bba71b76d14d04f55bbf6adea73386208c3c46de
[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 2019
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .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$&"
1403 .vindex "&$local_part_suffix$&"
1404 .cindex affix "router precondition"
1405 If the &%local_parts%& option is set, the local part of the address must be in
1406 the set of local parts that it defines. If &%local_part_prefix%& or
1407 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1408 part before this check. If you want to do precondition tests on local parts
1409 that include affixes, you can do so by using a &%condition%& option (see below)
1410 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1411 &$local_part_suffix$& as necessary.
1412 .next
1413 .vindex "&$local_user_uid$&"
1414 .vindex "&$local_user_gid$&"
1415 .vindex "&$home$&"
1416 If the &%check_local_user%& option is set, the local part must be the name of
1417 an account on the local host. If this check succeeds, the uid and gid of the
1418 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1419 user's home directory is placed in &$home$&; these values can be used in the
1420 remaining preconditions.
1421 .next
1422 If the &%router_home_directory%& option is set, it is expanded at this point,
1423 because it overrides the value of &$home$&. If this expansion were left till
1424 later, the value of &$home$& as set by &%check_local_user%& would be used in
1425 subsequent tests. Having two different values of &$home$& in the same router
1426 could lead to confusion.
1427 .next
1428 If the &%senders%& option is set, the envelope sender address must be in the
1429 set of addresses that it defines.
1430 .next
1431 If the &%require_files%& option is set, the existence or non-existence of
1432 specified files is tested.
1433 .next
1434 .cindex "customizing" "precondition"
1435 If the &%condition%& option is set, it is evaluated and tested. This option
1436 uses an expanded string to allow you to set up your own custom preconditions.
1437 Expanded strings are described in chapter &<<CHAPexpand>>&.
1438 .endlist
1439
1440
1441 Note that &%require_files%& comes near the end of the list, so you cannot use
1442 it to check for the existence of a file in which to lookup up a domain, local
1443 part, or sender. However, as these options are all expanded, you can use the
1444 &%exists%& expansion condition to make such tests within each condition. The
1445 &%require_files%& option is intended for checking files that the router may be
1446 going to use internally, or which are needed by a specific transport (for
1447 example, &_.procmailrc_&).
1448
1449
1450
1451 .section "Delivery in detail" "SECID18"
1452 .cindex "delivery" "in detail"
1453 When a message is to be delivered, the sequence of events is as follows:
1454
1455 .ilist
1456 If a system-wide filter file is specified, the message is passed to it. The
1457 filter may add recipients to the message, replace the recipients, discard the
1458 message, cause a new message to be generated, or cause the message delivery to
1459 fail. The format of the system filter file is the same as for Exim user filter
1460 files, described in the separate document entitled &'Exim's interfaces to mail
1461 filtering'&.
1462 .cindex "Sieve filter" "not available for system filter"
1463 (&*Note*&: Sieve cannot be used for system filter files.)
1464
1465 Some additional features are available in system filters &-- see chapter
1466 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1467 filter only once per delivery attempt, however many recipients it has. However,
1468 if there are several delivery attempts because one or more addresses could not
1469 be immediately delivered, the system filter is run each time. The filter
1470 condition &%first_delivery%& can be used to detect the first run of the system
1471 filter.
1472 .next
1473 Each recipient address is offered to each configured router, in turn, subject to
1474 its preconditions, until one is able to handle it. If no router can handle the
1475 address, that is, if they all decline, the address is failed. Because routers
1476 can be targeted at particular domains, several locally handled domains can be
1477 processed entirely independently of each other.
1478 .next
1479 .cindex "routing" "loops in"
1480 .cindex "loop" "while routing"
1481 A router that accepts an address may assign it to a local or a remote
1482 transport. However, the transport is not run at this time. Instead, the address
1483 is placed on a list for the particular transport, which will be run later.
1484 Alternatively, the router may generate one or more new addresses (typically
1485 from alias, forward, or filter files). New addresses are fed back into this
1486 process from the top, but in order to avoid loops, a router ignores any address
1487 which has an identically-named ancestor that was processed by itself.
1488 .next
1489 When all the routing has been done, addresses that have been successfully
1490 handled are passed to their assigned transports. When local transports are
1491 doing real local deliveries, they handle only one address at a time, but if a
1492 local transport is being used as a pseudo-remote transport (for example, to
1493 collect batched SMTP messages for transmission by some other means) multiple
1494 addresses can be handled. Remote transports can always handle more than one
1495 address at a time, but can be configured not to do so, or to restrict multiple
1496 addresses to the same domain.
1497 .next
1498 Each local delivery to a file or a pipe runs in a separate process under a
1499 non-privileged uid, and these deliveries are run one at a time. Remote
1500 deliveries also run in separate processes, normally under a uid that is private
1501 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1502 run in parallel. The maximum number of simultaneous remote deliveries for any
1503 one message is set by the &%remote_max_parallel%& option.
1504 The order in which deliveries are done is not defined, except that all local
1505 deliveries happen before any remote deliveries.
1506 .next
1507 .cindex "queue runner"
1508 When it encounters a local delivery during a queue run, Exim checks its retry
1509 database to see if there has been a previous temporary delivery failure for the
1510 address before running the local transport. If there was a previous failure,
1511 Exim does not attempt a new delivery until the retry time for the address is
1512 reached. However, this happens only for delivery attempts that are part of a
1513 queue run. Local deliveries are always attempted when delivery immediately
1514 follows message reception, even if retry times are set for them. This makes for
1515 better behaviour if one particular message is causing problems (for example,
1516 causing quota overflow, or provoking an error in a filter file).
1517 .next
1518 .cindex "delivery" "retry in remote transports"
1519 Remote transports do their own retry handling, since an address may be
1520 deliverable to one of a number of hosts, each of which may have a different
1521 retry time. If there have been previous temporary failures and no host has
1522 reached its retry time, no delivery is attempted, whether in a queue run or
1523 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1524 .next
1525 If there were any permanent errors, a bounce message is returned to an
1526 appropriate address (the sender in the common case), with details of the error
1527 for each failing address. Exim can be configured to send copies of bounce
1528 messages to other addresses.
1529 .next
1530 .cindex "delivery" "deferral"
1531 If one or more addresses suffered a temporary failure, the message is left on
1532 the queue, to be tried again later. Delivery of these addresses is said to be
1533 &'deferred'&.
1534 .next
1535 When all the recipient addresses have either been delivered or bounced,
1536 handling of the message is complete. The spool files and message log are
1537 deleted, though the message log can optionally be preserved if required.
1538 .endlist
1539
1540
1541
1542
1543 .section "Retry mechanism" "SECID19"
1544 .cindex "delivery" "retry mechanism"
1545 .cindex "retry" "description of mechanism"
1546 .cindex "queue runner"
1547 Exim's mechanism for retrying messages that fail to get delivered at the first
1548 attempt is the queue runner process. You must either run an Exim daemon that
1549 uses the &%-q%& option with a time interval to start queue runners at regular
1550 intervals or use some other means (such as &'cron'&) to start them. If you do
1551 not arrange for queue runners to be run, messages that fail temporarily at the
1552 first attempt will remain in your queue forever. A queue runner process works
1553 its way through the queue, one message at a time, trying each delivery that has
1554 passed its retry time.
1555 You can run several queue runners at once.
1556
1557 Exim uses a set of configured rules to determine when next to retry the failing
1558 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1559 should give up trying to deliver to the address, at which point it generates a
1560 bounce message. If no retry rules are set for a particular host, address, and
1561 error combination, no retries are attempted, and temporary errors are treated
1562 as permanent.
1563
1564
1565
1566 .section "Temporary delivery failure" "SECID20"
1567 .cindex "delivery" "temporary failure"
1568 There are many reasons why a message may not be immediately deliverable to a
1569 particular address. Failure to connect to a remote machine (because it, or the
1570 connection to it, is down) is one of the most common. Temporary failures may be
1571 detected during routing as well as during the transport stage of delivery.
1572 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1573 is on a file system where the user is over quota. Exim can be configured to
1574 impose its own quotas on local mailboxes; where system quotas are set they will
1575 also apply.
1576
1577 If a host is unreachable for a period of time, a number of messages may be
1578 waiting for it by the time it recovers, and sending them in a single SMTP
1579 connection is clearly beneficial. Whenever a delivery to a remote host is
1580 deferred,
1581 .cindex "hints database" "deferred deliveries"
1582 Exim makes a note in its hints database, and whenever a successful
1583 SMTP delivery has happened, it looks to see if any other messages are waiting
1584 for the same host. If any are found, they are sent over the same SMTP
1585 connection, subject to a configuration limit as to the maximum number in any
1586 one connection.
1587
1588
1589
1590 .section "Permanent delivery failure" "SECID21"
1591 .cindex "delivery" "permanent failure"
1592 .cindex "bounce message" "when generated"
1593 When a message cannot be delivered to some or all of its intended recipients, a
1594 bounce message is generated. Temporary delivery failures turn into permanent
1595 errors when their timeout expires. All the addresses that fail in a given
1596 delivery attempt are listed in a single message. If the original message has
1597 many recipients, it is possible for some addresses to fail in one delivery
1598 attempt and others to fail subsequently, giving rise to more than one bounce
1599 message. The wording of bounce messages can be customized by the administrator.
1600 See chapter &<<CHAPemsgcust>>& for details.
1601
1602 .cindex "&'X-Failed-Recipients:'& header line"
1603 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1604 failed addresses, for the benefit of programs that try to analyse such messages
1605 automatically.
1606
1607 .cindex "bounce message" "recipient of"
1608 A bounce message is normally sent to the sender of the original message, as
1609 obtained from the message's envelope. For incoming SMTP messages, this is the
1610 address given in the MAIL command. However, when an address is expanded via a
1611 forward or alias file, an alternative address can be specified for delivery
1612 failures of the generated addresses. For a mailing list expansion (see section
1613 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1614 of the list.
1615
1616
1617
1618 .section "Failures to deliver bounce messages" "SECID22"
1619 .cindex "bounce message" "failure to deliver"
1620 If a bounce message (either locally generated or received from a remote host)
1621 itself suffers a permanent delivery failure, the message is left in the queue,
1622 but it is frozen, awaiting the attention of an administrator. There are options
1623 that can be used to make Exim discard such failed messages, or to keep them
1624 for only a short time (see &%timeout_frozen_after%& and
1625 &%ignore_bounce_errors_after%&).
1626
1627
1628
1629
1630
1631 . ////////////////////////////////////////////////////////////////////////////
1632 . ////////////////////////////////////////////////////////////////////////////
1633
1634 .chapter "Building and installing Exim" "CHID3"
1635 .scindex IIDbuex "building Exim"
1636
1637 .section "Unpacking" "SECID23"
1638 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1639 creates a directory with the name of the current release (for example,
1640 &_exim-&version()_&) into which the following files are placed:
1641
1642 .table2 140pt
1643 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1644 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1645   documented"
1646 .irow &_LICENCE_&         "the GNU General Public Licence"
1647 .irow &_Makefile_&        "top-level make file"
1648 .irow &_NOTICE_&          "conditions for the use of Exim"
1649 .irow &_README_&          "list of files, directories and simple build &&&
1650   instructions"
1651 .endtable
1652
1653 Other files whose names begin with &_README_& may also be present. The
1654 following subdirectories are created:
1655
1656 .table2 140pt
1657 .irow &_Local_&           "an empty directory for local configuration files"
1658 .irow &_OS_&              "OS-specific files"
1659 .irow &_doc_&             "documentation files"
1660 .irow &_exim_monitor_&    "source files for the Exim monitor"
1661 .irow &_scripts_&         "scripts used in the build process"
1662 .irow &_src_&             "remaining source files"
1663 .irow &_util_&            "independent utilities"
1664 .endtable
1665
1666 The main utility programs are contained in the &_src_& directory and are built
1667 with the Exim binary. The &_util_& directory contains a few optional scripts
1668 that may be useful to some sites.
1669
1670
1671 .section "Multiple machine architectures and operating systems" "SECID24"
1672 .cindex "building Exim" "multiple OS/architectures"
1673 The building process for Exim is arranged to make it easy to build binaries for
1674 a number of different architectures and operating systems from the same set of
1675 source files. Compilation does not take place in the &_src_& directory.
1676 Instead, a &'build directory'& is created for each architecture and operating
1677 system.
1678 .cindex "symbolic link" "to build directory"
1679 Symbolic links to the sources are installed in this directory, which is where
1680 the actual building takes place. In most cases, Exim can discover the machine
1681 architecture and operating system for itself, but the defaults can be
1682 overridden if necessary.
1683 .cindex compiler requirements
1684 .cindex compiler version
1685 A C99-capable compiler will be required for the build.
1686
1687
1688 .section "PCRE library" "SECTpcre"
1689 .cindex "PCRE library"
1690 Exim no longer has an embedded PCRE library as the vast majority of
1691 modern systems include PCRE as a system library, although you may need to
1692 install the PCRE package or the PCRE development package for your operating
1693 system. If your system has a normal PCRE installation the Exim build
1694 process will need no further configuration. If the library or the
1695 headers are in an unusual location you will need to either set the PCRE_LIBS
1696 and INCLUDE directives appropriately,
1697 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1698 If your operating system has no
1699 PCRE support then you will need to obtain and build the current PCRE
1700 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1701 More information on PCRE is available at &url(https://www.pcre.org/).
1702
1703 .section "DBM libraries" "SECTdb"
1704 .cindex "DBM libraries" "discussion of"
1705 .cindex "hints database" "DBM files used for"
1706 Even if you do not use any DBM files in your configuration, Exim still needs a
1707 DBM library in order to operate, because it uses indexed files for its hints
1708 databases. Unfortunately, there are a number of DBM libraries in existence, and
1709 different operating systems often have different ones installed.
1710
1711 .cindex "Solaris" "DBM library for"
1712 .cindex "IRIX, DBM library for"
1713 .cindex "BSD, DBM library for"
1714 .cindex "Linux, DBM library for"
1715 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1716 Linux distribution, the DBM configuration should happen automatically, and you
1717 may be able to ignore this section. Otherwise, you may have to learn more than
1718 you would like about DBM libraries from what follows.
1719
1720 .cindex "&'ndbm'& DBM library"
1721 Licensed versions of Unix normally contain a library of DBM functions operating
1722 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1723 versions of Unix seem to vary in what they contain as standard. In particular,
1724 some early versions of Linux have no default DBM library, and different
1725 distributors have chosen to bundle different libraries with their packaged
1726 versions. However, the more recent releases seem to have standardized on the
1727 Berkeley DB library.
1728
1729 Different DBM libraries have different conventions for naming the files they
1730 use. When a program opens a file called &_dbmfile_&, there are several
1731 possibilities:
1732
1733 .olist
1734 A traditional &'ndbm'& implementation, such as that supplied as part of
1735 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1736 .next
1737 .cindex "&'gdbm'& DBM library"
1738 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1739 compatibility interface it makes two different hard links to it with names
1740 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1741 filename is used unmodified.
1742 .next
1743 .cindex "Berkeley DB library"
1744 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1745 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1746 programmer exactly the same as the traditional &'ndbm'& implementation.
1747 .next
1748 If the Berkeley package is used in its native mode, it operates on a single
1749 file called &_dbmfile_&; the programmer's interface is somewhat different to
1750 the traditional &'ndbm'& interface.
1751 .next
1752 To complicate things further, there are several very different versions of the
1753 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1754 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1755 Maintenance of some of the earlier releases has ceased. All versions of
1756 Berkeley DB could be obtained from
1757 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1758 page with far newer versions listed.
1759 It is probably wise to plan to move your storage configurations away from
1760 Berkeley DB format, as today there are smaller and simpler alternatives more
1761 suited to Exim's usage model.
1762 .next
1763 .cindex "&'tdb'& DBM library"
1764 Yet another DBM library, called &'tdb'&, is available from
1765 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1766 operates on a single file.
1767 .endlist
1768
1769 .cindex "USE_DB"
1770 .cindex "DBM libraries" "configuration for building"
1771 Exim and its utilities can be compiled to use any of these interfaces. In order
1772 to use any version of the Berkeley DB package in native mode, you must set
1773 USE_DB in an appropriate configuration file (typically
1774 &_Local/Makefile_&). For example:
1775 .code
1776 USE_DB=yes
1777 .endd
1778 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1779 error is diagnosed if you set more than one of these.
1780
1781 At the lowest level, the build-time configuration sets none of these options,
1782 thereby assuming an interface of type (1). However, some operating system
1783 configuration files (for example, those for the BSD operating systems and
1784 Linux) assume type (4) by setting USE_DB as their default, and the
1785 configuration files for Cygwin set USE_GDBM. Anything you set in
1786 &_Local/Makefile_&, however, overrides these system defaults.
1787
1788 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1789 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1790 in one of these lines:
1791 .code
1792 DBMLIB = -ldb
1793 DBMLIB = -ltdb
1794 .endd
1795 Settings like that will work if the DBM library is installed in the standard
1796 place. Sometimes it is not, and the library's header file may also not be in
1797 the default path. You may need to set INCLUDE to specify where the header
1798 file is, and to specify the path to the library more fully in DBMLIB, as in
1799 this example:
1800 .code
1801 INCLUDE=-I/usr/local/include/db-4.1
1802 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1803 .endd
1804 There is further detailed discussion about the various DBM libraries in the
1805 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1806
1807
1808
1809 .section "Pre-building configuration" "SECID25"
1810 .cindex "building Exim" "pre-building configuration"
1811 .cindex "configuration for building Exim"
1812 .cindex "&_Local/Makefile_&"
1813 .cindex "&_src/EDITME_&"
1814 Before building Exim, a local configuration file that specifies options
1815 independent of any operating system has to be created with the name
1816 &_Local/Makefile_&. A template for this file is supplied as the file
1817 &_src/EDITME_&, and it contains full descriptions of all the option settings
1818 therein. These descriptions are therefore not repeated here. If you are
1819 building Exim for the first time, the simplest thing to do is to copy
1820 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1821
1822 There are three settings that you must supply, because Exim will not build
1823 without them. They are the location of the runtime configuration file
1824 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1825 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1826 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1827 a colon-separated list of filenames; Exim uses the first of them that exists.
1828
1829 There are a few other parameters that can be specified either at build time or
1830 at runtime, to enable the same binary to be used on a number of different
1831 machines. However, if the locations of Exim's spool directory and log file
1832 directory (if not within the spool directory) are fixed, it is recommended that
1833 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1834 detected early in Exim's execution (such as a malformed configuration file) can
1835 be logged.
1836
1837 .cindex "content scanning" "specifying at build time"
1838 Exim's interfaces for calling virus and spam scanning software directly from
1839 access control lists are not compiled by default. If you want to include these
1840 facilities, you need to set
1841 .code
1842 WITH_CONTENT_SCAN=yes
1843 .endd
1844 in your &_Local/Makefile_&. For details of the facilities themselves, see
1845 chapter &<<CHAPexiscan>>&.
1846
1847
1848 .cindex "&_Local/eximon.conf_&"
1849 .cindex "&_exim_monitor/EDITME_&"
1850 If you are going to build the Exim monitor, a similar configuration process is
1851 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1852 your installation and saved under the name &_Local/eximon.conf_&. If you are
1853 happy with the default settings described in &_exim_monitor/EDITME_&,
1854 &_Local/eximon.conf_& can be empty, but it must exist.
1855
1856 This is all the configuration that is needed in straightforward cases for known
1857 operating systems. However, the building process is set up so that it is easy
1858 to override options that are set by default or by operating-system-specific
1859 configuration files, for example, to change the C compiler, which
1860 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1861 do this.
1862
1863
1864
1865 .section "Support for iconv()" "SECID26"
1866 .cindex "&[iconv()]& support"
1867 .cindex "RFC 2047"
1868 The contents of header lines in messages may be encoded according to the rules
1869 described RFC 2047. This makes it possible to transmit characters that are not
1870 in the ASCII character set, and to label them as being in a particular
1871 character set. When Exim is inspecting header lines by means of the &%$h_%&
1872 mechanism, it decodes them, and translates them into a specified character set
1873 (default is set at build time). The translation is possible only if the operating system
1874 supports the &[iconv()]& function.
1875
1876 However, some of the operating systems that supply &[iconv()]& do not support
1877 very many conversions. The GNU &%libiconv%& library (available from
1878 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1879 systems to remedy this deficiency, as well as on systems that do not supply
1880 &[iconv()]& at all. After installing &%libiconv%&, you should add
1881 .code
1882 HAVE_ICONV=yes
1883 .endd
1884 to your &_Local/Makefile_& and rebuild Exim.
1885
1886
1887
1888 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1889 .cindex "TLS" "including support for TLS"
1890 .cindex "encryption" "including support for"
1891 .cindex "OpenSSL" "building Exim with"
1892 .cindex "GnuTLS" "building Exim with"
1893 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1894 command as per RFC 2487. It can also support clients that expect to
1895 start a TLS session immediately on connection to a non-standard port (see the
1896 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1897 line option).
1898
1899 If you want to build Exim with TLS support, you must first install either the
1900 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1901 implementing SSL.
1902
1903 If you do not want TLS support you should set
1904 .code
1905 DISABLE_TLS=yes
1906 .endd
1907 in &_Local/Makefile_&.
1908
1909 If OpenSSL is installed, you should set
1910 .code
1911 USE_OPENSL=yes
1912 TLS_LIBS=-lssl -lcrypto
1913 .endd
1914 in &_Local/Makefile_&. You may also need to specify the locations of the
1915 OpenSSL library and include files. For example:
1916 .code
1917 USE_OPENSSL=yes
1918 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1919 TLS_INCLUDE=-I/usr/local/openssl/include/
1920 .endd
1921 .cindex "pkg-config" "OpenSSL"
1922 If you have &'pkg-config'& available, then instead you can just use:
1923 .code
1924 USE_OPENSSL=yes
1925 USE_OPENSSL_PC=openssl
1926 .endd
1927 .cindex "USE_GNUTLS"
1928 If GnuTLS is installed, you should set
1929 .code
1930 USE_GNUTLS=yes
1931 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1932 .endd
1933 in &_Local/Makefile_&, and again you may need to specify the locations of the
1934 library and include files. For example:
1935 .code
1936 USE_GNUTLS=yes
1937 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1938 TLS_INCLUDE=-I/usr/gnu/include
1939 .endd
1940 .cindex "pkg-config" "GnuTLS"
1941 If you have &'pkg-config'& available, then instead you can just use:
1942 .code
1943 USE_GNUTLS=yes
1944 USE_GNUTLS_PC=gnutls
1945 .endd
1946
1947 You do not need to set TLS_INCLUDE if the relevant directory is already
1948 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1949 given in chapter &<<CHAPTLS>>&.
1950
1951
1952
1953
1954 .section "Use of tcpwrappers" "SECID27"
1955
1956 .cindex "tcpwrappers, building Exim to support"
1957 .cindex "USE_TCP_WRAPPERS"
1958 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1959 .cindex "tcp_wrappers_daemon_name"
1960 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1961 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1962 alternative to Exim's own checking facilities for installations that are
1963 already making use of &'tcpwrappers'& for other purposes. To do this, you
1964 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1965 &_tcpd.h_& to be available at compile time, and also ensure that the library
1966 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1967 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1968 you might have
1969 .code
1970 USE_TCP_WRAPPERS=yes
1971 CFLAGS=-O -I/usr/local/include
1972 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1973 .endd
1974 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1975 files is &"exim"&. For example, the line
1976 .code
1977 exim : LOCAL  192.168.1.  .friendly.domain.example
1978 .endd
1979 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1980 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1981 All other connections are denied. The daemon name used by &'tcpwrappers'&
1982 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1983 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1984 configure file. Consult the &'tcpwrappers'& documentation for
1985 further details.
1986
1987
1988 .section "Including support for IPv6" "SECID28"
1989 .cindex "IPv6" "including support for"
1990 Exim contains code for use on systems that have IPv6 support. Setting
1991 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1992 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1993 where the IPv6 support is not fully integrated into the normal include and
1994 library files.
1995
1996 Two different types of DNS record for handling IPv6 addresses have been
1997 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1998 currently seen as the mainstream. Another record type called A6 was proposed
1999 as better than AAAA because it had more flexibility. However, it was felt to be
2000 over-complex, and its status was reduced to &"experimental"&.
2001 Exim used to
2002 have a compile option for including A6 record support but this has now been
2003 withdrawn.
2004
2005
2006
2007 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2008 .cindex "lookup modules"
2009 .cindex "dynamic modules"
2010 .cindex ".so building"
2011 On some platforms, Exim supports not compiling all lookup types directly into
2012 the main binary, instead putting some into external modules which can be loaded
2013 on demand.
2014 This permits packagers to build Exim with support for lookups with extensive
2015 library dependencies without requiring all users to install all of those
2016 dependencies.
2017 Most, but not all, lookup types can be built this way.
2018
2019 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2020 installed; Exim will only load modules from that directory, as a security
2021 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2022 for your OS; see &_OS/Makefile-Linux_& for an example.
2023 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2024 see &_src/EDITME_& for details.
2025
2026 Then, for each module to be loaded dynamically, define the relevant
2027 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2028 For example, this will build in lsearch but load sqlite and mysql support
2029 on demand:
2030 .code
2031 LOOKUP_LSEARCH=yes
2032 LOOKUP_SQLITE=2
2033 LOOKUP_MYSQL=2
2034 .endd
2035
2036
2037 .section "The building process" "SECID29"
2038 .cindex "build directory"
2039 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2040 created, run &'make'& at the top level. It determines the architecture and
2041 operating system types, and creates a build directory if one does not exist.
2042 For example, on a Sun system running Solaris 8, the directory
2043 &_build-SunOS5-5.8-sparc_& is created.
2044 .cindex "symbolic link" "to source files"
2045 Symbolic links to relevant source files are installed in the build directory.
2046
2047 If this is the first time &'make'& has been run, it calls a script that builds
2048 a make file inside the build directory, using the configuration files from the
2049 &_Local_& directory. The new make file is then passed to another instance of
2050 &'make'&. This does the real work, building a number of utility scripts, and
2051 then compiling and linking the binaries for the Exim monitor (if configured), a
2052 number of utility programs, and finally Exim itself. The command &`make
2053 makefile`& can be used to force a rebuild of the make file in the build
2054 directory, should this ever be necessary.
2055
2056 If you have problems building Exim, check for any comments there may be in the
2057 &_README_& file concerning your operating system, and also take a look at the
2058 FAQ, where some common problems are covered.
2059
2060
2061
2062 .section 'Output from &"make"&' "SECID283"
2063 The output produced by the &'make'& process for compile lines is often very
2064 unreadable, because these lines can be very long. For this reason, the normal
2065 output is suppressed by default, and instead output similar to that which
2066 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2067 each module that is being compiled or linked. However, it is still possible to
2068 get the full output, by calling &'make'& like this:
2069 .code
2070 FULLECHO='' make -e
2071 .endd
2072 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2073 command reflection in &'make'&. When you ask for the full output, it is
2074 given in addition to the short output.
2075
2076
2077
2078 .section "Overriding build-time options for Exim" "SECToverride"
2079 .cindex "build-time options, overriding"
2080 The main make file that is created at the beginning of the building process
2081 consists of the concatenation of a number of files which set configuration
2082 values, followed by a fixed set of &'make'& instructions. If a value is set
2083 more than once, the last setting overrides any previous ones. This provides a
2084 convenient way of overriding defaults. The files that are concatenated are, in
2085 order:
2086 .display
2087 &_OS/Makefile-Default_&
2088 &_OS/Makefile-_&<&'ostype'&>
2089 &_Local/Makefile_&
2090 &_Local/Makefile-_&<&'ostype'&>
2091 &_Local/Makefile-_&<&'archtype'&>
2092 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2093 &_OS/Makefile-Base_&
2094 .endd
2095 .cindex "&_Local/Makefile_&"
2096 .cindex "building Exim" "operating system type"
2097 .cindex "building Exim" "architecture type"
2098 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2099 architecture type. &_Local/Makefile_& is required to exist, and the building
2100 process fails if it is absent. The other three &_Local_& files are optional,
2101 and are often not needed.
2102
2103 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2104 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2105 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2106 values are used, thereby providing a means of forcing particular settings.
2107 Otherwise, the scripts try to get values from the &%uname%& command. If this
2108 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2109 of &'ad hoc'& transformations are then applied, to produce the standard names
2110 that Exim expects. You can run these scripts directly from the shell in order
2111 to find out what values are being used on your system.
2112
2113
2114 &_OS/Makefile-Default_& contains comments about the variables that are set
2115 therein. Some (but not all) are mentioned below. If there is something that
2116 needs changing, review the contents of this file and the contents of the make
2117 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2118 default values are.
2119
2120
2121 .cindex "building Exim" "overriding default settings"
2122 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2123 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2124 need to change the original files. Instead, you should make the changes by
2125 putting the new values in an appropriate &_Local_& file. For example,
2126 .cindex "Tru64-Unix build-time settings"
2127 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2128 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2129 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2130 called with the option &%-std1%&, to make it recognize some of the features of
2131 Standard C that Exim uses. (Most other compilers recognize Standard C by
2132 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2133 containing the lines
2134 .code
2135 CC=cc
2136 CFLAGS=-std1
2137 .endd
2138 If you are compiling for just one operating system, it may be easier to put
2139 these lines directly into &_Local/Makefile_&.
2140
2141 Keeping all your local configuration settings separate from the distributed
2142 files makes it easy to transfer them to new versions of Exim simply by copying
2143 the contents of the &_Local_& directory.
2144
2145
2146 .cindex "NIS lookup type" "including support for"
2147 .cindex "NIS+ lookup type" "including support for"
2148 .cindex "LDAP" "including support for"
2149 .cindex "lookup" "inclusion in binary"
2150 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2151 lookup, but not all systems have these components installed, so the default is
2152 not to include the relevant code in the binary. All the different kinds of file
2153 and database lookup that Exim supports are implemented as separate code modules
2154 which are included only if the relevant compile-time options are set. In the
2155 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2156 .code
2157 LOOKUP_LDAP=yes
2158 LOOKUP_NIS=yes
2159 LOOKUP_NISPLUS=yes
2160 .endd
2161 and similar settings apply to the other lookup types. They are all listed in
2162 &_src/EDITME_&. In many cases the relevant include files and interface
2163 libraries need to be installed before compiling Exim.
2164 .cindex "cdb" "including support for"
2165 However, there are some optional lookup types (such as cdb) for which
2166 the code is entirely contained within Exim, and no external include
2167 files or libraries are required. When a lookup type is not included in the
2168 binary, attempts to configure Exim to use it cause runtime configuration
2169 errors.
2170
2171 .cindex "pkg-config" "lookups"
2172 .cindex "pkg-config" "authenticators"
2173 Many systems now use a tool called &'pkg-config'& to encapsulate information
2174 about how to compile against a library; Exim has some initial support for
2175 being able to use pkg-config for lookups and authenticators.  For any given
2176 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2177 variable with the &`_PC`& suffix in the name and assign as the value the
2178 name of the package to be queried.  The results of querying via the
2179 &'pkg-config'& command will be added to the appropriate Makefile variables
2180 with &`+=`& directives, so your version of &'make'& will need to support that
2181 syntax.  For instance:
2182 .code
2183 LOOKUP_SQLITE=yes
2184 LOOKUP_SQLITE_PC=sqlite3
2185 AUTH_GSASL=yes
2186 AUTH_GSASL_PC=libgsasl
2187 AUTH_HEIMDAL_GSSAPI=yes
2188 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2189 .endd
2190
2191 .cindex "Perl" "including support for"
2192 Exim can be linked with an embedded Perl interpreter, allowing Perl
2193 subroutines to be called during string expansion. To enable this facility,
2194 .code
2195 EXIM_PERL=perl.o
2196 .endd
2197 must be defined in &_Local/Makefile_&. Details of this facility are given in
2198 chapter &<<CHAPperl>>&.
2199
2200 .cindex "X11 libraries, location of"
2201 The location of the X11 libraries is something that varies a lot between
2202 operating systems, and there may be different versions of X11 to cope
2203 with. Exim itself makes no use of X11, but if you are compiling the Exim
2204 monitor, the X11 libraries must be available.
2205 The following three variables are set in &_OS/Makefile-Default_&:
2206 .code
2207 X11=/usr/X11R6
2208 XINCLUDE=-I$(X11)/include
2209 XLFLAGS=-L$(X11)/lib
2210 .endd
2211 These are overridden in some of the operating-system configuration files. For
2212 example, in &_OS/Makefile-SunOS5_& there is
2213 .code
2214 X11=/usr/openwin
2215 XINCLUDE=-I$(X11)/include
2216 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2217 .endd
2218 If you need to override the default setting for your operating system, place a
2219 definition of all three of these variables into your
2220 &_Local/Makefile-<ostype>_& file.
2221
2222 .cindex "EXTRALIBS"
2223 If you need to add any extra libraries to the link steps, these can be put in a
2224 variable called EXTRALIBS, which appears in all the link commands, but by
2225 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2226 command for linking the main Exim binary, and not for any associated utilities.
2227
2228 .cindex "DBM libraries" "configuration for building"
2229 There is also DBMLIB, which appears in the link commands for binaries that
2230 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2231 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2232 binary, and which can be used, for example, to include additional X11
2233 libraries.
2234
2235 .cindex "configuration file" "editing"
2236 The make file copes with rebuilding Exim correctly if any of the configuration
2237 files are edited. However, if an optional configuration file is deleted, it is
2238 necessary to touch the associated non-optional file (that is,
2239 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2240
2241
2242 .section "OS-specific header files" "SECID30"
2243 .cindex "&_os.h_&"
2244 .cindex "building Exim" "OS-specific C header files"
2245 The &_OS_& directory contains a number of files with names of the form
2246 &_os.h-<ostype>_&. These are system-specific C header files that should not
2247 normally need to be changed. There is a list of macro settings that are
2248 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2249 are porting Exim to a new operating system.
2250
2251
2252
2253 .section "Overriding build-time options for the monitor" "SECID31"
2254 .cindex "building Eximon"
2255 A similar process is used for overriding things when building the Exim monitor,
2256 where the files that are involved are
2257 .display
2258 &_OS/eximon.conf-Default_&
2259 &_OS/eximon.conf-_&<&'ostype'&>
2260 &_Local/eximon.conf_&
2261 &_Local/eximon.conf-_&<&'ostype'&>
2262 &_Local/eximon.conf-_&<&'archtype'&>
2263 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2264 .endd
2265 .cindex "&_Local/eximon.conf_&"
2266 As with Exim itself, the final three files need not exist, and in this case the
2267 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2268 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2269 variables of the same name, preceded by EXIMON_. For example, setting
2270 EXIMON_LOG_DEPTH in the environment overrides the value of
2271 LOG_DEPTH at runtime.
2272 .ecindex IIDbuex
2273
2274
2275 .section "Installing Exim binaries and scripts" "SECID32"
2276 .cindex "installing Exim"
2277 .cindex "BIN_DIRECTORY"
2278 The command &`make install`& runs the &(exim_install)& script with no
2279 arguments. The script copies binaries and utility scripts into the directory
2280 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2281 .cindex "setuid" "installing Exim with"
2282 The install script copies files only if they are newer than the files they are
2283 going to replace. The Exim binary is required to be owned by root and have the
2284 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2285 install`& as root so that it can set up the Exim binary in this way. However, in
2286 some special situations (for example, if a host is doing no local deliveries)
2287 it may be possible to run Exim without making the binary setuid root (see
2288 chapter &<<CHAPsecurity>>& for details).
2289
2290 .cindex "CONFIGURE_FILE"
2291 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2292 in &_Local/Makefile_&. If this names a single file, and the file does not
2293 exist, the default configuration file &_src/configure.default_& is copied there
2294 by the installation script. If a runtime configuration file already exists, it
2295 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2296 alternative files, no default is installed.
2297
2298 .cindex "system aliases file"
2299 .cindex "&_/etc/aliases_&"
2300 One change is made to the default configuration file when it is installed: the
2301 default configuration contains a router that references a system aliases file.
2302 The path to this file is set to the value specified by
2303 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2304 If the system aliases file does not exist, the installation script creates it,
2305 and outputs a comment to the user.
2306
2307 The created file contains no aliases, but it does contain comments about the
2308 aliases a site should normally have. Mail aliases have traditionally been
2309 kept in &_/etc/aliases_&. However, some operating systems are now using
2310 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2311 Exim's configuration if necessary.
2312
2313 The default configuration uses the local host's name as the only local domain,
2314 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2315 running as the local user. System aliases and &_.forward_& files in users' home
2316 directories are supported, but no NIS or NIS+ support is configured. Domains
2317 other than the name of the local host are routed using the DNS, with delivery
2318 over SMTP.
2319
2320 It is possible to install Exim for special purposes (such as building a binary
2321 distribution) in a private part of the file system. You can do this by a
2322 command such as
2323 .code
2324 make DESTDIR=/some/directory/ install
2325 .endd
2326 This has the effect of pre-pending the specified directory to all the file
2327 paths, except the name of the system aliases file that appears in the default
2328 configuration. (If a default alias file is created, its name &'is'& modified.)
2329 For backwards compatibility, ROOT is used if DESTDIR is not set,
2330 but this usage is deprecated.
2331
2332 .cindex "installing Exim" "what is not installed"
2333 Running &'make install'& does not copy the Exim 4 conversion script
2334 &'convert4r4'&. You will probably run this only once if you are
2335 upgrading from Exim 3. None of the documentation files in the &_doc_&
2336 directory are copied, except for the info files when you have set
2337 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2338
2339 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2340 to their names. The Exim binary itself, however, is handled differently. It is
2341 installed under a name that includes the version number and the compile number,
2342 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2343 called &_exim_& to point to the binary. If you are updating a previous version
2344 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2345 from the directory (as seen by other processes).
2346
2347 .cindex "installing Exim" "testing the script"
2348 If you want to see what the &'make install'& will do before running it for
2349 real, you can pass the &%-n%& option to the installation script by this
2350 command:
2351 .code
2352 make INSTALL_ARG=-n install
2353 .endd
2354 The contents of the variable INSTALL_ARG are passed to the installation
2355 script. You do not need to be root to run this test. Alternatively, you can run
2356 the installation script directly, but this must be from within the build
2357 directory. For example, from the top-level Exim directory you could use this
2358 command:
2359 .code
2360 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2361 .endd
2362 .cindex "installing Exim" "install script options"
2363 There are two other options that can be supplied to the installation script.
2364
2365 .ilist
2366 &%-no_chown%& bypasses the call to change the owner of the installed binary
2367 to root, and the call to make it a setuid binary.
2368 .next
2369 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2370 installed binary.
2371 .endlist
2372
2373 INSTALL_ARG can be used to pass these options to the script. For example:
2374 .code
2375 make INSTALL_ARG=-no_symlink install
2376 .endd
2377 The installation script can also be given arguments specifying which files are
2378 to be copied. For example, to install just the Exim binary, and nothing else,
2379 without creating the symbolic link, you could use:
2380 .code
2381 make INSTALL_ARG='-no_symlink exim' install
2382 .endd
2383
2384
2385
2386 .section "Installing info documentation" "SECTinsinfdoc"
2387 .cindex "installing Exim" "&'info'& documentation"
2388 Not all systems use the GNU &'info'& system for documentation, and for this
2389 reason, the Texinfo source of Exim's documentation is not included in the main
2390 distribution. Instead it is available separately from the FTP site (see section
2391 &<<SECTavail>>&).
2392
2393 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2394 source of the documentation is found in the source tree, running &`make
2395 install`& automatically builds the info files and installs them.
2396
2397
2398
2399 .section "Setting up the spool directory" "SECID33"
2400 .cindex "spool directory" "creating"
2401 When it starts up, Exim tries to create its spool directory if it does not
2402 exist. The Exim uid and gid are used for the owner and group of the spool
2403 directory. Sub-directories are automatically created in the spool directory as
2404 necessary.
2405
2406
2407
2408
2409 .section "Testing" "SECID34"
2410 .cindex "testing" "installation"
2411 Having installed Exim, you can check that the runtime configuration file is
2412 syntactically valid by running the following command, which assumes that the
2413 Exim binary directory is within your PATH environment variable:
2414 .code
2415 exim -bV
2416 .endd
2417 If there are any errors in the configuration file, Exim outputs error messages.
2418 Otherwise it outputs the version number and build date,
2419 the DBM library that is being used, and information about which drivers and
2420 other optional code modules are included in the binary.
2421 Some simple routing tests can be done by using the address testing option. For
2422 example,
2423 .display
2424 &`exim -bt`& <&'local username'&>
2425 .endd
2426 should verify that it recognizes a local mailbox, and
2427 .display
2428 &`exim -bt`& <&'remote address'&>
2429 .endd
2430 a remote one. Then try getting it to deliver mail, both locally and remotely.
2431 This can be done by passing messages directly to Exim, without going through a
2432 user agent. For example:
2433 .code
2434 exim -v postmaster@your.domain.example
2435 From: user@your.domain.example
2436 To: postmaster@your.domain.example
2437 Subject: Testing Exim
2438
2439 This is a test message.
2440 ^D
2441 .endd
2442 The &%-v%& option causes Exim to output some verification of what it is doing.
2443 In this case you should see copies of three log lines, one for the message's
2444 arrival, one for its delivery, and one containing &"Completed"&.
2445
2446 .cindex "delivery" "problems with"
2447 If you encounter problems, look at Exim's log files (&'mainlog'& and
2448 &'paniclog'&) to see if there is any relevant information there. Another source
2449 of information is running Exim with debugging turned on, by specifying the
2450 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2451 with debugging turned on by a command of the form
2452 .display
2453 &`exim -d -M`& <&'exim-message-id'&>
2454 .endd
2455 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2456 produces rather a lot of output, but you can cut this down to specific areas.
2457 For example, if you use &%-d-all+route%& only the debugging information
2458 relevant to routing is included. (See the &%-d%& option in chapter
2459 &<<CHAPcommandline>>& for more details.)
2460
2461 .cindex '&"sticky"& bit'
2462 .cindex "lock files"
2463 One specific problem that has shown up on some sites is the inability to do
2464 local deliveries into a shared mailbox directory, because it does not have the
2465 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2466 writing to a mailbox file, and if it cannot create the lock file, the delivery
2467 is deferred. You can get round this either by setting the &"sticky bit"& on the
2468 directory, or by setting a specific group for local deliveries and allowing
2469 that group to create files in the directory (see the comments above the
2470 &(local_delivery)& transport in the default configuration file). Another
2471 approach is to configure Exim not to use lock files, but just to rely on
2472 &[fcntl()]& locking instead. However, you should do this only if all user
2473 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2474 see chapter &<<CHAPappendfile>>&.
2475
2476 One thing that cannot be tested on a system that is already running an MTA is
2477 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2478 &%-oX%& option can be used to run an Exim daemon that listens on some other
2479 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2480 &'exim_checkaccess'& utility can be used to check out policy controls on
2481 incoming SMTP mail.
2482
2483 Testing a new version on a system that is already running Exim can most easily
2484 be done by building a binary with a different CONFIGURE_FILE setting. From
2485 within the runtime configuration, all other file and directory names
2486 that Exim uses can be altered, in order to keep it entirely clear of the
2487 production version.
2488
2489
2490 .section "Replacing another MTA with Exim" "SECID35"
2491 .cindex "replacing another MTA"
2492 Building and installing Exim for the first time does not of itself put it in
2493 general use. The name by which the system's MTA is called by mail user agents
2494 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2495 operating system), and it is necessary to make this name point to the &'exim'&
2496 binary in order to get the user agents to pass messages to Exim. This is
2497 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2498 or &_/usr/lib/sendmail_&
2499 .cindex "symbolic link" "to &'exim'& binary"
2500 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2501 privilege and executable status from the old MTA. It is then necessary to stop
2502 and restart the mailer daemon, if one is running.
2503
2504 .cindex "FreeBSD, MTA indirection"
2505 .cindex "&_/etc/mail/mailer.conf_&"
2506 Some operating systems have introduced alternative ways of switching MTAs. For
2507 example, if you are running FreeBSD, you need to edit the file
2508 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2509 described. A typical example of the contents of this file for running Exim is
2510 as follows:
2511 .code
2512 sendmail            /usr/exim/bin/exim
2513 send-mail           /usr/exim/bin/exim
2514 mailq               /usr/exim/bin/exim -bp
2515 newaliases          /usr/bin/true
2516 .endd
2517 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2518 your Exim installation is &"live"&. Check it by sending a message from your
2519 favourite user agent.
2520
2521 You should consider what to tell your users about the change of MTA. Exim may
2522 have different capabilities to what was previously running, and there are
2523 various operational differences such as the text of messages produced by
2524 command line options and in bounce messages. If you allow your users to make
2525 use of Exim's filtering capabilities, you should make the document entitled
2526 &'Exim's interface to mail filtering'& available to them.
2527
2528
2529
2530 .section "Upgrading Exim" "SECID36"
2531 .cindex "upgrading Exim"
2532 If you are already running Exim on your host, building and installing a new
2533 version automatically makes it available to MUAs, or any other programs that
2534 call the MTA directly. However, if you are running an Exim daemon, you do need
2535 .cindex restart "on HUP signal"
2536 .cindex signal "HUP, to restart"
2537 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2538 new binary. You do not need to stop processing mail in order to install a new
2539 version of Exim. The install script does not modify an existing runtime
2540 configuration file.
2541
2542
2543
2544
2545 .section "Stopping the Exim daemon on Solaris" "SECID37"
2546 .cindex "Solaris" "stopping Exim on"
2547 The standard command for stopping the mailer daemon on Solaris is
2548 .code
2549 /etc/init.d/sendmail stop
2550 .endd
2551 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2552 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2553 for the text &"sendmail"&; this is not present because the actual program name
2554 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2555 solution is to replace the line that finds the process id with something like
2556 .code
2557 pid=`cat /var/spool/exim/exim-daemon.pid`
2558 .endd
2559 to obtain the daemon's pid directly from the file that Exim saves it in.
2560
2561 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2562 still be received from local processes, and if automatic delivery is configured
2563 (the normal case), deliveries will still occur.
2564
2565
2566
2567
2568 . ////////////////////////////////////////////////////////////////////////////
2569 . ////////////////////////////////////////////////////////////////////////////
2570
2571 .chapter "The Exim command line" "CHAPcommandline"
2572 .scindex IIDclo1 "command line" "options"
2573 .scindex IIDclo2 "options" "command line"
2574 Exim's command line takes the standard Unix form of a sequence of options,
2575 each starting with a hyphen character, followed by a number of arguments. The
2576 options are compatible with the main options of Sendmail, and there are also
2577 some additional options, some of which are compatible with Smail 3. Certain
2578 combinations of options do not make sense, and provoke an error if used.
2579 The form of the arguments depends on which options are set.
2580
2581
2582 .section "Setting options by program name" "SECID38"
2583 .cindex "&'mailq'&"
2584 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2585 were present before any other options.
2586 The &%-bp%& option requests a listing of the contents of the mail queue on the
2587 standard output.
2588 This feature is for compatibility with some systems that contain a command of
2589 that name in one of the standard libraries, symbolically linked to
2590 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2591
2592 .cindex "&'rsmtp'&"
2593 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2594 were present before any other options, for compatibility with Smail. The
2595 &%-bS%& option is used for reading in a number of messages in batched SMTP
2596 format.
2597
2598 .cindex "&'rmail'&"
2599 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2600 &%-oee%& options were present before any other options, for compatibility with
2601 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2602
2603 .cindex "&'runq'&"
2604 .cindex "queue runner"
2605 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2606 were present before any other options, for compatibility with Smail. The &%-q%&
2607 option causes a single queue runner process to be started.
2608
2609 .cindex "&'newaliases'&"
2610 .cindex "alias file" "building"
2611 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2612 If Exim is called under the name &'newaliases'& it behaves as if the option
2613 &%-bi%& were present before any other options, for compatibility with Sendmail.
2614 This option is used for rebuilding Sendmail's alias file. Exim does not have
2615 the concept of a single alias file, but can be configured to run a given
2616 command if called with the &%-bi%& option.
2617
2618
2619 .section "Trusted and admin users" "SECTtrustedadmin"
2620 Some Exim options are available only to &'trusted users'& and others are
2621 available only to &'admin users'&. In the description below, the phrases &"Exim
2622 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2623 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2624 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2625
2626 .ilist
2627 .cindex "trusted users" "definition of"
2628 .cindex "user" "trusted definition of"
2629 The trusted users are root, the Exim user, any user listed in the
2630 &%trusted_users%& configuration option, and any user whose current group or any
2631 supplementary group is one of those listed in the &%trusted_groups%&
2632 configuration option. Note that the Exim group is not automatically trusted.
2633
2634 .cindex '&"From"& line'
2635 .cindex "envelope from"
2636 .cindex "envelope sender"
2637 Trusted users are always permitted to use the &%-f%& option or a leading
2638 &"From&~"& line to specify the envelope sender of a message that is passed to
2639 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2640 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2641 users to set envelope senders.
2642
2643 .cindex "&'From:'& header line"
2644 .cindex "&'Sender:'& header line"
2645 .cindex "header lines" "From:"
2646 .cindex "header lines" "Sender:"
2647 For a trusted user, there is never any check on the contents of the &'From:'&
2648 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2649 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2650
2651 Trusted users may also specify a host name, host address, interface address,
2652 protocol name, ident value, and authentication data when submitting a message
2653 locally. Thus, they are able to insert messages into Exim's queue locally that
2654 have the characteristics of messages received from a remote host. Untrusted
2655 users may in some circumstances use &%-f%&, but can never set the other values
2656 that are available to trusted users.
2657 .next
2658 .cindex "user" "admin definition of"
2659 .cindex "admin user" "definition of"
2660 The admin users are root, the Exim user, and any user that is a member of the
2661 Exim group or of any group listed in the &%admin_groups%& configuration option.
2662 The current group does not have to be one of these groups.
2663
2664 Admin users are permitted to list the queue, and to carry out certain
2665 operations on messages, for example, to force delivery failures. It is also
2666 necessary to be an admin user in order to see the full information provided by
2667 the Exim monitor, and full debugging output.
2668
2669 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2670 Exim to attempt delivery of messages on its queue is restricted to admin users.
2671 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2672 option false (that is, specifying &%no_prod_requires_admin%&).
2673
2674 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2675 is restricted to admin users unless &%queue_list_requires_admin%& is set
2676 false.
2677 .endlist
2678
2679
2680 &*Warning*&: If you configure your system so that admin users are able to
2681 edit Exim's configuration file, you are giving those users an easy way of
2682 getting root. There is further discussion of this issue at the start of chapter
2683 &<<CHAPconf>>&.
2684
2685
2686
2687
2688 .section "Command line options" "SECID39"
2689 Exim's command line options are described in alphabetical order below. If none
2690 of the options that specifies a specific action (such as starting the daemon or
2691 a queue runner, or testing an address, or receiving a message in a specific
2692 format, or listing the queue) are present, and there is at least one argument
2693 on the command line, &%-bm%& (accept a local message on the standard input,
2694 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2695 outputs a brief message about itself and exits.
2696
2697 . ////////////////////////////////////////////////////////////////////////////
2698 . Insert a stylized XML comment here, to identify the start of the command line
2699 . options. This is for the benefit of the Perl script that automatically
2700 . creates a man page for the options.
2701 . ////////////////////////////////////////////////////////////////////////////
2702
2703 .literal xml
2704 <!-- === Start of command line options === -->
2705 .literal off
2706
2707
2708 .vlist
2709 .vitem &%--%&
2710 .oindex "--"
2711 .cindex "options" "command line; terminating"
2712 This is a pseudo-option whose only purpose is to terminate the options and
2713 therefore to cause subsequent command line items to be treated as arguments
2714 rather than options, even if they begin with hyphens.
2715
2716 .vitem &%--help%&
2717 .oindex "&%--help%&"
2718 This option causes Exim to output a few sentences stating what it is.
2719 The same output is generated if the Exim binary is called with no options and
2720 no arguments.
2721
2722 .vitem &%--version%&
2723 .oindex "&%--version%&"
2724 This option is an alias for &%-bV%& and causes version information to be
2725 displayed.
2726
2727 .vitem &%-Ac%& &&&
2728        &%-Am%&
2729 .oindex "&%-Ac%&"
2730 .oindex "&%-Am%&"
2731 These options are used by Sendmail for selecting configuration files and are
2732 ignored by Exim.
2733
2734 .vitem &%-B%&<&'type'&>
2735 .oindex "&%-B%&"
2736 .cindex "8-bit characters"
2737 .cindex "Sendmail compatibility" "8-bit characters"
2738 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2739 clean; it ignores this option.
2740
2741 .vitem &%-bd%&
2742 .oindex "&%-bd%&"
2743 .cindex "daemon"
2744 .cindex "SMTP" "listener"
2745 .cindex "queue runner"
2746 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2747 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2748 that the daemon should also initiate periodic queue runs.
2749
2750 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2751 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2752 disconnect from the controlling terminal. When running this way, it can be
2753 stopped by pressing ctrl-C.
2754
2755 By default, Exim listens for incoming connections to the standard SMTP port on
2756 all the host's running interfaces. However, it is possible to listen on other
2757 ports, on multiple ports, and only on specific interfaces. Chapter
2758 &<<CHAPinterfaces>>& contains a description of the options that control this.
2759
2760 When a listening daemon
2761 .cindex "daemon" "process id (pid)"
2762 .cindex "pid (process id)" "of daemon"
2763 is started without the use of &%-oX%& (that is, without overriding the normal
2764 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2765 in Exim's spool directory. This location can be overridden by setting
2766 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2767 running as root.
2768
2769 When &%-oX%& is used on the command line to start a listening daemon, the
2770 process id is not written to the normal pid file path. However, &%-oP%& can be
2771 used to specify a path on the command line if a pid file is required.
2772
2773 The SIGHUP signal
2774 .cindex "SIGHUP"
2775 .cindex restart "on HUP signal"
2776 .cindex signal "HUP, to restart"
2777 .cindex "daemon" "restarting"
2778 .cindex signal "to reload configuration"
2779 .cindex daemon "reload configuration"
2780 .cindex reload configuration
2781 can be used to cause the daemon to re-execute itself. This should be done
2782 whenever Exim's configuration file, or any file that is incorporated into it by
2783 means of the &%.include%& facility, is changed, and also whenever a new version
2784 of Exim is installed. It is not necessary to do this when other files that are
2785 referenced from the configuration (for example, alias files) are changed,
2786 because these are reread each time they are used.
2787
2788 .vitem &%-bdf%&
2789 .oindex "&%-bdf%&"
2790 This option has the same effect as &%-bd%& except that it never disconnects
2791 from the controlling terminal, even when no debugging is specified.
2792
2793 .vitem &%-be%&
2794 .oindex "&%-be%&"
2795 .cindex "testing" "string expansion"
2796 .cindex "expansion" "testing"
2797 Run Exim in expansion testing mode. Exim discards its root privilege, to
2798 prevent ordinary users from using this mode to read otherwise inaccessible
2799 files. If no arguments are given, Exim runs interactively, prompting for lines
2800 of data. Otherwise, it processes each argument in turn.
2801
2802 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2803 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2804 used without command line arguments. If successful, it uses the &[readline()]&
2805 function, which provides extensive line-editing facilities, for reading the
2806 test data. A line history is supported.
2807
2808 Long expansion expressions can be split over several lines by using backslash
2809 continuations. As in Exim's runtime configuration, white space at the start of
2810 continuation lines is ignored. Each argument or data line is passed through the
2811 string expansion mechanism, and the result is output. Variable values from the
2812 configuration file (for example, &$qualify_domain$&) are available, but no
2813 message-specific values (such as &$message_exim_id$&) are set, because no message
2814 is being processed (but see &%-bem%& and &%-Mset%&).
2815
2816 &*Note*&: If you use this mechanism to test lookups, and you change the data
2817 files or databases you are using, you must exit and restart Exim before trying
2818 the same lookup again. Otherwise, because each Exim process caches the results
2819 of lookups, you will just get the same result as before.
2820
2821 Macro processing is done on lines before string-expansion: new macros can be
2822 defined and macros will be expanded.
2823 Because macros in the config file are often used for secrets, those are only
2824 available to admin users.
2825
2826 .vitem &%-bem%&&~<&'filename'&>
2827 .oindex "&%-bem%&"
2828 .cindex "testing" "string expansion"
2829 .cindex "expansion" "testing"
2830 This option operates like &%-be%& except that it must be followed by the name
2831 of a file. For example:
2832 .code
2833 exim -bem /tmp/testmessage
2834 .endd
2835 The file is read as a message (as if receiving a locally-submitted non-SMTP
2836 message) before any of the test expansions are done. Thus, message-specific
2837 variables such as &$message_size$& and &$header_from:$& are available. However,
2838 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2839 recipients are read from the headers in the normal way, and are shown in the
2840 &$recipients$& variable. Note that recipients cannot be given on the command
2841 line, because further arguments are taken as strings to expand (just like
2842 &%-be%&).
2843
2844 .vitem &%-bF%&&~<&'filename'&>
2845 .oindex "&%-bF%&"
2846 .cindex "system filter" "testing"
2847 .cindex "testing" "system filter"
2848 This option is the same as &%-bf%& except that it assumes that the filter being
2849 tested is a system filter. The additional commands that are available only in
2850 system filters are recognized.
2851
2852 .vitem &%-bf%&&~<&'filename'&>
2853 .oindex "&%-bf%&"
2854 .cindex "filter" "testing"
2855 .cindex "testing" "filter file"
2856 .cindex "forward file" "testing"
2857 .cindex "testing" "forward file"
2858 .cindex "Sieve filter" "testing"
2859 This option runs Exim in user filter testing mode; the file is the filter file
2860 to be tested, and a test message must be supplied on the standard input. If
2861 there are no message-dependent tests in the filter, an empty file can be
2862 supplied.
2863
2864 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2865 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2866 filter and a user filter in the same run. For example:
2867 .code
2868 exim -bF /system/filter -bf /user/filter </test/message
2869 .endd
2870 This is helpful when the system filter adds header lines or sets filter
2871 variables that are used by the user filter.
2872
2873 If the test filter file does not begin with one of the special lines
2874 .code
2875 # Exim filter
2876 # Sieve filter
2877 .endd
2878 it is taken to be a normal &_.forward_& file, and is tested for validity under
2879 that interpretation. See sections &<<SECTitenonfilred>>& to
2880 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2881 redirection lists.
2882
2883 The result of an Exim command that uses &%-bf%&, provided no errors are
2884 detected, is a list of the actions that Exim would try to take if presented
2885 with the message for real. More details of filter testing are given in the
2886 separate document entitled &'Exim's interfaces to mail filtering'&.
2887
2888 When testing a filter file,
2889 .cindex "&""From""& line"
2890 .cindex "envelope from"
2891 .cindex "envelope sender"
2892 .oindex "&%-f%&" "for filter testing"
2893 the envelope sender can be set by the &%-f%& option,
2894 or by a &"From&~"& line at the start of the test message. Various parameters
2895 that would normally be taken from the envelope recipient address of the message
2896 can be set by means of additional command line options (see the next four
2897 options).
2898
2899 .vitem &%-bfd%&&~<&'domain'&>
2900 .oindex "&%-bfd%&"
2901 .vindex "&$qualify_domain$&"
2902 This sets the domain of the recipient address when a filter file is being
2903 tested by means of the &%-bf%& option. The default is the value of
2904 &$qualify_domain$&.
2905
2906 .vitem &%-bfl%&&~<&'local&~part'&>
2907 .oindex "&%-bfl%&"
2908 This sets the local part of the recipient address when a filter file is being
2909 tested by means of the &%-bf%& option. The default is the username of the
2910 process that calls Exim. A local part should be specified with any prefix or
2911 suffix stripped, because that is how it appears to the filter when a message is
2912 actually being delivered.
2913
2914 .vitem &%-bfp%&&~<&'prefix'&>
2915 .oindex "&%-bfp%&"
2916 .cindex affix "filter testing"
2917 This sets the prefix of the local part of the recipient address when a filter
2918 file is being tested by means of the &%-bf%& option. The default is an empty
2919 prefix.
2920
2921 .vitem &%-bfs%&&~<&'suffix'&>
2922 .oindex "&%-bfs%&"
2923 .cindex affix "filter testing"
2924 This sets the suffix of the local part of the recipient address when a filter
2925 file is being tested by means of the &%-bf%& option. The default is an empty
2926 suffix.
2927
2928 .vitem &%-bh%&&~<&'IP&~address'&>
2929 .oindex "&%-bh%&"
2930 .cindex "testing" "incoming SMTP"
2931 .cindex "SMTP" "testing incoming"
2932 .cindex "testing" "relay control"
2933 .cindex "relaying" "testing configuration"
2934 .cindex "policy control" "testing"
2935 .cindex "debugging" "&%-bh%& option"
2936 This option runs a fake SMTP session as if from the given IP address, using the
2937 standard input and output. The IP address may include a port number at the end,
2938 after a full stop. For example:
2939 .code
2940 exim -bh 10.9.8.7.1234
2941 exim -bh fe80::a00:20ff:fe86:a061.5678
2942 .endd
2943 When an IPv6 address is given, it is converted into canonical form. In the case
2944 of the second example above, the value of &$sender_host_address$& after
2945 conversion to the canonical form is
2946 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2947
2948 Comments as to what is going on are written to the standard error file. These
2949 include lines beginning with &"LOG"& for anything that would have been logged.
2950 This facility is provided for testing configuration options for incoming
2951 messages, to make sure they implement the required policy. For example, you can
2952 test your relay controls using &%-bh%&.
2953
2954 &*Warning 1*&:
2955 .cindex "RFC 1413"
2956 You can test features of the configuration that rely on ident (RFC 1413)
2957 information by using the &%-oMt%& option. However, Exim cannot actually perform
2958 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2959 connection.
2960
2961 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2962 are also skipped when testing using &%-bh%&. If you want these callouts to
2963 occur, use &%-bhc%& instead.
2964
2965 Messages supplied during the testing session are discarded, and nothing is
2966 written to any of the real log files. There may be pauses when DNS (and other)
2967 lookups are taking place, and of course these may time out. The &%-oMi%& option
2968 can be used to specify a specific IP interface and port if this is important,
2969 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2970 session were authenticated.
2971
2972 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2973 output just states whether a given recipient address from a given host is
2974 acceptable or not. See section &<<SECTcheckaccess>>&.
2975
2976 Features such as authentication and encryption, where the client input is not
2977 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2978 specialized SMTP test program such as
2979 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2980
2981 .vitem &%-bhc%&&~<&'IP&~address'&>
2982 .oindex "&%-bhc%&"
2983 This option operates in the same way as &%-bh%&, except that address
2984 verification callouts are performed if required. This includes consulting and
2985 updating the callout cache database.
2986
2987 .vitem &%-bi%&
2988 .oindex "&%-bi%&"
2989 .cindex "alias file" "building"
2990 .cindex "building alias file"
2991 .cindex "Sendmail compatibility" "&%-bi%& option"
2992 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2993 Exim does not have the concept of a single alias file, and so it cannot mimic
2994 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2995 tend to appear in various scripts such as NIS make files, so the option must be
2996 recognized.
2997
2998 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2999 configuration option is run, under the uid and gid of the caller of Exim. If
3000 the &%-oA%& option is used, its value is passed to the command as an argument.
3001 The command set by &%bi_command%& may not contain arguments. The command can
3002 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3003 if this is required. If the &%bi_command%& option is not set, calling Exim with
3004 &%-bi%& is a no-op.
3005
3006 . // Keep :help first, then the rest in alphabetical order
3007 .vitem &%-bI:help%&
3008 .oindex "&%-bI:help%&"
3009 .cindex "querying exim information"
3010 We shall provide various options starting &`-bI:`& for querying Exim for
3011 information.  The output of many of these will be intended for machine
3012 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3013 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3014 options shall cause Exim to exit after producing the requested output.
3015
3016 .vitem &%-bI:dscp%&
3017 .oindex "&%-bI:dscp%&"
3018 .cindex "DSCP" "values"
3019 This option causes Exim to emit an alphabetically sorted list of all
3020 recognised DSCP names.
3021
3022 .vitem &%-bI:sieve%&
3023 .oindex "&%-bI:sieve%&"
3024 .cindex "Sieve filter" "capabilities"
3025 This option causes Exim to emit an alphabetically sorted list of all supported
3026 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3027 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3028 &`SIEVE`& capability response line.  As the precise list may depend upon
3029 compile-time build options, which this option will adapt to, this is the only
3030 way to guarantee a correct response.
3031
3032 .vitem &%-bm%&
3033 .oindex "&%-bm%&"
3034 .cindex "local message reception"
3035 This option runs an Exim receiving process that accepts an incoming,
3036 locally-generated message on the standard input. The recipients are given as the
3037 command arguments (except when &%-t%& is also present &-- see below). Each
3038 argument can be a comma-separated list of RFC 2822 addresses. This is the
3039 default option for selecting the overall action of an Exim call; it is assumed
3040 if no other conflicting option is present.
3041
3042 If any addresses in the message are unqualified (have no domain), they are
3043 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3044 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3045 suppressing this for special cases.
3046
3047 Policy checks on the contents of local messages can be enforced by means of
3048 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3049
3050 .cindex "return code" "for &%-bm%&"
3051 The return code is zero if the message is successfully accepted. Otherwise, the
3052 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3053
3054 The format
3055 .cindex "message" "format"
3056 .cindex "format" "message"
3057 .cindex "&""From""& line"
3058 .cindex "UUCP" "&""From""& line"
3059 .cindex "Sendmail compatibility" "&""From""& line"
3060 of the message must be as defined in RFC 2822, except that, for
3061 compatibility with Sendmail and Smail, a line in one of the forms
3062 .code
3063 From sender Fri Jan  5 12:55 GMT 1997
3064 From sender Fri, 5 Jan 97 12:55:01
3065 .endd
3066 (with the weekday optional, and possibly with additional text after the date)
3067 is permitted to appear at the start of the message. There appears to be no
3068 authoritative specification of the format of this line. Exim recognizes it by
3069 matching against the regular expression defined by the &%uucp_from_pattern%&
3070 option, which can be changed if necessary.
3071
3072 .oindex "&%-f%&" "overriding &""From""& line"
3073 The specified sender is treated as if it were given as the argument to the
3074 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3075 preference to the address taken from the message. The caller of Exim must be a
3076 trusted user for the sender of a message to be set in this way.
3077
3078 .vitem &%-bmalware%&&~<&'filename'&>
3079 .oindex "&%-bmalware%&"
3080 .cindex "testing", "malware"
3081 .cindex "malware scan test"
3082 This debugging option causes Exim to scan the given file or directory
3083 (depending on the used scanner interface),
3084 using the malware scanning framework.  The option of &%av_scanner%& influences
3085 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3086 the expansion should have defaults which apply to this invocation.  ACLs are
3087 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3088 will never be populated and &%-bmalware%& will fail.
3089
3090 Exim will have changed working directory before resolving the filename, so
3091 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3092 user when it tries to open the file, rather than as the invoking user.
3093 This option requires admin privileges.
3094
3095 The &%-bmalware%& option will not be extended to be more generally useful,
3096 there are better tools for file-scanning.  This option exists to help
3097 administrators verify their Exim and AV scanner configuration.
3098
3099 .vitem &%-bnq%&
3100 .oindex "&%-bnq%&"
3101 .cindex "address qualification, suppressing"
3102 By default, Exim automatically qualifies unqualified addresses (those
3103 without domains) that appear in messages that are submitted locally (that
3104 is, not over TCP/IP). This qualification applies both to addresses in
3105 envelopes, and addresses in header lines. Sender addresses are qualified using
3106 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3107 defaults to the value of &%qualify_domain%&).
3108
3109 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3110 being used to re-submit messages that originally came from remote hosts after
3111 content scanning, you probably do not want to qualify unqualified addresses in
3112 header lines. (Such lines will be present only if you have not enabled a header
3113 syntax check in the appropriate ACL.)
3114
3115 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3116 messages that originate on the local host. When this is used, unqualified
3117 addresses in the envelope provoke errors (causing message rejection) and
3118 unqualified addresses in header lines are left alone.
3119
3120
3121 .vitem &%-bP%&
3122 .oindex "&%-bP%&"
3123 .cindex "configuration options" "extracting"
3124 .cindex "options" "configuration &-- extracting"
3125 If this option is given with no arguments, it causes the values of all Exim's
3126 main configuration options to be written to the standard output. The values
3127 of one or more specific options can be requested by giving their names as
3128 arguments, for example:
3129 .code
3130 exim -bP qualify_domain hold_domains
3131 .endd
3132 .cindex "hiding configuration option values"
3133 .cindex "configuration options" "hiding value of"
3134 .cindex "options" "hiding value of"
3135 However, any option setting that is preceded by the word &"hide"& in the
3136 configuration file is not shown in full, except to an admin user. For other
3137 users, the output is as in this example:
3138 .code
3139 mysql_servers = <value not displayable>
3140 .endd
3141 If &%config%& is given as an argument, the config is
3142 output, as it was parsed, any include file resolved, any comment removed.
3143
3144 If &%config_file%& is given as an argument, the name of the runtime
3145 configuration file is output. (&%configure_file%& works too, for
3146 backward compatibility.)
3147 If a list of configuration files was supplied, the value that is output here
3148 is the name of the file that was actually used.
3149
3150 .cindex "options" "hiding name of"
3151 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3152 name will not be output.
3153
3154 .cindex "daemon" "process id (pid)"
3155 .cindex "pid (process id)" "of daemon"
3156 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3157 directories where log files and daemon pid files are written are output,
3158 respectively. If these values are unset, log files are written in a
3159 sub-directory of the spool directory called &%log%&, and the pid file is
3160 written directly into the spool directory.
3161
3162 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3163 .code
3164 exim -bP +local_domains
3165 .endd
3166 it searches for a matching named list of any type (domain, host, address, or
3167 local part) and outputs what it finds.
3168
3169 .cindex "options" "router &-- extracting"
3170 .cindex "options" "transport &-- extracting"
3171 .cindex "options" "authenticator &-- extracting"
3172 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3173 followed by the name of an appropriate driver instance, the option settings for
3174 that driver are output. For example:
3175 .code
3176 exim -bP transport local_delivery
3177 .endd
3178 The generic driver options are output first, followed by the driver's private
3179 options. A list of the names of drivers of a particular type can be obtained by
3180 using one of the words &%router_list%&, &%transport_list%&, or
3181 &%authenticator_list%&, and a complete list of all drivers with their option
3182 settings can be obtained by using &%routers%&, &%transports%&, or
3183 &%authenticators%&.
3184
3185 .cindex "environment"
3186 If &%environment%& is given as an argument, the set of environment
3187 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3188 variables.
3189
3190 .cindex "options" "macro &-- extracting"
3191 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3192 are available, similarly to the drivers.  Because macros are sometimes used
3193 for storing passwords, this option is restricted.
3194 The output format is one item per line.
3195 For the "-bP macro <name>" form, if no such macro is found
3196 the exit status will be nonzero.
3197
3198 .vitem &%-bp%&
3199 .oindex "&%-bp%&"
3200 .cindex "queue" "listing messages in"
3201 .cindex "listing" "messages in the queue"
3202 This option requests a listing of the contents of the mail queue on the
3203 standard output. If the &%-bp%& option is followed by a list of message ids,
3204 just those messages are listed. By default, this option can be used only by an
3205 admin user. However, the &%queue_list_requires_admin%& option can be set false
3206 to allow any user to see the queue.
3207
3208 Each message in the queue is displayed as in the following example:
3209 .code
3210 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3211           red.king@looking-glass.fict.example
3212           <other addresses>
3213 .endd
3214 .cindex "message" "size in queue listing"
3215 .cindex "size" "of message"
3216 The first line contains the length of time the message has been in the queue
3217 (in this case 25 minutes), the size of the message (2.9K), the unique local
3218 identifier for the message, and the message sender, as contained in the
3219 envelope. For bounce messages, the sender address is empty, and appears as
3220 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3221 the default sender address, the user's login name is shown in parentheses
3222 before the sender address.
3223
3224 .cindex "frozen messages" "in queue listing"
3225 If the message is frozen (attempts to deliver it are suspended) then the text
3226 &"*** frozen ***"& is displayed at the end of this line.
3227
3228 The recipients of the message (taken from the envelope, not the headers) are
3229 displayed on subsequent lines. Those addresses to which the message has already
3230 been delivered are marked with the letter D. If an original address gets
3231 expanded into several addresses via an alias or forward file, the original is
3232 displayed with a D only when deliveries for all of its child addresses are
3233 complete.
3234
3235
3236 .vitem &%-bpa%&
3237 .oindex "&%-bpa%&"
3238 This option operates like &%-bp%&, but in addition it shows delivered addresses
3239 that were generated from the original top level address(es) in each message by
3240 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3241 of just &"D"&.
3242
3243
3244 .vitem &%-bpc%&
3245 .oindex "&%-bpc%&"
3246 .cindex "queue" "count of messages on"
3247 This option counts the number of messages in the queue, and writes the total
3248 to the standard output. It is restricted to admin users, unless
3249 &%queue_list_requires_admin%& is set false.
3250
3251
3252 .vitem &%-bpr%&
3253 .oindex "&%-bpr%&"
3254 This option operates like &%-bp%&, but the output is not sorted into
3255 chronological order of message arrival. This can speed it up when there are
3256 lots of messages in the queue, and is particularly useful if the output is
3257 going to be post-processed in a way that doesn't need the sorting.
3258
3259 .vitem &%-bpra%&
3260 .oindex "&%-bpra%&"
3261 This option is a combination of &%-bpr%& and &%-bpa%&.
3262
3263 .vitem &%-bpru%&
3264 .oindex "&%-bpru%&"
3265 This option is a combination of &%-bpr%& and &%-bpu%&.
3266
3267
3268 .vitem &%-bpu%&
3269 .oindex "&%-bpu%&"
3270 This option operates like &%-bp%& but shows only undelivered top-level
3271 addresses for each message displayed. Addresses generated by aliasing or
3272 forwarding are not shown, unless the message was deferred after processing by a
3273 router with the &%one_time%& option set.
3274
3275
3276 .vitem &%-brt%&
3277 .oindex "&%-brt%&"
3278 .cindex "testing" "retry configuration"
3279 .cindex "retry" "configuration testing"
3280 This option is for testing retry rules, and it must be followed by up to three
3281 arguments. It causes Exim to look for a retry rule that matches the values
3282 and to write it to the standard output. For example:
3283 .code
3284 exim -brt bach.comp.mus.example
3285 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3286 .endd
3287 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3288 argument, which is required, can be a complete address in the form
3289 &'local_part@domain'&, or it can be just a domain name. If the second argument
3290 contains a dot, it is interpreted as an optional second domain name; if no
3291 retry rule is found for the first argument, the second is tried. This ties in
3292 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3293 rule is found that matches the host, one that matches the mail domain is
3294 sought. Finally, an argument that is the name of a specific delivery error, as
3295 used in setting up retry rules, can be given. For example:
3296 .code
3297 exim -brt haydn.comp.mus.example quota_3d
3298 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3299 .endd
3300
3301 .vitem &%-brw%&
3302 .oindex "&%-brw%&"
3303 .cindex "testing" "rewriting"
3304 .cindex "rewriting" "testing"
3305 This option is for testing address rewriting rules, and it must be followed by
3306 a single argument, consisting of either a local part without a domain, or a
3307 complete address with a fully qualified domain. Exim outputs how this address
3308 would be rewritten for each possible place it might appear. See chapter
3309 &<<CHAPrewrite>>& for further details.
3310
3311 .vitem &%-bS%&
3312 .oindex "&%-bS%&"
3313 .cindex "SMTP" "batched incoming"
3314 .cindex "batched SMTP input"
3315 This option is used for batched SMTP input, which is an alternative interface
3316 for non-interactive local message submission. A number of messages can be
3317 submitted in a single run. However, despite its name, this is not really SMTP
3318 input. Exim reads each message's envelope from SMTP commands on the standard
3319 input, but generates no responses. If the caller is trusted, or
3320 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3321 believed; otherwise the sender is always the caller of Exim.
3322
3323 The message itself is read from the standard input, in SMTP format (leading
3324 dots doubled), terminated by a line containing just a single dot. An error is
3325 provoked if the terminating dot is missing. A further message may then follow.
3326
3327 As for other local message submissions, the contents of incoming batch SMTP
3328 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3329 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3330 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3331
3332 Some other SMTP commands are recognized in the input. HELO and EHLO act
3333 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3334 QUIT quits, ignoring the rest of the standard input.
3335
3336 .cindex "return code" "for &%-bS%&"
3337 If any error is encountered, reports are written to the standard output and
3338 error streams, and Exim gives up immediately. The return code is 0 if no error
3339 was detected; it is 1 if one or more messages were accepted before the error
3340 was detected; otherwise it is 2.
3341
3342 More details of input using batched SMTP are given in section
3343 &<<SECTincomingbatchedSMTP>>&.
3344
3345 .vitem &%-bs%&
3346 .oindex "&%-bs%&"
3347 .cindex "SMTP" "local input"
3348 .cindex "local SMTP input"
3349 This option causes Exim to accept one or more messages by reading SMTP commands
3350 on the standard input, and producing SMTP replies on the standard output. SMTP
3351 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3352 Some user agents use this interface as a way of passing locally-generated
3353 messages to the MTA.
3354
3355 In
3356 .cindex "sender" "source of"
3357 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3358 set, the senders of messages are taken from the SMTP MAIL commands.
3359 Otherwise the content of these commands is ignored and the sender is set up as
3360 the calling user. Unqualified addresses are automatically qualified using
3361 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3362 &%-bnq%& option is used.
3363
3364 .cindex "inetd"
3365 The
3366 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3367 using a listening daemon. Exim can distinguish the two cases by checking
3368 whether the standard input is a TCP/IP socket. When Exim is called from
3369 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3370 above concerning senders and qualification do not apply. In this situation,
3371 Exim behaves in exactly the same way as it does when receiving a message via
3372 the listening daemon.
3373
3374 .vitem &%-bt%&
3375 .oindex "&%-bt%&"
3376 .cindex "testing" "addresses"
3377 .cindex "address" "testing"
3378 This option runs Exim in address testing mode, in which each argument is taken
3379 as a recipient address to be tested for deliverability. The results are
3380 written to the standard output. If a test fails, and the caller is not an admin
3381 user, no details of the failure are output, because these might contain
3382 sensitive information such as usernames and passwords for database lookups.
3383
3384 If no arguments are given, Exim runs in an interactive manner, prompting with a
3385 right angle bracket for addresses to be tested.
3386
3387 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3388 &[readline()]& function, because it is running as &'root'& and there are
3389 security issues.
3390
3391 Each address is handled as if it were the recipient address of a message
3392 (compare the &%-bv%& option). It is passed to the routers and the result is
3393 written to the standard output. However, any router that has
3394 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3395 genuine routing tests if your first router passes everything to a scanner
3396 program.
3397
3398 .cindex "return code" "for &%-bt%&"
3399 The return code is 2 if any address failed outright; it is 1 if no address
3400 failed outright but at least one could not be resolved for some reason. Return
3401 code 0 is given only when all addresses succeed.
3402
3403 .cindex "duplicate addresses"
3404 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3405 addresses after routing is complete, so that only one delivery takes place.
3406 This does not happen when testing with &%-bt%&; the full results of routing are
3407 always shown.
3408
3409 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3410 routers in the configuration makes any tests on the sender address of a
3411 message,
3412 .oindex "&%-f%&" "for address testing"
3413 you can use the &%-f%& option to set an appropriate sender when running
3414 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3415 default qualifying domain. However, if you have set up (for example) routers
3416 whose behaviour depends on the contents of an incoming message, you cannot test
3417 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3418 doing such tests.
3419
3420 .vitem &%-bV%&
3421 .oindex "&%-bV%&"
3422 .cindex "version number of Exim"
3423 This option causes Exim to write the current version number, compilation
3424 number, and compilation date of the &'exim'& binary to the standard output.
3425 It also lists the DBM library that is being used, the optional modules (such as
3426 specific lookup types), the drivers that are included in the binary, and the
3427 name of the runtime configuration file that is in use.
3428
3429 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3430 configuration file. However, this is a static check only. It cannot check
3431 values that are to be expanded. For example, although a misspelt ACL verb is
3432 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3433 alone to discover (for example) all the typos in the configuration; some
3434 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3435 dynamic testing facilities.
3436
3437 .vitem &%-bv%&
3438 .oindex "&%-bv%&"
3439 .cindex "verifying address" "using &%-bv%&"
3440 .cindex "address" "verification"
3441 This option runs Exim in address verification mode, in which each argument is
3442 taken as a recipient address to be verified by the routers. (This does
3443 not involve any verification callouts). During normal operation, verification
3444 happens mostly as a consequence processing a &%verify%& condition in an ACL
3445 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3446 including callouts, see the &%-bh%& and &%-bhc%& options.
3447
3448 If verification fails, and the caller is not an admin user, no details of the
3449 failure are output, because these might contain sensitive information such as
3450 usernames and passwords for database lookups.
3451
3452 If no arguments are given, Exim runs in an interactive manner, prompting with a
3453 right angle bracket for addresses to be verified.
3454
3455 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3456 &[readline()]& function, because it is running as &'exim'& and there are
3457 security issues.
3458
3459 Verification differs from address testing (the &%-bt%& option) in that routers
3460 that have &%no_verify%& set are skipped, and if the address is accepted by a
3461 router that has &%fail_verify%& set, verification fails. The address is
3462 verified as a recipient if &%-bv%& is used; to test verification for a sender
3463 address, &%-bvs%& should be used.
3464
3465 If the &%-v%& option is not set, the output consists of a single line for each
3466 address, stating whether it was verified or not, and giving a reason in the
3467 latter case. Without &%-v%&, generating more than one address by redirection
3468 causes verification to end successfully, without considering the generated
3469 addresses. However, if just one address is generated, processing continues,
3470 and the generated address must verify successfully for the overall verification
3471 to succeed.
3472
3473 When &%-v%& is set, more details are given of how the address has been handled,
3474 and in the case of address redirection, all the generated addresses are also
3475 considered. Verification may succeed for some and fail for others.
3476
3477 The
3478 .cindex "return code" "for &%-bv%&"
3479 return code is 2 if any address failed outright; it is 1 if no address
3480 failed outright but at least one could not be resolved for some reason. Return
3481 code 0 is given only when all addresses succeed.
3482
3483 If any of the routers in the configuration makes any tests on the sender
3484 address of a message, you should use the &%-f%& option to set an appropriate
3485 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3486 calling user at the default qualifying domain.
3487
3488 .vitem &%-bvs%&
3489 .oindex "&%-bvs%&"
3490 This option acts like &%-bv%&, but verifies the address as a sender rather
3491 than a recipient address. This affects any rewriting and qualification that
3492 might happen.
3493
3494 .vitem &%-bw%&
3495 .oindex "&%-bw%&"
3496 .cindex "daemon"
3497 .cindex "inetd"
3498 .cindex "inetd" "wait mode"
3499 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3500 similarly to the &%-bd%& option.  All port specifications on the command-line
3501 and in the configuration file are ignored.  Queue-running may not be specified.
3502
3503 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3504 listening for connections.  This permits the system to start up and have
3505 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3506 each port only when the first connection is received.
3507
3508 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3509 which the daemon will exit, which should cause inetd to listen once more.
3510
3511 .vitem &%-C%&&~<&'filelist'&>
3512 .oindex "&%-C%&"
3513 .cindex "configuration file" "alternate"
3514 .cindex "CONFIGURE_FILE"
3515 .cindex "alternate configuration file"
3516 This option causes Exim to find the runtime configuration file from the given
3517 list instead of from the list specified by the CONFIGURE_FILE
3518 compile-time setting. Usually, the list will consist of just a single filename,
3519 but it can be a colon-separated list of names. In this case, the first
3520 file that exists is used. Failure to open an existing file stops Exim from
3521 proceeding any further along the list, and an error is generated.
3522
3523 When this option is used by a caller other than root, and the list is different
3524 from the compiled-in list, Exim gives up its root privilege immediately, and
3525 runs with the real and effective uid and gid set to those of the caller.
3526 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3527 file contains a list of full pathnames, one per line, for configuration files
3528 which are trusted. Root privilege is retained for any configuration file so
3529 listed, as long as the caller is the Exim user (or the user specified in the
3530 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3531 not writeable by inappropriate users or groups.
3532
3533 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3534 configuration using &%-C%& right through message reception and delivery,
3535 even if the caller is root. The reception works, but by that time, Exim is
3536 running as the Exim user, so when it re-executes to regain privilege for the
3537 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3538 test reception and delivery using two separate commands (one to put a message
3539 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3540
3541 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3542 prefix string with which any file named in a &%-C%& command line option
3543 must start. In addition, the filename must not contain the sequence &`/../`&.
3544 However, if the value of the &%-C%& option is identical to the value of
3545 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3546 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3547 unset, any filename can be used with &%-C%&.
3548
3549 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3550 to a directory to which only root has access. This prevents someone who has
3551 broken into the Exim account from running a privileged Exim with an arbitrary
3552 configuration file.
3553
3554 The &%-C%& facility is useful for ensuring that configuration files are
3555 syntactically correct, but cannot be used for test deliveries, unless the
3556 caller is privileged, or unless it is an exotic configuration that does not
3557 require privilege. No check is made on the owner or group of the files
3558 specified by this option.
3559
3560
3561 .vitem &%-D%&<&'macro'&>=<&'value'&>
3562 .oindex "&%-D%&"
3563 .cindex "macro" "setting on command line"
3564 This option can be used to override macro definitions in the configuration file
3565 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3566 unprivileged caller, it causes Exim to give up its root privilege.
3567 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3568 completely disabled, and its use causes an immediate error exit.
3569
3570 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3571 colon-separated list of macros which are considered safe and, if &%-D%& only
3572 supplies macros from this list, and the values are acceptable, then Exim will
3573 not give up root privilege if the caller is root, the Exim run-time user, or
3574 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3575 to be removed in the future.  Acceptable values for the macros satisfy the
3576 regexp: &`^[A-Za-z0-9_/.-]*$`&
3577
3578 The entire option (including equals sign if present) must all be within one
3579 command line item. &%-D%& can be used to set the value of a macro to the empty
3580 string, in which case the equals sign is optional. These two commands are
3581 synonymous:
3582 .code
3583 exim -DABC  ...
3584 exim -DABC= ...
3585 .endd
3586 To include spaces in a macro definition item, quotes must be used. If you use
3587 quotes, spaces are permitted around the macro name and the equals sign. For
3588 example:
3589 .code
3590 exim '-D ABC = something' ...
3591 .endd
3592 &%-D%& may be repeated up to 10 times on a command line.
3593 Only macro names up to 22 letters long can be set.
3594
3595
3596 .vitem &%-d%&<&'debug&~options'&>
3597 .oindex "&%-d%&"
3598 .cindex "debugging" "list of selectors"
3599 .cindex "debugging" "&%-d%& option"
3600 This option causes debugging information to be written to the standard
3601 error stream. It is restricted to admin users because debugging output may show
3602 database queries that contain password information. Also, the details of users'
3603 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3604 writes an error message to the standard error stream and exits with a non-zero
3605 return code.
3606
3607 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3608 standard debugging data is output. This can be reduced, or increased to include
3609 some more rarely needed information, by directly following &%-d%& with a string
3610 made up of names preceded by plus or minus characters. These add or remove sets
3611 of debugging data, respectively. For example, &%-d+filter%& adds filter
3612 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3613 no spaces are allowed in the debug setting. The available debugging categories
3614 are:
3615 .display
3616 &`acl            `& ACL interpretation
3617 &`auth           `& authenticators
3618 &`deliver        `& general delivery logic
3619 &`dns            `& DNS lookups (see also resolver)
3620 &`dnsbl          `& DNS black list (aka RBL) code
3621 &`exec           `& arguments for &[execv()]& calls
3622 &`expand         `& detailed debugging for string expansions
3623 &`filter         `& filter handling
3624 &`hints_lookup   `& hints data lookups
3625 &`host_lookup    `& all types of name-to-IP address handling
3626 &`ident          `& ident lookup
3627 &`interface      `& lists of local interfaces
3628 &`lists          `& matching things in lists
3629 &`load           `& system load checks
3630 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3631                     &<<CHAPlocalscan>>&)
3632 &`lookup         `& general lookup code and all lookups
3633 &`memory         `& memory handling
3634 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3635 &`pid            `& modifier: add pid to debug output lines
3636 &`process_info   `& setting info for the process log
3637 &`queue_run      `& queue runs
3638 &`receive        `& general message reception logic
3639 &`resolver       `& turn on the DNS resolver's debugging output
3640 &`retry          `& retry handling
3641 &`rewrite        `& address rewriting
3642 &`route          `& address routing
3643 &`timestamp      `& modifier: add timestamp to debug output lines
3644 &`tls            `& TLS logic
3645 &`transport      `& transports
3646 &`uid            `& changes of uid/gid and looking up uid/gid
3647 &`verify         `& address verification logic
3648 &`all            `& almost all of the above (see below), and also &%-v%&
3649 .endd
3650 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3651 for &`-all`&. The reason for this is that &`+all`& is something that people
3652 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3653 is included, an awful lot of output that is very rarely of interest is
3654 generated, so it now has to be explicitly requested. However, &`-all`& does
3655 turn everything off.
3656
3657 .cindex "resolver, debugging output"
3658 .cindex "DNS resolver, debugging output"
3659 The &`resolver`& option produces output only if the DNS resolver was compiled
3660 with DEBUG enabled. This is not the case in some operating systems. Also,
3661 unfortunately, debugging output from the DNS resolver is written to stdout
3662 rather than stderr.
3663
3664 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3665 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3666 However, the &`pid`& selector is forced when debugging is turned on for a
3667 daemon, which then passes it on to any re-executed Exims. Exim also
3668 automatically adds the pid to debug lines when several remote deliveries are
3669 run in parallel.
3670
3671 The &`timestamp`& selector causes the current time to be inserted at the start
3672 of all debug output lines. This can be useful when trying to track down delays
3673 in processing.
3674
3675 .cindex debugging "UTF-8 in"
3676 .cindex UTF-8 "in debug output"
3677 The &`noutf8`& selector disables the use of
3678 UTF-8 line-drawing characters to group related information.
3679 When disabled. ascii-art is used instead.
3680 Using the &`+all`& option does not set this modifier,
3681
3682 If the &%debug_print%& option is set in any driver, it produces output whenever
3683 any debugging is selected, or if &%-v%& is used.
3684
3685 .vitem &%-dd%&<&'debug&~options'&>
3686 .oindex "&%-dd%&"
3687 This option behaves exactly like &%-d%& except when used on a command that
3688 starts a daemon process. In that case, debugging is turned off for the
3689 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3690 behaviour of the daemon without creating as much output as full debugging does.
3691
3692 .vitem &%-dropcr%&
3693 .oindex "&%-dropcr%&"
3694 This is an obsolete option that is now a no-op. It used to affect the way Exim
3695 handled CR and LF characters in incoming messages. What happens now is
3696 described in section &<<SECTlineendings>>&.
3697
3698 .vitem &%-E%&
3699 .oindex "&%-E%&"
3700 .cindex "bounce message" "generating"
3701 This option specifies that an incoming message is a locally-generated delivery
3702 failure report. It is used internally by Exim when handling delivery failures
3703 and is not intended for external use. Its only effect is to stop Exim
3704 generating certain messages to the postmaster, as otherwise message cascades
3705 could occur in some situations. As part of the same option, a message id may
3706 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3707 new message contains the id, following &"R="&, as a cross-reference.
3708
3709 .vitem &%-e%&&'x'&
3710 .oindex "&%-e%&&'x'&"
3711 There are a number of Sendmail options starting with &%-oe%& which seem to be
3712 called by various programs without the leading &%o%& in the option. For
3713 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3714 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3715
3716 .vitem &%-F%&&~<&'string'&>
3717 .oindex "&%-F%&"
3718 .cindex "sender" "name"
3719 .cindex "name" "of sender"
3720 This option sets the sender's full name for use when a locally-generated
3721 message is being accepted. In the absence of this option, the user's &'gecos'&
3722 entry from the password data is used. As users are generally permitted to alter
3723 their &'gecos'& entries, no security considerations are involved. White space
3724 between &%-F%& and the <&'string'&> is optional.
3725
3726 .vitem &%-f%&&~<&'address'&>
3727 .oindex "&%-f%&"
3728 .cindex "sender" "address"
3729 .cindex "address" "sender"
3730 .cindex "trusted users"
3731 .cindex "envelope from"
3732 .cindex "envelope sender"
3733 .cindex "user" "trusted"
3734 This option sets the address of the envelope sender of a locally-generated
3735 message (also known as the return path). The option can normally be used only
3736 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3737 users to use it.
3738
3739 Processes running as root or the Exim user are always trusted. Other
3740 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3741 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3742 of a local message is set to the caller's login name at the default qualify
3743 domain.
3744
3745 There is one exception to the restriction on the use of &%-f%&: an empty sender
3746 can be specified by any user, trusted or not, to create a message that can
3747 never provoke a bounce. An empty sender can be specified either as an empty
3748 string, or as a pair of angle brackets with nothing between them, as in these
3749 examples of shell commands:
3750 .code
3751 exim -f '<>' user@domain
3752 exim -f "" user@domain
3753 .endd
3754 In addition, the use of &%-f%& is not restricted when testing a filter file
3755 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3756 &%-bv%& options.
3757
3758 Allowing untrusted users to change the sender address does not of itself make
3759 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3760 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3761 though this can be overridden by setting &%no_local_from_check%&.
3762
3763 White
3764 .cindex "&""From""& line"
3765 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3766 given as two arguments or one combined argument). The sender of a
3767 locally-generated message can also be set (when permitted) by an initial
3768 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3769 if &%-f%& is also present, it overrides &"From&~"&.
3770
3771 .vitem &%-G%&
3772 .oindex "&%-G%&"
3773 .cindex "submission fixups, suppressing (command-line)"
3774 This option is equivalent to an ACL applying:
3775 .code
3776 control = suppress_local_fixups
3777 .endd
3778 for every message received.  Note that Sendmail will complain about such
3779 bad formatting, where Exim silently just does not fix it up.  This may change
3780 in future.
3781
3782 As this affects audit information, the caller must be a trusted user to use
3783 this option.
3784
3785 .vitem &%-h%&&~<&'number'&>
3786 .oindex "&%-h%&"
3787 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3788 This option is accepted for compatibility with Sendmail, but has no effect. (In
3789 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3790 headers.)
3791
3792 .vitem &%-i%&
3793 .oindex "&%-i%&"
3794 .cindex "Solaris" "&'mail'& command"
3795 .cindex "dot" "in incoming non-SMTP message"
3796 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3797 line by itself should not terminate an incoming, non-SMTP message. I can find
3798 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3799 command in Solaris 2.4 uses it. See also &%-ti%&.
3800
3801 .vitem &%-L%&&~<&'tag'&>
3802 .oindex "&%-L%&"
3803 .cindex "syslog" "process name; set with flag"
3804 This option is equivalent to setting &%syslog_processname%& in the config
3805 file and setting &%log_file_path%& to &`syslog`&.
3806 Its use is restricted to administrators.  The configuration file has to be
3807 read and parsed, to determine access rights, before this is set and takes
3808 effect, so early configuration file errors will not honour this flag.
3809
3810 The tag should not be longer than 32 characters.
3811
3812 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3813 .oindex "&%-M%&"
3814 .cindex "forcing delivery"
3815 .cindex "delivery" "forcing attempt"
3816 .cindex "frozen messages" "forcing delivery"
3817 This option requests Exim to run a delivery attempt on each message in turn. If
3818 any of the messages are frozen, they are automatically thawed before the
3819 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3820 and &%hold_domains%& are ignored.
3821
3822 Retry
3823 .cindex "hints database" "overriding retry hints"
3824 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3825 the normal retry time has not yet been reached. This option requires the caller
3826 to be an admin user. However, there is an option called &%prod_requires_admin%&
3827 which can be set false to relax this restriction (and also the same requirement
3828 for the &%-q%&, &%-R%&, and &%-S%& options).
3829
3830 The deliveries happen synchronously, that is, the original Exim process does
3831 not terminate until all the delivery attempts have finished. No output is
3832 produced unless there is a serious error. If you want to see what is happening,
3833 use the &%-v%& option as well, or inspect Exim's main log.
3834
3835 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3836 .oindex "&%-Mar%&"
3837 .cindex "message" "adding recipients"
3838 .cindex "recipient" "adding"
3839 This option requests Exim to add the addresses to the list of recipients of the
3840 message (&"ar"& for &"add recipients"&). The first argument must be a message
3841 id, and the remaining ones must be email addresses. However, if the message is
3842 active (in the middle of a delivery attempt), it is not altered. This option
3843 can be used only by an admin user.
3844
3845 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3846         &~<&'message&~id'&>"
3847 .oindex "&%-MC%&"
3848 .cindex "SMTP" "passed connection"
3849 .cindex "SMTP" "multiple deliveries"
3850 .cindex "multiple SMTP deliveries"
3851 This option is not intended for use by external callers. It is used internally
3852 by Exim to invoke another instance of itself to deliver a waiting message using
3853 an existing SMTP connection, which is passed as the standard input. Details are
3854 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3855 must be root or the Exim user in order to use it.
3856
3857 .vitem &%-MCA%&
3858 .oindex "&%-MCA%&"
3859 This option is not intended for use by external callers. It is used internally
3860 by Exim in conjunction with the &%-MC%& option. It signifies that the
3861 connection to the remote host has been authenticated.
3862
3863 .vitem &%-MCD%&
3864 .oindex "&%-MCD%&"
3865 This option is not intended for use by external callers. It is used internally
3866 by Exim in conjunction with the &%-MC%& option. It signifies that the
3867 remote host supports the ESMTP &_DSN_& extension.
3868
3869 .vitem &%-MCG%&&~<&'queue&~name'&>
3870 .oindex "&%-MCG%&"
3871 This option is not intended for use by external callers. It is used internally
3872 by Exim in conjunction with the &%-MC%& option. It signifies that an
3873 alternate queue is used, named by the following argument.
3874
3875 .vitem &%-MCK%&
3876 .oindex "&%-MCK%&"
3877 This option is not intended for use by external callers. It is used internally
3878 by Exim in conjunction with the &%-MC%& option. It signifies that a
3879 remote host supports the ESMTP &_CHUNKING_& extension.
3880
3881 .vitem &%-MCP%&
3882 .oindex "&%-MCP%&"
3883 This option is not intended for use by external callers. It is used internally
3884 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3885 which Exim is connected supports pipelining.
3886
3887 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3888 .oindex "&%-MCQ%&"
3889 This option is not intended for use by external callers. It is used internally
3890 by Exim in conjunction with the &%-MC%& option when the original delivery was
3891 started by a queue runner. It passes on the process id of the queue runner,
3892 together with the file descriptor number of an open pipe. Closure of the pipe
3893 signals the final completion of the sequence of processes that are passing
3894 messages through the same SMTP connection.
3895
3896 .vitem &%-MCS%&
3897 .oindex "&%-MCS%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3900 SMTP SIZE option should be used on messages delivered down the existing
3901 connection.
3902
3903 .vitem &%-MCT%&
3904 .oindex "&%-MCT%&"
3905 This option is not intended for use by external callers. It is used internally
3906 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3907 host to which Exim is connected supports TLS encryption.
3908
3909 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3910 .oindex "&%-MCt%&"
3911 This option is not intended for use by external callers. It is used internally
3912 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3913 connection is being proxied by a parent process for handling TLS encryption.
3914 The arguments give the local address and port being proxied, and the TLS cipher.
3915
3916 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3917 .oindex "&%-Mc%&"
3918 .cindex "hints database" "not overridden by &%-Mc%&"
3919 .cindex "delivery" "manually started &-- not forced"
3920 This option requests Exim to run a delivery attempt on each message, in turn,
3921 but unlike the &%-M%& option, it does check for retry hints, and respects any
3922 that are found. This option is not very useful to external callers. It is
3923 provided mainly for internal use by Exim when it needs to re-invoke itself in
3924 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3925 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3926 respects retry times and other options such as &%hold_domains%& that are
3927 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3928 If you want to run a specific delivery as if in a queue run, you should use
3929 &%-q%& with a message id argument. A distinction between queue run deliveries
3930 and other deliveries is made in one or two places.
3931
3932 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3933 .oindex "&%-Mes%&"
3934 .cindex "message" "changing sender"
3935 .cindex "sender" "changing"
3936 This option requests Exim to change the sender address in the message to the
3937 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3938 &"edit sender"&). There must be exactly two arguments. The first argument must
3939 be a message id, and the second one an email address. However, if the message
3940 is active (in the middle of a delivery attempt), its status is not altered.
3941 This option can be used only by an admin user.
3942
3943 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3944 .oindex "&%-Mf%&"
3945 .cindex "freezing messages"
3946 .cindex "message" "manually freezing"
3947 This option requests Exim to mark each listed message as &"frozen"&. This
3948 prevents any delivery attempts taking place until the message is &"thawed"&,
3949 either manually or as a result of the &%auto_thaw%& configuration option.
3950 However, if any of the messages are active (in the middle of a delivery
3951 attempt), their status is not altered. This option can be used only by an admin
3952 user.
3953
3954 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3955 .oindex "&%-Mg%&"
3956 .cindex "giving up on messages"
3957 .cindex "message" "abandoning delivery attempts"
3958 .cindex "delivery" "abandoning further attempts"
3959 This option requests Exim to give up trying to deliver the listed messages,
3960 including any that are frozen. However, if any of the messages are active,
3961 their status is not altered. For non-bounce messages, a delivery error message
3962 is sent to the sender, containing the text &"cancelled by administrator"&.
3963 Bounce messages are just discarded. This option can be used only by an admin
3964 user.
3965
3966 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3967 .oindex "&%-MG%&"
3968 .cindex queue named
3969 .cindex "named queues" "moving messages"
3970 .cindex "queue" "moving messages"
3971 This option requests that each listed message be moved from its current
3972 queue to the given named queue.
3973 The destination queue name argument is required, but can be an empty
3974 string to define the default queue.
3975 If the messages are not currently located in the default queue,
3976 a &%-qG<name>%& option will be required to define the source queue.
3977
3978 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3979 .oindex "&%-Mmad%&"
3980 .cindex "delivery" "cancelling all"
3981 This option requests Exim to mark all the recipient addresses in the messages
3982 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3983 message is active (in the middle of a delivery attempt), its status is not
3984 altered. This option can be used only by an admin user.
3985
3986 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3987 .oindex "&%-Mmd%&"
3988 .cindex "delivery" "cancelling by address"
3989 .cindex "recipient" "removing"
3990 .cindex "removing recipients"
3991 This option requests Exim to mark the given addresses as already delivered
3992 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3993 the remaining ones must be email addresses. These are matched to recipient
3994 addresses in the message in a case-sensitive manner. If the message is active
3995 (in the middle of a delivery attempt), its status is not altered. This option
3996 can be used only by an admin user.
3997
3998 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3999 .oindex "&%-Mrm%&"
4000 .cindex "removing messages"
4001 .cindex "abandoning mail"
4002 .cindex "message" "manually discarding"
4003 This option requests Exim to remove the given messages from the queue. No
4004 bounce messages are sent; each message is simply forgotten. However, if any of
4005 the messages are active, their status is not altered. This option can be used
4006 only by an admin user or by the user who originally caused the message to be
4007 placed in the queue.
4008
4009 . .new
4010 . .vitem &%-MS%&
4011 . .oindex "&%-MS%&"
4012 . .cindex REQUIRETLS
4013 . This option is used to request REQUIRETLS processing on the message.
4014 . It is used internally by Exim in conjunction with -E when generating
4015 . a bounce message.
4016 . .wen
4017
4018 .vitem &%-Mset%&&~<&'message&~id'&>
4019 .oindex "&%-Mset%&"
4020 .cindex "testing" "string expansion"
4021 .cindex "expansion" "testing"
4022 This option is useful only in conjunction with &%-be%& (that is, when testing
4023 string expansions). Exim loads the given message from its spool before doing
4024 the test expansions, thus setting message-specific variables such as
4025 &$message_size$& and the header variables. The &$recipients$& variable is made
4026 available. This feature is provided to make it easier to test expansions that
4027 make use of these variables. However, this option can be used only by an admin
4028 user. See also &%-bem%&.
4029
4030 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4031 .oindex "&%-Mt%&"
4032 .cindex "thawing messages"
4033 .cindex "unfreezing messages"
4034 .cindex "frozen messages" "thawing"
4035 .cindex "message" "thawing frozen"
4036 This option requests Exim to &"thaw"& any of the listed messages that are
4037 &"frozen"&, so that delivery attempts can resume. However, if any of the
4038 messages are active, their status is not altered. This option can be used only
4039 by an admin user.
4040
4041 .vitem &%-Mvb%&&~<&'message&~id'&>
4042 .oindex "&%-Mvb%&"
4043 .cindex "listing" "message body"
4044 .cindex "message" "listing body of"
4045 This option causes the contents of the message body (-D) spool file to be
4046 written to the standard output. This option can be used only by an admin user.
4047
4048 .vitem &%-Mvc%&&~<&'message&~id'&>
4049 .oindex "&%-Mvc%&"
4050 .cindex "message" "listing in RFC 2822 format"
4051 .cindex "listing" "message in RFC 2822 format"
4052 This option causes a copy of the complete message (header lines plus body) to
4053 be written to the standard output in RFC 2822 format. This option can be used
4054 only by an admin user.
4055
4056 .vitem &%-Mvh%&&~<&'message&~id'&>
4057 .oindex "&%-Mvh%&"
4058 .cindex "listing" "message headers"
4059 .cindex "header lines" "listing"
4060 .cindex "message" "listing header lines"
4061 This option causes the contents of the message headers (-H) spool file to be
4062 written to the standard output. This option can be used only by an admin user.
4063
4064 .vitem &%-Mvl%&&~<&'message&~id'&>
4065 .oindex "&%-Mvl%&"
4066 .cindex "listing" "message log"
4067 .cindex "message" "listing message log"
4068 This option causes the contents of the message log spool file to be written to
4069 the standard output. This option can be used only by an admin user.
4070
4071 .vitem &%-m%&
4072 .oindex "&%-m%&"
4073 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4074 treats it that way too.
4075
4076 .vitem &%-N%&
4077 .oindex "&%-N%&"
4078 .cindex "debugging" "&%-N%& option"
4079 .cindex "debugging" "suppressing delivery"
4080 This is a debugging option that inhibits delivery of a message at the transport
4081 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4082 it just doesn't actually transport the message, but instead behaves as if it
4083 had successfully done so. However, it does not make any updates to the retry
4084 database, and the log entries for deliveries are flagged with &"*>"& rather
4085 than &"=>"&.
4086
4087 Because &%-N%& discards any message to which it applies, only root or the Exim
4088 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4089 words, an ordinary user can use it only when supplying an incoming message to
4090 which it will apply. Although transportation never fails when &%-N%& is set, an
4091 address may be deferred because of a configuration problem on a transport, or a
4092 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4093 the message, and applies to any subsequent delivery attempts that may happen
4094 for that message.
4095
4096 .vitem &%-n%&
4097 .oindex "&%-n%&"
4098 This option is interpreted by Sendmail to mean &"no aliasing"&.
4099 For normal modes of operation, it is ignored by Exim.
4100 When combined with &%-bP%& it makes the output more terse (suppresses
4101 option names, environment values and config pretty printing).
4102
4103 .vitem &%-O%&&~<&'data'&>
4104 .oindex "&%-O%&"
4105 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4106 Exim.
4107
4108 .vitem &%-oA%&&~<&'file&~name'&>
4109 .oindex "&%-oA%&"
4110 .cindex "Sendmail compatibility" "&%-oA%& option"
4111 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4112 alternative alias filename. Exim handles &%-bi%& differently; see the
4113 description above.
4114
4115 .vitem &%-oB%&&~<&'n'&>
4116 .oindex "&%-oB%&"
4117 .cindex "SMTP" "passed connection"
4118 .cindex "SMTP" "multiple deliveries"
4119 .cindex "multiple SMTP deliveries"
4120 This is a debugging option which limits the maximum number of messages that can
4121 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4122 transport. If <&'n'&> is omitted, the limit is set to 1.
4123
4124 .vitem &%-odb%&
4125 .oindex "&%-odb%&"
4126 .cindex "background delivery"
4127 .cindex "delivery" "in the background"
4128 This option applies to all modes in which Exim accepts incoming messages,
4129 including the listening daemon. It requests &"background"& delivery of such
4130 messages, which means that the accepting process automatically starts a
4131 delivery process for each message received, but does not wait for the delivery
4132 processes to finish.
4133
4134 When all the messages have been received, the reception process exits,
4135 leaving the delivery processes to finish in their own time. The standard output
4136 and error streams are closed at the start of each delivery process.
4137 This is the default action if none of the &%-od%& options are present.
4138
4139 If one of the queueing options in the configuration file
4140 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4141 overrides it if &%queue_only_override%& is set true, which is the default
4142 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4143
4144 .vitem &%-odf%&
4145 .oindex "&%-odf%&"
4146 .cindex "foreground delivery"
4147 .cindex "delivery" "in the foreground"
4148 This option requests &"foreground"& (synchronous) delivery when Exim has
4149 accepted a locally-generated message. (For the daemon it is exactly the same as
4150 &%-odb%&.) A delivery process is automatically started to deliver the message,
4151 and Exim waits for it to complete before proceeding.
4152
4153 The original Exim reception process does not finish until the delivery
4154 process for the final message has ended. The standard error stream is left open
4155 during deliveries.
4156
4157 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4158 false and one of the queueing options in the configuration file is in effect.
4159
4160 If there is a temporary delivery error during foreground delivery, the
4161 message is left in the queue for later delivery, and the original reception
4162 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4163 restricted configuration that never queues messages.
4164
4165
4166 .vitem &%-odi%&
4167 .oindex "&%-odi%&"
4168 This option is synonymous with &%-odf%&. It is provided for compatibility with
4169 Sendmail.
4170
4171 .vitem &%-odq%&
4172 .oindex "&%-odq%&"
4173 .cindex "non-immediate delivery"
4174 .cindex "delivery" "suppressing immediate"
4175 .cindex "queueing incoming messages"
4176 This option applies to all modes in which Exim accepts incoming messages,
4177 including the listening daemon. It specifies that the accepting process should
4178 not automatically start a delivery process for each message received. Messages
4179 are placed in the queue, and remain there until a subsequent queue runner
4180 process encounters them. There are several configuration options (such as
4181 &%queue_only%&) that can be used to queue incoming messages under certain
4182 conditions. This option overrides all of them and also &%-odqs%&. It always
4183 forces queueing.
4184
4185 .vitem &%-odqs%&
4186 .oindex "&%-odqs%&"
4187 .cindex "SMTP" "delaying delivery"
4188 .cindex "first pass routing"
4189 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4190 However, like &%-odb%& and &%-odi%&, this option has no effect if
4191 &%queue_only_override%& is false and one of the queueing options in the
4192 configuration file is in effect.
4193
4194 When &%-odqs%& does operate, a delivery process is started for each incoming
4195 message, in the background by default, but in the foreground if &%-odi%& is
4196 also present. The recipient addresses are routed, and local deliveries are done
4197 in the normal way. However, if any SMTP deliveries are required, they are not
4198 done at this time, so the message remains in the queue until a subsequent queue
4199 runner process encounters it. Because routing was done, Exim knows which
4200 messages are waiting for which hosts, and so a number of messages for the same
4201 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4202 configuration option has the same effect for specific domains. See also the
4203 &%-qq%& option.
4204
4205 .vitem &%-oee%&
4206 .oindex "&%-oee%&"
4207 .cindex "error" "reporting"
4208 If an error is detected while a non-SMTP message is being received (for
4209 example, a malformed address), the error is reported to the sender in a mail
4210 message.
4211
4212 .cindex "return code" "for &%-oee%&"
4213 Provided
4214 this error message is successfully sent, the Exim receiving process
4215 exits with a return code of zero. If not, the return code is 2 if the problem
4216 is that the original message has no recipients, or 1 for any other error.
4217 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4218
4219 .vitem &%-oem%&
4220 .oindex "&%-oem%&"
4221 .cindex "error" "reporting"
4222 .cindex "return code" "for &%-oem%&"
4223 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4224 return code, whether or not the error message was successfully sent.
4225 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4226
4227 .vitem &%-oep%&
4228 .oindex "&%-oep%&"
4229 .cindex "error" "reporting"
4230 If an error is detected while a non-SMTP message is being received, the
4231 error is reported by writing a message to the standard error file (stderr).
4232 .cindex "return code" "for &%-oep%&"
4233 The return code is 1 for all errors.
4234
4235 .vitem &%-oeq%&
4236 .oindex "&%-oeq%&"
4237 .cindex "error" "reporting"
4238 This option is supported for compatibility with Sendmail, but has the same
4239 effect as &%-oep%&.
4240
4241 .vitem &%-oew%&
4242 .oindex "&%-oew%&"
4243 .cindex "error" "reporting"
4244 This option is supported for compatibility with Sendmail, but has the same
4245 effect as &%-oem%&.
4246
4247 .vitem &%-oi%&
4248 .oindex "&%-oi%&"
4249 .cindex "dot" "in incoming non-SMTP message"
4250 This option, which has the same effect as &%-i%&, specifies that a dot on a
4251 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4252 single dot does terminate, though Exim does no special processing for other
4253 lines that start with a dot. This option is set by default if Exim is called as
4254 &'rmail'&. See also &%-ti%&.
4255
4256 .vitem &%-oitrue%&
4257 .oindex "&%-oitrue%&"
4258 This option is treated as synonymous with &%-oi%&.
4259
4260 .vitem &%-oMa%&&~<&'host&~address'&>
4261 .oindex "&%-oMa%&"
4262 .cindex "sender" "host address, specifying for local message"
4263 A number of options starting with &%-oM%& can be used to set values associated
4264 with remote hosts on locally-submitted messages (that is, messages not received
4265 over TCP/IP). These options can be used by any caller in conjunction with the
4266 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4267 other circumstances, they are ignored unless the caller is trusted.
4268
4269 The &%-oMa%& option sets the sender host address. This may include a port
4270 number at the end, after a full stop (period). For example:
4271 .code
4272 exim -bs -oMa 10.9.8.7.1234
4273 .endd
4274 An alternative syntax is to enclose the IP address in square brackets,
4275 followed by a colon and the port number:
4276 .code
4277 exim -bs -oMa [10.9.8.7]:1234
4278 .endd
4279 The IP address is placed in the &$sender_host_address$& variable, and the
4280 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4281 are present on the command line, the sender host IP address is taken from
4282 whichever one is last.
4283
4284 .vitem &%-oMaa%&&~<&'name'&>
4285 .oindex "&%-oMaa%&"
4286 .cindex "authentication" "name, specifying for local message"
4287 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4288 option sets the value of &$sender_host_authenticated$& (the authenticator
4289 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4290 This option can be used with &%-bh%& and &%-bs%& to set up an
4291 authenticated SMTP session without actually using the SMTP AUTH command.
4292
4293 .vitem &%-oMai%&&~<&'string'&>
4294 .oindex "&%-oMai%&"
4295 .cindex "authentication" "id, specifying for local message"
4296 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4297 option sets the value of &$authenticated_id$& (the id that was authenticated).
4298 This overrides the default value (the caller's login id, except with &%-bh%&,
4299 where there is no default) for messages from local sources. See chapter
4300 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4301
4302 .vitem &%-oMas%&&~<&'address'&>
4303 .oindex "&%-oMas%&"
4304 .cindex "authentication" "sender, specifying for local message"
4305 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4306 option sets the authenticated sender value in &$authenticated_sender$&. It
4307 overrides the sender address that is created from the caller's login id for
4308 messages from local sources, except when &%-bh%& is used, when there is no
4309 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4310 specified on a MAIL command overrides this value. See chapter
4311 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4312
4313 .vitem &%-oMi%&&~<&'interface&~address'&>
4314 .oindex "&%-oMi%&"
4315 .cindex "interface" "address, specifying for local message"
4316 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4317 option sets the IP interface address value. A port number may be included,
4318 using the same syntax as for &%-oMa%&. The interface address is placed in
4319 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4320
4321 .vitem &%-oMm%&&~<&'message&~reference'&>
4322 .oindex "&%-oMm%&"
4323 .cindex "message reference" "message reference, specifying for local message"
4324 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4325 option sets the message reference, e.g. message-id, and is logged during
4326 delivery. This is useful when some kind of audit trail is required to tie
4327 messages together. The format of the message reference is checked and will
4328 abort if the format is invalid. The option will only be accepted if exim is
4329 running in trusted mode, not as any regular user.
4330
4331 The best example of a message reference is when Exim sends a bounce message.
4332 The message reference is the message-id of the original message for which Exim
4333 is sending the bounce.
4334
4335 .vitem &%-oMr%&&~<&'protocol&~name'&>
4336 .oindex "&%-oMr%&"
4337 .cindex "protocol, specifying for local message"
4338 .vindex "&$received_protocol$&"
4339 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4340 option sets the received protocol value that is stored in
4341 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4342 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4343 SMTP protocol names (see the description of &$received_protocol$& in section
4344 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4345 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4346 be set by &%-oMr%&. Repeated use of this option is not supported.
4347
4348 .vitem &%-oMs%&&~<&'host&~name'&>
4349 .oindex "&%-oMs%&"
4350 .cindex "sender" "host name, specifying for local message"
4351 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4352 option sets the sender host name in &$sender_host_name$&. When this option is
4353 present, Exim does not attempt to look up a host name from an IP address; it
4354 uses the name it is given.
4355
4356 .vitem &%-oMt%&&~<&'ident&~string'&>
4357 .oindex "&%-oMt%&"
4358 .cindex "sender" "ident string, specifying for local message"
4359 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4360 option sets the sender ident value in &$sender_ident$&. The default setting for
4361 local callers is the login id of the calling process, except when &%-bh%& is
4362 used, when there is no default.
4363
4364 .vitem &%-om%&
4365 .oindex "&%-om%&"
4366 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4367 In Sendmail, this option means &"me too"&, indicating that the sender of a
4368 message should receive a copy of the message if the sender appears in an alias
4369 expansion. Exim always does this, so the option does nothing.
4370
4371 .vitem &%-oo%&
4372 .oindex "&%-oo%&"
4373 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4374 This option is ignored. In Sendmail it specifies &"old style headers"&,
4375 whatever that means.
4376
4377 .vitem &%-oP%&&~<&'path'&>
4378 .oindex "&%-oP%&"
4379 .cindex "pid (process id)" "of daemon"
4380 .cindex "daemon" "process id (pid)"
4381 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4382 value. The option specifies the file to which the process id of the daemon is
4383 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4384 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4385 because in those cases, the normal pid file is not used.
4386
4387 .new
4388 .vitem &%-oPX%&
4389 .oindex "&%-oPX%&"
4390 .cindex "pid (process id)" "of daemon"
4391 .cindex "daemon" "process id (pid)"
4392 This option is not intended for general use.
4393 The daemon uses it when terminating due to a SIGTEM, possibly in
4394 combination with &%-oP%&&~<&'path'&>.
4395 It causes the pid file to be removed.
4396 .wen
4397
4398 .vitem &%-or%&&~<&'time'&>
4399 .oindex "&%-or%&"
4400 .cindex "timeout" "for non-SMTP input"
4401 This option sets a timeout value for incoming non-SMTP messages. If it is not
4402 set, Exim will wait forever for the standard input. The value can also be set
4403 by the &%receive_timeout%& option. The format used for specifying times is
4404 described in section &<<SECTtimeformat>>&.
4405
4406 .vitem &%-os%&&~<&'time'&>
4407 .oindex "&%-os%&"
4408 .cindex "timeout" "for SMTP input"
4409 .cindex "SMTP" "input timeout"
4410 This option sets a timeout value for incoming SMTP messages. The timeout
4411 applies to each SMTP command and block of data. The value can also be set by
4412 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4413 for specifying times is described in section &<<SECTtimeformat>>&.
4414
4415 .vitem &%-ov%&
4416 .oindex "&%-ov%&"
4417 This option has exactly the same effect as &%-v%&.
4418
4419 .vitem &%-oX%&&~<&'number&~or&~string'&>
4420 .oindex "&%-oX%&"
4421 .cindex "TCP/IP" "setting listening ports"
4422 .cindex "TCP/IP" "setting listening interfaces"
4423 .cindex "port" "receiving TCP/IP"
4424 This option is relevant only when the &%-bd%& (start listening daemon) option
4425 is also given. It controls which ports and interfaces the daemon uses. Details
4426 of the syntax, and how it interacts with configuration file options, are given
4427 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4428 file is written unless &%-oP%& is also present to specify a pid filename.
4429
4430 .vitem &%-pd%&
4431 .oindex "&%-pd%&"
4432 .cindex "Perl" "starting the interpreter"
4433 This option applies when an embedded Perl interpreter is linked with Exim (see
4434 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4435 option, forcing the starting of the interpreter to be delayed until it is
4436 needed.
4437
4438 .vitem &%-ps%&
4439 .oindex "&%-ps%&"
4440 .cindex "Perl" "starting the interpreter"
4441 This option applies when an embedded Perl interpreter is linked with Exim (see
4442 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4443 option, forcing the starting of the interpreter to occur as soon as Exim is
4444 started.
4445
4446 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4447 .oindex "&%-p%&"
4448 For compatibility with Sendmail, this option is equivalent to
4449 .display
4450 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4451 .endd
4452 It sets the incoming protocol and host name (for trusted callers). The
4453 host name and its colon can be omitted when only the protocol is to be set.
4454 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4455 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4456 or &`s`& using this option (but that does not seem a real limitation).
4457 Repeated use of this option is not supported.
4458
4459 .vitem &%-q%&
4460 .oindex "&%-q%&"
4461 .cindex "queue runner" "starting manually"
4462 This option is normally restricted to admin users. However, there is a
4463 configuration option called &%prod_requires_admin%& which can be set false to
4464 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4465 and &%-S%& options).
4466
4467 .cindex "queue runner" "description of operation"
4468 If other commandline options do not specify an action,
4469 the &%-q%& option starts one queue runner process. This scans the queue of
4470 waiting messages, and runs a delivery process for each one in turn. It waits
4471 for each delivery process to finish before starting the next one. A delivery
4472 process may not actually do any deliveries if the retry times for the addresses
4473 have not been reached. Use &%-qf%& (see below) if you want to override this.
4474
4475 If
4476 .cindex "SMTP" "passed connection"
4477 .cindex "SMTP" "multiple deliveries"
4478 .cindex "multiple SMTP deliveries"
4479 the delivery process spawns other processes to deliver other messages down
4480 passed SMTP connections, the queue runner waits for these to finish before
4481 proceeding.
4482
4483 When all the queued messages have been considered, the original queue runner
4484 process terminates. In other words, a single pass is made over the waiting
4485 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4486 this to be repeated periodically.
4487
4488 Exim processes the waiting messages in an unpredictable order. It isn't very
4489 random, but it is likely to be different each time, which is all that matters.
4490 If one particular message screws up a remote MTA, other messages to the same
4491 MTA have a chance of getting through if they get tried first.
4492
4493 It is possible to cause the messages to be processed in lexical message id
4494 order, which is essentially the order in which they arrived, by setting the
4495 &%queue_run_in_order%& option, but this is not recommended for normal use.
4496
4497 .vitem &%-q%&<&'qflags'&>
4498 The &%-q%& option may be followed by one or more flag letters that change its
4499 behaviour. They are all optional, but if more than one is present, they must
4500 appear in the correct order. Each flag is described in a separate item below.
4501
4502 .vitem &%-qq...%&
4503 .oindex "&%-qq%&"
4504 .cindex "queue" "double scanning"
4505 .cindex "queue" "routing"
4506 .cindex "routing" "whole queue before delivery"
4507 .cindex "first pass routing"
4508 An option starting with &%-qq%& requests a two-stage queue run. In the first
4509 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4510 every domain. Addresses are routed, local deliveries happen, but no remote
4511 transports are run.
4512
4513 .new
4514 Performance will be best if the &%queue_run_in_order%& option is false.
4515 .wen
4516
4517 .cindex "hints database" "remembering routing"
4518 The hints database that remembers which messages are waiting for specific hosts
4519 is updated, as if delivery to those hosts had been deferred. After this is
4520 complete, a second, normal queue scan happens, with routing and delivery taking
4521 place as normal. Messages that are routed to the same host should mostly be
4522 delivered down a single SMTP
4523 .cindex "SMTP" "passed connection"
4524 .cindex "SMTP" "multiple deliveries"
4525 .cindex "multiple SMTP deliveries"
4526 connection because of the hints that were set up during the first queue scan.
4527 This option may be useful for hosts that are connected to the Internet
4528 intermittently.
4529
4530 .vitem &%-q[q]i...%&
4531 .oindex "&%-qi%&"
4532 .cindex "queue" "initial delivery"
4533 If the &'i'& flag is present, the queue runner runs delivery processes only for
4534 those messages that haven't previously been tried. (&'i'& stands for &"initial
4535 delivery"&.) This can be helpful if you are putting messages in the queue using
4536 &%-odq%& and want a queue runner just to process the new messages.
4537
4538 .vitem &%-q[q][i]f...%&
4539 .oindex "&%-qf%&"
4540 .cindex "queue" "forcing delivery"
4541 .cindex "delivery" "forcing in queue run"
4542 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4543 message, whereas without &'f'& only those non-frozen addresses that have passed
4544 their retry times are tried.
4545
4546 .vitem &%-q[q][i]ff...%&
4547 .oindex "&%-qff%&"
4548 .cindex "frozen messages" "forcing delivery"
4549 If &'ff'& is present, a delivery attempt is forced for every message, whether
4550 frozen or not.
4551
4552 .vitem &%-q[q][i][f[f]]l%&
4553 .oindex "&%-ql%&"
4554 .cindex "queue" "local deliveries only"
4555 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4556 be done. If a message requires any remote deliveries, it remains in the queue
4557 for later delivery.
4558
4559 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4560 .oindex "&%-qG%&"
4561 .cindex queue named
4562 .cindex "named queues"  "deliver from"
4563 .cindex "queue" "delivering specific messages"
4564 If the &'G'& flag and a name is present, the queue runner operates on the
4565 queue with the given name rather than the default queue.
4566 The name should not contain a &'/'& character.
4567 For a periodic queue run (see below)
4568 append to the name a slash and a time value.
4569
4570 If other commandline options specify an action, a &'-qG<name>'& option
4571 will specify a queue to operate on.
4572 For example:
4573 .code
4574 exim -bp -qGquarantine
4575 mailq -qGquarantine
4576 exim -qGoffpeak -Rf @special.domain.example
4577 .endd
4578
4579 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4580 When scanning the queue, Exim can be made to skip over messages whose ids are
4581 lexically less than a given value by following the &%-q%& option with a
4582 starting message id. For example:
4583 .code
4584 exim -q 0t5C6f-0000c8-00
4585 .endd
4586 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4587 second message id is given, messages whose ids are lexically greater than it
4588 are also skipped. If the same id is given twice, for example,
4589 .code
4590 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4591 .endd
4592 just one delivery process is started, for that message. This differs from
4593 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4594 that it counts as a delivery from a queue run. Note that the selection
4595 mechanism does not affect the order in which the messages are scanned. There
4596 are also other ways of selecting specific sets of messages for delivery in a
4597 queue run &-- see &%-R%& and &%-S%&.
4598
4599 .vitem &%-q%&<&'qflags'&><&'time'&>
4600 .cindex "queue runner" "starting periodically"
4601 .cindex "periodic queue running"
4602 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4603 starting a queue runner process at intervals specified by the given time value
4604 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4605 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4606 single daemon process handles both functions. A common way of starting up a
4607 combined daemon at system boot time is to use a command such as
4608 .code
4609 /usr/exim/bin/exim -bd -q30m
4610 .endd
4611 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4612 process every 30 minutes.
4613
4614 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4615 pid file is written unless one is explicitly requested by the &%-oP%& option.
4616
4617 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4618 .oindex "&%-qR%&"
4619 This option is synonymous with &%-R%&. It is provided for Sendmail
4620 compatibility.
4621
4622 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4623 .oindex "&%-qS%&"
4624 This option is synonymous with &%-S%&.
4625
4626 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4627 .oindex "&%-R%&"
4628 .cindex "queue runner" "for specific recipients"
4629 .cindex "delivery" "to given domain"
4630 .cindex "domain" "delivery to"
4631 The <&'rsflags'&> may be empty, in which case the white space before the string
4632 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4633 which are the possible values for <&'rsflags'&>. White space is required if
4634 <&'rsflags'&> is not empty.
4635
4636 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4637 perform a single queue run, except that, when scanning the messages on the
4638 queue, Exim processes only those that have at least one undelivered recipient
4639 address containing the given string, which is checked in a case-independent
4640 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4641 regular expression; otherwise it is a literal string.
4642
4643 If you want to do periodic queue runs for messages with specific recipients,
4644 you can combine &%-R%& with &%-q%& and a time value. For example:
4645 .code
4646 exim -q25m -R @special.domain.example
4647 .endd
4648 This example does a queue run for messages with recipients in the given domain
4649 every 25 minutes. Any additional flags that are specified with &%-q%& are
4650 applied to each queue run.
4651
4652 Once a message is selected for delivery by this mechanism, all its addresses
4653 are processed. For the first selected message, Exim overrides any retry
4654 information and forces a delivery attempt for each undelivered address. This
4655 means that if delivery of any address in the first message is successful, any
4656 existing retry information is deleted, and so delivery attempts for that
4657 address in subsequently selected messages (which are processed without forcing)
4658 will run. However, if delivery of any address does not succeed, the retry
4659 information is updated, and in subsequently selected messages, the failing
4660 address will be skipped.
4661
4662 .cindex "frozen messages" "forcing delivery"
4663 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4664 all selected messages, not just the first; frozen messages are included when
4665 &'ff'& is present.
4666
4667 The &%-R%& option makes it straightforward to initiate delivery of all messages
4668 to a given domain after a host has been down for some time. When the SMTP
4669 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4670 effect is to run Exim with the &%-R%& option, but it can be configured to run
4671 an arbitrary command instead.
4672
4673 .vitem &%-r%&
4674 .oindex "&%-r%&"
4675 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4676
4677 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4678 .oindex "&%-S%&"
4679 .cindex "delivery" "from given sender"
4680 .cindex "queue runner" "for specific senders"
4681 This option acts like &%-R%& except that it checks the string against each
4682 message's sender instead of against the recipients. If &%-R%& is also set, both
4683 conditions must be met for a message to be selected. If either of the options
4684 has &'f'& or &'ff'& in its flags, the associated action is taken.
4685
4686 .vitem &%-Tqt%&&~<&'times'&>
4687 .oindex "&%-Tqt%&"
4688 This is an option that is exclusively for use by the Exim testing suite. It is not
4689 recognized when Exim is run normally. It allows for the setting up of explicit
4690 &"queue times"& so that various warning/retry features can be tested.
4691
4692 .vitem &%-t%&
4693 .oindex "&%-t%&"
4694 .cindex "recipient" "extracting from header lines"
4695 .cindex "&'Bcc:'& header line"
4696 .cindex "&'Cc:'& header line"
4697 .cindex "&'To:'& header line"
4698 When Exim is receiving a locally-generated, non-SMTP message on its standard
4699 input, the &%-t%& option causes the recipients of the message to be obtained
4700 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4701 from the command arguments. The addresses are extracted before any rewriting
4702 takes place and the &'Bcc:'& header line, if present, is then removed.
4703
4704 .cindex "Sendmail compatibility" "&%-t%& option"
4705 If the command has any arguments, they specify addresses to which the message
4706 is &'not'& to be delivered. That is, the argument addresses are removed from
4707 the recipients list obtained from the headers. This is compatible with Smail 3
4708 and in accordance with the documented behaviour of several versions of
4709 Sendmail, as described in man pages on a number of operating systems (e.g.
4710 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4711 argument addresses to those obtained from the headers, and the O'Reilly
4712 Sendmail book documents it that way. Exim can be made to add argument addresses
4713 instead of subtracting them by setting the option
4714 &%extract_addresses_remove_arguments%& false.
4715
4716 .cindex "&%Resent-%& header lines" "with &%-t%&"
4717 If there are any &%Resent-%& header lines in the message, Exim extracts
4718 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4719 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4720 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4721 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4722
4723 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4724 message is resent several times). The RFC also specifies that they should be
4725 added at the front of the message, and separated by &'Received:'& lines. It is
4726 not at all clear how &%-t%& should operate in the present of multiple sets,
4727 nor indeed exactly what constitutes a &"set"&.
4728 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4729 are often added at the end of the header, and if a message is resent more than
4730 once, it is common for the original set of &%Resent-%& headers to be renamed as
4731 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4732
4733 .vitem &%-ti%&
4734 .oindex "&%-ti%&"
4735 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4736 compatibility with Sendmail.
4737
4738 .vitem &%-tls-on-connect%&
4739 .oindex "&%-tls-on-connect%&"
4740 .cindex "TLS" "use without STARTTLS"
4741 .cindex "TLS" "automatic start"
4742 This option is available when Exim is compiled with TLS support. It forces all
4743 incoming SMTP connections to behave as if the incoming port is listed in the
4744 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4745 &<<CHAPTLS>>& for further details.
4746
4747
4748 .vitem &%-U%&
4749 .oindex "&%-U%&"
4750 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4751 Sendmail uses this option for &"initial message submission"&, and its
4752 documentation states that in future releases, it may complain about
4753 syntactically invalid messages rather than fixing them when this flag is not
4754 set. Exim ignores this option.
4755
4756 .vitem &%-v%&
4757 .oindex "&%-v%&"
4758 This option causes Exim to write information to the standard error stream,
4759 describing what it is doing. In particular, it shows the log lines for
4760 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4761 dialogue is shown. Some of the log lines shown may not actually be written to
4762 the log if the setting of &%log_selector%& discards them. Any relevant
4763 selectors are shown with each log line. If none are shown, the logging is
4764 unconditional.
4765
4766 .vitem &%-x%&
4767 .oindex "&%-x%&"
4768 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4769 National Language Support extended characters in the body of the mail item"&).
4770 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4771 this option.
4772
4773 .vitem &%-X%&&~<&'logfile'&>
4774 .oindex "&%-X%&"
4775 This option is interpreted by Sendmail to cause debug information to be sent
4776 to the named file.  It is ignored by Exim.
4777
4778 .vitem &%-z%&&~<&'log-line'&>
4779 .oindex "&%-z%&"
4780 This option writes its argument to Exim's logfile.
4781 Use is restricted to administrators; the intent is for operational notes.
4782 Quotes should be used to maintain a multi-word item as a single argument,
4783 under most shells.
4784 .endlist
4785
4786 .ecindex IIDclo1
4787 .ecindex IIDclo2
4788
4789
4790 . ////////////////////////////////////////////////////////////////////////////
4791 . Insert a stylized DocBook comment here, to identify the end of the command
4792 . line options. This is for the benefit of the Perl script that automatically
4793 . creates a man page for the options.
4794 . ////////////////////////////////////////////////////////////////////////////
4795
4796 .literal xml
4797 <!-- === End of command line options === -->
4798 .literal off
4799
4800
4801
4802
4803
4804 . ////////////////////////////////////////////////////////////////////////////
4805 . ////////////////////////////////////////////////////////////////////////////
4806
4807
4808 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4809          "The runtime configuration file"
4810
4811 .cindex "runtime configuration"
4812 .cindex "configuration file" "general description"
4813 .cindex "CONFIGURE_FILE"
4814 .cindex "configuration file" "errors in"
4815 .cindex "error" "in configuration file"
4816 .cindex "return code" "for bad configuration"
4817 Exim uses a single runtime configuration file that is read whenever an Exim
4818 binary is executed. Note that in normal operation, this happens frequently,
4819 because Exim is designed to operate in a distributed manner, without central
4820 control.
4821
4822 If a syntax error is detected while reading the configuration file, Exim
4823 writes a message on the standard error, and exits with a non-zero return code.
4824 The message is also written to the panic log. &*Note*&: Only simple syntax
4825 errors can be detected at this time. The values of any expanded options are
4826 not checked until the expansion happens, even when the expansion does not
4827 actually alter the string.
4828
4829 The name of the configuration file is compiled into the binary for security
4830 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4831 most configurations, this specifies a single file. However, it is permitted to
4832 give a colon-separated list of filenames, in which case Exim uses the first
4833 existing file in the list.
4834
4835 .cindex "EXIM_USER"
4836 .cindex "EXIM_GROUP"
4837 .cindex "CONFIGURE_OWNER"
4838 .cindex "CONFIGURE_GROUP"
4839 .cindex "configuration file" "ownership"
4840 .cindex "ownership" "configuration file"
4841 The runtime configuration file must be owned by root or by the user that is
4842 specified at compile time by the CONFIGURE_OWNER option (if set). The
4843 configuration file must not be world-writeable, or group-writeable unless its
4844 group is the root group or the one specified at compile time by the
4845 CONFIGURE_GROUP option.
4846
4847 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4848 to root, anybody who is able to edit the runtime configuration file has an
4849 easy way to run commands as root. If you specify a user or group in the
4850 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4851 who are members of that group will trivially be able to obtain root privileges.
4852
4853 Up to Exim version 4.72, the runtime configuration file was also permitted to
4854 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4855 since it offered a simple privilege escalation for any attacker who managed to
4856 compromise the Exim user account.
4857
4858 A default configuration file, which will work correctly in simple situations,
4859 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4860 defines just one filename, the installation process copies the default
4861 configuration to a new file of that name if it did not previously exist. If
4862 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4863 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4864 configuration.
4865
4866
4867
4868 .section "Using a different configuration file" "SECID40"
4869 .cindex "configuration file" "alternate"
4870 A one-off alternate configuration can be specified by the &%-C%& command line
4871 option, which may specify a single file or a list of files. However, when
4872 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4873 unless the argument for &%-C%& is identical to the built-in value from
4874 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4875 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4876 is useful mainly for checking the syntax of configuration files before
4877 installing them. No owner or group checks are done on a configuration file
4878 specified by &%-C%&, if root privilege has been dropped.
4879
4880 Even the Exim user is not trusted to specify an arbitrary configuration file
4881 with the &%-C%& option to be used with root privileges, unless that file is
4882 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4883 testing a configuration using &%-C%& right through message reception and
4884 delivery, even if the caller is root. The reception works, but by that time,
4885 Exim is running as the Exim user, so when it re-execs to regain privilege for
4886 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4887 can test reception and delivery using two separate commands (one to put a
4888 message in the queue, using &%-odq%&, and another to do the delivery, using
4889 &%-M%&).
4890
4891 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4892 prefix string with which any file named in a &%-C%& command line option must
4893 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4894 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4895 filename can be used with &%-C%&.
4896
4897 One-off changes to a configuration can be specified by the &%-D%& command line
4898 option, which defines and overrides values for macros used inside the
4899 configuration file. However, like &%-C%&, the use of this option by a
4900 non-privileged user causes Exim to discard its root privilege.
4901 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4902 completely disabled, and its use causes an immediate error exit.
4903
4904 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4905 to declare certain macro names trusted, such that root privilege will not
4906 necessarily be discarded.
4907 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4908 considered safe and, if &%-D%& only supplies macros from this list, and the
4909 values are acceptable, then Exim will not give up root privilege if the caller
4910 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4911 transition mechanism and is expected to be removed in the future.  Acceptable
4912 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4913
4914 Some sites may wish to use the same Exim binary on different machines that
4915 share a file system, but to use different configuration files on each machine.
4916 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4917 looks for a file whose name is the configuration filename followed by a dot
4918 and the machine's node name, as obtained from the &[uname()]& function. If this
4919 file does not exist, the standard name is tried. This processing occurs for
4920 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4921
4922 In some esoteric situations different versions of Exim may be run under
4923 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4924 help with this. See the comments in &_src/EDITME_& for details.
4925
4926
4927
4928 .section "Configuration file format" "SECTconffilfor"
4929 .cindex "configuration file" "format of"
4930 .cindex "format" "configuration file"
4931 Exim's configuration file is divided into a number of different parts. General
4932 option settings must always appear at the start of the file. The other parts
4933 are all optional, and may appear in any order. Each part other than the first
4934 is introduced by the word &"begin"& followed by at least one literal
4935 space, and the name of the part. The optional parts are:
4936
4937 .ilist
4938 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4939 &<<CHAPACL>>&).
4940 .next
4941 .cindex "AUTH" "configuration"
4942 &'authenticators'&: Configuration settings for the authenticator drivers. These
4943 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4944 .next
4945 &'routers'&: Configuration settings for the router drivers. Routers process
4946 addresses and determine how the message is to be delivered (see chapters
4947 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4948 .next
4949 &'transports'&: Configuration settings for the transport drivers. Transports
4950 define mechanisms for copying messages to destinations (see chapters
4951 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4952 .next
4953 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4954 If there is no retry section, or if it is empty (that is, no retry rules are
4955 defined), Exim will not retry deliveries. In this situation, temporary errors
4956 are treated the same as permanent errors. Retry rules are discussed in chapter
4957 &<<CHAPretry>>&.
4958 .next
4959 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4960 when new addresses are generated during delivery. Rewriting is discussed in
4961 chapter &<<CHAPrewrite>>&.
4962 .next
4963 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4964 want to use this feature, you must set
4965 .code
4966 LOCAL_SCAN_HAS_OPTIONS=yes
4967 .endd
4968 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4969 facility are given in chapter &<<CHAPlocalscan>>&.
4970 .endlist
4971
4972 .cindex "configuration file" "leading white space in"
4973 .cindex "configuration file" "trailing white space in"
4974 .cindex "white space" "in configuration file"
4975 Leading and trailing white space in configuration lines is always ignored.
4976
4977 Blank lines in the file, and lines starting with a # character (ignoring
4978 leading white space) are treated as comments and are ignored. &*Note*&: A
4979 # character other than at the beginning of a line is not treated specially,
4980 and does not introduce a comment.
4981
4982 Any non-comment line can be continued by ending it with a backslash. Note that
4983 the general rule for white space means that trailing white space after the
4984 backslash and leading white space at the start of continuation
4985 lines is ignored. Comment lines beginning with # (but not empty lines) may
4986 appear in the middle of a sequence of continuation lines.
4987
4988 A convenient way to create a configuration file is to start from the
4989 default, which is supplied in &_src/configure.default_&, and add, delete, or
4990 change settings as required.
4991
4992 The ACLs, retry rules, and rewriting rules have their own syntax which is
4993 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4994 respectively. The other parts of the configuration file have some syntactic
4995 items in common, and these are described below, from section &<<SECTcos>>&
4996 onwards. Before that, the inclusion, macro, and conditional facilities are
4997 described.
4998
4999
5000
5001 .section "File inclusions in the configuration file" "SECID41"
5002 .cindex "inclusions in configuration file"
5003 .cindex "configuration file" "including other files"
5004 .cindex "&`.include`& in configuration file"
5005 .cindex "&`.include_if_exists`& in configuration file"
5006 You can include other files inside Exim's runtime configuration file by
5007 using this syntax:
5008 .display
5009 &`.include`& <&'filename'&>
5010 &`.include_if_exists`& <&'filename'&>
5011 .endd
5012 on a line by itself. Double quotes round the filename are optional. If you use
5013 the first form, a configuration error occurs if the file does not exist; the
5014 second form does nothing for non-existent files.
5015 The first form allows a relative name. It is resolved relative to
5016 the directory of the including file. For the second form an absolute filename
5017 is required.
5018
5019 Includes may be nested to any depth, but remember that Exim reads its
5020 configuration file often, so it is a good idea to keep them to a minimum.
5021 If you change the contents of an included file, you must HUP the daemon,
5022 because an included file is read only when the configuration itself is read.
5023
5024 The processing of inclusions happens early, at a physical line level, so, like
5025 comment lines, an inclusion can be used in the middle of an option setting,
5026 for example:
5027 .code
5028 hosts_lookup = a.b.c \
5029                .include /some/file
5030 .endd
5031 Include processing happens after macro processing (see below). Its effect is to
5032 process the lines of the included file as if they occurred inline where the
5033 inclusion appears.
5034
5035
5036
5037 .section "Macros in the configuration file" "SECTmacrodefs"
5038 .cindex "macro" "description of"
5039 .cindex "configuration file" "macros"
5040 If a line in the main part of the configuration (that is, before the first
5041 &"begin"& line) begins with an upper case letter, it is taken as a macro
5042 definition, and must be of the form
5043 .display
5044 <&'name'&> = <&'rest of line'&>
5045 .endd
5046 The name must consist of letters, digits, and underscores, and need not all be
5047 in upper case, though that is recommended. The rest of the line, including any
5048 continuations, is the replacement text, and has leading and trailing white
5049 space removed. Quotes are not removed. The replacement text can never end with
5050 a backslash character, but this doesn't seem to be a serious limitation.
5051
5052 Macros may also be defined between router, transport, authenticator, or ACL
5053 definitions. They may not, however, be defined within an individual driver or
5054 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5055
5056 .section "Macro substitution" "SECID42"
5057 Once a macro is defined, all subsequent lines in the file (and any included
5058 files) are scanned for the macro name; if there are several macros, the line is
5059 scanned for each, in turn, in the order in which the macros are defined. The
5060 replacement text is not re-scanned for the current macro, though it is scanned
5061 for subsequently defined macros. For this reason, a macro name may not contain
5062 the name of a previously defined macro as a substring. You could, for example,
5063 define
5064 .display
5065 &`ABCD_XYZ = `&<&'something'&>
5066 &`ABCD = `&<&'something else'&>
5067 .endd
5068 but putting the definitions in the opposite order would provoke a configuration
5069 error. Macro expansion is applied to individual physical lines from the file,
5070 before checking for line continuation or file inclusion (see above). If a line
5071 consists solely of a macro name, and the expansion of the macro is empty, the
5072 line is ignored. A macro at the start of a line may turn the line into a
5073 comment line or a &`.include`& line.
5074
5075
5076 .section "Redefining macros" "SECID43"
5077 Once defined, the value of a macro can be redefined later in the configuration
5078 (or in an included file). Redefinition is specified by using &'=='& instead of
5079 &'='&. For example:
5080 .code
5081 MAC =  initial value
5082 ...
5083 MAC == updated value
5084 .endd
5085 Redefinition does not alter the order in which the macros are applied to the
5086 subsequent lines of the configuration file. It is still the same order in which
5087 the macros were originally defined. All that changes is the macro's value.
5088 Redefinition makes it possible to accumulate values. For example:
5089 .code
5090 MAC =  initial value
5091 ...
5092 MAC == MAC and something added
5093 .endd
5094 This can be helpful in situations where the configuration file is built
5095 from a number of other files.
5096
5097 .section "Overriding macro values" "SECID44"
5098 The values set for macros in the configuration file can be overridden by the
5099 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5100 used, unless called by root or the Exim user. A definition on the command line
5101 using the &%-D%& option causes all definitions and redefinitions within the
5102 file to be ignored.
5103
5104
5105
5106 .section "Example of macro usage" "SECID45"
5107 As an example of macro usage, consider a configuration where aliases are looked
5108 up in a MySQL database. It helps to keep the file less cluttered if long
5109 strings such as SQL statements are defined separately as macros, for example:
5110 .code
5111 ALIAS_QUERY = select mailbox from user where \
5112               login='${quote_mysql:$local_part}';
5113 .endd
5114 This can then be used in a &(redirect)& router setting like this:
5115 .code
5116 data = ${lookup mysql{ALIAS_QUERY}}
5117 .endd
5118 In earlier versions of Exim macros were sometimes used for domain, host, or
5119 address lists. In Exim 4 these are handled better by named lists &-- see
5120 section &<<SECTnamedlists>>&.
5121
5122
5123 .section "Builtin macros" "SECTbuiltinmacros"
5124 Exim defines some macros depending on facilities available, which may
5125 differ due to build-time definitions and from one release to another.
5126 All of these macros start with an underscore.
5127 They can be used to conditionally include parts of a configuration
5128 (see below).
5129
5130 The following classes of macros are defined:
5131 .display
5132 &` _HAVE_*                    `&  build-time defines
5133 &` _DRIVER_ROUTER_*           `&  router drivers
5134 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5135 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5136 &` _LOG_*                     `&  log_selector values
5137 &` _OPT_MAIN_*                `&  main config options
5138 &` _OPT_ROUTERS_*             `&  generic router options
5139 &` _OPT_TRANSPORTS_*          `&  generic transport options
5140 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5141 &` _OPT_ROUTER_*_*            `&  private router options
5142 &` _OPT_TRANSPORT_*_*         `&  private transport options
5143 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5144 .endd
5145
5146 Use an &"exim -bP macros"& command to get the list of macros.
5147
5148
5149 .section "Conditional skips in the configuration file" "SECID46"
5150 .cindex "configuration file" "conditional skips"
5151 .cindex "&`.ifdef`&"
5152 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5153 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5154 portions of the configuration file. The processing happens whenever the file is
5155 read (that is, when an Exim binary starts to run).
5156
5157 The implementation is very simple. Instances of the first four directives must
5158 be followed by text that includes the names of one or macros. The condition
5159 that is tested is whether or not any macro substitution has taken place in the
5160 line. Thus:
5161 .code
5162 .ifdef AAA
5163 message_size_limit = 50M
5164 .else
5165 message_size_limit = 100M
5166 .endif
5167 .endd
5168 sets a message size limit of 50M if the macro &`AAA`& is defined
5169 (or &`A`& or &`AA`&), and 100M
5170 otherwise. If there is more than one macro named on the line, the condition
5171 is true if any of them are defined. That is, it is an &"or"& condition. To
5172 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5173
5174 Although you can use a macro expansion to generate one of these directives,
5175 it is not very useful, because the condition &"there was a macro substitution
5176 in this line"& will always be true.
5177
5178 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5179 to clarify complicated nestings.
5180
5181
5182
5183 .section "Common option syntax" "SECTcos"
5184 .cindex "common option syntax"
5185 .cindex "syntax of common options"
5186 .cindex "configuration file" "common option syntax"
5187 For the main set of options, driver options, and &[local_scan()]& options,
5188 each setting is on a line by itself, and starts with a name consisting of
5189 lower-case letters and underscores. Many options require a data value, and in
5190 these cases the name must be followed by an equals sign (with optional white
5191 space) and then the value. For example:
5192 .code
5193 qualify_domain = mydomain.example.com
5194 .endd
5195 .cindex "hiding configuration option values"
5196 .cindex "configuration options" "hiding value of"
5197 .cindex "options" "hiding value of"
5198 Some option settings may contain sensitive data, for example, passwords for
5199 accessing databases. To stop non-admin users from using the &%-bP%& command
5200 line option to read these values, you can precede the option settings with the
5201 word &"hide"&. For example:
5202 .code
5203 hide mysql_servers = localhost/users/admin/secret-password
5204 .endd
5205 For non-admin users, such options are displayed like this:
5206 .code
5207 mysql_servers = <value not displayable>
5208 .endd
5209 If &"hide"& is used on a driver option, it hides the value of that option on
5210 all instances of the same driver.
5211
5212 The following sections describe the syntax used for the different data types
5213 that are found in option settings.
5214
5215
5216 .section "Boolean options" "SECID47"
5217 .cindex "format" "boolean"
5218 .cindex "boolean configuration values"
5219 .oindex "&%no_%&&'xxx'&"
5220 .oindex "&%not_%&&'xxx'&"
5221 Options whose type is given as boolean are on/off switches. There are two
5222 different ways of specifying such options: with and without a data value. If
5223 the option name is specified on its own without data, the switch is turned on;
5224 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5225 boolean options may be followed by an equals sign and one of the words
5226 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5227 the following two settings have exactly the same effect:
5228 .code
5229 queue_only
5230 queue_only = true
5231 .endd
5232 The following two lines also have the same (opposite) effect:
5233 .code
5234 no_queue_only
5235 queue_only = false
5236 .endd
5237 You can use whichever syntax you prefer.
5238
5239
5240
5241
5242 .section "Integer values" "SECID48"
5243 .cindex "integer configuration values"
5244 .cindex "format" "integer"
5245 If an option's type is given as &"integer"&, the value can be given in decimal,
5246 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5247 number is assumed. Otherwise, it is treated as an octal number unless it starts
5248 with the characters &"0x"&, in which case the remainder is interpreted as a
5249 hexadecimal number.
5250
5251 If an integer value is followed by the letter K, it is multiplied by 1024; if
5252 it is followed by the letter M, it is multiplied by 1024x1024;
5253 if by the letter G, 1024x1024x1024.
5254 When the values
5255 of integer option settings are output, values which are an exact multiple of
5256 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5257 and M. The printing style is independent of the actual input format that was
5258 used.
5259
5260
5261 .section "Octal integer values" "SECID49"
5262 .cindex "integer format"
5263 .cindex "format" "octal integer"
5264 If an option's type is given as &"octal integer"&, its value is always
5265 interpreted as an octal number, whether or not it starts with the digit zero.
5266 Such options are always output in octal.
5267
5268
5269 .section "Fixed point numbers" "SECID50"
5270 .cindex "fixed point configuration values"
5271 .cindex "format" "fixed point"
5272 If an option's type is given as &"fixed-point"&, its value must be a decimal
5273 integer, optionally followed by a decimal point and up to three further digits.
5274
5275
5276
5277 .section "Time intervals" "SECTtimeformat"
5278 .cindex "time interval" "specifying in configuration"
5279 .cindex "format" "time interval"
5280 A time interval is specified as a sequence of numbers, each followed by one of
5281 the following letters, with no intervening white space:
5282
5283 .table2 30pt
5284 .irow &%s%& seconds
5285 .irow &%m%& minutes
5286 .irow &%h%& hours
5287 .irow &%d%& days
5288 .irow &%w%& weeks
5289 .endtable
5290
5291 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5292 intervals are output in the same format. Exim does not restrict the values; it
5293 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5294
5295
5296
5297 .section "String values" "SECTstrings"
5298 .cindex "string" "format of configuration values"
5299 .cindex "format" "string"
5300 If an option's type is specified as &"string"&, the value can be specified with
5301 or without double-quotes. If it does not start with a double-quote, the value
5302 consists of the remainder of the line plus any continuation lines, starting at
5303 the first character after any leading white space, with trailing white space
5304 removed, and with no interpretation of the characters in the string. Because
5305 Exim removes comment lines (those beginning with #) at an early stage, they can
5306 appear in the middle of a multi-line string. The following two settings are
5307 therefore equivalent:
5308 .code
5309 trusted_users = uucp:mail
5310 trusted_users = uucp:\
5311                 # This comment line is ignored
5312                 mail
5313 .endd
5314 .cindex "string" "quoted"
5315 .cindex "escape characters in quoted strings"
5316 If a string does start with a double-quote, it must end with a closing
5317 double-quote, and any backslash characters other than those used for line
5318 continuation are interpreted as escape characters, as follows:
5319
5320 .table2 100pt
5321 .irow &`\\`&                     "single backslash"
5322 .irow &`\n`&                     "newline"
5323 .irow &`\r`&                     "carriage return"
5324 .irow &`\t`&                     "tab"
5325 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5326 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5327                                    character"
5328 .endtable
5329
5330 If a backslash is followed by some other character, including a double-quote
5331 character, that character replaces the pair.
5332
5333 Quoting is necessary only if you want to make use of the backslash escapes to
5334 insert special characters, or if you need to specify a value with leading or
5335 trailing spaces. These cases are rare, so quoting is almost never needed in
5336 current versions of Exim. In versions of Exim before 3.14, quoting was required
5337 in order to continue lines, so you may come across older configuration files
5338 and examples that apparently quote unnecessarily.
5339
5340
5341 .section "Expanded strings" "SECID51"
5342 .cindex "expansion" "definition of"
5343 Some strings in the configuration file are subjected to &'string expansion'&,
5344 by which means various parts of the string may be changed according to the
5345 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5346 is as just described; in particular, the handling of backslashes in quoted
5347 strings is done as part of the input process, before expansion takes place.
5348 However, backslash is also an escape character for the expander, so any
5349 backslashes that are required for that reason must be doubled if they are
5350 within a quoted configuration string.
5351
5352
5353 .section "User and group names" "SECID52"
5354 .cindex "user name" "format of"
5355 .cindex "format" "user name"
5356 .cindex "groups" "name format"
5357 .cindex "format" "group name"
5358 User and group names are specified as strings, using the syntax described
5359 above, but the strings are interpreted specially. A user or group name must
5360 either consist entirely of digits, or be a name that can be looked up using the
5361 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5362
5363
5364 .section "List construction" "SECTlistconstruct"
5365 .cindex "list" "syntax of in configuration"
5366 .cindex "format" "list item in configuration"
5367 .cindex "string" "list, definition of"
5368 The data for some configuration options is a list of items, with colon as the
5369 default separator. Many of these options are shown with type &"string list"& in
5370 the descriptions later in this document. Others are listed as &"domain list"&,
5371 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5372 are all the same; however, those other than &"string list"& are subject to
5373 particular kinds of interpretation, as described in chapter
5374 &<<CHAPdomhosaddlists>>&.
5375
5376 In all these cases, the entire list is treated as a single string as far as the
5377 input syntax is concerned. The &%trusted_users%& setting in section
5378 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5379 in a list, it must be entered as two colons. Leading and trailing white space
5380 on each item in a list is ignored. This makes it possible to include items that
5381 start with a colon, and in particular, certain forms of IPv6 address. For
5382 example, the list
5383 .code
5384 local_interfaces = 127.0.0.1 : ::::1
5385 .endd
5386 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5387
5388 &*Note*&: Although leading and trailing white space is ignored in individual
5389 list items, it is not ignored when parsing the list. The space after the first
5390 colon in the example above is necessary. If it were not there, the list would
5391 be interpreted as the two items 127.0.0.1:: and 1.
5392
5393 .section "Changing list separators" "SECTlistsepchange"
5394 .cindex "list separator" "changing"
5395 .cindex "IPv6" "addresses in lists"
5396 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5397 introduced to allow the separator character to be changed. If a list begins
5398 with a left angle bracket, followed by any punctuation character, that
5399 character is used instead of colon as the list separator. For example, the list
5400 above can be rewritten to use a semicolon separator like this:
5401 .code
5402 local_interfaces = <; 127.0.0.1 ; ::1
5403 .endd
5404 This facility applies to all lists, with the exception of the list in
5405 &%log_file_path%&. It is recommended that the use of non-colon separators be
5406 confined to circumstances where they really are needed.
5407
5408 .cindex "list separator" "newline as"
5409 .cindex "newline" "as list separator"
5410 It is also possible to use newline and other control characters (those with
5411 code values less than 32, plus DEL) as separators in lists. Such separators
5412 must be provided literally at the time the list is processed. For options that
5413 are string-expanded, you can write the separator using a normal escape
5414 sequence. This will be processed by the expander before the string is
5415 interpreted as a list. For example, if a newline-separated list of domains is
5416 generated by a lookup, you can process it directly by a line such as this:
5417 .code
5418 domains = <\n ${lookup mysql{.....}}
5419 .endd
5420 This avoids having to change the list separator in such data. You are unlikely
5421 to want to use a control character as a separator in an option that is not
5422 expanded, because the value is literal text. However, it can be done by giving
5423 the value in quotes. For example:
5424 .code
5425 local_interfaces = "<\n 127.0.0.1 \n ::1"
5426 .endd
5427 Unlike printing character separators, which can be included in list items by
5428 doubling, it is not possible to include a control character as data when it is
5429 set as the separator. Two such characters in succession are interpreted as
5430 enclosing an empty list item.
5431
5432
5433
5434 .section "Empty items in lists" "SECTempitelis"
5435 .cindex "list" "empty item in"
5436 An empty item at the end of a list is always ignored. In other words, trailing
5437 separator characters are ignored. Thus, the list in
5438 .code
5439 senders = user@domain :
5440 .endd
5441 contains only a single item. If you want to include an empty string as one item
5442 in a list, it must not be the last item. For example, this list contains three
5443 items, the second of which is empty:
5444 .code
5445 senders = user1@domain : : user2@domain
5446 .endd
5447 &*Note*&: There must be white space between the two colons, as otherwise they
5448 are interpreted as representing a single colon data character (and the list
5449 would then contain just one item). If you want to specify a list that contains
5450 just one, empty item, you can do it as in this example:
5451 .code
5452 senders = :
5453 .endd
5454 In this case, the first item is empty, and the second is discarded because it
5455 is at the end of the list.
5456
5457
5458
5459
5460 .section "Format of driver configurations" "SECTfordricon"
5461 .cindex "drivers" "configuration format"
5462 There are separate parts in the configuration for defining routers, transports,
5463 and authenticators. In each part, you are defining a number of driver
5464 instances, each with its own set of options. Each driver instance is defined by
5465 a sequence of lines like this:
5466 .display
5467 <&'instance name'&>:
5468   <&'option'&>
5469   ...
5470   <&'option'&>
5471 .endd
5472 In the following example, the instance name is &(localuser)&, and it is
5473 followed by three options settings:
5474 .code
5475 localuser:
5476   driver = accept
5477   check_local_user
5478   transport = local_delivery
5479 .endd
5480 For each driver instance, you specify which Exim code module it uses &-- by the
5481 setting of the &%driver%& option &-- and (optionally) some configuration
5482 settings. For example, in the case of transports, if you want a transport to
5483 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5484 a local file you would use the &(appendfile)& driver. Each of the drivers is
5485 described in detail in its own separate chapter later in this manual.
5486
5487 You can have several routers, transports, or authenticators that are based on
5488 the same underlying driver (each must have a different instance name).
5489
5490 The order in which routers are defined is important, because addresses are
5491 passed to individual routers one by one, in order. The order in which
5492 transports are defined does not matter at all. The order in which
5493 authenticators are defined is used only when Exim, as a client, is searching
5494 them to find one that matches an authentication mechanism offered by the
5495 server.
5496
5497 .cindex "generic options"
5498 .cindex "options" "generic &-- definition of"
5499 Within a driver instance definition, there are two kinds of option: &'generic'&
5500 and &'private'&. The generic options are those that apply to all drivers of the
5501 same type (that is, all routers, all transports or all authenticators). The
5502 &%driver%& option is a generic option that must appear in every definition.
5503 .cindex "private options"
5504 The private options are special for each driver, and none need appear, because
5505 they all have default values.
5506
5507 The options may appear in any order, except that the &%driver%& option must
5508 precede any private options, since these depend on the particular driver. For
5509 this reason, it is recommended that &%driver%& always be the first option.
5510
5511 Driver instance names, which are used for reference in log entries and
5512 elsewhere, can be any sequence of letters, digits, and underscores (starting
5513 with a letter) and must be unique among drivers of the same type. A router and
5514 a transport (for example) can each have the same name, but no two router
5515 instances can have the same name. The name of a driver instance should not be
5516 confused with the name of the underlying driver module. For example, the
5517 configuration lines:
5518 .code
5519 remote_smtp:
5520   driver = smtp
5521 .endd
5522 create an instance of the &(smtp)& transport driver whose name is
5523 &(remote_smtp)&. The same driver code can be used more than once, with
5524 different instance names and different option settings each time. A second
5525 instance of the &(smtp)& transport, with different options, might be defined
5526 thus:
5527 .code
5528 special_smtp:
5529   driver = smtp
5530   port = 1234
5531   command_timeout = 10s
5532 .endd
5533 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5534 these transport instances from routers, and these names would appear in log
5535 lines.
5536
5537 Comment lines may be present in the middle of driver specifications. The full
5538 list of option settings for any particular driver instance, including all the
5539 defaulted values, can be extracted by making use of the &%-bP%& command line
5540 option.
5541
5542
5543
5544
5545
5546
5547 . ////////////////////////////////////////////////////////////////////////////
5548 . ////////////////////////////////////////////////////////////////////////////
5549
5550 .chapter "The default configuration file" "CHAPdefconfil"
5551 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5552 .cindex "default" "configuration file &""walk through""&"
5553 The default configuration file supplied with Exim as &_src/configure.default_&
5554 is sufficient for a host with simple mail requirements. As an introduction to
5555 the way Exim is configured, this chapter &"walks through"& the default
5556 configuration, giving brief explanations of the settings. Detailed descriptions
5557 of the options are given in subsequent chapters. The default configuration file
5558 itself contains extensive comments about ways you might want to modify the
5559 initial settings. However, note that there are many options that are not
5560 mentioned at all in the default configuration.
5561
5562
5563
5564 .section "Macros" "SECTdefconfmacros"
5565 All macros should be defined before any options.
5566
5567 One macro is specified, but commented out, in the default configuration:
5568 .code
5569 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5570 .endd
5571 If all off-site mail is expected to be delivered to a "smarthost", then set the
5572 hostname here and uncomment the macro.  This will affect which router is used
5573 later on.  If this is left commented out, then Exim will perform direct-to-MX
5574 deliveries using a &(dnslookup)& router.
5575
5576 In addition to macros defined here, Exim includes a number of built-in macros
5577 to enable configuration to be guarded by a binary built with support for a
5578 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5579
5580
5581 .section "Main configuration settings" "SECTdefconfmain"
5582 The main (global) configuration option settings section must always come first
5583 in the file, after the macros.
5584 The first thing you'll see in the file, after some initial comments, is the line
5585 .code
5586 # primary_hostname =
5587 .endd
5588 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5589 to know the official, fully qualified name of your host, and this is where you
5590 can specify it. However, in most cases you do not need to set this option. When
5591 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5592
5593 The first three non-comment configuration lines are as follows:
5594 .code
5595 domainlist local_domains    = @
5596 domainlist relay_to_domains =
5597 hostlist   relay_from_hosts = 127.0.0.1
5598 .endd
5599 These are not, in fact, option settings. They are definitions of two named
5600 domain lists and one named host list. Exim allows you to give names to lists of
5601 domains, hosts, and email addresses, in order to make it easier to manage the
5602 configuration file (see section &<<SECTnamedlists>>&).
5603
5604 The first line defines a domain list called &'local_domains'&; this is used
5605 later in the configuration to identify domains that are to be delivered
5606 on the local host.
5607
5608 .cindex "@ in a domain list"
5609 There is just one item in this list, the string &"@"&. This is a special form
5610 of entry which means &"the name of the local host"&. Thus, if the local host is
5611 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5612 be delivered locally. Because the local host's name is referenced indirectly,
5613 the same configuration file can be used on different hosts.
5614
5615 The second line defines a domain list called &'relay_to_domains'&, but the
5616 list itself is empty. Later in the configuration we will come to the part that
5617 controls mail relaying through the local host; it allows relaying to any
5618 domains in this list. By default, therefore, no relaying on the basis of a mail
5619 domain is permitted.
5620
5621 The third line defines a host list called &'relay_from_hosts'&. This list is
5622 used later in the configuration to permit relaying from any host or IP address
5623 that matches the list. The default contains just the IP address of the IPv4
5624 loopback interface, which means that processes on the local host are able to
5625 submit mail for relaying by sending it over TCP/IP to that interface. No other
5626 hosts are permitted to submit messages for relaying.
5627
5628 Just to be sure there's no misunderstanding: at this point in the configuration
5629 we aren't actually setting up any controls. We are just defining some domains
5630 and hosts that will be used in the controls that are specified later.
5631
5632 The next two configuration lines are genuine option settings:
5633 .code
5634 acl_smtp_rcpt = acl_check_rcpt
5635 acl_smtp_data = acl_check_data
5636 .endd
5637 These options specify &'Access Control Lists'& (ACLs) that are to be used
5638 during an incoming SMTP session for every recipient of a message (every RCPT
5639 command), and after the contents of the message have been received,
5640 respectively. The names of the lists are &'acl_check_rcpt'& and
5641 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5642 section of the configuration. The RCPT ACL controls which recipients are
5643 accepted for an incoming message &-- if a configuration does not provide an ACL
5644 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5645 contents of a message to be checked.
5646
5647 Two commented-out option settings are next:
5648 .code
5649 # av_scanner = clamd:/tmp/clamd
5650 # spamd_address = 127.0.0.1 783
5651 .endd
5652 These are example settings that can be used when Exim is compiled with the
5653 content-scanning extension. The first specifies the interface to the virus
5654 scanner, and the second specifies the interface to SpamAssassin. Further
5655 details are given in chapter &<<CHAPexiscan>>&.
5656
5657 Three more commented-out option settings follow:
5658 .code
5659 # tls_advertise_hosts = *
5660 # tls_certificate = /etc/ssl/exim.crt
5661 # tls_privatekey = /etc/ssl/exim.pem
5662 .endd
5663 These are example settings that can be used when Exim is compiled with
5664 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5665 first one specifies the list of clients that are allowed to use TLS when
5666 connecting to this server; in this case, the wildcard means all clients. The
5667 other options specify where Exim should find its TLS certificate and private
5668 key, which together prove the server's identity to any clients that connect.
5669 More details are given in chapter &<<CHAPTLS>>&.
5670
5671 Another two commented-out option settings follow:
5672 .code
5673 # daemon_smtp_ports = 25 : 465 : 587
5674 # tls_on_connect_ports = 465
5675 .endd
5676 .cindex "port" "465 and 587"
5677 .cindex "port" "for message submission"
5678 .cindex "message" "submission, ports for"
5679 .cindex "submissions protocol"
5680 .cindex "smtps protocol"
5681 .cindex "ssmtp protocol"
5682 .cindex "SMTP" "submissions protocol"
5683 .cindex "SMTP" "ssmtp protocol"
5684 .cindex "SMTP" "smtps protocol"
5685 These options provide better support for roaming users who wish to use this
5686 server for message submission. They are not much use unless you have turned on
5687 TLS (as described in the previous paragraph) and authentication (about which
5688 more in section &<<SECTdefconfauth>>&).
5689 Mail submission from mail clients (MUAs) should be separate from inbound mail
5690 to your domain (MX delivery) for various good reasons (eg, ability to impose
5691 much saner TLS protocol and ciphersuite requirements without unintended
5692 consequences).
5693 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5694 which uses STARTTLS, so this is the &"submission"& port.
5695 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5696 which should be used in preference to 587.
5697 You should also consider deploying SRV records to help clients find
5698 these ports.
5699 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5700
5701 Two more commented-out options settings follow:
5702 .code
5703 # qualify_domain =
5704 # qualify_recipient =
5705 .endd
5706 The first of these specifies a domain that Exim uses when it constructs a
5707 complete email address from a local login name. This is often needed when Exim
5708 receives a message from a local process. If you do not set &%qualify_domain%&,
5709 the value of &%primary_hostname%& is used. If you set both of these options,
5710 you can have different qualification domains for sender and recipient
5711 addresses. If you set only the first one, its value is used in both cases.
5712
5713 .cindex "domain literal" "recognizing format"
5714 The following line must be uncommented if you want Exim to recognize
5715 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5716 (an IP address within square brackets) instead of a named domain.
5717 .code
5718 # allow_domain_literals
5719 .endd
5720 The RFCs still require this form, but many people think that in the modern
5721 Internet it makes little sense to permit mail to be sent to specific hosts by
5722 quoting their IP addresses. This ancient format has been used by people who
5723 try to abuse hosts by using them for unwanted relaying. However, some
5724 people believe there are circumstances (for example, messages addressed to
5725 &'postmaster'&) where domain literals are still useful.
5726
5727 The next configuration line is a kind of trigger guard:
5728 .code
5729 never_users = root
5730 .endd
5731 It specifies that no delivery must ever be run as the root user. The normal
5732 convention is to set up &'root'& as an alias for the system administrator. This
5733 setting is a guard against slips in the configuration.
5734 The list of users specified by &%never_users%& is not, however, the complete
5735 list; the build-time configuration in &_Local/Makefile_& has an option called
5736 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5737 contents of &%never_users%& are added to this list. By default
5738 FIXED_NEVER_USERS also specifies root.
5739
5740 When a remote host connects to Exim in order to send mail, the only information
5741 Exim has about the host's identity is its IP address. The next configuration
5742 line,
5743 .code
5744 host_lookup = *
5745 .endd
5746 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5747 in order to get a host name. This improves the quality of the logging
5748 information, but if you feel it is too expensive, you can remove it entirely,
5749 or restrict the lookup to hosts on &"nearby"& networks.
5750 Note that it is not always possible to find a host name from an IP address,
5751 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5752 unreachable.
5753
5754 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5755 1413 (hence their names):
5756 .code
5757 rfc1413_hosts = *
5758 rfc1413_query_timeout = 0s
5759 .endd
5760 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5761 Few hosts offer RFC1413 service these days; calls have to be
5762 terminated by a timeout and this needlessly delays the startup
5763 of an incoming SMTP connection.
5764 If you have hosts for which you trust RFC1413 and need this
5765 information, you can change this.
5766
5767 This line enables an efficiency SMTP option.  It is negotiated by clients
5768 and not expected to cause problems but can be disabled if needed.
5769 .code
5770 prdr_enable = true
5771 .endd
5772
5773 When Exim receives messages over SMTP connections, it expects all addresses to
5774 be fully qualified with a domain, as required by the SMTP definition. However,
5775 if you are running a server to which simple clients submit messages, you may
5776 find that they send unqualified addresses. The two commented-out options:
5777 .code
5778 # sender_unqualified_hosts =
5779 # recipient_unqualified_hosts =
5780 .endd
5781 show how you can specify hosts that are permitted to send unqualified sender
5782 and recipient addresses, respectively.
5783
5784 The &%log_selector%& option is used to increase the detail of logging
5785 over the default:
5786 .code
5787 log_selector = +smtp_protocol_error +smtp_syntax_error \
5788                +tls_certificate_verified
5789 .endd
5790
5791 The &%percent_hack_domains%& option is also commented out:
5792 .code
5793 # percent_hack_domains =
5794 .endd
5795 It provides a list of domains for which the &"percent hack"& is to operate.
5796 This is an almost obsolete form of explicit email routing. If you do not know
5797 anything about it, you can safely ignore this topic.
5798
5799 The next two settings in the main part of the default configuration are
5800 concerned with messages that have been &"frozen"& on Exim's queue. When a
5801 message is frozen, Exim no longer continues to try to deliver it. Freezing
5802 occurs when a bounce message encounters a permanent failure because the sender
5803 address of the original message that caused the bounce is invalid, so the
5804 bounce cannot be delivered. This is probably the most common case, but there
5805 are also other conditions that cause freezing, and frozen messages are not
5806 always bounce messages.
5807 .code
5808 ignore_bounce_errors_after = 2d
5809 timeout_frozen_after = 7d
5810 .endd
5811 The first of these options specifies that failing bounce messages are to be
5812 discarded after 2 days in the queue. The second specifies that any frozen
5813 message (whether a bounce message or not) is to be timed out (and discarded)
5814 after a week. In this configuration, the first setting ensures that no failing
5815 bounce message ever lasts a week.
5816
5817 Exim queues it's messages in a spool directory. If you expect to have
5818 large queues, you may consider using this option. It splits the spool
5819 directory into subdirectories to avoid file system degradation from
5820 many files in a single directory, resulting in better performance.
5821 Manual manipulation of queued messages becomes more complex (though fortunately
5822 not often needed).
5823 .code
5824 # split_spool_directory = true
5825 .endd
5826
5827 In an ideal world everybody follows the standards. For non-ASCII
5828 messages RFC 2047 is a standard, allowing a maximum line length of 76
5829 characters. Exim adheres that standard and won't process messages which
5830 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5831 In particular, the Exim maintainers have had multiple reports of
5832 problems from Russian administrators of issues until they disable this
5833 check, because of some popular, yet buggy, mail composition software.
5834 .code
5835 # check_rfc2047_length = false
5836 .endd
5837
5838 If you need to be strictly RFC compliant you may wish to disable the
5839 8BITMIME advertisement. Use this, if you exchange mails with systems
5840 that are not 8-bit clean.
5841 .code
5842 # accept_8bitmime = false
5843 .endd
5844
5845 Libraries you use may depend on specific environment settings.  This
5846 imposes a security risk (e.g. PATH). There are two lists:
5847 &%keep_environment%& for the variables to import as they are, and
5848 &%add_environment%& for variables we want to set to a fixed value.
5849 Note that TZ is handled separately, by the $%timezone%$ runtime
5850 option and by the TIMEZONE_DEFAULT buildtime option.
5851 .code
5852 # keep_environment = ^LDAP
5853 # add_environment = PATH=/usr/bin::/bin
5854 .endd
5855
5856
5857 .section "ACL configuration" "SECID54"
5858 .cindex "default" "ACLs"
5859 .cindex "&ACL;" "default configuration"
5860 In the default configuration, the ACL section follows the main configuration.
5861 It starts with the line
5862 .code
5863 begin acl
5864 .endd
5865 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5866 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5867 and &%acl_smtp_data%& above.
5868
5869 .cindex "RCPT" "ACL for"
5870 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5871 RCPT command specifies one of the message's recipients. The ACL statements
5872 are considered in order, until the recipient address is either accepted or
5873 rejected. The RCPT command is then accepted or rejected, according to the
5874 result of the ACL processing.
5875 .code
5876 acl_check_rcpt:
5877 .endd
5878 This line, consisting of a name terminated by a colon, marks the start of the
5879 ACL, and names it.
5880 .code
5881 accept  hosts = :
5882 .endd
5883 This ACL statement accepts the recipient if the sending host matches the list.
5884 But what does that strange list mean? It doesn't actually contain any host
5885 names or IP addresses. The presence of the colon puts an empty item in the
5886 list; Exim matches this only if the incoming message did not come from a remote
5887 host, because in that case, the remote hostname is empty. The colon is
5888 important. Without it, the list itself is empty, and can never match anything.
5889
5890 What this statement is doing is to accept unconditionally all recipients in
5891 messages that are submitted by SMTP from local processes using the standard
5892 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5893 manner.
5894 .code
5895 deny    message       = Restricted characters in address
5896         domains       = +local_domains
5897         local_parts   = ^[.] : ^.*[@%!/|]
5898
5899 deny    message       = Restricted characters in address
5900         domains       = !+local_domains
5901         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5902 .endd
5903 These statements are concerned with local parts that contain any of the
5904 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5905 Although these characters are entirely legal in local parts (in the case of
5906 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5907 in Internet mail addresses.
5908
5909 The first three have in the past been associated with explicitly routed
5910 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5911 option). Addresses containing these characters are regularly tried by spammers
5912 in an attempt to bypass relaying restrictions, and also by open relay testing
5913 programs. Unless you really need them it is safest to reject these characters
5914 at this early stage. This configuration is heavy-handed in rejecting these
5915 characters for all messages it accepts from remote hosts. This is a deliberate
5916 policy of being as safe as possible.
5917
5918 The first rule above is stricter, and is applied to messages that are addressed
5919 to one of the local domains handled by this host. This is implemented by the
5920 first condition, which restricts it to domains that are listed in the
5921 &'local_domains'& domain list. The &"+"& character is used to indicate a
5922 reference to a named list. In this configuration, there is just one domain in
5923 &'local_domains'&, but in general there may be many.
5924
5925 The second condition on the first statement uses two regular expressions to
5926 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5927 or &"|"&. If you have local accounts that include these characters, you will
5928 have to modify this rule.
5929
5930 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5931 allows them because they have been encountered in practice. (Consider the
5932 common convention of local parts constructed as
5933 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5934 the author of Exim, who has no second initial.) However, a local part starting
5935 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5936 filename (for example, for a mailing list). This is also true for local parts
5937 that contain slashes. A pipe symbol can also be troublesome if the local part
5938 is incorporated unthinkingly into a shell command line.
5939
5940 The second rule above applies to all other domains, and is less strict. This
5941 allows your own users to send outgoing messages to sites that use slashes
5942 and vertical bars in their local parts. It blocks local parts that begin
5943 with a dot, slash, or vertical bar, but allows these characters within the
5944 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5945 and &"!"& is blocked, as before. The motivation here is to prevent your users
5946 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5947 .code
5948 accept  local_parts   = postmaster
5949         domains       = +local_domains
5950 .endd
5951 This statement, which has two conditions, accepts an incoming address if the
5952 local part is &'postmaster'& and the domain is one of those listed in the
5953 &'local_domains'& domain list. The &"+"& character is used to indicate a
5954 reference to a named list. In this configuration, there is just one domain in
5955 &'local_domains'&, but in general there may be many.
5956
5957 The presence of this statement means that mail to postmaster is never blocked
5958 by any of the subsequent tests. This can be helpful while sorting out problems
5959 in cases where the subsequent tests are incorrectly denying access.
5960 .code
5961 require verify        = sender
5962 .endd
5963 This statement requires the sender address to be verified before any subsequent
5964 ACL statement can be used. If verification fails, the incoming recipient
5965 address is refused. Verification consists of trying to route the address, to
5966 see if a bounce message could be delivered to it. In the case of remote
5967 addresses, basic verification checks only the domain, but &'callouts'& can be
5968 used for more verification if required. Section &<<SECTaddressverification>>&
5969 discusses the details of address verification.
5970 .code
5971 accept  hosts         = +relay_from_hosts
5972         control       = submission
5973 .endd
5974 This statement accepts the address if the message is coming from one of the
5975 hosts that are defined as being allowed to relay through this host. Recipient
5976 verification is omitted here, because in many cases the clients are dumb MUAs
5977 that do not cope well with SMTP error responses. For the same reason, the
5978 second line specifies &"submission mode"& for messages that are accepted. This
5979 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5980 messages that are deficient in some way, for example, because they lack a
5981 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5982 probably add recipient verification here, and disable submission mode.
5983 .code
5984 accept  authenticated = *
5985         control       = submission
5986 .endd
5987 This statement accepts the address if the client host has authenticated itself.
5988 Submission mode is again specified, on the grounds that such messages are most
5989 likely to come from MUAs. The default configuration does not define any
5990 authenticators, though it does include some nearly complete commented-out
5991 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5992 fact authenticate until you complete the authenticator definitions.
5993 .code
5994 require message = relay not permitted
5995         domains = +local_domains : +relay_to_domains
5996 .endd
5997 This statement rejects the address if its domain is neither a local domain nor
5998 one of the domains for which this host is a relay.
5999 .code
6000 require verify = recipient
6001 .endd
6002 This statement requires the recipient address to be verified; if verification
6003 fails, the address is rejected.
6004 .code
6005 # deny    message     = rejected because $sender_host_address \
6006 #                       is in a black list at $dnslist_domain\n\
6007 #                       $dnslist_text
6008 #         dnslists    = black.list.example
6009 #
6010 # warn    dnslists    = black.list.example
6011 #         add_header  = X-Warning: $sender_host_address is in \
6012 #                       a black list at $dnslist_domain
6013 #         log_message = found in $dnslist_domain
6014 .endd
6015 These commented-out lines are examples of how you could configure Exim to check
6016 sending hosts against a DNS black list. The first statement rejects messages
6017 from blacklisted hosts, whereas the second just inserts a warning header
6018 line.
6019 .code
6020 # require verify = csa
6021 .endd
6022 This commented-out line is an example of how you could turn on client SMTP
6023 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6024 records.
6025 .code
6026 accept
6027 .endd
6028 The final statement in the first ACL unconditionally accepts any recipient
6029 address that has successfully passed all the previous tests.
6030 .code
6031 acl_check_data:
6032 .endd
6033 This line marks the start of the second ACL, and names it. Most of the contents
6034 of this ACL are commented out:
6035 .code
6036 # deny    malware   = *
6037 #         message   = This message contains a virus \
6038 #                     ($malware_name).
6039 .endd
6040 These lines are examples of how to arrange for messages to be scanned for
6041 viruses when Exim has been compiled with the content-scanning extension, and a
6042 suitable virus scanner is installed. If the message is found to contain a
6043 virus, it is rejected with the given custom error message.
6044 .code
6045 # warn    spam      = nobody
6046 #         message   = X-Spam_score: $spam_score\n\
6047 #                     X-Spam_score_int: $spam_score_int\n\
6048 #                     X-Spam_bar: $spam_bar\n\
6049 #                     X-Spam_report: $spam_report
6050 .endd
6051 These lines are an example of how to arrange for messages to be scanned by
6052 SpamAssassin when Exim has been compiled with the content-scanning extension,
6053 and SpamAssassin has been installed. The SpamAssassin check is run with
6054 &`nobody`& as its user parameter, and the results are added to the message as a
6055 series of extra header line. In this case, the message is not rejected,
6056 whatever the spam score.
6057 .code
6058 accept
6059 .endd
6060 This final line in the DATA ACL accepts the message unconditionally.
6061
6062
6063 .section "Router configuration" "SECID55"
6064 .cindex "default" "routers"
6065 .cindex "routers" "default"
6066 The router configuration comes next in the default configuration, introduced
6067 by the line
6068 .code
6069 begin routers
6070 .endd
6071 Routers are the modules in Exim that make decisions about where to send
6072 messages. An address is passed to each router, in turn, until it is either
6073 accepted, or failed. This means that the order in which you define the routers
6074 matters. Each router is fully described in its own chapter later in this
6075 manual. Here we give only brief overviews.
6076 .code
6077 # domain_literal:
6078 #   driver = ipliteral
6079 #   domains = !+local_domains
6080 #   transport = remote_smtp
6081 .endd
6082 .cindex "domain literal" "default router"
6083 This router is commented out because the majority of sites do not want to
6084 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6085 you uncomment this router, you also need to uncomment the setting of
6086 &%allow_domain_literals%& in the main part of the configuration.
6087
6088 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6089 macro has been defined, per
6090 .code
6091 .ifdef ROUTER_SMARTHOST
6092 smarthost:
6093 #...
6094 .else
6095 dnslookup:
6096 #...
6097 .endif
6098 .endd
6099
6100 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6101 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6102 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6103 skip these routers because of the &%domains%& option.
6104
6105 .code
6106 smarthost:
6107   driver = manualroute
6108   domains = ! +local_domains
6109   transport = smarthost_smtp
6110   route_data = ROUTER_SMARTHOST
6111   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6112   no_more
6113 .endd
6114 This router only handles mail which is not to any local domains; this is
6115 specified by the line
6116 .code
6117 domains = ! +local_domains
6118 .endd
6119 The &%domains%& option lists the domains to which this router applies, but the
6120 exclamation mark is a negation sign, so the router is used only for domains
6121 that are not in the domain list called &'local_domains'& (which was defined at
6122 the start of the configuration). The plus sign before &'local_domains'&
6123 indicates that it is referring to a named list. Addresses in other domains are
6124 passed on to the following routers.
6125
6126 The name of the router driver is &(manualroute)& because we are manually
6127 specifying how mail should be routed onwards, instead of using DNS MX.
6128 While the name of this router instance is arbitrary, the &%driver%& option must
6129 be one of the driver modules that is in the Exim binary.
6130
6131 With no pre-conditions other than &%domains%&, all mail for non-local domains
6132 will be handled by this router, and the &%no_more%& setting will ensure that no
6133 other routers will be used for messages matching the pre-conditions.  See
6134 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6135 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6136 and the macro supplies the value; the address is then queued for the
6137 &(smarthost_smtp)& transport.
6138
6139 .code
6140 dnslookup:
6141   driver = dnslookup
6142   domains = ! +local_domains
6143   transport = remote_smtp
6144   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6145   no_more
6146 .endd
6147 The &%domains%& option behaves as per smarthost, above.
6148
6149 The name of the router driver is &(dnslookup)&,
6150 and is specified by the &%driver%& option. Do not be confused by the fact that
6151 the name of this router instance is the same as the name of the driver. The
6152 instance name is arbitrary, but the name set in the &%driver%& option must be
6153 one of the driver modules that is in the Exim binary.
6154
6155 The &(dnslookup)& router routes addresses by looking up their domains in the
6156 DNS in order to obtain a list of hosts to which the address is routed. If the
6157 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6158 specified by the &%transport%& option. If the router does not find the domain
6159 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6160 the address fails and is bounced.
6161
6162 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6163 be entirely ignored. This option is present because a number of cases have been
6164 encountered where MX records in the DNS point to host names
6165 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6166 Completely ignoring these IP addresses causes Exim to fail to route the
6167 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6168 continue to try to deliver the message periodically until the address timed
6169 out.
6170 .code
6171 system_aliases:
6172   driver = redirect
6173   allow_fail
6174   allow_defer
6175   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6176 # user = exim
6177   file_transport = address_file
6178   pipe_transport = address_pipe
6179 .endd
6180 Control reaches this and subsequent routers only for addresses in the local
6181 domains. This router checks to see whether the local part is defined as an
6182 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6183 data that it looks up from that file. If no data is found for the local part,
6184 the value of the &%data%& option is empty, causing the address to be passed to
6185 the next router.
6186
6187 &_/etc/aliases_& is a conventional name for the system aliases file that is
6188 often used. That is why it is referenced by from the default configuration
6189 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6190 &_Local/Makefile_& before building Exim.
6191 .code
6192 userforward:
6193   driver = redirect
6194   check_local_user
6195 # local_part_suffix = +* : -*
6196 # local_part_suffix_optional
6197   file = $home/.forward
6198 # allow_filter
6199   no_verify
6200   no_expn
6201   check_ancestor
6202   file_transport = address_file
6203   pipe_transport = address_pipe
6204   reply_transport = address_reply
6205 .endd
6206 This is the most complicated router in the default configuration. It is another
6207 redirection router, but this time it is looking for forwarding data set up by
6208 individual users. The &%check_local_user%& setting specifies a check that the
6209 local part of the address is the login name of a local user. If it is not, the
6210 router is skipped. The two commented options that follow &%check_local_user%&,
6211 namely:
6212 .code
6213 # local_part_suffix = +* : -*
6214 # local_part_suffix_optional
6215 .endd
6216 .vindex "&$local_part_suffix$&"
6217 show how you can specify the recognition of local part suffixes. If the first
6218 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6219 by any sequence of characters, is removed from the local part and placed in the
6220 variable &$local_part_suffix$&. The second suffix option specifies that the
6221 presence of a suffix in the local part is optional. When a suffix is present,
6222 the check for a local login uses the local part with the suffix removed.
6223
6224 When a local user account is found, the file called &_.forward_& in the user's
6225 home directory is consulted. If it does not exist, or is empty, the router
6226 declines. Otherwise, the contents of &_.forward_& are interpreted as
6227 redirection data (see chapter &<<CHAPredirect>>& for more details).
6228
6229 .cindex "Sieve filter" "enabling in default router"
6230 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6231 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6232 is commented out by default), the contents of the file are interpreted as a set
6233 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6234 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6235 separate document entitled &'Exim's interfaces to mail filtering'&.
6236
6237 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6238 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6239 There are two reasons for doing this:
6240
6241 .olist
6242 Whether or not a local user has a &_.forward_& file is not really relevant when
6243 checking an address for validity; it makes sense not to waste resources doing
6244 unnecessary work.
6245 .next
6246 More importantly, when Exim is verifying addresses or handling an EXPN
6247 command during an SMTP session, it is running as the Exim user, not as root.
6248 The group is the Exim group, and no additional groups are set up.
6249 It may therefore not be possible for Exim to read users' &_.forward_& files at
6250 this time.
6251 .endlist
6252
6253 The setting of &%check_ancestor%& prevents the router from generating a new
6254 address that is the same as any previous address that was redirected. (This
6255 works round a problem concerning a bad interaction between aliasing and
6256 forwarding &-- see section &<<SECTredlocmai>>&).
6257
6258 The final three option settings specify the transports that are to be used when
6259 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6260 auto-reply, respectively. For example, if a &_.forward_& file contains
6261 .code
6262 a.nother@elsewhere.example, /home/spqr/archive
6263 .endd
6264 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6265 transport.
6266 .code
6267 localuser:
6268   driver = accept
6269   check_local_user
6270 # local_part_suffix = +* : -*
6271 # local_part_suffix_optional
6272   transport = local_delivery
6273 .endd
6274 The final router sets up delivery into local mailboxes, provided that the local
6275 part is the name of a local login, by accepting the address and assigning it to
6276 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6277 routers, so the address is bounced. The commented suffix settings fulfil the
6278 same purpose as they do for the &(userforward)& router.
6279
6280
6281 .section "Transport configuration" "SECID56"
6282 .cindex "default" "transports"
6283 .cindex "transports" "default"
6284 Transports define mechanisms for actually delivering messages. They operate
6285 only when referenced from routers, so the order in which they are defined does
6286 not matter. The transports section of the configuration starts with
6287 .code
6288 begin transports
6289 .endd
6290 Two remote transports and four local transports are defined.
6291 .code
6292 remote_smtp:
6293   driver = smtp
6294   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6295 .ifdef _HAVE_PRDR
6296   hosts_try_prdr = *
6297 .endif
6298 .endd
6299 This transport is used for delivering messages over SMTP connections.
6300 The list of remote hosts comes from the router.
6301 The &%message_size_limit%& usage is a hack to avoid sending on messages
6302 with over-long lines.
6303
6304 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6305 negotiated between client and server and not expected to cause problems
6306 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6307 use of the &%hosts_try_prdr%& configuration option.
6308
6309 The other remote transport is used when delivering to a specific smarthost
6310 with whom there must be some kind of existing relationship, instead of the
6311 usual federated system.
6312
6313 .code
6314 smarthost_smtp:
6315   driver = smtp
6316   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6317   multi_domain
6318   #
6319 .ifdef _HAVE_TLS
6320   # Comment out any of these which you have to, then file a Support
6321   # request with your smarthost provider to get things fixed:
6322   hosts_require_tls = *
6323   tls_verify_hosts = *
6324   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6325   # have to comment it out then this will at least log whether you succeed
6326   # or not:
6327   tls_try_verify_hosts = *
6328   #
6329   # The SNI name should match the name which we'll expect to verify;
6330   # many mail systems don't use SNI and this doesn't matter, but if it does,
6331   # we need to send a name which the remote site will recognize.
6332   # This _should_ be the name which the smarthost operators specified as
6333   # the hostname for sending your mail to.
6334   tls_sni = ROUTER_SMARTHOST
6335   #
6336 .ifdef _HAVE_OPENSSL
6337   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6338 .endif
6339 .ifdef _HAVE_GNUTLS
6340   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6341 .endif
6342 .endif
6343 .ifdef _HAVE_PRDR
6344   hosts_try_prdr = *
6345 .endif
6346 .endd
6347 After the same &%message_size_limit%& hack, we then specify that this Transport
6348 can handle messages to multiple domains in one run.  The assumption here is
6349 that you're routing all non-local mail to the same place and that place is
6350 happy to take all messages from you as quickly as possible.
6351 All other options depend upon built-in macros; if Exim was built without TLS support
6352 then no other options are defined.
6353 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6354 and versions using the &%tls_require_ciphers%& option, where the value to be
6355 used depends upon the library providing TLS.
6356 Beyond that, the options adopt the stance that you should have TLS support available
6357 from your smarthost on today's Internet, so we turn on requiring TLS for the
6358 mail to be delivered, and requiring that the certificate be valid, and match
6359 the expected hostname.  The &%tls_sni%& option can be used by service providers
6360 to select an appropriate certificate to present to you and here we re-use the
6361 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6362 You want to specify the hostname which you'll expect to validate for, and that
6363 should not be subject to insecure tampering via DNS results.
6364
6365 For the &%hosts_try_prdr%& option see the previous transport.
6366
6367 All other options are defaulted.
6368 .code
6369 local_delivery:
6370   driver = appendfile
6371   file = /var/mail/$local_part_verified
6372   delivery_date_add
6373   envelope_to_add
6374   return_path_add
6375 # group = mail
6376 # mode = 0660
6377 .endd
6378 This &(appendfile)& transport is used for local delivery to user mailboxes in
6379 traditional BSD mailbox format.
6380
6381 .new
6382 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6383 as it is provided by a potential bad actor.
6384 Instead we use &$local_part_verified$&,
6385 the result of looking up &$local_part$& in the user database
6386 (done by using &%check_local_user%& in the the router).
6387 .wen
6388
6389 By default &(appendfile)& runs under the uid and gid of the
6390 local user, which requires the sticky bit to be set on the &_/var/mail_&
6391 directory. Some systems use the alternative approach of running mail deliveries
6392 under a particular group instead of using the sticky bit. The commented options
6393 show how this can be done.
6394
6395 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6396 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6397 similarly-named options above.
6398 .code
6399 address_pipe:
6400   driver = pipe
6401   return_output
6402 .endd
6403 This transport is used for handling deliveries to pipes that are generated by
6404 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6405 option specifies that any output on stdout or stderr generated by the pipe is to
6406 be returned to the sender.
6407 .code
6408 address_file:
6409   driver = appendfile
6410   delivery_date_add
6411   envelope_to_add
6412   return_path_add
6413 .endd
6414 This transport is used for handling deliveries to files that are generated by
6415 redirection. The name of the file is not specified in this instance of
6416 &(appendfile)&, because it comes from the &(redirect)& router.
6417 .code
6418 address_reply:
6419   driver = autoreply
6420 .endd
6421 This transport is used for handling automatic replies generated by users'
6422 filter files.
6423
6424
6425
6426 .section "Default retry rule" "SECID57"
6427 .cindex "retry" "default rule"
6428 .cindex "default" "retry rule"
6429 The retry section of the configuration file contains rules which affect the way
6430 Exim retries deliveries that cannot be completed at the first attempt. It is
6431 introduced by the line
6432 .code
6433 begin retry
6434 .endd
6435 In the default configuration, there is just one rule, which applies to all
6436 errors:
6437 .code
6438 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6439 .endd
6440 This causes any temporarily failing address to be retried every 15 minutes for
6441 2 hours, then at intervals starting at one hour and increasing by a factor of
6442 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6443 is not delivered after 4 days of temporary failure, it is bounced. The time is
6444 measured from first failure, not from the time the message was received.
6445
6446 If the retry section is removed from the configuration, or is empty (that is,
6447 if no retry rules are defined), Exim will not retry deliveries. This turns
6448 temporary errors into permanent errors.
6449
6450
6451 .section "Rewriting configuration" "SECID58"
6452 The rewriting section of the configuration, introduced by
6453 .code
6454 begin rewrite
6455 .endd
6456 contains rules for rewriting addresses in messages as they arrive. There are no
6457 rewriting rules in the default configuration file.
6458
6459
6460
6461 .section "Authenticators configuration" "SECTdefconfauth"
6462 .cindex "AUTH" "configuration"
6463 The authenticators section of the configuration, introduced by
6464 .code
6465 begin authenticators
6466 .endd
6467 defines mechanisms for the use of the SMTP AUTH command. The default
6468 configuration file contains two commented-out example authenticators
6469 which support plaintext username/password authentication using the
6470 standard PLAIN mechanism and the traditional but non-standard LOGIN
6471 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6472 to support most MUA software.
6473
6474 The example PLAIN authenticator looks like this:
6475 .code
6476 #PLAIN:
6477 #  driver                  = plaintext
6478 #  server_set_id           = $auth2
6479 #  server_prompts          = :
6480 #  server_condition        = Authentication is not yet configured
6481 #  server_advertise_condition = ${if def:tls_in_cipher }
6482 .endd
6483 And the example LOGIN authenticator looks like this:
6484 .code
6485 #LOGIN:
6486 #  driver                  = plaintext
6487 #  server_set_id           = $auth1
6488 #  server_prompts          = <| Username: | Password:
6489 #  server_condition        = Authentication is not yet configured
6490 #  server_advertise_condition = ${if def:tls_in_cipher }
6491 .endd
6492
6493 The &%server_set_id%& option makes Exim remember the authenticated username
6494 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6495 &%server_prompts%& option configures the &(plaintext)& authenticator so
6496 that it implements the details of the specific authentication mechanism,
6497 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6498 when Exim offers authentication to clients; in the examples, this is only
6499 when TLS or SSL has been started, so to enable the authenticators you also
6500 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6501
6502 The &%server_condition%& setting defines how to verify that the username and
6503 password are correct. In the examples it just produces an error message.
6504 To make the authenticators work, you can use a string expansion
6505 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6506
6507 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6508 usercode and password are in different positions.
6509 Chapter &<<CHAPplaintext>>& covers both.
6510
6511 .ecindex IIDconfiwal
6512
6513
6514
6515 . ////////////////////////////////////////////////////////////////////////////
6516 . ////////////////////////////////////////////////////////////////////////////
6517
6518 .chapter "Regular expressions" "CHAPregexp"
6519
6520 .cindex "regular expressions" "library"
6521 .cindex "PCRE"
6522 Exim supports the use of regular expressions in many of its options. It
6523 uses the PCRE regular expression library; this provides regular expression
6524 matching that is compatible with Perl 5. The syntax and semantics of
6525 regular expressions is discussed in
6526 online Perl manpages, in
6527 many Perl reference books, and also in
6528 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6529 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6530 . --- the http: URL here redirects to another page with the ISBN in the URL
6531 . --- where trying to use https: just redirects back to http:, so sticking
6532 . --- to the old URL for now.  2018-09-07.
6533
6534 The documentation for the syntax and semantics of the regular expressions that
6535 are supported by PCRE is included in the PCRE distribution, and no further
6536 description is included here. The PCRE functions are called from Exim using
6537 the default option settings (that is, with no PCRE options set), except that
6538 the PCRE_CASELESS option is set when the matching is required to be
6539 case-insensitive.
6540
6541 In most cases, when a regular expression is required in an Exim configuration,
6542 it has to start with a circumflex, in order to distinguish it from plain text
6543 or an &"ends with"& wildcard. In this example of a configuration setting, the
6544 second item in the colon-separated list is a regular expression.
6545 .code
6546 domains = a.b.c : ^\\d{3} : *.y.z : ...
6547 .endd
6548 The doubling of the backslash is required because of string expansion that
6549 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6550 of this issue, and a way of avoiding the need for doubling backslashes. The
6551 regular expression that is eventually used in this example contains just one
6552 backslash. The circumflex is included in the regular expression, and has the
6553 normal effect of &"anchoring"& it to the start of the string that is being
6554 matched.
6555
6556 There are, however, two cases where a circumflex is not required for the
6557 recognition of a regular expression: these are the &%match%& condition in a
6558 string expansion, and the &%matches%& condition in an Exim filter file. In
6559 these cases, the relevant string is always treated as a regular expression; if
6560 it does not start with a circumflex, the expression is not anchored, and can
6561 match anywhere in the subject string.
6562
6563 In all cases, if you want a regular expression to match at the end of a string,
6564 you must code the $ metacharacter to indicate this. For example:
6565 .code
6566 domains = ^\\d{3}\\.example
6567 .endd
6568 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6569 You need to use:
6570 .code
6571 domains = ^\\d{3}\\.example\$
6572 .endd
6573 if you want &'example'& to be the top-level domain. The backslash before the
6574 $ is needed because string expansion also interprets dollar characters.
6575
6576
6577
6578 . ////////////////////////////////////////////////////////////////////////////
6579 . ////////////////////////////////////////////////////////////////////////////
6580
6581 .chapter "File and database lookups" "CHAPfdlookup"
6582 .scindex IIDfidalo1 "file" "lookups"
6583 .scindex IIDfidalo2 "database" "lookups"
6584 .cindex "lookup" "description of"
6585 Exim can be configured to look up data in files or databases as it processes
6586 messages. Two different kinds of syntax are used:
6587
6588 .olist
6589 A string that is to be expanded may contain explicit lookup requests. These
6590 cause parts of the string to be replaced by data that is obtained from the
6591 lookup. Lookups of this type are conditional expansion items. Different results
6592 can be defined for the cases of lookup success and failure. See chapter
6593 &<<CHAPexpand>>&, where string expansions are described in detail.
6594 The key for the lookup is specified as part of the string expansion.
6595 .next
6596 Lists of domains, hosts, and email addresses can contain lookup requests as a
6597 way of avoiding excessively long linear lists. In this case, the data that is
6598 returned by the lookup is often (but not always) discarded; whether the lookup
6599 succeeds or fails is what really counts. These kinds of list are described in
6600 chapter &<<CHAPdomhosaddlists>>&.
6601 The key for the lookup is given by the context in which the list is expanded.
6602 .endlist
6603
6604 String expansions, lists, and lookups interact with each other in such a way
6605 that there is no order in which to describe any one of them that does not
6606 involve references to the others. Each of these three chapters makes more sense
6607 if you have read the other two first. If you are reading this for the first
6608 time, be aware that some of it will make a lot more sense after you have read
6609 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6610
6611 .section "Examples of different lookup syntax" "SECID60"
6612 It is easy to confuse the two different kinds of lookup, especially as the
6613 lists that may contain the second kind are always expanded before being
6614 processed as lists. Therefore, they may also contain lookups of the first kind.
6615 Be careful to distinguish between the following two examples:
6616 .code
6617 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6618 domains = lsearch;/some/file
6619 .endd
6620 The first uses a string expansion, the result of which must be a domain list.
6621 No strings have been specified for a successful or a failing lookup; the
6622 defaults in this case are the looked-up data and an empty string, respectively.
6623 The expansion takes place before the string is processed as a list, and the
6624 file that is searched could contain lines like this:
6625 .code
6626 192.168.3.4: domain1:domain2:...
6627 192.168.1.9: domain3:domain4:...
6628 .endd
6629 When the lookup succeeds, the result of the expansion is a list of domains (and
6630 possibly other types of item that are allowed in domain lists).
6631
6632 In the second example, the lookup is a single item in a domain list. It causes
6633 Exim to use a lookup to see if the domain that is being processed can be found
6634 in the file. The file could contains lines like this:
6635 .code
6636 domain1:
6637 domain2:
6638 .endd
6639 Any data that follows the keys is not relevant when checking that the domain
6640 matches the list item.
6641
6642 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6643 Consider a file containing lines like this:
6644 .code
6645 192.168.5.6: lsearch;/another/file
6646 .endd
6647 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6648 first &%domains%& setting above generates the second setting, which therefore
6649 causes a second lookup to occur.
6650
6651 The rest of this chapter describes the different lookup types that are
6652 available. Any of them can be used in any part of the configuration where a
6653 lookup is permitted.
6654
6655
6656 .section "Lookup types" "SECID61"
6657 .cindex "lookup" "types of"
6658 .cindex "single-key lookup" "definition of"
6659 Two different types of data lookup are implemented:
6660
6661 .ilist
6662 The &'single-key'& type requires the specification of a file in which to look,
6663 and a single key to search for. The key must be a non-empty string for the
6664 lookup to succeed. The lookup type determines how the file is searched.
6665 .next
6666 .cindex "query-style lookup" "definition of"
6667 The &'query-style'& type accepts a generalized database query. No particular
6668 key value is assumed by Exim for query-style lookups. You can use whichever
6669 Exim variables you need to construct the database query.
6670 .endlist
6671
6672 The code for each lookup type is in a separate source file that is included in
6673 the binary of Exim only if the corresponding compile-time option is set. The
6674 default settings in &_src/EDITME_& are:
6675 .code
6676 LOOKUP_DBM=yes
6677 LOOKUP_LSEARCH=yes
6678 .endd
6679 which means that only linear searching and DBM lookups are included by default.
6680 For some types of lookup (e.g. SQL databases), you need to install appropriate
6681 libraries and header files before building Exim.
6682
6683
6684
6685
6686 .section "Single-key lookup types" "SECTsinglekeylookups"
6687 .cindex "lookup" "single-key types"
6688 .cindex "single-key lookup" "list of types"
6689 The following single-key lookup types are implemented:
6690
6691 .ilist
6692 .cindex "cdb" "description of"
6693 .cindex "lookup" "cdb"
6694 .cindex "binary zero" "in lookup key"
6695 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6696 string without a terminating binary zero. The cdb format is designed for
6697 indexed files that are read frequently and never updated, except by total
6698 re-creation. As such, it is particularly suitable for large files containing
6699 aliases or other indexed data referenced by an MTA. Information about cdb and
6700 tools for building the files can be found in several places:
6701 .display
6702 &url(https://cr.yp.to/cdb.html)
6703 &url(https://www.corpit.ru/mjt/tinycdb.html)
6704 &url(https://packages.debian.org/stable/utils/freecdb)
6705 &url(https://github.com/philpennock/cdbtools) (in Go)
6706 .endd
6707 A cdb distribution is not needed in order to build Exim with cdb support,
6708 because the code for reading cdb files is included directly in Exim itself.
6709 However, no means of building or testing cdb files is provided with Exim, so
6710 you need to obtain a cdb distribution in order to do this.
6711 .next
6712 .cindex "DBM" "lookup type"
6713 .cindex "lookup" "dbm"
6714 .cindex "binary zero" "in lookup key"
6715 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6716 DBM file by looking up the record with the given key. A terminating binary
6717 zero is included in the key that is passed to the DBM library. See section
6718 &<<SECTdb>>& for a discussion of DBM libraries.
6719
6720 .cindex "Berkeley DB library" "file format"
6721 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6722 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6723 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6724 the DB_UNKNOWN option. This enables it to handle any of the types of database
6725 that the library supports, and can be useful for accessing DBM files created by
6726 other applications. (For earlier DB versions, DB_HASH is always used.)
6727 .next
6728 .cindex "lookup" "dbmjz"
6729 .cindex "lookup" "dbm &-- embedded NULs"
6730 .cindex "sasldb2"
6731 .cindex "dbmjz lookup type"
6732 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6733 interpreted as an Exim list; the elements of the list are joined together with
6734 ASCII NUL characters to form the lookup key.  An example usage would be to
6735 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6736 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6737 &(cram_md5)& authenticator.
6738 .next
6739 .cindex "lookup" "dbmnz"
6740 .cindex "lookup" "dbm &-- terminating zero"
6741 .cindex "binary zero" "in lookup key"
6742 .cindex "Courier"
6743 .cindex "&_/etc/userdbshadow.dat_&"
6744 .cindex "dbmnz lookup type"
6745 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6746 is not included in the key that is passed to the DBM library. You may need this
6747 if you want to look up data in files that are created by or shared with some
6748 other application that does not use terminating zeros. For example, you need to
6749 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6750 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6751 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6752 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6753 .next
6754 .cindex "lookup" "dsearch"
6755 .cindex "dsearch lookup type"
6756 &(dsearch)&: The given file must be a directory; this is searched for an entry
6757 whose name is the key by calling the &[lstat()]& function. The key may not
6758 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6759 the lookup is the name of the entry, which may be a file, directory,
6760 symbolic link, or any other kind of directory entry. An example of how this
6761 lookup can be used to support virtual domains is given in section
6762 &<<SECTvirtualdomains>>&.
6763 .next
6764 .cindex "lookup" "iplsearch"
6765 .cindex "iplsearch lookup type"
6766 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6767 terminated by a colon or white space or the end of the line. The keys in the
6768 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6769 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6770 being interpreted as a key terminator. For example:
6771 .code
6772 1.2.3.4:           data for 1.2.3.4
6773 192.168.0.0/16:    data for 192.168.0.0/16
6774 "abcd::cdab":      data for abcd::cdab
6775 "abcd:abcd::/32"   data for abcd:abcd::/32
6776 .endd
6777 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6778 file is searched linearly, using the CIDR masks where present, until a matching
6779 key is found. The first key that matches is used; there is no attempt to find a
6780 &"best"& match. Apart from the way the keys are matched, the processing for
6781 &(iplsearch)& is the same as for &(lsearch)&.
6782
6783 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6784 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6785 lookup types support only literal keys.
6786
6787 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6788 the implicit key is the host's IP address rather than its name (see section
6789 &<<SECThoslispatsikey>>&).
6790
6791 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6792 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6793 notation before executing the lookup.)
6794 .next
6795 .cindex lookup json
6796 .cindex json "lookup type"
6797 .cindex JSON expansions
6798 &(json)&: The given file is a text file with a JSON structure.
6799 An element of the structure is extracted, defined by the search key.
6800 The key is a list of subelement selectors
6801 (colon-separated by default but changeable in the usual way)
6802 which are applied in turn to select smaller and smaller portions
6803 of the JSON structure.
6804 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6805 nunbered array element is selected.
6806 Otherwise it must apply to a JSON object; the named element is selected.
6807 The final resulting element can be a simple JSON type or a JSON object
6808 or array; for the latter two a string-representation os the JSON
6809 is returned.
6810 For elements of type string, the returned value is de-quoted.
6811 .next
6812 .cindex "linear search"
6813 .cindex "lookup" "lsearch"
6814 .cindex "lsearch lookup type"
6815 .cindex "case sensitivity" "in lsearch lookup"
6816 &(lsearch)&: The given file is a text file that is searched linearly for a
6817 line beginning with the search key, terminated by a colon or white space or the
6818 end of the line. The search is case-insensitive; that is, upper and lower case
6819 letters are treated as the same. The first occurrence of the key that is found
6820 in the file is used.
6821
6822 White space between the key and the colon is permitted. The remainder of the
6823 line, with leading and trailing white space removed, is the data. This can be
6824 continued onto subsequent lines by starting them with any amount of white
6825 space, but only a single space character is included in the data at such a
6826 junction. If the data begins with a colon, the key must be terminated by a
6827 colon, for example:
6828 .code
6829 baduser:  :fail:
6830 .endd
6831 Empty lines and lines beginning with # are ignored, even if they occur in the
6832 middle of an item. This is the traditional textual format of alias files. Note
6833 that the keys in an &(lsearch)& file are literal strings. There is no
6834 wildcarding of any kind.
6835
6836 .cindex "lookup" "lsearch &-- colons in keys"
6837 .cindex "white space" "in lsearch key"
6838 In most &(lsearch)& files, keys are not required to contain colons or #
6839 characters, or white space. However, if you need this feature, it is available.
6840 If a key begins with a doublequote character, it is terminated only by a
6841 matching quote (or end of line), and the normal escaping rules apply to its
6842 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6843 quoted keys (exactly as for unquoted keys). There is no special handling of
6844 quotes for the data part of an &(lsearch)& line.
6845
6846 .next
6847 .cindex "NIS lookup type"
6848 .cindex "lookup" "NIS"
6849 .cindex "binary zero" "in lookup key"
6850 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6851 the given key, without a terminating binary zero. There is a variant called
6852 &(nis0)& which does include the terminating binary zero in the key. This is
6853 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6854 aliases; the full map names must be used.
6855
6856 .next
6857 .cindex "wildlsearch lookup type"
6858 .cindex "lookup" "wildlsearch"
6859 .cindex "nwildlsearch lookup type"
6860 .cindex "lookup" "nwildlsearch"
6861 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6862 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6863 the file may be wildcarded. The difference between these two lookup types is
6864 that for &(wildlsearch)&, each key in the file is string-expanded before being
6865 used, whereas for &(nwildlsearch)&, no expansion takes place.
6866
6867 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6868 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6869 file that are regular expressions can be made case-sensitive by the use of
6870 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6871
6872 . ==== As this is a nested list, any displays it contains must be indented
6873 . ==== as otherwise they are too far to the left.
6874
6875 .olist
6876 The string may begin with an asterisk to mean &"ends with"&. For example:
6877 .code
6878     *.a.b.c       data for anything.a.b.c
6879     *fish         data for anythingfish
6880 .endd
6881 .next
6882 The string may begin with a circumflex to indicate a regular expression. For
6883 example, for &(wildlsearch)&:
6884 .code
6885     ^\N\d+\.a\.b\N    data for <digits>.a.b
6886 .endd
6887 Note the use of &`\N`& to disable expansion of the contents of the regular
6888 expression. If you are using &(nwildlsearch)&, where the keys are not
6889 string-expanded, the equivalent entry is:
6890 .code
6891     ^\d+\.a\.b        data for <digits>.a.b
6892 .endd
6893 The case-insensitive flag is set at the start of compiling the regular
6894 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6895 For example, to make the entire pattern case-sensitive:
6896 .code
6897     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6898 .endd
6899
6900 If the regular expression contains white space or colon characters, you must
6901 either quote it (see &(lsearch)& above), or represent these characters in other
6902 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6903 colon. This may be easier than quoting, because if you quote, you have to
6904 escape all the backslashes inside the quotes.
6905
6906 &*Note*&: It is not possible to capture substrings in a regular expression
6907 match for later use, because the results of all lookups are cached. If a lookup
6908 is repeated, the result is taken from the cache, and no actual pattern matching
6909 takes place. The values of all the numeric variables are unset after a
6910 &((n)wildlsearch)& match.
6911
6912 .next
6913 Although I cannot see it being of much use, the general matching function that
6914 is used to implement &((n)wildlsearch)& means that the string may begin with a
6915 lookup name terminated by a semicolon, and followed by lookup data. For
6916 example:
6917 .code
6918     cdb;/some/file  data for keys that match the file
6919 .endd
6920 The data that is obtained from the nested lookup is discarded.
6921 .endlist olist
6922
6923 Keys that do not match any of these patterns are interpreted literally. The
6924 continuation rules for the data are the same as for &(lsearch)&, and keys may
6925 be followed by optional colons.
6926
6927 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6928 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6929 lookup types support only literal keys.
6930
6931 .next
6932 .cindex "lookup" "spf"
6933 If Exim is built with SPF support, manual lookups can be done
6934 (as opposed to the standard ACL condition method.
6935 For details see section &<<SECSPF>>&.
6936 .endlist ilist
6937
6938
6939 .section "Query-style lookup types" "SECTquerystylelookups"
6940 .cindex "lookup" "query-style types"
6941 .cindex "query-style lookup" "list of types"
6942 The supported query-style lookup types are listed below. Further details about
6943 many of them are given in later sections.
6944
6945 .ilist
6946 .cindex "DNS" "as a lookup type"
6947 .cindex "lookup" "DNS"
6948 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6949 are given in the supplied query. The resulting data is the contents of the
6950 records. See section &<<SECTdnsdb>>&.
6951 .next
6952 .cindex "InterBase lookup type"
6953 .cindex "lookup" "InterBase"
6954 &(ibase)&: This does a lookup in an InterBase database.
6955 .next
6956 .cindex "LDAP" "lookup type"
6957 .cindex "lookup" "LDAP"
6958 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6959 returns attributes from a single entry. There is a variant called &(ldapm)&
6960 that permits values from multiple entries to be returned. A third variant
6961 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6962 any attribute values. See section &<<SECTldap>>&.
6963 .next
6964 .cindex "MySQL" "lookup type"
6965 .cindex "lookup" "MySQL"
6966 &(mysql)&: The format of the query is an SQL statement that is passed to a
6967 MySQL database. See section &<<SECTsql>>&.
6968 .next
6969 .cindex "NIS+ lookup type"
6970 .cindex "lookup" "NIS+"
6971 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6972 the field to be returned. See section &<<SECTnisplus>>&.
6973 .next
6974 .cindex "Oracle" "lookup type"
6975 .cindex "lookup" "Oracle"
6976 &(oracle)&: The format of the query is an SQL statement that is passed to an
6977 Oracle database. See section &<<SECTsql>>&.
6978 .next
6979 .cindex "lookup" "passwd"
6980 .cindex "passwd lookup type"
6981 .cindex "&_/etc/passwd_&"
6982 &(passwd)& is a query-style lookup with queries that are just user names. The
6983 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6984 success, the result string is the same as you would get from an &(lsearch)&
6985 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6986 password value. For example:
6987 .code
6988 *:42:42:King Rat:/home/kr:/bin/bash
6989 .endd
6990 .next
6991 .cindex "PostgreSQL lookup type"
6992 .cindex "lookup" "PostgreSQL"
6993 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6994 PostgreSQL database. See section &<<SECTsql>>&.
6995
6996 .next
6997 .cindex "Redis lookup type"
6998 .cindex lookup Redis
6999 &(redis)&: The format of the query is either a simple get or simple set,
7000 passed to a Redis database. See section &<<SECTsql>>&.
7001
7002 .next
7003 .cindex "sqlite lookup type"
7004 .cindex "lookup" "sqlite"
7005 &(sqlite)&: The format of the query is a filename followed by an SQL statement
7006 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7007
7008 .next
7009 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7010 not likely to be useful in normal operation.
7011 .next
7012 .cindex "whoson lookup type"
7013 .cindex "lookup" "whoson"
7014 . --- still http:-only, 2018-09-07
7015 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7016 allows a server to check whether a particular (dynamically allocated) IP
7017 address is currently allocated to a known (trusted) user and, optionally, to
7018 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7019 at one time for &"POP before SMTP"& authentication, but that approach has been
7020 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7021 &"POP before SMTP"& checking using ACL statements such as
7022 .code
7023 require condition = \
7024   ${lookup whoson {$sender_host_address}{yes}{no}}
7025 .endd
7026 The query consists of a single IP address. The value returned is the name of
7027 the authenticated user, which is stored in the variable &$value$&. However, in
7028 this example, the data in &$value$& is not used; the result of the lookup is
7029 one of the fixed strings &"yes"& or &"no"&.
7030 .endlist
7031
7032
7033
7034 .section "Temporary errors in lookups" "SECID63"
7035 .cindex "lookup" "temporary error in"
7036 Lookup functions can return temporary error codes if the lookup cannot be
7037 completed. For example, an SQL or LDAP database might be unavailable. For this
7038 reason, it is not advisable to use a lookup that might do this for critical
7039 options such as a list of local domains.
7040
7041 When a lookup cannot be completed in a router or transport, delivery
7042 of the message (to the relevant address) is deferred, as for any other
7043 temporary error. In other circumstances Exim may assume the lookup has failed,
7044 or may give up altogether.
7045
7046
7047
7048 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7049 .cindex "wildcard lookups"
7050 .cindex "lookup" "default values"
7051 .cindex "lookup" "wildcard"
7052 .cindex "lookup" "* added to type"
7053 .cindex "default" "in single-key lookups"
7054 In this context, a &"default value"& is a value specified by the administrator
7055 that is to be used if a lookup fails.
7056
7057 &*Note:*& This section applies only to single-key lookups. For query-style
7058 lookups, the facilities of the query language must be used. An attempt to
7059 specify a default for a query-style lookup provokes an error.
7060
7061 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7062 and the initial lookup fails, the key &"*"& is looked up in the file to
7063 provide a default value. See also the section on partial matching below.
7064
7065 .cindex "*@ with single-key lookup"
7066 .cindex "lookup" "*@ added to type"
7067 .cindex "alias file" "per-domain default"
7068 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7069 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7070 character, a second lookup is done with everything before the last @ replaced
7071 by *. This makes it possible to provide per-domain defaults in alias files
7072 that include the domains in the keys. If the second lookup fails (or doesn't
7073 take place because there is no @ in the key), &"*"& is looked up.
7074 For example, a &(redirect)& router might contain:
7075 .code
7076 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7077 .endd
7078 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7079 looks up these keys, in this order:
7080 .code
7081 jane@eyre.example
7082 *@eyre.example
7083 *
7084 .endd
7085 The data is taken from whichever key it finds first. &*Note*&: In an
7086 &(lsearch)& file, this does not mean the first of these keys in the file. A
7087 complete scan is done for each key, and only if it is not found at all does
7088 Exim move on to try the next key.
7089
7090
7091
7092 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7093 .cindex "partial matching"
7094 .cindex "wildcard lookups"
7095 .cindex "lookup" "partial matching"
7096 .cindex "lookup" "wildcard"
7097 .cindex "asterisk" "in search type"
7098 The normal operation of a single-key lookup is to search the file for an exact
7099 match with the given key. However, in a number of situations where domains are
7100 being looked up, it is useful to be able to do partial matching. In this case,
7101 information in the file that has a key starting with &"*."& is matched by any
7102 domain that ends with the components that follow the full stop. For example, if
7103 a key in a DBM file is
7104 .code
7105 *.dates.fict.example
7106 .endd
7107 then when partial matching is enabled this is matched by (amongst others)
7108 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7109 by &'dates.fict.example'&, if that does not appear as a separate key in the
7110 file.
7111
7112 &*Note*&: Partial matching is not available for query-style lookups. It is
7113 also not available for any lookup items in address lists (see section
7114 &<<SECTaddresslist>>&).
7115
7116 Partial matching is implemented by doing a series of separate lookups using
7117 keys constructed by modifying the original subject key. This means that it can
7118 be used with any of the single-key lookup types, provided that
7119 partial matching keys
7120 beginning with a special prefix (default &"*."&) are included in the data file.
7121 Keys in the file that do not begin with the prefix are matched only by
7122 unmodified subject keys when partial matching is in use.
7123
7124 Partial matching is requested by adding the string &"partial-"& to the front of
7125 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7126 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7127 is added at the start of the subject key, and it is looked up again. If that
7128 fails, further lookups are tried with dot-separated components removed from the
7129 start of the subject key, one-by-one, and &"*."& added on the front of what
7130 remains.
7131
7132 A minimum number of two non-* components are required. This can be adjusted
7133 by including a number before the hyphen in the search type. For example,
7134 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7135 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7136 subject key is &'2250.dates.fict.example'& then the following keys are looked
7137 up when the minimum number of non-* components is two:
7138 .code
7139 2250.dates.fict.example
7140 *.2250.dates.fict.example
7141 *.dates.fict.example
7142 *.fict.example
7143 .endd
7144 As soon as one key in the sequence is successfully looked up, the lookup
7145 finishes.
7146
7147 .cindex "lookup" "partial matching &-- changing prefix"
7148 .cindex "prefix" "for partial matching"
7149 The use of &"*."& as the partial matching prefix is a default that can be
7150 changed. The motivation for this feature is to allow Exim to operate with file
7151 formats that are used by other MTAs. A different prefix can be supplied in
7152 parentheses instead of the hyphen after &"partial"&. For example:
7153 .code
7154 domains = partial(.)lsearch;/some/file
7155 .endd
7156 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7157 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7158 components is unchanged). The prefix may consist of any punctuation characters
7159 other than a closing parenthesis. It may be empty, for example:
7160 .code
7161 domains = partial1()cdb;/some/file
7162 .endd
7163 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7164 &`a.b.c`&, &`b.c`&, and &`c`&.
7165
7166 If &"partial0"& is specified, what happens at the end (when the lookup with
7167 just one non-wild component has failed, and the original key is shortened right
7168 down to the null string) depends on the prefix:
7169
7170 .ilist
7171 If the prefix has zero length, the whole lookup fails.
7172 .next
7173 If the prefix has length 1, a lookup for just the prefix is done. For
7174 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7175 .next
7176 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7177 remainder is looked up. With the default prefix, therefore, the final lookup is
7178 for &"*"& on its own.
7179 .next
7180 Otherwise, the whole prefix is looked up.
7181 .endlist
7182
7183
7184 If the search type ends in &"*"& or &"*@"& (see section
7185 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7186 this implies happens after all partial lookups have failed. If &"partial0"& is
7187 specified, adding &"*"& to the search type has no effect with the default
7188 prefix, because the &"*"& key is already included in the sequence of partial
7189 lookups. However, there might be a use for lookup types such as
7190 &"partial0(.)lsearch*"&.
7191
7192 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7193 in domain lists and the like. Partial matching works only in terms of
7194 dot-separated components; a key such as &`*fict.example`&
7195 in a database file is useless, because the asterisk in a partial matching
7196 subject key is always followed by a dot.
7197
7198
7199
7200
7201 .section "Lookup caching" "SECID64"
7202 .cindex "lookup" "caching"
7203 .cindex "caching" "lookup data"
7204 Exim caches all lookup results in order to avoid needless repetition of
7205 lookups. However, because (apart from the daemon) Exim operates as a collection
7206 of independent, short-lived processes, this caching applies only within a
7207 single Exim process. There is no inter-process lookup caching facility.
7208
7209 For single-key lookups, Exim keeps the relevant files open in case there is
7210 another lookup that needs them. In some types of configuration this can lead to
7211 many files being kept open for messages with many recipients. To avoid hitting
7212 the operating system limit on the number of simultaneously open files, Exim
7213 closes the least recently used file when it needs to open more files than its
7214 own internal limit, which can be changed via the &%lookup_open_max%& option.
7215
7216 The single-key lookup files are closed and the lookup caches are flushed at
7217 strategic points during delivery &-- for example, after all routing is
7218 complete.
7219
7220
7221
7222
7223 .section "Quoting lookup data" "SECID65"
7224 .cindex "lookup" "quoting"
7225 .cindex "quoting" "in lookups"
7226 When data from an incoming message is included in a query-style lookup, there
7227 is the possibility of special characters in the data messing up the syntax of
7228 the query. For example, a NIS+ query that contains
7229 .code
7230 [name=$local_part]
7231 .endd
7232 will be broken if the local part happens to contain a closing square bracket.
7233 For NIS+, data can be enclosed in double quotes like this:
7234 .code
7235 [name="$local_part"]
7236 .endd
7237 but this still leaves the problem of a double quote in the data. The rule for
7238 NIS+ is that double quotes must be doubled. Other lookup types have different
7239 rules, and to cope with the differing requirements, an expansion operator
7240 of the following form is provided:
7241 .code
7242 ${quote_<lookup-type>:<string>}
7243 .endd
7244 For example, the safest way to write the NIS+ query is
7245 .code
7246 [name="${quote_nisplus:$local_part}"]
7247 .endd
7248 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7249 operator can be used for all lookup types, but has no effect for single-key
7250 lookups, since no quoting is ever needed in their key strings.
7251
7252
7253
7254
7255 .section "More about dnsdb" "SECTdnsdb"
7256 .cindex "dnsdb lookup"
7257 .cindex "lookup" "dnsdb"
7258 .cindex "DNS" "as a lookup type"
7259 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7260 of a record type and a domain name, separated by an equals sign. For example,
7261 an expansion string could contain:
7262 .code
7263 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7264 .endd
7265 If the lookup succeeds, the result is placed in &$value$&, which in this case
7266 is used on its own as the result. If the lookup does not succeed, the
7267 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7268 &<<SECTforexpfai>>& for an explanation of what this means.
7269
7270 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7271 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7272 If no type is given, TXT is assumed.
7273
7274 For any record type, if multiple records are found, the data is returned as a
7275 concatenation, with newline as the default separator. The order, of course,
7276 depends on the DNS resolver. You can specify a different separator character
7277 between multiple records by putting a right angle-bracket followed immediately
7278 by the new separator at the start of the query. For example:
7279 .code
7280 ${lookup dnsdb{>: a=host1.example}}
7281 .endd
7282 It is permitted to specify a space as the separator character. Further
7283 white space is ignored.
7284 For lookup types that return multiple fields per record,
7285 an alternate field separator can be specified using a comma after the main
7286 separator character, followed immediately by the field separator.
7287
7288 .cindex "PTR record" "in &(dnsdb)& lookup"
7289 When the type is PTR,
7290 the data can be an IP address, written as normal; inversion and the addition of
7291 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7292 .code
7293 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7294 .endd
7295 If the data for a PTR record is not a syntactically valid IP address, it is not
7296 altered and nothing is added.
7297
7298 .cindex "MX record" "in &(dnsdb)& lookup"
7299 .cindex "SRV record" "in &(dnsdb)& lookup"
7300 For an MX lookup, both the preference value and the host name are returned for
7301 each record, separated by a space. For an SRV lookup, the priority, weight,
7302 port, and host name are returned for each record, separated by spaces.
7303 The field separator can be modified as above.
7304
7305 .cindex "TXT record" "in &(dnsdb)& lookup"
7306 .cindex "SPF record" "in &(dnsdb)& lookup"
7307 For TXT records with multiple items of data, only the first item is returned,
7308 unless a field separator is specified.
7309 To concatenate items without a separator, use a semicolon instead.
7310 For SPF records the
7311 default behaviour is to concatenate multiple items without using a separator.
7312 .code
7313 ${lookup dnsdb{>\n,: txt=a.b.example}}
7314 ${lookup dnsdb{>\n; txt=a.b.example}}
7315 ${lookup dnsdb{spf=example.org}}
7316 .endd
7317 It is permitted to specify a space as the separator character. Further
7318 white space is ignored.
7319
7320 .cindex "SOA record" "in &(dnsdb)& lookup"
7321 For an SOA lookup, while no result is obtained the lookup is redone with
7322 successively more leading components dropped from the given domain.
7323 Only the primary-nameserver field is returned unless a field separator is
7324 specified.
7325 .code
7326 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7327 .endd
7328
7329 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7330 .cindex "dnsdb modifiers"
7331 .cindex "modifiers" "dnsdb"
7332 .cindex "options" "dnsdb"
7333 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7334 each followed by a comma,
7335 that may appear before the record type.
7336
7337 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7338 temporary DNS error for any of them, the behaviour is controlled by
7339 a defer-option modifier.
7340 The possible keywords are
7341 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7342 With &"strict"& behaviour, any temporary DNS error causes the
7343 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7344 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7345 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7346 error causes the whole lookup to defer only if none of the other lookups
7347 succeed. The default is &"lax"&, so the following lookups are equivalent:
7348 .code
7349 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7350 ${lookup dnsdb{a=one.host.com:two.host.com}}
7351 .endd
7352 Thus, in the default case, as long as at least one of the DNS lookups
7353 yields some data, the lookup succeeds.
7354
7355 .cindex "DNSSEC" "dns lookup"
7356 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7357 The possible keywords are
7358 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7359 With &"strict"& or &"lax"& DNSSEC information is requested
7360 with the lookup.
7361 With &"strict"& a response from the DNS resolver that
7362 is not labelled as authenticated data
7363 is treated as equivalent to a temporary DNS error.
7364 The default is &"lax"&.
7365
7366 See also the &$lookup_dnssec_authenticated$& variable.
7367
7368 .cindex timeout "dns lookup"
7369 .cindex "DNS" timeout
7370 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7371 The form is &"retrans_VAL"& where VAL is an Exim time specification
7372 (e.g. &"5s"&).
7373 The default value is set by the main configuration option &%dns_retrans%&.
7374
7375 Retries for the dnsdb lookup can be controlled by a retry modifier.
7376 The form if &"retry_VAL"& where VAL is an integer.
7377 The default count is set by the main configuration option &%dns_retry%&.
7378
7379 .cindex caching "of dns lookup"
7380 .cindex TTL "of dns lookup"
7381 .cindex DNS TTL
7382 Dnsdb lookup results are cached within a single process (and its children).
7383 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7384 value of the set of returned DNS records.
7385
7386
7387 .section "Pseudo dnsdb record types" "SECID66"
7388 .cindex "MX record" "in &(dnsdb)& lookup"
7389 By default, both the preference value and the host name are returned for
7390 each MX record, separated by a space. If you want only host names, you can use
7391 the pseudo-type MXH:
7392 .code
7393 ${lookup dnsdb{mxh=a.b.example}}
7394 .endd
7395 In this case, the preference values are omitted, and just the host names are
7396 returned.
7397
7398 .cindex "name server for enclosing domain"
7399 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7400 records on the given domain, but if none are found, it removes the first
7401 component of the domain name, and tries again. This process continues until NS
7402 records are found or there are no more components left (or there is a DNS
7403 error). In other words, it may return the name servers for a top-level domain,
7404 but it never returns the root name servers. If there are no NS records for the
7405 top-level domain, the lookup fails. Consider these examples:
7406 .code
7407 ${lookup dnsdb{zns=xxx.quercite.com}}
7408 ${lookup dnsdb{zns=xxx.edu}}
7409 .endd
7410 Assuming that in each case there are no NS records for the full domain name,
7411 the first returns the name servers for &%quercite.com%&, and the second returns
7412 the name servers for &%edu%&.
7413
7414 You should be careful about how you use this lookup because, unless the
7415 top-level domain does not exist, the lookup always returns some host names. The
7416 sort of use to which this might be put is for seeing if the name servers for a
7417 given domain are on a blacklist. You can probably assume that the name servers
7418 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7419 such a list.
7420
7421 .cindex "CSA" "in &(dnsdb)& lookup"
7422 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7423 records according to the CSA rules, which are described in section
7424 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7425 not sufficient because of the extra parent domain search behaviour of CSA. The
7426 result of a successful lookup such as:
7427 .code
7428 ${lookup dnsdb {csa=$sender_helo_name}}
7429 .endd
7430 has two space-separated fields: an authorization code and a target host name.
7431 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7432 authorization required but absent, or &"?"& for unknown.
7433
7434 .cindex "A+" "in &(dnsdb)& lookup"
7435 The pseudo-type A+ performs an AAAA
7436 and then an A lookup.  All results are returned; defer processing
7437 (see below) is handled separately for each lookup.  Example:
7438 .code
7439 ${lookup dnsdb {>; a+=$sender_helo_name}}
7440 .endd
7441
7442
7443 .section "Multiple dnsdb lookups" "SECID67"
7444 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7445 However, you can specify a list of domains or IP addresses in a single
7446 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7447 the default separator, but with the ability to change this. For example:
7448 .code
7449 ${lookup dnsdb{one.domain.com:two.domain.com}}
7450 ${lookup dnsdb{a=one.host.com:two.host.com}}
7451 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7452 .endd
7453 In order to retain backwards compatibility, there is one special case: if
7454 the lookup type is PTR and no change of separator is specified, Exim looks
7455 to see if the rest of the string is precisely one IPv6 address. In this
7456 case, it does not treat it as a list.
7457
7458 The data from each lookup is concatenated, with newline separators by default,
7459 in the same way that multiple DNS records for a single item are handled. A
7460 different separator can be specified, as described above.
7461
7462
7463
7464
7465 .section "More about LDAP" "SECTldap"
7466 .cindex "LDAP" "lookup, more about"
7467 .cindex "lookup" "LDAP"
7468 .cindex "Solaris" "LDAP"
7469 The original LDAP implementation came from the University of Michigan; this has
7470 become &"Open LDAP"&, and there are now two different releases. Another
7471 implementation comes from Netscape, and Solaris 7 and subsequent releases
7472 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7473 the lookup function level, their error handling is different. For this reason
7474 it is necessary to set a compile-time variable when building Exim with LDAP, to
7475 indicate which LDAP library is in use. One of the following should appear in
7476 your &_Local/Makefile_&:
7477 .code
7478 LDAP_LIB_TYPE=UMICHIGAN
7479 LDAP_LIB_TYPE=OPENLDAP1
7480 LDAP_LIB_TYPE=OPENLDAP2
7481 LDAP_LIB_TYPE=NETSCAPE
7482 LDAP_LIB_TYPE=SOLARIS
7483 .endd
7484 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7485 same interface as the University of Michigan version.
7486
7487 There are three LDAP lookup types in Exim. These behave slightly differently in
7488 the way they handle the results of a query:
7489
7490 .ilist
7491 &(ldap)& requires the result to contain just one entry; if there are more, it
7492 gives an error.
7493 .next
7494 &(ldapdn)& also requires the result to contain just one entry, but it is the
7495 Distinguished Name that is returned rather than any attribute values.
7496 .next
7497 &(ldapm)& permits the result to contain more than one entry; the attributes
7498 from all of them are returned.
7499 .endlist
7500
7501
7502 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7503 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7504 the data returned by a successful lookup is described in the next section.
7505 First we explain how LDAP queries are coded.
7506
7507
7508 .section "Format of LDAP queries" "SECTforldaque"
7509 .cindex "LDAP" "query format"
7510 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7511 the configuration of a &(redirect)& router one might have this setting:
7512 .code
7513 data = ${lookup ldap \
7514   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7515   c=UK?mailbox?base?}}
7516 .endd
7517 .cindex "LDAP" "with TLS"
7518 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7519 secure (encrypted) LDAP connections. The second of these ensures that an
7520 encrypted TLS connection is used.
7521
7522 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7523 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7524 See the &%ldap_start_tls%& option.
7525
7526 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7527 controlled. Every part of the TLS configuration can be configured by settings in
7528 &_exim.conf_&. Depending on the version of the client libraries installed on
7529 your system, some of the initialization may have required setting options in
7530 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7531 certificates. This revealed a nuance where the current UID that exim was
7532 running as could affect which config files it read. With Exim 4.83, these
7533 methods become optional, only taking effect if not specifically set in
7534 &_exim.conf_&.
7535
7536
7537 .section "LDAP quoting" "SECID68"
7538 .cindex "LDAP" "quoting"
7539 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7540 and the second because the LDAP query is represented as a URL. Furthermore,
7541 within an LDAP query, two different kinds of quoting are required. For this
7542 reason, there are two different LDAP-specific quoting operators.
7543
7544 The &%quote_ldap%& operator is designed for use on strings that are part of
7545 filter specifications. Conceptually, it first does the following conversions on
7546 the string:
7547 .code
7548 *   =>   \2A
7549 (   =>   \28
7550 )   =>   \29
7551 \   =>   \5C
7552 .endd
7553 in accordance with RFC 2254. The resulting string is then quoted according
7554 to the rules for URLs, that is, all non-alphanumeric characters except
7555 .code
7556 ! $ ' - . _ ( ) * +
7557 .endd
7558 are converted to their hex values, preceded by a percent sign. For example:
7559 .code
7560 ${quote_ldap: a(bc)*, a<yz>; }
7561 .endd
7562 yields
7563 .code
7564 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7565 .endd
7566 Removing the URL quoting, this is (with a leading and a trailing space):
7567 .code
7568 a\28bc\29\2A, a<yz>;
7569 .endd
7570 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7571 base DN specifications in queries. Conceptually, it first converts the string
7572 by inserting a backslash in front of any of the following characters:
7573 .code
7574 , + " \ < > ;
7575 .endd
7576 It also inserts a backslash before any leading spaces or # characters, and
7577 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7578 is then quoted according to the rules for URLs. For example:
7579 .code
7580 ${quote_ldap_dn: a(bc)*, a<yz>; }
7581 .endd
7582 yields
7583 .code
7584 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7585 .endd
7586 Removing the URL quoting, this is (with a trailing space):
7587 .code
7588 \ a(bc)*\, a\<yz\>\;\
7589 .endd
7590 There are some further comments about quoting in the section on LDAP
7591 authentication below.
7592
7593
7594 .section "LDAP connections" "SECID69"
7595 .cindex "LDAP" "connections"
7596 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7597 is in use, via a Unix domain socket. The example given above does not specify
7598 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7599 by starting it with
7600 .code
7601 ldap://<hostname>:<port>/...
7602 .endd
7603 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7604 used. When no server is specified in a query, a list of default servers is
7605 taken from the &%ldap_default_servers%& configuration option. This supplies a
7606 colon-separated list of servers which are tried in turn until one successfully
7607 handles a query, or there is a serious error. Successful handling either
7608 returns the requested data, or indicates that it does not exist. Serious errors
7609 are syntactical, or multiple values when only a single value is expected.
7610 Errors which cause the next server to be tried are connection failures, bind
7611 failures, and timeouts.
7612
7613 For each server name in the list, a port number can be given. The standard way
7614 of specifying a host and port is to use a colon separator (RFC 1738). Because
7615 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7616 doubled. For example
7617 .code
7618 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7619 .endd
7620 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7621 to the LDAP library with no server name, and the library's default (normally
7622 the local host) is used.
7623
7624 If you are using the OpenLDAP library, you can connect to an LDAP server using
7625 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7626 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7627 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7628 not available.
7629
7630 For this type of connection, instead of a host name for the server, a pathname
7631 for the socket is required, and the port number is not relevant. The pathname
7632 can be specified either as an item in &%ldap_default_servers%&, or inline in
7633 the query. In the former case, you can have settings such as
7634 .code
7635 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7636 .endd
7637 When the pathname is given in the query, you have to escape the slashes as
7638 &`%2F`& to fit in with the LDAP URL syntax. For example:
7639 .code
7640 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7641 .endd
7642 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7643 a pathname, it uses the Unix domain socket code, even if the query actually
7644 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7645 socket connection. This behaviour means that you can use a setting of
7646 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7647 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7648 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7649 backup host.
7650
7651 If an explicit &`ldapi`& type is given in a query when a host name is
7652 specified, an error is diagnosed. However, if there are more items in
7653 &%ldap_default_servers%&, they are tried. In other words:
7654
7655 .ilist
7656 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7657 interface.
7658 .next
7659 Using &`ldapi`& with a host name causes an error.
7660 .endlist
7661
7662
7663 Using &`ldapi`& with no host or path in the query, and no setting of
7664 &%ldap_default_servers%&, does whatever the library does by default.
7665
7666
7667
7668 .section "LDAP authentication and control information" "SECID70"
7669 .cindex "LDAP" "authentication"
7670 The LDAP URL syntax provides no way of passing authentication and other control
7671 information to the server. To make this possible, the URL in an LDAP query may
7672 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7673 spaces. If a value contains spaces it must be enclosed in double quotes, and
7674 when double quotes are used, backslash is interpreted in the usual way inside
7675 them. The following names are recognized:
7676 .display
7677 &`DEREFERENCE`&  set the dereferencing parameter
7678 &`NETTIME    `&  set a timeout for a network operation
7679 &`USER       `&  set the DN, for authenticating the LDAP bind
7680 &`PASS       `&  set the password, likewise
7681 &`REFERRALS  `&  set the referrals parameter
7682 &`SERVERS    `&  set alternate server list for this query only
7683 &`SIZE       `&  set the limit for the number of entries returned
7684 &`TIME       `&  set the maximum waiting time for a query
7685 .endd
7686 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7687 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7688 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7689 library from trying to follow referrals issued by the LDAP server.
7690
7691 .cindex LDAP timeout
7692 .cindex timeout "LDAP lookup"
7693 The name CONNECT is an obsolete name for NETTIME, retained for
7694 backwards compatibility. This timeout (specified as a number of seconds) is
7695 enforced from the client end for operations that can be carried out over a
7696 network. Specifically, it applies to network connections and calls to the
7697 &'ldap_result()'& function. If the value is greater than zero, it is used if
7698 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7699 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7700 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7701 Netscape SDK; for OpenLDAP no action is taken.
7702
7703 The TIME parameter (also a number of seconds) is passed to the server to
7704 set a server-side limit on the time taken to complete a search.
7705
7706 The SERVERS parameter allows you to specify an alternate list of ldap servers
7707 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7708 default list of ldap servers, and a single lookup can specify a single ldap
7709 server to use.  But when you need to do a lookup with a list of servers that is
7710 different than the default list (maybe different order, maybe a completely
7711 different set of servers), the SERVERS parameter allows you to specify this
7712 alternate list (colon-separated).
7713
7714 Here is an example of an LDAP query in an Exim lookup that uses some of these
7715 values. This is a single line, folded to fit on the page:
7716 .code
7717 ${lookup ldap
7718   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7719   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7720   {$value}fail}
7721 .endd
7722 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7723 any of the auxiliary data. Exim configuration settings that include lookups
7724 which contain password information should be preceded by &"hide"& to prevent
7725 non-admin users from using the &%-bP%& option to see their values.
7726
7727 The auxiliary data items may be given in any order. The default is no
7728 connection timeout (the system timeout is used), no user or password, no limit
7729 on the number of entries returned, and no time limit on queries.
7730
7731 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7732 removes any URL quoting that it may contain before passing it LDAP. Apparently
7733 some libraries do this for themselves, but some do not. Removing the URL
7734 quoting has two advantages:
7735
7736 .ilist
7737 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7738 DNs as with DNs inside actual queries.
7739 .next
7740 It permits spaces inside USER= DNs.
7741 .endlist
7742
7743 For example, a setting such as
7744 .code
7745 USER=cn=${quote_ldap_dn:$1}
7746 .endd
7747 should work even if &$1$& contains spaces.
7748
7749 Expanded data for the PASS= value should be quoted using the &%quote%&
7750 expansion operator, rather than the LDAP quote operators. The only reason this
7751 field needs quoting is to ensure that it conforms to the Exim syntax, which
7752 does not allow unquoted spaces. For example:
7753 .code
7754 PASS=${quote:$3}
7755 .endd
7756 The LDAP authentication mechanism can be used to check passwords as part of
7757 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7758 &<<CHAPexpand>>&.
7759
7760
7761
7762 .section "Format of data returned by LDAP" "SECID71"
7763 .cindex "LDAP" "returned data formats"
7764 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7765 as a sequence of values, for example
7766 .code
7767 cn=manager,o=University of Cambridge,c=UK
7768 .endd
7769 The &(ldap)& lookup type generates an error if more than one entry matches the
7770 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7771 the result between the data from different entries. It is possible for multiple
7772 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7773 you know that whatever values are returned all came from a single entry in the
7774 directory.
7775
7776 In the common case where you specify a single attribute in your LDAP query, the
7777 result is not quoted, and does not contain the attribute name. If the attribute
7778 has multiple values, they are separated by commas. Any comma that is
7779 part of an attribute's value is doubled.
7780
7781 If you specify multiple attributes, the result contains space-separated, quoted
7782 strings, each preceded by the attribute name and an equals sign. Within the
7783 quotes, the quote character, backslash, and newline are escaped with
7784 backslashes, and commas are used to separate multiple values for the attribute.
7785 Any commas in attribute values are doubled
7786 (permitting treatment of the values as a comma-separated list).
7787 Apart from the escaping, the string within quotes takes the same form as the
7788 output when a single attribute is requested. Specifying no attributes is the
7789 same as specifying all of an entry's attributes.
7790
7791 Here are some examples of the output format. The first line of each pair is an
7792 LDAP query, and the second is the data that is returned. The attribute called
7793 &%attr1%& has two values, one of them with an embedded comma, whereas
7794 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7795 (they have SUP &%attr%& in their schema definitions).
7796
7797 .code
7798 ldap:///o=base?attr1?sub?(uid=fred)
7799 value1.1,value1,,2
7800
7801 ldap:///o=base?attr2?sub?(uid=fred)
7802 value two
7803
7804 ldap:///o=base?attr?sub?(uid=fred)
7805 value1.1,value1,,2,value two
7806
7807 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7808 attr1="value1.1,value1,,2" attr2="value two"
7809
7810 ldap:///o=base??sub?(uid=fred)
7811 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7812 .endd
7813 You can
7814 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7815 results of LDAP lookups.
7816 The &%extract%& operator in string expansions can be used to pick out
7817 individual fields from data that consists of &'key'&=&'value'& pairs.
7818 The &%listextract%& operator should be used to pick out individual values
7819 of attributes, even when only a single value is expected.
7820 The doubling of embedded commas allows you to use the returned data as a
7821 comma separated list (using the "<," syntax for changing the input list separator).
7822
7823
7824
7825
7826 .section "More about NIS+" "SECTnisplus"
7827 .cindex "NIS+ lookup type"
7828 .cindex "lookup" "NIS+"
7829 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7830 and field name. If this is given, the result of a successful query is the
7831 contents of the named field; otherwise the result consists of a concatenation
7832 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7833 values containing spaces are quoted. For example, the query
7834 .code
7835 [name=mg1456],passwd.org_dir
7836 .endd
7837 might return the string
7838 .code
7839 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7840 home=/home/mg1456 shell=/bin/bash shadow=""
7841 .endd
7842 (split over two lines here to fit on the page), whereas
7843 .code
7844 [name=mg1456],passwd.org_dir:gcos
7845 .endd
7846 would just return
7847 .code
7848 Martin Guerre
7849 .endd
7850 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7851 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7852 operator is to double any quote characters within the text.
7853
7854
7855
7856 .section "SQL lookups" "SECTsql"
7857 .cindex "SQL lookup types"
7858 .cindex "MySQL" "lookup type"
7859 .cindex "PostgreSQL lookup type"
7860 .cindex "lookup" "MySQL"
7861 .cindex "lookup" "PostgreSQL"
7862 .cindex "Oracle" "lookup type"
7863 .cindex "lookup" "Oracle"
7864 .cindex "InterBase lookup type"
7865 .cindex "lookup" "InterBase"
7866 .cindex "Redis lookup type"
7867 .cindex lookup Redis
7868 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7869 and SQLite
7870 databases. Queries for these databases contain SQL statements, so an example
7871 might be
7872 .code
7873 ${lookup mysql{select mailbox from users where id='userx'}\
7874   {$value}fail}
7875 .endd
7876 If the result of the query contains more than one field, the data for each
7877 field in the row is returned, preceded by its name, so the result of
7878 .code
7879 ${lookup pgsql{select home,name from users where id='userx'}\
7880   {$value}}
7881 .endd
7882 might be
7883 .code
7884 home=/home/userx name="Mister X"
7885 .endd
7886 Empty values and values containing spaces are double quoted, with embedded
7887 quotes escaped by a backslash. If the result of the query contains just one
7888 field, the value is passed back verbatim, without a field name, for example:
7889 .code
7890 Mister X
7891 .endd
7892 If the result of the query yields more than one row, it is all concatenated,
7893 with a newline between the data for each row.
7894
7895
7896 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7897 .cindex "MySQL" "lookup type"
7898 .cindex "PostgreSQL lookup type"
7899 .cindex "lookup" "MySQL"
7900 .cindex "lookup" "PostgreSQL"
7901 .cindex "Oracle" "lookup type"
7902 .cindex "lookup" "Oracle"
7903 .cindex "InterBase lookup type"
7904 .cindex "lookup" "InterBase"
7905 .cindex "Redis lookup type"
7906 .cindex lookup Redis
7907 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7908 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7909 or &%redis_servers%&
7910 option (as appropriate) must be set to a colon-separated list of server
7911 information.
7912 (For MySQL and PostgreSQL, the global option need not be set if all
7913 queries contain their own server information &-- see section
7914 &<<SECTspeserque>>&.)
7915 For all but Redis
7916 each item in the list is a slash-separated list of four
7917 items: host name, database name, user name, and password. In the case of
7918 Oracle, the host name field is used for the &"service name"&, and the database
7919 name field is not used and should be empty. For example:
7920 .code
7921 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7922 .endd
7923 Because password data is sensitive, you should always precede the setting with
7924 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7925 option. Here is an example where two MySQL servers are listed:
7926 .code
7927 hide mysql_servers = localhost/users/root/secret:\
7928                      otherhost/users/root/othersecret
7929 .endd
7930 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7931 because this is a colon-separated list, the colon has to be doubled. For each
7932 query, these parameter groups are tried in order until a connection is made and
7933 a query is successfully processed. The result of a query may be that no data is
7934 found, but that is still a successful query. In other words, the list of
7935 servers provides a backup facility, not a list of different places to look.
7936
7937 For Redis the global option need not be specified if all queries contain their
7938 own server information &-- see section &<<SECTspeserque>>&.
7939 If specified, the option must be set to a colon-separated list of server
7940 information.
7941 Each item in the list is a slash-separated list of three items:
7942 host, database number, and password.
7943 .olist
7944 The host is required and may be either an IPv4 address and optional
7945 port number (separated by a colon, which needs doubling due to the
7946 higher-level list), or a Unix socket pathname enclosed in parentheses
7947 .next
7948 The database number is optional; if present that number is selected in the backend
7949 .next
7950 The password is optional; if present it is used to authenticate to the backend
7951 .endlist
7952
7953 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7954 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7955 respectively, and the characters single-quote, double-quote, and backslash
7956 itself are escaped with backslashes.
7957
7958 The &%quote_redis%& expansion operator
7959 escapes whitespace and backslash characters with a backslash.
7960
7961 .section "Specifying the server in the query" "SECTspeserque"
7962 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7963 it is possible to specify a list of servers with an individual query. This is
7964 done by starting the query with
7965 .display
7966 &`servers=`&&'server1:server2:server3:...'&&`;`&
7967 .endd
7968 Each item in the list may take one of two forms:
7969 .olist
7970 If it contains no slashes it is assumed to be just a host name. The appropriate
7971 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7972 of the same name, and the remaining parameters (database, user, password) are
7973 taken from there.
7974 .next
7975 If it contains any slashes, it is taken as a complete parameter set.
7976 .endlist
7977 The list of servers is used in exactly the same way as the global list.
7978 Once a connection to a server has happened and a query has been
7979 successfully executed, processing of the lookup ceases.
7980
7981 This feature is intended for use in master/slave situations where updates
7982 are occurring and you want to update the master rather than a slave. If the
7983 master is in the list as a backup for reading, you might have a global setting
7984 like this:
7985 .code
7986 mysql_servers = slave1/db/name/pw:\
7987                 slave2/db/name/pw:\
7988                 master/db/name/pw
7989 .endd
7990 In an updating lookup, you could then write:
7991 .code
7992 ${lookup mysql{servers=master; UPDATE ...} }
7993 .endd
7994 That query would then be sent only to the master server. If, on the other hand,
7995 the master is not to be used for reading, and so is not present in the global
7996 option, you can still update it by a query of this form:
7997 .code
7998 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7999 .endd
8000
8001
8002 .section "Special MySQL features" "SECID73"
8003 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8004 causes a connection to the server on the local host by means of a Unix domain
8005 socket. An alternate socket can be specified in parentheses.
8006 An option group name for MySQL option files can be specified in square brackets;
8007 the default value is &"exim"&.
8008 The full syntax of each item in &%mysql_servers%& is:
8009 .display
8010 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8011   <&'database'&>/<&'user'&>/<&'password'&>
8012 .endd
8013 Any of the four sub-parts of the first field can be omitted. For normal use on
8014 the local host it can be left blank or set to just &"localhost"&.
8015
8016 No database need be supplied &-- but if it is absent here, it must be given in
8017 the queries.
8018
8019 If a MySQL query is issued that does not request any data (an insert, update,
8020 or delete command), the result of the lookup is the number of rows affected.
8021
8022 &*Warning*&: This can be misleading. If an update does not actually change
8023 anything (for example, setting a field to the value it already has), the result
8024 is zero because no rows are affected.
8025
8026
8027 .section "Special PostgreSQL features" "SECID74"
8028 PostgreSQL lookups can also use Unix domain socket connections to the database.
8029 This is usually faster and costs less CPU time than a TCP/IP connection.
8030 However it can be used only if the mail server runs on the same machine as the
8031 database server. A configuration line for PostgreSQL via Unix domain sockets
8032 looks like this:
8033 .code
8034 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8035 .endd
8036 In other words, instead of supplying a host name, a path to the socket is
8037 given. The path name is enclosed in parentheses so that its slashes aren't
8038 visually confused with the delimiters for the other server parameters.
8039
8040 If a PostgreSQL query is issued that does not request any data (an insert,
8041 update, or delete command), the result of the lookup is the number of rows
8042 affected.
8043
8044 .section "More about SQLite" "SECTsqlite"
8045 .cindex "lookup" "SQLite"
8046 .cindex "sqlite lookup type"
8047 SQLite is different to the other SQL lookups because a filename is required in
8048 addition to the SQL query. An SQLite database is a single file, and there is no
8049 daemon as in the other SQL databases. The interface to Exim requires the name
8050 of the file, as an absolute path, to be given at the start of the query. It is
8051 separated from the query by white space. This means that the path name cannot
8052 contain white space. Here is a lookup expansion example:
8053 .code
8054 ${lookup sqlite {/some/thing/sqlitedb \
8055   select name from aliases where id='userx';}}
8056 .endd
8057 In a list, the syntax is similar. For example:
8058 .code
8059 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8060    select * from relays where ip='$sender_host_address';
8061 .endd
8062 The only character affected by the &%quote_sqlite%& operator is a single
8063 quote, which it doubles.
8064
8065 .cindex timeout SQLite
8066 .cindex sqlite "lookup timeout"
8067 The SQLite library handles multiple simultaneous accesses to the database
8068 internally. Multiple readers are permitted, but only one process can
8069 update at once. Attempts to access the database while it is being updated
8070 are rejected after a timeout period, during which the SQLite library
8071 waits for the lock to be released. In Exim, the default timeout is set
8072 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8073 option.
8074
8075 .section "More about Redis" "SECTredis"
8076 .cindex "lookup" "Redis"
8077 .cindex "redis lookup type"
8078 Redis is a non-SQL database. Commands are simple get and set.
8079 Examples:
8080 .code
8081 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8082 ${lookup redis{get keyname}}
8083 .endd
8084
8085 As of release 4.91, "lightweight" support for Redis Cluster is available.
8086 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8087 of which must be reachable from the running exim instance. If the cluster has
8088 master/slave replication, the list must contain all the master and slave
8089 servers.
8090
8091 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8092 immediately follow the redirection but treats the response as a DEFER, moving on
8093 to the next server in the &%redis_servers%& list until the correct server is
8094 reached.
8095
8096 .ecindex IIDfidalo1
8097 .ecindex IIDfidalo2
8098
8099
8100 . ////////////////////////////////////////////////////////////////////////////
8101 . ////////////////////////////////////////////////////////////////////////////
8102
8103 .chapter "Domain, host, address, and local part lists" &&&
8104          "CHAPdomhosaddlists" &&&
8105          "Domain, host, and address lists"
8106 .scindex IIDdohoadli "lists of domains; hosts; etc."
8107 A number of Exim configuration options contain lists of domains, hosts,
8108 email addresses, or local parts. For example, the &%hold_domains%& option
8109 contains a list of domains whose delivery is currently suspended. These lists
8110 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8111 arguments to expansion conditions such as &%match_domain%&.
8112
8113 Each item in one of these lists is a pattern to be matched against a domain,
8114 host, email address, or local part, respectively. In the sections below, the
8115 different types of pattern for each case are described, but first we cover some
8116 general facilities that apply to all four kinds of list.
8117
8118 Note that other parts of Exim use a &'string list'& which does not
8119 support all the complexity available in
8120 domain, host, address and local part lists.
8121
8122
8123
8124 .section "Expansion of lists" "SECTlistexpand"
8125 .cindex "expansion" "of lists"
8126 Each list is expanded as a single string before it is used.
8127
8128 &'Exception: the router headers_remove option, where list-item
8129 splitting is done before string-expansion.'&
8130
8131 The result of
8132 expansion must be a list, possibly containing empty items, which is split up
8133 into separate items for matching. By default, colon is the separator character,
8134 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8135 &<<SECTempitelis>>& for details of the list syntax; the second of these
8136 discusses the way to specify empty list items.
8137
8138
8139 If the string expansion is forced to fail, Exim behaves as if the item it is
8140 testing (domain, host, address, or local part) is not in the list. Other
8141 expansion failures cause temporary errors.
8142
8143 If an item in a list is a regular expression, backslashes, dollars and possibly
8144 other special characters in the expression must be protected against
8145 misinterpretation by the string expander. The easiest way to do this is to use
8146 the &`\N`& expansion feature to indicate that the contents of the regular
8147 expression should not be expanded. For example, in an ACL you might have:
8148 .code
8149 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8150                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8151 .endd
8152 The first item is a regular expression that is protected from expansion by
8153 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8154 senders based on the receiving domain.
8155
8156
8157
8158
8159 .section "Negated items in lists" "SECID76"
8160 .cindex "list" "negation"
8161 .cindex "negation" "in lists"
8162 Items in a list may be positive or negative. Negative items are indicated by a
8163 leading exclamation mark, which may be followed by optional white space. A list
8164 defines a set of items (domains, etc). When Exim processes one of these lists,
8165 it is trying to find out whether a domain, host, address, or local part
8166 (respectively) is in the set that is defined by the list. It works like this:
8167
8168 The list is scanned from left to right. If a positive item is matched, the
8169 subject that is being checked is in the set; if a negative item is matched, the
8170 subject is not in the set. If the end of the list is reached without the
8171 subject having matched any of the patterns, it is in the set if the last item
8172 was a negative one, but not if it was a positive one. For example, the list in
8173 .code
8174 domainlist relay_to_domains = !a.b.c : *.b.c
8175 .endd
8176 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8177 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8178 list is positive. However, if the setting were
8179 .code
8180 domainlist relay_to_domains = !a.b.c
8181 .endd
8182 then all domains other than &'a.b.c'& would match because the last item in the
8183 list is negative. In other words, a list that ends with a negative item behaves
8184 as if it had an extra item &`:*`& on the end.
8185
8186 Another way of thinking about positive and negative items in lists is to read
8187 the connector as &"or"& after a positive item and as &"and"& after a negative
8188 item.
8189
8190
8191
8192 .section "File names in lists" "SECTfilnamlis"
8193 .cindex "list" "filename in"
8194 If an item in a domain, host, address, or local part list is an absolute
8195 filename (beginning with a slash character), each line of the file is read and
8196 processed as if it were an independent item in the list, except that further
8197 filenames are not allowed,
8198 and no expansion of the data from the file takes place.
8199 Empty lines in the file are ignored, and the file may also contain comment
8200 lines:
8201
8202 .ilist
8203 For domain and host lists, if a # character appears anywhere in a line of the
8204 file, it and all following characters are ignored.
8205 .next
8206 Because local parts may legitimately contain # characters, a comment in an
8207 address list or local part list file is recognized only if # is preceded by
8208 white space or the start of the line. For example:
8209 .code
8210 not#comment@x.y.z   # but this is a comment
8211 .endd
8212 .endlist
8213
8214 Putting a filename in a list has the same effect as inserting each line of the
8215 file as an item in the list (blank lines and comments excepted). However, there
8216 is one important difference: the file is read each time the list is processed,
8217 so if its contents vary over time, Exim's behaviour changes.
8218
8219 If a filename is preceded by an exclamation mark, the sense of any match
8220 within the file is inverted. For example, if
8221 .code
8222 hold_domains = !/etc/nohold-domains
8223 .endd
8224 and the file contains the lines
8225 .code
8226 !a.b.c
8227 *.b.c
8228 .endd
8229 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8230 any domain matching &`*.b.c`& is not.
8231
8232
8233
8234 .section "An lsearch file is not an out-of-line list" "SECID77"
8235 As will be described in the sections that follow, lookups can be used in lists
8236 to provide indexed methods of checking list membership. There has been some
8237 confusion about the way &(lsearch)& lookups work in lists. Because
8238 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8239 sometimes thought that it is allowed to contain wild cards and other kinds of
8240 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8241 always fixed strings, just as for any other single-key lookup type.
8242
8243 If you want to use a file to contain wild-card patterns that form part of a
8244 list, just give the filename on its own, without a search type, as described
8245 in the previous section. You could also use the &(wildlsearch)& or
8246 &(nwildlsearch)&, but there is no advantage in doing this.
8247
8248
8249
8250
8251 .section "Named lists" "SECTnamedlists"
8252 .cindex "named lists"
8253 .cindex "list" "named"
8254 A list of domains, hosts, email addresses, or local parts can be given a name
8255 which is then used to refer to the list elsewhere in the configuration. This is
8256 particularly convenient if the same list is required in several different
8257 places. It also allows lists to be given meaningful names, which can improve
8258 the readability of the configuration. For example, it is conventional to define
8259 a domain list called &'local_domains'& for all the domains that are handled
8260 locally on a host, using a configuration line such as
8261 .code
8262 domainlist local_domains = localhost:my.dom.example
8263 .endd
8264 Named lists are referenced by giving their name preceded by a plus sign, so,
8265 for example, a router that is intended to handle local domains would be
8266 configured with the line
8267 .code
8268 domains = +local_domains
8269 .endd
8270 The first router in a configuration is often one that handles all domains
8271 except the local ones, using a configuration with a negated item like this:
8272 .code
8273 dnslookup:
8274   driver = dnslookup
8275   domains = ! +local_domains
8276   transport = remote_smtp
8277   no_more
8278 .endd
8279 The four kinds of named list are created by configuration lines starting with
8280 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8281 respectively. Then there follows the name that you are defining, followed by an
8282 equals sign and the list itself. For example:
8283 .code
8284 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8285 addresslist bad_senders = cdb;/etc/badsenders
8286 .endd
8287 A named list may refer to other named lists:
8288 .code
8289 domainlist  dom1 = first.example : second.example
8290 domainlist  dom2 = +dom1 : third.example
8291 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8292 .endd
8293 &*Warning*&: If the last item in a referenced list is a negative one, the
8294 effect may not be what you intended, because the negation does not propagate
8295 out to the higher level. For example, consider:
8296 .code
8297 domainlist  dom1 = !a.b
8298 domainlist  dom2 = +dom1 : *.b
8299 .endd
8300 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8301 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8302 means it matches the second list as well. The effect is not the same as
8303 .code
8304 domainlist  dom2 = !a.b : *.b
8305 .endd
8306 where &'x.y'& does not match. It's best to avoid negation altogether in
8307 referenced lists if you can.
8308
8309 .new
8310 .cindex "hiding named list values"
8311 .cindex "named lists" "hiding value of"
8312 Some named list definitions may contain sensitive data, for example, passwords for
8313 accessing databases. To stop non-admin users from using the &%-bP%& command
8314 line option to read these values, you can precede the definition with the
8315 word &"hide"&. For example:
8316 .code
8317 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8318 .endd
8319 .wen
8320
8321
8322 Named lists may have a performance advantage. When Exim is routing an
8323 address or checking an incoming message, it caches the result of tests on named
8324 lists. So, if you have a setting such as
8325 .code
8326 domains = +local_domains
8327 .endd
8328 on several of your routers
8329 or in several ACL statements,
8330 the actual test is done only for the first one. However, the caching works only
8331 if there are no expansions within the list itself or any sublists that it
8332 references. In other words, caching happens only for lists that are known to be
8333 the same each time they are referenced.
8334
8335 By default, there may be up to 16 named lists of each type. This limit can be
8336 extended by changing a compile-time variable. The use of domain and host lists
8337 is recommended for concepts such as local domains, relay domains, and relay
8338 hosts. The default configuration is set up like this.
8339
8340
8341
8342 .section "Named lists compared with macros" "SECID78"
8343 .cindex "list" "named compared with macro"
8344 .cindex "macro" "compared with named list"
8345 At first sight, named lists might seem to be no different from macros in the
8346 configuration file. However, macros are just textual substitutions. If you
8347 write
8348 .code
8349 ALIST = host1 : host2
8350 auth_advertise_hosts = !ALIST
8351 .endd
8352 it probably won't do what you want, because that is exactly the same as
8353 .code
8354 auth_advertise_hosts = !host1 : host2
8355 .endd
8356 Notice that the second host name is not negated. However, if you use a host
8357 list, and write
8358 .code
8359 hostlist alist = host1 : host2
8360 auth_advertise_hosts = ! +alist
8361 .endd
8362 the negation applies to the whole list, and so that is equivalent to
8363 .code
8364 auth_advertise_hosts = !host1 : !host2
8365 .endd
8366
8367
8368 .section "Named list caching" "SECID79"
8369 .cindex "list" "caching of named"
8370 .cindex "caching" "named lists"
8371 While processing a message, Exim caches the result of checking a named list if
8372 it is sure that the list is the same each time. In practice, this means that
8373 the cache operates only if the list contains no $ characters, which guarantees
8374 that it will not change when it is expanded. Sometimes, however, you may have
8375 an expanded list that you know will be the same each time within a given
8376 message. For example:
8377 .code
8378 domainlist special_domains = \
8379            ${lookup{$sender_host_address}cdb{/some/file}}
8380 .endd
8381 This provides a list of domains that depends only on the sending host's IP
8382 address. If this domain list is referenced a number of times (for example,
8383 in several ACL lines, or in several routers) the result of the check is not
8384 cached by default, because Exim does not know that it is going to be the
8385 same list each time.
8386
8387 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8388 cache the result anyway. For example:
8389 .code
8390 domainlist_cache special_domains = ${lookup{...
8391 .endd
8392 If you do this, you should be absolutely sure that caching is going to do
8393 the right thing in all cases. When in doubt, leave it out.
8394
8395
8396
8397 .section "Domain lists" "SECTdomainlist"
8398 .cindex "domain list" "patterns for"
8399 .cindex "list" "domain list"
8400 Domain lists contain patterns that are to be matched against a mail domain.
8401 The following types of item may appear in domain lists:
8402
8403 .ilist
8404 .cindex "primary host name"
8405 .cindex "host name" "matched in domain list"
8406 .oindex "&%primary_hostname%&"
8407 .cindex "domain list" "matching primary host name"
8408 .cindex "@ in a domain list"
8409 If a pattern consists of a single @ character, it matches the local host name,
8410 as set by the &%primary_hostname%& option (or defaulted). This makes it
8411 possible to use the same configuration file on several different hosts that
8412 differ only in their names.
8413 .next
8414 .cindex "@[] in a domain list"
8415 .cindex "domain list" "matching local IP interfaces"
8416 .cindex "domain literal"
8417 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8418 in square brackets (as in an email address that contains a domain literal), but
8419 only if that IP address is recognized as local for email routing purposes. The
8420 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8421 control which of a host's several IP addresses are treated as local.
8422 In today's Internet, the use of domain literals is controversial.
8423 .next
8424 .cindex "@mx_any"
8425 .cindex "@mx_primary"
8426 .cindex "@mx_secondary"
8427 .cindex "domain list" "matching MX pointers to local host"
8428 If a pattern consists of the string &`@mx_any`& it matches any domain that
8429 has an MX record pointing to the local host or to any host that is listed in
8430 .oindex "&%hosts_treat_as_local%&"
8431 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8432 are similar, except that the first matches only when a primary MX target is the
8433 local host, and the second only when no primary MX target is the local host,
8434 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8435 preference value &-- there may of course be more than one of them.
8436
8437 The MX lookup that takes place when matching a pattern of this type is
8438 performed with the resolver options for widening names turned off. Thus, for
8439 example, a single-component domain will &'not'& be expanded by adding the
8440 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8441 options of the &(dnslookup)& router for a discussion of domain widening.
8442
8443 Sometimes you may want to ignore certain IP addresses when using one of these
8444 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8445 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8446 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8447 on a router). For example:
8448 .code
8449 domains = @mx_any/ignore=127.0.0.1
8450 .endd
8451 This example matches any domain that has an MX record pointing to one of
8452 the local host's IP addresses other than 127.0.0.1.
8453
8454 The list of IP addresses is in fact processed by the same code that processes
8455 host lists, so it may contain CIDR-coded network specifications and it may also
8456 contain negative items.
8457
8458 Because the list of IP addresses is a sublist within a domain list, you have to
8459 be careful about delimiters if there is more than one address. Like any other
8460 list, the default delimiter can be changed. Thus, you might have:
8461 .code
8462 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8463           an.other.domain : ...
8464 .endd
8465 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8466 involved, it is easiest to change the delimiter for the main list as well:
8467 .code
8468 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8469           an.other.domain ? ...
8470 .endd
8471 .next
8472 .cindex "asterisk" "in domain list"
8473 .cindex "domain list" "asterisk in"
8474 .cindex "domain list" "matching &""ends with""&"
8475 If a pattern starts with an asterisk, the remaining characters of the pattern
8476 are compared with the terminating characters of the domain. The use of &"*"& in
8477 domain lists differs from its use in partial matching lookups. In a domain
8478 list, the character following the asterisk need not be a dot, whereas partial
8479 matching works only in terms of dot-separated components. For example, a domain
8480 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8481 &'cipher.key.ex'&.
8482
8483 .next
8484 .cindex "regular expressions" "in domain list"
8485 .cindex "domain list" "matching regular expression"
8486 If a pattern starts with a circumflex character, it is treated as a regular
8487 expression, and matched against the domain using a regular expression matching
8488 function. The circumflex is treated as part of the regular expression.
8489 Email domains are case-independent, so this regular expression match is by
8490 default case-independent, but you can make it case-dependent by starting it
8491 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8492 are given in chapter &<<CHAPregexp>>&.
8493
8494 &*Warning*&: Because domain lists are expanded before being processed, you
8495 must escape any backslash and dollar characters in the regular expression, or
8496 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8497 it is not to be expanded (unless you really do want to build a regular
8498 expression by expansion, of course).
8499 .next
8500 .cindex "lookup" "in domain list"
8501 .cindex "domain list" "matching by lookup"
8502 If a pattern starts with the name of a single-key lookup type followed by a
8503 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8504 must be a filename in a suitable format for the lookup type. For example, for
8505 &"cdb;"& it must be an absolute path:
8506 .code
8507 domains = cdb;/etc/mail/local_domains.cdb
8508 .endd
8509 The appropriate type of lookup is done on the file using the domain name as the
8510 key. In most cases, the data that is looked up is not used; Exim is interested
8511 only in whether or not the key is present in the file. However, when a lookup
8512 is used for the &%domains%& option on a router
8513 or a &%domains%& condition in an ACL statement, the data is preserved in the
8514 &$domain_data$& variable and can be referred to in other router options or
8515 other statements in the same ACL.
8516
8517 .next
8518 Any of the single-key lookup type names may be preceded by
8519 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8520 .code
8521 domains = partial-dbm;/partial/domains
8522 .endd
8523 This causes partial matching logic to be invoked; a description of how this
8524 works is given in section &<<SECTpartiallookup>>&.
8525
8526 .next
8527 .cindex "asterisk" "in lookup type"
8528 Any of the single-key lookup types may be followed by an asterisk. This causes
8529 a default lookup for a key consisting of a single asterisk to be done if the
8530 original lookup fails. This is not a useful feature when using a domain list to
8531 select particular domains (because any domain would match), but it might have
8532 value if the result of the lookup is being used via the &$domain_data$&
8533 expansion variable.
8534 .next
8535 If the pattern starts with the name of a query-style lookup type followed by a
8536 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8537 pattern must be an appropriate query for the lookup type, as described in
8538 chapter &<<CHAPfdlookup>>&. For example:
8539 .code
8540 hold_domains = mysql;select domain from holdlist \
8541   where domain = '${quote_mysql:$domain}';
8542 .endd
8543 In most cases, the data that is looked up is not used (so for an SQL query, for
8544 example, it doesn't matter what field you select). Exim is interested only in
8545 whether or not the query succeeds. However, when a lookup is used for the
8546 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8547 variable and can be referred to in other options.
8548 .next
8549 .cindex "domain list" "matching literal domain name"
8550 If none of the above cases apply, a caseless textual comparison is made
8551 between the pattern and the domain.
8552 .endlist
8553
8554 Here is an example that uses several different kinds of pattern:
8555 .code
8556 domainlist funny_domains = \
8557   @ : \
8558   lib.unseen.edu : \
8559   *.foundation.fict.example : \
8560   \N^[1-2]\d{3}\.fict\.example$\N : \
8561   partial-dbm;/opt/data/penguin/book : \
8562   nis;domains.byname : \
8563   nisplus;[name=$domain,status=local],domains.org_dir
8564 .endd
8565 There are obvious processing trade-offs among the various matching modes. Using
8566 an asterisk is faster than a regular expression, and listing a few names
8567 explicitly probably is too. The use of a file or database lookup is expensive,
8568 but may be the only option if hundreds of names are required. Because the
8569 patterns are tested in order, it makes sense to put the most commonly matched
8570 patterns earlier.
8571
8572
8573
8574 .section "Host lists" "SECThostlist"
8575 .cindex "host list" "patterns in"
8576 .cindex "list" "host list"
8577 Host lists are used to control what remote hosts are allowed to do. For
8578 example, some hosts may be allowed to use the local host as a relay, and some
8579 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8580 two different ways, by name or by IP address. In a host list, some types of
8581 pattern are matched to a host name, and some are matched to an IP address.
8582 You need to be particularly careful with this when single-key lookups are
8583 involved, to ensure that the right value is being used as the key.
8584
8585
8586 .section "Special host list patterns" "SECID80"
8587 .cindex "empty item in hosts list"
8588 .cindex "host list" "empty string in"
8589 If a host list item is the empty string, it matches only when no remote host is
8590 involved. This is the case when a message is being received from a local
8591 process using SMTP on the standard input, that is, when a TCP/IP connection is
8592 not used.
8593
8594 .cindex "asterisk" "in host list"
8595 The special pattern &"*"& in a host list matches any host or no host. Neither
8596 the IP address nor the name is actually inspected.
8597
8598
8599
8600 .section "Host list patterns that match by IP address" "SECThoslispatip"
8601 .cindex "host list" "matching IP addresses"
8602 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8603 the incoming address actually appears in the IPv6 host as
8604 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8605 list, it is converted into a traditional IPv4 address first. (Not all operating
8606 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8607 concerns.)
8608
8609 The following types of pattern in a host list check the remote host by
8610 inspecting its IP address:
8611
8612 .ilist
8613 If the pattern is a plain domain name (not a regular expression, not starting
8614 with *, not a lookup of any kind), Exim calls the operating system function
8615 to find the associated IP address(es). Exim uses the newer
8616 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8617 This typically causes a forward DNS lookup of the name. The result is compared
8618 with the IP address of the subject host.
8619
8620 If there is a temporary problem (such as a DNS timeout) with the host name
8621 lookup, a temporary error occurs. For example, if the list is being used in an
8622 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8623 temporary SMTP error code. If no IP address can be found for the host name,
8624 what happens is described in section &<<SECTbehipnot>>& below.
8625
8626 .next
8627 .cindex "@ in a host list"
8628 If the pattern is &"@"&, the primary host name is substituted and used as a
8629 domain name, as just described.
8630
8631 .next
8632 If the pattern is an IP address, it is matched against the IP address of the
8633 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8634 IPv6 addresses can be given in colon-separated format, but the colons have to
8635 be doubled so as not to be taken as item separators when the default list
8636 separator is used. IPv6 addresses are recognized even when Exim is compiled
8637 without IPv6 support. This means that if they appear in a host list on an
8638 IPv4-only host, Exim will not treat them as host names. They are just addresses
8639 that can never match a client host.
8640
8641 .next
8642 .cindex "@[] in a host list"
8643 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8644 the local host. For example, if the local host is an IPv4 host with one
8645 interface address 10.45.23.56, these two ACL statements have the same effect:
8646 .code
8647 accept hosts = 127.0.0.1 : 10.45.23.56
8648 accept hosts = @[]
8649 .endd
8650 .next
8651 .cindex "CIDR notation"
8652 If the pattern is an IP address followed by a slash and a mask length (for
8653 example 10.11.42.0/24), it is matched against the IP address of the subject
8654 host under the given mask. This allows, an entire network of hosts to be
8655 included (or excluded) by a single item. The mask uses CIDR notation; it
8656 specifies the number of address bits that must match, starting from the most
8657 significant end of the address.
8658
8659 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8660 of a range of addresses. It is the number of bits in the network portion of the
8661 address. The above example specifies a 24-bit netmask, so it matches all 256
8662 addresses in the 10.11.42.0 network. An item such as
8663 .code
8664 192.168.23.236/31
8665 .endd
8666 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8667 32 for an IPv4 address is the same as no mask at all; just a single address
8668 matches.
8669
8670 Here is another example which shows an IPv4 and an IPv6 network:
8671 .code
8672 recipient_unqualified_hosts = 192.168.0.0/16: \
8673                               3ffe::ffff::836f::::/48
8674 .endd
8675 The doubling of list separator characters applies only when these items
8676 appear inline in a host list. It is not required when indirecting via a file.
8677 For example:
8678 .code
8679 recipient_unqualified_hosts = /opt/exim/unqualnets
8680 .endd
8681 could make use of a file containing
8682 .code
8683 172.16.0.0/12
8684 3ffe:ffff:836f::/48
8685 .endd
8686 to have exactly the same effect as the previous example. When listing IPv6
8687 addresses inline, it is usually more convenient to use the facility for
8688 changing separator characters. This list contains the same two networks:
8689 .code
8690 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8691                                  3ffe:ffff:836f::/48
8692 .endd
8693 The separator is changed to semicolon by the leading &"<;"& at the start of the
8694 list.
8695 .endlist
8696
8697
8698
8699 .section "Host list patterns for single-key lookups by host address" &&&
8700          "SECThoslispatsikey"
8701 .cindex "host list" "lookup of IP address"
8702 When a host is to be identified by a single-key lookup of its complete IP
8703 address, the pattern takes this form:
8704 .display
8705 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8706 .endd
8707 For example:
8708 .code
8709 hosts_lookup = net-cdb;/hosts-by-ip.db
8710 .endd
8711 The text form of the IP address of the subject host is used as the lookup key.
8712 IPv6 addresses are converted to an unabbreviated form, using lower case
8713 letters, with dots as separators because colon is the key terminator in
8714 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8715 quoting the keys, but this is a facility that was added later.] The data
8716 returned by the lookup is not used.
8717
8718 .cindex "IP address" "masking"
8719 .cindex "host list" "masked IP address"
8720 Single-key lookups can also be performed using masked IP addresses, using
8721 patterns of this form:
8722 .display
8723 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8724 .endd
8725 For example:
8726 .code
8727 net24-dbm;/networks.db
8728 .endd
8729 The IP address of the subject host is masked using <&'number'&> as the mask
8730 length. A textual string is constructed from the masked value, followed by the
8731 mask, and this is used as the lookup key. For example, if the host's IP address
8732 is 192.168.34.6, the key that is looked up for the above example is
8733 &"192.168.34.0/24"&.
8734
8735 When an IPv6 address is converted to a string, dots are normally used instead
8736 of colons, so that keys in &(lsearch)& files need not contain colons (which
8737 terminate &(lsearch)& keys). This was implemented some time before the ability
8738 to quote keys was made available in &(lsearch)& files. However, the more
8739 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8740 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8741 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8742 converted using colons and not dots.
8743 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8744 addresses are always used.
8745 The latter are converted to IPv4 addresses, in dotted-quad form.
8746
8747 Ideally, it would be nice to tidy up this anomalous situation by changing to
8748 colons in all cases, given that quoting is now available for &(lsearch)&.
8749 However, this would be an incompatible change that might break some existing
8750 configurations.
8751
8752 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8753 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8754 the former case the key strings include the mask value, whereas in the latter
8755 case the IP address is used on its own.
8756
8757
8758
8759 .section "Host list patterns that match by host name" "SECThoslispatnam"
8760 .cindex "host" "lookup failures"
8761 .cindex "unknown host name"
8762 .cindex "host list" "matching host name"
8763 There are several types of pattern that require Exim to know the name of the
8764 remote host. These are either wildcard patterns or lookups by name. (If a
8765 complete hostname is given without any wildcarding, it is used to find an IP
8766 address to match against, as described in section &<<SECThoslispatip>>&
8767 above.)
8768
8769 If the remote host name is not already known when Exim encounters one of these
8770 patterns, it has to be found from the IP address.
8771 Although many sites on the Internet are conscientious about maintaining reverse
8772 DNS data for their hosts, there are also many that do not do this.
8773 Consequently, a name cannot always be found, and this may lead to unwanted
8774 effects. Take care when configuring host lists with wildcarded name patterns.
8775 Consider what will happen if a name cannot be found.
8776
8777 Because of the problems of determining host names from IP addresses, matching
8778 against host names is not as common as matching against IP addresses.
8779
8780 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8781 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8782 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8783 are done can be changed by setting the &%host_lookup_order%& option. For
8784 security, once Exim has found one or more names, it looks up the IP addresses
8785 for these names and compares them with the IP address that it started with.
8786 Only those names whose IP addresses match are accepted. Any other names are
8787 discarded. If no names are left, Exim behaves as if the host name cannot be
8788 found. In the most common case there is only one name and one IP address.
8789
8790 There are some options that control what happens if a host name cannot be
8791 found. These are described in section &<<SECTbehipnot>>& below.
8792
8793 .cindex "host" "alias for"
8794 .cindex "alias for host"
8795 As a result of aliasing, hosts may have more than one name. When processing any
8796 of the following types of pattern, all the host's names are checked:
8797
8798 .ilist
8799 .cindex "asterisk" "in host list"
8800 If a pattern starts with &"*"& the remainder of the item must match the end of
8801 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8802 &'.b.c'&. This special simple form is provided because this is a very common
8803 requirement. Other kinds of wildcarding require the use of a regular
8804 expression.
8805 .next
8806 .cindex "regular expressions" "in host list"
8807 .cindex "host list" "regular expression in"
8808 If the item starts with &"^"& it is taken to be a regular expression which is
8809 matched against the host name. Host names are case-independent, so this regular
8810 expression match is by default case-independent, but you can make it
8811 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8812 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8813 example,
8814 .code
8815 ^(a|b)\.c\.d$
8816 .endd
8817 is a regular expression that matches either of the two hosts &'a.c.d'& or
8818 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8819 that backslash and dollar characters are not misinterpreted as part of the
8820 string expansion. The simplest way to do this is to use &`\N`& to mark that
8821 part of the string as non-expandable. For example:
8822 .code
8823 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8824 .endd
8825 &*Warning*&: If you want to match a complete host name, you must include the
8826 &`$`& terminating metacharacter in the regular expression, as in the above
8827 example. Without it, a match at the start of the host name is all that is
8828 required.
8829 .endlist
8830
8831
8832
8833
8834 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8835 .cindex "host" "lookup failures, permanent"
8836 While processing a host list, Exim may need to look up an IP address from a
8837 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8838 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8839 behaviour when it fails to find the information it is seeking is the same.
8840
8841 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8842 apply to temporary DNS errors, whose handling is described in the next section.
8843
8844 .cindex "&`+include_unknown`&"
8845 .cindex "&`+ignore_unknown`&"
8846 Exim parses a host list from left to right. If it encounters a permanent
8847 lookup failure in any item in the host list before it has found a match,
8848 Exim treats it as a failure and the default behavior is as if the host
8849 does not match the list. This may not always be what you want to happen.
8850 To change Exim's behaviour, the special items &`+include_unknown`& or
8851 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8852 not recognized in an indirected file).
8853
8854 .ilist
8855 If any item that follows &`+include_unknown`& requires information that
8856 cannot found, Exim behaves as if the host does match the list. For example,
8857 .code
8858 host_reject_connection = +include_unknown:*.enemy.ex
8859 .endd
8860 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8861 any hosts whose name it cannot find.
8862
8863 .next
8864 If any item that follows &`+ignore_unknown`& requires information that cannot
8865 be found, Exim ignores that item and proceeds to the rest of the list. For
8866 example:
8867 .code
8868 accept hosts = +ignore_unknown : friend.example : \
8869                192.168.4.5
8870 .endd
8871 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8872 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8873 name can be found for 192.168.4.5, it is rejected.
8874 .endlist
8875
8876 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8877 list. The effect of each one lasts until the next, or until the end of the
8878 list.
8879
8880 .section "Mixing wildcarded host names and addresses in host lists" &&&
8881          "SECTmixwilhos"
8882 .cindex "host list" "mixing names and addresses in"
8883
8884 This section explains the host/ip processing logic with the same concepts
8885 as the previous section, but specifically addresses what happens when a
8886 wildcarded hostname is one of the items in the hostlist.
8887
8888 .ilist
8889 If you have name lookups or wildcarded host names and
8890 IP addresses in the same host list, you should normally put the IP
8891 addresses first. For example, in an ACL you could have:
8892 .code
8893 accept hosts = 10.9.8.7 : *.friend.example
8894 .endd
8895 The reason you normally would order it this way lies in the
8896 left-to-right way that Exim processes lists.  It can test IP addresses
8897 without doing any DNS lookups, but when it reaches an item that requires
8898 a host name, it fails if it cannot find a host name to compare with the
8899 pattern. If the above list is given in the opposite order, the
8900 &%accept%& statement fails for a host whose name cannot be found, even
8901 if its IP address is 10.9.8.7.
8902
8903 .next
8904 If you really do want to do the name check first, and still recognize the IP
8905 address, you can rewrite the ACL like this:
8906 .code
8907 accept hosts = *.friend.example
8908 accept hosts = 10.9.8.7
8909 .endd
8910 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8911 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8912 &`+ignore_unknown`&, which was discussed in depth in the first example in
8913 this section.
8914 .endlist
8915
8916
8917 .section "Temporary DNS errors when looking up host information" &&&
8918          "SECTtemdnserr"
8919 .cindex "host" "lookup failures, temporary"
8920 .cindex "&`+include_defer`&"
8921 .cindex "&`+ignore_defer`&"
8922 A temporary DNS lookup failure normally causes a defer action (except when
8923 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8924 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8925 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8926 section. These options should be used with care, probably only in non-critical
8927 host lists such as whitelists.
8928
8929
8930
8931 .section "Host list patterns for single-key lookups by host name" &&&
8932          "SECThoslispatnamsk"
8933 .cindex "unknown host name"
8934 .cindex "host list" "matching host name"
8935 If a pattern is of the form
8936 .display
8937 <&'single-key-search-type'&>;<&'search-data'&>
8938 .endd
8939 for example
8940 .code
8941 dbm;/host/accept/list
8942 .endd
8943 a single-key lookup is performed, using the host name as its key. If the
8944 lookup succeeds, the host matches the item. The actual data that is looked up
8945 is not used.
8946
8947 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8948 keys in the file, not IP addresses. If you want to do lookups based on IP
8949 addresses, you must precede the search type with &"net-"& (see section
8950 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8951 two items in the same list, one doing an address lookup and one doing a name
8952 lookup, both using the same file.
8953
8954
8955
8956 .section "Host list patterns for query-style lookups" "SECID81"
8957 If a pattern is of the form
8958 .display
8959 <&'query-style-search-type'&>;<&'query'&>
8960 .endd
8961 the query is obeyed, and if it succeeds, the host matches the item. The actual
8962 data that is looked up is not used. The variables &$sender_host_address$& and
8963 &$sender_host_name$& can be used in the query. For example:
8964 .code
8965 hosts_lookup = pgsql;\
8966   select ip from hostlist where ip='$sender_host_address'
8967 .endd
8968 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8969 can use the &%sg%& expansion item to change this if you need to. If you want to
8970 use masked IP addresses in database queries, you can use the &%mask%& expansion
8971 operator.
8972
8973 If the query contains a reference to &$sender_host_name$&, Exim automatically
8974 looks up the host name if it has not already done so. (See section
8975 &<<SECThoslispatnam>>& for comments on finding host names.)
8976
8977 Historical note: prior to release 4.30, Exim would always attempt to find a
8978 host name before running the query, unless the search type was preceded by
8979 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8980 still recognized for query-style lookups, but its presence or absence has no
8981 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8982 See section &<<SECThoslispatsikey>>&.)
8983
8984
8985
8986
8987
8988 .section "Address lists" "SECTaddresslist"
8989 .cindex "list" "address list"
8990 .cindex "address list" "empty item"
8991 .cindex "address list" "patterns"
8992 Address lists contain patterns that are matched against mail addresses. There
8993 is one special case to be considered: the sender address of a bounce message is
8994 always empty. You can test for this by providing an empty item in an address
8995 list. For example, you can set up a router to process bounce messages by
8996 using this option setting:
8997 .code
8998 senders = :
8999 .endd
9000 The presence of the colon creates an empty item. If you do not provide any
9001 data, the list is empty and matches nothing. The empty sender can also be
9002 detected by a regular expression that matches an empty string,
9003 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9004
9005 Non-empty items in an address list can be straightforward email addresses. For
9006 example:
9007 .code
9008 senders = jbc@askone.example : hs@anacreon.example
9009 .endd
9010 A certain amount of wildcarding is permitted. If a pattern contains an @
9011 character, but is not a regular expression and does not begin with a
9012 semicolon-terminated lookup type (described below), the local part of the
9013 subject address is compared with the local part of the pattern, which may start
9014 with an asterisk. If the local parts match, the domain is checked in exactly
9015 the same way as for a pattern in a domain list. For example, the domain can be
9016 wildcarded, refer to a named list, or be a lookup:
9017 .code
9018 deny senders = *@*.spamming.site:\
9019                *@+hostile_domains:\
9020                bozo@partial-lsearch;/list/of/dodgy/sites:\
9021                *@dbm;/bad/domains.db
9022 .endd
9023 .cindex "local part" "starting with !"
9024 .cindex "address list" "local part starting with !"
9025 If a local part that begins with an exclamation mark is required, it has to be
9026 specified using a regular expression, because otherwise the exclamation mark is
9027 treated as a sign of negation, as is standard in lists.
9028
9029 If a non-empty pattern that is not a regular expression or a lookup does not
9030 contain an @ character, it is matched against the domain part of the subject
9031 address. The only two formats that are recognized this way are a literal
9032 domain, or a domain pattern that starts with *. In both these cases, the effect
9033 is the same as if &`*@`& preceded the pattern. For example:
9034 .code
9035 deny senders = enemy.domain : *.enemy.domain
9036 .endd
9037
9038 The following kinds of more complicated address list pattern can match any
9039 address, including the empty address that is characteristic of bounce message
9040 senders:
9041
9042 .ilist
9043 .cindex "regular expressions" "in address list"
9044 .cindex "address list" "regular expression in"
9045 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9046 done against the complete address, with the pattern as the regular expression.
9047 You must take care that backslash and dollar characters are not misinterpreted
9048 as part of the string expansion. The simplest way to do this is to use &`\N`&
9049 to mark that part of the string as non-expandable. For example:
9050 .code
9051 deny senders = \N^.*this.*@example\.com$\N : \
9052                \N^\d{8}.+@spamhaus.example$\N : ...
9053 .endd
9054 The &`\N`& sequences are removed by the expansion, so these items do indeed
9055 start with &"^"& by the time they are being interpreted as address patterns.
9056
9057 .next
9058 .cindex "address list" "lookup for complete address"
9059 Complete addresses can be looked up by using a pattern that starts with a
9060 lookup type terminated by a semicolon, followed by the data for the lookup. For
9061 example:
9062 .code
9063 deny senders = cdb;/etc/blocked.senders : \
9064   mysql;select address from blocked where \
9065   address='${quote_mysql:$sender_address}'
9066 .endd
9067 Both query-style and single-key lookup types can be used. For a single-key
9068 lookup type, Exim uses the complete address as the key. However, empty keys are
9069 not supported for single-key lookups, so a match against the empty address
9070 always fails. This restriction does not apply to query-style lookups.
9071
9072 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9073 cannot be used, and is ignored if specified, with an entry being written to the
9074 panic log.
9075 .cindex "*@ with single-key lookup"
9076 However, you can configure lookup defaults, as described in section
9077 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9078 default. For example, with this lookup:
9079 .code
9080 accept senders = lsearch*@;/some/file
9081 .endd
9082 the file could contains lines like this:
9083 .code
9084 user1@domain1.example
9085 *@domain2.example
9086 .endd
9087 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9088 that are tried is:
9089 .code
9090 nimrod@jaeger.example
9091 *@jaeger.example
9092 *
9093 .endd
9094 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9095 would mean that every address matches, thus rendering the test useless.
9096
9097 &*Warning 2*&: Do not confuse these two kinds of item:
9098 .code
9099 deny recipients = dbm*@;/some/file
9100 deny recipients = *@dbm;/some/file
9101 .endd
9102 The first does a whole address lookup, with defaulting, as just described,
9103 because it starts with a lookup type. The second matches the local part and
9104 domain independently, as described in a bullet point below.
9105 .endlist
9106
9107
9108 The following kinds of address list pattern can match only non-empty addresses.
9109 If the subject address is empty, a match against any of these pattern types
9110 always fails.
9111
9112
9113 .ilist
9114 .cindex "@@ with single-key lookup"
9115 .cindex "address list" "@@ lookup type"
9116 .cindex "address list" "split local part and domain"
9117 If a pattern starts with &"@@"& followed by a single-key lookup item
9118 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9119 split into a local part and a domain. The domain is looked up in the file. If
9120 it is not found, there is no match. If it is found, the data that is looked up
9121 from the file is treated as a colon-separated list of local part patterns, each
9122 of which is matched against the subject local part in turn.
9123
9124 .cindex "asterisk" "in address list"
9125 The lookup may be a partial one, and/or one involving a search for a default
9126 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9127 patterns that are looked up can be regular expressions or begin with &"*"&, or
9128 even be further lookups. They may also be independently negated. For example,
9129 with
9130 .code
9131 deny senders = @@dbm;/etc/reject-by-domain
9132 .endd
9133 the data from which the DBM file is built could contain lines like
9134 .code
9135 baddomain.com:  !postmaster : *
9136 .endd
9137 to reject all senders except &%postmaster%& from that domain.
9138
9139 .cindex "local part" "starting with !"
9140 If a local part that actually begins with an exclamation mark is required, it
9141 has to be specified using a regular expression. In &(lsearch)& files, an entry
9142 may be split over several lines by indenting the second and subsequent lines,
9143 but the separating colon must still be included at line breaks. White space
9144 surrounding the colons is ignored. For example:
9145 .code
9146 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9147   spammer3 : spammer4
9148 .endd
9149 As in all colon-separated lists in Exim, a colon can be included in an item by
9150 doubling.
9151
9152 If the last item in the list starts with a right angle-bracket, the remainder
9153 of the item is taken as a new key to look up in order to obtain a continuation
9154 list of local parts. The new key can be any sequence of characters. Thus one
9155 might have entries like
9156 .code
9157 aol.com: spammer1 : spammer 2 : >*
9158 xyz.com: spammer3 : >*
9159 *:       ^\d{8}$
9160 .endd
9161 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9162 local parts for all domains, in addition to the specific local parts listed for
9163 each domain. Of course, using this feature costs another lookup each time a
9164 chain is followed, but the effort needed to maintain the data is reduced.
9165
9166 .cindex "loop" "in lookups"
9167 It is possible to construct loops using this facility, and in order to catch
9168 them, the chains may be no more than fifty items long.
9169
9170 .next
9171 The @@<&'lookup'&> style of item can also be used with a query-style
9172 lookup, but in this case, the chaining facility is not available. The lookup
9173 can only return a single list of local parts.
9174 .endlist
9175
9176 &*Warning*&: There is an important difference between the address list items
9177 in these two examples:
9178 .code
9179 senders = +my_list
9180 senders = *@+my_list
9181 .endd
9182 In the first one, &`my_list`& is a named address list, whereas in the second
9183 example it is a named domain list.
9184
9185
9186
9187
9188 .section "Case of letters in address lists" "SECTcasletadd"
9189 .cindex "case of local parts"
9190 .cindex "address list" "case forcing"
9191 .cindex "case forcing in address lists"
9192 Domains in email addresses are always handled caselessly, but for local parts
9193 case may be significant on some systems (see &%caseful_local_part%& for how
9194 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9195 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9196 blocking lists should be done in a case-independent manner. Since most address
9197 lists in Exim are used for this kind of control, Exim attempts to do this by
9198 default.
9199
9200 The domain portion of an address is always lowercased before matching it to an
9201 address list. The local part is lowercased by default, and any string
9202 comparisons that take place are done caselessly. This means that the data in
9203 the address list itself, in files included as plain filenames, and in any file
9204 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9205 keys in files that are looked up by a search type other than &(lsearch)& (which
9206 works caselessly) must be in lower case, because these lookups are not
9207 case-independent.
9208
9209 .cindex "&`+caseful`&"
9210 To allow for the possibility of caseful address list matching, if an item in
9211 an address list is the string &"+caseful"&, the original case of the local
9212 part is restored for any comparisons that follow, and string comparisons are no
9213 longer case-independent. This does not affect the domain, which remains in
9214 lower case. However, although independent matches on the domain alone are still
9215 performed caselessly, regular expressions that match against an entire address
9216 become case-sensitive after &"+caseful"& has been seen.
9217
9218
9219
9220 .section "Local part lists" "SECTlocparlis"
9221 .cindex "list" "local part list"
9222 .cindex "local part" "list"
9223 Case-sensitivity in local part lists is handled in the same way as for address
9224 lists, as just described. The &"+caseful"& item can be used if required. In a
9225 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9226 set false, the subject is lowercased and the matching is initially
9227 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9228 matching in the local part list, but not elsewhere in the router. If
9229 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9230 option is case-sensitive from the start.
9231
9232 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9233 comments are handled in the same way as address lists &-- they are recognized
9234 only if the # is preceded by white space or the start of the line.
9235 Otherwise, local part lists are matched in the same way as domain lists, except
9236 that the special items that refer to the local host (&`@`&, &`@[]`&,
9237 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9238 Refer to section &<<SECTdomainlist>>& for details of the other available item
9239 types.
9240 .ecindex IIDdohoadli
9241
9242
9243
9244
9245 . ////////////////////////////////////////////////////////////////////////////
9246 . ////////////////////////////////////////////////////////////////////////////
9247
9248 .chapter "String expansions" "CHAPexpand"
9249 .scindex IIDstrexp "expansion" "of strings"
9250 Many strings in Exim's runtime configuration are expanded before use. Some of
9251 them are expanded every time they are used; others are expanded only once.
9252
9253 When a string is being expanded it is copied verbatim from left to right except
9254 .cindex expansion "string concatenation"
9255 when a dollar or backslash character is encountered. A dollar specifies the
9256 start of a portion of the string that is interpreted and replaced as described
9257 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9258 escape character, as described in the following section.
9259
9260 Whether a string is expanded depends upon the context.  Usually this is solely
9261 dependent upon the option for which a value is sought; in this documentation,
9262 options for which string expansion is performed are marked with &dagger; after
9263 the data type.  ACL rules always expand strings.  A couple of expansion
9264 conditions do not expand some of the brace-delimited branches, for security
9265 reasons,
9266 .cindex "tainted data" expansion
9267 .cindex expansion "tainted data"
9268 and expansion of data deriving from the sender (&"tainted data"&)
9269 is not permitted.
9270
9271
9272
9273 .section "Literal text in expanded strings" "SECTlittext"
9274 .cindex "expansion" "including literal text"
9275 An uninterpreted dollar can be included in an expanded string by putting a
9276 backslash in front of it. A backslash can be used to prevent any special
9277 character being treated specially in an expansion, including backslash itself.
9278 If the string appears in quotes in the configuration file, two backslashes are
9279 required because the quotes themselves cause interpretation of backslashes when
9280 the string is read in (see section &<<SECTstrings>>&).
9281
9282 .cindex "expansion" "non-expandable substrings"
9283 A portion of the string can specified as non-expandable by placing it between
9284 two occurrences of &`\N`&. This is particularly useful for protecting regular
9285 expressions, which often contain backslashes and dollar signs. For example:
9286 .code
9287 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9288 .endd
9289 On encountering the first &`\N`&, the expander copies subsequent characters
9290 without interpretation until it reaches the next &`\N`& or the end of the
9291 string.
9292
9293
9294
9295 .section "Character escape sequences in expanded strings" "SECID82"
9296 .cindex "expansion" "escape sequences"
9297 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9298 expanded string is recognized as an escape sequence for the character newline,
9299 carriage return, or tab, respectively. A backslash followed by up to three
9300 octal digits is recognized as an octal encoding for a single character, and a
9301 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9302 encoding.
9303
9304 These escape sequences are also recognized in quoted strings when they are read
9305 in. Their interpretation in expansions as well is useful for unquoted strings,
9306 and for other cases such as looked-up strings that are then expanded.
9307
9308
9309 .section "Testing string expansions" "SECID83"
9310 .cindex "expansion" "testing"
9311 .cindex "testing" "string expansion"
9312 .oindex "&%-be%&"
9313 Many expansions can be tested by calling Exim with the &%-be%& option. This
9314 takes the command arguments, or lines from the standard input if there are no
9315 arguments, runs them through the string expansion code, and writes the results
9316 to the standard output. Variables based on configuration values are set up, but
9317 since no message is being processed, variables such as &$local_part$& have no
9318 value. Nevertheless the &%-be%& option can be useful for checking out file and
9319 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9320 and &%nhash%&.
9321
9322 Exim gives up its root privilege when it is called with the &%-be%& option, and
9323 instead runs under the uid and gid it was called with, to prevent users from
9324 using &%-be%& for reading files to which they do not have access.
9325
9326 .oindex "&%-bem%&"
9327 If you want to test expansions that include variables whose values are taken
9328 from a message, there are two other options that can be used. The &%-bem%&
9329 option is like &%-be%& except that it is followed by a filename. The file is
9330 read as a message before doing the test expansions. For example:
9331 .code
9332 exim -bem /tmp/test.message '$h_subject:'
9333 .endd
9334 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9335 Exim message identifier. For example:
9336 .code
9337 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9338 .endd
9339 This loads the message from Exim's spool before doing the test expansions, and
9340 is therefore restricted to admin users.
9341
9342
9343 .section "Forced expansion failure" "SECTforexpfai"
9344 .cindex "expansion" "forced failure"
9345 A number of expansions that are described in the following section have
9346 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9347 (which are sometimes called &"curly brackets"&). Which of the two strings is
9348 used depends on some condition that is evaluated as part of the expansion. If,
9349 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9350 the entire string expansion fails in a way that can be detected by the code
9351 that requested the expansion. This is called &"forced expansion failure"&, and
9352 its consequences depend on the circumstances. In some cases it is no different
9353 from any other expansion failure, but in others a different action may be
9354 taken. Such variations are mentioned in the documentation of the option that is
9355 being expanded.
9356
9357
9358
9359
9360 .section "Expansion items" "SECTexpansionitems"
9361 The following items are recognized in expanded strings. White space may be used
9362 between sub-items that are keywords or substrings enclosed in braces inside an
9363 outer set of braces, to improve readability. &*Warning*&: Within braces,
9364 white space is significant.
9365
9366 .vlist
9367 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9368 .cindex "expansion" "variables"
9369 Substitute the contents of the named variable, for example:
9370 .code
9371 $local_part
9372 ${domain}
9373 .endd
9374 The second form can be used to separate the name from subsequent alphanumeric
9375 characters. This form (using braces) is available only for variables; it does
9376 &'not'& apply to message headers. The names of the variables are given in
9377 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9378 given, the expansion fails.
9379
9380 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9381 .cindex "expansion" "operators"
9382 The string is first itself expanded, and then the operation specified by
9383 <&'op'&> is applied to it. For example:
9384 .code
9385 ${lc:$local_part}
9386 .endd
9387 The string starts with the first character after the colon, which may be
9388 leading white space. A list of operators is given in section &<<SECTexpop>>&
9389 below. The operator notation is used for simple expansion items that have just
9390 one argument, because it reduces the number of braces and therefore makes the
9391 string easier to understand.
9392
9393 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9394 This item inserts &"basic"& header lines. It is described with the &%header%&
9395 expansion item below.
9396
9397
9398 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9399 .cindex "expansion" "calling an acl"
9400 .cindex "&%acl%&" "call from expansion"
9401 The name and zero to nine argument strings are first expanded separately.  The expanded
9402 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9403 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9404 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9405 and may use the variables; if another acl expansion is used the values
9406 are restored after it returns.  If the ACL sets
9407 a value using a "message =" modifier and returns accept or deny, the value becomes
9408 the result of the expansion.
9409 If no message is set and the ACL returns accept or deny
9410 the expansion result is an empty string.
9411 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9412
9413
9414 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9415 .cindex authentication "results header"
9416 .cindex headers "authentication-results:"
9417 .cindex authentication "expansion item"
9418 This item returns a string suitable for insertion as an
9419 &'Authentication-Results:'&
9420 header line.
9421 The given <&'authserv-id'&> is included in the result; typically this
9422 will be a domain name identifying the system performing the authentications.
9423 Methods that might be present in the result include:
9424 .code
9425 none
9426 iprev
9427 auth
9428 spf
9429 dkim
9430 .endd
9431
9432 Example use (as an ACL modifier):
9433 .code
9434       add_header = :at_start:${authresults {$primary_hostname}}
9435 .endd
9436 This is safe even if no authentication results are available.
9437
9438
9439 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9440        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9441 .cindex "expansion" "extracting certificate fields"
9442 .cindex "&%certextract%&" "certificate fields"
9443 .cindex "certificate" "extracting fields"
9444 The <&'certificate'&> must be a variable of type certificate.
9445 The field name is expanded and used to retrieve the relevant field from
9446 the certificate.  Supported fields are:
9447 .display
9448 &`version        `&
9449 &`serial_number  `&
9450 &`subject        `& RFC4514 DN
9451 &`issuer         `& RFC4514 DN
9452 &`notbefore      `& time
9453 &`notafter       `& time
9454 &`sig_algorithm  `&
9455 &`signature      `&
9456 &`subj_altname   `& tagged list
9457 &`ocsp_uri       `& list
9458 &`crl_uri        `& list
9459 .endd
9460 If the field is found,
9461 <&'string2'&> is expanded, and replaces the whole item;
9462 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9463 variable &$value$& contains the value that has been extracted. Afterwards, it
9464 is restored to any previous value it might have had.
9465
9466 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9467 key is not found. If {<&'string2'&>} is also omitted, the value that was
9468 extracted is used.
9469
9470 Some field names take optional modifiers, appended and separated by commas.
9471
9472 The field selectors marked as "RFC4514" above
9473 output a Distinguished Name string which is
9474 not quite
9475 parseable by Exim as a comma-separated tagged list
9476 (the exceptions being elements containing commas).
9477 RDN elements of a single type may be selected by
9478 a modifier of the type label; if so the expansion
9479 result is a list (newline-separated by default).
9480 The separator may be changed by another modifier of
9481 a right angle-bracket followed immediately by the new separator.
9482 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9483
9484 The field selectors marked as "time" above
9485 take an optional modifier of "int"
9486 for which the result is the number of seconds since epoch.
9487 Otherwise the result is a human-readable string
9488 in the timezone selected by the main "timezone" option.
9489
9490 The field selectors marked as "list" above return a list,
9491 newline-separated by default,
9492 (embedded separator characters in elements are doubled).
9493 The separator may be changed by a modifier of
9494 a right angle-bracket followed immediately by the new separator.
9495
9496 The field selectors marked as "tagged" above
9497 prefix each list element with a type string and an equals sign.
9498 Elements of only one type may be selected by a modifier
9499 which is one of "dns", "uri" or "mail";
9500 if so the element tags are omitted.
9501
9502 If not otherwise noted field values are presented in human-readable form.
9503
9504 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9505        {*&<&'arg'&>&*}...}*&"
9506 .cindex &%dlfunc%&
9507 This expansion dynamically loads and then calls a locally-written C function.
9508 This functionality is available only if Exim is compiled with
9509 .code
9510 EXPAND_DLFUNC=yes
9511 .endd
9512 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9513 object so that it doesn't reload the same object file in the same Exim process
9514 (but of course Exim does start new processes frequently).
9515
9516 There may be from zero to eight arguments to the function.
9517
9518 When compiling
9519 a local function that is to be called in this way,
9520 first &_DLFUNC_IMPL_& should be defined,
9521 and second &_local_scan.h_& should be included.
9522 The Exim variables and functions that are defined by that API
9523 are also available for dynamically loaded functions. The function itself
9524 must have the following type:
9525 .code
9526 int dlfunction(uschar **yield, int argc, uschar *argv[])
9527 .endd
9528 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9529 function should return one of the following values:
9530
9531 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9532 into the expanded string that is being built.
9533
9534 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9535 from &'yield'&, if it is set.
9536
9537 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9538 taken from &'yield'& if it is set.
9539
9540 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9541
9542 When compiling a function that is to be used in this way with gcc,
9543 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9544 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9545
9546
9547 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9548 .cindex "expansion" "extracting value from environment"
9549 .cindex "environment" "values from"
9550 The key is first expanded separately, and leading and trailing white space
9551 removed.
9552 This is then searched for as a name in the environment.
9553 If a variable is found then its value is placed in &$value$&
9554 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9555
9556 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9557 appear, for example:
9558 .code
9559 ${env{USER}{$value} fail }
9560 .endd
9561 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9562 {<&'string1'&>} must be present for &"fail"& to be recognized.
9563
9564 If {<&'string2'&>} is omitted an empty string is substituted on
9565 search failure.
9566 If {<&'string1'&>} is omitted the search result is substituted on
9567 search success.
9568
9569 The environment is adjusted by the &%keep_environment%& and
9570 &%add_environment%& main section options.
9571
9572
9573 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9574        {*&<&'string3'&>&*}}*&"
9575 .cindex "expansion" "extracting substrings by key"
9576 .cindex "&%extract%&" "substrings by key"
9577 The key and <&'string1'&> are first expanded separately. Leading and trailing
9578 white space is removed from the key (but not from any of the strings). The key
9579 must not be empty and must not consist entirely of digits.
9580 The expanded <&'string1'&> must be of the form:
9581 .display
9582 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9583 .endd
9584 .vindex "&$value$&"
9585 where the equals signs and spaces (but not both) are optional. If any of the
9586 values contain white space, they must be enclosed in double quotes, and any
9587 values that are enclosed in double quotes are subject to escape processing as
9588 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9589 for the value that corresponds to the key. The search is case-insensitive. If
9590 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9591 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9592 variable &$value$& contains the value that has been extracted. Afterwards, it
9593 is restored to any previous value it might have had.
9594
9595 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9596 key is not found. If {<&'string2'&>} is also omitted, the value that was
9597 extracted is used. Thus, for example, these two expansions are identical, and
9598 yield &"2001"&:
9599 .code
9600 ${extract{gid}{uid=1984 gid=2001}}
9601 ${extract{gid}{uid=1984 gid=2001}{$value}}
9602 .endd
9603 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9604 appear, for example:
9605 .code
9606 ${extract{Z}{A=... B=...}{$value} fail }
9607 .endd
9608 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9609 {<&'string2'&>} must be present for &"fail"& to be recognized.
9610
9611 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9612        {*&<&'string3'&>&*}}*&" &&&
9613        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9614        {*&<&'string3'&>&*}}*&"
9615 .cindex "expansion" "extracting from JSON object"
9616 .cindex JSON expansions
9617 The key and <&'string1'&> are first expanded separately. Leading and trailing
9618 white space is removed from the key (but not from any of the strings). The key
9619 must not be empty and must not consist entirely of digits.
9620 The expanded <&'string1'&> must be of the form:
9621 .display
9622 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9623 .endd
9624 .vindex "&$value$&"
9625 The braces, commas and colons, and the quoting of the member name are required;
9626 the spaces are optional.
9627 Matching of the key against the member names is done case-sensitively.
9628 For the &"json"& variant,
9629 if a returned value is a JSON string, it retains its leading and
9630 trailing quotes.
9631 For the &"jsons"& variant, which is intended for use with JSON strings, the
9632 leading and trailing quotes are removed from the returned value.
9633 . XXX should be a UTF-8 compare
9634
9635 The results of matching are handled as above.
9636
9637
9638 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9639         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9640 .cindex "expansion" "extracting substrings by number"
9641 .cindex "&%extract%&" "substrings by number"
9642 The <&'number'&> argument must consist entirely of decimal digits,
9643 apart from leading and trailing white space, which is ignored.
9644 This is what distinguishes this form of &%extract%& from the previous kind. It
9645 behaves in the same way, except that, instead of extracting a named field, it
9646 extracts from <&'string1'&> the field whose number is given as the first
9647 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9648 <&'string3'&> as before.
9649
9650 The fields in the string are separated by any one of the characters in the
9651 separator string. These may include space or tab characters.
9652 The first field is numbered one. If the number is negative, the fields are
9653 counted from the end of the string, with the rightmost one numbered -1. If the
9654 number given is zero, the entire string is returned. If the modulus of the
9655 number is greater than the number of fields in the string, the result is the
9656 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9657 provided. For example:
9658 .code
9659 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9660 .endd
9661 yields &"42"&, and
9662 .code
9663 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9664 .endd
9665 yields &"99"&. Two successive separators mean that the field between them is
9666 empty (for example, the fifth field above).
9667
9668
9669 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9670         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9671        "&*${extract jsons{*&<&'number'&>&*}}&&&
9672         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9673 .cindex "expansion" "extracting from JSON array"
9674 .cindex JSON expansions
9675 The <&'number'&> argument must consist entirely of decimal digits,
9676 apart from leading and trailing white space, which is ignored.
9677
9678 Field selection and result handling is as above;
9679 there is no choice of field separator.
9680 For the &"json"& variant,
9681 if a returned value is a JSON string, it retains its leading and
9682 trailing quotes.
9683 For the &"jsons"& variant, which is intended for use with JSON strings, the
9684 leading and trailing quotes are removed from the returned value.
9685
9686
9687 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9688 .cindex "list" "selecting by condition"
9689 .cindex "expansion" "selecting from list by condition"
9690 .vindex "&$item$&"
9691 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9692 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9693 For each item
9694 in this list, its value is place in &$item$&, and then the condition is
9695 evaluated. If the condition is true, &$item$& is added to the output as an
9696 item in a new list; if the condition is false, the item is discarded. The
9697 separator used for the output list is the same as the one used for the
9698 input, but a separator setting is not included in the output. For example:
9699 .code
9700 ${filter{a:b:c}{!eq{$item}{b}}}
9701 .endd
9702 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9703 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9704
9705
9706 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9707 .cindex "hash function" "textual"
9708 .cindex "expansion" "textual hash"
9709 This is a textual hashing function, and was the first to be implemented in
9710 early versions of Exim. In current releases, there are other hashing functions
9711 (numeric, MD5, and SHA-1), which are described below.
9712
9713 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9714 <&'n'&>. If you are using fixed values for these numbers, that is, if
9715 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9716 use the simpler operator notation that avoids some of the braces:
9717 .code
9718 ${hash_<n>_<m>:<string>}
9719 .endd
9720 The second number is optional (in both notations). If <&'n'&> is greater than
9721 or equal to the length of the string, the expansion item returns the string.
9722 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9723 function to the string. The new string consists of characters taken from the
9724 first <&'m'&> characters of the string
9725 .code
9726 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9727 .endd
9728 If <&'m'&> is not present the value 26 is used, so that only lower case
9729 letters appear. For example:
9730 .display
9731 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9732 &`$hash{5}{monty}}           `&   yields  &`monty`&
9733 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9734 .endd
9735
9736 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9737         &*$h_*&<&'header&~name'&>&*:*&" &&&
9738        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9739         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9740        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9741         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9742        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9743         &*$rh_*&<&'header&~name'&>&*:*&"
9744 .cindex "expansion" "header insertion"
9745 .vindex "&$header_$&"
9746 .vindex "&$bheader_$&"
9747 .vindex "&$lheader_$&"
9748 .vindex "&$rheader_$&"
9749 .cindex "header lines" "in expansion strings"
9750 .cindex "header lines" "character sets"
9751 .cindex "header lines" "decoding"
9752 Substitute the contents of the named message header line, for example
9753 .code
9754 $header_reply-to:
9755 .endd
9756 The newline that terminates a header line is not included in the expansion, but
9757 internal newlines (caused by splitting the header line over several physical
9758 lines) may be present.
9759
9760 The difference between the four pairs of expansions is in the way
9761 the data in the header line is interpreted.
9762
9763 .ilist
9764 .cindex "white space" "in header lines"
9765 &%rheader%& gives the original &"raw"& content of the header line, with no
9766 processing at all, and without the removal of leading and trailing white space.
9767
9768 .next
9769 .cindex "list" "of header lines"
9770 &%lheader%& gives a colon-separated list, one element per header when there
9771 are multiple headers with a given name.
9772 Any embedded colon characters within an element are doubled, so normal Exim
9773 list-processing facilities can be used.
9774 The terminating newline of each element is removed; in other respects
9775 the content is &"raw"&.
9776
9777 .next
9778 .cindex "base64 encoding" "in header lines"
9779 &%bheader%& removes leading and trailing white space, and then decodes base64
9780 or quoted-printable MIME &"words"& within the header text, but does no
9781 character set translation. If decoding of what looks superficially like a MIME
9782 &"word"& fails, the raw string is returned. If decoding
9783 .cindex "binary zero" "in header line"
9784 produces a binary zero character, it is replaced by a question mark &-- this is
9785 what Exim does for binary zeros that are actually received in header lines.
9786
9787 .next
9788 &%header%& tries to translate the string as decoded by &%bheader%& to a
9789 standard character set. This is an attempt to produce the same string as would
9790 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9791 returned. Translation is attempted only on operating systems that support the
9792 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9793 a system Makefile or in &_Local/Makefile_&.
9794 .endlist ilist
9795
9796 In a filter file, the target character set for &%header%& can be specified by a
9797 command of the following form:
9798 .code
9799 headers charset "UTF-8"
9800 .endd
9801 This command affects all references to &$h_$& (or &$header_$&) expansions in
9802 subsequently obeyed filter commands. In the absence of this command, the target
9803 character set in a filter is taken from the setting of the &%headers_charset%&
9804 option in the runtime configuration. The value of this option defaults to the
9805 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9806 ISO-8859-1.
9807
9808 Header names follow the syntax of RFC 2822, which states that they may contain
9809 any printing characters except space and colon. Consequently, curly brackets
9810 &'do not'& terminate header names, and should not be used to enclose them as
9811 if they were variables. Attempting to do so causes a syntax error.
9812
9813 Only header lines that are common to all copies of a message are visible to
9814 this mechanism. These are the original header lines that are received with the
9815 message, and any that are added by an ACL statement or by a system
9816 filter. Header lines that are added to a particular copy of a message by a
9817 router or transport are not accessible.
9818
9819 For incoming SMTP messages, no header lines are visible in
9820 ACLs that are obeyed before the data phase completes,
9821 because the header structure is not set up until the message is received.
9822 They are visible in DKIM, PRDR and DATA ACLs.
9823 Header lines that are added in a RCPT ACL (for example)
9824 are saved until the message's incoming header lines are available, at which
9825 point they are added.
9826 When any of the above ACLs ar
9827 running, however, header lines added by earlier ACLs are visible.
9828
9829 Upper case and lower case letters are synonymous in header names. If the
9830 following character is white space, the terminating colon may be omitted, but
9831 this is not recommended, because you may then forget it when it is needed. When
9832 white space terminates the header name, this white space is included in the
9833 expanded string.  If the message does not contain the given header, the
9834 expansion item is replaced by an empty string. (See the &%def%& condition in
9835 section &<<SECTexpcond>>& for a means of testing for the existence of a
9836 header.)
9837
9838 If there is more than one header with the same name, they are all concatenated
9839 to form the substitution string, up to a maximum length of 64K. Unless
9840 &%rheader%& is being used, leading and trailing white space is removed from
9841 each header before concatenation, and a completely empty header is ignored. A
9842 newline character is then inserted between non-empty headers, but there is no
9843 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9844 those headers that contain lists of addresses, a comma is also inserted at the
9845 junctions between headers. This does not happen for the &%rheader%& expansion.
9846
9847 .new
9848 .cindex "tainted data"
9849 When the headers are from an incoming message,
9850 the result of expanding any of these variables is tainted.
9851 .wen
9852
9853
9854 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9855 .cindex "expansion" "hmac hashing"
9856 .cindex &%hmac%&
9857 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9858 shared secret and some text into a message authentication code, as specified in
9859 RFC 2104. This differs from &`${md5:secret_text...}`& or
9860 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9861 cryptographic hash, allowing for authentication that is not possible with MD5
9862 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9863 present. For example:
9864 .code
9865 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9866 .endd
9867 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9868 produces:
9869 .code
9870 dd97e3ba5d1a61b5006108f8c8252953
9871 .endd
9872 As an example of how this might be used, you might put in the main part of
9873 an Exim configuration:
9874 .code
9875 SPAMSCAN_SECRET=cohgheeLei2thahw
9876 .endd
9877 In a router or a transport you could then have:
9878 .code
9879 headers_add = \
9880   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9881   ${hmac{md5}{SPAMSCAN_SECRET}\
9882   {${primary_hostname},${message_exim_id},$h_message-id:}}
9883 .endd
9884 Then given a message, you can check where it was scanned by looking at the
9885 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9886 this header line is authentic by recomputing the authentication code from the
9887 host name, message ID and the &'Message-id:'& header line. This can be done
9888 using Exim's &%-be%& option, or by other means, for example, by using the
9889 &'hmac_md5_hex()'& function in Perl.
9890
9891
9892 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9893 .cindex "expansion" "conditional"
9894 .cindex "&%if%&, expansion item"
9895 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9896 item; otherwise <&'string2'&> is used. The available conditions are described
9897 in section &<<SECTexpcond>>& below. For example:
9898 .code
9899 ${if eq {$local_part}{postmaster} {yes}{no} }
9900 .endd
9901 The second string need not be present; if it is not and the condition is not
9902 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9903 be present instead of the second string (without any curly brackets). In this
9904 case, the expansion is forced to fail if the condition is not true (see section
9905 &<<SECTforexpfai>>&).
9906
9907 If both strings are omitted, the result is the string &`true`& if the condition
9908 is true, and the empty string if the condition is false. This makes it less
9909 cumbersome to write custom ACL and router conditions. For example, instead of
9910 .code
9911 condition = ${if >{$acl_m4}{3}{true}{false}}
9912 .endd
9913 you can use
9914 .code
9915 condition = ${if >{$acl_m4}{3}}
9916 .endd
9917
9918
9919
9920 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9921 .cindex expansion "imap folder"
9922 .cindex "&%imapfolder%& expansion item"
9923 This item converts a (possibly multilevel, or with non-ASCII characters)
9924 folder specification to a Maildir name for filesystem use.
9925 For information on internationalisation support see &<<SECTi18nMDA>>&.
9926
9927
9928
9929 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9930 .cindex "expansion" "string truncation"
9931 .cindex "&%length%& expansion item"
9932 The &%length%& item is used to extract the initial portion of a string. Both
9933 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9934 you are using a fixed value for the number, that is, if <&'string1'&> does not
9935 change when expanded, you can use the simpler operator notation that avoids
9936 some of the braces:
9937 .code
9938 ${length_<n>:<string>}
9939 .endd
9940 The result of this item is either the first <&'n'&> bytes or the whole
9941 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9942 &%strlen%&, which gives the length of a string.
9943 All measurement is done in bytes and is not UTF-8 aware.
9944
9945
9946 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9947         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9948 .cindex "expansion" "extracting list elements by number"
9949 .cindex "&%listextract%&" "extract list elements by number"
9950 .cindex "list" "extracting elements by number"
9951 The <&'number'&> argument must consist entirely of decimal digits,
9952 apart from an optional leading minus,
9953 and leading and trailing white space (which is ignored).
9954
9955 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9956 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9957
9958 The first field of the list is numbered one.
9959 If the number is negative, the fields are
9960 counted from the end of the list, with the rightmost one numbered -1.
9961 The numbered element of the list is extracted and placed in &$value$&,
9962 then <&'string2'&> is expanded as the result.
9963
9964 If the modulus of the
9965 number is zero or greater than the number of fields in the string,
9966 the result is the expansion of <&'string3'&>.
9967
9968 For example:
9969 .code
9970 ${listextract{2}{x:42:99}}
9971 .endd
9972 yields &"42"&, and
9973 .code
9974 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9975 .endd
9976 yields &"result: 42"&.
9977
9978 If {<&'string3'&>} is omitted, an empty string is used for string3.
9979 If {<&'string2'&>} is also omitted, the value that was
9980 extracted is used.
9981 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9982
9983
9984 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9985         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9986 This is the first of one of two different types of lookup item, which are both
9987 described in the next item.
9988
9989 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9990         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9991 .cindex "expansion" "lookup in"
9992 .cindex "file" "lookups"
9993 .cindex "lookup" "in expanded string"
9994 The two forms of lookup item specify data lookups in files and databases, as
9995 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9996 lookups, and the second is used for query-style lookups. The <&'key'&>,
9997 <&'file'&>, and <&'query'&> strings are expanded before use.
9998
9999 If there is any white space in a lookup item which is part of a filter command,
10000 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10001 other place where white space is significant, the lookup item must be enclosed
10002 in double quotes. The use of data lookups in users' filter files may be locked
10003 out by the system administrator.
10004
10005 .vindex "&$value$&"
10006 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10007 During its expansion, the variable &$value$& contains the data returned by the
10008 lookup. Afterwards it reverts to the value it had previously (at the outer
10009 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10010 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10011 string on failure. If <&'string2'&> is provided, it can itself be a nested
10012 lookup, thus providing a mechanism for looking up a default value when the
10013 original lookup fails.
10014
10015 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10016 data for the outer lookup while the parameters of the second lookup are
10017 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10018 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10019 appear, and in this case, if the lookup fails, the entire expansion is forced
10020 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10021 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10022 successful lookup, and nothing in the case of failure.
10023
10024 For single-key lookups, the string &"partial"& is permitted to precede the
10025 search type in order to do partial matching, and * or *@ may follow a search
10026 type to request default lookups if the key does not match (see sections
10027 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10028
10029 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10030 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10031 and non-wild parts of the key during the expansion of the replacement text.
10032 They return to their previous values at the end of the lookup item.
10033
10034 This example looks up the postmaster alias in the conventional alias file:
10035 .code
10036 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10037 .endd
10038 This example uses NIS+ to look up the full name of the user corresponding to
10039 the local part of an address, forcing the expansion to fail if it is not found:
10040 .code
10041 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10042   {$value}fail}
10043 .endd
10044
10045
10046 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10047 .cindex "expansion" "list creation"
10048 .vindex "&$item$&"
10049 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10050 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10051 For each item
10052 in this list, its value is place in &$item$&, and then <&'string2'&> is
10053 expanded and added to the output as an item in a new list. The separator used
10054 for the output list is the same as the one used for the input, but a separator
10055 setting is not included in the output. For example:
10056 .code
10057 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10058 .endd
10059 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10060 value of &$item$& is restored to what it was before. See also the &%filter%&
10061 and &%reduce%& expansion items.
10062
10063 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10064 .cindex "expansion" "numeric hash"
10065 .cindex "hash function" "numeric"
10066 The three strings are expanded; the first two must yield numbers. Call them
10067 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10068 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10069 can use the simpler operator notation that avoids some of the braces:
10070 .code
10071 ${nhash_<n>_<m>:<string>}
10072 .endd
10073 The second number is optional (in both notations). If there is only one number,
10074 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10075 processed by a div/mod hash function that returns two numbers, separated by a
10076 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10077 example,
10078 .code
10079 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10080 .endd
10081 returns the string &"6/33"&.
10082
10083
10084
10085 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10086 .cindex "Perl" "use in expanded string"
10087 .cindex "expansion" "calling Perl from"
10088 This item is available only if Exim has been built to include an embedded Perl
10089 interpreter. The subroutine name and the arguments are first separately
10090 expanded, and then the Perl subroutine is called with those arguments. No
10091 additional arguments need be given; the maximum number permitted, including the
10092 name of the subroutine, is nine.
10093
10094 The return value of the subroutine is inserted into the expanded string, unless
10095 the return value is &%undef%&. In that case, the expansion fails in the same
10096 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10097 Whatever you return is evaluated in a scalar context. For example, if you
10098 return the name of a Perl vector, the return value is the size of the vector,
10099 not its contents.
10100
10101 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10102 with the error message that was passed to &%die%&. More details of the embedded
10103 Perl facility are given in chapter &<<CHAPperl>>&.
10104
10105 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10106 out the use of this expansion item in filter files.
10107
10108
10109 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10110 .cindex "&%prvs%& expansion item"
10111 The first argument is a complete email address and the second is secret
10112 keystring. The third argument, specifying a key number, is optional. If absent,
10113 it defaults to 0. The result of the expansion is a prvs-signed email address,
10114 to be typically used with the &%return_path%& option on an &(smtp)& transport
10115 as part of a bounce address tag validation (BATV) scheme. For more discussion
10116 and an example, see section &<<SECTverifyPRVS>>&.
10117
10118 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10119         {*&<&'string'&>&*}}*&"
10120 .cindex "&%prvscheck%& expansion item"
10121 This expansion item is the complement of the &%prvs%& item. It is used for
10122 checking prvs-signed addresses. If the expansion of the first argument does not
10123 yield a syntactically valid prvs-signed address, the whole item expands to the
10124 empty string. When the first argument does expand to a syntactically valid
10125 prvs-signed address, the second argument is expanded, with the prvs-decoded
10126 version of the address and the key number extracted from the address in the
10127 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10128
10129 These two variables can be used in the expansion of the second argument to
10130 retrieve the secret. The validity of the prvs-signed address is then checked
10131 against the secret. The result is stored in the variable &$prvscheck_result$&,
10132 which is empty for failure or &"1"& for success.
10133
10134 The third argument is optional; if it is missing, it defaults to an empty
10135 string. This argument is now expanded. If the result is an empty string, the
10136 result of the expansion is the decoded version of the address. This is the case
10137 whether or not the signature was valid. Otherwise, the result of the expansion
10138 is the expansion of the third argument.
10139
10140 All three variables can be used in the expansion of the third argument.
10141 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10142 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10143
10144 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10145 .cindex "expansion" "inserting an entire file"
10146 .cindex "file" "inserting into expansion"
10147 .cindex "&%readfile%& expansion item"
10148 The filename and end-of-line string are first expanded separately. The file is
10149 then read, and its contents replace the entire item. All newline characters in
10150 the file are replaced by the end-of-line string if it is present. Otherwise,
10151 newlines are left in the string.
10152 String expansion is not applied to the contents of the file. If you want this,
10153 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10154 the string expansion fails.
10155
10156 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10157 locks out the use of this expansion item in filter files.
10158
10159
10160
10161 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10162         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10163 .cindex "expansion" "inserting from a socket"
10164 .cindex "socket, use of in expansion"
10165 .cindex "&%readsocket%& expansion item"
10166 This item inserts data from a Unix domain or TCP socket into the expanded
10167 string. The minimal way of using it uses just two arguments, as in these
10168 examples:
10169 .code
10170 ${readsocket{/socket/name}{request string}}
10171 ${readsocket{inet:some.host:1234}{request string}}
10172 .endd
10173 For a Unix domain socket, the first substring must be the path to the socket.
10174 For an Internet socket, the first substring must contain &`inet:`& followed by
10175 a host name or IP address, followed by a colon and a port, which can be a
10176 number or the name of a TCP port in &_/etc/services_&. An IP address may
10177 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10178 example:
10179 .code
10180 ${readsocket{inet:[::1]:1234}{request string}}
10181 .endd
10182 Only a single host name may be given, but if looking it up yields more than
10183 one IP address, they are each tried in turn until a connection is made. For
10184 both kinds of socket, Exim makes a connection, writes the request string
10185 unless it is an empty string; and no terminating NUL is ever sent)
10186 and reads from the socket until an end-of-file
10187 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10188 extend what can be done. Firstly, you can vary the timeout. For example:
10189 .code
10190 ${readsocket{/socket/name}{request string}{3s}}
10191 .endd
10192
10193 The third argument is a list of options, of which the first element is the timeout
10194 and must be present if the argument is given.
10195 Further elements are options of form &'name=value'&.
10196 Two option types is currently recognised: shutdown and tls.
10197 The first defines whether (the default)
10198 or not a shutdown is done on the connection after sending the request.
10199 Example, to not do so (preferred, eg. by some webservers):
10200 .code
10201 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10202 .endd
10203 The second, tls, controls the use of TLS on the connection.  Example:
10204 .code
10205 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10206 .endd
10207 The default is to not use TLS.
10208 If it is enabled, a shutdown as descripbed above is never done.
10209
10210 A fourth argument allows you to change any newlines that are in the data
10211 that is read, in the same way as for &%readfile%& (see above). This example
10212 turns them into spaces:
10213 .code
10214 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10215 .endd
10216 As with all expansions, the substrings are expanded before the processing
10217 happens. Errors in these sub-expansions cause the expansion to fail. In
10218 addition, the following errors can occur:
10219
10220 .ilist
10221 Failure to create a socket file descriptor;
10222 .next
10223 Failure to connect the socket;
10224 .next
10225 Failure to write the request string;
10226 .next
10227 Timeout on reading from the socket.
10228 .endlist
10229
10230 By default, any of these errors causes the expansion to fail. However, if
10231 you supply a fifth substring, it is expanded and used when any of the above
10232 errors occurs. For example:
10233 .code
10234 ${readsocket{/socket/name}{request string}{3s}{\n}\
10235   {socket failure}}
10236 .endd
10237 You can test for the existence of a Unix domain socket by wrapping this
10238 expansion in &`${if exists`&, but there is a race condition between that test
10239 and the actual opening of the socket, so it is safer to use the fifth argument
10240 if you want to be absolutely sure of avoiding an expansion error for a
10241 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10242
10243 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10244 locks out the use of this expansion item in filter files.
10245
10246
10247 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10248 .cindex "expansion" "reducing a list to a scalar"
10249 .cindex "list" "reducing to a scalar"
10250 .vindex "&$value$&"
10251 .vindex "&$item$&"
10252 This operation reduces a list to a single, scalar string. After expansion,
10253 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10254 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10255 Then <&'string2'&> is expanded and
10256 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10257 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10258 them. The result of that expansion is assigned to &$value$& before the next
10259 iteration. When the end of the list is reached, the final value of &$value$& is
10260 added to the expansion output. The &%reduce%& expansion item can be used in a
10261 number of ways. For example, to add up a list of numbers:
10262 .code
10263 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10264 .endd
10265 The result of that expansion would be &`6`&. The maximum of a list of numbers
10266 can be found:
10267 .code
10268 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10269 .endd
10270 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10271 restored to what they were before. See also the &%filter%& and &%map%&
10272 expansion items.
10273
10274 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10275 This item inserts &"raw"& header lines. It is described with the &%header%&
10276 expansion item in section &<<SECTexpansionitems>>& above.
10277
10278 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10279         {*&<&'string2'&>&*}}*&"
10280 .cindex "expansion" "running a command"
10281 .cindex "&%run%& expansion item"
10282 The command and its arguments are first expanded as one string. The string is
10283 split apart into individual arguments by spaces, and then the command is run
10284 in a separate process, but under the same uid and gid.  As in other command
10285 executions from Exim, a shell is not used by default. If the command requires
10286 a shell, you must explicitly code it.
10287
10288 Since the arguments are split by spaces, when there is a variable expansion
10289 which has an empty result, it will cause the situation that the argument will
10290 simply be omitted when the program is actually executed by Exim. If the
10291 script/program requires a specific number of arguments and the expanded
10292 variable could possibly result in this empty expansion, the variable must be
10293 quoted. This is more difficult if the expanded variable itself could result
10294 in a string containing quotes, because it would interfere with the quotes
10295 around the command arguments. A possible guard against this is to wrap the
10296 variable in the &%sg%& operator to change any quote marks to some other
10297 character.
10298
10299 The standard input for the command exists, but is empty. The standard output
10300 and standard error are set to the same file descriptor.
10301 .cindex "return code" "from &%run%& expansion"
10302 .vindex "&$value$&"
10303 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10304 and replaces the entire item; during this expansion, the standard output/error
10305 from the command is in the variable &$value$&. If the command fails,
10306 <&'string2'&>, if present, is expanded and used. Once again, during the
10307 expansion, the standard output/error from the command is in the variable
10308 &$value$&.
10309
10310 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10311 can be the word &"fail"& (not in braces) to force expansion failure if the
10312 command does not succeed. If both strings are omitted, the result is contents
10313 of the standard output/error on success, and nothing on failure.
10314
10315 .vindex "&$run_in_acl$&"
10316 The standard output/error of the command is put in the variable &$value$&.
10317 In this ACL example, the output of a command is logged for the admin to
10318 troubleshoot:
10319 .code
10320 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10321       log_message  = Output of id: $value
10322 .endd
10323 If the command requires shell idioms, such as the > redirect operator, the
10324 shell must be invoked directly, such as with:
10325 .code
10326 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10327 .endd
10328
10329 .vindex "&$runrc$&"
10330 The return code from the command is put in the variable &$runrc$&, and this
10331 remains set afterwards, so in a filter file you can do things like this:
10332 .code
10333 if "${run{x y z}{}}$runrc" is 1 then ...
10334   elif $runrc is 2 then ...
10335   ...
10336 endif
10337 .endd
10338 If execution of the command fails (for example, the command does not exist),
10339 the return code is 127 &-- the same code that shells use for non-existent
10340 commands.
10341
10342 &*Warning*&: In a router or transport, you cannot assume the order in which
10343 option values are expanded, except for those preconditions whose order of
10344 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10345 by the expansion of one option, and use it in another.
10346
10347 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10348 out the use of this expansion item in filter files.
10349
10350
10351 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10352 .cindex "expansion" "string substitution"
10353 .cindex "&%sg%& expansion item"
10354 This item works like Perl's substitution operator (s) with the global (/g)
10355 option; hence its name. However, unlike the Perl equivalent, Exim does not
10356 modify the subject string; instead it returns the modified string for insertion
10357 into the overall expansion. The item takes three arguments: the subject string,
10358 a regular expression, and a substitution string. For example:
10359 .code
10360 ${sg{abcdefabcdef}{abc}{xyz}}
10361 .endd
10362 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10363 if any $, } or \ characters are required in the regular expression or in the
10364 substitution string, they have to be escaped. For example:
10365 .code
10366 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10367 .endd
10368 yields &"defabc"&, and
10369 .code
10370 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10371 .endd
10372 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10373 the regular expression from string expansion.
10374
10375 The regular expression is compiled in 8-bit mode, working against bytes
10376 rather than any Unicode-aware character handling.
10377
10378
10379 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10380 .cindex sorting "a list"
10381 .cindex list sorting
10382 .cindex expansion "list sorting"
10383 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10384 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10385 The <&'comparator'&> argument is interpreted as the operator
10386 of a two-argument expansion condition.
10387 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10388 The comparison should return true when applied to two values
10389 if the first value should sort before the second value.
10390 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10391 the element being placed in &$item$&,
10392 to give values for comparison.
10393
10394 The item result is a sorted list,
10395 with the original list separator,
10396 of the list elements (in full) of the original.
10397
10398 Examples:
10399 .code
10400 ${sort{3:2:1:4}{<}{$item}}
10401 .endd
10402 sorts a list of numbers, and
10403 .code
10404 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10405 .endd
10406 will sort an MX lookup into priority order.
10407
10408
10409 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10410 .cindex "&%substr%& expansion item"
10411 .cindex "substring extraction"
10412 .cindex "expansion" "substring extraction"
10413 The three strings are expanded; the first two must yield numbers. Call them
10414 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10415 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10416 can use the simpler operator notation that avoids some of the braces:
10417 .code
10418 ${substr_<n>_<m>:<string>}
10419 .endd
10420 The second number is optional (in both notations).
10421 If it is absent in the simpler format, the preceding underscore must also be
10422 omitted.
10423
10424 The &%substr%& item can be used to extract more general substrings than
10425 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10426 length required. For example
10427 .code
10428 ${substr{3}{2}{$local_part}}
10429 .endd
10430 If the starting offset is greater than the string length the result is the
10431 null string; if the length plus starting offset is greater than the string
10432 length, the result is the right-hand part of the string, starting from the
10433 given offset. The first byte (character) in the string has offset zero.
10434
10435 The &%substr%& expansion item can take negative offset values to count
10436 from the right-hand end of its operand. The last byte (character) is offset -1,
10437 the second-last is offset -2, and so on. Thus, for example,
10438 .code
10439 ${substr{-5}{2}{1234567}}
10440 .endd
10441 yields &"34"&. If the absolute value of a negative offset is greater than the
10442 length of the string, the substring starts at the beginning of the string, and
10443 the length is reduced by the amount of overshoot. Thus, for example,
10444 .code
10445 ${substr{-5}{2}{12}}
10446 .endd
10447 yields an empty string, but
10448 .code
10449 ${substr{-3}{2}{12}}
10450 .endd
10451 yields &"1"&.
10452
10453 When the second number is omitted from &%substr%&, the remainder of the string
10454 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10455 string preceding the offset point are taken. For example, an offset of -1 and
10456 no length, as in these semantically identical examples:
10457 .code
10458 ${substr_-1:abcde}
10459 ${substr{-1}{abcde}}
10460 .endd
10461 yields all but the last character of the string, that is, &"abcd"&.
10462
10463 All measurement is done in bytes and is not UTF-8 aware.
10464
10465
10466
10467 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10468         {*&<&'replacements'&>&*}}*&"
10469 .cindex "expansion" "character translation"
10470 .cindex "&%tr%& expansion item"
10471 This item does single-character (in bytes) translation on its subject string. The second
10472 argument is a list of characters to be translated in the subject string. Each
10473 matching character is replaced by the corresponding character from the
10474 replacement list. For example
10475 .code
10476 ${tr{abcdea}{ac}{13}}
10477 .endd
10478 yields &`1b3de1`&. If there are duplicates in the second character string, the
10479 last occurrence is used. If the third string is shorter than the second, its
10480 last character is replicated. However, if it is empty, no translation takes
10481 place.
10482
10483 All character handling is done in bytes and is not UTF-8 aware.
10484
10485 .endlist
10486
10487
10488
10489 .section "Expansion operators" "SECTexpop"
10490 .cindex "expansion" "operators"
10491 For expansion items that perform transformations on a single argument string,
10492 the &"operator"& notation is used because it is simpler and uses fewer braces.
10493 The substring is first expanded before the operation is applied to it. The
10494 following operations can be performed:
10495
10496 .vlist
10497 .vitem &*${address:*&<&'string'&>&*}*&
10498 .cindex "expansion" "RFC 2822 address handling"
10499 .cindex "&%address%& expansion item"
10500 The string is interpreted as an RFC 2822 address, as it might appear in a
10501 header line, and the effective address is extracted from it. If the string does
10502 not parse successfully, the result is empty.
10503
10504 The parsing correctly handles SMTPUTF8 Unicode in the string.
10505
10506
10507 .vitem &*${addresses:*&<&'string'&>&*}*&
10508 .cindex "expansion" "RFC 2822 address handling"
10509 .cindex "&%addresses%& expansion item"
10510 The string (after expansion) is interpreted as a list of addresses in RFC
10511 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10512 operative address (&'local-part@domain'&) is extracted from each item, and the
10513 result of the expansion is a colon-separated list, with appropriate
10514 doubling of colons should any happen to be present in the email addresses.
10515 Syntactically invalid RFC2822 address items are omitted from the output.
10516
10517 It is possible to specify a character other than colon for the output
10518 separator by starting the string with > followed by the new separator
10519 character. For example:
10520 .code
10521 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10522 .endd
10523 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10524 first, so if the expanded string starts with >, it may change the output
10525 separator unintentionally. This can be avoided by setting the output
10526 separator explicitly:
10527 .code
10528 ${addresses:>:$h_from:}
10529 .endd
10530
10531 Compare the &%address%& (singular)
10532 expansion item, which extracts the working address from a single RFC2822
10533 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10534 processing lists.
10535
10536 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10537 a strict interpretation of header line formatting.  Exim parses the bare,
10538 unquoted portion of an email address and if it finds a comma, treats it as an
10539 email address separator. For the example header line:
10540 .code
10541 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10542 .endd
10543 The first example below demonstrates that Q-encoded email addresses are parsed
10544 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10545 It does not see the comma because it's still encoded as "=2C".  The second
10546 example below is passed the contents of &`$header_from:`&, meaning it gets
10547 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10548 The third example shows that the presence of a comma is skipped when it is
10549 quoted.  The fourth example shows SMTPUTF8 handling.
10550 .code
10551 # exim -be '${addresses:From: \
10552 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10553 user@example.com
10554 # exim -be '${addresses:From: Last, First <user@example.com>}'
10555 Last:user@example.com
10556 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10557 user@example.com
10558 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10559 フィリップ@example.jp
10560 .endd
10561
10562 .vitem &*${base32:*&<&'digits'&>&*}*&
10563 .cindex "&%base32%& expansion item"
10564 .cindex "expansion" "conversion to base 32"
10565 The string must consist entirely of decimal digits. The number is converted to
10566 base 32 and output as a (empty, for zero) string of characters.
10567 Only lowercase letters are used.
10568
10569 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10570 .cindex "&%base32d%& expansion item"
10571 .cindex "expansion" "conversion to base 32"
10572 The string must consist entirely of base-32 digits.
10573 The number is converted to decimal and output as a string.
10574
10575 .vitem &*${base62:*&<&'digits'&>&*}*&
10576 .cindex "&%base62%& expansion item"
10577 .cindex "expansion" "conversion to base 62"
10578 The string must consist entirely of decimal digits. The number is converted to
10579 base 62 and output as a string of six characters, including leading zeros. In
10580 the few operating environments where Exim uses base 36 instead of base 62 for
10581 its message identifiers (because those systems do not have case-sensitive
10582 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10583 to be absolutely clear: this is &'not'& base64 encoding.
10584
10585 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10586 .cindex "&%base62d%& expansion item"
10587 .cindex "expansion" "conversion to base 62"
10588 The string must consist entirely of base-62 digits, or, in operating
10589 environments where Exim uses base 36 instead of base 62 for its message
10590 identifiers, base-36 digits. The number is converted to decimal and output as a
10591 string.
10592
10593 .vitem &*${base64:*&<&'string'&>&*}*&
10594 .cindex "expansion" "base64 encoding"
10595 .cindex "base64 encoding" "in string expansion"
10596 .cindex "&%base64%& expansion item"
10597 .cindex certificate "base64 of DER"
10598 This operator converts a string into one that is base64 encoded.
10599
10600 If the string is a single variable of type certificate,
10601 returns the base64 encoding of the DER form of the certificate.
10602
10603
10604 .vitem &*${base64d:*&<&'string'&>&*}*&
10605 .cindex "expansion" "base64 decoding"
10606 .cindex "base64 decoding" "in string expansion"
10607 .cindex "&%base64d%& expansion item"
10608 This operator converts a base64-encoded string into the un-coded form.
10609
10610
10611 .vitem &*${domain:*&<&'string'&>&*}*&
10612 .cindex "domain" "extraction"
10613 .cindex "expansion" "domain extraction"
10614 The string is interpreted as an RFC 2822 address and the domain is extracted
10615 from it. If the string does not parse successfully, the result is empty.
10616
10617
10618 .vitem &*${escape:*&<&'string'&>&*}*&
10619 .cindex "expansion" "escaping non-printing characters"
10620 .cindex "&%escape%& expansion item"
10621 If the string contains any non-printing characters, they are converted to
10622 escape sequences starting with a backslash. Whether characters with the most
10623 significant bit set (so-called &"8-bit characters"&) count as printing or not
10624 is controlled by the &%print_topbitchars%& option.
10625
10626 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10627 .cindex "expansion" "escaping 8-bit characters"
10628 .cindex "&%escape8bit%& expansion item"
10629 If the string contains and characters with the most significant bit set,
10630 they are converted to escape sequences starting with a backslash.
10631 Backslashes and DEL characters are also converted.
10632
10633
10634 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10635 .cindex "expansion" "expression evaluation"
10636 .cindex "expansion" "arithmetic expression"
10637 .cindex "&%eval%& expansion item"
10638 These items supports simple arithmetic and bitwise logical operations in
10639 expansion strings. The string (after expansion) must be a conventional
10640 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10641 logical operators, and parentheses. All operations are carried out using
10642 integer arithmetic. The operator priorities are as follows (the same as in the
10643 C programming language):
10644 .table2 70pt 300pt
10645 .irow &'highest:'& "not (~), negate (-)"
10646 .irow ""   "multiply (*), divide (/), remainder (%)"
10647 .irow ""   "plus (+), minus (-)"
10648 .irow ""   "shift-left (<<), shift-right (>>)"
10649 .irow ""   "and (&&)"
10650 .irow ""   "xor (^)"
10651 .irow &'lowest:'&  "or (|)"
10652 .endtable
10653 Binary operators with the same priority are evaluated from left to right. White
10654 space is permitted before or after operators.
10655
10656 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10657 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10658 decimal, even if they start with a leading zero; hexadecimal numbers are not
10659 permitted. This can be useful when processing numbers extracted from dates or
10660 times, which often do have leading zeros.
10661
10662 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10663 or 1024*1024*1024,
10664 respectively. Negative numbers are supported. The result of the computation is
10665 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10666
10667 .display
10668 &`${eval:1+1}            `&  yields 2
10669 &`${eval:1+2*3}          `&  yields 7
10670 &`${eval:(1+2)*3}        `&  yields 9
10671 &`${eval:2+42%5}         `&  yields 4
10672 &`${eval:0xc&amp;5}          `&  yields 4
10673 &`${eval:0xc|5}          `&  yields 13
10674 &`${eval:0xc^5}          `&  yields 9
10675 &`${eval:0xc>>1}         `&  yields 6
10676 &`${eval:0xc<<1}         `&  yields 24
10677 &`${eval:~255&amp;0x1234}    `&  yields 4608
10678 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10679 .endd
10680
10681 As a more realistic example, in an ACL you might have
10682 .code
10683 deny   message = Too many bad recipients
10684        condition =                    \
10685          ${if and {                   \
10686            {>{$rcpt_count}{10}}       \
10687            {                          \
10688            <                          \
10689              {$recipients_count}      \
10690              {${eval:$rcpt_count/2}}  \
10691            }                          \
10692          }{yes}{no}}
10693 .endd
10694 The condition is true if there have been more than 10 RCPT commands and
10695 fewer than half of them have resulted in a valid recipient.
10696
10697
10698 .vitem &*${expand:*&<&'string'&>&*}*&
10699 .cindex "expansion" "re-expansion of substring"
10700 The &%expand%& operator causes a string to be expanded for a second time. For
10701 example,
10702 .code
10703 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10704 .endd
10705 first looks up a string in a file while expanding the operand for &%expand%&,
10706 and then re-expands what it has found.
10707
10708
10709 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10710 .cindex "Unicode"
10711 .cindex "UTF-8" "conversion from"
10712 .cindex "expansion" "UTF-8 conversion"
10713 .cindex "&%from_utf8%& expansion item"
10714 The world is slowly moving towards Unicode, although there are no standards for
10715 email yet. However, other applications (including some databases) are starting
10716 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10717 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10718 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10719 the result is an undefined sequence of bytes.
10720
10721 Unicode code points with values less than 256 are compatible with ASCII and
10722 ISO-8859-1 (also known as Latin-1).
10723 For example, character 169 is the copyright symbol in both cases, though the
10724 way it is encoded is different. In UTF-8, more than one byte is needed for
10725 characters with code values greater than 127, whereas ISO-8859-1 is a
10726 single-byte encoding (but thereby limited to 256 characters). This makes
10727 translation from UTF-8 to ISO-8859-1 straightforward.
10728
10729
10730 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10731 .cindex "hash function" "textual"
10732 .cindex "expansion" "textual hash"
10733 The &%hash%& operator is a simpler interface to the hashing function that can
10734 be used when the two parameters are fixed numbers (as opposed to strings that
10735 change when expanded). The effect is the same as
10736 .code
10737 ${hash{<n>}{<m>}{<string>}}
10738 .endd
10739 See the description of the general &%hash%& item above for details. The
10740 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10741
10742
10743
10744 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10745 .cindex "base64 encoding" "conversion from hex"
10746 .cindex "expansion" "hex to base64"
10747 .cindex "&%hex2b64%& expansion item"
10748 This operator converts a hex string into one that is base64 encoded. This can
10749 be useful for processing the output of the various hashing functions.
10750
10751
10752
10753 .vitem &*${hexquote:*&<&'string'&>&*}*&
10754 .cindex "quoting" "hex-encoded unprintable characters"
10755 .cindex "&%hexquote%& expansion item"
10756 This operator converts non-printable characters in a string into a hex
10757 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10758 as is, and other byte values are converted to &`\xNN`&, for example, a
10759 byte value 127 is converted to &`\x7f`&.
10760
10761
10762 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10763 .cindex "&%ipv6denorm%& expansion item"
10764 .cindex "IP address" normalisation
10765 This expands an IPv6 address to a full eight-element colon-separated set
10766 of hex digits including leading zeroes.
10767 A trailing ipv4-style dotted-decimal set is converted to hex.
10768 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10769
10770 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10771 .cindex "&%ipv6norm%& expansion item"
10772 .cindex "IP address" normalisation
10773 .cindex "IP address" "canonical form"
10774 This converts an IPv6 address to canonical form.
10775 Leading zeroes of groups are omitted, and the longest
10776 set of zero-valued groups is replaced with a double colon.
10777 A trailing ipv4-style dotted-decimal set is converted to hex.
10778 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10779
10780
10781 .vitem &*${lc:*&<&'string'&>&*}*&
10782 .cindex "case forcing in strings"
10783 .cindex "string" "case forcing"
10784 .cindex "lower casing"
10785 .cindex "expansion" "case forcing"
10786 .cindex "&%lc%& expansion item"
10787 This forces the letters in the string into lower-case, for example:
10788 .code
10789 ${lc:$local_part}
10790 .endd
10791 Case is defined per the system C locale.
10792
10793 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10794 .cindex "expansion" "string truncation"
10795 .cindex "&%length%& expansion item"
10796 The &%length%& operator is a simpler interface to the &%length%& function that
10797 can be used when the parameter is a fixed number (as opposed to a string that
10798 changes when expanded). The effect is the same as
10799 .code
10800 ${length{<number>}{<string>}}
10801 .endd
10802 See the description of the general &%length%& item above for details. Note that
10803 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10804 when &%length%& is used as an operator.
10805 All measurement is done in bytes and is not UTF-8 aware.
10806
10807
10808 .vitem &*${listcount:*&<&'string'&>&*}*&
10809 .cindex "expansion" "list item count"
10810 .cindex "list" "item count"
10811 .cindex "list" "count of items"
10812 .cindex "&%listcount%& expansion item"
10813 The string is interpreted as a list and the number of items is returned.
10814
10815
10816 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10817 .cindex "expansion" "named list"
10818 .cindex "&%listnamed%& expansion item"
10819 The name is interpreted as a named list and the content of the list is returned,
10820 expanding any referenced lists, re-quoting as needed for colon-separation.
10821 If the optional type is given it must be one of "a", "d", "h" or "l"
10822 and selects address-, domain-, host- or localpart- lists to search among respectively.
10823 Otherwise all types are searched in an undefined order and the first
10824 matching list is returned.
10825
10826
10827 .vitem &*${local_part:*&<&'string'&>&*}*&
10828 .cindex "expansion" "local part extraction"
10829 .cindex "&%local_part%& expansion item"
10830 The string is interpreted as an RFC 2822 address and the local part is
10831 extracted from it. If the string does not parse successfully, the result is
10832 empty.
10833 The parsing correctly handles SMTPUTF8 Unicode in the string.
10834
10835
10836 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10837 .cindex "masked IP address"
10838 .cindex "IP address" "masking"
10839 .cindex "CIDR notation"
10840 .cindex "expansion" "IP address masking"
10841 .cindex "&%mask%& expansion item"
10842 If the form of the string to be operated on is not an IP address followed by a
10843 slash and an integer (that is, a network address in CIDR notation), the
10844 expansion fails. Otherwise, this operator converts the IP address to binary,
10845 masks off the least significant bits according to the bit count, and converts
10846 the result back to text, with mask appended. For example,
10847 .code
10848 ${mask:10.111.131.206/28}
10849 .endd
10850 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10851 be mostly used for looking up masked addresses in files, the result for an IPv6
10852 address uses dots to separate components instead of colons, because colon
10853 terminates a key string in lsearch files. So, for example,
10854 .code
10855 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10856 .endd
10857 returns the string
10858 .code
10859 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10860 .endd
10861 Letters in IPv6 addresses are always output in lower case.
10862
10863
10864 .vitem &*${md5:*&<&'string'&>&*}*&
10865 .cindex "MD5 hash"
10866 .cindex "expansion" "MD5 hash"
10867 .cindex certificate fingerprint
10868 .cindex "&%md5%& expansion item"
10869 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10870 as a 32-digit hexadecimal number, in which any letters are in lower case.
10871
10872 If the string is a single variable of type certificate,
10873 returns the MD5 hash fingerprint of the certificate.
10874
10875
10876 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10877 .cindex "expansion" "numeric hash"
10878 .cindex "hash function" "numeric"
10879 The &%nhash%& operator is a simpler interface to the numeric hashing function
10880 that can be used when the two parameters are fixed numbers (as opposed to
10881 strings that change when expanded). The effect is the same as
10882 .code
10883 ${nhash{<n>}{<m>}{<string>}}
10884 .endd
10885 See the description of the general &%nhash%& item above for details.
10886
10887
10888 .vitem &*${quote:*&<&'string'&>&*}*&
10889 .cindex "quoting" "in string expansions"
10890 .cindex "expansion" "quoting"
10891 .cindex "&%quote%& expansion item"
10892 The &%quote%& operator puts its argument into double quotes if it
10893 is an empty string or
10894 contains anything other than letters, digits, underscores, dots, and hyphens.
10895 Any occurrences of double quotes and backslashes are escaped with a backslash.
10896 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10897 respectively For example,
10898 .code
10899 ${quote:ab"*"cd}
10900 .endd
10901 becomes
10902 .code
10903 "ab\"*\"cd"
10904 .endd
10905 The place where this is useful is when the argument is a substitution from a
10906 variable or a message header.
10907
10908 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10909 .cindex "&%quote_local_part%& expansion item"
10910 This operator is like &%quote%&, except that it quotes the string only if
10911 required to do so by the rules of RFC 2822 for quoting local parts. For
10912 example, a plus sign would not cause quoting (but it would for &%quote%&).
10913 If you are creating a new email address from the contents of &$local_part$&
10914 (or any other unknown data), you should always use this operator.
10915
10916 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10917 will likely use the quoting form.
10918 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10919
10920
10921 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10922 .cindex "quoting" "lookup-specific"
10923 This operator applies lookup-specific quoting rules to the string. Each
10924 query-style lookup type has its own quoting rules which are described with
10925 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10926 .code
10927 ${quote_ldap:two * two}
10928 .endd
10929 returns
10930 .code
10931 two%20%5C2A%20two
10932 .endd
10933 For single-key lookup types, no quoting is ever necessary and this operator
10934 yields an unchanged string.
10935
10936
10937 .vitem &*${randint:*&<&'n'&>&*}*&
10938 .cindex "random number"
10939 This operator returns a somewhat random number which is less than the
10940 supplied number and is at least 0.  The quality of this randomness depends
10941 on how Exim was built; the values are not suitable for keying material.
10942 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10943 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10944 for versions of GnuTLS with that function.
10945 Otherwise, the implementation may be arc4random(), random() seeded by
10946 srandomdev() or srandom(), or a custom implementation even weaker than
10947 random().
10948
10949
10950 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10951 .cindex "expansion" "IP address"
10952 This operator reverses an IP address; for IPv4 addresses, the result is in
10953 dotted-quad decimal form, while for IPv6 addresses the result is in
10954 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10955 for DNS.  For example,
10956 .code
10957 ${reverse_ip:192.0.2.4}
10958 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10959 .endd
10960 returns
10961 .code
10962 4.2.0.192
10963 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
10964 .endd
10965
10966
10967 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10968 .cindex "expansion" "RFC 2047"
10969 .cindex "RFC 2047" "expansion operator"
10970 .cindex "&%rfc2047%& expansion item"
10971 This operator encodes text according to the rules of RFC 2047. This is an
10972 encoding that is used in header lines to encode non-ASCII characters. It is
10973 assumed that the input string is in the encoding specified by the
10974 &%headers_charset%& option, which gets its default at build time. If the string
10975 contains only characters in the range 33&--126, and no instances of the
10976 characters
10977 .code
10978 ? = ( ) < > @ , ; : \ " . [ ] _
10979 .endd
10980 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10981 string, using as many &"encoded words"& as necessary to encode all the
10982 characters.
10983
10984
10985 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10986 .cindex "expansion" "RFC 2047"
10987 .cindex "RFC 2047" "decoding"
10988 .cindex "&%rfc2047d%& expansion item"
10989 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10990 bytes are replaced by question marks. Characters are converted into the
10991 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10992 not recognized unless &%check_rfc2047_length%& is set false.
10993
10994 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10995 access a header line, RFC 2047 decoding is done automatically. You do not need
10996 to use this operator as well.
10997
10998
10999
11000 .vitem &*${rxquote:*&<&'string'&>&*}*&
11001 .cindex "quoting" "in regular expressions"
11002 .cindex "regular expressions" "quoting"
11003 .cindex "&%rxquote%& expansion item"
11004 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11005 characters in its argument. This is useful when substituting the values of
11006 variables or headers inside regular expressions.
11007
11008
11009 .vitem &*${sha1:*&<&'string'&>&*}*&
11010 .cindex "SHA-1 hash"
11011 .cindex "expansion" "SHA-1 hashing"
11012 .cindex certificate fingerprint
11013 .cindex "&%sha1%& expansion item"
11014 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11015 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11016
11017 If the string is a single variable of type certificate,
11018 returns the SHA-1 hash fingerprint of the certificate.
11019
11020
11021 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11022        &*${sha2:*&<&'string'&>&*}*& &&&
11023        &*${sha2_<n>:*&<&'string'&>&*}*&
11024 .cindex "SHA-256 hash"
11025 .cindex "SHA-2 hash"
11026 .cindex certificate fingerprint
11027 .cindex "expansion" "SHA-256 hashing"
11028 .cindex "&%sha256%& expansion item"
11029 .cindex "&%sha2%& expansion item"
11030 The &%sha256%& operator computes the SHA-256 hash value of the string
11031 and returns
11032 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11033
11034 If the string is a single variable of type certificate,
11035 returns the SHA-256 hash fingerprint of the certificate.
11036
11037 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11038 (except for certificates, which are not supported).
11039 Finally, if an underbar
11040 and a number is appended it specifies the output length, selecting a
11041 member of the SHA-2 family of hash functions.
11042 Values of 256, 384 and 512 are accepted, with 256 being the default.
11043
11044
11045 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11046        &*${sha3_<n>:*&<&'string'&>&*}*&
11047 .cindex "SHA3 hash"
11048 .cindex "expansion" "SHA3 hashing"
11049 .cindex "&%sha3%& expansion item"
11050 The &%sha3%& operator computes the SHA3-256 hash value of the string
11051 and returns
11052 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11053
11054 If a number is appended, separated by an underbar, it specifies
11055 the output length.  Values of 224, 256, 384 and 512 are accepted;
11056 with 256 being the default.
11057
11058 The &%sha3%& expansion item is only supported if Exim has been
11059 compiled with GnuTLS 3.5.0 or later,
11060 or OpenSSL 1.1.1 or later.
11061 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11062
11063
11064 .vitem &*${stat:*&<&'string'&>&*}*&
11065 .cindex "expansion" "statting a file"
11066 .cindex "file" "extracting characteristics"
11067 .cindex "&%stat%& expansion item"
11068 The string, after expansion, must be a file path. A call to the &[stat()]&
11069 function is made for this path. If &[stat()]& fails, an error occurs and the
11070 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11071 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11072 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11073 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11074 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11075 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11076 can extract individual fields using the &%extract%& expansion item.
11077
11078 The use of the &%stat%& expansion in users' filter files can be locked out by
11079 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11080 systems for files larger than 2GB.
11081
11082 .vitem &*${str2b64:*&<&'string'&>&*}*&
11083 .cindex "&%str2b64%& expansion item"
11084 Now deprecated, a synonym for the &%base64%& expansion operator.
11085
11086
11087
11088 .vitem &*${strlen:*&<&'string'&>&*}*&
11089 .cindex "expansion" "string length"
11090 .cindex "string" "length in expansion"
11091 .cindex "&%strlen%& expansion item"
11092 The item is replace by the length of the expanded string, expressed as a
11093 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11094 All measurement is done in bytes and is not UTF-8 aware.
11095
11096
11097 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11098 .cindex "&%substr%& expansion item"
11099 .cindex "substring extraction"
11100 .cindex "expansion" "substring expansion"
11101 The &%substr%& operator is a simpler interface to the &%substr%& function that
11102 can be used when the two parameters are fixed numbers (as opposed to strings
11103 that change when expanded). The effect is the same as
11104 .code
11105 ${substr{<start>}{<length>}{<string>}}
11106 .endd
11107 See the description of the general &%substr%& item above for details. The
11108 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11109 All measurement is done in bytes and is not UTF-8 aware.
11110
11111 .vitem &*${time_eval:*&<&'string'&>&*}*&
11112 .cindex "&%time_eval%& expansion item"
11113 .cindex "time interval" "decoding"
11114 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11115 seconds.
11116
11117 .vitem &*${time_interval:*&<&'string'&>&*}*&
11118 .cindex "&%time_interval%& expansion item"
11119 .cindex "time interval" "formatting"
11120 The argument (after sub-expansion) must be a sequence of decimal digits that
11121 represents an interval of time as a number of seconds. It is converted into a
11122 number of larger units and output in Exim's normal time format, for example,
11123 &`1w3d4h2m6s`&.
11124
11125 .vitem &*${uc:*&<&'string'&>&*}*&
11126 .cindex "case forcing in strings"
11127 .cindex "string" "case forcing"
11128 .cindex "upper casing"
11129 .cindex "expansion" "case forcing"
11130 .cindex "&%uc%& expansion item"
11131 This forces the letters in the string into upper-case.
11132 Case is defined per the system C locale.
11133
11134 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11135 .cindex "correction of invalid utf-8 sequences in strings"
11136 .cindex "utf-8" "utf-8 sequences"
11137 .cindex "incorrect utf-8"
11138 .cindex "expansion" "utf-8 forcing"
11139 .cindex "&%utf8clean%& expansion item"
11140 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11141 In versions of Exim before 4.92, this did not correctly do so for a truncated
11142 final codepoint's encoding, and the character would be silently dropped.
11143 If you must handle detection of this scenario across both sets of Exim behavior,
11144 the complexity will depend upon the task.
11145 For instance, to detect if the first character is multibyte and a 1-byte
11146 extraction can be successfully used as a path component (as is common for
11147 dividing up delivery folders), you might use:
11148 .code
11149 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11150 .endd
11151 (which will false-positive if the first character of the local part is a
11152 literal question mark).
11153
11154 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11155        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11156        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11157        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11158 .cindex expansion UTF-8
11159 .cindex UTF-8 expansion
11160 .cindex EAI
11161 .cindex internationalisation
11162 .cindex "&%utf8_domain_to_alabel%& expansion item"
11163 .cindex "&%utf8_domain_from_alabel%& expansion item"
11164 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11165 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11166 These convert EAI mail name components between UTF-8 and a-label forms.
11167 For information on internationalisation support see &<<SECTi18nMTA>>&.
11168 .endlist
11169
11170
11171
11172
11173
11174
11175 .section "Expansion conditions" "SECTexpcond"
11176 .scindex IIDexpcond "expansion" "conditions"
11177 The following conditions are available for testing by the &%${if%& construct
11178 while expanding strings:
11179
11180 .vlist
11181 .vitem &*!*&<&'condition'&>
11182 .cindex "expansion" "negating a condition"
11183 .cindex "negation" "in expansion condition"
11184 Preceding any condition with an exclamation mark negates the result of the
11185 condition.
11186
11187 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11188 .cindex "numeric comparison"
11189 .cindex "expansion" "numeric comparison"
11190 There are a number of symbolic operators for doing numeric comparisons. They
11191 are:
11192 .display
11193 &`=   `&   equal
11194 &`==  `&   equal
11195 &`>   `&   greater
11196 &`>=  `&   greater or equal
11197 &`<   `&   less
11198 &`<=  `&   less or equal
11199 .endd
11200 For example:
11201 .code
11202 ${if >{$message_size}{10M} ...
11203 .endd
11204 Note that the general negation operator provides for inequality testing. The
11205 two strings must take the form of optionally signed decimal integers,
11206 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11207 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11208 As a special case, the numerical value of an empty string is taken as
11209 zero.
11210
11211 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11212 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11213 10M, not if 10M is larger than &$message_size$&.
11214
11215
11216 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11217         {*&<&'arg2'&>&*}...}*&
11218 .cindex "expansion" "calling an acl"
11219 .cindex "&%acl%&" "expansion condition"
11220 The name and zero to nine argument strings are first expanded separately.  The expanded
11221 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11222 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11223 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11224 and may use the variables; if another acl expansion is used the values
11225 are restored after it returns.  If the ACL sets
11226 a value using a "message =" modifier the variable $value becomes
11227 the result of the expansion, otherwise it is empty.
11228 If the ACL returns accept the condition is true; if deny, false.
11229 If the ACL returns defer the result is a forced-fail.
11230
11231 .vitem &*bool&~{*&<&'string'&>&*}*&
11232 .cindex "expansion" "boolean parsing"
11233 .cindex "&%bool%& expansion condition"
11234 This condition turns a string holding a true or false representation into
11235 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11236 (case-insensitively); also integer numbers map to true if non-zero,
11237 false if zero.
11238 An empty string is treated as false.
11239 Leading and trailing whitespace is ignored;
11240 thus a string consisting only of whitespace is false.
11241 All other string values will result in expansion failure.
11242
11243 When combined with ACL variables, this expansion condition will let you
11244 make decisions in one place and act on those decisions in another place.
11245 For example:
11246 .code
11247 ${if bool{$acl_m_privileged_sender} ...
11248 .endd
11249
11250
11251 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11252 .cindex "expansion" "boolean parsing"
11253 .cindex "&%bool_lax%& expansion condition"
11254 Like &%bool%&, this condition turns a string into a boolean state.  But
11255 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11256 loose definition that the Router &%condition%& option uses.  The empty string
11257 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11258 true.  Leading and trailing whitespace is ignored.
11259
11260 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11261
11262 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11263 .cindex "expansion" "encrypted comparison"
11264 .cindex "encrypted strings, comparing"
11265 .cindex "&%crypteq%& expansion condition"
11266 This condition is included in the Exim binary if it is built to support any
11267 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11268 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11269 included in the binary.
11270
11271 The &%crypteq%& condition has two arguments. The first is encrypted and
11272 compared against the second, which is already encrypted. The second string may
11273 be in the LDAP form for storing encrypted strings, which starts with the
11274 encryption type in curly brackets, followed by the data. If the second string
11275 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11276 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11277 Typically this will be a field from a password file. An example of an encrypted
11278 string in LDAP form is:
11279 .code
11280 {md5}CY9rzUYh03PK3k6DJie09g==
11281 .endd
11282 If such a string appears directly in an expansion, the curly brackets have to
11283 be quoted, because they are part of the expansion syntax. For example:
11284 .code
11285 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11286 .endd
11287 The following encryption types (whose names are matched case-independently) are
11288 supported:
11289
11290 .ilist
11291 .cindex "MD5 hash"
11292 .cindex "base64 encoding" "in encrypted password"
11293 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11294 printable characters to compare with the remainder of the second string. If the
11295 length of the comparison string is 24, Exim assumes that it is base64 encoded
11296 (as in the above example). If the length is 32, Exim assumes that it is a
11297 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11298 comparison fails.
11299
11300 .next
11301 .cindex "SHA-1 hash"
11302 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11303 printable characters to compare with the remainder of the second string. If the
11304 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11305 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11306 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11307
11308 .next
11309 .cindex "&[crypt()]&"
11310 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11311 only the first eight characters of the password. However, in modern operating
11312 systems this is no longer true, and in many cases the entire password is used,
11313 whatever its length.
11314
11315 .next
11316 .cindex "&[crypt16()]&"
11317 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11318 use up to 16 characters of the password in some operating systems. Again, in
11319 modern operating systems, more characters may be used.
11320 .endlist
11321 Exim has its own version of &[crypt16()]&, which is just a double call to
11322 &[crypt()]&. For operating systems that have their own version, setting
11323 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11324 operating system version instead of its own. This option is set by default in
11325 the OS-dependent &_Makefile_& for those operating systems that are known to
11326 support &[crypt16()]&.
11327
11328 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11329 it was not using the same algorithm as some operating systems' versions. It
11330 turns out that as well as &[crypt16()]& there is a function called
11331 &[bigcrypt()]& in some operating systems. This may or may not use the same
11332 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11333
11334 However, since there is now a move away from the traditional &[crypt()]&
11335 functions towards using SHA1 and other algorithms, tidying up this area of
11336 Exim is seen as very low priority.
11337
11338 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11339 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11340 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11341 default is &`{crypt}`&. Whatever the default, you can always use either
11342 function by specifying it explicitly in curly brackets.
11343
11344 .vitem &*def:*&<&'variable&~name'&>
11345 .cindex "expansion" "checking for empty variable"
11346 .cindex "&%def%& expansion condition"
11347 The &%def%& condition must be followed by the name of one of the expansion
11348 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11349 variable does not contain the empty string. For example:
11350 .code
11351 ${if def:sender_ident {from $sender_ident}}
11352 .endd
11353 Note that the variable name is given without a leading &%$%& character. If the
11354 variable does not exist, the expansion fails.
11355
11356 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11357         &~&*def:h_*&<&'header&~name'&>&*:*&"
11358 .cindex "expansion" "checking header line existence"
11359 This condition is true if a message is being processed and the named header
11360 exists in the message. For example,
11361 .code
11362 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11363 .endd
11364 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11365 the header name must be terminated by a colon if white space does not follow.
11366
11367 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11368        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11369 .cindex "string" "comparison"
11370 .cindex "expansion" "string comparison"
11371 .cindex "&%eq%& expansion condition"
11372 .cindex "&%eqi%& expansion condition"
11373 The two substrings are first expanded. The condition is true if the two
11374 resulting strings are identical. For &%eq%& the comparison includes the case of
11375 letters, whereas for &%eqi%& the comparison is case-independent, where
11376 case is defined per the system C locale.
11377
11378 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11379 .cindex "expansion" "file existence test"
11380 .cindex "file" "existence test"
11381 .cindex "&%exists%&, expansion condition"
11382 The substring is first expanded and then interpreted as an absolute path. The
11383 condition is true if the named file (or directory) exists. The existence test
11384 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11385 users' filter files may be locked out by the system administrator.
11386
11387 .vitem &*first_delivery*&
11388 .cindex "delivery" "first"
11389 .cindex "first delivery"
11390 .cindex "expansion" "first delivery test"
11391 .cindex "&%first_delivery%& expansion condition"
11392 This condition, which has no data, is true during a message's first delivery
11393 attempt. It is false during any subsequent delivery attempts.
11394
11395
11396 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11397        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11398 .cindex "list" "iterative conditions"
11399 .cindex "expansion" "&*forall*& condition"
11400 .cindex "expansion" "&*forany*& condition"
11401 .vindex "&$item$&"
11402 These conditions iterate over a list. The first argument is expanded to form
11403 the list. By default, the list separator is a colon, but it can be changed by
11404 the normal method (&<<SECTlistsepchange>>&).
11405 The second argument is interpreted as a condition that is to
11406 be applied to each item in the list in turn. During the interpretation of the
11407 condition, the current list item is placed in a variable called &$item$&.
11408 .ilist
11409 For &*forany*&, interpretation stops if the condition is true for any item, and
11410 the result of the whole condition is true. If the condition is false for all
11411 items in the list, the overall condition is false.
11412 .next
11413 For &*forall*&, interpretation stops if the condition is false for any item,
11414 and the result of the whole condition is false. If the condition is true for
11415 all items in the list, the overall condition is true.
11416 .endlist
11417 Note that negation of &*forany*& means that the condition must be false for all
11418 items for the overall condition to succeed, and negation of &*forall*& means
11419 that the condition must be false for at least one item. In this example, the
11420 list separator is changed to a comma:
11421 .code
11422 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11423 .endd
11424 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11425 being processed, to enable these expansion items to be nested.
11426
11427 To scan a named list, expand it with the &*listnamed*& operator.
11428
11429 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11430        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11431        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11432        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11433 .cindex JSON "iterative conditions"
11434 .cindex JSON expansions
11435 .cindex expansion "&*forall_json*& condition"
11436 .cindex expansion "&*forany_json*& condition"
11437 .cindex expansion "&*forall_jsons*& condition"
11438 .cindex expansion "&*forany_jsons*& condition"
11439 As for the above, except that the first argument must, after expansion,
11440 be a JSON array.
11441 The array separator is not changeable.
11442 For the &"jsons"& variants the elements are expected to be JSON strings
11443 and have their quotes removed before the evaluation of the condition.
11444
11445
11446
11447 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11448        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11449 .cindex "string" "comparison"
11450 .cindex "expansion" "string comparison"
11451 .cindex "&%ge%& expansion condition"
11452 .cindex "&%gei%& expansion condition"
11453 The two substrings are first expanded. The condition is true if the first
11454 string is lexically greater than or equal to the second string. For &%ge%& the
11455 comparison includes the case of letters, whereas for &%gei%& the comparison is
11456 case-independent.
11457 Case and collation order are defined per the system C locale.
11458
11459 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11460        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11461 .cindex "string" "comparison"
11462 .cindex "expansion" "string comparison"
11463 .cindex "&%gt%& expansion condition"
11464 .cindex "&%gti%& expansion condition"
11465 The two substrings are first expanded. The condition is true if the first
11466 string is lexically greater than the second string. For &%gt%& the comparison
11467 includes the case of letters, whereas for &%gti%& the comparison is
11468 case-independent.
11469 Case and collation order are defined per the system C locale.
11470
11471 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11472        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11473 .cindex "string" "comparison"
11474 .cindex "list" "iterative conditions"
11475 Both strings are expanded; the second string is treated as a list of simple
11476 strings; if the first string is a member of the second, then the condition
11477 is true.
11478 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11479
11480 These are simpler to use versions of the more powerful &*forany*& condition.
11481 Examples, and the &*forany*& equivalents:
11482 .code
11483 ${if inlist{needle}{foo:needle:bar}}
11484   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11485 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11486   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11487 .endd
11488
11489 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11490        &*isip4&~{*&<&'string'&>&*}*& &&&
11491        &*isip6&~{*&<&'string'&>&*}*&
11492 .cindex "IP address" "testing string format"
11493 .cindex "string" "testing for IP address"
11494 .cindex "&%isip%& expansion condition"
11495 .cindex "&%isip4%& expansion condition"
11496 .cindex "&%isip6%& expansion condition"
11497 The substring is first expanded, and then tested to see if it has the form of
11498 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11499 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11500
11501 For an IPv4 address, the test is for four dot-separated components, each of
11502 which consists of from one to three digits. For an IPv6 address, up to eight
11503 colon-separated components are permitted, each containing from one to four
11504 hexadecimal digits. There may be fewer than eight components if an empty
11505 component (adjacent colons) is present. Only one empty component is permitted.
11506
11507 &*Note*&: The checks used to be just on the form of the address; actual numerical
11508 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11509 check.
11510 This is no longer the case.
11511
11512 The main use of these tests is to distinguish between IP addresses and
11513 host names, or between IPv4 and IPv6 addresses. For example, you could use
11514 .code
11515 ${if isip4{$sender_host_address}...
11516 .endd
11517 to test which IP version an incoming SMTP connection is using.
11518
11519 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11520 .cindex "LDAP" "use for authentication"
11521 .cindex "expansion" "LDAP authentication test"
11522 .cindex "&%ldapauth%& expansion condition"
11523 This condition supports user authentication using LDAP. See section
11524 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11525 queries. For this use, the query must contain a user name and password. The
11526 query itself is not used, and can be empty. The condition is true if the
11527 password is not empty, and the user name and password are accepted by the LDAP
11528 server. An empty password is rejected without calling LDAP because LDAP binds
11529 with an empty password are considered anonymous regardless of the username, and
11530 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11531 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11532 this can be used.
11533
11534
11535 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11536        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11537 .cindex "string" "comparison"
11538 .cindex "expansion" "string comparison"
11539 .cindex "&%le%& expansion condition"
11540 .cindex "&%lei%& expansion condition"
11541 The two substrings are first expanded. The condition is true if the first
11542 string is lexically less than or equal to the second string. For &%le%& the
11543 comparison includes the case of letters, whereas for &%lei%& the comparison is
11544 case-independent.
11545 Case and collation order are defined per the system C locale.
11546
11547 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11548        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11549 .cindex "string" "comparison"
11550 .cindex "expansion" "string comparison"
11551 .cindex "&%lt%& expansion condition"
11552 .cindex "&%lti%& expansion condition"
11553 The two substrings are first expanded. The condition is true if the first
11554 string is lexically less than the second string. For &%lt%& the comparison
11555 includes the case of letters, whereas for &%lti%& the comparison is
11556 case-independent.
11557 Case and collation order are defined per the system C locale.
11558
11559
11560 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11561 .cindex "expansion" "regular expression comparison"
11562 .cindex "regular expressions" "match in expanded string"
11563 .cindex "&%match%& expansion condition"
11564 The two substrings are first expanded. The second is then treated as a regular
11565 expression and applied to the first. Because of the pre-expansion, if the
11566 regular expression contains dollar, or backslash characters, they must be
11567 escaped. Care must also be taken if the regular expression contains braces
11568 (curly brackets). A closing brace must be escaped so that it is not taken as a
11569 premature termination of <&'string2'&>. The easiest approach is to use the
11570 &`\N`& feature to disable expansion of the regular expression.
11571 For example,
11572 .code
11573 ${if match {$local_part}{\N^\d{3}\N} ...
11574 .endd
11575 If the whole expansion string is in double quotes, further escaping of
11576 backslashes is also required.
11577
11578 The condition is true if the regular expression match succeeds.
11579 The regular expression is not required to begin with a circumflex
11580 metacharacter, but if there is no circumflex, the expression is not anchored,
11581 and it may match anywhere in the subject, not just at the start. If you want
11582 the pattern to match at the end of the subject, you must include the &`$`&
11583 metacharacter at an appropriate point.
11584 All character handling is done in bytes and is not UTF-8 aware,
11585 but we might change this in a future Exim release.
11586
11587 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11588 At the start of an &%if%& expansion the values of the numeric variable
11589 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11590 succeeds causes them to be reset to the substrings of that condition and they
11591 will have these values during the expansion of the success string. At the end
11592 of the &%if%& expansion, the previous values are restored. After testing a
11593 combination of conditions using &%or%&, the subsequent values of the numeric
11594 variables are those of the condition that succeeded.
11595
11596 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11597 .cindex "&%match_address%& expansion condition"
11598 See &*match_local_part*&.
11599
11600 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11601 .cindex "&%match_domain%& expansion condition"
11602 See &*match_local_part*&.
11603
11604 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11605 .cindex "&%match_ip%& expansion condition"
11606 This condition matches an IP address to a list of IP address patterns. It must
11607 be followed by two argument strings. The first (after expansion) must be an IP
11608 address or an empty string. The second (not expanded) is a restricted host
11609 list that can match only an IP address, not a host name. For example:
11610 .code
11611 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11612 .endd
11613 The specific types of host list item that are permitted in the list are:
11614
11615 .ilist
11616 An IP address, optionally with a CIDR mask.
11617 .next
11618 A single asterisk, which matches any IP address.
11619 .next
11620 An empty item, which matches only if the IP address is empty. This could be
11621 useful for testing for a locally submitted message or one from specific hosts
11622 in a single test such as
11623 . ==== As this is a nested list, any displays it contains must be indented
11624 . ==== as otherwise they are too far to the left. This comment applies to
11625 . ==== the use of xmlto plus fop. There's no problem when formatting with
11626 . ==== sdop, with or without the extra indent.
11627 .code
11628   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11629 .endd
11630 where the first item in the list is the empty string.
11631 .next
11632 The item @[] matches any of the local host's interface addresses.
11633 .next
11634 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11635 even if &`net-`& is not specified. There is never any attempt to turn the IP
11636 address into a host name. The most common type of linear search for
11637 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11638 masks. For example:
11639 .code
11640   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11641 .endd
11642 It is of course possible to use other kinds of lookup, and in such a case, you
11643 do need to specify the &`net-`& prefix if you want to specify a specific
11644 address mask, for example:
11645 .code
11646   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11647 .endd
11648 However, unless you are combining a &%match_ip%& condition with others, it is
11649 just as easy to use the fact that a lookup is itself a condition, and write:
11650 .code
11651   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11652 .endd
11653 .endlist ilist
11654
11655 Note that <&'string2'&> is not itself subject to string expansion, unless
11656 Exim was built with the EXPAND_LISTMATCH_RHS option.
11657
11658 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11659
11660 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11661 .cindex "domain list" "in expansion condition"
11662 .cindex "address list" "in expansion condition"
11663 .cindex "local part" "list, in expansion condition"
11664 .cindex "&%match_local_part%& expansion condition"
11665 This condition, together with &%match_address%& and &%match_domain%&, make it
11666 possible to test domain, address, and local part lists within expansions. Each
11667 condition requires two arguments: an item and a list to match. A trivial
11668 example is:
11669 .code
11670 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11671 .endd
11672 In each case, the second argument may contain any of the allowable items for a
11673 list of the appropriate type. Also, because the second argument
11674 is a standard form of list, it is possible to refer to a named list.
11675 Thus, you can use conditions like this:
11676 .code
11677 ${if match_domain{$domain}{+local_domains}{...
11678 .endd
11679 .cindex "&`+caseful`&"
11680 For address lists, the matching starts off caselessly, but the &`+caseful`&
11681 item can be used, as in all address lists, to cause subsequent items to
11682 have their local parts matched casefully. Domains are always matched
11683 caselessly.
11684
11685 Note that <&'string2'&> is not itself subject to string expansion, unless
11686 Exim was built with the EXPAND_LISTMATCH_RHS option.
11687
11688 &*Note*&: Host lists are &'not'& supported in this way. This is because
11689 hosts have two identities: a name and an IP address, and it is not clear
11690 how to specify cleanly how such a test would work. However, IP addresses can be
11691 matched using &%match_ip%&.
11692
11693 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11694 .cindex "PAM authentication"
11695 .cindex "AUTH" "with PAM"
11696 .cindex "Solaris" "PAM support"
11697 .cindex "expansion" "PAM authentication test"
11698 .cindex "&%pam%& expansion condition"
11699 &'Pluggable Authentication Modules'&
11700 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11701 available in the latest releases of Solaris and in some GNU/Linux
11702 distributions. The Exim support, which is intended for use in conjunction with
11703 the SMTP AUTH command, is available only if Exim is compiled with
11704 .code
11705 SUPPORT_PAM=yes
11706 .endd
11707 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11708 in some releases of GNU/Linux &%-ldl%& is also needed.
11709
11710 The argument string is first expanded, and the result must be a
11711 colon-separated list of strings. Leading and trailing white space is ignored.
11712 The PAM module is initialized with the service name &"exim"& and the user name
11713 taken from the first item in the colon-separated data string (<&'string1'&>).
11714 The remaining items in the data string are passed over in response to requests
11715 from the authentication function. In the simple case there will only be one
11716 request, for a password, so the data consists of just two strings.
11717
11718 There can be problems if any of the strings are permitted to contain colon
11719 characters. In the usual way, these have to be doubled to avoid being taken as
11720 separators. If the data is being inserted from a variable, the &%sg%& expansion
11721 item can be used to double any existing colons. For example, the configuration
11722 of a LOGIN authenticator might contain this setting:
11723 .code
11724 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11725 .endd
11726 For a PLAIN authenticator you could use:
11727 .code
11728 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11729 .endd
11730 In some operating systems, PAM authentication can be done only from a process
11731 running as root. Since Exim is running as the Exim user when receiving
11732 messages, this means that PAM cannot be used directly in those systems.
11733 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11734
11735
11736 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11737 .cindex "&'pwcheck'& daemon"
11738 .cindex "Cyrus"
11739 .cindex "expansion" "&'pwcheck'& authentication test"
11740 .cindex "&%pwcheck%& expansion condition"
11741 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11742 This is one way of making it possible for passwords to be checked by a process
11743 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11744 deprecated. Its replacement is &'saslauthd'& (see below).
11745
11746 The pwcheck support is not included in Exim by default. You need to specify
11747 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11748 building Exim. For example:
11749 .code
11750 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11751 .endd
11752 You do not need to install the full Cyrus software suite in order to use
11753 the pwcheck daemon. You can compile and install just the daemon alone
11754 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11755 access to the &_/var/pwcheck_& directory.
11756
11757 The &%pwcheck%& condition takes one argument, which must be the user name and
11758 password, separated by a colon. For example, in a LOGIN authenticator
11759 configuration, you might have this:
11760 .code
11761 server_condition = ${if pwcheck{$auth1:$auth2}}
11762 .endd
11763 Again, for a PLAIN authenticator configuration, this would be:
11764 .code
11765 server_condition = ${if pwcheck{$auth2:$auth3}}
11766 .endd
11767 .vitem &*queue_running*&
11768 .cindex "queue runner" "detecting when delivering from"
11769 .cindex "expansion" "queue runner test"
11770 .cindex "&%queue_running%& expansion condition"
11771 This condition, which has no data, is true during delivery attempts that are
11772 initiated by queue runner processes, and false otherwise.
11773
11774
11775 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11776 .cindex "Radius"
11777 .cindex "expansion" "Radius authentication"
11778 .cindex "&%radius%& expansion condition"
11779 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11780 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11781 the Radius client configuration file in order to build Exim with Radius
11782 support.
11783
11784 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11785 library, using the original API. If you are using release 0.4.0 or later of
11786 this library, you need to set
11787 .code
11788 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11789 .endd
11790 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11791 &%libradius%& library that comes with FreeBSD. To do this, set
11792 .code
11793 RADIUS_LIB_TYPE=RADLIB
11794 .endd
11795 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11796 You may also have to supply a suitable setting in EXTRALIBS so that the
11797 Radius library can be found when Exim is linked.
11798
11799 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11800 Radius client library, which calls the Radius server. The condition is true if
11801 the authentication is successful. For example:
11802 .code
11803 server_condition = ${if radius{<arguments>}}
11804 .endd
11805
11806
11807 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11808         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11809 .cindex "&'saslauthd'& daemon"
11810 .cindex "Cyrus"
11811 .cindex "expansion" "&'saslauthd'& authentication test"
11812 .cindex "&%saslauthd%& expansion condition"
11813 This condition supports user authentication using the Cyrus &'saslauthd'&
11814 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11815 Using this daemon is one way of making it possible for passwords to be checked
11816 by a process that is not running as root.
11817
11818 The saslauthd support is not included in Exim by default. You need to specify
11819 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11820 building Exim. For example:
11821 .code
11822 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11823 .endd
11824 You do not need to install the full Cyrus software suite in order to use
11825 the saslauthd daemon. You can compile and install just the daemon alone
11826 from the Cyrus SASL library.
11827
11828 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11829 two are mandatory. For example:
11830 .code
11831 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11832 .endd
11833 The service and the realm are optional (which is why the arguments are enclosed
11834 in their own set of braces). For details of the meaning of the service and
11835 realm, and how to run the daemon, consult the Cyrus documentation.
11836 .endlist vlist
11837
11838
11839
11840 .section "Combining expansion conditions" "SECID84"
11841 .cindex "expansion" "combining conditions"
11842 Several conditions can be tested at once by combining them using the &%and%&
11843 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11844 conditions on their own, and precede their lists of sub-conditions. Each
11845 sub-condition must be enclosed in braces within the overall braces that contain
11846 the list. No repetition of &%if%& is used.
11847
11848
11849 .vlist
11850 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11851 .cindex "&""or""& expansion condition"
11852 .cindex "expansion" "&""or""& of conditions"
11853 The sub-conditions are evaluated from left to right. The condition is true if
11854 any one of the sub-conditions is true.
11855 For example,
11856 .code
11857 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11858 .endd
11859 When a true sub-condition is found, the following ones are parsed but not
11860 evaluated. If there are several &"match"& sub-conditions the values of the
11861 numeric variables afterwards are taken from the first one that succeeds.
11862
11863 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11864 .cindex "&""and""& expansion condition"
11865 .cindex "expansion" "&""and""& of conditions"
11866 The sub-conditions are evaluated from left to right. The condition is true if
11867 all of the sub-conditions are true. If there are several &"match"&
11868 sub-conditions, the values of the numeric variables afterwards are taken from
11869 the last one. When a false sub-condition is found, the following ones are
11870 parsed but not evaluated.
11871 .endlist
11872 .ecindex IIDexpcond
11873
11874
11875
11876
11877 .section "Expansion variables" "SECTexpvar"
11878 .cindex "expansion" "variables, list of"
11879 This section contains an alphabetical list of all the expansion variables. Some
11880 of them are available only when Exim is compiled with specific options such as
11881 support for TLS or the content scanning extension.
11882
11883 .vlist
11884 .vitem "&$0$&, &$1$&, etc"
11885 .cindex "numerical variables (&$1$& &$2$& etc)"
11886 When a &%match%& expansion condition succeeds, these variables contain the
11887 captured substrings identified by the regular expression during subsequent
11888 processing of the success string of the containing &%if%& expansion item.
11889 In the expansion condition case
11890 they do not retain their values afterwards; in fact, their previous
11891 values are restored at the end of processing an &%if%& item. The numerical
11892 variables may also be set externally by some other matching process which
11893 precedes the expansion of the string. For example, the commands available in
11894 Exim filter files include an &%if%& command with its own regular expression
11895 matching condition.
11896
11897 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11898 Within an acl condition, expansion condition or expansion item
11899 any arguments are copied to these variables,
11900 any unused variables being made empty.
11901
11902 .vitem "&$acl_c...$&"
11903 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11904 can be given any name that starts with &$acl_c$& and is at least six characters
11905 long, but the sixth character must be either a digit or an underscore. For
11906 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11907 variables persist throughout the lifetime of an SMTP connection. They can be
11908 used to pass information between ACLs and between different invocations of the
11909 same ACL. When a message is received, the values of these variables are saved
11910 with the message, and can be accessed by filters, routers, and transports
11911 during subsequent delivery.
11912
11913 .vitem "&$acl_m...$&"
11914 These variables are like the &$acl_c...$& variables, except that their values
11915 are reset after a message has been received. Thus, if several messages are
11916 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11917 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11918 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11919 message is received, the values of these variables are saved with the message,
11920 and can be accessed by filters, routers, and transports during subsequent
11921 delivery.
11922
11923 .vitem &$acl_narg$&
11924 Within an acl condition, expansion condition or expansion item
11925 this variable has the number of arguments.
11926
11927 .vitem &$acl_verify_message$&
11928 .vindex "&$acl_verify_message$&"
11929 After an address verification has failed, this variable contains the failure
11930 message. It retains its value for use in subsequent modifiers. The message can
11931 be preserved by coding like this:
11932 .code
11933 warn !verify = sender
11934      set acl_m0 = $acl_verify_message
11935 .endd
11936 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11937 &%log_message%& modifiers, to include information about the verification
11938 failure.
11939
11940 .vitem &$address_data$&
11941 .vindex "&$address_data$&"
11942 This variable is set by means of the &%address_data%& option in routers. The
11943 value then remains with the address while it is processed by subsequent routers
11944 and eventually a transport. If the transport is handling multiple addresses,
11945 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11946 for more details. &*Note*&: The contents of &$address_data$& are visible in
11947 user filter files.
11948
11949 If &$address_data$& is set when the routers are called from an ACL to verify
11950 a recipient address, the final value is still in the variable for subsequent
11951 conditions and modifiers of the ACL statement. If routing the address caused it
11952 to be redirected to just one address, the child address is also routed as part
11953 of the verification, and in this case the final value of &$address_data$& is
11954 from the child's routing.
11955
11956 If &$address_data$& is set when the routers are called from an ACL to verify a
11957 sender address, the final value is also preserved, but this time in
11958 &$sender_address_data$&, to distinguish it from data from a recipient
11959 address.
11960
11961 In both cases (recipient and sender verification), the value does not persist
11962 after the end of the current ACL statement. If you want to preserve
11963 these values for longer, you can save them in ACL variables.
11964
11965 .vitem &$address_file$&
11966 .vindex "&$address_file$&"
11967 When, as a result of aliasing, forwarding, or filtering, a message is directed
11968 to a specific file, this variable holds the name of the file when the transport
11969 is running. At other times, the variable is empty. For example, using the
11970 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11971 .code
11972 /home/r2d2/savemail
11973 .endd
11974 then when the &(address_file)& transport is running, &$address_file$&
11975 contains the text string &`/home/r2d2/savemail`&.
11976 .cindex "Sieve filter" "value of &$address_file$&"
11977 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11978 then up to the transport configuration to generate an appropriate absolute path
11979 to the relevant file.
11980
11981 .vitem &$address_pipe$&
11982 .vindex "&$address_pipe$&"
11983 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11984 this variable holds the pipe command when the transport is running.
11985
11986 .vitem "&$auth1$& &-- &$auth3$&"
11987 .vindex "&$auth1$&, &$auth2$&, etc"
11988 These variables are used in SMTP authenticators (see chapters
11989 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11990
11991 .vitem &$authenticated_id$&
11992 .cindex "authentication" "id"
11993 .vindex "&$authenticated_id$&"
11994 When a server successfully authenticates a client it may be configured to
11995 preserve some of the authentication information in the variable
11996 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11997 user/password authenticator configuration might preserve the user name for use
11998 in the routers. Note that this is not the same information that is saved in
11999 &$sender_host_authenticated$&.
12000
12001 When a message is submitted locally (that is, not over a TCP connection)
12002 the value of &$authenticated_id$& is normally the login name of the calling
12003 process. However, a trusted user can override this by means of the &%-oMai%&
12004 command line option.
12005 This second case also sets up information used by the
12006 &$authresults$& expansion item.
12007
12008 .vitem &$authenticated_fail_id$&
12009 .cindex "authentication" "fail" "id"
12010 .vindex "&$authenticated_fail_id$&"
12011 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12012 will contain the failed authentication id. If more than one authentication
12013 id is attempted, it will contain only the last one. The variable is
12014 available for processing in the ACL's, generally the quit or notquit ACL.
12015 A message to a local recipient could still be accepted without requiring
12016 authentication, which means this variable could also be visible in all of
12017 the ACL's as well.
12018
12019
12020 .vitem &$authenticated_sender$&
12021 .cindex "sender" "authenticated"
12022 .cindex "authentication" "sender"
12023 .cindex "AUTH" "on MAIL command"
12024 .vindex "&$authenticated_sender$&"
12025 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12026 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12027 described in section &<<SECTauthparamail>>&. Unless the data is the string
12028 &"<>"&, it is set as the authenticated sender of the message, and the value is
12029 available during delivery in the &$authenticated_sender$& variable. If the
12030 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12031
12032 .vindex "&$qualify_domain$&"
12033 When a message is submitted locally (that is, not over a TCP connection), the
12034 value of &$authenticated_sender$& is an address constructed from the login
12035 name of the calling process and &$qualify_domain$&, except that a trusted user
12036 can override this by means of the &%-oMas%& command line option.
12037
12038
12039 .vitem &$authentication_failed$&
12040 .cindex "authentication" "failure"
12041 .vindex "&$authentication_failed$&"
12042 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12043 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12044 possible to distinguish between &"did not try to authenticate"&
12045 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12046 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12047 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12048 negative response to an AUTH command, including (for example) an attempt to use
12049 an undefined mechanism.
12050
12051 .vitem &$av_failed$&
12052 .cindex "content scanning" "AV scanner failure"
12053 This variable is available when Exim is compiled with the content-scanning
12054 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12055 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12056 the ACL malware condition.
12057
12058 .vitem &$body_linecount$&
12059 .cindex "message body" "line count"
12060 .cindex "body of message" "line count"
12061 .vindex "&$body_linecount$&"
12062 When a message is being received or delivered, this variable contains the
12063 number of lines in the message's body. See also &$message_linecount$&.
12064
12065 .vitem &$body_zerocount$&
12066 .cindex "message body" "binary zero count"
12067 .cindex "body of message" "binary zero count"
12068 .cindex "binary zero" "in message body"
12069 .vindex "&$body_zerocount$&"
12070 When a message is being received or delivered, this variable contains the
12071 number of binary zero bytes (ASCII NULs) in the message's body.
12072
12073 .vitem &$bounce_recipient$&
12074 .vindex "&$bounce_recipient$&"
12075 This is set to the recipient address of a bounce message while Exim is creating
12076 it. It is useful if a customized bounce message text file is in use (see
12077 chapter &<<CHAPemsgcust>>&).
12078
12079 .vitem &$bounce_return_size_limit$&
12080 .vindex "&$bounce_return_size_limit$&"
12081 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12082 up to a multiple of 1000. It is useful when a customized error message text
12083 file is in use (see chapter &<<CHAPemsgcust>>&).
12084
12085 .vitem &$caller_gid$&
12086 .cindex "gid (group id)" "caller"
12087 .vindex "&$caller_gid$&"
12088 The real group id under which the process that called Exim was running. This is
12089 not the same as the group id of the originator of a message (see
12090 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12091 incarnation normally contains the Exim gid.
12092
12093 .vitem &$caller_uid$&
12094 .cindex "uid (user id)" "caller"
12095 .vindex "&$caller_uid$&"
12096 The real user id under which the process that called Exim was running. This is
12097 not the same as the user id of the originator of a message (see
12098 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12099 incarnation normally contains the Exim uid.
12100
12101 .vitem &$callout_address$&
12102 .vindex "&$callout_address$&"
12103 After a callout for verification, spamd or malware daemon service, the
12104 address that was connected to.
12105
12106 .vitem &$compile_number$&
12107 .vindex "&$compile_number$&"
12108 The building process for Exim keeps a count of the number
12109 of times it has been compiled. This serves to distinguish different
12110 compilations of the same version of Exim.
12111
12112 .vitem &$config_dir$&
12113 .vindex "&$config_dir$&"
12114 The directory name of the main configuration file. That is, the content of
12115 &$config_file$& with the last component stripped. The value does not
12116 contain the trailing slash. If &$config_file$& does not contain a slash,
12117 &$config_dir$& is ".".
12118
12119 .vitem &$config_file$&
12120 .vindex "&$config_file$&"
12121 The name of the main configuration file Exim is using.
12122
12123 .vitem &$dmarc_domain_policy$& &&&
12124        &$dmarc_status$& &&&
12125        &$dmarc_status_text$& &&&
12126        &$dmarc_used_domains$&
12127 Results of DMARC verification.
12128 For details see section &<<SECDMARC>>&.
12129
12130 .vitem &$dkim_verify_status$&
12131 Results of DKIM verification.
12132 For details see section &<<SECDKIMVFY>>&.
12133
12134 .vitem &$dkim_cur_signer$& &&&
12135        &$dkim_verify_reason$& &&&
12136        &$dkim_domain$& &&&
12137        &$dkim_identity$& &&&
12138        &$dkim_selector$& &&&
12139        &$dkim_algo$& &&&
12140        &$dkim_canon_body$& &&&
12141        &$dkim_canon_headers$& &&&
12142        &$dkim_copiedheaders$& &&&
12143        &$dkim_bodylength$& &&&
12144        &$dkim_created$& &&&
12145        &$dkim_expires$& &&&
12146        &$dkim_headernames$& &&&
12147        &$dkim_key_testing$& &&&
12148        &$dkim_key_nosubdomains$& &&&
12149        &$dkim_key_srvtype$& &&&
12150        &$dkim_key_granularity$& &&&
12151        &$dkim_key_notes$& &&&
12152        &$dkim_key_length$&
12153 These variables are only available within the DKIM ACL.
12154 For details see section &<<SECDKIMVFY>>&.
12155
12156 .vitem &$dkim_signers$&
12157 .vindex &$dkim_signers$&
12158 When a message has been received this variable contains
12159 a colon-separated list of signer domains and identities for the message.
12160 For details see section &<<SECDKIMVFY>>&.
12161
12162 .vitem &$dnslist_domain$& &&&
12163        &$dnslist_matched$& &&&
12164        &$dnslist_text$& &&&
12165        &$dnslist_value$&
12166 .vindex "&$dnslist_domain$&"
12167 .vindex "&$dnslist_matched$&"
12168 .vindex "&$dnslist_text$&"
12169 .vindex "&$dnslist_value$&"
12170 .cindex "black list (DNS)"
12171 When a DNS (black) list lookup succeeds, these variables are set to contain
12172 the following data from the lookup: the list's domain name, the key that was
12173 looked up, the contents of any associated TXT record, and the value from the
12174 main A record. See section &<<SECID204>>& for more details.
12175
12176 .vitem &$domain$&
12177 .vindex "&$domain$&"
12178 When an address is being routed, or delivered on its own, this variable
12179 contains the domain. Uppercase letters in the domain are converted into lower
12180 case for &$domain$&.
12181
12182 Global address rewriting happens when a message is received, so the value of
12183 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12184 is set during user filtering, but not during system filtering, because a
12185 message may have many recipients and the system filter is called just once.
12186
12187 When more than one address is being delivered at once (for example, several
12188 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12189 have the same domain. Transports can be restricted to handling only one domain
12190 at a time if the value of &$domain$& is required at transport time &-- this is
12191 the default for local transports. For further details of the environment in
12192 which local transports are run, see chapter &<<CHAPenvironment>>&.
12193
12194 .oindex "&%delay_warning_condition%&"
12195 At the end of a delivery, if all deferred addresses have the same domain, it is
12196 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12197
12198 The &$domain$& variable is also used in some other circumstances:
12199
12200 .ilist
12201 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12202 the recipient address. The domain of the &'sender'& address is in
12203 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12204 normally set during the running of the MAIL ACL. However, if the sender address
12205 is verified with a callout during the MAIL ACL, the sender domain is placed in
12206 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12207 the &(smtp)& transport.
12208
12209 .next
12210 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12211 &$domain$& contains the domain portion of the address that is being rewritten;
12212 it can be used in the expansion of the replacement address, for example, to
12213 rewrite domains by file lookup.
12214
12215 .next
12216 With one important exception, whenever a domain list is being scanned,
12217 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12218 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12219 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12220 that, in a RCPT ACL, the sender domain list can be dependent on the
12221 recipient domain (which is what is in &$domain$& at this time).
12222
12223 .next
12224 .cindex "ETRN" "value of &$domain$&"
12225 .oindex "&%smtp_etrn_command%&"
12226 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12227 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12228 .endlist
12229
12230 .new
12231 .cindex "tainted data"
12232 If the origin of the data is an incoming message,
12233 the result of expanding this variable is tainted.
12234 See also &$domain_verified$&.
12235 .wen
12236
12237
12238 .vitem &$domain_data$&
12239 .vindex "&$domain_data$&"
12240 When the &%domains%& option on a router matches a domain by
12241 means of a lookup, the data read by the lookup is available during the running
12242 of the router as &$domain_data$&. In addition, if the driver routes the
12243 address to a transport, the value is available in that transport. If the
12244 transport is handling multiple addresses, the value from the first address is
12245 used.
12246
12247 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12248 domain by means of a lookup. The data read by the lookup is available during
12249 the rest of the ACL statement. In all other situations, this variable expands
12250 to nothing.
12251
12252 .vitem &$exim_gid$&
12253 .vindex "&$exim_gid$&"
12254 This variable contains the numerical value of the Exim group id.
12255
12256 .vitem &$exim_path$&
12257 .vindex "&$exim_path$&"
12258 This variable contains the path to the Exim binary.
12259
12260 .vitem &$exim_uid$&
12261 .vindex "&$exim_uid$&"
12262 This variable contains the numerical value of the Exim user id.
12263
12264 .vitem &$exim_version$&
12265 .vindex "&$exim_version$&"
12266 This variable contains the version string of the Exim build.
12267 The first character is a major version number, currently 4.
12268 Then after a dot, the next group of digits is a minor version number.
12269 There may be other characters following the minor version.
12270 This value may be overridden by the &%exim_version%& main config option.
12271
12272 .vitem &$header_$&<&'name'&>
12273 This is not strictly an expansion variable. It is expansion syntax for
12274 inserting the message header line with the given name. Note that the name must
12275 be terminated by colon or white space, because it may contain a wide variety of
12276 characters. Note also that braces must &'not'& be used.
12277 See the full description in section &<<SECTexpansionitems>>& above.
12278
12279 .vitem &$headers_added$&
12280 .vindex "&$headers_added$&"
12281 Within an ACL this variable contains the headers added so far by
12282 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12283 The headers are a newline-separated list.
12284
12285 .vitem &$home$&
12286 .vindex "&$home$&"
12287 When the &%check_local_user%& option is set for a router, the user's home
12288 directory is placed in &$home$& when the check succeeds. In particular, this
12289 means it is set during the running of users' filter files. A router may also
12290 explicitly set a home directory for use by a transport; this can be overridden
12291 by a setting on the transport itself.
12292
12293 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12294 of the environment variable HOME, which is subject to the
12295 &%keep_environment%& and &%add_environment%& main config options.
12296
12297 .vitem &$host$&
12298 .vindex "&$host$&"
12299 If a router assigns an address to a transport (any transport), and passes a
12300 list of hosts with the address, the value of &$host$& when the transport starts
12301 to run is the name of the first host on the list. Note that this applies both
12302 to local and remote transports.
12303
12304 .cindex "transport" "filter"
12305 .cindex "filter" "transport filter"
12306 For the &(smtp)& transport, if there is more than one host, the value of
12307 &$host$& changes as the transport works its way through the list. In
12308 particular, when the &(smtp)& transport is expanding its options for encryption
12309 using TLS, or for specifying a transport filter (see chapter
12310 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12311 is connected.
12312
12313 When used in the client part of an authenticator configuration (see chapter
12314 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12315 client is connected.
12316
12317
12318 .vitem &$host_address$&
12319 .vindex "&$host_address$&"
12320 This variable is set to the remote host's IP address whenever &$host$& is set
12321 for a remote connection. It is also set to the IP address that is being checked
12322 when the &%ignore_target_hosts%& option is being processed.
12323
12324 .vitem &$host_data$&
12325 .vindex "&$host_data$&"
12326 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12327 result of the lookup is made available in the &$host_data$& variable. This
12328 allows you, for example, to do things like this:
12329 .code
12330 deny  hosts = net-lsearch;/some/file
12331 message = $host_data
12332 .endd
12333 .vitem &$host_lookup_deferred$&
12334 .cindex "host name" "lookup, failure of"
12335 .vindex "&$host_lookup_deferred$&"
12336 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12337 message comes from a remote host and there is an attempt to look up the host's
12338 name from its IP address, and the attempt is not successful, one of these
12339 variables is set to &"1"&.
12340
12341 .ilist
12342 If the lookup receives a definite negative response (for example, a DNS lookup
12343 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12344
12345 .next
12346 If there is any kind of problem during the lookup, such that Exim cannot
12347 tell whether or not the host name is defined (for example, a timeout for a DNS
12348 lookup), &$host_lookup_deferred$& is set to &"1"&.
12349 .endlist ilist
12350
12351 Looking up a host's name from its IP address consists of more than just a
12352 single reverse lookup. Exim checks that a forward lookup of at least one of the
12353 names it receives from a reverse lookup yields the original IP address. If this
12354 is not the case, Exim does not accept the looked up name(s), and
12355 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12356 IP address (for example, the existence of a PTR record in the DNS) is not
12357 sufficient on its own for the success of a host name lookup. If the reverse
12358 lookup succeeds, but there is a lookup problem such as a timeout when checking
12359 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12360 &"1"&. See also &$sender_host_name$&.
12361
12362 .cindex authentication "expansion item"
12363 Performing these checks sets up information used by the
12364 &%authresults%& expansion item.
12365
12366
12367 .vitem &$host_lookup_failed$&
12368 .vindex "&$host_lookup_failed$&"
12369 See &$host_lookup_deferred$&.
12370
12371 .vitem &$host_port$&
12372 .vindex "&$host_port$&"
12373 This variable is set to the remote host's TCP port whenever &$host$& is set
12374 for an outbound connection.
12375
12376 .vitem &$initial_cwd$&
12377 .vindex "&$initial_cwd$&
12378 This variable contains the full path name of the initial working
12379 directory of the current Exim process. This may differ from the current
12380 working directory, as Exim changes this to "/" during early startup, and
12381 to &$spool_directory$& later.
12382
12383 .vitem &$inode$&
12384 .vindex "&$inode$&"
12385 The only time this variable is set is while expanding the &%directory_file%&
12386 option in the &(appendfile)& transport. The variable contains the inode number
12387 of the temporary file which is about to be renamed. It can be used to construct
12388 a unique name for the file.
12389
12390 .vitem &$interface_address$&
12391 .vindex "&$interface_address$&"
12392 This is an obsolete name for &$received_ip_address$&.
12393
12394 .vitem &$interface_port$&
12395 .vindex "&$interface_port$&"
12396 This is an obsolete name for &$received_port$&.
12397
12398 .vitem &$item$&
12399 .vindex "&$item$&"
12400 This variable is used during the expansion of &*forall*& and &*forany*&
12401 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12402 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12403 empty.
12404
12405 .vitem &$ldap_dn$&
12406 .vindex "&$ldap_dn$&"
12407 This variable, which is available only when Exim is compiled with LDAP support,
12408 contains the DN from the last entry in the most recently successful LDAP
12409 lookup.
12410
12411 .vitem &$load_average$&
12412 .vindex "&$load_average$&"
12413 This variable contains the system load average, multiplied by 1000 so that it
12414 is an integer. For example, if the load average is 0.21, the value of the
12415 variable is 210. The value is recomputed every time the variable is referenced.
12416
12417 .vitem &$local_part$&
12418 .vindex "&$local_part$&"
12419 When an address is being routed, or delivered on its own, this
12420 variable contains the local part. When a number of addresses are being
12421 delivered together (for example, multiple RCPT commands in an SMTP
12422 session), &$local_part$& is not set.
12423
12424 Global address rewriting happens when a message is received, so the value of
12425 &$local_part$& during routing and delivery is the value after rewriting.
12426 &$local_part$& is set during user filtering, but not during system filtering,
12427 because a message may have many recipients and the system filter is called just
12428 once.
12429
12430 .new
12431 .cindex "tainted data"
12432 If the origin of the data is an incoming message,
12433 the result of expanding this variable is tainted.
12434
12435 &*Warning*&: the content of this variable is usually provided by a potential
12436 attacker.
12437 Consider carefully the implications of using it unvalidated as a name
12438 for file access.
12439 This presents issues for users' &_.forward_& and filter files.
12440 For traditional full user accounts, use &%check_local_users%& and the
12441 &$local_part_verified$& variable rather than this one.
12442 For virtual users, store a suitable pathname component in the database
12443 which is used for account name validation, and use that retrieved value
12444 rather than this variable.
12445 If needed, use a router &%address_data%& or &%set%& option for
12446 the retrieved data.
12447 .wen
12448
12449 .vindex "&$local_part_prefix$&"
12450 .vindex "&$local_part_suffix$&"
12451 .cindex affix variables
12452 If a local part prefix or suffix has been recognized, it is not included in the
12453 value of &$local_part$& during routing and subsequent delivery. The values of
12454 any prefix or suffix are in &$local_part_prefix$& and
12455 &$local_part_suffix$&, respectively.
12456
12457 When a message is being delivered to a file, pipe, or autoreply transport as a
12458 result of aliasing or forwarding, &$local_part$& is set to the local part of
12459 the parent address, not to the filename or command (see &$address_file$& and
12460 &$address_pipe$&).
12461
12462 When an ACL is running for a RCPT command, &$local_part$& contains the
12463 local part of the recipient address.
12464
12465 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12466 &$local_part$& contains the local part of the address that is being rewritten;
12467 it can be used in the expansion of the replacement address, for example.
12468
12469 In all cases, all quoting is removed from the local part. For example, for both
12470 the addresses
12471 .code
12472 "abc:xyz"@test.example
12473 abc\:xyz@test.example
12474 .endd
12475 the value of &$local_part$& is
12476 .code
12477 abc:xyz
12478 .endd
12479 If you use &$local_part$& to create another address, you should always wrap it
12480 inside a quoting operator. For example, in a &(redirect)& router you could
12481 have:
12482 .code
12483 data = ${quote_local_part:$local_part}@new.domain.example
12484 .endd
12485 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12486 to process local parts in a case-dependent manner in a router, you can set the
12487 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12488
12489 .vitem &$local_part_data$&
12490 .vindex "&$local_part_data$&"
12491 When the &%local_parts%& option on a router matches a local part by means of a
12492 lookup, the data read by the lookup is available during the running of the
12493 router as &$local_part_data$&. In addition, if the driver routes the address
12494 to a transport, the value is available in that transport. If the transport is
12495 handling multiple addresses, the value from the first address is used.
12496
12497 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12498 matches a local part by means of a lookup. The data read by the lookup is
12499 available during the rest of the ACL statement. In all other situations, this
12500 variable expands to nothing.
12501
12502 .vitem &$local_part_prefix$&
12503 .vindex "&$local_part_prefix$&"
12504 .cindex affix variables
12505 When an address is being routed or delivered, and a
12506 specific prefix for the local part was recognized, it is available in this
12507 variable, having been removed from &$local_part$&.
12508
12509 .vitem &$local_part_suffix$&
12510 .vindex "&$local_part_suffix$&"
12511 When an address is being routed or delivered, and a
12512 specific suffix for the local part was recognized, it is available in this
12513 variable, having been removed from &$local_part$&.
12514
12515 .new
12516 .vitem &$local_part_verified$&
12517 .vindex "&$local_part_verified$&"
12518 If the router generic option &%check_local_part%& has run successfully,
12519 this variable has the user database version of &$local_part$&.
12520 Such values are not tainted and hence usable for building file names.
12521 .wen
12522
12523 .vitem &$local_scan_data$&
12524 .vindex "&$local_scan_data$&"
12525 This variable contains the text returned by the &[local_scan()]& function when
12526 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12527
12528 .vitem &$local_user_gid$&
12529 .vindex "&$local_user_gid$&"
12530 See &$local_user_uid$&.
12531
12532 .vitem &$local_user_uid$&
12533 .vindex "&$local_user_uid$&"
12534 This variable and &$local_user_gid$& are set to the uid and gid after the
12535 &%check_local_user%& router precondition succeeds. This means that their values
12536 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12537 and &%condition%&), for the &%address_data%& expansion, and for any
12538 router-specific expansions. At all other times, the values in these variables
12539 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12540
12541 .vitem &$localhost_number$&
12542 .vindex "&$localhost_number$&"
12543 This contains the expanded value of the
12544 &%localhost_number%& option. The expansion happens after the main options have
12545 been read.
12546
12547 .vitem &$log_inodes$&
12548 .vindex "&$log_inodes$&"
12549 The number of free inodes in the disk partition where Exim's
12550 log files are being written. The value is recalculated whenever the variable is
12551 referenced. If the relevant file system does not have the concept of inodes,
12552 the value of is -1. See also the &%check_log_inodes%& option.
12553
12554 .vitem &$log_space$&
12555 .vindex "&$log_space$&"
12556 The amount of free space (as a number of kilobytes) in the disk
12557 partition where Exim's log files are being written. The value is recalculated
12558 whenever the variable is referenced. If the operating system does not have the
12559 ability to find the amount of free space (only true for experimental systems),
12560 the space value is -1. See also the &%check_log_space%& option.
12561
12562
12563 .vitem &$lookup_dnssec_authenticated$&
12564 .vindex "&$lookup_dnssec_authenticated$&"
12565 This variable is set after a DNS lookup done by
12566 a dnsdb lookup expansion, dnslookup router or smtp transport.
12567 .cindex "DNS" "DNSSEC"
12568 It will be empty if &(DNSSEC)& was not requested,
12569 &"no"& if the result was not labelled as authenticated data
12570 and &"yes"& if it was.
12571 Results that are labelled as authoritative answer that match
12572 the &%dns_trust_aa%& configuration variable count also
12573 as authenticated data.
12574
12575 .vitem &$mailstore_basename$&
12576 .vindex "&$mailstore_basename$&"
12577 This variable is set only when doing deliveries in &"mailstore"& format in the
12578 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12579 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12580 contains the basename of the files that are being written, that is, the name
12581 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12582 variable is empty.
12583
12584 .vitem &$malware_name$&
12585 .vindex "&$malware_name$&"
12586 This variable is available when Exim is compiled with the
12587 content-scanning extension. It is set to the name of the virus that was found
12588 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12589
12590 .vitem &$max_received_linelength$&
12591 .vindex "&$max_received_linelength$&"
12592 .cindex "maximum" "line length"
12593 .cindex "line length" "maximum"
12594 This variable contains the number of bytes in the longest line that was
12595 received as part of the message, not counting the line termination
12596 character(s).
12597 It is not valid if the &%spool_files_wireformat%& option is used.
12598
12599 .vitem &$message_age$&
12600 .cindex "message" "age of"
12601 .vindex "&$message_age$&"
12602 This variable is set at the start of a delivery attempt to contain the number
12603 of seconds since the message was received. It does not change during a single
12604 delivery attempt.
12605
12606 .vitem &$message_body$&
12607 .cindex "body of message" "expansion variable"
12608 .cindex "message body" "in expansion"
12609 .cindex "binary zero" "in message body"
12610 .vindex "&$message_body$&"
12611 .oindex "&%message_body_visible%&"
12612 This variable contains the initial portion of a message's body while it is
12613 being delivered, and is intended mainly for use in filter files. The maximum
12614 number of characters of the body that are put into the variable is set by the
12615 &%message_body_visible%& configuration option; the default is 500.
12616
12617 .oindex "&%message_body_newlines%&"
12618 By default, newlines are converted into spaces in &$message_body$&, to make it
12619 easier to search for phrases that might be split over a line break. However,
12620 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12621 zeros are always converted into spaces.
12622
12623 .vitem &$message_body_end$&
12624 .cindex "body of message" "expansion variable"
12625 .cindex "message body" "in expansion"
12626 .vindex "&$message_body_end$&"
12627 This variable contains the final portion of a message's
12628 body while it is being delivered. The format and maximum size are as for
12629 &$message_body$&.
12630
12631 .vitem &$message_body_size$&
12632 .cindex "body of message" "size"
12633 .cindex "message body" "size"
12634 .vindex "&$message_body_size$&"
12635 When a message is being delivered, this variable contains the size of the body
12636 in bytes. The count starts from the character after the blank line that
12637 separates the body from the header. Newlines are included in the count. See
12638 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12639
12640 If the spool file is wireformat
12641 (see the &%spool_files_wireformat%& main option)
12642 the CRLF line-terminators are included in the count.
12643
12644 .vitem &$message_exim_id$&
12645 .vindex "&$message_exim_id$&"
12646 When a message is being received or delivered, this variable contains the
12647 unique message id that is generated and used by Exim to identify the message.
12648 An id is not created for a message until after its header has been successfully
12649 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12650 line; it is the local id that Exim assigns to the message, for example:
12651 &`1BXTIK-0001yO-VA`&.
12652
12653 .vitem &$message_headers$&
12654 .vindex &$message_headers$&
12655 This variable contains a concatenation of all the header lines when a message
12656 is being processed, except for lines added by routers or transports. The header
12657 lines are separated by newline characters. Their contents are decoded in the
12658 same way as a header line that is inserted by &%bheader%&.
12659
12660 .vitem &$message_headers_raw$&
12661 .vindex &$message_headers_raw$&
12662 This variable is like &$message_headers$& except that no processing of the
12663 contents of header lines is done.
12664
12665 .vitem &$message_id$&
12666 This is an old name for &$message_exim_id$&. It is now deprecated.
12667
12668 .vitem &$message_linecount$&
12669 .vindex "&$message_linecount$&"
12670 This variable contains the total number of lines in the header and body of the
12671 message. Compare &$body_linecount$&, which is the count for the body only.
12672 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12673 number of lines received. Before delivery happens (that is, before filters,
12674 routers, and transports run) the count is increased to include the
12675 &'Received:'& header line that Exim standardly adds, and also any other header
12676 lines that are added by ACLs. The blank line that separates the message header
12677 from the body is not counted.
12678
12679 As with the special case of &$message_size$&, during the expansion of the
12680 appendfile transport's maildir_tag option in maildir format, the value of
12681 &$message_linecount$& is the precise size of the number of newlines in the
12682 file that has been written (minus one for the blank line between the
12683 header and the body).
12684
12685 Here is an example of the use of this variable in a DATA ACL:
12686 .code
12687 deny message   = Too many lines in message header
12688      condition = \
12689       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12690 .endd
12691 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12692 message has not yet been received.
12693
12694 This variable is not valid if the &%spool_files_wireformat%& option is used.
12695
12696 .vitem &$message_size$&
12697 .cindex "size" "of message"
12698 .cindex "message" "size"
12699 .vindex "&$message_size$&"
12700 When a message is being processed, this variable contains its size in bytes. In
12701 most cases, the size includes those headers that were received with the
12702 message, but not those (such as &'Envelope-to:'&) that are added to individual
12703 deliveries as they are written. However, there is one special case: during the
12704 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12705 doing a delivery in maildir format, the value of &$message_size$& is the
12706 precise size of the file that has been written. See also
12707 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12708
12709 .cindex "RCPT" "value of &$message_size$&"
12710 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12711 contains the size supplied on the MAIL command, or -1 if no size was given. The
12712 value may not, of course, be truthful.
12713
12714 .vitem &$mime_$&&'xxx'&
12715 A number of variables whose names start with &$mime$& are
12716 available when Exim is compiled with the content-scanning extension. For
12717 details, see section &<<SECTscanmimepart>>&.
12718
12719 .vitem "&$n0$& &-- &$n9$&"
12720 These variables are counters that can be incremented by means
12721 of the &%add%& command in filter files.
12722
12723 .vitem &$original_domain$&
12724 .vindex "&$domain$&"
12725 .vindex "&$original_domain$&"
12726 When a top-level address is being processed for delivery, this contains the
12727 same value as &$domain$&. However, if a &"child"& address (for example,
12728 generated by an alias, forward, or filter file) is being processed, this
12729 variable contains the domain of the original address (lower cased). This
12730 differs from &$parent_domain$& only when there is more than one level of
12731 aliasing or forwarding. When more than one address is being delivered in a
12732 single transport run, &$original_domain$& is not set.
12733
12734 If a new address is created by means of a &%deliver%& command in a system
12735 filter, it is set up with an artificial &"parent"& address. This has the local
12736 part &'system-filter'& and the default qualify domain.
12737
12738 .vitem &$original_local_part$&
12739 .vindex "&$local_part$&"
12740 .vindex "&$original_local_part$&"
12741 When a top-level address is being processed for delivery, this contains the
12742 same value as &$local_part$&, unless a prefix or suffix was removed from the
12743 local part, because &$original_local_part$& always contains the full local
12744 part. When a &"child"& address (for example, generated by an alias, forward, or
12745 filter file) is being processed, this variable contains the full local part of
12746 the original address.
12747
12748 If the router that did the redirection processed the local part
12749 case-insensitively, the value in &$original_local_part$& is in lower case.
12750 This variable differs from &$parent_local_part$& only when there is more than
12751 one level of aliasing or forwarding. When more than one address is being
12752 delivered in a single transport run, &$original_local_part$& is not set.
12753
12754 If a new address is created by means of a &%deliver%& command in a system
12755 filter, it is set up with an artificial &"parent"& address. This has the local
12756 part &'system-filter'& and the default qualify domain.
12757
12758 .vitem &$originator_gid$&
12759 .cindex "gid (group id)" "of originating user"
12760 .cindex "sender" "gid"
12761 .vindex "&$caller_gid$&"
12762 .vindex "&$originator_gid$&"
12763 This variable contains the value of &$caller_gid$& that was set when the
12764 message was received. For messages received via the command line, this is the
12765 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12766 normally the gid of the Exim user.
12767
12768 .vitem &$originator_uid$&
12769 .cindex "uid (user id)" "of originating user"
12770 .cindex "sender" "uid"
12771 .vindex "&$caller_uid$&"
12772 .vindex "&$originator_uid$&"
12773 The value of &$caller_uid$& that was set when the message was received. For
12774 messages received via the command line, this is the uid of the sending user.
12775 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12776 user.
12777
12778 .vitem &$parent_domain$&
12779 .vindex "&$parent_domain$&"
12780 This variable is similar to &$original_domain$& (see
12781 above), except that it refers to the immediately preceding parent address.
12782
12783 .vitem &$parent_local_part$&
12784 .vindex "&$parent_local_part$&"
12785 This variable is similar to &$original_local_part$&
12786 (see above), except that it refers to the immediately preceding parent address.
12787
12788 .vitem &$pid$&
12789 .cindex "pid (process id)" "of current process"
12790 .vindex "&$pid$&"
12791 This variable contains the current process id.
12792
12793 .vitem &$pipe_addresses$&
12794 .cindex "filter" "transport filter"
12795 .cindex "transport" "filter"
12796 .vindex "&$pipe_addresses$&"
12797 This is not an expansion variable, but is mentioned here because the string
12798 &`$pipe_addresses`& is handled specially in the command specification for the
12799 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12800 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12801 It cannot be used in general expansion strings, and provokes an &"unknown
12802 variable"& error if encountered.
12803
12804 .vitem &$primary_hostname$&
12805 .vindex "&$primary_hostname$&"
12806 This variable contains the value set by &%primary_hostname%& in the
12807 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12808 a single-component name, Exim calls &[gethostbyname()]& (or
12809 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12810 qualified host name. See also &$smtp_active_hostname$&.
12811
12812
12813 .vitem &$proxy_external_address$& &&&
12814        &$proxy_external_port$& &&&
12815        &$proxy_local_address$& &&&
12816        &$proxy_local_port$& &&&
12817        &$proxy_session$&
12818 These variables are only available when built with Proxy Protocol
12819 or SOCKS5 support.
12820 For details see chapter &<<SECTproxyInbound>>&.
12821
12822 .vitem &$prdr_requested$&
12823 .cindex "PRDR" "variable for"
12824 This variable is set to &"yes"& if PRDR was requested by the client for the
12825 current message, otherwise &"no"&.
12826
12827 .vitem &$prvscheck_address$&
12828 This variable is used in conjunction with the &%prvscheck%& expansion item,
12829 which is described in sections &<<SECTexpansionitems>>& and
12830 &<<SECTverifyPRVS>>&.
12831
12832 .vitem &$prvscheck_keynum$&
12833 This variable is used in conjunction with the &%prvscheck%& expansion item,
12834 which is described in sections &<<SECTexpansionitems>>& and
12835 &<<SECTverifyPRVS>>&.
12836
12837 .vitem &$prvscheck_result$&
12838 This variable is used in conjunction with the &%prvscheck%& expansion item,
12839 which is described in sections &<<SECTexpansionitems>>& and
12840 &<<SECTverifyPRVS>>&.
12841
12842 .vitem &$qualify_domain$&
12843 .vindex "&$qualify_domain$&"
12844 The value set for the &%qualify_domain%& option in the configuration file.
12845
12846 .vitem &$qualify_recipient$&
12847 .vindex "&$qualify_recipient$&"
12848 The value set for the &%qualify_recipient%& option in the configuration file,
12849 or if not set, the value of &$qualify_domain$&.
12850
12851 .vitem &$queue_name$&
12852 .vindex &$queue_name$&
12853 .cindex "named queues" variable
12854 .cindex queues named
12855 The name of the spool queue in use; empty for the default queue.
12856
12857 .vitem &$queue_size$&
12858 .vindex "&$queue_size$&"
12859 .cindex "queue" "size of"
12860 .cindex "spool" "number of messages"
12861 This variable contains the number of messages queued.
12862 It is evaluated on demand, but no more often than once every minute.
12863
12864 .vitem &$r_...$&
12865 .vindex &$r_...$&
12866 .cindex router variables
12867 Values can be placed in these variables by the &%set%& option of a router.
12868 They can be given any name that starts with &$r_$&.
12869 The values persist for the address being handled through subsequent routers
12870 and the eventual transport.
12871
12872 .vitem &$rcpt_count$&
12873 .vindex "&$rcpt_count$&"
12874 When a message is being received by SMTP, this variable contains the number of
12875 RCPT commands received for the current message. If this variable is used in a
12876 RCPT ACL, its value includes the current command.
12877
12878 .vitem &$rcpt_defer_count$&
12879 .vindex "&$rcpt_defer_count$&"
12880 .cindex "4&'xx'& responses" "count of"
12881 When a message is being received by SMTP, this variable contains the number of
12882 RCPT commands in the current message that have previously been rejected with a
12883 temporary (4&'xx'&) response.
12884
12885 .vitem &$rcpt_fail_count$&
12886 .vindex "&$rcpt_fail_count$&"
12887 When a message is being received by SMTP, this variable contains the number of
12888 RCPT commands in the current message that have previously been rejected with a
12889 permanent (5&'xx'&) response.
12890
12891 .vitem &$received_count$&
12892 .vindex "&$received_count$&"
12893 This variable contains the number of &'Received:'& header lines in the message,
12894 including the one added by Exim (so its value is always greater than zero). It
12895 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12896 delivering.
12897
12898 .vitem &$received_for$&
12899 .vindex "&$received_for$&"
12900 If there is only a single recipient address in an incoming message, this
12901 variable contains that address when the &'Received:'& header line is being
12902 built. The value is copied after recipient rewriting has happened, but before
12903 the &[local_scan()]& function is run.
12904
12905 .vitem &$received_ip_address$&
12906 .vindex "&$received_ip_address$&"
12907 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12908 variable is set to the address of the local IP interface, and &$received_port$&
12909 is set to the local port number. (The remote IP address and port are in
12910 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12911 the port value is -1 unless it has been set using the &%-oMi%& command line
12912 option.
12913
12914 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12915 could be used, for example, to make the filename for a TLS certificate depend
12916 on which interface and/or port is being used for the incoming connection. The
12917 values of &$received_ip_address$& and &$received_port$& are saved with any
12918 messages that are received, thus making these variables available at delivery
12919 time.
12920 For outbound connections see &$sending_ip_address$&.
12921
12922 .vitem &$received_port$&
12923 .vindex "&$received_port$&"
12924 See &$received_ip_address$&.
12925
12926 .vitem &$received_protocol$&
12927 .vindex "&$received_protocol$&"
12928 When a message is being processed, this variable contains the name of the
12929 protocol by which it was received. Most of the names used by Exim are defined
12930 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12931 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12932 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12933 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12934 connection and the client was successfully authenticated.
12935
12936 Exim uses the protocol name &"smtps"& for the case when encryption is
12937 automatically set up on connection without the use of STARTTLS (see
12938 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12939 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12940 where the client initially uses EHLO, sets up an encrypted connection using
12941 STARTTLS, and then uses HELO afterwards.
12942
12943 The &%-oMr%& option provides a way of specifying a custom protocol name for
12944 messages that are injected locally by trusted callers. This is commonly used to
12945 identify messages that are being re-injected after some kind of scanning.
12946
12947 .vitem &$received_time$&
12948 .vindex "&$received_time$&"
12949 This variable contains the date and time when the current message was received,
12950 as a number of seconds since the start of the Unix epoch.
12951
12952 .vitem &$recipient_data$&
12953 .vindex "&$recipient_data$&"
12954 This variable is set after an indexing lookup success in an ACL &%recipients%&
12955 condition. It contains the data from the lookup, and the value remains set
12956 until the next &%recipients%& test. Thus, you can do things like this:
12957 .display
12958 &`require recipients  = cdb*@;/some/file`&
12959 &`deny    `&&'some further test involving'& &`$recipient_data`&
12960 .endd
12961 &*Warning*&: This variable is set only when a lookup is used as an indexing
12962 method in the address list, using the semicolon syntax as in the example above.
12963 The variable is not set for a lookup that is used as part of the string
12964 expansion that all such lists undergo before being interpreted.
12965
12966 .vitem &$recipient_verify_failure$&
12967 .vindex "&$recipient_verify_failure$&"
12968 In an ACL, when a recipient verification fails, this variable contains
12969 information about the failure. It is set to one of the following words:
12970
12971 .ilist
12972 &"qualify"&: The address was unqualified (no domain), and the message
12973 was neither local nor came from an exempted host.
12974
12975 .next
12976 &"route"&: Routing failed.
12977
12978 .next
12979 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12980 or before the MAIL command (that is, on initial connection, HELO, or
12981 MAIL).
12982
12983 .next
12984 &"recipient"&: The RCPT command in a callout was rejected.
12985 .next
12986
12987 &"postmaster"&: The postmaster check in a callout was rejected.
12988 .endlist
12989
12990 The main use of this variable is expected to be to distinguish between
12991 rejections of MAIL and rejections of RCPT.
12992
12993 .vitem &$recipients$&
12994 .vindex "&$recipients$&"
12995 This variable contains a list of envelope recipients for a message. A comma and
12996 a space separate the addresses in the replacement text. However, the variable
12997 is not generally available, to prevent exposure of Bcc recipients in
12998 unprivileged users' filter files. You can use &$recipients$& only in these
12999 cases:
13000
13001 .olist
13002 In a system filter file.
13003 .next
13004 In the ACLs associated with the DATA command and with non-SMTP messages, that
13005 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13006 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13007 &%acl_not_smtp_mime%&.
13008 .next
13009 From within a &[local_scan()]& function.
13010 .endlist
13011
13012
13013 .vitem &$recipients_count$&
13014 .vindex "&$recipients_count$&"
13015 When a message is being processed, this variable contains the number of
13016 envelope recipients that came with the message. Duplicates are not excluded
13017 from the count. While a message is being received over SMTP, the number
13018 increases for each accepted recipient. It can be referenced in an ACL.
13019
13020
13021 .vitem &$regex_match_string$&
13022 .vindex "&$regex_match_string$&"
13023 This variable is set to contain the matching regular expression after a
13024 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13025
13026 .vitem "&$regex1$&, &$regex2$&, etc"
13027 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13028 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13029 these variables contain the
13030 captured substrings identified by the regular expression.
13031
13032
13033 .vitem &$reply_address$&
13034 .vindex "&$reply_address$&"
13035 When a message is being processed, this variable contains the contents of the
13036 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13037 contents of the &'From:'& header line. Apart from the removal of leading
13038 white space, the value is not processed in any way. In particular, no RFC 2047
13039 decoding or character code translation takes place.
13040
13041 .vitem &$return_path$&
13042 .vindex "&$return_path$&"
13043 When a message is being delivered, this variable contains the return path &--
13044 the sender field that will be sent as part of the envelope. It is not enclosed
13045 in <> characters. At the start of routing an address, &$return_path$& has the
13046 same value as &$sender_address$&, but if, for example, an incoming message to a
13047 mailing list has been expanded by a router which specifies a different address
13048 for bounce messages, &$return_path$& subsequently contains the new bounce
13049 address, whereas &$sender_address$& always contains the original sender address
13050 that was received with the message. In other words, &$sender_address$& contains
13051 the incoming envelope sender, and &$return_path$& contains the outgoing
13052 envelope sender.
13053
13054 .vitem &$return_size_limit$&
13055 .vindex "&$return_size_limit$&"
13056 This is an obsolete name for &$bounce_return_size_limit$&.
13057
13058 .vitem &$router_name$&
13059 .cindex "router" "name"
13060 .cindex "name" "of router"
13061 .vindex "&$router_name$&"
13062 During the running of a router this variable contains its name.
13063
13064 .vitem &$runrc$&
13065 .cindex "return code" "from &%run%& expansion"
13066 .vindex "&$runrc$&"
13067 This variable contains the return code from a command that is run by the
13068 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13069 assume the order in which option values are expanded, except for those
13070 preconditions whose order of testing is documented. Therefore, you cannot
13071 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13072 another.
13073
13074 .vitem &$self_hostname$&
13075 .oindex "&%self%&" "value of host name"
13076 .vindex "&$self_hostname$&"
13077 When an address is routed to a supposedly remote host that turns out to be the
13078 local host, what happens is controlled by the &%self%& generic router option.
13079 One of its values causes the address to be passed to another router. When this
13080 happens, &$self_hostname$& is set to the name of the local host that the
13081 original router encountered. In other circumstances its contents are null.
13082
13083 .vitem &$sender_address$&
13084 .vindex "&$sender_address$&"
13085 When a message is being processed, this variable contains the sender's address
13086 that was received in the message's envelope. The case of letters in the address
13087 is retained, in both the local part and the domain. For bounce messages, the
13088 value of this variable is the empty string. See also &$return_path$&.
13089
13090 .vitem &$sender_address_data$&
13091 .vindex "&$address_data$&"
13092 .vindex "&$sender_address_data$&"
13093 If &$address_data$& is set when the routers are called from an ACL to verify a
13094 sender address, the final value is preserved in &$sender_address_data$&, to
13095 distinguish it from data from a recipient address. The value does not persist
13096 after the end of the current ACL statement. If you want to preserve it for
13097 longer, you can save it in an ACL variable.
13098
13099 .vitem &$sender_address_domain$&
13100 .vindex "&$sender_address_domain$&"
13101 The domain portion of &$sender_address$&.
13102
13103 .vitem &$sender_address_local_part$&
13104 .vindex "&$sender_address_local_part$&"
13105 The local part portion of &$sender_address$&.
13106
13107 .vitem &$sender_data$&
13108 .vindex "&$sender_data$&"
13109 This variable is set after a lookup success in an ACL &%senders%& condition or
13110 in a router &%senders%& option. It contains the data from the lookup, and the
13111 value remains set until the next &%senders%& test. Thus, you can do things like
13112 this:
13113 .display
13114 &`require senders      = cdb*@;/some/file`&
13115 &`deny    `&&'some further test involving'& &`$sender_data`&
13116 .endd
13117 &*Warning*&: This variable is set only when a lookup is used as an indexing
13118 method in the address list, using the semicolon syntax as in the example above.
13119 The variable is not set for a lookup that is used as part of the string
13120 expansion that all such lists undergo before being interpreted.
13121
13122 .vitem &$sender_fullhost$&
13123 .vindex "&$sender_fullhost$&"
13124 When a message is received from a remote host, this variable contains the host
13125 name and IP address in a single string. It ends with the IP address in square
13126 brackets, followed by a colon and a port number if the logging of ports is
13127 enabled. The format of the rest of the string depends on whether the host
13128 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13129 looking up its IP address. (Looking up the IP address can be forced by the
13130 &%host_lookup%& option, independent of verification.) A plain host name at the
13131 start of the string is a verified host name; if this is not present,
13132 verification either failed or was not requested. A host name in parentheses is
13133 the argument of a HELO or EHLO command. This is omitted if it is identical to
13134 the verified host name or to the host's IP address in square brackets.
13135
13136 .vitem &$sender_helo_dnssec$&
13137 .vindex "&$sender_helo_dnssec$&"
13138 This boolean variable is true if a successful HELO verification was
13139 .cindex "DNS" "DNSSEC"
13140 done using DNS information the resolver library stated was authenticated data.
13141
13142 .vitem &$sender_helo_name$&
13143 .vindex "&$sender_helo_name$&"
13144 When a message is received from a remote host that has issued a HELO or EHLO
13145 command, the argument of that command is placed in this variable. It is also
13146 set if HELO or EHLO is used when a message is received using SMTP locally via
13147 the &%-bs%& or &%-bS%& options.
13148
13149 .vitem &$sender_host_address$&
13150 .vindex "&$sender_host_address$&"
13151 When a message is received from a remote host using SMTP,
13152 this variable contains that
13153 host's IP address. For locally non-SMTP submitted messages, it is empty.
13154
13155 .vitem &$sender_host_authenticated$&
13156 .vindex "&$sender_host_authenticated$&"
13157 This variable contains the name (not the public name) of the authenticator
13158 driver that successfully authenticated the client from which the message was
13159 received. It is empty if there was no successful authentication. See also
13160 &$authenticated_id$&.
13161
13162 .vitem &$sender_host_dnssec$&
13163 .vindex "&$sender_host_dnssec$&"
13164 If an attempt to populate &$sender_host_name$& has been made
13165 (by reference, &%hosts_lookup%& or
13166 otherwise) then this boolean will have been set true if, and only if, the
13167 resolver library states that both
13168 the reverse and forward DNS were authenticated data.  At all
13169 other times, this variable is false.
13170
13171 .cindex "DNS" "DNSSEC"
13172 It is likely that you will need to coerce DNSSEC support on in the resolver
13173 library, by setting:
13174 .code
13175 dns_dnssec_ok = 1
13176 .endd
13177
13178 Exim does not perform DNSSEC validation itself, instead leaving that to a
13179 validating resolver (e.g. unbound, or bind with suitable configuration).
13180
13181 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13182 mechanism in the list, then this variable will be false.
13183
13184 This requires that your system resolver library support EDNS0 (and that
13185 DNSSEC flags exist in the system headers).  If the resolver silently drops
13186 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13187 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13188
13189
13190 .vitem &$sender_host_name$&
13191 .vindex "&$sender_host_name$&"
13192 When a message is received from a remote host, this variable contains the
13193 host's name as obtained by looking up its IP address. For messages received by
13194 other means, this variable is empty.
13195
13196 .vindex "&$host_lookup_failed$&"
13197 If the host name has not previously been looked up, a reference to
13198 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13199 A looked up name is accepted only if it leads back to the original IP address
13200 via a forward lookup. If either the reverse or the forward lookup fails to find
13201 any data, or if the forward lookup does not yield the original IP address,
13202 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13203
13204 .vindex "&$host_lookup_deferred$&"
13205 However, if either of the lookups cannot be completed (for example, there is a
13206 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13207 &$host_lookup_failed$& remains set to &"0"&.
13208
13209 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13210 host name again if there is a subsequent reference to &$sender_host_name$&
13211 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13212 is set to &"1"&.
13213
13214 Exim does not automatically look up every calling host's name. If you want
13215 maximum efficiency, you should arrange your configuration so that it avoids
13216 these lookups altogether. The lookup happens only if one or more of the
13217 following are true:
13218
13219 .ilist
13220 A string containing &$sender_host_name$& is expanded.
13221 .next
13222 The calling host matches the list in &%host_lookup%&. In the default
13223 configuration, this option is set to *, so it must be changed if lookups are
13224 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13225 .next
13226 Exim needs the host name in order to test an item in a host list. The items
13227 that require this are described in sections &<<SECThoslispatnam>>& and
13228 &<<SECThoslispatnamsk>>&.
13229 .next
13230 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13231 In this case, the host name is required to compare with the name quoted in any
13232 EHLO or HELO commands that the client issues.
13233 .next
13234 The remote host issues a EHLO or HELO command that quotes one of the
13235 domains in &%helo_lookup_domains%&. The default value of this option is
13236 . ==== As this is a nested list, any displays it contains must be indented
13237 . ==== as otherwise they are too far to the left.
13238 .code
13239   helo_lookup_domains = @ : @[]
13240 .endd
13241 which causes a lookup if a remote host (incorrectly) gives the server's name or
13242 IP address in an EHLO or HELO command.
13243 .endlist
13244
13245
13246 .vitem &$sender_host_port$&
13247 .vindex "&$sender_host_port$&"
13248 When a message is received from a remote host, this variable contains the port
13249 number that was used on the remote host.
13250
13251 .vitem &$sender_ident$&
13252 .vindex "&$sender_ident$&"
13253 When a message is received from a remote host, this variable contains the
13254 identification received in response to an RFC 1413 request. When a message has
13255 been received locally, this variable contains the login name of the user that
13256 called Exim.
13257
13258 .vitem &$sender_rate_$&&'xxx'&
13259 A number of variables whose names begin &$sender_rate_$& are set as part of the
13260 &%ratelimit%& ACL condition. Details are given in section
13261 &<<SECTratelimiting>>&.
13262
13263 .vitem &$sender_rcvhost$&
13264 .cindex "DNS" "reverse lookup"
13265 .cindex "reverse DNS lookup"
13266 .vindex "&$sender_rcvhost$&"
13267 This is provided specifically for use in &'Received:'& headers. It starts with
13268 either the verified host name (as obtained from a reverse DNS lookup) or, if
13269 there is no verified host name, the IP address in square brackets. After that
13270 there may be text in parentheses. When the first item is a verified host name,
13271 the first thing in the parentheses is the IP address in square brackets,
13272 followed by a colon and a port number if port logging is enabled. When the
13273 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13274 the parentheses.
13275
13276 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13277 was used and its argument was not identical to the real host name or IP
13278 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13279 all three items are present in the parentheses, a newline and tab are inserted
13280 into the string, to improve the formatting of the &'Received:'& header.
13281
13282 .vitem &$sender_verify_failure$&
13283 .vindex "&$sender_verify_failure$&"
13284 In an ACL, when a sender verification fails, this variable contains information
13285 about the failure. The details are the same as for
13286 &$recipient_verify_failure$&.
13287
13288 .vitem &$sending_ip_address$&
13289 .vindex "&$sending_ip_address$&"
13290 This variable is set whenever an outgoing SMTP connection to another host has
13291 been set up. It contains the IP address of the local interface that is being
13292 used. This is useful if a host that has more than one IP address wants to take
13293 on different personalities depending on which one is being used. For incoming
13294 connections, see &$received_ip_address$&.
13295
13296 .vitem &$sending_port$&
13297 .vindex "&$sending_port$&"
13298 This variable is set whenever an outgoing SMTP connection to another host has
13299 been set up. It contains the local port that is being used. For incoming
13300 connections, see &$received_port$&.
13301
13302 .vitem &$smtp_active_hostname$&
13303 .vindex "&$smtp_active_hostname$&"
13304 During an incoming SMTP session, this variable contains the value of the active
13305 host name, as specified by the &%smtp_active_hostname%& option. The value of
13306 &$smtp_active_hostname$& is saved with any message that is received, so its
13307 value can be consulted during routing and delivery.
13308
13309 .vitem &$smtp_command$&
13310 .vindex "&$smtp_command$&"
13311 During the processing of an incoming SMTP command, this variable contains the
13312 entire command. This makes it possible to distinguish between HELO and EHLO in
13313 the HELO ACL, and also to distinguish between commands such as these:
13314 .code
13315 MAIL FROM:<>
13316 MAIL FROM: <>
13317 .endd
13318 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13319 command, the address in &$smtp_command$& is the original address before any
13320 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13321 the address after SMTP-time rewriting.
13322
13323 .vitem &$smtp_command_argument$&
13324 .cindex "SMTP" "command, argument for"
13325 .vindex "&$smtp_command_argument$&"
13326 While an ACL is running to check an SMTP command, this variable contains the
13327 argument, that is, the text that follows the command name, with leading white
13328 space removed. Following the introduction of &$smtp_command$&, this variable is
13329 somewhat redundant, but is retained for backwards compatibility.
13330
13331 .vitem &$smtp_command_history$&
13332 .cindex SMTP "command history"
13333 .vindex "&$smtp_command_history$&"
13334 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13335 received, in time-order left to right.  Only a limited number of commands
13336 are remembered.
13337
13338 .vitem &$smtp_count_at_connection_start$&
13339 .vindex "&$smtp_count_at_connection_start$&"
13340 This variable is set greater than zero only in processes spawned by the Exim
13341 daemon for handling incoming SMTP connections. The name is deliberately long,
13342 in order to emphasize what the contents are. When the daemon accepts a new
13343 connection, it increments this variable. A copy of the variable is passed to
13344 the child process that handles the connection, but its value is fixed, and
13345 never changes. It is only an approximation of how many incoming connections
13346 there actually are, because many other connections may come and go while a
13347 single connection is being processed. When a child process terminates, the
13348 daemon decrements its copy of the variable.
13349
13350 .vitem "&$sn0$& &-- &$sn9$&"
13351 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13352 that were current at the end of the system filter file. This allows a system
13353 filter file to set values that can be tested in users' filter files. For
13354 example, a system filter could set a value indicating how likely it is that a
13355 message is junk mail.
13356
13357 .vitem &$spam_$&&'xxx'&
13358 A number of variables whose names start with &$spam$& are available when Exim
13359 is compiled with the content-scanning extension. For details, see section
13360 &<<SECTscanspamass>>&.
13361
13362 .vitem &$spf_header_comment$& &&&
13363        &$spf_received$& &&&
13364        &$spf_result$& &&&
13365        &$spf_result_guessed$& &&&
13366        &$spf_smtp_comment$&
13367 These variables are only available if Exim is built with SPF support.
13368 For details see section &<<SECSPF>>&.
13369
13370 .vitem &$spool_directory$&
13371 .vindex "&$spool_directory$&"
13372 The name of Exim's spool directory.
13373
13374 .vitem &$spool_inodes$&
13375 .vindex "&$spool_inodes$&"
13376 The number of free inodes in the disk partition where Exim's spool files are
13377 being written. The value is recalculated whenever the variable is referenced.
13378 If the relevant file system does not have the concept of inodes, the value of
13379 is -1. See also the &%check_spool_inodes%& option.
13380
13381 .vitem &$spool_space$&
13382 .vindex "&$spool_space$&"
13383 The amount of free space (as a number of kilobytes) in the disk partition where
13384 Exim's spool files are being written. The value is recalculated whenever the
13385 variable is referenced. If the operating system does not have the ability to
13386 find the amount of free space (only true for experimental systems), the space
13387 value is -1. For example, to check in an ACL that there is at least 50
13388 megabytes free on the spool, you could write:
13389 .code
13390 condition = ${if > {$spool_space}{50000}}
13391 .endd
13392 See also the &%check_spool_space%& option.
13393
13394
13395 .vitem &$thisaddress$&
13396 .vindex "&$thisaddress$&"
13397 This variable is set only during the processing of the &%foranyaddress%&
13398 command in a filter file. Its use is explained in the description of that
13399 command, which can be found in the separate document entitled &'Exim's
13400 interfaces to mail filtering'&.
13401
13402 .vitem &$tls_in_bits$&
13403 .vindex "&$tls_in_bits$&"
13404 Contains an approximation of the TLS cipher's bit-strength
13405 on the inbound connection; the meaning of
13406 this depends upon the TLS implementation used.
13407 If TLS has not been negotiated, the value will be 0.
13408 The value of this is automatically fed into the Cyrus SASL authenticator
13409 when acting as a server, to specify the "external SSF" (a SASL term).
13410
13411 The deprecated &$tls_bits$& variable refers to the inbound side
13412 except when used in the context of an outbound SMTP delivery, when it refers to
13413 the outbound.
13414
13415 .vitem &$tls_out_bits$&
13416 .vindex "&$tls_out_bits$&"
13417 Contains an approximation of the TLS cipher's bit-strength
13418 on an outbound SMTP connection; the meaning of
13419 this depends upon the TLS implementation used.
13420 If TLS has not been negotiated, the value will be 0.
13421
13422 .vitem &$tls_in_ourcert$&
13423 .vindex "&$tls_in_ourcert$&"
13424 .cindex certificate variables
13425 This variable refers to the certificate presented to the peer of an
13426 inbound connection when the message was received.
13427 It is only useful as the argument of a
13428 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13429 or a &%def%& condition.
13430
13431 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13432 when a list of more than one
13433 file is used for &%tls_certificate%&, this variable is not reliable.
13434 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13435
13436 .vitem &$tls_in_peercert$&
13437 .vindex "&$tls_in_peercert$&"
13438 This variable refers to the certificate presented by the peer of an
13439 inbound connection when the message was received.
13440 It is only useful as the argument of a
13441 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13442 or a &%def%& condition.
13443 If certificate verification fails it may refer to a failing chain element
13444 which is not the leaf.
13445
13446 .vitem &$tls_out_ourcert$&
13447 .vindex "&$tls_out_ourcert$&"
13448 This variable refers to the certificate presented to the peer of an
13449 outbound connection.  It is only useful as the argument of a
13450 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13451 or a &%def%& condition.
13452
13453 .vitem &$tls_out_peercert$&
13454 .vindex "&$tls_out_peercert$&"
13455 This variable refers to the certificate presented by the peer of an
13456 outbound connection.  It is only useful as the argument of a
13457 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13458 or a &%def%& condition.
13459 If certificate verification fails it may refer to a failing chain element
13460 which is not the leaf.
13461
13462 .vitem &$tls_in_certificate_verified$&
13463 .vindex "&$tls_in_certificate_verified$&"
13464 This variable is set to &"1"& if a TLS certificate was verified when the
13465 message was received, and &"0"& otherwise.
13466
13467 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13468 except when used in the context of an outbound SMTP delivery, when it refers to
13469 the outbound.
13470
13471 .vitem &$tls_out_certificate_verified$&
13472 .vindex "&$tls_out_certificate_verified$&"
13473 This variable is set to &"1"& if a TLS certificate was verified when an
13474 outbound SMTP connection was made,
13475 and &"0"& otherwise.
13476
13477 .vitem &$tls_in_cipher$&
13478 .vindex "&$tls_in_cipher$&"
13479 .vindex "&$tls_cipher$&"
13480 When a message is received from a remote host over an encrypted SMTP
13481 connection, this variable is set to the cipher suite that was negotiated, for
13482 example DES-CBC3-SHA. In other circumstances, in particular, for message
13483 received over unencrypted connections, the variable is empty. Testing
13484 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13485 non-encrypted connections during ACL processing.
13486
13487 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13488 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13489 becomes the same as &$tls_out_cipher$&.
13490
13491 .vitem &$tls_in_cipher_std$&
13492 .vindex "&$tls_in_cipher_std$&"
13493 As above, but returning the RFC standard name for the cipher suite.
13494
13495 .vitem &$tls_out_cipher$&
13496 .vindex "&$tls_out_cipher$&"
13497 This variable is
13498 cleared before any outgoing SMTP connection is made,
13499 and then set to the outgoing cipher suite if one is negotiated. See chapter
13500 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13501 details of the &(smtp)& transport.
13502
13503 .vitem &$tls_out_cipher_std$&
13504 .vindex "&$tls_out_cipher_std$&"
13505 As above, but returning the RFC standard name for the cipher suite.
13506
13507 .vitem &$tls_out_dane$&
13508 .vindex &$tls_out_dane$&
13509 DANE active status.  See section &<<SECDANE>>&.
13510
13511 .vitem &$tls_in_ocsp$&
13512 .vindex "&$tls_in_ocsp$&"
13513 When a message is received from a remote client connection
13514 the result of any OCSP request from the client is encoded in this variable:
13515 .code
13516 0 OCSP proof was not requested (default value)
13517 1 No response to request
13518 2 Response not verified
13519 3 Verification failed
13520 4 Verification succeeded
13521 .endd
13522
13523 .vitem &$tls_out_ocsp$&
13524 .vindex "&$tls_out_ocsp$&"
13525 When a message is sent to a remote host connection
13526 the result of any OCSP request made is encoded in this variable.
13527 See &$tls_in_ocsp$& for values.
13528
13529 .vitem &$tls_in_peerdn$&
13530 .vindex "&$tls_in_peerdn$&"
13531 .vindex "&$tls_peerdn$&"
13532 .cindex certificate "extracting fields"
13533 When a message is received from a remote host over an encrypted SMTP
13534 connection, and Exim is configured to request a certificate from the client,
13535 the value of the Distinguished Name of the certificate is made available in the
13536 &$tls_in_peerdn$& during subsequent processing.
13537 If certificate verification fails it may refer to a failing chain element
13538 which is not the leaf.
13539
13540 The deprecated &$tls_peerdn$& variable refers to the inbound side
13541 except when used in the context of an outbound SMTP delivery, when it refers to
13542 the outbound.
13543
13544 .vitem &$tls_out_peerdn$&
13545 .vindex "&$tls_out_peerdn$&"
13546 When a message is being delivered to a remote host over an encrypted SMTP
13547 connection, and Exim is configured to request a certificate from the server,
13548 the value of the Distinguished Name of the certificate is made available in the
13549 &$tls_out_peerdn$& during subsequent processing.
13550 If certificate verification fails it may refer to a failing chain element
13551 which is not the leaf.
13552
13553 .vitem &$tls_in_sni$&
13554 .vindex "&$tls_in_sni$&"
13555 .vindex "&$tls_sni$&"
13556 .cindex "TLS" "Server Name Indication"
13557 When a TLS session is being established, if the client sends the Server
13558 Name Indication extension, the value will be placed in this variable.
13559 If the variable appears in &%tls_certificate%& then this option and
13560 some others, described in &<<SECTtlssni>>&,
13561 will be re-expanded early in the TLS session, to permit
13562 a different certificate to be presented (and optionally a different key to be
13563 used) to the client, based upon the value of the SNI extension.
13564
13565 The deprecated &$tls_sni$& variable refers to the inbound side
13566 except when used in the context of an outbound SMTP delivery, when it refers to
13567 the outbound.
13568
13569 .vitem &$tls_out_sni$&
13570 .vindex "&$tls_out_sni$&"
13571 .cindex "TLS" "Server Name Indication"
13572 During outbound
13573 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13574 the transport.
13575
13576 .vitem &$tls_out_tlsa_usage$&
13577 .vindex &$tls_out_tlsa_usage$&
13578 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13579
13580 .vitem &$tls_in_ver$&
13581 .vindex "&$tls_in_ver$&"
13582 When a message is received from a remote host over an encrypted SMTP connection
13583 this variable is set to the protocol version, eg &'TLS1.2'&.
13584
13585 .vitem &$tls_out_ver$&
13586 .vindex "&$tls_out_ver$&"
13587 When a message is being delivered to a remote host over an encrypted SMTP connection
13588 this variable is set to the protocol version.
13589
13590
13591 .vitem &$tod_bsdinbox$&
13592 .vindex "&$tod_bsdinbox$&"
13593 The time of day and the date, in the format required for BSD-style mailbox
13594 files, for example: Thu Oct 17 17:14:09 1995.
13595
13596 .vitem &$tod_epoch$&
13597 .vindex "&$tod_epoch$&"
13598 The time and date as a number of seconds since the start of the Unix epoch.
13599
13600 .vitem &$tod_epoch_l$&
13601 .vindex "&$tod_epoch_l$&"
13602 The time and date as a number of microseconds since the start of the Unix epoch.
13603
13604 .vitem &$tod_full$&
13605 .vindex "&$tod_full$&"
13606 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13607 +0100. The timezone is always given as a numerical offset from UTC, with
13608 positive values used for timezones that are ahead (east) of UTC, and negative
13609 values for those that are behind (west).
13610
13611 .vitem &$tod_log$&
13612 .vindex "&$tod_log$&"
13613 The time and date in the format used for writing Exim's log files, for example:
13614 1995-10-12 15:32:29, but without a timezone.
13615
13616 .vitem &$tod_logfile$&
13617 .vindex "&$tod_logfile$&"
13618 This variable contains the date in the format yyyymmdd. This is the format that
13619 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13620 flag.
13621
13622 .vitem &$tod_zone$&
13623 .vindex "&$tod_zone$&"
13624 This variable contains the numerical value of the local timezone, for example:
13625 -0500.
13626
13627 .vitem &$tod_zulu$&
13628 .vindex "&$tod_zulu$&"
13629 This variable contains the UTC date and time in &"Zulu"& format, as specified
13630 by ISO 8601, for example: 20030221154023Z.
13631
13632 .vitem &$transport_name$&
13633 .cindex "transport" "name"
13634 .cindex "name" "of transport"
13635 .vindex "&$transport_name$&"
13636 During the running of a transport, this variable contains its name.
13637
13638 .vitem &$value$&
13639 .vindex "&$value$&"
13640 This variable contains the result of an expansion lookup, extraction operation,
13641 or external command, as described above. It is also used during a
13642 &*reduce*& expansion.
13643
13644 .vitem &$verify_mode$&
13645 .vindex "&$verify_mode$&"
13646 While a router or transport is being run in verify mode or for cutthrough delivery,
13647 contains "S" for sender-verification or "R" for recipient-verification.
13648 Otherwise, empty.
13649
13650 .vitem &$version_number$&
13651 .vindex "&$version_number$&"
13652 The version number of Exim. Same as &$exim_version$&, may be overridden
13653 by the &%exim_version%& main config option.
13654
13655 .vitem &$warn_message_delay$&
13656 .vindex "&$warn_message_delay$&"
13657 This variable is set only during the creation of a message warning about a
13658 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13659
13660 .vitem &$warn_message_recipients$&
13661 .vindex "&$warn_message_recipients$&"
13662 This variable is set only during the creation of a message warning about a
13663 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13664 .endlist
13665 .ecindex IIDstrexp
13666
13667
13668
13669 . ////////////////////////////////////////////////////////////////////////////
13670 . ////////////////////////////////////////////////////////////////////////////
13671
13672 .chapter "Embedded Perl" "CHAPperl"
13673 .scindex IIDperl "Perl" "calling from Exim"
13674 Exim can be built to include an embedded Perl interpreter. When this is done,
13675 Perl subroutines can be called as part of the string expansion process. To make
13676 use of the Perl support, you need version 5.004 or later of Perl installed on
13677 your system. To include the embedded interpreter in the Exim binary, include
13678 the line
13679 .code
13680 EXIM_PERL = perl.o
13681 .endd
13682 in your &_Local/Makefile_& and then build Exim in the normal way.
13683
13684
13685 .section "Setting up so Perl can be used" "SECID85"
13686 .oindex "&%perl_startup%&"
13687 Access to Perl subroutines is via a global configuration option called
13688 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13689 no &%perl_startup%& option in the Exim configuration file then no Perl
13690 interpreter is started and there is almost no overhead for Exim (since none of
13691 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13692 option then the associated value is taken to be Perl code which is executed in
13693 a newly created Perl interpreter.
13694
13695 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13696 need backslashes before any characters to escape special meanings. The option
13697 should usually be something like
13698 .code
13699 perl_startup = do '/etc/exim.pl'
13700 .endd
13701 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13702 use from Exim. Exim can be configured either to start up a Perl interpreter as
13703 soon as it is entered, or to wait until the first time it is needed. Starting
13704 the interpreter at the beginning ensures that it is done while Exim still has
13705 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13706 fact used in a particular run. Also, note that this does not mean that Exim is
13707 necessarily running as root when Perl is called at a later time. By default,
13708 the interpreter is started only when it is needed, but this can be changed in
13709 two ways:
13710
13711 .ilist
13712 .oindex "&%perl_at_start%&"
13713 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13714 a startup when Exim is entered.
13715 .next
13716 The command line option &%-ps%& also requests a startup when Exim is entered,
13717 overriding the setting of &%perl_at_start%&.
13718 .endlist
13719
13720 There is also a command line option &%-pd%& (for delay) which suppresses the
13721 initial startup, even if &%perl_at_start%& is set.
13722
13723 .ilist
13724 .oindex "&%perl_taintmode%&"
13725 .cindex "Perl" "taintmode"
13726 To provide more security executing Perl code via the embedded Perl
13727 interpreter, the &%perl_taintmode%& option can be set. This enables the
13728 taint mode of the Perl interpreter. You are encouraged to set this
13729 option to a true value. To avoid breaking existing installations, it
13730 defaults to false.
13731
13732
13733 .section "Calling Perl subroutines" "SECID86"
13734 When the configuration file includes a &%perl_startup%& option you can make use
13735 of the string expansion item to call the Perl subroutines that are defined
13736 by the &%perl_startup%& code. The operator is used in any of the following
13737 forms:
13738 .code
13739 ${perl{foo}}
13740 ${perl{foo}{argument}}
13741 ${perl{foo}{argument1}{argument2} ... }
13742 .endd
13743 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13744 arguments may be passed. Passing more than this results in an expansion failure
13745 with an error message of the form
13746 .code
13747 Too many arguments passed to Perl subroutine "foo" (max is 8)
13748 .endd
13749 The return value of the Perl subroutine is evaluated in a scalar context before
13750 it is passed back to Exim to be inserted into the expanded string. If the
13751 return value is &'undef'&, the expansion is forced to fail in the same way as
13752 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13753 by obeying Perl's &%die%& function, the expansion fails with the error message
13754 that was passed to &%die%&.
13755
13756
13757 .section "Calling Exim functions from Perl" "SECID87"
13758 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13759 is available to call back into Exim's string expansion function. For example,
13760 the Perl code
13761 .code
13762 my $lp = Exim::expand_string('$local_part');
13763 .endd
13764 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13765 Note those are single quotes and not double quotes to protect against
13766 &$local_part$& being interpolated as a Perl variable.
13767
13768 If the string expansion is forced to fail by a &"fail"& item, the result of
13769 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13770 expansion string, the Perl call from the original expansion string fails with
13771 an appropriate error message, in the same way as if &%die%& were used.
13772
13773 .cindex "debugging" "from embedded Perl"
13774 .cindex "log" "writing from embedded Perl"
13775 Two other Exim functions are available for use from within Perl code.
13776 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13777 debugging is enabled. If you want a newline at the end, you must supply it.
13778 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13779 timestamp. In this case, you should not supply a terminating newline.
13780
13781
13782 .section "Use of standard output and error by Perl" "SECID88"
13783 .cindex "Perl" "standard output and error"
13784 You should not write to the standard error or output streams from within your
13785 Perl code, as it is not defined how these are set up. In versions of Exim
13786 before 4.50, it is possible for the standard output or error to refer to the
13787 SMTP connection during message reception via the daemon. Writing to this stream
13788 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13789 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13790 avoided, but the output is lost.
13791
13792 .cindex "Perl" "use of &%warn%&"
13793 The Perl &%warn%& statement writes to the standard error stream by default.
13794 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13795 you have no control. When Exim starts up the Perl interpreter, it arranges for
13796 output from the &%warn%& statement to be written to the Exim main log. You can
13797 change this by including appropriate Perl magic somewhere in your Perl code.
13798 For example, to discard &%warn%& output completely, you need this:
13799 .code
13800 $SIG{__WARN__} = sub { };
13801 .endd
13802 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13803 example, the code for the subroutine is empty, so it does nothing, but you can
13804 include any Perl code that you like. The text of the &%warn%& message is passed
13805 as the first subroutine argument.
13806 .ecindex IIDperl
13807
13808
13809 . ////////////////////////////////////////////////////////////////////////////
13810 . ////////////////////////////////////////////////////////////////////////////
13811
13812 .chapter "Starting the daemon and the use of network interfaces" &&&
13813          "CHAPinterfaces" &&&
13814          "Starting the daemon"
13815 .cindex "daemon" "starting"
13816 .cindex "interface" "listening"
13817 .cindex "network interface"
13818 .cindex "interface" "network"
13819 .cindex "IP address" "for listening"
13820 .cindex "daemon" "listening IP addresses"
13821 .cindex "TCP/IP" "setting listening interfaces"
13822 .cindex "TCP/IP" "setting listening ports"
13823 A host that is connected to a TCP/IP network may have one or more physical
13824 hardware network interfaces. Each of these interfaces may be configured as one
13825 or more &"logical"& interfaces, which are the entities that a program actually
13826 works with. Each of these logical interfaces is associated with an IP address.
13827 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13828 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13829 knowledge about the host's interfaces for use in three different circumstances:
13830
13831 .olist
13832 When a listening daemon is started, Exim needs to know which interfaces
13833 and ports to listen on.
13834 .next
13835 When Exim is routing an address, it needs to know which IP addresses
13836 are associated with local interfaces. This is required for the correct
13837 processing of MX lists by removing the local host and others with the
13838 same or higher priority values. Also, Exim needs to detect cases
13839 when an address is routed to an IP address that in fact belongs to the
13840 local host. Unless the &%self%& router option or the &%allow_localhost%&
13841 option of the smtp transport is set (as appropriate), this is treated
13842 as an error situation.
13843 .next
13844 When Exim connects to a remote host, it may need to know which interface to use
13845 for the outgoing connection.
13846 .endlist
13847
13848
13849 Exim's default behaviour is likely to be appropriate in the vast majority
13850 of cases. If your host has only one interface, and you want all its IP
13851 addresses to be treated in the same way, and you are using only the
13852 standard SMTP port, you should not need to take any special action. The
13853 rest of this chapter does not apply to you.
13854
13855 In a more complicated situation you may want to listen only on certain
13856 interfaces, or on different ports, and for this reason there are a number of
13857 options that can be used to influence Exim's behaviour. The rest of this
13858 chapter describes how they operate.
13859
13860 When a message is received over TCP/IP, the interface and port that were
13861 actually used are set in &$received_ip_address$& and &$received_port$&.
13862
13863
13864
13865 .section "Starting a listening daemon" "SECID89"
13866 When a listening daemon is started (by means of the &%-bd%& command line
13867 option), the interfaces and ports on which it listens are controlled by the
13868 following options:
13869
13870 .ilist
13871 &%daemon_smtp_ports%& contains a list of default ports
13872 or service names.
13873 (For backward compatibility, this option can also be specified in the singular.)
13874 .next
13875 &%local_interfaces%& contains list of interface IP addresses on which to
13876 listen. Each item may optionally also specify a port.
13877 .endlist
13878
13879 The default list separator in both cases is a colon, but this can be changed as
13880 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13881 it is usually best to change the separator to avoid having to double all the
13882 colons. For example:
13883 .code
13884 local_interfaces = <; 127.0.0.1 ; \
13885                       192.168.23.65 ; \
13886                       ::1 ; \
13887                       3ffe:ffff:836f::fe86:a061
13888 .endd
13889 There are two different formats for specifying a port along with an IP address
13890 in &%local_interfaces%&:
13891
13892 .olist
13893 The port is added onto the address with a dot separator. For example, to listen
13894 on port 1234 on two different IP addresses:
13895 .code
13896 local_interfaces = <; 192.168.23.65.1234 ; \
13897                       3ffe:ffff:836f::fe86:a061.1234
13898 .endd
13899 .next
13900 The IP address is enclosed in square brackets, and the port is added
13901 with a colon separator, for example:
13902 .code
13903 local_interfaces = <; [192.168.23.65]:1234 ; \
13904                       [3ffe:ffff:836f::fe86:a061]:1234
13905 .endd
13906 .endlist
13907
13908 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13909 default setting contains just one port:
13910 .code
13911 daemon_smtp_ports = smtp
13912 .endd
13913 If more than one port is listed, each interface that does not have its own port
13914 specified listens on all of them. Ports that are listed in
13915 &%daemon_smtp_ports%& can be identified either by name (defined in
13916 &_/etc/services_&) or by number. However, when ports are given with individual
13917 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13918
13919
13920
13921 .section "Special IP listening addresses" "SECID90"
13922 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13923 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13924 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13925 instead of setting up separate listening sockets for each interface. The
13926 default value of &%local_interfaces%& is
13927 .code
13928 local_interfaces = 0.0.0.0
13929 .endd
13930 when Exim is built without IPv6 support; otherwise it is:
13931 .code
13932 local_interfaces = <; ::0 ; 0.0.0.0
13933 .endd
13934 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13935
13936
13937
13938 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13939 The &%-oX%& command line option can be used to override the values of
13940 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13941 instance. Another way of doing this would be to use macros and the &%-D%&
13942 option. However, &%-oX%& can be used by any admin user, whereas modification of
13943 the runtime configuration by &%-D%& is allowed only when the caller is root or
13944 exim.
13945
13946 The value of &%-oX%& is a list of items. The default colon separator can be
13947 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13948 If there are any items that do not
13949 contain dots or colons (that is, are not IP addresses), the value of
13950 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13951 items that do contain dots or colons, the value of &%local_interfaces%& is
13952 replaced by those items. Thus, for example,
13953 .code
13954 -oX 1225
13955 .endd
13956 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13957 whereas
13958 .code
13959 -oX 192.168.34.5.1125
13960 .endd
13961 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13962 (However, since &%local_interfaces%& now contains no items without ports, the
13963 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13964
13965
13966
13967 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13968 .cindex "submissions protocol"
13969 .cindex "ssmtp protocol"
13970 .cindex "smtps protocol"
13971 .cindex "SMTP" "ssmtp protocol"
13972 .cindex "SMTP" "smtps protocol"
13973 Exim supports the use of TLS-on-connect, used by mail clients in the
13974 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13975 For some years, IETF Standards Track documents only blessed the
13976 STARTTLS-based Submission service (port 587) while common practice was to support
13977 the same feature set on port 465, but using TLS-on-connect.
13978 If your installation needs to provide service to mail clients
13979 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13980 the 465 TCP ports.
13981
13982 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13983 service names, connections to those ports must first establish TLS, before
13984 proceeding to the application layer use of the SMTP protocol.
13985
13986 The common use of this option is expected to be
13987 .code
13988 tls_on_connect_ports = 465
13989 .endd
13990 per RFC 8314.
13991 There is also a command line option &%-tls-on-connect%&, which forces all ports
13992 to behave in this way when a daemon is started.
13993
13994 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13995 daemon to listen on those ports. You must still specify them in
13996 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13997 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13998 connections via the daemon.)
13999
14000
14001
14002
14003 .section "IPv6 address scopes" "SECID92"
14004 .cindex "IPv6" "address scopes"
14005 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14006 can, in principle, have the same link-local IPv6 address on different
14007 interfaces. Thus, additional information is needed, over and above the IP
14008 address, to distinguish individual interfaces. A convention of using a
14009 percent sign followed by something (often the interface name) has been
14010 adopted in some cases, leading to addresses like this:
14011 .code
14012 fe80::202:b3ff:fe03:45c1%eth0
14013 .endd
14014 To accommodate this usage, a percent sign followed by an arbitrary string is
14015 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14016 to convert a textual IPv6 address for actual use. This function recognizes the
14017 percent convention in operating systems that support it, and it processes the
14018 address appropriately. Unfortunately, some older libraries have problems with
14019 &[getaddrinfo()]&. If
14020 .code
14021 IPV6_USE_INET_PTON=yes
14022 .endd
14023 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14024 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14025 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14026 function.) Of course, this means that the additional functionality of
14027 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14028
14029 .section "Disabling IPv6" "SECID93"
14030 .cindex "IPv6" "disabling"
14031 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14032 run on a host whose kernel does not support IPv6. The binary will fall back to
14033 using IPv4, but it may waste resources looking up AAAA records, and trying to
14034 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14035 .oindex "&%disable_ipv6%&"
14036 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14037 activities take place. AAAA records are never looked up, and any IPv6 addresses
14038 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14039 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14040 to handle IPv6 literal addresses.
14041
14042 On the other hand, when IPv6 is in use, there may be times when you want to
14043 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14044 option to globally suppress the lookup of AAAA records for specified domains,
14045 and you can use the &%ignore_target_hosts%& generic router option to ignore
14046 IPv6 addresses in an individual router.
14047
14048
14049
14050 .section "Examples of starting a listening daemon" "SECID94"
14051 The default case in an IPv6 environment is
14052 .code
14053 daemon_smtp_ports = smtp
14054 local_interfaces = <; ::0 ; 0.0.0.0
14055 .endd
14056 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14057 Either one or two sockets may be used, depending on the characteristics of
14058 the TCP/IP stack. (This is complicated and messy; for more information,
14059 read the comments in the &_daemon.c_& source file.)
14060
14061 To specify listening on ports 25 and 26 on all interfaces:
14062 .code
14063 daemon_smtp_ports = 25 : 26
14064 .endd
14065 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14066 .code
14067 local_interfaces = <; ::0.25     ; ::0.26 \
14068                       0.0.0.0.25 ; 0.0.0.0.26
14069 .endd
14070 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14071 IPv4 loopback address only:
14072 .code
14073 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14074 .endd
14075 To specify listening on the default port on specific interfaces only:
14076 .code
14077 local_interfaces = 10.0.0.67 : 192.168.34.67
14078 .endd
14079 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14080
14081
14082
14083 .section "Recognizing the local host" "SECTreclocipadd"
14084 The &%local_interfaces%& option is also used when Exim needs to determine
14085 whether or not an IP address refers to the local host. That is, the IP
14086 addresses of all the interfaces on which a daemon is listening are always
14087 treated as local.
14088
14089 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14090 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14091 available interfaces from the operating system, and extracts the relevant
14092 (that is, IPv4 or IPv6) addresses to use for checking.
14093
14094 Some systems set up large numbers of virtual interfaces in order to provide
14095 many virtual web servers. In this situation, you may want to listen for
14096 email on only a few of the available interfaces, but nevertheless treat all
14097 interfaces as local when routing. You can do this by setting
14098 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14099 &"all"& wildcard values. These addresses are recognized as local, but are not
14100 used for listening. Consider this example:
14101 .code
14102 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14103                       192.168.53.235 ; \
14104                       3ffe:2101:12:1:a00:20ff:fe86:a061
14105
14106 extra_local_interfaces = <; ::0 ; 0.0.0.0
14107 .endd
14108 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14109 address, but all available interface addresses are treated as local when
14110 Exim is routing.
14111
14112 In some environments the local host name may be in an MX list, but with an IP
14113 address that is not assigned to any local interface. In other cases it may be
14114 desirable to treat other host names as if they referred to the local host. Both
14115 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14116 This contains host names rather than IP addresses. When a host is referenced
14117 during routing, either via an MX record or directly, it is treated as the local
14118 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14119 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14120
14121
14122
14123 .section "Delivering to a remote host" "SECID95"
14124 Delivery to a remote host is handled by the smtp transport. By default, it
14125 allows the system's TCP/IP functions to choose which interface to use (if
14126 there is more than one) when connecting to a remote host. However, the
14127 &%interface%& option can be set to specify which interface is used. See the
14128 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14129 details.
14130
14131
14132
14133
14134 . ////////////////////////////////////////////////////////////////////////////
14135 . ////////////////////////////////////////////////////////////////////////////
14136
14137 .chapter "Main configuration" "CHAPmainconfig"
14138 .scindex IIDconfima "configuration file" "main section"
14139 .scindex IIDmaiconf "main configuration"
14140 The first part of the runtime configuration file contains three types of item:
14141
14142 .ilist
14143 Macro definitions: These lines start with an upper case letter. See section
14144 &<<SECTmacrodefs>>& for details of macro processing.
14145 .next
14146 Named list definitions: These lines start with one of the words &"domainlist"&,
14147 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14148 section &<<SECTnamedlists>>&.
14149 .next
14150 Main configuration settings: Each setting occupies one line of the file
14151 (with possible continuations). If any setting is preceded by the word
14152 &"hide"&, the &%-bP%& command line option displays its value to admin users
14153 only. See section &<<SECTcos>>& for a description of the syntax of these option
14154 settings.
14155 .endlist
14156
14157 This chapter specifies all the main configuration options, along with their
14158 types and default values. For ease of finding a particular option, they appear
14159 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14160 are now so many options, they are first listed briefly in functional groups, as
14161 an aid to finding the name of the option you are looking for. Some options are
14162 listed in more than one group.
14163
14164 .section "Miscellaneous" "SECID96"
14165 .table2
14166 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14167 .row &%debug_store%&                 "do extra internal checks"
14168 .row &%disable_ipv6%&                "do no IPv6 processing"
14169 .row &%keep_malformed%&              "for broken files &-- should not happen"
14170 .row &%localhost_number%&            "for unique message ids in clusters"
14171 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14172 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14173 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14174 .row &%print_topbitchars%&           "top-bit characters are printing"
14175 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14176 .row &%timezone%&                    "force time zone"
14177 .endtable
14178
14179
14180 .section "Exim parameters" "SECID97"
14181 .table2
14182 .row &%exim_group%&                  "override compiled-in value"
14183 .row &%exim_path%&                   "override compiled-in value"
14184 .row &%exim_user%&                   "override compiled-in value"
14185 .row &%primary_hostname%&            "default from &[uname()]&"
14186 .row &%split_spool_directory%&       "use multiple directories"
14187 .row &%spool_directory%&             "override compiled-in value"
14188 .endtable
14189
14190
14191
14192 .section "Privilege controls" "SECID98"
14193 .table2
14194 .row &%admin_groups%&                "groups that are Exim admin users"
14195 .row &%commandline_checks_require_admin%& "require admin for various checks"
14196 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14197 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14198 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14199 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14200 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14201 .row &%never_users%&                 "do not run deliveries as these"
14202 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14203 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14204 .row &%trusted_groups%&              "groups that are trusted"
14205 .row &%trusted_users%&               "users that are trusted"
14206 .endtable
14207
14208
14209
14210 .section "Logging" "SECID99"
14211 .table2
14212 .row &%event_action%&                "custom logging"
14213 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14214 .row &%log_file_path%&               "override compiled-in value"
14215 .row &%log_selector%&                "set/unset optional logging"
14216 .row &%log_timezone%&                "add timezone to log lines"
14217 .row &%message_logs%&                "create per-message logs"
14218 .row &%preserve_message_logs%&       "after message completion"
14219 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14220 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14221 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14222 .row &%syslog_facility%&             "set syslog &""facility""& field"
14223 .row &%syslog_pid%&                  "pid in syslog lines"
14224 .row &%syslog_processname%&          "set syslog &""ident""& field"
14225 .row &%syslog_timestamp%&            "timestamp syslog lines"
14226 .row &%write_rejectlog%&             "control use of message log"
14227 .endtable
14228
14229
14230
14231 .section "Frozen messages" "SECID100"
14232 .table2
14233 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14234 .row &%freeze_tell%&                 "send message when freezing"
14235 .row &%move_frozen_messages%&        "to another directory"
14236 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14237 .endtable
14238
14239
14240
14241 .section "Data lookups" "SECID101"
14242 .table2
14243 .row &%ibase_servers%&               "InterBase servers"
14244 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14245 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14246 .row &%ldap_cert_file%&              "client cert file for LDAP"
14247 .row &%ldap_cert_key%&               "client key file for LDAP"
14248 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14249 .row &%ldap_default_servers%&        "used if no server in query"
14250 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14251 .row &%ldap_start_tls%&              "require TLS within LDAP"
14252 .row &%ldap_version%&                "set protocol version"
14253 .row &%lookup_open_max%&             "lookup files held open"
14254 .row &%mysql_servers%&               "default MySQL servers"
14255 .row &%oracle_servers%&              "Oracle servers"
14256 .row &%pgsql_servers%&               "default PostgreSQL servers"
14257 .row &%sqlite_lock_timeout%&         "as it says"
14258 .endtable
14259
14260
14261
14262 .section "Message ids" "SECID102"
14263 .table2
14264 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14265 .row &%message_id_header_text%&      "ditto"
14266 .endtable
14267
14268
14269
14270 .section "Embedded Perl Startup" "SECID103"
14271 .table2
14272 .row &%perl_at_start%&               "always start the interpreter"
14273 .row &%perl_startup%&                "code to obey when starting Perl"
14274 .row &%perl_taintmode%&              "enable taint mode in Perl"
14275 .endtable
14276
14277
14278
14279 .section "Daemon" "SECID104"
14280 .table2
14281 .row &%daemon_smtp_ports%&           "default ports"
14282 .row &%daemon_startup_retries%&      "number of times to retry"
14283 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14284 .row &%extra_local_interfaces%&      "not necessarily listened on"
14285 .row &%local_interfaces%&            "on which to listen, with optional ports"
14286 .row &%pid_file_path%&               "override compiled-in value"
14287 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14288 .endtable
14289
14290
14291
14292 .section "Resource control" "SECID105"
14293 .table2
14294 .row &%check_log_inodes%&            "before accepting a message"
14295 .row &%check_log_space%&             "before accepting a message"
14296 .row &%check_spool_inodes%&          "before accepting a message"
14297 .row &%check_spool_space%&           "before accepting a message"
14298 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14299 .row &%queue_only_load%&             "queue incoming if load high"
14300 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14301 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14302 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14303 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14304 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14305 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14306 .row &%smtp_accept_max_per_connection%& "messages per connection"
14307 .row &%smtp_accept_max_per_host%&    "connections from one host"
14308 .row &%smtp_accept_queue%&           "queue mail if more connections"
14309 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14310                                            connection"
14311 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14312 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14313 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14314 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14315 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14316 .endtable
14317
14318
14319
14320 .section "Policy controls" "SECID106"
14321 .table2
14322 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14323 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14324 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14325 .row &%acl_smtp_auth%&               "ACL for AUTH"
14326 .row &%acl_smtp_connect%&            "ACL for connection"
14327 .row &%acl_smtp_data%&               "ACL for DATA"
14328 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14329 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14330 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14331 .row &%acl_smtp_expn%&               "ACL for EXPN"
14332 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14333 .row &%acl_smtp_mail%&               "ACL for MAIL"
14334 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14335 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14336 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14337 .row &%acl_smtp_predata%&            "ACL for start of data"
14338 .row &%acl_smtp_quit%&               "ACL for QUIT"
14339 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14340 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14341 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14342 .row &%av_scanner%&                  "specify virus scanner"
14343 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14344                                       words""&"
14345 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14346 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14347 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14348 .row &%header_maxsize%&              "total size of message header"
14349 .row &%header_line_maxsize%&         "individual header line limit"
14350 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14351 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14352 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14353 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14354 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14355 .row &%host_lookup%&                 "host name looked up for these hosts"
14356 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14357 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14358 .row &%host_reject_connection%&      "reject connection from these hosts"
14359 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14360 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14361 .row &%message_size_limit%&          "for all messages"
14362 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14363 .row &%spamd_address%&               "set interface to SpamAssassin"
14364 .row &%strict_acl_vars%&             "object to unset ACL variables"
14365 .endtable
14366
14367
14368
14369 .section "Callout cache" "SECID107"
14370 .table2
14371 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14372                                          item"
14373 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14374                                          item"
14375 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14376 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14377 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14378 .endtable
14379
14380
14381
14382 .section "TLS" "SECID108"
14383 .table2
14384 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14385 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14386 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14387 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14388 .row &%tls_certificate%&             "location of server certificate"
14389 .row &%tls_crl%&                     "certificate revocation list"
14390 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14391 .row &%tls_dhparam%&                 "DH parameters for server"
14392 .row &%tls_eccurve%&                 "EC curve selection for server"
14393 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14394 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14395 .row &%tls_privatekey%&              "location of server private key"
14396 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14397 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14398 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14399 .row &%tls_verify_certificates%&     "expected client certificates"
14400 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14401 .endtable
14402
14403
14404
14405 .section "Local user handling" "SECID109"
14406 .table2
14407 .row &%finduser_retries%&            "useful in NIS environments"
14408 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14409 .row &%gecos_pattern%&               "ditto"
14410 .row &%max_username_length%&         "for systems that truncate"
14411 .row &%unknown_login%&               "used when no login name found"
14412 .row &%unknown_username%&            "ditto"
14413 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14414 .row &%uucp_from_sender%&            "ditto"
14415 .endtable
14416
14417
14418
14419 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14420 .table2
14421 .row &%header_maxsize%&              "total size of message header"
14422 .row &%header_line_maxsize%&         "individual header line limit"
14423 .row &%message_size_limit%&          "applies to all messages"
14424 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14425 .row &%received_header_text%&        "expanded to make &'Received:'&"
14426 .row &%received_headers_max%&        "for mail loop detection"
14427 .row &%recipients_max%&              "limit per message"
14428 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14429 .endtable
14430
14431
14432
14433
14434 .section "Non-SMTP incoming messages" "SECID111"
14435 .table2
14436 .row &%receive_timeout%&             "for non-SMTP messages"
14437 .endtable
14438
14439
14440
14441
14442
14443 .section "Incoming SMTP messages" "SECID112"
14444 See also the &'Policy controls'& section above.
14445
14446 .table2
14447 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14448 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14449 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14450 .row &%host_lookup%&                 "host name looked up for these hosts"
14451 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14452 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14453 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14454 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14455 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14456 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14457 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14458 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14459 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14460 .row &%smtp_accept_max_per_connection%& "messages per connection"
14461 .row &%smtp_accept_max_per_host%&    "connections from one host"
14462 .row &%smtp_accept_queue%&           "queue mail if more connections"
14463 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14464                                            connection"
14465 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14466 .row &%smtp_active_hostname%&        "host name to use in messages"
14467 .row &%smtp_banner%&                 "text for welcome banner"
14468 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14469 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14470 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14471 .row &%smtp_etrn_command%&           "what to run for ETRN"
14472 .row &%smtp_etrn_serialize%&         "only one at once"
14473 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14474 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14475 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14476 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14477 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14478 .row &%smtp_receive_timeout%&        "per command or data line"
14479 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14480 .row &%smtp_return_error_details%&   "give detail on rejections"
14481 .endtable
14482
14483
14484
14485 .section "SMTP extensions" "SECID113"
14486 .table2
14487 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14488 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14489 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14490 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14491 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14492 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14493 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14494 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14495 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14496 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14497 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14498 .endtable
14499
14500
14501
14502 .section "Processing messages" "SECID114"
14503 .table2
14504 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14505 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14506 .row &%allow_utf8_domains%&          "in addresses"
14507 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14508                                       words""&"
14509 .row &%delivery_date_remove%&        "from incoming messages"
14510 .row &%envelope_to_remove%&          "from incoming messages"
14511 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14512 .row &%headers_charset%&             "default for translations"
14513 .row &%qualify_domain%&              "default for senders"
14514 .row &%qualify_recipient%&           "default for recipients"
14515 .row &%return_path_remove%&          "from incoming messages"
14516 .row &%strip_excess_angle_brackets%& "in addresses"
14517 .row &%strip_trailing_dot%&          "at end of addresses"
14518 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14519 .endtable
14520
14521
14522
14523 .section "System filter" "SECID115"
14524 .table2
14525 .row &%system_filter%&               "locate system filter"
14526 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14527                                             directory"
14528 .row &%system_filter_file_transport%& "transport for delivery to a file"
14529 .row &%system_filter_group%&         "group for filter running"
14530 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14531 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14532 .row &%system_filter_user%&          "user for filter running"
14533 .endtable
14534
14535
14536
14537 .section "Routing and delivery" "SECID116"
14538 .table2
14539 .row &%disable_ipv6%&                "do no IPv6 processing"
14540 .row &%dns_again_means_nonexist%&    "for broken domains"
14541 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14542 .row &%dns_dnssec_ok%&               "parameter for resolver"
14543 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14544 .row &%dns_retrans%&                 "parameter for resolver"
14545 .row &%dns_retry%&                   "parameter for resolver"
14546 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14547 .row &%dns_use_edns0%&               "parameter for resolver"
14548 .row &%hold_domains%&                "hold delivery for these domains"
14549 .row &%local_interfaces%&            "for routing checks"
14550 .row &%queue_domains%&               "no immediate delivery for these"
14551 .row &%queue_only%&                  "no immediate delivery at all"
14552 .row &%queue_only_file%&             "no immediate delivery if file exists"
14553 .row &%queue_only_load%&             "no immediate delivery if load is high"
14554 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14555 .row &%queue_only_override%&         "allow command line to override"
14556 .row &%queue_run_in_order%&          "order of arrival"
14557 .row &%queue_run_max%&               "of simultaneous queue runners"
14558 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14559 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14560 .row &%remote_sort_domains%&         "order of remote deliveries"
14561 .row &%retry_data_expire%&           "timeout for retry data"
14562 .row &%retry_interval_max%&          "safety net for retry rules"
14563 .endtable
14564
14565
14566
14567 .section "Bounce and warning messages" "SECID117"
14568 .table2
14569 .row &%bounce_message_file%&         "content of bounce"
14570 .row &%bounce_message_text%&         "content of bounce"
14571 .row &%bounce_return_body%&          "include body if returning message"
14572 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14573 .row &%bounce_return_message%&       "include original message in bounce"
14574 .row &%bounce_return_size_limit%&    "limit on returned message"
14575 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14576 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14577 .row &%errors_copy%&                 "copy bounce messages"
14578 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14579 .row &%delay_warning%&               "time schedule"
14580 .row &%delay_warning_condition%&     "condition for warning messages"
14581 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14582 .row &%smtp_return_error_details%&   "give detail on rejections"
14583 .row &%warn_message_file%&           "content of warning message"
14584 .endtable
14585
14586
14587
14588 .section "Alphabetical list of main options" "SECTalomo"
14589 Those options that undergo string expansion before use are marked with
14590 &dagger;.
14591
14592 .option accept_8bitmime main boolean true
14593 .cindex "8BITMIME"
14594 .cindex "8-bit characters"
14595 .cindex "log" "selectors"
14596 .cindex "log" "8BITMIME"
14597 This option causes Exim to send 8BITMIME in its response to an SMTP
14598 EHLO command, and to accept the BODY= parameter on MAIL commands.
14599 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14600 takes no steps to do anything special with messages received by this route.
14601
14602 Historically Exim kept this option off by default, but the maintainers
14603 feel that in today's Internet, this causes more problems than it solves.
14604 It now defaults to true.
14605 A more detailed analysis of the issues is provided by Dan Bernstein:
14606 .display
14607 &url(https://cr.yp.to/smtp/8bitmime.html)
14608 .endd
14609
14610 To log received 8BITMIME status use
14611 .code
14612 log_selector = +8bitmime
14613 .endd
14614
14615 .option acl_not_smtp main string&!! unset
14616 .cindex "&ACL;" "for non-SMTP messages"
14617 .cindex "non-SMTP messages" "ACLs for"
14618 This option defines the ACL that is run when a non-SMTP message has been
14619 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14620 further details.
14621
14622 .option acl_not_smtp_mime main string&!! unset
14623 This option defines the ACL that is run for individual MIME parts of non-SMTP
14624 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14625 SMTP messages.
14626
14627 .option acl_not_smtp_start main string&!! unset
14628 .cindex "&ACL;" "at start of non-SMTP message"
14629 .cindex "non-SMTP messages" "ACLs for"
14630 This option defines the ACL that is run before Exim starts reading a
14631 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14632
14633 .option acl_smtp_auth main string&!! unset
14634 .cindex "&ACL;" "setting up for SMTP commands"
14635 .cindex "AUTH" "ACL for"
14636 This option defines the ACL that is run when an SMTP AUTH command is
14637 received. See chapter &<<CHAPACL>>& for further details.
14638
14639 .option acl_smtp_connect main string&!! unset
14640 .cindex "&ACL;" "on SMTP connection"
14641 This option defines the ACL that is run when an SMTP connection is received.
14642 See chapter &<<CHAPACL>>& for further details.
14643
14644 .option acl_smtp_data main string&!! unset
14645 .cindex "DATA" "ACL for"
14646 This option defines the ACL that is run after an SMTP DATA command has been
14647 processed and the message itself has been received, but before the final
14648 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14649
14650 .option acl_smtp_data_prdr main string&!! accept
14651 .cindex "PRDR" "ACL for"
14652 .cindex "DATA" "PRDR ACL for"
14653 .cindex "&ACL;" "PRDR-related"
14654 .cindex "&ACL;" "per-user data processing"
14655 This option defines the ACL that,
14656 if the PRDR feature has been negotiated,
14657 is run for each recipient after an SMTP DATA command has been
14658 processed and the message itself has been received, but before the
14659 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14660
14661 .option acl_smtp_dkim main string&!! unset
14662 .cindex DKIM "ACL for"
14663 This option defines the ACL that is run for each DKIM signature
14664 (by default, or as specified in the dkim_verify_signers option)
14665 of a received message.
14666 See section &<<SECDKIMVFY>>& for further details.
14667
14668 .option acl_smtp_etrn main string&!! unset
14669 .cindex "ETRN" "ACL for"
14670 This option defines the ACL that is run when an SMTP ETRN command is
14671 received. See chapter &<<CHAPACL>>& for further details.
14672
14673 .option acl_smtp_expn main string&!! unset
14674 .cindex "EXPN" "ACL for"
14675 This option defines the ACL that is run when an SMTP EXPN command is
14676 received. See chapter &<<CHAPACL>>& for further details.
14677
14678 .option acl_smtp_helo main string&!! unset
14679 .cindex "EHLO" "ACL for"
14680 .cindex "HELO" "ACL for"
14681 This option defines the ACL that is run when an SMTP EHLO or HELO
14682 command is received. See chapter &<<CHAPACL>>& for further details.
14683
14684
14685 .option acl_smtp_mail main string&!! unset
14686 .cindex "MAIL" "ACL for"
14687 This option defines the ACL that is run when an SMTP MAIL command is
14688 received. See chapter &<<CHAPACL>>& for further details.
14689
14690 .option acl_smtp_mailauth main string&!! unset
14691 .cindex "AUTH" "on MAIL command"
14692 This option defines the ACL that is run when there is an AUTH parameter on
14693 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14694 &<<CHAPSMTPAUTH>>& for details of authentication.
14695
14696 .option acl_smtp_mime main string&!! unset
14697 .cindex "MIME content scanning" "ACL for"
14698 This option is available when Exim is built with the content-scanning
14699 extension. It defines the ACL that is run for each MIME part in a message. See
14700 section &<<SECTscanmimepart>>& for details.
14701
14702 .option acl_smtp_notquit main string&!! unset
14703 .cindex "not-QUIT, ACL for"
14704 This option defines the ACL that is run when an SMTP session
14705 ends without a QUIT command being received.
14706 See chapter &<<CHAPACL>>& for further details.
14707
14708 .option acl_smtp_predata main string&!! unset
14709 This option defines the ACL that is run when an SMTP DATA command is
14710 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14711 further details.
14712
14713 .option acl_smtp_quit main string&!! unset
14714 .cindex "QUIT, ACL for"
14715 This option defines the ACL that is run when an SMTP QUIT command is
14716 received. See chapter &<<CHAPACL>>& for further details.
14717
14718 .option acl_smtp_rcpt main string&!! unset
14719 .cindex "RCPT" "ACL for"
14720 This option defines the ACL that is run when an SMTP RCPT command is
14721 received. See chapter &<<CHAPACL>>& for further details.
14722
14723 .option acl_smtp_starttls main string&!! unset
14724 .cindex "STARTTLS, ACL for"
14725 This option defines the ACL that is run when an SMTP STARTTLS command is
14726 received. See chapter &<<CHAPACL>>& for further details.
14727
14728 .option acl_smtp_vrfy main string&!! unset
14729 .cindex "VRFY" "ACL for"
14730 This option defines the ACL that is run when an SMTP VRFY command is
14731 received. See chapter &<<CHAPACL>>& for further details.
14732
14733 .option add_environment main "string list" empty
14734 .cindex "environment" "set values"
14735 This option adds individual environment variables that the
14736 currently linked libraries and programs in child processes may use.
14737 Each list element should be of the form &"name=value"&.
14738
14739 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14740
14741 .option admin_groups main "string list&!!" unset
14742 .cindex "admin user"
14743 This option is expanded just once, at the start of Exim's processing. If the
14744 current group or any of the supplementary groups of an Exim caller is in this
14745 colon-separated list, the caller has admin privileges. If all your system
14746 programmers are in a specific group, for example, you can give them all Exim
14747 admin privileges by putting that group in &%admin_groups%&. However, this does
14748 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14749 To permit this, you have to add individuals to the Exim group.
14750
14751 .option allow_domain_literals main boolean false
14752 .cindex "domain literal"
14753 If this option is set, the RFC 2822 domain literal format is permitted in
14754 email addresses. The option is not set by default, because the domain literal
14755 format is not normally required these days, and few people know about it. It
14756 has, however, been exploited by mail abusers.
14757
14758 Unfortunately, it seems that some DNS black list maintainers are using this
14759 format to report black listing to postmasters. If you want to accept messages
14760 addressed to your hosts by IP address, you need to set
14761 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14762 domains (defined in the named domain list &%local_domains%& in the default
14763 configuration). This &"magic string"& matches the domain literal form of all
14764 the local host's IP addresses.
14765
14766
14767 .option allow_mx_to_ip main boolean false
14768 .cindex "MX record" "pointing to IP address"
14769 It appears that more and more DNS zone administrators are breaking the rules
14770 and putting domain names that look like IP addresses on the right hand side of
14771 MX records. Exim follows the rules and rejects this, giving an error message
14772 that explains the misconfiguration. However, some other MTAs support this
14773 practice, so to avoid &"Why can't Exim do this?"& complaints,
14774 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14775 recommended, except when you have no other choice.
14776
14777 .option allow_utf8_domains main boolean false
14778 .cindex "domain" "UTF-8 characters in"
14779 .cindex "UTF-8" "in domain name"
14780 Lots of discussion is going on about internationalized domain names. One
14781 camp is strongly in favour of just using UTF-8 characters, and it seems
14782 that at least two other MTAs permit this.
14783 This option allows Exim users to experiment if they wish.
14784
14785 If it is set true, Exim's domain parsing function allows valid
14786 UTF-8 multicharacters to appear in domain name components, in addition to
14787 letters, digits, and hyphens.
14788
14789 If Exim is built with internationalization support
14790 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14791 this option can be left as default.
14792 Without that,
14793 if you want to look up such domain names in the DNS, you must also
14794 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14795 suitable setting is:
14796 .code
14797 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14798   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14799 .endd
14800 Alternatively, you can just disable this feature by setting
14801 .code
14802 dns_check_names_pattern =
14803 .endd
14804 That is, set the option to an empty string so that no check is done.
14805
14806
14807 .option auth_advertise_hosts main "host list&!!" *
14808 .cindex "authentication" "advertising"
14809 .cindex "AUTH" "advertising"
14810 If any server authentication mechanisms are configured, Exim advertises them in
14811 response to an EHLO command only if the calling host matches this list.
14812 Otherwise, Exim does not advertise AUTH.
14813 Exim does not accept AUTH commands from clients to which it has not
14814 advertised the availability of AUTH. The advertising of individual
14815 authentication mechanisms can be controlled by the use of the
14816 &%server_advertise_condition%& generic authenticator option on the individual
14817 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14818
14819 Certain mail clients (for example, Netscape) require the user to provide a name
14820 and password for authentication if AUTH is advertised, even though it may
14821 not be needed (the host may accept messages from hosts on its local LAN without
14822 authentication, for example). The &%auth_advertise_hosts%& option can be used
14823 to make these clients more friendly by excluding them from the set of hosts to
14824 which Exim advertises AUTH.
14825
14826 .cindex "AUTH" "advertising when encrypted"
14827 If you want to advertise the availability of AUTH only when the connection
14828 is encrypted using TLS, you can make use of the fact that the value of this
14829 option is expanded, with a setting like this:
14830 .code
14831 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14832 .endd
14833 .vindex "&$tls_in_cipher$&"
14834 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14835 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14836 expansion is *, which matches all hosts.
14837
14838
14839 .option auto_thaw main time 0s
14840 .cindex "thawing messages"
14841 .cindex "unfreezing messages"
14842 If this option is set to a time greater than zero, a queue runner will try a
14843 new delivery attempt on any frozen message, other than a bounce message, if
14844 this much time has passed since it was frozen. This may result in the message
14845 being re-frozen if nothing has changed since the last attempt. It is a way of
14846 saying &"keep on trying, even though there are big problems"&.
14847
14848 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14849 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14850 thought to be very useful any more, and its use should probably be avoided.
14851
14852
14853 .option av_scanner main string "see below"
14854 This option is available if Exim is built with the content-scanning extension.
14855 It specifies which anti-virus scanner to use. The default value is:
14856 .code
14857 sophie:/var/run/sophie
14858 .endd
14859 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14860 before use. See section &<<SECTscanvirus>>& for further details.
14861
14862
14863 .option bi_command main string unset
14864 .oindex "&%-bi%&"
14865 This option supplies the name of a command that is run when Exim is called with
14866 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14867 just the command name, it is not a complete command line. If an argument is
14868 required, it must come from the &%-oA%& command line option.
14869
14870
14871 .option bounce_message_file main string unset
14872 .cindex "bounce message" "customizing"
14873 .cindex "customizing" "bounce message"
14874 This option defines a template file containing paragraphs of text to be used
14875 for constructing bounce messages.  Details of the file's contents are given in
14876 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14877
14878
14879 .option bounce_message_text main string unset
14880 When this option is set, its contents are included in the default bounce
14881 message immediately after &"This message was created automatically by mail
14882 delivery software."& It is not used if &%bounce_message_file%& is set.
14883
14884 .option bounce_return_body main boolean true
14885 .cindex "bounce message" "including body"
14886 This option controls whether the body of an incoming message is included in a
14887 bounce message when &%bounce_return_message%& is true. The default setting
14888 causes the entire message, both header and body, to be returned (subject to the
14889 value of &%bounce_return_size_limit%&). If this option is false, only the
14890 message header is included. In the case of a non-SMTP message containing an
14891 error that is detected during reception, only those header lines preceding the
14892 point at which the error was detected are returned.
14893 .cindex "bounce message" "including original"
14894
14895 .option bounce_return_linesize_limit main integer 998
14896 .cindex "size" "of bounce lines, limit"
14897 .cindex "bounce message" "line length limit"
14898 .cindex "limit" "bounce message line length"
14899 This option sets a limit in bytes on the line length of messages
14900 that are returned to senders due to delivery problems,
14901 when &%bounce_return_message%& is true.
14902 The default value corresponds to RFC limits.
14903 If the message being returned has lines longer than this value it is
14904 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14905
14906 The option also applies to bounces returned when an error is detected
14907 during reception of a message.
14908 In this case lines from the original are truncated.
14909
14910 The option does not apply to messages generated by an &(autoreply)& transport.
14911
14912
14913 .option bounce_return_message main boolean true
14914 If this option is set false, none of the original message is included in
14915 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14916 &%bounce_return_body%&.
14917
14918
14919 .option bounce_return_size_limit main integer 100K
14920 .cindex "size" "of bounce, limit"
14921 .cindex "bounce message" "size limit"
14922 .cindex "limit" "bounce message size"
14923 This option sets a limit in bytes on the size of messages that are returned to
14924 senders as part of bounce messages when &%bounce_return_message%& is true. The
14925 limit should be less than the value of the global &%message_size_limit%& and of
14926 any &%message_size_limit%& settings on transports, to allow for the bounce text
14927 that Exim generates. If this option is set to zero there is no limit.
14928
14929 When the body of any message that is to be included in a bounce message is
14930 greater than the limit, it is truncated, and a comment pointing this out is
14931 added at the top. The actual cutoff may be greater than the value given, owing
14932 to the use of buffering for transferring the message in chunks (typically 8K in
14933 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14934 messages.
14935
14936 .option bounce_sender_authentication main string unset
14937 .cindex "bounce message" "sender authentication"
14938 .cindex "authentication" "bounce message"
14939 .cindex "AUTH" "on bounce message"
14940 This option provides an authenticated sender address that is sent with any
14941 bounce messages generated by Exim that are sent over an authenticated SMTP
14942 connection. A typical setting might be:
14943 .code
14944 bounce_sender_authentication = mailer-daemon@my.domain.example
14945 .endd
14946 which would cause bounce messages to be sent using the SMTP command:
14947 .code
14948 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14949 .endd
14950 The value of &%bounce_sender_authentication%& must always be a complete email
14951 address.
14952
14953 .option callout_domain_negative_expire main time 3h
14954 .cindex "caching" "callout timeouts"
14955 .cindex "callout" "caching timeouts"
14956 This option specifies the expiry time for negative callout cache data for a
14957 domain. See section &<<SECTcallver>>& for details of callout verification, and
14958 section &<<SECTcallvercache>>& for details of the caching.
14959
14960
14961 .option callout_domain_positive_expire main time 7d
14962 This option specifies the expiry time for positive callout cache data for a
14963 domain. See section &<<SECTcallver>>& for details of callout verification, and
14964 section &<<SECTcallvercache>>& for details of the caching.
14965
14966
14967 .option callout_negative_expire main time 2h
14968 This option specifies the expiry time for negative callout cache data for an
14969 address. See section &<<SECTcallver>>& for details of callout verification, and
14970 section &<<SECTcallvercache>>& for details of the caching.
14971
14972
14973 .option callout_positive_expire main time 24h
14974 This option specifies the expiry time for positive callout cache data for an
14975 address. See section &<<SECTcallver>>& for details of callout verification, and
14976 section &<<SECTcallvercache>>& for details of the caching.
14977
14978
14979 .option callout_random_local_part main string&!! "see below"
14980 This option defines the &"random"& local part that can be used as part of
14981 callout verification. The default value is
14982 .code
14983 $primary_hostname-$tod_epoch-testing
14984 .endd
14985 See section &<<CALLaddparcall>>& for details of how this value is used.
14986
14987
14988 .option check_log_inodes main integer 100
14989 See &%check_spool_space%& below.
14990
14991
14992 .option check_log_space main integer 10M
14993 See &%check_spool_space%& below.
14994
14995 .oindex "&%check_rfc2047_length%&"
14996 .cindex "RFC 2047" "disabling length check"
14997 .option check_rfc2047_length main boolean true
14998 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14999 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15000 word; strings to be encoded that exceed this length are supposed to use
15001 multiple encoded words. By default, Exim does not recognize encoded words that
15002 exceed the maximum length. However, it seems that some software, in violation
15003 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15004 set false, Exim recognizes encoded words of any length.
15005
15006
15007 .option check_spool_inodes main integer 100
15008 See &%check_spool_space%& below.
15009
15010
15011 .option check_spool_space main integer 10M
15012 .cindex "checking disk space"
15013 .cindex "disk space, checking"
15014 .cindex "spool directory" "checking space"
15015 The four &%check_...%& options allow for checking of disk resources before a
15016 message is accepted.
15017
15018 .vindex "&$log_inodes$&"
15019 .vindex "&$log_space$&"
15020 .vindex "&$spool_inodes$&"
15021 .vindex "&$spool_space$&"
15022 When any of these options are nonzero, they apply to all incoming messages. If you
15023 want to apply different checks to different kinds of message, you can do so by
15024 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15025 &$spool_space$& in an ACL with appropriate additional conditions.
15026
15027
15028 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15029 either value is greater than zero, for example:
15030 .code
15031 check_spool_space = 100M
15032 check_spool_inodes = 100
15033 .endd
15034 The spool partition is the one that contains the directory defined by
15035 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15036 transit.
15037
15038 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15039 files are written if either is greater than zero. These should be set only if
15040 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15041
15042 If there is less space or fewer inodes than requested, Exim refuses to accept
15043 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15044 error response to the MAIL command. If ESMTP is in use and there was a
15045 SIZE parameter on the MAIL command, its value is added to the
15046 &%check_spool_space%& value, and the check is performed even if
15047 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15048
15049 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15050 number of kilobytes (though specified in bytes).
15051 If a non-multiple of 1024 is specified, it is rounded up.
15052
15053 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15054 failure a message is written to stderr and Exim exits with a non-zero code, as
15055 it obviously cannot send an error message of any kind.
15056
15057 There is a slight performance penalty for these checks.
15058 Versions of Exim preceding 4.88 had these disabled by default;
15059 high-rate installations confident they will never run out of resources
15060 may wish to deliberately disable them.
15061
15062 .option chunking_advertise_hosts main "host list&!!" *
15063 .cindex CHUNKING advertisement
15064 .cindex "RFC 3030" "CHUNKING"
15065 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15066 these hosts.
15067 Hosts may use the BDAT command as an alternate to DATA.
15068
15069 .option commandline_checks_require_admin main boolean &`false`&
15070 .cindex "restricting access to features"
15071 This option restricts various basic checking features to require an
15072 administrative user.
15073 This affects most of the &%-b*%& options, such as &%-be%&.
15074
15075 .option debug_store main boolean &`false`&
15076 .cindex debugging "memory corruption"
15077 .cindex memory debugging
15078 This option, when true, enables extra checking in Exim's internal memory
15079 management.  For use when a memory corruption issue is being investigated,
15080 it should normally be left as default.
15081
15082 .option daemon_smtp_ports main string &`smtp`&
15083 .cindex "port" "for daemon"
15084 .cindex "TCP/IP" "setting listening ports"
15085 This option specifies one or more default SMTP ports on which the Exim daemon
15086 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15087 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15088
15089 .option daemon_startup_retries main integer 9
15090 .cindex "daemon startup, retrying"
15091 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15092 the daemon at startup when it cannot immediately bind a listening socket
15093 (typically because the socket is already in use): &%daemon_startup_retries%&
15094 defines the number of retries after the first failure, and
15095 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15096
15097 .option daemon_startup_sleep main time 30s
15098 See &%daemon_startup_retries%&.
15099
15100 .option delay_warning main "time list" 24h
15101 .cindex "warning of delay"
15102 .cindex "delay warning, specifying"
15103 .cindex "queue" "delay warning"
15104 When a message is delayed, Exim sends a warning message to the sender at
15105 intervals specified by this option. The data is a colon-separated list of times
15106 after which to send warning messages. If the value of the option is an empty
15107 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15108 message has been in the queue for longer than the last time, the last interval
15109 between the times is used to compute subsequent warning times. For example,
15110 with
15111 .code
15112 delay_warning = 4h:8h:24h
15113 .endd
15114 the first message is sent after 4 hours, the second after 8 hours, and
15115 the third one after 24 hours. After that, messages are sent every 16 hours,
15116 because that is the interval between the last two times on the list. If you set
15117 just one time, it specifies the repeat interval. For example, with:
15118 .code
15119 delay_warning = 6h
15120 .endd
15121 messages are repeated every six hours. To stop warnings after a given time, set
15122 a very large time at the end of the list. For example:
15123 .code
15124 delay_warning = 2h:12h:99d
15125 .endd
15126 Note that the option is only evaluated at the time a delivery attempt fails,
15127 which depends on retry and queue-runner configuration.
15128 Typically retries will be configured more frequently than warning messages.
15129
15130 .option delay_warning_condition main string&!! "see below"
15131 .vindex "&$domain$&"
15132 The string is expanded at the time a warning message might be sent. If all the
15133 deferred addresses have the same domain, it is set in &$domain$& during the
15134 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15135 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15136 &"false"& (the comparison being done caselessly) then the warning message is
15137 not sent. The default is:
15138 .code
15139 delay_warning_condition = ${if or {\
15140   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15141   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15142   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15143   } {no}{yes}}
15144 .endd
15145 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15146 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15147 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15148 &"auto-replied"& in an &'Auto-Submitted:'& header.
15149
15150 .option deliver_drop_privilege main boolean false
15151 .cindex "unprivileged delivery"
15152 .cindex "delivery" "unprivileged"
15153 If this option is set true, Exim drops its root privilege at the start of a
15154 delivery process, and runs as the Exim user throughout. This severely restricts
15155 the kinds of local delivery that are possible, but is viable in certain types
15156 of configuration. There is a discussion about the use of root privilege in
15157 chapter &<<CHAPsecurity>>&.
15158
15159 .option deliver_queue_load_max main fixed-point unset
15160 .cindex "load average"
15161 .cindex "queue runner" "abandoning"
15162 When this option is set, a queue run is abandoned if the system load average
15163 becomes greater than the value of the option. The option has no effect on
15164 ancient operating systems on which Exim cannot determine the load average.
15165 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15166
15167
15168 .option delivery_date_remove main boolean true
15169 .cindex "&'Delivery-date:'& header line"
15170 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15171 message when it is delivered, in exactly the same way as &'Return-path:'& is
15172 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15173 should not be present in incoming messages, and this option causes them to be
15174 removed at the time the message is received, to avoid any problems that might
15175 occur when a delivered message is subsequently sent on to some other recipient.
15176
15177 .option disable_fsync main boolean false
15178 .cindex "&[fsync()]&, disabling"
15179 This option is available only if Exim was built with the compile-time option
15180 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15181 a runtime configuration generates an &"unknown option"& error. You should not
15182 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15183 really, really, really understand what you are doing. &'No pre-compiled
15184 distributions of Exim should ever make this option available.'&
15185
15186 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15187 updated files' data to be written to disc before continuing. Unexpected events
15188 such as crashes and power outages may cause data to be lost or scrambled.
15189 Here be Dragons. &*Beware.*&
15190
15191
15192 .option disable_ipv6 main boolean false
15193 .cindex "IPv6" "disabling"
15194 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15195 activities take place. AAAA records are never looked up, and any IPv6 addresses
15196 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15197 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15198 to handle IPv6 literal addresses.
15199
15200
15201 .new
15202 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15203 .cindex DKIM "selecting signature algorithms"
15204 This option gives a list of hash types which are acceptable in signatures,
15205 .wen
15206 and an order of processing.
15207 Signatures with algorithms not in the list will be ignored.
15208
15209 Acceptable values include:
15210 .code
15211 sha1
15212 sha256
15213 sha512
15214 .endd
15215
15216 Note that the acceptance of sha1 violates RFC 8301.
15217
15218 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15219 This option gives a list of key types which are acceptable in signatures,
15220 and an order of processing.
15221 Signatures with algorithms not in the list will be ignored.
15222
15223 .option dkim_verify_minimal main boolean false
15224 If set to true, verification of signatures will terminate after the
15225 first success.
15226
15227 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15228 .cindex DKIM "controlling calls to the ACL"
15229 This option gives a list of DKIM domains for which the DKIM ACL is run.
15230 It is expanded after the message is received; by default it runs
15231 the ACL once for each signature in the message.
15232 See section &<<SECDKIMVFY>>&.
15233
15234
15235 .option dns_again_means_nonexist main "domain list&!!" unset
15236 .cindex "DNS" "&""try again""& response; overriding"
15237 DNS lookups give a &"try again"& response for the DNS errors
15238 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15239 keep trying to deliver a message, or to give repeated temporary errors to
15240 incoming mail. Sometimes the effect is caused by a badly set up name server and
15241 may persist for a long time. If a domain which exhibits this problem matches
15242 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15243 This option should be used with care. You can make it apply to reverse lookups
15244 by a setting such as this:
15245 .code
15246 dns_again_means_nonexist = *.in-addr.arpa
15247 .endd
15248 This option applies to all DNS lookups that Exim does. It also applies when the
15249 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15250 since these are most likely to be caused by DNS lookup problems. The
15251 &(dnslookup)& router has some options of its own for controlling what happens
15252 when lookups for MX or SRV records give temporary errors. These more specific
15253 options are applied after this global option.
15254
15255 .option dns_check_names_pattern main string "see below"
15256 .cindex "DNS" "pre-check of name syntax"
15257 When this option is set to a non-empty string, it causes Exim to check domain
15258 names for characters that are not allowed in host names before handing them to
15259 the DNS resolver, because some resolvers give temporary errors for names that
15260 contain unusual characters. If a domain name contains any unwanted characters,
15261 a &"not found"& result is forced, and the resolver is not called. The check is
15262 done by matching the domain name against a regular expression, which is the
15263 value of this option. The default pattern is
15264 .code
15265 dns_check_names_pattern = \
15266   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15267 .endd
15268 which permits only letters, digits, slashes, and hyphens in components, but
15269 they must start and end with a letter or digit. Slashes are not, in fact,
15270 permitted in host names, but they are found in certain NS records (which can be
15271 accessed in Exim by using a &%dnsdb%& lookup). If you set
15272 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15273 empty string.
15274
15275 .option dns_csa_search_limit main integer 5
15276 This option controls the depth of parental searching for CSA SRV records in the
15277 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15278
15279 .option dns_csa_use_reverse main boolean true
15280 This option controls whether or not an IP address, given as a CSA domain, is
15281 reversed and looked up in the reverse DNS, as described in more detail in
15282 section &<<SECTverifyCSA>>&.
15283
15284 .option dns_cname_loops main integer 1
15285 .cindex DNS "CNAME following"
15286 This option controls the following of CNAME chains, needed if the resolver does
15287 not do it internally.
15288 As of 2018 most should, and the default can be left.
15289 If you have an ancient one, a value of 10 is likely needed.
15290
15291 The default value of one CNAME-follow is needed
15292 thanks to the observed return for an MX request,
15293 given no MX presence but a CNAME to an A, of the CNAME.
15294
15295
15296 .option dns_dnssec_ok main integer -1
15297 .cindex "DNS" "resolver options"
15298 .cindex "DNS" "DNSSEC"
15299 If this option is set to a non-negative number then Exim will initialise the
15300 DNS resolver library to either use or not use DNSSEC, overriding the system
15301 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15302
15303 If the resolver library does not support DNSSEC then this option has no effect.
15304
15305
15306 .option dns_ipv4_lookup main "domain list&!!" unset
15307 .cindex "IPv6" "DNS lookup for AAAA records"
15308 .cindex "DNS" "IPv6 lookup for AAAA records"
15309 .cindex DNS "IPv6 disabling"
15310 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15311 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15312 (A records) when trying to find IP addresses for hosts, unless the host's
15313 domain matches this list.
15314
15315 This is a fudge to help with name servers that give big delays or otherwise do
15316 not work for the AAAA record type. In due course, when the world's name
15317 servers have all been upgraded, there should be no need for this option.
15318 Note that all lookups, including those done for verification, are affected;
15319 this will result in verify failure for IPv6 connections or ones using names
15320 only valid for IPv6 addresses.
15321
15322
15323 .option dns_retrans main time 0s
15324 .cindex "DNS" "resolver options"
15325 .cindex timeout "dns lookup"
15326 .cindex "DNS" timeout
15327 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15328 retransmission and retry parameters for DNS lookups. Values of zero (the
15329 defaults) leave the system default settings unchanged. The first value is the
15330 time between retries, and the second is the number of retries. It isn't
15331 totally clear exactly how these settings affect the total time a DNS lookup may
15332 take. I haven't found any documentation about timeouts on DNS lookups; these
15333 parameter values are available in the external resolver interface structure,
15334 but nowhere does it seem to describe how they are used or what you might want
15335 to set in them.
15336 See also the &%slow_lookup_log%& option.
15337
15338
15339 .option dns_retry main integer 0
15340 See &%dns_retrans%& above.
15341
15342
15343 .option dns_trust_aa main "domain list&!!" unset
15344 .cindex "DNS" "resolver options"
15345 .cindex "DNS" "DNSSEC"
15346 If this option is set then lookup results marked with the AA bit
15347 (Authoritative Answer) are trusted the same way as if they were
15348 DNSSEC-verified. The authority section's name of the answer must
15349 match with this expanded domain list.
15350
15351 Use this option only if you talk directly to a resolver that is
15352 authoritative for some zones and does not set the AD (Authentic Data)
15353 bit in the answer. Some DNS servers may have an configuration option to
15354 mark the answers from their own zones as verified (they set the AD bit).
15355 Others do not have this option. It is considered as poor practice using
15356 a resolver that is an authoritative server for some zones.
15357
15358 Use this option only if you really have to (e.g. if you want
15359 to use DANE for remote delivery to a server that is listed in the DNS
15360 zones that your resolver is authoritative for).
15361
15362 If the DNS answer packet has the AA bit set and contains resource record
15363 in the answer section, the name of the first NS record appearing in the
15364 authority section is compared against the list. If the answer packet is
15365 authoritative but the answer section is empty, the name of the first SOA
15366 record in the authoritative section is used instead.
15367
15368 .cindex "DNS" "resolver options"
15369 .option dns_use_edns0 main integer -1
15370 .cindex "DNS" "resolver options"
15371 .cindex "DNS" "EDNS0"
15372 .cindex "DNS" "OpenBSD
15373 If this option is set to a non-negative number then Exim will initialise the
15374 DNS resolver library to either use or not use EDNS0 extensions, overriding
15375 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15376 on.
15377
15378 If the resolver library does not support EDNS0 then this option has no effect.
15379
15380 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15381 means that DNSSEC will not work with Exim on that platform either, unless Exim
15382 is linked against an alternative DNS client library.
15383
15384
15385 .option drop_cr main boolean false
15386 This is an obsolete option that is now a no-op. It used to affect the way Exim
15387 handled CR and LF characters in incoming messages. What happens now is
15388 described in section &<<SECTlineendings>>&.
15389
15390 .option dsn_advertise_hosts main "host list&!!" unset
15391 .cindex "bounce messages" "success"
15392 .cindex "DSN" "success"
15393 .cindex "Delivery Status Notification" "success"
15394 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15395 and accepted from, these hosts.
15396 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15397 and RET and ORCPT options on MAIL FROM commands.
15398 A NOTIFY=SUCCESS option requests success-DSN messages.
15399 A NOTIFY= option with no argument requests that no delay or failure DSNs
15400 are sent.
15401
15402 .option dsn_from main "string&!!" "see below"
15403 .cindex "&'From:'& header line" "in bounces"
15404 .cindex "bounce messages" "&'From:'& line, specifying"
15405 This option can be used to vary the contents of &'From:'& header lines in
15406 bounces and other automatically generated messages (&"Delivery Status
15407 Notifications"& &-- hence the name of the option). The default setting is:
15408 .code
15409 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15410 .endd
15411 The value is expanded every time it is needed. If the expansion fails, a
15412 panic is logged, and the default value is used.
15413
15414 .option envelope_to_remove main boolean true
15415 .cindex "&'Envelope-to:'& header line"
15416 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15417 message when it is delivered, in exactly the same way as &'Return-path:'& is
15418 handled. &'Envelope-to:'& records the original recipient address from the
15419 message's envelope that caused the delivery to happen. Such headers should not
15420 be present in incoming messages, and this option causes them to be removed at
15421 the time the message is received, to avoid any problems that might occur when a
15422 delivered message is subsequently sent on to some other recipient.
15423
15424
15425 .option errors_copy main "string list&!!" unset
15426 .cindex "bounce message" "copy to other address"
15427 .cindex "copy of bounce message"
15428 Setting this option causes Exim to send bcc copies of bounce messages that it
15429 generates to other addresses. &*Note*&: This does not apply to bounce messages
15430 coming from elsewhere. The value of the option is a colon-separated list of
15431 items. Each item consists of a pattern, terminated by white space, followed by
15432 a comma-separated list of email addresses. If a pattern contains spaces, it
15433 must be enclosed in double quotes.
15434
15435 Each pattern is processed in the same way as a single item in an address list
15436 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15437 the bounce message, the message is copied to the addresses on the list. The
15438 items are scanned in order, and once a matching one is found, no further items
15439 are examined. For example:
15440 .code
15441 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15442               rqps@mydomain   hostmaster@mydomain.example,\
15443                               postmaster@mydomain.example
15444 .endd
15445 .vindex "&$domain$&"
15446 .vindex "&$local_part$&"
15447 The address list is expanded before use. The expansion variables &$local_part$&
15448 and &$domain$& are set from the original recipient of the error message, and if
15449 there was any wildcard matching in the pattern, the expansion
15450 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15451 variables &$0$&, &$1$&, etc. are set in the normal way.
15452
15453
15454 .option errors_reply_to main string unset
15455 .cindex "bounce message" "&'Reply-to:'& in"
15456 By default, Exim's bounce and delivery warning messages contain the header line
15457 .display
15458 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15459 .endd
15460 .oindex &%quota_warn_message%&
15461 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15462 A warning message that is generated by the &%quota_warn_message%& option in an
15463 &(appendfile)& transport may contain its own &'From:'& header line that
15464 overrides the default.
15465
15466 Experience shows that people reply to bounce messages. If the
15467 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15468 and warning messages. For example:
15469 .code
15470 errors_reply_to = postmaster@my.domain.example
15471 .endd
15472 The value of the option is not expanded. It must specify a valid RFC 2822
15473 address. However, if a warning message that is generated by the
15474 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15475 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15476 not used.
15477
15478
15479 .option event_action main string&!! unset
15480 .cindex events
15481 This option declares a string to be expanded for Exim's events mechanism.
15482 For details see chapter &<<CHAPevents>>&.
15483
15484
15485 .option exim_group main string "compile-time configured"
15486 .cindex "gid (group id)" "Exim's own"
15487 .cindex "Exim group"
15488 This option changes the gid under which Exim runs when it gives up root
15489 privilege. The default value is compiled into the binary. The value of this
15490 option is used only when &%exim_user%& is also set. Unless it consists entirely
15491 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15492 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15493 security issues.
15494
15495
15496 .option exim_path main string "see below"
15497 .cindex "Exim binary, path name"
15498 This option specifies the path name of the Exim binary, which is used when Exim
15499 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15500 the directory configured at compile time by the BIN_DIRECTORY setting. It
15501 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15502 other place.
15503 &*Warning*&: Do not use a macro to define the value of this option, because
15504 you will break those Exim utilities that scan the configuration file to find
15505 where the binary is. (They then use the &%-bP%& option to extract option
15506 settings such as the value of &%spool_directory%&.)
15507
15508
15509 .option exim_user main string "compile-time configured"
15510 .cindex "uid (user id)" "Exim's own"
15511 .cindex "Exim user"
15512 This option changes the uid under which Exim runs when it gives up root
15513 privilege. The default value is compiled into the binary. Ownership of the run
15514 time configuration file and the use of the &%-C%& and &%-D%& command line
15515 options is checked against the values in the binary, not what is set here.
15516
15517 Unless it consists entirely of digits, the string is looked up using
15518 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15519 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15520 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15521
15522
15523 .option exim_version main string "current version"
15524 .cindex "Exim version"
15525 .cindex customizing "version number"
15526 .cindex "version number of Exim" override
15527 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15528 various places.  Use with care; this may fool stupid security scanners.
15529
15530
15531 .option extra_local_interfaces main "string list" unset
15532 This option defines network interfaces that are to be considered local when
15533 routing, but which are not used for listening by the daemon. See section
15534 &<<SECTreclocipadd>>& for details.
15535
15536
15537 . Allow this long option name to split; give it unsplit as a fifth argument
15538 . for the automatic .oindex that is generated by .option.
15539
15540 .option "extract_addresses_remove_arguments" main boolean true &&&
15541          extract_addresses_remove_arguments
15542 .oindex "&%-t%&"
15543 .cindex "command line" "addresses with &%-t%&"
15544 .cindex "Sendmail compatibility" "&%-t%& option"
15545 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15546 are present on the command line when the &%-t%& option is used to build an
15547 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15548 line addresses are removed from the recipients list. This is also how Smail
15549 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15550 command line addresses are added to those obtained from the header lines. When
15551 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15552 argument headers. If it is set false, Exim adds rather than removes argument
15553 addresses.
15554
15555
15556 .option finduser_retries main integer 0
15557 .cindex "NIS, retrying user lookups"
15558 On systems running NIS or other schemes in which user and group information is
15559 distributed from a remote system, there can be times when &[getpwnam()]& and
15560 related functions fail, even when given valid data, because things time out.
15561 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15562 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15563 many extra times to find a user or a group, waiting for one second between
15564 retries.
15565
15566 .cindex "&_/etc/passwd_&" "multiple reading of"
15567 You should not set this option greater than zero if your user information is in
15568 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15569 search the file multiple times for non-existent users, and also cause delay.
15570
15571
15572
15573 .option freeze_tell main "string list, comma separated" unset
15574 .cindex "freezing messages" "sending a message when freezing"
15575 On encountering certain errors, or when configured to do so in a system filter,
15576 ACL, or special router, Exim freezes a message. This means that no further
15577 delivery attempts take place until an administrator thaws the message, or the
15578 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15579 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15580 warning message whenever it freezes something, unless the message it is
15581 freezing is a locally-generated bounce message. (Without this exception there
15582 is the possibility of looping.) The warning message is sent to the addresses
15583 supplied as the comma-separated value of this option. If several of the
15584 message's addresses cause freezing, only a single message is sent. If the
15585 freezing was automatic, the reason(s) for freezing can be found in the message
15586 log. If you configure freezing in a filter or ACL, you must arrange for any
15587 logging that you require.
15588
15589
15590 .option gecos_name main string&!! unset
15591 .cindex "HP-UX"
15592 .cindex "&""gecos""& field, parsing"
15593 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15594 password file to hold other information in addition to users' real names. Exim
15595 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15596 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15597 of the field are used unchanged, except that, if an ampersand is encountered,
15598 it is replaced by the user's login name with the first character forced to
15599 upper case, since this is a convention that is observed on many systems.
15600
15601 When these options are set, &%gecos_pattern%& is treated as a regular
15602 expression that is to be applied to the field (again with && replaced by the
15603 login name), and if it matches, &%gecos_name%& is expanded and used as the
15604 user's name.
15605
15606 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15607 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15608 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15609 name terminates at the first comma, the following can be used:
15610 .code
15611 gecos_pattern = ([^,]*)
15612 gecos_name = $1
15613 .endd
15614
15615 .option gecos_pattern main string unset
15616 See &%gecos_name%& above.
15617
15618
15619 .option gnutls_compat_mode main boolean unset
15620 This option controls whether GnuTLS is used in compatibility mode in an Exim
15621 server. This reduces security slightly, but improves interworking with older
15622 implementations of TLS.
15623
15624
15625 .option gnutls_allow_auto_pkcs11 main boolean unset
15626 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15627 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15628
15629 See
15630 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15631 for documentation.
15632
15633
15634
15635 .option headers_charset main string "see below"
15636 This option sets a default character set for translating from encoded MIME
15637 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15638 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15639 ultimate default is ISO-8859-1. For more details see the description of header
15640 insertions in section &<<SECTexpansionitems>>&.
15641
15642
15643
15644 .option header_maxsize main integer "see below"
15645 .cindex "header section" "maximum size of"
15646 .cindex "limit" "size of message header section"
15647 This option controls the overall maximum size of a message's header
15648 section. The default is the value of HEADER_MAXSIZE in
15649 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15650 sections are rejected.
15651
15652
15653 .option header_line_maxsize main integer 0
15654 .cindex "header lines" "maximum size of"
15655 .cindex "limit" "size of one header line"
15656 This option limits the length of any individual header line in a message, after
15657 all the continuations have been joined together. Messages with individual
15658 header lines that are longer than the limit are rejected. The default value of
15659 zero means &"no limit"&.
15660
15661
15662
15663
15664 .option helo_accept_junk_hosts main "host list&!!" unset
15665 .cindex "HELO" "accepting junk data"
15666 .cindex "EHLO" "accepting junk data"
15667 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15668 mail, and gives an error response for invalid data. Unfortunately, there are
15669 some SMTP clients that send syntactic junk. They can be accommodated by setting
15670 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15671 if you want to do semantic checking.
15672 See also &%helo_allow_chars%& for a way of extending the permitted character
15673 set.
15674
15675
15676 .option helo_allow_chars main string unset
15677 .cindex "HELO" "underscores in"
15678 .cindex "EHLO" "underscores in"
15679 .cindex "underscore in EHLO/HELO"
15680 This option can be set to a string of rogue characters that are permitted in
15681 all EHLO and HELO names in addition to the standard letters, digits,
15682 hyphens, and dots. If you really must allow underscores, you can set
15683 .code
15684 helo_allow_chars = _
15685 .endd
15686 Note that the value is one string, not a list.
15687
15688
15689 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15690 .cindex "HELO" "forcing reverse lookup"
15691 .cindex "EHLO" "forcing reverse lookup"
15692 If the domain given by a client in a HELO or EHLO command matches this
15693 list, a reverse lookup is done in order to establish the host's true name. The
15694 default forces a lookup if the client host gives the server's name or any of
15695 its IP addresses (in brackets), something that broken clients have been seen to
15696 do.
15697
15698
15699 .option helo_try_verify_hosts main "host list&!!" unset
15700 .cindex "HELO verifying" "optional"
15701 .cindex "EHLO" "verifying, optional"
15702 By default, Exim just checks the syntax of HELO and EHLO commands (see
15703 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15704 to do more extensive checking of the data supplied by these commands. The ACL
15705 condition &`verify = helo`& is provided to make this possible.
15706 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15707 to force the check to occur. From release 4.53 onwards, this is no longer
15708 necessary. If the check has not been done before &`verify = helo`& is
15709 encountered, it is done at that time. Consequently, this option is obsolete.
15710 Its specification is retained here for backwards compatibility.
15711
15712 When an EHLO or HELO command is received, if the calling host matches
15713 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15714 EHLO command either:
15715
15716 .ilist
15717 is an IP literal matching the calling address of the host, or
15718 .next
15719 .cindex "DNS" "reverse lookup"
15720 .cindex "reverse DNS lookup"
15721 matches the host name that Exim obtains by doing a reverse lookup of the
15722 calling host address, or
15723 .next
15724 when looked up in DNS yields the calling host address.
15725 .endlist
15726
15727 However, the EHLO or HELO command is not rejected if any of the checks
15728 fail. Processing continues, but the result of the check is remembered, and can
15729 be detected later in an ACL by the &`verify = helo`& condition.
15730
15731 If DNS was used for successful verification, the variable
15732 .cindex "DNS" "DNSSEC"
15733 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15734
15735 .option helo_verify_hosts main "host list&!!" unset
15736 .cindex "HELO verifying" "mandatory"
15737 .cindex "EHLO" "verifying, mandatory"
15738 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15739 backwards compatibility. For hosts that match this option, Exim checks the host
15740 name given in the HELO or EHLO in the same way as for
15741 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15742 rejected with a 550 error, and entries are written to the main and reject logs.
15743 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15744 error.
15745
15746 .option hold_domains main "domain list&!!" unset
15747 .cindex "domain" "delaying delivery"
15748 .cindex "delivery" "delaying certain domains"
15749 This option allows mail for particular domains to be held in the queue
15750 manually. The option is overridden if a message delivery is forced with the
15751 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15752 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15753 item in &%hold_domains%&, no routing or delivery for that address is done, and
15754 it is deferred every time the message is looked at.
15755
15756 This option is intended as a temporary operational measure for delaying the
15757 delivery of mail while some problem is being sorted out, or some new
15758 configuration tested. If you just want to delay the processing of some
15759 domains until a queue run occurs, you should use &%queue_domains%& or
15760 &%queue_smtp_domains%&, not &%hold_domains%&.
15761
15762 A setting of &%hold_domains%& does not override Exim's code for removing
15763 messages from the queue if they have been there longer than the longest retry
15764 time in any retry rule. If you want to hold messages for longer than the normal
15765 retry times, insert a dummy retry rule with a long retry time.
15766
15767
15768 .option host_lookup main "host list&!!" unset
15769 .cindex "host name" "lookup, forcing"
15770 Exim does not look up the name of a calling host from its IP address unless it
15771 is required to compare against some host list, or the host matches
15772 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15773 option (which normally contains IP addresses rather than host names). The
15774 default configuration file contains
15775 .code
15776 host_lookup = *
15777 .endd
15778 which causes a lookup to happen for all hosts. If the expense of these lookups
15779 is felt to be too great, the setting can be changed or removed.
15780
15781 After a successful reverse lookup, Exim does a forward lookup on the name it
15782 has obtained, to verify that it yields the IP address that it started with. If
15783 this check fails, Exim behaves as if the name lookup failed.
15784
15785 .vindex "&$host_lookup_failed$&"
15786 .vindex "&$sender_host_name$&"
15787 After any kind of failure, the host name (in &$sender_host_name$&) remains
15788 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15789 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15790 &`verify = reverse_host_lookup`& in ACLs.
15791
15792
15793 .option host_lookup_order main "string list" &`bydns:byaddr`&
15794 This option specifies the order of different lookup methods when Exim is trying
15795 to find a host name from an IP address. The default is to do a DNS lookup
15796 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15797 if that fails. You can change the order of these lookups, or omit one entirely,
15798 if you want.
15799
15800 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15801 multiple PTR records in the DNS and the IP address is not listed in
15802 &_/etc/hosts_&. Different operating systems give different results in this
15803 case. That is why the default tries a DNS lookup first.
15804
15805
15806
15807 .option host_reject_connection main "host list&!!" unset
15808 .cindex "host" "rejecting connections from"
15809 If this option is set, incoming SMTP calls from the hosts listed are rejected
15810 as soon as the connection is made.
15811 This option is obsolete, and retained only for backward compatibility, because
15812 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15813 connections immediately.
15814
15815 The ability to give an immediate rejection (either by this option or using an
15816 ACL) is provided for use in unusual cases. Many hosts will just try again,
15817 sometimes without much delay. Normally, it is better to use an ACL to reject
15818 incoming messages at a later stage, such as after RCPT commands. See
15819 chapter &<<CHAPACL>>&.
15820
15821
15822 .option hosts_connection_nolog main "host list&!!" unset
15823 .cindex "host" "not logging connections from"
15824 This option defines a list of hosts for which connection logging does not
15825 happen, even though the &%smtp_connection%& log selector is set. For example,
15826 you might want not to log SMTP connections from local processes, or from
15827 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15828 the daemon; you should therefore strive to restrict its value to a short inline
15829 list of IP addresses and networks. To disable logging SMTP connections from
15830 local processes, you must create a host list with an empty item. For example:
15831 .code
15832 hosts_connection_nolog = :
15833 .endd
15834 If the &%smtp_connection%& log selector is not set, this option has no effect.
15835
15836
15837
15838 .option hosts_proxy main "host list&!!" unset
15839 .cindex proxy "proxy protocol"
15840 This option enables use of Proxy Protocol proxies for incoming
15841 connections.  For details see section &<<SECTproxyInbound>>&.
15842
15843
15844 .option hosts_treat_as_local main "domain list&!!" unset
15845 .cindex "local host" "domains treated as"
15846 .cindex "host" "treated as local"
15847 If this option is set, any host names that match the domain list are treated as
15848 if they were the local host when Exim is scanning host lists obtained from MX
15849 records
15850 or other sources. Note that the value of this option is a domain list, not a
15851 host list, because it is always used to check host names, not IP addresses.
15852
15853 This option also applies when Exim is matching the special items
15854 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15855 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15856 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15857 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15858 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15859 interfaces and recognizing the local host.
15860
15861
15862 .option ibase_servers main "string list" unset
15863 .cindex "InterBase" "server list"
15864 This option provides a list of InterBase servers and associated connection data,
15865 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15866 The option is available only if Exim has been built with InterBase support.
15867
15868
15869
15870 .option ignore_bounce_errors_after main time 10w
15871 .cindex "bounce message" "discarding"
15872 .cindex "discarding bounce message"
15873 This option affects the processing of bounce messages that cannot be delivered,
15874 that is, those that suffer a permanent delivery failure. (Bounce messages that
15875 suffer temporary delivery failures are of course retried in the usual way.)
15876
15877 After a permanent delivery failure, bounce messages are frozen,
15878 because there is no sender to whom they can be returned. When a frozen bounce
15879 message has been in the queue for more than the given time, it is unfrozen at
15880 the next queue run, and a further delivery is attempted. If delivery fails
15881 again, the bounce message is discarded. This makes it possible to keep failed
15882 bounce messages around for a shorter time than the normal maximum retry time
15883 for frozen messages. For example,
15884 .code
15885 ignore_bounce_errors_after = 12h
15886 .endd
15887 retries failed bounce message deliveries after 12 hours, discarding any further
15888 failures. If the value of this option is set to a zero time period, bounce
15889 failures are discarded immediately. Setting a very long time (as in the default
15890 value) has the effect of disabling this option. For ways of automatically
15891 dealing with other kinds of frozen message, see &%auto_thaw%& and
15892 &%timeout_frozen_after%&.
15893
15894
15895 .option ignore_fromline_hosts main "host list&!!" unset
15896 .cindex "&""From""& line"
15897 .cindex "UUCP" "&""From""& line"
15898 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15899 the headers of a message. By default this is treated as the start of the
15900 message's body, which means that any following headers are not recognized as
15901 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15902 match those hosts that insist on sending it. If the sender is actually a local
15903 process rather than a remote host, and is using &%-bs%& to inject the messages,
15904 &%ignore_fromline_local%& must be set to achieve this effect.
15905
15906
15907 .option ignore_fromline_local main boolean false
15908 See &%ignore_fromline_hosts%& above.
15909
15910 .option keep_environment main "string list" unset
15911 .cindex "environment" "values from"
15912 This option contains a string list of environment variables to keep.
15913 You have to trust these variables or you have to be sure that
15914 these variables do not impose any security risk. Keep in mind that
15915 during the startup phase Exim is running with an effective UID 0 in most
15916 installations. As the default value is an empty list, the default
15917 environment for using libraries, running embedded Perl code, or running
15918 external binaries is empty, and does not not even contain PATH or HOME.
15919
15920 Actually the list is interpreted as a list of patterns
15921 (&<<SECTlistexpand>>&), except that it is not expanded first.
15922
15923 WARNING: Macro substitution is still done first, so having a macro
15924 FOO and having FOO_HOME in your &%keep_environment%& option may have
15925 unexpected results. You may work around this using a regular expression
15926 that does not match the macro name: ^[F]OO_HOME$.
15927
15928 Current versions of Exim issue a warning during startup if you do not mention
15929 &%keep_environment%& in your runtime configuration file and if your
15930 current environment is not empty. Future versions may not issue that warning
15931 anymore.
15932
15933 See the &%add_environment%& main config option for a way to set
15934 environment variables to a fixed value.  The environment for &(pipe)&
15935 transports is handled separately, see section &<<SECTpipeenv>>& for
15936 details.
15937
15938
15939 .option keep_malformed main time 4d
15940 This option specifies the length of time to keep messages whose spool files
15941 have been corrupted in some way. This should, of course, never happen. At the
15942 next attempt to deliver such a message, it gets removed. The incident is
15943 logged.
15944
15945
15946 .option ldap_ca_cert_dir main string unset
15947 .cindex "LDAP", "TLS CA certificate directory"
15948 .cindex certificate "directory for LDAP"
15949 This option indicates which directory contains CA certificates for verifying
15950 a TLS certificate presented by an LDAP server.
15951 While Exim does not provide a default value, your SSL library may.
15952 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15953 and constrained to be a directory.
15954
15955
15956 .option ldap_ca_cert_file main string unset
15957 .cindex "LDAP", "TLS CA certificate file"
15958 .cindex certificate "file for LDAP"
15959 This option indicates which file contains CA certificates for verifying
15960 a TLS certificate presented by an LDAP server.
15961 While Exim does not provide a default value, your SSL library may.
15962 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15963 and constrained to be a file.
15964
15965
15966 .option ldap_cert_file main string unset
15967 .cindex "LDAP" "TLS client certificate file"
15968 .cindex certificate "file for LDAP"
15969 This option indicates which file contains an TLS client certificate which
15970 Exim should present to the LDAP server during TLS negotiation.
15971 Should be used together with &%ldap_cert_key%&.
15972
15973
15974 .option ldap_cert_key main string unset
15975 .cindex "LDAP" "TLS client key file"
15976 .cindex certificate "key for LDAP"
15977 This option indicates which file contains the secret/private key to use
15978 to prove identity to the LDAP server during TLS negotiation.
15979 Should be used together with &%ldap_cert_file%&, which contains the
15980 identity to be proven.
15981
15982
15983 .option ldap_cipher_suite main string unset
15984 .cindex "LDAP" "TLS cipher suite"
15985 This controls the TLS cipher-suite negotiation during TLS negotiation with
15986 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15987 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15988
15989
15990 .option ldap_default_servers main "string list" unset
15991 .cindex "LDAP" "default servers"
15992 This option provides a list of LDAP servers which are tried in turn when an
15993 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15994 details of LDAP queries. This option is available only when Exim has been built
15995 with LDAP support.
15996
15997
15998 .option ldap_require_cert main string unset.
15999 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16000 This should be one of the values "hard", "demand", "allow", "try" or "never".
16001 A value other than one of these is interpreted as "never".
16002 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16003 Although Exim does not set a default, the LDAP library probably defaults
16004 to hard/demand.
16005
16006
16007 .option ldap_start_tls main boolean false
16008 .cindex "LDAP" "whether or not to negotiate TLS"
16009 If set, Exim will attempt to negotiate TLS with the LDAP server when
16010 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16011 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16012 of SSL-on-connect.
16013 In the event of failure to negotiate TLS, the action taken is controlled
16014 by &%ldap_require_cert%&.
16015 This option is ignored for &`ldapi`& connections.
16016
16017
16018 .option ldap_version main integer unset
16019 .cindex "LDAP" "protocol version, forcing"
16020 This option can be used to force Exim to set a specific protocol version for
16021 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16022 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16023 the LDAP headers; otherwise it is 2. This option is available only when Exim
16024 has been built with LDAP support.
16025
16026
16027
16028 .option local_from_check main boolean true
16029 .cindex "&'Sender:'& header line" "disabling addition of"
16030 .cindex "&'From:'& header line" "disabling checking of"
16031 When a message is submitted locally (that is, not over a TCP/IP connection) by
16032 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16033 checks that the &'From:'& header line matches the login of the calling user and
16034 the domain specified by &%qualify_domain%&.
16035
16036 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16037 locally submitted message is automatically qualified by Exim, unless the
16038 &%-bnq%& command line option is used.
16039
16040 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16041 on the local part. If the &'From:'& header line does not match, Exim adds a
16042 &'Sender:'& header with an address constructed from the calling user's login
16043 and the default qualify domain.
16044
16045 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16046 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16047 &'Sender:'& header lines supplied by untrusted users, you must also set
16048 &%local_sender_retain%& to be true.
16049
16050 .cindex "envelope from"
16051 .cindex "envelope sender"
16052 These options affect only the header lines in the message. The envelope sender
16053 is still forced to be the login id at the qualify domain unless
16054 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16055
16056 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16057 request similar header line checking. See section &<<SECTthesenhea>>&, which
16058 has more details about &'Sender:'& processing.
16059
16060
16061
16062
16063 .option local_from_prefix main string unset
16064 When Exim checks the &'From:'& header line of locally submitted messages for
16065 matching the login id (see &%local_from_check%& above), it can be configured to
16066 ignore certain prefixes and suffixes in the local part of the address. This is
16067 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16068 appropriate lists, in the same form as the &%local_part_prefix%& and
16069 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16070 example, if
16071 .code
16072 local_from_prefix = *-
16073 .endd
16074 is set, a &'From:'& line containing
16075 .code
16076 From: anything-user@your.domain.example
16077 .endd
16078 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16079 matches the actual sender address that is constructed from the login name and
16080 qualify domain.
16081
16082
16083 .option local_from_suffix main string unset
16084 See &%local_from_prefix%& above.
16085
16086
16087 .option local_interfaces main "string list" "see below"
16088 This option controls which network interfaces are used by the daemon for
16089 listening; they are also used to identify the local host when routing. Chapter
16090 &<<CHAPinterfaces>>& contains a full description of this option and the related
16091 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16092 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16093 &%local_interfaces%& is
16094 .code
16095 local_interfaces = 0.0.0.0
16096 .endd
16097 when Exim is built without IPv6 support; otherwise it is
16098 .code
16099 local_interfaces = <; ::0 ; 0.0.0.0
16100 .endd
16101
16102 .option local_scan_timeout main time 5m
16103 .cindex "timeout" "for &[local_scan()]& function"
16104 .cindex "&[local_scan()]& function" "timeout"
16105 This timeout applies to the &[local_scan()]& function (see chapter
16106 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16107 the incoming message is rejected with a temporary error if it is an SMTP
16108 message. For a non-SMTP message, the message is dropped and Exim ends with a
16109 non-zero code. The incident is logged on the main and reject logs.
16110
16111
16112
16113 .option local_sender_retain main boolean false
16114 .cindex "&'Sender:'& header line" "retaining from local submission"
16115 When a message is submitted locally (that is, not over a TCP/IP connection) by
16116 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16117 do not want this to happen, you must set &%local_sender_retain%&, and you must
16118 also set &%local_from_check%& to be false (Exim will complain if you do not).
16119 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16120 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16121
16122
16123
16124
16125 .option localhost_number main string&!! unset
16126 .cindex "host" "locally unique number for"
16127 .cindex "message ids" "with multiple hosts"
16128 .vindex "&$localhost_number$&"
16129 Exim's message ids are normally unique only within the local host. If
16130 uniqueness among a set of hosts is required, each host must set a different
16131 value for the &%localhost_number%& option. The string is expanded immediately
16132 after reading the configuration file (so that a number can be computed from the
16133 host name, for example) and the result of the expansion must be a number in the
16134 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16135 systems). This is available in subsequent string expansions via the variable
16136 &$localhost_number$&. When &%localhost_number is set%&, the final two
16137 characters of the message id, instead of just being a fractional part of the
16138 time, are computed from the time and the local host number as described in
16139 section &<<SECTmessiden>>&.
16140
16141
16142
16143 .option log_file_path main "string list&!!" "set at compile time"
16144 .cindex "log" "file path for"
16145 This option sets the path which is used to determine the names of Exim's log
16146 files, or indicates that logging is to be to syslog, or both. It is expanded
16147 when Exim is entered, so it can, for example, contain a reference to the host
16148 name. If no specific path is set for the log files at compile or runtime,
16149 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16150 they are written in a sub-directory called &_log_& in Exim's spool directory.
16151 A path must start with a slash.
16152 To send to syslog, use the word &"syslog"&.
16153 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16154 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16155 used. If this string is fixed at your installation (contains no expansion
16156 variables) it is recommended that you do not set this option in the
16157 configuration file, but instead supply the path using LOG_FILE_PATH in
16158 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16159 early on &-- in particular, failure to read the configuration file.
16160
16161
16162 .option log_selector main string unset
16163 .cindex "log" "selectors"
16164 This option can be used to reduce or increase the number of things that Exim
16165 writes to its log files. Its argument is made up of names preceded by plus or
16166 minus characters. For example:
16167 .code
16168 log_selector = +arguments -retry_defer
16169 .endd
16170 A list of possible names and what they control is given in the chapter on
16171 logging, in section &<<SECTlogselector>>&.
16172
16173
16174 .option log_timezone main boolean false
16175 .cindex "log" "timezone for entries"
16176 .vindex "&$tod_log$&"
16177 .vindex "&$tod_zone$&"
16178 By default, the timestamps on log lines are in local time without the
16179 timezone. This means that if your timezone changes twice a year, the timestamps
16180 in log lines are ambiguous for an hour when the clocks go back. One way of
16181 avoiding this problem is to set the timezone to UTC. An alternative is to set
16182 &%log_timezone%& true. This turns on the addition of the timezone offset to
16183 timestamps in log lines. Turning on this option can add quite a lot to the size
16184 of log files because each line is extended by 6 characters. Note that the
16185 &$tod_log$& variable contains the log timestamp without the zone, but there is
16186 another variable called &$tod_zone$& that contains just the timezone offset.
16187
16188
16189 .option lookup_open_max main integer 25
16190 .cindex "too many open files"
16191 .cindex "open files, too many"
16192 .cindex "file" "too many open"
16193 .cindex "lookup" "maximum open files"
16194 .cindex "limit" "open files for lookups"
16195 This option limits the number of simultaneously open files for single-key
16196 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16197 Exim normally keeps these files open during routing, because often the same
16198 file is required several times. If the limit is reached, Exim closes the least
16199 recently used file. Note that if you are using the &'ndbm'& library, it
16200 actually opens two files for each logical DBM database, though it still counts
16201 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16202 open files"& errors with NDBM, you need to reduce the value of
16203 &%lookup_open_max%&.
16204
16205
16206 .option max_username_length main integer 0
16207 .cindex "length of login name"
16208 .cindex "user name" "maximum length"
16209 .cindex "limit" "user name length"
16210 Some operating systems are broken in that they truncate long arguments to
16211 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16212 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16213 an argument that is longer behaves as if &[getpwnam()]& failed.
16214
16215
16216 .option message_body_newlines main bool false
16217 .cindex "message body" "newlines in variables"
16218 .cindex "newline" "in message body variables"
16219 .vindex "&$message_body$&"
16220 .vindex "&$message_body_end$&"
16221 By default, newlines in the message body are replaced by spaces when setting
16222 the &$message_body$& and &$message_body_end$& expansion variables. If this
16223 option is set true, this no longer happens.
16224
16225
16226 .option message_body_visible main integer 500
16227 .cindex "body of message" "visible size"
16228 .cindex "message body" "visible size"
16229 .vindex "&$message_body$&"
16230 .vindex "&$message_body_end$&"
16231 This option specifies how much of a message's body is to be included in the
16232 &$message_body$& and &$message_body_end$& expansion variables.
16233
16234
16235 .option message_id_header_domain main string&!! unset
16236 .cindex "&'Message-ID:'& header line"
16237 If this option is set, the string is expanded and used as the right hand side
16238 (domain) of the &'Message-ID:'& header that Exim creates if a
16239 locally-originated incoming message does not have one. &"Locally-originated"&
16240 means &"not received over TCP/IP."&
16241 Otherwise, the primary host name is used.
16242 Only letters, digits, dot and hyphen are accepted; any other characters are
16243 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16244 empty string, the option is ignored.
16245
16246
16247 .option message_id_header_text main string&!! unset
16248 If this variable is set, the string is expanded and used to augment the text of
16249 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16250 message does not have one. The text of this header is required by RFC 2822 to
16251 take the form of an address. By default, Exim uses its internal message id as
16252 the local part, and the primary host name as the domain. If this option is set,
16253 it is expanded, and provided the expansion is not forced to fail, and does not
16254 yield an empty string, the result is inserted into the header immediately
16255 before the @, separated from the internal message id by a dot. Any characters
16256 that are illegal in an address are automatically converted into hyphens. This
16257 means that variables such as &$tod_log$& can be used, because the spaces and
16258 colons will become hyphens.
16259
16260
16261 .option message_logs main boolean true
16262 .cindex "message logs" "disabling"
16263 .cindex "log" "message log; disabling"
16264 If this option is turned off, per-message log files are not created in the
16265 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16266 Exim, by reducing the number of files involved in handling a message from a
16267 minimum of four (header spool file, body spool file, delivery journal, and
16268 per-message log) to three. The other major I/O activity is Exim's main log,
16269 which is not affected by this option.
16270
16271
16272 .option message_size_limit main string&!! 50M
16273 .cindex "message" "size limit"
16274 .cindex "limit" "message size"
16275 .cindex "size" "of message, limit"
16276 This option limits the maximum size of message that Exim will process. The
16277 value is expanded for each incoming connection so, for example, it can be made
16278 to depend on the IP address of the remote host for messages arriving via
16279 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16280 optionally followed by K or M.
16281
16282 &*Note*&: This limit cannot be made to depend on a message's sender or any
16283 other properties of an individual message, because it has to be advertised in
16284 the server's response to EHLO. String expansion failure causes a temporary
16285 error. A value of zero means no limit, but its use is not recommended. See also
16286 &%bounce_return_size_limit%&.
16287
16288 Incoming SMTP messages are failed with a 552 error if the limit is
16289 exceeded; locally-generated messages either get a stderr message or a delivery
16290 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16291 an oversized message is logged in both the main and the reject logs. See also
16292 the generic transport option &%message_size_limit%&, which limits the size of
16293 message that an individual transport can process.
16294
16295 If you use a virus-scanner and set this option to to a value larger than the
16296 maximum size that your virus-scanner is configured to support, you may get
16297 failures triggered by large mails.  The right size to configure for the
16298 virus-scanner depends upon what data is passed and the options in use but it's
16299 probably safest to just set it to a little larger than this value.  E.g., with a
16300 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16301 some problems may result.
16302
16303 A value of 0 will disable size limit checking; Exim will still advertise the
16304 SIZE extension in an EHLO response, but without a limit, so as to permit
16305 SMTP clients to still indicate the message size along with the MAIL verb.
16306
16307
16308 .option move_frozen_messages main boolean false
16309 .cindex "frozen messages" "moving"
16310 This option, which is available only if Exim has been built with the setting
16311 .code
16312 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16313 .endd
16314 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16315 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16316 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16317 standard utilities for handling such moved messages, and they do not show up in
16318 lists generated by &%-bp%& or by the Exim monitor.
16319
16320
16321 .option mua_wrapper main boolean false
16322 Setting this option true causes Exim to run in a very restrictive mode in which
16323 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16324 contains a full description of this facility.
16325
16326
16327
16328 .option mysql_servers main "string list" unset
16329 .cindex "MySQL" "server list"
16330 This option provides a list of MySQL servers and associated connection data, to
16331 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16332 option is available only if Exim has been built with MySQL support.
16333
16334
16335 .option never_users main "string list&!!" unset
16336 This option is expanded just once, at the start of Exim's processing. Local
16337 message deliveries are normally run in processes that are setuid to the
16338 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16339 It is usually desirable to prevent any deliveries from running as root, as a
16340 safety precaution.
16341
16342 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16343 list of users that must not be used for local deliveries. This list is fixed in
16344 the binary and cannot be overridden by the configuration file. By default, it
16345 contains just the single user name &"root"&. The &%never_users%& runtime option
16346 can be used to add more users to the fixed list.
16347
16348 If a message is to be delivered as one of the users on the fixed list or the
16349 &%never_users%& list, an error occurs, and delivery is deferred. A common
16350 example is
16351 .code
16352 never_users = root:daemon:bin
16353 .endd
16354 Including root is redundant if it is also on the fixed list, but it does no
16355 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16356 transport driver.
16357
16358
16359 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16360 .cindex "OpenSSL "compatibility options"
16361 This option allows an administrator to adjust the SSL options applied
16362 by OpenSSL to connections.  It is given as a space-separated list of items,
16363 each one to be +added or -subtracted from the current value.
16364
16365 This option is only available if Exim is built against OpenSSL.  The values
16366 available for this option vary according to the age of your OpenSSL install.
16367 The &"all"& value controls a subset of flags which are available, typically
16368 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16369 list the values known on your system and Exim should support all the
16370 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16371 names lose the leading &"SSL_OP_"& and are lower-cased.
16372
16373 Note that adjusting the options can have severe impact upon the security of
16374 SSL as used by Exim.  It is possible to disable safety checks and shoot
16375 yourself in the foot in various unpleasant ways.  This option should not be
16376 adjusted lightly.  An unrecognised item will be detected at startup, by
16377 invoking Exim with the &%-bV%& flag.
16378
16379 The option affects Exim operating both as a server and as a client.
16380
16381 Historical note: prior to release 4.80, Exim defaulted this value to
16382 "+dont_insert_empty_fragments", which may still be needed for compatibility
16383 with some clients, but which lowers security by increasing exposure to
16384 some now infamous attacks.
16385
16386 Examples:
16387 .code
16388 # Make both old MS and old Eudora happy:
16389 openssl_options = -all +microsoft_big_sslv3_buffer \
16390                        +dont_insert_empty_fragments
16391
16392 # Disable older protocol versions:
16393 openssl_options = +no_sslv2 +no_sslv3
16394 .endd
16395
16396 Possible options may include:
16397 .ilist
16398 &`all`&
16399 .next
16400 &`allow_unsafe_legacy_renegotiation`&
16401 .next
16402 &`cipher_server_preference`&
16403 .next
16404 &`dont_insert_empty_fragments`&
16405 .next
16406 &`ephemeral_rsa`&
16407 .next
16408 &`legacy_server_connect`&
16409 .next
16410 &`microsoft_big_sslv3_buffer`&
16411 .next
16412 &`microsoft_sess_id_bug`&
16413 .next
16414 &`msie_sslv2_rsa_padding`&
16415 .next
16416 &`netscape_challenge_bug`&
16417 .next
16418 &`netscape_reuse_cipher_change_bug`&
16419 .next
16420 &`no_compression`&
16421 .next
16422 &`no_session_resumption_on_renegotiation`&
16423 .next
16424 &`no_sslv2`&
16425 .next
16426 &`no_sslv3`&
16427 .next
16428 &`no_ticket`&
16429 .next
16430 &`no_tlsv1`&
16431 .next
16432 &`no_tlsv1_1`&
16433 .next
16434 &`no_tlsv1_2`&
16435 .next
16436 &`safari_ecdhe_ecdsa_bug`&
16437 .next
16438 &`single_dh_use`&
16439 .next
16440 &`single_ecdh_use`&
16441 .next
16442 &`ssleay_080_client_dh_bug`&
16443 .next
16444 &`sslref2_reuse_cert_type_bug`&
16445 .next
16446 &`tls_block_padding_bug`&
16447 .next
16448 &`tls_d5_bug`&
16449 .next
16450 &`tls_rollback_bug`&
16451 .endlist
16452
16453 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16454 all clients connecting using the MacOS SecureTransport TLS facility prior
16455 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16456 to negotiate TLS then this option value might help, provided that your OpenSSL
16457 release is new enough to contain this work-around.  This may be a situation
16458 where you have to upgrade OpenSSL to get buggy clients working.
16459
16460
16461 .option oracle_servers main "string list" unset
16462 .cindex "Oracle" "server list"
16463 This option provides a list of Oracle servers and associated connection data,
16464 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16465 The option is available only if Exim has been built with Oracle support.
16466
16467
16468 .option percent_hack_domains main "domain list&!!" unset
16469 .cindex "&""percent hack""&"
16470 .cindex "source routing" "in email address"
16471 .cindex "address" "source-routed"
16472 The &"percent hack"& is the convention whereby a local part containing a
16473 percent sign is re-interpreted as a new email address, with the percent
16474 replaced by @. This is sometimes called &"source routing"&, though that term is
16475 also applied to RFC 2822 addresses that begin with an @ character. If this
16476 option is set, Exim implements the percent facility for those domains listed,
16477 but no others. This happens before an incoming SMTP address is tested against
16478 an ACL.
16479
16480 &*Warning*&: The &"percent hack"& has often been abused by people who are
16481 trying to get round relaying restrictions. For this reason, it is best avoided
16482 if at all possible. Unfortunately, a number of less security-conscious MTAs
16483 implement it unconditionally. If you are running Exim on a gateway host, and
16484 routing mail through to internal MTAs without processing the local parts, it is
16485 a good idea to reject recipient addresses with percent characters in their
16486 local parts. Exim's default configuration does this.
16487
16488
16489 .option perl_at_start main boolean false
16490 .cindex "Perl"
16491 This option is available only when Exim is built with an embedded Perl
16492 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16493
16494
16495 .option perl_startup main string unset
16496 .cindex "Perl"
16497 This option is available only when Exim is built with an embedded Perl
16498 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16499
16500 .option perl_taintmode main boolean false
16501 .cindex "Perl"
16502 This option enables the taint mode of the embedded Perl interpreter.
16503
16504
16505 .option pgsql_servers main "string list" unset
16506 .cindex "PostgreSQL lookup type" "server list"
16507 This option provides a list of PostgreSQL servers and associated connection
16508 data, to be used in conjunction with &(pgsql)& lookups (see section
16509 &<<SECID72>>&). The option is available only if Exim has been built with
16510 PostgreSQL support.
16511
16512
16513 .option pid_file_path main string&!! "set at compile time"
16514 .cindex "daemon" "pid file path"
16515 .cindex "pid file, path for"
16516 This option sets the name of the file to which the Exim daemon writes its
16517 process id. The string is expanded, so it can contain, for example, references
16518 to the host name:
16519 .code
16520 pid_file_path = /var/log/$primary_hostname/exim.pid
16521 .endd
16522 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16523 spool directory.
16524 The value set by the option can be overridden by the &%-oP%& command line
16525 option. A pid file is not written if a &"non-standard"& daemon is run by means
16526 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16527
16528
16529 .option pipelining_advertise_hosts main "host list&!!" *
16530 .cindex "PIPELINING" "suppressing advertising"
16531 This option can be used to suppress the advertisement of the SMTP
16532 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16533 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16534 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16535 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16536 that clients will use it; &"out of order"& commands that are &"expected"& do
16537 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16538
16539 .option pipelining_connect_advertise_hosts main "host list&!!" *
16540 .cindex "pipelining" "early connection"
16541 .cindex "pipelining" PIPE_CONNECT
16542 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16543 this option controls which hosts the facility is advertised to
16544 and from which pipeline early-connection (before MAIL) SMTP
16545 commands are acceptable.
16546 When used, the pipelining saves on roundtrip times.
16547
16548 See also the &%hosts_pipe_connect%& smtp transport option.
16549
16550 Currently the option name &"X_PIPE_CONNECT"& is used.
16551
16552
16553 .option prdr_enable main boolean false
16554 .cindex "PRDR" "enabling on server"
16555 This option can be used to enable the Per-Recipient Data Response extension
16556 to SMTP, defined by Eric Hall.
16557 If the option is set, PRDR is advertised by Exim when operating as a server.
16558 If the client requests PRDR, and more than one recipient, for a message
16559 an additional ACL is called for each recipient after the message content
16560 is received.  See section &<<SECTPRDRACL>>&.
16561
16562 .option preserve_message_logs main boolean false
16563 .cindex "message logs" "preserving"
16564 If this option is set, message log files are not deleted when messages are
16565 completed. Instead, they are moved to a sub-directory of the spool directory
16566 called &_msglog.OLD_&, where they remain available for statistical or debugging
16567 purposes. This is a dangerous option to set on systems with any appreciable
16568 volume of mail. Use with care!
16569
16570
16571 .option primary_hostname main string "see below"
16572 .cindex "name" "of local host"
16573 .cindex "host" "name of local"
16574 .cindex "local host" "name of"
16575 .vindex "&$primary_hostname$&"
16576 This specifies the name of the current host. It is used in the default EHLO or
16577 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16578 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16579 The value is also used by default in some SMTP response messages from an Exim
16580 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16581
16582 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16583 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16584 contains only one component, Exim passes it to &[gethostbyname()]& (or
16585 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16586 version. The variable &$primary_hostname$& contains the host name, whether set
16587 explicitly by this option, or defaulted.
16588
16589
16590 .option print_topbitchars main boolean false
16591 .cindex "printing characters"
16592 .cindex "8-bit characters"
16593 By default, Exim considers only those characters whose codes lie in the range
16594 32&--126 to be printing characters. In a number of circumstances (for example,
16595 when writing log entries) non-printing characters are converted into escape
16596 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16597 is set, code values of 128 and above are also considered to be printing
16598 characters.
16599
16600 This option also affects the header syntax checks performed by the
16601 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16602 the user's full name when constructing From: and Sender: addresses (as
16603 described in section &<<SECTconstr>>&). Setting this option can cause
16604 Exim to generate eight bit message headers that do not conform to the
16605 standards.
16606
16607
16608 .option process_log_path main string unset
16609 .cindex "process log path"
16610 .cindex "log" "process log"
16611 .cindex "&'exiwhat'&"
16612 This option sets the name of the file to which an Exim process writes its
16613 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16614 utility script. If this option is unset, the file called &_exim-process.info_&
16615 in Exim's spool directory is used. The ability to specify the name explicitly
16616 can be useful in environments where two different Exims are running, using
16617 different spool directories.
16618
16619
16620 .option prod_requires_admin main boolean true
16621 .cindex "restricting access to features"
16622 .oindex "&%-M%&"
16623 .oindex "&%-R%&"
16624 .oindex "&%-q%&"
16625 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16626 admin user unless &%prod_requires_admin%& is set false. See also
16627 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16628
16629
16630 .option qualify_domain main string "see below"
16631 .cindex "domain" "for qualifying addresses"
16632 .cindex "address" "qualification"
16633 This option specifies the domain name that is added to any envelope sender
16634 addresses that do not have a domain qualification. It also applies to
16635 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16636 are accepted by default only for locally-generated messages. Qualification is
16637 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16638 locally-generated messages, unless the &%-bnq%& command line option is used.
16639
16640 Messages from external sources must always contain fully qualified addresses,
16641 unless the sending host matches &%sender_unqualified_hosts%& or
16642 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16643 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16644 necessary. Internally, Exim always works with fully qualified envelope
16645 addresses. If &%qualify_domain%& is not set, it defaults to the
16646 &%primary_hostname%& value.
16647
16648
16649 .option qualify_recipient main string "see below"
16650 This option allows you to specify a different domain for qualifying recipient
16651 addresses to the one that is used for senders. See &%qualify_domain%& above.
16652
16653
16654
16655 .option queue_domains main "domain list&!!" unset
16656 .cindex "domain" "specifying non-immediate delivery"
16657 .cindex "queueing incoming messages"
16658 .cindex "message" "queueing certain domains"
16659 This option lists domains for which immediate delivery is not required.
16660 A delivery process is started whenever a message is received, but only those
16661 domains that do not match are processed. All other deliveries wait until the
16662 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16663
16664
16665 .option queue_list_requires_admin main boolean true
16666 .cindex "restricting access to features"
16667 .oindex "&%-bp%&"
16668 The &%-bp%& command-line option, which lists the messages that are on the
16669 queue, requires the caller to be an admin user unless
16670 &%queue_list_requires_admin%& is set false.
16671 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16672
16673
16674 .option queue_only main boolean false
16675 .cindex "queueing incoming messages"
16676 .cindex "message" "queueing unconditionally"
16677 If &%queue_only%& is set, a delivery process is not automatically started
16678 whenever a message is received. Instead, the message waits in the queue for the
16679 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16680 delivered immediately when certain conditions (such as heavy load) occur.
16681
16682 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16683 and &%-odi%& command line options override &%queue_only%& unless
16684 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16685 &%queue_only_load%&, and &%smtp_accept_queue%&.
16686
16687
16688 .option queue_only_file main string unset
16689 .cindex "queueing incoming messages"
16690 .cindex "message" "queueing by file existence"
16691 This option can be set to a colon-separated list of absolute path names, each
16692 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16693 it tests for the existence of each listed path using a call to &[stat()]&. For
16694 each path that exists, the corresponding queueing option is set.
16695 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16696 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16697 .code
16698 queue_only_file = smtp/some/file
16699 .endd
16700 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16701 &_/some/file_& exists.
16702
16703
16704 .option queue_only_load main fixed-point unset
16705 .cindex "load average"
16706 .cindex "queueing incoming messages"
16707 .cindex "message" "queueing by load"
16708 If the system load average is higher than this value, incoming messages from
16709 all sources are queued, and no automatic deliveries are started. If this
16710 happens during local or remote SMTP input, all subsequent messages received on
16711 the same SMTP connection are queued by default, whatever happens to the load in
16712 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16713 false.
16714
16715 Deliveries will subsequently be performed by queue runner processes. This
16716 option has no effect on ancient operating systems on which Exim cannot
16717 determine the load average. See also &%deliver_queue_load_max%& and
16718 &%smtp_load_reserve%&.
16719
16720
16721 .option queue_only_load_latch main boolean true
16722 .cindex "load average" "re-evaluating per message"
16723 When this option is true (the default), once one message has been queued
16724 because the load average is higher than the value set by &%queue_only_load%&,
16725 all subsequent messages received on the same SMTP connection are also queued.
16726 This is a deliberate choice; even though the load average may fall below the
16727 threshold, it doesn't seem right to deliver later messages on the same
16728 connection when not delivering earlier ones. However, there are special
16729 circumstances such as very long-lived connections from scanning appliances
16730 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16731 should be set false. This causes the value of the load average to be
16732 re-evaluated for each message.
16733
16734
16735 .option queue_only_override main boolean true
16736 .cindex "queueing incoming messages"
16737 When this option is true, the &%-od%&&'x'& command line options override the
16738 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16739 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16740 to override; they are accepted, but ignored.
16741
16742
16743 .option queue_run_in_order main boolean false
16744 .cindex "queue runner" "processing messages in order"
16745 If this option is set, queue runs happen in order of message arrival instead of
16746 in an arbitrary order. For this to happen, a complete list of the entire queue
16747 must be set up before the deliveries start. When the queue is all held in a
16748 single directory (the default), a single list is created for both the ordered
16749 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16750 single list is not created when &%queue_run_in_order%& is false. In this case,
16751 the sub-directories are processed one at a time (in a random order), and this
16752 avoids setting up one huge list for the whole queue. Thus, setting
16753 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16754 when the queue is large, because of the extra work in setting up the single,
16755 large list. In most situations, &%queue_run_in_order%& should not be set.
16756
16757
16758
16759 .option queue_run_max main integer&!! 5
16760 .cindex "queue runner" "maximum number of"
16761 This controls the maximum number of queue runner processes that an Exim daemon
16762 can run simultaneously. This does not mean that it starts them all at once,
16763 but rather that if the maximum number are still running when the time comes to
16764 start another one, it refrains from starting another one. This can happen with
16765 very large queues and/or very sluggish deliveries. This option does not,
16766 however, interlock with other processes, so additional queue runners can be
16767 started by other means, or by killing and restarting the daemon.
16768
16769 Setting this option to zero does not suppress queue runs; rather, it disables
16770 the limit, allowing any number of simultaneous queue runner processes to be
16771 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16772 the daemon's command line.
16773
16774 .cindex queues named
16775 .cindex "named queues" "resource limit"
16776 To set limits for different named queues use
16777 an expansion depending on the &$queue_name$& variable.
16778
16779 .option queue_smtp_domains main "domain list&!!" unset
16780 .cindex "queueing incoming messages"
16781 .cindex "message" "queueing remote deliveries"
16782 .cindex "first pass routing"
16783 When this option is set, a delivery process is started whenever a message is
16784 received, routing is performed, and local deliveries take place.
16785 However, if any SMTP deliveries are required for domains that match
16786 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16787 message waits in the queue for the next queue run. Since routing of the message
16788 has taken place, Exim knows to which remote hosts it must be delivered, and so
16789 when the queue run happens, multiple messages for the same host are delivered
16790 over a single SMTP connection. The &%-odqs%& command line option causes all
16791 SMTP deliveries to be queued in this way, and is equivalent to setting
16792 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16793 &%queue_domains%&.
16794
16795
16796 .option receive_timeout main time 0s
16797 .cindex "timeout" "for non-SMTP input"
16798 This option sets the timeout for accepting a non-SMTP message, that is, the
16799 maximum time that Exim waits when reading a message on the standard input. If
16800 the value is zero, it will wait forever. This setting is overridden by the
16801 &%-or%& command line option. The timeout for incoming SMTP messages is
16802 controlled by &%smtp_receive_timeout%&.
16803
16804 .option received_header_text main string&!! "see below"
16805 .cindex "customizing" "&'Received:'& header"
16806 .cindex "&'Received:'& header line" "customizing"
16807 This string defines the contents of the &'Received:'& message header that is
16808 added to each message, except for the timestamp, which is automatically added
16809 on at the end (preceded by a semicolon). The string is expanded each time it is
16810 used. If the expansion yields an empty string, no &'Received:'& header line is
16811 added to the message. Otherwise, the string should start with the text
16812 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16813 header lines.
16814 The default setting is:
16815
16816 .code
16817 received_header_text = Received: \
16818   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16819     {${if def:sender_ident \
16820       {from ${quote_local_part:$sender_ident} }}\
16821         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16822   by $primary_hostname \
16823   ${if def:received_protocol {with $received_protocol }}\
16824   ${if def:tls_ver           { ($tls_ver)}}\
16825   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16826   (Exim $version_number)\n\t\
16827   ${if def:sender_address \
16828   {(envelope-from <$sender_address>)\n\t}}\
16829   id $message_exim_id\
16830   ${if def:received_for {\n\tfor $received_for}}
16831 .endd
16832
16833 The reference to the TLS cipher is omitted when Exim is built without TLS
16834 support. The use of conditional expansions ensures that this works for both
16835 locally generated messages and messages received from remote hosts, giving
16836 header lines such as the following:
16837 .code
16838 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16839 by marley.carol.example with esmtp (Exim 4.00)
16840 (envelope-from <bob@carol.example>)
16841 id 16IOWa-00019l-00
16842 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16843 Received: by scrooge.carol.example with local (Exim 4.00)
16844 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16845 .endd
16846 Until the body of the message has been received, the timestamp is the time when
16847 the message started to be received. Once the body has arrived, and all policy
16848 checks have taken place, the timestamp is updated to the time at which the
16849 message was accepted.
16850
16851
16852 .option received_headers_max main integer 30
16853 .cindex "loop" "prevention"
16854 .cindex "mail loop prevention"
16855 .cindex "&'Received:'& header line" "counting"
16856 When a message is to be delivered, the number of &'Received:'& headers is
16857 counted, and if it is greater than this parameter, a mail loop is assumed to
16858 have occurred, the delivery is abandoned, and an error message is generated.
16859 This applies to both local and remote deliveries.
16860
16861
16862 .option recipient_unqualified_hosts main "host list&!!" unset
16863 .cindex "unqualified addresses"
16864 .cindex "host" "unqualified addresses from"
16865 This option lists those hosts from which Exim is prepared to accept unqualified
16866 recipient addresses in message envelopes. The addresses are made fully
16867 qualified by the addition of the &%qualify_recipient%& value. This option also
16868 affects message header lines. Exim does not reject unqualified recipient
16869 addresses in headers, but it qualifies them only if the message came from a
16870 host that matches &%recipient_unqualified_hosts%&,
16871 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16872 option was not set.
16873
16874
16875 .option recipients_max main integer 0
16876 .cindex "limit" "number of recipients"
16877 .cindex "recipient" "maximum number"
16878 If this option is set greater than zero, it specifies the maximum number of
16879 original recipients for any message. Additional recipients that are generated
16880 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16881 all recipients over the limit; earlier recipients are delivered as normal.
16882 Non-SMTP messages with too many recipients are failed, and no deliveries are
16883 done.
16884
16885 .cindex "RCPT" "maximum number of incoming"
16886 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16887 RCPT commands in a single message.
16888
16889
16890 .option recipients_max_reject main boolean false
16891 If this option is set true, Exim rejects SMTP messages containing too many
16892 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16893 error to the eventual DATA command. Otherwise (the default) it gives a 452
16894 error to the surplus RCPT commands and accepts the message on behalf of the
16895 initial set of recipients. The remote server should then re-send the message
16896 for the remaining recipients at a later time.
16897
16898
16899 .option remote_max_parallel main integer 2
16900 .cindex "delivery" "parallelism for remote"
16901 This option controls parallel delivery of one message to a number of remote
16902 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16903 does all the remote deliveries for a message one by one. Otherwise, if a single
16904 message has to be delivered to more than one remote host, or if several copies
16905 have to be sent to the same remote host, up to &%remote_max_parallel%&
16906 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16907 deliveries are required, the maximum number of processes are started, and as
16908 each one finishes, another is begun. The order of starting processes is the
16909 same as if sequential delivery were being done, and can be controlled by the
16910 &%remote_sort_domains%& option. If parallel delivery takes place while running
16911 with debugging turned on, the debugging output from each delivery process is
16912 tagged with its process id.
16913
16914 This option controls only the maximum number of parallel deliveries for one
16915 message in one Exim delivery process. Because Exim has no central queue
16916 manager, there is no way of controlling the total number of simultaneous
16917 deliveries if the configuration allows a delivery attempt as soon as a message
16918 is received.
16919
16920 .cindex "number of deliveries"
16921 .cindex "delivery" "maximum number of"
16922 If you want to control the total number of deliveries on the system, you
16923 need to set the &%queue_only%& option. This ensures that all incoming messages
16924 are added to the queue without starting a delivery process. Then set up an Exim
16925 daemon to start queue runner processes at appropriate intervals (probably
16926 fairly often, for example, every minute), and limit the total number of queue
16927 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16928 delivers only one message at a time, the maximum number of deliveries that can
16929 then take place at once is &%queue_run_max%& multiplied by
16930 &%remote_max_parallel%&.
16931
16932 If it is purely remote deliveries you want to control, use
16933 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16934 doing the SMTP routing before queueing, so that several messages for the same
16935 host will eventually get delivered down the same connection.
16936
16937
16938 .option remote_sort_domains main "domain list&!!" unset
16939 .cindex "sorting remote deliveries"
16940 .cindex "delivery" "sorting remote"
16941 When there are a number of remote deliveries for a message, they are sorted by
16942 domain into the order given by this list. For example,
16943 .code
16944 remote_sort_domains = *.cam.ac.uk:*.uk
16945 .endd
16946 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16947 then to those in the &%uk%& domain, then to any others.
16948
16949
16950 .option retry_data_expire main time 7d
16951 .cindex "hints database" "data expiry"
16952 This option sets a &"use before"& time on retry information in Exim's hints
16953 database. Any older retry data is ignored. This means that, for example, once a
16954 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16955 past failures.
16956
16957
16958 .option retry_interval_max main time 24h
16959 .cindex "retry" "limit on interval"
16960 .cindex "limit" "on retry interval"
16961 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16962 intervals between delivery attempts for messages that cannot be delivered
16963 straight away. This option sets an overall limit to the length of time between
16964 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16965 the default value.
16966
16967
16968 .option return_path_remove main boolean true
16969 .cindex "&'Return-path:'& header line" "removing"
16970 RFC 2821, section 4.4, states that an SMTP server must insert a
16971 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16972 The &'Return-path:'& header preserves the sender address as received in the
16973 MAIL command. This description implies that this header should not be present
16974 in an incoming message. If &%return_path_remove%& is true, any existing
16975 &'Return-path:'& headers are removed from messages at the time they are
16976 received. Exim's transports have options for adding &'Return-path:'& headers at
16977 the time of delivery. They are normally used only for final local deliveries.
16978
16979
16980 .option return_size_limit main integer 100K
16981 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16982
16983
16984 .option rfc1413_hosts main "host list&!!" @[]
16985 .cindex "RFC 1413"
16986 .cindex "host" "for RFC 1413 calls"
16987 RFC 1413 identification calls are made to any client host which matches
16988 an item in the list.
16989 The default value specifies just this host, being any local interface
16990 for the system.
16991
16992 .option rfc1413_query_timeout main time 0s
16993 .cindex "RFC 1413" "query timeout"
16994 .cindex "timeout" "for RFC 1413 call"
16995 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16996 no RFC 1413 calls are ever made.
16997
16998
16999 .option sender_unqualified_hosts main "host list&!!" unset
17000 .cindex "unqualified addresses"
17001 .cindex "host" "unqualified addresses from"
17002 This option lists those hosts from which Exim is prepared to accept unqualified
17003 sender addresses. The addresses are made fully qualified by the addition of
17004 &%qualify_domain%&. This option also affects message header lines. Exim does
17005 not reject unqualified addresses in headers that contain sender addresses, but
17006 it qualifies them only if the message came from a host that matches
17007 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17008 using TCP/IP), and the &%-bnq%& option was not set.
17009
17010
17011 .option slow_lookup_log main integer 0
17012 .cindex "logging" "slow lookups"
17013 .cindex "dns" "logging slow lookups"
17014 This option controls logging of slow lookups.
17015 If the value is nonzero it is taken as a number of milliseconds
17016 and lookups taking longer than this are logged.
17017 Currently this applies only to DNS lookups.
17018
17019
17020
17021 .option smtp_accept_keepalive main boolean true
17022 .cindex "keepalive" "on incoming connection"
17023 This option controls the setting of the SO_KEEPALIVE option on incoming
17024 TCP/IP socket connections. When set, it causes the kernel to probe idle
17025 connections periodically, by sending packets with &"old"& sequence numbers. The
17026 other end of the connection should send an acknowledgment if the connection is
17027 still okay or a reset if the connection has been aborted. The reason for doing
17028 this is that it has the beneficial effect of freeing up certain types of
17029 connection that can get stuck when the remote host is disconnected without
17030 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17031 hours to detect unreachable hosts.
17032
17033
17034
17035 .option smtp_accept_max main integer 20
17036 .cindex "limit" "incoming SMTP connections"
17037 .cindex "SMTP" "incoming connection count"
17038 .cindex "inetd"
17039 This option specifies the maximum number of simultaneous incoming SMTP calls
17040 that Exim will accept. It applies only to the listening daemon; there is no
17041 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17042 value is set to zero, no limit is applied. However, it is required to be
17043 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17044 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17045
17046 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17047 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17048 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17049 and &%smtp_load_reserve%& are then checked before accepting the connection.
17050
17051
17052 .option smtp_accept_max_nonmail main integer 10
17053 .cindex "limit" "non-mail SMTP commands"
17054 .cindex "SMTP" "limiting non-mail commands"
17055 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17056 the connection if there are too many. This option defines &"too many"&. The
17057 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17058 client looping sending EHLO, for example. The check is applied only if the
17059 client host matches &%smtp_accept_max_nonmail_hosts%&.
17060
17061 When a new message is expected, one occurrence of RSET is not counted. This
17062 allows a client to send one RSET between messages (this is not necessary,
17063 but some clients do it). Exim also allows one uncounted occurrence of HELO
17064 or EHLO, and one occurrence of STARTTLS between messages. After
17065 starting up a TLS session, another EHLO is expected, and so it too is not
17066 counted. The first occurrence of AUTH in a connection, or immediately
17067 following STARTTLS is not counted. Otherwise, all commands other than
17068 MAIL, RCPT, DATA, and QUIT are counted.
17069
17070
17071 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17072 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17073 check by setting this option. The default value makes it apply to all hosts. By
17074 changing the value, you can exclude any badly-behaved hosts that you have to
17075 live with.
17076
17077
17078 . Allow this long option name to split; give it unsplit as a fifth argument
17079 . for the automatic .oindex that is generated by .option.
17080 . We insert " &~&~" which is both pretty nasty visually and results in
17081 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17082 . zero-width-space, which would be nicer visually and results in (at least)
17083 . html that Firefox will split on when it's forced to reflow (rather than
17084 . inserting a horizontal scrollbar).  However, the text is still not
17085 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17086 . the option name to split.
17087
17088 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17089          smtp_accept_max_per_connection
17090 .cindex "SMTP" "limiting incoming message count"
17091 .cindex "limit" "messages per SMTP connection"
17092 The value of this option limits the number of MAIL commands that Exim is
17093 prepared to accept over a single SMTP connection, whether or not each command
17094 results in the transfer of a message. After the limit is reached, a 421
17095 response is given to subsequent MAIL commands. This limit is a safety
17096 precaution against a client that goes mad (incidents of this type have been
17097 seen).
17098
17099
17100 .option smtp_accept_max_per_host main string&!! unset
17101 .cindex "limit" "SMTP connections from one host"
17102 .cindex "host" "limiting SMTP connections from"
17103 This option restricts the number of simultaneous IP connections from a single
17104 host (strictly, from a single IP address) to the Exim daemon. The option is
17105 expanded, to enable different limits to be applied to different hosts by
17106 reference to &$sender_host_address$&. Once the limit is reached, additional
17107 connection attempts from the same host are rejected with error code 421. This
17108 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17109 of zero imposes no limit. If this option is set greater than zero, it is
17110 required that &%smtp_accept_max%& be non-zero.
17111
17112 &*Warning*&: When setting this option you should not use any expansion
17113 constructions that take an appreciable amount of time. The expansion and test
17114 happen in the main daemon loop, in order to reject additional connections
17115 without forking additional processes (otherwise a denial-of-service attack
17116 could cause a vast number or processes to be created). While the daemon is
17117 doing this processing, it cannot accept any other incoming connections.
17118
17119
17120
17121 .option smtp_accept_queue main integer 0
17122 .cindex "SMTP" "incoming connection count"
17123 .cindex "queueing incoming messages"
17124 .cindex "message" "queueing by SMTP connection count"
17125 If the number of simultaneous incoming SMTP connections being handled via the
17126 listening daemon exceeds this value, messages received by SMTP are just placed
17127 in the queue; no delivery processes are started automatically. The count is
17128 fixed at the start of an SMTP connection. It cannot be updated in the
17129 subprocess that receives messages, and so the queueing or not queueing applies
17130 to all messages received in the same connection.
17131
17132 A value of zero implies no limit, and clearly any non-zero value is useful only
17133 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17134 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17135 various &%-od%&&'x'& command line options.
17136
17137
17138 . See the comment on smtp_accept_max_per_connection
17139
17140 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17141          smtp_accept_queue_per_connection
17142 .cindex "queueing incoming messages"
17143 .cindex "message" "queueing by message count"
17144 This option limits the number of delivery processes that Exim starts
17145 automatically when receiving messages via SMTP, whether via the daemon or by
17146 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17147 and the number of messages received in a single SMTP session exceeds this
17148 number, subsequent messages are placed in the queue, but no delivery processes
17149 are started. This helps to limit the number of Exim processes when a server
17150 restarts after downtime and there is a lot of mail waiting for it on other
17151 systems. On large systems, the default should probably be increased, and on
17152 dial-in client systems it should probably be set to zero (that is, disabled).
17153
17154
17155 .option smtp_accept_reserve main integer 0
17156 .cindex "SMTP" "incoming call count"
17157 .cindex "host" "reserved"
17158 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17159 number of SMTP connections that are reserved for connections from the hosts
17160 that are specified in &%smtp_reserve_hosts%&. The value set in
17161 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17162 restricted to this number of connections; the option specifies a minimum number
17163 of connection slots for them, not a maximum. It is a guarantee that this group
17164 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17165 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17166 individual host.
17167
17168 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17169 set to 5, once there are 45 active connections (from any hosts), new
17170 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17171 provided the other criteria for acceptance are met.
17172
17173
17174 .option smtp_active_hostname main string&!! unset
17175 .cindex "host" "name in SMTP responses"
17176 .cindex "SMTP" "host name in responses"
17177 .vindex "&$primary_hostname$&"
17178 This option is provided for multi-homed servers that want to masquerade as
17179 several different hosts. At the start of an incoming SMTP connection, its value
17180 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17181 responses. For example, it is used as domain name in the response to an
17182 incoming HELO or EHLO command.
17183
17184 .vindex "&$smtp_active_hostname$&"
17185 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17186 is saved with any messages that are received. It is therefore available for use
17187 in routers and transports when the message is later delivered.
17188
17189 If this option is unset, or if its expansion is forced to fail, or if the
17190 expansion results in an empty string, the value of &$primary_hostname$& is
17191 used. Other expansion failures cause a message to be written to the main and
17192 panic logs, and the SMTP command receives a temporary error. Typically, the
17193 value of &%smtp_active_hostname%& depends on the incoming interface address.
17194 For example:
17195 .code
17196 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17197   {cox.mydomain}{box.mydomain}}
17198 .endd
17199
17200 Although &$smtp_active_hostname$& is primarily concerned with incoming
17201 messages, it is also used as the default for HELO commands in callout
17202 verification if there is no remote transport from which to obtain a
17203 &%helo_data%& value.
17204
17205 .option smtp_banner main string&!! "see below"
17206 .cindex "SMTP" "welcome banner"
17207 .cindex "banner for SMTP"
17208 .cindex "welcome banner for SMTP"
17209 .cindex "customizing" "SMTP banner"
17210 This string, which is expanded every time it is used, is output as the initial
17211 positive response to an SMTP connection. The default setting is:
17212 .code
17213 smtp_banner = $smtp_active_hostname ESMTP Exim \
17214   $version_number $tod_full
17215 .endd
17216 Failure to expand the string causes a panic error. If you want to create a
17217 multiline response to the initial SMTP connection, use &"\n"& in the string at
17218 appropriate points, but not at the end. Note that the 220 code is not included
17219 in this string. Exim adds it automatically (several times in the case of a
17220 multiline response).
17221
17222
17223 .option smtp_check_spool_space main boolean true
17224 .cindex "checking disk space"
17225 .cindex "disk space, checking"
17226 .cindex "spool directory" "checking space"
17227 When this option is set, if an incoming SMTP session encounters the SIZE
17228 option on a MAIL command, it checks that there is enough space in the
17229 spool directory's partition to accept a message of that size, while still
17230 leaving free the amount specified by &%check_spool_space%& (even if that value
17231 is zero). If there isn't enough space, a temporary error code is returned.
17232
17233
17234 .option smtp_connect_backlog main integer 20
17235 .cindex "connection backlog"
17236 .cindex "SMTP" "connection backlog"
17237 .cindex "backlog of connections"
17238 This option specifies a maximum number of waiting SMTP connections. Exim passes
17239 this value to the TCP/IP system when it sets up its listener. Once this number
17240 of connections are waiting for the daemon's attention, subsequent connection
17241 attempts are refused at the TCP/IP level. At least, that is what the manuals
17242 say; in some circumstances such connection attempts have been observed to time
17243 out instead. For large systems it is probably a good idea to increase the
17244 value (to 50, say). It also gives some protection against denial-of-service
17245 attacks by SYN flooding.
17246
17247
17248 .option smtp_enforce_sync main boolean true
17249 .cindex "SMTP" "synchronization checking"
17250 .cindex "synchronization checking in SMTP"
17251 The SMTP protocol specification requires the client to wait for a response from
17252 the server at certain points in the dialogue. Without PIPELINING these
17253 synchronization points are after every command; with PIPELINING they are
17254 fewer, but they still exist.
17255
17256 Some spamming sites send out a complete set of SMTP commands without waiting
17257 for any response. Exim protects against this by rejecting a message if the
17258 client has sent further input when it should not have. The error response &"554
17259 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17260 for this error cannot be perfect because of transmission delays (unexpected
17261 input may be on its way but not yet received when Exim checks). However, it
17262 does detect many instances.
17263
17264 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17265 If you want to disable the check selectively (for example, only for certain
17266 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17267 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17268
17269
17270
17271 .option smtp_etrn_command main string&!! unset
17272 .cindex "ETRN" "command to be run"
17273 .vindex "&$domain$&"
17274 If this option is set, the given command is run whenever an SMTP ETRN
17275 command is received from a host that is permitted to issue such commands (see
17276 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17277 are independently expanded. The expansion variable &$domain$& is set to the
17278 argument of the ETRN command, and no syntax checking is done on it. For
17279 example:
17280 .code
17281 smtp_etrn_command = /etc/etrn_command $domain \
17282                     $sender_host_address
17283 .endd
17284 .new
17285 If the option is not set, the argument for the ETRN command must
17286 be a &'#'& followed by an address string.
17287 In this case an &'exim -R <string>'& command is used;
17288 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17289 .wen
17290
17291 A new process is created to run the command, but Exim does not wait for it to
17292 complete. Consequently, its status cannot be checked. If the command cannot be
17293 run, a line is written to the panic log, but the ETRN caller still receives
17294 a 250 success response. Exim is normally running under its own uid when
17295 receiving SMTP, so it is not possible for it to change the uid before running
17296 the command.
17297
17298
17299 .option smtp_etrn_serialize main boolean true
17300 .cindex "ETRN" "serializing"
17301 When this option is set, it prevents the simultaneous execution of more than
17302 one identical command as a result of ETRN in an SMTP connection. See
17303 section &<<SECTETRN>>& for details.
17304
17305
17306 .option smtp_load_reserve main fixed-point unset
17307 .cindex "load average"
17308 If the system load average ever gets higher than this, incoming SMTP calls are
17309 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17310 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17311 the load is over the limit. The option has no effect on ancient operating
17312 systems on which Exim cannot determine the load average. See also
17313 &%deliver_queue_load_max%& and &%queue_only_load%&.
17314
17315
17316
17317 .option smtp_max_synprot_errors main integer 3
17318 .cindex "SMTP" "limiting syntax and protocol errors"
17319 .cindex "limit" "SMTP syntax and protocol errors"
17320 Exim rejects SMTP commands that contain syntax or protocol errors. In
17321 particular, a syntactically invalid email address, as in this command:
17322 .code
17323 RCPT TO:<abc xyz@a.b.c>
17324 .endd
17325 causes immediate rejection of the command, before any other tests are done.
17326 (The ACL cannot be run if there is no valid address to set up for it.) An
17327 example of a protocol error is receiving RCPT before MAIL. If there are
17328 too many syntax or protocol errors in one SMTP session, the connection is
17329 dropped. The limit is set by this option.
17330
17331 .cindex "PIPELINING" "expected errors"
17332 When the PIPELINING extension to SMTP is in use, some protocol errors are
17333 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17334 Exim assumes that PIPELINING will be used if it advertises it (see
17335 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17336 not count towards the limit.
17337
17338
17339
17340 .option smtp_max_unknown_commands main integer 3
17341 .cindex "SMTP" "limiting unknown commands"
17342 .cindex "limit" "unknown SMTP commands"
17343 If there are too many unrecognized commands in an incoming SMTP session, an
17344 Exim server drops the connection. This is a defence against some kinds of abuse
17345 that subvert web
17346 clients
17347 into making connections to SMTP ports; in these circumstances, a number of
17348 non-SMTP command lines are sent first.
17349
17350
17351
17352 .option smtp_ratelimit_hosts main "host list&!!" unset
17353 .cindex "SMTP" "rate limiting"
17354 .cindex "limit" "rate of message arrival"
17355 .cindex "RCPT" "rate limiting"
17356 Some sites find it helpful to be able to limit the rate at which certain hosts
17357 can send them messages, and the rate at which an individual message can specify
17358 recipients.
17359
17360 Exim has two rate-limiting facilities. This section describes the older
17361 facility, which can limit rates within a single connection. The newer
17362 &%ratelimit%& ACL condition can limit rates across all connections. See section
17363 &<<SECTratelimiting>>& for details of the newer facility.
17364
17365 When a host matches &%smtp_ratelimit_hosts%&, the values of
17366 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17367 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17368 respectively. Each option, if set, must contain a set of four comma-separated
17369 values:
17370
17371 .ilist
17372 A threshold, before which there is no rate limiting.
17373 .next
17374 An initial time delay. Unlike other times in Exim, numbers with decimal
17375 fractional parts are allowed here.
17376 .next
17377 A factor by which to increase the delay each time.
17378 .next
17379 A maximum value for the delay. This should normally be less than 5 minutes,
17380 because after that time, the client is liable to timeout the SMTP command.
17381 .endlist
17382
17383 For example, these settings have been used successfully at the site which
17384 first suggested this feature, for controlling mail from their customers:
17385 .code
17386 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17387 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17388 .endd
17389 The first setting specifies delays that are applied to MAIL commands after
17390 two have been received over a single connection. The initial delay is 0.5
17391 seconds, increasing by a factor of 1.05 each time. The second setting applies
17392 delays to RCPT commands when more than four occur in a single message.
17393
17394
17395 .option smtp_ratelimit_mail main string unset
17396 See &%smtp_ratelimit_hosts%& above.
17397
17398
17399 .option smtp_ratelimit_rcpt main string unset
17400 See &%smtp_ratelimit_hosts%& above.
17401
17402
17403 .option smtp_receive_timeout main time&!! 5m
17404 .cindex "timeout" "for SMTP input"
17405 .cindex "SMTP" "input timeout"
17406 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17407 input, including batch SMTP. If a line of input (either an SMTP command or a
17408 data line) is not received within this time, the SMTP connection is dropped and
17409 the message is abandoned.
17410 A line is written to the log containing one of the following messages:
17411 .code
17412 SMTP command timeout on connection from...
17413 SMTP data timeout on connection from...
17414 .endd
17415 The former means that Exim was expecting to read an SMTP command; the latter
17416 means that it was in the DATA phase, reading the contents of a message.
17417
17418 If the first character of the option is a &"$"& the option is
17419 expanded before use and may depend on
17420 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17421
17422
17423 .oindex "&%-os%&"
17424 The value set by this option can be overridden by the
17425 &%-os%& command-line option. A setting of zero time disables the timeout, but
17426 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17427 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17428 timeout is controlled by &%receive_timeout%& and &%-or%&.
17429
17430
17431 .option smtp_reserve_hosts main "host list&!!" unset
17432 This option defines hosts for which SMTP connections are reserved; see
17433 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17434
17435
17436 .option smtp_return_error_details main boolean false
17437 .cindex "SMTP" "details policy failures"
17438 .cindex "policy control" "rejection, returning details"
17439 In the default state, Exim uses bland messages such as
17440 &"Administrative prohibition"& when it rejects SMTP commands for policy
17441 reasons. Many sysadmins like this because it gives away little information
17442 to spammers. However, some other sysadmins who are applying strict checking
17443 policies want to give out much fuller information about failures. Setting
17444 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17445 example, instead of &"Administrative prohibition"&, it might give:
17446 .code
17447 550-Rejected after DATA: '>' missing at end of address:
17448 550 failing address in "From" header is: <user@dom.ain
17449 .endd
17450
17451
17452 .option smtputf8_advertise_hosts main "host list&!!" *
17453 .cindex "SMTPUTF8" "advertising"
17454 When Exim is built with support for internationalised mail names,
17455 the availability thereof is advertised in
17456 response to EHLO only to those client hosts that match this option. See
17457 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17458
17459
17460 .option spamd_address main string "127.0.0.1 783"
17461 This option is available when Exim is compiled with the content-scanning
17462 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17463 See section &<<SECTscanspamass>>& for more details.
17464
17465
17466
17467 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17468 This option is available when Exim is compiled with SPF support.
17469 See section &<<SECSPF>>& for more details.
17470
17471
17472
17473 .option split_spool_directory main boolean false
17474 .cindex "multiple spool directories"
17475 .cindex "spool directory" "split"
17476 .cindex "directories, multiple"
17477 If this option is set, it causes Exim to split its input directory into 62
17478 subdirectories, each with a single alphanumeric character as its name. The
17479 sixth character of the message id is used to allocate messages to
17480 subdirectories; this is the least significant base-62 digit of the time of
17481 arrival of the message.
17482
17483 Splitting up the spool in this way may provide better performance on systems
17484 where there are long mail queues, by reducing the number of files in any one
17485 directory. The msglog directory is also split up in a similar way to the input
17486 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17487 are still placed in the single directory &_msglog.OLD_&.
17488
17489 It is not necessary to take any special action for existing messages when
17490 changing &%split_spool_directory%&. Exim notices messages that are in the
17491 &"wrong"& place, and continues to process them. If the option is turned off
17492 after a period of being on, the subdirectories will eventually empty and be
17493 automatically deleted.
17494
17495 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17496 changes. Instead of creating a list of all messages in the queue, and then
17497 trying to deliver each one, in turn, it constructs a list of those in one
17498 sub-directory and tries to deliver them, before moving on to the next
17499 sub-directory. The sub-directories are processed in a random order. This
17500 spreads out the scanning of the input directories, and uses less memory. It is
17501 particularly beneficial when there are lots of messages in the queue. However,
17502 if &%queue_run_in_order%& is set, none of this new processing happens. The
17503 entire queue has to be scanned and sorted before any deliveries can start.
17504
17505
17506 .option spool_directory main string&!! "set at compile time"
17507 .cindex "spool directory" "path to"
17508 This defines the directory in which Exim keeps its spool, that is, the messages
17509 it is waiting to deliver. The default value is taken from the compile-time
17510 configuration setting, if there is one. If not, this option must be set. The
17511 string is expanded, so it can contain, for example, a reference to
17512 &$primary_hostname$&.
17513
17514 If the spool directory name is fixed on your installation, it is recommended
17515 that you set it at build time rather than from this option, particularly if the
17516 log files are being written to the spool directory (see &%log_file_path%&).
17517 Otherwise log files cannot be used for errors that are detected early on, such
17518 as failures in the configuration file.
17519
17520 By using this option to override the compiled-in path, it is possible to run
17521 tests of Exim without using the standard spool.
17522
17523 .option spool_wireformat main boolean false
17524 .cindex "spool directory" "file formats"
17525 If this option is set, Exim may for some messages use an alternative format
17526 for data-files in the spool which matches the wire format.
17527 Doing this permits more efficient message reception and transmission.
17528 Currently it is only done for messages received using the ESMTP CHUNKING
17529 option.
17530
17531 The following variables will not have useful values:
17532 .code
17533 $max_received_linelength
17534 $body_linecount
17535 $body_zerocount
17536 .endd
17537
17538 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17539 and any external programs which are passed a reference to a message data file
17540 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17541 will need to be aware of the different formats potentially available.
17542
17543 Using any of the ACL conditions noted will negate the reception benefit
17544 (as a Unix-mbox-format file is constructed for them).
17545 The transmission benefit is maintained.
17546
17547 .option sqlite_lock_timeout main time 5s
17548 .cindex "sqlite lookup type" "lock timeout"
17549 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17550 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17551
17552 .option strict_acl_vars main boolean false
17553 .cindex "&ACL;" "variables, handling unset"
17554 This option controls what happens if a syntactically valid but undefined ACL
17555 variable is referenced. If it is false (the default), an empty string
17556 is substituted; if it is true, an error is generated. See section
17557 &<<SECTaclvariables>>& for details of ACL variables.
17558
17559 .option strip_excess_angle_brackets main boolean false
17560 .cindex "angle brackets, excess"
17561 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17562 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17563 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17564 passed on to another MTA, the excess angle brackets are not passed on. If this
17565 option is not set, multiple pairs of angle brackets cause a syntax error.
17566
17567
17568 .option strip_trailing_dot main boolean false
17569 .cindex "trailing dot on domain"
17570 .cindex "dot" "trailing on domain"
17571 If this option is set, a trailing dot at the end of a domain in an address is
17572 ignored. If this is in the envelope and the message is passed on to another
17573 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17574 domain causes a syntax error.
17575 However, addresses in header lines are checked only when an ACL requests header
17576 syntax checking.
17577
17578
17579 .option syslog_duplication main boolean true
17580 .cindex "syslog" "duplicate log lines; suppressing"
17581 When Exim is logging to syslog, it writes the log lines for its three
17582 separate logs at different syslog priorities so that they can in principle
17583 be separated on the logging hosts. Some installations do not require this
17584 separation, and in those cases, the duplication of certain log lines is a
17585 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17586 particular log line is written to syslog. For lines that normally go to
17587 both the main log and the reject log, the reject log version (possibly
17588 containing message header lines) is written, at LOG_NOTICE priority.
17589 Lines that normally go to both the main and the panic log are written at
17590 the LOG_ALERT priority.
17591
17592
17593 .option syslog_facility main string unset
17594 .cindex "syslog" "facility; setting"
17595 This option sets the syslog &"facility"& name, used when Exim is logging to
17596 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17597 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17598 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17599 details of Exim's logging.
17600
17601
17602 .option syslog_pid main boolean true
17603 .cindex "syslog" "pid"
17604 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17605 omitted when these lines are sent to syslog. (Syslog normally prefixes
17606 the log lines with the PID of the logging process automatically.) You need
17607 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17608 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17609
17610
17611
17612 .option syslog_processname main string &`exim`&
17613 .cindex "syslog" "process name; setting"
17614 This option sets the syslog &"ident"& name, used when Exim is logging to
17615 syslog. The value must be no longer than 32 characters. See chapter
17616 &<<CHAPlog>>& for details of Exim's logging.
17617
17618
17619
17620 .option syslog_timestamp main boolean true
17621 .cindex "syslog" "timestamps"
17622 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17623 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17624 details of Exim's logging.
17625
17626
17627 .option system_filter main string&!! unset
17628 .cindex "filter" "system filter"
17629 .cindex "system filter" "specifying"
17630 .cindex "Sieve filter" "not available for system filter"
17631 This option specifies an Exim filter file that is applied to all messages at
17632 the start of each delivery attempt, before any routing is done. System filters
17633 must be Exim filters; they cannot be Sieve filters. If the system filter
17634 generates any deliveries to files or pipes, or any new mail messages, the
17635 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17636 which transports are to be used. Details of this facility are given in chapter
17637 &<<CHAPsystemfilter>>&.
17638 A forced expansion failure results in no filter operation.
17639
17640
17641 .option system_filter_directory_transport main string&!! unset
17642 .vindex "&$address_file$&"
17643 This sets the name of the transport driver that is to be used when the
17644 &%save%& command in a system message filter specifies a path ending in &"/"&,
17645 implying delivery of each message into a separate file in some directory.
17646 During the delivery, the variable &$address_file$& contains the path name.
17647
17648
17649 .option system_filter_file_transport main string&!! unset
17650 .cindex "file" "transport for system filter"
17651 This sets the name of the transport driver that is to be used when the &%save%&
17652 command in a system message filter specifies a path not ending in &"/"&. During
17653 the delivery, the variable &$address_file$& contains the path name.
17654
17655 .option system_filter_group main string unset
17656 .cindex "gid (group id)" "system filter"
17657 This option is used only when &%system_filter_user%& is also set. It sets the
17658 gid under which the system filter is run, overriding any gid that is associated
17659 with the user. The value may be numerical or symbolic.
17660
17661 .option system_filter_pipe_transport main string&!! unset
17662 .cindex "&(pipe)& transport" "for system filter"
17663 .vindex "&$address_pipe$&"
17664 This specifies the transport driver that is to be used when a &%pipe%& command
17665 is used in a system filter. During the delivery, the variable &$address_pipe$&
17666 contains the pipe command.
17667
17668
17669 .option system_filter_reply_transport main string&!! unset
17670 .cindex "&(autoreply)& transport" "for system filter"
17671 This specifies the transport driver that is to be used when a &%mail%& command
17672 is used in a system filter.
17673
17674
17675 .option system_filter_user main string unset
17676 .cindex "uid (user id)" "system filter"
17677 If this option is set to root, the system filter is run in the main Exim
17678 delivery process, as root.  Otherwise, the system filter runs in a separate
17679 process, as the given user, defaulting to the Exim run-time user.
17680 Unless the string consists entirely of digits, it
17681 is looked up in the password data. Failure to find the named user causes a
17682 configuration error. The gid is either taken from the password data, or
17683 specified by &%system_filter_group%&. When the uid is specified numerically,
17684 &%system_filter_group%& is required to be set.
17685
17686 If the system filter generates any pipe, file, or reply deliveries, the uid
17687 under which the filter is run is used when transporting them, unless a
17688 transport option overrides.
17689
17690
17691 .option tcp_nodelay main boolean true
17692 .cindex "daemon" "TCP_NODELAY on sockets"
17693 .cindex "Nagle algorithm"
17694 .cindex "TCP_NODELAY on listening sockets"
17695 If this option is set false, it stops the Exim daemon setting the
17696 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17697 turns off the &"Nagle algorithm"&, which is a way of improving network
17698 performance in interactive (character-by-character) situations. Turning it off
17699 should improve Exim's performance a bit, so that is what happens by default.
17700 However, it appears that some broken clients cannot cope, and time out. Hence
17701 this option. It affects only those sockets that are set up for listening by the
17702 daemon. Sockets created by the smtp transport for delivering mail always set
17703 TCP_NODELAY.
17704
17705
17706 .option timeout_frozen_after main time 0s
17707 .cindex "frozen messages" "timing out"
17708 .cindex "timeout" "frozen messages"
17709 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17710 message of any kind that has been in the queue for longer than the given time
17711 is automatically cancelled at the next queue run. If the frozen message is a
17712 bounce message, it is just discarded; otherwise, a bounce is sent to the
17713 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17714 If you want to timeout frozen bounce messages earlier than other kinds of
17715 frozen message, see &%ignore_bounce_errors_after%&.
17716
17717 &*Note:*& the default value of zero means no timeouts; with this setting,
17718 frozen messages remain in the queue forever (except for any frozen bounce
17719 messages that are released by &%ignore_bounce_errors_after%&).
17720
17721
17722 .option timezone main string unset
17723 .cindex "timezone, setting"
17724 .cindex "environment" "values from"
17725 The value of &%timezone%& is used to set the environment variable TZ while
17726 running Exim (if it is different on entry). This ensures that all timestamps
17727 created by Exim are in the required timezone. If you want all your timestamps
17728 to be in UTC (aka GMT) you should set
17729 .code
17730 timezone = UTC
17731 .endd
17732 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17733 or, if that is not set, from the value of the TZ environment variable when Exim
17734 is built. If &%timezone%& is set to the empty string, either at build or run
17735 time, any existing TZ variable is removed from the environment when Exim
17736 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17737 unfortunately not all, operating systems.
17738
17739
17740 .option tls_advertise_hosts main "host list&!!" *
17741 .cindex "TLS" "advertising"
17742 .cindex "encryption" "on SMTP connection"
17743 .cindex "SMTP" "encrypted connection"
17744 When Exim is built with support for TLS encrypted connections, the availability
17745 of the STARTTLS command to set up an encrypted session is advertised in
17746 response to EHLO only to those client hosts that match this option. See
17747 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17748 Note that the default value requires that a certificate be supplied
17749 using the &%tls_certificate%& option.  If TLS support for incoming connections
17750 is not required the &%tls_advertise_hosts%& option should be set empty.
17751
17752
17753 .option tls_certificate main string list&!! unset
17754 .cindex "TLS" "server certificate; location of"
17755 .cindex "certificate" "server, location of"
17756 The value of this option is expanded, and must then be a list of absolute paths to
17757 files which contain the server's certificates (in PEM format).
17758 Commonly only one file is needed.
17759 The server's private key is also
17760 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17761 &<<CHAPTLS>>& for further details.
17762
17763 &*Note*&: The certificates defined by this option are used only when Exim is
17764 receiving incoming messages as a server. If you want to supply certificates for
17765 use when sending messages as a client, you must set the &%tls_certificate%&
17766 option in the relevant &(smtp)& transport.
17767
17768 &*Note*&: If you use filenames based on IP addresses, change the list
17769 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17770
17771 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17772 when a list of more than one
17773 file is used, the &$tls_in_ourcert$& variable is unreliable.
17774 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17775
17776 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17777 if the OpenSSL build supports TLS extensions and the TLS client sends the
17778 Server Name Indication extension, then this option and others documented in
17779 &<<SECTtlssni>>& will be re-expanded.
17780
17781 If this option is unset or empty a fresh self-signed certificate will be
17782 generated for every connection.
17783
17784 .option tls_crl main string&!! unset
17785 .cindex "TLS" "server certificate revocation list"
17786 .cindex "certificate" "revocation list for server"
17787 This option specifies a certificate revocation list. The expanded value must
17788 be the name of a file that contains CRLs in PEM format.
17789
17790 Under OpenSSL the option can specify a directory with CRL files.
17791
17792 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17793 for each signing element of the certificate chain (i.e. all but the leaf).
17794 For the file variant this can be multiple PEM blocks in the one file.
17795
17796 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17797
17798
17799 .option tls_dh_max_bits main integer 2236
17800 .cindex "TLS" "D-H bit count"
17801 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17802 the chosen TLS library.  That value might prove to be too high for
17803 interoperability.  This option provides a maximum clamp on the value
17804 suggested, trading off security for interoperability.
17805
17806 The value must be at least 1024.
17807
17808 The value 2236 was chosen because, at time of adding the option, it was the
17809 hard-coded maximum value supported by the NSS cryptographic library, as used
17810 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17811
17812 If you prefer more security and are willing to break some clients, raise this
17813 number.
17814
17815 Note that the value passed to GnuTLS for *generating* a new prime may be a
17816 little less than this figure, because GnuTLS is inexact and may produce a
17817 larger prime than requested.
17818
17819
17820 .option tls_dhparam main string&!! unset
17821 .cindex "TLS" "D-H parameters for server"
17822 The value of this option is expanded and indicates the source of DH parameters
17823 to be used by Exim.
17824
17825 This option is ignored for GnuTLS version 3.6.0 and later.
17826 The library manages parameter negotiation internally.
17827
17828 &*Note: The Exim Maintainers strongly recommend,
17829 for other TLS library versions,
17830 using a filename with site-generated
17831 local DH parameters*&, which has been supported across all versions of Exim.  The
17832 other specific constants available are a fallback so that even when
17833 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17834
17835 If &%tls_dhparam%& is a filename starting with a &`/`&,
17836 then it names a file from which DH
17837 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17838 PKCS#3 representation of the DH prime.  If the file does not exist, for
17839 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17840 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17841 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17842 and treated as though the &%tls_dhparam%& were set to "none".
17843
17844 If this option expands to the string "none", then no DH parameters will be
17845 loaded by Exim.
17846
17847 If this option expands to the string "historic" and Exim is using GnuTLS, then
17848 Exim will attempt to load a file from inside the spool directory.  If the file
17849 does not exist, Exim will attempt to create it.
17850 See section &<<SECTgnutlsparam>>& for further details.
17851
17852 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17853 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17854
17855 In older versions of Exim the default was the 2048 bit prime described in section
17856 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17857 in IKE is assigned number 23.
17858
17859 Otherwise, the option must expand to the name used by Exim for any of a number
17860 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17861 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17862 the number used by IKE, or "default" which corresponds to
17863 &`exim.dev.20160529.3`&.
17864
17865 The available standard primes are:
17866 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17867 &`ike1`&, &`ike2`&, &`ike5`&,
17868 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17869 &`ike22`&, &`ike23`& and &`ike24`&.
17870
17871 The available additional primes are:
17872 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17873
17874 Some of these will be too small to be accepted by clients.
17875 Some may be too large to be accepted by clients.
17876 The open cryptographic community has suspicions about the integrity of some
17877 of the later IKE values, which led into RFC7919 providing new fixed constants
17878 (the "ffdhe" identifiers).
17879
17880 At this point, all of the "ike" values should be considered obsolete;
17881 they're still in Exim to avoid breaking unusual configurations, but are
17882 candidates for removal the next time we have backwards-incompatible changes.
17883
17884 The TLS protocol does not negotiate an acceptable size for this; clients tend
17885 to hard-drop connections if what is offered by the server is unacceptable,
17886 whether too large or too small, and there's no provision for the client to
17887 tell the server what these constraints are.  Thus, as a server operator, you
17888 need to make an educated guess as to what is most likely to work for your
17889 userbase.
17890
17891 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17892 is most likely to maximise interoperability.  The upper bound comes from
17893 applications using the Mozilla Network Security Services (NSS) library, which
17894 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17895 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17896 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17897 acceptable bound from 1024 to 2048.
17898
17899
17900 .option tls_eccurve main string&!! &`auto`&
17901 .cindex TLS "EC cryptography"
17902 This option selects a EC curve for use by Exim when used with OpenSSL.
17903 It has no effect when Exim is used with GnuTLS.
17904
17905 After expansion it must contain a valid EC curve parameter, such as
17906 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17907 for valid selections.
17908
17909 For OpenSSL versions before (and not including) 1.0.2, the string
17910 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17911 &`auto`& tells the library to choose.
17912
17913 If the option expands to an empty string, no EC curves will be enabled.
17914
17915
17916 .option tls_ocsp_file main string&!! unset
17917 .cindex TLS "certificate status"
17918 .cindex TLS "OCSP proof file"
17919 This option
17920 must if set expand to the absolute path to a file which contains a current
17921 status proof for the server's certificate, as obtained from the
17922 Certificate Authority.
17923
17924 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17925 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
17926
17927 For OpenSSL 1.1.0 or later, and
17928 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17929 of files, to match a list given for the &%tls_certificate%& option.
17930 The ordering of the two lists must match.
17931 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
17932
17933 The file(s) should be in DER format,
17934 except for GnuTLS 3.6.3 or later
17935 or for OpenSSL,
17936 when an optional filetype prefix can be used.
17937 The prefix must be one of "DER" or "PEM", followed by
17938 a single space.  If one is used it sets the format for subsequent
17939 files in the list; the initial format is DER.
17940 If multiple proofs are wanted, for multiple chain elements
17941 (this only works under TLS1.3)
17942 they must be coded as a combined OCSP response.
17943
17944 Although GnuTLS will accept PEM files with multiple separate
17945 PEM blobs (ie. separate OCSP responses), it sends them in the
17946 TLS Certificate record interleaved with the certificates of the chain;
17947 although a GnuTLS client is happy with that, an OpenSSL client is not.
17948
17949 .option tls_on_connect_ports main "string list" unset
17950 .cindex SSMTP
17951 .cindex SMTPS
17952 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17953 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17954 set up without waiting for the client to issue a STARTTLS command. For
17955 further details, see section &<<SECTsupobssmt>>&.
17956
17957
17958
17959 .option tls_privatekey main string list&!! unset
17960 .cindex "TLS" "server private key; location of"
17961 The value of this option is expanded, and must then be a list of absolute paths to
17962 files which contains the server's private keys.
17963 If this option is unset, or if
17964 the expansion is forced to fail, or the result is an empty string, the private
17965 key is assumed to be in the same file as the server's certificates. See chapter
17966 &<<CHAPTLS>>& for further details.
17967
17968 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17969
17970
17971 .option tls_remember_esmtp main boolean false
17972 .cindex "TLS" "esmtp state; remembering"
17973 .cindex "TLS" "broken clients"
17974 If this option is set true, Exim violates the RFCs by remembering that it is in
17975 &"esmtp"& state after successfully negotiating a TLS session. This provides
17976 support for broken clients that fail to send a new EHLO after starting a
17977 TLS session.
17978
17979
17980 .option tls_require_ciphers main string&!! unset
17981 .cindex "TLS" "requiring specific ciphers"
17982 .cindex "cipher" "requiring specific"
17983 This option controls which ciphers can be used for incoming TLS connections.
17984 The &(smtp)& transport has an option of the same name for controlling outgoing
17985 connections. This option is expanded for each connection, so can be varied for
17986 different clients if required. The value of this option must be a list of
17987 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17988 in somewhat different ways. If GnuTLS is being used, the client controls the
17989 preference order of the available ciphers. Details are given in sections
17990 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17991
17992
17993 .option tls_try_verify_hosts main "host list&!!" unset
17994 .cindex "TLS" "client certificate verification"
17995 .cindex "certificate" "verification of client"
17996 See &%tls_verify_hosts%& below.
17997
17998
17999 .option tls_verify_certificates main string&!! system
18000 .cindex "TLS" "client certificate verification"
18001 .cindex "certificate" "verification of client"
18002 The value of this option is expanded, and must then be either the
18003 word "system"
18004 or the absolute path to
18005 a file or directory containing permitted certificates for clients that
18006 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18007
18008 The "system" value for the option will use a
18009 system default location compiled into the SSL library.
18010 This is not available for GnuTLS versions preceding 3.0.20,
18011 and will be taken as empty; an explicit location
18012 must be specified.
18013
18014 The use of a directory for the option value is not available for GnuTLS versions
18015 preceding 3.3.6 and a single file must be used.
18016
18017 With OpenSSL the certificates specified
18018 explicitly
18019 either by file or directory
18020 are added to those given by the system default location.
18021
18022 These certificates should be for the certificate authorities trusted, rather
18023 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18024 the value is a file then the certificates are sent by Exim as a server to
18025 connecting clients, defining the list of accepted certificate authorities.
18026 Thus the values defined should be considered public data.  To avoid this,
18027 use the explicit directory version.
18028
18029 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18030
18031 A forced expansion failure or setting to an empty string is equivalent to
18032 being unset.
18033
18034
18035 .option tls_verify_hosts main "host list&!!" unset
18036 .cindex "TLS" "client certificate verification"
18037 .cindex "certificate" "verification of client"
18038 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18039 certificates from clients. The expected certificates are defined by
18040 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18041 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18042 &%tls_verify_certificates%& is not set.
18043
18044 Any client that matches &%tls_verify_hosts%& is constrained by
18045 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18046 present one of the listed certificates. If it does not, the connection is
18047 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18048 the host to use TLS. It can still send SMTP commands through unencrypted
18049 connections. Forcing a client to use TLS has to be done separately using an
18050 ACL to reject inappropriate commands when the connection is not encrypted.
18051
18052 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18053 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18054 certificate and checks it against &%tls_verify_certificates%&, but does not
18055 abort the connection if there is no certificate or if it does not match. This
18056 state can be detected in an ACL, which makes it possible to implement policies
18057 such as &"accept for relay only if a verified certificate has been received,
18058 but accept for local delivery if encrypted, even without a verified
18059 certificate"&.
18060
18061 Client hosts that match neither of these lists are not asked to present
18062 certificates.
18063
18064
18065 .option trusted_groups main "string list&!!" unset
18066 .cindex "trusted groups"
18067 .cindex "groups" "trusted"
18068 This option is expanded just once, at the start of Exim's processing. If this
18069 option is set, any process that is running in one of the listed groups, or
18070 which has one of them as a supplementary group, is trusted. The groups can be
18071 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18072 details of what trusted callers are permitted to do. If neither
18073 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18074 are trusted.
18075
18076 .option trusted_users main "string list&!!" unset
18077 .cindex "trusted users"
18078 .cindex "user" "trusted"
18079 This option is expanded just once, at the start of Exim's processing. If this
18080 option is set, any process that is running as one of the listed users is
18081 trusted. The users can be specified numerically or by name. See section
18082 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18083 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18084 Exim user are trusted.
18085
18086 .option unknown_login main string&!! unset
18087 .cindex "uid (user id)" "unknown caller"
18088 .vindex "&$caller_uid$&"
18089 This is a specialized feature for use in unusual configurations. By default, if
18090 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18091 gives up. The &%unknown_login%& option can be used to set a login name to be
18092 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18093 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18094 is used for the user's real name (gecos field), unless this has been set by the
18095 &%-F%& option.
18096
18097 .option unknown_username main string unset
18098 See &%unknown_login%&.
18099
18100 .option untrusted_set_sender main "address list&!!" unset
18101 .cindex "trusted users"
18102 .cindex "sender" "setting by untrusted user"
18103 .cindex "untrusted user setting sender"
18104 .cindex "user" "untrusted setting sender"
18105 .cindex "envelope from"
18106 .cindex "envelope sender"
18107 When an untrusted user submits a message to Exim using the standard input, Exim
18108 normally creates an envelope sender address from the user's login and the
18109 default qualification domain. Data from the &%-f%& option (for setting envelope
18110 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18111 is used) is ignored.
18112
18113 However, untrusted users are permitted to set an empty envelope sender address,
18114 to declare that a message should never generate any bounces. For example:
18115 .code
18116 exim -f '<>' user@domain.example
18117 .endd
18118 .vindex "&$sender_ident$&"
18119 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18120 other envelope sender addresses in a controlled way. When it is set, untrusted
18121 users are allowed to set envelope sender addresses that match any of the
18122 patterns in the list. Like all address lists, the string is expanded. The
18123 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18124 users to setting senders that start with their login ids
18125 followed by a hyphen
18126 by a setting like this:
18127 .code
18128 untrusted_set_sender = ^$sender_ident-
18129 .endd
18130 If you want to allow untrusted users to set envelope sender addresses without
18131 restriction, you can use
18132 .code
18133 untrusted_set_sender = *
18134 .endd
18135 The &%untrusted_set_sender%& option applies to all forms of local input, but
18136 only to the setting of the envelope sender. It does not permit untrusted users
18137 to use the other options which trusted user can use to override message
18138 parameters. Furthermore, it does not stop Exim from removing an existing
18139 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18140 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18141 overriding these actions. The handling of the &'Sender:'& header is also
18142 described in section &<<SECTthesenhea>>&.
18143
18144 The log line for a message's arrival shows the envelope sender following
18145 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18146 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18147 envelope sender address, the user's login is shown in parentheses after the
18148 sender address.
18149
18150
18151 .option uucp_from_pattern main string "see below"
18152 .cindex "&""From""& line"
18153 .cindex "UUCP" "&""From""& line"
18154 Some applications that pass messages to an MTA via a command line interface use
18155 an initial line starting with &"From&~"& to pass the envelope sender. In
18156 particular, this is used by UUCP software. Exim recognizes such a line by means
18157 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18158 matches, the sender address is constructed by expanding the contents of
18159 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18160 default pattern recognizes lines in the following two forms:
18161 .code
18162 From ph10 Fri Jan  5 12:35 GMT 1996
18163 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18164 .endd
18165 The pattern can be seen by running
18166 .code
18167 exim -bP uucp_from_pattern
18168 .endd
18169 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18170 year in the second case. The first word after &"From&~"& is matched in the
18171 regular expression by a parenthesized subpattern. The default value for
18172 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18173 (&"ph10"& in the example above) as the message's sender. See also
18174 &%ignore_fromline_hosts%&.
18175
18176
18177 .option uucp_from_sender main string&!! &`$1`&
18178 See &%uucp_from_pattern%& above.
18179
18180
18181 .option warn_message_file main string unset
18182 .cindex "warning of delay" "customizing the message"
18183 .cindex "customizing" "warning message"
18184 This option defines a template file containing paragraphs of text to be used
18185 for constructing the warning message which is sent by Exim when a message has
18186 been in the queue for a specified amount of time, as specified by
18187 &%delay_warning%&. Details of the file's contents are given in chapter
18188 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18189
18190
18191 .option write_rejectlog main boolean true
18192 .cindex "reject log" "disabling"
18193 If this option is set false, Exim no longer writes anything to the reject log.
18194 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18195 .ecindex IIDconfima
18196 .ecindex IIDmaiconf
18197
18198
18199
18200
18201 . ////////////////////////////////////////////////////////////////////////////
18202 . ////////////////////////////////////////////////////////////////////////////
18203
18204 .chapter "Generic options for routers" "CHAProutergeneric"
18205 .scindex IIDgenoprou1 "options" "generic; for routers"
18206 .scindex IIDgenoprou2 "generic options" "router"
18207 This chapter describes the generic options that apply to all routers.
18208 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18209
18210 For a general description of how a router operates, see sections
18211 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18212 which the preconditions are tested. The order of expansion of the options that
18213 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18214 &%headers_remove%&, &%transport%&.
18215
18216
18217
18218 .option address_data routers string&!! unset
18219 .cindex "router" "data attached to address"
18220 The string is expanded just before the router is run, that is, after all the
18221 precondition tests have succeeded. If the expansion is forced to fail, the
18222 router declines, the value of &%address_data%& remains unchanged, and the
18223 &%more%& option controls what happens next. Other expansion failures cause
18224 delivery of the address to be deferred.
18225
18226 .vindex "&$address_data$&"
18227 When the expansion succeeds, the value is retained with the address, and can be
18228 accessed using the variable &$address_data$& in the current router, subsequent
18229 routers, and the eventual transport.
18230
18231 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18232 that runs a user's filter file, the contents of &$address_data$& are accessible
18233 in the filter. This is not normally a problem, because such data is usually
18234 either not confidential or it &"belongs"& to the current user, but if you do
18235 put confidential data into &$address_data$& you need to remember this point.
18236
18237 Even if the router declines or passes, the value of &$address_data$& remains
18238 with the address, though it can be changed by another &%address_data%& setting
18239 on a subsequent router. If a router generates child addresses, the value of
18240 &$address_data$& propagates to them. This also applies to the special kind of
18241 &"child"& that is generated by a router with the &%unseen%& option.
18242
18243 The idea of &%address_data%& is that you can use it to look up a lot of data
18244 for the address once, and then pick out parts of the data later. For example,
18245 you could use a single LDAP lookup to return a string of the form
18246 .code
18247 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18248 .endd
18249 In the transport you could pick out the mailbox by a setting such as
18250 .code
18251 file = ${extract{mailbox}{$address_data}}
18252 .endd
18253 This makes the configuration file less messy, and also reduces the number of
18254 lookups (though Exim does cache lookups).
18255
18256 See also the &%set%& option below.
18257
18258 .vindex "&$sender_address_data$&"
18259 .vindex "&$address_data$&"
18260 The &%address_data%& facility is also useful as a means of passing information
18261 from one router to another, and from a router to a transport. In addition, if
18262 &$address_data$& is set by a router when verifying a recipient address from an
18263 ACL, it remains available for use in the rest of the ACL statement. After
18264 verifying a sender, the value is transferred to &$sender_address_data$&.
18265
18266
18267
18268 .option address_test routers&!? boolean true
18269 .oindex "&%-bt%&"
18270 .cindex "router" "skipping when address testing"
18271 If this option is set false, the router is skipped when routing is being tested
18272 by means of the &%-bt%& command line option. This can be a convenience when
18273 your first router sends messages to an external scanner, because it saves you
18274 having to set the &"already scanned"& indicator when testing real address
18275 routing.
18276
18277
18278
18279 .option cannot_route_message routers string&!! unset
18280 .cindex "router" "customizing &""cannot route""& message"
18281 .cindex "customizing" "&""cannot route""& message"
18282 This option specifies a text message that is used when an address cannot be
18283 routed because Exim has run out of routers. The default message is
18284 &"Unrouteable address"&. This option is useful only on routers that have
18285 &%more%& set false, or on the very last router in a configuration, because the
18286 value that is used is taken from the last router that is considered. This
18287 includes a router that is skipped because its preconditions are not met, as
18288 well as a router that declines. For example, using the default configuration,
18289 you could put:
18290 .code
18291 cannot_route_message = Remote domain not found in DNS
18292 .endd
18293 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18294 and
18295 .code
18296 cannot_route_message = Unknown local user
18297 .endd
18298 on the final router that checks for local users. If string expansion fails for
18299 this option, the default message is used. Unless the expansion failure was
18300 explicitly forced, a message about the failure is written to the main and panic
18301 logs, in addition to the normal message about the routing failure.
18302
18303
18304 .option caseful_local_part routers boolean false
18305 .cindex "case of local parts"
18306 .cindex "router" "case of local parts"
18307 By default, routers handle the local parts of addresses in a case-insensitive
18308 manner, though the actual case is preserved for transmission with the message.
18309 If you want the case of letters to be significant in a router, you must set
18310 this option true. For individual router options that contain address or local
18311 part lists (for example, &%local_parts%&), case-sensitive matching can be
18312 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18313 more details.
18314
18315 .vindex "&$local_part$&"
18316 .vindex "&$original_local_part$&"
18317 .vindex "&$parent_local_part$&"
18318 The value of the &$local_part$& variable is forced to lower case while a
18319 router is running unless &%caseful_local_part%& is set. When a router assigns
18320 an address to a transport, the value of &$local_part$& when the transport runs
18321 is the same as it was in the router. Similarly, when a router generates child
18322 addresses by aliasing or forwarding, the values of &$original_local_part$&
18323 and &$parent_local_part$& are those that were used by the redirecting router.
18324
18325 This option applies to the processing of an address by a router. When a
18326 recipient address is being processed in an ACL, there is a separate &%control%&
18327 modifier that can be used to specify case-sensitive processing within the ACL
18328 (see section &<<SECTcontrols>>&).
18329
18330
18331
18332 .option check_local_user routers&!? boolean false
18333 .cindex "local user, checking in router"
18334 .cindex "router" "checking for local user"
18335 .cindex "&_/etc/passwd_&"
18336 .vindex "&$home$&"
18337 When this option is true, Exim checks that the local part of the recipient
18338 address (with affixes removed if relevant) is the name of an account on the
18339 local system. The check is done by calling the &[getpwnam()]& function rather
18340 than trying to read &_/etc/passwd_& directly. This means that other methods of
18341 holding password data (such as NIS) are supported. If the local part is a local
18342 user, &$home$& is set from the password data, and can be tested in other
18343 preconditions that are evaluated after this one (the order of evaluation is
18344 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18345 overridden by &%router_home_directory%&. If the local part is not a local user,
18346 the router is skipped.
18347
18348 If you want to check that the local part is either the name of a local user
18349 or matches something else, you cannot combine &%check_local_user%& with a
18350 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18351 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18352 setting to achieve this. For example:
18353 .code
18354 local_parts = passwd;$local_part : lsearch;/etc/other/users
18355 .endd
18356 Note, however, that the side effects of &%check_local_user%& (such as setting
18357 up a home directory) do not occur when a &(passwd)& lookup is used in a
18358 &%local_parts%& (or any other) precondition.
18359
18360
18361
18362 .option condition routers&!? string&!! unset
18363 .cindex "router" "customized precondition"
18364 This option specifies a general precondition test that has to succeed for the
18365 router to be called. The &%condition%& option is the last precondition to be
18366 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18367 result is a forced failure, or an empty string, or one of the strings &"0"& or
18368 &"no"& or &"false"& (checked without regard to the case of the letters), the
18369 router is skipped, and the address is offered to the next one.
18370
18371 If the result is any other value, the router is run (as this is the last
18372 precondition to be evaluated, all the other preconditions must be true).
18373
18374 This option is unusual in that multiple &%condition%& options may be present.
18375 All &%condition%& options must succeed.
18376
18377 The &%condition%& option provides a means of applying custom conditions to the
18378 running of routers. Note that in the case of a simple conditional expansion,
18379 the default expansion values are exactly what is wanted. For example:
18380 .code
18381 condition = ${if >{$message_age}{600}}
18382 .endd
18383 Because of the default behaviour of the string expansion, this is equivalent to
18384 .code
18385 condition = ${if >{$message_age}{600}{true}{}}
18386 .endd
18387
18388 A multiple condition example, which succeeds:
18389 .code
18390 condition = ${if >{$message_age}{600}}
18391 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18392 condition = foobar
18393 .endd
18394
18395 If the expansion fails (other than forced failure) delivery is deferred. Some
18396 of the other precondition options are common special cases that could in fact
18397 be specified using &%condition%&.
18398
18399 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18400 are far older, and use one set of semantics.  ACLs are newer and when
18401 they were created, the ACL &%condition%& process was given far stricter
18402 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18403 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18404 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18405 Router rules processing behavior.
18406
18407 This is best illustrated in an example:
18408 .code
18409 # If used in an ACL condition will fail with a syntax error, but
18410 # in a router condition any extra characters are treated as a string
18411
18412 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18413 true {yes} {no}}
18414
18415 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18416  {yes} {no}}
18417 .endd
18418 In each example above, the &%if%& statement actually ends after
18419 &"{google.com}}"&.  Since no true or false braces were defined, the
18420 default &%if%& behavior is to return a boolean true or a null answer
18421 (which evaluates to false). The rest of the line is then treated as a
18422 string. So the first example resulted in the boolean answer &"true"&
18423 with the string &" {yes} {no}}"& appended to it. The second example
18424 resulted in the null output (indicating false) with the string
18425 &" {yes} {no}}"& appended to it.
18426
18427 In fact you can put excess forward braces in too.  In the router
18428 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18429 mean something, like after a &"$"& or when required as part of a
18430 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18431 string characters.
18432
18433 Thus, in a Router, the above expansion strings will both always evaluate
18434 true, as the result of expansion is a non-empty string which doesn't
18435 match an explicit false value.  This can be tricky to debug.  By
18436 contrast, in an ACL either of those strings will always result in an
18437 expansion error because the result doesn't look sufficiently boolean.
18438
18439
18440 .option debug_print routers string&!! unset
18441 .cindex "testing" "variables in drivers"
18442 If this option is set and debugging is enabled (see the &%-d%& command line
18443 option) or in address-testing mode (see the &%-bt%& command line option),
18444 the string is expanded and included in the debugging output.
18445 If expansion of the string fails, the error message is written to the debugging
18446 output, and Exim carries on processing.
18447 This option is provided to help with checking out the values of variables and
18448 so on when debugging router configurations. For example, if a &%condition%&
18449 option appears not to be working, &%debug_print%& can be used to output the
18450 variables it references. The output happens after checks for &%domains%&,
18451 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18452 are tested. A newline is added to the text if it does not end with one.
18453 The variable &$router_name$& contains the name of the router.
18454
18455
18456
18457 .option disable_logging routers boolean false
18458 If this option is set true, nothing is logged for any routing errors
18459 or for any deliveries caused by this router. You should not set this option
18460 unless you really, really know what you are doing. See also the generic
18461 transport option of the same name.
18462
18463 .option dnssec_request_domains routers "domain list&!!" *
18464 .cindex "MX record" "security"
18465 .cindex "DNSSEC" "MX lookup"
18466 .cindex "security" "MX lookup"
18467 .cindex "DNS" "DNSSEC"
18468 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18469 the dnssec request bit set.
18470 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18471
18472 .option dnssec_require_domains routers "domain list&!!" unset
18473 .cindex "MX record" "security"
18474 .cindex "DNSSEC" "MX lookup"
18475 .cindex "security" "MX lookup"
18476 .cindex "DNS" "DNSSEC"
18477 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18478 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18479 (AD bit) set will be ignored and logged as a host-lookup failure.
18480 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18481
18482
18483 .option domains routers&!? "domain list&!!" unset
18484 .cindex "router" "restricting to specific domains"
18485 .vindex "&$domain_data$&"
18486 If this option is set, the router is skipped unless the current domain matches
18487 the list. If the match is achieved by means of a file lookup, the data that the
18488 lookup returned for the domain is placed in &$domain_data$& for use in string
18489 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18490 a list of the order in which preconditions are evaluated.
18491
18492
18493
18494 .option driver routers string unset
18495 This option must always be set. It specifies which of the available routers is
18496 to be used.
18497
18498
18499 .option dsn_lasthop routers boolean false
18500 .cindex "DSN" "success"
18501 .cindex "Delivery Status Notification" "success"
18502 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18503 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18504 instead send a success DSN as if the next hop does not support DSN.
18505 Not effective on redirect routers.
18506
18507
18508
18509 .option errors_to routers string&!! unset
18510 .cindex "envelope from"
18511 .cindex "envelope sender"
18512 .cindex "router" "changing address for errors"
18513 If a router successfully handles an address, it may assign the address to a
18514 transport for delivery or it may generate child addresses. In both cases, if
18515 there is a delivery problem during later processing, the resulting bounce
18516 message is sent to the address that results from expanding this string,
18517 provided that the address verifies successfully. The &%errors_to%& option is
18518 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18519
18520 The &%errors_to%& setting associated with an address can be overridden if it
18521 subsequently passes through other routers that have their own &%errors_to%&
18522 settings, or if the message is delivered by a transport with a &%return_path%&
18523 setting.
18524
18525 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18526 the expansion fails to verify, the errors address associated with the incoming
18527 address is used. At top level, this is the envelope sender. A non-forced
18528 expansion failure causes delivery to be deferred.
18529
18530 If an address for which &%errors_to%& has been set ends up being delivered over
18531 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18532 any bounces that are generated by other MTAs on the delivery route are also
18533 sent there. You can set &%errors_to%& to the empty string by either of these
18534 settings:
18535 .code
18536 errors_to =
18537 errors_to = ""
18538 .endd
18539 An expansion item that yields an empty string has the same effect. If you do
18540 this, a locally detected delivery error for addresses processed by this router
18541 no longer gives rise to a bounce message; the error is discarded. If the
18542 address is delivered to a remote host, the return path is set to &`<>`&, unless
18543 overridden by the &%return_path%& option on the transport.
18544
18545 .vindex "&$address_data$&"
18546 If for some reason you want to discard local errors, but use a non-empty
18547 MAIL command for remote delivery, you can preserve the original return
18548 path in &$address_data$& in the router, and reinstate it in the transport by
18549 setting &%return_path%&.
18550
18551 The most common use of &%errors_to%& is to direct mailing list bounces to the
18552 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18553 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18554
18555
18556
18557 .option expn routers&!? boolean true
18558 .cindex "address" "testing"
18559 .cindex "testing" "addresses"
18560 .cindex "EXPN" "router skipping"
18561 .cindex "router" "skipping for EXPN"
18562 If this option is turned off, the router is skipped when testing an address
18563 as a result of processing an SMTP EXPN command. You might, for example,
18564 want to turn it off on a router for users' &_.forward_& files, while leaving it
18565 on for the system alias file.
18566 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18567 are evaluated.
18568
18569 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18570 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18571 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18572
18573
18574
18575 .option fail_verify routers boolean false
18576 .cindex "router" "forcing verification failure"
18577 Setting this option has the effect of setting both &%fail_verify_sender%& and
18578 &%fail_verify_recipient%& to the same value.
18579
18580
18581
18582 .option fail_verify_recipient routers boolean false
18583 If this option is true and an address is accepted by this router when
18584 verifying a recipient, verification fails.
18585
18586
18587
18588 .option fail_verify_sender routers boolean false
18589 If this option is true and an address is accepted by this router when
18590 verifying a sender, verification fails.
18591
18592
18593
18594 .option fallback_hosts routers "string list" unset
18595 .cindex "router" "fallback hosts"
18596 .cindex "fallback" "hosts specified on router"
18597 String expansion is not applied to this option. The argument must be a
18598 colon-separated list of host names or IP addresses. The list separator can be
18599 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18600 each name or address. In fact, the format of each item is exactly the same as
18601 defined for the list of hosts in a &(manualroute)& router (see section
18602 &<<SECTformatonehostitem>>&).
18603
18604 If a router queues an address for a remote transport, this host list is
18605 associated with the address, and used instead of the transport's fallback host
18606 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18607 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18608 transport for further details.
18609
18610
18611 .option group routers string&!! "see below"
18612 .cindex "gid (group id)" "local delivery"
18613 .cindex "local transports" "uid and gid"
18614 .cindex "transport" "local"
18615 .cindex "router" "setting group"
18616 When a router queues an address for a transport, and the transport does not
18617 specify a group, the group given here is used when running the delivery
18618 process.
18619 The group may be specified numerically or by name. If expansion fails, the
18620 error is logged and delivery is deferred.
18621 The default is unset, unless &%check_local_user%& is set, when the default
18622 is taken from the password information. See also &%initgroups%& and &%user%&
18623 and the discussion in chapter &<<CHAPenvironment>>&.
18624
18625
18626
18627 .option headers_add routers list&!! unset
18628 .cindex "header lines" "adding"
18629 .cindex "router" "adding header lines"
18630 This option specifies a list of text headers,
18631 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18632 that is associated with any addresses that are accepted by the router.
18633 Each item is separately expanded, at routing time.  However, this
18634 option has no effect when an address is just being verified. The way in which
18635 the text is used to add header lines at transport time is described in section
18636 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18637 message is in the process of being transported. This means that references to
18638 header lines in string expansions in the transport's configuration do not
18639 &"see"& the added header lines.
18640
18641 The &%headers_add%& option is expanded after &%errors_to%&, but before
18642 &%headers_remove%& and &%transport%&. If an item is empty, or if
18643 an item expansion is forced to fail, the item has no effect. Other expansion
18644 failures are treated as configuration errors.
18645
18646 Unlike most options, &%headers_add%& can be specified multiple times
18647 for a router; all listed headers are added.
18648
18649 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18650 router that has the &%one_time%& option set.
18651
18652 .cindex "duplicate addresses"
18653 .oindex "&%unseen%&"
18654 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18655 additions are deleted when the address is passed on to subsequent routers.
18656 For a &%redirect%& router, if a generated address is the same as the incoming
18657 address, this can lead to duplicate addresses with different header
18658 modifications. Exim does not do duplicate deliveries (except, in certain
18659 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18660 which of the duplicates is discarded, so this ambiguous situation should be
18661 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18662
18663
18664
18665 .option headers_remove routers list&!! unset
18666 .cindex "header lines" "removing"
18667 .cindex "router" "removing header lines"
18668 This option specifies a list of text headers,
18669 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18670 that is associated with any addresses that are accepted by the router.
18671 However, the option has no effect when an address is just being verified.
18672 Each list item is separately expanded, at transport time.
18673 .new
18674 If an item ends in *, it will match any header with the given prefix.
18675 .wen
18676 The way in which
18677 the text is used to remove header lines at transport time is described in
18678 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18679 the message is in the process of being transported. This means that references
18680 to header lines in string expansions in the transport's configuration still
18681 &"see"& the original header lines.
18682
18683 The &%headers_remove%& option is handled after &%errors_to%& and
18684 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18685 the item has no effect. Other expansion failures are treated as configuration
18686 errors.
18687
18688 Unlike most options, &%headers_remove%& can be specified multiple times
18689 for a router; all listed headers are removed.
18690
18691 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18692 router that has the &%one_time%& option set.
18693
18694 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18695 removal requests are deleted when the address is passed on to subsequent
18696 routers, and this can lead to problems with duplicates -- see the similar
18697 warning for &%headers_add%& above.
18698
18699 &*Warning 3*&: Because of the separate expansion of the list items,
18700 items that contain a list separator must have it doubled.
18701 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18702
18703
18704
18705 .option ignore_target_hosts routers "host list&!!" unset
18706 .cindex "IP address" "discarding"
18707 .cindex "router" "discarding IP addresses"
18708 Although this option is a host list, it should normally contain IP address
18709 entries rather than names. If any host that is looked up by the router has an
18710 IP address that matches an item in this list, Exim behaves as if that IP
18711 address did not exist. This option allows you to cope with rogue DNS entries
18712 like
18713 .code
18714 remote.domain.example.  A  127.0.0.1
18715 .endd
18716 by setting
18717 .code
18718 ignore_target_hosts = 127.0.0.1
18719 .endd
18720 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18721 discarded in this way, the router declines. In a conventional configuration, an
18722 attempt to mail to such a domain would normally provoke the &"unrouteable
18723 domain"& error, and an attempt to verify an address in the domain would fail.
18724 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18725 router declines if presented with one of the listed addresses.
18726
18727 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18728 means of the first or the second of the following settings, respectively:
18729 .code
18730 ignore_target_hosts = 0.0.0.0/0
18731 ignore_target_hosts = <; 0::0/0
18732 .endd
18733 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18734 in the second line matches all IPv6 addresses.
18735
18736 This option may also be useful for ignoring link-local and site-local IPv6
18737 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18738 is expanded before use as a list, it is possible to make it dependent on the
18739 domain that is being routed.
18740
18741 .vindex "&$host_address$&"
18742 During its expansion, &$host_address$& is set to the IP address that is being
18743 checked.
18744
18745 .option initgroups routers boolean false
18746 .cindex "additional groups"
18747 .cindex "groups" "additional"
18748 .cindex "local transports" "uid and gid"
18749 .cindex "transport" "local"
18750 If the router queues an address for a transport, and this option is true, and
18751 the uid supplied by the router is not overridden by the transport, the
18752 &[initgroups()]& function is called when running the transport to ensure that
18753 any additional groups associated with the uid are set up. See also &%group%&
18754 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18755
18756
18757
18758 .option local_part_prefix routers&!? "string list" unset
18759 .cindex affix "router precondition"
18760 .cindex "router" "prefix for local part"
18761 .cindex "prefix" "for local part, used in router"
18762 If this option is set, the router is skipped unless the local part starts with
18763 one of the given strings, or &%local_part_prefix_optional%& is true. See
18764 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18765 evaluated.
18766
18767 The list is scanned from left to right, and the first prefix that matches is
18768 used. A limited form of wildcard is available; if the prefix begins with an
18769 asterisk, it matches the longest possible sequence of arbitrary characters at
18770 the start of the local part. An asterisk should therefore always be followed by
18771 some character that does not occur in normal local parts.
18772 .cindex "multiple mailboxes"
18773 .cindex "mailbox" "multiple"
18774 Wildcarding can be used to set up multiple user mailboxes, as described in
18775 section &<<SECTmulbox>>&.
18776
18777 .vindex "&$local_part$&"
18778 .vindex "&$local_part_prefix$&"
18779 During the testing of the &%local_parts%& option, and while the router is
18780 running, the prefix is removed from the local part, and is available in the
18781 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18782 the router accepts the address, this remains true during subsequent delivery by
18783 a transport. In particular, the local part that is transmitted in the RCPT
18784 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18785 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18786 the relevant transport.
18787
18788 When an address is being verified, &%local_part_prefix%& affects only the
18789 behaviour of the router. If the callout feature of verification is in use, this
18790 means that the full address, including the prefix, will be used during the
18791 callout.
18792
18793 The prefix facility is commonly used to handle local parts of the form
18794 &%owner-something%&. Another common use is to support local parts of the form
18795 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18796 to tell a user their forwarding is broken &-- by placing a router like this one
18797 immediately before the router that handles &_.forward_& files:
18798 .code
18799 real_localuser:
18800   driver = accept
18801   local_part_prefix = real-
18802   check_local_user
18803   transport = local_delivery
18804 .endd
18805 For security, it would probably be a good idea to restrict the use of this
18806 router to locally-generated messages, using a condition such as this:
18807 .code
18808   condition = ${if match {$sender_host_address}\
18809                          {\N^(|127\.0\.0\.1)$\N}}
18810 .endd
18811
18812 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18813 both conditions must be met if not optional. Care must be taken if wildcards
18814 are used in both a prefix and a suffix on the same router. Different
18815 separator characters must be used to avoid ambiguity.
18816
18817
18818 .option local_part_prefix_optional routers boolean false
18819 See &%local_part_prefix%& above.
18820
18821
18822
18823 .option local_part_suffix routers&!? "string list" unset
18824 .cindex "router" "suffix for local part"
18825 .cindex "suffix for local part" "used in router"
18826 This option operates in the same way as &%local_part_prefix%&, except that the
18827 local part must end (rather than start) with the given string, the
18828 &%local_part_suffix_optional%& option determines whether the suffix is
18829 mandatory, and the wildcard * character, if present, must be the last
18830 character of the suffix. This option facility is commonly used to handle local
18831 parts of the form &%something-request%& and multiple user mailboxes of the form
18832 &%username-foo%&.
18833
18834
18835 .option local_part_suffix_optional routers boolean false
18836 See &%local_part_suffix%& above.
18837
18838
18839
18840 .option local_parts routers&!? "local part list&!!" unset
18841 .cindex "router" "restricting to specific local parts"
18842 .cindex "local part" "checking in router"
18843 The router is run only if the local part of the address matches the list.
18844 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18845 are evaluated, and
18846 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18847 string is expanded, it is possible to make it depend on the domain, for
18848 example:
18849 .code
18850 local_parts = dbm;/usr/local/specials/$domain
18851 .endd
18852 .vindex "&$local_part_data$&"
18853 If the match is achieved by a lookup, the data that the lookup returned
18854 for the local part is placed in the variable &$local_part_data$& for use in
18855 expansions of the router's private options. You might use this option, for
18856 example, if you have a large number of local virtual domains, and you want to
18857 send all postmaster mail to the same place without having to set up an alias in
18858 each virtual domain:
18859 .code
18860 postmaster:
18861   driver = redirect
18862   local_parts = postmaster
18863   data = postmaster@real.domain.example
18864 .endd
18865
18866
18867 .option log_as_local routers boolean "see below"
18868 .cindex "log" "delivery line"
18869 .cindex "delivery" "log line format"
18870 Exim has two logging styles for delivery, the idea being to make local
18871 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18872 recipient address is given just as the local part, without a domain. The use of
18873 this style is controlled by this option. It defaults to true for the &(accept)&
18874 router, and false for all the others. This option applies only when a
18875 router assigns an address to a transport. It has no effect on routers that
18876 redirect addresses.
18877
18878
18879
18880 .option more routers boolean&!! true
18881 The result of string expansion for this option must be a valid boolean value,
18882 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18883 result causes an error, and delivery is deferred. If the expansion is forced to
18884 fail, the default value for the option (true) is used. Other failures cause
18885 delivery to be deferred.
18886
18887 If this option is set false, and the router declines to handle the address, no
18888 further routers are tried, routing fails, and the address is bounced.
18889 .oindex "&%self%&"
18890 However, if the router explicitly passes an address to the following router by
18891 means of the setting
18892 .code
18893 self = pass
18894 .endd
18895 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18896 does not affect the behaviour if one of the precondition tests fails. In that
18897 case, the address is always passed to the next router.
18898
18899 Note that &%address_data%& is not considered to be a precondition. If its
18900 expansion is forced to fail, the router declines, and the value of &%more%&
18901 controls what happens next.
18902
18903
18904 .option pass_on_timeout routers boolean false
18905 .cindex "timeout" "of router"
18906 .cindex "router" "timeout"
18907 If a router times out during a host lookup, it normally causes deferral of the
18908 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18909 router, overriding &%no_more%&. This may be helpful for systems that are
18910 intermittently connected to the Internet, or those that want to pass to a smart
18911 host any messages that cannot immediately be delivered.
18912
18913 There are occasional other temporary errors that can occur while doing DNS
18914 lookups. They are treated in the same way as a timeout, and this option
18915 applies to all of them.
18916
18917
18918
18919 .option pass_router routers string unset
18920 .cindex "router" "go to after &""pass""&"
18921 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18922 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18923 routing to continue, and overriding a false setting of &%more%&. When one of
18924 these routers returns &"pass"&, the address is normally handed on to the next
18925 router in sequence. This can be changed by setting &%pass_router%& to the name
18926 of another router. However (unlike &%redirect_router%&) the named router must
18927 be below the current router, to avoid loops. Note that this option applies only
18928 to the special case of &"pass"&. It does not apply when a router returns
18929 &"decline"& because it cannot handle an address.
18930
18931
18932
18933 .option redirect_router routers string unset
18934 .cindex "router" "start at after redirection"
18935 Sometimes an administrator knows that it is pointless to reprocess addresses
18936 generated from alias or forward files with the same router again. For
18937 example, if an alias file translates real names into login ids there is no
18938 point searching the alias file a second time, especially if it is a large file.
18939
18940 The &%redirect_router%& option can be set to the name of any router instance.
18941 It causes the routing of any generated addresses to start at the named router
18942 instead of at the first router. This option has no effect if the router in
18943 which it is set does not generate new addresses.
18944
18945
18946
18947 .option require_files routers&!? "string list&!!" unset
18948 .cindex "file" "requiring for router"
18949 .cindex "router" "requiring file existence"
18950 This option provides a general mechanism for predicating the running of a
18951 router on the existence or non-existence of certain files or directories.
18952 Before running a router, as one of its precondition tests, Exim works its way
18953 through the &%require_files%& list, expanding each item separately.
18954
18955 Because the list is split before expansion, any colons in expansion items must
18956 be doubled, or the facility for using a different list separator must be used
18957 (&<<SECTlistsepchange>>&).
18958 If any expansion is forced to fail, the item is ignored. Other expansion
18959 failures cause routing of the address to be deferred.
18960
18961 If any expanded string is empty, it is ignored. Otherwise, except as described
18962 below, each string must be a fully qualified file path, optionally preceded by
18963 &"!"&. The paths are passed to the &[stat()]& function to test for the
18964 existence of the files or directories. The router is skipped if any paths not
18965 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18966
18967 .cindex "NFS"
18968 If &[stat()]& cannot determine whether a file exists or not, delivery of
18969 the message is deferred. This can happen when NFS-mounted filesystems are
18970 unavailable.
18971
18972 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18973 options, so you cannot use it to check for the existence of a file in which to
18974 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18975 full list of the order in which preconditions are evaluated.) However, as
18976 these options are all expanded, you can use the &%exists%& expansion condition
18977 to make such tests. The &%require_files%& option is intended for checking files
18978 that the router may be going to use internally, or which are needed by a
18979 transport (e.g., &_.procmailrc_&).
18980
18981 During delivery, the &[stat()]& function is run as root, but there is a
18982 facility for some checking of the accessibility of a file by another user.
18983 This is not a proper permissions check, but just a &"rough"& check that
18984 operates as follows:
18985
18986 If an item in a &%require_files%& list does not contain any forward slash
18987 characters, it is taken to be the user (and optional group, separated by a
18988 comma) to be checked for subsequent files in the list. If no group is specified
18989 but the user is specified symbolically, the gid associated with the uid is
18990 used. For example:
18991 .code
18992 require_files = mail:/some/file
18993 require_files = $local_part:$home/.procmailrc
18994 .endd
18995 If a user or group name in a &%require_files%& list does not exist, the
18996 &%require_files%& condition fails.
18997
18998 Exim performs the check by scanning along the components of the file path, and
18999 checking the access for the given uid and gid. It checks for &"x"& access on
19000 directories, and &"r"& access on the final file. Note that this means that file
19001 access control lists, if the operating system has them, are ignored.
19002
19003 &*Warning 1*&: When the router is being run to verify addresses for an
19004 incoming SMTP message, Exim is not running as root, but under its own uid. This
19005 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19006 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19007 user is not permitted to read one of the directories on the file's path.
19008
19009 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19010 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19011 without root access. In this case, if a check for access by a particular user
19012 is requested, Exim creates a subprocess that runs as that user, and tries the
19013 check again in that process.
19014
19015 The default action for handling an unresolved EACCES is to consider it to
19016 be caused by a configuration error, and routing is deferred because the
19017 existence or non-existence of the file cannot be determined. However, in some
19018 circumstances it may be desirable to treat this condition as if the file did
19019 not exist. If the filename (or the exclamation mark that precedes the filename
19020 for non-existence) is preceded by a plus sign, the EACCES error is treated
19021 as if the file did not exist. For example:
19022 .code
19023 require_files = +/some/file
19024 .endd
19025 If the router is not an essential part of verification (for example, it
19026 handles users' &_.forward_& files), another solution is to set the &%verify%&
19027 option false so that the router is skipped when verifying.
19028
19029
19030
19031 .option retry_use_local_part routers boolean "see below"
19032 .cindex "hints database" "retry keys"
19033 .cindex "local part" "in retry keys"
19034 When a delivery suffers a temporary routing failure, a retry record is created
19035 in Exim's hints database. For addresses whose routing depends only on the
19036 domain, the key for the retry record should not involve the local part, but for
19037 other addresses, both the domain and the local part should be included.
19038 Usually, remote routing is of the former kind, and local routing is of the
19039 latter kind.
19040
19041 This option controls whether the local part is used to form the key for retry
19042 hints for addresses that suffer temporary errors while being handled by this
19043 router. The default value is true for any router that has any of
19044 &%check_local_user%&,
19045 &%local_parts%&,
19046 &%condition%&,
19047 &%local_part_prefix%&,
19048 &%local_part_suffix%&,
19049 &%senders%& or
19050 &%require_files%&
19051 set, and false otherwise. Note that this option does not apply to hints keys
19052 for transport delays; they are controlled by a generic transport option of the
19053 same name.
19054
19055 Failing to set this option when it is needed
19056 (because a remote router handles only some of the local-parts for a domain)
19057 can result in incorrect error messages being generated.
19058
19059 The setting of &%retry_use_local_part%& applies only to the router on which it
19060 appears. If the router generates child addresses, they are routed
19061 independently; this setting does not become attached to them.
19062
19063
19064
19065 .option router_home_directory routers string&!! unset
19066 .cindex "router" "home directory for"
19067 .cindex "home directory" "for router"
19068 .vindex "&$home$&"
19069 This option sets a home directory for use while the router is running. (Compare
19070 &%transport_home_directory%&, which sets a home directory for later
19071 transporting.) In particular, if used on a &(redirect)& router, this option
19072 sets a value for &$home$& while a filter is running. The value is expanded;
19073 forced expansion failure causes the option to be ignored &-- other failures
19074 cause the router to defer.
19075
19076 Expansion of &%router_home_directory%& happens immediately after the
19077 &%check_local_user%& test (if configured), before any further expansions take
19078 place.
19079 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19080 are evaluated.)
19081 While the router is running, &%router_home_directory%& overrides the value of
19082 &$home$& that came from &%check_local_user%&.
19083
19084 When a router accepts an address and assigns it to a local transport (including
19085 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19086 delivery), the home directory setting for the transport is taken from the first
19087 of these values that is set:
19088
19089 .ilist
19090 The &%home_directory%& option on the transport;
19091 .next
19092 The &%transport_home_directory%& option on the router;
19093 .next
19094 The password data if &%check_local_user%& is set on the router;
19095 .next
19096 The &%router_home_directory%& option on the router.
19097 .endlist
19098
19099 In other words, &%router_home_directory%& overrides the password data for the
19100 router, but not for the transport.
19101
19102
19103
19104 .option self routers string freeze
19105 .cindex "MX record" "pointing to local host"
19106 .cindex "local host" "MX pointing to"
19107 This option applies to those routers that use a recipient address to find a
19108 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19109 and &(manualroute)& routers.
19110 Certain configurations of the &(queryprogram)& router can also specify a list
19111 of remote hosts.
19112 Usually such routers are configured to send the message to a remote host via an
19113 &(smtp)& transport. The &%self%& option specifies what happens when the first
19114 host on the list turns out to be the local host.
19115 The way in which Exim checks for the local host is described in section
19116 &<<SECTreclocipadd>>&.
19117
19118 Normally this situation indicates either an error in Exim's configuration (for
19119 example, the router should be configured not to process this domain), or an
19120 error in the DNS (for example, the MX should not point to this host). For this
19121 reason, the default action is to log the incident, defer the address, and
19122 freeze the message. The following alternatives are provided for use in special
19123 cases:
19124
19125 .vlist
19126 .vitem &%defer%&
19127 Delivery of the message is tried again later, but the message is not frozen.
19128
19129 .vitem "&%reroute%&: <&'domain'&>"
19130 The domain is changed to the given domain, and the address is passed back to
19131 be reprocessed by the routers. No rewriting of headers takes place. This
19132 behaviour is essentially a redirection.
19133
19134 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19135 The domain is changed to the given domain, and the address is passed back to be
19136 reprocessed by the routers. Any headers that contain the original domain are
19137 rewritten.
19138
19139 .vitem &%pass%&
19140 .oindex "&%more%&"
19141 .vindex "&$self_hostname$&"
19142 The router passes the address to the next router, or to the router named in the
19143 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19144 subsequent routing and delivery, the variable &$self_hostname$& contains the
19145 name of the local host that the router encountered. This can be used to
19146 distinguish between different cases for hosts with multiple names. The
19147 combination
19148 .code
19149 self = pass
19150 no_more
19151 .endd
19152 ensures that only those addresses that routed to the local host are passed on.
19153 Without &%no_more%&, addresses that were declined for other reasons would also
19154 be passed to the next router.
19155
19156 .vitem &%fail%&
19157 Delivery fails and an error report is generated.
19158
19159 .vitem &%send%&
19160 .cindex "local host" "sending to"
19161 The anomaly is ignored and the address is queued for the transport. This
19162 setting should be used with extreme caution. For an &(smtp)& transport, it
19163 makes sense only in cases where the program that is listening on the SMTP port
19164 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19165 different configuration file that handles the domain in another way.
19166 .endlist
19167
19168
19169
19170 .option senders routers&!? "address list&!!" unset
19171 .cindex "router" "checking senders"
19172 If this option is set, the router is skipped unless the message's sender
19173 address matches something on the list.
19174 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19175 are evaluated.
19176
19177 There are issues concerning verification when the running of routers is
19178 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19179 setting, it sets the sender to the null string. When using the &%-bt%& option
19180 to check a configuration file, it is necessary also to use the &%-f%& option to
19181 set an appropriate sender. For incoming mail, the sender is unset when
19182 verifying the sender, but is available when verifying any recipients. If the
19183 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19184 matters.
19185
19186
19187 .option set routers "string list" unset
19188 .cindex router variables
19189 This option may be used multiple times on a router;
19190 because of this the list aspect is mostly irrelevant.
19191 The list separator is a semicolon but can be changed in the
19192 usual way.
19193
19194 Each list-element given must be of the form &"name = value"&
19195 and the names used must start with the string &"r_"&.
19196 Values containing a list-separator should have them doubled.
19197 When a router runs, the strings are evaluated in order,
19198 to create variables which are added to the set associated with
19199 the address.
19200 The variable is set with the expansion of the value.
19201 The variables can be used by the router options
19202 (not including any preconditions)
19203 and by the transport.
19204 Later definitions of a given named variable will override former ones.
19205 Variable use is via the usual &$r_...$& syntax.
19206
19207 This is similar to the &%address_data%& option, except that
19208 many independent variables can be used, with choice of naming.
19209
19210
19211 .option translate_ip_address routers string&!! unset
19212 .cindex "IP address" "translating"
19213 .cindex "packet radio"
19214 .cindex "router" "IP address translation"
19215 There exist some rare networking situations (for example, packet radio) where
19216 it is helpful to be able to translate IP addresses generated by normal routing
19217 mechanisms into other IP addresses, thus performing a kind of manual IP
19218 routing. This should be done only if the normal IP routing of the TCP/IP stack
19219 is inadequate or broken. Because this is an extremely uncommon requirement, the
19220 code to support this option is not included in the Exim binary unless
19221 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19222
19223 .vindex "&$host_address$&"
19224 The &%translate_ip_address%& string is expanded for every IP address generated
19225 by the router, with the generated address set in &$host_address$&. If the
19226 expansion is forced to fail, no action is taken.
19227 For any other expansion error, delivery of the message is deferred.
19228 If the result of the expansion is an IP address, that replaces the original
19229 address; otherwise the result is assumed to be a host name &-- this is looked
19230 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19231 produce one or more replacement IP addresses. For example, to subvert all IP
19232 addresses in some specific networks, this could be added to a router:
19233 .code
19234 translate_ip_address = \
19235   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19236     {$value}fail}}
19237 .endd
19238 The file would contain lines like
19239 .code
19240 10.2.3.128/26    some.host
19241 10.8.4.34/26     10.44.8.15
19242 .endd
19243 You should not make use of this facility unless you really understand what you
19244 are doing.
19245
19246
19247
19248 .option transport routers string&!! unset
19249 This option specifies the transport to be used when a router accepts an address
19250 and sets it up for delivery. A transport is never needed if a router is used
19251 only for verification. The value of the option is expanded at routing time,
19252 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19253 and result must be the name of one of the configured transports. If it is not,
19254 delivery is deferred.
19255
19256 The &%transport%& option is not used by the &(redirect)& router, but it does
19257 have some private options that set up transports for pipe and file deliveries
19258 (see chapter &<<CHAPredirect>>&).
19259
19260
19261
19262 .option transport_current_directory routers string&!! unset
19263 .cindex "current directory for local transport"
19264 This option associates a current directory with any address that is routed
19265 to a local transport. This can happen either because a transport is
19266 explicitly configured for the router, or because it generates a delivery to a
19267 file or a pipe. During the delivery process (that is, at transport time), this
19268 option string is expanded and is set as the current directory, unless
19269 overridden by a setting on the transport.
19270 If the expansion fails for any reason, including forced failure, an error is
19271 logged, and delivery is deferred.
19272 See chapter &<<CHAPenvironment>>& for details of the local delivery
19273 environment.
19274
19275
19276
19277
19278 .option transport_home_directory routers string&!! "see below"
19279 .cindex "home directory" "for local transport"
19280 This option associates a home directory with any address that is routed to a
19281 local transport. This can happen either because a transport is explicitly
19282 configured for the router, or because it generates a delivery to a file or a
19283 pipe. During the delivery process (that is, at transport time), the option
19284 string is expanded and is set as the home directory, unless overridden by a
19285 setting of &%home_directory%& on the transport.
19286 If the expansion fails for any reason, including forced failure, an error is
19287 logged, and delivery is deferred.
19288
19289 If the transport does not specify a home directory, and
19290 &%transport_home_directory%& is not set for the router, the home directory for
19291 the transport is taken from the password data if &%check_local_user%& is set for
19292 the router. Otherwise it is taken from &%router_home_directory%& if that option
19293 is set; if not, no home directory is set for the transport.
19294
19295 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19296 environment.
19297
19298
19299
19300
19301 .option unseen routers boolean&!! false
19302 .cindex "router" "carrying on after success"
19303 The result of string expansion for this option must be a valid boolean value,
19304 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19305 result causes an error, and delivery is deferred. If the expansion is forced to
19306 fail, the default value for the option (false) is used. Other failures cause
19307 delivery to be deferred.
19308
19309 When this option is set true, routing does not cease if the router accepts the
19310 address. Instead, a copy of the incoming address is passed to the next router,
19311 overriding a false setting of &%more%&. There is little point in setting
19312 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19313 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19314 sometimes true and sometimes false).
19315
19316 .cindex "copy of message (&%unseen%& option)"
19317 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19318 qualifier in filter files. It can be used to cause copies of messages to be
19319 delivered to some other destination, while also carrying out a normal delivery.
19320 In effect, the current address is made into a &"parent"& that has two children
19321 &-- one that is delivered as specified by this router, and a clone that goes on
19322 to be routed further. For this reason, &%unseen%& may not be combined with the
19323 &%one_time%& option in a &(redirect)& router.
19324
19325 &*Warning*&: Header lines added to the address (or specified for removal) by
19326 this router or by previous routers affect the &"unseen"& copy of the message
19327 only. The clone that continues to be processed by further routers starts with
19328 no added headers and none specified for removal. For a &%redirect%& router, if
19329 a generated address is the same as the incoming address, this can lead to
19330 duplicate addresses with different header modifications. Exim does not do
19331 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19332 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19333 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19334 &%redirect%& router may be of help.
19335
19336 Unlike the handling of header modifications, any data that was set by the
19337 &%address_data%& option in the current or previous routers &'is'& passed on to
19338 subsequent routers.
19339
19340
19341 .option user routers string&!! "see below"
19342 .cindex "uid (user id)" "local delivery"
19343 .cindex "local transports" "uid and gid"
19344 .cindex "transport" "local"
19345 .cindex "router" "user for filter processing"
19346 .cindex "filter" "user for processing"
19347 When a router queues an address for a transport, and the transport does not
19348 specify a user, the user given here is used when running the delivery process.
19349 The user may be specified numerically or by name. If expansion fails, the
19350 error is logged and delivery is deferred.
19351 This user is also used by the &(redirect)& router when running a filter file.
19352 The default is unset, except when &%check_local_user%& is set. In this case,
19353 the default is taken from the password information. If the user is specified as
19354 a name, and &%group%& is not set, the group associated with the user is used.
19355 See also &%initgroups%& and &%group%& and the discussion in chapter
19356 &<<CHAPenvironment>>&.
19357
19358
19359
19360 .option verify routers&!? boolean true
19361 Setting this option has the effect of setting &%verify_sender%& and
19362 &%verify_recipient%& to the same value.
19363
19364
19365 .option verify_only routers&!? boolean false
19366 .cindex "EXPN" "with &%verify_only%&"
19367 .oindex "&%-bv%&"
19368 .cindex "router" "used only when verifying"
19369 If this option is set, the router is used only when verifying an address,
19370 delivering in cutthrough mode or
19371 testing with the &%-bv%& option, not when actually doing a delivery, testing
19372 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19373 restricted to verifying only senders or recipients by means of
19374 &%verify_sender%& and &%verify_recipient%&.
19375
19376 &*Warning*&: When the router is being run to verify addresses for an incoming
19377 SMTP message, Exim is not running as root, but under its own uid. If the router
19378 accesses any files, you need to make sure that they are accessible to the Exim
19379 user or group.
19380
19381
19382 .option verify_recipient routers&!? boolean true
19383 If this option is false, the router is skipped when verifying recipient
19384 addresses,
19385 delivering in cutthrough mode
19386 or testing recipient verification using &%-bv%&.
19387 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19388 are evaluated.
19389 See also the &$verify_mode$& variable.
19390
19391
19392 .option verify_sender routers&!? boolean true
19393 If this option is false, the router is skipped when verifying sender addresses
19394 or testing sender verification using &%-bvs%&.
19395 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19396 are evaluated.
19397 See also the &$verify_mode$& variable.
19398 .ecindex IIDgenoprou1
19399 .ecindex IIDgenoprou2
19400
19401
19402
19403
19404
19405
19406 . ////////////////////////////////////////////////////////////////////////////
19407 . ////////////////////////////////////////////////////////////////////////////
19408
19409 .chapter "The accept router" "CHID4"
19410 .cindex "&(accept)& router"
19411 .cindex "routers" "&(accept)&"
19412 The &(accept)& router has no private options of its own. Unless it is being
19413 used purely for verification (see &%verify_only%&) a transport is required to
19414 be defined by the generic &%transport%& option. If the preconditions that are
19415 specified by generic options are met, the router accepts the address and queues
19416 it for the given transport. The most common use of this router is for setting
19417 up deliveries to local mailboxes. For example:
19418 .code
19419 localusers:
19420   driver = accept
19421   domains = mydomain.example
19422   check_local_user
19423   transport = local_delivery
19424 .endd
19425 The &%domains%& condition in this example checks the domain of the address, and
19426 &%check_local_user%& checks that the local part is the login of a local user.
19427 When both preconditions are met, the &(accept)& router runs, and queues the
19428 address for the &(local_delivery)& transport.
19429
19430
19431
19432
19433
19434
19435 . ////////////////////////////////////////////////////////////////////////////
19436 . ////////////////////////////////////////////////////////////////////////////
19437
19438 .chapter "The dnslookup router" "CHAPdnslookup"
19439 .scindex IIDdnsrou1 "&(dnslookup)& router"
19440 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19441 The &(dnslookup)& router looks up the hosts that handle mail for the
19442 recipient's domain in the DNS. A transport must always be set for this router,
19443 unless &%verify_only%& is set.
19444
19445 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19446 SRV records. If none are found, or if SRV support is not configured,
19447 MX records are looked up. If no MX records exist, address records are sought.
19448 However, &%mx_domains%& can be set to disable the direct use of address
19449 records.
19450
19451 MX records of equal priority are sorted by Exim into a random order. Exim then
19452 looks for address records for the host names obtained from MX or SRV records.
19453 When a host has more than one IP address, they are sorted into a random order,
19454 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19455 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19456 generic option, the router declines.
19457
19458 Unless they have the highest priority (lowest MX value), MX records that point
19459 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19460 are discarded, together with any other MX records of equal or lower priority.
19461
19462 .cindex "MX record" "pointing to local host"
19463 .cindex "local host" "MX pointing to"
19464 .oindex "&%self%&" "in &(dnslookup)& router"
19465 If the host pointed to by the highest priority MX record, or looked up as an
19466 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19467 happens is controlled by the generic &%self%& option.
19468
19469
19470 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19471 There have been problems with DNS servers when SRV records are looked up.
19472 Some misbehaving servers return a DNS error or timeout when a non-existent
19473 SRV record is sought. Similar problems have in the past been reported for
19474 MX records. The global &%dns_again_means_nonexist%& option can help with this
19475 problem, but it is heavy-handed because it is a global option.
19476
19477 For this reason, there are two options, &%srv_fail_domains%& and
19478 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19479 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19480 an attempt to look up an SRV or MX record causes one of these results, and the
19481 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19482 such record"&. In the case of an SRV lookup, this means that the router
19483 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19484 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19485 case routing fails.
19486
19487
19488 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19489 .cindex "&(dnslookup)& router" "declines"
19490 There are a few cases where a &(dnslookup)& router will decline to accept
19491 an address; if such a router is expected to handle "all remaining non-local
19492 domains", then it is important to set &%no_more%&.
19493
19494 The router will defer rather than decline if the domain
19495 is found in the &%fail_defer_domains%& router option.
19496
19497 Reasons for a &(dnslookup)& router to decline currently include:
19498 .ilist
19499 The domain does not exist in DNS
19500 .next
19501 The domain exists but the MX record's host part is just "."; this is a common
19502 convention (borrowed from SRV) used to indicate that there is no such service
19503 for this domain and to not fall back to trying A/AAAA records.
19504 .next
19505 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19506 .next
19507 MX record points to a non-existent host.
19508 .next
19509 MX record points to an IP address and the main section option
19510 &%allow_mx_to_ip%& is not set.
19511 .next
19512 MX records exist and point to valid hosts, but all hosts resolve only to
19513 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19514 .next
19515 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19516 &%dns_check_names_pattern%& for handling one variant of this)
19517 .next
19518 &%check_secondary_mx%& is set on this router but the local host can
19519 not be found in the MX records (see below)
19520 .endlist
19521
19522
19523
19524
19525 .section "Private options for dnslookup" "SECID118"
19526 .cindex "options" "&(dnslookup)& router"
19527 The private options for the &(dnslookup)& router are as follows:
19528
19529 .option check_secondary_mx dnslookup boolean false
19530 .cindex "MX record" "checking for secondary"
19531 If this option is set, the router declines unless the local host is found in
19532 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19533 process domains for which the local host is a secondary mail exchanger
19534 differently to other domains. The way in which Exim decides whether a host is
19535 the local host is described in section &<<SECTreclocipadd>>&.
19536
19537
19538 .option check_srv dnslookup string&!! unset
19539 .cindex "SRV record" "enabling use of"
19540 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19541 addition to MX and address records. The support is disabled by default. To
19542 enable SRV support, set the &%check_srv%& option to the name of the service
19543 required. For example,
19544 .code
19545 check_srv = smtp
19546 .endd
19547 looks for SRV records that refer to the normal smtp service. The option is
19548 expanded, so the service name can vary from message to message or address
19549 to address. This might be helpful if SRV records are being used for a
19550 submission service. If the expansion is forced to fail, the &%check_srv%&
19551 option is ignored, and the router proceeds to look for MX records in the
19552 normal way.
19553
19554 When the expansion succeeds, the router searches first for SRV records for
19555 the given service (it assumes TCP protocol). A single SRV record with a
19556 host name that consists of just a single dot indicates &"no such service for
19557 this domain"&; if this is encountered, the router declines. If other kinds of
19558 SRV record are found, they are used to construct a host list for delivery
19559 according to the rules of RFC 2782. MX records are not sought in this case.
19560
19561 When no SRV records are found, MX records (and address records) are sought in
19562 the traditional way. In other words, SRV records take precedence over MX
19563 records, just as MX records take precedence over address records. Note that
19564 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19565 defined it. It is apparently believed that MX records are sufficient for email
19566 and that SRV records should not be used for this purpose. However, SRV records
19567 have an additional &"weight"& feature which some people might find useful when
19568 trying to split an SMTP load between hosts of different power.
19569
19570 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19571 when there is a DNS lookup error.
19572
19573
19574
19575
19576 .option fail_defer_domains dnslookup "domain list&!!" unset
19577 .cindex "MX record" "not found"
19578 DNS lookups for domains matching &%fail_defer_domains%&
19579 which find no matching record will cause the router to defer
19580 rather than the default behaviour of decline.
19581 This maybe be useful for queueing messages for a newly created
19582 domain while the DNS configuration is not ready.
19583 However, it will result in any message with mistyped domains
19584 also being queued.
19585
19586
19587 .option ipv4_only "string&!!" unset
19588 .cindex IPv6 disabling
19589 .cindex DNS "IPv6 disabling"
19590 The string is expanded, and if the result is anything but a forced failure,
19591 or an empty string, or one of the strings “0” or “no” or “false”
19592 (checked without regard to the case of the letters),
19593 only A records are used.
19594
19595 .option ipv4_prefer "string&!!" unset
19596 .cindex IPv4 preference
19597 .cindex DNS "IPv4 preference"
19598 The string is expanded, and if the result is anything but a forced failure,
19599 or an empty string, or one of the strings “0” or “no” or “false”
19600 (checked without regard to the case of the letters),
19601 A records are sorted before AAAA records (inverting the default).
19602
19603 .option mx_domains dnslookup "domain list&!!" unset
19604 .cindex "MX record" "required to exist"
19605 .cindex "SRV record" "required to exist"
19606 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19607 record in order to be recognized. (The name of this option could be improved.)
19608 For example, if all the mail hosts in &'fict.example'& are known to have MX
19609 records, except for those in &'discworld.fict.example'&, you could use this
19610 setting:
19611 .code
19612 mx_domains = ! *.discworld.fict.example : *.fict.example
19613 .endd
19614 This specifies that messages addressed to a domain that matches the list but
19615 has no MX record should be bounced immediately instead of being routed using
19616 the address record.
19617
19618
19619 .option mx_fail_domains dnslookup "domain list&!!" unset
19620 If the DNS lookup for MX records for one of the domains in this list causes a
19621 DNS lookup error, Exim behaves as if no MX records were found. See section
19622 &<<SECTprowitdnsloo>>& for more discussion.
19623
19624
19625
19626
19627 .option qualify_single dnslookup boolean true
19628 .cindex "DNS" "resolver options"
19629 .cindex "DNS" "qualifying single-component names"
19630 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19631 lookups. Typically, but not standardly, this causes the resolver to qualify
19632 single-component names with the default domain. For example, on a machine
19633 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19634 &'thesaurus.ref.example'& inside the resolver. For details of what your
19635 resolver actually does, consult your man pages for &'resolver'& and
19636 &'resolv.conf'&.
19637
19638
19639
19640 .option rewrite_headers dnslookup boolean true
19641 .cindex "rewriting" "header lines"
19642 .cindex "header lines" "rewriting"
19643 If the domain name in the address that is being processed is not fully
19644 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19645 an address is specified as &'dormouse@teaparty'&, the domain might be
19646 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19647 occur as a result of setting the &%widen_domains%& option. If
19648 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19649 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19650 header lines of the message are rewritten with the full domain name.
19651
19652 This option should be turned off only when it is known that no message is
19653 ever going to be sent outside an environment where the abbreviation makes
19654 sense.
19655
19656 When an MX record is looked up in the DNS and matches a wildcard record, name
19657 servers normally return a record containing the name that has been looked up,
19658 making it impossible to detect whether a wildcard was present or not. However,
19659 some name servers have recently been seen to return the wildcard entry. If the
19660 name returned by a DNS lookup begins with an asterisk, it is not used for
19661 header rewriting.
19662
19663
19664 .option same_domain_copy_routing dnslookup boolean false
19665 .cindex "address" "copying routing"
19666 Addresses with the same domain are normally routed by the &(dnslookup)& router
19667 to the same list of hosts. However, this cannot be presumed, because the router
19668 options and preconditions may refer to the local part of the address. By
19669 default, therefore, Exim routes each address in a message independently. DNS
19670 servers run caches, so repeated DNS lookups are not normally expensive, and in
19671 any case, personal messages rarely have more than a few recipients.
19672
19673 If you are running mailing lists with large numbers of subscribers at the same
19674 domain, and you are using a &(dnslookup)& router which is independent of the
19675 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19676 lookups for identical domains in one message. In this case, when &(dnslookup)&
19677 routes an address to a remote transport, any other unrouted addresses in the
19678 message that have the same domain are automatically given the same routing
19679 without processing them independently,
19680 provided the following conditions are met:
19681
19682 .ilist
19683 No router that processed the address specified &%headers_add%& or
19684 &%headers_remove%&.
19685 .next
19686 The router did not change the address in any way, for example, by &"widening"&
19687 the domain.
19688 .endlist
19689
19690
19691
19692
19693 .option search_parents dnslookup boolean false
19694 .cindex "DNS" "resolver options"
19695 When this option is true, the resolver option RES_DNSRCH is set for DNS
19696 lookups. This is different from the &%qualify_single%& option in that it
19697 applies to domains containing dots. Typically, but not standardly, it causes
19698 the resolver to search for the name in the current domain and in parent
19699 domains. For example, on a machine in the &'fict.example'& domain, if looking
19700 up &'teaparty.wonderland'& failed, the resolver would try
19701 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19702 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19703
19704 Setting this option true can cause problems in domains that have a wildcard MX
19705 record, because any domain that does not have its own MX record matches the
19706 local wildcard.
19707
19708
19709
19710 .option srv_fail_domains dnslookup "domain list&!!" unset
19711 If the DNS lookup for SRV records for one of the domains in this list causes a
19712 DNS lookup error, Exim behaves as if no SRV records were found. See section
19713 &<<SECTprowitdnsloo>>& for more discussion.
19714
19715
19716
19717
19718 .option widen_domains dnslookup "string list" unset
19719 .cindex "domain" "partial; widening"
19720 If a DNS lookup fails and this option is set, each of its strings in turn is
19721 added onto the end of the domain, and the lookup is tried again. For example,
19722 if
19723 .code
19724 widen_domains = fict.example:ref.example
19725 .endd
19726 is set and a lookup of &'klingon.dictionary'& fails,
19727 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19728 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19729 and &%search_parents%& options can cause some widening to be undertaken inside
19730 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19731 when verifying, unless &%rewrite_headers%& is false (not the default).
19732
19733
19734 .section "Effect of qualify_single and search_parents" "SECID119"
19735 When a domain from an envelope recipient is changed by the resolver as a result
19736 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19737 corresponding address in the message's header lines unless &%rewrite_headers%&
19738 is set false. Exim then re-routes the address, using the full domain.
19739
19740 These two options affect only the DNS lookup that takes place inside the router
19741 for the domain of the address that is being routed. They do not affect lookups
19742 such as that implied by
19743 .code
19744 domains = @mx_any
19745 .endd
19746 that may happen while processing a router precondition before the router is
19747 entered. No widening ever takes place for these lookups.
19748 .ecindex IIDdnsrou1
19749 .ecindex IIDdnsrou2
19750
19751
19752
19753
19754
19755
19756
19757
19758
19759 . ////////////////////////////////////////////////////////////////////////////
19760 . ////////////////////////////////////////////////////////////////////////////
19761
19762 .chapter "The ipliteral router" "CHID5"
19763 .cindex "&(ipliteral)& router"
19764 .cindex "domain literal" "routing"
19765 .cindex "routers" "&(ipliteral)&"
19766 This router has no private options. Unless it is being used purely for
19767 verification (see &%verify_only%&) a transport is required to be defined by the
19768 generic &%transport%& option. The router accepts the address if its domain part
19769 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19770 router handles the address
19771 .code
19772 root@[192.168.1.1]
19773 .endd
19774 by setting up delivery to the host with that IP address. IPv4 domain literals
19775 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19776 are similar, but the address is preceded by &`ipv6:`&. For example:
19777 .code
19778 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19779 .endd
19780 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19781 grounds that sooner or later somebody will try it.
19782
19783 .oindex "&%self%&" "in &(ipliteral)& router"
19784 If the IP address matches something in &%ignore_target_hosts%&, the router
19785 declines. If an IP literal turns out to refer to the local host, the generic
19786 &%self%& option determines what happens.
19787
19788 The RFCs require support for domain literals; however, their use is
19789 controversial in today's Internet. If you want to use this router, you must
19790 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19791 Exim will not recognize the domain literal syntax in addresses.
19792
19793
19794
19795 . ////////////////////////////////////////////////////////////////////////////
19796 . ////////////////////////////////////////////////////////////////////////////
19797
19798 .chapter "The iplookup router" "CHID6"
19799 .cindex "&(iplookup)& router"
19800 .cindex "routers" "&(iplookup)&"
19801 The &(iplookup)& router was written to fulfil a specific requirement in
19802 Cambridge University (which in fact no longer exists). For this reason, it is
19803 not included in the binary of Exim by default. If you want to include it, you
19804 must set
19805 .code
19806 ROUTER_IPLOOKUP=yes
19807 .endd
19808 in your &_Local/Makefile_& configuration file.
19809
19810 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19811 connection to one or more specific hosts. The host can then return the same or
19812 a different address &-- in effect rewriting the recipient address in the
19813 message's envelope. The new address is then passed on to subsequent routers. If
19814 this process fails, the address can be passed on to other routers, or delivery
19815 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19816 must not be specified for it.
19817
19818 .cindex "options" "&(iplookup)& router"
19819 .option hosts iplookup string unset
19820 This option must be supplied. Its value is a colon-separated list of host
19821 names. The hosts are looked up using &[gethostbyname()]&
19822 (or &[getipnodebyname()]& when available)
19823 and are tried in order until one responds to the query. If none respond, what
19824 happens is controlled by &%optional%&.
19825
19826
19827 .option optional iplookup boolean false
19828 If &%optional%& is true, if no response is obtained from any host, the address
19829 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19830 delivery to the address is deferred.
19831
19832
19833 .option port iplookup integer 0
19834 .cindex "port" "&(iplookup)& router"
19835 This option must be supplied. It specifies the port number for the TCP or UDP
19836 call.
19837
19838
19839 .option protocol iplookup string udp
19840 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19841 protocols is to be used.
19842
19843
19844 .option query iplookup string&!! "see below"
19845 This defines the content of the query that is sent to the remote hosts. The
19846 default value is:
19847 .code
19848 $local_part@$domain $local_part@$domain
19849 .endd
19850 The repetition serves as a way of checking that a response is to the correct
19851 query in the default case (see &%response_pattern%& below).
19852
19853
19854 .option reroute iplookup string&!! unset
19855 If this option is not set, the rerouted address is precisely the byte string
19856 returned by the remote host, up to the first white space, if any. If set, the
19857 string is expanded to form the rerouted address. It can include parts matched
19858 in the response by &%response_pattern%& by means of numeric variables such as
19859 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19860 whether or not a pattern is in use. In all cases, the rerouted address must end
19861 up in the form &'local_part@domain'&.
19862
19863
19864 .option response_pattern iplookup string unset
19865 This option can be set to a regular expression that is applied to the string
19866 returned from the remote host. If the pattern does not match the response, the
19867 router declines. If &%response_pattern%& is not set, no checking of the
19868 response is done, unless the query was defaulted, in which case there is a
19869 check that the text returned after the first white space is the original
19870 address. This checks that the answer that has been received is in response to
19871 the correct question. For example, if the response is just a new domain, the
19872 following could be used:
19873 .code
19874 response_pattern = ^([^@]+)$
19875 reroute = $local_part@$1
19876 .endd
19877
19878 .option timeout iplookup time 5s
19879 This specifies the amount of time to wait for a response from the remote
19880 machine. The same timeout is used for the &[connect()]& function for a TCP
19881 call. It does not apply to UDP.
19882
19883
19884
19885
19886 . ////////////////////////////////////////////////////////////////////////////
19887 . ////////////////////////////////////////////////////////////////////////////
19888
19889 .chapter "The manualroute router" "CHID7"
19890 .scindex IIDmanrou1 "&(manualroute)& router"
19891 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19892 .cindex "domain" "manually routing"
19893 The &(manualroute)& router is so-called because it provides a way of manually
19894 routing an address according to its domain. It is mainly used when you want to
19895 route addresses to remote hosts according to your own rules, bypassing the
19896 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19897 route to local transports, a facility that may be useful if you want to save
19898 messages for dial-in hosts in local files.
19899
19900 The &(manualroute)& router compares a list of domain patterns with the domain
19901 it is trying to route. If there is no match, the router declines. Each pattern
19902 has associated with it a list of hosts and some other optional data, which may
19903 include a transport. The combination of a pattern and its data is called a
19904 &"routing rule"&. For patterns that do not have an associated transport, the
19905 generic &%transport%& option must specify a transport, unless the router is
19906 being used purely for verification (see &%verify_only%&).
19907
19908 .vindex "&$host$&"
19909 In the case of verification, matching the domain pattern is sufficient for the
19910 router to accept the address. When actually routing an address for delivery,
19911 an address that matches a domain pattern is queued for the associated
19912 transport. If the transport is not a local one, a host list must be associated
19913 with the pattern; IP addresses are looked up for the hosts, and these are
19914 passed to the transport along with the mail address. For local transports, a
19915 host list is optional. If it is present, it is passed in &$host$& as a single
19916 text string.
19917
19918 The list of routing rules can be provided as an inline string in
19919 &%route_list%&, or the data can be obtained by looking up the domain in a file
19920 or database by setting &%route_data%&. Only one of these settings may appear in
19921 any one instance of &(manualroute)&. The format of routing rules is described
19922 below, following the list of private options.
19923
19924
19925 .section "Private options for manualroute" "SECTprioptman"
19926
19927 .cindex "options" "&(manualroute)& router"
19928 The private options for the &(manualroute)& router are as follows:
19929
19930 .option host_all_ignored manualroute string defer
19931 See &%host_find_failed%&.
19932
19933 .option host_find_failed manualroute string freeze
19934 This option controls what happens when &(manualroute)& tries to find an IP
19935 address for a host, and the host does not exist. The option can be set to one
19936 of the following values:
19937 .code
19938 decline
19939 defer
19940 fail
19941 freeze
19942 ignore
19943 pass
19944 .endd
19945 The default (&"freeze"&) assumes that this state is a serious configuration
19946 error. The difference between &"pass"& and &"decline"& is that the former
19947 forces the address to be passed to the next router (or the router defined by
19948 &%pass_router%&),
19949 .oindex "&%more%&"
19950 overriding &%no_more%&, whereas the latter passes the address to the next
19951 router only if &%more%& is true.
19952
19953 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19954 cannot be found. If all the hosts in the list are ignored, the behaviour is
19955 controlled by the &%host_all_ignored%& option. This takes the same values
19956 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19957
19958 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19959 state; if a host lookup gets a temporary error, delivery is deferred unless the
19960 generic &%pass_on_timeout%& option is set.
19961
19962
19963 .option hosts_randomize manualroute boolean false
19964 .cindex "randomized host list"
19965 .cindex "host" "list of; randomized"
19966 If this option is set, the order of the items in a host list in a routing rule
19967 is randomized each time the list is used, unless an option in the routing rule
19968 overrides (see below). Randomizing the order of a host list can be used to do
19969 crude load sharing. However, if more than one mail address is routed by the
19970 same router to the same host list, the host lists are considered to be the same
19971 (even though they may be randomized into different orders) for the purpose of
19972 deciding whether to batch the deliveries into a single SMTP transaction.
19973
19974 When &%hosts_randomize%& is true, a host list may be split
19975 into groups whose order is separately randomized. This makes it possible to
19976 set up MX-like behaviour. The boundaries between groups are indicated by an
19977 item that is just &`+`& in the host list. For example:
19978 .code
19979 route_list = * host1:host2:host3:+:host4:host5
19980 .endd
19981 The order of the first three hosts and the order of the last two hosts is
19982 randomized for each use, but the first three always end up before the last two.
19983 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19984 randomized host list is passed to an &(smtp)& transport that also has
19985 &%hosts_randomize set%&, the list is not re-randomized.
19986
19987
19988 .option route_data manualroute string&!! unset
19989 If this option is set, it must expand to yield the data part of a routing rule.
19990 Typically, the expansion string includes a lookup based on the domain. For
19991 example:
19992 .code
19993 route_data = ${lookup{$domain}dbm{/etc/routes}}
19994 .endd
19995 If the expansion is forced to fail, or the result is an empty string, the
19996 router declines. Other kinds of expansion failure cause delivery to be
19997 deferred.
19998
19999
20000 .option route_list manualroute "string list" unset
20001 This string is a list of routing rules, in the form defined below. Note that,
20002 unlike most string lists, the items are separated by semicolons. This is so
20003 that they may contain colon-separated host lists.
20004
20005
20006 .option same_domain_copy_routing manualroute boolean false
20007 .cindex "address" "copying routing"
20008 Addresses with the same domain are normally routed by the &(manualroute)&
20009 router to the same list of hosts. However, this cannot be presumed, because the
20010 router options and preconditions may refer to the local part of the address. By
20011 default, therefore, Exim routes each address in a message independently. DNS
20012 servers run caches, so repeated DNS lookups are not normally expensive, and in
20013 any case, personal messages rarely have more than a few recipients.
20014
20015 If you are running mailing lists with large numbers of subscribers at the same
20016 domain, and you are using a &(manualroute)& router which is independent of the
20017 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20018 lookups for identical domains in one message. In this case, when
20019 &(manualroute)& routes an address to a remote transport, any other unrouted
20020 addresses in the message that have the same domain are automatically given the
20021 same routing without processing them independently. However, this is only done
20022 if &%headers_add%& and &%headers_remove%& are unset.
20023
20024
20025
20026
20027 .section "Routing rules in route_list" "SECID120"
20028 The value of &%route_list%& is a string consisting of a sequence of routing
20029 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20030 entered as two semicolons. Alternatively, the list separator can be changed as
20031 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20032 Empty rules are ignored. The format of each rule is
20033 .display
20034 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20035 .endd
20036 The following example contains two rules, each with a simple domain pattern and
20037 no options:
20038 .code
20039 route_list = \
20040   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20041   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20042 .endd
20043 The three parts of a rule are separated by white space. The pattern and the
20044 list of hosts can be enclosed in quotes if necessary, and if they are, the
20045 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20046 single domain pattern, which is the only mandatory item in the rule. The
20047 pattern is in the same format as one item in a domain list (see section
20048 &<<SECTdomainlist>>&),
20049 except that it may not be the name of an interpolated file.
20050 That is, it may be wildcarded, or a regular expression, or a file or database
20051 lookup (with semicolons doubled, because of the use of semicolon as a separator
20052 in a &%route_list%&).
20053
20054 The rules in &%route_list%& are searched in order until one of the patterns
20055 matches the domain that is being routed. The list of hosts and then options are
20056 then used as described below. If there is no match, the router declines. When
20057 &%route_list%& is set, &%route_data%& must not be set.
20058
20059
20060
20061 .section "Routing rules in route_data" "SECID121"
20062 The use of &%route_list%& is convenient when there are only a small number of
20063 routing rules. For larger numbers, it is easier to use a file or database to
20064 hold the routing information, and use the &%route_data%& option instead.
20065 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20066 Most commonly, &%route_data%& is set as a string that contains an
20067 expansion lookup. For example, suppose we place two routing rules in a file
20068 like this:
20069 .code
20070 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20071 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20072 .endd
20073 This data can be accessed by setting
20074 .code
20075 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20076 .endd
20077 Failure of the lookup results in an empty string, causing the router to
20078 decline. However, you do not have to use a lookup in &%route_data%&. The only
20079 requirement is that the result of expanding the string is a list of hosts,
20080 possibly followed by options, separated by white space. The list of hosts must
20081 be enclosed in quotes if it contains white space.
20082
20083
20084
20085
20086 .section "Format of the list of hosts" "SECID122"
20087 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20088 always separately expanded before use. If the expansion fails, the router
20089 declines. The result of the expansion must be a colon-separated list of names
20090 and/or IP addresses, optionally also including ports.
20091 If the list is written with spaces, it must be protected with quotes.
20092 The format of each item
20093 in the list is described in the next section. The list separator can be changed
20094 as described in section &<<SECTlistsepchange>>&.
20095
20096 If the list of hosts was obtained from a &%route_list%& item, the following
20097 variables are set during its expansion:
20098
20099 .ilist
20100 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20101 If the domain was matched against a regular expression, the numeric variables
20102 &$1$&, &$2$&, etc. may be set. For example:
20103 .code
20104 route_list = ^domain(\d+)   host-$1.text.example
20105 .endd
20106 .next
20107 &$0$& is always set to the entire domain.
20108 .next
20109 &$1$& is also set when partial matching is done in a file lookup.
20110
20111 .next
20112 .vindex "&$value$&"
20113 If the pattern that matched the domain was a lookup item, the data that was
20114 looked up is available in the expansion variable &$value$&. For example:
20115 .code
20116 route_list = lsearch;;/some/file.routes  $value
20117 .endd
20118 .endlist
20119
20120 Note the doubling of the semicolon in the pattern that is necessary because
20121 semicolon is the default route list separator.
20122
20123
20124
20125 .section "Format of one host item" "SECTformatonehostitem"
20126 Each item in the list of hosts is either a host name or an IP address,
20127 optionally with an attached port number. When no port is given, an IP address
20128 is not enclosed in brackets. When a port is specified, it overrides the port
20129 specification on the transport. The port is separated from the name or address
20130 by a colon. This leads to some complications:
20131
20132 .ilist
20133 Because colon is the default separator for the list of hosts, either
20134 the colon that specifies a port must be doubled, or the list separator must
20135 be changed. The following two examples have the same effect:
20136 .code
20137 route_list = * "host1.tld::1225 : host2.tld::1226"
20138 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20139 .endd
20140 .next
20141 When IPv6 addresses are involved, it gets worse, because they contain
20142 colons of their own. To make this case easier, it is permitted to
20143 enclose an IP address (either v4 or v6) in square brackets if a port
20144 number follows. For example:
20145 .code
20146 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20147 .endd
20148 .endlist
20149
20150 .section "How the list of hosts is used" "SECThostshowused"
20151 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20152 the hosts is tried, in the order specified, when carrying out the SMTP
20153 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20154 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20155 transport.
20156
20157 Hosts may be listed by name or by IP address. An unadorned name in the list of
20158 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20159 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20160 records in the DNS. For example:
20161 .code
20162 route_list = *  x.y.z:p.q.r/MX:e.f.g
20163 .endd
20164 If this feature is used with a port specifier, the port must come last. For
20165 example:
20166 .code
20167 route_list = *  dom1.tld/mx::1225
20168 .endd
20169 If the &%hosts_randomize%& option is set, the order of the items in the list is
20170 randomized before any lookups are done. Exim then scans the list; for any name
20171 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20172 be an interface on the local host and the item is not the first in the list,
20173 Exim discards it and any subsequent items. If it is the first item, what
20174 happens is controlled by the
20175 .oindex "&%self%&" "in &(manualroute)& router"
20176 &%self%& option of the router.
20177
20178 A name on the list that is followed by &`/MX`& is replaced with the list of
20179 hosts obtained by looking up MX records for the name. This is always a DNS
20180 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20181 below) are not relevant here. The order of these hosts is determined by the
20182 preference values in the MX records, according to the usual rules. Because
20183 randomizing happens before the MX lookup, it does not affect the order that is
20184 defined by MX preferences.
20185
20186 If the local host is present in the sublist obtained from MX records, but is
20187 not the most preferred host in that list, it and any equally or less
20188 preferred hosts are removed before the sublist is inserted into the main list.
20189
20190 If the local host is the most preferred host in the MX list, what happens
20191 depends on where in the original list of hosts the &`/MX`& item appears. If it
20192 is not the first item (that is, there are previous hosts in the main list),
20193 Exim discards this name and any subsequent items in the main list.
20194
20195 If the MX item is first in the list of hosts, and the local host is the
20196 most preferred host, what happens is controlled by the &%self%& option of the
20197 router.
20198
20199 DNS failures when lookup up the MX records are treated in the same way as DNS
20200 failures when looking up IP addresses: &%pass_on_timeout%& and
20201 &%host_find_failed%& are used when relevant.
20202
20203 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20204 whether obtained from an MX lookup or not.
20205
20206
20207
20208 .section "How the options are used" "SECThowoptused"
20209 The options are a sequence of words, space-separated.
20210 One of the words can be the name of a transport; this overrides the
20211 &%transport%& option on the router for this particular routing rule only. The
20212 other words (if present) control randomization of the list of hosts on a
20213 per-rule basis, and how the IP addresses of the hosts are to be found when
20214 routing to a remote transport. These options are as follows:
20215
20216 .ilist
20217 &%randomize%&: randomize the order of the hosts in this list, overriding the
20218 setting of &%hosts_randomize%& for this routing rule only.
20219 .next
20220 &%no_randomize%&: do not randomize the order of the hosts in this list,
20221 overriding the setting of &%hosts_randomize%& for this routing rule only.
20222 .next
20223 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20224 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20225 also look in &_/etc/hosts_& or other sources of information.
20226 .next
20227 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20228 no address records are found. If there is a temporary DNS error (such as a
20229 timeout), delivery is deferred.
20230 .next
20231 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20232 .next
20233 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20234 .endlist
20235
20236 For example:
20237 .code
20238 route_list = domain1  host1:host2:host3  randomize bydns;\
20239              domain2  host4:host5
20240 .endd
20241 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20242 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20243 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20244 or &[gethostbyname()]&, and the result of the lookup is the result of that
20245 call.
20246
20247 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20248 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20249 instead of TRY_AGAIN. That is why the default action is to try a DNS
20250 lookup first. Only if that gives a definite &"no such host"& is the local
20251 function called.
20252
20253 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20254 inadvertent constraint that a transport name as an option had to be the last
20255 option specified.
20256
20257
20258
20259 If no IP address for a host can be found, what happens is controlled by the
20260 &%host_find_failed%& option.
20261
20262 .vindex "&$host$&"
20263 When an address is routed to a local transport, IP addresses are not looked up.
20264 The host list is passed to the transport in the &$host$& variable.
20265
20266
20267
20268 .section "Manualroute examples" "SECID123"
20269 In some of the examples that follow, the presence of the &%remote_smtp%&
20270 transport, as defined in the default configuration file, is assumed:
20271
20272 .ilist
20273 .cindex "smart host" "example router"
20274 The &(manualroute)& router can be used to forward all external mail to a
20275 &'smart host'&. If you have set up, in the main part of the configuration, a
20276 named domain list that contains your local domains, for example:
20277 .code
20278 domainlist local_domains = my.domain.example
20279 .endd
20280 You can arrange for all other domains to be routed to a smart host by making
20281 your first router something like this:
20282 .code
20283 smart_route:
20284   driver = manualroute
20285   domains = !+local_domains
20286   transport = remote_smtp
20287   route_list = * smarthost.ref.example
20288 .endd
20289 This causes all non-local addresses to be sent to the single host
20290 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20291 they are tried in order
20292 (but you can use &%hosts_randomize%& to vary the order each time).
20293 Another way of configuring the same thing is this:
20294 .code
20295 smart_route:
20296   driver = manualroute
20297   transport = remote_smtp
20298   route_list = !+local_domains  smarthost.ref.example
20299 .endd
20300 There is no difference in behaviour between these two routers as they stand.
20301 However, they behave differently if &%no_more%& is added to them. In the first
20302 example, the router is skipped if the domain does not match the &%domains%&
20303 precondition; the following router is always tried. If the router runs, it
20304 always matches the domain and so can never decline. Therefore, &%no_more%&
20305 would have no effect. In the second case, the router is never skipped; it
20306 always runs. However, if it doesn't match the domain, it declines. In this case
20307 &%no_more%& would prevent subsequent routers from running.
20308
20309 .next
20310 .cindex "mail hub example"
20311 A &'mail hub'& is a host which receives mail for a number of domains via MX
20312 records in the DNS and delivers it via its own private routing mechanism. Often
20313 the final destinations are behind a firewall, with the mail hub being the one
20314 machine that can connect to machines both inside and outside the firewall. The
20315 &(manualroute)& router is usually used on a mail hub to route incoming messages
20316 to the correct hosts. For a small number of domains, the routing can be inline,
20317 using the &%route_list%& option, but for a larger number a file or database
20318 lookup is easier to manage.
20319
20320 If the domain names are in fact the names of the machines to which the mail is
20321 to be sent by the mail hub, the configuration can be quite simple. For
20322 example:
20323 .code
20324 hub_route:
20325   driver = manualroute
20326   transport = remote_smtp
20327   route_list = *.rhodes.tvs.example  $domain
20328 .endd
20329 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20330 whose names are the same as the mail domains. A similar approach can be taken
20331 if the host name can be obtained from the domain name by a string manipulation
20332 that the expansion facilities can handle. Otherwise, a lookup based on the
20333 domain can be used to find the host:
20334 .code
20335 through_firewall:
20336   driver = manualroute
20337   transport = remote_smtp
20338   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20339 .endd
20340 The result of the lookup must be the name or IP address of the host (or
20341 hosts) to which the address is to be routed. If the lookup fails, the route
20342 data is empty, causing the router to decline. The address then passes to the
20343 next router.
20344
20345 .next
20346 .cindex "batched SMTP output example"
20347 .cindex "SMTP" "batched outgoing; example"
20348 You can use &(manualroute)& to deliver messages to pipes or files in batched
20349 SMTP format for onward transportation by some other means. This is one way of
20350 storing mail for a dial-up host when it is not connected. The route list entry
20351 can be as simple as a single domain name in a configuration like this:
20352 .code
20353 save_in_file:
20354   driver = manualroute
20355   transport = batchsmtp_appendfile
20356   route_list = saved.domain.example
20357 .endd
20358 though often a pattern is used to pick up more than one domain. If there are
20359 several domains or groups of domains with different transport requirements,
20360 different transports can be listed in the routing information:
20361 .code
20362 save_in_file:
20363   driver = manualroute
20364   route_list = \
20365     *.saved.domain1.example  $domain  batch_appendfile; \
20366     *.saved.domain2.example  \
20367       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20368       batch_pipe
20369 .endd
20370 .vindex "&$domain$&"
20371 .vindex "&$host$&"
20372 The first of these just passes the domain in the &$host$& variable, which
20373 doesn't achieve much (since it is also in &$domain$&), but the second does a
20374 file lookup to find a value to pass, causing the router to decline to handle
20375 the address if the lookup fails.
20376
20377 .next
20378 .cindex "UUCP" "example of router for"
20379 Routing mail directly to UUCP software is a specific case of the use of
20380 &(manualroute)& in a gateway to another mail environment. This is an example of
20381 one way it can be done:
20382 .code
20383 # Transport
20384 uucp:
20385   driver = pipe
20386   user = nobody
20387   command = /usr/local/bin/uux -r - \
20388     ${substr_-5:$host}!rmail ${local_part}
20389   return_fail_output = true
20390
20391 # Router
20392 uucphost:
20393   transport = uucp
20394   driver = manualroute
20395   route_data = \
20396     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20397 .endd
20398 The file &_/usr/local/exim/uucphosts_& contains entries like
20399 .code
20400 darksite.ethereal.example:           darksite.UUCP
20401 .endd
20402 It can be set up more simply without adding and removing &".UUCP"& but this way
20403 makes clear the distinction between the domain name
20404 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20405 .endlist
20406 .ecindex IIDmanrou1
20407 .ecindex IIDmanrou2
20408
20409
20410
20411
20412
20413
20414
20415
20416 . ////////////////////////////////////////////////////////////////////////////
20417 . ////////////////////////////////////////////////////////////////////////////
20418
20419 .chapter "The queryprogram router" "CHAPdriverlast"
20420 .scindex IIDquerou1 "&(queryprogram)& router"
20421 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20422 .cindex "routing" "by external program"
20423 The &(queryprogram)& router routes an address by running an external command
20424 and acting on its output. This is an expensive way to route, and is intended
20425 mainly for use in lightly-loaded systems, or for performing experiments.
20426 However, if it is possible to use the precondition options (&%domains%&,
20427 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20428 be used in special cases, even on a busy host. There are the following private
20429 options:
20430 .cindex "options" "&(queryprogram)& router"
20431
20432 .option command queryprogram string&!! unset
20433 This option must be set. It specifies the command that is to be run. The
20434 command is split up into a command name and arguments, and then each is
20435 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20436 &<<CHAPpipetransport>>&).
20437
20438
20439 .option command_group queryprogram string unset
20440 .cindex "gid (group id)" "in &(queryprogram)& router"
20441 This option specifies a gid to be set when running the command while routing an
20442 address for deliver. It must be set if &%command_user%& specifies a numerical
20443 uid. If it begins with a digit, it is interpreted as the numerical value of the
20444 gid. Otherwise it is looked up using &[getgrnam()]&.
20445
20446
20447 .option command_user queryprogram string unset
20448 .cindex "uid (user id)" "for &(queryprogram)&"
20449 This option must be set. It specifies the uid which is set when running the
20450 command while routing an address for delivery. If the value begins with a digit,
20451 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20452 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20453 not set, a value for the gid also.
20454
20455 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20456 root, which it does during a normal delivery in a conventional configuration.
20457 However, when an address is being verified during message reception, Exim is
20458 usually running as the Exim user, not as root. If the &(queryprogram)& router
20459 is called from a non-root process, Exim cannot change uid or gid before running
20460 the command. In this circumstance the command runs under the current uid and
20461 gid.
20462
20463
20464 .option current_directory queryprogram string /
20465 This option specifies an absolute path which is made the current directory
20466 before running the command.
20467
20468
20469 .option timeout queryprogram time 1h
20470 If the command does not complete within the timeout period, its process group
20471 is killed and the message is frozen. A value of zero time specifies no
20472 timeout.
20473
20474
20475 The standard output of the command is connected to a pipe, which is read when
20476 the command terminates. It should consist of a single line of output,
20477 containing up to five fields, separated by white space. The maximum length of
20478 the line is 1023 characters. Longer lines are silently truncated. The first
20479 field is one of the following words (case-insensitive):
20480
20481 .ilist
20482 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20483 below).
20484 .next
20485 &'Decline'&: the router declines; pass the address to the next router, unless
20486 &%no_more%& is set.
20487 .next
20488 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20489 subsequent text on the line is an error message. If the router is run as part
20490 of address verification during an incoming SMTP message, the message is
20491 included in the SMTP response.
20492 .next
20493 &'Defer'&: routing could not be completed at this time; try again later. Any
20494 subsequent text on the line is an error message which is logged. It is not
20495 included in any SMTP response.
20496 .next
20497 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20498 .next
20499 &'Pass'&: pass the address to the next router (or the router specified by
20500 &%pass_router%&), overriding &%no_more%&.
20501 .next
20502 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20503 new addresses, which are routed independently, starting with the first router,
20504 or the router specified by &%redirect_router%&, if set.
20505 .endlist
20506
20507 When the first word is &'accept'&, the remainder of the line consists of a
20508 number of keyed data values, as follows (split into two lines here, to fit on
20509 the page):
20510 .code
20511 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20512 LOOKUP=byname|bydns DATA=<text>
20513 .endd
20514 The data items can be given in any order, and all are optional. If no transport
20515 is included, the transport specified by the generic &%transport%& option is
20516 used. The list of hosts and the lookup type are needed only if the transport is
20517 an &(smtp)& transport that does not itself supply a list of hosts.
20518
20519 The format of the list of hosts is the same as for the &(manualroute)& router.
20520 As well as host names and IP addresses with optional port numbers, as described
20521 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20522 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20523 (see section &<<SECThostshowused>>&).
20524
20525 If the lookup type is not specified, Exim behaves as follows when trying to
20526 find an IP address for each host: First, a DNS lookup is done. If this yields
20527 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20528 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20529 result of the lookup is the result of that call.
20530
20531 .vindex "&$address_data$&"
20532 If the DATA field is set, its value is placed in the &$address_data$&
20533 variable. For example, this return line
20534 .code
20535 accept hosts=x1.y.example:x2.y.example data="rule1"
20536 .endd
20537 routes the address to the default transport, passing a list of two hosts. When
20538 the transport runs, the string &"rule1"& is in &$address_data$&.
20539 .ecindex IIDquerou1
20540 .ecindex IIDquerou2
20541
20542
20543
20544
20545 . ////////////////////////////////////////////////////////////////////////////
20546 . ////////////////////////////////////////////////////////////////////////////
20547
20548 .chapter "The redirect router" "CHAPredirect"
20549 .scindex IIDredrou1 "&(redirect)& router"
20550 .scindex IIDredrou2 "routers" "&(redirect)&"
20551 .cindex "alias file" "in a &(redirect)& router"
20552 .cindex "address redirection" "&(redirect)& router"
20553 The &(redirect)& router handles several kinds of address redirection. Its most
20554 common uses are for resolving local part aliases from a central alias file
20555 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20556 files, but it has many other potential uses. The incoming address can be
20557 redirected in several different ways:
20558
20559 .ilist
20560 It can be replaced by one or more new addresses which are themselves routed
20561 independently.
20562 .next
20563 It can be routed to be delivered to a given file or directory.
20564 .next
20565 It can be routed to be delivered to a specified pipe command.
20566 .next
20567 It can cause an automatic reply to be generated.
20568 .next
20569 It can be forced to fail, optionally with a custom error message.
20570 .next
20571 It can be temporarily deferred, optionally with a custom message.
20572 .next
20573 It can be discarded.
20574 .endlist
20575
20576 The generic &%transport%& option must not be set for &(redirect)& routers.
20577 However, there are some private options which define transports for delivery to
20578 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20579 &%pipe_transport%& and &%reply_transport%& descriptions below.
20580
20581 If success DSNs have been requested
20582 .cindex "DSN" "success"
20583 .cindex "Delivery Status Notification" "success"
20584 redirection triggers one and the DSN options are not passed any further.
20585
20586
20587
20588 .section "Redirection data" "SECID124"
20589 The router operates by interpreting a text string which it obtains either by
20590 expanding the contents of the &%data%& option, or by reading the entire
20591 contents of a file whose name is given in the &%file%& option. These two
20592 options are mutually exclusive. The first is commonly used for handling system
20593 aliases, in a configuration like this:
20594 .code
20595 system_aliases:
20596   driver = redirect
20597   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20598 .endd
20599 If the lookup fails, the expanded string in this example is empty. When the
20600 expansion of &%data%& results in an empty string, the router declines. A forced
20601 expansion failure also causes the router to decline; other expansion failures
20602 cause delivery to be deferred.
20603
20604 A configuration using &%file%& is commonly used for handling users'
20605 &_.forward_& files, like this:
20606 .code
20607 userforward:
20608   driver = redirect
20609   check_local_user
20610   file = $home/.forward
20611   no_verify
20612 .endd
20613 If the file does not exist, or causes no action to be taken (for example, it is
20614 empty or consists only of comments), the router declines. &*Warning*&: This
20615 is not the case when the file contains syntactically valid items that happen to
20616 yield empty addresses, for example, items containing only RFC 2822 address
20617 comments.
20618
20619 .new
20620 .cindex "tainted data" "in filenames"
20621 .cindex redirect "tainted data"
20622 Tainted data may not be used for a filename.
20623
20624 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20625 directly for redirection,
20626 as they are provided by a potential attacker.
20627 In the examples above, &$local_part$& is used for looking up data held locally
20628 on the system, and not used directly (the second example derives &$home$& via
20629 the passsword file or database, using &$local_part$&).
20630 .wen
20631
20632
20633
20634 .section "Forward files and address verification" "SECID125"
20635 .cindex "address redirection" "while verifying"
20636 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20637 &_.forward_& files, as in the example above. There are two reasons for this:
20638
20639 .ilist
20640 When Exim is receiving an incoming SMTP message from a remote host, it is
20641 running under the Exim uid, not as root. Exim is unable to change uid to read
20642 the file as the user, and it may not be able to read it as the Exim user. So in
20643 practice the router may not be able to operate.
20644 .next
20645 However, even when the router can operate, the existence of a &_.forward_& file
20646 is unimportant when verifying an address. What should be checked is whether the
20647 local part is a valid user name or not. Cutting out the redirection processing
20648 saves some resources.
20649 .endlist
20650
20651
20652
20653
20654
20655
20656 .section "Interpreting redirection data" "SECID126"
20657 .cindex "Sieve filter" "specifying in redirection data"
20658 .cindex "filter" "specifying in redirection data"
20659 The contents of the data string, whether obtained from &%data%& or &%file%&,
20660 can be interpreted in two different ways:
20661
20662 .ilist
20663 If the &%allow_filter%& option is set true, and the data begins with the text
20664 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20665 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20666 respectively. Details of the syntax and semantics of filter files are described
20667 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20668 document is intended for use by end users.
20669 .next
20670 Otherwise, the data must be a comma-separated list of redirection items, as
20671 described in the next section.
20672 .endlist
20673
20674 When a message is redirected to a file (a &"mail folder"&), the filename given
20675 in a non-filter redirection list must always be an absolute path. A filter may
20676 generate a relative path &-- how this is handled depends on the transport's
20677 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20678 for the &(appendfile)& transport.
20679
20680
20681
20682 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20683 .cindex "address redirection" "non-filter list items"
20684 When the redirection data is not an Exim or Sieve filter, for example, if it
20685 comes from a conventional alias or forward file, it consists of a list of
20686 addresses, filenames, pipe commands, or certain special items (see section
20687 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20688 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20689 depending on their default values. The items in the list are separated by
20690 commas or newlines.
20691 If a comma is required in an item, the entire item must be enclosed in double
20692 quotes.
20693
20694 Lines starting with a # character are comments, and are ignored, and # may
20695 also appear following a comma, in which case everything between the # and the
20696 next newline character is ignored.
20697
20698 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20699 double quotes are retained because some forms of mail address require their use
20700 (but never to enclose the entire address). In the following description,
20701 &"item"& refers to what remains after any surrounding double quotes have been
20702 removed.
20703
20704 .vindex "&$local_part$&"
20705 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20706 and the expansion contains a reference to &$local_part$&, you should make use
20707 of the &%quote_local_part%& expansion operator, in case the local part contains
20708 special characters. For example, to redirect all mail for the domain
20709 &'obsolete.example'&, retaining the existing local part, you could use this
20710 setting:
20711 .code
20712 data = ${quote_local_part:$local_part}@newdomain.example
20713 .endd
20714
20715
20716 .section "Redirecting to a local mailbox" "SECTredlocmai"
20717 .cindex "routing" "loops in"
20718 .cindex "loop" "while routing, avoidance of"
20719 .cindex "address redirection" "to local mailbox"
20720 A redirection item may safely be the same as the address currently under
20721 consideration. This does not cause a routing loop, because a router is
20722 automatically skipped if any ancestor of the address that is being processed
20723 is the same as the current address and was processed by the current router.
20724 Such an address is therefore passed to the following routers, so it is handled
20725 as if there were no redirection. When making this loop-avoidance test, the
20726 complete local part, including any prefix or suffix, is used.
20727
20728 .cindex "address redirection" "local part without domain"
20729 Specifying the same local part without a domain is a common usage in personal
20730 filter files when the user wants to have messages delivered to the local
20731 mailbox and also forwarded elsewhere. For example, the user whose login is
20732 &'cleo'& might have a &_.forward_& file containing this:
20733 .code
20734 cleo, cleopatra@egypt.example
20735 .endd
20736 .cindex "backslash in alias file"
20737 .cindex "alias file" "backslash in"
20738 For compatibility with other MTAs, such unqualified local parts may be
20739 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20740 it does make a difference if more than one domain is being handled
20741 synonymously.
20742
20743 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20744 2822 address that does not include a domain, the item is qualified using the
20745 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20746 addresses are qualified using the value in &%qualify_recipient%&, but you can
20747 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20748
20749 Care must be taken if there are alias names for local users.
20750 Consider an MTA handling a single local domain where the system alias file
20751 contains:
20752 .code
20753 Sam.Reman: spqr
20754 .endd
20755 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20756 messages in the local mailbox, and also forward copies elsewhere. He creates
20757 this forward file:
20758 .code
20759 Sam.Reman, spqr@reme.elsewhere.example
20760 .endd
20761 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20762 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20763 second time round, because it has previously routed it,
20764 and the following routers presumably cannot handle the alias. The forward file
20765 should really contain
20766 .code
20767 spqr, spqr@reme.elsewhere.example
20768 .endd
20769 but because this is such a common error, the &%check_ancestor%& option (see
20770 below) exists to provide a way to get round it. This is normally set on a
20771 &(redirect)& router that is handling users' &_.forward_& files.
20772
20773
20774
20775 .section "Special items in redirection lists" "SECTspecitredli"
20776 In addition to addresses, the following types of item may appear in redirection
20777 lists (that is, in non-filter redirection data):
20778
20779 .ilist
20780 .cindex "pipe" "in redirection list"
20781 .cindex "address redirection" "to pipe"
20782 An item is treated as a pipe command if it begins with &"|"& and does not parse
20783 as a valid RFC 2822 address that includes a domain. A transport for running the
20784 command must be specified by the &%pipe_transport%& option.
20785 Normally, either the router or the transport specifies a user and a group under
20786 which to run the delivery. The default is to use the Exim user and group.
20787
20788 Single or double quotes can be used for enclosing the individual arguments of
20789 the pipe command; no interpretation of escapes is done for single quotes. If
20790 the command contains a comma character, it is necessary to put the whole item
20791 in double quotes, for example:
20792 .code
20793 "|/some/command ready,steady,go"
20794 .endd
20795 since items in redirection lists are terminated by commas. Do not, however,
20796 quote just the command. An item such as
20797 .code
20798 |"/some/command ready,steady,go"
20799 .endd
20800 is interpreted as a pipe with a rather strange command name, and no arguments.
20801
20802 Note that the above example assumes that the text comes from a lookup source
20803 of some sort, so that the quotes are part of the data.  If composing a
20804 redirect router with a &%data%& option directly specifying this command, the
20805 quotes will be used by the configuration parser to define the extent of one
20806 string, but will not be passed down into the redirect router itself.  There
20807 are two main approaches to get around this: escape quotes to be part of the
20808 data itself, or avoid using this mechanism and instead create a custom
20809 transport with the &%command%& option set and reference that transport from
20810 an &%accept%& router.
20811
20812 .next
20813 .cindex "file" "in redirection list"
20814 .cindex "address redirection" "to file"
20815 An item is interpreted as a path name if it begins with &"/"& and does not
20816 parse as a valid RFC 2822 address that includes a domain. For example,
20817 .code
20818 /home/world/minbari
20819 .endd
20820 is treated as a filename, but
20821 .code
20822 /s=molari/o=babylon/@x400gate.way
20823 .endd
20824 is treated as an address. For a filename, a transport must be specified using
20825 the &%file_transport%& option. However, if the generated path name ends with a
20826 forward slash character, it is interpreted as a directory name rather than a
20827 filename, and &%directory_transport%& is used instead.
20828
20829 Normally, either the router or the transport specifies a user and a group under
20830 which to run the delivery. The default is to use the Exim user and group.
20831
20832 .cindex "&_/dev/null_&"
20833 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20834 bypassed at a high level, and the log entry shows &"**bypassed**"&
20835 instead of a transport name. In this case the user and group are not used.
20836
20837 .next
20838 .cindex "included address list"
20839 .cindex "address redirection" "included external list"
20840 If an item is of the form
20841 .code
20842 :include:<path name>
20843 .endd
20844 a list of further items is taken from the given file and included at that
20845 point. &*Note*&: Such a file can not be a filter file; it is just an
20846 out-of-line addition to the list. The items in the included list are separated
20847 by commas or newlines and are not subject to expansion. If this is the first
20848 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20849 the alias name. This example is incorrect:
20850 .code
20851 list1    :include:/opt/lists/list1
20852 .endd
20853 It must be given as
20854 .code
20855 list1:   :include:/opt/lists/list1
20856 .endd
20857 .new
20858 .cindex "tainted data" "in filenames"
20859 .cindex redirect "tainted data"
20860 Tainted data may not be used for a filename.
20861 .wen
20862 .next
20863 .cindex "address redirection" "to black hole"
20864 .cindex "delivery" "discard"
20865 .cindex "delivery" "blackhole"
20866 .cindex "black hole"
20867 .cindex "abandoning mail"
20868 Sometimes you want to throw away mail to a particular local part.  Making the
20869 &%data%& option expand to an empty string does not work, because that causes
20870 the router to decline. Instead, the alias item
20871 .code
20872 :blackhole:
20873 .endd
20874 can be used. It does what its name implies. No delivery is
20875 done, and no error message is generated. This has the same effect as specifying
20876 &_/dev/null_& as a destination, but it can be independently disabled.
20877
20878 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20879 delivery is done for the original local part, even if other redirection items
20880 are present. If you are generating a multi-item list (for example, by reading a
20881 database) and need the ability to provide a no-op item, you must use
20882 &_/dev/null_&.
20883
20884 .next
20885 .cindex "delivery" "forcing failure"
20886 .cindex "delivery" "forcing deferral"
20887 .cindex "failing delivery" "forcing"
20888 .cindex "deferred delivery, forcing"
20889 .cindex "customizing" "failure message"
20890 An attempt to deliver a particular address can be deferred or forced to fail by
20891 redirection items of the form
20892 .code
20893 :defer:
20894 :fail:
20895 .endd
20896 respectively. When a redirection list contains such an item, it applies
20897 to the entire redirection; any other items in the list are ignored. Any
20898 text following &':fail:'& or &':defer:'& is placed in the error text
20899 associated with the failure. For example, an alias file might contain:
20900 .code
20901 X.Employee:  :fail: Gone away, no forwarding address
20902 .endd
20903 In the case of an address that is being verified from an ACL or as the subject
20904 of a
20905 .cindex "VRFY" "error text, display of"
20906 VRFY command, the text is included in the SMTP error response by
20907 default.
20908 .cindex "EXPN" "error text, display of"
20909 The text is not included in the response to an EXPN command. In non-SMTP cases
20910 the text is included in the error message that Exim generates.
20911
20912 .cindex "SMTP" "error codes"
20913 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20914 &':fail:'&. However, if the message starts with three digits followed by a
20915 space, optionally followed by an extended code of the form &'n.n.n'&, also
20916 followed by a space, and the very first digit is the same as the default error
20917 code, the code from the message is used instead. If the very first digit is
20918 incorrect, a panic error is logged, and the default code is used. You can
20919 suppress the use of the supplied code in a redirect router by setting the
20920 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20921 ignored.
20922
20923 .vindex "&$acl_verify_message$&"
20924 In an ACL, an explicitly provided message overrides the default, but the
20925 default message is available in the variable &$acl_verify_message$& and can
20926 therefore be included in a custom message if this is desired.
20927
20928 Normally the error text is the rest of the redirection list &-- a comma does
20929 not terminate it &-- but a newline does act as a terminator. Newlines are not
20930 normally present in alias expansions. In &(lsearch)& lookups they are removed
20931 as part of the continuation process, but they may exist in other kinds of
20932 lookup and in &':include:'& files.
20933
20934 During routing for message delivery (as opposed to verification), a redirection
20935 containing &':fail:'& causes an immediate failure of the incoming address,
20936 whereas &':defer:'& causes the message to remain in the queue so that a
20937 subsequent delivery attempt can happen at a later time. If an address is
20938 deferred for too long, it will ultimately fail, because the normal retry
20939 rules still apply.
20940
20941 .next
20942 .cindex "alias file" "exception to default"
20943 Sometimes it is useful to use a single-key search type with a default (see
20944 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20945 for exceptions to the default. These can be handled by aliasing them to
20946 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20947 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20948 results in an empty redirection list has the same effect.
20949 .endlist
20950
20951
20952 .section "Duplicate addresses" "SECTdupaddr"
20953 .cindex "duplicate addresses"
20954 .cindex "address duplicate, discarding"
20955 .cindex "pipe" "duplicated"
20956 Exim removes duplicate addresses from the list to which it is delivering, so as
20957 to deliver just one copy to each address. This does not apply to deliveries
20958 routed to pipes by different immediate parent addresses, but an indirect
20959 aliasing scheme of the type
20960 .code
20961 pipe:       |/some/command $local_part
20962 localpart1: pipe
20963 localpart2: pipe
20964 .endd
20965 does not work with a message that is addressed to both local parts, because
20966 when the second is aliased to the intermediate local part &"pipe"& it gets
20967 discarded as being the same as a previously handled address. However, a scheme
20968 such as
20969 .code
20970 localpart1: |/some/command $local_part
20971 localpart2: |/some/command $local_part
20972 .endd
20973 does result in two different pipe deliveries, because the immediate parents of
20974 the pipes are distinct.
20975
20976
20977
20978 .section "Repeated redirection expansion" "SECID128"
20979 .cindex "repeated redirection expansion"
20980 .cindex "address redirection" "repeated for each delivery attempt"
20981 When a message cannot be delivered to all of its recipients immediately,
20982 leading to two or more delivery attempts, redirection expansion is carried out
20983 afresh each time for those addresses whose children were not all previously
20984 delivered. If redirection is being used as a mailing list, this can lead to new
20985 members of the list receiving copies of old messages. The &%one_time%& option
20986 can be used to avoid this.
20987
20988
20989 .section "Errors in redirection lists" "SECID129"
20990 .cindex "address redirection" "errors"
20991 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20992 error is skipped, and an entry is written to the main log. This may be useful
20993 for mailing lists that are automatically managed. Otherwise, if an error is
20994 detected while generating the list of new addresses, the original address is
20995 deferred. See also &%syntax_errors_to%&.
20996
20997
20998
20999 .section "Private options for the redirect router" "SECID130"
21000
21001 .cindex "options" "&(redirect)& router"
21002 The private options for the &(redirect)& router are as follows:
21003
21004
21005 .option allow_defer redirect boolean false
21006 Setting this option allows the use of &':defer:'& in non-filter redirection
21007 data, or the &%defer%& command in an Exim filter file.
21008
21009
21010 .option allow_fail redirect boolean false
21011 .cindex "failing delivery" "from filter"
21012 If this option is true, the &':fail:'& item can be used in a redirection list,
21013 and the &%fail%& command may be used in an Exim filter file.
21014
21015
21016 .option allow_filter redirect boolean false
21017 .cindex "filter" "enabling use of"
21018 .cindex "Sieve filter" "enabling use of"
21019 Setting this option allows Exim to interpret redirection data that starts with
21020 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21021 are some features of Exim filter files that some administrators may wish to
21022 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21023
21024 It is also possible to lock out Exim filters or Sieve filters while allowing
21025 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21026
21027
21028 The filter is run using the uid and gid set by the generic &%user%& and
21029 &%group%& options. These take their defaults from the password data if
21030 &%check_local_user%& is set, so in the normal case of users' personal filter
21031 files, the filter is run as the relevant user. When &%allow_filter%& is set
21032 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21033
21034
21035
21036 .option allow_freeze redirect boolean false
21037 .cindex "freezing messages" "allowing in filter"
21038 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21039 This command is more normally encountered in system filters, and is disabled by
21040 default for redirection filters because it isn't something you usually want to
21041 let ordinary users do.
21042
21043
21044
21045 .option check_ancestor redirect boolean false
21046 This option is concerned with handling generated addresses that are the same
21047 as some address in the list of redirection ancestors of the current address.
21048 Although it is turned off by default in the code, it is set in the default
21049 configuration file for handling users' &_.forward_& files. It is recommended
21050 for this use of the &(redirect)& router.
21051
21052 When &%check_ancestor%& is set, if a generated address (including the domain)
21053 is the same as any ancestor of the current address, it is replaced by a copy of
21054 the current address. This helps in the case where local part A is aliased to B,
21055 and B has a &_.forward_& file pointing back to A. For example, within a single
21056 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21057 &_&~jb/.forward_& contains:
21058 .code
21059 \Joe.Bloggs, <other item(s)>
21060 .endd
21061 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21062 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21063 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21064 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21065 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21066 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21067 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21068 original address. See also the &%repeat_use%& option below.
21069
21070
21071 .option check_group redirect boolean "see below"
21072 When the &%file%& option is used, the group owner of the file is checked only
21073 when this option is set. The permitted groups are those listed in the
21074 &%owngroups%& option, together with the user's default group if
21075 &%check_local_user%& is set. If the file has the wrong group, routing is
21076 deferred. The default setting for this option is true if &%check_local_user%&
21077 is set and the &%modemask%& option permits the group write bit, or if the
21078 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21079
21080
21081
21082 .option check_owner redirect boolean "see below"
21083 When the &%file%& option is used, the owner of the file is checked only when
21084 this option is set. If &%check_local_user%& is set, the local user is
21085 permitted; otherwise the owner must be one of those listed in the &%owners%&
21086 option. The default value for this option is true if &%check_local_user%& or
21087 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21088
21089
21090 .option data redirect string&!! unset
21091 This option is mutually exclusive with &%file%&. One or other of them must be
21092 set, but not both. The contents of &%data%& are expanded, and then used as the
21093 list of forwarding items, or as a set of filtering instructions. If the
21094 expansion is forced to fail, or the result is an empty string or a string that
21095 has no effect (consists entirely of comments), the router declines.
21096
21097 When filtering instructions are used, the string must begin with &"#Exim
21098 filter"&, and all comments in the string, including this initial one, must be
21099 terminated with newline characters. For example:
21100 .code
21101 data = #Exim filter\n\
21102        if $h_to: contains Exim then save $home/mail/exim endif
21103 .endd
21104 If you are reading the data from a database where newlines cannot be included,
21105 you can use the &${sg}$& expansion item to turn the escape string of your
21106 choice into a newline.
21107
21108
21109 .option directory_transport redirect string&!! unset
21110 A &(redirect)& router sets up a direct delivery to a directory when a path name
21111 ending with a slash is specified as a new &"address"&. The transport used is
21112 specified by this option, which, after expansion, must be the name of a
21113 configured transport. This should normally be an &(appendfile)& transport.
21114
21115
21116 .option file redirect string&!! unset
21117 This option specifies the name of a file that contains the redirection data. It
21118 is mutually exclusive with the &%data%& option. The string is expanded before
21119 use; if the expansion is forced to fail, the router declines. Other expansion
21120 failures cause delivery to be deferred. The result of a successful expansion
21121 must be an absolute path. The entire file is read and used as the redirection
21122 data. If the data is an empty string or a string that has no effect (consists
21123 entirely of comments), the router declines.
21124
21125 .cindex "NFS" "checking for file existence"
21126 If the attempt to open the file fails with a &"does not exist"& error, Exim
21127 runs a check on the containing directory,
21128 unless &%ignore_enotdir%& is true (see below).
21129 If the directory does not appear to exist, delivery is deferred. This can
21130 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21131 is a mount problem. If the containing directory does exist, but the file does
21132 not, the router declines.
21133
21134
21135 .option file_transport redirect string&!! unset
21136 .vindex "&$address_file$&"
21137 A &(redirect)& router sets up a direct delivery to a file when a path name not
21138 ending in a slash is specified as a new &"address"&. The transport used is
21139 specified by this option, which, after expansion, must be the name of a
21140 configured transport. This should normally be an &(appendfile)& transport. When
21141 it is running, the filename is in &$address_file$&.
21142
21143
21144 .option filter_prepend_home redirect boolean true
21145 When this option is true, if a &(save)& command in an Exim filter specifies a
21146 relative path, and &$home$& is defined, it is automatically prepended to the
21147 relative path. If this option is set false, this action does not happen. The
21148 relative path is then passed to the transport unmodified.
21149
21150
21151 .option forbid_blackhole redirect boolean false
21152 .cindex "restricting access to features"
21153 .cindex "filter" "locking out certain features"
21154 If this option is true, the &':blackhole:'& item may not appear in a
21155 redirection list.
21156
21157
21158 .option forbid_exim_filter redirect boolean false
21159 .cindex "restricting access to features"
21160 .cindex "filter" "locking out certain features"
21161 If this option is set true, only Sieve filters are permitted when
21162 &%allow_filter%& is true.
21163
21164
21165
21166
21167 .option forbid_file redirect boolean false
21168 .cindex "restricting access to features"
21169 .cindex "delivery" "to file; forbidding"
21170 .cindex "filter" "locking out certain features"
21171 .cindex "Sieve filter" "forbidding delivery to a file"
21172 .cindex "Sieve filter" "&""keep""& facility; disabling"
21173 If this option is true, this router may not generate a new address that
21174 specifies delivery to a local file or directory, either from a filter or from a
21175 conventional forward file. This option is forced to be true if &%one_time%& is
21176 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21177 locks out the Sieve's &"keep"& facility.
21178
21179
21180 .option forbid_filter_dlfunc redirect boolean false
21181 .cindex "restricting access to features"
21182 .cindex "filter" "locking out certain features"
21183 If this option is true, string expansions in Exim filters are not allowed to
21184 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21185 functions.
21186
21187 .option forbid_filter_existstest redirect boolean false
21188 .cindex "restricting access to features"
21189 .cindex "filter" "locking out certain features"
21190 .cindex "expansion" "statting a file"
21191 If this option is true, string expansions in Exim filters are not allowed to
21192 make use of the &%exists%& condition or the &%stat%& expansion item.
21193
21194 .option forbid_filter_logwrite redirect boolean false
21195 .cindex "restricting access to features"
21196 .cindex "filter" "locking out certain features"
21197 If this option is true, use of the logging facility in Exim filters is not
21198 permitted. Logging is in any case available only if the filter is being run
21199 under some unprivileged uid (which is normally the case for ordinary users'
21200 &_.forward_& files).
21201
21202
21203 .option forbid_filter_lookup redirect boolean false
21204 .cindex "restricting access to features"
21205 .cindex "filter" "locking out certain features"
21206 If this option is true, string expansions in Exim filter files are not allowed
21207 to make use of &%lookup%& items.
21208
21209
21210 .option forbid_filter_perl redirect boolean false
21211 .cindex "restricting access to features"
21212 .cindex "filter" "locking out certain features"
21213 This option has an effect only if Exim is built with embedded Perl support. If
21214 it is true, string expansions in Exim filter files are not allowed to make use
21215 of the embedded Perl support.
21216
21217
21218 .option forbid_filter_readfile redirect boolean false
21219 .cindex "restricting access to features"
21220 .cindex "filter" "locking out certain features"
21221 If this option is true, string expansions in Exim filter files are not allowed
21222 to make use of &%readfile%& items.
21223
21224
21225 .option forbid_filter_readsocket redirect boolean false
21226 .cindex "restricting access to features"
21227 .cindex "filter" "locking out certain features"
21228 If this option is true, string expansions in Exim filter files are not allowed
21229 to make use of &%readsocket%& items.
21230
21231
21232 .option forbid_filter_reply redirect boolean false
21233 .cindex "restricting access to features"
21234 .cindex "filter" "locking out certain features"
21235 If this option is true, this router may not generate an automatic reply
21236 message. Automatic replies can be generated only from Exim or Sieve filter
21237 files, not from traditional forward files. This option is forced to be true if
21238 &%one_time%& is set.
21239
21240
21241 .option forbid_filter_run redirect boolean false
21242 .cindex "restricting access to features"
21243 .cindex "filter" "locking out certain features"
21244 If this option is true, string expansions in Exim filter files are not allowed
21245 to make use of &%run%& items.
21246
21247
21248 .option forbid_include redirect boolean false
21249 .cindex "restricting access to features"
21250 .cindex "filter" "locking out certain features"
21251 If this option is true, items of the form
21252 .code
21253 :include:<path name>
21254 .endd
21255 are not permitted in non-filter redirection lists.
21256
21257
21258 .option forbid_pipe redirect boolean false
21259 .cindex "restricting access to features"
21260 .cindex "filter" "locking out certain features"
21261 .cindex "delivery" "to pipe; forbidding"
21262 If this option is true, this router may not generate a new address which
21263 specifies delivery to a pipe, either from an Exim filter or from a conventional
21264 forward file. This option is forced to be true if &%one_time%& is set.
21265
21266
21267 .option forbid_sieve_filter redirect boolean false
21268 .cindex "restricting access to features"
21269 .cindex "filter" "locking out certain features"
21270 If this option is set true, only Exim filters are permitted when
21271 &%allow_filter%& is true.
21272
21273
21274 .cindex "SMTP" "error codes"
21275 .option forbid_smtp_code redirect boolean false
21276 If this option is set true, any SMTP error codes that are present at the start
21277 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21278 the default codes (451 and 550, respectively) are always used.
21279
21280
21281
21282
21283 .option hide_child_in_errmsg redirect boolean false
21284 .cindex "bounce message" "redirection details; suppressing"
21285 If this option is true, it prevents Exim from quoting a child address if it
21286 generates a bounce or delay message for it. Instead it says &"an address
21287 generated from <&'the top level address'&>"&. Of course, this applies only to
21288 bounces generated locally. If a message is forwarded to another host, &'its'&
21289 bounce may well quote the generated address.
21290
21291
21292 .option ignore_eacces redirect boolean false
21293 .cindex "EACCES"
21294 If this option is set and an attempt to open a redirection file yields the
21295 EACCES error (permission denied), the &(redirect)& router behaves as if the
21296 file did not exist.
21297
21298
21299 .option ignore_enotdir redirect boolean false
21300 .cindex "ENOTDIR"
21301 If this option is set and an attempt to open a redirection file yields the
21302 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21303 router behaves as if the file did not exist.
21304
21305 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21306 router that has the &%file%& option set discovers that the file does not exist
21307 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21308 against unmounted NFS directories. If the parent can not be statted, delivery
21309 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21310 is set, because that option tells Exim to ignore &"something on the path is not
21311 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21312 that some operating systems give ENOENT where others give ENOTDIR.
21313
21314
21315
21316 .option include_directory redirect string unset
21317 If this option is set, the path names of any &':include:'& items in a
21318 redirection list must start with this directory.
21319
21320
21321 .option modemask redirect "octal integer" 022
21322 This specifies mode bits which must not be set for a file specified by the
21323 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21324
21325
21326 .option one_time redirect boolean false
21327 .cindex "one-time aliasing/forwarding expansion"
21328 .cindex "alias file" "one-time expansion"
21329 .cindex "forward file" "one-time expansion"
21330 .cindex "mailing lists" "one-time expansion"
21331 .cindex "address redirection" "one-time expansion"
21332 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21333 files each time it tries to deliver a message causes a problem when one or more
21334 of the generated addresses fails be delivered at the first attempt. The problem
21335 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21336 but of what happens when the redirection list changes during the time that the
21337 message is on Exim's queue. This is particularly true in the case of mailing
21338 lists, where new subscribers might receive copies of messages that were posted
21339 before they subscribed.
21340
21341 If &%one_time%& is set and any addresses generated by the router fail to
21342 deliver at the first attempt, the failing addresses are added to the message as
21343 &"top level"& addresses, and the parent address that generated them is marked
21344 &"delivered"&. Thus, redirection does not happen again at the next delivery
21345 attempt.
21346
21347 &*Warning 1*&: Any header line addition or removal that is specified by this
21348 router would be lost if delivery did not succeed at the first attempt. For this
21349 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21350 permitted when &%one_time%& is set.
21351
21352 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21353 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21354 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21355
21356 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21357 &%one_time%&.
21358
21359 The original top-level address is remembered with each of the generated
21360 addresses, and is output in any log messages. However, any intermediate parent
21361 addresses are not recorded. This makes a difference to the log only if
21362 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21363 typically be used for mailing lists, where there is normally just one level of
21364 expansion.
21365
21366
21367 .option owners redirect "string list" unset
21368 .cindex "ownership" "alias file"
21369 .cindex "ownership" "forward file"
21370 .cindex "alias file" "ownership"
21371 .cindex "forward file" "ownership"
21372 This specifies a list of permitted owners for the file specified by &%file%&.
21373 This list is in addition to the local user when &%check_local_user%& is set.
21374 See &%check_owner%& above.
21375
21376
21377 .option owngroups redirect "string list" unset
21378 This specifies a list of permitted groups for the file specified by &%file%&.
21379 The list is in addition to the local user's primary group when
21380 &%check_local_user%& is set. See &%check_group%& above.
21381
21382
21383 .option pipe_transport redirect string&!! unset
21384 .vindex "&$address_pipe$&"
21385 A &(redirect)& router sets up a direct delivery to a pipe when a string
21386 starting with a vertical bar character is specified as a new &"address"&. The
21387 transport used is specified by this option, which, after expansion, must be the
21388 name of a configured transport. This should normally be a &(pipe)& transport.
21389 When the transport is run, the pipe command is in &$address_pipe$&.
21390
21391
21392 .option qualify_domain redirect string&!! unset
21393 .vindex "&$qualify_recipient$&"
21394 If this option is set, and an unqualified address (one without a domain) is
21395 generated, and that address would normally be qualified by the global setting
21396 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21397 expanding this string. If the expansion fails, the router declines. If you want
21398 to revert to the default, you can have the expansion generate
21399 &$qualify_recipient$&.
21400
21401 This option applies to all unqualified addresses generated by Exim filters,
21402 but for traditional &_.forward_& files, it applies only to addresses that are
21403 not preceded by a backslash. Sieve filters cannot generate unqualified
21404 addresses.
21405
21406 .option qualify_preserve_domain redirect boolean false
21407 .cindex "domain" "in redirection; preserving"
21408 .cindex "preserving domain in redirection"
21409 .cindex "address redirection" "domain; preserving"
21410 If this option is set, the router's local &%qualify_domain%& option must not be
21411 set (a configuration error occurs if it is). If an unqualified address (one
21412 without a domain) is generated, it is qualified with the domain of the parent
21413 address (the immediately preceding ancestor) instead of the global
21414 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21415 this applies whether or not the address is preceded by a backslash.
21416
21417
21418 .option repeat_use redirect boolean true
21419 If this option is set false, the router is skipped for a child address that has
21420 any ancestor that was routed by this router. This test happens before any of
21421 the other preconditions are tested. Exim's default anti-looping rules skip
21422 only when the ancestor is the same as the current address. See also
21423 &%check_ancestor%& above and the generic &%redirect_router%& option.
21424
21425
21426 .option reply_transport redirect string&!! unset
21427 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21428 &%vacation%& command is used in a filter file. The transport used is specified
21429 by this option, which, after expansion, must be the name of a configured
21430 transport. This should normally be an &(autoreply)& transport. Other transports
21431 are unlikely to do anything sensible or useful.
21432
21433
21434 .option rewrite redirect boolean true
21435 .cindex "address redirection" "disabling rewriting"
21436 If this option is set false, addresses generated by the router are not
21437 subject to address rewriting. Otherwise, they are treated like new addresses
21438 and are rewritten according to the global rewriting rules.
21439
21440
21441 .option sieve_subaddress redirect string&!! unset
21442 The value of this option is passed to a Sieve filter to specify the
21443 :subaddress part of an address.
21444
21445 .option sieve_useraddress redirect string&!! unset
21446 The value of this option is passed to a Sieve filter to specify the :user part
21447 of an address. However, if it is unset, the entire original local part
21448 (including any prefix or suffix) is used for :user.
21449
21450
21451 .option sieve_vacation_directory redirect string&!! unset
21452 .cindex "Sieve filter" "vacation directory"
21453 To enable the &"vacation"& extension for Sieve filters, you must set
21454 &%sieve_vacation_directory%& to the directory where vacation databases are held
21455 (do not put anything else in that directory), and ensure that the
21456 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21457 needs their own directory; Exim will create it if necessary.
21458
21459
21460
21461 .option skip_syntax_errors redirect boolean false
21462 .cindex "forward file" "broken"
21463 .cindex "address redirection" "broken files"
21464 .cindex "alias file" "broken"
21465 .cindex "broken alias or forward files"
21466 .cindex "ignoring faulty addresses"
21467 .cindex "skipping faulty addresses"
21468 .cindex "error" "skipping bad syntax"
21469 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21470 non-filter redirection data are skipped, and each failing address is logged. If
21471 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21472 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21473 are expanded and placed at the head of the error message generated by
21474 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21475 be the same address as the generic &%errors_to%& option. The
21476 &%skip_syntax_errors%& option is often used when handling mailing lists.
21477
21478 If all the addresses in a redirection list are skipped because of syntax
21479 errors, the router declines to handle the original address, and it is passed to
21480 the following routers.
21481
21482 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21483 error in the filter causes filtering to be abandoned without any action being
21484 taken. The incident is logged, and the router declines to handle the address,
21485 so it is passed to the following routers.
21486
21487 .cindex "Sieve filter" "syntax errors in"
21488 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21489 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21490 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21491
21492 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21493 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21494 option, used with an address that does not get redirected, can be used to
21495 notify users of these errors, by means of a router like this:
21496 .code
21497 userforward:
21498   driver = redirect
21499   allow_filter
21500   check_local_user
21501   file = $home/.forward
21502   file_transport = address_file
21503   pipe_transport = address_pipe
21504   reply_transport = address_reply
21505   no_verify
21506   skip_syntax_errors
21507   syntax_errors_to = real-$local_part@$domain
21508   syntax_errors_text = \
21509    This is an automatically generated message. An error has\n\
21510    been found in your .forward file. Details of the error are\n\
21511    reported below. While this error persists, you will receive\n\
21512    a copy of this message for every message that is addressed\n\
21513    to you. If your .forward file is a filter file, or if it is\n\
21514    a non-filter file containing no valid forwarding addresses,\n\
21515    a copy of each incoming message will be put in your normal\n\
21516    mailbox. If a non-filter file contains at least one valid\n\
21517    forwarding address, forwarding to the valid addresses will\n\
21518    happen, and those will be the only deliveries that occur.
21519 .endd
21520 You also need a router to ensure that local addresses that are prefixed by
21521 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21522 put this immediately before the &(userforward)& router:
21523 .code
21524 real_localuser:
21525   driver = accept
21526   check_local_user
21527   local_part_prefix = real-
21528   transport = local_delivery
21529 .endd
21530 For security, it would probably be a good idea to restrict the use of this
21531 router to locally-generated messages, using a condition such as this:
21532 .code
21533   condition = ${if match {$sender_host_address}\
21534                          {\N^(|127\.0\.0\.1)$\N}}
21535 .endd
21536
21537
21538 .option syntax_errors_text redirect string&!! unset
21539 See &%skip_syntax_errors%& above.
21540
21541
21542 .option syntax_errors_to redirect string unset
21543 See &%skip_syntax_errors%& above.
21544 .ecindex IIDredrou1
21545 .ecindex IIDredrou2
21546
21547
21548
21549
21550
21551
21552 . ////////////////////////////////////////////////////////////////////////////
21553 . ////////////////////////////////////////////////////////////////////////////
21554
21555 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21556          "Environment for local transports"
21557 .scindex IIDenvlotra1 "local transports" "environment for"
21558 .scindex IIDenvlotra2 "environment" "local transports"
21559 .scindex IIDenvlotra3 "transport" "local; environment for"
21560 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21561 transport can be thought of as similar to a pipe.) Exim always runs transports
21562 in subprocesses, under specified uids and gids. Typical deliveries to local
21563 mailboxes run under the uid and gid of the local user.
21564
21565 Exim also sets a specific current directory while running the transport; for
21566 some transports a home directory setting is also relevant. The &(pipe)&
21567 transport is the only one that sets up environment variables; see section
21568 &<<SECTpipeenv>>& for details.
21569
21570 The values used for the uid, gid, and the directories may come from several
21571 different places. In many cases, the router that handles the address associates
21572 settings with that address as a result of its &%check_local_user%&, &%group%&,
21573 or &%user%& options. However, values may also be given in the transport's own
21574 configuration, and these override anything that comes from the router.
21575
21576
21577
21578 .section "Concurrent deliveries" "SECID131"
21579 .cindex "concurrent deliveries"
21580 .cindex "simultaneous deliveries"
21581 If two different messages for the same local recipient arrive more or less
21582 simultaneously, the two delivery processes are likely to run concurrently. When
21583 the &(appendfile)& transport is used to write to a file, Exim applies locking
21584 rules to stop concurrent processes from writing to the same file at the same
21585 time.
21586
21587 However, when you use a &(pipe)& transport, it is up to you to arrange any
21588 locking that is needed. Here is a silly example:
21589 .code
21590 my_transport:
21591   driver = pipe
21592   command = /bin/sh -c 'cat >>/some/file'
21593 .endd
21594 This is supposed to write the message at the end of the file. However, if two
21595 messages arrive at the same time, the file will be scrambled. You can use the
21596 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21597 file using the same algorithm that Exim itself uses.
21598
21599
21600
21601
21602 .section "Uids and gids" "SECTenvuidgid"
21603 .cindex "local transports" "uid and gid"
21604 .cindex "transport" "local; uid and gid"
21605 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21606 overrides any group that the router set in the address, even if &%user%& is not
21607 set for the transport. This makes it possible, for example, to run local mail
21608 delivery under the uid of the recipient (set by the router), but in a special
21609 group (set by the transport). For example:
21610 .code
21611 # Routers ...
21612 # User/group are set by check_local_user in this router
21613 local_users:
21614   driver = accept
21615   check_local_user
21616   transport = group_delivery
21617
21618 # Transports ...
21619 # This transport overrides the group
21620 group_delivery:
21621   driver = appendfile
21622   file = /var/spool/mail/$local_part
21623   group = mail
21624 .endd
21625 If &%user%& is set for a transport, its value overrides what is set in the
21626 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21627 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21628 set.
21629
21630 .oindex "&%initgroups%&"
21631 When the uid is taken from the transport's configuration, the &[initgroups()]&
21632 function is called for the groups associated with that uid if the
21633 &%initgroups%& option is set for the transport. When the uid is not specified
21634 by the transport, but is associated with the address by a router, the option
21635 for calling &[initgroups()]& is taken from the router configuration.
21636
21637 .cindex "&(pipe)& transport" "uid for"
21638 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21639 is set and &%user%& is not set, the uid of the process that called Exim to
21640 receive the message is used, and if &%group%& is not set, the corresponding
21641 original gid is also used.
21642
21643 This is the detailed preference order for obtaining a gid; the first of the
21644 following that is set is used:
21645
21646 .ilist
21647 A &%group%& setting of the transport;
21648 .next
21649 A &%group%& setting of the router;
21650 .next
21651 A gid associated with a user setting of the router, either as a result of
21652 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21653 .next
21654 The group associated with a non-numeric &%user%& setting of the transport;
21655 .next
21656 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21657 the uid is the creator's uid;
21658 .next
21659 The Exim gid if the Exim uid is being used as a default.
21660 .endlist
21661
21662 If, for example, the user is specified numerically on the router and there are
21663 no group settings, no gid is available. In this situation, an error occurs.
21664 This is different for the uid, for which there always is an ultimate default.
21665 The first of the following that is set is used:
21666
21667 .ilist
21668 A &%user%& setting of the transport;
21669 .next
21670 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21671 .next
21672 A &%user%& setting of the router;
21673 .next
21674 A &%check_local_user%& setting of the router;
21675 .next
21676 The Exim uid.
21677 .endlist
21678
21679 Of course, an error will still occur if the uid that is chosen is on the
21680 &%never_users%& list.
21681
21682
21683
21684
21685
21686 .section "Current and home directories" "SECID132"
21687 .cindex "current directory for local transport"
21688 .cindex "home directory" "for local transport"
21689 .cindex "transport" "local; home directory for"
21690 .cindex "transport" "local; current directory for"
21691 Routers may set current and home directories for local transports by means of
21692 the &%transport_current_directory%& and &%transport_home_directory%& options.
21693 However, if the transport's &%current_directory%& or &%home_directory%& options
21694 are set, they override the router's values. In detail, the home directory
21695 for a local transport is taken from the first of these values that is set:
21696
21697 .ilist
21698 The &%home_directory%& option on the transport;
21699 .next
21700 The &%transport_home_directory%& option on the router;
21701 .next
21702 The password data if &%check_local_user%& is set on the router;
21703 .next
21704 The &%router_home_directory%& option on the router.
21705 .endlist
21706
21707 The current directory is taken from the first of these values that is set:
21708
21709 .ilist
21710 The &%current_directory%& option on the transport;
21711 .next
21712 The &%transport_current_directory%& option on the router.
21713 .endlist
21714
21715
21716 If neither the router nor the transport sets a current directory, Exim uses the
21717 value of the home directory, if it is set. Otherwise it sets the current
21718 directory to &_/_& before running a local transport.
21719
21720
21721
21722 .section "Expansion variables derived from the address" "SECID133"
21723 .vindex "&$domain$&"
21724 .vindex "&$local_part$&"
21725 .vindex "&$original_domain$&"
21726 Normally a local delivery is handling a single address, and in that case the
21727 variables such as &$domain$& and &$local_part$& are set during local
21728 deliveries. However, in some circumstances more than one address may be handled
21729 at once (for example, while writing batch SMTP for onward transmission by some
21730 other means). In this case, the variables associated with the local part are
21731 never set, &$domain$& is set only if all the addresses have the same domain,
21732 and &$original_domain$& is never set.
21733 .ecindex IIDenvlotra1
21734 .ecindex IIDenvlotra2
21735 .ecindex IIDenvlotra3
21736
21737
21738
21739
21740
21741
21742
21743 . ////////////////////////////////////////////////////////////////////////////
21744 . ////////////////////////////////////////////////////////////////////////////
21745
21746 .chapter "Generic options for transports" "CHAPtransportgeneric"
21747 .scindex IIDgenoptra1 "generic options" "transport"
21748 .scindex IIDgenoptra2 "options" "generic; for transports"
21749 .scindex IIDgenoptra3 "transport" "generic options for"
21750 The following generic options apply to all transports:
21751
21752
21753 .option body_only transports boolean false
21754 .cindex "transport" "body only"
21755 .cindex "message" "transporting body only"
21756 .cindex "body of message" "transporting"
21757 If this option is set, the message's headers are not transported. It is
21758 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21759 or &(pipe)& transports, the settings of &%message_prefix%& and
21760 &%message_suffix%& should be checked, because this option does not
21761 automatically suppress them.
21762
21763
21764 .option current_directory transports string&!! unset
21765 .cindex "transport" "current directory for"
21766 This specifies the current directory that is to be set while running the
21767 transport, overriding any value that may have been set by the router.
21768 If the expansion fails for any reason, including forced failure, an error is
21769 logged, and delivery is deferred.
21770
21771
21772 .option disable_logging transports boolean false
21773 If this option is set true, nothing is logged for any
21774 deliveries by the transport or for any
21775 transport errors. You should not set this option unless you really, really know
21776 what you are doing.
21777
21778
21779 .option debug_print transports string&!! unset
21780 .cindex "testing" "variables in drivers"
21781 If this option is set and debugging is enabled (see the &%-d%& command line
21782 option), the string is expanded and included in the debugging output when the
21783 transport is run.
21784 If expansion of the string fails, the error message is written to the debugging
21785 output, and Exim carries on processing.
21786 This facility is provided to help with checking out the values of variables and
21787 so on when debugging driver configurations. For example, if a &%headers_add%&
21788 option is not working properly, &%debug_print%& could be used to output the
21789 variables it references. A newline is added to the text if it does not end with
21790 one.
21791 The variables &$transport_name$& and &$router_name$& contain the name of the
21792 transport and the router that called it.
21793
21794 .option delivery_date_add transports boolean false
21795 .cindex "&'Delivery-date:'& header line"
21796 If this option is true, a &'Delivery-date:'& header is added to the message.
21797 This gives the actual time the delivery was made. As this is not a standard
21798 header, Exim has a configuration option (&%delivery_date_remove%&) which
21799 requests its removal from incoming messages, so that delivered messages can
21800 safely be resent to other recipients.
21801
21802
21803 .option driver transports string unset
21804 This specifies which of the available transport drivers is to be used.
21805 There is no default, and this option must be set for every transport.
21806
21807
21808 .option envelope_to_add transports boolean false
21809 .cindex "&'Envelope-to:'& header line"
21810 If this option is true, an &'Envelope-to:'& header is added to the message.
21811 This gives the original address(es) in the incoming envelope that caused this
21812 delivery to happen. More than one address may be present if the transport is
21813 configured to handle several addresses at once, or if more than one original
21814 address was redirected to the same final address. As this is not a standard
21815 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21816 its removal from incoming messages, so that delivered messages can safely be
21817 resent to other recipients.
21818
21819
21820 .option event_action transports string&!! unset
21821 .cindex events
21822 This option declares a string to be expanded for Exim's events mechanism.
21823 For details see chapter &<<CHAPevents>>&.
21824
21825
21826 .option group transports string&!! "Exim group"
21827 .cindex "transport" "group; specifying"
21828 This option specifies a gid for running the transport process, overriding any
21829 value that the router supplies, and also overriding any value associated with
21830 &%user%& (see below).
21831
21832
21833 .option headers_add transports list&!! unset
21834 .cindex "header lines" "adding in transport"
21835 .cindex "transport" "header lines; adding"
21836 This option specifies a list of text headers,
21837 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21838 which are (separately) expanded and added to the header
21839 portion of a message as it is transported, as described in section
21840 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21841 routers. If the result of the expansion is an empty string, or if the expansion
21842 is forced to fail, no action is taken. Other expansion failures are treated as
21843 errors and cause the delivery to be deferred.
21844
21845 Unlike most options, &%headers_add%& can be specified multiple times
21846 for a transport; all listed headers are added.
21847
21848
21849 .option headers_only transports boolean false
21850 .cindex "transport" "header lines only"
21851 .cindex "message" "transporting headers only"
21852 .cindex "header lines" "transporting"
21853 If this option is set, the message's body is not transported. It is mutually
21854 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21855 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21856 checked, since this option does not automatically suppress them.
21857
21858
21859 .option headers_remove transports list&!! unset
21860 .cindex "header lines" "removing"
21861 .cindex "transport" "header lines; removing"
21862 This option specifies a list of text headers,
21863 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21864 to be removed from the message.
21865 However, the option has no effect when an address is just being verified.
21866 Each list item is separately expanded.
21867 If the result of the expansion is an empty string, or if the expansion
21868 is forced to fail, no action is taken. Other expansion failures are treated as
21869 errors and cause the delivery to be deferred.
21870 .new
21871 If an item ends in *, it will match any header with the given prefix.
21872 .wen
21873
21874 Matching headers are omitted from the message as it is transported, as described
21875 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21876 routers.
21877
21878 Unlike most options, &%headers_remove%& can be specified multiple times
21879 for a transport; all listed headers are removed.
21880
21881 &*Warning*&: Because of the separate expansion of the list items,
21882 items that contain a list separator must have it doubled.
21883 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21884
21885
21886
21887 .option headers_rewrite transports string unset
21888 .cindex "transport" "header lines; rewriting"
21889 .cindex "rewriting" "at transport time"
21890 This option allows addresses in header lines to be rewritten at transport time,
21891 that is, as the message is being copied to its destination. The contents of the
21892 option are a colon-separated list of rewriting rules. Each rule is in exactly
21893 the same form as one of the general rewriting rules that are applied when a
21894 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21895 example,
21896 .code
21897 headers_rewrite = a@b c@d f : \
21898                   x@y w@z
21899 .endd
21900 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21901 &'w@z'& in all address-bearing header lines. The rules are applied to the
21902 header lines just before they are written out at transport time, so they affect
21903 only those copies of the message that pass through the transport. However, only
21904 the message's original header lines, and any that were added by a system
21905 filter, are rewritten. If a router or transport adds header lines, they are not
21906 affected by this option. These rewriting rules are &'not'& applied to the
21907 envelope. You can change the return path using &%return_path%&, but you cannot
21908 change envelope recipients at this time.
21909
21910
21911 .option home_directory transports string&!! unset
21912 .cindex "transport" "home directory for"
21913 .vindex "&$home$&"
21914 This option specifies a home directory setting for a local transport,
21915 overriding any value that may be set by the router. The home directory is
21916 placed in &$home$& while expanding the transport's private options. It is also
21917 used as the current directory if no current directory is set by the
21918 &%current_directory%& option on the transport or the
21919 &%transport_current_directory%& option on the router. If the expansion fails
21920 for any reason, including forced failure, an error is logged, and delivery is
21921 deferred.
21922
21923
21924 .option initgroups transports boolean false
21925 .cindex "additional groups"
21926 .cindex "groups" "additional"
21927 .cindex "transport" "group; additional"
21928 If this option is true and the uid for the delivery process is provided by the
21929 transport, the &[initgroups()]& function is called when running the transport
21930 to ensure that any additional groups associated with the uid are set up.
21931
21932
21933 .option max_parallel transports integer&!! unset
21934 .cindex limit "transport parallelism"
21935 .cindex transport "parallel processes"
21936 .cindex transport "concurrency limit"
21937 .cindex "delivery" "parallelism for transport"
21938 If this option is set and expands to an integer greater than zero
21939 it limits the number of concurrent runs of the transport.
21940 The control does not apply to shadow transports.
21941
21942 .cindex "hints database" "transport concurrency control"
21943 Exim implements this control by means of a hints database in which a record is
21944 incremented whenever a transport process is being created. The record
21945 is decremented and possibly removed when the process terminates.
21946 Obviously there is scope for
21947 records to get left lying around if there is a system or program crash. To
21948 guard against this, Exim ignores any records that are more than six hours old.
21949
21950 If you use this option, you should also arrange to delete the
21951 relevant hints database whenever your system reboots. The names of the files
21952 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21953 may be one or two files, depending on the type of DBM in use. The same files
21954 are used for ETRN and smtp transport serialization.
21955
21956
21957 .option message_size_limit transports string&!! 0
21958 .cindex "limit" "message size per transport"
21959 .cindex "size" "of message, limit"
21960 .cindex "transport" "message size; limiting"
21961 This option controls the size of messages passed through the transport. It is
21962 expanded before use; the result of the expansion must be a sequence of decimal
21963 digits, optionally followed by K or M. If the expansion fails for any reason,
21964 including forced failure, or if the result is not of the required form,
21965 delivery is deferred. If the value is greater than zero and the size of a
21966 message exceeds this limit, the address is failed. If there is any chance that
21967 the resulting bounce message could be routed to the same transport, you should
21968 ensure that &%return_size_limit%& is less than the transport's
21969 &%message_size_limit%&, as otherwise the bounce message will fail to get
21970 delivered.
21971
21972
21973
21974 .option rcpt_include_affixes transports boolean false
21975 .cindex "prefix" "for local part, including in envelope"
21976 .cindex "suffix for local part" "including in envelope"
21977 .cindex "local part" "prefix"
21978 .cindex "local part" "suffix"
21979 When this option is false (the default), and an address that has had any
21980 affixes (prefixes or suffixes) removed from the local part is delivered by any
21981 form of SMTP or LMTP, the affixes are not included. For example, if a router
21982 that contains
21983 .code
21984 local_part_prefix = *-
21985 .endd
21986 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21987 is delivered with
21988 .code
21989 RCPT TO:<xyz@some.domain>
21990 .endd
21991 This is also the case when an ACL-time callout is being used to verify a
21992 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21993 whole local part is included in the RCPT command. This option applies to BSMTP
21994 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21995 &(lmtp)& and &(smtp)& transports.
21996
21997
21998 .option retry_use_local_part transports boolean "see below"
21999 .cindex "hints database" "retry keys"
22000 When a delivery suffers a temporary failure, a retry record is created
22001 in Exim's hints database. For remote deliveries, the key for the retry record
22002 is based on the name and/or IP address of the failing remote host. For local
22003 deliveries, the key is normally the entire address, including both the local
22004 part and the domain. This is suitable for most common cases of local delivery
22005 temporary failure &-- for example, exceeding a mailbox quota should delay only
22006 deliveries to that mailbox, not to the whole domain.
22007
22008 However, in some special cases you may want to treat a temporary local delivery
22009 as a failure associated with the domain, and not with a particular local part.
22010 (For example, if you are storing all mail for some domain in files.) You can do
22011 this by setting &%retry_use_local_part%& false.
22012
22013 For all the local transports, its default value is true. For remote transports,
22014 the default value is false for tidiness, but changing the value has no effect
22015 on a remote transport in the current implementation.
22016
22017
22018 .option return_path transports string&!! unset
22019 .cindex "envelope sender"
22020 .cindex "envelope from"
22021 .cindex "transport" "return path; changing"
22022 .cindex "return path" "changing in transport"
22023 If this option is set, the string is expanded at transport time and replaces
22024 the existing return path (envelope sender) value in the copy of the message
22025 that is being delivered. An empty return path is permitted. This feature is
22026 designed for remote deliveries, where the value of this option is used in the
22027 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22028 only effect is to change the address that is placed in the &'Return-path:'&
22029 header line, if one is added to the message (see the next option).
22030
22031 &*Note:*& A changed return path is not logged unless you add
22032 &%return_path_on_delivery%& to the log selector.
22033
22034 .vindex "&$return_path$&"
22035 The expansion can refer to the existing value via &$return_path$&. This is
22036 either the message's envelope sender, or an address set by the
22037 &%errors_to%& option on a router. If the expansion is forced to fail, no
22038 replacement occurs; if it fails for another reason, delivery is deferred. This
22039 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22040 section &<<SECTverp>>&.
22041
22042 &*Note*&: If a delivery error is detected locally, including the case when a
22043 remote server rejects a message at SMTP time, the bounce message is not sent to
22044 the value of this option. It is sent to the previously set errors address.
22045 This defaults to the incoming sender address, but can be changed by setting
22046 &%errors_to%& in a router.
22047
22048
22049
22050 .option return_path_add transports boolean false
22051 .cindex "&'Return-path:'& header line"
22052 If this option is true, a &'Return-path:'& header is added to the message.
22053 Although the return path is normally available in the prefix line of BSD
22054 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22055 have easy access to it.
22056
22057 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22058 the delivery SMTP server makes the final delivery"&. This implies that this
22059 header should not be present in incoming messages. Exim has a configuration
22060 option, &%return_path_remove%&, which requests removal of this header from
22061 incoming messages, so that delivered messages can safely be resent to other
22062 recipients.
22063
22064
22065 .option shadow_condition transports string&!! unset
22066 See &%shadow_transport%& below.
22067
22068
22069 .option shadow_transport transports string unset
22070 .cindex "shadow transport"
22071 .cindex "transport" "shadow"
22072 A local transport may set the &%shadow_transport%& option to the name of
22073 another local transport. Shadow remote transports are not supported.
22074
22075 Whenever a delivery to the main transport succeeds, and either
22076 &%shadow_condition%& is unset, or its expansion does not result in the empty
22077 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22078 passed to the shadow transport, with the same delivery address or addresses. If
22079 expansion fails, no action is taken except that non-forced expansion failures
22080 cause a log line to be written.
22081
22082 The result of the shadow transport is discarded and does not affect the
22083 subsequent processing of the message. Only a single level of shadowing is
22084 provided; the &%shadow_transport%& option is ignored on any transport when it
22085 is running as a shadow. Options concerned with output from pipes are also
22086 ignored. The log line for the successful delivery has an item added on the end,
22087 of the form
22088 .code
22089 ST=<shadow transport name>
22090 .endd
22091 If the shadow transport did not succeed, the error message is put in
22092 parentheses afterwards. Shadow transports can be used for a number of different
22093 purposes, including keeping more detailed log information than Exim normally
22094 provides, and implementing automatic acknowledgment policies based on message
22095 headers that some sites insist on.
22096
22097
22098 .option transport_filter transports string&!! unset
22099 .cindex "transport" "filter"
22100 .cindex "filter" "transport filter"
22101 This option sets up a filtering (in the Unix shell sense) process for messages
22102 at transport time. It should not be confused with mail filtering as set up by
22103 individual users or via a system filter.
22104 If unset, or expanding to an empty string, no filtering is done.
22105
22106 When the message is about to be written out, the command specified by
22107 &%transport_filter%& is started up in a separate, parallel process, and
22108 the entire message, including the header lines, is passed to it on its standard
22109 input (this in fact is done from a third process, to avoid deadlock). The
22110 command must be specified as an absolute path.
22111
22112 The lines of the message that are written to the transport filter are
22113 terminated by newline (&"\n"&). The message is passed to the filter before any
22114 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22115 lines beginning with a dot, and also before any processing implied by the
22116 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22117 &(pipe)& transports.
22118
22119 The standard error for the filter process is set to the same destination as its
22120 standard output; this is read and written to the message's ultimate
22121 destination. The process that writes the message to the filter, the
22122 filter itself, and the original process that reads the result and delivers it
22123 are all run in parallel, like a shell pipeline.
22124
22125 The filter can perform any transformations it likes, but of course should take
22126 care not to break RFC 2822 syntax. Exim does not check the result, except to
22127 test for a final newline when SMTP is in use. All messages transmitted over
22128 SMTP must end with a newline, so Exim supplies one if it is missing.
22129
22130 .cindex "content scanning" "per user"
22131 A transport filter can be used to provide content-scanning on a per-user basis
22132 at delivery time if the only required effect of the scan is to modify the
22133 message. For example, a content scan could insert a new header line containing
22134 a spam score. This could be interpreted by a filter in the user's MUA. It is
22135 not possible to discard a message at this stage.
22136
22137 .cindex "SMTP" "SIZE"
22138 A problem might arise if the filter increases the size of a message that is
22139 being sent down an SMTP connection. If the receiving SMTP server has indicated
22140 support for the SIZE parameter, Exim will have sent the size of the message
22141 at the start of the SMTP session. If what is actually sent is substantially
22142 more, the server might reject the message. This can be worked round by setting
22143 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22144 additions to the message, or to disable the use of SIZE altogether.
22145
22146 .vindex "&$pipe_addresses$&"
22147 The value of the &%transport_filter%& option is the command string for starting
22148 the filter, which is run directly from Exim, not under a shell. The string is
22149 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22150 Exim breaks it up into arguments and then expands each argument separately (see
22151 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22152 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22153 of arguments, one for each address that applies to this delivery. (This isn't
22154 an ideal name for this feature here, but as it was already implemented for the
22155 &(pipe)& transport, it seemed sensible not to change it.)
22156
22157 .vindex "&$host$&"
22158 .vindex "&$host_address$&"
22159 The expansion variables &$host$& and &$host_address$& are available when the
22160 transport is a remote one. They contain the name and IP address of the host to
22161 which the message is being sent. For example:
22162 .code
22163 transport_filter = /some/directory/transport-filter.pl \
22164   $host $host_address $sender_address $pipe_addresses
22165 .endd
22166
22167 Two problems arise if you want to use more complicated expansion items to
22168 generate transport filter commands, both of which due to the fact that the
22169 command is split up &'before'& expansion.
22170 .ilist
22171 If an expansion item contains white space, you must quote it, so that it is all
22172 part of the same command item. If the entire option setting is one such
22173 expansion item, you have to take care what kind of quoting you use. For
22174 example:
22175 .code
22176 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22177 .endd
22178 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22179 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22180 stripped by Exim when it read the option's value. When the value is used, if
22181 the single quotes were missing, the line would be split into two items,
22182 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22183 Exim tried to expand the first one.
22184 .next
22185 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22186 expansion cannot generate multiple arguments, or a command name followed by
22187 arguments. Consider this example:
22188 .code
22189 transport_filter = ${lookup{$host}lsearch{/a/file}\
22190                     {$value}{/bin/cat}}
22191 .endd
22192 The result of the lookup is interpreted as the name of the command, even
22193 if it contains white space. The simplest way round this is to use a shell:
22194 .code
22195 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22196                                {$value}{/bin/cat}}
22197 .endd
22198 .endlist
22199
22200 The filter process is run under the same uid and gid as the normal delivery.
22201 For remote deliveries this is the Exim uid/gid by default. The command should
22202 normally yield a zero return code. Transport filters are not supposed to fail.
22203 A non-zero code is taken to mean that the transport filter encountered some
22204 serious problem. Delivery of the message is deferred; the message remains on
22205 the queue and is tried again later. It is not possible to cause a message to be
22206 bounced from a transport filter.
22207
22208 If a transport filter is set on an autoreply transport, the original message is
22209 passed through the filter as it is being copied into the newly generated
22210 message, which happens if the &%return_message%& option is set.
22211
22212
22213 .option transport_filter_timeout transports time 5m
22214 .cindex "transport" "filter, timeout"
22215 When Exim is reading the output of a transport filter, it applies a timeout
22216 that can be set by this option. Exceeding the timeout is normally treated as a
22217 temporary delivery failure. However, if a transport filter is used with a
22218 &(pipe)& transport, a timeout in the transport filter is treated in the same
22219 way as a timeout in the pipe command itself. By default, a timeout is a hard
22220 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22221 becomes a temporary error.
22222
22223
22224 .option user transports string&!! "Exim user"
22225 .cindex "uid (user id)" "local delivery"
22226 .cindex "transport" "user, specifying"
22227 This option specifies the user under whose uid the delivery process is to be
22228 run, overriding any uid that may have been set by the router. If the user is
22229 given as a name, the uid is looked up from the password data, and the
22230 associated group is taken as the value of the gid to be used if the &%group%&
22231 option is not set.
22232
22233 For deliveries that use local transports, a user and group are normally
22234 specified explicitly or implicitly (for example, as a result of
22235 &%check_local_user%&) by the router or transport.
22236
22237 .cindex "hints database" "access by remote transport"
22238 For remote transports, you should leave this option unset unless you really are
22239 sure you know what you are doing. When a remote transport is running, it needs
22240 to be able to access Exim's hints databases, because each host may have its own
22241 retry data.
22242 .ecindex IIDgenoptra1
22243 .ecindex IIDgenoptra2
22244 .ecindex IIDgenoptra3
22245
22246
22247
22248
22249
22250
22251 . ////////////////////////////////////////////////////////////////////////////
22252 . ////////////////////////////////////////////////////////////////////////////
22253
22254 .chapter "Address batching in local transports" "CHAPbatching" &&&
22255          "Address batching"
22256 .cindex "transport" "local; address batching in"
22257 The only remote transport (&(smtp)&) is normally configured to handle more than
22258 one address at a time, so that when several addresses are routed to the same
22259 remote host, just one copy of the message is sent. Local transports, however,
22260 normally handle one address at a time. That is, a separate instance of the
22261 transport is run for each address that is routed to the transport. A separate
22262 copy of the message is delivered each time.
22263
22264 .cindex "batched local delivery"
22265 .oindex "&%batch_max%&"
22266 .oindex "&%batch_id%&"
22267 In special cases, it may be desirable to handle several addresses at once in a
22268 local transport, for example:
22269
22270 .ilist
22271 In an &(appendfile)& transport, when storing messages in files for later
22272 delivery by some other means, a single copy of the message with multiple
22273 recipients saves space.
22274 .next
22275 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22276 a single copy saves time, and is the normal way LMTP is expected to work.
22277 .next
22278 In a &(pipe)& transport, when passing the message
22279 to a scanner program or
22280 to some other delivery mechanism such as UUCP, multiple recipients may be
22281 acceptable.
22282 .endlist
22283
22284 These three local transports all have the same options for controlling multiple
22285 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22286 repeating the information for each transport, these options are described here.
22287
22288 The &%batch_max%& option specifies the maximum number of addresses that can be
22289 delivered together in a single run of the transport. Its default value is one
22290 (no batching). When more than one address is routed to a transport that has a
22291 &%batch_max%& value greater than one, the addresses are delivered in a batch
22292 (that is, in a single run of the transport with multiple recipients), subject
22293 to certain conditions:
22294
22295 .ilist
22296 .vindex "&$local_part$&"
22297 If any of the transport's options contain a reference to &$local_part$&, no
22298 batching is possible.
22299 .next
22300 .vindex "&$domain$&"
22301 If any of the transport's options contain a reference to &$domain$&, only
22302 addresses with the same domain are batched.
22303 .next
22304 .cindex "customizing" "batching condition"
22305 If &%batch_id%& is set, it is expanded for each address, and only those
22306 addresses with the same expanded value are batched. This allows you to specify
22307 customized batching conditions. Failure of the expansion for any reason,
22308 including forced failure, disables batching, but it does not stop the delivery
22309 from taking place.
22310 .next
22311 Batched addresses must also have the same errors address (where to send
22312 delivery errors), the same header additions and removals, the same user and
22313 group for the transport, and if a host list is present, the first host must
22314 be the same.
22315 .endlist
22316
22317 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22318 both when the file or pipe command is specified in the transport, and when it
22319 is specified by a &(redirect)& router, but all the batched addresses must of
22320 course be routed to the same file or pipe command. These two transports have an
22321 option called &%use_bsmtp%&, which causes them to deliver the message in
22322 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22323 &%check_string%& and &%escape_string%& options are forced to the values
22324 .code
22325 check_string = "."
22326 escape_string = ".."
22327 .endd
22328 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22329 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22330 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22331
22332 .cindex "&'Envelope-to:'& header line"
22333 If the generic &%envelope_to_add%& option is set for a batching transport, the
22334 &'Envelope-to:'& header that is added to the message contains all the addresses
22335 that are being processed together. If you are using a batching &(appendfile)&
22336 transport without &%use_bsmtp%&, the only way to preserve the recipient
22337 addresses is to set the &%envelope_to_add%& option.
22338
22339 .cindex "&(pipe)& transport" "with multiple addresses"
22340 .vindex "&$pipe_addresses$&"
22341 If you are using a &(pipe)& transport without BSMTP, and setting the
22342 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22343 the command. This is not a true variable; it is a bit of magic that causes each
22344 of the recipient addresses to be inserted into the command as a separate
22345 argument. This provides a way of accessing all the addresses that are being
22346 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22347 are specified by a &(redirect)& router.
22348
22349
22350
22351
22352 . ////////////////////////////////////////////////////////////////////////////
22353 . ////////////////////////////////////////////////////////////////////////////
22354
22355 .chapter "The appendfile transport" "CHAPappendfile"
22356 .scindex IIDapptra1 "&(appendfile)& transport"
22357 .scindex IIDapptra2 "transports" "&(appendfile)&"
22358 .cindex "directory creation"
22359 .cindex "creating directories"
22360 The &(appendfile)& transport delivers a message by appending it to an existing
22361 file, or by creating an entirely new file in a specified directory. Single
22362 files to which messages are appended can be in the traditional Unix mailbox
22363 format, or optionally in the MBX format supported by the Pine MUA and
22364 University of Washington IMAP daemon, &'inter alia'&. When each message is
22365 being delivered as a separate file, &"maildir"& format can optionally be used
22366 to give added protection against failures that happen part-way through the
22367 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22368 supported. For all file formats, Exim attempts to create as many levels of
22369 directory as necessary, provided that &%create_directory%& is set.
22370
22371 The code for the optional formats is not included in the Exim binary by
22372 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22373 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22374 included.
22375
22376 .cindex "quota" "system"
22377 Exim recognizes system quota errors, and generates an appropriate message. Exim
22378 also supports its own quota control within the transport, for use when the
22379 system facility is unavailable or cannot be used for some reason.
22380
22381 If there is an error while appending to a file (for example, quota exceeded or
22382 partition filled), Exim attempts to reset the file's length and last
22383 modification time back to what they were before. If there is an error while
22384 creating an entirely new file, the new file is removed.
22385
22386 Before appending to a file, a number of security checks are made, and the
22387 file is locked. A detailed description is given below, after the list of
22388 private options.
22389
22390 The &(appendfile)& transport is most commonly used for local deliveries to
22391 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22392 putting messages into files for remote delivery by some means other than Exim.
22393 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22394 option).
22395
22396
22397
22398 .section "The file and directory options" "SECTfildiropt"
22399 The &%file%& option specifies a single file, to which the message is appended;
22400 the &%directory%& option specifies a directory, in which a new file containing
22401 the message is created. Only one of these two options can be set, and for
22402 normal deliveries to mailboxes, one of them &'must'& be set.
22403
22404 .vindex "&$address_file$&"
22405 .vindex "&$local_part$&"
22406 However, &(appendfile)& is also used for delivering messages to files or
22407 directories whose names (or parts of names) are obtained from alias,
22408 forwarding, or filtering operations (for example, a &%save%& command in a
22409 user's Exim filter). When such a transport is running, &$local_part$& contains
22410 the local part that was aliased or forwarded, and &$address_file$& contains the
22411 name (or partial name) of the file or directory generated by the redirection
22412 operation. There are two cases:
22413
22414 .ilist
22415 If neither &%file%& nor &%directory%& is set, the redirection operation
22416 must specify an absolute path (one that begins with &`/`&). This is the most
22417 common case when users with local accounts use filtering to sort mail into
22418 different folders. See for example, the &(address_file)& transport in the
22419 default configuration. If the path ends with a slash, it is assumed to be the
22420 name of a directory. A delivery to a directory can also be forced by setting
22421 &%maildir_format%& or &%mailstore_format%&.
22422 .next
22423 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22424 used to determine the file or directory name for the delivery. Normally, the
22425 contents of &$address_file$& are used in some way in the string expansion.
22426 .endlist
22427 .new
22428 .cindex "tainted data" "in filenames"
22429 .cindex appendfile "tainted data"
22430 Tainted data may not be used for a file or directory name.
22431 This means that, for instance, &$local_part$& cannot be used directly
22432 as a component of a path.  It can however be used as the key for a lookup
22433 which returns a path (or component).
22434 .wen
22435
22436
22437 .cindex "Sieve filter" "configuring &(appendfile)&"
22438 .cindex "Sieve filter" "relative mailbox path handling"
22439 As an example of the second case, consider an environment where users do not
22440 have home directories. They may be permitted to use Exim filter commands of the
22441 form:
22442 .code
22443 save folder23
22444 .endd
22445 or Sieve filter commands of the form:
22446 .code
22447 require "fileinto";
22448 fileinto "folder23";
22449 .endd
22450 In this situation, the expansion of &%file%& or &%directory%& in the transport
22451 must transform the relative path into an appropriate absolute filename. In the
22452 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22453 is used as a result of a &"keep"& action in the filter. This example shows one
22454 way of handling this requirement:
22455 .code
22456 file = ${if eq{$address_file}{inbox} \
22457             {/var/mail/$local_part} \
22458             {${if eq{${substr_0_1:$address_file}}{/} \
22459                   {$address_file} \
22460                   {$home/mail/$address_file} \
22461             }} \
22462        }
22463 .endd
22464 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22465 location, absolute paths are used without change, and other folders are in the
22466 &_mail_& directory within the home directory.
22467
22468 &*Note 1*&: While processing an Exim filter, a relative path such as
22469 &_folder23_& is turned into an absolute path if a home directory is known to
22470 the router. In particular, this is the case if &%check_local_user%& is set. If
22471 you want to prevent this happening at routing time, you can set
22472 &%router_home_directory%& empty. This forces the router to pass the relative
22473 path to the transport.
22474
22475 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22476 the &%file%& or &%directory%& option is still used if it is set.
22477
22478
22479
22480
22481 .section "Private options for appendfile" "SECID134"
22482 .cindex "options" "&(appendfile)& transport"
22483
22484
22485
22486 .option allow_fifo appendfile boolean false
22487 .cindex "fifo (named pipe)"
22488 .cindex "named pipe (fifo)"
22489 .cindex "pipe" "named (fifo)"
22490 Setting this option permits delivery to named pipes (FIFOs) as well as to
22491 regular files. If no process is reading the named pipe at delivery time, the
22492 delivery is deferred.
22493
22494
22495 .option allow_symlink appendfile boolean false
22496 .cindex "symbolic link" "to mailbox"
22497 .cindex "mailbox" "symbolic link"
22498 By default, &(appendfile)& will not deliver if the path name for the file is
22499 that of a symbolic link. Setting this option relaxes that constraint, but there
22500 are security issues involved in the use of symbolic links. Be sure you know
22501 what you are doing if you set this. Details of exactly what this option affects
22502 are included in the discussion which follows this list of options.
22503
22504
22505 .option batch_id appendfile string&!! unset
22506 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22507 However, batching is automatically disabled for &(appendfile)& deliveries that
22508 happen as a result of forwarding or aliasing or other redirection directly to a
22509 file.
22510
22511
22512 .option batch_max appendfile integer 1
22513 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22514
22515
22516 .option check_group appendfile boolean false
22517 When this option is set, the group owner of the file defined by the &%file%&
22518 option is checked to see that it is the same as the group under which the
22519 delivery process is running. The default setting is false because the default
22520 file mode is 0600, which means that the group is irrelevant.
22521
22522
22523 .option check_owner appendfile boolean true
22524 When this option is set, the owner of the file defined by the &%file%& option
22525 is checked to ensure that it is the same as the user under which the delivery
22526 process is running.
22527
22528
22529 .option check_string appendfile string "see below"
22530 .cindex "&""From""& line"
22531 As &(appendfile)& writes the message, the start of each line is tested for
22532 matching &%check_string%&, and if it does, the initial matching characters are
22533 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22534 a literal string, not a regular expression, and the case of any letters it
22535 contains is significant.
22536
22537 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22538 are forced to &"."& and &".."& respectively, and any settings in the
22539 configuration are ignored. Otherwise, they default to &"From&~"& and
22540 &">From&~"& when the &%file%& option is set, and unset when any of the
22541 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22542
22543 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22544 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22545 &"From&~"& indicates the start of a new message. All four options need changing
22546 if another format is used. For example, to deliver to mailboxes in MMDF format:
22547 .cindex "MMDF format mailbox"
22548 .cindex "mailbox" "MMDF format"
22549 .code
22550 check_string = "\1\1\1\1\n"
22551 escape_string = "\1\1\1\1 \n"
22552 message_prefix = "\1\1\1\1\n"
22553 message_suffix = "\1\1\1\1\n"
22554 .endd
22555 .option create_directory appendfile boolean true
22556 .cindex "directory creation"
22557 When this option is true, Exim attempts to create any missing superior
22558 directories for the file that it is about to write. A created directory's mode
22559 is given by the &%directory_mode%& option.
22560
22561 The group ownership of a newly created directory is highly dependent on the
22562 operating system (and possibly the file system) that is being used. For
22563 example, in Solaris, if the parent directory has the setgid bit set, its group
22564 is propagated to the child; if not, the currently set group is used. However,
22565 in FreeBSD, the parent's group is always used.
22566
22567
22568
22569 .option create_file appendfile string anywhere
22570 This option constrains the location of files and directories that are created
22571 by this transport. It applies to files defined by the &%file%& option and
22572 directories defined by the &%directory%& option. In the case of maildir
22573 delivery, it applies to the top level directory, not the maildir directories
22574 beneath.
22575
22576 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22577 &"belowhome"&. In the second and third cases, a home directory must have been
22578 set for the transport. This option is not useful when an explicit filename is
22579 given for normal mailbox deliveries. It is intended for the case when filenames
22580 are generated from users' &_.forward_& files. These are usually handled
22581 by an &(appendfile)& transport called &%address_file%&. See also
22582 &%file_must_exist%&.
22583
22584
22585 .option directory appendfile string&!! unset
22586 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22587 or &%directory%& must be set, unless the delivery is the direct result of a
22588 redirection (see section &<<SECTfildiropt>>&).
22589
22590 When &%directory%& is set, the string is expanded, and the message is delivered
22591 into a new file or files in or below the given directory, instead of being
22592 appended to a single mailbox file. A number of different formats are provided
22593 (see &%maildir_format%& and &%mailstore_format%&), and see section
22594 &<<SECTopdir>>& for further details of this form of delivery.
22595
22596
22597 .option directory_file appendfile string&!! "see below"
22598 .cindex "base62"
22599 .vindex "&$inode$&"
22600 When &%directory%& is set, but neither &%maildir_format%& nor
22601 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22602 whose name is obtained by expanding this string. The default value is:
22603 .code
22604 q${base62:$tod_epoch}-$inode
22605 .endd
22606 This generates a unique name from the current time, in base 62 form, and the
22607 inode of the file. The variable &$inode$& is available only when expanding this
22608 option.
22609
22610
22611 .option directory_mode appendfile "octal integer" 0700
22612 If &(appendfile)& creates any directories as a result of the
22613 &%create_directory%& option, their mode is specified by this option.
22614
22615
22616 .option escape_string appendfile string "see description"
22617 See &%check_string%& above.
22618
22619
22620 .option file appendfile string&!! unset
22621 This option is mutually exclusive with the &%directory%& option, but one of
22622 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22623 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22624 specifies a single file, to which the message is appended. One or more of
22625 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22626 &%file%&.
22627
22628 .cindex "NFS" "lock file"
22629 .cindex "locking files"
22630 .cindex "lock files"
22631 If you are using more than one host to deliver over NFS into the same
22632 mailboxes, you should always use lock files.
22633
22634 The string value is expanded for each delivery, and must yield an absolute
22635 path. The most common settings of this option are variations on one of these
22636 examples:
22637 .code
22638 file = /var/spool/mail/$local_part
22639 file = /home/$local_part/inbox
22640 file = $home/inbox
22641 .endd
22642 .cindex "&""sticky""& bit"
22643 In the first example, all deliveries are done into the same directory. If Exim
22644 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22645 create a file in the directory, so the &"sticky"& bit must be turned on for
22646 deliveries to be possible, or alternatively the &%group%& option can be used to
22647 run the delivery under a group id which has write access to the directory.
22648
22649
22650
22651 .option file_format appendfile string unset
22652 .cindex "file" "mailbox; checking existing format"
22653 This option requests the transport to check the format of an existing file
22654 before adding to it. The check consists of matching a specific string at the
22655 start of the file. The value of the option consists of an even number of
22656 colon-separated strings. The first of each pair is the test string, and the
22657 second is the name of a transport. If the transport associated with a matched
22658 string is not the current transport, control is passed over to the other
22659 transport. For example, suppose the standard &(local_delivery)& transport has
22660 this added to it:
22661 .code
22662 file_format = "From       : local_delivery :\
22663                \1\1\1\1\n : local_mmdf_delivery"
22664 .endd
22665 Mailboxes that begin with &"From"& are still handled by this transport, but if
22666 a mailbox begins with four binary ones followed by a newline, control is passed
22667 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22668 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22669 is assumed to match the current transport. If the start of a mailbox doesn't
22670 match any string, or if the transport named for a given string is not defined,
22671 delivery is deferred.
22672
22673
22674 .option file_must_exist appendfile boolean false
22675 If this option is true, the file specified by the &%file%& option must exist.
22676 A temporary error occurs if it does not, causing delivery to be deferred.
22677 If this option is false, the file is created if it does not exist.
22678
22679
22680 .option lock_fcntl_timeout appendfile time 0s
22681 .cindex "timeout" "mailbox locking"
22682 .cindex "mailbox" "locking, blocking and non-blocking"
22683 .cindex "locking files"
22684 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22685 when locking an open mailbox file. If the call fails, the delivery process
22686 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22687 Non-blocking calls are used so that the file is not kept open during the wait
22688 for the lock; the reason for this is to make it as safe as possible for
22689 deliveries over NFS in the case when processes might be accessing an NFS
22690 mailbox without using a lock file. This should not be done, but
22691 misunderstandings and hence misconfigurations are not unknown.
22692
22693 On a busy system, however, the performance of a non-blocking lock approach is
22694 not as good as using a blocking lock with a timeout. In this case, the waiting
22695 is done inside the system call, and Exim's delivery process acquires the lock
22696 and can proceed as soon as the previous lock holder releases it.
22697
22698 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22699 timeout, are used. There may still be some retrying: the maximum number of
22700 retries is
22701 .code
22702 (lock_retries * lock_interval) / lock_fcntl_timeout
22703 .endd
22704 rounded up to the next whole number. In other words, the total time during
22705 which &(appendfile)& is trying to get a lock is roughly the same, unless
22706 &%lock_fcntl_timeout%& is set very large.
22707
22708 You should consider setting this option if you are getting a lot of delayed
22709 local deliveries because of errors of the form
22710 .code
22711 failed to lock mailbox /some/file (fcntl)
22712 .endd
22713
22714 .option lock_flock_timeout appendfile time 0s
22715 This timeout applies to file locking when using &[flock()]& (see
22716 &%use_flock%&); the timeout operates in a similar manner to
22717 &%lock_fcntl_timeout%&.
22718
22719
22720 .option lock_interval appendfile time 3s
22721 This specifies the time to wait between attempts to lock the file. See below
22722 for details of locking.
22723
22724
22725 .option lock_retries appendfile integer 10
22726 This specifies the maximum number of attempts to lock the file. A value of zero
22727 is treated as 1. See below for details of locking.
22728
22729
22730 .option lockfile_mode appendfile "octal integer" 0600
22731 This specifies the mode of the created lock file, when a lock file is being
22732 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22733
22734
22735 .option lockfile_timeout appendfile time 30m
22736 .cindex "timeout" "mailbox locking"
22737 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22738 exists and is older than this value, it is assumed to have been left behind by
22739 accident, and Exim attempts to remove it.
22740
22741
22742 .option mailbox_filecount appendfile string&!! unset
22743 .cindex "mailbox" "specifying size of"
22744 .cindex "size" "of mailbox"
22745 If this option is set, it is expanded, and the result is taken as the current
22746 number of files in the mailbox. It must be a decimal number, optionally
22747 followed by K or M. This provides a way of obtaining this information from an
22748 external source that maintains the data.
22749
22750
22751 .option mailbox_size appendfile string&!! unset
22752 .cindex "mailbox" "specifying size of"
22753 .cindex "size" "of mailbox"
22754 If this option is set, it is expanded, and the result is taken as the current
22755 size the mailbox. It must be a decimal number, optionally followed by K or M.
22756 This provides a way of obtaining this information from an external source that
22757 maintains the data. This is likely to be helpful for maildir deliveries where
22758 it is computationally expensive to compute the size of a mailbox.
22759
22760
22761
22762 .option maildir_format appendfile boolean false
22763 .cindex "maildir format" "specifying"
22764 If this option is set with the &%directory%& option, the delivery is into a new
22765 file, in the &"maildir"& format that is used by other mail software. When the
22766 transport is activated directly from a &(redirect)& router (for example, the
22767 &(address_file)& transport in the default configuration), setting
22768 &%maildir_format%& causes the path received from the router to be treated as a
22769 directory, whether or not it ends with &`/`&. This option is available only if
22770 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22771 &<<SECTmaildirdelivery>>& below for further details.
22772
22773
22774 .option maildir_quota_directory_regex appendfile string "See below"
22775 .cindex "maildir format" "quota; directories included in"
22776 .cindex "quota" "maildir; directories included in"
22777 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22778 a regular expression for specifying directories, relative to the quota
22779 directory (see &%quota_directory%&), that should be included in the quota
22780 calculation. The default value is:
22781 .code
22782 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22783 .endd
22784 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22785 (directories whose names begin with a dot). If you want to exclude the
22786 &_Trash_&
22787 folder from the count (as some sites do), you need to change this setting to
22788 .code
22789 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22790 .endd
22791 This uses a negative lookahead in the regular expression to exclude the
22792 directory whose name is &_.Trash_&. When a directory is excluded from quota
22793 calculations, quota processing is bypassed for any messages that are delivered
22794 directly into that directory.
22795
22796
22797 .option maildir_retries appendfile integer 10
22798 This option specifies the number of times to retry when writing a file in
22799 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22800
22801
22802 .option maildir_tag appendfile string&!! unset
22803 This option applies only to deliveries in maildir format, and is described in
22804 section &<<SECTmaildirdelivery>>& below.
22805
22806
22807 .option maildir_use_size_file appendfile&!! boolean false
22808 .cindex "maildir format" "&_maildirsize_& file"
22809 The result of string expansion for this option must be a valid boolean value.
22810 If it is true, it enables support for &_maildirsize_& files. Exim
22811 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22812 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22813 value is zero. See &%maildir_quota_directory_regex%& above and section
22814 &<<SECTmaildirdelivery>>& below for further details.
22815
22816 .option maildirfolder_create_regex appendfile string unset
22817 .cindex "maildir format" "&_maildirfolder_& file"
22818 .cindex "&_maildirfolder_&, creating"
22819 The value of this option is a regular expression. If it is unset, it has no
22820 effect. Otherwise, before a maildir delivery takes place, the pattern is
22821 matched against the name of the maildir directory, that is, the directory
22822 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22823 delivery. If there is a match, Exim checks for the existence of a file called
22824 &_maildirfolder_& in the directory, and creates it if it does not exist.
22825 See section &<<SECTmaildirdelivery>>& for more details.
22826
22827
22828 .option mailstore_format appendfile boolean false
22829 .cindex "mailstore format" "specifying"
22830 If this option is set with the &%directory%& option, the delivery is into two
22831 new files in  &"mailstore"& format. The option is available only if
22832 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22833 below for further details.
22834
22835
22836 .option mailstore_prefix appendfile string&!! unset
22837 This option applies only to deliveries in mailstore format, and is described in
22838 section &<<SECTopdir>>& below.
22839
22840
22841 .option mailstore_suffix appendfile string&!! unset
22842 This option applies only to deliveries in mailstore format, and is described in
22843 section &<<SECTopdir>>& below.
22844
22845
22846 .option mbx_format appendfile boolean false
22847 .cindex "locking files"
22848 .cindex "file" "locking"
22849 .cindex "file" "MBX format"
22850 .cindex "MBX format, specifying"
22851 This option is available only if Exim has been compiled with SUPPORT_MBX
22852 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22853 the message is appended to the mailbox file in MBX format instead of
22854 traditional Unix format. This format is supported by Pine4 and its associated
22855 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22856
22857 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22858 automatically changed by the use of &%mbx_format%&. They should normally be set
22859 empty when using MBX format, so this option almost always appears in this
22860 combination:
22861 .code
22862 mbx_format = true
22863 message_prefix =
22864 message_suffix =
22865 .endd
22866 If none of the locking options are mentioned in the configuration,
22867 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22868 is possible to specify the other kinds of locking with &%mbx_format%&, but
22869 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22870 interworks with &'c-client'&, providing for shared access to the mailbox. It
22871 should not be used if any program that does not use this form of locking is
22872 going to access the mailbox, nor should it be used if the mailbox file is NFS
22873 mounted, because it works only when the mailbox is accessed from a single host.
22874
22875 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22876 the standard version of &'c-client'&, because as long as it has a mailbox open
22877 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22878 append messages to it.
22879
22880
22881 .option message_prefix appendfile string&!! "see below"
22882 .cindex "&""From""& line"
22883 The string specified here is expanded and output at the start of every message.
22884 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22885 in which case it is:
22886 .code
22887 message_prefix = "From ${if def:return_path{$return_path}\
22888   {MAILER-DAEMON}} $tod_bsdinbox\n"
22889 .endd
22890 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22891 &`\n`& to &`\r\n`& in &%message_prefix%&.
22892
22893 .option message_suffix appendfile string&!! "see below"
22894 The string specified here is expanded and output at the end of every message.
22895 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22896 in which case it is a single newline character. The suffix can be suppressed by
22897 setting
22898 .code
22899 message_suffix =
22900 .endd
22901 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22902 &`\n`& to &`\r\n`& in &%message_suffix%&.
22903
22904 .option mode appendfile "octal integer" 0600
22905 If the output file is created, it is given this mode. If it already exists and
22906 has wider permissions, they are reduced to this mode. If it has narrower
22907 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22908 if the delivery is the result of a &%save%& command in a filter file specifying
22909 a particular mode, the mode of the output file is always forced to take that
22910 value, and this option is ignored.
22911
22912
22913 .option mode_fail_narrower appendfile boolean true
22914 This option applies in the case when an existing mailbox file has a narrower
22915 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22916 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22917 continues with the delivery attempt, using the existing mode of the file.
22918
22919
22920 .option notify_comsat appendfile boolean false
22921 If this option is true, the &'comsat'& daemon is notified after every
22922 successful delivery to a user mailbox. This is the daemon that notifies logged
22923 on users about incoming mail.
22924
22925
22926 .option quota appendfile string&!! unset
22927 .cindex "quota" "imposed by Exim"
22928 This option imposes a limit on the size of the file to which Exim is appending,
22929 or to the total space used in the directory tree when the &%directory%& option
22930 is set. In the latter case, computation of the space used is expensive, because
22931 all the files in the directory (and any sub-directories) have to be
22932 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22933 &%maildir_use_size_file%& for ways to avoid this in environments where users
22934 have no shell access to their mailboxes).
22935
22936 As there is no interlock against two simultaneous deliveries into a
22937 multi-file mailbox, it is possible for the quota to be overrun in this case.
22938 For single-file mailboxes, of course, an interlock is a necessity.
22939
22940 A file's size is taken as its &'used'& value. Because of blocking effects, this
22941 may be a lot less than the actual amount of disk space allocated to the file.
22942 If the sizes of a number of files are being added up, the rounding effect can
22943 become quite noticeable, especially on systems that have large block sizes.
22944 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22945 the obvious value which users understand most easily.
22946
22947 The value of the option is expanded, and must then be a numerical value
22948 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22949 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22950 and further option modifiers. If Exim is running on a system with
22951 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22952 be handled.
22953
22954 The option modifier &%no_check%& can be used to force delivery even if the over
22955 quota condition is met. The quota gets updated as usual.
22956
22957 &*Note*&: A value of zero is interpreted as &"no quota"&.
22958
22959 The expansion happens while Exim is running as root, before it changes uid for
22960 the delivery. This means that files that are inaccessible to the end user can
22961 be used to hold quota values that are looked up in the expansion. When delivery
22962 fails because this quota is exceeded, the handling of the error is as for
22963 system quota failures.
22964
22965 By default, Exim's quota checking mimics system quotas, and restricts the
22966 mailbox to the specified maximum size, though the value is not accurate to the
22967 last byte, owing to separator lines and additional headers that may get added
22968 during message delivery. When a mailbox is nearly full, large messages may get
22969 refused even though small ones are accepted, because the size of the current
22970 message is added to the quota when the check is made. This behaviour can be
22971 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22972 for exceeding the quota does not include the current message. Thus, deliveries
22973 continue until the quota has been exceeded; thereafter, no further messages are
22974 delivered. See also &%quota_warn_threshold%&.
22975
22976
22977 .option quota_directory appendfile string&!! unset
22978 This option defines the directory to check for quota purposes when delivering
22979 into individual files. The default is the delivery directory, or, if a file
22980 called &_maildirfolder_& exists in a maildir directory, the parent of the
22981 delivery directory.
22982
22983
22984 .option quota_filecount appendfile string&!! 0
22985 This option applies when the &%directory%& option is set. It limits the total
22986 number of files in the directory (compare the inode limit in system quotas). It
22987 can only be used if &%quota%& is also set. The value is expanded; an expansion
22988 failure causes delivery to be deferred. A value of zero is interpreted as
22989 &"no quota"&.
22990
22991 The option modifier &%no_check%& can be used to force delivery even if the over
22992 quota condition is met. The quota gets updated as usual.
22993
22994 .option quota_is_inclusive appendfile boolean true
22995 See &%quota%& above.
22996
22997
22998 .option quota_size_regex appendfile string unset
22999 This option applies when one of the delivery modes that writes a separate file
23000 for each message is being used. When Exim wants to find the size of one of
23001 these files in order to test the quota, it first checks &%quota_size_regex%&.
23002 If this is set to a regular expression that matches the filename, and it
23003 captures one string, that string is interpreted as a representation of the
23004 file's size. The value of &%quota_size_regex%& is not expanded.
23005
23006 This feature is useful only when users have no shell access to their mailboxes
23007 &-- otherwise they could defeat the quota simply by renaming the files. This
23008 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23009 the file length to the filename. For example:
23010 .code
23011 maildir_tag = ,S=$message_size
23012 quota_size_regex = ,S=(\d+)
23013 .endd
23014 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23015 number of lines in the message.
23016
23017 The regular expression should not assume that the length is at the end of the
23018 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23019 sometimes add other information onto the ends of message filenames.
23020
23021 Section &<<SECID136>>& contains further information.
23022
23023 This option should not be used when other message-handling software
23024 may duplicate messages by making hardlinks to the files.  When that is done Exim
23025 will count the message size once for each filename, in contrast with the actual
23026 disk usage.  When the option is not set, calculating total usage requires
23027 a system-call per file to get the size; the number of links is then available also
23028 as is used to adjust the effective size.
23029
23030
23031 .option quota_warn_message appendfile string&!! "see below"
23032 See below for the use of this option. If it is not set when
23033 &%quota_warn_threshold%& is set, it defaults to
23034 .code
23035 quota_warn_message = "\
23036   To: $local_part@$domain\n\
23037   Subject: Your mailbox\n\n\
23038   This message is automatically created \
23039   by mail delivery software.\n\n\
23040   The size of your mailbox has exceeded \
23041   a warning threshold that is\n\
23042   set by the system administrator.\n"
23043 .endd
23044
23045
23046 .option quota_warn_threshold appendfile string&!! 0
23047 .cindex "quota" "warning threshold"
23048 .cindex "mailbox" "size warning"
23049 .cindex "size" "of mailbox"
23050 This option is expanded in the same way as &%quota%& (see above). If the
23051 resulting value is greater than zero, and delivery of the message causes the
23052 size of the file or total space in the directory tree to cross the given
23053 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23054 may be specified as a percentage of it by following the value with a percent
23055 sign. For example:
23056 .code
23057 quota = 10M
23058 quota_warn_threshold = 75%
23059 .endd
23060 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23061 percent sign is ignored.
23062
23063 The warning message itself is specified by the &%quota_warn_message%& option,
23064 and it must start with a &'To:'& header line containing the recipient(s) of the
23065 warning message. These do not necessarily have to include the recipient(s) of
23066 the original message. A &'Subject:'& line should also normally be supplied. You
23067 can include any other header lines that you want. If you do not include a
23068 &'From:'& line, the default is:
23069 .code
23070 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23071 .endd
23072 .oindex &%errors_reply_to%&
23073 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23074 option.
23075
23076 The &%quota%& option does not have to be set in order to use this option; they
23077 are independent of one another except when the threshold is specified as a
23078 percentage.
23079
23080
23081 .option use_bsmtp appendfile boolean false
23082 .cindex "envelope from"
23083 .cindex "envelope sender"
23084 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23085 format, with the envelope sender and recipient(s) included as SMTP commands. If
23086 you want to include a leading HELO command with such messages, you can do
23087 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23088 for details of batch SMTP.
23089
23090
23091 .option use_crlf appendfile boolean false
23092 .cindex "carriage return"
23093 .cindex "linefeed"
23094 This option causes lines to be terminated with the two-character CRLF sequence
23095 (carriage return, linefeed) instead of just a linefeed character. In the case
23096 of batched SMTP, the byte sequence written to the file is then an exact image
23097 of what would be sent down a real SMTP connection.
23098
23099 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23100 (which are used to supply the traditional &"From&~"& and blank line separators
23101 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23102 carriage return characters if these are needed. In cases where these options
23103 have non-empty defaults, the values end with a single linefeed, so they must be
23104 changed to end with &`\r\n`& if &%use_crlf%& is set.
23105
23106
23107 .option use_fcntl_lock appendfile boolean "see below"
23108 This option controls the use of the &[fcntl()]& function to lock a file for
23109 exclusive use when a message is being appended. It is set by default unless
23110 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23111 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23112 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23113
23114
23115 .option use_flock_lock appendfile boolean false
23116 This option is provided to support the use of &[flock()]& for file locking, for
23117 the few situations where it is needed. Most modern operating systems support
23118 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23119 each other. Exim uses &[fcntl()]& locking by default.
23120
23121 This option is required only if you are using an operating system where
23122 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23123 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23124 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23125
23126 .cindex "Solaris" "&[flock()]& support"
23127 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23128 have it (and some, I think, provide a not quite right version built on top of
23129 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23130 the ability to use it, and any attempt to do so will cause a configuration
23131 error.
23132
23133 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23134 is just being mapped onto &[fcntl()]& by the OS).
23135
23136
23137 .option use_lockfile appendfile boolean "see below"
23138 If this option is turned off, Exim does not attempt to create a lock file when
23139 appending to a mailbox file. In this situation, the only locking is by
23140 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23141 sure that every MUA that is ever going to look at your users' mailboxes uses
23142 &[fcntl()]& rather than a lock file, and even then only when you are not
23143 delivering over NFS from more than one host.
23144
23145 .cindex "NFS" "lock file"
23146 In order to append to an NFS file safely from more than one host, it is
23147 necessary to take out a lock &'before'& opening the file, and the lock file
23148 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23149 file corruption.
23150
23151 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23152 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23153 except when &%mbx_format%& is set.
23154
23155
23156 .option use_mbx_lock appendfile boolean "see below"
23157 This option is available only if Exim has been compiled with SUPPORT_MBX
23158 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23159 locking rules be used. It is set by default if &%mbx_format%& is set and none
23160 of the locking options are mentioned in the configuration. The locking rules
23161 are the same as are used by the &'c-client'& library that underlies Pine and
23162 the IMAP4 and POP daemons that come with it (see the discussion below). The
23163 rules allow for shared access to the mailbox. However, this kind of locking
23164 does not work when the mailbox is NFS mounted.
23165
23166 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23167 &%use_flock_lock%& to control what kind of locking is used in implementing the
23168 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23169 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23170
23171
23172
23173
23174 .section "Operational details for appending" "SECTopappend"
23175 .cindex "appending to a file"
23176 .cindex "file" "appending"
23177 Before appending to a file, the following preparations are made:
23178
23179 .ilist
23180 If the name of the file is &_/dev/null_&, no action is taken, and a success
23181 return is given.
23182
23183 .next
23184 .cindex "directory creation"
23185 If any directories on the file's path are missing, Exim creates them if the
23186 &%create_directory%& option is set. A created directory's mode is given by the
23187 &%directory_mode%& option.
23188
23189 .next
23190 If &%file_format%& is set, the format of an existing file is checked. If this
23191 indicates that a different transport should be used, control is passed to that
23192 transport.
23193
23194 .next
23195 .cindex "file" "locking"
23196 .cindex "locking files"
23197 .cindex "NFS" "lock file"
23198 If &%use_lockfile%& is set, a lock file is built in a way that will work
23199 reliably over NFS, as follows:
23200
23201 .olist
23202 Create a &"hitching post"& file whose name is that of the lock file with the
23203 current time, primary host name, and process id added, by opening for writing
23204 as a new file. If this fails with an access error, delivery is deferred.
23205 .next
23206 Close the hitching post file, and hard link it to the lock filename.
23207 .next
23208 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23209 Unlink the hitching post name.
23210 .next
23211 Otherwise, use &[stat()]& to get information about the hitching post file, and
23212 then unlink hitching post name. If the number of links is exactly two, creation
23213 of the lock file succeeded but something (for example, an NFS server crash and
23214 restart) caused this fact not to be communicated to the &[link()]& call.
23215 .next
23216 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23217 up to &%lock_retries%& times. However, since any program that writes to a
23218 mailbox should complete its task very quickly, it is reasonable to time out old
23219 lock files that are normally the result of user agent and system crashes. If an
23220 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23221 it before trying again.
23222 .endlist olist
23223
23224 .next
23225 A call is made to &[lstat()]& to discover whether the main file exists, and if
23226 so, what its characteristics are. If &[lstat()]& fails for any reason other
23227 than non-existence, delivery is deferred.
23228
23229 .next
23230 .cindex "symbolic link" "to mailbox"
23231 .cindex "mailbox" "symbolic link"
23232 If the file does exist and is a symbolic link, delivery is deferred, unless the
23233 &%allow_symlink%& option is set, in which case the ownership of the link is
23234 checked, and then &[stat()]& is called to find out about the real file, which
23235 is then subjected to the checks below. The check on the top-level link
23236 ownership prevents one user creating a link for another's mailbox in a sticky
23237 directory, though allowing symbolic links in this case is definitely not a good
23238 idea. If there is a chain of symbolic links, the intermediate ones are not
23239 checked.
23240
23241 .next
23242 If the file already exists but is not a regular file, or if the file's owner
23243 and group (if the group is being checked &-- see &%check_group%& above) are
23244 different from the user and group under which the delivery is running,
23245 delivery is deferred.
23246
23247 .next
23248 If the file's permissions are more generous than specified, they are reduced.
23249 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23250 is set false, in which case the delivery is tried using the existing
23251 permissions.
23252
23253 .next
23254 The file's inode number is saved, and the file is then opened for appending.
23255 If this fails because the file has vanished, &(appendfile)& behaves as if it
23256 hadn't existed (see below). For any other failures, delivery is deferred.
23257
23258 .next
23259 If the file is opened successfully, check that the inode number hasn't
23260 changed, that it is still a regular file, and that the owner and permissions
23261 have not changed. If anything is wrong, defer delivery and freeze the message.
23262
23263 .next
23264 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23265 option is set. Otherwise, check that the file is being created in a permitted
23266 directory if the &%create_file%& option is set (deferring on failure), and then
23267 open for writing as a new file, with the O_EXCL and O_CREAT options,
23268 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23269 set). In this case, which can happen if the link points to a non-existent file,
23270 the file is opened for writing using O_CREAT but not O_EXCL, because
23271 that prevents link following.
23272
23273 .next
23274 .cindex "loop" "while file testing"
23275 If opening fails because the file exists, obey the tests given above for
23276 existing files. However, to avoid looping in a situation where the file is
23277 being continuously created and destroyed, the exists/not-exists loop is broken
23278 after 10 repetitions, and the message is then frozen.
23279
23280 .next
23281 If opening fails with any other error, defer delivery.
23282
23283 .next
23284 .cindex "file" "locking"
23285 .cindex "locking files"
23286 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23287 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23288 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23289 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23290 file, and an exclusive lock on the file whose name is
23291 .code
23292 /tmp/.<device-number>.<inode-number>
23293 .endd
23294 using the device and inode numbers of the open mailbox file, in accordance with
23295 the MBX locking rules. This file is created with a mode that is specified by
23296 the &%lockfile_mode%& option.
23297
23298 If Exim fails to lock the file, there are two possible courses of action,
23299 depending on the value of the locking timeout. This is obtained from
23300 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23301
23302 If the timeout value is zero, the file is closed, Exim waits for
23303 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23304 to lock it again. This happens up to &%lock_retries%& times, after which the
23305 delivery is deferred.
23306
23307 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23308 &[flock()]& are used (with the given timeout), so there has already been some
23309 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23310 immediately. It retries up to
23311 .code
23312 (lock_retries * lock_interval) / <timeout>
23313 .endd
23314 times (rounded up).
23315 .endlist
23316
23317 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23318 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23319
23320
23321 .section "Operational details for delivery to a new file" "SECTopdir"
23322 .cindex "delivery" "to single file"
23323 .cindex "&""From""& line"
23324 When the &%directory%& option is set instead of &%file%&, each message is
23325 delivered into a newly-created file or set of files. When &(appendfile)& is
23326 activated directly from a &(redirect)& router, neither &%file%& nor
23327 &%directory%& is normally set, because the path for delivery is supplied by the
23328 router. (See for example, the &(address_file)& transport in the default
23329 configuration.) In this case, delivery is to a new file if either the path name
23330 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23331
23332 No locking is required while writing the message to a new file, so the various
23333 locking options of the transport are ignored. The &"From"& line that by default
23334 separates messages in a single file is not normally needed, nor is the escaping
23335 of message lines that start with &"From"&, and there is no need to ensure a
23336 newline at the end of each message. Consequently, the default values for
23337 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23338 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23339
23340 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23341 the files in the delivery directory by default. However, you can specify a
23342 different directory by setting &%quota_directory%&. Also, for maildir
23343 deliveries (see below) the &_maildirfolder_& convention is honoured.
23344
23345
23346 .cindex "maildir format"
23347 .cindex "mailstore format"
23348 There are three different ways in which delivery to individual files can be
23349 done, controlled by the settings of the &%maildir_format%& and
23350 &%mailstore_format%& options. Note that code to support maildir or mailstore
23351 formats is not included in the binary unless SUPPORT_MAILDIR or
23352 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23353
23354 .cindex "directory creation"
23355 In all three cases an attempt is made to create the directory and any necessary
23356 sub-directories if they do not exist, provided that the &%create_directory%&
23357 option is set (the default). The location of a created directory can be
23358 constrained by setting &%create_file%&. A created directory's mode is given by
23359 the &%directory_mode%& option. If creation fails, or if the
23360 &%create_directory%& option is not set when creation is required, delivery is
23361 deferred.
23362
23363
23364
23365 .section "Maildir delivery" "SECTmaildirdelivery"
23366 .cindex "maildir format" "description of"
23367 If the &%maildir_format%& option is true, Exim delivers each message by writing
23368 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23369 directory that is defined by the &%directory%& option (the &"delivery
23370 directory"&). If the delivery is successful, the file is renamed into the
23371 &_new_& subdirectory.
23372
23373 In the filename, <&'stime'&> is the current time of day in seconds, and
23374 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23375 Exim checks that the time-of-day clock has moved on by at least one microsecond
23376 before terminating the delivery process. This guarantees uniqueness for the
23377 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23378 opening it. If any response other than ENOENT (does not exist) is given,
23379 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23380
23381 Before Exim carries out a maildir delivery, it ensures that subdirectories
23382 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23383 do not exist, Exim tries to create them and any superior directories in their
23384 path, subject to the &%create_directory%& and &%create_file%& options. If the
23385 &%maildirfolder_create_regex%& option is set, and the regular expression it
23386 contains matches the delivery directory, Exim also ensures that a file called
23387 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23388 &_maildirfolder_& file cannot be created, delivery is deferred.
23389
23390 These features make it possible to use Exim to create all the necessary files
23391 and directories in a maildir mailbox, including subdirectories for maildir++
23392 folders. Consider this example:
23393 .code
23394 maildir_format = true
23395 directory = /var/mail/$local_part\
23396            ${if eq{$local_part_suffix}{}{}\
23397            {/.${substr_1:$local_part_suffix}}}
23398 maildirfolder_create_regex = /\.[^/]+$
23399 .endd
23400 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23401 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23402 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23403 not match this name, so Exim will not look for or create the file
23404 &_/var/mail/pimbo/maildirfolder_&, though it will create
23405 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23406
23407 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23408 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23409 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23410 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23411 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23412
23413 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23414 not inadvertently match the toplevel maildir directory, because a
23415 &_maildirfolder_& file at top level would completely break quota calculations.
23416
23417 .cindex "quota" "in maildir delivery"
23418 .cindex "maildir++"
23419 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23420 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23421 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23422 Exim assumes the directory is a maildir++ folder directory, which is one level
23423 down from the user's top level mailbox directory. This causes it to start at
23424 the parent directory instead of the current directory when calculating the
23425 amount of space used.
23426
23427 One problem with delivering into a multi-file mailbox is that it is
23428 computationally expensive to compute the size of the mailbox for quota
23429 checking. Various approaches have been taken to reduce the amount of work
23430 needed. The next two sections describe two of them. A third alternative is to
23431 use some external process for maintaining the size data, and use the expansion
23432 of the &%mailbox_size%& option as a way of importing it into Exim.
23433
23434
23435
23436
23437 .section "Using tags to record message sizes" "SECID135"
23438 If &%maildir_tag%& is set, the string is expanded for each delivery.
23439 When the maildir file is renamed into the &_new_& sub-directory, the
23440 tag is added to its name. However, if adding the tag takes the length of the
23441 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23442 the tag is dropped and the maildir file is created with no tag.
23443
23444
23445 .vindex "&$message_size$&"
23446 Tags can be used to encode the size of files in their names; see
23447 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23448 happens after the message has been written. The value of the &$message_size$&
23449 variable is set to the number of bytes actually written. If the expansion is
23450 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23451 be deferred. The expanded tag may contain any printing characters except &"/"&.
23452 Non-printing characters in the string are ignored; if the resulting string is
23453 empty, it is ignored. If it starts with an alphanumeric character, a leading
23454 colon is inserted; this default has not proven to be the path that popular
23455 maildir implementations have chosen (but changing it in Exim would break
23456 backwards compatibility).
23457
23458 For one common implementation, you might set:
23459 .code
23460 maildir_tag = ,S=${message_size}
23461 .endd
23462 but you should check the documentation of the other software to be sure.
23463
23464 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23465 as this allows Exim to extract the size from your tag, instead of having to
23466 &[stat()]& each message file.
23467
23468
23469 .section "Using a maildirsize file" "SECID136"
23470 .cindex "quota" "in maildir delivery"
23471 .cindex "maildir format" "&_maildirsize_& file"
23472 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23473 storing quota and message size information in a file called &_maildirsize_&
23474 within the toplevel maildir directory. If this file does not exist, Exim
23475 creates it, setting the quota from the &%quota%& option of the transport. If
23476 the maildir directory itself does not exist, it is created before any attempt
23477 to write a &_maildirsize_& file.
23478
23479 The &_maildirsize_& file is used to hold information about the sizes of
23480 messages in the maildir, thus speeding up quota calculations. The quota value
23481 in the file is just a cache; if the quota is changed in the transport, the new
23482 value overrides the cached value when the next message is delivered. The cache
23483 is maintained for the benefit of other programs that access the maildir and
23484 need to know the quota.
23485
23486 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23487 file is maintained (with a zero quota setting), but no quota is imposed.
23488
23489 A regular expression is available for controlling which directories in the
23490 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23491 See the description of the &%maildir_quota_directory_regex%& option above for
23492 details.
23493
23494
23495 .section "Mailstore delivery" "SECID137"
23496 .cindex "mailstore format" "description of"
23497 If the &%mailstore_format%& option is true, each message is written as two
23498 files in the given directory. A unique base name is constructed from the
23499 message id and the current delivery process, and the files that are written use
23500 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23501 contains the message's envelope, and the &_.msg_& file contains the message
23502 itself. The base name is placed in the variable &$mailstore_basename$&.
23503
23504 During delivery, the envelope is first written to a file with the suffix
23505 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23506 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23507 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23508 file before accessing either of them. An alternative approach is to wait for
23509 the absence of a &_.tmp_& file.
23510
23511 The envelope file starts with any text defined by the &%mailstore_prefix%&
23512 option, expanded and terminated by a newline if there isn't one. Then follows
23513 the sender address on one line, then all the recipient addresses, one per line.
23514 There can be more than one recipient only if the &%batch_max%& option is set
23515 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23516 appended to the file, followed by a newline if it does not end with one.
23517
23518 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23519 failure, it is ignored. Other expansion errors are treated as serious
23520 configuration errors, and delivery is deferred. The variable
23521 &$mailstore_basename$& is available for use during these expansions.
23522
23523
23524 .section "Non-special new file delivery" "SECID138"
23525 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23526 file is created directly in the named directory. For example, when delivering
23527 messages into files in batched SMTP format for later delivery to some host (see
23528 section &<<SECTbatchSMTP>>&), a setting such as
23529 .code
23530 directory = /var/bsmtp/$host
23531 .endd
23532 might be used. A message is written to a file with a temporary name, which is
23533 then renamed when the delivery is complete. The final name is obtained by
23534 expanding the contents of the &%directory_file%& option.
23535 .ecindex IIDapptra1
23536 .ecindex IIDapptra2
23537
23538
23539
23540
23541
23542
23543 . ////////////////////////////////////////////////////////////////////////////
23544 . ////////////////////////////////////////////////////////////////////////////
23545
23546 .chapter "The autoreply transport" "CHID8"
23547 .scindex IIDauttra1 "transports" "&(autoreply)&"
23548 .scindex IIDauttra2 "&(autoreply)& transport"
23549 The &(autoreply)& transport is not a true transport in that it does not cause
23550 the message to be transmitted. Instead, it generates a new mail message as an
23551 automatic reply to the incoming message. &'References:'& and
23552 &'Auto-Submitted:'& header lines are included. These are constructed according
23553 to the rules in RFCs 2822 and 3834, respectively.
23554
23555 If the router that passes the message to this transport does not have the
23556 &%unseen%& option set, the original message (for the current recipient) is not
23557 delivered anywhere. However, when the &%unseen%& option is set on the router
23558 that passes the message to this transport, routing of the address continues, so
23559 another router can set up a normal message delivery.
23560
23561
23562 The &(autoreply)& transport is usually run as the result of mail filtering, a
23563 &"vacation"& message being the standard example. However, it can also be run
23564 directly from a router like any other transport. To reduce the possibility of
23565 message cascades, messages created by the &(autoreply)& transport always have
23566 empty envelope sender addresses, like bounce messages.
23567
23568 The parameters of the message to be sent can be specified in the configuration
23569 by options described below. However, these are used only when the address
23570 passed to the transport does not contain its own reply information. When the
23571 transport is run as a consequence of a
23572 &%mail%&
23573 or &%vacation%& command in a filter file, the parameters of the message are
23574 supplied by the filter, and passed with the address. The transport's options
23575 that define the message are then ignored (so they are not usually set in this
23576 case). The message is specified entirely by the filter or by the transport; it
23577 is never built from a mixture of options. However, the &%file_optional%&,
23578 &%mode%&, and &%return_message%& options apply in all cases.
23579
23580 &(Autoreply)& is implemented as a local transport. When used as a result of a
23581 command in a user's filter file, &(autoreply)& normally runs under the uid and
23582 gid of the user, and with appropriate current and home directories (see chapter
23583 &<<CHAPenvironment>>&).
23584
23585 There is a subtle difference between routing a message to a &(pipe)& transport
23586 that generates some text to be returned to the sender, and routing it to an
23587 &(autoreply)& transport. This difference is noticeable only if more than one
23588 address from the same message is so handled. In the case of a pipe, the
23589 separate outputs from the different addresses are gathered up and returned to
23590 the sender in a single message, whereas if &(autoreply)& is used, a separate
23591 message is generated for each address that is passed to it.
23592
23593 Non-printing characters are not permitted in the header lines generated for the
23594 message that &(autoreply)& creates, with the exception of newlines that are
23595 immediately followed by white space. If any non-printing characters are found,
23596 the transport defers.
23597 Whether characters with the top bit set count as printing characters or not is
23598 controlled by the &%print_topbitchars%& global option.
23599
23600 If any of the generic options for manipulating headers (for example,
23601 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23602 of the original message that is included in the generated message when
23603 &%return_message%& is set. They do not apply to the generated message itself.
23604
23605 .vindex "&$sender_address$&"
23606 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23607 the message, indicating that there were no recipients, it does not treat this
23608 as an error. This means that autoreplies sent to &$sender_address$& when this
23609 is empty (because the incoming message is a bounce message) do not cause
23610 problems. They are just discarded.
23611
23612
23613
23614 .section "Private options for autoreply" "SECID139"
23615 .cindex "options" "&(autoreply)& transport"
23616
23617 .option bcc autoreply string&!! unset
23618 This specifies the addresses that are to receive &"blind carbon copies"& of the
23619 message when the message is specified by the transport.
23620
23621
23622 .option cc autoreply string&!! unset
23623 This specifies recipients of the message and the contents of the &'Cc:'& header
23624 when the message is specified by the transport.
23625
23626
23627 .option file autoreply string&!! unset
23628 The contents of the file are sent as the body of the message when the message
23629 is specified by the transport. If both &%file%& and &%text%& are set, the text
23630 string comes first.
23631
23632
23633 .option file_expand autoreply boolean false
23634 If this is set, the contents of the file named by the &%file%& option are
23635 subjected to string expansion as they are added to the message.
23636
23637
23638 .option file_optional autoreply boolean false
23639 If this option is true, no error is generated if the file named by the &%file%&
23640 option or passed with the address does not exist or cannot be read.
23641
23642
23643 .option from autoreply string&!! unset
23644 This specifies the contents of the &'From:'& header when the message is
23645 specified by the transport.
23646
23647
23648 .option headers autoreply string&!! unset
23649 This specifies additional RFC 2822 headers that are to be added to the message
23650 when the message is specified by the transport. Several can be given by using
23651 &"\n"& to separate them. There is no check on the format.
23652
23653
23654 .option log autoreply string&!! unset
23655 This option names a file in which a record of every message sent is logged when
23656 the message is specified by the transport.
23657
23658
23659 .option mode autoreply "octal integer" 0600
23660 If either the log file or the &"once"& file has to be created, this mode is
23661 used.
23662
23663
23664 .option never_mail autoreply "address list&!!" unset
23665 If any run of the transport creates a message with a recipient that matches any
23666 item in the list, that recipient is quietly discarded. If all recipients are
23667 discarded, no message is created. This applies both when the recipients are
23668 generated by a filter and when they are specified in the transport.
23669
23670
23671
23672 .option once autoreply string&!! unset
23673 This option names a file or DBM database in which a record of each &'To:'&
23674 recipient is kept when the message is specified by the transport. &*Note*&:
23675 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23676
23677 If &%once%& is unset, or is set to an empty string, the message is always sent.
23678 By default, if &%once%& is set to a non-empty filename, the message
23679 is not sent if a potential recipient is already listed in the database.
23680 However, if the &%once_repeat%& option specifies a time greater than zero, the
23681 message is sent if that much time has elapsed since a message was last sent to
23682 this recipient. A setting of zero time for &%once_repeat%& (the default)
23683 prevents a message from being sent a second time &-- in this case, zero means
23684 infinity.
23685
23686 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23687 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23688 greater than zero, it changes the way Exim implements the &%once%& option.
23689 Instead of using a DBM file to record every recipient it sends to, it uses a
23690 regular file, whose size will never get larger than the given value.
23691
23692 In the file, Exim keeps a linear list of recipient addresses and the times at
23693 which they were sent messages. If the file is full when a new address needs to
23694 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23695 means that a given recipient may receive multiple messages, but at
23696 unpredictable intervals that depend on the rate of turnover of addresses in the
23697 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23698
23699
23700 .option once_file_size autoreply integer 0
23701 See &%once%& above.
23702
23703
23704 .option once_repeat autoreply time&!! 0s
23705 See &%once%& above.
23706 After expansion, the value of this option must be a valid time value.
23707
23708
23709 .option reply_to autoreply string&!! unset
23710 This specifies the contents of the &'Reply-To:'& header when the message is
23711 specified by the transport.
23712
23713
23714 .option return_message autoreply boolean false
23715 If this is set, a copy of the original message is returned with the new
23716 message, subject to the maximum size set in the &%return_size_limit%& global
23717 configuration option.
23718
23719
23720 .option subject autoreply string&!! unset
23721 This specifies the contents of the &'Subject:'& header when the message is
23722 specified by the transport. It is tempting to quote the original subject in
23723 automatic responses. For example:
23724 .code
23725 subject = Re: $h_subject:
23726 .endd
23727 There is a danger in doing this, however. It may allow a third party to
23728 subscribe your users to an opt-in mailing list, provided that the list accepts
23729 bounce messages as subscription confirmations. Well-managed lists require a
23730 non-bounce message to confirm a subscription, so the danger is relatively
23731 small.
23732
23733
23734
23735 .option text autoreply string&!! unset
23736 This specifies a single string to be used as the body of the message when the
23737 message is specified by the transport. If both &%text%& and &%file%& are set,
23738 the text comes first.
23739
23740
23741 .option to autoreply string&!! unset
23742 This specifies recipients of the message and the contents of the &'To:'& header
23743 when the message is specified by the transport.
23744 .ecindex IIDauttra1
23745 .ecindex IIDauttra2
23746
23747
23748
23749
23750 . ////////////////////////////////////////////////////////////////////////////
23751 . ////////////////////////////////////////////////////////////////////////////
23752
23753 .chapter "The lmtp transport" "CHAPLMTP"
23754 .cindex "transports" "&(lmtp)&"
23755 .cindex "&(lmtp)& transport"
23756 .cindex "LMTP" "over a pipe"
23757 .cindex "LMTP" "over a socket"
23758 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23759 specified command
23760 or by interacting with a Unix domain socket.
23761 This transport is something of a cross between the &(pipe)& and &(smtp)&
23762 transports. Exim also has support for using LMTP over TCP/IP; this is
23763 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23764 to be of minority interest, the default build-time configure in &_src/EDITME_&
23765 has it commented out. You need to ensure that
23766 .code
23767 TRANSPORT_LMTP=yes
23768 .endd
23769 .cindex "options" "&(lmtp)& transport"
23770 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23771 included in the Exim binary. The private options of the &(lmtp)& transport are
23772 as follows:
23773
23774 .option batch_id lmtp string&!! unset
23775 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23776
23777
23778 .option batch_max lmtp integer 1
23779 This limits the number of addresses that can be handled in a single delivery.
23780 Most LMTP servers can handle several addresses at once, so it is normally a
23781 good idea to increase this value. See the description of local delivery
23782 batching in chapter &<<CHAPbatching>>&.
23783
23784
23785 .option command lmtp string&!! unset
23786 This option must be set if &%socket%& is not set. The string is a command which
23787 is run in a separate process. It is split up into a command name and list of
23788 arguments, each of which is separately expanded (so expansion cannot change the
23789 number of arguments). The command is run directly, not via a shell. The message
23790 is passed to the new process using the standard input and output to operate the
23791 LMTP protocol.
23792
23793 .option ignore_quota lmtp boolean false
23794 .cindex "LMTP" "ignoring quota errors"
23795 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23796 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23797 in its response to the LHLO command.
23798
23799 .option socket lmtp string&!! unset
23800 This option must be set if &%command%& is not set. The result of expansion must
23801 be the name of a Unix domain socket. The transport connects to the socket and
23802 delivers the message to it using the LMTP protocol.
23803
23804
23805 .option timeout lmtp time 5m
23806 The transport is aborted if the created process or Unix domain socket does not
23807 respond to LMTP commands or message input within this timeout. Delivery
23808 is deferred, and will be tried again later. Here is an example of a typical
23809 LMTP transport:
23810 .code
23811 lmtp:
23812   driver = lmtp
23813   command = /some/local/lmtp/delivery/program
23814   batch_max = 20
23815   user = exim
23816 .endd
23817 This delivers up to 20 addresses at a time, in a mixture of domains if
23818 necessary, running as the user &'exim'&.
23819
23820
23821
23822 . ////////////////////////////////////////////////////////////////////////////
23823 . ////////////////////////////////////////////////////////////////////////////
23824
23825 .chapter "The pipe transport" "CHAPpipetransport"
23826 .scindex IIDpiptra1 "transports" "&(pipe)&"
23827 .scindex IIDpiptra2 "&(pipe)& transport"
23828 The &(pipe)& transport is used to deliver messages via a pipe to a command
23829 running in another process. One example is the use of &(pipe)& as a
23830 pseudo-remote transport for passing messages to some other delivery mechanism
23831 (such as UUCP). Another is the use by individual users to automatically process
23832 their incoming messages. The &(pipe)& transport can be used in one of the
23833 following ways:
23834
23835 .ilist
23836 .vindex "&$local_part$&"
23837 A router routes one address to a transport in the normal way, and the
23838 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23839 contains the local part of the address (as usual), and the command that is run
23840 is specified by the &%command%& option on the transport.
23841 .next
23842 .vindex "&$pipe_addresses$&"
23843 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23844 transport can handle more than one address in a single run. In this case, when
23845 more than one address is routed to the transport, &$local_part$& is not set
23846 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23847 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23848 that are routed to the transport.
23849 .next
23850 .vindex "&$address_pipe$&"
23851 A router redirects an address directly to a pipe command (for example, from an
23852 alias or forward file). In this case, &$address_pipe$& contains the text of the
23853 pipe command, and the &%command%& option on the transport is ignored unless
23854 &%force_command%& is set. If only one address is being transported
23855 (&%batch_max%& is not greater than one, or only one address was redirected to
23856 this pipe command), &$local_part$& contains the local part that was redirected.
23857 .endlist
23858
23859
23860 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23861 deliver messages over pipes using the LMTP interactive protocol. This is
23862 implemented by the &(lmtp)& transport.
23863
23864 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23865 &_.forward_& file, the command runs under the uid and gid of that user. In
23866 other cases, the uid and gid have to be specified explicitly, either on the
23867 transport or on the router that handles the address. Current and &"home"&
23868 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23869 details of the local delivery environment and chapter &<<CHAPbatching>>&
23870 for a discussion of local delivery batching.
23871
23872 .new
23873 .cindex "tainted data" "in pipe command"
23874 .cindex pipe "tainted data"
23875 Tainted data may not be used for the command name.
23876 .wen
23877
23878
23879 .section "Concurrent delivery" "SECID140"
23880 If two messages arrive at almost the same time, and both are routed to a pipe
23881 delivery, the two pipe transports may be run concurrently. You must ensure that
23882 any pipe commands you set up are robust against this happening. If the commands
23883 write to a file, the &%exim_lock%& utility might be of use.
23884 Alternatively the &%max_parallel%& option could be used with a value
23885 of "1" to enforce serialization.
23886
23887
23888
23889
23890 .section "Returned status and data" "SECID141"
23891 .cindex "&(pipe)& transport" "returned data"
23892 If the command exits with a non-zero return code, the delivery is deemed to
23893 have failed, unless either the &%ignore_status%& option is set (in which case
23894 the return code is treated as zero), or the return code is one of those listed
23895 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23896 later"&. In this case, delivery is deferred. Details of a permanent failure are
23897 logged, but are not included in the bounce message, which merely contains
23898 &"local delivery failed"&.
23899
23900 If the command exits on a signal and the &%freeze_signal%& option is set then
23901 the message will be frozen in the queue. If that option is not set, a bounce
23902 will be sent as normal.
23903
23904 If the return code is greater than 128 and the command being run is a shell
23905 script, it normally means that the script was terminated by a signal whose
23906 value is the return code minus 128. The &%freeze_signal%& option does not
23907 apply in this case.
23908
23909 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23910 return code is set to 127. This is the value that a shell returns if it is
23911 asked to run a non-existent command. The wording for the log line suggests that
23912 a non-existent command may be the problem.
23913
23914 The &%return_output%& option can affect the result of a pipe delivery. If it is
23915 set and the command produces any output on its standard output or standard
23916 error streams, the command is considered to have failed, even if it gave a zero
23917 return code or if &%ignore_status%& is set. The output from the command is
23918 included as part of the bounce message. The &%return_fail_output%& option is
23919 similar, except that output is returned only when the command exits with a
23920 failure return code, that is, a value other than zero or a code that matches
23921 &%temp_errors%&.
23922
23923
23924
23925 .section "How the command is run" "SECThowcommandrun"
23926 .cindex "&(pipe)& transport" "path for command"
23927 The command line is (by default) broken down into a command name and arguments
23928 by the &(pipe)& transport itself. The &%allow_commands%& and
23929 &%restrict_to_path%& options can be used to restrict the commands that may be
23930 run.
23931
23932 .cindex "quoting" "in pipe command"
23933 Unquoted arguments are delimited by white space. If an argument appears in
23934 double quotes, backslash is interpreted as an escape character in the usual
23935 way. If an argument appears in single quotes, no escaping is done.
23936
23937 String expansion is applied to the command line except when it comes from a
23938 traditional &_.forward_& file (commands from a filter file are expanded). The
23939 expansion is applied to each argument in turn rather than to the whole line.
23940 For this reason, any string expansion item that contains white space must be
23941 quoted so as to be contained within a single argument. A setting such as
23942 .code
23943 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23944 .endd
23945 will not work, because the expansion item gets split between several
23946 arguments. You have to write
23947 .code
23948 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23949 .endd
23950 to ensure that it is all in one argument. The expansion is done in this way,
23951 argument by argument, so that the number of arguments cannot be changed as a
23952 result of expansion, and quotes or backslashes in inserted variables do not
23953 interact with external quoting. However, this leads to problems if you want to
23954 generate multiple arguments (or the command name plus arguments) from a single
23955 expansion. In this situation, the simplest solution is to use a shell. For
23956 example:
23957 .code
23958 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23959 .endd
23960
23961 .cindex "transport" "filter"
23962 .cindex "filter" "transport filter"
23963 .vindex "&$pipe_addresses$&"
23964 Special handling takes place when an argument consists of precisely the text
23965 &`$pipe_addresses`& (no quotes).
23966 This is not a general expansion variable; the only
23967 place this string is recognized is when it appears as an argument for a pipe or
23968 transport filter command. It causes each address that is being handled to be
23969 inserted in the argument list at that point &'as a separate argument'&. This
23970 avoids any problems with spaces or shell metacharacters, and is of use when a
23971 &(pipe)& transport is handling groups of addresses in a batch.
23972
23973 If &%force_command%& is enabled on the transport, special handling takes place
23974 for an argument that consists of precisely the text &`$address_pipe`&.  It
23975 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23976 argument is inserted in the argument list at that point
23977 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23978 the only item in the argument; in fact, if it were then &%force_command%&
23979 should behave as a no-op.  Rather, it should be used to adjust the command
23980 run while preserving the argument vector separation.
23981
23982 After splitting up into arguments and expansion, the resulting command is run
23983 in a subprocess directly from the transport, &'not'& under a shell. The
23984 message that is being delivered is supplied on the standard input, and the
23985 standard output and standard error are both connected to a single pipe that is
23986 read by Exim. The &%max_output%& option controls how much output the command
23987 may produce, and the &%return_output%& and &%return_fail_output%& options
23988 control what is done with it.
23989
23990 Not running the command under a shell (by default) lessens the security risks
23991 in cases when a command from a user's filter file is built out of data that was
23992 taken from an incoming message. If a shell is required, it can of course be
23993 explicitly specified as the command to be run. However, there are circumstances
23994 where existing commands (for example, in &_.forward_& files) expect to be run
23995 under a shell and cannot easily be modified. To allow for these cases, there is
23996 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23997 works. Instead of breaking up the command line as just described, it expands it
23998 as a single string and passes the result to &_/bin/sh_&. The
23999 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24000 with &%use_shell%&, and the whole mechanism is inherently less secure.
24001
24002
24003
24004 .section "Environment variables" "SECTpipeenv"
24005 .cindex "&(pipe)& transport" "environment for command"
24006 .cindex "environment" "&(pipe)& transport"
24007 The environment variables listed below are set up when the command is invoked.
24008 This list is a compromise for maximum compatibility with other MTAs. Note that
24009 the &%environment%& option can be used to add additional variables to this
24010 environment. The environment for the &(pipe)& transport is not subject
24011 to the &%add_environment%& and &%keep_environment%& main config options.
24012 .display
24013 &`DOMAIN            `&   the domain of the address
24014 &`HOME              `&   the home directory, if set
24015 &`HOST              `&   the host name when called from a router (see below)
24016 &`LOCAL_PART        `&   see below
24017 &`LOCAL_PART_PREFIX `&   see below
24018 &`LOCAL_PART_SUFFIX `&   see below
24019 &`LOGNAME           `&   see below
24020 &`MESSAGE_ID        `&   Exim's local ID for the message
24021 &`PATH              `&   as specified by the &%path%& option below
24022 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24023 &`RECIPIENT         `&   the complete recipient address
24024 &`SENDER            `&   the sender of the message (empty if a bounce)
24025 &`SHELL             `&   &`/bin/sh`&
24026 &`TZ                `&   the value of the &%timezone%& option, if set
24027 &`USER              `&   see below
24028 .endd
24029 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24030 router, LOCAL_PART is set to the local part of the address. When it is
24031 called as a result of a forward or alias expansion, LOCAL_PART is set to
24032 the local part of the address that was expanded. In both cases, any affixes are
24033 removed from the local part, and made available in LOCAL_PART_PREFIX and
24034 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24035 same value as LOCAL_PART for compatibility with other MTAs.
24036
24037 .cindex "HOST"
24038 HOST is set only when a &(pipe)& transport is called from a router that
24039 associates hosts with an address, typically when using &(pipe)& as a
24040 pseudo-remote transport. HOST is set to the first host name specified by
24041 the router.
24042
24043 .cindex "HOME"
24044 If the transport's generic &%home_directory%& option is set, its value is used
24045 for the HOME environment variable. Otherwise, a home directory may be set
24046 by the router's &%transport_home_directory%& option, which defaults to the
24047 user's home directory if &%check_local_user%& is set.
24048
24049
24050 .section "Private options for pipe" "SECID142"
24051 .cindex "options" "&(pipe)& transport"
24052
24053
24054
24055 .option allow_commands pipe "string list&!!" unset
24056 .cindex "&(pipe)& transport" "permitted commands"
24057 The string is expanded, and is then interpreted as a colon-separated list of
24058 permitted commands. If &%restrict_to_path%& is not set, the only commands
24059 permitted are those in the &%allow_commands%& list. They need not be absolute
24060 paths; the &%path%& option is still used for relative paths. If
24061 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24062 in the &%allow_commands%& list, or a name without any slashes that is found on
24063 the path. In other words, if neither &%allow_commands%& nor
24064 &%restrict_to_path%& is set, there is no restriction on the command, but
24065 otherwise only commands that are permitted by one or the other are allowed. For
24066 example, if
24067 .code
24068 allow_commands = /usr/bin/vacation
24069 .endd
24070 and &%restrict_to_path%& is not set, the only permitted command is
24071 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24072 &%use_shell%& is set.
24073
24074
24075 .option batch_id pipe string&!! unset
24076 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24077
24078
24079 .option batch_max pipe integer 1
24080 This limits the number of addresses that can be handled in a single delivery.
24081 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24082
24083
24084 .option check_string pipe string unset
24085 As &(pipe)& writes the message, the start of each line is tested for matching
24086 &%check_string%&, and if it does, the initial matching characters are replaced
24087 by the contents of &%escape_string%&, provided both are set. The value of
24088 &%check_string%& is a literal string, not a regular expression, and the case of
24089 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24090 of &%check_string%& and &%escape_string%& are forced to values that implement
24091 the SMTP escaping protocol. Any settings made in the configuration file are
24092 ignored.
24093
24094
24095 .option command pipe string&!! unset
24096 This option need not be set when &(pipe)& is being used to deliver to pipes
24097 obtained directly from address redirections. In other cases, the option must be
24098 set, to provide a command to be run. It need not yield an absolute path (see
24099 the &%path%& option below). The command is split up into separate arguments by
24100 Exim, and each argument is separately expanded, as described in section
24101 &<<SECThowcommandrun>>& above.
24102
24103
24104 .option environment pipe string&!! unset
24105 .cindex "&(pipe)& transport" "environment for command"
24106 .cindex "environment" "&(pipe)& transport"
24107 This option is used to add additional variables to the environment in which the
24108 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24109 a string which is expanded, and then interpreted as a colon-separated list of
24110 environment settings of the form <&'name'&>=<&'value'&>.
24111
24112
24113 .option escape_string pipe string unset
24114 See &%check_string%& above.
24115
24116
24117 .option freeze_exec_fail pipe boolean false
24118 .cindex "exec failure"
24119 .cindex "failure of exec"
24120 .cindex "&(pipe)& transport" "failure of exec"
24121 Failure to exec the command in a pipe transport is by default treated like
24122 any other failure while running the command. However, if &%freeze_exec_fail%&
24123 is set, failure to exec is treated specially, and causes the message to be
24124 frozen, whatever the setting of &%ignore_status%&.
24125
24126
24127 .option freeze_signal pipe boolean false
24128 .cindex "signal exit"
24129 .cindex "&(pipe)& transport", "signal exit"
24130 Normally if the process run by a command in a pipe transport exits on a signal,
24131 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24132 frozen in Exim's queue instead.
24133
24134
24135 .option force_command pipe boolean false
24136 .cindex "force command"
24137 .cindex "&(pipe)& transport", "force command"
24138 Normally when a router redirects an address directly to a pipe command
24139 the &%command%& option on the transport is ignored.  If &%force_command%&
24140 is set, the &%command%& option will used. This is especially
24141 useful for forcing a wrapper or additional argument to be added to the
24142 command. For example:
24143 .code
24144 command = /usr/bin/remote_exec myhost -- $address_pipe
24145 force_command
24146 .endd
24147
24148 Note that &$address_pipe$& is handled specially in &%command%& when
24149 &%force_command%& is set, expanding out to the original argument vector as
24150 separate items, similarly to a Unix shell &`"$@"`& construct.
24151
24152
24153 .option ignore_status pipe boolean false
24154 If this option is true, the status returned by the subprocess that is set up to
24155 run the command is ignored, and Exim behaves as if zero had been returned.
24156 Otherwise, a non-zero status or termination by signal causes an error return
24157 from the transport unless the status value is one of those listed in
24158 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24159
24160 &*Note*&: This option does not apply to timeouts, which do not return a status.
24161 See the &%timeout_defer%& option for how timeouts are handled.
24162
24163
24164 .option log_defer_output pipe boolean false
24165 .cindex "&(pipe)& transport" "logging output"
24166 If this option is set, and the status returned by the command is
24167 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24168 and any output was produced on stdout or stderr, the first line of it is
24169 written to the main log.
24170
24171
24172 .option log_fail_output pipe boolean false
24173 If this option is set, and the command returns any output on stdout or
24174 stderr, and also ends with a return code that is neither zero nor one of
24175 the return codes listed in &%temp_errors%& (that is, the delivery
24176 failed), the first line of output is written to the main log. This
24177 option and &%log_output%& are mutually exclusive.  Only one of them may
24178 be set.
24179
24180
24181 .option log_output pipe boolean false
24182 If this option is set and the command returns any output on stdout or
24183 stderr, the first line of output is written to the main log, whatever
24184 the return code. This option and &%log_fail_output%& are mutually
24185 exclusive. Only one of them may be set.
24186
24187
24188 .option max_output pipe integer 20K
24189 This specifies the maximum amount of output that the command may produce on its
24190 standard output and standard error file combined. If the limit is exceeded, the
24191 process running the command is killed. This is intended as a safety measure to
24192 catch runaway processes. The limit is applied independently of the settings of
24193 the options that control what is done with such output (for example,
24194 &%return_output%&). Because of buffering effects, the amount of output may
24195 exceed the limit by a small amount before Exim notices.
24196
24197
24198 .option message_prefix pipe string&!! "see below"
24199 The string specified here is expanded and output at the start of every message.
24200 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24201 .code
24202 message_prefix = \
24203   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24204   ${tod_bsdinbox}\n
24205 .endd
24206 .cindex "Cyrus"
24207 .cindex "&%tmail%&"
24208 .cindex "&""From""& line"
24209 This is required by the commonly used &_/usr/bin/vacation_& program.
24210 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24211 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24212 setting
24213 .code
24214 message_prefix =
24215 .endd
24216 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24217 &`\n`& to &`\r\n`& in &%message_prefix%&.
24218
24219
24220 .option message_suffix pipe string&!! "see below"
24221 The string specified here is expanded and output at the end of every message.
24222 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24223 The suffix can be suppressed by setting
24224 .code
24225 message_suffix =
24226 .endd
24227 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24228 &`\n`& to &`\r\n`& in &%message_suffix%&.
24229
24230
24231 .option path pipe string&!! "/bin:/usr/bin"
24232 This option is expanded and
24233 specifies the string that is set up in the PATH environment
24234 variable of the subprocess.
24235 If the &%command%& option does not yield an absolute path name, the command is
24236 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24237 apply to a command specified as a transport filter.
24238
24239
24240 .option permit_coredump pipe boolean false
24241 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24242 a core-dump of a pipe command, enable this command.  This enables core-dumps
24243 during delivery and affects both the Exim binary and the pipe command run.
24244 It is recommended that this option remain off unless and until you have a need
24245 for it and that this only be enabled when needed, as the risk of excessive
24246 resource consumption can be quite high.  Note also that Exim is typically
24247 installed as a setuid binary and most operating systems will inhibit coredumps
24248 of these by default, so further OS-specific action may be required.
24249
24250
24251 .option pipe_as_creator pipe boolean false
24252 .cindex "uid (user id)" "local delivery"
24253 If the generic &%user%& option is not set and this option is true, the delivery
24254 process is run under the uid that was in force when Exim was originally called
24255 to accept the message. If the group id is not otherwise set (via the generic
24256 &%group%& option), the gid that was in force when Exim was originally called to
24257 accept the message is used.
24258
24259
24260 .option restrict_to_path pipe boolean false
24261 When this option is set, any command name not listed in &%allow_commands%& must
24262 contain no slashes. The command is searched for only in the directories listed
24263 in the &%path%& option. This option is intended for use in the case when a pipe
24264 command has been generated from a user's &_.forward_& file. This is usually
24265 handled by a &(pipe)& transport called &%address_pipe%&.
24266
24267
24268 .option return_fail_output pipe boolean false
24269 If this option is true, and the command produced any output and ended with a
24270 return code other than zero or one of the codes listed in &%temp_errors%& (that
24271 is, the delivery failed), the output is returned in the bounce message.
24272 However, if the message has a null sender (that is, it is itself a bounce
24273 message), output from the command is discarded. This option and
24274 &%return_output%& are mutually exclusive. Only one of them may be set.
24275
24276
24277
24278 .option return_output pipe boolean false
24279 If this option is true, and the command produced any output, the delivery is
24280 deemed to have failed whatever the return code from the command, and the output
24281 is returned in the bounce message. Otherwise, the output is just discarded.
24282 However, if the message has a null sender (that is, it is a bounce message),
24283 output from the command is always discarded, whatever the setting of this
24284 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24285 of them may be set.
24286
24287
24288
24289 .option temp_errors pipe "string list" "see below"
24290 .cindex "&(pipe)& transport" "temporary failure"
24291 This option contains either a colon-separated list of numbers, or a single
24292 asterisk. If &%ignore_status%& is false
24293 and &%return_output%& is not set,
24294 and the command exits with a non-zero return code, the failure is treated as
24295 temporary and the delivery is deferred if the return code matches one of the
24296 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24297 codes are treated as permanent errors. The default setting contains the codes
24298 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24299 compiled on a system that does not define these macros, it assumes values of 75
24300 and 73, respectively.
24301
24302
24303 .option timeout pipe time 1h
24304 If the command fails to complete within this time, it is killed. This normally
24305 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24306 specifies no timeout. In order to ensure that any subprocesses created by the
24307 command are also killed, Exim makes the initial process a process group leader,
24308 and kills the whole process group on a timeout. However, this can be defeated
24309 if one of the processes starts a new process group.
24310
24311 .option timeout_defer pipe boolean false
24312 A timeout in a &(pipe)& transport, either in the command that the transport
24313 runs, or in a transport filter that is associated with it, is by default
24314 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24315 is set true, both kinds of timeout become temporary errors, causing the
24316 delivery to be deferred.
24317
24318 .option umask pipe "octal integer" 022
24319 This specifies the umask setting for the subprocess that runs the command.
24320
24321
24322 .option use_bsmtp pipe boolean false
24323 .cindex "envelope sender"
24324 If this option is set true, the &(pipe)& transport writes messages in &"batch
24325 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24326 commands. If you want to include a leading HELO command with such messages,
24327 you can do so by setting the &%message_prefix%& option. See section
24328 &<<SECTbatchSMTP>>& for details of batch SMTP.
24329
24330 .option use_classresources pipe boolean false
24331 .cindex "class resources (BSD)"
24332 This option is available only when Exim is running on FreeBSD, NetBSD, or
24333 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24334 resource limits when a &(pipe)& transport is run to perform a delivery. The
24335 limits for the uid under which the pipe is to run are obtained from the login
24336 class database.
24337
24338
24339 .option use_crlf pipe boolean false
24340 .cindex "carriage return"
24341 .cindex "linefeed"
24342 This option causes lines to be terminated with the two-character CRLF sequence
24343 (carriage return, linefeed) instead of just a linefeed character. In the case
24344 of batched SMTP, the byte sequence written to the pipe is then an exact image
24345 of what would be sent down a real SMTP connection.
24346
24347 The contents of the &%message_prefix%& and &%message_suffix%& options are
24348 written verbatim, so must contain their own carriage return characters if these
24349 are needed. When &%use_bsmtp%& is not set, the default values for both
24350 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24351 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24352
24353
24354 .option use_shell pipe boolean false
24355 .vindex "&$pipe_addresses$&"
24356 If this option is set, it causes the command to be passed to &_/bin/sh_&
24357 instead of being run directly from the transport, as described in section
24358 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24359 where the command is expected to be run under a shell and cannot easily be
24360 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24361 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24362 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24363 its &%-c%& option.
24364
24365
24366
24367 .section "Using an external local delivery agent" "SECID143"
24368 .cindex "local delivery" "using an external agent"
24369 .cindex "&'procmail'&"
24370 .cindex "external local delivery"
24371 .cindex "delivery" "&'procmail'&"
24372 .cindex "delivery" "by external agent"
24373 The &(pipe)& transport can be used to pass all messages that require local
24374 delivery to a separate local delivery agent such as &%procmail%&. When doing
24375 this, care must be taken to ensure that the pipe is run under an appropriate
24376 uid and gid. In some configurations one wants this to be a uid that is trusted
24377 by the delivery agent to supply the correct sender of the message. It may be
24378 necessary to recompile or reconfigure the delivery agent so that it trusts an
24379 appropriate user. The following is an example transport and router
24380 configuration for &%procmail%&:
24381 .code
24382 # transport
24383 procmail_pipe:
24384   driver = pipe
24385   command = /usr/local/bin/procmail -d $local_part
24386   return_path_add
24387   delivery_date_add
24388   envelope_to_add
24389   check_string = "From "
24390   escape_string = ">From "
24391   umask = 077
24392   user = $local_part
24393   group = mail
24394
24395 # router
24396 procmail:
24397   driver = accept
24398   check_local_user
24399   transport = procmail_pipe
24400 .endd
24401 In this example, the pipe is run as the local user, but with the group set to
24402 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24403 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24404 user to supply a correct sender address. If you do not specify either a
24405 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24406 home directory is the user's home directory by default.
24407
24408 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24409 .code
24410 IFS=" "
24411 .endd
24412 as shown in some &%procmail%& documentation, because Exim does not by default
24413 use a shell to run pipe commands.
24414
24415 .cindex "Cyrus"
24416 The next example shows a transport and a router for a system where local
24417 deliveries are handled by the Cyrus IMAP server.
24418 .code
24419 # transport
24420 local_delivery_cyrus:
24421   driver = pipe
24422   command = /usr/cyrus/bin/deliver \
24423             -m ${substr_1:$local_part_suffix} -- $local_part
24424   user = cyrus
24425   group = mail
24426   return_output
24427   log_output
24428   message_prefix =
24429   message_suffix =
24430
24431 # router
24432 local_user_cyrus:
24433   driver = accept
24434   check_local_user
24435   local_part_suffix = .*
24436   transport = local_delivery_cyrus
24437 .endd
24438 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24439 &%return_output%& to cause any text written by Cyrus to be returned to the
24440 sender.
24441 .ecindex IIDpiptra1
24442 .ecindex IIDpiptra2
24443
24444
24445 . ////////////////////////////////////////////////////////////////////////////
24446 . ////////////////////////////////////////////////////////////////////////////
24447
24448 .chapter "The smtp transport" "CHAPsmtptrans"
24449 .scindex IIDsmttra1 "transports" "&(smtp)&"
24450 .scindex IIDsmttra2 "&(smtp)& transport"
24451 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24452 or LMTP protocol. The list of hosts to try can either be taken from the address
24453 that is being processed (having been set up by the router), or specified
24454 explicitly for the transport. Timeout and retry processing (see chapter
24455 &<<CHAPretry>>&) is applied to each IP address independently.
24456
24457
24458 .section "Multiple messages on a single connection" "SECID144"
24459 The sending of multiple messages over a single TCP/IP connection can arise in
24460 two ways:
24461
24462 .ilist
24463 If a message contains more than &%max_rcpt%& (see below) addresses that are
24464 routed to the same host, more than one copy of the message has to be sent to
24465 that host. In this situation, multiple copies may be sent in a single run of
24466 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24467 does when it has too many addresses to send in one message also depends on the
24468 value of the global &%remote_max_parallel%& option. Details are given in
24469 section &<<SECToutSMTPTCP>>&.)
24470 .next
24471 .cindex "hints database" "remembering routing"
24472 When a message has been successfully delivered over a TCP/IP connection, Exim
24473 looks in its hints database to see if there are any other messages awaiting a
24474 connection to the same host. If there are, a new delivery process is started
24475 for one of them, and the current TCP/IP connection is passed on to it. The new
24476 process may in turn send multiple copies and possibly create yet another
24477 process.
24478 .endlist
24479
24480
24481 For each copy sent over the same TCP/IP connection, a sequence counter is
24482 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24483 no further messages are sent over that connection.
24484
24485
24486
24487 .section "Use of the $host and $host_address variables" "SECID145"
24488 .vindex "&$host$&"
24489 .vindex "&$host_address$&"
24490 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24491 &$host_address$& are the name and IP address of the first host on the host list
24492 passed by the router. However, when the transport is about to connect to a
24493 specific host, and while it is connected to that host, &$host$& and
24494 &$host_address$& are set to the values for that host. These are the values
24495 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24496 &%serialize_hosts%&, and the various TLS options are expanded.
24497
24498
24499 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24500 .vindex &$tls_bits$&
24501 .vindex &$tls_cipher$&
24502 .vindex &$tls_peerdn$&
24503 .vindex &$tls_sni$&
24504 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24505 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24506 are the values that were set when the message was received.
24507 These are the values that are used for options that are expanded before any
24508 SMTP connections are made. Just before each connection is made, these four
24509 variables are emptied. If TLS is subsequently started, they are set to the
24510 appropriate values for the outgoing connection, and these are the values that
24511 are in force when any authenticators are run and when the
24512 &%authenticated_sender%& option is expanded.
24513
24514 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24515 and will be removed in a future release.
24516
24517
24518 .section "Private options for smtp" "SECID146"
24519 .cindex "options" "&(smtp)& transport"
24520 The private options of the &(smtp)& transport are as follows:
24521
24522
24523 .option address_retry_include_sender smtp boolean true
24524 .cindex "4&'xx'& responses" "retrying after"
24525 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24526 is the combination of sender and recipient that is delayed in subsequent queue
24527 runs until the retry time is reached. You can delay the recipient without
24528 reference to the sender (which is what earlier versions of Exim did), by
24529 setting &%address_retry_include_sender%& false. However, this can lead to
24530 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24531
24532 .option allow_localhost smtp boolean false
24533 .cindex "local host" "sending to"
24534 .cindex "fallback" "hosts specified on transport"
24535 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24536 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24537 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24538 the delivery anyway. This should be used only in special cases when the
24539 configuration ensures that no looping will result (for example, a differently
24540 configured Exim is listening on the port to which the message is sent).
24541
24542
24543 .option authenticated_sender smtp string&!! unset
24544 .cindex "Cyrus"
24545 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24546 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24547 overriding any existing authenticated sender value. If the string expansion is
24548 forced to fail, the option is ignored. Other expansion failures cause delivery
24549 to be deferred. If the result of expansion is an empty string, that is also
24550 ignored.
24551
24552 The expansion happens after the outgoing connection has been made and TLS
24553 started, if required. This means that the &$host$&, &$host_address$&,
24554 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24555 particular connection.
24556
24557 If the SMTP session is not authenticated, the expansion of
24558 &%authenticated_sender%& still happens (and can cause the delivery to be
24559 deferred if it fails), but no AUTH= item is added to MAIL commands
24560 unless &%authenticated_sender_force%& is true.
24561
24562 This option allows you to use the &(smtp)& transport in LMTP mode to
24563 deliver mail to Cyrus IMAP and provide the proper local part as the
24564 &"authenticated sender"&, via a setting such as:
24565 .code
24566 authenticated_sender = $local_part
24567 .endd
24568 This removes the need for IMAP subfolders to be assigned special ACLs to
24569 allow direct delivery to those subfolders.
24570
24571 Because of expected uses such as that just described for Cyrus (when no
24572 domain is involved), there is no checking on the syntax of the provided
24573 value.
24574
24575
24576 .option authenticated_sender_force smtp boolean false
24577 If this option is set true, the &%authenticated_sender%& option's value
24578 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24579 authenticated as a client.
24580
24581
24582 .option command_timeout smtp time 5m
24583 This sets a timeout for receiving a response to an SMTP command that has been
24584 sent out. It is also used when waiting for the initial banner line from the
24585 remote host. Its value must not be zero.
24586
24587
24588 .option connect_timeout smtp time 5m
24589 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24590 to a remote host. A setting of zero allows the system timeout (typically
24591 several minutes) to act. To have any effect, the value of this option must be
24592 less than the system timeout. However, it has been observed that on some
24593 systems there is no system timeout, which is why the default value for this
24594 option is 5 minutes, a value recommended by RFC 1123.
24595
24596
24597 .option connection_max_messages smtp integer 500
24598 .cindex "SMTP" "passed connection"
24599 .cindex "SMTP" "multiple deliveries"
24600 .cindex "multiple SMTP deliveries"
24601 This controls the maximum number of separate message deliveries that are sent
24602 over a single TCP/IP connection. If the value is zero, there is no limit.
24603 For testing purposes, this value can be overridden by the &%-oB%& command line
24604 option.
24605
24606
24607 .option dane_require_tls_ciphers smtp string&!! unset
24608 .cindex "TLS" "requiring specific ciphers for DANE"
24609 .cindex "cipher" "requiring specific"
24610 .cindex DANE "TLS ciphers"
24611 This option may be used to override &%tls_require_ciphers%& for connections
24612 where DANE has been determined to be in effect.
24613 If not set, then &%tls_require_ciphers%& will be used.
24614 Normal SMTP delivery is not able to make strong demands of TLS cipher
24615 configuration, because delivery will fall back to plaintext.  Once DANE has
24616 been determined to be in effect, there is no plaintext fallback and making the
24617 TLS cipherlist configuration stronger will increase security, rather than
24618 counter-intuitively decreasing it.
24619 If the option expands to be empty or is forced to fail, then it will
24620 be treated as unset and &%tls_require_ciphers%& will be used instead.
24621
24622
24623 .option data_timeout smtp time 5m
24624 This sets a timeout for the transmission of each block in the data portion of
24625 the message. As a result, the overall timeout for a message depends on the size
24626 of the message. Its value must not be zero. See also &%final_timeout%&.
24627
24628
24629 .option dkim_canon smtp string&!! unset
24630 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24631 .option dkim_domain smtp string list&!! unset
24632 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24633 .option dkim_hash smtp string&!! sha256
24634 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24635 .option dkim_identity smtp string&!! unset
24636 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24637 .option dkim_private_key smtp string&!! unset
24638 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24639 .option dkim_selector smtp string&!! unset
24640 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24641 .option dkim_strict smtp string&!! unset
24642 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24643 .option dkim_sign_headers smtp string&!! "per RFC"
24644 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24645 .option dkim_timestamps smtp string&!! unset
24646 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24647
24648
24649 .option delay_after_cutoff smtp boolean true
24650 .cindex "final cutoff" "retries, controlling"
24651 .cindex retry "final cutoff"
24652 This option controls what happens when all remote IP addresses for a given
24653 domain have been inaccessible for so long that they have passed their retry
24654 cutoff times.
24655
24656 In the default state, if the next retry time has not been reached for any of
24657 them, the address is bounced without trying any deliveries. In other words,
24658 Exim delays retrying an IP address after the final cutoff time until a new
24659 retry time is reached, and can therefore bounce an address without ever trying
24660 a delivery, when machines have been down for a long time. Some people are
24661 unhappy at this prospect, so...
24662
24663 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24664 addresses are past their final cutoff time, Exim tries to deliver to those
24665 IP addresses that have not been tried since the message arrived. If there are
24666 none, of if they all fail, the address is bounced. In other words, it does not
24667 delay when a new message arrives, but immediately tries those expired IP
24668 addresses that haven't been tried since the message arrived. If there is a
24669 continuous stream of messages for the dead hosts, unsetting
24670 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24671 to them.
24672
24673
24674 .option dns_qualify_single smtp boolean true
24675 If the &%hosts%& or &%fallback_hosts%& option is being used,
24676 and the &%gethostbyname%& option is false,
24677 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24678 in chapter &<<CHAPdnslookup>>& for more details.
24679
24680
24681 .option dns_search_parents smtp boolean false
24682 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24683 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24684 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24685 details.
24686
24687
24688 .option dnssec_request_domains smtp "domain list&!!" *
24689 .cindex "MX record" "security"
24690 .cindex "DNSSEC" "MX lookup"
24691 .cindex "security" "MX lookup"
24692 .cindex "DNS" "DNSSEC"
24693 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24694 the dnssec request bit set. Setting this transport option is only useful if the
24695 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24696 router option.
24697
24698
24699
24700 .option dnssec_require_domains smtp "domain list&!!" unset
24701 .cindex "MX record" "security"
24702 .cindex "DNSSEC" "MX lookup"
24703 .cindex "security" "MX lookup"
24704 .cindex "DNS" "DNSSEC"
24705 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24706 the dnssec request bit set.  Setting this transport option is only
24707 useful if the transport overrides or sets the host names. See the
24708 &%dnssec_require_domains%& router option.
24709
24710
24711
24712 .option dscp smtp string&!! unset
24713 .cindex "DCSP" "outbound"
24714 This option causes the DSCP value associated with a socket to be set to one
24715 of a number of fixed strings or to numeric value.
24716 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24717 Common values include &`throughput`&, &`mincost`&, and on newer systems
24718 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24719
24720 The outbound packets from Exim will be marked with this value in the header
24721 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24722 that these values will have any effect, not be stripped by networking
24723 equipment, or do much of anything without cooperation with your Network
24724 Engineer and those of all network operators between the source and destination.
24725
24726
24727 .option fallback_hosts smtp "string list" unset
24728 .cindex "fallback" "hosts specified on transport"
24729 String expansion is not applied to this option. The argument must be a
24730 colon-separated list of host names or IP addresses, optionally also including
24731 port numbers, though the separator can be changed, as described in section
24732 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24733 item in a &%route_list%& setting for the &(manualroute)& router, as described
24734 in section &<<SECTformatonehostitem>>&.
24735
24736 Fallback hosts can also be specified on routers, which associate them with the
24737 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24738 &%fallback_hosts%& specified on the transport is used only if the address does
24739 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24740 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24741 However, &%hosts_randomize%& does apply to fallback host lists.
24742
24743 If Exim is unable to deliver to any of the hosts for a particular address, and
24744 the errors are not permanent rejections, the address is put on a separate
24745 transport queue with its host list replaced by the fallback hosts, unless the
24746 address was routed via MX records and the current host was in the original MX
24747 list. In that situation, the fallback host list is not used.
24748
24749 Once normal deliveries are complete, the fallback queue is delivered by
24750 re-running the same transports with the new host lists. If several failing
24751 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24752 copy of the message is sent.
24753
24754 The resolution of the host names on the fallback list is controlled by the
24755 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24756 both to cases when the host list comes with the address and when it is taken
24757 from &%hosts%&. This option provides a &"use a smart host only if delivery
24758 fails"& facility.
24759
24760
24761 .option final_timeout smtp time 10m
24762 This is the timeout that applies while waiting for the response to the final
24763 line containing just &"."& that terminates a message. Its value must not be
24764 zero.
24765
24766 .option gethostbyname smtp boolean false
24767 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24768 being used, names are looked up using &[gethostbyname()]&
24769 (or &[getipnodebyname()]& when available)
24770 instead of using the DNS. Of course, that function may in fact use the DNS, but
24771 it may also consult other sources of information such as &_/etc/hosts_&.
24772
24773 .option gnutls_compat_mode smtp boolean unset
24774 This option controls whether GnuTLS is used in compatibility mode in an Exim
24775 server. This reduces security slightly, but improves interworking with older
24776 implementations of TLS.
24777
24778 .option helo_data smtp string&!! "see below"
24779 .cindex "HELO" "argument, setting"
24780 .cindex "EHLO" "argument, setting"
24781 .cindex "LHLO argument setting"
24782 The value of this option is expanded after a connection to a another host has
24783 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24784 command that starts the outgoing SMTP or LMTP session. The default value of the
24785 option is:
24786 .code
24787 $primary_hostname
24788 .endd
24789 During the expansion, the variables &$host$& and &$host_address$& are set to
24790 the identity of the remote host, and the variables &$sending_ip_address$& and
24791 &$sending_port$& are set to the local IP address and port number that are being
24792 used. These variables can be used to generate different values for different
24793 servers or different local IP addresses. For example, if you want the string
24794 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24795 interface address, you could use this:
24796 .code
24797 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24798   {$primary_hostname}}
24799 .endd
24800 The use of &%helo_data%& applies both to sending messages and when doing
24801 callouts.
24802
24803 .option hosts smtp "string list&!!" unset
24804 Hosts are associated with an address by a router such as &(dnslookup)&, which
24805 finds the hosts by looking up the address domain in the DNS, or by
24806 &(manualroute)&, which has lists of hosts in its configuration. However,
24807 email addresses can be passed to the &(smtp)& transport by any router, and not
24808 all of them can provide an associated list of hosts.
24809
24810 The &%hosts%& option specifies a list of hosts to be used if the address being
24811 processed does not have any hosts associated with it. The hosts specified by
24812 &%hosts%& are also used, whether or not the address has its own hosts, if
24813 &%hosts_override%& is set.
24814
24815 The string is first expanded, before being interpreted as a colon-separated
24816 list of host names or IP addresses, possibly including port numbers. The
24817 separator may be changed to something other than colon, as described in section
24818 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24819 item in a &%route_list%& setting for the &(manualroute)& router, as described
24820 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24821 of the &(manualroute)& router is not available here.
24822
24823 If the expansion fails, delivery is deferred. Unless the failure was caused by
24824 the inability to complete a lookup, the error is logged to the panic log as
24825 well as the main log. Host names are looked up either by searching directly for
24826 address records in the DNS or by calling &[gethostbyname()]& (or
24827 &[getipnodebyname()]& when available), depending on the setting of the
24828 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24829 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24830 address are used.
24831
24832 During delivery, the hosts are tried in order, subject to their retry status,
24833 unless &%hosts_randomize%& is set.
24834
24835
24836 .option hosts_avoid_esmtp smtp "host list&!!" unset
24837 .cindex "ESMTP, avoiding use of"
24838 .cindex "HELO" "forcing use of"
24839 .cindex "EHLO" "avoiding use of"
24840 .cindex "PIPELINING" "avoiding the use of"
24841 This option is for use with broken hosts that announce ESMTP facilities (for
24842 example, PIPELINING) and then fail to implement them properly. When a host
24843 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24844 start of the SMTP session. This means that it cannot use any of the ESMTP
24845 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24846
24847
24848 .option hosts_avoid_pipelining smtp "host list&!!" unset
24849 .cindex "PIPELINING" "avoiding the use of"
24850 Exim will not use the SMTP PIPELINING extension when delivering to any host
24851 that matches this list, even if the server host advertises PIPELINING support.
24852
24853 .option hosts_pipe_connect smtp "host list&!!" unset
24854 .cindex "pipelining" "early connection"
24855 .cindex "pipelining" PIPE_CONNECT
24856 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24857 this option controls which to hosts the facility watched for
24858 and recorded, and used for subsequent connections.
24859
24860 The retry hints database is used for the record,
24861 and records are subject to the &%retry_data_expire%& option.
24862 When used, the pipelining saves on roundtrip times.
24863 It also turns SMTP into a client-first protocol
24864 so combines well with TCP Fast Open.
24865
24866 See also the &%pipelining_connect_advertise_hosts%& main option.
24867
24868 Note:
24869 When the facility is used, the transport &%helo_data%& option
24870 will be expanded before the &$sending_ip_address$& variable
24871 is filled in.
24872 A check is made for the use of that variable, without the
24873 presence of a &"def:"& test on it, but suitably complex coding
24874 can avoid the check and produce unexpected results.
24875 You have been warned.
24876
24877
24878 .option hosts_avoid_tls smtp "host list&!!" unset
24879 .cindex "TLS" "avoiding for certain hosts"
24880 Exim will not try to start a TLS session when delivering to any host that
24881 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24882
24883 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24884 .cindex "TLS" "avoiding for certain hosts"
24885 Exim will not try to start a TLS session for a verify callout,
24886 or when delivering in cutthrough mode,
24887 to any host that matches this list.
24888
24889
24890 .option hosts_max_try smtp integer 5
24891 .cindex "host" "maximum number to try"
24892 .cindex "limit" "number of hosts tried"
24893 .cindex "limit" "number of MX tried"
24894 .cindex "MX record" "maximum tried"
24895 This option limits the number of IP addresses that are tried for any one
24896 delivery in cases where there are temporary delivery errors. Section
24897 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24898
24899
24900 .option hosts_max_try_hardlimit smtp integer 50
24901 This is an additional check on the maximum number of IP addresses that Exim
24902 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24903 why it exists.
24904
24905
24906
24907 .option hosts_nopass_tls smtp "host list&!!" unset
24908 .cindex "TLS" "passing connection"
24909 .cindex "multiple SMTP deliveries"
24910 .cindex "TLS" "multiple message deliveries"
24911 For any host that matches this list, a connection on which a TLS session has
24912 been started will not be passed to a new delivery process for sending another
24913 message on the same connection. See section &<<SECTmulmessam>>& for an
24914 explanation of when this might be needed.
24915
24916 .option hosts_noproxy_tls smtp "host list&!!" unset
24917 .cindex "TLS" "passing connection"
24918 .cindex "multiple SMTP deliveries"
24919 .cindex "TLS" "multiple message deliveries"
24920 For any host that matches this list, a TLS session which has
24921 been started will not be passed to a new delivery process for sending another
24922 message on the same session.
24923
24924 The traditional implementation closes down TLS and re-starts it in the new
24925 process, on the same open TCP connection, for each successive message
24926 sent.  If permitted by this option a pipe to to the new process is set up
24927 instead, and the original process maintains the TLS connection and proxies
24928 the SMTP connection from and to the new process and any subsequents.
24929 The new process has no access to TLS information, so cannot include it in
24930 logging.
24931
24932
24933
24934 .option hosts_override smtp boolean false
24935 If this option is set and the &%hosts%& option is also set, any hosts that are
24936 attached to the address are ignored, and instead the hosts specified by the
24937 &%hosts%& option are always used. This option does not apply to
24938 &%fallback_hosts%&.
24939
24940
24941 .option hosts_randomize smtp boolean false
24942 .cindex "randomized host list"
24943 .cindex "host" "list of; randomized"
24944 .cindex "fallback" "randomized hosts"
24945 If this option is set, and either the list of hosts is taken from the
24946 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24947 were not obtained from MX records (this includes fallback hosts from the
24948 router), and were not randomized by the router, the order of trying the hosts
24949 is randomized each time the transport runs. Randomizing the order of a host
24950 list can be used to do crude load sharing.
24951
24952 When &%hosts_randomize%& is true, a host list may be split into groups whose
24953 order is separately randomized. This makes it possible to set up MX-like
24954 behaviour. The boundaries between groups are indicated by an item that is just
24955 &`+`& in the host list. For example:
24956 .code
24957 hosts = host1:host2:host3:+:host4:host5
24958 .endd
24959 The order of the first three hosts and the order of the last two hosts is
24960 randomized for each use, but the first three always end up before the last two.
24961 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24962
24963 .option hosts_require_auth smtp "host list&!!" unset
24964 .cindex "authentication" "required by client"
24965 This option provides a list of servers for which authentication must succeed
24966 before Exim will try to transfer a message. If authentication fails for
24967 servers which are not in this list, Exim tries to send unauthenticated. If
24968 authentication fails for one of these servers, delivery is deferred. This
24969 temporary error is detectable in the retry rules, so it can be turned into a
24970 hard failure if required. See also &%hosts_try_auth%&, and chapter
24971 &<<CHAPSMTPAUTH>>& for details of authentication.
24972
24973
24974 .option hosts_request_ocsp smtp "host list&!!" *
24975 .cindex "TLS" "requiring for certain servers"
24976 Exim will request a Certificate Status on a
24977 TLS session for any host that matches this list.
24978 &%tls_verify_certificates%& should also be set for the transport.
24979
24980 .option hosts_require_dane smtp "host list&!!" unset
24981 .cindex DANE "transport options"
24982 .cindex DANE "requiring for certain servers"
24983 If built with DANE support, Exim  will require that a DNSSEC-validated
24984 TLSA record is present for any host matching the list,
24985 and that a DANE-verified TLS connection is made. See
24986 the &%dnssec_request_domains%& router and transport options.
24987 There will be no fallback to in-clear communication.
24988 See section &<<SECDANE>>&.
24989
24990 .option hosts_require_ocsp smtp "host list&!!" unset
24991 .cindex "TLS" "requiring for certain servers"
24992 Exim will request, and check for a valid Certificate Status being given, on a
24993 TLS session for any host that matches this list.
24994 &%tls_verify_certificates%& should also be set for the transport.
24995
24996 .option hosts_require_tls smtp "host list&!!" unset
24997 .cindex "TLS" "requiring for certain servers"
24998 Exim will insist on using a TLS session when delivering to any host that
24999 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25000 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25001 incoming messages, use an appropriate ACL.
25002
25003 .option hosts_try_auth smtp "host list&!!" unset
25004 .cindex "authentication" "optional in client"
25005 This option provides a list of servers to which, provided they announce
25006 authentication support, Exim will attempt to authenticate as a client when it
25007 connects. If authentication fails, Exim will try to transfer the message
25008 unauthenticated. See also &%hosts_require_auth%&, and chapter
25009 &<<CHAPSMTPAUTH>>& for details of authentication.
25010
25011 .option hosts_try_chunking smtp "host list&!!" *
25012 .cindex CHUNKING "enabling, in client"
25013 .cindex BDAT "SMTP command"
25014 .cindex "RFC 3030" "CHUNKING"
25015 This option provides a list of servers to which, provided they announce
25016 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25017 .new
25018 Unless DKIM signing is being done,
25019 .wen
25020 BDAT will not be used in conjunction with a transport filter.
25021
25022 .option hosts_try_dane smtp "host list&!!" *
25023 .cindex DANE "transport options"
25024 .cindex DANE "attempting for certain servers"
25025 If built with DANE support, Exim  will require that a DNSSEC-validated
25026 TLSA record is present for any host matching the list,
25027 and that a DANE-verified TLS connection is made. See
25028 the &%dnssec_request_domains%& router and transport options.
25029 There will be no fallback to in-clear communication.
25030 See section &<<SECDANE>>&.
25031
25032 .option hosts_try_fastopen smtp "host list&!!" *
25033 .cindex "fast open, TCP" "enabling, in client"
25034 .cindex "TCP Fast Open" "enabling, in client"
25035 .cindex "RFC 7413" "TCP Fast Open"
25036 This option provides a list of servers to which, provided
25037 the facility is supported by this system, Exim will attempt to
25038 perform a TCP Fast Open.
25039 No data is sent on the SYN segment but, if the remote server also
25040 supports the facility, it can send its SMTP banner immediately after
25041 the SYN,ACK segment.  This can save up to one round-trip time.
25042
25043 The facility is only active for previously-contacted servers,
25044 as the initiator must present a cookie in the SYN segment.
25045
25046 On (at least some) current Linux distributions the facility must be enabled
25047 in the kernel by the sysadmin before the support is usable.
25048 There is no option for control of the server side; if the system supports
25049 it it is always enabled.  Note that lengthy operations in the connect ACL,
25050 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25051
25052 .option hosts_try_prdr smtp "host list&!!" *
25053 .cindex "PRDR" "enabling, optional in client"
25054 This option provides a list of servers to which, provided they announce
25055 PRDR support, Exim will attempt to negotiate PRDR
25056 for multi-recipient messages.
25057 The option can usually be left as default.
25058
25059 .option interface smtp "string list&!!" unset
25060 .cindex "bind IP address"
25061 .cindex "IP address" "binding"
25062 .vindex "&$host$&"
25063 .vindex "&$host_address$&"
25064 This option specifies which interface to bind to when making an outgoing SMTP
25065 call. The value is an IP address, not an interface name such as
25066 &`eth0`&. Do not confuse this with the interface address that was used when a
25067 message was received, which is in &$received_ip_address$&, formerly known as
25068 &$interface_address$&. The name was changed to minimize confusion with the
25069 outgoing interface address. There is no variable that contains an outgoing
25070 interface address because, unless it is set by this option, its value is
25071 unknown.
25072
25073 During the expansion of the &%interface%& option the variables &$host$& and
25074 &$host_address$& refer to the host to which a connection is about to be made
25075 during the expansion of the string. Forced expansion failure, or an empty
25076 string result causes the option to be ignored. Otherwise, after expansion, the
25077 string must be a list of IP addresses, colon-separated by default, but the
25078 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25079 For example:
25080 .code
25081 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25082 .endd
25083 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25084 connection. If none of them are the correct type, the option is ignored. If
25085 &%interface%& is not set, or is ignored, the system's IP functions choose which
25086 interface to use if the host has more than one.
25087
25088
25089 .option keepalive smtp boolean true
25090 .cindex "keepalive" "on outgoing connection"
25091 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25092 connections. When set, it causes the kernel to probe idle connections
25093 periodically, by sending packets with &"old"& sequence numbers. The other end
25094 of the connection should send a acknowledgment if the connection is still okay
25095 or a reset if the connection has been aborted. The reason for doing this is
25096 that it has the beneficial effect of freeing up certain types of connection
25097 that can get stuck when the remote host is disconnected without tidying up the
25098 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25099 unreachable hosts.
25100
25101
25102 .option lmtp_ignore_quota smtp boolean false
25103 .cindex "LMTP" "ignoring quota errors"
25104 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25105 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25106 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25107
25108 .option max_rcpt smtp integer 100
25109 .cindex "RCPT" "maximum number of outgoing"
25110 This option limits the number of RCPT commands that are sent in a single
25111 SMTP message transaction. Each set of addresses is treated independently, and
25112 so can cause parallel connections to the same host if &%remote_max_parallel%&
25113 permits this.
25114
25115
25116 .option multi_domain smtp boolean&!! true
25117 .vindex "&$domain$&"
25118 When this option is set, the &(smtp)& transport can handle a number of
25119 addresses containing a mixture of different domains provided they all resolve
25120 to the same list of hosts. Turning the option off restricts the transport to
25121 handling only one domain at a time. This is useful if you want to use
25122 &$domain$& in an expansion for the transport, because it is set only when there
25123 is a single domain involved in a remote delivery.
25124
25125 It is expanded per-address and can depend on any of
25126 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25127 &$host$&, &$host_address$& and &$host_port$&.
25128
25129 .option port smtp string&!! "see below"
25130 .cindex "port" "sending TCP/IP"
25131 .cindex "TCP/IP" "setting outgoing port"
25132 This option specifies the TCP/IP port on the server to which Exim connects.
25133 &*Note:*& Do not confuse this with the port that was used when a message was
25134 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25135 The name was changed to minimize confusion with the outgoing port. There is no
25136 variable that contains an outgoing port.
25137
25138 If the value of this option begins with a digit it is taken as a port number;
25139 otherwise it is looked up using &[getservbyname()]&. The default value is
25140 normally &"smtp"&,
25141 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25142 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25143 If the expansion fails, or if a port number cannot be found, delivery
25144 is deferred.
25145
25146 Note that at least one Linux distribution has been seen failing
25147 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25148
25149
25150
25151 .option protocol smtp string smtp
25152 .cindex "LMTP" "over TCP/IP"
25153 .cindex "ssmtp protocol" "outbound"
25154 .cindex "TLS" "SSL-on-connect outbound"
25155 .vindex "&$port$&"
25156 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25157 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25158 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25159 deliveries into closed message stores. Exim also has support for running LMTP
25160 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25161
25162 If this option is set to &"smtps"&, the default value for the &%port%& option
25163 changes to &"smtps"&, and the transport initiates TLS immediately after
25164 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25165 The Internet standards bodies used to strongly discourage use of this mode,
25166 but as of RFC 8314 it is perferred over STARTTLS for message submission
25167 (as distinct from MTA-MTA communication).
25168
25169
25170 .option retry_include_ip_address smtp boolean&!! true
25171 Exim normally includes both the host name and the IP address in the key it
25172 constructs for indexing retry data after a temporary delivery failure. This
25173 means that when one of several IP addresses for a host is failing, it gets
25174 tried periodically (controlled by the retry rules), but use of the other IP
25175 addresses is not affected.
25176
25177 However, in some dialup environments hosts are assigned a different IP address
25178 each time they connect. In this situation the use of the IP address as part of
25179 the retry key leads to undesirable behaviour. Setting this option false causes
25180 Exim to use only the host name.
25181 Since it is expanded it can be made to depend on the host or domain.
25182
25183
25184 .option serialize_hosts smtp "host list&!!" unset
25185 .cindex "serializing connections"
25186 .cindex "host" "serializing connections"
25187 Because Exim operates in a distributed manner, if several messages for the same
25188 host arrive at around the same time, more than one simultaneous connection to
25189 the remote host can occur. This is not usually a problem except when there is a
25190 slow link between the hosts. In that situation it may be helpful to restrict
25191 Exim to one connection at a time. This can be done by setting
25192 &%serialize_hosts%& to match the relevant hosts.
25193
25194 .cindex "hints database" "serializing deliveries to a host"
25195 Exim implements serialization by means of a hints database in which a record is
25196 written whenever a process connects to one of the restricted hosts. The record
25197 is deleted when the connection is completed. Obviously there is scope for
25198 records to get left lying around if there is a system or program crash. To
25199 guard against this, Exim ignores any records that are more than six hours old.
25200
25201 If you set up this kind of serialization, you should also arrange to delete the
25202 relevant hints database whenever your system reboots. The names of the files
25203 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25204 may be one or two files, depending on the type of DBM in use. The same files
25205 are used for ETRN serialization.
25206
25207 See also the &%max_parallel%& generic transport option.
25208
25209
25210 .option size_addition smtp integer 1024
25211 .cindex "SMTP" "SIZE"
25212 .cindex "message" "size issue for transport filter"
25213 .cindex "size" "of message"
25214 .cindex "transport" "filter"
25215 .cindex "filter" "transport filter"
25216 If a remote SMTP server indicates that it supports the SIZE option of the
25217 MAIL command, Exim uses this to pass over the message size at the start of
25218 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25219 sends, to allow for headers and other text that may be added during delivery by
25220 configuration options or in a transport filter. It may be necessary to increase
25221 this if a lot of text is added to messages.
25222
25223 Alternatively, if the value of &%size_addition%& is set negative, it disables
25224 the use of the SIZE option altogether.
25225
25226
25227 .option socks_proxy smtp string&!! unset
25228 .cindex proxy SOCKS
25229 This option enables use of SOCKS proxies for connections made by the
25230 transport.  For details see section &<<SECTproxySOCKS>>&.
25231
25232
25233 .option tls_certificate smtp string&!! unset
25234 .cindex "TLS" "client certificate, location of"
25235 .cindex "certificate" "client, location of"
25236 .vindex "&$host$&"
25237 .vindex "&$host_address$&"
25238 The value of this option must be the absolute path to a file which contains the
25239 client's certificate, for possible use when sending a message over an encrypted
25240 connection. The values of &$host$& and &$host_address$& are set to the name and
25241 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25242 details of TLS.
25243
25244 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25245 certificate when sending messages as a client. The global option of the same
25246 name specifies the certificate for Exim as a server; it is not automatically
25247 assumed that the same certificate should be used when Exim is operating as a
25248 client.
25249
25250
25251 .option tls_crl smtp string&!! unset
25252 .cindex "TLS" "client certificate revocation list"
25253 .cindex "certificate" "revocation list for client"
25254 This option specifies a certificate revocation list. The expanded value must
25255 be the name of a file that contains a CRL in PEM format.
25256
25257
25258 .option tls_dh_min_bits smtp integer 1024
25259 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25260 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25261 key agreement is negotiated, the server will provide a large prime number
25262 for use.  This option establishes the minimum acceptable size of that number.
25263 If the parameter offered by the server is too small, then the TLS handshake
25264 will fail.
25265
25266 Only supported when using GnuTLS.
25267
25268
25269 .option tls_privatekey smtp string&!! unset
25270 .cindex "TLS" "client private key, location of"
25271 .vindex "&$host$&"
25272 .vindex "&$host_address$&"
25273 The value of this option must be the absolute path to a file which contains the
25274 client's private key. This is used when sending a message over an encrypted
25275 connection using a client certificate. The values of &$host$& and
25276 &$host_address$& are set to the name and address of the server during the
25277 expansion. If this option is unset, or the expansion is forced to fail, or the
25278 result is an empty string, the private key is assumed to be in the same file as
25279 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25280
25281
25282 .option tls_require_ciphers smtp string&!! unset
25283 .cindex "TLS" "requiring specific ciphers"
25284 .cindex "cipher" "requiring specific"
25285 .vindex "&$host$&"
25286 .vindex "&$host_address$&"
25287 The value of this option must be a list of permitted cipher suites, for use
25288 when setting up an outgoing encrypted connection. (There is a global option of
25289 the same name for controlling incoming connections.) The values of &$host$& and
25290 &$host_address$& are set to the name and address of the server during the
25291 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25292 is used in different ways by OpenSSL and GnuTLS (see sections
25293 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25294 ciphers is a preference order.
25295
25296
25297
25298 .option tls_sni smtp string&!! unset
25299 .cindex "TLS" "Server Name Indication"
25300 .vindex "&$tls_sni$&"
25301 If this option is set then it sets the $tls_out_sni variable and causes any
25302 TLS session to pass this value as the Server Name Indication extension to
25303 the remote side, which can be used by the remote side to select an appropriate
25304 certificate and private key for the session.
25305
25306 See &<<SECTtlssni>>& for more information.
25307
25308 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25309 TLS extensions.
25310
25311
25312
25313
25314 .option tls_tempfail_tryclear smtp boolean true
25315 .cindex "4&'xx'& responses" "to STARTTLS"
25316 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25317 setting up a TLS session, this option determines whether or not Exim should try
25318 to deliver the message unencrypted. If it is set false, delivery to the
25319 current host is deferred; if there are other hosts, they are tried. If this
25320 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25321 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25322 TLS negotiation fails, Exim closes the current connection (because it is in an
25323 unknown state), opens a new one to the same host, and then tries the delivery
25324 in clear.
25325
25326
25327 .option tls_try_verify_hosts smtp "host list&!!" *
25328 .cindex "TLS" "server certificate verification"
25329 .cindex "certificate" "verification of server"
25330 This option gives a list of hosts for which, on encrypted connections,
25331 certificate verification will be tried but need not succeed.
25332 The &%tls_verify_certificates%& option must also be set.
25333 Note that unless the host is in this list
25334 TLS connections will be denied to hosts using self-signed certificates
25335 when &%tls_verify_certificates%& is matched.
25336 The &$tls_out_certificate_verified$& variable is set when
25337 certificate verification succeeds.
25338
25339
25340 .option tls_verify_cert_hostnames smtp "host list&!!" *
25341 .cindex "TLS" "server certificate hostname verification"
25342 .cindex "certificate" "verification of server"
25343 This option give a list of hosts for which,
25344 while verifying the server certificate,
25345 checks will be included on the host name
25346 (note that this will generally be the result of a DNS MX lookup)
25347 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25348 limited to being the initial component of a 3-or-more component FQDN.
25349
25350 There is no equivalent checking on client certificates.
25351
25352
25353 .option tls_verify_certificates smtp string&!! system
25354 .cindex "TLS" "server certificate verification"
25355 .cindex "certificate" "verification of server"
25356 .vindex "&$host$&"
25357 .vindex "&$host_address$&"
25358 The value of this option must be either the
25359 word "system"
25360 or the absolute path to
25361 a file or directory containing permitted certificates for servers,
25362 for use when setting up an encrypted connection.
25363
25364 The "system" value for the option will use a location compiled into the SSL library.
25365 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25366 is taken as empty and an explicit location
25367 must be specified.
25368
25369 The use of a directory for the option value is not available for GnuTLS versions
25370 preceding 3.3.6 and a single file must be used.
25371
25372 With OpenSSL the certificates specified
25373 explicitly
25374 either by file or directory
25375 are added to those given by the system default location.
25376
25377 The values of &$host$& and
25378 &$host_address$& are set to the name and address of the server during the
25379 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25380
25381 For back-compatibility,
25382 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25383 (a single-colon empty list counts as being set)
25384 and certificate verification fails the TLS connection is closed.
25385
25386
25387 .option tls_verify_hosts smtp "host list&!!" unset
25388 .cindex "TLS" "server certificate verification"
25389 .cindex "certificate" "verification of server"
25390 This option gives a list of hosts for which, on encrypted connections,
25391 certificate verification must succeed.
25392 The &%tls_verify_certificates%& option must also be set.
25393 If both this option and &%tls_try_verify_hosts%& are unset
25394 operation is as if this option selected all hosts.
25395
25396 .option utf8_downconvert smtp integer!! unset
25397 .cindex utf8 "address downconversion"
25398 .cindex i18n "utf8 address downconversion"
25399 If built with internationalization support,
25400 this option controls conversion of UTF-8 in message addresses
25401 to a-label form.
25402 For details see section &<<SECTi18nMTA>>&.
25403
25404
25405
25406
25407 .section "How the limits for the number of hosts to try are used" &&&
25408          "SECTvalhosmax"
25409 .cindex "host" "maximum number to try"
25410 .cindex "limit" "hosts; maximum number tried"
25411 There are two options that are concerned with the number of hosts that are
25412 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25413 &%hosts_max_try_hardlimit%&.
25414
25415
25416 The &%hosts_max_try%& option limits the number of hosts that are tried
25417 for a single delivery. However, despite the term &"host"& in its name, the
25418 option actually applies to each IP address independently. In other words, a
25419 multihomed host is treated as several independent hosts, just as it is for
25420 retrying.
25421
25422 Many of the larger ISPs have multiple MX records which often point to
25423 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25424 created as a result of routing one of these domains.
25425
25426 Trying every single IP address on such a long list does not seem sensible; if
25427 several at the top of the list fail, it is reasonable to assume there is some
25428 problem that is likely to affect all of them. Roughly speaking, the value of
25429 &%hosts_max_try%& is the maximum number that are tried before deferring the
25430 delivery. However, the logic cannot be quite that simple.
25431
25432 Firstly, IP addresses that are skipped because their retry times have not
25433 arrived do not count, and in addition, addresses that are past their retry
25434 limits are also not counted, even when they are tried. This means that when
25435 some IP addresses are past their retry limits, more than the value of
25436 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25437 that all IP addresses are considered before timing out an email address (but
25438 see below for an exception).
25439
25440 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25441 list to see if there is a subsequent host with a different (higher valued) MX.
25442 If there is, that host is considered next, and the current IP address is used
25443 but not counted. This behaviour helps in the case of a domain with a retry rule
25444 that hardly ever delays any hosts, as is now explained:
25445
25446 Consider the case of a long list of hosts with one MX value, and a few with a
25447 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25448 hosts at the top of the list are tried at first. With the default retry rule,
25449 which specifies increasing retry times, the higher MX hosts are eventually
25450 tried when those at the top of the list are skipped because they have not
25451 reached their retry times.
25452
25453 However, it is common practice to put a fixed short retry time on domains for
25454 large ISPs, on the grounds that their servers are rarely down for very long.
25455 Unfortunately, these are exactly the domains that tend to resolve to long lists
25456 of hosts. The short retry time means that the lowest MX hosts are tried every
25457 time. The attempts may be in a different order because of random sorting, but
25458 without the special MX check, the higher MX hosts would never be tried until
25459 all the lower MX hosts had timed out (which might be several days), because
25460 there are always some lower MX hosts that have reached their retry times. With
25461 the special check, Exim considers at least one IP address from each MX value at
25462 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25463 reached.
25464
25465 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25466 particular, Exim normally eventually tries all the IP addresses before timing
25467 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25468 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25469 been set up with hundreds of IP addresses for some domains. It can
25470 take a very long time indeed for an address to time out in these cases.
25471
25472 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25473 Exim never tries more than this number of IP addresses; if it hits this limit
25474 and they are all timed out, the email address is bounced, even though not all
25475 possible IP addresses have been tried.
25476 .ecindex IIDsmttra1
25477 .ecindex IIDsmttra2
25478
25479
25480
25481
25482
25483 . ////////////////////////////////////////////////////////////////////////////
25484 . ////////////////////////////////////////////////////////////////////////////
25485
25486 .chapter "Address rewriting" "CHAPrewrite"
25487 .scindex IIDaddrew "rewriting" "addresses"
25488 There are some circumstances in which Exim automatically rewrites domains in
25489 addresses. The two most common are when an address is given without a domain
25490 (referred to as an &"unqualified address"&) or when an address contains an
25491 abbreviated domain that is expanded by DNS lookup.
25492
25493 Unqualified envelope addresses are accepted only for locally submitted
25494 messages, or for messages that are received from hosts matching
25495 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25496 appropriate. Unqualified addresses in header lines are qualified if they are in
25497 locally submitted messages, or messages from hosts that are permitted to send
25498 unqualified envelope addresses. Otherwise, unqualified addresses in header
25499 lines are neither qualified nor rewritten.
25500
25501 One situation in which Exim does &'not'& automatically rewrite a domain is
25502 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25503 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25504 do this. The new RFCs do not contain this suggestion.
25505
25506
25507 .section "Explicitly configured address rewriting" "SECID147"
25508 This chapter describes the rewriting rules that can be used in the
25509 main rewrite section of the configuration file, and also in the generic
25510 &%headers_rewrite%& option that can be set on any transport.
25511
25512 Some people believe that configured address rewriting is a Mortal Sin.
25513 Others believe that life is not possible without it. Exim provides the
25514 facility; you do not have to use it.
25515
25516 The main rewriting rules that appear in the &"rewrite"& section of the
25517 configuration file are applied to addresses in incoming messages, both envelope
25518 addresses and addresses in header lines. Each rule specifies the types of
25519 address to which it applies.
25520
25521 Whether or not addresses in header lines are rewritten depends on the origin of
25522 the headers and the type of rewriting. Global rewriting, that is, rewriting
25523 rules from the rewrite section of the configuration file, is applied only to
25524 those headers that were received with the message. Header lines that are added
25525 by ACLs or by a system filter or by individual routers or transports (which
25526 are specific to individual recipient addresses) are not rewritten by the global
25527 rules.
25528
25529 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25530 applies all headers except those added by routers and transports. That is, as
25531 well as the headers that were received with the message, it also applies to
25532 headers that were added by an ACL or a system filter.
25533
25534
25535 In general, rewriting addresses from your own system or domain has some
25536 legitimacy. Rewriting other addresses should be done only with great care and
25537 in special circumstances. The author of Exim believes that rewriting should be
25538 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25539 Although it can sometimes be used as a routing tool, this is very strongly
25540 discouraged.
25541
25542 There are two commonly encountered circumstances where rewriting is used, as
25543 illustrated by these examples:
25544
25545 .ilist
25546 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25547 exchange mail with each other behind a firewall, but there is only a single
25548 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25549 &'hitch.fict.example'& when sending mail off-site.
25550 .next
25551 A host rewrites the local parts of its own users so that, for example,
25552 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25553 .endlist
25554
25555
25556
25557 .section "When does rewriting happen?" "SECID148"
25558 .cindex "rewriting" "timing of"
25559 .cindex "&ACL;" "rewriting addresses in"
25560 Configured address rewriting can take place at several different stages of a
25561 message's processing.
25562
25563 .vindex "&$sender_address$&"
25564 At the start of an ACL for MAIL, the sender address may have been rewritten
25565 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25566 ordinary rewrite rules have yet been applied. If, however, the sender address
25567 is verified in the ACL, it is rewritten before verification, and remains
25568 rewritten thereafter. The subsequent value of &$sender_address$& is the
25569 rewritten address. This also applies if sender verification happens in a
25570 RCPT ACL. Otherwise, when the sender address is not verified, it is
25571 rewritten as soon as a message's header lines have been received.
25572
25573 .vindex "&$domain$&"
25574 .vindex "&$local_part$&"
25575 Similarly, at the start of an ACL for RCPT, the current recipient's address
25576 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25577 rewrite rules have yet been applied to it. However, the behaviour is different
25578 from the sender address when a recipient is verified. The address is rewritten
25579 for the verification, but the rewriting is not remembered at this stage. The
25580 value of &$local_part$& and &$domain$& after verification are always the same
25581 as they were before (that is, they contain the unrewritten &-- except for
25582 SMTP-time rewriting &-- address).
25583
25584 As soon as a message's header lines have been received, all the envelope
25585 recipient addresses are permanently rewritten, and rewriting is also applied to
25586 the addresses in the header lines (if configured). This happens before adding
25587 any header lines that were specified in MAIL or RCPT ACLs, and
25588 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25589 before the DATA ACL and &[local_scan()]& functions are run.
25590
25591 When an address is being routed, either for delivery or for verification,
25592 rewriting is applied immediately to child addresses that are generated by
25593 redirection, unless &%no_rewrite%& is set on the router.
25594
25595 .cindex "envelope from"
25596 .cindex "envelope sender" "rewriting at transport time"
25597 .cindex "rewriting" "at transport time"
25598 .cindex "header lines" "rewriting at transport time"
25599 At transport time, additional rewriting of addresses in header lines can be
25600 specified by setting the generic &%headers_rewrite%& option on a transport.
25601 This option contains rules that are identical in form to those in the rewrite
25602 section of the configuration file. They are applied to the original message
25603 header lines and any that were added by ACLs or a system filter. They are not
25604 applied to header lines that are added by routers or the transport.
25605
25606 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25607 transport option. However, it is not possible to rewrite envelope recipients at
25608 transport time.
25609
25610
25611
25612
25613 .section "Testing the rewriting rules that apply on input" "SECID149"
25614 .cindex "rewriting" "testing"
25615 .cindex "testing" "rewriting"
25616 Exim's input rewriting configuration appears in a part of the runtime
25617 configuration file headed by &"begin rewrite"&. It can be tested by the
25618 &%-brw%& command line option. This takes an address (which can be a full RFC
25619 2822 address) as its argument. The output is a list of how the address would be
25620 transformed by the rewriting rules for each of the different places it might
25621 appear in an incoming message, that is, for each different header and for the
25622 envelope sender and recipient fields. For example,
25623 .code
25624 exim -brw ph10@exim.workshop.example
25625 .endd
25626 might produce the output
25627 .code
25628 sender: Philip.Hazel@exim.workshop.example
25629 from: Philip.Hazel@exim.workshop.example
25630 to: ph10@exim.workshop.example
25631 cc: ph10@exim.workshop.example
25632 bcc: ph10@exim.workshop.example
25633 reply-to: Philip.Hazel@exim.workshop.example
25634 env-from: Philip.Hazel@exim.workshop.example
25635 env-to: ph10@exim.workshop.example
25636 .endd
25637 which shows that rewriting has been set up for that address when used in any of
25638 the source fields, but not when it appears as a recipient address. At the
25639 present time, there is no equivalent way of testing rewriting rules that are
25640 set for a particular transport.
25641
25642
25643 .section "Rewriting rules" "SECID150"
25644 .cindex "rewriting" "rules"
25645 The rewrite section of the configuration file consists of lines of rewriting
25646 rules in the form
25647 .display
25648 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25649 .endd
25650 Rewriting rules that are specified for the &%headers_rewrite%& generic
25651 transport option are given as a colon-separated list. Each item in the list
25652 takes the same form as a line in the main rewriting configuration (except that
25653 any colons must be doubled, of course).
25654
25655 The formats of source patterns and replacement strings are described below.
25656 Each is terminated by white space, unless enclosed in double quotes, in which
25657 case normal quoting conventions apply inside the quotes. The flags are single
25658 characters which may appear in any order. Spaces and tabs between them are
25659 ignored.
25660
25661 For each address that could potentially be rewritten, the rules are scanned in
25662 order, and replacements for the address from earlier rules can themselves be
25663 replaced by later rules (but see the &"q"& and &"R"& flags).
25664
25665 The order in which addresses are rewritten is undefined, may change between
25666 releases, and must not be relied on, with one exception: when a message is
25667 received, the envelope sender is always rewritten first, before any header
25668 lines are rewritten. For example, the replacement string for a rewrite of an
25669 address in &'To:'& must not assume that the message's address in &'From:'& has
25670 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25671 that the envelope sender has already been rewritten.
25672
25673 .vindex "&$domain$&"
25674 .vindex "&$local_part$&"
25675 The variables &$local_part$& and &$domain$& can be used in the replacement
25676 string to refer to the address that is being rewritten. Note that lookup-driven
25677 rewriting can be done by a rule of the form
25678 .code
25679 *@*   ${lookup ...
25680 .endd
25681 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25682 refer to the address that is being rewritten.
25683
25684
25685 .section "Rewriting patterns" "SECID151"
25686 .cindex "rewriting" "patterns"
25687 .cindex "address list" "in a rewriting pattern"
25688 The source pattern in a rewriting rule is any item which may appear in an
25689 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25690 single-item address list, which means that it is expanded before being tested
25691 against the address. As always, if you use a regular expression as a pattern,
25692 you must take care to escape dollar and backslash characters, or use the &`\N`&
25693 facility to suppress string expansion within the regular expression.
25694
25695 Domains in patterns should be given in lower case. Local parts in patterns are
25696 case-sensitive. If you want to do case-insensitive matching of local parts, you
25697 can use a regular expression that starts with &`^(?i)`&.
25698
25699 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25700 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25701 depending on the type of match which occurred. These can be used in the
25702 replacement string to insert portions of the incoming address. &$0$& always
25703 refers to the complete incoming address. When a regular expression is used, the
25704 numerical variables are set from its capturing subexpressions. For other types
25705 of pattern they are set as follows:
25706
25707 .ilist
25708 If a local part or domain starts with an asterisk, the numerical variables
25709 refer to the character strings matched by asterisks, with &$1$& associated with
25710 the first asterisk, and &$2$& with the second, if present. For example, if the
25711 pattern
25712 .code
25713 *queen@*.fict.example
25714 .endd
25715 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25716 .code
25717 $0 = hearts-queen@wonderland.fict.example
25718 $1 = hearts-
25719 $2 = wonderland
25720 .endd
25721 Note that if the local part does not start with an asterisk, but the domain
25722 does, it is &$1$& that contains the wild part of the domain.
25723
25724 .next
25725 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25726 of the domain are placed in the next available numerical variables. Suppose,
25727 for example, that the address &'foo@bar.baz.example'& is processed by a
25728 rewriting rule of the form
25729 .display
25730 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25731 .endd
25732 and the key in the file that matches the domain is &`*.baz.example`&. Then
25733 .code
25734 $1 = foo
25735 $2 = bar
25736 $3 = baz.example
25737 .endd
25738 If the address &'foo@baz.example'& is looked up, this matches the same
25739 wildcard file entry, and in this case &$2$& is set to the empty string, but
25740 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25741 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25742 whole domain. For non-partial domain lookups, no numerical variables are set.
25743 .endlist
25744
25745
25746 .section "Rewriting replacements" "SECID152"
25747 .cindex "rewriting" "replacements"
25748 If the replacement string for a rule is a single asterisk, addresses that
25749 match the pattern and the flags are &'not'& rewritten, and no subsequent
25750 rewriting rules are scanned. For example,
25751 .code
25752 hatta@lookingglass.fict.example  *  f
25753 .endd
25754 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25755 &'From:'& headers.
25756
25757 .vindex "&$domain$&"
25758 .vindex "&$local_part$&"
25759 If the replacement string is not a single asterisk, it is expanded, and must
25760 yield a fully qualified address. Within the expansion, the variables
25761 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25762 Any letters they contain retain their original case &-- they are not lower
25763 cased. The numerical variables are set up according to the type of pattern that
25764 matched the address, as described above. If the expansion is forced to fail by
25765 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25766 current rule is abandoned, but subsequent rules may take effect. Any other
25767 expansion failure causes the entire rewriting operation to be abandoned, and an
25768 entry written to the panic log.
25769
25770
25771
25772 .section "Rewriting flags" "SECID153"
25773 There are three different kinds of flag that may appear on rewriting rules:
25774
25775 .ilist
25776 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25777 c, f, h, r, s, t.
25778 .next
25779 A flag that specifies rewriting at SMTP time: S.
25780 .next
25781 Flags that control the rewriting process: Q, q, R, w.
25782 .endlist
25783
25784 For rules that are part of the &%headers_rewrite%& generic transport option,
25785 E, F, T, and S are not permitted.
25786
25787
25788
25789 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25790          "SECID154"
25791 .cindex "rewriting" "flags"
25792 If none of the following flag letters, nor the &"S"& flag (see section
25793 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25794 and to both the sender and recipient fields of the envelope, whereas a
25795 transport-time rewriting rule just applies to all headers. Otherwise, the
25796 rewriting rule is skipped unless the relevant addresses are being processed.
25797 .display
25798 &`E`&       rewrite all envelope fields
25799 &`F`&       rewrite the envelope From field
25800 &`T`&       rewrite the envelope To field
25801 &`b`&       rewrite the &'Bcc:'& header
25802 &`c`&       rewrite the &'Cc:'& header
25803 &`f`&       rewrite the &'From:'& header
25804 &`h`&       rewrite all headers
25805 &`r`&       rewrite the &'Reply-To:'& header
25806 &`s`&       rewrite the &'Sender:'& header
25807 &`t`&       rewrite the &'To:'& header
25808 .endd
25809 "All headers" means all of the headers listed above that can be selected
25810 individually, plus their &'Resent-'& versions. It does not include
25811 other headers such as &'Subject:'& etc.
25812
25813 You should be particularly careful about rewriting &'Sender:'& headers, and
25814 restrict this to special known cases in your own domains.
25815
25816
25817 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25818 .cindex "SMTP" "rewriting malformed addresses"
25819 .cindex "RCPT" "rewriting argument of"
25820 .cindex "MAIL" "rewriting argument of"
25821 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25822 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25823 before any other processing; even before syntax checking. The pattern is
25824 required to be a regular expression, and it is matched against the whole of the
25825 data for the command, including any surrounding angle brackets.
25826
25827 .vindex "&$domain$&"
25828 .vindex "&$local_part$&"
25829 This form of rewrite rule allows for the handling of addresses that are not
25830 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25831 input). Because the input is not required to be a syntactically valid address,
25832 the variables &$local_part$& and &$domain$& are not available during the
25833 expansion of the replacement string. The result of rewriting replaces the
25834 original address in the MAIL or RCPT command.
25835
25836
25837 .section "Flags controlling the rewriting process" "SECID155"
25838 There are four flags which control the way the rewriting process works. These
25839 take effect only when a rule is invoked, that is, when the address is of the
25840 correct type (matches the flags) and matches the pattern:
25841
25842 .ilist
25843 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25844 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25845 absence of &"Q"& the rewritten address must always include a domain.
25846 .next
25847 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25848 even if no rewriting actually takes place because of a &"fail"& in the
25849 expansion. The &"q"& flag is not effective if the address is of the wrong type
25850 (does not match the flags) or does not match the pattern.
25851 .next
25852 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25853 address, up to ten times. It can be combined with the &"q"& flag, to stop
25854 rewriting once it fails to match (after at least one successful rewrite).
25855 .next
25856 .cindex "rewriting" "whole addresses"
25857 When an address in a header is rewritten, the rewriting normally applies only
25858 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25859 left unchanged. For example, rewriting might change
25860 .code
25861 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25862 .endd
25863 into
25864 .code
25865 From: Ford Prefect <prefectf@hitch.fict.example>
25866 .endd
25867 .cindex "RFC 2047"
25868 Sometimes there is a need to replace the whole address item, and this can be
25869 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25870 causes an address in a header line to be rewritten, the entire address is
25871 replaced, not just the working part. The replacement must be a complete RFC
25872 2822 address, including the angle brackets if necessary. If text outside angle
25873 brackets contains a character whose value is greater than 126 or less than 32
25874 (except for tab), the text is encoded according to RFC 2047. The character set
25875 is taken from &%headers_charset%&, which gets its default at build time.
25876
25877 When the &"w"& flag is set on a rule that causes an envelope address to be
25878 rewritten, all but the working part of the replacement address is discarded.
25879 .endlist
25880
25881
25882 .section "Rewriting examples" "SECID156"
25883 Here is an example of the two common rewriting paradigms:
25884 .code
25885 *@*.hitch.fict.example  $1@hitch.fict.example
25886 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25887                      {$value}fail}@hitch.fict.example bctfrF
25888 .endd
25889 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25890 the string expansion to fail if the lookup does not succeed. In this context it
25891 has the effect of leaving the original address unchanged, but Exim goes on to
25892 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25893 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25894 explicitly, which would cause the rewritten address to be the same as before,
25895 at the cost of a small bit of processing. Not supplying either of these is an
25896 error, since the rewritten address would then contain no local part.
25897
25898 The first example above replaces the domain with a superior, more general
25899 domain. This may not be desirable for certain local parts. If the rule
25900 .code
25901 root@*.hitch.fict.example  *
25902 .endd
25903 were inserted before the first rule, rewriting would be suppressed for the
25904 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25905
25906 Rewriting can be made conditional on a number of tests, by making use of
25907 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25908 messages that originate outside the local host:
25909 .code
25910 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25911                          {$1@hitch.fict.example}fail}"
25912 .endd
25913 The replacement string is quoted in this example because it contains white
25914 space.
25915
25916 .cindex "rewriting" "bang paths"
25917 .cindex "bang paths" "rewriting"
25918 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25919 an address it treats it as an unqualified local part which it qualifies with
25920 the local qualification domain (if the source of the message is local or if the
25921 remote host is permitted to send unqualified addresses). Rewriting can
25922 sometimes be used to handle simple bang paths with a fixed number of
25923 components. For example, the rule
25924 .code
25925 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25926 .endd
25927 rewrites a two-component bang path &'host.name!user'& as the domain address
25928 &'user@host.name'&. However, there is a security implication in using this as
25929 a global rewriting rule for envelope addresses. It can provide a backdoor
25930 method for using your system as a relay, because the incoming addresses appear
25931 to be local. If the bang path addresses are received via SMTP, it is safer to
25932 use the &"S"& flag to rewrite them as they are received, so that relay checking
25933 can be done on the rewritten addresses.
25934 .ecindex IIDaddrew
25935
25936
25937
25938
25939
25940 . ////////////////////////////////////////////////////////////////////////////
25941 . ////////////////////////////////////////////////////////////////////////////
25942
25943 .chapter "Retry configuration" "CHAPretry"
25944 .scindex IIDretconf1 "retry" "configuration, description of"
25945 .scindex IIDregconf2 "configuration file" "retry section"
25946 The &"retry"& section of the runtime configuration file contains a list of
25947 retry rules that control how often Exim tries to deliver messages that cannot
25948 be delivered at the first attempt. If there are no retry rules (the section is
25949 empty or not present), there are no retries. In this situation, temporary
25950 errors are treated as permanent. The default configuration contains a single,
25951 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25952 line option can be used to test which retry rule will be used for a given
25953 address, domain and error.
25954
25955 The most common cause of retries is temporary failure to deliver to a remote
25956 host because the host is down, or inaccessible because of a network problem.
25957 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25958 address) basis, not on a per-message basis. Thus, if one message has recently
25959 been delayed, delivery of a new message to the same host is not immediately
25960 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25961 log selector is set, the message
25962 .cindex "retry" "time not reached"
25963 &"retry time not reached"& is written to the main log whenever a delivery is
25964 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25965 the handling of errors during remote deliveries.
25966
25967 Retry processing applies to routing as well as to delivering, except as covered
25968 in the next paragraph. The retry rules do not distinguish between these
25969 actions. It is not possible, for example, to specify different behaviour for
25970 failures to route the domain &'snark.fict.example'& and failures to deliver to
25971 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25972 added complication, so did not implement it. However, although they share the
25973 same retry rule, the actual retry times for routing and transporting a given
25974 domain are maintained independently.
25975
25976 When a delivery is not part of a queue run (typically an immediate delivery on
25977 receipt of a message), the routers are always run, and local deliveries are
25978 always attempted, even if retry times are set for them. This makes for better
25979 behaviour if one particular message is causing problems (for example, causing
25980 quota overflow, or provoking an error in a filter file). If such a delivery
25981 suffers a temporary failure, the retry data is updated as normal, and
25982 subsequent delivery attempts from queue runs occur only when the retry time for
25983 the local address is reached.
25984
25985 .section "Changing retry rules" "SECID157"
25986 If you change the retry rules in your configuration, you should consider
25987 whether or not to delete the retry data that is stored in Exim's spool area in
25988 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25989 always safe; that is why they are called &"hints"&.
25990
25991 The hints retry data contains suggested retry times based on the previous
25992 rules. In the case of a long-running problem with a remote host, it might
25993 record the fact that the host has timed out. If your new rules increase the
25994 timeout time for such a host, you should definitely remove the old retry data
25995 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25996 messages that it should now be retaining.
25997
25998
25999
26000 .section "Format of retry rules" "SECID158"
26001 .cindex "retry" "rules"
26002 Each retry rule occupies one line and consists of three or four parts,
26003 separated by white space: a pattern, an error name, an optional list of sender
26004 addresses, and a list of retry parameters. The pattern and sender lists must be
26005 enclosed in double quotes if they contain white space. The rules are searched
26006 in order until one is found where the pattern, error name, and sender list (if
26007 present) match the failing host or address, the error that occurred, and the
26008 message's sender, respectively.
26009
26010
26011 The pattern is any single item that may appear in an address list (see section
26012 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26013 which means that it is expanded before being tested against the address that
26014 has been delayed. A negated address list item is permitted. Address
26015 list processing treats a plain domain name as if it were preceded by &"*@"&,
26016 which makes it possible for many retry rules to start with just a domain. For
26017 example,
26018 .code
26019 lookingglass.fict.example        *  F,24h,30m;
26020 .endd
26021 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26022 whereas
26023 .code
26024 alice@lookingglass.fict.example  *  F,24h,30m;
26025 .endd
26026 applies only to temporary failures involving the local part &%alice%&.
26027 In practice, almost all rules start with a domain name pattern without a local
26028 part.
26029
26030 .cindex "regular expressions" "in retry rules"
26031 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26032 must match a complete address, not just a domain, because that is how regular
26033 expressions work in address lists.
26034 .display
26035 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26036 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26037 .endd
26038
26039
26040 .section "Choosing which retry rule to use for address errors" "SECID159"
26041 When Exim is looking for a retry rule after a routing attempt has failed (for
26042 example, after a DNS timeout), each line in the retry configuration is tested
26043 against the complete address only if &%retry_use_local_part%& is set for the
26044 router. Otherwise, only the domain is used, except when matching against a
26045 regular expression, when the local part of the address is replaced with &"*"&.
26046 A domain on its own can match a domain pattern, or a pattern that starts with
26047 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26048 &%check_local_user%& is true, and false for other routers.
26049
26050 Similarly, when Exim is looking for a retry rule after a local delivery has
26051 failed (for example, after a mailbox full error), each line in the retry
26052 configuration is tested against the complete address only if
26053 &%retry_use_local_part%& is set for the transport (it defaults true for all
26054 local transports).
26055
26056 .cindex "4&'xx'& responses" "retry rules for"
26057 However, when Exim is looking for a retry rule after a remote delivery attempt
26058 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26059 whole address is always used as the key when searching the retry rules. The
26060 rule that is found is used to create a retry time for the combination of the
26061 failing address and the message's sender. It is the combination of sender and
26062 recipient that is delayed in subsequent queue runs until its retry time is
26063 reached. You can delay the recipient without regard to the sender by setting
26064 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26065 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26066 commands.
26067
26068
26069
26070 .section "Choosing which retry rule to use for host and message errors" &&&
26071          "SECID160"
26072 For a temporary error that is not related to an individual address (for
26073 example, a connection timeout), each line in the retry configuration is checked
26074 twice. First, the name of the remote host is used as a domain name (preceded by
26075 &"*@"& when matching a regular expression). If this does not match the line,
26076 the domain from the email address is tried in a similar fashion. For example,
26077 suppose the MX records for &'a.b.c.example'& are
26078 .code
26079 a.b.c.example  MX  5  x.y.z.example
26080                MX  6  p.q.r.example
26081                MX  7  m.n.o.example
26082 .endd
26083 and the retry rules are
26084 .code
26085 p.q.r.example    *      F,24h,30m;
26086 a.b.c.example    *      F,4d,45m;
26087 .endd
26088 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26089 first rule matches neither the host nor the domain, so Exim looks at the second
26090 rule. This does not match the host, but it does match the domain, so it is used
26091 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26092 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26093 first retry rule is used, because it matches the host.
26094
26095 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26096 first rule to determine retry times, but for all the other hosts for the domain
26097 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26098 routing to &'a.b.c.example'& suffers a temporary failure.
26099
26100 &*Note*&: The host name is used when matching the patterns, not its IP address.
26101 However, if a message is routed directly to an IP address without the use of a
26102 host name, for example, if a &(manualroute)& router contains a setting such as:
26103 .code
26104 route_list = *.a.example  192.168.34.23
26105 .endd
26106 then the &"host name"& that is used when searching for a retry rule is the
26107 textual form of the IP address.
26108
26109 .section "Retry rules for specific errors" "SECID161"
26110 .cindex "retry" "specific errors; specifying"
26111 The second field in a retry rule is the name of a particular error, or an
26112 asterisk, which matches any error. The errors that can be tested for are:
26113
26114 .vlist
26115 .vitem &%auth_failed%&
26116 Authentication failed when trying to send to a host in the
26117 &%hosts_require_auth%& list in an &(smtp)& transport.
26118
26119 .vitem &%data_4xx%&
26120 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26121 after the command, or after sending the message's data.
26122
26123 .vitem &%mail_4xx%&
26124 A 4&'xx'& error was received for an outgoing MAIL command.
26125
26126 .vitem &%rcpt_4xx%&
26127 A 4&'xx'& error was received for an outgoing RCPT command.
26128 .endlist
26129
26130 For the three 4&'xx'& errors, either the first or both of the x's can be given
26131 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26132 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26133 and have retries every ten minutes with a one-hour timeout, you could set up a
26134 retry rule of this form:
26135 .code
26136 the.domain.name  rcpt_452   F,1h,10m
26137 .endd
26138 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26139 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26140
26141 .vlist
26142 .vitem &%lost_connection%&
26143 A server unexpectedly closed the SMTP connection. There may, of course,
26144 legitimate reasons for this (host died, network died), but if it repeats a lot
26145 for the same host, it indicates something odd.
26146
26147 .vitem &%lookup%&
26148 A DNS lookup for a host failed.
26149 Note that a &%dnslookup%& router will need to have matched
26150 its &%fail_defer_domains%& option for this retry type to be usable.
26151 Also note that a &%manualroute%& router will probably need
26152 its &%host_find_failed%& option set to &%defer%&.
26153
26154 .vitem &%refused_MX%&
26155 A connection to a host obtained from an MX record was refused.
26156
26157 .vitem &%refused_A%&
26158 A connection to a host not obtained from an MX record was refused.
26159
26160 .vitem &%refused%&
26161 A connection was refused.
26162
26163 .vitem &%timeout_connect_MX%&
26164 A connection attempt to a host obtained from an MX record timed out.
26165
26166 .vitem &%timeout_connect_A%&
26167 A connection attempt to a host not obtained from an MX record timed out.
26168
26169 .vitem &%timeout_connect%&
26170 A connection attempt timed out.
26171
26172 .vitem &%timeout_MX%&
26173 There was a timeout while connecting or during an SMTP session with a host
26174 obtained from an MX record.
26175
26176 .vitem &%timeout_A%&
26177 There was a timeout while connecting or during an SMTP session with a host not
26178 obtained from an MX record.
26179
26180 .vitem &%timeout%&
26181 There was a timeout while connecting or during an SMTP session.
26182
26183 .vitem &%tls_required%&
26184 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26185 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26186 to STARTTLS, or there was a problem setting up the TLS connection.
26187
26188 .vitem &%quota%&
26189 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26190 transport.
26191
26192 .vitem &%quota_%&<&'time'&>
26193 .cindex "quota" "error testing in retry rule"
26194 .cindex "retry" "quota error testing"
26195 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26196 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26197 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26198 for four days.
26199 .endlist
26200
26201 .cindex "mailbox" "time of last read"
26202 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26203 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26204 it should be based on the last time that the user accessed the mailbox.
26205 However, it is not always possible to determine this. Exim uses the following
26206 heuristic rules:
26207
26208 .ilist
26209 If the mailbox is a single file, the time of last access (the &"atime"&) is
26210 used. As no new messages are being delivered (because the mailbox is over
26211 quota), Exim does not access the file, so this is the time of last user access.
26212 .next
26213 .cindex "maildir format" "time of last read"
26214 For a maildir delivery, the time of last modification of the &_new_&
26215 subdirectory is used. As the mailbox is over quota, no new files are created in
26216 the &_new_& subdirectory, because no new messages are being delivered. Any
26217 change to the &_new_& subdirectory is therefore assumed to be the result of an
26218 MUA moving a new message to the &_cur_& directory when it is first read. The
26219 time that is used is therefore the last time that the user read a new message.
26220 .next
26221 For other kinds of multi-file mailbox, the time of last access cannot be
26222 obtained, so a retry rule that uses this type of error field is never matched.
26223 .endlist
26224
26225 The quota errors apply both to system-enforced quotas and to Exim's own quota
26226 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26227 when a local delivery is deferred because a partition is full (the ENOSPC
26228 error).
26229
26230
26231
26232 .section "Retry rules for specified senders" "SECID162"
26233 .cindex "retry" "rules; sender-specific"
26234 You can specify retry rules that apply only when the failing message has a
26235 specific sender. In particular, this can be used to define retry rules that
26236 apply only to bounce messages. The third item in a retry rule can be of this
26237 form:
26238 .display
26239 &`senders=`&<&'address list'&>
26240 .endd
26241 The retry timings themselves are then the fourth item. For example:
26242 .code
26243 *   rcpt_4xx   senders=:   F,1h,30m
26244 .endd
26245 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26246 host. If the address list contains white space, it must be enclosed in quotes.
26247 For example:
26248 .code
26249 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26250 .endd
26251 &*Warning*&: This facility can be unhelpful if it is used for host errors
26252 (which do not depend on the recipient). The reason is that the sender is used
26253 only to match the retry rule. Once the rule has been found for a host error,
26254 its contents are used to set a retry time for the host, and this will apply to
26255 all messages, not just those with specific senders.
26256
26257 When testing retry rules using &%-brt%&, you can supply a sender using the
26258 &%-f%& command line option, like this:
26259 .code
26260 exim -f "" -brt user@dom.ain
26261 .endd
26262 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26263 list is never matched.
26264
26265
26266
26267
26268
26269 .section "Retry parameters" "SECID163"
26270 .cindex "retry" "parameters in rules"
26271 The third (or fourth, if a senders list is present) field in a retry rule is a
26272 sequence of retry parameter sets, separated by semicolons. Each set consists of
26273 .display
26274 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26275 .endd
26276 The letter identifies the algorithm for computing a new retry time; the cutoff
26277 time is the time beyond which this algorithm no longer applies, and the
26278 arguments vary the algorithm's action. The cutoff time is measured from the
26279 time that the first failure for the domain (combined with the local part if
26280 relevant) was detected, not from the time the message was received.
26281
26282 .cindex "retry" "algorithms"
26283 .cindex "retry" "fixed intervals"
26284 .cindex "retry" "increasing intervals"
26285 .cindex "retry" "random intervals"
26286 The available algorithms are:
26287
26288 .ilist
26289 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26290 the interval.
26291 .next
26292 &'G'&: retry at geometrically increasing intervals. The first argument
26293 specifies a starting value for the interval, and the second a multiplier, which
26294 is used to increase the size of the interval at each retry.
26295 .next
26296 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26297 retry, the previous interval is multiplied by the factor in order to get a
26298 maximum for the next interval. The minimum interval is the first argument of
26299 the parameter, and an actual interval is chosen randomly between them. Such a
26300 rule has been found to be helpful in cluster configurations when all the
26301 members of the cluster restart at once, and may therefore synchronize their
26302 queue processing times.
26303 .endlist
26304
26305 When computing the next retry time, the algorithm definitions are scanned in
26306 order until one whose cutoff time has not yet passed is reached. This is then
26307 used to compute a new retry time that is later than the current time. In the
26308 case of fixed interval retries, this simply means adding the interval to the
26309 current time. For geometrically increasing intervals, retry intervals are
26310 computed from the rule's parameters until one that is greater than the previous
26311 interval is found. The main configuration variable
26312 .cindex "limit" "retry interval"
26313 .cindex "retry" "interval, maximum"
26314 .oindex "&%retry_interval_max%&"
26315 &%retry_interval_max%& limits the maximum interval between retries. It
26316 cannot be set greater than &`24h`&, which is its default value.
26317
26318 A single remote domain may have a number of hosts associated with it, and each
26319 host may have more than one IP address. Retry algorithms are selected on the
26320 basis of the domain name, but are applied to each IP address independently. If,
26321 for example, a host has two IP addresses and one is unusable, Exim will
26322 generate retry times for it and will not try to use it until its next retry
26323 time comes. Thus the good IP address is likely to be tried first most of the
26324 time.
26325
26326 .cindex "hints database" "use for retrying"
26327 Retry times are hints rather than promises. Exim does not make any attempt to
26328 run deliveries exactly at the computed times. Instead, a queue runner process
26329 starts delivery processes for delayed messages periodically, and these attempt
26330 new deliveries only for those addresses that have passed their next retry time.
26331 If a new message arrives for a deferred address, an immediate delivery attempt
26332 occurs only if the address has passed its retry time. In the absence of new
26333 messages, the minimum time between retries is the interval between queue runner
26334 processes. There is not much point in setting retry times of five minutes if
26335 your queue runners happen only once an hour, unless there are a significant
26336 number of incoming messages (which might be the case on a system that is
26337 sending everything to a smart host, for example).
26338
26339 The data in the retry hints database can be inspected by using the
26340 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26341 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26342 &'exinext'& utility script can be used to find out what the next retry times
26343 are for the hosts associated with a particular mail domain, and also for local
26344 deliveries that have been deferred.
26345
26346
26347 .section "Retry rule examples" "SECID164"
26348 Here are some example retry rules:
26349 .code
26350 alice@wonderland.fict.example quota_5d  F,7d,3h
26351 wonderland.fict.example       quota_5d
26352 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26353 lookingglass.fict.example     *         F,24h,30m;
26354 *                 refused_A   F,2h,20m;
26355 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26356 .endd
26357 The first rule sets up special handling for mail to
26358 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26359 mailbox has not been read for at least 5 days. Retries continue every three
26360 hours for 7 days. The second rule handles over-quota errors for all other local
26361 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26362 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26363 fail are bounced immediately if the mailbox has not been read for at least 5
26364 days.
26365
26366 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26367 happen every 15 minutes for an hour, then with geometrically increasing
26368 intervals until two days have passed since a delivery first failed. After the
26369 first hour there is a delay of one hour, then two hours, then four hours, and
26370 so on (this is a rather extreme example).
26371
26372 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26373 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26374 all other domains, with special action for connection refusal from hosts that
26375 were not obtained from an MX record.
26376
26377 The final rule in a retry configuration should always have asterisks in the
26378 first two fields so as to provide a general catch-all for any addresses that do
26379 not have their own special handling. This example tries every 15 minutes for 2
26380 hours, then with intervals starting at one hour and increasing by a factor of
26381 1.5 up to 16 hours, then every 8 hours up to 5 days.
26382
26383
26384
26385 .section "Timeout of retry data" "SECID165"
26386 .cindex "timeout" "of retry data"
26387 .oindex "&%retry_data_expire%&"
26388 .cindex "hints database" "data expiry"
26389 .cindex "retry" "timeout of data"
26390 Exim timestamps the data that it writes to its retry hints database. When it
26391 consults the data during a delivery it ignores any that is older than the value
26392 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26393 been tried for 7 days, Exim will try to deliver to it immediately a message
26394 arrives, and if that fails, it will calculate a retry time as if it were
26395 failing for the first time.
26396
26397 This improves the behaviour for messages routed to rarely-used hosts such as MX
26398 backups. If such a host was down at one time, and happens to be down again when
26399 Exim tries a month later, using the old retry data would imply that it had been
26400 down all the time, which is not a justified assumption.
26401
26402 If a host really is permanently dead, this behaviour causes a burst of retries
26403 every now and again, but only if messages routed to it are rare. If there is a
26404 message at least once every 7 days the retry data never expires.
26405
26406
26407
26408
26409 .section "Long-term failures" "SECID166"
26410 .cindex "delivery failure, long-term"
26411 .cindex "retry" "after long-term failure"
26412 Special processing happens when an email address has been failing for so long
26413 that the cutoff time for the last algorithm is reached. For example, using the
26414 default retry rule:
26415 .code
26416 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26417 .endd
26418 the cutoff time is four days. Reaching the retry cutoff is independent of how
26419 long any specific message has been failing; it is the length of continuous
26420 failure for the recipient address that counts.
26421
26422 When the cutoff time is reached for a local delivery, or for all the IP
26423 addresses associated with a remote delivery, a subsequent delivery failure
26424 causes Exim to give up on the address, and a bounce message is generated.
26425 In order to cater for new messages that use the failing address, a next retry
26426 time is still computed from the final algorithm, and is used as follows:
26427
26428 For local deliveries, one delivery attempt is always made for any subsequent
26429 messages. If this delivery fails, the address fails immediately. The
26430 post-cutoff retry time is not used.
26431
26432 .cindex "final cutoff" "retries, controlling"
26433 .cindex retry "final cutoff"
26434 If the delivery is remote, there are two possibilities, controlled by the
26435 .oindex "&%delay_after_cutoff%&"
26436 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26437 default. Until the post-cutoff retry time for one of the IP addresses,
26438 as set by the &%retry_data_expire%& option, is
26439 reached, the failing email address is bounced immediately, without a delivery
26440 attempt taking place. After that time, one new delivery attempt is made to
26441 those IP addresses that are past their retry times, and if that still fails,
26442 the address is bounced and new retry times are computed.
26443
26444 In other words, when all the hosts for a given email address have been failing
26445 for a long time, Exim bounces rather then defers until one of the hosts' retry
26446 times is reached. Then it tries once, and bounces if that attempt fails. This
26447 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26448 to a broken destination, but if the host does recover, Exim will eventually
26449 notice.
26450
26451 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26452 addresses are past their final cutoff time, Exim tries to deliver to those IP
26453 addresses that have not been tried since the message arrived. If there are
26454 no suitable IP addresses, or if they all fail, the address is bounced. In other
26455 words, it does not delay when a new message arrives, but tries the expired
26456 addresses immediately, unless they have been tried since the message arrived.
26457 If there is a continuous stream of messages for the failing domains, setting
26458 &%delay_after_cutoff%& false means that there will be many more attempts to
26459 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26460 true.
26461
26462 .section "Deliveries that work intermittently" "SECID167"
26463 .cindex "retry" "intermittently working deliveries"
26464 Some additional logic is needed to cope with cases where a host is
26465 intermittently available, or when a message has some attribute that prevents
26466 its delivery when others to the same address get through. In this situation,
26467 because some messages are successfully delivered, the &"retry clock"& for the
26468 host or address keeps getting reset by the successful deliveries, and so
26469 failing messages remain in the queue for ever because the cutoff time is never
26470 reached.
26471
26472 Two exceptional actions are applied to prevent this happening. The first
26473 applies to errors that are related to a message rather than a remote host.
26474 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26475 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26476 commands, and quota failures. For this type of error, if a message's arrival
26477 time is earlier than the &"first failed"& time for the error, the earlier time
26478 is used when scanning the retry rules to decide when to try next and when to
26479 time out the address.
26480
26481 The exceptional second action applies in all cases. If a message has been on
26482 the queue for longer than the cutoff time of any applicable retry rule for a
26483 given address, a delivery is attempted for that address, even if it is not yet
26484 time, and if this delivery fails, the address is timed out. A new retry time is
26485 not computed in this case, so that other messages for the same address are
26486 considered immediately.
26487 .ecindex IIDretconf1
26488 .ecindex IIDregconf2
26489
26490
26491
26492
26493
26494
26495 . ////////////////////////////////////////////////////////////////////////////
26496 . ////////////////////////////////////////////////////////////////////////////
26497
26498 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26499 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26500 .scindex IIDauthconf2 "authentication"
26501 The &"authenticators"& section of Exim's runtime configuration is concerned
26502 with SMTP authentication. This facility is an extension to the SMTP protocol,
26503 described in RFC 2554, which allows a client SMTP host to authenticate itself
26504 to a server. This is a common way for a server to recognize clients that are
26505 permitted to use it as a relay. SMTP authentication is not of relevance to the
26506 transfer of mail between servers that have no managerial connection with each
26507 other.
26508
26509 .cindex "AUTH" "description of"
26510 Very briefly, the way SMTP authentication works is as follows:
26511
26512 .ilist
26513 The server advertises a number of authentication &'mechanisms'& in response to
26514 the client's EHLO command.
26515 .next
26516 The client issues an AUTH command, naming a specific mechanism. The command
26517 may, optionally, contain some authentication data.
26518 .next
26519 The server may issue one or more &'challenges'&, to which the client must send
26520 appropriate responses. In simple authentication mechanisms, the challenges are
26521 just prompts for user names and passwords. The server does not have to issue
26522 any challenges &-- in some mechanisms the relevant data may all be transmitted
26523 with the AUTH command.
26524 .next
26525 The server either accepts or denies authentication.
26526 .next
26527 If authentication succeeds, the client may optionally make use of the AUTH
26528 option on the MAIL command to pass an authenticated sender in subsequent
26529 mail transactions. Authentication lasts for the remainder of the SMTP
26530 connection.
26531 .next
26532 If authentication fails, the client may give up, or it may try a different
26533 authentication mechanism, or it may try transferring mail over the
26534 unauthenticated connection.
26535 .endlist
26536
26537 If you are setting up a client, and want to know which authentication
26538 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26539 SMTP port) on the server, and issue an EHLO command. The response to this
26540 includes the list of supported mechanisms. For example:
26541 .display
26542 &`$ `&&*&`telnet server.example 25`&*&
26543 &`Trying 192.168.34.25...`&
26544 &`Connected to server.example.`&
26545 &`Escape character is &#x0027;^]&#x0027;.`&
26546 &`220 server.example ESMTP Exim 4.20 ...`&
26547 &*&`ehlo client.example`&*&
26548 &`250-server.example Hello client.example [10.8.4.5]`&
26549 &`250-SIZE 52428800`&
26550 &`250-PIPELINING`&
26551 &`250-AUTH PLAIN`&
26552 &`250 HELP`&
26553 .endd
26554 The second-last line of this example output shows that the server supports
26555 authentication using the PLAIN mechanism. In Exim, the different authentication
26556 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26557 routers and transports, which authenticators are included in the binary is
26558 controlled by build-time definitions. The following are currently available,
26559 included by setting
26560 .code
26561 AUTH_CRAM_MD5=yes
26562 AUTH_CYRUS_SASL=yes
26563 AUTH_DOVECOT=yes
26564 AUTH_EXTERNAL=yes
26565 AUTH_GSASL=yes
26566 AUTH_HEIMDAL_GSSAPI=yes
26567 AUTH_PLAINTEXT=yes
26568 AUTH_SPA=yes
26569 AUTH_TLS=yes
26570 .endd
26571 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26572 authentication mechanism (RFC 2195), and the second provides an interface to
26573 the Cyrus SASL authentication library.
26574 The third is an interface to Dovecot's authentication system, delegating the
26575 work via a socket interface.
26576 The fourth provides for negotiation of authentication done via non-SMTP means,
26577 as defined by RFC 4422 Appendix A.
26578 The fifth provides an interface to the GNU SASL authentication library, which
26579 provides mechanisms but typically not data sources.
26580 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26581 supporting setting a server keytab.
26582 The seventh can be configured to support
26583 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26584 not formally documented, but used by several MUAs.
26585 The eighth authenticator
26586 supports Microsoft's &'Secure Password Authentication'& mechanism.
26587 The last is an Exim authenticator but not an SMTP one;
26588 instead it can use information from a TLS negotiation.
26589
26590 The authenticators are configured using the same syntax as other drivers (see
26591 section &<<SECTfordricon>>&). If no authenticators are required, no
26592 authentication section need be present in the configuration file. Each
26593 authenticator can in principle have both server and client functions. When Exim
26594 is receiving SMTP mail, it is acting as a server; when it is sending out
26595 messages over SMTP, it is acting as a client. Authenticator configuration
26596 options are provided for use in both these circumstances.
26597
26598 To make it clear which options apply to which situation, the prefixes
26599 &%server_%& and &%client_%& are used on option names that are specific to
26600 either the server or the client function, respectively. Server and client
26601 functions are disabled if none of their options are set. If an authenticator is
26602 to be used for both server and client functions, a single definition, using
26603 both sets of options, is required. For example:
26604 .code
26605 cram:
26606   driver = cram_md5
26607   public_name = CRAM-MD5
26608   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26609   client_name = ph10
26610   client_secret = secret2
26611 .endd
26612 The &%server_%& option is used when Exim is acting as a server, and the
26613 &%client_%& options when it is acting as a client.
26614
26615 Descriptions of the individual authenticators are given in subsequent chapters.
26616 The remainder of this chapter covers the generic options for the
26617 authenticators, followed by general discussion of the way authentication works
26618 in Exim.
26619
26620 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26621 per-mechanism basis.  Please read carefully to determine which variables hold
26622 account labels such as usercodes and which hold passwords or other
26623 authenticating data.
26624
26625 Note that some mechanisms support two different identifiers for accounts: the
26626 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26627 and &'authz'& are commonly encountered.  The American spelling is standard here.
26628 Conceptually, authentication data such as passwords are tied to the identifier
26629 used to authenticate; servers may have rules to permit one user to act as a
26630 second user, so that after login the session is treated as though that second
26631 user had logged in.  That second user is the &'authorization id'&.  A robust
26632 configuration might confirm that the &'authz'& field is empty or matches the
26633 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26634 as verified data, the &'authz'& as an unverified request which the server might
26635 choose to honour.
26636
26637 A &'realm'& is a text string, typically a domain name, presented by a server
26638 to a client to help it select an account and credentials to use.  In some
26639 mechanisms, the client and server provably agree on the realm, but clients
26640 typically can not treat the realm as secure data to be blindly trusted.
26641
26642
26643
26644 .section "Generic options for authenticators" "SECID168"
26645 .cindex "authentication" "generic options"
26646 .cindex "options" "generic; for authenticators"
26647
26648 .option client_condition authenticators string&!! unset
26649 When Exim is authenticating as a client, it skips any authenticator whose
26650 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26651 used, for example, to skip plain text authenticators when the connection is not
26652 encrypted by a setting such as:
26653 .code
26654 client_condition = ${if !eq{$tls_out_cipher}{}}
26655 .endd
26656
26657
26658 .option client_set_id authenticators string&!! unset
26659 When client authentication succeeds, this condition is expanded; the
26660 result is used in the log lines for outbound messages.
26661 Typically it will be the user name used for authentication.
26662
26663
26664 .option driver authenticators string unset
26665 This option must always be set. It specifies which of the available
26666 authenticators is to be used.
26667
26668
26669 .option public_name authenticators string unset
26670 This option specifies the name of the authentication mechanism that the driver
26671 implements, and by which it is known to the outside world. These names should
26672 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26673 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26674 defaults to the driver's instance name.
26675
26676
26677 .option server_advertise_condition authenticators string&!! unset
26678 When a server is about to advertise an authentication mechanism, the condition
26679 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26680 mechanism is not advertised.
26681 If the expansion fails, the mechanism is not advertised. If the failure was not
26682 forced, and was not caused by a lookup defer, the incident is logged.
26683 See section &<<SECTauthexiser>>& below for further discussion.
26684
26685
26686 .option server_condition authenticators string&!! unset
26687 This option must be set for a &%plaintext%& server authenticator, where it
26688 is used directly to control authentication. See section &<<SECTplainserver>>&
26689 for details.
26690
26691 For the &(gsasl)& authenticator, this option is required for various
26692 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26693
26694 For the other authenticators, &%server_condition%& can be used as an additional
26695 authentication or authorization mechanism that is applied after the other
26696 authenticator conditions succeed. If it is set, it is expanded when the
26697 authenticator would otherwise return a success code. If the expansion is forced
26698 to fail, authentication fails. Any other expansion failure causes a temporary
26699 error code to be returned. If the result of a successful expansion is an empty
26700 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26701 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26702 other result, a temporary error code is returned, with the expanded string as
26703 the error text.
26704
26705
26706 .option server_debug_print authenticators string&!! unset
26707 If this option is set and authentication debugging is enabled (see the &%-d%&
26708 command line option), the string is expanded and included in the debugging
26709 output when the authenticator is run as a server. This can help with checking
26710 out the values of variables.
26711 If expansion of the string fails, the error message is written to the debugging
26712 output, and Exim carries on processing.
26713
26714
26715 .option server_set_id authenticators string&!! unset
26716 .vindex "&$authenticated_id$&"
26717 .vindex "&$authenticated_fail_id$&"
26718 When an Exim server successfully authenticates a client, this string is
26719 expanded using data from the authentication, and preserved for any incoming
26720 messages in the variable &$authenticated_id$&. It is also included in the log
26721 lines for incoming messages. For example, a user/password authenticator
26722 configuration might preserve the user name that was used to authenticate, and
26723 refer to it subsequently during delivery of the message.
26724 On a failing authentication the expansion result is instead saved in
26725 the &$authenticated_fail_id$& variable.
26726 If expansion fails, the option is ignored.
26727
26728
26729 .option server_mail_auth_condition authenticators string&!! unset
26730 This option allows a server to discard authenticated sender addresses supplied
26731 as part of MAIL commands in SMTP connections that are authenticated by the
26732 driver on which &%server_mail_auth_condition%& is set. The option is not used
26733 as part of the authentication process; instead its (unexpanded) value is
26734 remembered for later use.
26735 How it is used is described in the following section.
26736
26737
26738
26739
26740
26741 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26742 .cindex "authentication" "sender; authenticated"
26743 .cindex "AUTH" "on MAIL command"
26744 When a client supplied an AUTH= item on a MAIL command, Exim applies
26745 the following checks before accepting it as the authenticated sender of the
26746 message:
26747
26748 .ilist
26749 If the connection is not using extended SMTP (that is, HELO was used rather
26750 than EHLO), the use of AUTH= is a syntax error.
26751 .next
26752 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26753 .next
26754 .vindex "&$authenticated_sender$&"
26755 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26756 running, the value of &$authenticated_sender$& is set to the value obtained
26757 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26758 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26759 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26760 given for the MAIL command.
26761 .next
26762 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26763 is accepted and placed in &$authenticated_sender$& only if the client has
26764 authenticated.
26765 .next
26766 If the AUTH= value was accepted by either of the two previous rules, and
26767 the client has authenticated, and the authenticator has a setting for the
26768 &%server_mail_auth_condition%&, the condition is checked at this point. The
26769 valued that was saved from the authenticator is expanded. If the expansion
26770 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26771 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26772 the value of &$authenticated_sender$& is retained and passed on with the
26773 message.
26774 .endlist
26775
26776
26777 When &$authenticated_sender$& is set for a message, it is passed on to other
26778 hosts to which Exim authenticates as a client. Do not confuse this value with
26779 &$authenticated_id$&, which is a string obtained from the authentication
26780 process, and which is not usually a complete email address.
26781
26782 .vindex "&$sender_address$&"
26783 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26784 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26785 therefore make use of &$authenticated_sender$&. The converse is not true: the
26786 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26787 ACL is run.
26788
26789
26790
26791 .section "Authentication on an Exim server" "SECTauthexiser"
26792 .cindex "authentication" "on an Exim server"
26793 When Exim receives an EHLO command, it advertises the public names of those
26794 authenticators that are configured as servers, subject to the following
26795 conditions:
26796
26797 .ilist
26798 The client host must match &%auth_advertise_hosts%& (default *).
26799 .next
26800 It the &%server_advertise_condition%& option is set, its expansion must not
26801 yield the empty string, &"0"&, &"no"&, or &"false"&.
26802 .endlist
26803
26804 The order in which the authenticators are defined controls the order in which
26805 the mechanisms are advertised.
26806
26807 Some mail clients (for example, some versions of Netscape) require the user to
26808 provide a name and password for authentication whenever AUTH is advertised,
26809 even though authentication may not in fact be needed (for example, Exim may be
26810 set up to allow unconditional relaying from the client by an IP address check).
26811 You can make such clients more friendly by not advertising AUTH to them.
26812 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26813 that runs for RCPT) to relay without authentication, you should set
26814 .code
26815 auth_advertise_hosts = ! 10.9.8.0/24
26816 .endd
26817 so that no authentication mechanisms are advertised to them.
26818
26819 The &%server_advertise_condition%& controls the advertisement of individual
26820 authentication mechanisms. For example, it can be used to restrict the
26821 advertisement of a particular mechanism to encrypted connections, by a setting
26822 such as:
26823 .code
26824 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26825 .endd
26826 .vindex "&$tls_in_cipher$&"
26827 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26828 yields &"yes"&, which allows the advertisement to happen.
26829
26830 When an Exim server receives an AUTH command from a client, it rejects it
26831 immediately if AUTH was not advertised in response to an earlier EHLO
26832 command. This is the case if
26833
26834 .ilist
26835 The client host does not match &%auth_advertise_hosts%&; or
26836 .next
26837 No authenticators are configured with server options; or
26838 .next
26839 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26840 server authenticators.
26841 .endlist
26842
26843
26844 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26845 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26846 AUTH is accepted from any client host.
26847
26848 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26849 server authentication mechanism that was advertised in response to EHLO and
26850 that matches the one named in the AUTH command. If it finds one, it runs
26851 the appropriate authentication protocol, and authentication either succeeds or
26852 fails. If there is no matching advertised mechanism, the AUTH command is
26853 rejected with a 504 error.
26854
26855 .vindex "&$received_protocol$&"
26856 .vindex "&$sender_host_authenticated$&"
26857 When a message is received from an authenticated host, the value of
26858 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26859 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26860 public name) of the authenticator driver that successfully authenticated the
26861 client from which the message was received. This variable is empty if there was
26862 no successful authentication.
26863
26864 .cindex authentication "expansion item"
26865 Successful authentication sets up information used by the
26866 &%authresults%& expansion item.
26867
26868
26869
26870
26871 .section "Testing server authentication" "SECID169"
26872 .cindex "authentication" "testing a server"
26873 .cindex "AUTH" "testing a server"
26874 .cindex "base64 encoding" "creating authentication test data"
26875 Exim's &%-bh%& option can be useful for testing server authentication
26876 configurations. The data for the AUTH command has to be sent using base64
26877 encoding. A quick way to produce such data for testing is the following Perl
26878 script:
26879 .code
26880 use MIME::Base64;
26881 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26882 .endd
26883 .cindex "binary zero" "in authentication data"
26884 This interprets its argument as a Perl string, and then encodes it. The
26885 interpretation as a Perl string allows binary zeros, which are required for
26886 some kinds of authentication, to be included in the data. For example, a
26887 command line to run this script on such data might be
26888 .code
26889 encode '\0user\0password'
26890 .endd
26891 Note the use of single quotes to prevent the shell interpreting the
26892 backslashes, so that they can be interpreted by Perl to specify characters
26893 whose code value is zero.
26894
26895 &*Warning 1*&: If either of the user or password strings starts with an octal
26896 digit, you must use three zeros instead of one after the leading backslash. If
26897 you do not, the octal digit that starts your string will be incorrectly
26898 interpreted as part of the code for the first character.
26899
26900 &*Warning 2*&: If there are characters in the strings that Perl interprets
26901 specially, you must use a Perl escape to prevent them being misinterpreted. For
26902 example, a command such as
26903 .code
26904 encode '\0user@domain.com\0pas$$word'
26905 .endd
26906 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26907
26908 If you have the &%mimencode%& command installed, another way to do produce
26909 base64-encoded strings is to run the command
26910 .code
26911 echo -e -n `\0user\0password' | mimencode
26912 .endd
26913 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26914 in the argument, and the &%-n%& option specifies no newline at the end of its
26915 output. However, not all versions of &%echo%& recognize these options, so you
26916 should check your version before relying on this suggestion.
26917
26918
26919
26920 .section "Authentication by an Exim client" "SECID170"
26921 .cindex "authentication" "on an Exim client"
26922 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26923 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26924 announces support for authentication, and the host matches an entry in either
26925 of these options, Exim (as a client) tries to authenticate as follows:
26926
26927 .ilist
26928 For each authenticator that is configured as a client, in the order in which
26929 they are defined in the configuration, it searches the authentication
26930 mechanisms announced by the server for one whose name matches the public name
26931 of the authenticator.
26932 .next
26933 .vindex "&$host$&"
26934 .vindex "&$host_address$&"
26935 When it finds one that matches, it runs the authenticator's client code. The
26936 variables &$host$& and &$host_address$& are available for any string expansions
26937 that the client might do. They are set to the server's name and IP address. If
26938 any expansion is forced to fail, the authentication attempt is abandoned, and
26939 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26940 delivery to be deferred.
26941 .next
26942 If the result of the authentication attempt is a temporary error or a timeout,
26943 Exim abandons trying to send the message to the host for the moment. It will
26944 try again later. If there are any backup hosts available, they are tried in the
26945 usual way.
26946 .next
26947 If the response to authentication is a permanent error (5&'xx'& code), Exim
26948 carries on searching the list of authenticators and tries another one if
26949 possible. If all authentication attempts give permanent errors, or if there are
26950 no attempts because no mechanisms match (or option expansions force failure),
26951 what happens depends on whether the host matches &%hosts_require_auth%& or
26952 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26953 delivery is deferred. The error can be detected in the retry rules, and thereby
26954 turned into a permanent error if you wish. In the second case, Exim tries to
26955 deliver the message unauthenticated.
26956 .endlist
26957
26958 Note that the hostlist test for whether to do authentication can be
26959 confused if name-IP lookups change between the time the peer is decided
26960 upon and the time that the transport runs.  For example, with a manualroute
26961 router given a host name, and with DNS "round-robin" used by that name: if
26962 the local resolver cache times out between the router and the transport
26963 running, the transport may get an IP for the name for its authentication
26964 check which does not match the connection peer IP.
26965 No authentication will then be done, despite the names being identical.
26966
26967 For such cases use a separate transport which always authenticates.
26968
26969 .cindex "AUTH" "on MAIL command"
26970 When Exim has authenticated itself to a remote server, it adds the AUTH
26971 parameter to the MAIL commands it sends, if it has an authenticated sender for
26972 the message. If the message came from a remote host, the authenticated sender
26973 is the one that was receiving on an incoming MAIL command, provided that the
26974 incoming connection was authenticated and the &%server_mail_auth%& condition
26975 allowed the authenticated sender to be retained. If a local process calls Exim
26976 to send a message, the sender address that is built from the login name and
26977 &%qualify_domain%& is treated as authenticated. However, if the
26978 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26979 the authenticated sender that was received with the message.
26980 .ecindex IIDauthconf1
26981 .ecindex IIDauthconf2
26982
26983
26984
26985
26986
26987
26988 . ////////////////////////////////////////////////////////////////////////////
26989 . ////////////////////////////////////////////////////////////////////////////
26990
26991 .chapter "The plaintext authenticator" "CHAPplaintext"
26992 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26993 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26994 The &(plaintext)& authenticator can be configured to support the PLAIN and
26995 LOGIN authentication mechanisms, both of which transfer authentication data as
26996 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26997 security risk; you are strongly advised to insist on the use of SMTP encryption
26998 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26999 use unencrypted plain text, you should not use the same passwords for SMTP
27000 connections as you do for login accounts.
27001
27002 .section "Avoiding cleartext use" "SECTplain_TLS"
27003 The following generic option settings will disable &(plaintext)& authenticators when
27004 TLS is not being used:
27005 .code
27006   server_advertise_condition = ${if def:tls_in_cipher }
27007   client_condition =           ${if def:tls_out_cipher}
27008 .endd
27009
27010 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27011 but is still vulnerable to a Man In The Middle attack unless certificates
27012 (including their names) have been properly verified.
27013
27014 .section "Plaintext server options" "SECID171"
27015 .cindex "options" "&(plaintext)& authenticator (server)"
27016 When configured as a server, &(plaintext)& uses the following options:
27017
27018 .option server_condition authenticators string&!! unset
27019 This is actually a global authentication option, but it must be set in order to
27020 configure the &(plaintext)& driver as a server. Its use is described below.
27021
27022 .option server_prompts plaintext "string list&!!" unset
27023 The contents of this option, after expansion, must be a colon-separated list of
27024 prompt strings. If expansion fails, a temporary authentication rejection is
27025 given.
27026
27027 .section "Using plaintext in a server" "SECTplainserver"
27028 .cindex "AUTH" "in &(plaintext)& authenticator"
27029 .cindex "binary zero" "in &(plaintext)& authenticator"
27030 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27031         "in &(plaintext)& authenticator"
27032 .vindex "&$auth1$&, &$auth2$&, etc"
27033 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27034
27035 When running as a server, &(plaintext)& performs the authentication test by
27036 expanding a string. The data sent by the client with the AUTH command, or in
27037 response to subsequent prompts, is base64 encoded, and so may contain any byte
27038 values when decoded. If any data is supplied with the command, it is treated as
27039 a list of strings, separated by NULs (binary zeros), the first three of which
27040 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27041 (neither LOGIN nor PLAIN uses more than three strings).
27042
27043 For compatibility with previous releases of Exim, the values are also placed in
27044 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27045 variables for this purpose is now deprecated, as it can lead to confusion in
27046 string expansions that also use them for other things.
27047
27048 If there are more strings in &%server_prompts%& than the number of strings
27049 supplied with the AUTH command, the remaining prompts are used to obtain more
27050 data. Each response from the client may be a list of NUL-separated strings.
27051
27052 .vindex "&$authenticated_id$&"
27053 Once a sufficient number of data strings have been received,
27054 &%server_condition%& is expanded. If the expansion is forced to fail,
27055 authentication fails. Any other expansion failure causes a temporary error code
27056 to be returned. If the result of a successful expansion is an empty string,
27057 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27058 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27059 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27060 For any other result, a temporary error code is returned, with the expanded
27061 string as the error text.
27062
27063 &*Warning*&: If you use a lookup in the expansion to find the user's
27064 password, be sure to make the authentication fail if the user is unknown.
27065 There are good and bad examples at the end of the next section.
27066
27067
27068
27069 .section "The PLAIN authentication mechanism" "SECID172"
27070 .cindex "PLAIN authentication mechanism"
27071 .cindex authentication PLAIN
27072 .cindex "binary zero" "in &(plaintext)& authenticator"
27073 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27074 sent as one item of data (that is, one combined string containing two NUL
27075 separators). The data is sent either as part of the AUTH command, or
27076 subsequently in response to an empty prompt from the server.
27077
27078 The second and third strings are a user name and a corresponding password.
27079 Using a single fixed user name and password as an example, this could be
27080 configured as follows:
27081 .code
27082 fixed_plain:
27083   driver = plaintext
27084   public_name = PLAIN
27085   server_prompts = :
27086   server_condition = \
27087     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27088   server_set_id = $auth2
27089 .endd
27090 Note that the default result strings from &%if%& (&"true"& or an empty string)
27091 are exactly what we want here, so they need not be specified. Obviously, if the
27092 password contains expansion-significant characters such as dollar, backslash,
27093 or closing brace, they have to be escaped.
27094
27095 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27096 the end of a string list are ignored). If all the data comes as part of the
27097 AUTH command, as is commonly the case, the prompt is not used. This
27098 authenticator is advertised in the response to EHLO as
27099 .code
27100 250-AUTH PLAIN
27101 .endd
27102 and a client host can authenticate itself by sending the command
27103 .code
27104 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27105 .endd
27106 As this contains three strings (more than the number of prompts), no further
27107 data is required from the client. Alternatively, the client may just send
27108 .code
27109 AUTH PLAIN
27110 .endd
27111 to initiate authentication, in which case the server replies with an empty
27112 prompt. The client must respond with the combined data string.
27113
27114 The data string is base64 encoded, as required by the RFC. This example,
27115 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27116 represents a zero byte. This is split up into three strings, the first of which
27117 is empty. The &%server_condition%& option in the authenticator checks that the
27118 second two are &`username`& and &`mysecret`& respectively.
27119
27120 Having just one fixed user name and password, as in this example, is not very
27121 realistic, though for a small organization with only a handful of
27122 authenticating clients it could make sense.
27123
27124 A more sophisticated instance of this authenticator could use the user name in
27125 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27126 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27127 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27128 This is an incorrect example:
27129 .code
27130 server_condition = \
27131   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27132 .endd
27133 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27134 which it then compares to the supplied password (&$auth3$&). Why is this example
27135 incorrect? It works fine for existing users, but consider what happens if a
27136 non-existent user name is given. The lookup fails, but as no success/failure
27137 strings are given for the lookup, it yields an empty string. Thus, to defeat
27138 the authentication, all a client has to do is to supply a non-existent user
27139 name and an empty password. The correct way of writing this test is:
27140 .code
27141 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27142   {${if eq{$value}{$auth3}}} {false}}
27143 .endd
27144 In this case, if the lookup succeeds, the result is checked; if the lookup
27145 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27146 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27147 always fails if its second argument is empty. However, the second way of
27148 writing the test makes the logic clearer.
27149
27150
27151 .section "The LOGIN authentication mechanism" "SECID173"
27152 .cindex "LOGIN authentication mechanism"
27153 .cindex authentication LOGIN
27154 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27155 in a number of programs. No data is sent with the AUTH command. Instead, a
27156 user name and password are supplied separately, in response to prompts. The
27157 plaintext authenticator can be configured to support this as in this example:
27158 .code
27159 fixed_login:
27160   driver = plaintext
27161   public_name = LOGIN
27162   server_prompts = User Name : Password
27163   server_condition = \
27164     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27165   server_set_id = $auth1
27166 .endd
27167 Because of the way plaintext operates, this authenticator accepts data supplied
27168 with the AUTH command (in contravention of the specification of LOGIN), but
27169 if the client does not supply it (as is the case for LOGIN clients), the prompt
27170 strings are used to obtain two data items.
27171
27172 Some clients are very particular about the precise text of the prompts. For
27173 example, Outlook Express is reported to recognize only &"Username:"& and
27174 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27175 strings. It uses the &%ldapauth%& expansion condition to check the user
27176 name and password by binding to an LDAP server:
27177 .code
27178 login:
27179   driver = plaintext
27180   public_name = LOGIN
27181   server_prompts = Username:: : Password::
27182   server_condition = ${if and{{ \
27183     !eq{}{$auth1} }{ \
27184     ldapauth{\
27185       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27186       pass=${quote:$auth2} \
27187       ldap://ldap.example.org/} }} }
27188   server_set_id = uid=$auth1,ou=people,o=example.org
27189 .endd
27190 We have to check that the username is not empty before using it, because LDAP
27191 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27192 operator to correctly quote the DN for authentication. However, the basic
27193 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27194 correct one to use for the password, because quoting is needed only to make
27195 the password conform to the Exim syntax. At the LDAP level, the password is an
27196 uninterpreted string.
27197
27198
27199 .section "Support for different kinds of authentication" "SECID174"
27200 A number of string expansion features are provided for the purpose of
27201 interfacing to different ways of user authentication. These include checking
27202 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27203 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27204 &<<SECTexpcond>>&.
27205
27206
27207
27208
27209 .section "Using plaintext in a client" "SECID175"
27210 .cindex "options" "&(plaintext)& authenticator (client)"
27211 The &(plaintext)& authenticator has two client options:
27212
27213 .option client_ignore_invalid_base64 plaintext boolean false
27214 If the client receives a server prompt that is not a valid base64 string,
27215 authentication is abandoned by default. However, if this option is set true,
27216 the error in the challenge is ignored and the client sends the response as
27217 usual.
27218
27219 .option client_send plaintext string&!! unset
27220 The string is a colon-separated list of authentication data strings. Each
27221 string is independently expanded before being sent to the server. The first
27222 string is sent with the AUTH command; any more strings are sent in response
27223 to prompts from the server. Before each string is expanded, the value of the
27224 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27225 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27226 way. Thus, the prompt that is received in response to sending the first string
27227 (with the AUTH command) can be used in the expansion of the second string, and
27228 so on. If an invalid base64 string is received when
27229 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27230 &$auth$&<&'n'&> variable.
27231
27232 &*Note*&: You cannot use expansion to create multiple strings, because
27233 splitting takes priority and happens first.
27234
27235 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27236 the data, further processing is applied to each string before it is sent. If
27237 there are any single circumflex characters in the string, they are converted to
27238 NULs. Should an actual circumflex be required as data, it must be doubled in
27239 the string.
27240
27241 This is an example of a client configuration that implements the PLAIN
27242 authentication mechanism with a fixed user name and password:
27243 .code
27244 fixed_plain:
27245   driver = plaintext
27246   public_name = PLAIN
27247   client_send = ^username^mysecret
27248 .endd
27249 The lack of colons means that the entire text is sent with the AUTH
27250 command, with the circumflex characters converted to NULs. A similar example
27251 that uses the LOGIN mechanism is:
27252 .code
27253 fixed_login:
27254   driver = plaintext
27255   public_name = LOGIN
27256   client_send = : username : mysecret
27257 .endd
27258 The initial colon means that the first string is empty, so no data is sent with
27259 the AUTH command itself. The remaining strings are sent in response to
27260 prompts.
27261 .ecindex IIDplaiauth1
27262 .ecindex IIDplaiauth2
27263
27264
27265
27266
27267 . ////////////////////////////////////////////////////////////////////////////
27268 . ////////////////////////////////////////////////////////////////////////////
27269
27270 .chapter "The cram_md5 authenticator" "CHID9"
27271 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27272 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27273 .cindex "CRAM-MD5 authentication mechanism"
27274 .cindex authentication CRAM-MD5
27275 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27276 sends a challenge string to the client, and the response consists of a user
27277 name and the CRAM-MD5 digest of the challenge string combined with a secret
27278 string (password) which is known to both server and client. Thus, the secret
27279 is not sent over the network as plain text, which makes this authenticator more
27280 secure than &(plaintext)&. However, the downside is that the secret has to be
27281 available in plain text at either end.
27282
27283
27284 .section "Using cram_md5 as a server" "SECID176"
27285 .cindex "options" "&(cram_md5)& authenticator (server)"
27286 This authenticator has one server option, which must be set to configure the
27287 authenticator as a server:
27288
27289 .option server_secret cram_md5 string&!! unset
27290 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27291 When the server receives the client's response, the user name is placed in
27292 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27293 obtain the password for that user. The server then computes the CRAM-MD5 digest
27294 that the client should have sent, and checks that it received the correct
27295 string. If the expansion of &%server_secret%& is forced to fail, authentication
27296 fails. If the expansion fails for some other reason, a temporary error code is
27297 returned to the client.
27298
27299 For compatibility with previous releases of Exim, the user name is also placed
27300 in &$1$&. However, the use of this variables for this purpose is now
27301 deprecated, as it can lead to confusion in string expansions that also use
27302 numeric variables for other things.
27303
27304 For example, the following authenticator checks that the user name given by the
27305 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27306 user name, authentication fails.
27307 .code
27308 fixed_cram:
27309   driver = cram_md5
27310   public_name = CRAM-MD5
27311   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27312   server_set_id = $auth1
27313 .endd
27314 .vindex "&$authenticated_id$&"
27315 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27316 name in &$authenticated_id$&. A more typical configuration might look up the
27317 secret string in a file, using the user name as the key. For example:
27318 .code
27319 lookup_cram:
27320   driver = cram_md5
27321   public_name = CRAM-MD5
27322   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27323                   {$value}fail}
27324   server_set_id = $auth1
27325 .endd
27326 Note that this expansion explicitly forces failure if the lookup fails
27327 because &$auth1$& contains an unknown user name.
27328
27329 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27330 using the relevant libraries, you need to know the realm to specify in the
27331 lookup and then ask for the &"userPassword"& attribute for that user in that
27332 realm, with:
27333 .code
27334 cyrusless_crammd5:
27335   driver = cram_md5
27336   public_name = CRAM-MD5
27337   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27338                   dbmjz{/etc/sasldb2}{$value}fail}
27339   server_set_id = $auth1
27340 .endd
27341
27342 .section "Using cram_md5 as a client" "SECID177"
27343 .cindex "options" "&(cram_md5)& authenticator (client)"
27344 When used as a client, the &(cram_md5)& authenticator has two options:
27345
27346
27347
27348 .option client_name cram_md5 string&!! "the primary host name"
27349 This string is expanded, and the result used as the user name data when
27350 computing the response to the server's challenge.
27351
27352
27353 .option client_secret cram_md5 string&!! unset
27354 This option must be set for the authenticator to work as a client. Its value is
27355 expanded and the result used as the secret string when computing the response.
27356
27357
27358 .vindex "&$host$&"
27359 .vindex "&$host_address$&"
27360 Different user names and secrets can be used for different servers by referring
27361 to &$host$& or &$host_address$& in the options. Forced failure of either
27362 expansion string is treated as an indication that this authenticator is not
27363 prepared to handle this case. Exim moves on to the next configured client
27364 authenticator. Any other expansion failure causes Exim to give up trying to
27365 send the message to the current server.
27366
27367 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27368 strings, is:
27369 .code
27370 fixed_cram:
27371   driver = cram_md5
27372   public_name = CRAM-MD5
27373   client_name = ph10
27374   client_secret = secret
27375 .endd
27376 .ecindex IIDcramauth1
27377 .ecindex IIDcramauth2
27378
27379
27380
27381 . ////////////////////////////////////////////////////////////////////////////
27382 . ////////////////////////////////////////////////////////////////////////////
27383
27384 .chapter "The cyrus_sasl authenticator" "CHID10"
27385 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27386 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27387 .cindex "Cyrus" "SASL library"
27388 .cindex "Kerberos"
27389 The code for this authenticator was provided by Matthew Byng-Maddick while
27390 at A L Digital Ltd.
27391
27392 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27393 library implementation of the RFC 2222 (&"Simple Authentication and Security
27394 Layer"&). This library supports a number of authentication mechanisms,
27395 including PLAIN and LOGIN, but also several others that Exim does not support
27396 directly. In particular, there is support for Kerberos authentication.
27397
27398 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27399 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27400 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27401 name of the driver to determine which mechanism to support.
27402
27403 Where access to some kind of secret file is required, for example, in GSSAPI
27404 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27405 user, and that the Cyrus SASL library has no way of escalating privileges
27406 by default. You may also find you need to set environment variables,
27407 depending on the driver you are using.
27408
27409 The application name provided by Exim is &"exim"&, so various SASL options may
27410 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27411 Kerberos, note that because of limitations in the GSSAPI interface,
27412 changing the server keytab might need to be communicated down to the Kerberos
27413 layer independently. The mechanism for doing so is dependent upon the Kerberos
27414 implementation.
27415
27416 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27417 may be set to point to an alternative keytab file. Exim will pass this
27418 variable through from its own inherited environment when started as root or the
27419 Exim user. The keytab file needs to be readable by the Exim user.
27420 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27421 environment variable.  In practice, for those releases, the Cyrus authenticator
27422 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27423 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27424
27425
27426 .section "Using cyrus_sasl as a server" "SECID178"
27427 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27428 (on a successful authentication) into &$auth1$&. For compatibility with
27429 previous releases of Exim, the username is also placed in &$1$&. However, the
27430 use of this variable for this purpose is now deprecated, as it can lead to
27431 confusion in string expansions that also use numeric variables for other
27432 things.
27433
27434
27435 .option server_hostname cyrus_sasl string&!! "see below"
27436 This option selects the hostname that is used when communicating with the
27437 library. The default value is &`$primary_hostname`&. It is up to the underlying
27438 SASL plug-in what it does with this data.
27439
27440
27441 .option server_mech cyrus_sasl string "see below"
27442 This option selects the authentication mechanism this driver should use. The
27443 default is the value of the generic &%public_name%& option. This option allows
27444 you to use a different underlying mechanism from the advertised name. For
27445 example:
27446 .code
27447 sasl:
27448   driver = cyrus_sasl
27449   public_name = X-ANYTHING
27450   server_mech = CRAM-MD5
27451   server_set_id = $auth1
27452 .endd
27453
27454 .option server_realm cyrus_sasl string&!! unset
27455 This specifies the SASL realm that the server claims to be in.
27456
27457
27458 .option server_service cyrus_sasl string &`smtp`&
27459 This is the SASL service that the server claims to implement.
27460
27461
27462 For straightforward cases, you do not need to set any of the authenticator's
27463 private options. All you need to do is to specify an appropriate mechanism as
27464 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27465 PLAIN, you could have two authenticators as follows:
27466 .code
27467 sasl_cram_md5:
27468   driver = cyrus_sasl
27469   public_name = CRAM-MD5
27470   server_set_id = $auth1
27471
27472 sasl_plain:
27473   driver = cyrus_sasl
27474   public_name = PLAIN
27475   server_set_id = $auth2
27476 .endd
27477 Cyrus SASL does implement the LOGIN authentication method, even though it is
27478 not a standard method. It is disabled by default in the source distribution,
27479 but it is present in many binary distributions.
27480 .ecindex IIDcyrauth1
27481 .ecindex IIDcyrauth2
27482
27483
27484
27485
27486 . ////////////////////////////////////////////////////////////////////////////
27487 . ////////////////////////////////////////////////////////////////////////////
27488 .chapter "The dovecot authenticator" "CHAPdovecot"
27489 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27490 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27491 This authenticator is an interface to the authentication facility of the
27492 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27493 Note that Dovecot must be configured to use auth-client not auth-userdb.
27494 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27495 to use the same mechanisms for SMTP authentication. This is a server
27496 authenticator only. There is only one option:
27497
27498 .option server_socket dovecot string unset
27499
27500 This option must specify the UNIX socket that is the interface to Dovecot
27501 authentication. The &%public_name%& option must specify an authentication
27502 mechanism that Dovecot is configured to support. You can have several
27503 authenticators for different mechanisms. For example:
27504 .code
27505 dovecot_plain:
27506   driver = dovecot
27507   public_name = PLAIN
27508   server_socket = /var/run/dovecot/auth-client
27509   server_set_id = $auth1
27510
27511 dovecot_ntlm:
27512   driver = dovecot
27513   public_name = NTLM
27514   server_socket = /var/run/dovecot/auth-client
27515   server_set_id = $auth1
27516 .endd
27517 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27518 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27519 option is passed in the Dovecot authentication command. If, for a TLS
27520 connection, a client certificate has been verified, the &"valid-client-cert"&
27521 option is passed. When authentication succeeds, the identity of the user
27522 who authenticated is placed in &$auth1$&.
27523
27524 .new
27525 The Dovecot configuration to match the above wil look
27526 something like:
27527 .code
27528 conf.d/10-master.conf :-
27529
27530 service auth {
27531 ...
27532 #SASL
27533   unix_listener auth-client {
27534     mode = 0660
27535     user = mail
27536   }
27537 ...
27538 }
27539
27540 conf.d/10-auth.conf :-
27541
27542 auth_mechanisms = plain login ntlm
27543 .endd
27544 .wen
27545
27546 .ecindex IIDdcotauth1
27547 .ecindex IIDdcotauth2
27548
27549
27550 . ////////////////////////////////////////////////////////////////////////////
27551 . ////////////////////////////////////////////////////////////////////////////
27552 .chapter "The gsasl authenticator" "CHAPgsasl"
27553 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27554 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27555 .cindex "authentication" "GNU SASL"
27556 .cindex "authentication" "SASL"
27557 .cindex "authentication" "EXTERNAL"
27558 .cindex "authentication" "ANONYMOUS"
27559 .cindex "authentication" "PLAIN"
27560 .cindex "authentication" "LOGIN"
27561 .cindex "authentication" "DIGEST-MD5"
27562 .cindex "authentication" "CRAM-MD5"
27563 .cindex "authentication" "SCRAM family"
27564 The &(gsasl)& authenticator provides integration for the GNU SASL
27565 library and the mechanisms it provides.  This is new as of the 4.80 release
27566 and there are a few areas where the library does not let Exim smoothly
27567 scale to handle future authentication mechanisms, so no guarantee can be
27568 made that any particular new authentication mechanism will be supported
27569 without code changes in Exim.
27570
27571 .new
27572 The library is expected to add support in an upcoming
27573 realease for the SCRAM-SHA-256 method.
27574 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27575 when this happens.
27576
27577
27578 .option client_authz gsasl string&!! unset
27579 This option can be used to supply an &'authorization id'&
27580 which is different to the &'authentication_id'& provided
27581 by &%client_username%& option.
27582 If unset or (after expansion) empty it is not used,
27583 which is the common case.
27584
27585 .option client_channelbinding gsasl boolean false
27586 See &%server_channelbinding%& below.
27587
27588 .option client_password gsasl string&!! unset
27589 This option is exapanded before use, and should result in
27590 the password to be used, in clear.
27591
27592 .option client_username gsasl string&!! unset
27593 This option is exapanded before use, and should result in
27594 the account name to be used.
27595 .wen
27596
27597 .new
27598 .option client_spassword gsasl string&!! unset
27599 If a SCRAM mechanism is being used and this option is set
27600 it is used in preference to &%client_password%&.
27601 The value after expansion should be
27602 a 40 (for SHA-1) or 64 (for SHA-256) character string
27603 with the PBKDF2-prepared password, hex-encoded.
27604 Note that this value will depend on the salt and iteration-count
27605 supplied by the server.
27606 .wen
27607
27608
27609
27610 .option server_channelbinding gsasl boolean false
27611 Do not set this true and rely on the properties
27612 without consulting a cryptographic engineer.
27613
27614 Some authentication mechanisms are able to use external context at both ends
27615 of the session to bind the authentication to that context, and fail the
27616 authentication process if that context differs.  Specifically, some TLS
27617 ciphersuites can provide identifying information about the cryptographic
27618 context.
27619
27620 This should have meant that certificate identity and verification becomes a
27621 non-issue, as a man-in-the-middle attack will cause the correct client and
27622 server to see different identifiers and authentication will fail.
27623
27624 .new
27625 This is
27626 only usable by mechanisms which support "channel binding"; at time of
27627 writing, that's the SCRAM family.
27628 When using this feature the "-PLUS" variants of the method names need to be used.
27629 .wen
27630
27631 This defaults off to ensure smooth upgrade across Exim releases, in case
27632 this option causes some clients to start failing.  Some future release
27633 of Exim might have switched the default to be true.
27634
27635 However, Channel Binding in TLS has proven to be vulnerable in current versions.
27636 Do not plan to rely upon this feature for security, ever, without consulting
27637 with a subject matter expert (a cryptographic engineer).
27638
27639
27640 .option server_hostname gsasl string&!! "see below"
27641 This option selects the hostname that is used when communicating with the
27642 library. The default value is &`$primary_hostname`&.
27643 Some mechanisms will use this data.
27644
27645
27646 .option server_mech gsasl string "see below"
27647 This option selects the authentication mechanism this driver should use. The
27648 default is the value of the generic &%public_name%& option. This option allows
27649 you to use a different underlying mechanism from the advertised name. For
27650 example:
27651 .code
27652 sasl:
27653   driver = gsasl
27654   public_name = X-ANYTHING
27655   server_mech = CRAM-MD5
27656   server_set_id = $auth1
27657 .endd
27658
27659
27660 .option server_password gsasl string&!! unset
27661 Various mechanisms need access to the cleartext password on the server, so
27662 that proof-of-possession can be demonstrated on the wire, without sending
27663 the password itself.
27664
27665 The data available for lookup varies per mechanism.
27666 In all cases, &$auth1$& is set to the &'authentication id'&.
27667 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27668 if available, else the empty string.
27669 The &$auth3$& variable will always be the &'realm'& if available,
27670 else the empty string.
27671
27672 A forced failure will cause authentication to defer.
27673
27674 If using this option, it may make sense to set the &%server_condition%&
27675 option to be simply "true".
27676
27677
27678 .option server_realm gsasl string&!! unset
27679 This specifies the SASL realm that the server claims to be in.
27680 Some mechanisms will use this data.
27681
27682
27683 .option server_scram_iter gsasl string&!! 4096
27684 This option provides data for the SCRAM family of mechanisms.
27685 .new
27686 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27687 when this option is expanded.
27688
27689 The result of expansion should be a decimal number,
27690 and represents both a lower-bound on the security, and
27691 a compute cost factor imposed on the client
27692 (if it does not cache results, or the server changes
27693 either the iteration count or the salt).
27694 A minimum value of 4096 is required by the standards
27695 for all current SCRAM mechanism variants.
27696 .wen
27697
27698 .option server_scram_salt gsasl string&!! unset
27699 This option provides data for the SCRAM family of mechanisms.
27700 .new
27701 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27702 when this option is expanded.
27703 The value should be a base64-encoded string,
27704 of random data typically 4-to-16 bytes long.
27705 If unset or empty after expansion the library will provides a value for the
27706 protocol conversation.
27707 .wen
27708
27709
27710 .new
27711 .option server_key gsasl string&!! unset
27712 .option server_skey gsasl string&!! unset
27713 These options can be used for the SCRAM family of mechanisms
27714 to provide stored information related to a password,
27715 the storage of which is preferable to plaintext.
27716
27717 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
27718 &%server_skey%& is StoredKey.
27719
27720 They are only available for version 1.9.0 (or later) of the gsasl library.
27721 When this is so, the macros
27722 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
27723 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
27724 will be defined.
27725
27726 The &$authN$& variables are available when these options are expanded.
27727
27728 If set, the results of expansion should for each
27729 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
27730 of base64-coded data, and will be used in preference to the
27731 &%server_password%& option.
27732 If unset or not of the right length, &%server_password%& will be used.
27733
27734 The libgsasl library release includes a utility &'gsasl'& which can be used
27735 to generate these values.
27736 .wen
27737
27738
27739 .option server_service gsasl string &`smtp`&
27740 This is the SASL service that the server claims to implement.
27741 Some mechanisms will use this data.
27742
27743
27744 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27745 .vindex "&$auth1$&, &$auth2$&, etc"
27746 These may be set when evaluating specific options, as detailed above.
27747 They will also be set when evaluating &%server_condition%&.
27748
27749 Unless otherwise stated below, the &(gsasl)& integration will use the following
27750 meanings for these variables:
27751
27752 .ilist
27753 .vindex "&$auth1$&"
27754 &$auth1$&: the &'authentication id'&
27755 .next
27756 .vindex "&$auth2$&"
27757 &$auth2$&: the &'authorization id'&
27758 .next
27759 .vindex "&$auth3$&"
27760 &$auth3$&: the &'realm'&
27761 .endlist
27762
27763 On a per-mechanism basis:
27764
27765 .ilist
27766 .cindex "authentication" "EXTERNAL"
27767 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27768 the &%server_condition%& option must be present.
27769 .next
27770 .cindex "authentication" "ANONYMOUS"
27771 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27772 the &%server_condition%& option must be present.
27773 .next
27774 .cindex "authentication" "GSSAPI"
27775 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27776 &$auth2$& will be set to the &'authorization id'&,
27777 the &%server_condition%& option must be present.
27778 .endlist
27779
27780 An &'anonymous token'& is something passed along as an unauthenticated
27781 identifier; this is analogous to FTP anonymous authentication passing an
27782 email address, or software-identifier@, as the "password".
27783
27784
27785 An example showing the password having the realm specified in the callback
27786 and demonstrating a Cyrus SASL to GSASL migration approach is:
27787 .code
27788 gsasl_cyrusless_crammd5:
27789   driver = gsasl
27790   public_name = CRAM-MD5
27791   server_realm = imap.example.org
27792   server_password = ${lookup{$auth1:$auth3:userPassword}\
27793                     dbmjz{/etc/sasldb2}{$value}fail}
27794   server_set_id = ${quote:$auth1}
27795   server_condition = yes
27796 .endd
27797
27798
27799 . ////////////////////////////////////////////////////////////////////////////
27800 . ////////////////////////////////////////////////////////////////////////////
27801
27802 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27803 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27804 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27805 .cindex "authentication" "GSSAPI"
27806 .cindex "authentication" "Kerberos"
27807 The &(heimdal_gssapi)& authenticator provides server integration for the
27808 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27809 reliably.
27810
27811 .option server_hostname heimdal_gssapi string&!! "see below"
27812 This option selects the hostname that is used, with &%server_service%&,
27813 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27814 identifier.  The default value is &`$primary_hostname`&.
27815
27816 .option server_keytab heimdal_gssapi string&!! unset
27817 If set, then Heimdal will not use the system default keytab (typically
27818 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27819 The value should be a pathname, with no &"file:"& prefix.
27820
27821 .option server_service heimdal_gssapi string&!! "smtp"
27822 This option specifies the service identifier used, in conjunction with
27823 &%server_hostname%&, for building the identifier for finding credentials
27824 from the keytab.
27825
27826
27827 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27828 Beware that these variables will typically include a realm, thus will appear
27829 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27830 not verified, so a malicious client can set it to anything.
27831
27832 The &$auth1$& field should be safely trustable as a value from the Key
27833 Distribution Center.  Note that these are not quite email addresses.
27834 Each identifier is for a role, and so the left-hand-side may include a
27835 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27836
27837 .vindex "&$auth1$&, &$auth2$&, etc"
27838 .ilist
27839 .vindex "&$auth1$&"
27840 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27841 .next
27842 .vindex "&$auth2$&"
27843 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27844 authentication.  If that was empty, this will also be set to the
27845 GSS Display Name.
27846 .endlist
27847
27848
27849 . ////////////////////////////////////////////////////////////////////////////
27850 . ////////////////////////////////////////////////////////////////////////////
27851
27852 .chapter "The spa authenticator" "CHAPspa"
27853 .scindex IIDspaauth1 "&(spa)& authenticator"
27854 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27855 .cindex "authentication" "Microsoft Secure Password"
27856 .cindex "authentication" "NTLM"
27857 .cindex "Microsoft Secure Password Authentication"
27858 .cindex "NTLM authentication"
27859 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27860 Password Authentication'& mechanism,
27861 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27862 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27863 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27864 server side was subsequently contributed by Tom Kistner. The mechanism works as
27865 follows:
27866
27867 .ilist
27868 After the AUTH command has been accepted, the client sends an SPA
27869 authentication request based on the user name and optional domain.
27870 .next
27871 The server sends back a challenge.
27872 .next
27873 The client builds a challenge response which makes use of the user's password
27874 and sends it to the server, which then accepts or rejects it.
27875 .endlist
27876
27877 Encryption is used to protect the password in transit.
27878
27879
27880
27881 .section "Using spa as a server" "SECID179"
27882 .cindex "options" "&(spa)& authenticator (server)"
27883 The &(spa)& authenticator has just one server option:
27884
27885 .option server_password spa string&!! unset
27886 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27887 This option is expanded, and the result must be the cleartext password for the
27888 authenticating user, whose name is at this point in &$auth1$&. For
27889 compatibility with previous releases of Exim, the user name is also placed in
27890 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27891 it can lead to confusion in string expansions that also use numeric variables
27892 for other things. For example:
27893 .code
27894 spa:
27895   driver = spa
27896   public_name = NTLM
27897   server_password = \
27898     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27899 .endd
27900 If the expansion is forced to fail, authentication fails. Any other expansion
27901 failure causes a temporary error code to be returned.
27902
27903
27904
27905
27906
27907 .section "Using spa as a client" "SECID180"
27908 .cindex "options" "&(spa)& authenticator (client)"
27909 The &(spa)& authenticator has the following client options:
27910
27911
27912
27913 .option client_domain spa string&!! unset
27914 This option specifies an optional domain for the authentication.
27915
27916
27917 .option client_password spa string&!! unset
27918 This option specifies the user's password, and must be set.
27919
27920
27921 .option client_username spa string&!! unset
27922 This option specifies the user name, and must be set. Here is an example of a
27923 configuration of this authenticator for use with the mail servers at
27924 &'msn.com'&:
27925 .code
27926 msn:
27927   driver = spa
27928   public_name = MSN
27929   client_username = msn/msn_username
27930   client_password = msn_plaintext_password
27931   client_domain = DOMAIN_OR_UNSET
27932 .endd
27933 .ecindex IIDspaauth1
27934 .ecindex IIDspaauth2
27935
27936
27937
27938
27939
27940 . ////////////////////////////////////////////////////////////////////////////
27941 . ////////////////////////////////////////////////////////////////////////////
27942
27943 .chapter "The external authenticator" "CHAPexternauth"
27944 .scindex IIDexternauth1 "&(external)& authenticator"
27945 .scindex IIDexternauth2 "authenticators" "&(external)&"
27946 .cindex "authentication" "Client Certificate"
27947 .cindex "authentication" "X509"
27948 .cindex "Certificate-based authentication"
27949 The &(external)& authenticator provides support for
27950 authentication based on non-SMTP information.
27951 The specification is in RFC 4422 Appendix A
27952 (&url(https://tools.ietf.org/html/rfc4422)).
27953 It is only a transport and negotiation mechanism;
27954 the process of authentication is entirely controlled
27955 by the server configuration.
27956
27957 The client presents an identity in-clear.
27958 It is probably wise for a server to only advertise,
27959 and for clients to only attempt,
27960 this authentication method on a secure (eg. under TLS) connection.
27961
27962 One possible use, compatible with the
27963 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27964 is for using X509 client certificates.
27965
27966 It thus overlaps in function with the TLS authenticator
27967 (see &<<CHAPtlsauth>>&)
27968 but is a full SMTP SASL authenticator
27969 rather than being implicit for TLS-connection carried
27970 client certificates only.
27971
27972 The examples and discussion in this chapter assume that
27973 client-certificate authentication is being done.
27974
27975 The client must present a certificate,
27976 for which it must have been requested via the
27977 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27978 (see &<<CHAPTLS>>&).
27979 For authentication to be effective the certificate should be
27980 verifiable against a trust-anchor certificate known to the server.
27981
27982 .section "External options" "SECTexternsoptions"
27983 .cindex "options" "&(external)& authenticator (server)"
27984 The &(external)& authenticator has two server options:
27985
27986 .option server_param2 external string&!! unset
27987 .option server_param3 external string&!! unset
27988 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27989 These options are expanded before the &%server_condition%& option
27990 and the result are placed in &$auth2$& and &$auth3$& resectively.
27991 If the expansion is forced to fail, authentication fails. Any other expansion
27992 failure causes a temporary error code to be returned.
27993
27994 They can be used to clarify the coding of a complex &%server_condition%&.
27995
27996 .section "Using external in a server" "SECTexternserver"
27997 .cindex "AUTH" "in &(external)& authenticator"
27998 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27999         "in &(external)& authenticator"
28000 .vindex "&$auth1$&, &$auth2$&, etc"
28001 .cindex "base64 encoding" "in &(external)& authenticator"
28002
28003 When running as a server, &(external)& performs the authentication test by
28004 expanding a string. The data sent by the client with the AUTH command, or in
28005 response to subsequent prompts, is base64 encoded, and so may contain any byte
28006 values when decoded. The decoded value is treated as
28007 an identity for authentication and
28008 placed in the expansion variable &$auth1$&.
28009
28010 For compatibility with previous releases of Exim, the value is also placed in
28011 the expansion variable &$1$&. However, the use of this
28012 variable for this purpose is now deprecated, as it can lead to confusion in
28013 string expansions that also use them for other things.
28014
28015 .vindex "&$authenticated_id$&"
28016 Once an identity has been received,
28017 &%server_condition%& is expanded. If the expansion is forced to fail,
28018 authentication fails. Any other expansion failure causes a temporary error code
28019 to be returned. If the result of a successful expansion is an empty string,
28020 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28021 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28022 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28023 For any other result, a temporary error code is returned, with the expanded
28024 string as the error text.
28025
28026 Example:
28027 .code
28028 ext_ccert_san_mail:
28029   driver =            external
28030   public_name =       EXTERNAL
28031
28032   server_advertise_condition = $tls_in_certificate_verified
28033   server_param2 =     ${certextract {subj_altname,mail,>:} \
28034                                     {$tls_in_peercert}}
28035   server_condition =  ${if forany {$auth2} \
28036                             {eq {$item}{$auth1}}}
28037   server_set_id =     $auth1
28038 .endd
28039 This accepts a client certificate that is verifiable against any
28040 of your configured trust-anchors
28041 (which usually means the full set of public CAs)
28042 and which has a mail-SAN matching the claimed identity sent by the client.
28043
28044 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28045 The account name is therefore guessable by an opponent.
28046 TLS 1.3 protects both server and client certificates, and is not vulnerable
28047 in this way.
28048
28049
28050 .section "Using external in a client" "SECTexternclient"
28051 .cindex "options" "&(external)& authenticator (client)"
28052 The &(external)& authenticator has one client option:
28053
28054 .option client_send external string&!! unset
28055 This option is expanded and sent with the AUTH command as the
28056 identity being asserted.
28057
28058 Example:
28059 .code
28060 ext_ccert:
28061   driver =      external
28062   public_name = EXTERNAL
28063
28064   client_condition = ${if !eq{$tls_out_cipher}{}}
28065   client_send = myaccount@smarthost.example.net
28066 .endd
28067
28068
28069 .ecindex IIDexternauth1
28070 .ecindex IIDexternauth2
28071
28072
28073
28074
28075
28076 . ////////////////////////////////////////////////////////////////////////////
28077 . ////////////////////////////////////////////////////////////////////////////
28078
28079 .chapter "The tls authenticator" "CHAPtlsauth"
28080 .scindex IIDtlsauth1 "&(tls)& authenticator"
28081 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28082 .cindex "authentication" "Client Certificate"
28083 .cindex "authentication" "X509"
28084 .cindex "Certificate-based authentication"
28085 The &(tls)& authenticator provides server support for
28086 authentication based on client certificates.
28087
28088 It is not an SMTP authentication mechanism and is not
28089 advertised by the server as part of the SMTP EHLO response.
28090 It is an Exim authenticator in the sense that it affects
28091 the protocol element of the log line, can be tested for
28092 by the &%authenticated%& ACL condition, and can set
28093 the &$authenticated_id$& variable.
28094
28095 The client must present a verifiable certificate,
28096 for which it must have been requested via the
28097 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28098 (see &<<CHAPTLS>>&).
28099
28100 If an authenticator of this type is configured it is
28101 run before any SMTP-level communication is done,
28102 and can authenticate the connection.
28103 If it does, SMTP authentication is not offered.
28104
28105 A maximum of one authenticator of this type may be present.
28106
28107
28108 .cindex "options" "&(tls)& authenticator (server)"
28109 The &(tls)& authenticator has three server options:
28110
28111 .option server_param1 tls string&!! unset
28112 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28113 This option is expanded after the TLS negotiation and
28114 the result is placed in &$auth1$&.
28115 If the expansion is forced to fail, authentication fails. Any other expansion
28116 failure causes a temporary error code to be returned.
28117
28118 .option server_param2 tls string&!! unset
28119 .option server_param3 tls string&!! unset
28120 As above, for &$auth2$& and &$auth3$&.
28121
28122 &%server_param1%& may also be spelled &%server_param%&.
28123
28124
28125 Example:
28126 .code
28127 tls:
28128   driver = tls
28129   server_param1 =     ${certextract {subj_altname,mail,>:} \
28130                                     {$tls_in_peercert}}
28131   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28132                                  {forany {$auth1} \
28133                             {!= {0} \
28134                                 {${lookup ldap{ldap:///\
28135                          mailname=${quote_ldap_dn:${lc:$item}},\
28136                          ou=users,LDAP_DC?mailid} {$value}{0} \
28137                        }    }  } }}}
28138   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28139 .endd
28140 This accepts a client certificate that is verifiable against any
28141 of your configured trust-anchors
28142 (which usually means the full set of public CAs)
28143 and which has a SAN with a good account name.
28144
28145 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28146 The account name is therefore guessable by an opponent.
28147 TLS 1.3 protects both server and client certificates, and is not vulnerable
28148 in this way.
28149 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28150
28151 . An alternative might use
28152 . .code
28153 .   server_param1 = ${sha256:$tls_in_peercert}
28154 . .endd
28155 . to require one of a set of specific certs that define a given account
28156 . (the verification is still required, but mostly irrelevant).
28157 . This would help for per-device use.
28158 .
28159 . However, for the future we really need support for checking a
28160 . user cert in LDAP - which probably wants a base-64 DER.
28161
28162 .ecindex IIDtlsauth1
28163 .ecindex IIDtlsauth2
28164
28165
28166 Note that because authentication is traditionally an SMTP operation,
28167 the &%authenticated%& ACL condition cannot be used in
28168 a connect- or helo-ACL.
28169
28170
28171
28172 . ////////////////////////////////////////////////////////////////////////////
28173 . ////////////////////////////////////////////////////////////////////////////
28174
28175 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28176          "Encrypted SMTP connections"
28177 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28178 .scindex IIDencsmtp2 "SMTP" "encryption"
28179 .cindex "TLS" "on SMTP connection"
28180 .cindex "OpenSSL"
28181 .cindex "GnuTLS"
28182 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28183 Sockets Layer), is implemented by making use of the OpenSSL library or the
28184 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28185 cryptographic code in the Exim distribution itself for implementing TLS. In
28186 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28187 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28188 You also need to understand the basic concepts of encryption at a managerial
28189 level, and in particular, the way that public keys, private keys, and
28190 certificates are used.
28191
28192 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28193 connection is established, the client issues a STARTTLS command. If the
28194 server accepts this, the client and the server negotiate an encryption
28195 mechanism. If the negotiation succeeds, the data that subsequently passes
28196 between them is encrypted.
28197
28198 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28199 and if so, what cipher suite is in use, whether the client supplied a
28200 certificate, and whether or not that certificate was verified. This makes it
28201 possible for an Exim server to deny or accept certain commands based on the
28202 encryption state.
28203
28204 &*Warning*&: Certain types of firewall and certain anti-virus products can
28205 disrupt TLS connections. You need to turn off SMTP scanning for these products
28206 in order to get TLS to work.
28207
28208
28209
28210 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28211          "SECID284"
28212 .cindex "submissions protocol"
28213 .cindex "ssmtp protocol"
28214 .cindex "smtps protocol"
28215 .cindex "SMTP" "submissions protocol"
28216 .cindex "SMTP" "ssmtp protocol"
28217 .cindex "SMTP" "smtps protocol"
28218 The history of port numbers for TLS in SMTP is a little messy and has been
28219 contentious.  As of RFC 8314, the common practice of using the historically
28220 allocated port 465 for "email submission but with TLS immediately upon connect
28221 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28222 by them in preference to STARTTLS.
28223
28224 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28225 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28226 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28227
28228 This approach was, for a while, officially abandoned when encrypted SMTP was
28229 standardized, but many clients kept using it, even as the TCP port number was
28230 reassigned for other use.
28231 Thus you may encounter guidance claiming that you shouldn't enable use of
28232 this port.
28233 In practice, a number of mail-clients have only ever supported submissions,
28234 not submission with STARTTLS upgrade.
28235 Ideally, offer both submission (587) and submissions (465) service.
28236
28237 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28238 global option. Its value must be a list of port numbers;
28239 the most common use is expected to be:
28240 .code
28241 tls_on_connect_ports = 465
28242 .endd
28243 The port numbers specified by this option apply to all SMTP connections, both
28244 via the daemon and via &'inetd'&. You still need to specify all the ports that
28245 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28246 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28247 an extra port &-- rather, it specifies different behaviour on a port that is
28248 defined elsewhere.
28249
28250 There is also a &%-tls-on-connect%& command line option. This overrides
28251 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28252
28253
28254
28255
28256
28257
28258 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28259 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28260 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28261 To build Exim to use OpenSSL you need to set
28262 .code
28263 USE_OPENSSL=yes
28264 .endd
28265 in Local/Makefile.
28266
28267 To build Exim to use GnuTLS, you need to set
28268 .code
28269 USE_GNUTLS=yes
28270 .endd
28271 in Local/Makefile.
28272
28273 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28274 include files and libraries for GnuTLS can be found.
28275
28276 There are some differences in usage when using GnuTLS instead of OpenSSL:
28277
28278 .ilist
28279 The &%tls_verify_certificates%& option
28280 cannot be the path of a directory
28281 for GnuTLS versions before 3.3.6
28282 (for later versions, or OpenSSL, it can be either).
28283 .next
28284 The default value for &%tls_dhparam%& differs for historical reasons.
28285 .next
28286 .vindex "&$tls_in_peerdn$&"
28287 .vindex "&$tls_out_peerdn$&"
28288 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28289 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28290 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28291 .next
28292 OpenSSL identifies cipher suites using hyphens as separators, for example:
28293 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28294 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28295 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28296 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28297 to handle its own older variants) when processing lists of cipher suites in the
28298 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28299 option).
28300 .next
28301 The &%tls_require_ciphers%& options operate differently, as described in the
28302 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28303 .next
28304 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28305 When using OpenSSL, this option is ignored.
28306 (If an API is found to let OpenSSL be configured in this way,
28307 let the Exim Maintainers know and we'll likely use it).
28308 .next
28309 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28310 main option, it must be ordered to match the &%tls_certificate%& list.
28311 .next
28312 Some other recently added features may only be available in one or the other.
28313 This should be documented with the feature.  If the documentation does not
28314 explicitly state that the feature is infeasible in the other TLS
28315 implementation, then patches are welcome.
28316 .endlist
28317
28318
28319 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28320 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28321 an explicit path; if the latter, then the text about generation still applies,
28322 but not the chosen filename.
28323 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28324 See the documentation of &%tls_dhparam%& for more information.
28325
28326 GnuTLS uses D-H parameters that may take a substantial amount of time
28327 to compute. It is unreasonable to re-compute them for every TLS session.
28328 Therefore, Exim keeps this data in a file in its spool directory, called
28329 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28330 of bits requested.
28331 The file is owned by the Exim user and is readable only by
28332 its owner. Every Exim process that start up GnuTLS reads the D-H
28333 parameters from this file. If the file does not exist, the first Exim process
28334 that needs it computes the data and writes it to a temporary file which is
28335 renamed once it is complete. It does not matter if several Exim processes do
28336 this simultaneously (apart from wasting a few resources). Once a file is in
28337 place, new Exim processes immediately start using it.
28338
28339 For maximum security, the parameters that are stored in this file should be
28340 recalculated periodically, the frequency depending on your paranoia level.
28341 If you are avoiding using the fixed D-H primes published in RFCs, then you
28342 are concerned about some advanced attacks and will wish to do this; if you do
28343 not regenerate then you might as well stick to the standard primes.
28344
28345 Arranging this is easy in principle; just delete the file when you want new
28346 values to be computed. However, there may be a problem. The calculation of new
28347 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28348 If the system is not very active, &_/dev/random_& may delay returning data
28349 until enough randomness (entropy) is available. This may cause Exim to hang for
28350 a substantial amount of time, causing timeouts on incoming connections.
28351
28352 The solution is to generate the parameters externally to Exim. They are stored
28353 in &_gnutls-params-N_& in PEM format, which means that they can be
28354 generated externally using the &(certtool)& command that is part of GnuTLS.
28355
28356 To replace the parameters with new ones, instead of deleting the file
28357 and letting Exim re-create it, you can generate new parameters using
28358 &(certtool)& and, when this has been done, replace Exim's cache file by
28359 renaming. The relevant commands are something like this:
28360 .code
28361 # ls
28362 [ look for file; assume gnutls-params-2236 is the most recent ]
28363 # rm -f new-params
28364 # touch new-params
28365 # chown exim:exim new-params
28366 # chmod 0600 new-params
28367 # certtool --generate-dh-params --bits 2236 >>new-params
28368 # openssl dhparam -noout -text -in new-params | head
28369 [ check the first line, make sure it's not more than 2236;
28370   if it is, then go back to the start ("rm") and repeat
28371   until the size generated is at most the size requested ]
28372 # chmod 0400 new-params
28373 # mv new-params gnutls-params-2236
28374 .endd
28375 If Exim never has to generate the parameters itself, the possibility of
28376 stalling is removed.
28377
28378 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28379 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28380 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28381 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28382 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28383 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28384 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28385 which applies to all D-H usage, client or server.  If the value returned by
28386 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28387 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28388 limit, which is still much higher than Exim historically used.
28389
28390 The filename and bits used will change as the GnuTLS maintainers change the
28391 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28392 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28393 2432 bits, while NSS is limited to 2236 bits.
28394
28395 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28396 increase the chance of the generated prime actually being within acceptable
28397 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28398 procedure above.  There is no sane procedure available to Exim to double-check
28399 the size of the generated prime, so it might still be too large.
28400
28401
28402 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28403 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28404 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28405 There is a function in the OpenSSL library that can be passed a list of cipher
28406 suites before the cipher negotiation takes place. This specifies which ciphers
28407 are acceptable for TLS versions prior to 1.3.
28408 The list is colon separated and may contain names like
28409 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28410 directly to this function call.
28411 Many systems will install the OpenSSL manual-pages, so you may have
28412 &'ciphers(1)'& available to you.
28413 The following quotation from the OpenSSL
28414 documentation specifies what forms of item are allowed in the cipher string:
28415
28416 .ilist
28417 It can consist of a single cipher suite such as RC4-SHA.
28418 .next
28419 It can represent a list of cipher suites containing a certain algorithm,
28420 or cipher suites of a certain type. For example SHA1 represents all
28421 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28422 SSL v3 algorithms.
28423 .next
28424 Lists of cipher suites can be combined in a single cipher string using
28425 the + character. This is used as a logical and operation. For example
28426 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28427 algorithms.
28428 .endlist
28429
28430 Each cipher string can be optionally preceded by one of the characters &`!`&,
28431 &`-`& or &`+`&.
28432 .ilist
28433 If &`!`& is used, the ciphers are permanently deleted from the list. The
28434 ciphers deleted can never reappear in the list even if they are explicitly
28435 stated.
28436 .next
28437 If &`-`& is used, the ciphers are deleted from the list, but some or all
28438 of the ciphers can be added again by later options.
28439 .next
28440 If &`+`& is used, the ciphers are moved to the end of the list. This
28441 option does not add any new ciphers; it just moves matching existing ones.
28442 .endlist
28443
28444 If none of these characters is present, the string is interpreted as
28445 a list of ciphers to be appended to the current preference list. If the list
28446 includes any ciphers already present they will be ignored: that is, they will
28447 not be moved to the end of the list.
28448 .endlist
28449
28450 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28451 string:
28452 .code
28453 # note single-quotes to get ! past any shell history expansion
28454 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28455 .endd
28456
28457 This example will let the library defaults be permitted on the MX port, where
28458 there's probably no identity verification anyway, but ups the ante on the
28459 submission ports where the administrator might have some influence on the
28460 choice of clients used:
28461 .code
28462 # OpenSSL variant; see man ciphers(1)
28463 tls_require_ciphers = ${if =={$received_port}{25}\
28464                            {DEFAULT}\
28465                            {HIGH:!MD5:!SHA1}}
28466 .endd
28467
28468 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28469 .code
28470 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28471 .endd
28472
28473 For TLS version 1.3 the control available is less fine-grained
28474 and Exim does not provide access to it at present.
28475 The value of the &%tls_require_ciphers%& option is ignored when
28476 TLS version 1.3 is negotiated.
28477
28478 As of writing the library default cipher suite list for TLSv1.3 is
28479 .code
28480 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28481 .endd
28482
28483
28484 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28485          "SECTreqciphgnu"
28486 .cindex "GnuTLS" "specifying parameters for"
28487 .cindex "TLS" "specifying ciphers (GnuTLS)"
28488 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28489 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28490 .cindex "TLS" "specifying protocols (GnuTLS)"
28491 .cindex "TLS" "specifying priority string (GnuTLS)"
28492 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28493 The GnuTLS library allows the caller to provide a "priority string", documented
28494 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28495 ciphersuite specification in OpenSSL.
28496
28497 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28498 and controls both protocols and ciphers.
28499
28500 The &%tls_require_ciphers%& option is available both as an global option,
28501 controlling how Exim behaves as a server, and also as an option of the
28502 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28503 the value is string expanded.  The resulting string is not an Exim list and
28504 the string is given to the GnuTLS library, so that Exim does not need to be
28505 aware of future feature enhancements of GnuTLS.
28506
28507 Documentation of the strings accepted may be found in the GnuTLS manual, under
28508 "Priority strings".  This is online as
28509 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28510 but beware that this relates to GnuTLS 3, which may be newer than the version
28511 installed on your system.  If you are using GnuTLS 3,
28512 then the example code
28513 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28514 on that site can be used to test a given string.
28515
28516 For example:
28517 .code
28518 # Disable older versions of protocols
28519 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28520 .endd
28521
28522 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28523 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28524 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28525
28526 This example will let the library defaults be permitted on the MX port, where
28527 there's probably no identity verification anyway, and lowers security further
28528 by increasing compatibility; but this ups the ante on the submission ports
28529 where the administrator might have some influence on the choice of clients
28530 used:
28531 .code
28532 # GnuTLS variant
28533 tls_require_ciphers = ${if =={$received_port}{25}\
28534                            {NORMAL:%COMPAT}\
28535                            {SECURE128}}
28536 .endd
28537
28538
28539 .section "Configuring an Exim server to use TLS" "SECID182"
28540 .cindex "TLS" "configuring an Exim server"
28541 When Exim has been built with TLS support, it advertises the availability of
28542 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28543 but not to any others. The default value of this option is *, which means
28544 that STARTTLS is always advertised.  Set it to blank to never advertise;
28545 this is reasonable for systems that want to use TLS only as a client.
28546
28547 If STARTTLS is to be used you
28548 need to set some other options in order to make TLS available.
28549
28550 If a client issues a STARTTLS command and there is some configuration
28551 problem in the server, the command is rejected with a 454 error. If the client
28552 persists in trying to issue SMTP commands, all except QUIT are rejected
28553 with the error
28554 .code
28555 554 Security failure
28556 .endd
28557 If a STARTTLS command is issued within an existing TLS session, it is
28558 rejected with a 554 error code.
28559
28560 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28561 must be set to match some hosts. The default is * which matches all hosts.
28562
28563 If this is all you do, TLS encryption will be enabled but not authentication -
28564 meaning that the peer has no assurance it is actually you he is talking to.
28565 You gain protection from a passive sniffer listening on the wire but not
28566 from someone able to intercept the communication.
28567
28568 Further protection requires some further configuration at the server end.
28569
28570 To make TLS work you need to set, in the server,
28571 .code
28572 tls_certificate = /some/file/name
28573 tls_privatekey = /some/file/name
28574 .endd
28575 These options are, in fact, expanded strings, so you can make them depend on
28576 the identity of the client that is connected if you wish. The first file
28577 contains the server's X509 certificate, and the second contains the private key
28578 that goes with it. These files need to be
28579 PEM format and readable by the Exim user, and must
28580 always be given as full path names.
28581 The key must not be password-protected.
28582 They can be the same file if both the
28583 certificate and the key are contained within it. If &%tls_privatekey%& is not
28584 set, or if its expansion is forced to fail or results in an empty string, this
28585 is assumed to be the case. The certificate file may also contain intermediate
28586 certificates that need to be sent to the client to enable it to authenticate
28587 the server's certificate.
28588
28589 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28590 colon-separated lists of file paths.  Ciphers using given authentication
28591 algorithms require the presence of a suitable certificate to supply the
28592 public-key.  The server selects among the certificates to present to the
28593 client depending on the selected cipher, hence the priority ordering for
28594 ciphers will affect which certificate is used.
28595
28596 If you do not understand about certificates and keys, please try to find a
28597 source of this background information, which is not Exim-specific. (There are a
28598 few comments below in section &<<SECTcerandall>>&.)
28599
28600 &*Note*&: These options do not apply when Exim is operating as a client &--
28601 they apply only in the case of a server. If you need to use a certificate in an
28602 Exim client, you must set the options of the same names in an &(smtp)&
28603 transport.
28604
28605 With just these options, an Exim server will be able to use TLS. It does not
28606 require the client to have a certificate (but see below for how to insist on
28607 this). There is one other option that may be needed in other situations. If
28608 .code
28609 tls_dhparam = /some/file/name
28610 .endd
28611 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28612 with the parameters contained in the file.
28613 Set this to &`none`& to disable use of DH entirely, by making no prime
28614 available:
28615 .code
28616 tls_dhparam = none
28617 .endd
28618 This may also be set to a string identifying a standard prime to be used for
28619 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28620 used is &`ike23`&.  There are a few standard primes available, see the
28621 documentation for &%tls_dhparam%& for the complete list.
28622
28623 See the command
28624 .code
28625 openssl dhparam
28626 .endd
28627 for a way of generating file data.
28628
28629 The strings supplied for these three options are expanded every time a client
28630 host connects. It is therefore possible to use different certificates and keys
28631 for different hosts, if you so wish, by making use of the client's IP address
28632 in &$sender_host_address$& to control the expansion. If a string expansion is
28633 forced to fail, Exim behaves as if the option is not set.
28634
28635 .cindex "cipher" "logging"
28636 .cindex "log" "TLS cipher"
28637 .vindex "&$tls_in_cipher$&"
28638 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28639 an incoming TLS connection. It is included in the &'Received:'& header of an
28640 incoming message (by default &-- you can, of course, change this), and it is
28641 also included in the log line that records a message's arrival, keyed by
28642 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28643 condition can be used to test for specific cipher suites in ACLs.
28644
28645 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28646 can check the name of the cipher suite and vary their actions accordingly. The
28647 cipher suite names vary, depending on which TLS library is being used. For
28648 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28649 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28650 documentation for more details.
28651
28652 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28653 (again depending on the &%tls_cipher%& log selector).
28654
28655
28656 .section "Requesting and verifying client certificates" "SECID183"
28657 .cindex "certificate" "verification of client"
28658 .cindex "TLS" "client certificate verification"
28659 If you want an Exim server to request a certificate when negotiating a TLS
28660 session with a client, you must set either &%tls_verify_hosts%& or
28661 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28662 apply to all TLS connections. For any host that matches one of these options,
28663 Exim requests a certificate as part of the setup of the TLS session. The
28664 contents of the certificate are verified by comparing it with a list of
28665 expected trust-anchors or certificates.
28666 These may be the system default set (depending on library version),
28667 an explicit file or,
28668 depending on library version, a directory, identified by
28669 &%tls_verify_certificates%&.
28670
28671 A file can contain multiple certificates, concatenated end to end. If a
28672 directory is used
28673 (OpenSSL only),
28674 each certificate must be in a separate file, with a name (or a symbolic link)
28675 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28676 certificate. You can compute the relevant hash by running the command
28677 .code
28678 openssl x509 -hash -noout -in /cert/file
28679 .endd
28680 where &_/cert/file_& contains a single certificate.
28681
28682 There is no checking of names of the client against the certificate
28683 Subject Name or Subject Alternate Names.
28684
28685 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28686 what happens if the client does not supply a certificate, or if the certificate
28687 does not match any of the certificates in the collection named by
28688 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28689 attempt to set up a TLS session is aborted, and the incoming connection is
28690 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28691 session continues. ACLs that run for subsequent SMTP commands can detect the
28692 fact that no certificate was verified, and vary their actions accordingly. For
28693 example, you can insist on a certificate before accepting a message for
28694 relaying, but not when the message is destined for local delivery.
28695
28696 .vindex "&$tls_in_peerdn$&"
28697 When a client supplies a certificate (whether it verifies or not), the value of
28698 the Distinguished Name of the certificate is made available in the variable
28699 &$tls_in_peerdn$& during subsequent processing of the message.
28700
28701 .cindex "log" "distinguished name"
28702 Because it is often a long text string, it is not included in the log line or
28703 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28704 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28705 &%received_header_text%& to change the &'Received:'& header. When no
28706 certificate is supplied, &$tls_in_peerdn$& is empty.
28707
28708
28709 .section "Revoked certificates" "SECID184"
28710 .cindex "TLS" "revoked certificates"
28711 .cindex "revocation list"
28712 .cindex "certificate" "revocation list"
28713 .cindex "OCSP" "stapling"
28714 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28715 certificates are revoked. If you have such a list, you can pass it to an Exim
28716 server using the global option called &%tls_crl%& and to an Exim client using
28717 an identically named option for the &(smtp)& transport. In each case, the value
28718 of the option is expanded and must then be the name of a file that contains a
28719 CRL in PEM format.
28720 The downside is that clients have to periodically re-download a potentially huge
28721 file from every certificate authority they know of.
28722
28723 The way with most moving parts at query time is Online Certificate
28724 Status Protocol (OCSP), where the client verifies the certificate
28725 against an OCSP server run by the CA.  This lets the CA track all
28726 usage of the certs.  It requires running software with access to the
28727 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28728 is based on HTTP and can be proxied accordingly.
28729
28730 The only widespread OCSP server implementation (known to this writer)
28731 comes as part of OpenSSL and aborts on an invalid request, such as
28732 connecting to the port and then disconnecting.  This requires
28733 re-entering the passphrase each time some random client does this.
28734
28735 The third way is OCSP Stapling; in this, the server using a certificate
28736 issued by the CA periodically requests an OCSP proof of validity from
28737 the OCSP server, then serves it up inline as part of the TLS
28738 negotiation.   This approach adds no extra round trips, does not let the
28739 CA track users, scales well with number of certs issued by the CA and is
28740 resilient to temporary OCSP server failures, as long as the server
28741 starts retrying to fetch an OCSP proof some time before its current
28742 proof expires.  The downside is that it requires server support.
28743
28744 Unless Exim is built with the support disabled,
28745 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28746 support for OCSP stapling is included.
28747
28748 There is a global option called &%tls_ocsp_file%&.
28749 The file specified therein is expected to be in DER format, and contain
28750 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28751 option will be re-expanded for SNI, if the &%tls_certificate%& option
28752 contains &`tls_in_sni`&, as per other TLS options.
28753
28754 Exim does not at this time implement any support for fetching a new OCSP
28755 proof.  The burden is on the administrator to handle this, outside of
28756 Exim.  The file specified should be replaced atomically, so that the
28757 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28758 on each connection, so a new file will be handled transparently on the
28759 next connection.
28760
28761 When built with OpenSSL Exim will check for a valid next update timestamp
28762 in the OCSP proof; if not present, or if the proof has expired, it will be
28763 ignored.
28764
28765 For the client to be able to verify the stapled OCSP the server must
28766 also supply, in its stapled information, any intermediate
28767 certificates for the chain leading to the OCSP proof from the signer
28768 of the server certificate.  There may be zero or one such. These
28769 intermediate certificates should be added to the server OCSP stapling
28770 file named by &%tls_ocsp_file%&.
28771
28772 Note that the proof only covers the terminal server certificate,
28773 not any of the chain from CA to it.
28774
28775 There is no current way to staple a proof for a client certificate.
28776
28777 .code
28778   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28779   OCSP server is supplied.  The server URL may be included in the
28780   server certificate, if the CA is helpful.
28781
28782   One failure mode seen was the OCSP Signer cert expiring before the end
28783   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28784   noted this as invalid overall, but the re-fetch script did not.
28785 .endd
28786
28787
28788
28789
28790 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28791 .cindex "cipher" "logging"
28792 .cindex "log" "TLS cipher"
28793 .cindex "log" "distinguished name"
28794 .cindex "TLS" "configuring an Exim client"
28795 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28796 deliveries as well as to incoming, the latter one causing logging of the
28797 server certificate's DN. The remaining client configuration for TLS is all
28798 within the &(smtp)& transport.
28799
28800 It is not necessary to set any options to have TLS work in the &(smtp)&
28801 transport. If Exim is built with TLS support, and TLS is advertised by a
28802 server, the &(smtp)& transport always tries to start a TLS session. However,
28803 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28804 transport) to a list of server hosts for which TLS should not be used.
28805
28806 If you do not want Exim to attempt to send messages unencrypted when an attempt
28807 to set up an encrypted connection fails in any way, you can set
28808 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28809 those hosts, delivery is always deferred if an encrypted connection cannot be
28810 set up. If there are any other hosts for the address, they are tried in the
28811 usual way.
28812
28813 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28814 the message unencrypted. It always does this if the response to STARTTLS is
28815 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28816 session after a success response code, what happens is controlled by the
28817 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28818 delivery to this host is deferred, and other hosts (if available) are tried. If
28819 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28820 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28821 negotiation fails, Exim closes the current connection (because it is in an
28822 unknown state), opens a new one to the same host, and then tries the delivery
28823 unencrypted.
28824
28825 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28826 transport provide the client with a certificate, which is passed to the server
28827 if it requests it. If the server is Exim, it will request a certificate only if
28828 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28829
28830 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
28831 for client use (they are usable for server use).
28832 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
28833 in failed connections.
28834
28835 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28836 specifies a collection of expected server certificates.
28837 These may be
28838 the system default set (depending on library version),
28839 a file,
28840 or (depending on library version) a directory.
28841 The client verifies the server's certificate
28842 against this collection, taking into account any revoked certificates that are
28843 in the list defined by &%tls_crl%&.
28844 Failure to verify fails the TLS connection unless either of the
28845 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28846
28847 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28848 certificate verification to the listed servers.  Verification either must
28849 or need not succeed respectively.
28850
28851 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28852 checks are made: that the host name (the one in the DNS A record)
28853 is valid for the certificate.
28854 The option defaults to always checking.
28855
28856 The &(smtp)& transport has two OCSP-related options:
28857 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28858 is requested and required for the connection to proceed.  The default
28859 value is empty.
28860 &%hosts_request_ocsp%&; a host-list for which (additionally)
28861 a Certificate Status is requested (but not necessarily verified).  The default
28862 value is "*" meaning that requests are made unless configured
28863 otherwise.
28864
28865 The host(s) should also be in &%hosts_require_tls%&, and
28866 &%tls_verify_certificates%& configured for the transport,
28867 for OCSP to be relevant.
28868
28869 If
28870 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28871 list of permitted cipher suites. If either of these checks fails, delivery to
28872 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28873 alternative hosts, if any.
28874
28875  &*Note*&:
28876 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28877 is operating as a client. Exim does not assume that a server certificate (set
28878 by the global options of the same name) should also be used when operating as a
28879 client.
28880
28881 .vindex "&$host$&"
28882 .vindex "&$host_address$&"
28883 All the TLS options in the &(smtp)& transport are expanded before use, with
28884 &$host$& and &$host_address$& containing the name and address of the server to
28885 which the client is connected. Forced failure of an expansion causes Exim to
28886 behave as if the relevant option were unset.
28887
28888 .vindex &$tls_out_bits$&
28889 .vindex &$tls_out_cipher$&
28890 .vindex &$tls_out_peerdn$&
28891 .vindex &$tls_out_sni$&
28892 Before an SMTP connection is established, the
28893 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28894 variables are emptied. (Until the first connection, they contain the values
28895 that were set when the message was received.) If STARTTLS is subsequently
28896 successfully obeyed, these variables are set to the relevant values for the
28897 outgoing connection.
28898
28899
28900
28901 .section "Use of TLS Server Name Indication" "SECTtlssni"
28902 .cindex "TLS" "Server Name Indication"
28903 .vindex "&$tls_in_sni$&"
28904 .oindex "&%tls_in_sni%&"
28905 With TLS1.0 or above, there is an extension mechanism by which extra
28906 information can be included at various points in the protocol.  One of these
28907 extensions, documented in RFC 6066 (and before that RFC 4366) is
28908 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28909 client in the initial handshake, so that the server can examine the servername
28910 within and possibly choose to use different certificates and keys (and more)
28911 for this session.
28912
28913 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28914 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28915 address.
28916
28917 With SMTP to MX, there are the same problems here as in choosing the identity
28918 against which to validate a certificate: you can't rely on insecure DNS to
28919 provide the identity which you then cryptographically verify.  So this will
28920 be of limited use in that environment.
28921
28922 With SMTP to Submission, there is a well-defined hostname which clients are
28923 connecting to and can validate certificates against.  Thus clients &*can*&
28924 choose to include this information in the TLS negotiation.  If this becomes
28925 wide-spread, then hosters can choose to present different certificates to
28926 different clients.  Or even negotiate different cipher suites.
28927
28928 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28929 if not empty, will be sent on a TLS session as part of the handshake.  There's
28930 nothing more to it.  Choosing a sensible value not derived insecurely is the
28931 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28932 for the lifetime of the client connection (including during authentication).
28933
28934 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28935 received from a client.
28936 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28937
28938 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28939 option (prior to expansion) then the following options will be re-expanded
28940 during TLS session handshake, to permit alternative values to be chosen:
28941
28942 .ilist
28943 &%tls_certificate%&
28944 .next
28945 &%tls_crl%&
28946 .next
28947 &%tls_privatekey%&
28948 .next
28949 &%tls_verify_certificates%&
28950 .next
28951 &%tls_ocsp_file%&
28952 .endlist
28953
28954 Great care should be taken to deal with matters of case, various injection
28955 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28956 can always be referenced; it is important to remember that &$tls_in_sni$& is
28957 arbitrary unverified data provided prior to authentication.
28958 Further, the initial certificate is loaded before SNI has arrived, so
28959 an expansion for &%tls_certificate%& must have a default which is used
28960 when &$tls_in_sni$& is empty.
28961
28962 The Exim developers are proceeding cautiously and so far no other TLS options
28963 are re-expanded.
28964
28965 When Exim is built against OpenSSL, OpenSSL must have been built with support
28966 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28967 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28968 see &`-servername`& in the output, then OpenSSL has support.
28969
28970 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28971 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28972 built, then you have SNI support).
28973
28974
28975
28976 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28977          "SECTmulmessam"
28978 .cindex "multiple SMTP deliveries with TLS"
28979 .cindex "TLS" "multiple message deliveries"
28980 Exim sends multiple messages down the same TCP/IP connection by starting up
28981 an entirely new delivery process for each message, passing the socket from
28982 one process to the next. This implementation does not fit well with the use
28983 of TLS, because there is quite a lot of state information associated with a TLS
28984 connection, not just a socket identification. Passing all the state information
28985 to a new process is not feasible. Consequently, for sending using TLS Exim
28986 starts an additional proxy process for handling the encryption, piping the
28987 unencrypted data stream from and to the delivery processes.
28988
28989 An older mode of operation can be enabled on a per-host basis by the
28990 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28991 this list the proxy process described above is not used; instead Exim
28992 shuts down an existing TLS session being run by the delivery process
28993 before passing the socket to a new process. The new process may then
28994 try to start a new TLS session, and if successful, may try to re-authenticate
28995 if AUTH is in use, before sending the next message.
28996
28997 The RFC is not clear as to whether or not an SMTP session continues in clear
28998 after TLS has been shut down, or whether TLS may be restarted again later, as
28999 just described. However, if the server is Exim, this shutdown and
29000 reinitialization works. It is not known which (if any) other servers operate
29001 successfully if the client closes a TLS session and continues with unencrypted
29002 SMTP, but there are certainly some that do not work. For such servers, Exim
29003 should not pass the socket to another process, because the failure of the
29004 subsequent attempt to use it would cause Exim to record a temporary host error,
29005 and delay other deliveries to that host.
29006
29007 To test for this case, Exim sends an EHLO command to the server after
29008 closing down the TLS session. If this fails in any way, the connection is
29009 closed instead of being passed to a new delivery process, but no retry
29010 information is recorded.
29011
29012 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29013 &(smtp)& transport to match those hosts for which Exim should not pass
29014 connections to new processes if TLS has been used.
29015
29016
29017
29018
29019 .section "Certificates and all that" "SECTcerandall"
29020 .cindex "certificate" "references to discussion"
29021 In order to understand fully how TLS works, you need to know about
29022 certificates, certificate signing, and certificate authorities.
29023 This is a large topic and an introductory guide is unsuitable for the Exim
29024 reference manual, so instead we provide pointers to existing documentation.
29025
29026 The Apache web-server was for a long time the canonical guide, so their
29027 documentation is a good place to start; their SSL module's Introduction
29028 document is currently at
29029 .display
29030 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29031 .endd
29032 and their FAQ is at
29033 .display
29034 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29035 .endd
29036
29037 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29038 0-201-61598-3) in 2001, contains both introductory and more in-depth
29039 descriptions.
29040 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29041 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29042 Ivan is the author of the popular TLS testing tools at
29043 &url(https://www.ssllabs.com/).
29044
29045
29046 .section "Certificate chains" "SECID186"
29047 The file named by &%tls_certificate%& may contain more than one
29048 certificate. This is useful in the case where the certificate that is being
29049 sent is validated by an intermediate certificate which the other end does
29050 not have. Multiple certificates must be in the correct order in the file.
29051 First the host's certificate itself, then the first intermediate
29052 certificate to validate the issuer of the host certificate, then the next
29053 intermediate certificate to validate the issuer of the first intermediate
29054 certificate, and so on, until finally (optionally) the root certificate.
29055 The root certificate must already be trusted by the recipient for
29056 validation to succeed, of course, but if it's not preinstalled, sending the
29057 root certificate along with the rest makes it available for the user to
29058 install if the receiving end is a client MUA that can interact with a user.
29059
29060 Note that certificates using MD5 are unlikely to work on today's Internet;
29061 even if your libraries allow loading them for use in Exim when acting as a
29062 server, increasingly clients will not accept such certificates.  The error
29063 diagnostics in such a case can be frustratingly vague.
29064
29065
29066
29067 .section "Self-signed certificates" "SECID187"
29068 .cindex "certificate" "self-signed"
29069 You can create a self-signed certificate using the &'req'& command provided
29070 with OpenSSL, like this:
29071 . ==== Do not shorten the duration here without reading and considering
29072 . ==== the text below.  Please leave it at 9999 days.
29073 .code
29074 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29075             -days 9999 -nodes
29076 .endd
29077 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29078 delimited and so can be identified independently. The &%-days%& option
29079 specifies a period for which the certificate is valid. The &%-nodes%& option is
29080 important: if you do not set it, the key is encrypted with a passphrase
29081 that you are prompted for, and any use that is made of the key causes more
29082 prompting for the passphrase. This is not helpful if you are going to use
29083 this certificate and key in an MTA, where prompting is not possible.
29084
29085 . ==== I expect to still be working 26 years from now.  The less technical
29086 . ==== debt I create, in terms of storing up trouble for my later years, the
29087 . ==== happier I will be then.  We really have reached the point where we
29088 . ==== should start, at the very least, provoking thought and making folks
29089 . ==== pause before proceeding, instead of leaving all the fixes until two
29090 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29091 . ==== -pdp, 2012
29092 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29093 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29094 the above command might produce a date in the past.  Think carefully about
29095 the lifetime of the systems you're deploying, and either reduce the duration
29096 of the certificate or reconsider your platform deployment.  (At time of
29097 writing, reducing the duration is the most likely choice, but the inexorable
29098 progression of time takes us steadily towards an era where this will not
29099 be a sensible resolution).
29100
29101 A self-signed certificate made in this way is sufficient for testing, and
29102 may be adequate for all your requirements if you are mainly interested in
29103 encrypting transfers, and not in secure identification.
29104
29105 However, many clients require that the certificate presented by the server be a
29106 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29107 certificate. In this situation, the self-signed certificate described above
29108 must be installed on the client host as a trusted root &'certification
29109 authority'& (CA), and the certificate used by Exim must be a user certificate
29110 signed with that self-signed certificate.
29111
29112 For information on creating self-signed CA certificates and using them to sign
29113 user certificates, see the &'General implementation overview'& chapter of the
29114 Open-source PKI book, available online at
29115 &url(https://sourceforge.net/projects/ospkibook/).
29116 .ecindex IIDencsmtp1
29117 .ecindex IIDencsmtp2
29118
29119
29120
29121 .section DANE "SECDANE"
29122 .cindex DANE
29123 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29124 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29125 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29126 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29127 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29128 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29129
29130 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29131 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29132 by (a) is thought to be smaller than that of the set of root CAs.
29133
29134 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29135 fail to pass on a server's STARTTLS.
29136
29137 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29138 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29139 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29140
29141 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29142 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29143 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29144 DNSSEC.
29145 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29146 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29147
29148 There are no changes to Exim specific to server-side operation of DANE.
29149 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29150 in &_Local/Makefile_&.
29151 If it has been included, the macro "_HAVE_DANE" will be defined.
29152
29153 A TLSA record consist of 4 fields, the "Certificate Usage", the
29154 "Selector", the "Matching type", and the "Certificate Association Data".
29155 For a detailed description of the TLSA record see
29156 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29157
29158 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29159 These are the "Trust Anchor" and "End Entity" variants.
29160 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29161 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29162 this is appropriate for a single system, using a self-signed certificate.
29163 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29164 well-known one.
29165 A private CA at simplest is just a self-signed certificate (with certain
29166 attributes) which is used to sign server certificates, but running one securely
29167 does require careful arrangement.
29168 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29169 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29170 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29171 all of which point to a single TLSA record.
29172 DANE-TA and DANE-EE can both be used together.
29173
29174 Our recommendation is to use DANE with a certificate from a public CA,
29175 because this enables a variety of strategies for remote clients to verify
29176 your certificate.
29177 You can then publish information both via DANE and another technology,
29178 "MTA-STS", described below.
29179
29180 When you use DANE-TA to publish trust anchor information, you ask entities
29181 outside your administrative control to trust the Certificate Authority for
29182 connections to you.
29183 If using a private CA then you should expect others to still apply the
29184 technical criteria they'd use for a public CA to your certificates.
29185 In particular, you should probably try to follow current best practices for CA
29186 operation around hash algorithms and key sizes.
29187 Do not expect other organizations to lower their security expectations just
29188 because a particular profile might be reasonable for your own internal use.
29189
29190 When this text was last updated, this in practice means to avoid use of SHA-1
29191 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29192 than 4096, for interoperability); to use keyUsage fields correctly; to use
29193 random serial numbers.
29194 The list of requirements is subject to change as best practices evolve.
29195 If you're not already using a private CA, or it doesn't meet these
29196 requirements, then we encourage you to avoid all these issues and use a public
29197 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29198
29199 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29200 a "Matching Type" (3rd) field of SHA2-512(2).
29201
29202 For the "Certificate Authority Data" (4th) field, commands like
29203
29204 .code
29205   openssl x509 -pubkey -noout <certificate.pem \
29206   | openssl rsa -outform der -pubin 2>/dev/null \
29207   | openssl sha512 \
29208   | awk '{print $2}'
29209 .endd
29210
29211 are workable to create a hash of the certificate's public key.
29212
29213 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29214
29215 .code
29216   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29217 .endd
29218
29219 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29220 is useful for quickly generating TLSA records.
29221
29222
29223 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29224
29225 The Certificate issued by the CA published in the DANE-TA model should be
29226 issued using a strong hash algorithm.
29227 Exim, and importantly various other MTAs sending to you, will not
29228 re-enable hash algorithms which have been disabled by default in TLS
29229 libraries.
29230 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29231 interoperability (and probably the maximum too, in 2018).
29232
29233 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29234 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29235 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29236
29237 .code
29238   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29239                                  {= {4}{$tls_out_tlsa_usage}} } \
29240                          {*}{}}
29241 .endd
29242
29243 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29244 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29245 found. If the definition of &%hosts_request_ocsp%& includes the
29246 string "tls_out_tlsa_usage", they are re-expanded in time to
29247 control the OCSP request.
29248
29249 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29250 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29251
29252
29253 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29254 and &%dane_require_tls_ciphers%&.
29255 The &"require"& variant will result in failure if the target host is not
29256 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29257 the &%dnssec_request_domains%& router or transport option.
29258
29259 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29260
29261 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29262 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29263 will be required for the host.  If it does not, the host will not
29264 be used; there is no fallback to non-DANE or non-TLS.
29265
29266 If DANE is requested and usable, then the TLS cipher list configuration
29267 prefers to use the option &%dane_require_tls_ciphers%& and falls
29268 back to &%tls_require_ciphers%& only if that is unset.
29269 This lets you configure "decent crypto" for DANE and "better than nothing
29270 crypto" as the default.  Note though that while GnuTLS lets the string control
29271 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29272 limited to ciphersuite constraints.
29273
29274 If DANE is requested and useable (see above) the following transport options are ignored:
29275 .code
29276   hosts_require_tls
29277   tls_verify_hosts
29278   tls_try_verify_hosts
29279   tls_verify_certificates
29280   tls_crl
29281   tls_verify_cert_hostnames
29282 .endd
29283
29284 If DANE is not usable, whether requested or not, and CA-anchored
29285 verification evaluation is wanted, the above variables should be set appropriately.
29286
29287 The router and transport option &%dnssec_request_domains%& must not be
29288 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29289
29290 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29291
29292 There is a new variable &$tls_out_dane$& which will have "yes" if
29293 verification succeeded using DANE and "no" otherwise (only useful
29294 in combination with events; see &<<CHAPevents>>&),
29295 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29296
29297 .cindex DANE reporting
29298 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29299 to achieve DANE-verified connection, if one was either requested and offered, or
29300 required.  This is intended to support TLS-reporting as defined in
29301 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29302 The &$event_data$& will be one of the Result Types defined in
29303 Section 4.3 of that document.
29304
29305 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29306
29307 DANE is specified in published RFCs and decouples certificate authority trust
29308 selection from a "race to the bottom" of "you must trust everything for mail
29309 to get through".  There is an alternative technology called MTA-STS, which
29310 instead publishes MX trust anchor information on an HTTPS website.  At the
29311 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29312 Exim has no support for MTA-STS as a client, but Exim mail server operators
29313 can choose to publish information describing their TLS configuration using
29314 MTA-STS to let those clients who do use that protocol derive trust
29315 information.
29316
29317 The MTA-STS design requires a certificate from a public Certificate Authority
29318 which is recognized by clients sending to you.
29319 That selection of which CAs are trusted by others is outside your control.
29320
29321 The most interoperable course of action is probably to use
29322 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29323 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29324 records for DANE clients (such as Exim and Postfix) and to publish anchor
29325 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29326 domain itself (with caveats around occasionally broken MTA-STS because of
29327 incompatible specification changes prior to reaching RFC status).
29328
29329
29330
29331 . ////////////////////////////////////////////////////////////////////////////
29332 . ////////////////////////////////////////////////////////////////////////////
29333
29334 .chapter "Access control lists" "CHAPACL"
29335 .scindex IIDacl "&ACL;" "description"
29336 .cindex "control of incoming mail"
29337 .cindex "message" "controlling incoming"
29338 .cindex "policy control" "access control lists"
29339 Access Control Lists (ACLs) are defined in a separate section of the runtime
29340 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29341 name, terminated by a colon. Here is a complete ACL section that contains just
29342 one very small ACL:
29343 .code
29344 begin acl
29345 small_acl:
29346   accept   hosts = one.host.only
29347 .endd
29348 You can have as many lists as you like in the ACL section, and the order in
29349 which they appear does not matter. The lists are self-terminating.
29350
29351 The majority of ACLs are used to control Exim's behaviour when it receives
29352 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29353 when a local process submits a message using SMTP by specifying the &%-bs%&
29354 option. The most common use is for controlling which recipients are accepted
29355 in incoming messages. In addition, you can define an ACL that is used to check
29356 local non-SMTP messages. The default configuration file contains an example of
29357 a realistic ACL for checking RCPT commands. This is discussed in chapter
29358 &<<CHAPdefconfil>>&.
29359
29360
29361 .section "Testing ACLs" "SECID188"
29362 The &%-bh%& command line option provides a way of testing your ACL
29363 configuration locally by running a fake SMTP session with which you interact.
29364
29365
29366 .section "Specifying when ACLs are used" "SECID189"
29367 .cindex "&ACL;" "options for specifying"
29368 In order to cause an ACL to be used, you have to name it in one of the relevant
29369 options in the main part of the configuration. These options are:
29370 .cindex "AUTH" "ACL for"
29371 .cindex "DATA" "ACLs for"
29372 .cindex "ETRN" "ACL for"
29373 .cindex "EXPN" "ACL for"
29374 .cindex "HELO" "ACL for"
29375 .cindex "EHLO" "ACL for"
29376 .cindex "DKIM" "ACL for"
29377 .cindex "MAIL" "ACL for"
29378 .cindex "QUIT, ACL for"
29379 .cindex "RCPT" "ACL for"
29380 .cindex "STARTTLS, ACL for"
29381 .cindex "VRFY" "ACL for"
29382 .cindex "SMTP" "connection, ACL for"
29383 .cindex "non-SMTP messages" "ACLs for"
29384 .cindex "MIME content scanning" "ACL for"
29385 .cindex "PRDR" "ACL for"
29386
29387 .table2 140pt
29388 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29389 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29390 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29391 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29392 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29393 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29394 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29395 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29396 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29397 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29398 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29399 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29400 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29401 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29402 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29403 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29404 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29405 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29406 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29407 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29408 .endtable
29409
29410 For example, if you set
29411 .code
29412 acl_smtp_rcpt = small_acl
29413 .endd
29414 the little ACL defined above is used whenever Exim receives a RCPT command
29415 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29416 done when RCPT commands arrive. A rejection of RCPT should cause the
29417 sending MTA to give up on the recipient address contained in the RCPT
29418 command, whereas rejection at other times may cause the client MTA to keep on
29419 trying to deliver the message. It is therefore recommended that you do as much
29420 testing as possible at RCPT time.
29421
29422
29423 .section "The non-SMTP ACLs" "SECID190"
29424 .cindex "non-SMTP messages" "ACLs for"
29425 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29426 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29427 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29428 the state of the SMTP connection such as encryption and authentication) are not
29429 relevant and are forbidden in these ACLs. However, the sender and recipients
29430 are known, so the &%senders%& and &%sender_domains%& conditions and the
29431 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29432 &$authenticated_sender$& are also available. You can specify added header lines
29433 in any of these ACLs.
29434
29435 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29436 non-SMTP message, before any of the message has been read. (This is the
29437 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29438 batched SMTP input, it runs after the DATA command has been reached. The
29439 result of this ACL is ignored; it cannot be used to reject a message. If you
29440 really need to, you could set a value in an ACL variable here and reject based
29441 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29442 controls, and in particular, it can be used to set
29443 .code
29444 control = suppress_local_fixups
29445 .endd
29446 This cannot be used in the other non-SMTP ACLs because by the time they are
29447 run, it is too late.
29448
29449 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29450 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29451
29452 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29453 kind of rejection is treated as permanent, because there is no way of sending a
29454 temporary error for these kinds of message.
29455
29456
29457 .section "The SMTP connect ACL" "SECID191"
29458 .cindex "SMTP" "connection, ACL for"
29459 .oindex &%smtp_banner%&
29460 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29461 session, after the test specified by &%host_reject_connection%& (which is now
29462 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29463 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29464 the message override the banner message that is otherwise specified by the
29465 &%smtp_banner%& option.
29466
29467
29468 .section "The EHLO/HELO ACL" "SECID192"
29469 .cindex "EHLO" "ACL for"
29470 .cindex "HELO" "ACL for"
29471 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29472 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29473 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29474 Note that a client may issue more than one EHLO or HELO command in an SMTP
29475 session, and indeed is required to issue a new EHLO or HELO after successfully
29476 setting up encryption following a STARTTLS command.
29477
29478 Note also that a deny neither forces the client to go away nor means that
29479 mail will be refused on the connection.  Consider checking for
29480 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29481
29482 If the command is accepted by an &%accept%& verb that has a &%message%&
29483 modifier, the message may not contain more than one line (it will be truncated
29484 at the first newline and a panic logged if it does). Such a message cannot
29485 affect the EHLO options that are listed on the second and subsequent lines of
29486 an EHLO response.
29487
29488
29489 .section "The DATA ACLs" "SECID193"
29490 .cindex "DATA" "ACLs for"
29491 Two ACLs are associated with the DATA command, because it is two-stage
29492 command, with two responses being sent to the client.
29493 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29494 is obeyed. This gives you control after all the RCPT commands, but before
29495 the message itself is received. It offers the opportunity to give a negative
29496 response to the DATA command before the data is transmitted. Header lines
29497 added by MAIL or RCPT ACLs are not visible at this time, but any that
29498 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29499
29500 You cannot test the contents of the message, for example, to verify addresses
29501 in the headers, at RCPT time or when the DATA command is received. Such
29502 tests have to appear in the ACL that is run after the message itself has been
29503 received, before the final response to the DATA command is sent. This is
29504 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29505 associated with the DATA command.
29506
29507 .cindex CHUNKING "BDAT command"
29508 .cindex BDAT "SMTP command"
29509 .cindex "RFC 3030" CHUNKING
29510 If CHUNKING was advertised and a BDAT command sequence is received,
29511 the &%acl_smtp_predata%& ACL is not run.
29512 . XXX why not?  It should be possible, for the first BDAT.
29513 The &%acl_smtp_data%& is run after the last BDAT command and all of
29514 the data specified is received.
29515
29516 For both of these ACLs, it is not possible to reject individual recipients. An
29517 error response rejects the entire message. Unfortunately, it is known that some
29518 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29519 before or after the data) correctly &-- they keep the message on their queues
29520 and try again later, but that is their problem, though it does waste some of
29521 your resources.
29522
29523 The &%acl_smtp_data%& ACL is run after
29524 the &%acl_smtp_data_prdr%&,
29525 the &%acl_smtp_dkim%&
29526 and the &%acl_smtp_mime%& ACLs.
29527
29528 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29529 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29530 enabled (which is the default).
29531
29532 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29533 received, and is executed for each DKIM signature found in a message.  If not
29534 otherwise specified, the default action is to accept.
29535
29536 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29537
29538 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29539
29540
29541 .section "The SMTP MIME ACL" "SECID194"
29542 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29543 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29544
29545 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29546
29547
29548 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29549 .cindex "PRDR" "ACL for"
29550 .oindex "&%prdr_enable%&"
29551 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29552 with PRDR support enabled (which is the default).
29553 It becomes active only when the PRDR feature is negotiated between
29554 client and server for a message, and more than one recipient
29555 has been accepted.
29556
29557 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29558 has been received, and is executed once for each recipient of the message
29559 with &$local_part$& and &$domain$& valid.
29560 The test may accept, defer or deny for individual recipients.
29561 The &%acl_smtp_data%& will still be called after this ACL and
29562 can reject the message overall, even if this ACL has accepted it
29563 for some or all recipients.
29564
29565 PRDR may be used to support per-user content filtering.  Without it
29566 one must defer any recipient after the first that has a different
29567 content-filter configuration.  With PRDR, the RCPT-time check
29568 .cindex "PRDR" "variable for"
29569 for this can be disabled when the variable &$prdr_requested$&
29570 is &"yes"&.
29571 Any required difference in behaviour of the main DATA-time
29572 ACL should however depend on the PRDR-time ACL having run, as Exim
29573 will avoid doing so in some situations (e.g. single-recipient mails).
29574
29575 See also the &%prdr_enable%& global option
29576 and the &%hosts_try_prdr%& smtp transport option.
29577
29578 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29579 If the ACL is not defined, processing completes as if
29580 the feature was not requested by the client.
29581
29582 .section "The QUIT ACL" "SECTQUITACL"
29583 .cindex "QUIT, ACL for"
29584 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29585 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29586 does not in fact control any access.
29587 For this reason, it may only accept
29588 or warn as its final result.
29589
29590 This ACL can be used for tasks such as custom logging at the end of an SMTP
29591 session. For example, you can use ACL variables in other ACLs to count
29592 messages, recipients, etc., and log the totals at QUIT time using one or
29593 more &%logwrite%& modifiers on a &%warn%& verb.
29594
29595 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29596 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29597
29598 You do not need to have a final &%accept%&, but if you do, you can use a
29599 &%message%& modifier to specify custom text that is sent as part of the 221
29600 response to QUIT.
29601
29602 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29603 failure (for example, failure to open a log file, or when Exim is bombing out
29604 because it has detected an unrecoverable error), all SMTP commands from the
29605 client are given temporary error responses until QUIT is received or the
29606 connection is closed. In these special cases, the QUIT ACL does not run.
29607
29608
29609 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29610 .vindex &$acl_smtp_notquit$&
29611 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29612 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29613 trouble, such as being unable to write to its log files, this ACL is not run,
29614 because it might try to do things (such as write to log files) that make the
29615 situation even worse.
29616
29617 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29618 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29619 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29620 and &%warn%&.
29621
29622 .vindex &$smtp_notquit_reason$&
29623 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29624 to a string that indicates the reason for the termination of the SMTP
29625 connection. The possible values are:
29626 .table2
29627 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29628 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29629 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29630 .irow &`connection-lost`&          "The SMTP connection has been lost"
29631 .irow &`data-timeout`&             "Timeout while reading message data"
29632 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29633 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29634 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29635 .irow &`synchronization-error`&    "SMTP synchronization error"
29636 .irow &`tls-failed`&               "TLS failed to start"
29637 .endtable
29638 In most cases when an SMTP connection is closed without having received QUIT,
29639 Exim sends an SMTP response message before actually closing the connection.
29640 With the exception of the &`acl-drop`& case, the default message can be
29641 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29642 &%drop%& verb in another ACL, it is the message from the other ACL that is
29643 used.
29644
29645
29646 .section "Finding an ACL to use" "SECID195"
29647 .cindex "&ACL;" "finding which to use"
29648 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29649 you can use different ACLs in different circumstances. For example,
29650 .code
29651 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29652                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29653 .endd
29654 In the default configuration file there are some example settings for
29655 providing an RFC 4409 message &"submission"& service on port 587 and
29656 an RFC 8314 &"submissions"& service on port 465. You can use a string
29657 expansion like this to choose an ACL for MUAs on these ports which is
29658 more appropriate for this purpose than the default ACL on port 25.
29659
29660 The expanded string does not have to be the name of an ACL in the
29661 configuration file; there are other possibilities. Having expanded the
29662 string, Exim searches for an ACL as follows:
29663
29664 .ilist
29665 If the string begins with a slash, Exim uses it as a filename, and reads its
29666 contents as an ACL. The lines are processed in the same way as lines in the
29667 Exim configuration file. In particular, continuation lines are supported, blank
29668 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29669 If the file does not exist or cannot be read, an error occurs (typically
29670 causing a temporary failure of whatever caused the ACL to be run). For example:
29671 .code
29672 acl_smtp_data = /etc/acls/\
29673   ${lookup{$sender_host_address}lsearch\
29674   {/etc/acllist}{$value}{default}}
29675 .endd
29676 This looks up an ACL file to use on the basis of the host's IP address, falling
29677 back to a default if the lookup fails. If an ACL is successfully read from a
29678 file, it is retained in memory for the duration of the Exim process, so that it
29679 can be re-used without having to re-read the file.
29680 .next
29681 If the string does not start with a slash, and does not contain any spaces,
29682 Exim searches the ACL section of the configuration for an ACL whose name
29683 matches the string.
29684 .next
29685 If no named ACL is found, or if the string contains spaces, Exim parses
29686 the string as an inline ACL. This can save typing in cases where you just
29687 want to have something like
29688 .code
29689 acl_smtp_vrfy = accept
29690 .endd
29691 in order to allow free use of the VRFY command. Such a string may contain
29692 newlines; it is processed in the same way as an ACL that is read from a file.
29693 .endlist
29694
29695
29696
29697
29698 .section "ACL return codes" "SECID196"
29699 .cindex "&ACL;" "return codes"
29700 Except for the QUIT ACL, which does not affect the SMTP return code (see
29701 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29702 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29703 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29704 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29705 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29706 This also causes a 4&'xx'& return code.
29707
29708 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29709 &"deny"&, because there is no mechanism for passing temporary errors to the
29710 submitters of non-SMTP messages.
29711
29712
29713 ACLs that are relevant to message reception may also return &"discard"&. This
29714 has the effect of &"accept"&, but causes either the entire message or an
29715 individual recipient address to be discarded. In other words, it is a
29716 blackholing facility. Use it with care.
29717
29718 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29719 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29720 RCPT ACL is to discard just the one recipient address. If there are no
29721 recipients left when the message's data is received, the DATA ACL is not
29722 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29723 remaining recipients. The &"discard"& return is not permitted for the
29724 &%acl_smtp_predata%& ACL.
29725
29726 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29727 is done on the address and the result determines the SMTP response.
29728
29729
29730 .cindex "&[local_scan()]& function" "when all recipients discarded"
29731 The &[local_scan()]& function is always run, even if there are no remaining
29732 recipients; it may create new recipients.
29733
29734
29735
29736 .section "Unset ACL options" "SECID197"
29737 .cindex "&ACL;" "unset options"
29738 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29739 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29740 not defined at all. For any defined ACL, the default action when control
29741 reaches the end of the ACL statements is &"deny"&.
29742
29743 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29744 these two are ACLs that are used only for their side effects. They cannot be
29745 used to accept or reject anything.
29746
29747 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29748 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29749 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29750 when the ACL is not defined is &"accept"&.
29751
29752 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29753 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29754 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29755 messages over an SMTP connection. For an example, see the ACL in the default
29756 configuration file.
29757
29758
29759
29760
29761 .section "Data for message ACLs" "SECID198"
29762 .cindex "&ACL;" "data for message ACL"
29763 .vindex &$domain$&
29764 .vindex &$local_part$&
29765 .vindex &$sender_address$&
29766 .vindex &$sender_host_address$&
29767 .vindex &$smtp_command$&
29768 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29769 that contain information about the host and the message's sender (for example,
29770 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29771 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29772 &$local_part$& are set from the argument address. The entire SMTP command
29773 is available in &$smtp_command$&.
29774
29775 When an ACL for the AUTH parameter of MAIL is running, the variables that
29776 contain information about the host are set, but &$sender_address$& is not yet
29777 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29778 how it is used.
29779
29780 .vindex "&$message_size$&"
29781 The &$message_size$& variable is set to the value of the SIZE parameter on
29782 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29783 that parameter is not given. The value is updated to the true message size by
29784 the time the final DATA ACL is run (after the message data has been
29785 received).
29786
29787 .vindex "&$rcpt_count$&"
29788 .vindex "&$recipients_count$&"
29789 The &$rcpt_count$& variable increases by one for each RCPT command received.
29790 The &$recipients_count$& variable increases by one each time a RCPT command is
29791 accepted, so while an ACL for RCPT is being processed, it contains the number
29792 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29793 &$rcpt_count$& contains the total number of RCPT commands, and
29794 &$recipients_count$& contains the total number of accepted recipients.
29795
29796
29797
29798
29799
29800 .section "Data for non-message ACLs" "SECTdatfornon"
29801 .cindex "&ACL;" "data for non-message ACL"
29802 .vindex &$smtp_command_argument$&
29803 .vindex &$smtp_command$&
29804 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29805 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29806 and the entire SMTP command is available in &$smtp_command$&.
29807 These variables can be tested using a &%condition%& condition. For example,
29808 here is an ACL for use with AUTH, which insists that either the session is
29809 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29810 does not permit authentication methods that use cleartext passwords on
29811 unencrypted connections.
29812 .code
29813 acl_check_auth:
29814   accept encrypted = *
29815   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29816                      {CRAM-MD5}}
29817   deny   message   = TLS encryption or CRAM-MD5 required
29818 .endd
29819 (Another way of applying this restriction is to arrange for the authenticators
29820 that use cleartext passwords not to be advertised when the connection is not
29821 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29822 option to do this.)
29823
29824
29825
29826 .section "Format of an ACL" "SECID199"
29827 .cindex "&ACL;" "format of"
29828 .cindex "&ACL;" "verbs, definition of"
29829 An individual ACL consists of a number of statements. Each statement starts
29830 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29831 Modifiers can change the way the verb operates, define error and log messages,
29832 set variables, insert delays, and vary the processing of accepted messages.
29833
29834 If all the conditions are met, the verb is obeyed. The same condition may be
29835 used (with different arguments) more than once in the same statement. This
29836 provides a means of specifying an &"and"& conjunction between conditions. For
29837 example:
29838 .code
29839 deny  dnslists = list1.example
29840       dnslists = list2.example
29841 .endd
29842 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29843 the conditions and modifiers when it reaches a condition that fails. What
29844 happens then depends on the verb (and in one case, on a special modifier). Not
29845 all the conditions make sense at every testing point. For example, you cannot
29846 test a sender address in the ACL that is run for a VRFY command.
29847
29848
29849 .section "ACL verbs" "SECID200"
29850 The ACL verbs are as follows:
29851
29852 .ilist
29853 .cindex "&%accept%& ACL verb"
29854 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29855 of the conditions are not met, what happens depends on whether &%endpass%&
29856 appears among the conditions (for syntax see below). If the failing condition
29857 is before &%endpass%&, control is passed to the next ACL statement; if it is
29858 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29859 check a RCPT command:
29860 .code
29861 accept domains = +local_domains
29862        endpass
29863        verify = recipient
29864 .endd
29865 If the recipient domain does not match the &%domains%& condition, control
29866 passes to the next statement. If it does match, the recipient is verified, and
29867 the command is accepted if verification succeeds. However, if verification
29868 fails, the ACL yields &"deny"&, because the failing condition is after
29869 &%endpass%&.
29870
29871 The &%endpass%& feature has turned out to be confusing to many people, so its
29872 use is not recommended nowadays. It is always possible to rewrite an ACL so
29873 that &%endpass%& is not needed, and it is no longer used in the default
29874 configuration.
29875
29876 .cindex "&%message%& ACL modifier" "with &%accept%&"
29877 If a &%message%& modifier appears on an &%accept%& statement, its action
29878 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29879 (when an &%accept%& verb either accepts or passes control to the next
29880 statement), &%message%& can be used to vary the message that is sent when an
29881 SMTP command is accepted. For example, in a RCPT ACL you could have:
29882 .display
29883 &`accept  `&<&'some conditions'&>
29884 &`        message = OK, I will allow you through today`&
29885 .endd
29886 You can specify an SMTP response code, optionally followed by an &"extended
29887 response code"& at the start of the message, but the first digit must be the
29888 same as would be sent by default, which is 2 for an &%accept%& verb.
29889
29890 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29891 an error message that is used when access is denied. This behaviour is retained
29892 for backward compatibility, but current &"best practice"& is to avoid the use
29893 of &%endpass%&.
29894
29895
29896 .next
29897 .cindex "&%defer%& ACL verb"
29898 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29899 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29900 &%defer%& is the same as &%deny%&, because there is no way of sending a
29901 temporary error. For a RCPT command, &%defer%& is much the same as using a
29902 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29903 be used in any ACL, and even for a recipient it might be a simpler approach.
29904
29905
29906 .next
29907 .cindex "&%deny%& ACL verb"
29908 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29909 the conditions are not met, control is passed to the next ACL statement. For
29910 example,
29911 .code
29912 deny dnslists = blackholes.mail-abuse.org
29913 .endd
29914 rejects commands from hosts that are on a DNS black list.
29915
29916
29917 .next
29918 .cindex "&%discard%& ACL verb"
29919 &%discard%&: This verb behaves like &%accept%&, except that it returns
29920 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29921 that are concerned with receiving messages. When all the conditions are true,
29922 the sending entity receives a &"success"& response. However, &%discard%& causes
29923 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29924 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29925 message's recipients are discarded. Recipients that are discarded before DATA
29926 do not appear in the log line when the &%received_recipients%& log selector is set.
29927
29928 If the &%log_message%& modifier is set when &%discard%& operates,
29929 its contents are added to the line that is automatically written to the log.
29930 The &%message%& modifier operates exactly as it does for &%accept%&.
29931
29932
29933 .next
29934 .cindex "&%drop%& ACL verb"
29935 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29936 forcibly closed after the 5&'xx'& error message has been sent. For example:
29937 .code
29938 drop   message   = I don't take more than 20 RCPTs
29939        condition = ${if > {$rcpt_count}{20}}
29940 .endd
29941 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29942 The connection is always dropped after sending a 550 response.
29943
29944 .next
29945 .cindex "&%require%& ACL verb"
29946 &%require%&: If all the conditions are met, control is passed to the next ACL
29947 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29948 example, when checking a RCPT command,
29949 .code
29950 require message = Sender did not verify
29951         verify  = sender
29952 .endd
29953 passes control to subsequent statements only if the message's sender can be
29954 verified. Otherwise, it rejects the command. Note the positioning of the
29955 &%message%& modifier, before the &%verify%& condition. The reason for this is
29956 discussed in section &<<SECTcondmodproc>>&.
29957
29958 .next
29959 .cindex "&%warn%& ACL verb"
29960 &%warn%&: If all the conditions are true, a line specified by the
29961 &%log_message%& modifier is written to Exim's main log. Control always passes
29962 to the next ACL statement. If any condition is false, the log line is not
29963 written. If an identical log line is requested several times in the same
29964 message, only one copy is actually written to the log. If you want to force
29965 duplicates to be written, use the &%logwrite%& modifier instead.
29966
29967 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29968 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29969 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29970 first failing condition. There is more about adding header lines in section
29971 &<<SECTaddheadacl>>&.
29972
29973 If any condition on a &%warn%& statement cannot be completed (that is, there is
29974 some sort of defer), the log line specified by &%log_message%& is not written.
29975 This does not include the case of a forced failure from a lookup, which
29976 is considered to be a successful completion. After a defer, no further
29977 conditions or modifiers in the &%warn%& statement are processed. The incident
29978 is logged, and the ACL continues to be processed, from the next statement
29979 onwards.
29980
29981
29982 .vindex "&$acl_verify_message$&"
29983 When one of the &%warn%& conditions is an address verification that fails, the
29984 text of the verification failure message is in &$acl_verify_message$&. If you
29985 want this logged, you must set it up explicitly. For example:
29986 .code
29987 warn   !verify = sender
29988        log_message = sender verify failed: $acl_verify_message
29989 .endd
29990 .endlist
29991
29992 At the end of each ACL there is an implicit unconditional &%deny%&.
29993
29994 As you can see from the examples above, the conditions and modifiers are
29995 written one to a line, with the first one on the same line as the verb, and
29996 subsequent ones on following lines. If you have a very long condition, you can
29997 continue it onto several physical lines by the usual backslash continuation
29998 mechanism. It is conventional to align the conditions vertically.
29999
30000
30001
30002 .section "ACL variables" "SECTaclvariables"
30003 .cindex "&ACL;" "variables"
30004 There are some special variables that can be set during ACL processing. They
30005 can be used to pass information between different ACLs, different invocations
30006 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30007 transports, and filters that are used to deliver a message. The names of these
30008 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30009 an underscore, but the remainder of the name can be any sequence of
30010 alphanumeric characters and underscores that you choose. There is no limit on
30011 the number of ACL variables. The two sets act as follows:
30012 .ilist
30013 The values of those variables whose names begin with &$acl_c$& persist
30014 throughout an SMTP connection. They are never reset. Thus, a value that is set
30015 while receiving one message is still available when receiving the next message
30016 on the same SMTP connection.
30017 .next
30018 The values of those variables whose names begin with &$acl_m$& persist only
30019 while a message is being received. They are reset afterwards. They are also
30020 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30021 .endlist
30022
30023 When a message is accepted, the current values of all the ACL variables are
30024 preserved with the message and are subsequently made available at delivery
30025 time. The ACL variables are set by a modifier called &%set%&. For example:
30026 .code
30027 accept hosts = whatever
30028        set acl_m4 = some value
30029 accept authenticated = *
30030        set acl_c_auth = yes
30031 .endd
30032 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30033 be set. If you want to set a variable without taking any action, you can use a
30034 &%warn%& verb without any other modifiers or conditions.
30035
30036 .oindex &%strict_acl_vars%&
30037 What happens if a syntactically valid but undefined ACL variable is
30038 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30039 false (the default), an empty string is substituted; if it is true, an
30040 error is generated.
30041
30042 Versions of Exim before 4.64 have a limited set of numbered variables, but
30043 their names are compatible, so there is no problem with upgrading.
30044
30045
30046 .section "Condition and modifier processing" "SECTcondmodproc"
30047 .cindex "&ACL;" "conditions; processing"
30048 .cindex "&ACL;" "modifiers; processing"
30049 An exclamation mark preceding a condition negates its result. For example:
30050 .code
30051 deny   domains = *.dom.example
30052       !verify  = recipient
30053 .endd
30054 causes the ACL to return &"deny"& if the recipient domain ends in
30055 &'dom.example'& and the recipient address cannot be verified. Sometimes
30056 negation can be used on the right-hand side of a condition. For example, these
30057 two statements are equivalent:
30058 .code
30059 deny  hosts = !192.168.3.4
30060 deny !hosts =  192.168.3.4
30061 .endd
30062 However, for many conditions (&%verify%& being a good example), only left-hand
30063 side negation of the whole condition is possible.
30064
30065 The arguments of conditions and modifiers are expanded. A forced failure
30066 of an expansion causes a condition to be ignored, that is, it behaves as if the
30067 condition is true. Consider these two statements:
30068 .code
30069 accept  senders = ${lookup{$host_name}lsearch\
30070                   {/some/file}{$value}fail}
30071 accept  senders = ${lookup{$host_name}lsearch\
30072                   {/some/file}{$value}{}}
30073 .endd
30074 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30075 the returned list is searched, but if the lookup fails the behaviour is
30076 different in the two cases. The &%fail%& in the first statement causes the
30077 condition to be ignored, leaving no further conditions. The &%accept%& verb
30078 therefore succeeds. The second statement, however, generates an empty list when
30079 the lookup fails. No sender can match an empty list, so the condition fails,
30080 and therefore the &%accept%& also fails.
30081
30082 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30083 specify actions that are taken as the conditions for a statement are checked;
30084 others specify text for messages that are used when access is denied or a
30085 warning is generated. The &%control%& modifier affects the way an incoming
30086 message is handled.
30087
30088 The positioning of the modifiers in an ACL statement is important, because the
30089 processing of a verb ceases as soon as its outcome is known. Only those
30090 modifiers that have already been encountered will take effect. For example,
30091 consider this use of the &%message%& modifier:
30092 .code
30093 require message = Can't verify sender
30094         verify  = sender
30095         message = Can't verify recipient
30096         verify  = recipient
30097         message = This message cannot be used
30098 .endd
30099 If sender verification fails, Exim knows that the result of the statement is
30100 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30101 so its text is used as the error message. If sender verification succeeds, but
30102 recipient verification fails, the second message is used. If recipient
30103 verification succeeds, the third message becomes &"current"&, but is never used
30104 because there are no more conditions to cause failure.
30105
30106 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30107 modifier that is used, because all the conditions must be true for rejection to
30108 happen. Specifying more than one &%message%& modifier does not make sense, and
30109 the message can even be specified after all the conditions. For example:
30110 .code
30111 deny   hosts = ...
30112       !senders = *@my.domain.example
30113        message = Invalid sender from client host
30114 .endd
30115 The &"deny"& result does not happen until the end of the statement is reached,
30116 by which time Exim has set up the message.
30117
30118
30119
30120 .section "ACL modifiers" "SECTACLmodi"
30121 .cindex "&ACL;" "modifiers; list of"
30122 The ACL modifiers are as follows:
30123
30124 .vlist
30125 .vitem &*add_header*&&~=&~<&'text'&>
30126 This modifier specifies one or more header lines that are to be added to an
30127 incoming message, assuming, of course, that the message is ultimately
30128 accepted. For details, see section &<<SECTaddheadacl>>&.
30129
30130 .vitem &*continue*&&~=&~<&'text'&>
30131 .cindex "&%continue%& ACL modifier"
30132 .cindex "database" "updating in ACL"
30133 This modifier does nothing of itself, and processing of the ACL always
30134 continues with the next condition or modifier. The value of &%continue%& is in
30135 the side effects of expanding its argument. Typically this could be used to
30136 update a database. It is really just a syntactic tidiness, to avoid having to
30137 write rather ugly lines like this:
30138 .display
30139 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30140 .endd
30141 Instead, all you need is
30142 .display
30143 &`continue = `&<&'some expansion'&>
30144 .endd
30145
30146 .vitem &*control*&&~=&~<&'text'&>
30147 .cindex "&%control%& ACL modifier"
30148 This modifier affects the subsequent processing of the SMTP connection or of an
30149 incoming message that is accepted. The effect of the first type of control
30150 lasts for the duration of the connection, whereas the effect of the second type
30151 lasts only until the current message has been received. The message-specific
30152 controls always apply to the whole message, not to individual recipients,
30153 even if the &%control%& modifier appears in a RCPT ACL.
30154
30155 As there are now quite a few controls that can be applied, they are described
30156 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30157 in several different ways. For example:
30158
30159 . ==== As this is a nested list, any displays it contains must be indented
30160 . ==== as otherwise they are too far to the left. That comment applies only
30161 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30162 . ==== way.
30163
30164 .ilist
30165 It can be at the end of an &%accept%& statement:
30166 .code
30167     accept  ...some conditions
30168             control = queue
30169 .endd
30170 In this case, the control is applied when this statement yields &"accept"&, in
30171 other words, when the conditions are all true.
30172
30173 .next
30174 It can be in the middle of an &%accept%& statement:
30175 .code
30176     accept  ...some conditions...
30177             control = queue
30178             ...some more conditions...
30179 .endd
30180 If the first set of conditions are true, the control is applied, even if the
30181 statement does not accept because one of the second set of conditions is false.
30182 In this case, some subsequent statement must yield &"accept"& for the control
30183 to be relevant.
30184
30185 .next
30186 It can be used with &%warn%& to apply the control, leaving the
30187 decision about accepting or denying to a subsequent verb. For
30188 example:
30189 .code
30190     warn    ...some conditions...
30191             control = freeze
30192     accept  ...
30193 .endd
30194 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30195 &%logwrite%&, so it does not add anything to the message and does not write a
30196 log entry.
30197
30198 .next
30199 If you want to apply a control unconditionally, you can use it with a
30200 &%require%& verb. For example:
30201 .code
30202     require  control = no_multiline_responses
30203 .endd
30204 .endlist
30205
30206 .vitem &*delay*&&~=&~<&'time'&>
30207 .cindex "&%delay%& ACL modifier"
30208 .oindex "&%-bh%&"
30209 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30210 the time interval before proceeding. However, when testing Exim using the
30211 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30212 output instead). The time is given in the usual Exim notation, and the delay
30213 happens as soon as the modifier is processed. In an SMTP session, pending
30214 output is flushed before the delay is imposed.
30215
30216 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30217 example:
30218 .code
30219 deny    ...some conditions...
30220         delay = 30s
30221 .endd
30222 The delay happens if all the conditions are true, before the statement returns
30223 &"deny"&. Compare this with:
30224 .code
30225 deny    delay = 30s
30226         ...some conditions...
30227 .endd
30228 which waits for 30s before processing the conditions. The &%delay%& modifier
30229 can also be used with &%warn%& and together with &%control%&:
30230 .code
30231 warn    ...some conditions...
30232         delay = 2m
30233         control = freeze
30234 accept  ...
30235 .endd
30236
30237 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30238 responses to several commands are no longer buffered and sent in one packet (as
30239 they would normally be) because all output is flushed before imposing the
30240 delay. This optimization is disabled so that a number of small delays do not
30241 appear to the client as one large aggregated delay that might provoke an
30242 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30243 using a &%control%& modifier to set &%no_delay_flush%&.
30244
30245
30246 .vitem &*endpass*&
30247 .cindex "&%endpass%& ACL modifier"
30248 This modifier, which has no argument, is recognized only in &%accept%& and
30249 &%discard%& statements. It marks the boundary between the conditions whose
30250 failure causes control to pass to the next statement, and the conditions whose
30251 failure causes the ACL to return &"deny"&. This concept has proved to be
30252 confusing to some people, so the use of &%endpass%& is no longer recommended as
30253 &"best practice"&. See the description of &%accept%& above for more details.
30254
30255
30256 .vitem &*log_message*&&~=&~<&'text'&>
30257 .cindex "&%log_message%& ACL modifier"
30258 This modifier sets up a message that is used as part of the log message if the
30259 ACL denies access or a &%warn%& statement's conditions are true. For example:
30260 .code
30261 require log_message = wrong cipher suite $tls_in_cipher
30262         encrypted   = DES-CBC3-SHA
30263 .endd
30264 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30265 example:
30266 .display
30267 &`discard `&<&'some conditions'&>
30268 &`        log_message = Discarded $local_part@$domain because...`&
30269 .endd
30270 When access is denied, &%log_message%& adds to any underlying error message
30271 that may exist because of a condition failure. For example, while verifying a
30272 recipient address, a &':fail:'& redirection might have already set up a
30273 message.
30274
30275 The message may be defined before the conditions to which it applies, because
30276 the string expansion does not happen until Exim decides that access is to be
30277 denied. This means that any variables that are set by the condition are
30278 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30279 variables are set after a DNS black list lookup succeeds. If the expansion of
30280 &%log_message%& fails, or if the result is an empty string, the modifier is
30281 ignored.
30282
30283 .vindex "&$acl_verify_message$&"
30284 If you want to use a &%warn%& statement to log the result of an address
30285 verification, you can use &$acl_verify_message$& to include the verification
30286 error message.
30287
30288 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30289 the start of the logged message. If the same warning log message is requested
30290 more than once while receiving  a single email message, only one copy is
30291 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30292 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30293 is logged for a successful &%warn%& statement.
30294
30295 If &%log_message%& is not present and there is no underlying error message (for
30296 example, from the failure of address verification), but &%message%& is present,
30297 the &%message%& text is used for logging rejections. However, if any text for
30298 logging contains newlines, only the first line is logged. In the absence of
30299 both &%log_message%& and &%message%&, a default built-in message is used for
30300 logging rejections.
30301
30302
30303 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30304 .cindex "&%log_reject_target%& ACL modifier"
30305 .cindex "logging in ACL" "specifying which log"
30306 This modifier makes it possible to specify which logs are used for messages
30307 about ACL rejections. Its argument is a colon-separated list of words that can
30308 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30309 may be empty, in which case a rejection is not logged at all. For example, this
30310 ACL fragment writes no logging information when access is denied:
30311 .display
30312 &`deny `&<&'some conditions'&>
30313 &`     log_reject_target =`&
30314 .endd
30315 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30316 permanent and temporary rejections. Its effect lasts for the rest of the
30317 current ACL.
30318
30319
30320 .vitem &*logwrite*&&~=&~<&'text'&>
30321 .cindex "&%logwrite%& ACL modifier"
30322 .cindex "logging in ACL" "immediate"
30323 This modifier writes a message to a log file as soon as it is encountered when
30324 processing an ACL. (Compare &%log_message%&, which, except in the case of
30325 &%warn%& and &%discard%&, is used only if the ACL statement denies
30326 access.) The &%logwrite%& modifier can be used to log special incidents in
30327 ACLs. For example:
30328 .display
30329 &`accept `&<&'some special conditions'&>
30330 &`       control  = freeze`&
30331 &`       logwrite = froze message because ...`&
30332 .endd
30333 By default, the message is written to the main log. However, it may begin
30334 with a colon, followed by a comma-separated list of log names, and then
30335 another colon, to specify exactly which logs are to be written. For
30336 example:
30337 .code
30338 logwrite = :main,reject: text for main and reject logs
30339 logwrite = :panic: text for panic log only
30340 .endd
30341
30342
30343 .vitem &*message*&&~=&~<&'text'&>
30344 .cindex "&%message%& ACL modifier"
30345 This modifier sets up a text string that is expanded and used as a response
30346 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30347 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30348 there is some complication if &%endpass%& is involved; see the description of
30349 &%accept%& for details.)
30350
30351 The expansion of the message happens at the time Exim decides that the ACL is
30352 to end, not at the time it processes &%message%&. If the expansion fails, or
30353 generates an empty string, the modifier is ignored. Here is an example where
30354 &%message%& must be specified first, because the ACL ends with a rejection if
30355 the &%hosts%& condition fails:
30356 .code
30357 require  message = Host not recognized
30358          hosts = 10.0.0.0/8
30359 .endd
30360 (Once a condition has failed, no further conditions or modifiers are
30361 processed.)
30362
30363 .cindex "SMTP" "error codes"
30364 .oindex "&%smtp_banner%&
30365 For ACLs that are triggered by SMTP commands, the message is returned as part
30366 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30367 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30368 is accepted. In the case of the connect ACL, accepting with a message modifier
30369 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30370 accept message may not contain more than one line (otherwise it will be
30371 truncated at the first newline and a panic logged), and it cannot affect the
30372 EHLO options.
30373
30374 When SMTP is involved, the message may begin with an overriding response code,
30375 consisting of three digits optionally followed by an &"extended response code"&
30376 of the form &'n.n.n'&, each code being followed by a space. For example:
30377 .code
30378 deny  message = 599 1.2.3 Host not welcome
30379       hosts = 192.168.34.0/24
30380 .endd
30381 The first digit of the supplied response code must be the same as would be sent
30382 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30383 access, but for the predata ACL, note that the default success code is 354, not
30384 2&'xx'&.
30385
30386 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30387 the message modifier cannot override the 221 response code.
30388
30389 The text in a &%message%& modifier is literal; any quotes are taken as
30390 literals, but because the string is expanded, backslash escapes are processed
30391 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30392 response.
30393
30394 .vindex "&$acl_verify_message$&"
30395 For ACLs that are called by an &%acl =%& ACL condition, the message is
30396 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30397
30398 If &%message%& is used on a statement that verifies an address, the message
30399 specified overrides any message that is generated by the verification process.
30400 However, the original message is available in the variable
30401 &$acl_verify_message$&, so you can incorporate it into your message if you
30402 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30403 routers to be passed back as part of the SMTP response, you should either not
30404 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30405
30406 For compatibility with previous releases of Exim, a &%message%& modifier that
30407 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30408 modifier, but this usage is now deprecated. However, &%message%& acts only when
30409 all the conditions are true, wherever it appears in an ACL command, whereas
30410 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30411 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30412 effect.
30413
30414
30415 .vitem &*queue*&&~=&~<&'text'&>
30416 .cindex "&%queue%& ACL modifier"
30417 .cindex "named queues" "selecting in ACL"
30418 This modifier specifies the use of a named queue for spool files
30419 for the message.
30420 It can only be used before the message is received (i.e. not in
30421 the DATA ACL).
30422 This could be used, for example, for known high-volume burst sources
30423 of traffic, or for quarantine of messages.
30424 Separate queue-runner processes will be needed for named queues.
30425 If the text after expansion is empty, the default queue is used.
30426
30427
30428 .vitem &*remove_header*&&~=&~<&'text'&>
30429 This modifier specifies one or more header names in a colon-separated list
30430  that are to be removed from an incoming message, assuming, of course, that
30431 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30432
30433
30434 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30435 .cindex "&%set%& ACL modifier"
30436 This modifier puts a value into one of the ACL variables (see section
30437 &<<SECTaclvariables>>&).
30438
30439
30440 .vitem &*udpsend*&&~=&~<&'parameters'&>
30441 .cindex "UDP communications"
30442 This modifier sends a UDP packet, for purposes such as statistics
30443 collection or behaviour monitoring. The parameters are expanded, and
30444 the result of the expansion must be a colon-separated list consisting
30445 of a destination server, port number, and the packet contents. The
30446 server can be specified as a host name or IPv4 or IPv6 address. The
30447 separator can be changed with the usual angle bracket syntax. For
30448 example, you might want to collect information on which hosts connect
30449 when:
30450 .code
30451 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30452              $tod_zulu $sender_host_address
30453 .endd
30454 .endlist
30455
30456
30457
30458
30459 .section "Use of the control modifier" "SECTcontrols"
30460 .cindex "&%control%& ACL modifier"
30461 The &%control%& modifier supports the following settings:
30462
30463 .vlist
30464 .vitem &*control&~=&~allow_auth_unadvertised*&
30465 This modifier allows a client host to use the SMTP AUTH command even when it
30466 has not been advertised in response to EHLO. Furthermore, because there are
30467 apparently some really broken clients that do this, Exim will accept AUTH after
30468 HELO (rather than EHLO) when this control is set. It should be used only if you
30469 really need it, and you should limit its use to those broken clients that do
30470 not work without it. For example:
30471 .code
30472 warn hosts   = 192.168.34.25
30473      control = allow_auth_unadvertised
30474 .endd
30475 Normally, when an Exim server receives an AUTH command, it checks the name of
30476 the authentication mechanism that is given in the command to ensure that it
30477 matches an advertised mechanism. When this control is set, the check that a
30478 mechanism has been advertised is bypassed. Any configured mechanism can be used
30479 by the client. This control is permitted only in the connection and HELO ACLs.
30480
30481
30482 .vitem &*control&~=&~caseful_local_part*& &&&
30483        &*control&~=&~caselower_local_part*&
30484 .cindex "&ACL;" "case of local part in"
30485 .cindex "case of local parts"
30486 .vindex "&$local_part$&"
30487 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30488 (that is, during RCPT processing). By default, the contents of &$local_part$&
30489 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30490 any uppercase letters in the original local part are restored in &$local_part$&
30491 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30492 is encountered.
30493
30494 These controls affect only the current recipient. Moreover, they apply only to
30495 local part handling that takes place directly in the ACL (for example, as a key
30496 in lookups). If a test to verify the recipient is obeyed, the case-related
30497 handling of the local part during the verification is controlled by the router
30498 configuration (see the &%caseful_local_part%& generic router option).
30499
30500 This facility could be used, for example, to add a spam score to local parts
30501 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30502 spam score:
30503 .code
30504 warn  control = caseful_local_part
30505       set acl_m4 = ${eval:\
30506                      $acl_m4 + \
30507                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30508                     }
30509       control = caselower_local_part
30510 .endd
30511 Notice that we put back the lower cased version afterwards, assuming that
30512 is what is wanted for subsequent tests.
30513
30514
30515 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30516 .cindex "&ACL;" "cutthrough routing"
30517 .cindex "cutthrough" "requesting"
30518 This option requests delivery be attempted while the item is being received.
30519
30520 The option is usable in the RCPT ACL.
30521 If enabled for a message received via smtp and routed to an smtp transport,
30522 and only one transport, interface, destination host and port combination
30523 is used for all recipients of the message,
30524 then the delivery connection is made while the receiving connection is open
30525 and data is copied from one to the other.
30526
30527 An attempt to set this option for any recipient but the first
30528 for a mail will be quietly ignored.
30529 If a recipient-verify callout
30530 (with use_sender)
30531 connection is subsequently
30532 requested in the same ACL it is held open and used for
30533 any subsequent recipients and the data,
30534 otherwise one is made after the initial RCPT ACL completes.
30535
30536 Note that routers are used in verify mode,
30537 and cannot depend on content of received headers.
30538 Note also that headers cannot be
30539 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30540 Headers may be modified by routers (subject to the above) and transports.
30541 The &'Received-By:'& header is generated as soon as the body reception starts,
30542 rather than the traditional time after the full message is received;
30543 this will affect the timestamp.
30544
30545 All the usual ACLs are called; if one results in the message being
30546 rejected, all effort spent in delivery (including the costs on
30547 the ultimate destination) will be wasted.
30548 Note that in the case of data-time ACLs this includes the entire
30549 message body.
30550
30551 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30552 of outgoing messages is done, because it sends data to the ultimate destination
30553 before the entire message has been received from the source.
30554 It is not supported for messages received with the SMTP PRDR
30555 or CHUNKING
30556 options in use.
30557
30558 Should the ultimate destination system positively accept or reject the mail,
30559 a corresponding indication is given to the source system and nothing is queued.
30560 If the item is successfully delivered in cutthrough mode
30561 the delivery log lines are tagged with ">>" rather than "=>" and appear
30562 before the acceptance "<=" line.
30563
30564 If there is a temporary error the item is queued for later delivery in the
30565 usual fashion.
30566 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30567 to the control; the default value is &"spool"& and the alternate value
30568 &"pass"& copies an SMTP defer response from the target back to the initiator
30569 and does not queue the message.
30570 Note that this is independent of any recipient verify conditions in the ACL.
30571
30572 Delivery in this mode avoids the generation of a bounce mail to a
30573 (possibly faked)
30574 sender when the destination system is doing content-scan based rejection.
30575
30576
30577 .vitem &*control&~=&~debug/*&<&'options'&>
30578 .cindex "&ACL;" "enabling debug logging"
30579 .cindex "debugging" "enabling from an ACL"
30580 This control turns on debug logging, almost as though Exim had been invoked
30581 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30582 by default called &'debuglog'&.
30583 The filename can be adjusted with the &'tag'& option, which
30584 may access any variables already defined.  The logging may be adjusted with
30585 the &'opts'& option, which takes the same values as the &`-d`& command-line
30586 option.
30587 Logging started this way may be stopped, and the file removed,
30588 with the &'kill'& option.
30589 Some examples (which depend on variables that don't exist in all
30590 contexts):
30591 .code
30592       control = debug
30593       control = debug/tag=.$sender_host_address
30594       control = debug/opts=+expand+acl
30595       control = debug/tag=.$message_exim_id/opts=+expand
30596       control = debug/kill
30597 .endd
30598
30599
30600 .vitem &*control&~=&~dkim_disable_verify*&
30601 .cindex "disable DKIM verify"
30602 .cindex "DKIM" "disable verify"
30603 This control turns off DKIM verification processing entirely.  For details on
30604 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30605
30606
30607 .vitem &*control&~=&~dmarc_disable_verify*&
30608 .cindex "disable DMARC verify"
30609 .cindex "DMARC" "disable verify"
30610 This control turns off DMARC verification processing entirely.  For details on
30611 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30612
30613
30614 .vitem &*control&~=&~dscp/*&<&'value'&>
30615 .cindex "&ACL;" "setting DSCP value"
30616 .cindex "DSCP" "inbound"
30617 This option causes the DSCP value associated with the socket for the inbound
30618 connection to be adjusted to a given value, given as one of a number of fixed
30619 strings or to numeric value.
30620 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30621 Common values include &`throughput`&, &`mincost`&, and on newer systems
30622 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30623
30624 The outbound packets from Exim will be marked with this value in the header
30625 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30626 that these values will have any effect, not be stripped by networking
30627 equipment, or do much of anything without cooperation with your Network
30628 Engineer and those of all network operators between the source and destination.
30629
30630
30631 .vitem &*control&~=&~enforce_sync*& &&&
30632        &*control&~=&~no_enforce_sync*&
30633 .cindex "SMTP" "synchronization checking"
30634 .cindex "synchronization checking in SMTP"
30635 These controls make it possible to be selective about when SMTP synchronization
30636 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30637 state of the switch (it is true by default). See the description of this option
30638 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30639
30640 The effect of these two controls lasts for the remainder of the SMTP
30641 connection. They can appear in any ACL except the one for the non-SMTP
30642 messages. The most straightforward place to put them is in the ACL defined by
30643 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30644 before the first synchronization check. The expected use is to turn off the
30645 synchronization checks for badly-behaved hosts that you nevertheless need to
30646 work with.
30647
30648
30649 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30650 .cindex "fake defer"
30651 .cindex "defer, fake"
30652 This control works in exactly the same way as &%fakereject%& (described below)
30653 except that it causes an SMTP 450 response after the message data instead of a
30654 550 response. You must take care when using &%fakedefer%& because it causes the
30655 messages to be duplicated when the sender retries. Therefore, you should not
30656 use &%fakedefer%& if the message is to be delivered normally.
30657
30658 .vitem &*control&~=&~fakereject/*&<&'message'&>
30659 .cindex "fake rejection"
30660 .cindex "rejection, fake"
30661 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30662 words, only when an SMTP message is being received. If Exim accepts the
30663 message, instead the final 250 response, a 550 rejection message is sent.
30664 However, Exim proceeds to deliver the message as normal. The control applies
30665 only to the current message, not to any subsequent ones that may be received in
30666 the same SMTP connection.
30667
30668 The text for the 550 response is taken from the &%control%& modifier. If no
30669 message is supplied, the following is used:
30670 .code
30671 550-Your message has been rejected but is being
30672 550-kept for evaluation.
30673 550-If it was a legitimate message, it may still be
30674 550 delivered to the target recipient(s).
30675 .endd
30676 This facility should be used with extreme caution.
30677
30678 .vitem &*control&~=&~freeze*&
30679 .cindex "frozen messages" "forcing in ACL"
30680 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30681 other words, only when a message is being received. If the message is accepted,
30682 it is placed on Exim's queue and frozen. The control applies only to the
30683 current message, not to any subsequent ones that may be received in the same
30684 SMTP connection.
30685
30686 This modifier can optionally be followed by &`/no_tell`&. If the global option
30687 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30688 is told about the freezing), provided all the &*control=freeze*& modifiers that
30689 are obeyed for the current message have the &`/no_tell`& option.
30690
30691 .vitem &*control&~=&~no_delay_flush*&
30692 .cindex "SMTP" "output flushing, disabling for delay"
30693 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30694 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30695 use. This control, as long as it is encountered before the &%delay%& modifier,
30696 disables such output flushing.
30697
30698 .vitem &*control&~=&~no_callout_flush*&
30699 .cindex "SMTP" "output flushing, disabling for callout"
30700 Exim normally flushes SMTP output before performing a callout in an ACL, to
30701 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30702 use. This control, as long as it is encountered before the &%verify%& condition
30703 that causes the callout, disables such output flushing.
30704
30705 .vitem &*control&~=&~no_mbox_unspool*&
30706 This control is available when Exim is compiled with the content scanning
30707 extension. Content scanning may require a copy of the current message, or parts
30708 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30709 or spam scanner. Normally, such copies are deleted when they are no longer
30710 needed. If this control is set, the copies are not deleted. The control applies
30711 only to the current message, not to any subsequent ones that may be received in
30712 the same SMTP connection. It is provided for debugging purposes and is unlikely
30713 to be useful in production.
30714
30715 .vitem &*control&~=&~no_multiline_responses*&
30716 .cindex "multiline responses, suppressing"
30717 This control is permitted for any ACL except the one for non-SMTP messages.
30718 It seems that there are broken clients in use that cannot handle multiline
30719 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30720
30721 If this control is set, multiline SMTP responses from ACL rejections are
30722 suppressed. One way of doing this would have been to put out these responses as
30723 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30724 (&"use multiline responses for more"& it says &-- ha!), and some of the
30725 responses might get close to that. So this facility, which is after all only a
30726 sop to broken clients, is implemented by doing two very easy things:
30727
30728 .ilist
30729 Extra information that is normally output as part of a rejection caused by
30730 sender verification failure is omitted. Only the final line (typically &"sender
30731 verification failed"&) is sent.
30732 .next
30733 If a &%message%& modifier supplies a multiline response, only the first
30734 line is output.
30735 .endlist
30736
30737 The setting of the switch can, of course, be made conditional on the
30738 calling host. Its effect lasts until the end of the SMTP connection.
30739
30740 .vitem &*control&~=&~no_pipelining*&
30741 .cindex "PIPELINING" "suppressing advertising"
30742 This control turns off the advertising of the PIPELINING extension to SMTP in
30743 the current session. To be useful, it must be obeyed before Exim sends its
30744 response to an EHLO command. Therefore, it should normally appear in an ACL
30745 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30746 &%pipelining_advertise_hosts%&.
30747
30748 .new
30749 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
30750        &*control&~=&~queue_only*&
30751 .oindex "&%queue%&"
30752 .oindex "&%queue_only%&"
30753 .cindex "queueing incoming messages"
30754 .cindex queueing "forcing in ACL"
30755 .cindex "first pass routing"
30756 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30757 other words, only when a message is being received. If the message is accepted,
30758 it is placed on Exim's queue and left there for delivery by a subsequent queue
30759 runner.
30760 If used with no options set,
30761 no immediate delivery process is started. In other words, it has the
30762 effect as the &%queue_only%& global option or &'-odq'& command-line option.
30763
30764 If the &'first_pass_route'& option is given then
30765 the behaviour is like the command-line &'-oqds'& option;
30766 a delivery process is started which stops short of making
30767 any SMTP delivery.  The benefit is that the hints database will be updated for
30768 the message being waiting for a specific host, and a later queue run will be
30769 able to send all such messages on a single connection.
30770
30771 The control only applies to the current message, not to any subsequent ones that
30772  may be received in the same SMTP connection.
30773 .wen
30774
30775 .vitem &*control&~=&~submission/*&<&'options'&>
30776 .cindex "message" "submission"
30777 .cindex "submission mode"
30778 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30779 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30780 the current message is a submission from a local MUA. In this case, Exim
30781 operates in &"submission mode"&, and applies certain fixups to the message if
30782 necessary. For example, it adds a &'Date:'& header line if one is not present.
30783 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30784 late (the message has already been created).
30785
30786 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30787 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30788 submission mode; the available options for this control are described there.
30789 The control applies only to the current message, not to any subsequent ones
30790 that may be received in the same SMTP connection.
30791
30792 .vitem &*control&~=&~suppress_local_fixups*&
30793 .cindex "submission fixups, suppressing"
30794 This control applies to locally submitted (non TCP/IP) messages, and is the
30795 complement of &`control = submission`&. It disables the fixups that are
30796 normally applied to locally-submitted messages. Specifically:
30797
30798 .ilist
30799 Any &'Sender:'& header line is left alone (in this respect, it is a
30800 dynamic version of &%local_sender_retain%&).
30801 .next
30802 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30803 .next
30804 There is no check that &'From:'& corresponds to the actual sender.
30805 .endlist ilist
30806
30807 This control may be useful when a remotely-originated message is accepted,
30808 passed to some scanning program, and then re-submitted for delivery. It can be
30809 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30810 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30811 data is read.
30812
30813 &*Note:*& This control applies only to the current message, not to any others
30814 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30815
30816 .vitem &*control&~=&~utf8_downconvert*&
30817 This control enables conversion of UTF-8 in message addresses
30818 to a-label form.
30819 For details see section &<<SECTi18nMTA>>&.
30820 .endlist vlist
30821
30822
30823 .section "Summary of message fixup control" "SECTsummesfix"
30824 All four possibilities for message fixups can be specified:
30825
30826 .ilist
30827 Locally submitted, fixups applied: the default.
30828 .next
30829 Locally submitted, no fixups applied: use
30830 &`control = suppress_local_fixups`&.
30831 .next
30832 Remotely submitted, no fixups applied: the default.
30833 .next
30834 Remotely submitted, fixups applied: use &`control = submission`&.
30835 .endlist
30836
30837
30838
30839 .section "Adding header lines in ACLs" "SECTaddheadacl"
30840 .cindex "header lines" "adding in an ACL"
30841 .cindex "header lines" "position of added lines"
30842 .cindex "&%add_header%& ACL modifier"
30843 The &%add_header%& modifier can be used to add one or more extra header lines
30844 to an incoming message, as in this example:
30845 .code
30846 warn dnslists = sbl.spamhaus.org : \
30847                 dialup.mail-abuse.org
30848      add_header = X-blacklisted-at: $dnslist_domain
30849 .endd
30850 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30851 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30852 receiving a message). The message must ultimately be accepted for
30853 &%add_header%& to have any significant effect. You can use &%add_header%& with
30854 any ACL verb, including &%deny%& (though this is potentially useful only in a
30855 RCPT ACL).
30856
30857 Headers will not be added to the message if the modifier is used in
30858 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30859
30860 Leading and trailing newlines are removed from
30861 the data for the &%add_header%& modifier; if it then
30862 contains one or more newlines that
30863 are not followed by a space or a tab, it is assumed to contain multiple header
30864 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30865 front of any line that is not a valid header line.
30866
30867 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30868 They are added to the message before processing the DATA and MIME ACLs.
30869 However, if an identical header line is requested more than once, only one copy
30870 is actually added to the message. Further header lines may be accumulated
30871 during the DATA and MIME ACLs, after which they are added to the message, again
30872 with duplicates suppressed. Thus, it is possible to add two identical header
30873 lines to an SMTP message, but only if one is added before DATA and one after.
30874 In the case of non-SMTP messages, new headers are accumulated during the
30875 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30876 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30877 are included in the entry that is written to the reject log.
30878
30879 .cindex "header lines" "added; visibility of"
30880 Header lines are not visible in string expansions
30881 of message headers
30882 until they are added to the
30883 message. It follows that header lines defined in the MAIL, RCPT, and predata
30884 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30885 header lines that are added by the DATA or MIME ACLs are not visible in those
30886 ACLs. Because of this restriction, you cannot use header lines as a way of
30887 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30888 this, you can use ACL variables, as described in section
30889 &<<SECTaclvariables>>&.
30890
30891 The list of headers yet to be added is given by the &%$headers_added%& variable.
30892
30893 The &%add_header%& modifier acts immediately as it is encountered during the
30894 processing of an ACL. Notice the difference between these two cases:
30895 .display
30896 &`accept add_header = ADDED: some text`&
30897 &`       `&<&'some condition'&>
30898
30899 &`accept `&<&'some condition'&>
30900 &`       add_header = ADDED: some text`&
30901 .endd
30902 In the first case, the header line is always added, whether or not the
30903 condition is true. In the second case, the header line is added only if the
30904 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30905 ACL statement. All those that are encountered before a condition fails are
30906 honoured.
30907
30908 .cindex "&%warn%& ACL verb"
30909 For compatibility with previous versions of Exim, a &%message%& modifier for a
30910 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30911 effect only if all the conditions are true, even if it appears before some of
30912 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30913 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30914 are present on a &%warn%& verb, both are processed according to their
30915 specifications.
30916
30917 By default, new header lines are added to a message at the end of the existing
30918 header lines. However, you can specify that any particular header line should
30919 be added right at the start (before all the &'Received:'& lines), immediately
30920 after the first block of &'Received:'& lines, or immediately before any line
30921 that is not a &'Received:'& or &'Resent-something:'& header.
30922
30923 This is done by specifying &":at_start:"&, &":after_received:"&, or
30924 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30925 header line, respectively. (Header text cannot start with a colon, as there has
30926 to be a header name first.) For example:
30927 .code
30928 warn add_header = \
30929        :after_received:X-My-Header: something or other...
30930 .endd
30931 If more than one header line is supplied in a single &%add_header%& modifier,
30932 each one is treated independently and can therefore be placed differently. If
30933 you add more than one line at the start, or after the Received: block, they end
30934 up in reverse order.
30935
30936 &*Warning*&: This facility currently applies only to header lines that are
30937 added in an ACL. It does NOT work for header lines that are added in a
30938 system filter or in a router or transport.
30939
30940
30941
30942 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30943 .cindex "header lines" "removing in an ACL"
30944 .cindex "header lines" "position of removed lines"
30945 .cindex "&%remove_header%& ACL modifier"
30946 The &%remove_header%& modifier can be used to remove one or more header lines
30947 from an incoming message, as in this example:
30948 .code
30949 warn   message        = Remove internal headers
30950        remove_header  = x-route-mail1 : x-route-mail2
30951 .endd
30952 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30953 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30954 receiving a message). The message must ultimately be accepted for
30955 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30956 with any ACL verb, including &%deny%&, though this is really not useful for
30957 any verb that doesn't result in a delivered message.
30958
30959 Headers will not be removed from the message if the modifier is used in
30960 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30961
30962 More than one header can be removed at the same time by using a colon separated
30963 list of header names. The header matching is case insensitive. Wildcards are
30964 not permitted, nor is list expansion performed, so you cannot use hostlists to
30965 create a list of headers, however both connection and message variable expansion
30966 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30967 .code
30968 warn   hosts           = +internal_hosts
30969        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30970 warn   message         = Remove internal headers
30971        remove_header   = $acl_c_ihdrs
30972 .endd
30973 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30974 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30975 If multiple header lines match, all are removed.
30976 There is no harm in attempting to remove the same header twice nor in removing
30977 a non-existent header. Further header lines to be removed may be accumulated
30978 during the DATA and MIME ACLs, after which they are removed from the message,
30979 if present. In the case of non-SMTP messages, headers to be removed are
30980 accumulated during the non-SMTP ACLs, and are removed from the message after
30981 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30982 ACL, there really is no effect because there is no logging of what headers
30983 would have been removed.
30984
30985 .cindex "header lines" "removed; visibility of"
30986 Header lines are not visible in string expansions until the DATA phase when it
30987 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30988 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30989 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30990 this restriction, you cannot use header lines as a way of controlling data
30991 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30992 you should instead use ACL variables, as described in section
30993 &<<SECTaclvariables>>&.
30994
30995 The &%remove_header%& modifier acts immediately as it is encountered during the
30996 processing of an ACL. Notice the difference between these two cases:
30997 .display
30998 &`accept remove_header = X-Internal`&
30999 &`       `&<&'some condition'&>
31000
31001 &`accept `&<&'some condition'&>
31002 &`       remove_header = X-Internal`&
31003 .endd
31004 In the first case, the header line is always removed, whether or not the
31005 condition is true. In the second case, the header line is removed only if the
31006 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31007 same ACL statement. All those that are encountered before a condition fails
31008 are honoured.
31009
31010 &*Warning*&: This facility currently applies only to header lines that are
31011 present during ACL processing. It does NOT remove header lines that are added
31012 in a system filter or in a router or transport.
31013
31014
31015
31016
31017 .section "ACL conditions" "SECTaclconditions"
31018 .cindex "&ACL;" "conditions; list of"
31019 Some of the conditions listed in this section are available only when Exim is
31020 compiled with the content-scanning extension. They are included here briefly
31021 for completeness. More detailed descriptions can be found in the discussion on
31022 content scanning in chapter &<<CHAPexiscan>>&.
31023
31024 Not all conditions are relevant in all circumstances. For example, testing
31025 senders and recipients does not make sense in an ACL that is being run as the
31026 result of the arrival of an ETRN command, and checks on message headers can be
31027 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31028 can use the same condition (with different parameters) more than once in the
31029 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31030 The conditions are as follows:
31031
31032
31033 .vlist
31034 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31035 .cindex "&ACL;" "nested"
31036 .cindex "&ACL;" "indirect"
31037 .cindex "&ACL;" "arguments"
31038 .cindex "&%acl%& ACL condition"
31039 The possible values of the argument are the same as for the
31040 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31041 &"accept"& the condition is true; if it returns &"deny"& the condition is
31042 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31043 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31044 condition false. This means that further processing of the &%warn%& verb
31045 ceases, but processing of the ACL continues.
31046
31047 If the argument is a named ACL, up to nine space-separated optional values
31048 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31049 and $acl_narg is set to the count of values.
31050 Previous values of these variables are restored after the call returns.
31051 The name and values are expanded separately.
31052 Note that spaces in complex expansions which are used as arguments
31053 will act as argument separators.
31054
31055 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31056 the connection is dropped. If it returns &"discard"&, the verb must be
31057 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31058 conditions are tested.
31059
31060 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31061 loops. This condition allows you to use different ACLs in different
31062 circumstances. For example, different ACLs can be used to handle RCPT commands
31063 for different local users or different local domains.
31064
31065 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31066 .cindex "&%authenticated%& ACL condition"
31067 .cindex "authentication" "ACL checking"
31068 .cindex "&ACL;" "testing for authentication"
31069 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31070 the name of the authenticator is tested against the list. To test for
31071 authentication by any authenticator, you can set
31072 .code
31073 authenticated = *
31074 .endd
31075
31076 .vitem &*condition&~=&~*&<&'string'&>
31077 .cindex "&%condition%& ACL condition"
31078 .cindex "customizing" "ACL condition"
31079 .cindex "&ACL;" "customized test"
31080 .cindex "&ACL;" "testing, customized"
31081 This feature allows you to make up custom conditions. If the result of
31082 expanding the string is an empty string, the number zero, or one of the strings
31083 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31084 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31085 any other value, some error is assumed to have occurred, and the ACL returns
31086 &"defer"&. However, if the expansion is forced to fail, the condition is
31087 ignored. The effect is to treat it as true, whether it is positive or
31088 negative.
31089
31090 .vitem &*decode&~=&~*&<&'location'&>
31091 .cindex "&%decode%& ACL condition"
31092 This condition is available only when Exim is compiled with the
31093 content-scanning extension, and it is allowed only in the ACL defined by
31094 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31095 If all goes well, the condition is true. It is false only if there are
31096 problems such as a syntax error or a memory shortage. For more details, see
31097 chapter &<<CHAPexiscan>>&.
31098
31099 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31100 .cindex "&%dnslists%& ACL condition"
31101 .cindex "DNS list" "in ACL"
31102 .cindex "black list (DNS)"
31103 .cindex "&ACL;" "testing a DNS list"
31104 This condition checks for entries in DNS black lists. These are also known as
31105 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31106 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31107 different variants of this condition to describe briefly here. See sections
31108 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31109
31110 .vitem &*domains&~=&~*&<&'domain&~list'&>
31111 .cindex "&%domains%& ACL condition"
31112 .cindex "domain" "ACL checking"
31113 .cindex "&ACL;" "testing a recipient domain"
31114 .vindex "&$domain_data$&"
31115 This condition is relevant only after a RCPT command. It checks that the domain
31116 of the recipient address is in the domain list. If percent-hack processing is
31117 enabled, it is done before this test is done. If the check succeeds with a
31118 lookup, the result of the lookup is placed in &$domain_data$& until the next
31119 &%domains%& test.
31120
31121 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31122 use &%domains%& in a DATA ACL.
31123
31124
31125 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31126 .cindex "&%encrypted%& ACL condition"
31127 .cindex "encryption" "checking in an ACL"
31128 .cindex "&ACL;" "testing for encryption"
31129 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31130 name of the cipher suite in use is tested against the list. To test for
31131 encryption without testing for any specific cipher suite(s), set
31132 .code
31133 encrypted = *
31134 .endd
31135
31136
31137 .vitem &*hosts&~=&~*&<&'host&~list'&>
31138 .cindex "&%hosts%& ACL condition"
31139 .cindex "host" "ACL checking"
31140 .cindex "&ACL;" "testing the client host"
31141 This condition tests that the calling host matches the host list. If you have
31142 name lookups or wildcarded host names and IP addresses in the same host list,
31143 you should normally put the IP addresses first. For example, you could have:
31144 .code
31145 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31146 .endd
31147 The lookup in this example uses the host name for its key. This is implied by
31148 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31149 and it wouldn't matter which way round you had these two items.)
31150
31151 The reason for the problem with host names lies in the left-to-right way that
31152 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31153 but when it reaches an item that requires a host name, it fails if it cannot
31154 find a host name to compare with the pattern. If the above list is given in the
31155 opposite order, the &%accept%& statement fails for a host whose name cannot be
31156 found, even if its IP address is 10.9.8.7.
31157
31158 If you really do want to do the name check first, and still recognize the IP
31159 address even if the name lookup fails, you can rewrite the ACL like this:
31160 .code
31161 accept hosts = dbm;/etc/friendly/hosts
31162 accept hosts = 10.9.8.7
31163 .endd
31164 The default action on failing to find the host name is to assume that the host
31165 is not in the list, so the first &%accept%& statement fails. The second
31166 statement can then check the IP address.
31167
31168 .vindex "&$host_data$&"
31169 If a &%hosts%& condition is satisfied by means of a lookup, the result
31170 of the lookup is made available in the &$host_data$& variable. This
31171 allows you, for example, to set up a statement like this:
31172 .code
31173 deny  hosts = net-lsearch;/some/file
31174 message = $host_data
31175 .endd
31176 which gives a custom error message for each denied host.
31177
31178 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31179 .cindex "&%local_parts%& ACL condition"
31180 .cindex "local part" "ACL checking"
31181 .cindex "&ACL;" "testing a local part"
31182 .vindex "&$local_part_data$&"
31183 This condition is relevant only after a RCPT command. It checks that the local
31184 part of the recipient address is in the list. If percent-hack processing is
31185 enabled, it is done before this test. If the check succeeds with a lookup, the
31186 result of the lookup is placed in &$local_part_data$&, which remains set until
31187 the next &%local_parts%& test.
31188
31189 .vitem &*malware&~=&~*&<&'option'&>
31190 .cindex "&%malware%& ACL condition"
31191 .cindex "&ACL;" "virus scanning"
31192 .cindex "&ACL;" "scanning for viruses"
31193 This condition is available only when Exim is compiled with the
31194 content-scanning extension
31195 and only after a DATA command.
31196 It causes the incoming message to be scanned for
31197 viruses. For details, see chapter &<<CHAPexiscan>>&.
31198
31199 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31200 .cindex "&%mime_regex%& ACL condition"
31201 .cindex "&ACL;" "testing by regex matching"
31202 This condition is available only when Exim is compiled with the
31203 content-scanning extension, and it is allowed only in the ACL defined by
31204 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31205 with any of the regular expressions. For details, see chapter
31206 &<<CHAPexiscan>>&.
31207
31208 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31209 .cindex "rate limiting"
31210 This condition can be used to limit the rate at which a user or host submits
31211 messages. Details are given in section &<<SECTratelimiting>>&.
31212
31213 .vitem &*recipients&~=&~*&<&'address&~list'&>
31214 .cindex "&%recipients%& ACL condition"
31215 .cindex "recipient" "ACL checking"
31216 .cindex "&ACL;" "testing a recipient"
31217 This condition is relevant only after a RCPT command. It checks the entire
31218 recipient address against a list of recipients.
31219
31220 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31221 .cindex "&%regex%& ACL condition"
31222 .cindex "&ACL;" "testing by regex matching"
31223 This condition is available only when Exim is compiled with the
31224 content-scanning extension, and is available only in the DATA, MIME, and
31225 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31226 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31227
31228 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31229 .cindex "&%sender_domains%& ACL condition"
31230 .cindex "sender" "ACL checking"
31231 .cindex "&ACL;" "testing a sender domain"
31232 .vindex "&$domain$&"
31233 .vindex "&$sender_address_domain$&"
31234 This condition tests the domain of the sender of the message against the given
31235 domain list. &*Note*&: The domain of the sender address is in
31236 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31237 of this condition. This is an exception to the general rule for testing domain
31238 lists. It is done this way so that, if this condition is used in an ACL for a
31239 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31240 influence the sender checking.
31241
31242 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31243 relaying, because sender addresses are easily, and commonly, forged.
31244
31245 .vitem &*senders&~=&~*&<&'address&~list'&>
31246 .cindex "&%senders%& ACL condition"
31247 .cindex "sender" "ACL checking"
31248 .cindex "&ACL;" "testing a sender"
31249 This condition tests the sender of the message against the given list. To test
31250 for a bounce message, which has an empty sender, set
31251 .code
31252 senders = :
31253 .endd
31254 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31255 relaying, because sender addresses are easily, and commonly, forged.
31256
31257 .vitem &*spam&~=&~*&<&'username'&>
31258 .cindex "&%spam%& ACL condition"
31259 .cindex "&ACL;" "scanning for spam"
31260 This condition is available only when Exim is compiled with the
31261 content-scanning extension. It causes the incoming message to be scanned by
31262 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31263
31264 .vitem &*verify&~=&~certificate*&
31265 .cindex "&%verify%& ACL condition"
31266 .cindex "TLS" "client certificate verification"
31267 .cindex "certificate" "verification of client"
31268 .cindex "&ACL;" "certificate verification"
31269 .cindex "&ACL;" "testing a TLS certificate"
31270 This condition is true in an SMTP session if the session is encrypted, and a
31271 certificate was received from the client, and the certificate was verified. The
31272 server requests a certificate only if the client matches &%tls_verify_hosts%&
31273 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31274
31275 .vitem &*verify&~=&~csa*&
31276 .cindex "CSA verification"
31277 This condition checks whether the sending host (the client) is authorized to
31278 send email. Details of how this works are given in section
31279 &<<SECTverifyCSA>>&.
31280
31281 .vitem &*verify&~=&~header_names_ascii*&
31282 .cindex "&%verify%& ACL condition"
31283 .cindex "&ACL;" "verifying header names only ASCII"
31284 .cindex "header lines" "verifying header names only ASCII"
31285 .cindex "verifying" "header names only ASCII"
31286 This condition is relevant only in an ACL that is run after a message has been
31287 received, that is, in an ACL specified by &%acl_smtp_data%& or
31288 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31289 there are no non-ASCII characters, also excluding control characters.  The
31290 allowable characters are decimal ASCII values 33 through 126.
31291
31292 Exim itself will handle headers with non-ASCII characters, but it can cause
31293 problems for downstream applications, so this option will allow their
31294 detection and rejection in the DATA ACL's.
31295
31296 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31297 .cindex "&%verify%& ACL condition"
31298 .cindex "&ACL;" "verifying sender in the header"
31299 .cindex "header lines" "verifying the sender in"
31300 .cindex "sender" "verifying in header"
31301 .cindex "verifying" "sender in header"
31302 This condition is relevant only in an ACL that is run after a message has been
31303 received, that is, in an ACL specified by &%acl_smtp_data%& or
31304 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31305 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31306 is loosely thought of as a &"sender"& address (hence the name of the test).
31307 However, an address that appears in one of these headers need not be an address
31308 that accepts bounce messages; only sender addresses in envelopes are required
31309 to accept bounces. Therefore, if you use the callout option on this check, you
31310 might want to arrange for a non-empty address in the MAIL command.
31311
31312 Details of address verification and the options are given later, starting at
31313 section &<<SECTaddressverification>>& (callouts are described in section
31314 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31315 condition to restrict it to bounce messages only:
31316 .code
31317 deny    senders = :
31318         message = A valid sender header is required for bounces
31319        !verify  = header_sender
31320 .endd
31321
31322 .vitem &*verify&~=&~header_syntax*&
31323 .cindex "&%verify%& ACL condition"
31324 .cindex "&ACL;" "verifying header syntax"
31325 .cindex "header lines" "verifying syntax"
31326 .cindex "verifying" "header syntax"
31327 This condition is relevant only in an ACL that is run after a message has been
31328 received, that is, in an ACL specified by &%acl_smtp_data%& or
31329 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31330 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31331 and &'Bcc:'&), returning true if there are no problems.
31332 Unqualified addresses (local parts without domains) are
31333 permitted only in locally generated messages and from hosts that match
31334 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31335 appropriate.
31336
31337 Note that this condition is a syntax check only. However, a common spamming
31338 ploy used to be to send syntactically invalid headers such as
31339 .code
31340 To: @
31341 .endd
31342 and this condition can be used to reject such messages, though they are not as
31343 common as they used to be.
31344
31345 .vitem &*verify&~=&~helo*&
31346 .cindex "&%verify%& ACL condition"
31347 .cindex "&ACL;" "verifying HELO/EHLO"
31348 .cindex "HELO" "verifying"
31349 .cindex "EHLO" "verifying"
31350 .cindex "verifying" "EHLO"
31351 .cindex "verifying" "HELO"
31352 This condition is true if a HELO or EHLO command has been received from the
31353 client host, and its contents have been verified. If there has been no previous
31354 attempt to verify the HELO/EHLO contents, it is carried out when this
31355 condition is encountered. See the description of the &%helo_verify_hosts%& and
31356 &%helo_try_verify_hosts%& options for details of how to request verification
31357 independently of this condition, and for detail of the verification.
31358
31359 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31360 option), this condition is always true.
31361
31362
31363 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31364 .cindex "verifying" "not blind"
31365 .cindex "bcc recipients, verifying none"
31366 This condition checks that there are no blind (bcc) recipients in the message.
31367 Every envelope recipient must appear either in a &'To:'& header line or in a
31368 &'Cc:'& header line for this condition to be true. Local parts are checked
31369 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31370 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31371 used only in a DATA or non-SMTP ACL.
31372
31373 There is one possible option, &`case_insensitive`&.  If this is present then
31374 local parts are checked case-insensitively.
31375
31376 There are, of course, many legitimate messages that make use of blind (bcc)
31377 recipients. This check should not be used on its own for blocking messages.
31378
31379
31380 .vitem &*verify&~=&~recipient/*&<&'options'&>
31381 .cindex "&%verify%& ACL condition"
31382 .cindex "&ACL;" "verifying recipient"
31383 .cindex "recipient" "verifying"
31384 .cindex "verifying" "recipient"
31385 .vindex "&$address_data$&"
31386 This condition is relevant only after a RCPT command. It verifies the current
31387 recipient. Details of address verification are given later, starting at section
31388 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31389 of &$address_data$& is the last value that was set while routing the address.
31390 This applies even if the verification fails. When an address that is being
31391 verified is redirected to a single address, verification continues with the new
31392 address, and in that case, the subsequent value of &$address_data$& is the
31393 value for the child address.
31394
31395 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31396 .cindex "&%verify%& ACL condition"
31397 .cindex "&ACL;" "verifying host reverse lookup"
31398 .cindex "host" "verifying reverse lookup"
31399 This condition ensures that a verified host name has been looked up from the IP
31400 address of the client host. (This may have happened already if the host name
31401 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31402 Verification ensures that the host name obtained from a reverse DNS lookup, or
31403 one of its aliases, does, when it is itself looked up in the DNS, yield the
31404 original IP address.
31405
31406 There is one possible option, &`defer_ok`&.  If this is present and a
31407 DNS operation returns a temporary error, the verify condition succeeds.
31408
31409 If this condition is used for a locally generated message (that is, when there
31410 is no client host involved), it always succeeds.
31411
31412 .vitem &*verify&~=&~sender/*&<&'options'&>
31413 .cindex "&%verify%& ACL condition"
31414 .cindex "&ACL;" "verifying sender"
31415 .cindex "sender" "verifying"
31416 .cindex "verifying" "sender"
31417 This condition is relevant only after a MAIL or RCPT command, or after a
31418 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31419 the message's sender is empty (that is, this is a bounce message), the
31420 condition is true. Otherwise, the sender address is verified.
31421
31422 .vindex "&$address_data$&"
31423 .vindex "&$sender_address_data$&"
31424 If there is data in the &$address_data$& variable at the end of routing, its
31425 value is placed in &$sender_address_data$& at the end of verification. This
31426 value can be used in subsequent conditions and modifiers in the same ACL
31427 statement. It does not persist after the end of the current statement. If you
31428 want to preserve the value for longer, you can save it in an ACL variable.
31429
31430 Details of verification are given later, starting at section
31431 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31432 to avoid doing it more than once per message.
31433
31434 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31435 .cindex "&%verify%& ACL condition"
31436 This is a variation of the previous option, in which a modified address is
31437 verified as a sender.
31438
31439 Note that '/' is legal in local-parts; if the address may have such
31440 (eg. is generated from the received message)
31441 they must be protected from the options parsing by doubling:
31442 .code
31443 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31444 .endd
31445 .endlist
31446
31447
31448
31449 .section "Using DNS lists" "SECTmorednslists"
31450 .cindex "DNS list" "in ACL"
31451 .cindex "black list (DNS)"
31452 .cindex "&ACL;" "testing a DNS list"
31453 In its simplest form, the &%dnslists%& condition tests whether the calling host
31454 is on at least one of a number of DNS lists by looking up the inverted IP
31455 address in one or more DNS domains. (Note that DNS list domains are not mail
31456 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31457 special options instead.) For example, if the calling host's IP
31458 address is 192.168.62.43, and the ACL statement is
31459 .code
31460 deny dnslists = blackholes.mail-abuse.org : \
31461                 dialups.mail-abuse.org
31462 .endd
31463 the following records are looked up:
31464 .code
31465 43.62.168.192.blackholes.mail-abuse.org
31466 43.62.168.192.dialups.mail-abuse.org
31467 .endd
31468 As soon as Exim finds an existing DNS record, processing of the list stops.
31469 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31470 to test that a host is on more than one list (an &"and"& conjunction), you can
31471 use two separate conditions:
31472 .code
31473 deny dnslists = blackholes.mail-abuse.org
31474      dnslists = dialups.mail-abuse.org
31475 .endd
31476 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31477 behaves as if the host does not match the list item, that is, as if the DNS
31478 record does not exist. If there are further items in the DNS list, they are
31479 processed.
31480
31481 This is usually the required action when &%dnslists%& is used with &%deny%&
31482 (which is the most common usage), because it prevents a DNS failure from
31483 blocking mail. However, you can change this behaviour by putting one of the
31484 following special items in the list:
31485 .display
31486 &`+include_unknown `&   behave as if the item is on the list
31487 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31488 &`+defer_unknown   `&   give a temporary error
31489 .endd
31490 .cindex "&`+include_unknown`&"
31491 .cindex "&`+exclude_unknown`&"
31492 .cindex "&`+defer_unknown`&"
31493 Each of these applies to any subsequent items on the list. For example:
31494 .code
31495 deny dnslists = +defer_unknown : foo.bar.example
31496 .endd
31497 Testing the list of domains stops as soon as a match is found. If you want to
31498 warn for one list and block for another, you can use two different statements:
31499 .code
31500 deny  dnslists = blackholes.mail-abuse.org
31501 warn  message  = X-Warn: sending host is on dialups list
31502       dnslists = dialups.mail-abuse.org
31503 .endd
31504 .cindex caching "of dns lookup"
31505 .cindex DNS TTL
31506 DNS list lookups are cached by Exim for the duration of the SMTP session
31507 (but limited by the DNS return TTL value),
31508 so a lookup based on the IP address is done at most once for any incoming
31509 connection (assuming long-enough TTL).
31510 Exim does not share information between multiple incoming
31511 connections (but your local name server cache should be active).
31512
31513 There are a number of DNS lists to choose from, some commercial, some free,
31514 or free for small deployments.  An overview can be found at
31515 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31516
31517
31518
31519 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31520 .cindex "DNS list" "keyed by explicit IP address"
31521 By default, the IP address that is used in a DNS list lookup is the IP address
31522 of the calling host. However, you can specify another IP address by listing it
31523 after the domain name, introduced by a slash. For example:
31524 .code
31525 deny dnslists = black.list.tld/192.168.1.2
31526 .endd
31527 This feature is not very helpful with explicit IP addresses; it is intended for
31528 use with IP addresses that are looked up, for example, the IP addresses of the
31529 MX hosts or nameservers of an email sender address. For an example, see section
31530 &<<SECTmulkeyfor>>& below.
31531
31532
31533
31534
31535 .section "DNS lists keyed on domain names" "SECID202"
31536 .cindex "DNS list" "keyed by domain name"
31537 There are some lists that are keyed on domain names rather than inverted IP
31538 addresses (see, e.g., the &'domain based zones'& link at
31539 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31540 with these lists. You can change the name that is looked up in a DNS list by
31541 listing it after the domain name, introduced by a slash. For example,
31542 .code
31543 deny  message  = Sender's domain is listed at $dnslist_domain
31544       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31545 .endd
31546 This particular example is useful only in ACLs that are obeyed after the
31547 RCPT or DATA commands, when a sender address is available. If (for
31548 example) the message's sender is &'user@tld.example'& the name that is looked
31549 up by this example is
31550 .code
31551 tld.example.dsn.rfc-ignorant.org
31552 .endd
31553 A single &%dnslists%& condition can contain entries for both names and IP
31554 addresses. For example:
31555 .code
31556 deny dnslists = sbl.spamhaus.org : \
31557                 dsn.rfc-ignorant.org/$sender_address_domain
31558 .endd
31559 The first item checks the sending host's IP address; the second checks a domain
31560 name. The whole condition is true if either of the DNS lookups succeeds.
31561
31562
31563
31564
31565 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31566 .cindex "DNS list" "multiple keys for"
31567 The syntax described above for looking up explicitly-defined values (either
31568 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31569 name for the DNS list, what follows the slash can in fact be a list of items.
31570 As with all lists in Exim, the default separator is a colon. However, because
31571 this is a sublist within the list of DNS blacklist domains, it is necessary
31572 either to double the separators like this:
31573 .code
31574 dnslists = black.list.tld/name.1::name.2
31575 .endd
31576 or to change the separator character, like this:
31577 .code
31578 dnslists = black.list.tld/<;name.1;name.2
31579 .endd
31580 If an item in the list is an IP address, it is inverted before the DNS
31581 blacklist domain is appended. If it is not an IP address, no inversion
31582 occurs. Consider this condition:
31583 .code
31584 dnslists = black.list.tld/<;192.168.1.2;a.domain
31585 .endd
31586 The DNS lookups that occur are:
31587 .code
31588 2.1.168.192.black.list.tld
31589 a.domain.black.list.tld
31590 .endd
31591 Once a DNS record has been found (that matches a specific IP return
31592 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31593 are done. If there is a temporary DNS error, the rest of the sublist of domains
31594 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31595 only if no other DNS lookup in this sublist succeeds. In other words, a
31596 successful lookup for any of the items in the sublist overrides a temporary
31597 error for a previous item.
31598
31599 The ability to supply a list of items after the slash is in some sense just a
31600 syntactic convenience. These two examples have the same effect:
31601 .code
31602 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31603 dnslists = black.list.tld/a.domain::b.domain
31604 .endd
31605 However, when the data for the list is obtained from a lookup, the second form
31606 is usually much more convenient. Consider this example:
31607 .code
31608 deny message  = The mail servers for the domain \
31609                 $sender_address_domain \
31610                 are listed at $dnslist_domain ($dnslist_value); \
31611                 see $dnslist_text.
31612      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31613                                    ${lookup dnsdb {>|mxh=\
31614                                    $sender_address_domain} }} }
31615 .endd
31616 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31617 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31618 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31619 of expanding the condition might be something like this:
31620 .code
31621 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31622 .endd
31623 Thus, this example checks whether or not the IP addresses of the sender
31624 domain's mail servers are on the Spamhaus black list.
31625
31626 The key that was used for a successful DNS list lookup is put into the variable
31627 &$dnslist_matched$& (see section &<<SECID204>>&).
31628
31629
31630
31631
31632 .section "Data returned by DNS lists" "SECID203"
31633 .cindex "DNS list" "data returned from"
31634 DNS lists are constructed using address records in the DNS. The original RBL
31635 just used the address 127.0.0.1 on the right hand side of each record, but the
31636 RBL+ list and some other lists use a number of values with different meanings.
31637 The values used on the RBL+ list are:
31638 .display
31639 127.1.0.1  RBL
31640 127.1.0.2  DUL
31641 127.1.0.3  DUL and RBL
31642 127.1.0.4  RSS
31643 127.1.0.5  RSS and RBL
31644 127.1.0.6  RSS and DUL
31645 127.1.0.7  RSS and DUL and RBL
31646 .endd
31647 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31648 different values. Some DNS lists may return more than one address record;
31649 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31650
31651
31652 .section "Variables set from DNS lists" "SECID204"
31653 .cindex "expansion" "variables, set from DNS list"
31654 .cindex "DNS list" "variables set from"
31655 .vindex "&$dnslist_domain$&"
31656 .vindex "&$dnslist_matched$&"
31657 .vindex "&$dnslist_text$&"
31658 .vindex "&$dnslist_value$&"
31659 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31660 the name of the overall domain that matched (for example,
31661 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31662 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31663 the DNS record. When the key is an IP address, it is not reversed in
31664 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31665 cases, for example:
31666 .code
31667 deny dnslists = spamhaus.example
31668 .endd
31669 the key is also available in another variable (in this case,
31670 &$sender_host_address$&). In more complicated cases, however, this is not true.
31671 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31672 might generate a dnslists lookup like this:
31673 .code
31674 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31675 .endd
31676 If this condition succeeds, the value in &$dnslist_matched$& might be
31677 &`192.168.6.7`& (for example).
31678
31679 If more than one address record is returned by the DNS lookup, all the IP
31680 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31681 The variable &$dnslist_text$& contains the contents of any associated TXT
31682 record. For lists such as RBL+ the TXT record for a merged entry is often not
31683 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31684 information.
31685
31686 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31687 &-- although these appear before the condition in the ACL, they are not
31688 expanded until after it has failed. For example:
31689 .code
31690 deny    hosts = !+local_networks
31691         message = $sender_host_address is listed \
31692                   at $dnslist_domain
31693         dnslists = rbl-plus.mail-abuse.example
31694 .endd
31695
31696
31697
31698 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31699 .cindex "DNS list" "matching specific returned data"
31700 You can add an equals sign and an IP address after a &%dnslists%& domain name
31701 in order to restrict its action to DNS records with a matching right hand side.
31702 For example,
31703 .code
31704 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31705 .endd
31706 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31707 any address record is considered to be a match. For the moment, we assume
31708 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31709 describes how multiple records are handled.
31710
31711 More than one IP address may be given for checking, using a comma as a
31712 separator. These are alternatives &-- if any one of them matches, the
31713 &%dnslists%& condition is true. For example:
31714 .code
31715 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31716 .endd
31717 If you want to specify a constraining address list and also specify names or IP
31718 addresses to be looked up, the constraining address list must be specified
31719 first. For example:
31720 .code
31721 deny dnslists = dsn.rfc-ignorant.org\
31722                 =127.0.0.2/$sender_address_domain
31723 .endd
31724
31725 If the character &`&&`& is used instead of &`=`&, the comparison for each
31726 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31727 In other words, the listed addresses are used as bit masks. The comparison is
31728 true if all the bits in the mask are present in the address that is being
31729 tested. For example:
31730 .code
31731 dnslists = a.b.c&0.0.0.3
31732 .endd
31733 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31734 want to test whether one bit or another bit is present (as opposed to both
31735 being present), you must use multiple values. For example:
31736 .code
31737 dnslists = a.b.c&0.0.0.1,0.0.0.2
31738 .endd
31739 matches if the final component of the address is an odd number or two times
31740 an odd number.
31741
31742
31743
31744 .section "Negated DNS matching conditions" "SECID205"
31745 You can supply a negative list of IP addresses as part of a &%dnslists%&
31746 condition. Whereas
31747 .code
31748 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31749 .endd
31750 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31751 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31752 .code
31753 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31754 .endd
31755 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31756 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31757 words, the result of the test is inverted if an exclamation mark appears before
31758 the &`=`& (or the &`&&`&) sign.
31759
31760 &*Note*&: This kind of negation is not the same as negation in a domain,
31761 host, or address list (which is why the syntax is different).
31762
31763 If you are using just one list, the negation syntax does not gain you much. The
31764 previous example is precisely equivalent to
31765 .code
31766 deny  dnslists = a.b.c
31767      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31768 .endd
31769 However, if you are using multiple lists, the negation syntax is clearer.
31770 Consider this example:
31771 .code
31772 deny  dnslists = sbl.spamhaus.org : \
31773                  list.dsbl.org : \
31774                  dnsbl.njabl.org!=127.0.0.3 : \
31775                  relays.ordb.org
31776 .endd
31777 Using only positive lists, this would have to be:
31778 .code
31779 deny  dnslists = sbl.spamhaus.org : \
31780                  list.dsbl.org
31781 deny  dnslists = dnsbl.njabl.org
31782      !dnslists = dnsbl.njabl.org=127.0.0.3
31783 deny  dnslists = relays.ordb.org
31784 .endd
31785 which is less clear, and harder to maintain.
31786
31787
31788
31789
31790 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31791 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31792 thereby providing more than one IP address. When an item in a &%dnslists%& list
31793 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31794 the match to specific results from the DNS lookup, there are two ways in which
31795 the checking can be handled. For example, consider the condition:
31796 .code
31797 dnslists = a.b.c=127.0.0.1
31798 .endd
31799 What happens if the DNS lookup for the incoming IP address yields both
31800 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31801 condition true because at least one given value was found, or is it false
31802 because at least one of the found values was not listed? And how does this
31803 affect negated conditions? Both possibilities are provided for with the help of
31804 additional separators &`==`& and &`=&&`&.
31805
31806 .ilist
31807 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31808 IP addresses matches one of the listed addresses. For the example above, the
31809 condition is true because 127.0.0.1 matches.
31810 .next
31811 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31812 looked up IP addresses matches one of the listed addresses. If the condition is
31813 changed to:
31814 .code
31815 dnslists = a.b.c==127.0.0.1
31816 .endd
31817 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31818 false because 127.0.0.2 is not listed. You would need to have:
31819 .code
31820 dnslists = a.b.c==127.0.0.1,127.0.0.2
31821 .endd
31822 for the condition to be true.
31823 .endlist
31824
31825 When &`!`& is used to negate IP address matching, it inverts the result, giving
31826 the precise opposite of the behaviour above. Thus:
31827 .ilist
31828 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31829 addresses matches one of the listed addresses. Consider:
31830 .code
31831 dnslists = a.b.c!&0.0.0.1
31832 .endd
31833 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31834 false because 127.0.0.1 matches.
31835 .next
31836 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31837 looked up IP address that does not match. Consider:
31838 .code
31839 dnslists = a.b.c!=&0.0.0.1
31840 .endd
31841 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31842 true, because 127.0.0.2 does not match. You would need to have:
31843 .code
31844 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31845 .endd
31846 for the condition to be false.
31847 .endlist
31848 When the DNS lookup yields only a single IP address, there is no difference
31849 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31850
31851
31852
31853
31854 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31855 .cindex "DNS list" "information from merged"
31856 When the facility for restricting the matching IP values in a DNS list is used,
31857 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31858 the true reason for rejection. This happens when lists are merged and the IP
31859 address in the A record is used to distinguish them; unfortunately there is
31860 only one TXT record. One way round this is not to use merged lists, but that
31861 can be inefficient because it requires multiple DNS lookups where one would do
31862 in the vast majority of cases when the host of interest is not on any of the
31863 lists.
31864
31865 A less inefficient way of solving this problem is available. If
31866 two domain names, comma-separated, are given, the second is used first to
31867 do an initial check, making use of any IP value restrictions that are set.
31868 If there is a match, the first domain is used, without any IP value
31869 restrictions, to get the TXT record. As a byproduct of this, there is also
31870 a check that the IP being tested is indeed on the first list. The first
31871 domain is the one that is put in &$dnslist_domain$&. For example:
31872 .code
31873 deny message  = \
31874          rejected because $sender_host_address is blacklisted \
31875          at $dnslist_domain\n$dnslist_text
31876        dnslists = \
31877          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31878          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31879 .endd
31880 For the first blacklist item, this starts by doing a lookup in
31881 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31882 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31883 value, and as long as something is found, it looks for the corresponding TXT
31884 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31885 The second blacklist item is processed similarly.
31886
31887 If you are interested in more than one merged list, the same list must be
31888 given several times, but because the results of the DNS lookups are cached,
31889 the DNS calls themselves are not repeated. For example:
31890 .code
31891 deny dnslists = \
31892          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31893          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31894          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31895          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31896 .endd
31897 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31898 values matches (or if no record is found), this is the only lookup that is
31899 done. Only if there is a match is one of the more specific lists consulted.
31900
31901
31902
31903 .section "DNS lists and IPv6" "SECTmorednslistslast"
31904 .cindex "IPv6" "DNS black lists"
31905 .cindex "DNS list" "IPv6 usage"
31906 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31907 nibble by nibble. For example, if the calling host's IP address is
31908 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31909 .code
31910 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31911   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31912 .endd
31913 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31914 lists contain wildcard records, intended for IPv4, that interact badly with
31915 IPv6. For example, the DNS entry
31916 .code
31917 *.3.some.list.example.    A    127.0.0.1
31918 .endd
31919 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31920 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31921
31922 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31923 &%condition%& condition, as in this example:
31924 .code
31925 deny   condition = ${if isip4{$sender_host_address}}
31926        dnslists  = some.list.example
31927 .endd
31928
31929 If an explicit key is being used for a DNS lookup and it may be an IPv6
31930 address you should specify alternate list separators for both the outer
31931 (DNS list name) list and inner (lookup keys) list:
31932 .code
31933        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31934 .endd
31935
31936 .section "Rate limiting incoming messages" "SECTratelimiting"
31937 .cindex "rate limiting" "client sending"
31938 .cindex "limiting client sending rates"
31939 .oindex "&%smtp_ratelimit_*%&"
31940 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31941 which clients can send email. This is more powerful than the
31942 &%smtp_ratelimit_*%& options, because those options control the rate of
31943 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31944 works across all connections (concurrent and sequential) from the same client
31945 host. The syntax of the &%ratelimit%& condition is:
31946 .display
31947 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31948 .endd
31949 If the average client sending rate is less than &'m'& messages per time
31950 period &'p'& then the condition is false; otherwise it is true.
31951
31952 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31953 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31954 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31955 of &'p'&.
31956
31957 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31958 time interval, for example, &`8h`& for eight hours. A larger time constant
31959 means that it takes Exim longer to forget a client's past behaviour. The
31960 parameter &'m'& is the maximum number of messages that a client is permitted to
31961 send in each time interval. It also specifies the number of messages permitted
31962 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31963 constant, you can allow a client to send more messages in a burst without
31964 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31965 both small, messages must be sent at an even rate.
31966
31967 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31968 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31969 when deploying the &%ratelimit%& ACL condition. The script prints usage
31970 instructions when it is run with no arguments.
31971
31972 The key is used to look up the data for calculating the client's average
31973 sending rate. This data is stored in Exim's spool directory, alongside the
31974 retry and other hints databases. The default key is &$sender_host_address$&,
31975 which means Exim computes the sending rate of each client host IP address.
31976 By changing the key you can change how Exim identifies clients for the purpose
31977 of ratelimiting. For example, to limit the sending rate of each authenticated
31978 user, independent of the computer they are sending from, set the key to
31979 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31980 example, &$authenticated_id$& is only meaningful if the client has
31981 authenticated (which you can check with the &%authenticated%& ACL condition).
31982
31983 The lookup key does not have to identify clients: If you want to limit the
31984 rate at which a recipient receives messages, you can use the key
31985 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31986 ACL.
31987
31988 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31989 specifies what Exim measures the rate of, for example, messages or recipients
31990 or bytes. You can adjust the measurement using the &%unique=%& and/or
31991 &%count=%& options. You can also control when Exim updates the recorded rate
31992 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31993 separated by a slash, like the other parameters. They may appear in any order.
31994
31995 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31996 any options that alter the meaning of the stored data. The limit &'m'& is not
31997 stored, so you can alter the configured maximum rate and Exim will still
31998 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31999 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32000 behaviour. The lookup key is not affected by changes to the update mode and
32001 the &%count=%& option.
32002
32003
32004 .section "Ratelimit options for what is being measured" "ratoptmea"
32005 .cindex "rate limiting" "per_* options"
32006 The &%per_conn%& option limits the client's connection rate. It is not
32007 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32008 &%acl_not_smtp_start%& ACLs.
32009
32010 The &%per_mail%& option limits the client's rate of sending messages. This is
32011 the default if none of the &%per_*%& options is specified. It can be used in
32012 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32013 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32014
32015 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32016 the same ACLs as the &%per_mail%& option, though it is best to use this option
32017 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32018 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32019 in its MAIL command, which may be inaccurate or completely missing. You can
32020 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32021 in kilobytes, megabytes, or gigabytes, respectively.
32022
32023 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32024 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32025 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32026 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32027 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32028 in either case the rate limiting engine will see a message with many
32029 recipients as a large high-speed burst.
32030
32031 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32032 number of different recipients that the client has sent messages to in the
32033 last time period. That is, if the client repeatedly sends messages to the same
32034 recipient, its measured rate is not increased. This option can only be used in
32035 &%acl_smtp_rcpt%&.
32036
32037 The &%per_cmd%& option causes Exim to recompute the rate every time the
32038 condition is processed. This can be used to limit the rate of any SMTP
32039 command. If it is used in multiple ACLs it can limit the aggregate rate of
32040 multiple different commands.
32041
32042 The &%count=%& option can be used to alter how much Exim adds to the client's
32043 measured rate. For example, the &%per_byte%& option is equivalent to
32044 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32045 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32046 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32047
32048 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32049
32050
32051 .section "Ratelimit update modes" "ratoptupd"
32052 .cindex "rate limiting" "reading data without updating"
32053 You can specify one of three options with the &%ratelimit%& condition to
32054 control when its database is updated. This section describes the &%readonly%&
32055 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32056
32057 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32058 previously-computed rate to check against the limit.
32059
32060 For example, you can test the client's sending rate and deny it access (when
32061 it is too fast) in the connect ACL. If the client passes this check then it
32062 can go on to send a message, in which case its recorded rate will be updated
32063 in the MAIL ACL. Subsequent connections from the same client will check this
32064 new rate.
32065 .code
32066 acl_check_connect:
32067  deny ratelimit = 100 / 5m / readonly
32068     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32069                   (max $sender_rate_limit)
32070 # ...
32071 acl_check_mail:
32072  warn ratelimit = 100 / 5m / strict
32073     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32074                   (max $sender_rate_limit)
32075 .endd
32076
32077 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32078 processing a message then it may increase the client's measured rate more than
32079 it should. For example, this will happen if you check the &%per_rcpt%& option
32080 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32081 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32082 multiple update problems by using the &%readonly%& option on later ratelimit
32083 checks.
32084
32085 The &%per_*%& options described above do not make sense in some ACLs. If you
32086 use a &%per_*%& option in an ACL where it is not normally permitted then the
32087 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32088 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32089 next section) so you must specify the &%readonly%& option explicitly.
32090
32091
32092 .section "Ratelimit options for handling fast clients" "ratoptfast"
32093 .cindex "rate limiting" "strict and leaky modes"
32094 If a client's average rate is greater than the maximum, the rate limiting
32095 engine can react in two possible ways, depending on the presence of the
32096 &%strict%& or &%leaky%& update modes. This is independent of the other
32097 counter-measures (such as rejecting the message) that may be specified by the
32098 rest of the ACL.
32099
32100 The &%leaky%& (default) option means that the client's recorded rate is not
32101 updated if it is above the limit. The effect of this is that Exim measures the
32102 client's average rate of successfully sent email,
32103 up to the given limit.
32104 This is appropriate if the countermeasure when the condition is true
32105 consists of refusing the message, and
32106 is generally the better choice if you have clients that retry automatically.
32107 If the action when true is anything more complex then this option is
32108 likely not what is wanted.
32109
32110 The &%strict%& option means that the client's recorded rate is always
32111 updated. The effect of this is that Exim measures the client's average rate
32112 of attempts to send email, which can be much higher than the maximum it is
32113 actually allowed. If the client is over the limit it may be subjected to
32114 counter-measures by the ACL. It must slow down and allow sufficient time to
32115 pass that its computed rate falls below the maximum before it can send email
32116 again. The time (the number of smoothing periods) it must wait and not
32117 attempt to send mail can be calculated with this formula:
32118 .code
32119         ln(peakrate/maxrate)
32120 .endd
32121
32122
32123 .section "Limiting the rate of different events" "ratoptuniq"
32124 .cindex "rate limiting" "counting unique events"
32125 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32126 rate of different events. For example, the &%per_addr%& option uses this
32127 mechanism to count the number of different recipients that the client has
32128 sent messages to in the last time period; it is equivalent to
32129 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32130 measure the rate that a client uses different sender addresses with the
32131 options &`per_mail/unique=$sender_address`&.
32132
32133 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32134 has seen for that key. The whole set is thrown away when it is older than the
32135 rate smoothing period &'p'&, so each different event is counted at most once
32136 per period. In the &%leaky%& update mode, an event that causes the client to
32137 go over the limit is not added to the set, in the same way that the client's
32138 recorded rate is not updated in the same situation.
32139
32140 When you combine the &%unique=%& and &%readonly%& options, the specific
32141 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32142 rate.
32143
32144 The &%unique=%& mechanism needs more space in the ratelimit database than the
32145 other &%ratelimit%& options in order to store the event set. The number of
32146 unique values is potentially as large as the rate limit, so the extra space
32147 required increases with larger limits.
32148
32149 The uniqueification is not perfect: there is a small probability that Exim
32150 will think a new event has happened before. If the sender's rate is less than
32151 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32152 the measured rate can go above the limit, in which case Exim may under-count
32153 events by a significant margin. Fortunately, if the rate is high enough (2.7
32154 times the limit) that the false positive rate goes above 9%, then Exim will
32155 throw away the over-full event set before the measured rate falls below the
32156 limit. Therefore the only harm should be that exceptionally high sending rates
32157 are logged incorrectly; any countermeasures you configure will be as effective
32158 as intended.
32159
32160
32161 .section "Using rate limiting" "useratlim"
32162 Exim's other ACL facilities are used to define what counter-measures are taken
32163 when the rate limit is exceeded. This might be anything from logging a warning
32164 (for example, while measuring existing sending rates in order to define
32165 policy), through time delays to slow down fast senders, up to rejecting the
32166 message. For example:
32167 .code
32168 # Log all senders' rates
32169 warn ratelimit = 0 / 1h / strict
32170      log_message = Sender rate $sender_rate / $sender_rate_period
32171
32172 # Slow down fast senders; note the need to truncate $sender_rate
32173 # at the decimal point.
32174 warn ratelimit = 100 / 1h / per_rcpt / strict
32175      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32176                    $sender_rate_limit }s
32177
32178 # Keep authenticated users under control
32179 deny authenticated = *
32180      ratelimit = 100 / 1d / strict / $authenticated_id
32181
32182 # System-wide rate limit
32183 defer message = Sorry, too busy. Try again later.
32184      ratelimit = 10 / 1s / $primary_hostname
32185
32186 # Restrict incoming rate from each host, with a default
32187 # set using a macro and special cases looked up in a table.
32188 defer message = Sender rate exceeds $sender_rate_limit \
32189                messages per $sender_rate_period
32190      ratelimit = ${lookup {$sender_host_address} \
32191                    cdb {DB/ratelimits.cdb} \
32192                    {$value} {RATELIMIT} }
32193 .endd
32194 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32195 especially with the &%per_rcpt%& option, you may suffer from a performance
32196 bottleneck caused by locking on the ratelimit hints database. Apart from
32197 making your ACLs less complicated, you can reduce the problem by using a
32198 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32199 this means that Exim will lose its hints data after a reboot (including retry
32200 hints, the callout cache, and ratelimit data).
32201
32202
32203
32204 .section "Address verification" "SECTaddressverification"
32205 .cindex "verifying address" "options for"
32206 .cindex "policy control" "address verification"
32207 Several of the &%verify%& conditions described in section
32208 &<<SECTaclconditions>>& cause addresses to be verified. Section
32209 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32210 The verification conditions can be followed by options that modify the
32211 verification process. The options are separated from the keyword and from each
32212 other by slashes, and some of them contain parameters. For example:
32213 .code
32214 verify = sender/callout
32215 verify = recipient/defer_ok/callout=10s,defer_ok
32216 .endd
32217 The first stage of address verification, which always happens, is to run the
32218 address through the routers, in &"verify mode"&. Routers can detect the
32219 difference between verification and routing for delivery, and their actions can
32220 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32221 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32222 The available options are as follows:
32223
32224 .ilist
32225 If the &%callout%& option is specified, successful routing to one or more
32226 remote hosts is followed by a &"callout"& to those hosts as an additional
32227 check. Callouts and their sub-options are discussed in the next section.
32228 .next
32229 If there is a defer error while doing verification routing, the ACL
32230 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32231 options, the condition is forced to be true instead. Note that this is a main
32232 verification option as well as a suboption for callouts.
32233 .next
32234 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32235 discusses the reporting of sender address verification failures.
32236 .next
32237 The &%success_on_redirect%& option causes verification always to succeed
32238 immediately after a successful redirection. By default, if a redirection
32239 generates just one address, that address is also verified. See further
32240 discussion in section &<<SECTredirwhilveri>>&.
32241 .endlist
32242
32243 .cindex "verifying address" "differentiating failures"
32244 .vindex "&$recipient_verify_failure$&"
32245 .vindex "&$sender_verify_failure$&"
32246 .vindex "&$acl_verify_message$&"
32247 After an address verification failure, &$acl_verify_message$& contains the
32248 error message that is associated with the failure. It can be preserved by
32249 coding like this:
32250 .code
32251 warn  !verify = sender
32252        set acl_m0 = $acl_verify_message
32253 .endd
32254 If you are writing your own custom rejection message or log message when
32255 denying access, you can use this variable to include information about the
32256 verification failure.
32257
32258 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32259 appropriate) contains one of the following words:
32260
32261 .ilist
32262 &%qualify%&: The address was unqualified (no domain), and the message
32263 was neither local nor came from an exempted host.
32264 .next
32265 &%route%&: Routing failed.
32266 .next
32267 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32268 occurred at or before the MAIL command (that is, on initial
32269 connection, HELO, or MAIL).
32270 .next
32271 &%recipient%&: The RCPT command in a callout was rejected.
32272 .next
32273 &%postmaster%&: The postmaster check in a callout was rejected.
32274 .endlist
32275
32276 The main use of these variables is expected to be to distinguish between
32277 rejections of MAIL and rejections of RCPT in callouts.
32278
32279 The above variables may also be set after a &*successful*&
32280 address verification to:
32281
32282 .ilist
32283 &%random%&: A random local-part callout succeeded
32284 .endlist
32285
32286
32287
32288
32289 .section "Callout verification" "SECTcallver"
32290 .cindex "verifying address" "by callout"
32291 .cindex "callout" "verification"
32292 .cindex "SMTP" "callout verification"
32293 For non-local addresses, routing verifies the domain, but is unable to do any
32294 checking of the local part. There are situations where some means of verifying
32295 the local part is desirable. One way this can be done is to make an SMTP
32296 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32297 a subsequent host for a recipient address, to see if the host accepts the
32298 address. We use the term &'callout'& to cover both cases. Note that for a
32299 sender address, the callback is not to the client host that is trying to
32300 deliver the message, but to one of the hosts that accepts incoming mail for the
32301 sender's domain.
32302
32303 Exim does not do callouts by default. If you want them to happen, you must
32304 request them by setting appropriate options on the &%verify%& condition, as
32305 described below. This facility should be used with care, because it can add a
32306 lot of resource usage to the cost of verifying an address. However, Exim does
32307 cache the results of callouts, which helps to reduce the cost. Details of
32308 caching are in section &<<SECTcallvercache>>&.
32309
32310 Recipient callouts are usually used only between hosts that are controlled by
32311 the same administration. For example, a corporate gateway host could use
32312 callouts to check for valid recipients on an internal mailserver. A successful
32313 callout does not guarantee that a real delivery to the address would succeed;
32314 on the other hand, a failing callout does guarantee that a delivery would fail.
32315
32316 If the &%callout%& option is present on a condition that verifies an address, a
32317 second stage of verification occurs if the address is successfully routed to
32318 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32319 &(manualroute)& router, where the router specifies the hosts. However, if a
32320 router that does not set up hosts routes to an &(smtp)& transport with a
32321 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32322 &%hosts_override%& set, its hosts are always used, whether or not the router
32323 supplies a host list.
32324 Callouts are only supported on &(smtp)& transports.
32325
32326 The port that is used is taken from the transport, if it is specified and is a
32327 remote transport. (For routers that do verification only, no transport need be
32328 specified.) Otherwise, the default SMTP port is used. If a remote transport
32329 specifies an outgoing interface, this is used; otherwise the interface is not
32330 specified. Likewise, the text that is used for the HELO command is taken from
32331 the transport's &%helo_data%& option; if there is no transport, the value of
32332 &$smtp_active_hostname$& is used.
32333
32334 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32335 test whether a bounce message could be delivered to the sender address. The
32336 following SMTP commands are sent:
32337 .display
32338 &`HELO `&<&'local host name'&>
32339 &`MAIL FROM:<>`&
32340 &`RCPT TO:`&<&'the address to be tested'&>
32341 &`QUIT`&
32342 .endd
32343 LHLO is used instead of HELO if the transport's &%protocol%& option is
32344 set to &"lmtp"&.
32345
32346 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32347 settings.
32348
32349 A recipient callout check is similar. By default, it also uses an empty address
32350 for the sender. This default is chosen because most hosts do not make use of
32351 the sender address when verifying a recipient. Using the same address means
32352 that a single cache entry can be used for each recipient. Some sites, however,
32353 do make use of the sender address when verifying. These are catered for by the
32354 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32355
32356 If the response to the RCPT command is a 2&'xx'& code, the verification
32357 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32358 Exim tries the next host, if any. If there is a problem with all the remote
32359 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32360 &%callout%& option is given, in which case the condition is forced to succeed.
32361
32362 .cindex "SMTP" "output flushing, disabling for callout"
32363 A callout may take a little time. For this reason, Exim normally flushes SMTP
32364 output before performing a callout in an ACL, to avoid unexpected timeouts in
32365 clients when the SMTP PIPELINING extension is in use. The flushing can be
32366 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32367
32368
32369
32370
32371 .section "Additional parameters for callouts" "CALLaddparcall"
32372 .cindex "callout" "additional parameters for"
32373 The &%callout%& option can be followed by an equals sign and a number of
32374 optional parameters, separated by commas. For example:
32375 .code
32376 verify = recipient/callout=10s,defer_ok
32377 .endd
32378 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32379 separate verify options, is retained for backwards compatibility, but is now
32380 deprecated. The additional parameters for &%callout%& are as follows:
32381
32382
32383 .vlist
32384 .vitem <&'a&~time&~interval'&>
32385 .cindex "callout" "timeout, specifying"
32386 This specifies the timeout that applies for the callout attempt to each host.
32387 For example:
32388 .code
32389 verify = sender/callout=5s
32390 .endd
32391 The default is 30 seconds. The timeout is used for each response from the
32392 remote host. It is also used for the initial connection, unless overridden by
32393 the &%connect%& parameter.
32394
32395
32396 .vitem &*connect&~=&~*&<&'time&~interval'&>
32397 .cindex "callout" "connection timeout, specifying"
32398 This parameter makes it possible to set a different (usually smaller) timeout
32399 for making the SMTP connection. For example:
32400 .code
32401 verify = sender/callout=5s,connect=1s
32402 .endd
32403 If not specified, this timeout defaults to the general timeout value.
32404
32405 .vitem &*defer_ok*&
32406 .cindex "callout" "defer, action on"
32407 When this parameter is present, failure to contact any host, or any other kind
32408 of temporary error, is treated as success by the ACL. However, the cache is not
32409 updated in this circumstance.
32410
32411 .vitem &*fullpostmaster*&
32412 .cindex "callout" "full postmaster check"
32413 This operates like the &%postmaster%& option (see below), but if the check for
32414 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32415 accordance with the specification in RFC 2821. The RFC states that the
32416 unqualified address &'postmaster'& should be accepted.
32417
32418
32419 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32420 .cindex "callout" "sender when verifying header"
32421 When verifying addresses in header lines using the &%header_sender%&
32422 verification option, Exim behaves by default as if the addresses are envelope
32423 sender addresses from a message. Callout verification therefore tests to see
32424 whether a bounce message could be delivered, by using an empty address in the
32425 MAIL command. However, it is arguable that these addresses might never be used
32426 as envelope senders, and could therefore justifiably reject bounce messages
32427 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32428 address to use in the MAIL command. For example:
32429 .code
32430 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32431 .endd
32432 This parameter is available only for the &%header_sender%& verification option.
32433
32434
32435 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32436 .cindex "callout" "overall timeout, specifying"
32437 This parameter sets an overall timeout for performing a callout verification.
32438 For example:
32439 .code
32440 verify = sender/callout=5s,maxwait=30s
32441 .endd
32442 This timeout defaults to four times the callout timeout for individual SMTP
32443 commands. The overall timeout applies when there is more than one host that can
32444 be tried. The timeout is checked before trying the next host. This prevents
32445 very long delays if there are a large number of hosts and all are timing out
32446 (for example, when network connections are timing out).
32447
32448
32449 .vitem &*no_cache*&
32450 .cindex "callout" "cache, suppressing"
32451 .cindex "caching callout, suppressing"
32452 When this parameter is given, the callout cache is neither read nor updated.
32453
32454 .vitem &*postmaster*&
32455 .cindex "callout" "postmaster; checking"
32456 When this parameter is set, a successful callout check is followed by a similar
32457 check for the local part &'postmaster'& at the same domain. If this address is
32458 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32459 the postmaster check is recorded in a cache record; if it is a failure, this is
32460 used to fail subsequent callouts for the domain without a connection being
32461 made, until the cache record expires.
32462
32463 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32464 The postmaster check uses an empty sender in the MAIL command by default.
32465 You can use this parameter to do a postmaster check using a different address.
32466 For example:
32467 .code
32468 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32469 .endd
32470 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32471 one overrides. The &%postmaster%& parameter is equivalent to this example:
32472 .code
32473 require  verify = sender/callout=postmaster_mailfrom=
32474 .endd
32475 &*Warning*&: The caching arrangements for postmaster checking do not take
32476 account of the sender address. It is assumed that either the empty address or
32477 a fixed non-empty address will be used. All that Exim remembers is that the
32478 postmaster check for the domain succeeded or failed.
32479
32480
32481 .vitem &*random*&
32482 .cindex "callout" "&""random""& check"
32483 When this parameter is set, before doing the normal callout check, Exim does a
32484 check for a &"random"& local part at the same domain. The local part is not
32485 really random &-- it is defined by the expansion of the option
32486 &%callout_random_local_part%&, which defaults to
32487 .code
32488 $primary_hostname-$tod_epoch-testing
32489 .endd
32490 The idea here is to try to determine whether the remote host accepts all local
32491 parts without checking. If it does, there is no point in doing callouts for
32492 specific local parts. If the &"random"& check succeeds, the result is saved in
32493 a cache record, and used to force the current and subsequent callout checks to
32494 succeed without a connection being made, until the cache record expires.
32495
32496 .vitem &*use_postmaster*&
32497 .cindex "callout" "sender for recipient check"
32498 This parameter applies to recipient callouts only. For example:
32499 .code
32500 deny  !verify = recipient/callout=use_postmaster
32501 .endd
32502 .vindex "&$qualify_domain$&"
32503 It causes a non-empty postmaster address to be used in the MAIL command when
32504 performing the callout for the recipient, and also for a &"random"& check if
32505 that is configured. The local part of the address is &`postmaster`& and the
32506 domain is the contents of &$qualify_domain$&.
32507
32508 .vitem &*use_sender*&
32509 This option applies to recipient callouts only. For example:
32510 .code
32511 require  verify = recipient/callout=use_sender
32512 .endd
32513 It causes the message's actual sender address to be used in the MAIL
32514 command when performing the callout, instead of an empty address. There is no
32515 need to use this option unless you know that the called hosts make use of the
32516 sender when checking recipients. If used indiscriminately, it reduces the
32517 usefulness of callout caching.
32518
32519 .vitem &*hold*&
32520 This option applies to recipient callouts only. For example:
32521 .code
32522 require  verify = recipient/callout=use_sender,hold
32523 .endd
32524 It causes the connection to be held open and used for any further recipients
32525 and for eventual delivery (should that be done quickly).
32526 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32527 when that is used for the connections.
32528 The advantage is only gained if there are no callout cache hits
32529 (which could be enforced by the no_cache option),
32530 if the use_sender option is used,
32531 if neither the random nor the use_postmaster option is used,
32532 and if no other callouts intervene.
32533 .endlist
32534
32535 If you use any of the parameters that set a non-empty sender for the MAIL
32536 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32537 &%use_sender%&), you should think about possible loops. Recipient checking is
32538 usually done between two hosts that are under the same management, and the host
32539 that receives the callouts is not normally configured to do callouts itself.
32540 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32541 these circumstances.
32542
32543 However, if you use a non-empty sender address for a callout to an arbitrary
32544 host, there is the likelihood that the remote host will itself initiate a
32545 callout check back to your host. As it is checking what appears to be a message
32546 sender, it is likely to use an empty address in MAIL, thus avoiding a
32547 callout loop. However, to be on the safe side it would be best to set up your
32548 own ACLs so that they do not do sender verification checks when the recipient
32549 is the address you use for header sender or postmaster callout checking.
32550
32551 Another issue to think about when using non-empty senders for callouts is
32552 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32553 by the sender/recipient combination; thus, for any given recipient, many more
32554 actual callouts are performed than when an empty sender or postmaster is used.
32555
32556
32557
32558
32559 .section "Callout caching" "SECTcallvercache"
32560 .cindex "hints database" "callout cache"
32561 .cindex "callout" "cache, description of"
32562 .cindex "caching" "callout"
32563 Exim caches the results of callouts in order to reduce the amount of resources
32564 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32565 option. A hints database called &"callout"& is used for the cache. Two
32566 different record types are used: one records the result of a callout check for
32567 a specific address, and the other records information that applies to the
32568 entire domain (for example, that it accepts the local part &'postmaster'&).
32569
32570 When an original callout fails, a detailed SMTP error message is given about
32571 the failure. However, for subsequent failures use the cache data, this message
32572 is not available.
32573
32574 The expiry times for negative and positive address cache records are
32575 independent, and can be set by the global options &%callout_negative_expire%&
32576 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32577
32578 If a host gives a negative response to an SMTP connection, or rejects any
32579 commands up to and including
32580 .code
32581 MAIL FROM:<>
32582 .endd
32583 (but not including the MAIL command with a non-empty address),
32584 any callout attempt is bound to fail. Exim remembers such failures in a
32585 domain cache record, which it uses to fail callouts for the domain without
32586 making new connections, until the domain record times out. There are two
32587 separate expiry times for domain cache records:
32588 &%callout_domain_negative_expire%& (default 3h) and
32589 &%callout_domain_positive_expire%& (default 7d).
32590
32591 Domain records expire when the negative expiry time is reached if callouts
32592 cannot be made for the domain, or if the postmaster check failed.
32593 Otherwise, they expire when the positive expiry time is reached. This
32594 ensures that, for example, a host that stops accepting &"random"& local parts
32595 will eventually be noticed.
32596
32597 The callout caching mechanism is based on the domain of the address that is
32598 being tested. If the domain routes to several hosts, it is assumed that their
32599 behaviour will be the same.
32600
32601
32602
32603 .section "Sender address verification reporting" "SECTsenaddver"
32604 .cindex "verifying" "suppressing error details"
32605 See section &<<SECTaddressverification>>& for a general discussion of
32606 verification. When sender verification fails in an ACL, the details of the
32607 failure are given as additional output lines before the 550 response to the
32608 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32609 you might see:
32610 .code
32611 MAIL FROM:<xyz@abc.example>
32612 250 OK
32613 RCPT TO:<pqr@def.example>
32614 550-Verification failed for <xyz@abc.example>
32615 550-Called:   192.168.34.43
32616 550-Sent:     RCPT TO:<xyz@abc.example>
32617 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32618 550 Sender verification failed
32619 .endd
32620 If more than one RCPT command fails in the same way, the details are given
32621 only for the first of them. However, some administrators do not want to send
32622 out this much information. You can suppress the details by adding
32623 &`/no_details`& to the ACL statement that requests sender verification. For
32624 example:
32625 .code
32626 verify = sender/no_details
32627 .endd
32628
32629 .section "Redirection while verifying" "SECTredirwhilveri"
32630 .cindex "verifying" "redirection while"
32631 .cindex "address redirection" "while verifying"
32632 A dilemma arises when a local address is redirected by aliasing or forwarding
32633 during verification: should the generated addresses themselves be verified,
32634 or should the successful expansion of the original address be enough to verify
32635 it? By default, Exim takes the following pragmatic approach:
32636
32637 .ilist
32638 When an incoming address is redirected to just one child address, verification
32639 continues with the child address, and if that fails to verify, the original
32640 verification also fails.
32641 .next
32642 When an incoming address is redirected to more than one child address,
32643 verification does not continue. A success result is returned.
32644 .endlist
32645
32646 This seems the most reasonable behaviour for the common use of aliasing as a
32647 way of redirecting different local parts to the same mailbox. It means, for
32648 example, that a pair of alias entries of the form
32649 .code
32650 A.Wol:   aw123
32651 aw123:   :fail: Gone away, no forwarding address
32652 .endd
32653 work as expected, with both local parts causing verification failure. When a
32654 redirection generates more than one address, the behaviour is more like a
32655 mailing list, where the existence of the alias itself is sufficient for
32656 verification to succeed.
32657
32658 It is possible, however, to change the default behaviour so that all successful
32659 redirections count as successful verifications, however many new addresses are
32660 generated. This is specified by the &%success_on_redirect%& verification
32661 option. For example:
32662 .code
32663 require verify = recipient/success_on_redirect/callout=10s
32664 .endd
32665 In this example, verification succeeds if a router generates a new address, and
32666 the callout does not occur, because no address was routed to a remote host.
32667
32668 When verification is being tested via the &%-bv%& option, the treatment of
32669 redirections is as just described, unless the &%-v%& or any debugging option is
32670 also specified. In that case, full verification is done for every generated
32671 address and a report is output for each of them.
32672
32673
32674
32675 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32676 .cindex "CSA" "verifying"
32677 Client SMTP Authorization is a system that allows a site to advertise
32678 which machines are and are not permitted to send email. This is done by placing
32679 special SRV records in the DNS; these are looked up using the client's HELO
32680 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32681 Authorization checks in Exim are performed by the ACL condition:
32682 .code
32683 verify = csa
32684 .endd
32685 This fails if the client is not authorized. If there is a DNS problem, or if no
32686 valid CSA SRV record is found, or if the client is authorized, the condition
32687 succeeds. These three cases can be distinguished using the expansion variable
32688 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32689 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32690 be likely to cause problems for legitimate email.
32691
32692 The error messages produced by the CSA code include slightly more
32693 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32694 looking up the CSA SRV record, or problems looking up the CSA target
32695 address record. There are four reasons for &$csa_status$& being &"fail"&:
32696
32697 .ilist
32698 The client's host name is explicitly not authorized.
32699 .next
32700 The client's IP address does not match any of the CSA target IP addresses.
32701 .next
32702 The client's host name is authorized but it has no valid target IP addresses
32703 (for example, the target's addresses are IPv6 and the client is using IPv4).
32704 .next
32705 The client's host name has no CSA SRV record but a parent domain has asserted
32706 that all subdomains must be explicitly authorized.
32707 .endlist
32708
32709 The &%csa%& verification condition can take an argument which is the domain to
32710 use for the DNS query. The default is:
32711 .code
32712 verify = csa/$sender_helo_name
32713 .endd
32714 This implementation includes an extension to CSA. If the query domain
32715 is an address literal such as [192.0.2.95], or if it is a bare IP
32716 address, Exim searches for CSA SRV records in the reverse DNS as if
32717 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32718 meaningful to say:
32719 .code
32720 verify = csa/$sender_host_address
32721 .endd
32722 In fact, this is the check that Exim performs if the client does not say HELO.
32723 This extension can be turned off by setting the main configuration option
32724 &%dns_csa_use_reverse%& to be false.
32725
32726 If a CSA SRV record is not found for the domain itself, a search
32727 is performed through its parent domains for a record which might be
32728 making assertions about subdomains. The maximum depth of this search is limited
32729 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32730 default. Exim does not look for CSA SRV records in a top level domain, so the
32731 default settings handle HELO domains as long as seven
32732 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32733 of legitimate HELO domains.
32734
32735 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32736 direct SRV lookups, this is not sufficient because of the extra parent domain
32737 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32738 addresses into lookups in the reverse DNS space. The result of a successful
32739 lookup such as:
32740 .code
32741 ${lookup dnsdb {csa=$sender_helo_name}}
32742 .endd
32743 has two space-separated fields: an authorization code and a target host name.
32744 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32745 authorization required but absent, or &"?"& for unknown.
32746
32747
32748
32749
32750 .section "Bounce address tag validation" "SECTverifyPRVS"
32751 .cindex "BATV, verifying"
32752 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32753 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32754 Genuine incoming bounce messages should therefore always be addressed to
32755 recipients that have a valid tag. This scheme is a way of detecting unwanted
32756 bounce messages caused by sender address forgeries (often called &"collateral
32757 spam"&), because the recipients of such messages do not include valid tags.
32758
32759 There are two expansion items to help with the implementation of the BATV
32760 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32761 the original envelope sender address by using a simple key to add a hash of the
32762 address and some time-based randomizing information. The &%prvs%& expansion
32763 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32764 The syntax of these expansion items is described in section
32765 &<<SECTexpansionitems>>&.
32766 The validity period on signed addresses is seven days.
32767
32768 As an example, suppose the secret per-address keys are stored in an MySQL
32769 database. A query to look up the key for an address could be defined as a macro
32770 like this:
32771 .code
32772 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32773                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32774                 }{$value}}
32775 .endd
32776 Suppose also that the senders who make use of BATV are defined by an address
32777 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32778 use this:
32779 .code
32780 # Bounces: drop unsigned addresses for BATV senders
32781 deny message = This address does not send an unsigned reverse path
32782      senders = :
32783      recipients = +batv_senders
32784
32785 # Bounces: In case of prvs-signed address, check signature.
32786 deny message = Invalid reverse path signature.
32787      senders = :
32788      condition  = ${prvscheck {$local_part@$domain}\
32789                   {PRVSCHECK_SQL}{1}}
32790      !condition = $prvscheck_result
32791 .endd
32792 The first statement rejects recipients for bounce messages that are addressed
32793 to plain BATV sender addresses, because it is known that BATV senders do not
32794 send out messages with plain sender addresses. The second statement rejects
32795 recipients that are prvs-signed, but with invalid signatures (either because
32796 the key is wrong, or the signature has timed out).
32797
32798 A non-prvs-signed address is not rejected by the second statement, because the
32799 &%prvscheck%& expansion yields an empty string if its first argument is not a
32800 prvs-signed address, thus causing the &%condition%& condition to be false. If
32801 the first argument is a syntactically valid prvs-signed address, the yield is
32802 the third string (in this case &"1"&), whether or not the cryptographic and
32803 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32804 of the checks (empty for failure, &"1"& for success).
32805
32806 There is one more issue you must consider when implementing prvs-signing:
32807 you have to ensure that the routers accept prvs-signed addresses and
32808 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32809 router to remove the signature with a configuration along these lines:
32810 .code
32811 batv_redirect:
32812   driver = redirect
32813   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32814 .endd
32815 This works because, if the third argument of &%prvscheck%& is empty, the result
32816 of the expansion of a prvs-signed address is the decoded value of the original
32817 address. This router should probably be the first of your routers that handles
32818 local addresses.
32819
32820 To create BATV-signed addresses in the first place, a transport of this form
32821 can be used:
32822 .code
32823 external_smtp_batv:
32824   driver = smtp
32825   return_path = ${prvs {$return_path} \
32826                        {${lookup mysql{SELECT \
32827                        secret FROM batv_prvs WHERE \
32828                        sender='${quote_mysql:$sender_address}'} \
32829                        {$value}fail}}}
32830 .endd
32831 If no key can be found for the existing return path, no signing takes place.
32832
32833
32834
32835 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32836 .cindex "&ACL;" "relay control"
32837 .cindex "relaying" "control by ACL"
32838 .cindex "policy control" "relay control"
32839 An MTA is said to &'relay'& a message if it receives it from some host and
32840 delivers it directly to another host as a result of a remote address contained
32841 within it. Redirecting a local address via an alias or forward file and then
32842 passing the message on to another host is not relaying,
32843 .cindex "&""percent hack""&"
32844 but a redirection as a result of the &"percent hack"& is.
32845
32846 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32847 A host which is acting as a gateway or an MX backup is concerned with incoming
32848 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32849 a host which is acting as a smart host for a number of clients is concerned
32850 with outgoing relaying from those clients to the Internet at large. Often the
32851 same host is fulfilling both functions,
32852 . ///
32853 . as illustrated in the diagram below,
32854 . ///
32855 but in principle these two kinds of relaying are entirely independent. What is
32856 not wanted is the transmission of mail from arbitrary remote hosts through your
32857 system to arbitrary domains.
32858
32859
32860 You can implement relay control by means of suitable statements in the ACL that
32861 runs for each RCPT command. For convenience, it is often easiest to use
32862 Exim's named list facility to define the domains and hosts involved. For
32863 example, suppose you want to do the following:
32864
32865 .ilist
32866 Deliver a number of domains to mailboxes on the local host (or process them
32867 locally in some other way). Let's say these are &'my.dom1.example'& and
32868 &'my.dom2.example'&.
32869 .next
32870 Relay mail for a number of other domains for which you are the secondary MX.
32871 These might be &'friend1.example'& and &'friend2.example'&.
32872 .next
32873 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32874 Suppose your LAN is 192.168.45.0/24.
32875 .endlist
32876
32877
32878 In the main part of the configuration, you put the following definitions:
32879 .code
32880 domainlist local_domains    = my.dom1.example : my.dom2.example
32881 domainlist relay_to_domains = friend1.example : friend2.example
32882 hostlist   relay_from_hosts = 192.168.45.0/24
32883 .endd
32884 Now you can use these definitions in the ACL that is run for every RCPT
32885 command:
32886 .code
32887 acl_check_rcpt:
32888   accept domains = +local_domains : +relay_to_domains
32889   accept hosts   = +relay_from_hosts
32890 .endd
32891 The first statement accepts any RCPT command that contains an address in
32892 the local or relay domains. For any other domain, control passes to the second
32893 statement, which accepts the command only if it comes from one of the relay
32894 hosts. In practice, you will probably want to make your ACL more sophisticated
32895 than this, for example, by including sender and recipient verification. The
32896 default configuration includes a more comprehensive example, which is described
32897 in chapter &<<CHAPdefconfil>>&.
32898
32899
32900
32901 .section "Checking a relay configuration" "SECTcheralcon"
32902 .cindex "relaying" "checking control of"
32903 You can check the relay characteristics of your configuration in the same way
32904 that you can test any ACL behaviour for an incoming SMTP connection, by using
32905 the &%-bh%& option to run a fake SMTP session with which you interact.
32906 .ecindex IIDacl
32907
32908
32909
32910 . ////////////////////////////////////////////////////////////////////////////
32911 . ////////////////////////////////////////////////////////////////////////////
32912
32913 .chapter "Content scanning at ACL time" "CHAPexiscan"
32914 .scindex IIDcosca "content scanning" "at ACL time"
32915 The extension of Exim to include content scanning at ACL time, formerly known
32916 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32917 was integrated into the main source for Exim release 4.50, and Tom continues to
32918 maintain it. Most of the wording of this chapter is taken from Tom's
32919 specification.
32920
32921 It is also possible to scan the content of messages at other times. The
32922 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32923 scanning after all the ACLs have run. A transport filter can be used to scan
32924 messages at delivery time (see the &%transport_filter%& option, described in
32925 chapter &<<CHAPtransportgeneric>>&).
32926
32927 If you want to include the ACL-time content-scanning features when you compile
32928 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32929 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32930
32931 .ilist
32932 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32933 for all MIME parts for SMTP and non-SMTP messages, respectively.
32934 .next
32935 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32936 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32937 run at the end of message reception (the &%acl_smtp_data%& ACL).
32938 .next
32939 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32940 of messages, or parts of messages, for debugging purposes.
32941 .next
32942 Additional expansion variables that are set in the new ACL and by the new
32943 conditions.
32944 .next
32945 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32946 .endlist
32947
32948 Content-scanning is continually evolving, and new features are still being
32949 added. While such features are still unstable and liable to incompatible
32950 changes, they are made available in Exim by setting options whose names begin
32951 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32952 this manual. You can find out about them by reading the file called
32953 &_doc/experimental.txt_&.
32954
32955 All the content-scanning facilities work on a MBOX copy of the message that is
32956 temporarily created in a file called:
32957 .display
32958 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32959 .endd
32960 The &_.eml_& extension is a friendly hint to virus scanners that they can
32961 expect an MBOX-like structure inside that file. The file is created when the
32962 first content scanning facility is called. Subsequent calls to content
32963 scanning conditions open the same file again. The directory is recursively
32964 removed when the &%acl_smtp_data%& ACL has finished running, unless
32965 .code
32966 control = no_mbox_unspool
32967 .endd
32968 has been encountered. When the MIME ACL decodes files, they are put into the
32969 same directory by default.
32970
32971
32972
32973 .section "Scanning for viruses" "SECTscanvirus"
32974 .cindex "virus scanning"
32975 .cindex "content scanning" "for viruses"
32976 .cindex "content scanning" "the &%malware%& condition"
32977 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32978 It supports a &"generic"& interface to scanners called via the shell, and
32979 specialized interfaces for &"daemon"& type virus scanners, which are resident
32980 in memory and thus are much faster.
32981
32982 Since message data needs to have arrived,
32983 the condition may be only called in ACL defined by
32984 &%acl_smtp_data%&,
32985 &%acl_smtp_data_prdr%&,
32986 &%acl_smtp_mime%& or
32987 &%acl_smtp_dkim%&
32988
32989 A timeout of 2 minutes is applied to a scanner call (by default);
32990 if it expires then a defer action is taken.
32991
32992 .oindex "&%av_scanner%&"
32993 You can set the &%av_scanner%& option in the main part of the configuration
32994 to specify which scanner to use, together with any additional options that
32995 are needed. The basic syntax is as follows:
32996 .display
32997 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32998 .endd
32999 If you do not set &%av_scanner%&, it defaults to
33000 .code
33001 av_scanner = sophie:/var/run/sophie
33002 .endd
33003 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33004 before use.
33005 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33006 The following scanner types are supported in this release,
33007 though individual ones can be included or not at build time:
33008
33009 .vlist
33010 .vitem &%avast%&
33011 .cindex "virus scanners" "avast"
33012 This is the scanner daemon of Avast. It has been tested with Avast Core
33013 Security (currently at version 2.2.0).
33014 You can get a trial version at &url(https://www.avast.com) or for Linux
33015 at &url(https://www.avast.com/linux-server-antivirus).
33016 This scanner type takes one option,
33017 which can be either a full path to a UNIX socket,
33018 or host and port specifiers separated by white space.
33019 The host may be a name or an IP address; the port is either a
33020 single number or a pair of numbers with a dash between.
33021 A list of options may follow. These options are interpreted on the
33022 Exim's side of the malware scanner, or are given on separate lines to
33023 the daemon as options before the main scan command.
33024
33025 .cindex &`pass_unscanned`& "avast"
33026 If &`pass_unscanned`&
33027 is set, any files the Avast scanner can't scan (e.g.
33028 decompression bombs, or invalid archives) are considered clean. Use with
33029 care.
33030
33031 For example:
33032 .code
33033 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33034 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33035 av_scanner = avast:192.168.2.22 5036
33036 .endd
33037 If you omit the argument, the default path
33038 &_/var/run/avast/scan.sock_&
33039 is used.
33040 If you use a remote host,
33041 you need to make Exim's spool directory available to it,
33042 as the scanner is passed a file path, not file contents.
33043 For information about available commands and their options you may use
33044 .code
33045 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33046     FLAGS
33047     SENSITIVITY
33048     PACK
33049 .endd
33050
33051 If the scanner returns a temporary failure (e.g. license issues, or
33052 permission problems), the message is deferred and a paniclog entry is
33053 written.  The usual &`defer_ok`& option is available.
33054
33055 .vitem &%aveserver%&
33056 .cindex "virus scanners" "Kaspersky"
33057 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33058 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33059 which is the path to the daemon's UNIX socket. The default is shown in this
33060 example:
33061 .code
33062 av_scanner = aveserver:/var/run/aveserver
33063 .endd
33064
33065
33066 .vitem &%clamd%&
33067 .cindex "virus scanners" "clamd"
33068 This daemon-type scanner is GPL and free. You can get it at
33069 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33070 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33071 in the MIME ACL. This is no longer believed to be necessary.
33072
33073 The options are a list of server specifiers, which may be
33074 a UNIX socket specification,
33075 a TCP socket specification,
33076 or a (global) option.
33077
33078 A socket specification consists of a space-separated list.
33079 For a Unix socket the first element is a full path for the socket,
33080 for a TCP socket the first element is the IP address
33081 and the second a port number,
33082 Any further elements are per-server (non-global) options.
33083 These per-server options are supported:
33084 .code
33085 retry=<timespec>        Retry on connect fail
33086 .endd
33087
33088 The &`retry`& option specifies a time after which a single retry for
33089 a failed connect is made.  The default is to not retry.
33090
33091 If a Unix socket file is specified, only one server is supported.
33092
33093 Examples:
33094 .code
33095 av_scanner = clamd:/opt/clamd/socket
33096 av_scanner = clamd:192.0.2.3 1234
33097 av_scanner = clamd:192.0.2.3 1234:local
33098 av_scanner = clamd:192.0.2.3 1234 retry=10s
33099 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33100 .endd
33101 If the value of av_scanner points to a UNIX socket file or contains the
33102 &`local`&
33103 option, then the ClamAV interface will pass a filename containing the data
33104 to be scanned, which should normally result in less I/O happening and be
33105 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33106 Exim does not assume that there is a common filesystem with the remote host.
33107
33108 The final example shows that multiple TCP targets can be specified.  Exim will
33109 randomly use one for each incoming email (i.e. it load balances them).  Note
33110 that only TCP targets may be used if specifying a list of scanners; a UNIX
33111 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33112 unavailable, Exim will try the remaining one(s) until it finds one that works.
33113 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33114 not keep track of scanner state between multiple messages, and the scanner
33115 selection is random, so the message will get logged in the mainlog for each
33116 email that the down scanner gets chosen first (message wrapped to be readable):
33117 .code
33118 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33119    clamd: connection to localhost, port 3310 failed
33120    (Connection refused)
33121 .endd
33122
33123 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33124 contributing the code for this scanner.
33125
33126 .vitem &%cmdline%&
33127 .cindex "virus scanners" "command line interface"
33128 This is the keyword for the generic command line scanner interface. It can be
33129 used to attach virus scanners that are invoked from the shell. This scanner
33130 type takes 3 mandatory options:
33131
33132 .olist
33133 The full path and name of the scanner binary, with all command line options,
33134 and a placeholder (&`%s`&) for the directory to scan.
33135
33136 .next
33137 A regular expression to match against the STDOUT and STDERR output of the
33138 virus scanner. If the expression matches, a virus was found. You must make
33139 absolutely sure that this expression matches on &"virus found"&. This is called
33140 the &"trigger"& expression.
33141
33142 .next
33143 Another regular expression, containing exactly one pair of parentheses, to
33144 match the name of the virus found in the scanners output. This is called the
33145 &"name"& expression.
33146 .endlist olist
33147
33148 For example, Sophos Sweep reports a virus on a line like this:
33149 .code
33150 Virus 'W32/Magistr-B' found in file ./those.bat
33151 .endd
33152 For the trigger expression, we can match the phrase &"found in file"&. For the
33153 name expression, we want to extract the W32/Magistr-B string, so we can match
33154 for the single quotes left and right of it. Altogether, this makes the
33155 configuration setting:
33156 .code
33157 av_scanner = cmdline:\
33158              /path/to/sweep -ss -all -rec -archive %s:\
33159              found in file:'(.+)'
33160 .endd
33161 .vitem &%drweb%&
33162 .cindex "virus scanners" "DrWeb"
33163 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33164 takes one option,
33165 either a full path to a UNIX socket,
33166 or host and port specifiers separated by white space.
33167 The host may be a name or an IP address; the port is either a
33168 single number or a pair of numbers with a dash between.
33169 For example:
33170 .code
33171 av_scanner = drweb:/var/run/drwebd.sock
33172 av_scanner = drweb:192.168.2.20 31337
33173 .endd
33174 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33175 is used. Thanks to Alex Miller for contributing the code for this scanner.
33176
33177 .vitem &%f-protd%&
33178 .cindex "virus scanners" "f-protd"
33179 The f-protd scanner is accessed via HTTP over TCP.
33180 One argument is taken, being a space-separated hostname and port number
33181 (or port-range).
33182 For example:
33183 .code
33184 av_scanner = f-protd:localhost 10200-10204
33185 .endd
33186 If you omit the argument, the default values shown above are used.
33187
33188 .vitem &%f-prot6d%&
33189 .cindex "virus scanners" "f-prot6d"
33190 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33191 One argument is taken, being a space-separated hostname and port number.
33192 For example:
33193 .code
33194 av_scanner = f-prot6d:localhost 10200
33195 .endd
33196 If you omit the argument, the default values show above are used.
33197
33198 .vitem &%fsecure%&
33199 .cindex "virus scanners" "F-Secure"
33200 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33201 argument which is the path to a UNIX socket. For example:
33202 .code
33203 av_scanner = fsecure:/path/to/.fsav
33204 .endd
33205 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33206 Thelmen for contributing the code for this scanner.
33207
33208 .vitem &%kavdaemon%&
33209 .cindex "virus scanners" "Kaspersky"
33210 This is the scanner daemon of Kaspersky Version 4. This version of the
33211 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33212 scanner type takes one option, which is the path to the daemon's UNIX socket.
33213 For example:
33214 .code
33215 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33216 .endd
33217 The default path is &_/var/run/AvpCtl_&.
33218
33219 .vitem &%mksd%&
33220 .cindex "virus scanners" "mksd"
33221 This was a daemon type scanner that is aimed mainly at Polish users,
33222 though some documentation was available in English.
33223 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33224 and this appears to be a candidate for removal from Exim, unless
33225 we are informed of other virus scanners which use the same protocol
33226 to integrate.
33227 The only option for this scanner type is
33228 the maximum number of processes used simultaneously to scan the attachments,
33229 provided that mksd has
33230 been run with at least the same number of child processes. For example:
33231 .code
33232 av_scanner = mksd:2
33233 .endd
33234 You can safely omit this option (the default value is 1).
33235
33236 .vitem &%sock%&
33237 .cindex "virus scanners" "simple socket-connected"
33238 This is a general-purpose way of talking to simple scanner daemons
33239 running on the local machine.
33240 There are four options:
33241 an address (which may be an IP address and port, or the path of a Unix socket),
33242 a commandline to send (may include a single %s which will be replaced with
33243 the path to the mail file to be scanned),
33244 an RE to trigger on from the returned data,
33245 and an RE to extract malware_name from the returned data.
33246 For example:
33247 .code
33248 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33249 .endd
33250 Note that surrounding whitespace is stripped from each option, meaning
33251 there is no way to specify a trailing newline.
33252 The socket specifier and both regular-expressions are required.
33253 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33254 specify an empty element to get this.
33255
33256 .vitem &%sophie%&
33257 .cindex "virus scanners" "Sophos and Sophie"
33258 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33259 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33260 for this scanner type is the path to the UNIX socket that Sophie uses for
33261 client communication. For example:
33262 .code
33263 av_scanner = sophie:/tmp/sophie
33264 .endd
33265 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33266 the option.
33267 .endlist
33268
33269 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33270 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33271 ACL.
33272
33273 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33274 makes it possible to use different scanners. See further below for an example.
33275 The &%malware%& condition caches its results, so when you use it multiple times
33276 for the same message, the actual scanning process is only carried out once.
33277 However, using expandable items in &%av_scanner%& disables this caching, in
33278 which case each use of the &%malware%& condition causes a new scan of the
33279 message.
33280
33281 The &%malware%& condition takes a right-hand argument that is expanded before
33282 use and taken as a list, slash-separated by default.
33283 The first element can then be one of
33284
33285 .ilist
33286 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33287 The condition succeeds if a virus was found, and fail otherwise. This is the
33288 recommended usage.
33289 .next
33290 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33291 the condition fails immediately.
33292 .next
33293 A regular expression, in which case the message is scanned for viruses. The
33294 condition succeeds if a virus is found and its name matches the regular
33295 expression. This allows you to take special actions on certain types of virus.
33296 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33297 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33298 .endlist
33299
33300 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33301 messages even if there is a problem with the virus scanner.
33302 Otherwise, such a problem causes the ACL to defer.
33303
33304 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33305 specify a non-default timeout.  The default is two minutes.
33306 For example:
33307 .code
33308 malware = * / defer_ok / tmo=10s
33309 .endd
33310 A timeout causes the ACL to defer.
33311
33312 .vindex "&$callout_address$&"
33313 When a connection is made to the scanner the expansion variable &$callout_address$&
33314 is set to record the actual address used.
33315
33316 .vindex "&$malware_name$&"
33317 When a virus is found, the condition sets up an expansion variable called
33318 &$malware_name$& that contains the name of the virus. You can use it in a
33319 &%message%& modifier that specifies the error returned to the sender, and/or in
33320 logging data.
33321
33322 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33323 imposed by your anti-virus scanner.
33324
33325 Here is a very simple scanning example:
33326 .code
33327 deny message = This message contains malware ($malware_name)
33328      malware = *
33329 .endd
33330 The next example accepts messages when there is a problem with the scanner:
33331 .code
33332 deny message = This message contains malware ($malware_name)
33333      malware = */defer_ok
33334 .endd
33335 The next example shows how to use an ACL variable to scan with both sophie and
33336 aveserver. It assumes you have set:
33337 .code
33338 av_scanner = $acl_m0
33339 .endd
33340 in the main Exim configuration.
33341 .code
33342 deny message = This message contains malware ($malware_name)
33343      set acl_m0 = sophie
33344      malware = *
33345
33346 deny message = This message contains malware ($malware_name)
33347      set acl_m0 = aveserver
33348      malware = *
33349 .endd
33350
33351
33352 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33353 .cindex "content scanning" "for spam"
33354 .cindex "spam scanning"
33355 .cindex "SpamAssassin"
33356 .cindex "Rspamd"
33357 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33358 score and a report for the message.
33359 Support is also provided for Rspamd.
33360
33361 For more information about installation and configuration of SpamAssassin or
33362 Rspamd refer to their respective websites at
33363 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33364
33365 SpamAssassin can be installed with CPAN by running:
33366 .code
33367 perl -MCPAN -e 'install Mail::SpamAssassin'
33368 .endd
33369 SpamAssassin has its own set of configuration files. Please review its
33370 documentation to see how you can tweak it. The default installation should work
33371 nicely, however.
33372
33373 .oindex "&%spamd_address%&"
33374 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33375 intend to use an instance running on the local host you do not need to set
33376 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33377 you must set the &%spamd_address%& option in the global part of the Exim
33378 configuration as follows (example):
33379 .code
33380 spamd_address = 192.168.99.45 783
33381 .endd
33382 The SpamAssassin protocol relies on a TCP half-close from the client.
33383 If your SpamAssassin client side is running a Linux system with an
33384 iptables firewall, consider setting
33385 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33386 timeout, Exim uses when waiting for a response from the SpamAssassin
33387 server (currently defaulting to 120s).  With a lower value the Linux
33388 connection tracking may consider your half-closed connection as dead too
33389 soon.
33390
33391
33392 To use Rspamd (which by default listens on all local addresses
33393 on TCP port 11333)
33394 you should add &%variant=rspamd%& after the address/port pair, for example:
33395 .code
33396 spamd_address = 127.0.0.1 11333 variant=rspamd
33397 .endd
33398
33399 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33400 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33401 filename instead of an address/port pair:
33402 .code
33403 spamd_address = /var/run/spamd_socket
33404 .endd
33405 You can have multiple &%spamd%& servers to improve scalability. These can
33406 reside on other hardware reachable over the network. To specify multiple
33407 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33408 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33409 .code
33410 spamd_address = 192.168.2.10 783 : \
33411                 192.168.2.11 783 : \
33412                 192.168.2.12 783
33413 .endd
33414 Up to 32 &%spamd%& servers are supported.
33415 When a server fails to respond to the connection attempt, all other
33416 servers are tried until one succeeds. If no server responds, the &%spam%&
33417 condition defers.
33418
33419 Unix and TCP socket specifications may be mixed in any order.
33420 Each element of the list is a list itself, space-separated by default
33421 and changeable in the usual way (&<<SECTlistsepchange>>&);
33422 take care to not double the separator.
33423
33424 For TCP socket specifications a host name or IP (v4 or v6, but
33425 subject to list-separator quoting rules) address can be used,
33426 and the port can be one or a dash-separated pair.
33427 In the latter case, the range is tried in strict order.
33428
33429 Elements after the first for Unix sockets, or second for TCP socket,
33430 are options.
33431 The supported options are:
33432 .code
33433 pri=<priority>      Selection priority
33434 weight=<value>      Selection bias
33435 time=<start>-<end>  Use only between these times of day
33436 retry=<timespec>    Retry on connect fail
33437 tmo=<timespec>      Connection time limit
33438 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33439 .endd
33440
33441 The &`pri`& option specifies a priority for the server within the list,
33442 higher values being tried first.
33443 The default priority is 1.
33444
33445 The &`weight`& option specifies a selection bias.
33446 Within a priority set
33447 servers are queried in a random fashion, weighted by this value.
33448 The default value for selection bias is 1.
33449
33450 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33451 in the local time zone; each element being one or more digits.
33452 Either the seconds or both minutes and seconds, plus the leading &`.`&
33453 characters, may be omitted and will be taken as zero.
33454
33455 Timeout specifications for the &`retry`& and &`tmo`& options
33456 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33457
33458 The &`tmo`& option specifies an overall timeout for communication.
33459 The default value is two minutes.
33460
33461 The &`retry`& option specifies a time after which a single retry for
33462 a failed connect is made.
33463 The default is to not retry.
33464
33465 The &%spamd_address%& variable is expanded before use if it starts with
33466 a dollar sign. In this case, the expansion may return a string that is
33467 used as the list so that multiple spamd servers can be the result of an
33468 expansion.
33469
33470 .vindex "&$callout_address$&"
33471 When a connection is made to the server the expansion variable &$callout_address$&
33472 is set to record the actual address used.
33473
33474 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33475 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33476 .code
33477 deny message = This message was classified as SPAM
33478      spam = joe
33479 .endd
33480 The right-hand side of the &%spam%& condition specifies a name. This is
33481 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33482 to scan using a specific profile, but rather use the SpamAssassin system-wide
33483 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33484 Rspamd does not use this setting. However, you must put something on the
33485 right-hand side.
33486
33487 The name allows you to use per-domain or per-user antispam profiles in
33488 principle, but this is not straightforward in practice, because a message may
33489 have multiple recipients, not necessarily all in the same domain. Because the
33490 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33491 read the contents of the message, the variables &$local_part$& and &$domain$&
33492 are not set.
33493 Careful enforcement of single-recipient messages
33494 (e.g. by responding with defer in the recipient ACL for all recipients
33495 after the first),
33496 or the use of PRDR,
33497 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33498 are needed to use this feature.
33499
33500 The right-hand side of the &%spam%& condition is expanded before being used, so
33501 you can put lookups or conditions there. When the right-hand side evaluates to
33502 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33503
33504
33505 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33506 large ones may cause significant performance degradation. As most spam messages
33507 are quite small, it is recommended that you do not scan the big ones. For
33508 example:
33509 .code
33510 deny message = This message was classified as SPAM
33511      condition = ${if < {$message_size}{10K}}
33512      spam = nobody
33513 .endd
33514
33515 The &%spam%& condition returns true if the threshold specified in the user's
33516 SpamAssassin profile has been matched or exceeded. If you want to use the
33517 &%spam%& condition for its side effects (see the variables below), you can make
33518 it always return &"true"& by appending &`:true`& to the username.
33519
33520 .cindex "spam scanning" "returned variables"
33521 When the &%spam%& condition is run, it sets up a number of expansion
33522 variables.
33523 Except for &$spam_report$&,
33524 these variables are saved with the received message so are
33525 available for use at delivery time.
33526
33527 .vlist
33528 .vitem &$spam_score$&
33529 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33530 for inclusion in log or reject messages.
33531
33532 .vitem &$spam_score_int$&
33533 The spam score of the message, multiplied by ten, as an integer value. For
33534 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33535 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33536 The integer value is useful for numeric comparisons in conditions.
33537
33538 .vitem &$spam_bar$&
33539 A string consisting of a number of &"+"& or &"-"& characters, representing the
33540 integer part of the spam score value. A spam score of 4.4 would have a
33541 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33542 headers, since MUAs can match on such strings. The maximum length of the
33543 spam bar is 50 characters.
33544
33545 .vitem &$spam_report$&
33546 A multiline text table, containing the full SpamAssassin report for the
33547 message. Useful for inclusion in headers or reject messages.
33548 This variable is only usable in a DATA-time ACL.
33549 Beware that SpamAssassin may return non-ASCII characters, especially
33550 when running in country-specific locales, which are not legal
33551 unencoded in headers.
33552
33553 .vitem &$spam_action$&
33554 For SpamAssassin either 'reject' or 'no action' depending on the
33555 spam score versus threshold.
33556 For Rspamd, the recommended action.
33557
33558 .endlist
33559
33560 The &%spam%& condition caches its results unless expansion in
33561 spamd_address was used. If you call it again with the same user name, it
33562 does not scan again, but rather returns the same values as before.
33563
33564 The &%spam%& condition returns DEFER if there is any error while running
33565 the message through SpamAssassin or if the expansion of spamd_address
33566 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33567 statement block), append &`/defer_ok`& to the right-hand side of the
33568 spam condition, like this:
33569 .code
33570 deny message = This message was classified as SPAM
33571      spam    = joe/defer_ok
33572 .endd
33573 This causes messages to be accepted even if there is a problem with &%spamd%&.
33574
33575 Here is a longer, commented example of the use of the &%spam%&
33576 condition:
33577 .code
33578 # put headers in all messages (no matter if spam or not)
33579 warn  spam = nobody:true
33580       add_header = X-Spam-Score: $spam_score ($spam_bar)
33581       add_header = X-Spam-Report: $spam_report
33582
33583 # add second subject line with *SPAM* marker when message
33584 # is over threshold
33585 warn  spam = nobody
33586       add_header = Subject: *SPAM* $h_Subject:
33587
33588 # reject spam at high scores (> 12)
33589 deny  message = This message scored $spam_score spam points.
33590       spam = nobody:true
33591       condition = ${if >{$spam_score_int}{120}{1}{0}}
33592 .endd
33593
33594
33595
33596 .section "Scanning MIME parts" "SECTscanmimepart"
33597 .cindex "content scanning" "MIME parts"
33598 .cindex "MIME content scanning"
33599 .oindex "&%acl_smtp_mime%&"
33600 .oindex "&%acl_not_smtp_mime%&"
33601 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33602 each MIME part of an SMTP message, including multipart types, in the sequence
33603 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33604 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33605 options may both refer to the same ACL if you want the same processing in both
33606 cases.
33607
33608 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33609 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33610 the case of a non-SMTP message. However, a MIME ACL is called only if the
33611 message contains a &'Content-Type:'& header line. When a call to a MIME
33612 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33613 result code is sent to the client. In the case of an SMTP message, the
33614 &%acl_smtp_data%& ACL is not called when this happens.
33615
33616 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33617 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33618 condition to match against the raw MIME part. You can also use the
33619 &%mime_regex%& condition to match against the decoded MIME part (see section
33620 &<<SECTscanregex>>&).
33621
33622 At the start of a MIME ACL, a number of variables are set from the header
33623 information for the relevant MIME part. These are described below. The contents
33624 of the MIME part are not by default decoded into a disk file except for MIME
33625 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33626 part into a disk file, you can use the &%decode%& condition. The general
33627 syntax is:
33628 .display
33629 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33630 .endd
33631 The right hand side is expanded before use. After expansion,
33632 the value can be:
33633
33634 .olist
33635 &"0"& or &"false"&, in which case no decoding is done.
33636 .next
33637 The string &"default"&. In that case, the file is put in the temporary
33638 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33639 a sequential filename consisting of the message id and a sequence number. The
33640 full path and name is available in &$mime_decoded_filename$& after decoding.
33641 .next
33642 A full path name starting with a slash. If the full name is an existing
33643 directory, it is used as a replacement for the default directory. The filename
33644 is then sequentially assigned. If the path does not exist, it is used as
33645 the full path and filename.
33646 .next
33647 If the string does not start with a slash, it is used as the
33648 filename, and the default path is then used.
33649 .endlist
33650 The &%decode%& condition normally succeeds. It is only false for syntax
33651 errors or unusual circumstances such as memory shortages. You can easily decode
33652 a file with its original, proposed filename using
33653 .code
33654 decode = $mime_filename
33655 .endd
33656 However, you should keep in mind that &$mime_filename$& might contain
33657 anything. If you place files outside of the default path, they are not
33658 automatically unlinked.
33659
33660 For RFC822 attachments (these are messages attached to messages, with a
33661 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33662 as for the primary message, only that the &$mime_is_rfc822$& expansion
33663 variable is set (see below). Attached messages are always decoded to disk
33664 before being checked, and the files are unlinked once the check is done.
33665
33666 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33667 used to match regular expressions against raw and decoded MIME parts,
33668 respectively. They are described in section &<<SECTscanregex>>&.
33669
33670 .cindex "MIME content scanning" "returned variables"
33671 The following list describes all expansion variables that are
33672 available in the MIME ACL:
33673
33674 .vlist
33675 .vitem &$mime_boundary$&
33676 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33677 have a boundary string, which is stored in this variable. If the current part
33678 has no boundary parameter in the &'Content-Type:'& header, this variable
33679 contains the empty string.
33680
33681 .vitem &$mime_charset$&
33682 This variable contains the character set identifier, if one was found in the
33683 &'Content-Type:'& header. Examples for charset identifiers are:
33684 .code
33685 us-ascii
33686 gb2312 (Chinese)
33687 iso-8859-1
33688 .endd
33689 Please note that this value is not normalized, so you should do matches
33690 case-insensitively.
33691
33692 .vitem &$mime_content_description$&
33693 This variable contains the normalized content of the &'Content-Description:'&
33694 header. It can contain a human-readable description of the parts content. Some
33695 implementations repeat the filename for attachments here, but they are usually
33696 only used for display purposes.
33697
33698 .vitem &$mime_content_disposition$&
33699 This variable contains the normalized content of the &'Content-Disposition:'&
33700 header. You can expect strings like &"attachment"& or &"inline"& here.
33701
33702 .vitem &$mime_content_id$&
33703 This variable contains the normalized content of the &'Content-ID:'& header.
33704 This is a unique ID that can be used to reference a part from another part.
33705
33706 .vitem &$mime_content_size$&
33707 This variable is set only after the &%decode%& modifier (see above) has been
33708 successfully run. It contains the size of the decoded part in kilobytes. The
33709 size is always rounded up to full kilobytes, so only a completely empty part
33710 has a &$mime_content_size$& of zero.
33711
33712 .vitem &$mime_content_transfer_encoding$&
33713 This variable contains the normalized content of the
33714 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33715 type. Typical values are &"base64"& and &"quoted-printable"&.
33716
33717 .vitem &$mime_content_type$&
33718 If the MIME part has a &'Content-Type:'& header, this variable contains its
33719 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33720 are some examples of popular MIME types, as they may appear in this variable:
33721 .code
33722 text/plain
33723 text/html
33724 application/octet-stream
33725 image/jpeg
33726 audio/midi
33727 .endd
33728 If the MIME part has no &'Content-Type:'& header, this variable contains the
33729 empty string.
33730
33731 .vitem &$mime_decoded_filename$&
33732 This variable is set only after the &%decode%& modifier (see above) has been
33733 successfully run. It contains the full path and filename of the file
33734 containing the decoded data.
33735 .endlist
33736
33737 .cindex "RFC 2047"
33738 .vlist
33739 .vitem &$mime_filename$&
33740 This is perhaps the most important of the MIME variables. It contains a
33741 proposed filename for an attachment, if one was found in either the
33742 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33743 RFC2047
33744 or RFC2231
33745 decoded, but no additional sanity checks are done.
33746  If no filename was
33747 found, this variable contains the empty string.
33748
33749 .vitem &$mime_is_coverletter$&
33750 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33751 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33752 content in the cover letter, while not restricting attachments at all.
33753
33754 The variable contains 1 (true) for a MIME part believed to be part of the
33755 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33756 follows:
33757
33758 .olist
33759 The outermost MIME part of a message is always a cover letter.
33760
33761 .next
33762 If a multipart/alternative or multipart/related MIME part is a cover letter,
33763 so are all MIME subparts within that multipart.
33764
33765 .next
33766 If any other multipart is a cover letter, the first subpart is a cover letter,
33767 and the rest are attachments.
33768
33769 .next
33770 All parts contained within an attachment multipart are attachments.
33771 .endlist olist
33772
33773 As an example, the following will ban &"HTML mail"& (including that sent with
33774 alternative plain text), while allowing HTML files to be attached. HTML
33775 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33776 .code
33777 deny message = HTML mail is not accepted here
33778 !condition = $mime_is_rfc822
33779 condition = $mime_is_coverletter
33780 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33781 .endd
33782 .vitem &$mime_is_multipart$&
33783 This variable has the value 1 (true) when the current part has the main type
33784 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33785 Since multipart entities only serve as containers for other parts, you may not
33786 want to carry out specific actions on them.
33787
33788 .vitem &$mime_is_rfc822$&
33789 This variable has the value 1 (true) if the current part is not a part of the
33790 checked message itself, but part of an attached message. Attached message
33791 decoding is fully recursive.
33792
33793 .vitem &$mime_part_count$&
33794 This variable is a counter that is raised for each processed MIME part. It
33795 starts at zero for the very first part (which is usually a multipart). The
33796 counter is per-message, so it is reset when processing RFC822 attachments (see
33797 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33798 complete, so you can use it in the DATA ACL to determine the number of MIME
33799 parts of a message. For non-MIME messages, this variable contains the value -1.
33800 .endlist
33801
33802
33803
33804 .section "Scanning with regular expressions" "SECTscanregex"
33805 .cindex "content scanning" "with regular expressions"
33806 .cindex "regular expressions" "content scanning with"
33807 You can specify your own custom regular expression matches on the full body of
33808 the message, or on individual MIME parts.
33809
33810 The &%regex%& condition takes one or more regular expressions as arguments and
33811 matches them against the full message (when called in the DATA ACL) or a raw
33812 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33813 linewise, with a maximum line length of 32K characters. That means you cannot
33814 have multiline matches with the &%regex%& condition.
33815
33816 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33817 to 32K of decoded content (the whole content at once, not linewise). If the
33818 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33819 is decoded automatically when &%mime_regex%& is executed (using default path
33820 and filename values). If the decoded data is larger than  32K, only the first
33821 32K characters are checked.
33822
33823 The regular expressions are passed as a colon-separated list. To include a
33824 literal colon, you must double it. Since the whole right-hand side string is
33825 expanded before being used, you must also escape dollar signs and backslashes
33826 with more backslashes, or use the &`\N`& facility to disable expansion.
33827 Here is a simple example that contains two regular expressions:
33828 .code
33829 deny message = contains blacklisted regex ($regex_match_string)
33830      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33831 .endd
33832 The conditions returns true if any one of the regular expressions matches. The
33833 &$regex_match_string$& expansion variable is then set up and contains the
33834 matching regular expression.
33835 The expansion variables &$regex1$& &$regex2$& etc
33836 are set to any substrings captured by the regular expression.
33837
33838 &*Warning*&: With large messages, these conditions can be fairly
33839 CPU-intensive.
33840
33841 .ecindex IIDcosca
33842
33843
33844
33845
33846 . ////////////////////////////////////////////////////////////////////////////
33847 . ////////////////////////////////////////////////////////////////////////////
33848
33849 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33850          "Local scan function"
33851 .scindex IIDlosca "&[local_scan()]& function" "description of"
33852 .cindex "customizing" "input scan using C function"
33853 .cindex "policy control" "by local scan function"
33854 In these days of email worms, viruses, and ever-increasing spam, some sites
33855 want to apply a lot of checking to messages before accepting them.
33856
33857 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33858 passing messages to external virus and spam scanning software. You can also do
33859 a certain amount in Exim itself through string expansions and the &%condition%&
33860 condition in the ACL that runs after the SMTP DATA command or the ACL for
33861 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33862
33863 To allow for further customization to a site's own requirements, there is the
33864 possibility of linking Exim with a private message scanning function, written
33865 in C. If you want to run code that is written in something other than C, you
33866 can of course use a little C stub to call it.
33867
33868 The local scan function is run once for every incoming message, at the point
33869 when Exim is just about to accept the message.
33870 It can therefore be used to control non-SMTP messages from local processes as
33871 well as messages arriving via SMTP.
33872
33873 Exim applies a timeout to calls of the local scan function, and there is an
33874 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33875 Zero means &"no timeout"&.
33876 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33877 before calling the local scan function, so that the most common types of crash
33878 are caught. If the timeout is exceeded or one of those signals is caught, the
33879 incoming message is rejected with a temporary error if it is an SMTP message.
33880 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33881 code. The incident is logged on the main and reject logs.
33882
33883
33884
33885 .section "Building Exim to use a local scan function" "SECID207"
33886 .cindex "&[local_scan()]& function" "building Exim to use"
33887 To make use of the local scan function feature, you must tell Exim where your
33888 function is before building Exim, by setting
33889 both HAVE_LOCAL_SCAN and
33890 LOCAL_SCAN_SOURCE in your
33891 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33892 directory, so you might set
33893 .code
33894 HAVE_LOCAL_SCAN=yes
33895 LOCAL_SCAN_SOURCE=Local/local_scan.c
33896 .endd
33897 for example. The function must be called &[local_scan()]&;
33898 .new
33899 the source file(s) for it should first #define LOCAL_SCAN
33900 and then #include "local_scan.h".
33901 .wen
33902 It is called by
33903 Exim after it has received a message, when the success return code is about to
33904 be sent. This is after all the ACLs have been run. The return code from your
33905 function controls whether the message is actually accepted or not. There is a
33906 commented template function (that just accepts the message) in the file
33907 _src/local_scan.c_.
33908
33909 If you want to make use of Exim's runtime configuration file to set options
33910 for your &[local_scan()]& function, you must also set
33911 .code
33912 LOCAL_SCAN_HAS_OPTIONS=yes
33913 .endd
33914 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33915
33916
33917
33918
33919 .section "API for local_scan()" "SECTapiforloc"
33920 .cindex "&[local_scan()]& function" "API description"
33921 .cindex &%dlfunc%& "API description"
33922 You must include this line near the start of your code:
33923 .code
33924 #define LOCAL_SCAN
33925 #include "local_scan.h"
33926 .endd
33927 This header file defines a number of variables and other values, and the
33928 prototype for the function itself. Exim is coded to use unsigned char values
33929 almost exclusively, and one of the things this header defines is a shorthand
33930 for &`unsigned char`& called &`uschar`&.
33931 It also makes available the following macro definitions, to simplify casting character
33932 strings and pointers to character strings:
33933 .code
33934 #define CS   (char *)
33935 #define CCS  (const char *)
33936 #define CSS  (char **)
33937 #define US   (unsigned char *)
33938 #define CUS  (const unsigned char *)
33939 #define USS  (unsigned char **)
33940 .endd
33941 The function prototype for &[local_scan()]& is:
33942 .code
33943 extern int local_scan(int fd, uschar **return_text);
33944 .endd
33945 The arguments are as follows:
33946
33947 .ilist
33948 &%fd%& is a file descriptor for the file that contains the body of the message
33949 (the -D file). The file is open for reading and writing, but updating it is not
33950 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33951
33952 The descriptor is positioned at character 19 of the file, which is the first
33953 character of the body itself, because the first 19 characters are the message
33954 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33955 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33956 case this changes in some future version.
33957 .next
33958 &%return_text%& is an address which you can use to return a pointer to a text
33959 string at the end of the function. The value it points to on entry is NULL.
33960 .endlist
33961
33962 The function must return an &%int%& value which is one of the following macros:
33963
33964 .vlist
33965 .vitem &`LOCAL_SCAN_ACCEPT`&
33966 .vindex "&$local_scan_data$&"
33967 The message is accepted. If you pass back a string of text, it is saved with
33968 the message, and made available in the variable &$local_scan_data$&. No
33969 newlines are permitted (if there are any, they are turned into spaces) and the
33970 maximum length of text is 1000 characters.
33971
33972 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33973 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33974 queued without immediate delivery, and is frozen.
33975
33976 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33977 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33978 queued without immediate delivery.
33979
33980 .vitem &`LOCAL_SCAN_REJECT`&
33981 The message is rejected; the returned text is used as an error message which is
33982 passed back to the sender and which is also logged. Newlines are permitted &--
33983 they cause a multiline response for SMTP rejections, but are converted to
33984 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33985 used.
33986
33987 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33988 The message is temporarily rejected; the returned text is used as an error
33989 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33990 problem"& is used.
33991
33992 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33993 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33994 message is not written to the reject log. It has the effect of unsetting the
33995 &%rejected_header%& log selector for just this rejection. If
33996 &%rejected_header%& is already unset (see the discussion of the
33997 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33998 same as LOCAL_SCAN_REJECT.
33999
34000 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34001 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34002 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34003 .endlist
34004
34005 If the message is not being received by interactive SMTP, rejections are
34006 reported by writing to &%stderr%& or by sending an email, as configured by the
34007 &%-oe%& command line options.
34008
34009
34010
34011 .section "Configuration options for local_scan()" "SECTconoptloc"
34012 .cindex "&[local_scan()]& function" "configuration options"
34013 It is possible to have option settings in the main configuration file
34014 that set values in static variables in the &[local_scan()]& module. If you
34015 want to do this, you must have the line
34016 .code
34017 LOCAL_SCAN_HAS_OPTIONS=yes
34018 .endd
34019 in your &_Local/Makefile_& when you build Exim. (This line is in
34020 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34021 file, you must define static variables to hold the option values, and a table
34022 to define them.
34023
34024 The table must be a vector called &%local_scan_options%&, of type
34025 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34026 and a pointer to the variable that holds the value. The entries must appear in
34027 alphabetical order. Following &%local_scan_options%& you must also define a
34028 variable called &%local_scan_options_count%& that contains the number of
34029 entries in the table. Here is a short example, showing two kinds of option:
34030 .code
34031 static int my_integer_option = 42;
34032 static uschar *my_string_option = US"a default string";
34033
34034 optionlist local_scan_options[] = {
34035   { "my_integer", opt_int,       &my_integer_option },
34036   { "my_string",  opt_stringptr, &my_string_option }
34037 };
34038
34039 int local_scan_options_count =
34040   sizeof(local_scan_options)/sizeof(optionlist);
34041 .endd
34042 The values of the variables can now be changed from Exim's runtime
34043 configuration file by including a local scan section as in this example:
34044 .code
34045 begin local_scan
34046 my_integer = 99
34047 my_string = some string of text...
34048 .endd
34049 The available types of option data are as follows:
34050
34051 .vlist
34052 .vitem &*opt_bool*&
34053 This specifies a boolean (true/false) option. The address should point to a
34054 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34055 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34056 whether such a variable has been set at all, you can initialize it to
34057 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34058 values.)
34059
34060 .vitem &*opt_fixed*&
34061 This specifies a fixed point number, such as is used for load averages.
34062 The address should point to a variable of type &`int`&. The value is stored
34063 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34064
34065 .vitem &*opt_int*&
34066 This specifies an integer; the address should point to a variable of type
34067 &`int`&. The value may be specified in any of the integer formats accepted by
34068 Exim.
34069
34070 .vitem &*opt_mkint*&
34071 This is the same as &%opt_int%&, except that when such a value is output in a
34072 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34073 printed with the suffix K or M.
34074
34075 .vitem &*opt_octint*&
34076 This also specifies an integer, but the value is always interpreted as an
34077 octal integer, whether or not it starts with the digit zero, and it is
34078 always output in octal.
34079
34080 .vitem &*opt_stringptr*&
34081 This specifies a string value; the address must be a pointer to a
34082 variable that points to a string (for example, of type &`uschar *`&).
34083
34084 .vitem &*opt_time*&
34085 This specifies a time interval value. The address must point to a variable of
34086 type &`int`&. The value that is placed there is a number of seconds.
34087 .endlist
34088
34089 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34090 out the values of all the &[local_scan()]& options.
34091
34092
34093
34094 .section "Available Exim variables" "SECID208"
34095 .cindex "&[local_scan()]& function" "available Exim variables"
34096 The header &_local_scan.h_& gives you access to a number of C variables. These
34097 are the only ones that are guaranteed to be maintained from release to release.
34098 Note, however, that you can obtain the value of any Exim expansion variable,
34099 including &$recipients$&, by calling &'expand_string()'&. The exported
34100 C variables are as follows:
34101
34102 .vlist
34103 .vitem &*int&~body_linecount*&
34104 This variable contains the number of lines in the message's body.
34105 It is not valid if the &%spool_files_wireformat%& option is used.
34106
34107 .vitem &*int&~body_zerocount*&
34108 This variable contains the number of binary zero bytes in the message's body.
34109 It is not valid if the &%spool_files_wireformat%& option is used.
34110
34111 .vitem &*unsigned&~int&~debug_selector*&
34112 This variable is set to zero when no debugging is taking place. Otherwise, it
34113 is a bitmap of debugging selectors. Two bits are identified for use in
34114 &[local_scan()]&; they are defined as macros:
34115
34116 .ilist
34117 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34118 testing option that is not privileged &-- any caller may set it. All the
34119 other selector bits can be set only by admin users.
34120
34121 .next
34122 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34123 by the &`+local_scan`& debug selector. It is not included in the default set
34124 of debugging bits.
34125 .endlist ilist
34126
34127 Thus, to write to the debugging output only when &`+local_scan`& has been
34128 selected, you should use code like this:
34129 .code
34130 if ((debug_selector & D_local_scan) != 0)
34131   debug_printf("xxx", ...);
34132 .endd
34133 .vitem &*uschar&~*expand_string_message*&
34134 After a failing call to &'expand_string()'& (returned value NULL), the
34135 variable &%expand_string_message%& contains the error message, zero-terminated.
34136
34137 .vitem &*header_line&~*header_list*&
34138 A pointer to a chain of header lines. The &%header_line%& structure is
34139 discussed below.
34140
34141 .vitem &*header_line&~*header_last*&
34142 A pointer to the last of the header lines.
34143
34144 .vitem &*uschar&~*headers_charset*&
34145 The value of the &%headers_charset%& configuration option.
34146
34147 .vitem &*BOOL&~host_checking*&
34148 This variable is TRUE during a host checking session that is initiated by the
34149 &%-bh%& command line option.
34150
34151 .vitem &*uschar&~*interface_address*&
34152 The IP address of the interface that received the message, as a string. This
34153 is NULL for locally submitted messages.
34154
34155 .vitem &*int&~interface_port*&
34156 The port on which this message was received. When testing with the &%-bh%&
34157 command line option, the value of this variable is -1 unless a port has been
34158 specified via the &%-oMi%& option.
34159
34160 .vitem &*uschar&~*message_id*&
34161 This variable contains Exim's message id for the incoming message (the value of
34162 &$message_exim_id$&) as a zero-terminated string.
34163
34164 .vitem &*uschar&~*received_protocol*&
34165 The name of the protocol by which the message was received.
34166
34167 .vitem &*int&~recipients_count*&
34168 The number of accepted recipients.
34169
34170 .vitem &*recipient_item&~*recipients_list*&
34171 .cindex "recipient" "adding in local scan"
34172 .cindex "recipient" "removing in local scan"
34173 The list of accepted recipients, held in a vector of length
34174 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34175 can add additional recipients by calling &'receive_add_recipient()'& (see
34176 below). You can delete recipients by removing them from the vector and
34177 adjusting the value in &%recipients_count%&. In particular, by setting
34178 &%recipients_count%& to zero you remove all recipients. If you then return the
34179 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34180 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34181 and then call &'receive_add_recipient()'& as often as needed.
34182
34183 .vitem &*uschar&~*sender_address*&
34184 The envelope sender address. For bounce messages this is the empty string.
34185
34186 .vitem &*uschar&~*sender_host_address*&
34187 The IP address of the sending host, as a string. This is NULL for
34188 locally-submitted messages.
34189
34190 .vitem &*uschar&~*sender_host_authenticated*&
34191 The name of the authentication mechanism that was used, or NULL if the message
34192 was not received over an authenticated SMTP connection.
34193
34194 .vitem &*uschar&~*sender_host_name*&
34195 The name of the sending host, if known.
34196
34197 .vitem &*int&~sender_host_port*&
34198 The port on the sending host.
34199
34200 .vitem &*BOOL&~smtp_input*&
34201 This variable is TRUE for all SMTP input, including BSMTP.
34202
34203 .vitem &*BOOL&~smtp_batched_input*&
34204 This variable is TRUE for BSMTP input.
34205
34206 .vitem &*int&~store_pool*&
34207 The contents of this variable control which pool of memory is used for new
34208 requests. See section &<<SECTmemhanloc>>& for details.
34209 .endlist
34210
34211
34212 .section "Structure of header lines" "SECID209"
34213 The &%header_line%& structure contains the members listed below.
34214 You can add additional header lines by calling the &'header_add()'& function
34215 (see below). You can cause header lines to be ignored (deleted) by setting
34216 their type to *.
34217
34218
34219 .vlist
34220 .vitem &*struct&~header_line&~*next*&
34221 A pointer to the next header line, or NULL for the last line.
34222
34223 .vitem &*int&~type*&
34224 A code identifying certain headers that Exim recognizes. The codes are printing
34225 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34226 Notice in particular that any header line whose type is * is not transmitted
34227 with the message. This flagging is used for header lines that have been
34228 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34229 lines.) Effectively, * means &"deleted"&.
34230
34231 .vitem &*int&~slen*&
34232 The number of characters in the header line, including the terminating and any
34233 internal newlines.
34234
34235 .vitem &*uschar&~*text*&
34236 A pointer to the text of the header. It always ends with a newline, followed by
34237 a zero byte. Internal newlines are preserved.
34238 .endlist
34239
34240
34241
34242 .section "Structure of recipient items" "SECID210"
34243 The &%recipient_item%& structure contains these members:
34244
34245 .vlist
34246 .vitem &*uschar&~*address*&
34247 This is a pointer to the recipient address as it was received.
34248
34249 .vitem &*int&~pno*&
34250 This is used in later Exim processing when top level addresses are created by
34251 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34252 and must always contain -1 at this stage.
34253
34254 .vitem &*uschar&~*errors_to*&
34255 If this value is not NULL, bounce messages caused by failing to deliver to the
34256 recipient are sent to the address it contains. In other words, it overrides the
34257 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34258 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34259 an unqualified address, Exim qualifies it using the domain from
34260 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34261 is NULL for all recipients.
34262 .endlist
34263
34264
34265
34266 .section "Available Exim functions" "SECID211"
34267 .cindex "&[local_scan()]& function" "available Exim functions"
34268 The header &_local_scan.h_& gives you access to a number of Exim functions.
34269 These are the only ones that are guaranteed to be maintained from release to
34270 release:
34271
34272 .vlist
34273 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34274        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34275
34276 This function creates a child process that runs the command specified by
34277 &%argv%&. The environment for the process is specified by &%envp%&, which can
34278 be NULL if no environment variables are to be passed. A new umask is supplied
34279 for the process in &%newumask%&.
34280
34281 Pipes to the standard input and output of the new process are set up
34282 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34283 standard error is cloned to the standard output. If there are any file
34284 descriptors &"in the way"& in the new process, they are closed. If the final
34285 argument is TRUE, the new process is made into a process group leader.
34286
34287 The function returns the pid of the new process, or -1 if things go wrong.
34288
34289 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34290 This function waits for a child process to terminate, or for a timeout (in
34291 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34292 return value is as follows:
34293
34294 .ilist
34295 >= 0
34296
34297 The process terminated by a normal exit and the value is the process
34298 ending status.
34299
34300 .next
34301 < 0 and > &--256
34302
34303 The process was terminated by a signal and the value is the negation of the
34304 signal number.
34305
34306 .next
34307 &--256
34308
34309 The process timed out.
34310 .next
34311 &--257
34312
34313 The was some other error in wait(); &%errno%& is still set.
34314 .endlist
34315
34316 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34317 This function provide you with a means of submitting a new message to
34318 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34319 want, but this packages it all up for you.) The function creates a pipe,
34320 forks a subprocess that is running
34321 .code
34322 exim -t -oem -oi -f <>
34323 .endd
34324 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34325 that is connected to the standard input. The yield of the function is the PID
34326 of the subprocess. You can then write a message to the file descriptor, with
34327 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34328
34329 When you have finished, call &'child_close()'& to wait for the process to
34330 finish and to collect its ending status. A timeout value of zero is usually
34331 fine in this circumstance. Unless you have made a mistake with the recipient
34332 addresses, you should get a return code of zero.
34333
34334
34335 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34336        *sender_authentication)*&
34337 This function is a more sophisticated version of &'child_open()'&. The command
34338 that it runs is:
34339 .display
34340 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34341 .endd
34342 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34343
34344
34345 .vitem &*void&~debug_printf(char&~*,&~...)*&
34346 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34347 output is written to the standard error stream. If no debugging is selected,
34348 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34349 conditional on the &`local_scan`& debug selector by coding like this:
34350 .code
34351 if ((debug_selector & D_local_scan) != 0)
34352   debug_printf("xxx", ...);
34353 .endd
34354
34355 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34356 This is an interface to Exim's string expansion code. The return value is the
34357 expanded string, or NULL if there was an expansion failure.
34358 The C variable &%expand_string_message%& contains an error message after an
34359 expansion failure. If expansion does not change the string, the return value is
34360 the pointer to the input string. Otherwise, the return value points to a new
34361 block of memory that was obtained by a call to &'store_get()'&. See section
34362 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34363
34364 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34365 This function allows you to an add additional header line at the end of the
34366 existing ones. The first argument is the type, and should normally be a space
34367 character. The second argument is a format string and any number of
34368 substitution arguments as for &[sprintf()]&. You may include internal newlines
34369 if you want, and you must ensure that the string ends with a newline.
34370
34371 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34372         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34373 This function adds a new header line at a specified point in the header
34374 chain. The header itself is specified as for &'header_add()'&.
34375
34376 If &%name%& is NULL, the new header is added at the end of the chain if
34377 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34378 NULL, the header lines are searched for the first non-deleted header that
34379 matches the name. If one is found, the new header is added before it if
34380 &%after%& is false. If &%after%& is true, the new header is added after the
34381 found header and any adjacent subsequent ones with the same name (even if
34382 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34383 option controls where the header is added. If it is true, addition is at the
34384 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34385 headers, or at the top if there are no &'Received:'& headers, you could use
34386 .code
34387 header_add_at_position(TRUE, US"Received", TRUE,
34388   ' ', "X-xxx: ...");
34389 .endd
34390 Normally, there is always at least one non-deleted &'Received:'& header, but
34391 there may not be if &%received_header_text%& expands to an empty string.
34392
34393
34394 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34395 This function removes header lines. If &%occurrence%& is zero or negative, all
34396 occurrences of the header are removed. If occurrence is greater than zero, that
34397 particular instance of the header is removed. If no header(s) can be found that
34398 match the specification, the function does nothing.
34399
34400
34401 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34402         int&~length,&~BOOL&~notdel)*&"
34403 This function tests whether the given header has the given name. It is not just
34404 a string comparison, because white space is permitted between the name and the
34405 colon. If the &%notdel%& argument is true, a false return is forced for all
34406 &"deleted"& headers; otherwise they are not treated specially. For example:
34407 .code
34408 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34409 .endd
34410 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34411 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34412 This function base64-encodes a string, which is passed by address and length.
34413 The text may contain bytes of any value, including zero. The result is passed
34414 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34415 zero-terminated.
34416
34417 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34418 This function decodes a base64-encoded string. Its arguments are a
34419 zero-terminated base64-encoded string and the address of a variable that is set
34420 to point to the result, which is in dynamic memory. The length of the decoded
34421 string is the yield of the function. If the input is invalid base64 data, the
34422 yield is -1. A zero byte is added to the end of the output string to make it
34423 easy to interpret as a C string (assuming it contains no zeros of its own). The
34424 added zero byte is not included in the returned count.
34425
34426 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34427 This function checks for a match in a domain list. Domains are always
34428 matched caselessly. The return value is one of the following:
34429 .display
34430 &`OK     `& match succeeded
34431 &`FAIL   `& match failed
34432 &`DEFER  `& match deferred
34433 .endd
34434 DEFER is usually caused by some kind of lookup defer, such as the
34435 inability to contact a database.
34436
34437 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34438         BOOL&~caseless)*&"
34439 This function checks for a match in a local part list. The third argument
34440 controls case-sensitivity. The return values are as for
34441 &'lss_match_domain()'&.
34442
34443 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34444         BOOL&~caseless)*&"
34445 This function checks for a match in an address list. The third argument
34446 controls the case-sensitivity of the local part match. The domain is always
34447 matched caselessly. The return values are as for &'lss_match_domain()'&.
34448
34449 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34450         uschar&~*list)*&"
34451 This function checks for a match in a host list. The most common usage is
34452 expected to be
34453 .code
34454 lss_match_host(sender_host_name, sender_host_address, ...)
34455 .endd
34456 .vindex "&$sender_host_address$&"
34457 An empty address field matches an empty item in the host list. If the host name
34458 is NULL, the name corresponding to &$sender_host_address$& is automatically
34459 looked up if a host name is required to match an item in the list. The return
34460 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34461 returns ERROR in the case when it had to look up a host name, but the lookup
34462 failed.
34463
34464 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34465         *format,&~...)*&"
34466 This function writes to Exim's log files. The first argument should be zero (it
34467 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34468 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34469 them. It specifies to which log or logs the message is written. The remaining
34470 arguments are a format and relevant insertion arguments. The string should not
34471 contain any newlines, not even at the end.
34472
34473
34474 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34475 This function adds an additional recipient to the message. The first argument
34476 is the recipient address. If it is unqualified (has no domain), it is qualified
34477 with the &%qualify_recipient%& domain. The second argument must always be -1.
34478
34479 This function does not allow you to specify a private &%errors_to%& address (as
34480 described with the structure of &%recipient_item%& above), because it pre-dates
34481 the addition of that field to the structure. However, it is easy to add such a
34482 value afterwards. For example:
34483 .code
34484  receive_add_recipient(US"monitor@mydom.example", -1);
34485  recipients_list[recipients_count-1].errors_to =
34486    US"postmaster@mydom.example";
34487 .endd
34488
34489 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34490 This is a convenience function to remove a named recipient from the list of
34491 recipients. It returns true if a recipient was removed, and false if no
34492 matching recipient could be found. The argument must be a complete email
34493 address.
34494 .endlist
34495
34496
34497 .cindex "RFC 2047"
34498 .vlist
34499 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34500   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34501 This function decodes strings that are encoded according to RFC 2047. Typically
34502 these are the contents of header lines. First, each &"encoded word"& is decoded
34503 from the Q or B encoding into a byte-string. Then, if provided with the name of
34504 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34505 made  to translate the result to the named character set. If this fails, the
34506 binary string is returned with an error message.
34507
34508 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34509 maximum MIME word length is enforced. The third argument is the target
34510 encoding, or NULL if no translation is wanted.
34511
34512 .cindex "binary zero" "in RFC 2047 decoding"
34513 .cindex "RFC 2047" "binary zero in"
34514 If a binary zero is encountered in the decoded string, it is replaced by the
34515 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34516 not be 0 because header lines are handled as zero-terminated strings.
34517
34518 The function returns the result of processing the string, zero-terminated; if
34519 &%lenptr%& is not NULL, the length of the result is set in the variable to
34520 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34521
34522 If an error is encountered, the function returns NULL and uses the &%error%&
34523 argument to return an error message. The variable pointed to by &%error%& is
34524 set to NULL if there is no error; it may be set non-NULL even when the function
34525 returns a non-NULL value if decoding was successful, but there was a problem
34526 with translation.
34527
34528
34529 .vitem &*int&~smtp_fflush(void)*&
34530 This function is used in conjunction with &'smtp_printf()'&, as described
34531 below.
34532
34533 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34534 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34535 output stream. You should use this function only when there is an SMTP output
34536 stream, that is, when the incoming message is being received via interactive
34537 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34538 is FALSE. If you want to test for an incoming message from another host (as
34539 opposed to a local process that used the &%-bs%& command line option), you can
34540 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34541 is involved.
34542
34543 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34544 output function, so it can be used for all forms of SMTP connection.
34545
34546 The second argument is used to request that the data be buffered
34547 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34548 This is advisory only, but likely to save on system-calls and packets
34549 sent when a sequence of calls to the function are made.
34550
34551 The argument was added in Exim version 4.90 - changing the API/ABI.
34552 Nobody noticed until 4.93 was imminent, at which point the
34553 ABI version number was incremented.
34554
34555 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34556 must start with an appropriate response code: 550 if you are going to return
34557 LOCAL_SCAN_REJECT, 451 if you are going to return
34558 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34559 initial lines of a multi-line response, the code must be followed by a hyphen
34560 to indicate that the line is not the final response line. You must also ensure
34561 that the lines you write terminate with CRLF. For example:
34562 .code
34563 smtp_printf("550-this is some extra info\r\n");
34564 return LOCAL_SCAN_REJECT;
34565 .endd
34566 Note that you can also create multi-line responses by including newlines in
34567 the data returned via the &%return_text%& argument. The added value of using
34568 &'smtp_printf()'& is that, for instance, you could introduce delays between
34569 multiple output lines.
34570
34571 The &'smtp_printf()'& function does not return any error indication, because it
34572 does not
34573 guarantee a flush of
34574 pending output, and therefore does not test
34575 the state of the stream. (In the main code of Exim, flushing and error
34576 detection is done when Exim is ready for the next SMTP input command.) If
34577 you want to flush the output and check for an error (for example, the
34578 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34579 arguments. It flushes the output stream, and returns a non-zero value if there
34580 is an error.
34581
34582 .new
34583 .vitem &*void&~*store_get(int,BOOL)*&
34584 This function accesses Exim's internal store (memory) manager. It gets a new
34585 chunk of memory whose size is given by the first argument.
34586 The second argument should be given as TRUE if the memory will be used for
34587 data possibly coming from an attacker (eg. the message content),
34588 FALSE if it is locally-sourced.
34589 Exim bombs out if it ever
34590 runs out of memory. See the next section for a discussion of memory handling.
34591 .wen
34592
34593 .vitem &*void&~*store_get_perm(int,BOOL)*&
34594 This function is like &'store_get()'&, but it always gets memory from the
34595 permanent pool. See the next section for a discussion of memory handling.
34596
34597 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34598 See below.
34599
34600 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34601 See below.
34602
34603 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34604 These three functions create strings using Exim's dynamic memory facilities.
34605 The first makes a copy of an entire string. The second copies up to a maximum
34606 number of characters, indicated by the second argument. The third uses a format
34607 and insertion arguments to create a new string. In each case, the result is a
34608 pointer to a new string in the current memory pool. See the next section for
34609 more discussion.
34610 .endlist
34611
34612
34613
34614 .section "More about Exim's memory handling" "SECTmemhanloc"
34615 .cindex "&[local_scan()]& function" "memory handling"
34616 No function is provided for freeing memory, because that is never needed.
34617 The dynamic memory that Exim uses when receiving a message is automatically
34618 recycled if another message is received by the same process (this applies only
34619 to incoming SMTP connections &-- other input methods can supply only one
34620 message at a time). After receiving the last message, a reception process
34621 terminates.
34622
34623 Because it is recycled, the normal dynamic memory cannot be used for holding
34624 data that must be preserved over a number of incoming messages on the same SMTP
34625 connection. However, Exim in fact uses two pools of dynamic memory; the second
34626 one is not recycled, and can be used for this purpose.
34627
34628 If you want to allocate memory that remains available for subsequent messages
34629 in the same SMTP connection, you should set
34630 .code
34631 store_pool = POOL_PERM
34632 .endd
34633 before calling the function that does the allocation. There is no need to
34634 restore the value if you do not need to; however, if you do want to revert to
34635 the normal pool, you can either restore the previous value of &%store_pool%& or
34636 set it explicitly to POOL_MAIN.
34637
34638 The pool setting applies to all functions that get dynamic memory, including
34639 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34640 There is also a convenience function called &'store_get_perm()'& that gets a
34641 block of memory from the permanent pool while preserving the value of
34642 &%store_pool%&.
34643 .ecindex IIDlosca
34644
34645
34646
34647
34648 . ////////////////////////////////////////////////////////////////////////////
34649 . ////////////////////////////////////////////////////////////////////////////
34650
34651 .chapter "System-wide message filtering" "CHAPsystemfilter"
34652 .scindex IIDsysfil1 "filter" "system filter"
34653 .scindex IIDsysfil2 "filtering all mail"
34654 .scindex IIDsysfil3 "system filter"
34655 The previous chapters (on ACLs and the local scan function) describe checks
34656 that can be applied to messages before they are accepted by a host. There is
34657 also a mechanism for checking messages once they have been received, but before
34658 they are delivered. This is called the &'system filter'&.
34659
34660 The system filter operates in a similar manner to users' filter files, but it
34661 is run just once per message (however many recipients the message has).
34662 It should not normally be used as a substitute for routing, because &%deliver%&
34663 commands in a system router provide new envelope recipient addresses.
34664 The system filter must be an Exim filter. It cannot be a Sieve filter.
34665
34666 The system filter is run at the start of a delivery attempt, before any routing
34667 is done. If a message fails to be completely delivered at the first attempt,
34668 the system filter is run again at the start of every retry.
34669 If you want your filter to do something only once per message, you can make use
34670 of the &%first_delivery%& condition in an &%if%& command in the filter to
34671 prevent it happening on retries.
34672
34673 .vindex "&$domain$&"
34674 .vindex "&$local_part$&"
34675 &*Warning*&: Because the system filter runs just once, variables that are
34676 specific to individual recipient addresses, such as &$local_part$& and
34677 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34678 you want to run a centrally-specified filter for each recipient address
34679 independently, you can do so by setting up a suitable &(redirect)& router, as
34680 described in section &<<SECTperaddfil>>& below.
34681
34682
34683 .section "Specifying a system filter" "SECID212"
34684 .cindex "uid (user id)" "system filter"
34685 .cindex "gid (group id)" "system filter"
34686 The name of the file that contains the system filter must be specified by
34687 setting &%system_filter%&. If you want the filter to run under a uid and gid
34688 other than root, you must also set &%system_filter_user%& and
34689 &%system_filter_group%& as appropriate. For example:
34690 .code
34691 system_filter = /etc/mail/exim.filter
34692 system_filter_user = exim
34693 .endd
34694 If a system filter generates any deliveries directly to files or pipes (via the
34695 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34696 specified by setting &%system_filter_file_transport%& and
34697 &%system_filter_pipe_transport%&, respectively. Similarly,
34698 &%system_filter_reply_transport%& must be set to handle any messages generated
34699 by the &%reply%& command.
34700
34701
34702 .section "Testing a system filter" "SECID213"
34703 You can run simple tests of a system filter in the same way as for a user
34704 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34705 are permitted only in system filters are recognized.
34706
34707 If you want to test the combined effect of a system filter and a user filter,
34708 you can use both &%-bF%& and &%-bf%& on the same command line.
34709
34710
34711
34712 .section "Contents of a system filter" "SECID214"
34713 The language used to specify system filters is the same as for users' filter
34714 files. It is described in the separate end-user document &'Exim's interface to
34715 mail filtering'&. However, there are some additional features that are
34716 available only in system filters; these are described in subsequent sections.
34717 If they are encountered in a user's filter file or when testing with &%-bf%&,
34718 they cause errors.
34719
34720 .cindex "frozen messages" "manual thaw; testing in filter"
34721 There are two special conditions which, though available in users' filter
34722 files, are designed for use in system filters. The condition &%first_delivery%&
34723 is true only for the first attempt at delivering a message, and
34724 &%manually_thawed%& is true only if the message has been frozen, and
34725 subsequently thawed by an admin user. An explicit forced delivery counts as a
34726 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34727
34728 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34729 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34730 succeed, it will not be tried again.
34731 If you want Exim to retry an unseen delivery until it succeeds, you should
34732 arrange to set it up every time the filter runs.
34733
34734 When a system filter finishes running, the values of the variables &$n0$& &--
34735 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34736 users' filter files. Thus a system filter can, for example, set up &"scores"&
34737 to which users' filter files can refer.
34738
34739
34740
34741 .section "Additional variable for system filters" "SECID215"
34742 .vindex "&$recipients$&"
34743 The expansion variable &$recipients$&, containing a list of all the recipients
34744 of the message (separated by commas and white space), is available in system
34745 filters. It is not available in users' filters for privacy reasons.
34746
34747
34748
34749 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34750 .cindex "freezing messages"
34751 .cindex "message" "freezing"
34752 .cindex "message" "forced failure"
34753 .cindex "&%fail%&" "in system filter"
34754 .cindex "&%freeze%& in system filter"
34755 .cindex "&%defer%& in system filter"
34756 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34757 always available in system filters, but are not normally enabled in users'
34758 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34759 for the &(redirect)& router.) These commands can optionally be followed by the
34760 word &%text%& and a string containing an error message, for example:
34761 .code
34762 fail text "this message looks like spam to me"
34763 .endd
34764 The keyword &%text%& is optional if the next character is a double quote.
34765
34766 The &%defer%& command defers delivery of the original recipients of the
34767 message. The &%fail%& command causes all the original recipients to be failed,
34768 and a bounce message to be created. The &%freeze%& command suspends all
34769 delivery attempts for the original recipients. In all cases, any new deliveries
34770 that are specified by the filter are attempted as normal after the filter has
34771 run.
34772
34773 The &%freeze%& command is ignored if the message has been manually unfrozen and
34774 not manually frozen since. This means that automatic freezing by a system
34775 filter can be used as a way of checking out suspicious messages. If a message
34776 is found to be all right, manually unfreezing it allows it to be delivered.
34777
34778 .cindex "log" "&%fail%& command log line"
34779 .cindex "&%fail%&" "log line; reducing"
34780 The text given with a fail command is used as part of the bounce message as
34781 well as being written to the log. If the message is quite long, this can fill
34782 up a lot of log space when such failures are common. To reduce the size of the
34783 log message, Exim interprets the text in a special way if it starts with the
34784 two characters &`<<`& and contains &`>>`& later. The text between these two
34785 strings is written to the log, and the rest of the text is used in the bounce
34786 message. For example:
34787 .code
34788 fail "<<filter test 1>>Your message is rejected \
34789      because it contains attachments that we are \
34790      not prepared to receive."
34791 .endd
34792
34793 .cindex "loop" "caused by &%fail%&"
34794 Take great care with the &%fail%& command when basing the decision to fail on
34795 the contents of the message, because the bounce message will of course include
34796 the contents of the original message and will therefore trigger the &%fail%&
34797 command again (causing a mail loop) unless steps are taken to prevent this.
34798 Testing the &%error_message%& condition is one way to prevent this. You could
34799 use, for example
34800 .code
34801 if $message_body contains "this is spam" and not error_message
34802 then fail text "spam is not wanted here" endif
34803 .endd
34804 though of course that might let through unwanted bounce messages. The
34805 alternative is clever checking of the body and/or headers to detect bounces
34806 generated by the filter.
34807
34808 The interpretation of a system filter file ceases after a
34809 &%defer%&,
34810 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34811 set up earlier in the filter file are honoured, so you can use a sequence such
34812 as
34813 .code
34814 mail ...
34815 freeze
34816 .endd
34817 to send a specified message when the system filter is freezing (or deferring or
34818 failing) a message. The normal deliveries for the message do not, of course,
34819 take place.
34820
34821
34822
34823 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34824 .cindex "header lines" "adding; in system filter"
34825 .cindex "header lines" "removing; in system filter"
34826 .cindex "filter" "header lines; adding/removing"
34827 Two filter commands that are available only in system filters are:
34828 .code
34829 headers add <string>
34830 headers remove <string>
34831 .endd
34832 The argument for the &%headers add%& is a string that is expanded and then
34833 added to the end of the message's headers. It is the responsibility of the
34834 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34835 space is ignored, and if the string is otherwise empty, or if the expansion is
34836 forced to fail, the command has no effect.
34837
34838 You can use &"\n"& within the string, followed by white space, to specify
34839 continued header lines. More than one header may be added in one command by
34840 including &"\n"& within the string without any following white space. For
34841 example:
34842 .code
34843 headers add "X-header-1: ....\n  \
34844              continuation of X-header-1 ...\n\
34845              X-header-2: ...."
34846 .endd
34847 Note that the header line continuation white space after the first newline must
34848 be placed before the backslash that continues the input string, because white
34849 space after input continuations is ignored.
34850
34851 The argument for &%headers remove%& is a colon-separated list of header names.
34852 This command applies only to those headers that are stored with the message;
34853 those that are added at delivery time (such as &'Envelope-To:'& and
34854 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34855 header with the same name, they are all removed.
34856
34857 The &%headers%& command in a system filter makes an immediate change to the set
34858 of header lines that was received with the message (with possible additions
34859 from ACL processing). Subsequent commands in the system filter operate on the
34860 modified set, which also forms the basis for subsequent message delivery.
34861 Unless further modified during routing or transporting, this set of headers is
34862 used for all recipients of the message.
34863
34864 During routing and transporting, the variables that refer to the contents of
34865 header lines refer only to those lines that are in this set. Thus, header lines
34866 that are added by a system filter are visible to users' filter files and to all
34867 routers and transports. This contrasts with the manipulation of header lines by
34868 routers and transports, which is not immediate, but which instead is saved up
34869 until the message is actually being written (see section
34870 &<<SECTheadersaddrem>>&).
34871
34872 If the message is not delivered at the first attempt, header lines that were
34873 added by the system filter are stored with the message, and so are still
34874 present at the next delivery attempt. Header lines that were removed are still
34875 present, but marked &"deleted"& so that they are not transported with the
34876 message. For this reason, it is usual to make the &%headers%& command
34877 conditional on &%first_delivery%& so that the set of header lines is not
34878 modified more than once.
34879
34880 Because header modification in a system filter acts immediately, you have to
34881 use an indirect approach if you want to modify the contents of a header line.
34882 For example:
34883 .code
34884 headers add "Old-Subject: $h_subject:"
34885 headers remove "Subject"
34886 headers add "Subject: new subject (was: $h_old-subject:)"
34887 headers remove "Old-Subject"
34888 .endd
34889
34890
34891
34892 .section "Setting an errors address in a system filter" "SECID217"
34893 .cindex "envelope from"
34894 .cindex "envelope sender"
34895 In a system filter, if a &%deliver%& command is followed by
34896 .code
34897 errors_to <some address>
34898 .endd
34899 in order to change the envelope sender (and hence the error reporting) for that
34900 delivery, any address may be specified. (In a user filter, only the current
34901 user's address can be set.) For example, if some mail is being monitored, you
34902 might use
34903 .code
34904 unseen deliver monitor@spying.example errors_to root@local.example
34905 .endd
34906 to take a copy which would not be sent back to the normal error reporting
34907 address if its delivery failed.
34908
34909
34910
34911 .section "Per-address filtering" "SECTperaddfil"
34912 .vindex "&$domain$&"
34913 .vindex "&$local_part$&"
34914 In contrast to the system filter, which is run just once per message for each
34915 delivery attempt, it is also possible to set up a system-wide filtering
34916 operation that runs once for each recipient address. In this case, variables
34917 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34918 filter file could be made dependent on them. This is an example of a router
34919 which implements such a filter:
34920 .code
34921 central_filter:
34922   check_local_user
34923   driver = redirect
34924   domains = +local_domains
34925   file = /central/filters/$local_part
34926   no_verify
34927   allow_filter
34928   allow_freeze
34929 .endd
34930 The filter is run in a separate process under its own uid. Therefore, either
34931 &%check_local_user%& must be set (as above), in which case the filter is run as
34932 the local user, or the &%user%& option must be used to specify which user to
34933 use. If both are set, &%user%& overrides.
34934
34935 Care should be taken to ensure that none of the commands in the filter file
34936 specify a significant delivery if the message is to go on to be delivered to
34937 its intended recipient. The router will not then claim to have dealt with the
34938 address, so it will be passed on to subsequent routers to be delivered in the
34939 normal way.
34940 .ecindex IIDsysfil1
34941 .ecindex IIDsysfil2
34942 .ecindex IIDsysfil3
34943
34944
34945
34946
34947
34948
34949 . ////////////////////////////////////////////////////////////////////////////
34950 . ////////////////////////////////////////////////////////////////////////////
34951
34952 .chapter "Message processing" "CHAPmsgproc"
34953 .scindex IIDmesproc "message" "general processing"
34954 Exim performs various transformations on the sender and recipient addresses of
34955 all messages that it handles, and also on the messages' header lines. Some of
34956 these are optional and configurable, while others always take place. All of
34957 this processing, except rewriting as a result of routing, and the addition or
34958 removal of header lines while delivering, happens when a message is received,
34959 before it is placed on Exim's queue.
34960
34961 Some of the automatic processing takes place by default only for
34962 &"locally-originated"& messages. This adjective is used to describe messages
34963 that are not received over TCP/IP, but instead are passed to an Exim process on
34964 its standard input. This includes the interactive &"local SMTP"& case that is
34965 set up by the &%-bs%& command line option.
34966
34967 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34968 or ::1) are not considered to be locally-originated. Exim does not treat the
34969 loopback interface specially in any way.
34970
34971 If you want the loopback interface to be treated specially, you must ensure
34972 that there are appropriate entries in your ACLs.
34973
34974
34975
34976
34977 .section "Submission mode for non-local messages" "SECTsubmodnon"
34978 .cindex "message" "submission"
34979 .cindex "submission mode"
34980 Processing that happens automatically for locally-originated messages (unless
34981 &%suppress_local_fixups%& is set) can also be requested for messages that are
34982 received over TCP/IP. The term &"submission mode"& is used to describe this
34983 state. Submission mode is set by the modifier
34984 .code
34985 control = submission
34986 .endd
34987 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34988 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34989 a local submission, and is normally used when the source of the message is
34990 known to be an MUA running on a client host (as opposed to an MTA). For
34991 example, to set submission mode for messages originating on the IPv4 loopback
34992 interface, you could include the following in the MAIL ACL:
34993 .code
34994 warn  hosts = 127.0.0.1
34995       control = submission
34996 .endd
34997 .cindex "&%sender_retain%& submission option"
34998 There are some options that can be used when setting submission mode. A slash
34999 is used to separate options. For example:
35000 .code
35001 control = submission/sender_retain
35002 .endd
35003 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35004 true and &%local_from_check%& false for the current incoming message. The first
35005 of these allows an existing &'Sender:'& header in the message to remain, and
35006 the second suppresses the check to ensure that &'From:'& matches the
35007 authenticated sender. With this setting, Exim still fixes up messages by adding
35008 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35009 attempt to check sender authenticity in header lines.
35010
35011 When &%sender_retain%& is not set, a submission mode setting may specify a
35012 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35013 example:
35014 .code
35015 control = submission/domain=some.domain
35016 .endd
35017 The domain may be empty. How this value is used is described in sections
35018 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35019 that allows you to specify the user's full name for inclusion in a created
35020 &'Sender:'& or &'From:'& header line. For example:
35021 .code
35022 accept authenticated = *
35023        control = submission/domain=wonderland.example/\
35024                             name=${lookup {$authenticated_id} \
35025                                    lsearch {/etc/exim/namelist}}
35026 .endd
35027 Because the name may contain any characters, including slashes, the &%name%&
35028 option must be given last. The remainder of the string is used as the name. For
35029 the example above, if &_/etc/exim/namelist_& contains:
35030 .code
35031 bigegg:  Humpty Dumpty
35032 .endd
35033 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35034 line would be:
35035 .code
35036 Sender: Humpty Dumpty <bigegg@wonderland.example>
35037 .endd
35038 .cindex "return path" "in submission mode"
35039 By default, submission mode forces the return path to the same address as is
35040 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35041 specified, the return path is also left unchanged.
35042
35043 &*Note*&: The changes caused by submission mode take effect after the predata
35044 ACL. This means that any sender checks performed before the fix-ups use the
35045 untrusted sender address specified by the user, not the trusted sender address
35046 specified by submission mode. Although this might be slightly unexpected, it
35047 does mean that you can configure ACL checks to spot that a user is trying to
35048 spoof another's address.
35049
35050 .section "Line endings" "SECTlineendings"
35051 .cindex "line endings"
35052 .cindex "carriage return"
35053 .cindex "linefeed"
35054 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35055 linefeed) is the line ending for messages transmitted over the Internet using
35056 SMTP over TCP/IP. However, within individual operating systems, different
35057 conventions are used. For example, Unix-like systems use just LF, but others
35058 use CRLF or just CR.
35059
35060 Exim was designed for Unix-like systems, and internally, it stores messages
35061 using the system's convention of a single LF as a line terminator. When
35062 receiving a message, all line endings are translated to this standard format.
35063 Originally, it was thought that programs that passed messages directly to an
35064 MTA within an operating system would use that system's convention. Experience
35065 has shown that this is not the case; for example, there are Unix applications
35066 that use CRLF in this circumstance. For this reason, and for compatibility with
35067 other MTAs, the way Exim handles line endings for all messages is now as
35068 follows:
35069
35070 .ilist
35071 LF not preceded by CR is treated as a line ending.
35072 .next
35073 CR is treated as a line ending; if it is immediately followed by LF, the LF
35074 is ignored.
35075 .next
35076 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35077 nor a local message in the state where a line containing only a dot is a
35078 terminator.
35079 .next
35080 If a bare CR is encountered within a header line, an extra space is added after
35081 the line terminator so as not to end the header line. The reasoning behind this
35082 is that bare CRs in header lines are most likely either to be mistakes, or
35083 people trying to play silly games.
35084 .next
35085 If the first header line received in a message ends with CRLF, a subsequent
35086 bare LF in a header line is treated in the same way as a bare CR in a header
35087 line.
35088 .endlist
35089
35090
35091
35092
35093
35094 .section "Unqualified addresses" "SECID218"
35095 .cindex "unqualified addresses"
35096 .cindex "address" "qualification"
35097 By default, Exim expects every envelope address it receives from an external
35098 host to be fully qualified. Unqualified addresses cause negative responses to
35099 SMTP commands. However, because SMTP is used as a means of transporting
35100 messages from MUAs running on personal workstations, there is sometimes a
35101 requirement to accept unqualified addresses from specific hosts or IP networks.
35102
35103 Exim has two options that separately control which hosts may send unqualified
35104 sender or recipient addresses in SMTP commands, namely
35105 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35106 cases, if an unqualified address is accepted, it is qualified by adding the
35107 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35108
35109 .oindex "&%qualify_domain%&"
35110 .oindex "&%qualify_recipient%&"
35111 Unqualified addresses in header lines are automatically qualified for messages
35112 that are locally originated, unless the &%-bnq%& option is given on the command
35113 line. For messages received over SMTP, unqualified addresses in header lines
35114 are qualified only if unqualified addresses are permitted in SMTP commands. In
35115 other words, such qualification is also controlled by
35116 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35117
35118
35119
35120
35121 .section "The UUCP From line" "SECID219"
35122 .cindex "&""From""& line"
35123 .cindex "UUCP" "&""From""& line"
35124 .cindex "sender" "address"
35125 .oindex "&%uucp_from_pattern%&"
35126 .oindex "&%uucp_from_sender%&"
35127 .cindex "envelope from"
35128 .cindex "envelope sender"
35129 .cindex "Sendmail compatibility" "&""From""& line"
35130 Messages that have come from UUCP (and some other applications) often begin
35131 with a line containing the envelope sender and a timestamp, following the word
35132 &"From"&. Examples of two common formats are:
35133 .code
35134 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35135 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35136 .endd
35137 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35138 Exim recognizes such lines at the start of messages that are submitted to it
35139 via the command line (that is, on the standard input). It does not recognize
35140 such lines in incoming SMTP messages, unless the sending host matches
35141 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35142 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35143 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35144 default value matches the two common cases shown above and puts the address
35145 that follows &"From"& into &$1$&.
35146
35147 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35148 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35149 a trusted user, the message's sender address is constructed by expanding the
35150 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35151 then parsed as an RFC 2822 address. If there is no domain, the local part is
35152 qualified with &%qualify_domain%& unless it is the empty string. However, if
35153 the command line &%-f%& option is used, it overrides the &"From"& line.
35154
35155 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35156 sender address is not changed. This is also the case for incoming SMTP messages
35157 that are permitted to contain &"From"& lines.
35158
35159 Only one &"From"& line is recognized. If there is more than one, the second is
35160 treated as a data line that starts the body of the message, as it is not valid
35161 as a header line. This also happens if a &"From"& line is present in an
35162 incoming SMTP message from a source that is not permitted to send them.
35163
35164
35165
35166 .section "Resent- header lines" "SECID220"
35167 .cindex "&%Resent-%& header lines"
35168 .cindex "header lines" "Resent-"
35169 RFC 2822 makes provision for sets of header lines starting with the string
35170 &`Resent-`& to be added to a message when it is resent by the original
35171 recipient to somebody else. These headers are &'Resent-Date:'&,
35172 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35173 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35174
35175 .blockquote
35176 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35177 processing of replies or other such automatic actions on messages.'&
35178 .endblockquote
35179
35180 This leaves things a bit vague as far as other processing actions such as
35181 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35182 follows:
35183
35184 .ilist
35185 A &'Resent-From:'& line that just contains the login id of the submitting user
35186 is automatically rewritten in the same way as &'From:'& (see below).
35187 .next
35188 If there's a rewriting rule for a particular header line, it is also applied to
35189 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35190 &'From:'& also rewrites &'Resent-From:'&.
35191 .next
35192 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35193 also removed.
35194 .next
35195 For a locally-submitted message,
35196 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35197 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35198 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35199 included in log lines in this case.
35200 .next
35201 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35202 &%Resent-%& header lines are present.
35203 .endlist
35204
35205
35206
35207
35208 .section "The Auto-Submitted: header line" "SECID221"
35209 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35210 includes the header line:
35211 .code
35212 Auto-Submitted: auto-replied
35213 .endd
35214
35215 .section "The Bcc: header line" "SECID222"
35216 .cindex "&'Bcc:'& header line"
35217 If Exim is called with the &%-t%& option, to take recipient addresses from a
35218 message's header, it removes any &'Bcc:'& header line that may exist (after
35219 extracting its addresses). If &%-t%& is not present on the command line, any
35220 existing &'Bcc:'& is not removed.
35221
35222
35223 .section "The Date: header line" "SECID223"
35224 .cindex "&'Date:'& header line"
35225 .cindex "header lines" "Date:"
35226 If a locally-generated or submission-mode message has no &'Date:'& header line,
35227 Exim adds one, using the current date and time, unless the
35228 &%suppress_local_fixups%& control has been specified.
35229
35230 .section "The Delivery-date: header line" "SECID224"
35231 .cindex "&'Delivery-date:'& header line"
35232 .oindex "&%delivery_date_remove%&"
35233 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35234 set. Exim can be configured to add them to the final delivery of messages. (See
35235 the generic &%delivery_date_add%& transport option.) They should not be present
35236 in messages in transit. If the &%delivery_date_remove%& configuration option is
35237 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35238 messages.
35239
35240
35241 .section "The Envelope-to: header line" "SECID225"
35242 .cindex "&'Envelope-to:'& header line"
35243 .cindex "header lines" "Envelope-to:"
35244 .oindex "&%envelope_to_remove%&"
35245 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35246 Exim can be configured to add them to the final delivery of messages. (See the
35247 generic &%envelope_to_add%& transport option.) They should not be present in
35248 messages in transit. If the &%envelope_to_remove%& configuration option is set
35249 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35250 messages.
35251
35252
35253 .section "The From: header line" "SECTthefrohea"
35254 .cindex "&'From:'& header line"
35255 .cindex "header lines" "From:"
35256 .cindex "Sendmail compatibility" "&""From""& line"
35257 .cindex "message" "submission"
35258 .cindex "submission mode"
35259 If a submission-mode message does not contain a &'From:'& header line, Exim
35260 adds one if either of the following conditions is true:
35261
35262 .ilist
35263 The envelope sender address is not empty (that is, this is not a bounce
35264 message). The added header line copies the envelope sender address.
35265 .next
35266 .vindex "&$authenticated_id$&"
35267 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35268 .olist
35269 .vindex "&$qualify_domain$&"
35270 If no domain is specified by the submission control, the local part is
35271 &$authenticated_id$& and the domain is &$qualify_domain$&.
35272 .next
35273 If a non-empty domain is specified by the submission control, the local
35274 part is &$authenticated_id$&, and the domain is the specified domain.
35275 .next
35276 If an empty domain is specified by the submission control,
35277 &$authenticated_id$& is assumed to be the complete address.
35278 .endlist
35279 .endlist
35280
35281 A non-empty envelope sender takes precedence.
35282
35283 If a locally-generated incoming message does not contain a &'From:'& header
35284 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35285 containing the sender's address. The calling user's login name and full name
35286 are used to construct the address, as described in section &<<SECTconstr>>&.
35287 They are obtained from the password data by calling &[getpwuid()]& (but see the
35288 &%unknown_login%& configuration option). The address is qualified with
35289 &%qualify_domain%&.
35290
35291 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35292 &'From:'& header line containing just the unqualified login name of the calling
35293 user, this is replaced by an address containing the user's login name and full
35294 name as described in section &<<SECTconstr>>&.
35295
35296
35297 .section "The Message-ID: header line" "SECID226"
35298 .cindex "&'Message-ID:'& header line"
35299 .cindex "header lines" "Message-ID:"
35300 .cindex "message" "submission"
35301 .oindex "&%message_id_header_text%&"
35302 If a locally-generated or submission-mode incoming message does not contain a
35303 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35304 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35305 to the message. If there are any &'Resent-:'& headers in the message, it
35306 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35307 message id, preceded by the letter E to ensure it starts with a letter, and
35308 followed by @ and the primary host name. Additional information can be included
35309 in this header line by setting the &%message_id_header_text%& and/or
35310 &%message_id_header_domain%& options.
35311
35312
35313 .section "The Received: header line" "SECID227"
35314 .cindex "&'Received:'& header line"
35315 .cindex "header lines" "Received:"
35316 A &'Received:'& header line is added at the start of every message. The
35317 contents are defined by the &%received_header_text%& configuration option, and
35318 Exim automatically adds a semicolon and a timestamp to the configured string.
35319
35320 The &'Received:'& header is generated as soon as the message's header lines
35321 have been received. At this stage, the timestamp in the &'Received:'& header
35322 line is the time that the message started to be received. This is the value
35323 that is seen by the DATA ACL and by the &[local_scan()]& function.
35324
35325 Once a message is accepted, the timestamp in the &'Received:'& header line is
35326 changed to the time of acceptance, which is (apart from a small delay while the
35327 -H spool file is written) the earliest time at which delivery could start.
35328
35329
35330 .section "The References: header line" "SECID228"
35331 .cindex "&'References:'& header line"
35332 .cindex "header lines" "References:"
35333 Messages created by the &(autoreply)& transport include a &'References:'&
35334 header line. This is constructed according to the rules that are described in
35335 section 3.64 of RFC 2822 (which states that replies should contain such a
35336 header line), and section 3.14 of RFC 3834 (which states that automatic
35337 responses are not different in this respect). However, because some mail
35338 processing software does not cope well with very long header lines, no more
35339 than 12 message IDs are copied from the &'References:'& header line in the
35340 incoming message. If there are more than 12, the first one and then the final
35341 11 are copied, before adding the message ID of the incoming message.
35342
35343
35344
35345 .section "The Return-path: header line" "SECID229"
35346 .cindex "&'Return-path:'& header line"
35347 .cindex "header lines" "Return-path:"
35348 .oindex "&%return_path_remove%&"
35349 &'Return-path:'& header lines are defined as something an MTA may insert when
35350 it does the final delivery of messages. (See the generic &%return_path_add%&
35351 transport option.) Therefore, they should not be present in messages in
35352 transit. If the &%return_path_remove%& configuration option is set (the
35353 default), Exim removes &'Return-path:'& header lines from incoming messages.
35354
35355
35356
35357 .section "The Sender: header line" "SECTthesenhea"
35358 .cindex "&'Sender:'& header line"
35359 .cindex "message" "submission"
35360 .cindex "header lines" "Sender:"
35361 For a locally-originated message from an untrusted user, Exim may remove an
35362 existing &'Sender:'& header line, and it may add a new one. You can modify
35363 these actions by setting the &%local_sender_retain%& option true, the
35364 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35365 control setting.
35366
35367 When a local message is received from an untrusted user and
35368 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35369 control has not been set, a check is made to see if the address given in the
35370 &'From:'& header line is the correct (local) sender of the message. The address
35371 that is expected has the login name as the local part and the value of
35372 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35373 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35374 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35375 line is added to the message.
35376
35377 If you set &%local_from_check%& false, this checking does not occur. However,
35378 the removal of an existing &'Sender:'& line still happens, unless you also set
35379 &%local_sender_retain%& to be true. It is not possible to set both of these
35380 options true at the same time.
35381
35382 .cindex "submission mode"
35383 By default, no processing of &'Sender:'& header lines is done for messages
35384 received over TCP/IP or for messages submitted by trusted users. However, when
35385 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35386 not specified on the submission control, the following processing takes place:
35387
35388 .vindex "&$authenticated_id$&"
35389 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35390 authenticated, and &$authenticated_id$& is not empty, a sender address is
35391 created as follows:
35392
35393 .ilist
35394 .vindex "&$qualify_domain$&"
35395 If no domain is specified by the submission control, the local part is
35396 &$authenticated_id$& and the domain is &$qualify_domain$&.
35397 .next
35398 If a non-empty domain is specified by the submission control, the local part
35399 is &$authenticated_id$&, and the domain is the specified domain.
35400 .next
35401 If an empty domain is specified by the submission control,
35402 &$authenticated_id$& is assumed to be the complete address.
35403 .endlist
35404
35405 This address is compared with the address in the &'From:'& header line. If they
35406 are different, a &'Sender:'& header line containing the created address is
35407 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35408 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35409
35410 .cindex "return path" "created from &'Sender:'&"
35411 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35412 the message (the envelope sender address) is changed to be the same address,
35413 except in the case of submission mode when &%sender_retain%& is specified.
35414
35415
35416
35417 .section "Adding and removing header lines in routers and transports" &&&
35418          "SECTheadersaddrem"
35419 .cindex "header lines" "adding; in router or transport"
35420 .cindex "header lines" "removing; in router or transport"
35421 When a message is delivered, the addition and removal of header lines can be
35422 specified in a system filter, or on any of the routers and transports that
35423 process the message. Section &<<SECTaddremheasys>>& contains details about
35424 modifying headers in a system filter. Header lines can also be added in an ACL
35425 as a message is received (see section &<<SECTaddheadacl>>&).
35426
35427 In contrast to what happens in a system filter, header modifications that are
35428 specified on routers and transports apply only to the particular recipient
35429 addresses that are being processed by those routers and transports. These
35430 changes do not actually take place until a copy of the message is being
35431 transported. Therefore, they do not affect the basic set of header lines, and
35432 they do not affect the values of the variables that refer to header lines.
35433
35434 &*Note*&: In particular, this means that any expansions in the configuration of
35435 the transport cannot refer to the modified header lines, because such
35436 expansions all occur before the message is actually transported.
35437
35438 For both routers and transports, the argument of a &%headers_add%&
35439 option must be in the form of one or more RFC 2822 header lines, separated by
35440 newlines (coded as &"\n"&). For example:
35441 .code
35442 headers_add = X-added-header: added by $primary_hostname\n\
35443               X-added-second: another added header line
35444 .endd
35445 Exim does not check the syntax of these added header lines.
35446
35447 Multiple &%headers_add%& options for a single router or transport can be
35448 specified; the values will append to a single list of header lines.
35449 Each header-line is separately expanded.
35450
35451 The argument of a &%headers_remove%& option must consist of a colon-separated
35452 list of header names. This is confusing, because header names themselves are
35453 often terminated by colons. In this case, the colons are the list separators,
35454 not part of the names. For example:
35455 .code
35456 headers_remove = return-receipt-to:acknowledge-to
35457 .endd
35458
35459 Multiple &%headers_remove%& options for a single router or transport can be
35460 specified; the arguments will append to a single header-names list.
35461 Each item is separately expanded.
35462 Note that colons in complex expansions which are used to
35463 form all or part of a &%headers_remove%& list
35464 will act as list separators.
35465
35466 When &%headers_add%& or &%headers_remove%& is specified on a router,
35467 items are expanded at routing time,
35468 and then associated with all addresses that are
35469 accepted by that router, and also with any new addresses that it generates. If
35470 an address passes through several routers as a result of aliasing or
35471 forwarding, the changes are cumulative.
35472
35473 .oindex "&%unseen%&"
35474 However, this does not apply to multiple routers that result from the use of
35475 the &%unseen%& option. Any header modifications that were specified by the
35476 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35477
35478 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35479 settings cannot be delivered together in a batch, so a transport is always
35480 dealing with a set of addresses that have the same header-processing
35481 requirements.
35482
35483 The transport starts by writing the original set of header lines that arrived
35484 with the message, possibly modified by the system filter. As it writes out
35485 these lines, it consults the list of header names that were attached to the
35486 recipient address(es) by &%headers_remove%& options in routers, and it also
35487 consults the transport's own &%headers_remove%& option. Header lines whose
35488 names are on either of these lists are not written out. If there are multiple
35489 instances of any listed header, they are all skipped.
35490
35491 After the remaining original header lines have been written, new header
35492 lines that were specified by routers' &%headers_add%& options are written, in
35493 the order in which they were attached to the address. These are followed by any
35494 header lines specified by the transport's &%headers_add%& option.
35495
35496 This way of handling header line modifications in routers and transports has
35497 the following consequences:
35498
35499 .ilist
35500 The original set of header lines, possibly modified by the system filter,
35501 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35502 to it, at all times.
35503 .next
35504 Header lines that are added by a router's
35505 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35506 expansion syntax in subsequent routers or the transport.
35507 .next
35508 Conversely, header lines that are specified for removal by &%headers_remove%&
35509 in a router remain visible to subsequent routers and the transport.
35510 .next
35511 Headers added to an address by &%headers_add%& in a router cannot be removed by
35512 a later router or by a transport.
35513 .next
35514 An added header can refer to the contents of an original header that is to be
35515 removed, even it has the same name as the added header. For example:
35516 .code
35517 headers_remove = subject
35518 headers_add = Subject: new subject (was: $h_subject:)
35519 .endd
35520 .endlist
35521
35522 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35523 for a &(redirect)& router that has the &%one_time%& option set.
35524
35525
35526
35527
35528
35529 .section "Constructed addresses" "SECTconstr"
35530 .cindex "address" "constructed"
35531 .cindex "constructed address"
35532 When Exim constructs a sender address for a locally-generated message, it uses
35533 the form
35534 .display
35535 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35536 .endd
35537 For example:
35538 .code
35539 Zaphod Beeblebrox <zaphod@end.univ.example>
35540 .endd
35541 The user name is obtained from the &%-F%& command line option if set, or
35542 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35543 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35544 ampersand character, this is replaced by the login name with the first letter
35545 upper cased, as is conventional in a number of operating systems. See the
35546 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35547 The &%unknown_username%& option can be used to specify user names in cases when
35548 there is no password file entry.
35549
35550 .cindex "RFC 2047"
35551 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35552 parts of it if necessary. In addition, if it contains any non-printing
35553 characters, it is encoded as described in RFC 2047, which defines a way of
35554 including non-ASCII characters in header lines. The value of the
35555 &%headers_charset%& option specifies the name of the encoding that is used (the
35556 characters are assumed to be in this encoding). The setting of
35557 &%print_topbitchars%& controls whether characters with the top bit set (that
35558 is, with codes greater than 127) count as printing characters or not.
35559
35560
35561
35562 .section "Case of local parts" "SECID230"
35563 .cindex "case of local parts"
35564 .cindex "local part" "case of"
35565 RFC 2822 states that the case of letters in the local parts of addresses cannot
35566 be assumed to be non-significant. Exim preserves the case of local parts of
35567 addresses, but by default it uses a lower-cased form when it is routing,
35568 because on most Unix systems, usernames are in lower case and case-insensitive
35569 routing is required. However, any particular router can be made to use the
35570 original case for local parts by setting the &%caseful_local_part%& generic
35571 router option.
35572
35573 .cindex "mixed-case login names"
35574 If you must have mixed-case user names on your system, the best way to proceed,
35575 assuming you want case-independent handling of incoming email, is to set up
35576 your first router to convert incoming local parts in your domains to the
35577 correct case by means of a file lookup. For example:
35578 .code
35579 correct_case:
35580   driver = redirect
35581   domains = +local_domains
35582   data = ${lookup{$local_part}cdb\
35583               {/etc/usercased.cdb}{$value}fail}\
35584               @$domain
35585 .endd
35586 For this router, the local part is forced to lower case by the default action
35587 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35588 up a new local part in the correct case. If you then set &%caseful_local_part%&
35589 on any subsequent routers which process your domains, they will operate on
35590 local parts with the correct case in a case-sensitive manner.
35591
35592
35593
35594 .section "Dots in local parts" "SECID231"
35595 .cindex "dot" "in local part"
35596 .cindex "local part" "dots in"
35597 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35598 part may not begin or end with a dot, nor have two consecutive dots in the
35599 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35600 empty components for compatibility.
35601
35602
35603
35604 .section "Rewriting addresses" "SECID232"
35605 .cindex "rewriting" "addresses"
35606 Rewriting of sender and recipient addresses, and addresses in headers, can
35607 happen automatically, or as the result of configuration options, as described
35608 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35609 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35610
35611 Automatic rewriting includes qualification, as mentioned above. The other case
35612 in which it can happen is when an incomplete non-local domain is given. The
35613 routing process may cause this to be expanded into the full domain name. For
35614 example, a header such as
35615 .code
35616 To: hare@teaparty
35617 .endd
35618 might get rewritten as
35619 .code
35620 To: hare@teaparty.wonderland.fict.example
35621 .endd
35622 Rewriting as a result of routing is the one kind of message processing that
35623 does not happen at input time, as it cannot be done until the address has
35624 been routed.
35625
35626 Strictly, one should not do &'any'& deliveries of a message until all its
35627 addresses have been routed, in case any of the headers get changed as a
35628 result of routing. However, doing this in practice would hold up many
35629 deliveries for unreasonable amounts of time, just because one address could not
35630 immediately be routed. Exim therefore does not delay other deliveries when
35631 routing of one or more addresses is deferred.
35632 .ecindex IIDmesproc
35633
35634
35635
35636 . ////////////////////////////////////////////////////////////////////////////
35637 . ////////////////////////////////////////////////////////////////////////////
35638
35639 .chapter "SMTP processing" "CHAPSMTP"
35640 .scindex IIDsmtpproc1 "SMTP" "processing details"
35641 .scindex IIDsmtpproc2 "LMTP" "processing details"
35642 Exim supports a number of different ways of using the SMTP protocol, and its
35643 LMTP variant, which is an interactive protocol for transferring messages into a
35644 closed mail store application. This chapter contains details of how SMTP is
35645 processed. For incoming mail, the following are available:
35646
35647 .ilist
35648 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35649 .next
35650 SMTP over the standard input and output (the &%-bs%& option);
35651 .next
35652 Batched SMTP on the standard input (the &%-bS%& option).
35653 .endlist
35654
35655 For mail delivery, the following are available:
35656
35657 .ilist
35658 SMTP over TCP/IP (the &(smtp)& transport);
35659 .next
35660 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35661 &"lmtp"&);
35662 .next
35663 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35664 transport);
35665 .next
35666 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35667 the &%use_bsmtp%& option set).
35668 .endlist
35669
35670 &'Batched SMTP'& is the name for a process in which batches of messages are
35671 stored in or read from files (or pipes), in a format in which SMTP commands are
35672 used to contain the envelope information.
35673
35674
35675
35676 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35677 .cindex "SMTP" "outgoing over TCP/IP"
35678 .cindex "outgoing SMTP over TCP/IP"
35679 .cindex "LMTP" "over TCP/IP"
35680 .cindex "outgoing LMTP over TCP/IP"
35681 .cindex "EHLO"
35682 .cindex "HELO"
35683 .cindex "SIZE option on MAIL command"
35684 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35685 The &%protocol%& option selects which protocol is to be used, but the actual
35686 processing is the same in both cases.
35687
35688 If, in response to its EHLO command, Exim is told that the SIZE
35689 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35690 command. The value of <&'n'&> is the message size plus the value of the
35691 &%size_addition%& option (default 1024) to allow for additions to the message
35692 such as per-transport header lines, or changes made in a
35693 .cindex "transport" "filter"
35694 .cindex "filter" "transport filter"
35695 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35696 suppressed.
35697
35698 If the remote server advertises support for PIPELINING, Exim uses the
35699 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35700 required for the transaction.
35701
35702 If the remote server advertises support for the STARTTLS command, and Exim
35703 was built to support TLS encryption, it tries to start a TLS session unless the
35704 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35705 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35706 is called for verification.
35707
35708 If the remote server advertises support for the AUTH command, Exim scans
35709 the authenticators configuration for any suitable client settings, as described
35710 in chapter &<<CHAPSMTPAUTH>>&.
35711
35712 .cindex "carriage return"
35713 .cindex "linefeed"
35714 Responses from the remote host are supposed to be terminated by CR followed by
35715 LF. However, there are known to be hosts that do not send CR characters, so in
35716 order to be able to interwork with such hosts, Exim treats LF on its own as a
35717 line terminator.
35718
35719 If a message contains a number of different addresses, all those with the same
35720 characteristics (for example, the same envelope sender) that resolve to the
35721 same set of hosts, in the same order, are sent in a single SMTP transaction,
35722 even if they are for different domains, unless there are more than the setting
35723 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35724 they are split into groups containing no more than &%max_rcpt%&s addresses
35725 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35726 in parallel sessions. The order of hosts with identical MX values is not
35727 significant when checking whether addresses can be batched in this way.
35728
35729 When the &(smtp)& transport suffers a temporary failure that is not
35730 message-related, Exim updates its transport-specific database, which contains
35731 records indexed by host name that remember which messages are waiting for each
35732 particular host. It also updates the retry database with new retry times.
35733
35734 .cindex "hints database" "retry keys"
35735 Exim's retry hints are based on host name plus IP address, so if one address of
35736 a multi-homed host is broken, it will soon be skipped most of the time.
35737 See the next section for more detail about error handling.
35738
35739 .cindex "SMTP" "passed connection"
35740 .cindex "SMTP" "batching over TCP/IP"
35741 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35742 looks in the hints database for the transport to see if there are any queued
35743 messages waiting for the host to which it is connected. If it finds one, it
35744 creates a new Exim process using the &%-MC%& option (which can only be used by
35745 a process running as root or the Exim user) and passes the TCP/IP socket to it
35746 so that it can deliver another message using the same socket. The new process
35747 does only those deliveries that are routed to the connected host, and may in
35748 turn pass the socket on to a third process, and so on.
35749
35750 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35751 limit the number of messages sent down a single TCP/IP connection.
35752
35753 .cindex "asterisk" "after IP address"
35754 The second and subsequent messages delivered down an existing connection are
35755 identified in the main log by the addition of an asterisk after the closing
35756 square bracket of the IP address.
35757
35758
35759
35760
35761 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35762 .cindex "error" "in outgoing SMTP"
35763 .cindex "SMTP" "errors in outgoing"
35764 .cindex "host" "error"
35765 Three different kinds of error are recognized for outgoing SMTP: host errors,
35766 message errors, and recipient errors.
35767
35768 .vlist
35769 .vitem "&*Host errors*&"
35770 A host error is not associated with a particular message or with a
35771 particular recipient of a message. The host errors are:
35772
35773 .ilist
35774 Connection refused or timed out,
35775 .next
35776 Any error response code on connection,
35777 .next
35778 Any error response code to EHLO or HELO,
35779 .next
35780 Loss of connection at any time, except after &"."&,
35781 .next
35782 I/O errors at any time,
35783 .next
35784 Timeouts during the session, other than in response to MAIL, RCPT or
35785 the &"."& at the end of the data.
35786 .endlist ilist
35787
35788 For a host error, a permanent error response on connection, or in response to
35789 EHLO, causes all addresses routed to the host to be failed. Any other host
35790 error causes all addresses to be deferred, and retry data to be created for the
35791 host. It is not tried again, for any message, until its retry time arrives. If
35792 the current set of addresses are not all delivered in this run (to some
35793 alternative host), the message is added to the list of those waiting for this
35794 host, so if it is still undelivered when a subsequent successful delivery is
35795 made to the host, it will be sent down the same SMTP connection.
35796
35797 .vitem "&*Message errors*&"
35798 .cindex "message" "error"
35799 A message error is associated with a particular message when sent to a
35800 particular host, but not with a particular recipient of the message. The
35801 message errors are:
35802
35803 .ilist
35804 Any error response code to MAIL, DATA, or the &"."& that terminates
35805 the data,
35806 .next
35807 Timeout after MAIL,
35808 .next
35809 Timeout or loss of connection after the &"."& that terminates the data. A
35810 timeout after the DATA command itself is treated as a host error, as is loss of
35811 connection at any other time.
35812 .endlist ilist
35813
35814 For a message error, a permanent error response (5&'xx'&) causes all addresses
35815 to be failed, and a delivery error report to be returned to the sender. A
35816 temporary error response (4&'xx'&), or one of the timeouts, causes all
35817 addresses to be deferred. Retry data is not created for the host, but instead,
35818 a retry record for the combination of host plus message id is created. The
35819 message is not added to the list of those waiting for this host. This ensures
35820 that the failing message will not be sent to this host again until the retry
35821 time arrives. However, other messages that are routed to the host are not
35822 affected, so if it is some property of the message that is causing the error,
35823 it will not stop the delivery of other mail.
35824
35825 If the remote host specified support for the SIZE parameter in its response
35826 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35827 over-large message will cause a message error because the error arrives as a
35828 response to MAIL.
35829
35830 .vitem "&*Recipient errors*&"
35831 .cindex "recipient" "error"
35832 A recipient error is associated with a particular recipient of a message. The
35833 recipient errors are:
35834
35835 .ilist
35836 Any error response to RCPT,
35837 .next
35838 Timeout after RCPT.
35839 .endlist
35840
35841 For a recipient error, a permanent error response (5&'xx'&) causes the
35842 recipient address to be failed, and a bounce message to be returned to the
35843 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35844 address to be deferred, and routing retry data to be created for it. This is
35845 used to delay processing of the address in subsequent queue runs, until its
35846 routing retry time arrives. This applies to all messages, but because it
35847 operates only in queue runs, one attempt will be made to deliver a new message
35848 to the failing address before the delay starts to operate. This ensures that,
35849 if the failure is really related to the message rather than the recipient
35850 (&"message too big for this recipient"& is a possible example), other messages
35851 have a chance of getting delivered. If a delivery to the address does succeed,
35852 the retry information gets cleared, so all stuck messages get tried again, and
35853 the retry clock is reset.
35854
35855 The message is not added to the list of those waiting for this host. Use of the
35856 host for other messages is unaffected, and except in the case of a timeout,
35857 other recipients are processed independently, and may be successfully delivered
35858 in the current SMTP session. After a timeout it is of course impossible to
35859 proceed with the session, so all addresses get deferred. However, those other
35860 than the one that failed do not suffer any subsequent retry delays. Therefore,
35861 if one recipient is causing trouble, the others have a chance of getting
35862 through when a subsequent delivery attempt occurs before the failing
35863 recipient's retry time.
35864 .endlist
35865
35866 In all cases, if there are other hosts (or IP addresses) available for the
35867 current set of addresses (for example, from multiple MX records), they are
35868 tried in this run for any undelivered addresses, subject of course to their
35869 own retry data. In other words, recipient error retry data does not take effect
35870 until the next delivery attempt.
35871
35872 Some hosts have been observed to give temporary error responses to every
35873 MAIL command at certain times (&"insufficient space"& has been seen). It
35874 would be nice if such circumstances could be recognized, and defer data for the
35875 host itself created, but this is not possible within the current Exim design.
35876 What actually happens is that retry data for every (host, message) combination
35877 is created.
35878
35879 The reason that timeouts after MAIL and RCPT are treated specially is that
35880 these can sometimes arise as a result of the remote host's verification
35881 procedures. Exim makes this assumption, and treats them as if a temporary error
35882 response had been received. A timeout after &"."& is treated specially because
35883 it is known that some broken implementations fail to recognize the end of the
35884 message if the last character of the last line is a binary zero. Thus, it is
35885 helpful to treat this case as a message error.
35886
35887 Timeouts at other times are treated as host errors, assuming a problem with the
35888 host, or the connection to it. If a timeout after MAIL, RCPT,
35889 or &"."& is really a connection problem, the assumption is that at the next try
35890 the timeout is likely to occur at some other point in the dialogue, causing it
35891 then to be treated as a host error.
35892
35893 There is experimental evidence that some MTAs drop the connection after the
35894 terminating &"."& if they do not like the contents of the message for some
35895 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35896 should be given. That is why Exim treats this case as a message rather than a
35897 host error, in order not to delay other messages to the same host.
35898
35899
35900
35901
35902 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35903 .cindex "SMTP" "incoming over TCP/IP"
35904 .cindex "incoming SMTP over TCP/IP"
35905 .cindex "inetd"
35906 .cindex "daemon"
35907 Incoming SMTP messages can be accepted in one of two ways: by running a
35908 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35909 &_/etc/inetd.conf_& should be like this:
35910 .code
35911 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35912 .endd
35913 Exim distinguishes between this case and the case of a locally running user
35914 agent using the &%-bs%& option by checking whether or not the standard input is
35915 a socket. When it is, either the port must be privileged (less than 1024), or
35916 the caller must be root or the Exim user. If any other user passes a socket
35917 with an unprivileged port number, Exim prints a message on the standard error
35918 stream and exits with an error code.
35919
35920 By default, Exim does not make a log entry when a remote host connects or
35921 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35922 unexpected. It can be made to write such log entries by setting the
35923 &%smtp_connection%& log selector.
35924
35925 .cindex "carriage return"
35926 .cindex "linefeed"
35927 Commands from the remote host are supposed to be terminated by CR followed by
35928 LF. However, there are known to be hosts that do not send CR characters. In
35929 order to be able to interwork with such hosts, Exim treats LF on its own as a
35930 line terminator.
35931 Furthermore, because common code is used for receiving messages from all
35932 sources, a CR on its own is also interpreted as a line terminator. However, the
35933 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35934
35935 .cindex "EHLO" "invalid data"
35936 .cindex "HELO" "invalid data"
35937 One area that sometimes gives rise to problems concerns the EHLO or
35938 HELO commands. Some clients send syntactically invalid versions of these
35939 commands, which Exim rejects by default. (This is nothing to do with verifying
35940 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35941 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35942 match the broken hosts that send invalid commands.
35943
35944 .cindex "SIZE option on MAIL command"
35945 .cindex "MAIL" "SIZE option"
35946 The amount of disk space available is checked whenever SIZE is received on
35947 a MAIL command, independently of whether &%message_size_limit%& or
35948 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35949 false. A temporary error is given if there is not enough space. If
35950 &%check_spool_space%& is set, the check is for that amount of space plus the
35951 value given with SIZE, that is, it checks that the addition of the incoming
35952 message will not reduce the space below the threshold.
35953
35954 When a message is successfully received, Exim includes the local message id in
35955 its response to the final &"."& that terminates the data. If the remote host
35956 logs this text it can help with tracing what has happened to a message.
35957
35958 The Exim daemon can limit the number of simultaneous incoming connections it is
35959 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35960 number of simultaneous incoming connections from a single remote host (see the
35961 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35962 rejected using the SMTP temporary error code 421.
35963
35964 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35965 subprocess has finished, as this can get lost at busy times. Instead, it looks
35966 for completed subprocesses every time it wakes up. Provided there are other
35967 things happening (new incoming calls, starts of queue runs), completed
35968 processes will be noticed and tidied away. On very quiet systems you may
35969 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35970 it will be noticed when the daemon next wakes up.
35971
35972 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35973 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35974 high system load &-- for details see the &%smtp_accept_reserve%&,
35975 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35976 applies in both the daemon and &'inetd'& cases.
35977
35978 Exim normally starts a delivery process for each message received, though this
35979 can be varied by means of the &%-odq%& command line option and the
35980 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35981 number of simultaneously running delivery processes started in this way from
35982 SMTP input can be limited by the &%smtp_accept_queue%& and
35983 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35984 subsequently received messages are just put on the input queue without starting
35985 a delivery process.
35986
35987 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35988 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35989 started up from the &'inetd'& daemon, because in that case each connection is
35990 handled by an entirely independent Exim process. Control by load average is,
35991 however, available with &'inetd'&.
35992
35993 Exim can be configured to verify addresses in incoming SMTP commands as they
35994 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35995 to rewrite addresses at this time &-- before any syntax checking is done. See
35996 section &<<SECTrewriteS>>&.
35997
35998 Exim can also be configured to limit the rate at which a client host submits
35999 MAIL and RCPT commands in a single SMTP session. See the
36000 &%smtp_ratelimit_hosts%& option.
36001
36002
36003
36004 .section "Unrecognized SMTP commands" "SECID234"
36005 .cindex "SMTP" "unrecognized commands"
36006 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36007 commands during a single SMTP connection, it drops the connection after sending
36008 the error response to the last command. The default value for
36009 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36010 abuse that subvert web servers into making connections to SMTP ports; in these
36011 circumstances, a number of non-SMTP lines are sent first.
36012
36013
36014 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36015 .cindex "SMTP" "syntax errors"
36016 .cindex "SMTP" "protocol errors"
36017 A syntax error is detected if an SMTP command is recognized, but there is
36018 something syntactically wrong with its data, for example, a malformed email
36019 address in a RCPT command. Protocol errors include invalid command
36020 sequencing such as RCPT before MAIL. If Exim receives more than
36021 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36022 drops the connection after sending the error response to the last command. The
36023 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36024 broken clients that loop sending bad commands (yes, it has been seen).
36025
36026
36027
36028 .section "Use of non-mail SMTP commands" "SECID236"
36029 .cindex "SMTP" "non-mail commands"
36030 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36031 DATA. Exim counts such commands, and drops the connection if there are too
36032 many of them in a single SMTP session. This action catches some
36033 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36034 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36035 defines what &"too many"& means. Its default value is 10.
36036
36037 When a new message is expected, one occurrence of RSET is not counted. This
36038 allows a client to send one RSET between messages (this is not necessary,
36039 but some clients do it). Exim also allows one uncounted occurrence of HELO
36040 or EHLO, and one occurrence of STARTTLS between messages. After
36041 starting up a TLS session, another EHLO is expected, and so it too is not
36042 counted.
36043
36044 The first occurrence of AUTH in a connection, or immediately following
36045 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36046 RCPT, DATA, and QUIT are counted.
36047
36048 You can control which hosts are subject to the limit set by
36049 &%smtp_accept_max_nonmail%& by setting
36050 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36051 the limit apply to all hosts. This option means that you can exclude any
36052 specific badly-behaved hosts that you have to live with.
36053
36054
36055
36056
36057 .section "The VRFY and EXPN commands" "SECID237"
36058 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36059 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36060 appropriate) in order to decide whether the command should be accepted or not.
36061
36062 .cindex "VRFY" "processing"
36063 When no ACL is defined for VRFY, or if it rejects without
36064 setting an explicit response code, the command is accepted
36065 (with a 252 SMTP response code)
36066 in order to support awkward clients that do a VRFY before every RCPT.
36067 When VRFY is accepted, it runs exactly the same code as when Exim is
36068 called with the &%-bv%& option, and returns 250/451/550
36069 SMTP response codes.
36070
36071 .cindex "EXPN" "processing"
36072 If no ACL for EXPN is defined, the command is rejected.
36073 When EXPN is accepted, a single-level expansion of the address is done.
36074 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36075 than a verification (the &%-bv%& option). If an unqualified local part is given
36076 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36077 of VRFY and EXPN commands are logged on the main and reject logs, and
36078 VRFY verification failures are logged on the main log for consistency with
36079 RCPT failures.
36080
36081
36082
36083 .section "The ETRN command" "SECTETRN"
36084 .cindex "ETRN" "processing"
36085 RFC 1985 describes an SMTP command called ETRN that is designed to
36086 overcome the security problems of the TURN command (which has fallen into
36087 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36088 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36089 should be accepted or not. If no ACL is defined, the command is rejected.
36090
36091 The ETRN command is concerned with &"releasing"& messages that are awaiting
36092 delivery to certain hosts. As Exim does not organize its message queue by host,
36093 the only form of ETRN that is supported by default is the one where the
36094 text starts with the &"#"& prefix, in which case the remainder of the text is
36095 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36096 the &%-R%& option to happen, with the remainder of the ETRN text as its
36097 argument. For example,
36098 .code
36099 ETRN #brigadoon
36100 .endd
36101 runs the command
36102 .code
36103 exim -R brigadoon
36104 .endd
36105 which causes a delivery attempt on all messages with undelivered addresses
36106 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36107 default), Exim prevents the simultaneous execution of more than one queue run
36108 for the same argument string as a result of an ETRN command. This stops
36109 a misbehaving client from starting more than one queue runner at once.
36110
36111 .cindex "hints database" "ETRN serialization"
36112 Exim implements the serialization by means of a hints database in which a
36113 record is written whenever a process is started by ETRN, and deleted when
36114 the process completes. However, Exim does not keep the SMTP session waiting for
36115 the ETRN process to complete. Once ETRN is accepted, the client is sent
36116 a &"success"& return code. Obviously there is scope for hints records to get
36117 left lying around if there is a system or program crash. To guard against this,
36118 Exim ignores any records that are more than six hours old.
36119
36120 .oindex "&%smtp_etrn_command%&"
36121 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36122 used. This specifies a command that is run whenever ETRN is received,
36123 whatever the form of its argument. For
36124 example:
36125 .code
36126 smtp_etrn_command = /etc/etrn_command $domain \
36127                     $sender_host_address
36128 .endd
36129 .vindex "&$domain$&"
36130 The string is split up into arguments which are independently expanded. The
36131 expansion variable &$domain$& is set to the argument of the ETRN command,
36132 and no syntax checking is done on the contents of this argument. Exim does not
36133 wait for the command to complete, so its status code is not checked. Exim runs
36134 under its own uid and gid when receiving incoming SMTP, so it is not possible
36135 for it to change them before running the command.
36136
36137
36138
36139 .section "Incoming local SMTP" "SECID238"
36140 .cindex "SMTP" "local incoming"
36141 Some user agents use SMTP to pass messages to their local MTA using the
36142 standard input and output, as opposed to passing the envelope on the command
36143 line and writing the message to the standard input. This is supported by the
36144 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36145 messages over TCP/IP (including the use of ACLs), except that the envelope
36146 sender given in a MAIL command is ignored unless the caller is trusted. In
36147 an ACL you can detect this form of SMTP input by testing for an empty host
36148 identification. It is common to have this as the first line in the ACL that
36149 runs for RCPT commands:
36150 .code
36151 accept hosts = :
36152 .endd
36153 This accepts SMTP messages from local processes without doing any other tests.
36154
36155
36156
36157 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36158 .cindex "SMTP" "batched outgoing"
36159 .cindex "batched SMTP output"
36160 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36161 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36162 be output in BSMTP format. No SMTP responses are possible for this form of
36163 delivery. All it is doing is using SMTP commands as a way of transmitting the
36164 envelope along with the message.
36165
36166 The message is written to the file or pipe preceded by the SMTP commands
36167 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36168 the message that start with a dot have an extra dot added. The SMTP command
36169 HELO is not normally used. If it is required, the &%message_prefix%& option
36170 can be used to specify it.
36171
36172 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36173 one recipient address at a time by default. However, you can arrange for them
36174 to handle several addresses at once by setting the &%batch_max%& option. When
36175 this is done for BSMTP, messages may contain multiple RCPT commands. See
36176 chapter &<<CHAPbatching>>& for more details.
36177
36178 .vindex "&$host$&"
36179 When one or more addresses are routed to a BSMTP transport by a router that
36180 sets up a host list, the name of the first host on the list is available to the
36181 transport in the variable &$host$&. Here is an example of such a transport and
36182 router:
36183 .code
36184 begin routers
36185 route_append:
36186   driver = manualroute
36187   transport = smtp_appendfile
36188   route_list = domain.example  batch.host.example
36189
36190 begin transports
36191 smtp_appendfile:
36192   driver = appendfile
36193   directory = /var/bsmtp/$host
36194   batch_max = 1000
36195   use_bsmtp
36196   user = exim
36197 .endd
36198 This causes messages addressed to &'domain.example'& to be written in BSMTP
36199 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36200 message (unless there are more than 1000 recipients).
36201
36202
36203
36204 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36205 .cindex "SMTP" "batched incoming"
36206 .cindex "batched SMTP input"
36207 The &%-bS%& command line option causes Exim to accept one or more messages by
36208 reading SMTP on the standard input, but to generate no responses. If the caller
36209 is trusted, the senders in the MAIL commands are believed; otherwise the
36210 sender is always the caller of Exim. Unqualified senders and receivers are not
36211 rejected (there seems little point) but instead just get qualified. HELO
36212 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36213 as NOOP; QUIT quits.
36214
36215 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36216 ACL is run in the same way as for non-SMTP local input.
36217
36218 If an error is detected while reading a message, including a missing &"."& at
36219 the end, Exim gives up immediately. It writes details of the error to the
36220 standard output in a stylized way that the calling program should be able to
36221 make some use of automatically, for example:
36222 .code
36223 554 Unexpected end of file
36224 Transaction started in line 10
36225 Error detected in line 14
36226 .endd
36227 It writes a more verbose version, for human consumption, to the standard error
36228 file, for example:
36229 .code
36230 An error was detected while processing a file of BSMTP input.
36231 The error message was:
36232
36233 501 '>' missing at end of address
36234
36235 The SMTP transaction started in line 10.
36236 The error was detected in line 12.
36237 The SMTP command at fault was:
36238
36239 rcpt to:<malformed@in.com.plete
36240
36241 1 previous message was successfully processed.
36242 The rest of the batch was abandoned.
36243 .endd
36244 The return code from Exim is zero only if there were no errors. It is 1 if some
36245 messages were accepted before an error was detected, and 2 if no messages were
36246 accepted.
36247 .ecindex IIDsmtpproc1
36248 .ecindex IIDsmtpproc2
36249
36250
36251
36252 . ////////////////////////////////////////////////////////////////////////////
36253 . ////////////////////////////////////////////////////////////////////////////
36254
36255 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36256          "Customizing messages"
36257 When a message fails to be delivered, or remains in the queue for more than a
36258 configured amount of time, Exim sends a message to the original sender, or
36259 to an alternative configured address. The text of these messages is built into
36260 the code of Exim, but it is possible to change it, either by adding a single
36261 string, or by replacing each of the paragraphs by text supplied in a file.
36262
36263 The &'From:'& and &'To:'& header lines are automatically generated; you can
36264 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36265 option. Exim also adds the line
36266 .code
36267 Auto-Submitted: auto-generated
36268 .endd
36269 to all warning and bounce messages,
36270
36271
36272 .section "Customizing bounce messages" "SECID239"
36273 .cindex "customizing" "bounce message"
36274 .cindex "bounce message" "customizing"
36275 If &%bounce_message_text%& is set, its contents are included in the default
36276 message immediately after &"This message was created automatically by mail
36277 delivery software."& The string is not expanded. It is not used if
36278 &%bounce_message_file%& is set.
36279
36280 When &%bounce_message_file%& is set, it must point to a template file for
36281 constructing error messages. The file consists of a series of text items,
36282 separated by lines consisting of exactly four asterisks. If the file cannot be
36283 opened, default text is used and a message is written to the main and panic
36284 logs. If any text item in the file is empty, default text is used for that
36285 item.
36286
36287 .vindex "&$bounce_recipient$&"
36288 .vindex "&$bounce_return_size_limit$&"
36289 Each item of text that is read from the file is expanded, and there are two
36290 expansion variables which can be of use here: &$bounce_recipient$& is set to
36291 the recipient of an error message while it is being created, and
36292 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36293 option, rounded to a whole number.
36294
36295 The items must appear in the file in the following order:
36296
36297 .ilist
36298 The first item is included in the headers, and should include at least a
36299 &'Subject:'& header. Exim does not check the syntax of these headers.
36300 .next
36301 The second item forms the start of the error message. After it, Exim lists the
36302 failing addresses with their error messages.
36303 .next
36304 The third item is used to introduce any text from pipe transports that is to be
36305 returned to the sender. It is omitted if there is no such text.
36306 .next
36307 The fourth, fifth and sixth items will be ignored and may be empty.
36308 The fields exist for back-compatibility
36309 .endlist
36310
36311 The default state (&%bounce_message_file%& unset) is equivalent to the
36312 following file, in which the sixth item is empty. The &'Subject:'& and some
36313 other lines have been split in order to fit them on the page:
36314 .code
36315 Subject: Mail delivery failed
36316   ${if eq{$sender_address}{$bounce_recipient}
36317   {: returning message to sender}}
36318 ****
36319 This message was created automatically by mail delivery software.
36320
36321 A message ${if eq{$sender_address}{$bounce_recipient}
36322   {that you sent }{sent by
36323
36324 <$sender_address>
36325
36326 }}could not be delivered to all of its recipients.
36327 This is a permanent error. The following address(es) failed:
36328 ****
36329 The following text was generated during the delivery attempt(s):
36330 ****
36331 ------ This is a copy of the message, including all the headers.
36332   ------
36333 ****
36334 ------ The body of the message is $message_size characters long;
36335   only the first
36336 ------ $bounce_return_size_limit or so are included here.
36337 ****
36338 .endd
36339 .section "Customizing warning messages" "SECTcustwarn"
36340 .cindex "customizing" "warning message"
36341 .cindex "warning of delay" "customizing the message"
36342 The option &%warn_message_file%& can be pointed at a template file for use when
36343 warnings about message delays are created. In this case there are only three
36344 text sections:
36345
36346 .ilist
36347 The first item is included in the headers, and should include at least a
36348 &'Subject:'& header. Exim does not check the syntax of these headers.
36349 .next
36350 The second item forms the start of the warning message. After it, Exim lists
36351 the delayed addresses.
36352 .next
36353 The third item then ends the message.
36354 .endlist
36355
36356 The default state is equivalent to the following file, except that some lines
36357 have been split here, in order to fit them on the page:
36358 .code
36359 Subject: Warning: message $message_exim_id delayed
36360   $warn_message_delay
36361 ****
36362 This message was created automatically by mail delivery software.
36363
36364 A message ${if eq{$sender_address}{$warn_message_recipients}
36365 {that you sent }{sent by
36366
36367 <$sender_address>
36368
36369 }}has not been delivered to all of its recipients after
36370 more than $warn_message_delay in the queue on $primary_hostname.
36371
36372 The message identifier is:     $message_exim_id
36373 The subject of the message is: $h_subject
36374 The date of the message is:    $h_date
36375
36376 The following address(es) have not yet been delivered:
36377 ****
36378 No action is required on your part. Delivery attempts will
36379 continue for some time, and this warning may be repeated at
36380 intervals if the message remains undelivered. Eventually the
36381 mail delivery software will give up, and when that happens,
36382 the message will be returned to you.
36383 .endd
36384 .vindex "&$warn_message_delay$&"
36385 .vindex "&$warn_message_recipients$&"
36386 However, in the default state the subject and date lines are omitted if no
36387 appropriate headers exist. During the expansion of this file,
36388 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36389 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36390 of recipients for the warning message. There may be more than one if there are
36391 multiple addresses with different &%errors_to%& settings on the routers that
36392 handled them.
36393
36394
36395
36396
36397 . ////////////////////////////////////////////////////////////////////////////
36398 . ////////////////////////////////////////////////////////////////////////////
36399
36400 .chapter "Some common configuration settings" "CHAPcomconreq"
36401 This chapter discusses some configuration settings that seem to be fairly
36402 common. More examples and discussion can be found in the Exim book.
36403
36404
36405
36406 .section "Sending mail to a smart host" "SECID240"
36407 .cindex "smart host" "example router"
36408 If you want to send all mail for non-local domains to a &"smart host"&, you
36409 should replace the default &(dnslookup)& router with a router which does the
36410 routing explicitly:
36411 .code
36412 send_to_smart_host:
36413   driver = manualroute
36414   route_list = !+local_domains smart.host.name
36415   transport = remote_smtp
36416 .endd
36417 You can use the smart host's IP address instead of the name if you wish.
36418 If you are using Exim only to submit messages to a smart host, and not for
36419 receiving incoming messages, you can arrange for it to do the submission
36420 synchronously by setting the &%mua_wrapper%& option (see chapter
36421 &<<CHAPnonqueueing>>&).
36422
36423
36424
36425
36426 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36427 .cindex "mailing lists"
36428 Exim can be used to run simple mailing lists, but for large and/or complicated
36429 requirements, the use of additional specialized mailing list software such as
36430 Majordomo or Mailman is recommended.
36431
36432 The &(redirect)& router can be used to handle mailing lists where each list
36433 is maintained in a separate file, which can therefore be managed by an
36434 independent manager. The &%domains%& router option can be used to run these
36435 lists in a separate domain from normal mail. For example:
36436 .code
36437 lists:
36438   driver = redirect
36439   domains = lists.example
36440   file = /usr/lists/$local_part
36441   forbid_pipe
36442   forbid_file
36443   errors_to = $local_part-request@lists.example
36444   no_more
36445 .endd
36446 This router is skipped for domains other than &'lists.example'&. For addresses
36447 in that domain, it looks for a file that matches the local part. If there is no
36448 such file, the router declines, but because &%no_more%& is set, no subsequent
36449 routers are tried, and so the whole delivery fails.
36450
36451 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36452 expanded into a filename or a pipe delivery, which is usually inappropriate in
36453 a mailing list.
36454
36455 .oindex "&%errors_to%&"
36456 The &%errors_to%& option specifies that any delivery errors caused by addresses
36457 taken from a mailing list are to be sent to the given address rather than the
36458 original sender of the message. However, before acting on this, Exim verifies
36459 the error address, and ignores it if verification fails.
36460
36461 For example, using the configuration above, mail sent to
36462 &'dicts@lists.example'& is passed on to those addresses contained in
36463 &_/usr/lists/dicts_&, with error reports directed to
36464 &'dicts-request@lists.example'&, provided that this address can be verified.
36465 There could be a file called &_/usr/lists/dicts-request_& containing
36466 the address(es) of this particular list's manager(s), but other approaches,
36467 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36468 or &%local_part_suffix%& options) to handle addresses of the form
36469 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36470
36471
36472
36473 .section "Syntax errors in mailing lists" "SECID241"
36474 .cindex "mailing lists" "syntax errors in"
36475 If an entry in redirection data contains a syntax error, Exim normally defers
36476 delivery of the original address. That means that a syntax error in a mailing
36477 list holds up all deliveries to the list. This may not be appropriate when a
36478 list is being maintained automatically from data supplied by users, and the
36479 addresses are not rigorously checked.
36480
36481 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36482 entries that fail to parse, noting the incident in the log. If in addition
36483 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36484 whenever a broken address is skipped. It is usually appropriate to set
36485 &%syntax_errors_to%& to the same address as &%errors_to%&.
36486
36487
36488
36489 .section "Re-expansion of mailing lists" "SECID242"
36490 .cindex "mailing lists" "re-expansion of"
36491 Exim remembers every individual address to which a message has been delivered,
36492 in order to avoid duplication, but it normally stores only the original
36493 recipient addresses with a message. If all the deliveries to a mailing list
36494 cannot be done at the first attempt, the mailing list is re-expanded when the
36495 delivery is next tried. This means that alterations to the list are taken into
36496 account at each delivery attempt, so addresses that have been added to
36497 the list since the message arrived will therefore receive a copy of the
36498 message, even though it pre-dates their subscription.
36499
36500 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36501 on the &(redirect)& router. If this is done, any addresses generated by the
36502 router that fail to deliver at the first attempt are added to the message as
36503 &"top level"& addresses, and the parent address that generated them is marked
36504 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36505 subsequent delivery attempts. The disadvantage of this is that if any of the
36506 failing addresses are incorrect, correcting them in the file has no effect on
36507 pre-existing messages.
36508
36509 The original top-level address is remembered with each of the generated
36510 addresses, and is output in any log messages. However, any intermediate parent
36511 addresses are not recorded. This makes a difference to the log only if the
36512 &%all_parents%& selector is set, but for mailing lists there is normally only
36513 one level of expansion anyway.
36514
36515
36516
36517 .section "Closed mailing lists" "SECID243"
36518 .cindex "mailing lists" "closed"
36519 The examples so far have assumed open mailing lists, to which anybody may
36520 send mail. It is also possible to set up closed lists, where mail is accepted
36521 from specified senders only. This is done by making use of the generic
36522 &%senders%& option to restrict the router that handles the list.
36523
36524 The following example uses the same file as a list of recipients and as a list
36525 of permitted senders. It requires three routers:
36526 .code
36527 lists_request:
36528   driver = redirect
36529   domains = lists.example
36530   local_part_suffix = -request
36531   file = /usr/lists/$local_part$local_part_suffix
36532   no_more
36533
36534 lists_post:
36535   driver = redirect
36536   domains = lists.example
36537   senders = ${if exists {/usr/lists/$local_part}\
36538              {lsearch;/usr/lists/$local_part}{*}}
36539   file = /usr/lists/$local_part
36540   forbid_pipe
36541   forbid_file
36542   errors_to = $local_part-request@lists.example
36543   no_more
36544
36545 lists_closed:
36546   driver = redirect
36547   domains = lists.example
36548   allow_fail
36549   data = :fail: $local_part@lists.example is a closed mailing list
36550 .endd
36551 All three routers have the same &%domains%& setting, so for any other domains,
36552 they are all skipped. The first router runs only if the local part ends in
36553 &%-request%&. It handles messages to the list manager(s) by means of an open
36554 mailing list.
36555
36556 The second router runs only if the &%senders%& precondition is satisfied. It
36557 checks for the existence of a list that corresponds to the local part, and then
36558 checks that the sender is on the list by means of a linear search. It is
36559 necessary to check for the existence of the file before trying to search it,
36560 because otherwise Exim thinks there is a configuration error. If the file does
36561 not exist, the expansion of &%senders%& is *, which matches all senders. This
36562 means that the router runs, but because there is no list, declines, and
36563 &%no_more%& ensures that no further routers are run. The address fails with an
36564 &"unrouteable address"& error.
36565
36566 The third router runs only if the second router is skipped, which happens when
36567 a mailing list exists, but the sender is not on it. This router forcibly fails
36568 the address, giving a suitable error message.
36569
36570
36571
36572
36573 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36574 .cindex "VERP"
36575 .cindex "Variable Envelope Return Paths"
36576 .cindex "envelope from"
36577 .cindex "envelope sender"
36578 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36579 are a way of helping mailing list administrators discover which subscription
36580 address is the cause of a particular delivery failure. The idea is to encode
36581 the original recipient address in the outgoing envelope sender address, so that
36582 if the message is forwarded by another host and then subsequently bounces, the
36583 original recipient can be extracted from the recipient address of the bounce.
36584
36585 .oindex &%errors_to%&
36586 .oindex &%return_path%&
36587 Envelope sender addresses can be modified by Exim using two different
36588 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36589 list examples), or the &%return_path%& option on a transport. The second of
36590 these is effective only if the message is successfully delivered to another
36591 host; it is not used for errors detected on the local host (see the description
36592 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36593 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36594 .code
36595 verp_smtp:
36596   driver = smtp
36597   max_rcpt = 1
36598   return_path = \
36599     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36600       {$1-request+$local_part=$domain@your.dom.example}fail}
36601 .endd
36602 This has the effect of rewriting the return path (envelope sender) on outgoing
36603 SMTP messages, if the local part of the original return path ends in
36604 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36605 local part and domain of the recipient into the return path. Suppose, for
36606 example, that a message whose return path has been set to
36607 &'somelist-request@your.dom.example'& is sent to
36608 &'subscriber@other.dom.example'&. In the transport, the return path is
36609 rewritten as
36610 .code
36611 somelist-request+subscriber=other.dom.example@your.dom.example
36612 .endd
36613 .vindex "&$local_part$&"
36614 For this to work, you must tell Exim to send multiple copies of messages that
36615 have more than one recipient, so that each copy has just one recipient. This is
36616 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36617 might be sent to several different recipients in the same domain, in which case
36618 &$local_part$& is not available in the transport, because it is not unique.
36619
36620 Unless your host is doing nothing but mailing list deliveries, you should
36621 probably use a separate transport for the VERP deliveries, so as not to use
36622 extra resources in making one-per-recipient copies for other deliveries. This
36623 can easily be done by expanding the &%transport%& option in the router:
36624 .code
36625 dnslookup:
36626   driver = dnslookup
36627   domains = ! +local_domains
36628   transport = \
36629     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36630       {verp_smtp}{remote_smtp}}
36631   no_more
36632 .endd
36633 If you want to change the return path using &%errors_to%& in a router instead
36634 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36635 routers that handle mailing list addresses. This will ensure that all delivery
36636 errors, including those detected on the local host, are sent to the VERP
36637 address.
36638
36639 On a host that does no local deliveries and has no manual routing, only the
36640 &(dnslookup)& router needs to be changed. A special transport is not needed for
36641 SMTP deliveries. Every mailing list recipient has its own return path value,
36642 and so Exim must hand them to the transport one at a time. Here is an example
36643 of a &(dnslookup)& router that implements VERP:
36644 .code
36645 verp_dnslookup:
36646   driver = dnslookup
36647   domains = ! +local_domains
36648   transport = remote_smtp
36649   errors_to = \
36650     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36651      {$1-request+$local_part=$domain@your.dom.example}fail}
36652   no_more
36653 .endd
36654 Before you start sending out messages with VERPed return paths, you must also
36655 configure Exim to accept the bounce messages that come back to those paths.
36656 Typically this is done by setting a &%local_part_suffix%& option for a
36657 router, and using this to route the messages to wherever you want to handle
36658 them.
36659
36660 The overhead incurred in using VERP depends very much on the size of the
36661 message, the number of recipient addresses that resolve to the same remote
36662 host, and the speed of the connection over which the message is being sent. If
36663 a lot of addresses resolve to the same host and the connection is slow, sending
36664 a separate copy of the message for each address may take substantially longer
36665 than sending a single copy with many recipients (for which VERP cannot be
36666 used).
36667
36668
36669
36670
36671
36672
36673 .section "Virtual domains" "SECTvirtualdomains"
36674 .cindex "virtual domains"
36675 .cindex "domain" "virtual"
36676 The phrase &'virtual domain'& is unfortunately used with two rather different
36677 meanings:
36678
36679 .ilist
36680 A domain for which there are no real mailboxes; all valid local parts are
36681 aliases for other email addresses. Common examples are organizational
36682 top-level domains and &"vanity"& domains.
36683 .next
36684 One of a number of independent domains that are all handled by the same host,
36685 with mailboxes on that host, but where the mailbox owners do not necessarily
36686 have login accounts on that host.
36687 .endlist
36688
36689 The first usage is probably more common, and does seem more &"virtual"& than
36690 the second. This kind of domain can be handled in Exim with a straightforward
36691 aliasing router. One approach is to create a separate alias file for each
36692 virtual domain. Exim can test for the existence of the alias file to determine
36693 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36694 to a router of this form:
36695 .code
36696 virtual:
36697   driver = redirect
36698   domains = dsearch;/etc/mail/virtual
36699   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36700   no_more
36701 .endd
36702 The &%domains%& option specifies that the router is to be skipped, unless there
36703 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36704 domain that is being processed. When the router runs, it looks up the local
36705 part in the file to find a new address (or list of addresses). The &%no_more%&
36706 setting ensures that if the lookup fails (leading to &%data%& being an empty
36707 string), Exim gives up on the address without trying any subsequent routers.
36708
36709 This one router can handle all the virtual domains because the alias filenames
36710 follow a fixed pattern. Permissions can be arranged so that appropriate people
36711 can edit the different alias files. A successful aliasing operation results in
36712 a new envelope recipient address, which is then routed from scratch.
36713
36714 The other kind of &"virtual"& domain can also be handled in a straightforward
36715 way. One approach is to create a file for each domain containing a list of
36716 valid local parts, and use it in a router like this:
36717 .code
36718 my_domains:
36719   driver = accept
36720   domains = dsearch;/etc/mail/domains
36721   local_parts = lsearch;/etc/mail/domains/$domain
36722   transport = my_mailboxes
36723 .endd
36724 The address is accepted if there is a file for the domain, and the local part
36725 can be found in the file. The &%domains%& option is used to check for the
36726 file's existence because &%domains%& is tested before the &%local_parts%&
36727 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36728 because that option is tested after &%local_parts%&. The transport is as
36729 follows:
36730 .code
36731 my_mailboxes:
36732   driver = appendfile
36733   file = /var/mail/$domain/$local_part
36734   user = mail
36735 .endd
36736 This uses a directory of mailboxes for each domain. The &%user%& setting is
36737 required, to specify which uid is to be used for writing to the mailboxes.
36738
36739 The configuration shown here is just one example of how you might support this
36740 requirement. There are many other ways this kind of configuration can be set
36741 up, for example, by using a database instead of separate files to hold all the
36742 information about the domains.
36743
36744
36745
36746 .section "Multiple user mailboxes" "SECTmulbox"
36747 .cindex "multiple mailboxes"
36748 .cindex "mailbox" "multiple"
36749 .cindex "local part" "prefix"
36750 .cindex "local part" "suffix"
36751 Heavy email users often want to operate with multiple mailboxes, into which
36752 incoming mail is automatically sorted. A popular way of handling this is to
36753 allow users to use multiple sender addresses, so that replies can easily be
36754 identified. Users are permitted to add prefixes or suffixes to their local
36755 parts for this purpose. The wildcard facility of the generic router options
36756 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36757 example, consider this router:
36758 .code
36759 userforward:
36760   driver = redirect
36761   check_local_user
36762   file = $home/.forward
36763   local_part_suffix = -*
36764   local_part_suffix_optional
36765   allow_filter
36766 .endd
36767 .vindex "&$local_part_suffix$&"
36768 It runs a user's &_.forward_& file for all local parts of the form
36769 &'username-*'&. Within the filter file the user can distinguish different
36770 cases by testing the variable &$local_part_suffix$&. For example:
36771 .code
36772 if $local_part_suffix contains -special then
36773 save /home/$local_part/Mail/special
36774 endif
36775 .endd
36776 If the filter file does not exist, or does not deal with such addresses, they
36777 fall through to subsequent routers, and, assuming no subsequent use of the
36778 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36779 control over which suffixes are valid.
36780
36781 Alternatively, a suffix can be used to trigger the use of a different
36782 &_.forward_& file &-- which is the way a similar facility is implemented in
36783 another MTA:
36784 .code
36785 userforward:
36786   driver = redirect
36787   check_local_user
36788   file = $home/.forward$local_part_suffix
36789   local_part_suffix = -*
36790   local_part_suffix_optional
36791   allow_filter
36792 .endd
36793 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36794 example, &_.forward-special_& is used. Once again, if the appropriate file
36795 does not exist, or does not deal with the address, it is passed on to
36796 subsequent routers, which could, if required, look for an unqualified
36797 &_.forward_& file to use as a default.
36798
36799
36800
36801 .section "Simplified vacation processing" "SECID244"
36802 .cindex "vacation processing"
36803 The traditional way of running the &'vacation'& program is for a user to set up
36804 a pipe command in a &_.forward_& file
36805 (see section &<<SECTspecitredli>>& for syntax details).
36806 This is prone to error by inexperienced users. There are two features of Exim
36807 that can be used to make this process simpler for users:
36808
36809 .ilist
36810 A local part prefix such as &"vacation-"& can be specified on a router which
36811 can cause the message to be delivered directly to the &'vacation'& program, or
36812 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36813 &_.forward_& file are then much simpler. For example:
36814 .code
36815 spqr, vacation-spqr
36816 .endd
36817 .next
36818 The &%require_files%& generic router option can be used to trigger a
36819 vacation delivery by checking for the existence of a certain file in the
36820 user's home directory. The &%unseen%& generic option should also be used, to
36821 ensure that the original delivery also proceeds. In this case, all the user has
36822 to do is to create a file called, say, &_.vacation_&, containing a vacation
36823 message.
36824 .endlist
36825
36826 Another advantage of both these methods is that they both work even when the
36827 use of arbitrary pipes by users is locked out.
36828
36829
36830
36831 .section "Taking copies of mail" "SECID245"
36832 .cindex "message" "copying every"
36833 Some installations have policies that require archive copies of all messages to
36834 be made. A single copy of each message can easily be taken by an appropriate
36835 command in a system filter, which could, for example, use a different file for
36836 each day's messages.
36837
36838 There is also a shadow transport mechanism that can be used to take copies of
36839 messages that are successfully delivered by local transports, one copy per
36840 delivery. This could be used, &'inter alia'&, to implement automatic
36841 notification of delivery by sites that insist on doing such things.
36842
36843
36844
36845 .section "Intermittently connected hosts" "SECID246"
36846 .cindex "intermittently connected hosts"
36847 It has become quite common (because it is cheaper) for hosts to connect to the
36848 Internet periodically rather than remain connected all the time. The normal
36849 arrangement is that mail for such hosts accumulates on a system that is
36850 permanently connected.
36851
36852 Exim was designed for use on permanently connected hosts, and so it is not
36853 particularly well-suited to use in an intermittently connected environment.
36854 Nevertheless there are some features that can be used.
36855
36856
36857 .section "Exim on the upstream server host" "SECID247"
36858 It is tempting to arrange for incoming mail for the intermittently connected
36859 host to remain in Exim's queue until the client connects. However, this
36860 approach does not scale very well. Two different kinds of waiting message are
36861 being mixed up in the same queue &-- those that cannot be delivered because of
36862 some temporary problem, and those that are waiting for their destination host
36863 to connect. This makes it hard to manage the queue, as well as wasting
36864 resources, because each queue runner scans the entire queue.
36865
36866 A better approach is to separate off those messages that are waiting for an
36867 intermittently connected host. This can be done by delivering these messages
36868 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36869 format, from where they are transmitted by other software when their
36870 destination connects. This makes it easy to collect all the mail for one host
36871 in a single directory, and to apply local timeout rules on a per-message basis
36872 if required.
36873
36874 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36875 you are doing this, you should configure Exim with a long retry period for the
36876 intermittent host. For example:
36877 .code
36878 cheshire.wonderland.fict.example    *   F,5d,24h
36879 .endd
36880 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36881 which messages it has queued up for that host. Once the intermittent host comes
36882 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36883 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36884 causes all the queued up messages to be delivered, often down a single SMTP
36885 connection. While the host remains connected, any new messages get delivered
36886 immediately.
36887
36888 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36889 issued with a different IP address each time it connects, Exim's retry
36890 mechanisms on the holding host get confused, because the IP address is normally
36891 used as part of the key string for holding retry information. This can be
36892 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36893 Since this has disadvantages for permanently connected hosts, it is best to
36894 arrange a separate transport for the intermittently connected ones.
36895
36896
36897
36898 .section "Exim on the intermittently connected client host" "SECID248"
36899 The value of &%smtp_accept_queue_per_connection%& should probably be
36900 increased, or even set to zero (that is, disabled) on the intermittently
36901 connected host, so that all incoming messages down a single connection get
36902 delivered immediately.
36903
36904 .cindex "SMTP" "passed connection"
36905 .cindex "SMTP" "multiple deliveries"
36906 .cindex "multiple SMTP deliveries"
36907 .cindex "first pass routing"
36908 Mail waiting to be sent from an intermittently connected host will probably
36909 not have been routed, because without a connection DNS lookups are not
36910 possible. This means that if a normal queue run is done at connection time,
36911 each message is likely to be sent in a separate SMTP session. This can be
36912 avoided by starting the queue run with a command line option beginning with
36913 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36914 first pass, routing is done but no deliveries take place. The second pass is a
36915 normal queue run; since all the messages have been previously routed, those
36916 destined for the same host are likely to get sent as multiple deliveries in a
36917 single SMTP connection.
36918
36919
36920
36921 . ////////////////////////////////////////////////////////////////////////////
36922 . ////////////////////////////////////////////////////////////////////////////
36923
36924 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36925          "Exim as a non-queueing client"
36926 .cindex "client, non-queueing"
36927 .cindex "smart host" "suppressing queueing"
36928 On a personal computer, it is a common requirement for all
36929 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36930 configured to operate that way, for all the popular operating systems.
36931 However, there are some MUAs for Unix-like systems that cannot be so
36932 configured: they submit messages using the command line interface of
36933 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36934 messages this way.
36935
36936 If the personal computer runs continuously, there is no problem, because it can
36937 run a conventional MTA that handles delivery to the smart host, and deal with
36938 any delays via its queueing mechanism. However, if the computer does not run
36939 continuously or runs different operating systems at different times, queueing
36940 email is not desirable.
36941
36942 There is therefore a requirement for something that can provide the
36943 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36944 any queueing or retrying facilities. Furthermore, the delivery to the smart
36945 host should be synchronous, so that if it fails, the sending MUA is immediately
36946 informed. In other words, we want something that extends an MUA that submits
36947 to a local MTA via the command line so that it behaves like one that submits
36948 to a remote smart host using TCP/SMTP.
36949
36950 There are a number of applications (for example, there is one called &'ssmtp'&)
36951 that do this job. However, people have found them to be lacking in various
36952 ways. For instance, you might want to allow aliasing and forwarding to be done
36953 before sending a message to the smart host.
36954
36955 Exim already had the necessary infrastructure for doing this job. Just a few
36956 tweaks were needed to make it behave as required, though it is somewhat of an
36957 overkill to use a fully-featured MTA for this purpose.
36958
36959 .oindex "&%mua_wrapper%&"
36960 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36961 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36962 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36963 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36964 compatible router and transport configuration. Typically there will be just one
36965 router and one transport, sending everything to a smart host.
36966
36967 When run in MUA wrapping mode, the behaviour of Exim changes in the
36968 following ways:
36969
36970 .ilist
36971 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36972 In other words, the only way to submit messages is via the command line.
36973 .next
36974 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36975 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36976 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36977 does not finish until the delivery attempt is complete. If the delivery is
36978 successful, a zero return code is given.
36979 .next
36980 Address redirection is permitted, but the final routing for all addresses must
36981 be to the same remote transport, and to the same list of hosts. Furthermore,
36982 the return address (envelope sender) must be the same for all recipients, as
36983 must any added or deleted header lines. In other words, it must be possible to
36984 deliver the message in a single SMTP transaction, however many recipients there
36985 are.
36986 .next
36987 If these conditions are not met, or if routing any address results in a
36988 failure or defer status, or if Exim is unable to deliver all the recipients
36989 successfully to one of the smart hosts, delivery of the entire message fails.
36990 .next
36991 Because no queueing is allowed, all failures are treated as permanent; there
36992 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36993 smart host. Furthermore, because only a single yes/no response can be given to
36994 the caller, it is not possible to deliver to some recipients and not others. If
36995 there is an error (temporary or permanent) for any recipient, all are failed.
36996 .next
36997 If more than one smart host is listed, Exim will try another host after a
36998 connection failure or a timeout, in the normal way. However, if this kind of
36999 failure happens for all the hosts, the delivery fails.
37000 .next
37001 When delivery fails, an error message is written to the standard error stream
37002 (as well as to Exim's log), and Exim exits to the caller with a return code
37003 value 1. The message is expunged from Exim's spool files. No bounce messages
37004 are ever generated.
37005 .next
37006 No retry data is maintained, and any retry rules are ignored.
37007 .next
37008 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37009 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37010 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37011 .endlist
37012
37013 The overall effect is that Exim makes a single synchronous attempt to deliver
37014 the message, failing if there is any kind of problem. Because no local
37015 deliveries are done and no daemon can be run, Exim does not need root
37016 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37017 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37018 the advantages and disadvantages of running without root privilege.
37019
37020
37021
37022
37023 . ////////////////////////////////////////////////////////////////////////////
37024 . ////////////////////////////////////////////////////////////////////////////
37025
37026 .chapter "Log files" "CHAPlog"
37027 .scindex IIDloggen "log" "general description"
37028 .cindex "log" "types of"
37029 Exim writes three different logs, referred to as the main log, the reject log,
37030 and the panic log:
37031
37032 .ilist
37033 .cindex "main log"
37034 The main log records the arrival of each message and each delivery in a single
37035 line in each case. The format is as compact as possible, in an attempt to keep
37036 down the size of log files. Two-character flag sequences make it easy to pick
37037 out these lines. A number of other events are recorded in the main log. Some of
37038 them are optional, in which case the &%log_selector%& option controls whether
37039 they are included or not. A Perl script called &'eximstats'&, which does simple
37040 analysis of main log files, is provided in the Exim distribution (see section
37041 &<<SECTmailstat>>&).
37042 .next
37043 .cindex "reject log"
37044 The reject log records information from messages that are rejected as a result
37045 of a configuration option (that is, for policy reasons).
37046 The first line of each rejection is a copy of the line that is also written to
37047 the main log. Then, if the message's header has been read at the time the log
37048 is written, its contents are written to this log. Only the original header
37049 lines are available; header lines added by ACLs are not logged. You can use the
37050 reject log to check that your policy controls are working correctly; on a busy
37051 host this may be easier than scanning the main log for rejection messages. You
37052 can suppress the writing of the reject log by setting &%write_rejectlog%&
37053 false.
37054 .next
37055 .cindex "panic log"
37056 .cindex "system log"
37057 When certain serious errors occur, Exim writes entries to its panic log. If the
37058 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37059 are usually written to the main log as well, but can get lost amid the mass of
37060 other entries. The panic log should be empty under normal circumstances. It is
37061 therefore a good idea to check it (or to have a &'cron'& script check it)
37062 regularly, in order to become aware of any problems. When Exim cannot open its
37063 panic log, it tries as a last resort to write to the system log (syslog). This
37064 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37065 message itself is written at priority LOG_CRIT.
37066 .endlist
37067
37068 Every log line starts with a timestamp, in the format shown in the following
37069 example. Note that many of the examples shown in this chapter are line-wrapped.
37070 In the log file, this would be all on one line:
37071 .code
37072 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37073   by QUIT
37074 .endd
37075 By default, the timestamps are in the local timezone. There are two
37076 ways of changing this:
37077
37078 .ilist
37079 You can set the &%timezone%& option to a different time zone; in particular, if
37080 you set
37081 .code
37082 timezone = UTC
37083 .endd
37084 the timestamps will be in UTC (aka GMT).
37085 .next
37086 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37087 example:
37088 .code
37089 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37090 .endd
37091 .endlist
37092
37093 .cindex "log" "process ids in"
37094 .cindex "pid (process id)" "in log lines"
37095 Exim does not include its process id in log lines by default, but you can
37096 request that it does so by specifying the &`pid`& log selector (see section
37097 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37098 brackets, immediately after the time and date.
37099
37100
37101
37102
37103 .section "Where the logs are written" "SECTwhelogwri"
37104 .cindex "log" "destination"
37105 .cindex "log" "to file"
37106 .cindex "log" "to syslog"
37107 .cindex "syslog"
37108 The logs may be written to local files, or to syslog, or both. However, it
37109 should be noted that many syslog implementations use UDP as a transport, and
37110 are therefore unreliable in the sense that messages are not guaranteed to
37111 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37112 It has also been reported that on large log files (tens of megabytes) you may
37113 need to tweak syslog to prevent it syncing the file with each write &-- on
37114 Linux this has been seen to make syslog take 90% plus of CPU time.
37115
37116 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37117 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37118 configuration. This latter string is expanded, so it can contain, for example,
37119 references to the host name:
37120 .code
37121 log_file_path = /var/log/$primary_hostname/exim_%slog
37122 .endd
37123 It is generally advisable, however, to set the string in &_Local/Makefile_&
37124 rather than at runtime, because then the setting is available right from the
37125 start of Exim's execution. Otherwise, if there's something it wants to log
37126 before it has read the configuration file (for example, an error in the
37127 configuration file) it will not use the path you want, and may not be able to
37128 log at all.
37129
37130 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37131 list, currently limited to at most two items. This is one option where the
37132 facility for changing a list separator may not be used. The list must always be
37133 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37134 otherwise the item must either be an absolute path, containing &`%s`& at the
37135 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37136 implying the use of a default path.
37137
37138 When Exim encounters an empty item in the list, it searches the list defined by
37139 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37140 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37141 mean &"use the path specified at build time"&. It no such item exists, log
37142 files are written in the &_log_& subdirectory of the spool directory. This is
37143 equivalent to the setting:
37144 .code
37145 log_file_path = $spool_directory/log/%slog
37146 .endd
37147 If you do not specify anything at build time or runtime,
37148 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37149 that is where the logs are written.
37150
37151 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37152 are in use &-- see section &<<SECTdatlogfil>>& below.
37153
37154 Here are some examples of possible settings:
37155 .display
37156 &`LOG_FILE_PATH=syslog                    `& syslog only
37157 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37158 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37159 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37160 .endd
37161 If there are more than two paths in the list, the first is used and a panic
37162 error is logged.
37163
37164
37165
37166 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37167 .cindex "log" "cycling local files"
37168 .cindex "cycling logs"
37169 .cindex "&'exicyclog'&"
37170 .cindex "log" "local files; writing to"
37171 Some operating systems provide centralized and standardized methods for cycling
37172 log files. For those that do not, a utility script called &'exicyclog'& is
37173 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37174 main and reject logs each time it is called. The maximum number of old logs to
37175 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37176
37177 An Exim delivery process opens the main log when it first needs to write to it,
37178 and it keeps the file open in case subsequent entries are required &-- for
37179 example, if a number of different deliveries are being done for the same
37180 message. However, remote SMTP deliveries can take a long time, and this means
37181 that the file may be kept open long after it is renamed if &'exicyclog'& or
37182 something similar is being used to rename log files on a regular basis. To
37183 ensure that a switch of log files is noticed as soon as possible, Exim calls
37184 &[stat()]& on the main log's name before reusing an open file, and if the file
37185 does not exist, or its inode has changed, the old file is closed and Exim
37186 tries to open the main log from scratch. Thus, an old log file may remain open
37187 for quite some time, but no Exim processes should write to it once it has been
37188 renamed.
37189
37190
37191
37192 .section "Datestamped log files" "SECTdatlogfil"
37193 .cindex "log" "datestamped files"
37194 Instead of cycling the main and reject log files by renaming them
37195 periodically, some sites like to use files whose names contain a datestamp,
37196 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37197 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37198 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37199 point where the datestamp is required. For example:
37200 .code
37201 log_file_path = /var/spool/exim/log/%slog-%D
37202 log_file_path = /var/log/exim-%s-%D.log
37203 log_file_path = /var/spool/exim/log/%D-%slog
37204 log_file_path = /var/log/exim/%s.%M
37205 .endd
37206 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37207 examples of names generated by the above examples:
37208 .code
37209 /var/spool/exim/log/mainlog-20021225
37210 /var/log/exim-reject-20021225.log
37211 /var/spool/exim/log/20021225-mainlog
37212 /var/log/exim/main.200212
37213 .endd
37214 When this form of log file is specified, Exim automatically switches to new
37215 files at midnight. It does not make any attempt to compress old logs; you
37216 will need to write your own script if you require this. You should not
37217 run &'exicyclog'& with this form of logging.
37218
37219 The location of the panic log is also determined by &%log_file_path%&, but it
37220 is not datestamped, because rotation of the panic log does not make sense.
37221 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37222 the string. In addition, if it immediately follows a slash, a following
37223 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37224 character is removed. Thus, the four examples above would give these panic
37225 log names:
37226 .code
37227 /var/spool/exim/log/paniclog
37228 /var/log/exim-panic.log
37229 /var/spool/exim/log/paniclog
37230 /var/log/exim/panic
37231 .endd
37232
37233
37234 .section "Logging to syslog" "SECID249"
37235 .cindex "log" "syslog; writing to"
37236 The use of syslog does not change what Exim logs or the format of its messages,
37237 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37238 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37239 that, the same strings are written to syslog as to log files. The syslog
37240 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37241 by default, but you can change these by setting the &%syslog_facility%& and
37242 &%syslog_processname%& options, respectively. If Exim was compiled with
37243 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37244 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37245 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37246 the time and host name to each line.
37247 The three log streams are mapped onto syslog priorities as follows:
37248
37249 .ilist
37250 &'mainlog'& is mapped to LOG_INFO
37251 .next
37252 &'rejectlog'& is mapped to LOG_NOTICE
37253 .next
37254 &'paniclog'& is mapped to LOG_ALERT
37255 .endlist
37256
37257 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37258 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37259 these are routed by syslog to the same place. You can suppress this duplication
37260 by setting &%syslog_duplication%& false.
37261
37262 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37263 entries contain multiple lines when headers are included. To cope with both
37264 these cases, entries written to syslog are split into separate &[syslog()]&
37265 calls at each internal newline, and also after a maximum of
37266 870 data characters. (This allows for a total syslog line length of 1024, when
37267 additions such as timestamps are added.) If you are running a syslog
37268 replacement that can handle lines longer than the 1024 characters allowed by
37269 RFC 3164, you should set
37270 .code
37271 SYSLOG_LONG_LINES=yes
37272 .endd
37273 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37274 lines, but it still splits at internal newlines in &'reject'& log entries.
37275
37276 To make it easy to re-assemble split lines later, each component of a split
37277 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37278 where <&'n'&> is the component number and <&'m'&> is the total number of
37279 components in the entry. The / delimiter is used when the line was split
37280 because it was too long; if it was split because of an internal newline, the \
37281 delimiter is used. For example, supposing the length limit to be 50 instead of
37282 870, the following would be the result of a typical rejection message to
37283 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37284 name, and pid as added by syslog:
37285 .code
37286 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37287 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37288 [3/5]  when scanning for sender: missing or malformed lo
37289 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37290 [5/5] mple>)
37291 .endd
37292 The same error might cause the following lines to be written to &"rejectlog"&
37293 (LOG_NOTICE):
37294 .code
37295 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37296 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37297 [3/18] er when scanning for sender: missing or malformed
37298 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37299 [5\18] .example>)
37300 [6\18] Recipients: ph10@some.domain.cam.example
37301 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37302 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37303 [9\18]        id 16RdAL-0006pc-00
37304 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37305 [11\18] 09:43 +0100
37306 [12\18] F From: <>
37307 [13\18]   Subject: this is a test header
37308 [18\18]   X-something: this is another header
37309 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37310 [16\18] le>
37311 [17\18] B Bcc:
37312 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37313 .endd
37314 Log lines that are neither too long nor contain newlines are written to syslog
37315 without modification.
37316
37317 If only syslog is being used, the Exim monitor is unable to provide a log tail
37318 display, unless syslog is routing &'mainlog'& to a file on the local host and
37319 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37320 where it is.
37321
37322
37323
37324 .section "Log line flags" "SECID250"
37325 One line is written to the main log for each message received, and for each
37326 successful, unsuccessful, and delayed delivery. These lines can readily be
37327 picked out by the distinctive two-character flags that immediately follow the
37328 timestamp. The flags are:
37329 .display
37330 &`<=`&     message arrival
37331 &`(=`&     message fakereject
37332 &`=>`&     normal message delivery
37333 &`->`&     additional address in same delivery
37334 &`>>`&     cutthrough message delivery
37335 &`*>`&     delivery suppressed by &%-N%&
37336 &`**`&     delivery failed; address bounced
37337 &`==`&     delivery deferred; temporary problem
37338 .endd
37339
37340
37341 .section "Logging message reception" "SECID251"
37342 .cindex "log" "reception line"
37343 The format of the single-line entry in the main log that is written for every
37344 message received is shown in the basic example below, which is split over
37345 several lines in order to fit it on the page:
37346 .code
37347 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37348   H=mailer.fict.example [192.168.123.123] U=exim
37349   P=smtp S=5678 id=<incoming message id>
37350 .endd
37351 The address immediately following &"<="& is the envelope sender address. A
37352 bounce message is shown with the sender address &"<>"&, and if it is locally
37353 generated, this is followed by an item of the form
37354 .code
37355 R=<message id>
37356 .endd
37357 which is a reference to the message that caused the bounce to be sent.
37358
37359 .cindex "HELO"
37360 .cindex "EHLO"
37361 For messages from other hosts, the H and U fields identify the remote host and
37362 record the RFC 1413 identity of the user that sent the message, if one was
37363 received. The number given in square brackets is the IP address of the sending
37364 host. If there is a single, unparenthesized  host name in the H field, as
37365 above, it has been verified to correspond to the IP address (see the
37366 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37367 by the remote host in the SMTP HELO or EHLO command, and has not been
37368 verified. If verification yields a different name to that given for HELO or
37369 EHLO, the verified name appears first, followed by the HELO or EHLO
37370 name in parentheses.
37371
37372 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37373 without brackets, in the HELO or EHLO command, leading to entries in
37374 the log containing text like these examples:
37375 .code
37376 H=(10.21.32.43) [192.168.8.34]
37377 H=([10.21.32.43]) [192.168.8.34]
37378 .endd
37379 This can be confusing. Only the final address in square brackets can be relied
37380 on.
37381
37382 For locally generated messages (that is, messages not received over TCP/IP),
37383 the H field is omitted, and the U field contains the login name of the caller
37384 of Exim.
37385
37386 .cindex "authentication" "logging"
37387 .cindex "AUTH" "logging"
37388 For all messages, the P field specifies the protocol used to receive the
37389 message. This is the value that is stored in &$received_protocol$&. In the case
37390 of incoming SMTP messages, the value indicates whether or not any SMTP
37391 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37392 session was encrypted, there is an additional X field that records the cipher
37393 suite that was used.
37394
37395 .cindex log protocol
37396 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37397 hosts that have authenticated themselves using the SMTP AUTH command. The first
37398 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37399 there is an additional item A= followed by the name of the authenticator that
37400 was used. If an authenticated identification was set up by the authenticator's
37401 &%server_set_id%& option, this is logged too, separated by a colon from the
37402 authenticator name.
37403
37404 .cindex "size" "of message"
37405 The id field records the existing message id, if present. The size of the
37406 received message is given by the S field. When the message is delivered,
37407 headers may be removed or added, so that the size of delivered copies of the
37408 message may not correspond with this value (and indeed may be different to each
37409 other).
37410
37411 The &%log_selector%& option can be used to request the logging of additional
37412 data when a message is received. See section &<<SECTlogselector>>& below.
37413
37414
37415
37416 .section "Logging deliveries" "SECID252"
37417 .cindex "log" "delivery line"
37418 The format of the single-line entry in the main log that is written for every
37419 delivery is shown in one of the examples below, for local and remote
37420 deliveries, respectively. Each example has been split into multiple lines in order
37421 to fit it on the page:
37422 .code
37423 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37424   <marv@hitch.fict.example> R=localuser T=local_delivery
37425 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37426   monk@holistic.fict.example R=dnslookup T=remote_smtp
37427   H=holistic.fict.example [192.168.234.234]
37428 .endd
37429 For ordinary local deliveries, the original address is given in angle brackets
37430 after the final delivery address, which might be a pipe or a file. If
37431 intermediate address(es) exist between the original and the final address, the
37432 last of these is given in parentheses after the final address. The R and T
37433 fields record the router and transport that were used to process the address.
37434
37435 If SMTP AUTH was used for the delivery there is an additional item A=
37436 followed by the name of the authenticator that was used.
37437 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37438 option, this is logged too, separated by a colon from the authenticator name.
37439
37440 If a shadow transport was run after a successful local delivery, the log line
37441 for the successful delivery has an item added on the end, of the form
37442 .display
37443 &`ST=<`&&'shadow transport name'&&`>`&
37444 .endd
37445 If the shadow transport did not succeed, the error message is put in
37446 parentheses afterwards.
37447
37448 .cindex "asterisk" "after IP address"
37449 When more than one address is included in a single delivery (for example, two
37450 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37451 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37452 down a single SMTP connection, an asterisk follows the IP address in the log
37453 lines for the second and subsequent messages.
37454 When two or more messages are delivered down a single TLS connection, the
37455 DNS and some TLS-related information logged for the first message delivered
37456 will not be present in the log lines for the second and subsequent messages.
37457 TLS cipher information is still available.
37458
37459 .cindex "delivery" "cutthrough; logging"
37460 .cindex "cutthrough" "logging"
37461 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37462 line precedes the reception line, since cutthrough waits for a possible
37463 rejection from the destination in case it can reject the sourced item.
37464
37465 The generation of a reply message by a filter file gets logged as a
37466 &"delivery"& to the addressee, preceded by &">"&.
37467
37468 The &%log_selector%& option can be used to request the logging of additional
37469 data when a message is delivered. See section &<<SECTlogselector>>& below.
37470
37471
37472 .section "Discarded deliveries" "SECID253"
37473 .cindex "discarded messages"
37474 .cindex "message" "discarded"
37475 .cindex "delivery" "discarded; logging"
37476 When a message is discarded as a result of the command &"seen finish"& being
37477 obeyed in a filter file which generates no deliveries, a log entry of the form
37478 .code
37479 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37480   <low.club@bridge.example> R=userforward
37481 .endd
37482 is written, to record why no deliveries are logged. When a message is discarded
37483 because it is aliased to &":blackhole:"& the log line is like this:
37484 .code
37485 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37486   <hole@nowhere.example> R=blackhole_router
37487 .endd
37488
37489
37490 .section "Deferred deliveries" "SECID254"
37491 When a delivery is deferred, a line of the following form is logged:
37492 .code
37493 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37494   R=dnslookup T=smtp defer (146): Connection refused
37495 .endd
37496 In the case of remote deliveries, the error is the one that was given for the
37497 last IP address that was tried. Details of individual SMTP failures are also
37498 written to the log, so the above line would be preceded by something like
37499 .code
37500 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37501   mail1.endrest.example [192.168.239.239]: Connection refused
37502 .endd
37503 When a deferred address is skipped because its retry time has not been reached,
37504 a message is written to the log, but this can be suppressed by setting an
37505 appropriate value in &%log_selector%&.
37506
37507
37508
37509 .section "Delivery failures" "SECID255"
37510 .cindex "delivery" "failure; logging"
37511 If a delivery fails because an address cannot be routed, a line of the
37512 following form is logged:
37513 .code
37514 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37515   <jim@trek99.example>: unknown mail domain
37516 .endd
37517 If a delivery fails at transport time, the router and transport are shown, and
37518 the response from the remote host is included, as in this example:
37519 .code
37520 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37521   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37522   after pipelined RCPT TO:<ace400@pb.example>: host
37523   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37524   <ace400@pb.example>...Addressee unknown
37525 .endd
37526 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37527 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37528 disabling PIPELINING. The log lines for all forms of delivery failure are
37529 flagged with &`**`&.
37530
37531
37532
37533 .section "Fake deliveries" "SECID256"
37534 .cindex "delivery" "fake; logging"
37535 If a delivery does not actually take place because the &%-N%& option has been
37536 used to suppress it, a normal delivery line is written to the log, except that
37537 &"=>"& is replaced by &"*>"&.
37538
37539
37540
37541 .section "Completion" "SECID257"
37542 A line of the form
37543 .code
37544 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37545 .endd
37546 is written to the main log when a message is about to be removed from the spool
37547 at the end of its processing.
37548
37549
37550
37551
37552 .section "Summary of Fields in Log Lines" "SECID258"
37553 .cindex "log" "summary of fields"
37554 A summary of the field identifiers that are used in log lines is shown in
37555 the following table:
37556 .display
37557 &`A   `&        authenticator name (and optional id and sender)
37558 &`C   `&        SMTP confirmation on delivery
37559 &`    `&        command list for &"no mail in SMTP session"&
37560 &`CV  `&        certificate verification status
37561 &`D   `&        duration of &"no mail in SMTP session"&
37562 &`DKIM`&        domain verified in incoming message
37563 &`DN  `&        distinguished name from peer certificate
37564 &`DS  `&        DNSSEC secured lookups
37565 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
37566 &`F   `&        sender address (on delivery lines)
37567 &`H   `&        host name and IP address
37568 &`I   `&        local interface used
37569 &`id  `&        message id (from header) for incoming message
37570 &`K   `&        CHUNKING extension used
37571 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37572 &`M8S `&        8BITMIME status for incoming message
37573 &`P   `&        on &`<=`& lines: protocol used
37574 &`    `&        on &`=>`& and &`**`& lines: return path
37575 &`PRDR`&        PRDR extension used
37576 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37577 &`Q   `&        alternate queue name
37578 &`QT  `&        on &`=>`& lines: time spent on queue so far
37579 &`    `&        on &"Completed"& lines: time spent on queue
37580 &`R   `&        on &`<=`& lines: reference for local bounce
37581 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37582 &`RT  `&        on &`<=`& lines: time taken for reception
37583 &`S   `&        size of message in bytes
37584 &`SNI `&        server name indication from TLS client hello
37585 &`ST  `&        shadow transport name
37586 &`T   `&        on &`<=`& lines: message subject (topic)
37587 &`TFO `&        connection took advantage of TCP Fast Open
37588 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37589 &`U   `&        local user or RFC 1413 identity
37590 &`X   `&        TLS cipher suite
37591 .endd
37592
37593
37594 .section "Other log entries" "SECID259"
37595 Various other types of log entry are written from time to time. Most should be
37596 self-explanatory. Among the more common are:
37597
37598 .ilist
37599 .cindex "retry" "time not reached"
37600 &'retry time not reached'&&~&~An address previously suffered a temporary error
37601 during routing or local delivery, and the time to retry has not yet arrived.
37602 This message is not written to an individual message log file unless it happens
37603 during the first delivery attempt.
37604 .next
37605 &'retry time not reached for any host'&&~&~An address previously suffered
37606 temporary errors during remote delivery, and the retry time has not yet arrived
37607 for any of the hosts to which it is routed.
37608 .next
37609 .cindex "spool directory" "file locked"
37610 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37611 some other Exim process is already working on the message. This can be quite
37612 common if queue running processes are started at frequent intervals. The
37613 &'exiwhat'& utility script can be used to find out what Exim processes are
37614 doing.
37615 .next
37616 .cindex "error" "ignored"
37617 &'error ignored'&&~&~There are several circumstances that give rise to this
37618 message:
37619 .olist
37620 Exim failed to deliver a bounce message whose age was greater than
37621 &%ignore_bounce_errors_after%&. The bounce was discarded.
37622 .next
37623 A filter file set up a delivery using the &"noerror"& option, and the delivery
37624 failed. The delivery was discarded.
37625 .next
37626 A delivery set up by a router configured with
37627 . ==== As this is a nested list, any displays it contains must be indented
37628 . ==== as otherwise they are too far to the left.
37629 .code
37630     errors_to = <>
37631 .endd
37632 failed. The delivery was discarded.
37633 .endlist olist
37634 .next
37635 .cindex DKIM "log line"
37636 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37637 logging and the message has a DKIM signature header.
37638 .endlist ilist
37639
37640
37641
37642
37643
37644 .section "Reducing or increasing what is logged" "SECTlogselector"
37645 .cindex "log" "selectors"
37646 By setting the &%log_selector%& global option, you can disable some of Exim's
37647 default logging, or you can request additional logging. The value of
37648 &%log_selector%& is made up of names preceded by plus or minus characters. For
37649 example:
37650 .code
37651 log_selector = +arguments -retry_defer
37652 .endd
37653 The list of optional log items is in the following table, with the default
37654 selection marked by asterisks:
37655 .display
37656 &` 8bitmime                   `&  received 8BITMIME status
37657 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37658 &` address_rewrite            `&  address rewriting
37659 &` all_parents                `&  all parents in => lines
37660 &` arguments                  `&  command line arguments
37661 &`*connection_reject          `&  connection rejections
37662 &`*delay_delivery             `&  immediate delivery delayed
37663 &` deliver_time               `&  time taken to attempt delivery
37664 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37665 &`*dkim                       `&  DKIM verified domain on <= lines
37666 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37667 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37668 &` dnssec                     `&  DNSSEC secured lookups
37669 &`*etrn                       `&  ETRN commands
37670 &`*host_lookup_failed         `&  as it says
37671 &` ident_timeout              `&  timeout for ident connection
37672 &` incoming_interface         `&  local interface on <= and => lines
37673 &` incoming_port              `&  remote port on <= lines
37674 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37675 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37676 &`*msg_id                     `&  on <= lines, Message-ID: header value
37677 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37678 &` outgoing_interface         `&  local interface on => lines
37679 &` outgoing_port              `&  add remote port to => lines
37680 &`*queue_run                  `&  start and end queue runs
37681 &` queue_time                 `&  time on queue for one recipient
37682 &` queue_time_overall         `&  time on queue for whole message
37683 &` pid                        `&  Exim process id
37684 &` pipelining                 `&  PIPELINING use, on <= and => lines
37685 &` proxy                      `&  proxy address on <= and => lines
37686 &` receive_time               `&  time taken to receive message
37687 &` received_recipients        `&  recipients on <= lines
37688 &` received_sender            `&  sender on <= lines
37689 &`*rejected_header            `&  header contents on reject log
37690 &`*retry_defer                `&  &"retry time not reached"&
37691 &` return_path_on_delivery    `&  put return path on => and ** lines
37692 &` sender_on_delivery         `&  add sender to => lines
37693 &`*sender_verify_fail         `&  sender verification failures
37694 &`*size_reject                `&  rejection because too big
37695 &`*skip_delivery              `&  delivery skipped in a queue run
37696 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37697 &` smtp_connection            `&  incoming SMTP connections
37698 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37699 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37700 &` smtp_no_mail               `&  session with no MAIL commands
37701 &` smtp_protocol_error        `&  SMTP protocol errors
37702 &` smtp_syntax_error          `&  SMTP syntax errors
37703 &` subject                    `&  contents of &'Subject:'& on <= lines
37704 &`*tls_certificate_verified   `&  certificate verification status
37705 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37706 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37707 &` tls_sni                    `&  TLS SNI on <= lines
37708 &` unknown_in_list            `&  DNS lookup failed in list match
37709
37710 &` all                        `&  all of the above
37711 .endd
37712 See also the &%slow_lookup_log%& main configuration option,
37713 section &<<SECID99>>&
37714
37715 More details on each of these items follows:
37716
37717 .ilist
37718 .cindex "8BITMIME"
37719 .cindex "log" "8BITMIME"
37720 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37721 which may help in tracking down interoperability issues with ancient MTAs
37722 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37723 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37724 &`7BIT`& and &`8BITMIME`& respectively.
37725 .next
37726 .cindex "&%warn%& ACL verb" "log when skipping"
37727 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37728 its conditions cannot be evaluated, a log line to this effect is written if
37729 this log selector is set.
37730 .next
37731 .cindex "log" "rewriting"
37732 .cindex "rewriting" "logging"
37733 &%address_rewrite%&: This applies both to global rewrites and per-transport
37734 rewrites, but not to rewrites in filters run as an unprivileged user (because
37735 such users cannot access the log).
37736 .next
37737 .cindex "log" "full parentage"
37738 &%all_parents%&: Normally only the original and final addresses are logged on
37739 delivery lines; with this selector, intermediate parents are given in
37740 parentheses between them.
37741 .next
37742 .cindex "log" "Exim arguments"
37743 .cindex "Exim arguments, logging"
37744 &%arguments%&: This causes Exim to write the arguments with which it was called
37745 to the main log, preceded by the current working directory. This is a debugging
37746 feature, added to make it easier to find out how certain MUAs call
37747 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37748 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37749 that are empty or that contain white space are quoted. Non-printing characters
37750 are shown as escape sequences. This facility cannot log unrecognized arguments,
37751 because the arguments are checked before the configuration file is read. The
37752 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37753 between the caller and Exim.
37754 .next
37755 .cindex "log" "connection rejections"
37756 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37757 connection is rejected, for whatever reason.
37758 .next
37759 .cindex "log" "delayed delivery"
37760 .cindex "delayed delivery, logging"
37761 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37762 started for an incoming message because the load is too high or too many
37763 messages were received on one connection. Logging does not occur if no delivery
37764 process is started because &%queue_only%& is set or &%-odq%& was used.
37765 .next
37766 .cindex "log" "delivery duration"
37767 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37768 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37769 If millisecond logging is enabled, short times will be shown with greater
37770 precision, eg. &`DT=0.304s`&.
37771 .next
37772 .cindex "log" "message size on delivery"
37773 .cindex "size" "of message"
37774 &%delivery_size%&: For each delivery, the size of message delivered is added to
37775 the &"=>"& line, tagged with S=.
37776 .next
37777 .cindex log "DKIM verification"
37778 .cindex DKIM "verification logging"
37779 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37780 verifies successfully a tag of DKIM is added, with one of the verified domains.
37781 .next
37782 .cindex log "DKIM verification"
37783 .cindex DKIM "verification logging"
37784 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37785 .next
37786 .cindex "log" "dnslist defer"
37787 .cindex "DNS list" "logging defer"
37788 .cindex "black list (DNS)"
37789 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37790 DNS black list suffers a temporary error.
37791 .next
37792 .cindex log dnssec
37793 .cindex dnssec logging
37794 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37795 dns lookups gave secure results a tag of DS is added.
37796 For acceptance this covers the reverse and forward lookups for host name verification.
37797 It does not cover helo-name verification.
37798 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37799 .next
37800 .cindex "log" "ETRN commands"
37801 .cindex "ETRN" "logging"
37802 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37803 is run to determine whether or not it is actually accepted. An invalid ETRN
37804 command, or one received within a message transaction is not logged by this
37805 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37806 .next
37807 .cindex "log" "host lookup failure"
37808 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37809 any addresses, or when a lookup of an IP address fails to find a host name, a
37810 log line is written. This logging does not apply to direct DNS lookups when
37811 routing email addresses, but it does apply to &"byname"& lookups.
37812 .next
37813 .cindex "log" "ident timeout"
37814 .cindex "RFC 1413" "logging timeout"
37815 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37816 client's ident port times out.
37817 .next
37818 .cindex "log" "incoming interface"
37819 .cindex "log" "local interface"
37820 .cindex "log" "local address and port"
37821 .cindex "TCP/IP" "logging local address and port"
37822 .cindex "interface" "logging"
37823 &%incoming_interface%&: The interface on which a message was received is added
37824 to the &"<="& line as an IP address in square brackets, tagged by I= and
37825 followed by a colon and the port number. The local interface and port are also
37826 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37827 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37828 The latter can be disabled by turning off the &%outgoing_interface%& option.
37829 .next
37830 .cindex log "incoming proxy address"
37831 .cindex proxy "logging proxy address"
37832 .cindex "TCP/IP" "logging proxy address"
37833 &%proxy%&: The internal (closest to the system running Exim) IP address
37834 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37835 on a proxied connection
37836 or the &"=>"& line for a message delivered on a proxied connection.
37837 See &<<SECTproxyInbound>>& for more information.
37838 .next
37839 .cindex "log" "incoming remote port"
37840 .cindex "port" "logging remote"
37841 .cindex "TCP/IP" "logging incoming remote port"
37842 .vindex "&$sender_fullhost$&"
37843 .vindex "&$sender_rcvhost$&"
37844 &%incoming_port%&: The remote port number from which a message was received is
37845 added to log entries and &'Received:'& header lines, following the IP address
37846 in square brackets, and separated from it by a colon. This is implemented by
37847 changing the value that is put in the &$sender_fullhost$& and
37848 &$sender_rcvhost$& variables. Recording the remote port number has become more
37849 important with the widening use of NAT (see RFC 2505).
37850 .next
37851 .cindex "log" "dropped connection"
37852 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37853 connection is unexpectedly dropped.
37854 .next
37855 .cindex "log" "millisecond timestamps"
37856 .cindex millisecond logging
37857 .cindex timestamps "millisecond, in logs"
37858 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37859 appended to the seconds value.
37860 .next
37861 .cindex "log" "message id"
37862 &%msg_id%&: The value of the Message-ID: header.
37863 .next
37864 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37865 This will be either because the message is a bounce, or was submitted locally
37866 (submission mode) without one.
37867 The field identifier will have an asterix appended: &"id*="&.
37868 .next
37869 .cindex "log" "outgoing interface"
37870 .cindex "log" "local interface"
37871 .cindex "log" "local address and port"
37872 .cindex "TCP/IP" "logging local address and port"
37873 .cindex "interface" "logging"
37874 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37875 interface on which a message was sent is added to delivery lines as an I= tag
37876 followed by IP address in square brackets. You can disable this by turning
37877 off the &%outgoing_interface%& option.
37878 .next
37879 .cindex "log" "outgoing remote port"
37880 .cindex "port" "logging outgoing remote"
37881 .cindex "TCP/IP" "logging outgoing remote port"
37882 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37883 containing => tags) following the IP address.
37884 The local port is also added if &%incoming_interface%& and
37885 &%outgoing_interface%& are both enabled.
37886 This option is not included in the default setting, because for most ordinary
37887 configurations, the remote port number is always 25 (the SMTP port), and the
37888 local port is a random ephemeral port.
37889 .next
37890 .cindex "log" "process ids in"
37891 .cindex "pid (process id)" "in log lines"
37892 &%pid%&: The current process id is added to every log line, in square brackets,
37893 immediately after the time and date.
37894 .next
37895 .cindex log pipelining
37896 .cindex pipelining "logging outgoing"
37897 &%pipelining%&: A field is added to delivery and accept
37898 log lines when the ESMTP PIPELINING extension was used.
37899 The field is a single "L".
37900
37901 On accept lines, where PIPELINING was offered but not used by the client,
37902 the field has a minus appended.
37903
37904 .cindex "pipelining" "early connection"
37905 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37906 accept "L" fields have a period appended if the feature was
37907 offered but not used, or an asterisk appended if used.
37908 Delivery "L" fields have an asterisk appended if used.
37909
37910 .next
37911 .cindex "log" "queue run"
37912 .cindex "queue runner" "logging"
37913 &%queue_run%&: The start and end of every queue run are logged.
37914 .next
37915 .cindex "log" "queue time"
37916 &%queue_time%&: The amount of time the message has been in the queue on the
37917 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37918 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37919 includes reception time as well as the delivery time for the current address.
37920 This means that it may be longer than the difference between the arrival and
37921 delivery log line times, because the arrival log line is not written until the
37922 message has been successfully received.
37923 If millisecond logging is enabled, short times will be shown with greater
37924 precision, eg. &`QT=1.578s`&.
37925 .next
37926 &%queue_time_overall%&: The amount of time the message has been in the queue on
37927 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37928 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37929 message, so it includes reception time as well as the total delivery time.
37930 .next
37931 .cindex "log" "receive duration"
37932 &%receive_time%&: For each message, the amount of real time it has taken to
37933 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37934 If millisecond logging is enabled, short times will be shown with greater
37935 precision, eg. &`RT=0.204s`&.
37936 .next
37937 .cindex "log" "recipients"
37938 &%received_recipients%&: The recipients of a message are listed in the main log
37939 as soon as the message is received. The list appears at the end of the log line
37940 that is written when a message is received, preceded by the word &"for"&. The
37941 addresses are listed after they have been qualified, but before any rewriting
37942 has taken place.
37943 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37944 in the list.
37945 .next
37946 .cindex "log" "sender reception"
37947 &%received_sender%&: The unrewritten original sender of a message is added to
37948 the end of the log line that records the message's arrival, after the word
37949 &"from"& (before the recipients if &%received_recipients%& is also set).
37950 .next
37951 .cindex "log" "header lines for rejection"
37952 &%rejected_header%&: If a message's header has been received at the time a
37953 rejection is written to the reject log, the complete header is added to the
37954 log. Header logging can be turned off individually for messages that are
37955 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37956 .next
37957 .cindex "log" "retry defer"
37958 &%retry_defer%&: A log line is written if a delivery is deferred because a
37959 retry time has not yet been reached. However, this &"retry time not reached"&
37960 message is always omitted from individual message logs after the first delivery
37961 attempt.
37962 .next
37963 .cindex "log" "return path"
37964 &%return_path_on_delivery%&: The return path that is being transmitted with
37965 the message is included in delivery and bounce lines, using the tag P=.
37966 This is omitted if no delivery actually happens, for example, if routing fails,
37967 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37968 .next
37969 .cindex "log" "sender on delivery"
37970 &%sender_on_delivery%&: The message's sender address is added to every delivery
37971 and bounce line, tagged by F= (for &"from"&).
37972 This is the original sender that was received with the message; it is not
37973 necessarily the same as the outgoing return path.
37974 .next
37975 .cindex "log" "sender verify failure"
37976 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37977 gives details of a sender verification failure is not written. Log lines for
37978 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37979 detail is lost.
37980 .next
37981 .cindex "log" "size rejection"
37982 &%size_reject%&: A log line is written whenever a message is rejected because
37983 it is too big.
37984 .next
37985 .cindex "log" "frozen messages; skipped"
37986 .cindex "frozen messages" "logging skipping"
37987 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37988 queue run because it is frozen or because another process is already delivering
37989 it.
37990 .cindex "&""spool file is locked""&"
37991 The message that is written is &"spool file is locked"&.
37992 .next
37993 .cindex "log" "smtp confirmation"
37994 .cindex "SMTP" "logging confirmation"
37995 .cindex "LMTP" "logging confirmation"
37996 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37997 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37998 A number of MTAs (including Exim) return an identifying string in this
37999 response.
38000 .next
38001 .cindex "log" "SMTP connections"
38002 .cindex "SMTP" "logging connections"
38003 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38004 established or closed, unless the connection is from a host that matches
38005 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38006 only when the closure is unexpected.) This applies to connections from local
38007 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38008 dropped in the middle of a message, a log line is always written, whether or
38009 not this selector is set, but otherwise nothing is written at the start and end
38010 of connections unless this selector is enabled.
38011
38012 For TCP/IP connections to an Exim daemon, the current number of connections is
38013 included in the log message for each new connection, but note that the count is
38014 reset if the daemon is restarted.
38015 Also, because connections are closed (and the closure is logged) in
38016 subprocesses, the count may not include connections that have been closed but
38017 whose termination the daemon has not yet noticed. Thus, while it is possible to
38018 match up the opening and closing of connections in the log, the value of the
38019 logged counts may not be entirely accurate.
38020 .next
38021 .cindex "log" "SMTP transaction; incomplete"
38022 .cindex "SMTP" "logging incomplete transactions"
38023 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38024 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38025 and the message sender plus any accepted recipients are included in the log
38026 line. This can provide evidence of dictionary attacks.
38027 .next
38028 .cindex "log" "non-MAIL SMTP sessions"
38029 .cindex "MAIL" "logging session without"
38030 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38031 connection terminates without having issued a MAIL command. This includes both
38032 the case when the connection is dropped, and the case when QUIT is used. It
38033 does not include cases where the connection is rejected right at the start (by
38034 an ACL, or because there are too many connections, or whatever). These cases
38035 already have their own log lines.
38036
38037 The log line that is written contains the identity of the client in the usual
38038 way, followed by D= and a time, which records the duration of the connection.
38039 If the connection was authenticated, this fact is logged exactly as it is for
38040 an incoming message, with an A= item. If the connection was encrypted, CV=,
38041 DN=, and X= items may appear as they do for an incoming message, controlled by
38042 the same logging options.
38043
38044 Finally, if any SMTP commands were issued during the connection, a C= item
38045 is added to the line, listing the commands that were used. For example,
38046 .code
38047 C=EHLO,QUIT
38048 .endd
38049 shows that the client issued QUIT straight after EHLO. If there were fewer
38050 than 20 commands, they are all listed. If there were more than 20 commands,
38051 the last 20 are listed, preceded by &"..."&. However, with the default
38052 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38053 have been aborted before 20 non-mail commands are processed.
38054 .next
38055 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38056 colon-separated, is appended to the A= item for a message arrival or delivery
38057 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38058 was accepted or used.
38059 .next
38060 .cindex "log" "SMTP protocol error"
38061 .cindex "SMTP" "logging protocol error"
38062 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38063 encountered. Exim does not have perfect detection of all protocol errors
38064 because of transmission delays and the use of pipelining. If PIPELINING has
38065 been advertised to a client, an Exim server assumes that the client will use
38066 it, and therefore it does not count &"expected"& errors (for example, RCPT
38067 received after rejecting MAIL) as protocol errors.
38068 .next
38069 .cindex "SMTP" "logging syntax errors"
38070 .cindex "SMTP" "syntax errors; logging"
38071 .cindex "SMTP" "unknown command; logging"
38072 .cindex "log" "unknown SMTP command"
38073 .cindex "log" "SMTP syntax error"
38074 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38075 encountered. An unrecognized command is treated as a syntax error. For an
38076 external connection, the host identity is given; for an internal connection
38077 using &%-bs%& the sender identification (normally the calling user) is given.
38078 .next
38079 .cindex "log" "subject"
38080 .cindex "subject, logging"
38081 &%subject%&: The subject of the message is added to the arrival log line,
38082 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38083 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38084 specifies whether characters with values greater than 127 should be logged
38085 unchanged, or whether they should be rendered as escape sequences.
38086 .next
38087 .cindex "log" "certificate verification"
38088 .cindex log DANE
38089 .cindex DANE logging
38090 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38091 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38092 verified
38093 using a CA trust anchor,
38094 &`CA=dane`& if using a DNS trust anchor,
38095 and &`CV=no`& if not.
38096 .next
38097 .cindex "log" "TLS cipher"
38098 .cindex "TLS" "logging cipher"
38099 &%tls_cipher%&: When a message is sent or received over an encrypted
38100 connection, the cipher suite used is added to the log line, preceded by X=.
38101 .next
38102 .cindex "log" "TLS peer DN"
38103 .cindex "TLS" "logging peer DN"
38104 &%tls_peerdn%&: When a message is sent or received over an encrypted
38105 connection, and a certificate is supplied by the remote host, the peer DN is
38106 added to the log line, preceded by DN=.
38107 .next
38108 .cindex "log" "TLS SNI"
38109 .cindex "TLS" "logging SNI"
38110 &%tls_sni%&: When a message is received over an encrypted connection, and
38111 the remote host provided the Server Name Indication extension, the SNI is
38112 added to the log line, preceded by SNI=.
38113 .next
38114 .cindex "log" "DNS failure in list"
38115 &%unknown_in_list%&: This setting causes a log entry to be written when the
38116 result of a list match is failure because a DNS lookup failed.
38117 .endlist
38118
38119
38120 .section "Message log" "SECID260"
38121 .cindex "message" "log file for"
38122 .cindex "log" "message log; description of"
38123 .cindex "&_msglog_& directory"
38124 .oindex "&%preserve_message_logs%&"
38125 In addition to the general log files, Exim writes a log file for each message
38126 that it handles. The names of these per-message logs are the message ids, and
38127 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38128 message log contains copies of the log lines that apply to the message. This
38129 makes it easier to inspect the status of an individual message without having
38130 to search the main log. A message log is deleted when processing of the message
38131 is complete, unless &%preserve_message_logs%& is set, but this should be used
38132 only with great care because they can fill up your disk very quickly.
38133
38134 On a heavily loaded system, it may be desirable to disable the use of
38135 per-message logs, in order to reduce disk I/O. This can be done by setting the
38136 &%message_logs%& option false.
38137 .ecindex IIDloggen
38138
38139
38140
38141
38142 . ////////////////////////////////////////////////////////////////////////////
38143 . ////////////////////////////////////////////////////////////////////////////
38144
38145 .chapter "Exim utilities" "CHAPutils"
38146 .scindex IIDutils "utilities"
38147 A number of utility scripts and programs are supplied with Exim and are
38148 described in this chapter. There is also the Exim Monitor, which is covered in
38149 the next chapter. The utilities described here are:
38150
38151 .itable none 0 0 3  7* left  15* left  40* left
38152 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38153   "list what Exim processes are doing"
38154 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38155 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38156 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38157 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38158                                                 various criteria"
38159 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38160 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38161   "extract statistics from the log"
38162 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38163   "check address acceptance from given IP"
38164 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38165 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38166 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38167 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38168 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38169 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38170 .endtable
38171
38172 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38173 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38174 &url(https://duncanthrax.net/exilog/) for details.
38175
38176
38177
38178
38179 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38180 .cindex "&'exiwhat'&"
38181 .cindex "process, querying"
38182 .cindex "SIGUSR1"
38183 On operating systems that can restart a system call after receiving a signal
38184 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38185 a line describing what it is doing to the file &_exim-process.info_& in the
38186 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38187 processes it can find, having first emptied the file. It then waits for one
38188 second to allow the Exim processes to react before displaying the results. In
38189 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38190 send the signal to the Exim processes, so it is normally run as root.
38191
38192 &*Warning*&: This is not an efficient process. It is intended for occasional
38193 use by system administrators. It is not sensible, for example, to set up a
38194 script that sends SIGUSR1 signals to Exim processes at short intervals.
38195
38196
38197 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38198 varies in different operating systems. Not only are different options used,
38199 but the format of the output is different. For this reason, there are some
38200 system configuration options that configure exactly how &'exiwhat'& works. If
38201 it doesn't seem to be working for you, check the following compile-time
38202 options:
38203 .display
38204 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38205 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38206 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38207 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38208 .endd
38209 An example of typical output from &'exiwhat'& is
38210 .code
38211 164 daemon: -q1h, listening on port 25
38212 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38213 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38214   [10.19.42.42] (editor@ref.example)
38215 10592 handling incoming call from [192.168.243.242]
38216 10628 accepting a local non-SMTP message
38217 .endd
38218 The first number in the output line is the process number. The third line has
38219 been split here, in order to fit it on the page.
38220
38221
38222
38223 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38224 .cindex "&'exiqgrep'&"
38225 .cindex "queue" "grepping"
38226 This utility is a Perl script contributed by Matt Hubbard. It runs
38227 .code
38228 exim -bpu
38229 .endd
38230 or (in case &*-a*& switch is specified)
38231 .code
38232 exim -bp
38233 .endd
38234 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38235 contain alternate exim configuration the queue management might be using.
38236
38237 to obtain a queue listing, and then greps the output to select messages
38238 that match given criteria. The following selection options are available:
38239
38240 .vlist
38241 .vitem &*-f*&&~<&'regex'&>
38242 Match the sender address using a case-insensitive search. The field that is
38243 tested is enclosed in angle brackets, so you can test for bounce messages with
38244 .code
38245 exiqgrep -f '^<>$'
38246 .endd
38247 .vitem &*-r*&&~<&'regex'&>
38248 Match a recipient address using a case-insensitive search. The field that is
38249 tested is not enclosed in angle brackets.
38250
38251 .vitem &*-s*&&~<&'regex'&>
38252 Match against the size field.
38253
38254 .vitem &*-y*&&~<&'seconds'&>
38255 Match messages that are younger than the given time.
38256
38257 .vitem &*-o*&&~<&'seconds'&>
38258 Match messages that are older than the given time.
38259
38260 .vitem &*-z*&
38261 Match only frozen messages.
38262
38263 .vitem &*-x*&
38264 Match only non-frozen messages.
38265
38266 .vitem &*-G*&&~<&'queuename'&>
38267 Match only messages in the given queue.  Without this, the default queue is searched.
38268 .endlist
38269
38270 The following options control the format of the output:
38271
38272 .vlist
38273 .vitem &*-c*&
38274 Display only the count of matching messages.
38275
38276 .vitem &*-l*&
38277 Long format &-- display the full message information as output by Exim. This is
38278 the default.
38279
38280 .vitem &*-i*&
38281 Display message ids only.
38282
38283 .vitem &*-b*&
38284 Brief format &-- one line per message.
38285
38286 .vitem &*-R*&
38287 Display messages in reverse order.
38288
38289 .vitem &*-a*&
38290 Include delivered recipients in queue listing.
38291 .endlist
38292
38293 There is one more option, &%-h%&, which outputs a list of options.
38294
38295
38296
38297 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38298 .cindex "&'exiqsumm'&"
38299 .cindex "queue" "summary"
38300 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38301 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38302 running a command such as
38303 .code
38304 exim -bp | exiqsumm
38305 .endd
38306 The output consists of one line for each domain that has messages waiting for
38307 it, as in the following example:
38308 .code
38309 3   2322   74m   66m  msn.com.example
38310 .endd
38311 Each line lists the number of pending deliveries for a domain, their total
38312 volume, and the length of time that the oldest and the newest messages have
38313 been waiting. Note that the number of pending deliveries is greater than the
38314 number of messages when messages have more than one recipient.
38315
38316 A summary line is output at the end. By default the output is sorted on the
38317 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38318 the output to be sorted by oldest message and by count of messages,
38319 respectively. There are also three options that split the messages for each
38320 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38321 separates frozen messages, and &%-s%& separates messages according to their
38322 sender.
38323
38324 The output of &'exim -bp'& contains the original addresses in the message, so
38325 this also applies to the output from &'exiqsumm'&. No domains from addresses
38326 generated by aliasing or forwarding are included (unless the &%one_time%&
38327 option of the &(redirect)& router has been used to convert them into &"top
38328 level"& addresses).
38329
38330
38331
38332
38333 .section "Extracting specific information from the log (exigrep)" &&&
38334          "SECTextspeinf"
38335 .cindex "&'exigrep'&"
38336 .cindex "log" "extracts; grepping for"
38337 The &'exigrep'& utility is a Perl script that searches one or more main log
38338 files for entries that match a given pattern. When it finds a match, it
38339 extracts all the log entries for the relevant message, not just those that
38340 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38341 given message, or all mail for a given user, or for a given host, for example.
38342 The input files can be in Exim log format or syslog format.
38343 If a matching log line is not associated with a specific message, it is
38344 included in &'exigrep'&'s output without any additional lines. The usage is:
38345 .display
38346 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38347 .endd
38348 If no log filenames are given on the command line, the standard input is read.
38349
38350 The &%-t%& argument specifies a number of seconds. It adds an additional
38351 condition for message selection. Messages that are complete are shown only if
38352 they spent more than <&'n'&> seconds in the queue.
38353
38354 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38355 makes it case-sensitive. This may give a performance improvement when searching
38356 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38357 option; with &%-I%& they do not. In both cases it is possible to change the
38358 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38359
38360 The &%-l%& option means &"literal"&, that is, treat all characters in the
38361 pattern as standing for themselves. Otherwise the pattern must be a Perl
38362 regular expression.
38363
38364 The &%-v%& option inverts the matching condition. That is, a line is selected
38365 if it does &'not'& match the pattern.
38366
38367 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38368 that are generated as a result/response to a message that &'exigrep'& matched
38369 normally.
38370
38371 Example of &%-M%&:
38372 user_a sends a message to user_b, which generates a bounce back to user_b. If
38373 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38374 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38375 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38376 when searching for &"user_a"& will show both messages since the bounce is
38377 &"related"& to or a &"result"& of the first message that was found by the
38378 search term.
38379
38380 If the location of a &'zcat'& command is known from the definition of
38381 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38382 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38383 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38384 autodetection of some well known compression extensions.
38385
38386
38387 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38388 .cindex "&'exipick'&"
38389 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38390 lists messages from the queue according to a variety of criteria. For details
38391 of &'exipick'&'s facilities, run &'exipick'& with
38392 the &%--help%& option.
38393
38394
38395 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38396 .cindex "log" "cycling local files"
38397 .cindex "cycling logs"
38398 .cindex "&'exicyclog'&"
38399 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38400 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38401 you are using log files with datestamps in their names (see section
38402 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38403 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38404 There are two command line options for &'exicyclog'&:
38405 .ilist
38406 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38407 default that is set when Exim is built. The default default is 10.
38408 .next
38409 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38410 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38411 overriding the script's default, which is to find the setting from Exim's
38412 configuration.
38413 .endlist
38414
38415 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38416 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38417 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38418 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38419 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38420 logs are handled similarly.
38421
38422 If the limit is greater than 99, the script uses 3-digit numbers such as
38423 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38424 to one that is greater, or &'vice versa'&, you will have to fix the names of
38425 any existing log files.
38426
38427 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38428 the end are deleted. All files with numbers greater than 01 are compressed,
38429 using a compression command which is configured by the COMPRESS_COMMAND
38430 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38431 root &%crontab%& entry of the form
38432 .code
38433 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38434 .endd
38435 assuming you have used the name &"exim"& for the Exim user. You can run
38436 &'exicyclog'& as root if you wish, but there is no need.
38437
38438
38439
38440 .section "Mail statistics (eximstats)" "SECTmailstat"
38441 .cindex "statistics"
38442 .cindex "&'eximstats'&"
38443 A Perl script called &'eximstats'& is provided for extracting statistical
38444 information from log files. The output is either plain text, or HTML.
38445 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38446 . --- 404 error and everything else points to that.
38447
38448 The &'eximstats'& script has been hacked about quite a bit over time. The
38449 latest version is the result of some extensive revision by Steve Campbell. A
38450 lot of information is given by default, but there are options for suppressing
38451 various parts of it. Following any options, the arguments to the script are a
38452 list of files, which should be main log files. For example:
38453 .code
38454 eximstats -nr /var/spool/exim/log/mainlog.01
38455 .endd
38456 By default, &'eximstats'& extracts information about the number and volume of
38457 messages received from or delivered to various hosts. The information is sorted
38458 both by message count and by volume, and the top fifty hosts in each category
38459 are listed on the standard output. Similar information, based on email
38460 addresses or domains instead of hosts can be requested by means of various
38461 options. For messages delivered and received locally, similar statistics are
38462 also produced per user.
38463
38464 The output also includes total counts and statistics about delivery errors, and
38465 histograms showing the number of messages received and deliveries made in each
38466 hour of the day. A delivery with more than one address in its envelope (for
38467 example, an SMTP transaction with more than one RCPT command) is counted
38468 as a single delivery by &'eximstats'&.
38469
38470 Though normally more deliveries than receipts are reported (as messages may
38471 have multiple recipients), it is possible for &'eximstats'& to report more
38472 messages received than delivered, even though the queue is empty at the start
38473 and end of the period in question. If an incoming message contains no valid
38474 recipients, no deliveries are recorded for it. A bounce message is handled as
38475 an entirely separate message.
38476
38477 &'eximstats'& always outputs a grand total summary giving the volume and number
38478 of messages received and deliveries made, and the number of hosts involved in
38479 each case. It also outputs the number of messages that were delayed (that is,
38480 not completely delivered at the first attempt), and the number that had at
38481 least one address that failed.
38482
38483 The remainder of the output is in sections that can be independently disabled
38484 or modified by various options. It consists of a summary of deliveries by
38485 transport, histograms of messages received and delivered per time interval
38486 (default per hour), information about the time messages spent in the queue,
38487 a list of relayed messages, lists of the top fifty sending hosts, local
38488 senders, destination hosts, and destination local users by count and by volume,
38489 and a list of delivery errors that occurred.
38490
38491 The relay information lists messages that were actually relayed, that is, they
38492 came from a remote host and were directly delivered to some other remote host,
38493 without being processed (for example, for aliasing or forwarding) locally.
38494
38495 There are quite a few options for &'eximstats'& to control exactly what it
38496 outputs. These are documented in the Perl script itself, and can be extracted
38497 by running the command &(perldoc)& on the script. For example:
38498 .code
38499 perldoc /usr/exim/bin/eximstats
38500 .endd
38501
38502 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38503 .cindex "&'exim_checkaccess'&"
38504 .cindex "policy control" "checking access"
38505 .cindex "checking access"
38506 The &%-bh%& command line argument allows you to run a fake SMTP session with
38507 debugging output, in order to check what Exim is doing when it is applying
38508 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38509 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38510 sometimes you just want to answer the question &"Does this address have
38511 access?"& without bothering with any further details.
38512
38513 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38514 two arguments, an IP address and an email address:
38515 .code
38516 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38517 .endd
38518 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38519 given email address would be accepted in a RCPT command in a TCP/IP
38520 connection from the host with the given IP address. The output of the utility
38521 is either the word &"accepted"&, or the SMTP error response, for example:
38522 .code
38523 Rejected:
38524 550 Relay not permitted
38525 .endd
38526 When running this test, the utility uses &`<>`& as the envelope sender address
38527 for the MAIL command, but you can change this by providing additional
38528 options. These are passed directly to the Exim command. For example, to specify
38529 that the test is to be run with the sender address &'himself@there.example'&
38530 you can use:
38531 .code
38532 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38533                  -f himself@there.example
38534 .endd
38535 Note that these additional Exim command line items must be given after the two
38536 mandatory arguments.
38537
38538 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38539 while running its checks. You can run checks that include callouts by using
38540 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38541
38542
38543
38544 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38545 .cindex "DBM" "building dbm files"
38546 .cindex "building DBM files"
38547 .cindex "&'exim_dbmbuild'&"
38548 .cindex "lower casing"
38549 .cindex "binary zero" "in lookup key"
38550 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38551 the format used by the &(lsearch)& lookup (see section
38552 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38553 names as keys and the remainder of the information as data. The lower-casing
38554 can be prevented by calling the program with the &%-nolc%& option.
38555
38556 A terminating zero is included as part of the key string. This is expected by
38557 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38558 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38559 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38560 files.
38561
38562 The program requires two arguments: the name of the input file (which can be a
38563 single hyphen to indicate the standard input), and the name of the output file.
38564 It creates the output under a temporary name, and then renames it if all went
38565 well.
38566
38567 .cindex "USE_DB"
38568 If the native DB interface is in use (USE_DB is set in a compile-time
38569 configuration file &-- this is common in free versions of Unix) the two
38570 filenames must be different, because in this mode the Berkeley DB functions
38571 create a single output file using exactly the name given. For example,
38572 .code
38573 exim_dbmbuild /etc/aliases /etc/aliases.db
38574 .endd
38575 reads the system alias file and creates a DBM version of it in
38576 &_/etc/aliases.db_&.
38577
38578 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38579 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38580 environment, the suffixes are added to the second argument of
38581 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38582 when the Berkeley functions are used in compatibility mode (though this is not
38583 recommended), because in that case it adds a &_.db_& suffix to the filename.
38584
38585 If a duplicate key is encountered, the program outputs a warning, and when it
38586 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38587 option is used. By default, only the first of a set of duplicates is used &--
38588 this makes it compatible with &(lsearch)& lookups. There is an option
38589 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38590 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38591 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38592 return code is 2.
38593
38594
38595
38596
38597 .section "Finding individual retry times (exinext)" "SECTfinindret"
38598 .cindex "retry" "times"
38599 .cindex "&'exinext'&"
38600 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38601 fish specific information out of the retry database. Given a mail domain (or a
38602 complete address), it looks up the hosts for that domain, and outputs any retry
38603 information for the hosts or for the domain. At present, the retry information
38604 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38605 output. For example:
38606 .code
38607 $ exinext piglet@milne.fict.example
38608 kanga.milne.example:192.168.8.1 error 146: Connection refused
38609   first failed: 21-Feb-1996 14:57:34
38610   last tried:   21-Feb-1996 14:57:34
38611   next try at:  21-Feb-1996 15:02:34
38612 roo.milne.example:192.168.8.3 error 146: Connection refused
38613   first failed: 20-Jan-1996 13:12:08
38614   last tried:   21-Feb-1996 11:42:03
38615   next try at:  21-Feb-1996 19:42:03
38616   past final cutoff time
38617 .endd
38618 You can also give &'exinext'& a local part, without a domain, and it
38619 will give any retry information for that local part in your default domain.
38620 A message id can be used to obtain retry information pertaining to a specific
38621 message. This exists only when an attempt to deliver a message to a remote host
38622 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38623 &'exinext'& is not particularly efficient, but then it is not expected to be
38624 run very often.
38625
38626 The &'exinext'& utility calls Exim to find out information such as the location
38627 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38628 passed on to the &'exim'& commands. The first specifies an alternate Exim
38629 configuration file, and the second sets macros for use within the configuration
38630 file. These features are mainly to help in testing, but might also be useful in
38631 environments where more than one configuration file is in use.
38632
38633
38634
38635 .section "Hints database maintenance" "SECThindatmai"
38636 .cindex "hints database" "maintenance"
38637 .cindex "maintaining Exim's hints database"
38638 Three utility programs are provided for maintaining the DBM files that Exim
38639 uses to contain its delivery hint information. Each program requires two
38640 arguments. The first specifies the name of Exim's spool directory, and the
38641 second is the name of the database it is to operate on. These are as follows:
38642
38643 .ilist
38644 &'retry'&: the database of retry information
38645 .next
38646 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38647 for remote hosts
38648 .next
38649 &'callout'&: the callout cache
38650 .next
38651 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38652 .next
38653 &'misc'&: other hints data
38654 .endlist
38655
38656 The &'misc'& database is used for
38657
38658 .ilist
38659 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38660 .next
38661 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38662 &(smtp)& transport)
38663 .next
38664 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38665 in a transport)
38666 .endlist
38667
38668
38669
38670 .section "exim_dumpdb" "SECID261"
38671 .cindex "&'exim_dumpdb'&"
38672 The entire contents of a database are written to the standard output by the
38673 &'exim_dumpdb'& program, which has no options or arguments other than the
38674 spool and database names. For example, to dump the retry database:
38675 .code
38676 exim_dumpdb /var/spool/exim retry
38677 .endd
38678 Two lines of output are produced for each entry:
38679 .code
38680 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38681 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38682 .endd
38683 The first item on the first line is the key of the record. It starts with one
38684 of the letters R, or T, depending on whether it refers to a routing or
38685 transport retry. For a local delivery, the next part is the local address; for
38686 a remote delivery it is the name of the remote host, followed by its failing IP
38687 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38688 transport). If the remote port is not the standard one (port 25), it is added
38689 to the IP address. Then there follows an error code, an additional error code,
38690 and a textual description of the error.
38691
38692 The three times on the second line are the time of first failure, the time of
38693 the last delivery attempt, and the computed time for the next attempt. The line
38694 ends with an asterisk if the cutoff time for the last retry rule has been
38695 exceeded.
38696
38697 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38698 consists of a host name followed by a list of ids for messages that are or were
38699 waiting to be delivered to that host. If there are a very large number for any
38700 one host, continuation records, with a sequence number added to the host name,
38701 may be seen. The data in these records is often out of date, because a message
38702 may be routed to several alternative hosts, and Exim makes no effort to keep
38703 cross-references.
38704
38705
38706
38707 .section "exim_tidydb" "SECID262"
38708 .cindex "&'exim_tidydb'&"
38709 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38710 database. If run with no options, it removes all records that are more than 30
38711 days old. The age is calculated from the date and time that the record was last
38712 updated. Note that, in the case of the retry database, it is &'not'& the time
38713 since the first delivery failure. Information about a host that has been down
38714 for more than 30 days will remain in the database, provided that the record is
38715 updated sufficiently often.
38716
38717 The cutoff date can be altered by means of the &%-t%& option, which must be
38718 followed by a time. For example, to remove all records older than a week from
38719 the retry database:
38720 .code
38721 exim_tidydb -t 7d /var/spool/exim retry
38722 .endd
38723 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38724 message ids. In the former these appear as data in records keyed by host &--
38725 they were messages that were waiting for that host &-- and in the latter they
38726 are the keys for retry information for messages that have suffered certain
38727 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38728 message ids in database records are those of messages that are still on the
38729 queue. Message ids for messages that no longer exist are removed from
38730 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38731 For the &'retry'& database, records whose keys are non-existent message ids are
38732 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38733 whenever it removes information from the database.
38734
38735 Certain records are automatically removed by Exim when they are no longer
38736 needed, but others are not. For example, if all the MX hosts for a domain are
38737 down, a retry record is created for each one. If the primary MX host comes back
38738 first, its record is removed when Exim successfully delivers to it, but the
38739 records for the others remain because Exim has not tried to use those hosts.
38740
38741 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38742 hints databases. You should do this at a quiet time of day, because it requires
38743 a database to be locked (and therefore inaccessible to Exim) while it does its
38744 work. Removing records from a DBM file does not normally make the file smaller,
38745 but all the common DBM libraries are able to re-use the space that is released.
38746 After an initial phase of increasing in size, the databases normally reach a
38747 point at which they no longer get any bigger, as long as they are regularly
38748 tidied.
38749
38750 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38751 databases is likely to keep on increasing.
38752
38753
38754
38755
38756 .section "exim_fixdb" "SECID263"
38757 .cindex "&'exim_fixdb'&"
38758 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38759 Its main use is for testing Exim, but it might also be occasionally useful for
38760 getting round problems in a live system. It has no options, and its interface
38761 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38762 key of a database record can then be entered, and the data for that record is
38763 displayed.
38764
38765 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38766 except the &'retry'& database, that is the only operation that can be carried
38767 out. For the &'retry'& database, each field is output preceded by a number, and
38768 data for individual fields can be changed by typing the field number followed
38769 by new data, for example:
38770 .code
38771 > 4 951102:1000
38772 .endd
38773 resets the time of the next delivery attempt. Time values are given as a
38774 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38775 used as optional separators.
38776
38777
38778
38779
38780 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38781 .cindex "mailbox" "maintenance"
38782 .cindex "&'exim_lock'&"
38783 .cindex "locking mailboxes"
38784 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38785 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38786 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38787 a user agent while investigating a problem. The utility requires the name of
38788 the file as its first argument. If the locking is successful, the second
38789 argument is run as a command (using C's &[system()]& function); if there is no
38790 second argument, the value of the SHELL environment variable is used; if this
38791 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38792 is unlocked and the utility ends. The following options are available:
38793
38794 .vlist
38795 .vitem &%-fcntl%&
38796 Use &[fcntl()]& locking on the open mailbox.
38797
38798 .vitem &%-flock%&
38799 Use &[flock()]& locking on the open mailbox, provided the operating system
38800 supports it.
38801
38802 .vitem &%-interval%&
38803 This must be followed by a number, which is a number of seconds; it sets the
38804 interval to sleep between retries (default 3).
38805
38806 .vitem &%-lockfile%&
38807 Create a lock file before opening the mailbox.
38808
38809 .vitem &%-mbx%&
38810 Lock the mailbox using MBX rules.
38811
38812 .vitem &%-q%&
38813 Suppress verification output.
38814
38815 .vitem &%-retries%&
38816 This must be followed by a number; it sets the number of times to try to get
38817 the lock (default 10).
38818
38819 .vitem &%-restore_time%&
38820 This option causes &%exim_lock%& to restore the modified and read times to the
38821 locked file before exiting. This allows you to access a locked mailbox (for
38822 example, to take a backup copy) without disturbing the times that the user
38823 subsequently sees.
38824
38825 .vitem &%-timeout%&
38826 This must be followed by a number, which is a number of seconds; it sets a
38827 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38828 default), a non-blocking call is used.
38829
38830 .vitem &%-v%&
38831 Generate verbose output.
38832 .endlist
38833
38834 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38835 default is to create a lock file and also to use &[fcntl()]& locking on the
38836 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38837 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38838 requires that the directory containing the file be writeable. Locking by lock
38839 file does not last forever; Exim assumes that a lock file is expired if it is
38840 more than 30 minutes old.
38841
38842 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38843 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38844 to be taken out on the open mailbox, and an exclusive lock on the file
38845 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38846 number of the mailbox file. When the locking is released, if an exclusive lock
38847 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38848
38849 The default output contains verification of the locking that takes place. The
38850 &%-v%& option causes some additional information to be given. The &%-q%& option
38851 suppresses all output except error messages.
38852
38853 A command such as
38854 .code
38855 exim_lock /var/spool/mail/spqr
38856 .endd
38857 runs an interactive shell while the file is locked, whereas
38858 .display
38859 &`exim_lock -q /var/spool/mail/spqr <<End`&
38860 <&'some commands'&>
38861 &`End`&
38862 .endd
38863 runs a specific non-interactive sequence of commands while the file is locked,
38864 suppressing all verification output. A single command can be run by a command
38865 such as
38866 .code
38867 exim_lock -q /var/spool/mail/spqr \
38868   "cp /var/spool/mail/spqr /some/where"
38869 .endd
38870 Note that if a command is supplied, it must be entirely contained within the
38871 second argument &-- hence the quotes.
38872 .ecindex IIDutils
38873
38874
38875 . ////////////////////////////////////////////////////////////////////////////
38876 . ////////////////////////////////////////////////////////////////////////////
38877
38878 .chapter "The Exim monitor" "CHAPeximon"
38879 .scindex IIDeximon "Exim monitor" "description"
38880 .cindex "X-windows"
38881 .cindex "&'eximon'&"
38882 .cindex "Local/eximon.conf"
38883 .cindex "&_exim_monitor/EDITME_&"
38884 The Exim monitor is an application which displays in an X window information
38885 about the state of Exim's queue and what Exim is doing. An admin user can
38886 perform certain operations on messages from this GUI interface; however all
38887 such facilities are also available from the command line, and indeed, the
38888 monitor itself makes use of the command line to perform any actions requested.
38889
38890
38891
38892 .section "Running the monitor" "SECID264"
38893 The monitor is started by running the script called &'eximon'&. This is a shell
38894 script that sets up a number of environment variables, and then runs the
38895 binary called &_eximon.bin_&. The default appearance of the monitor window can
38896 be changed by editing the &_Local/eximon.conf_& file created by editing
38897 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38898 parameters are for.
38899
38900 The parameters that get built into the &'eximon'& script can be overridden for
38901 a particular invocation by setting up environment variables of the same names,
38902 preceded by &`EXIMON_`&. For example, a shell command such as
38903 .code
38904 EXIMON_LOG_DEPTH=400 eximon
38905 .endd
38906 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38907 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38908 overrides the Exim log file configuration. This makes it possible to have
38909 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38910 syslog messages are routed to a file on the local host.
38911
38912 X resources can be used to change the appearance of the window in the normal
38913 way. For example, a resource setting of the form
38914 .code
38915 Eximon*background: gray94
38916 .endd
38917 changes the colour of the background to light grey rather than white. The
38918 stripcharts are drawn with both the data lines and the reference lines in
38919 black. This means that the reference lines are not visible when on top of the
38920 data. However, their colour can be changed by setting a resource called
38921 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38922 For example, if your X server is running Unix, you could set up lighter
38923 reference lines in the stripcharts by obeying
38924 .code
38925 xrdb -merge <<End
38926 Eximon*highlight: gray
38927 End
38928 .endd
38929 .cindex "admin user"
38930 In order to see the contents of messages in the queue, and to operate on them,
38931 &'eximon'& must either be run as root or by an admin user.
38932
38933 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38934 contain X11 resource parameters interpreted by the X11 library.  In addition,
38935 if the first parameter starts with the string "gdb" then it is removed and the
38936 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38937 versioned variants of gdb can be invoked).
38938
38939 The monitor's window is divided into three parts. The first contains one or
38940 more stripcharts and two action buttons, the second contains a &"tail"& of the
38941 main log file, and the third is a display of the queue of messages awaiting
38942 delivery, with two more action buttons. The following sections describe these
38943 different parts of the display.
38944
38945
38946
38947
38948 .section "The stripcharts" "SECID265"
38949 .cindex "stripchart"
38950 The first stripchart is always a count of messages in the queue. Its name can
38951 be configured by setting QUEUE_STRIPCHART_NAME in the
38952 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38953 configuration script by regular expression matches on log file entries, making
38954 it possible to display, for example, counts of messages delivered to certain
38955 hosts or using certain transports. The supplied defaults display counts of
38956 received and delivered messages, and of local and SMTP deliveries. The default
38957 period between stripchart updates is one minute; this can be adjusted by a
38958 parameter in the &_Local/eximon.conf_& file.
38959
38960 The stripchart displays rescale themselves automatically as the value they are
38961 displaying changes. There are always 10 horizontal lines in each chart; the
38962 title string indicates the value of each division when it is greater than one.
38963 For example, &"x2"& means that each division represents a value of 2.
38964
38965 It is also possible to have a stripchart which shows the percentage fullness of
38966 a particular disk partition, which is useful when local deliveries are confined
38967 to a single partition.
38968
38969 .cindex "&%statvfs%& function"
38970 This relies on the availability of the &[statvfs()]& function or equivalent in
38971 the operating system. Most, but not all versions of Unix that support Exim have
38972 this. For this particular stripchart, the top of the chart always represents
38973 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38974 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38975 &_Local/eximon.conf_& file.
38976
38977
38978
38979
38980 .section "Main action buttons" "SECID266"
38981 .cindex "size" "of monitor window"
38982 .cindex "Exim monitor" "window size"
38983 .cindex "window size"
38984 Below the stripcharts there is an action button for quitting the monitor. Next
38985 to this is another button marked &"Size"&. They are placed here so that
38986 shrinking the window to its default minimum size leaves just the queue count
38987 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38988 the window to expand to its maximum size, unless it is already at the maximum,
38989 in which case it is reduced to its minimum.
38990
38991 When expanding to the maximum, if the window cannot be fully seen where it
38992 currently is, it is moved back to where it was the last time it was at full
38993 size. When it is expanding from its minimum size, the old position is
38994 remembered, and next time it is reduced to the minimum it is moved back there.
38995
38996 The idea is that you can keep a reduced window just showing one or two
38997 stripcharts at a convenient place on your screen, easily expand it to show
38998 the full window when required, and just as easily put it back to what it was.
38999 The idea is copied from what the &'twm'& window manager does for its
39000 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39001 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39002
39003 Normally, the monitor starts up with the window at its full size, but it can be
39004 built so that it starts up with the window at its smallest size, by setting
39005 START_SMALL=yes in &_Local/eximon.conf_&.
39006
39007
39008
39009 .section "The log display" "SECID267"
39010 .cindex "log" "tail of; in monitor"
39011 The second section of the window is an area in which a display of the tail of
39012 the main log is maintained.
39013 To save space on the screen, the timestamp on each log line is shortened by
39014 removing the date and, if &%log_timezone%& is set, the timezone.
39015 The log tail is not available when the only destination for logging data is
39016 syslog, unless the syslog lines are routed to a local file whose name is passed
39017 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39018
39019 The log sub-window has a scroll bar at its lefthand side which can be used to
39020 move back to look at earlier text, and the up and down arrow keys also have a
39021 scrolling effect. The amount of log that is kept depends on the setting of
39022 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39023 to use. When this is full, the earlier 50% of data is discarded &-- this is
39024 much more efficient than throwing it away line by line. The sub-window also has
39025 a horizontal scroll bar for accessing the ends of long log lines. This is the
39026 only means of horizontal scrolling; the right and left arrow keys are not
39027 available. Text can be cut from this part of the window using the mouse in the
39028 normal way. The size of this subwindow is controlled by parameters in the
39029 configuration file &_Local/eximon.conf_&.
39030
39031 Searches of the text in the log window can be carried out by means of the ^R
39032 and ^S keystrokes, which default to a reverse and a forward search,
39033 respectively. The search covers only the text that is displayed in the window.
39034 It cannot go further back up the log.
39035
39036 The point from which the search starts is indicated by a caret marker. This is
39037 normally at the end of the text in the window, but can be positioned explicitly
39038 by pointing and clicking with the left mouse button, and is moved automatically
39039 by a successful search. If new text arrives in the window when it is scrolled
39040 back, the caret remains where it is, but if the window is not scrolled back,
39041 the caret is moved to the end of the new text.
39042
39043 Pressing ^R or ^S pops up a window into which the search text can be typed.
39044 There are buttons for selecting forward or reverse searching, for carrying out
39045 the search, and for cancelling. If the &"Search"& button is pressed, the search
39046 happens and the window remains so that further searches can be done. If the
39047 &"Return"& key is pressed, a single search is done and the window is closed. If
39048 ^C is typed the search is cancelled.
39049
39050 The searching facility is implemented using the facilities of the Athena text
39051 widget. By default this pops up a window containing both &"search"& and
39052 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39053 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39054 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39055 provided version of &%TextPop%& when the remaining parts of the text widget
39056 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39057 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39058 on these systems, at the expense of having unwanted items in the search popup
39059 window.
39060
39061
39062
39063 .section "The queue display" "SECID268"
39064 .cindex "queue" "display in monitor"
39065 The bottom section of the monitor window contains a list of all messages that
39066 are in the queue, which includes those currently being received or delivered,
39067 as well as those awaiting delivery. The size of this subwindow is controlled by
39068 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39069 at which it is updated is controlled by another parameter in the same file &--
39070 the default is 5 minutes, since queue scans can be quite expensive. However,
39071 there is an &"Update"& action button just above the display which can be used
39072 to force an update of the queue display at any time.
39073
39074 When a host is down for some time, a lot of pending mail can build up for it,
39075 and this can make it hard to deal with other messages in the queue. To help
39076 with this situation there is a button next to &"Update"& called &"Hide"&. If
39077 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39078 type anything in here and press &"Return"&, the text is added to a chain of
39079 such texts, and if every undelivered address in a message matches at least one
39080 of the texts, the message is not displayed.
39081
39082 If there is an address that does not match any of the texts, all the addresses
39083 are displayed as normal. The matching happens on the ends of addresses so, for
39084 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39085 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39086 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39087 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39088 a hide request is automatically cancelled after one hour.
39089
39090 While the dialogue box is displayed, you can't press any buttons or do anything
39091 else to the monitor window. For this reason, if you want to cut text from the
39092 queue display to use in the dialogue box, you have to do the cutting before
39093 pressing the &"Hide"& button.
39094
39095 The queue display contains, for each unhidden queued message, the length of
39096 time it has been in the queue, the size of the message, the message id, the
39097 message sender, and the first undelivered recipient, all on one line. If it is
39098 a bounce message, the sender is shown as &"<>"&. If there is more than one
39099 recipient to which the message has not yet been delivered, subsequent ones are
39100 listed on additional lines, up to a maximum configured number, following which
39101 an ellipsis is displayed. Recipients that have already received the message are
39102 not shown.
39103
39104 .cindex "frozen messages" "display"
39105 If a message is frozen, an asterisk is displayed at the left-hand side.
39106
39107 The queue display has a vertical scroll bar, and can also be scrolled by means
39108 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39109 The text searching facilities, as described above for the log window, are also
39110 available, but the caret is always moved to the end of the text when the queue
39111 display is updated.
39112
39113
39114
39115 .section "The queue menu" "SECID269"
39116 .cindex "queue" "menu in monitor"
39117 If the &%shift%& key is held down and the left button is clicked when the mouse
39118 pointer is over the text for any message, an action menu pops up, and the first
39119 line of the queue display for the message is highlighted. This does not affect
39120 any selected text.
39121
39122 If you want to use some other event for popping up the menu, you can set the
39123 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39124 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39125 value set in this parameter is a standard X event description. For example, to
39126 run eximon using &%ctrl%& rather than &%shift%& you could use
39127 .code
39128 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39129 .endd
39130 The title of the menu is the message id, and it contains entries which act as
39131 follows:
39132
39133 .ilist
39134 &'message log'&: The contents of the message log for the message are displayed
39135 in a new text window.
39136 .next
39137 &'headers'&: Information from the spool file that contains the envelope
39138 information and headers is displayed in a new text window. See chapter
39139 &<<CHAPspool>>& for a description of the format of spool files.
39140 .next
39141 &'body'&: The contents of the spool file containing the body of the message are
39142 displayed in a new text window. There is a default limit of 20,000 bytes to the
39143 amount of data displayed. This can be changed by setting the BODY_MAX
39144 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39145 .next
39146 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39147 delivery of the message. This causes an automatic thaw if the message is
39148 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39149 a new text window. The delivery is run in a separate process, to avoid holding
39150 up the monitor while the delivery proceeds.
39151 .next
39152 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39153 that the message be frozen.
39154 .next
39155 .cindex "thawing messages"
39156 .cindex "unfreezing messages"
39157 .cindex "frozen messages" "thawing"
39158 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39159 that the message be thawed.
39160 .next
39161 .cindex "delivery" "forcing failure"
39162 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39163 that Exim gives up trying to deliver the message. A bounce message is generated
39164 for any remaining undelivered addresses.
39165 .next
39166 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39167 that the message be deleted from the system without generating a bounce
39168 message.
39169 .next
39170 &'add recipient'&: A dialog box is displayed into which a recipient address can
39171 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39172 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39173 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39174 causes a call to Exim to be made using the &%-Mar%& option to request that an
39175 additional recipient be added to the message, unless the entry box is empty, in
39176 which case no action is taken.
39177 .next
39178 &'mark delivered'&: A dialog box is displayed into which a recipient address
39179 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39180 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39181 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39182 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39183 recipient address as already delivered, unless the entry box is empty, in which
39184 case no action is taken.
39185 .next
39186 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39187 mark all recipient addresses as already delivered.
39188 .next
39189 &'edit sender'&: A dialog box is displayed initialized with the current
39190 sender's address. Pressing RETURN causes a call to Exim to be made using the
39191 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39192 in which case no action is taken. If you want to set an empty sender (as in
39193 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39194 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39195 the address is qualified with that domain.
39196 .endlist
39197
39198 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39199 other cases when a call to Exim is made, if there is any output from Exim (in
39200 particular, if the command fails) a window containing the command and the
39201 output is displayed. Otherwise, the results of the action are normally apparent
39202 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39203 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39204 if no output is generated.
39205
39206 The queue display is automatically updated for actions such as freezing and
39207 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39208 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39209 force an update of the display after one of these actions.
39210
39211 In any text window that is displayed as result of a menu action, the normal
39212 cut-and-paste facility is available, and searching can be carried out using ^R
39213 and ^S, as described above for the log tail window.
39214 .ecindex IIDeximon
39215
39216
39217
39218
39219
39220 . ////////////////////////////////////////////////////////////////////////////
39221 . ////////////////////////////////////////////////////////////////////////////
39222
39223 .chapter "Security considerations" "CHAPsecurity"
39224 .scindex IIDsecurcon "security" "discussion of"
39225 This chapter discusses a number of issues concerned with security, some of
39226 which are also covered in other parts of this manual.
39227
39228 For reasons that this author does not understand, some people have promoted
39229 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39230 existence of this chapter in the documentation. However, the intent of the
39231 chapter is simply to describe the way Exim works in relation to certain
39232 security concerns, not to make any specific claims about the effectiveness of
39233 its security as compared with other MTAs.
39234
39235 What follows is a description of the way Exim is supposed to be. Best efforts
39236 have been made to try to ensure that the code agrees with the theory, but an
39237 absence of bugs can never be guaranteed. Any that are reported will get fixed
39238 as soon as possible.
39239
39240
39241 .section "Building a more &""hardened""& Exim" "SECID286"
39242 .cindex "security" "build-time features"
39243 There are a number of build-time options that can be set in &_Local/Makefile_&
39244 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39245 Exim administrator who does not have the root password, or by someone who has
39246 penetrated the Exim (but not the root) account. These options are as follows:
39247
39248 .ilist
39249 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39250 start of any filenames used with the &%-C%& option. When it is set, these
39251 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39252 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39253 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39254 default setting for &%ALT_CONFIG_PREFIX%&.
39255
39256 If the permitted configuration files are confined to a directory to
39257 which only root has access, this guards against someone who has broken
39258 into the Exim account from running a privileged Exim with an arbitrary
39259 configuration file, and using it to break into other accounts.
39260 .next
39261
39262 If a non-trusted configuration file (i.e. not the default configuration file
39263 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39264 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39265 the next item), then root privilege is retained only if the caller of Exim is
39266 root. This locks out the possibility of testing a configuration using &%-C%&
39267 right through message reception and delivery, even if the caller is root. The
39268 reception works, but by that time, Exim is running as the Exim user, so when
39269 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39270 privilege to be lost. However, root can test reception and delivery using two
39271 separate commands.
39272
39273 .next
39274 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39275 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39276 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39277 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39278 the restrictive side.  Requiring build-time selection of safe macros is onerous
39279 but this option is intended solely as a transition mechanism to permit
39280 previously-working configurations to continue to work after release 4.73.
39281 .next
39282 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39283 is disabled.
39284 .next
39285 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39286 never to be used for any deliveries. This is like the &%never_users%& runtime
39287 option, but it cannot be overridden; the runtime option adds additional users
39288 to the list. The default setting is &"root"&; this prevents a non-root user who
39289 is permitted to modify the runtime file from using Exim as a way to get root.
39290 .endlist
39291
39292
39293
39294 .section "Root privilege" "SECID270"
39295 .cindex "setuid"
39296 .cindex "root privilege"
39297 The Exim binary is normally setuid to root, which means that it gains root
39298 privilege (runs as root) when it starts execution. In some special cases (for
39299 example, when the daemon is not in use and there are no local deliveries), it
39300 may be possible to run Exim setuid to some user other than root. This is
39301 discussed in the next section. However, in most installations, root privilege
39302 is required for two things:
39303
39304 .ilist
39305 To set up a socket connected to the standard SMTP port (25) when initialising
39306 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39307 not required.
39308 .next
39309 To be able to change uid and gid in order to read users' &_.forward_& files and
39310 perform local deliveries as the receiving user or as specified in the
39311 configuration.
39312 .endlist
39313
39314 It is not necessary to be root to do any of the other things Exim does, such as
39315 receiving messages and delivering them externally over SMTP, and it is
39316 obviously more secure if Exim does not run as root except when necessary.
39317 For this reason, a user and group for Exim to use must be defined in
39318 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39319 group"&. Their values can be changed by the runtime configuration, though this
39320 is not recommended. Often a user called &'exim'& is used, but some sites use
39321 &'mail'& or another user name altogether.
39322
39323 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39324 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39325 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39326
39327 After a new Exim process has interpreted its command line options, it changes
39328 uid and gid in the following cases:
39329
39330 .ilist
39331 .oindex "&%-C%&"
39332 .oindex "&%-D%&"
39333 If the &%-C%& option is used to specify an alternate configuration file, or if
39334 the &%-D%& option is used to define macro values for the configuration, and the
39335 calling process is not running as root, the uid and gid are changed to those of
39336 the calling process.
39337 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39338 option may not be used at all.
39339 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39340 can be supplied if the calling process is running as root, the Exim run-time
39341 user or CONFIGURE_OWNER, if defined.
39342 .next
39343 .oindex "&%-be%&"
39344 .oindex "&%-bf%&"
39345 .oindex "&%-bF%&"
39346 If the expansion test option (&%-be%&) or one of the filter testing options
39347 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39348 calling process.
39349 .next
39350 If the process is not a daemon process or a queue runner process or a delivery
39351 process or a process for testing address routing (started with &%-bt%&), the
39352 uid and gid are changed to the Exim user and group. This means that Exim always
39353 runs under its own uid and gid when receiving messages. This also applies when
39354 testing address verification
39355 .oindex "&%-bv%&"
39356 .oindex "&%-bh%&"
39357 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39358 option).
39359 .next
39360 For a daemon, queue runner, delivery, or address testing process, the uid
39361 remains as root at this stage, but the gid is changed to the Exim group.
39362 .endlist
39363
39364 The processes that initially retain root privilege behave as follows:
39365
39366 .ilist
39367 A daemon process changes the gid to the Exim group and the uid to the Exim
39368 user after setting up one or more listening sockets. The &[initgroups()]&
39369 function is called, so that if the Exim user is in any additional groups, they
39370 will be used during message reception.
39371 .next
39372 A queue runner process retains root privilege throughout its execution. Its
39373 job is to fork a controlled sequence of delivery processes.
39374 .next
39375 A delivery process retains root privilege throughout most of its execution,
39376 but any actual deliveries (that is, the transports themselves) are run in
39377 subprocesses which always change to a non-root uid and gid. For local
39378 deliveries this is typically the uid and gid of the owner of the mailbox; for
39379 remote deliveries, the Exim uid and gid are used. Once all the delivery
39380 subprocesses have been run, a delivery process changes to the Exim uid and gid
39381 while doing post-delivery tidying up such as updating the retry database and
39382 generating bounce and warning messages.
39383
39384 While the recipient addresses in a message are being routed, the delivery
39385 process runs as root. However, if a user's filter file has to be processed,
39386 this is done in a subprocess that runs under the individual user's uid and
39387 gid. A system filter is run as root unless &%system_filter_user%& is set.
39388 .next
39389 A process that is testing addresses (the &%-bt%& option) runs as root so that
39390 the routing is done in the same environment as a message delivery.
39391 .endlist
39392
39393
39394
39395
39396 .section "Running Exim without privilege" "SECTrunexiwitpri"
39397 .cindex "privilege, running without"
39398 .cindex "unprivileged running"
39399 .cindex "root privilege" "running without"
39400 Some installations like to run Exim in an unprivileged state for more of its
39401 operation, for added security. Support for this mode of operation is provided
39402 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39403 gid are changed to the Exim user and group at the start of a delivery process
39404 (and also queue runner and address testing processes). This means that address
39405 routing is no longer run as root, and the deliveries themselves cannot change
39406 to any other uid.
39407
39408 .cindex SIGHUP
39409 .cindex "daemon" "restarting"
39410 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39411 that the daemon can still be started in the usual way, and it can respond
39412 correctly to SIGHUP because the re-invocation regains root privilege.
39413
39414 An alternative approach is to make Exim setuid to the Exim user and also setgid
39415 to the Exim group. If you do this, the daemon must be started from a root
39416 process. (Calling Exim from a root process makes it behave in the way it does
39417 when it is setuid root.) However, the daemon cannot restart itself after a
39418 SIGHUP signal because it cannot regain privilege.
39419
39420 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39421 stops Exim from trying to re-invoke itself to do a delivery after a message has
39422 been received. Such a re-invocation is a waste of resources because it has no
39423 effect.
39424
39425 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39426 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39427 to the Exim user seems a clean approach, but there is one complication:
39428
39429 In this style of operation, Exim is running with the real uid and gid set to
39430 those of the calling process, and the effective uid/gid set to Exim's values.
39431 Ideally, any association with the calling process' uid/gid should be dropped,
39432 that is, the real uid/gid should be reset to the effective values so as to
39433 discard any privileges that the caller may have. While some operating systems
39434 have a function that permits this action for a non-root effective uid, quite a
39435 number of them do not. Because of this lack of standardization, Exim does not
39436 address this problem at this time.
39437
39438 For this reason, the recommended approach for &"mostly unprivileged"& running
39439 is to keep the Exim binary setuid to root, and to set
39440 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39441 be used in the most straightforward way.
39442
39443 If you configure Exim not to run delivery processes as root, there are a
39444 number of restrictions on what you can do:
39445
39446 .ilist
39447 You can deliver only as the Exim user/group. You should  explicitly use the
39448 &%user%& and &%group%& options to override routers or local transports that
39449 normally deliver as the recipient. This makes sure that configurations that
39450 work in this mode function the same way in normal mode. Any implicit or
39451 explicit specification of another user causes an error.
39452 .next
39453 Use of &_.forward_& files is severely restricted, such that it is usually
39454 not worthwhile to include them in the configuration.
39455 .next
39456 Users who wish to use &_.forward_& would have to make their home directory and
39457 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39458 and their equivalents in Exim filters, cannot be used. While they could be
39459 enabled in the Exim user's name, that would be insecure and not very useful.
39460 .next
39461 Unless the local user mailboxes are all owned by the Exim user (possible in
39462 some POP3 or IMAP-only environments):
39463
39464 .olist
39465 They must be owned by the Exim group and be writeable by that group. This
39466 implies you must set &%mode%& in the appendfile configuration, as well as the
39467 mode of the mailbox files themselves.
39468 .next
39469 You must set &%no_check_owner%&, since most or all of the files will not be
39470 owned by the Exim user.
39471 .next
39472 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39473 on a newly created mailbox when unprivileged. This also implies that new
39474 mailboxes need to be created manually.
39475 .endlist olist
39476 .endlist ilist
39477
39478
39479 These restrictions severely restrict what can be done in local deliveries.
39480 However, there are no restrictions on remote deliveries. If you are running a
39481 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39482 gives more security at essentially no cost.
39483
39484 If you are using the &%mua_wrapper%& facility (see chapter
39485 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39486
39487
39488
39489
39490 .section "Delivering to local files" "SECID271"
39491 Full details of the checks applied by &(appendfile)& before it writes to a file
39492 are given in chapter &<<CHAPappendfile>>&.
39493
39494
39495
39496 .section "Running local commands" "SECTsecconslocalcmds"
39497 .cindex "security" "local commands"
39498 .cindex "security" "command injection attacks"
39499 There are a number of ways in which an administrator can configure Exim to run
39500 commands based upon received, untrustworthy, data. Further, in some
39501 configurations a user who can control a &_.forward_& file can also arrange to
39502 run commands. Configuration to check includes, but is not limited to:
39503
39504 .ilist
39505 Use of &%use_shell%& in the pipe transport: various forms of shell command
39506 injection may be possible with this option present. It is dangerous and should
39507 be used only with considerable caution. Consider constraints which whitelist
39508 allowed characters in a variable which is to be used in a pipe transport that
39509 has &%use_shell%& enabled.
39510 .next
39511 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39512 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39513 &_.forward_& files in a redirect router. If Exim is running on a central mail
39514 hub to which ordinary users do not have shell access, but home directories are
39515 NFS mounted (for instance) then administrators should review the list of these
39516 forbid options available, and should bear in mind that the options that may
39517 need forbidding can change as new features are added between releases.
39518 .next
39519 The &%${run...}%& expansion item does not use a shell by default, but
39520 administrators can configure use of &_/bin/sh_& as part of the command.
39521 Such invocations should be viewed with prejudicial suspicion.
39522 .next
39523 Administrators who use embedded Perl are advised to explore how Perl's
39524 taint checking might apply to their usage.
39525 .next
39526 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39527 administrators are well advised to view its use with suspicion, in case (for
39528 instance) it allows a local-part to contain embedded Exim directives.
39529 .next
39530 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39531 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39532 each can reference arbitrary lists and files, rather than just being a list
39533 of opaque strings.
39534 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39535 real-world security vulnerabilities caused by its use with untrustworthy data
39536 injected in, for SQL injection attacks.
39537 Consider the use of the &%inlisti%& expansion condition instead.
39538 .endlist
39539
39540
39541
39542
39543 .section "Trust in configuration data" "SECTsecconfdata"
39544 .cindex "security" "data sources"
39545 .cindex "security" "regular expressions"
39546 .cindex "regular expressions" "security"
39547 .cindex "PCRE" "security"
39548 If configuration data for Exim can come from untrustworthy sources, there
39549 are some issues to be aware of:
39550
39551 .ilist
39552 Use of &%${expand...}%& may provide a path for shell injection attacks.
39553 .next
39554 Letting untrusted data provide a regular expression is unwise.
39555 .next
39556 Using &%${match...}%& to apply a fixed regular expression against untrusted
39557 data may result in pathological behaviour within PCRE.  Be aware of what
39558 "backtracking" means and consider options for being more strict with a regular
39559 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39560 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39561 possessive quantifiers or just not using regular expressions against untrusted
39562 data.
39563 .next
39564 It can be important to correctly use &%${quote:...}%&,
39565 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39566 items to ensure that data is correctly constructed.
39567 .next
39568 Some lookups might return multiple results, even though normal usage is only
39569 expected to yield one result.
39570 .endlist
39571
39572
39573
39574
39575 .section "IPv4 source routing" "SECID272"
39576 .cindex "source routing" "in IP packets"
39577 .cindex "IP source routing"
39578 Many operating systems suppress IP source-routed packets in the kernel, but
39579 some cannot be made to do this, so Exim does its own check. It logs incoming
39580 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39581 IPv6. No special checking is currently done.
39582
39583
39584
39585 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39586 Support for these SMTP commands is disabled by default. If required, they can
39587 be enabled by defining suitable ACLs.
39588
39589
39590
39591
39592 .section "Privileged users" "SECID274"
39593 .cindex "trusted users"
39594 .cindex "admin user"
39595 .cindex "privileged user"
39596 .cindex "user" "trusted"
39597 .cindex "user" "admin"
39598 Exim recognizes two sets of users with special privileges. Trusted users are
39599 able to submit new messages to Exim locally, but supply their own sender
39600 addresses and information about a sending host. For other users submitting
39601 local messages, Exim sets up the sender address from the uid, and doesn't
39602 permit a remote host to be specified.
39603
39604 .oindex "&%-f%&"
39605 However, an untrusted user is permitted to use the &%-f%& command line option
39606 in the special form &%-f <>%& to indicate that a delivery failure for the
39607 message should not cause an error report. This affects the message's envelope,
39608 but it does not affect the &'Sender:'& header. Untrusted users may also be
39609 permitted to use specific forms of address with the &%-f%& option by setting
39610 the &%untrusted_set_sender%& option.
39611
39612 Trusted users are used to run processes that receive mail messages from some
39613 other mail domain and pass them on to Exim for delivery either locally, or over
39614 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39615 as any user listed in the &%trusted_users%& configuration option, or under any
39616 group listed in the &%trusted_groups%& option.
39617
39618 Admin users are permitted to do things to the messages on Exim's queue. They
39619 can freeze or thaw messages, cause them to be returned to their senders, remove
39620 them entirely, or modify them in various ways. In addition, admin users can run
39621 the Exim monitor and see all the information it is capable of providing, which
39622 includes the contents of files on the spool.
39623
39624 .oindex "&%-M%&"
39625 .oindex "&%-q%&"
39626 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39627 delivery of messages on its queue is restricted to admin users. This
39628 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39629 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39630 queue is also restricted to admin users. This restriction can be relaxed by
39631 setting &%no_queue_list_requires_admin%&.
39632
39633 Exim recognizes an admin user if the calling process is running as root or as
39634 the Exim user or if any of the groups associated with the calling process is
39635 the Exim group. It is not necessary actually to be running under the Exim
39636 group. However, if admin users who are not root or the Exim user are to access
39637 the contents of files on the spool via the Exim monitor (which runs
39638 unprivileged), Exim must be built to allow group read access to its spool
39639 files.
39640
39641 By default, regular users are trusted to perform basic testing and
39642 introspection commands, as themselves.  This setting can be tightened by
39643 setting the &%commandline_checks_require_admin%& option.
39644 This affects most of the checking options,
39645 such as &%-be%& and anything else &%-b*%&.
39646
39647
39648 .section "Spool files" "SECID275"
39649 .cindex "spool directory" "files"
39650 Exim's spool directory and everything it contains is owned by the Exim user and
39651 set to the Exim group. The mode for spool files is defined in the
39652 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39653 any user who is a member of the Exim group can access these files.
39654
39655
39656
39657 .section "Use of argv[0]" "SECID276"
39658 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39659 of specific strings, Exim assumes certain options. For example, calling Exim
39660 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39661 to calling it with the option &%-bS%&. There are no security implications in
39662 this.
39663
39664
39665
39666 .section "Use of %f formatting" "SECID277"
39667 The only use made of &"%f"& by Exim is in formatting load average values. These
39668 are actually stored in integer variables as 1000 times the load average.
39669 Consequently, their range is limited and so therefore is the length of the
39670 converted output.
39671
39672
39673
39674 .section "Embedded Exim path" "SECID278"
39675 Exim uses its own path name, which is embedded in the code, only when it needs
39676 to re-exec in order to regain root privilege. Therefore, it is not root when it
39677 does so. If some bug allowed the path to get overwritten, it would lead to an
39678 arbitrary program's being run as exim, not as root.
39679
39680
39681
39682 .section "Dynamic module directory" "SECTdynmoddir"
39683 Any dynamically loadable modules must be installed into the directory
39684 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39685 loading it.
39686
39687
39688 .section "Use of sprintf()" "SECID279"
39689 .cindex "&[sprintf()]&"
39690 A large number of occurrences of &"sprintf"& in the code are actually calls to
39691 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39692 The intermediate formatting is done into a large fixed buffer by a function
39693 that runs through the format string itself, and checks the length of each
39694 conversion before performing it, thus preventing buffer overruns.
39695
39696 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39697 the output buffer is known to be sufficiently long to contain the converted
39698 string.
39699
39700
39701
39702 .section "Use of debug_printf() and log_write()" "SECID280"
39703 Arbitrary strings are passed to both these functions, but they do their
39704 formatting by calling the function &'string_vformat()'&, which runs through
39705 the format string itself, and checks the length of each conversion.
39706
39707
39708
39709 .section "Use of strcat() and strcpy()" "SECID281"
39710 These are used only in cases where the output buffer is known to be large
39711 enough to hold the result.
39712 .ecindex IIDsecurcon
39713
39714
39715
39716
39717 . ////////////////////////////////////////////////////////////////////////////
39718 . ////////////////////////////////////////////////////////////////////////////
39719
39720 .chapter "Format of spool files" "CHAPspool"
39721 .scindex IIDforspo1 "format" "spool files"
39722 .scindex IIDforspo2 "spool directory" "format of files"
39723 .scindex IIDforspo3 "spool files" "format of"
39724 .cindex "spool files" "editing"
39725 A message on Exim's queue consists of two files, whose names are the message id
39726 followed by -D and -H, respectively. The data portion of the message is kept in
39727 the -D file on its own. The message's envelope, status, and headers are all
39728 kept in the -H file, whose format is described in this chapter. Each of these
39729 two files contains the final component of its own name as its first line. This
39730 is insurance against disk crashes where the directory is lost but the files
39731 themselves are recoverable.
39732
39733 The file formats may be changed, or new formats added, at any release.
39734 Spool files are not intended as an interface to other programs
39735 and should not be used as such.
39736
39737 Some people are tempted into editing -D files in order to modify messages. You
39738 need to be extremely careful if you do this; it is not recommended and you are
39739 on your own if you do it. Here are some of the pitfalls:
39740
39741 .ilist
39742 You must ensure that Exim does not try to deliver the message while you are
39743 fiddling with it. The safest way is to take out a write lock on the -D file,
39744 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39745 place, the lock will be retained. If you write a new file and rename it, the
39746 lock will be lost at the instant of rename.
39747 .next
39748 .vindex "&$body_linecount$&"
39749 If you change the number of lines in the file, the value of
39750 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39751 cause incomplete transmission of messages or undeliverable messages.
39752 .next
39753 If the message is in MIME format, you must take care not to break it.
39754 .next
39755 If the message is cryptographically signed, any change will invalidate the
39756 signature.
39757 .endlist
39758 All in all, modifying -D files is fraught with danger.
39759
39760 Files whose names end with -J may also be seen in the &_input_& directory (or
39761 its subdirectories when &%split_spool_directory%& is set). These are journal
39762 files, used to record addresses to which the message has been delivered during
39763 the course of a delivery attempt. If there are still undelivered recipients at
39764 the end, the -H file is updated, and the -J file is deleted. If, however, there
39765 is some kind of crash (for example, a power outage) before this happens, the -J
39766 file remains in existence. When Exim next processes the message, it notices the
39767 -J file and uses it to update the -H file before starting the next delivery
39768 attempt.
39769
39770 Files whose names end with -K or .eml may also be seen in the spool.
39771 These are temporaries used for DKIM or malware processing, when that is used.
39772 They should be tidied up by normal operations; any old ones are probably
39773 relics of crashes and can be removed.
39774
39775 .section "Format of the -H file" "SECID282"
39776 .cindex "uid (user id)" "in spool file"
39777 .cindex "gid (group id)" "in spool file"
39778 The second line of the -H file contains the login name for the uid of the
39779 process that called Exim to read the message, followed by the numerical uid and
39780 gid. For a locally generated message, this is normally the user who sent the
39781 message. For a message received over TCP/IP via the daemon, it is
39782 normally the Exim user.
39783
39784 The third line of the file contains the address of the message's sender as
39785 transmitted in the envelope, contained in angle brackets. The sender address is
39786 empty for bounce messages. For incoming SMTP mail, the sender address is given
39787 in the MAIL command. For locally generated mail, the sender address is
39788 created by Exim from the login name of the current user and the configured
39789 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39790 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39791 &"<>"& or an address that matches &%untrusted_set_senders%&.
39792
39793 The fourth line contains two numbers. The first is the time that the message
39794 was received, in the conventional Unix form &-- the number of seconds since the
39795 start of the epoch. The second number is a count of the number of messages
39796 warning of delayed delivery that have been sent to the sender.
39797
39798 There follow a number of lines starting with a hyphen. These can appear in any
39799 order, and are omitted when not relevant:
39800
39801 .vlist
39802 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39803 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39804 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39805 recognized, to provide backward compatibility. In the old format, a line of
39806 this form is present for every ACL variable that is not empty. The number
39807 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39808 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39809 the data string for the variable. The string itself starts at the beginning of
39810 the next line, and is followed by a newline character. It may contain internal
39811 newlines.
39812
39813 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39814 A line of this form is present for every ACL connection variable that is
39815 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39816 The length is the length of the data string for the variable. The string itself
39817 starts at the beginning of the next line, and is followed by a newline
39818 character. It may contain internal newlines.
39819
39820 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39821 A line of this form is present for every ACL message variable that is defined.
39822 Note that there is a space between &%-aclm%& and the rest of the name. The
39823 length is the length of the data string for the variable. The string itself
39824 starts at the beginning of the next line, and is followed by a newline
39825 character. It may contain internal newlines.
39826
39827 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39828 This is present if, when the message was received over SMTP, the value of
39829 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39830
39831 .vitem &%-allow_unqualified_recipient%&
39832 This is present if unqualified recipient addresses are permitted in header
39833 lines (to stop such addresses from being qualified if rewriting occurs at
39834 transport time). Local messages that were input using &%-bnq%& and remote
39835 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39836
39837 .vitem &%-allow_unqualified_sender%&
39838 This is present if unqualified sender addresses are permitted in header lines
39839 (to stop such addresses from being qualified if rewriting occurs at transport
39840 time). Local messages that were input using &%-bnq%& and remote messages from
39841 hosts that match &%sender_unqualified_hosts%& set this flag.
39842
39843 .vitem "&%-auth_id%&&~<&'text'&>"
39844 The id information for a message received on an authenticated SMTP connection
39845 &-- the value of the &$authenticated_id$& variable.
39846
39847 .vitem "&%-auth_sender%&&~<&'address'&>"
39848 The address of an authenticated sender &-- the value of the
39849 &$authenticated_sender$& variable.
39850
39851 .vitem "&%-body_linecount%&&~<&'number'&>"
39852 This records the number of lines in the body of the message, and is
39853 present unless &%-spool_file_wireformat%& is.
39854
39855 .vitem "&%-body_zerocount%&&~<&'number'&>"
39856 This records the number of binary zero bytes in the body of the message, and is
39857 present if the number is greater than zero.
39858
39859 .vitem &%-deliver_firsttime%&
39860 This is written when a new message is first added to the spool. When the spool
39861 file is updated after a deferral, it is omitted.
39862
39863 .vitem "&%-frozen%&&~<&'time'&>"
39864 .cindex "frozen messages" "spool data"
39865 The message is frozen, and the freezing happened at <&'time'&>.
39866
39867 .vitem "&%-helo_name%&&~<&'text'&>"
39868 This records the host name as specified by a remote host in a HELO or EHLO
39869 command.
39870
39871 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39872 This records the IP address of the host from which the message was received and
39873 the remote port number that was used. It is omitted for locally generated
39874 messages.
39875
39876 .vitem "&%-host_auth%&&~<&'text'&>"
39877 If the message was received on an authenticated SMTP connection, this records
39878 the name of the authenticator &-- the value of the
39879 &$sender_host_authenticated$& variable.
39880
39881 .vitem &%-host_lookup_failed%&
39882 This is present if an attempt to look up the sending host's name from its IP
39883 address failed. It corresponds to the &$host_lookup_failed$& variable.
39884
39885 .vitem "&%-host_name%&&~<&'text'&>"
39886 .cindex "reverse DNS lookup"
39887 .cindex "DNS" "reverse lookup"
39888 This records the name of the remote host from which the message was received,
39889 if the host name was looked up from the IP address when the message was being
39890 received. It is not present if no reverse lookup was done.
39891
39892 .vitem "&%-ident%&&~<&'text'&>"
39893 For locally submitted messages, this records the login of the originating user,
39894 unless it was a trusted user and the &%-oMt%& option was used to specify an
39895 ident value. For messages received over TCP/IP, this records the ident string
39896 supplied by the remote host, if any.
39897
39898 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39899 This records the IP address of the local interface and the port number through
39900 which a message was received from a remote host. It is omitted for locally
39901 generated messages.
39902
39903 .vitem &%-local%&
39904 The message is from a local sender.
39905
39906 .vitem &%-localerror%&
39907 The message is a locally-generated bounce message.
39908
39909 .vitem "&%-local_scan%&&~<&'string'&>"
39910 This records the data string that was returned by the &[local_scan()]& function
39911 when the message was received &-- the value of the &$local_scan_data$&
39912 variable. It is omitted if no data was returned.
39913
39914 .vitem &%-manual_thaw%&
39915 The message was frozen but has been thawed manually, that is, by an explicit
39916 Exim command rather than via the auto-thaw process.
39917
39918 .vitem &%-N%&
39919 A testing delivery process was started using the &%-N%& option to suppress any
39920 actual deliveries, but delivery was deferred. At any further delivery attempts,
39921 &%-N%& is assumed.
39922
39923 .vitem &%-received_protocol%&
39924 This records the value of the &$received_protocol$& variable, which contains
39925 the name of the protocol by which the message was received.
39926
39927 .vitem &%-sender_set_untrusted%&
39928 The envelope sender of this message was set by an untrusted local caller (used
39929 to ensure that the caller is displayed in queue listings).
39930
39931 .vitem "&%-spam_score_int%&&~<&'number'&>"
39932 If a message was scanned by SpamAssassin, this is present. It records the value
39933 of &$spam_score_int$&.
39934
39935 .vitem &%-spool_file_wireformat%&
39936 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39937 rather than Unix-format.
39938 The line-ending is CRLF rather than newline.
39939 There is still, however, no leading-dot-stuffing.
39940
39941 .vitem &%-tls_certificate_verified%&
39942 A TLS certificate was received from the client that sent this message, and the
39943 certificate was verified by the server.
39944
39945 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39946 When the message was received over an encrypted connection, this records the
39947 name of the cipher suite that was used.
39948
39949 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39950 When the message was received over an encrypted connection, and a certificate
39951 was received from the client, this records the Distinguished Name from that
39952 certificate.
39953 .endlist
39954
39955 Any of the above may have an extra hyphen prepended, to indicate the the
39956 corresponding data is untrusted.
39957
39958 Following the options there is a list of those addresses to which the message
39959 is not to be delivered. This set of addresses is initialized from the command
39960 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39961 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39962 the address is added to this set. The addresses are kept internally as a
39963 balanced binary tree, and it is a representation of that tree which is written
39964 to the spool file. If an address is expanded via an alias or forward file, the
39965 original address is added to the tree when deliveries to all its child
39966 addresses are complete.
39967
39968 If the tree is empty, there is a single line in the spool file containing just
39969 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39970 Y or N, followed by an address. The address is the value for the node of the
39971 tree, and the letters indicate whether the node has a left branch and/or a
39972 right branch attached to it, respectively. If branches exist, they immediately
39973 follow. Here is an example of a three-node tree:
39974 .code
39975 YY darcy@austen.fict.example
39976 NN alice@wonderland.fict.example
39977 NN editor@thesaurus.ref.example
39978 .endd
39979 After the non-recipients tree, there is a list of the message's recipients.
39980 This is a simple list, preceded by a count. It includes all the original
39981 recipients of the message, including those to whom the message has already been
39982 delivered. In the simplest case, the list contains one address per line. For
39983 example:
39984 .code
39985 4
39986 editor@thesaurus.ref.example
39987 darcy@austen.fict.example
39988 rdo@foundation
39989 alice@wonderland.fict.example
39990 .endd
39991 However, when a child address has been added to the top-level addresses as a
39992 result of the use of the &%one_time%& option on a &(redirect)& router, each
39993 line is of the following form:
39994 .display
39995 <&'top-level address'&> <&'errors_to address'&> &&&
39996   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39997 .endd
39998 The 01 flag bit indicates the presence of the three other fields that follow
39999 the top-level address. Other bits may be used in future to support additional
40000 fields. The <&'parent number'&> is the offset in the recipients list of the
40001 original parent of the &"one time"& address. The first two fields are the
40002 envelope sender that is associated with this address and its length. If the
40003 length is zero, there is no special envelope sender (there are then two space
40004 characters in the line). A non-empty field can arise from a &(redirect)& router
40005 that has an &%errors_to%& setting.
40006
40007
40008 A blank line separates the envelope and status information from the headers
40009 which follow. A header may occupy several lines of the file, and to save effort
40010 when reading it in, each header is preceded by a number and an identifying
40011 character. The number is the number of characters in the header, including any
40012 embedded newlines and the terminating newline. The character is one of the
40013 following:
40014
40015 .table2 50pt
40016 .row <&'blank'&>         "header in which Exim has no special interest"
40017 .row &`B`&               "&'Bcc:'& header"
40018 .row &`C`&               "&'Cc:'& header"
40019 .row &`F`&               "&'From:'& header"
40020 .row &`I`&               "&'Message-id:'& header"
40021 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40022 .row &`R`&               "&'Reply-To:'& header"
40023 .row &`S`&               "&'Sender:'& header"
40024 .row &`T`&               "&'To:'& header"
40025 .row &`*`&               "replaced or deleted header"
40026 .endtable
40027
40028 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40029 purposes. They are not transmitted when the message is delivered. Here is a
40030 typical set of headers:
40031 .code
40032 111P Received: by hobbit.fict.example with local (Exim 4.00)
40033 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40034 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40035 038* X-rewrote-sender: bb@hobbit.fict.example
40036 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40037 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40038 099* To: alice@wonderland.fict.example, rdo@foundation,
40039 darcy@austen.fict.example, editor@thesaurus.ref.example
40040 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40041 darcy@austen.fict.example, editor@thesaurus.ref.example
40042 038  Date: Fri, 11 May 2001 10:28:59 +0100
40043 .endd
40044 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40045 &'To:'& header have been rewritten, the last one because routing expanded the
40046 unqualified domain &'foundation'&.
40047 .ecindex IIDforspo1
40048 .ecindex IIDforspo2
40049 .ecindex IIDforspo3
40050
40051 .section "Format of the -D file" "SECID282a"
40052 The data file is traditionally in Unix-standard format: lines are ended with
40053 an ASCII newline character.
40054 However, when the &%spool_wireformat%& main option is used some -D files
40055 can have an alternate format.
40056 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40057 The -D file lines (not including the first name-component line) are
40058 suitable for direct copying to the wire when transmitting using the
40059 ESMTP CHUNKING option, meaning lower processing overhead.
40060 Lines are terminated with an ASCII CRLF pair.
40061 There is no dot-stuffing (and no dot-termination).
40062
40063 . ////////////////////////////////////////////////////////////////////////////
40064 . ////////////////////////////////////////////////////////////////////////////
40065
40066 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
40067          "DKIM, SPF and DMARC Support"
40068
40069 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40070 .cindex "DKIM"
40071
40072 DKIM is a mechanism by which messages sent by some entity can be provably
40073 linked to a domain which that entity controls.  It permits reputation to
40074 be tracked on a per-domain basis, rather than merely upon source IP address.
40075 DKIM is documented in RFC 6376.
40076
40077 As DKIM relies on the message being unchanged in transit, messages handled
40078 by a mailing-list (which traditionally adds to the message) will not match
40079 any original DKIM signature.
40080
40081 DKIM support is compiled into Exim by default if TLS support is present.
40082 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40083
40084 Exim's DKIM implementation allows for
40085 .olist
40086 Signing outgoing messages: This function is implemented in the SMTP transport.
40087 It can co-exist with all other Exim features
40088 (including transport filters)
40089 except cutthrough delivery.
40090 .next
40091 Verifying signatures in incoming messages: This is implemented by an additional
40092 ACL (acl_smtp_dkim), which can be called several times per message, with
40093 different signature contexts.
40094 .endlist
40095
40096 In typical Exim style, the verification implementation does not include any
40097 default "policy". Instead it enables you to build your own policy using
40098 Exim's standard controls.
40099
40100 Please note that verification of DKIM signatures in incoming mail is turned
40101 on by default for logging (in the <= line) purposes.
40102
40103 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40104 When set, for each signature in incoming email,
40105 exim will log a line displaying the most important signature details, and the
40106 signature status. Here is an example (with line-breaks added for clarity):
40107 .code
40108 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40109     d=facebookmail.com s=q1-2009b
40110     c=relaxed/relaxed a=rsa-sha1
40111     i=@facebookmail.com t=1252484542 [verification succeeded]
40112 .endd
40113
40114 You might want to turn off DKIM verification processing entirely for internal
40115 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40116 control modifier. This should typically be done in the RCPT ACL, at points
40117 where you accept mail from relay sources (internal hosts or authenticated
40118 senders).
40119
40120
40121 .section "Signing outgoing messages" "SECDKIMSIGN"
40122 .cindex "DKIM" "signing"
40123
40124 For signing to be usable you must have published a DKIM record in DNS.
40125 Note that RFC 8301 (which does not cover EC keys) says:
40126 .code
40127 rsa-sha1 MUST NOT be used for signing or verifying.
40128
40129 Signers MUST use RSA keys of at least 1024 bits for all keys.
40130 Signers SHOULD use RSA keys of at least 2048 bits.
40131 .endd
40132
40133 Note also that the key content (the 'p=' field)
40134 in the DNS record is different between RSA and EC keys;
40135 for the former it is the base64 of the ASN.1 for the RSA public key
40136 (equivalent to the private-key .pem with the header/trailer stripped)
40137 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40138
40139 Signing is enabled by setting private options on the SMTP transport.
40140 These options take (expandable) strings as arguments.
40141
40142 .option dkim_domain smtp string list&!! unset
40143 The domain(s) you want to sign with.
40144 After expansion, this can be a list.
40145 Each element in turn,
40146 lowercased,
40147 is put into the &%$dkim_domain%& expansion variable
40148 while expanding the remaining signing options.
40149 If it is empty after expansion, DKIM signing is not done,
40150 and no error will result even if &%dkim_strict%& is set.
40151
40152 .option dkim_selector smtp string list&!! unset
40153 This sets the key selector string.
40154 After expansion, which can use &$dkim_domain$&, this can be a list.
40155 Each element in turn is put in the expansion
40156 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40157 option along with &%$dkim_domain%&.
40158 If the option is empty after expansion, DKIM signing is not done for this domain,
40159 and no error will result even if &%dkim_strict%& is set.
40160
40161 .option dkim_private_key smtp string&!! unset
40162 This sets the private key to use.
40163 You can use the &%$dkim_domain%& and
40164 &%$dkim_selector%& expansion variables to determine the private key to use.
40165 The result can either
40166 .ilist
40167 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40168 .next
40169 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40170 be a valid Ed25519 private key (same format as above)
40171 .next
40172 start with a slash, in which case it is treated as a file that contains
40173 the private key
40174 .next
40175 be "0", "false" or the empty string, in which case the message will not
40176 be signed. This case will not result in an error, even if &%dkim_strict%&
40177 is set.
40178 .endlist
40179
40180 To generate keys under OpenSSL:
40181 .code
40182 openssl genrsa -out dkim_rsa.private 2048
40183 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40184 .endd
40185 The result file from the first command should be retained, and
40186 this option set to use it.
40187 Take the base-64 lines from the output of the second command, concatenated,
40188 for the DNS TXT record.
40189 See section 3.6 of RFC6376 for the record specification.
40190
40191 Under GnuTLS:
40192 .code
40193 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40194 certtool --load-privkey=dkim_rsa.private --pubkey-info
40195 .endd
40196
40197 Note that RFC 8301 says:
40198 .code
40199 Signers MUST use RSA keys of at least 1024 bits for all keys.
40200 Signers SHOULD use RSA keys of at least 2048 bits.
40201 .endd
40202
40203 EC keys for DKIM are defined by RFC 8463.
40204 They are considerably smaller than RSA keys for equivalent protection.
40205 As they are a recent development, users should consider dual-signing
40206 (by setting a list of selectors, and an expansion for this option)
40207 for some transition period.
40208 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40209 for EC keys.
40210
40211 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40212 .code
40213 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40214 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40215 .endd
40216
40217 To produce the required public key value for a DNS record:
40218 .code
40219 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40220 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40221 .endd
40222
40223 Exim also supports an alternate format
40224 of Ed25519 keys in DNS which was a candidate during development
40225 of the standard, but not adopted.
40226 A future release will probably drop that support.
40227
40228 .option dkim_hash smtp string&!! sha256
40229 Can be set to any one of the supported hash methods, which are:
40230 .ilist
40231 &`sha1`& &-- should not be used, is old and insecure
40232 .next
40233 &`sha256`& &-- the default
40234 .next
40235 &`sha512`& &-- possibly more secure but less well supported
40236 .endlist
40237
40238 Note that RFC 8301 says:
40239 .code
40240 rsa-sha1 MUST NOT be used for signing or verifying.
40241 .endd
40242
40243 .option dkim_identity smtp string&!! unset
40244 If set after expansion, the value is used to set an "i=" tag in
40245 the signing header.  The DKIM standards restrict the permissible
40246 syntax of this optional tag to a mail address, with possibly-empty
40247 local part, an @, and a domain identical to or subdomain of the "d="
40248 tag value.  Note that Exim does not check the value.
40249
40250 .option dkim_canon smtp string&!! unset
40251 This option sets the canonicalization method used when signing a message.
40252 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40253 The option defaults to "relaxed" when unset. Note: the current implementation
40254 only supports signing with the same canonicalization method for both headers and body.
40255
40256 .option dkim_strict smtp string&!! unset
40257 This  option  defines  how  Exim  behaves  when  signing a message that
40258 should be signed fails for some reason.  When the expansion evaluates to
40259 either "1" or "true", Exim will defer. Otherwise Exim will send the message
40260 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40261 variables here.
40262
40263 .option dkim_sign_headers smtp string&!! "see below"
40264 If set, this option must expand to a colon-separated
40265 list of header names.
40266 Headers with these names, or the absence or such a header, will be included
40267 in the message signature.
40268 When unspecified, the header names listed in RFC4871 will be used,
40269 whether or not each header is present in the message.
40270 The default list is available for the expansion in the macro
40271 "_DKIM_SIGN_HEADERS".
40272
40273 If a name is repeated, multiple headers by that name (or the absence thereof)
40274 will be signed.  The textually later headers in the headers part of the
40275 message are signed first, if there are multiples.
40276
40277 A name can be prefixed with either an '=' or a '+' character.
40278 If an '=' prefix is used, all headers that are present with this name
40279 will be signed.
40280 If a '+' prefix if used, all headers that are present with this name
40281 will be signed, and one signature added for a missing header with the
40282 name will be appended.
40283
40284 .option dkim_timestamps smtp integer&!! unset
40285 This option controls the inclusion of timestamp information in the signature.
40286 If not set, no such information will be included.
40287 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40288 for the expiry tag
40289 (eg. 1209600 for two weeks);
40290 both creation (t=) and expiry (x=) tags will be included.
40291
40292 RFC 6376 lists these tags as RECOMMENDED.
40293
40294
40295 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40296 .cindex "DKIM" "verification"
40297
40298 Verification of DKIM signatures in SMTP incoming email is done for all
40299 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40300 .cindex DKIM "selecting signature algorithms"
40301 Individual classes of signature algorithm can be ignored by changing
40302 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40303 The &%dkim_verify_minimal%& option can be set to cease verification
40304 processing for a message once the first passing signature is found.
40305
40306 .cindex authentication "expansion item"
40307 Performing verification sets up information used by the
40308 &%authresults%& expansion item.
40309
40310 For most purposes the default option settings suffice and the remainder
40311 of this section can be ignored.
40312
40313 The results of verification are made available to the
40314 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40315 A missing ACL definition defaults to accept.
40316 By default, the ACL is called once for each
40317 syntactically(!) correct signature in the incoming message.
40318 If any ACL call does not accept, the message is not accepted.
40319 If a cutthrough delivery was in progress for the message, that is
40320 summarily dropped (having wasted the transmission effort).
40321
40322 To evaluate the verification result in the ACL
40323 a large number of expansion variables
40324 containing the signature status and its details are set up during the
40325 runtime of the ACL.
40326
40327 Calling the ACL only for existing signatures is not sufficient to build
40328 more advanced policies. For that reason, the main option
40329 &%dkim_verify_signers%&, and an expansion variable
40330 &%$dkim_signers%& exist.
40331
40332 The main option &%dkim_verify_signers%& can be set to a colon-separated
40333 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40334 called. It is expanded when the message has been received. At this point,
40335 the expansion variable &%$dkim_signers%& already contains a colon-separated
40336 list of signer domains and identities for the message. When
40337 &%dkim_verify_signers%& is not specified in the main configuration,
40338 it defaults as:
40339 .code
40340 dkim_verify_signers = $dkim_signers
40341 .endd
40342 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40343 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40344 call the ACL for known domains or identities. This would be achieved as follows:
40345 .code
40346 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40347 .endd
40348 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40349 and "ebay.com", plus all domains and identities that have signatures in the message.
40350 You can also be more creative in constructing your policy. For example:
40351 .code
40352 dkim_verify_signers = $sender_address_domain:$dkim_signers
40353 .endd
40354
40355 If a domain or identity is listed several times in the (expanded) value of
40356 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40357
40358 Note that if the option is set using untrustworthy data
40359 (such as the From: header)
40360 care should be taken to force lowercase for domains
40361 and for the domain part if identities.
40362 The default setting can be regarded as trustworthy in this respect.
40363
40364 If multiple signatures match a domain (or identity), the ACL is called once
40365 for each matching signature.
40366
40367
40368 Inside the DKIM ACL, the following expansion variables are
40369 available (from most to least important):
40370
40371
40372 .vlist
40373 .vitem &%$dkim_cur_signer%&
40374 The signer that is being evaluated in this ACL run. This can be a domain or
40375 an identity. This is one of the list items from the expanded main option
40376 &%dkim_verify_signers%& (see above).
40377
40378 .vitem &%$dkim_verify_status%&
40379 Within the DKIM ACL,
40380 a string describing the general status of the signature. One of
40381 .ilist
40382 &%none%&: There is no signature in the message for the current domain or
40383 identity (as reflected by &%$dkim_cur_signer%&).
40384 .next
40385 &%invalid%&: The signature could not be verified due to a processing error.
40386 More detail is available in &%$dkim_verify_reason%&.
40387 .next
40388 &%fail%&: Verification of the signature failed.  More detail is
40389 available in &%$dkim_verify_reason%&.
40390 .next
40391 &%pass%&: The signature passed verification. It is valid.
40392 .endlist
40393
40394 This variable can be overwritten using an ACL 'set' modifier.
40395 This might, for instance, be done to enforce a policy restriction on
40396 hash-method or key-size:
40397 .code
40398   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40399        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40400        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40401                                   {< {$dkim_key_length}{1024}}}}
40402        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40403        set dkim_verify_status = fail
40404        set dkim_verify_reason = hash too weak or key too short
40405 .endd
40406
40407 So long as a DKIM ACL is defined (it need do no more than accept),
40408 after all the DKIM ACL runs have completed, the value becomes a
40409 colon-separated list of the values after each run.
40410 This is maintained for the mime, prdr and data ACLs.
40411
40412 .vitem &%$dkim_verify_reason%&
40413 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40414 "fail" or "invalid". One of
40415 .ilist
40416 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40417 key for the domain could not be retrieved. This may be a temporary problem.
40418 .next
40419 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40420 record for the domain is syntactically invalid.
40421 .next
40422 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40423 body hash does not match the one specified in the signature header. This
40424 means that the message body was modified in transit.
40425 .next
40426 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40427 could not be verified. This may mean that headers were modified,
40428 re-written or otherwise changed in a way which is incompatible with
40429 DKIM verification. It may of course also mean that the signature is forged.
40430 .endlist
40431
40432 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40433
40434 .vitem &%$dkim_domain%&
40435 The signing domain. IMPORTANT: This variable is only populated if there is
40436 an actual signature in the message for the current domain or identity (as
40437 reflected by &%$dkim_cur_signer%&).
40438
40439 .vitem &%$dkim_identity%&
40440 The signing identity, if present. IMPORTANT: This variable is only populated
40441 if there is an actual signature in the message for the current domain or
40442 identity (as reflected by &%$dkim_cur_signer%&).
40443
40444 .vitem &%$dkim_selector%&
40445 The key record selector string.
40446
40447 .vitem &%$dkim_algo%&
40448 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40449 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40450 may also be 'ed25519-sha256'.
40451 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40452 for EC keys.
40453
40454 Note that RFC 8301 says:
40455 .code
40456 rsa-sha1 MUST NOT be used for signing or verifying.
40457
40458 DKIM signatures identified as having been signed with historic
40459 algorithms (currently, rsa-sha1) have permanently failed evaluation
40460 .endd
40461
40462 To enforce this you must either have a DKIM ACL which checks this variable
40463 and overwrites the &$dkim_verify_status$& variable as discussed above,
40464 or have set the main option &%dkim_verify_hashes%& to exclude
40465 processing of such signatures.
40466
40467 .vitem &%$dkim_canon_body%&
40468 The body canonicalization method. One of 'relaxed' or 'simple'.
40469
40470 .vitem &%$dkim_canon_headers%&
40471 The header canonicalization method. One of 'relaxed' or 'simple'.
40472
40473 .vitem &%$dkim_copiedheaders%&
40474 A transcript of headers and their values which are included in the signature
40475 (copied from the 'z=' tag of the signature).
40476 Note that RFC6376 requires that verification fail if the From: header is
40477 not included in the signature.  Exim does not enforce this; sites wishing
40478 strict enforcement should code the check explicitly.
40479
40480 .vitem &%$dkim_bodylength%&
40481 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40482 limit was set by the signer, "9999999999999" is returned. This makes sure
40483 that this variable always expands to an integer value.
40484 &*Note:*& The presence of the signature tag specifying a signing body length
40485 is one possible route to spoofing of valid DKIM signatures.
40486 A paranoid implementation might wish to regard signature where this variable
40487 shows less than the "no limit" return as being invalid.
40488
40489 .vitem &%$dkim_created%&
40490 UNIX timestamp reflecting the date and time when the signature was created.
40491 When this was not specified by the signer, "0" is returned.
40492
40493 .vitem &%$dkim_expires%&
40494 UNIX timestamp reflecting the date and time when the signer wants the
40495 signature to be treated as "expired". When this was not specified by the
40496 signer, "9999999999999" is returned. This makes it possible to do useful
40497 integer size comparisons against this value.
40498 Note that Exim does not check this value.
40499
40500 .vitem &%$dkim_headernames%&
40501 A colon-separated list of names of headers included in the signature.
40502
40503 .vitem &%$dkim_key_testing%&
40504 "1" if the key record has the "testing" flag set, "0" if not.
40505
40506 .vitem &%$dkim_key_nosubdomains%&
40507 "1" if the key record forbids subdomaining, "0" otherwise.
40508
40509 .vitem &%$dkim_key_srvtype%&
40510 Service type (tag s=) from the key record. Defaults to "*" if not specified
40511 in the key record.
40512
40513 .vitem &%$dkim_key_granularity%&
40514 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40515 in the key record.
40516
40517 .vitem &%$dkim_key_notes%&
40518 Notes from the key record (tag n=).
40519
40520 .vitem &%$dkim_key_length%&
40521 Number of bits in the key.
40522
40523 Note that RFC 8301 says:
40524 .code
40525 Verifiers MUST NOT consider signatures using RSA keys of
40526 less than 1024 bits as valid signatures.
40527 .endd
40528
40529 To enforce this you must have a DKIM ACL which checks this variable
40530 and overwrites the &$dkim_verify_status$& variable as discussed above.
40531 As EC keys are much smaller, the check should only do this for RSA keys.
40532
40533 .endlist
40534
40535 In addition, two ACL conditions are provided:
40536
40537 .vlist
40538 .vitem &%dkim_signers%&
40539 ACL condition that checks a colon-separated list of domains or identities
40540 for a match against the domain or identity that the ACL is currently verifying
40541 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40542 verb to a group of domains or identities. For example:
40543
40544 .code
40545 # Warn when Mail purportedly from GMail has no gmail signature
40546 warn log_message = GMail sender without gmail.com DKIM signature
40547      sender_domains = gmail.com
40548      dkim_signers = gmail.com
40549      dkim_status = none
40550 .endd
40551
40552 Note that the above does not check for a total lack of DKIM signing;
40553 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40554
40555 .vitem &%dkim_status%&
40556 ACL condition that checks a colon-separated list of possible DKIM verification
40557 results against the actual result of verification. This is typically used
40558 to restrict an ACL verb to a list of verification outcomes, for example:
40559
40560 .code
40561 deny message = Mail from Paypal with invalid/missing signature
40562      sender_domains = paypal.com:paypal.de
40563      dkim_signers = paypal.com:paypal.de
40564      dkim_status = none:invalid:fail
40565 .endd
40566
40567 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40568 see the documentation of the &%$dkim_verify_status%& expansion variable above
40569 for more information of what they mean.
40570 .endlist
40571
40572
40573
40574
40575 .section "SPF (Sender Policy Framework)" SECSPF
40576 .cindex SPF verification
40577
40578 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40579 messages with its domain in the envelope from, documented by RFC 7208.
40580 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40581 the &url(http://openspf.org).
40582 . --- 2019-10-28: still not https, open-spf.org is told to be a
40583 . --- web-archive copy of the now dead openspf.org site
40584 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40585 . --- discussion.
40586
40587 Messages sent by a system not authorised will fail checking of such assertions.
40588 This includes retransmissions done by traditional forwarders.
40589
40590 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40591 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40592 &url(https://www.libspf2.org/).
40593 There is no Exim involvement in the transmission of messages;
40594 publishing certain DNS records is all that is required.
40595
40596 For verification, an ACL condition and an expansion lookup are provided.
40597 .cindex authentication "expansion item"
40598 Performing verification sets up information used by the
40599 &%authresults%& expansion item.
40600
40601
40602 .cindex SPF "ACL condition"
40603 .cindex ACL "spf condition"
40604 The ACL condition "spf" can be used at or after the MAIL ACL.
40605 It takes as an argument a list of strings giving the outcome of the SPF check,
40606 and will succeed for any matching outcome.
40607 Valid strings are:
40608 .vlist
40609 .vitem &%pass%&
40610 The SPF check passed, the sending host is positively verified by SPF.
40611
40612 .vitem &%fail%&
40613 The SPF check failed, the sending host is NOT allowed to send mail for the
40614 domain in the envelope-from address.
40615
40616 .vitem &%softfail%&
40617 The SPF check failed, but the queried domain can't absolutely confirm that this
40618 is a forgery.
40619
40620 .vitem &%none%&
40621 The queried domain does not publish SPF records.
40622
40623 .vitem &%neutral%&
40624 The SPF check returned a "neutral" state.  This means the queried domain has
40625 published a SPF record, but wants to allow outside servers to send mail under
40626 its domain as well.  This should be treated like "none".
40627
40628 .vitem &%permerror%&
40629 This indicates a syntax error in the SPF record of the queried domain.
40630 You may deny messages when this occurs.
40631
40632 .vitem &%temperror%&
40633 This indicates a temporary error during all processing, including Exim's
40634 SPF processing.  You may defer messages when this occurs.
40635 .endlist
40636
40637 You can prefix each string with an exclamation mark to  invert
40638 its meaning,  for example  "!fail" will  match all  results but
40639 "fail".  The  string  list is  evaluated  left-to-right,  in a
40640 short-circuit fashion.
40641
40642 Example:
40643 .code
40644 deny spf = fail
40645      message = $sender_host_address is not allowed to send mail from \
40646                ${if def:sender_address_domain \
40647                     {$sender_address_domain}{$sender_helo_name}}.  \
40648                Please see http://www.open-spf.org/Why?scope=\
40649                ${if def:sender_address_domain {mfrom}{helo}};\
40650                identity=${if def:sender_address_domain \
40651                              {$sender_address}{$sender_helo_name}};\
40652                ip=$sender_host_address
40653 .endd
40654
40655 When the spf condition has run, it sets up several expansion
40656 variables:
40657
40658 .cindex SPF "verification variables"
40659 .vlist
40660 .vitem &$spf_header_comment$&
40661 .vindex &$spf_header_comment$&
40662   This contains a human-readable string describing the outcome
40663   of the SPF check. You can add it to a custom header or use
40664   it for logging purposes.
40665
40666 .vitem &$spf_received$&
40667 .vindex &$spf_received$&
40668   This contains a complete Received-SPF: header that can be
40669   added to the message. Please note that according to the SPF
40670   draft, this header must be added at the top of the header
40671   list. Please see section 10 on how you can do this.
40672
40673   Note: in case of "Best-guess" (see below), the convention is
40674   to put this string in a header called X-SPF-Guess: instead.
40675
40676 .vitem &$spf_result$&
40677 .vindex &$spf_result$&
40678   This contains the outcome of the SPF check in string form,
40679   one of pass, fail, softfail, none, neutral, permerror or
40680   temperror.
40681
40682 .vitem &$spf_result_guessed$&
40683 .vindex &$spf_result_guessed$&
40684   This boolean is true only if a best-guess operation was used
40685   and required in order to obtain a result.
40686
40687 .vitem &$spf_smtp_comment$&
40688 .vindex &$spf_smtp_comment$&
40689   This contains a string that can be used in a SMTP response
40690   to the calling party. Useful for "fail".
40691 .endlist
40692
40693
40694 .cindex SPF "ACL condition"
40695 .cindex ACL "spf_guess condition"
40696 .cindex SPF "best guess"
40697 In addition to SPF, you can also perform checks for so-called
40698 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40699 SPF, but it is supported by the same framework that enables SPF
40700 capability.
40701 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
40702 for a description of what it means.
40703 . --- 2019-10-28: still not https:
40704
40705 To access this feature, simply use the spf_guess condition in place
40706 of the spf one.  For example:
40707
40708 .code
40709 deny spf_guess = fail
40710      message = $sender_host_address doesn't look trustworthy to me
40711 .endd
40712
40713 In case you decide to reject messages based on this check, you
40714 should note that although it uses the same framework, "Best-guess"
40715 is not SPF, and therefore you should not mention SPF at all in your
40716 reject message.
40717
40718 When the spf_guess condition has run, it sets up the same expansion
40719 variables as when spf condition is run, described above.
40720
40721 Additionally, since Best-guess is not standardized, you may redefine
40722 what "Best-guess" means to you by redefining the main configuration
40723 &%spf_guess%& option.
40724 For example, the following:
40725
40726 .code
40727 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40728 .endd
40729
40730 would relax host matching rules to a broader network range.
40731
40732
40733 .cindex SPF "lookup expansion"
40734 .cindex lookup spf
40735 A lookup expansion is also available. It takes an email
40736 address as the key and an IP address
40737 (v4 or v6)
40738 as the database:
40739
40740 .code
40741   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40742 .endd
40743
40744 The lookup will return the same result strings as can appear in
40745 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40746
40747
40748
40749
40750
40751 .section DMARC SECDMARC
40752 .cindex DMARC verification
40753
40754 DMARC combines feedback from SPF, DKIM, and header From: in order
40755 to attempt to provide better indicators of the authenticity of an
40756 email.  This document does not explain the fundamentals; you
40757 should read and understand how it works by visiting the website at
40758 &url(http://www.dmarc.org/).
40759
40760 If Exim is built with DMARC support,
40761 the libopendmarc library is used.
40762
40763 For building Exim yourself, obtain the library from
40764 &url(http://sourceforge.net/projects/opendmarc/)
40765 to obtain a copy, or find it in your favorite package
40766 repository.  You will need to attend to the local/Makefile feature
40767 SUPPORT_DMARC and the associated LDFLAGS addition.
40768 This description assumes
40769 that headers will be in /usr/local/include, and that the libraries
40770 are in /usr/local/lib.
40771
40772 . subsection
40773
40774 There are three main-configuration options:
40775 .cindex DMARC "configuration options"
40776
40777 The &%dmarc_tld_file%& option
40778 .oindex &%dmarc_tld_file%&
40779 defines the location of a text file of valid
40780 top level domains the opendmarc library uses
40781 during domain parsing. Maintained by Mozilla,
40782 the most current version can be downloaded
40783 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
40784 See also the util/renew-opendmarc-tlds.sh script.
40785 .new
40786 The default for the option is unset.
40787 If not set, DMARC processing is disabled.
40788 .wen
40789
40790
40791 The &%dmarc_history_file%& option, if set
40792 .oindex &%dmarc_history_file%&
40793 defines the location of a file to log results
40794 of dmarc verification on inbound emails. The
40795 contents are importable by the opendmarc tools
40796 which will manage the data, send out DMARC
40797 reports, and expire the data. Make sure the
40798 directory of this file is writable by the user
40799 exim runs as.
40800 The default is unset.
40801
40802 The &%dmarc_forensic_sender%& option
40803 .oindex &%dmarc_forensic_sender%&
40804 defines an alternate email address to use when sending a
40805 forensic report detailing alignment failures
40806 if a sender domain's dmarc record specifies it
40807 and you have configured Exim to send them.
40808 If set, this is expanded and used for the
40809 From: header line; the address is extracted
40810 from it and used for the envelope from.
40811 If not set (the default), the From: header is expanded from
40812 the dsn_from option, and <> is used for the
40813 envelope from.
40814
40815 . I wish we had subsections...
40816
40817 .cindex DMARC controls
40818 By default, the DMARC processing will run for any remote,
40819 non-authenticated user.  It makes sense to only verify DMARC
40820 status of messages coming from remote, untrusted sources.  You can
40821 use standard conditions such as hosts, senders, etc, to decide that
40822 DMARC verification should *not* be performed for them and disable
40823 DMARC with an ACL control modifier:
40824 .code
40825   control = dmarc_disable_verify
40826 .endd
40827 A DMARC record can also specify a "forensic address", which gives
40828 exim an email address to submit reports about failed alignment.
40829 Exim does not do this by default because in certain conditions it
40830 results in unintended information leakage (what lists a user might
40831 be subscribed to, etc).  You must configure exim to submit forensic
40832 reports to the owner of the domain.  If the DMARC record contains a
40833 forensic address and you specify the control statement below, then
40834 exim will send these forensic emails.  It is also advised that you
40835 configure a &%dmarc_forensic_sender%& because the default sender address
40836 construction might be inadequate.
40837 .code
40838   control = dmarc_enable_forensic
40839 .endd
40840 (AGAIN: You can choose not to send these forensic reports by simply
40841 not putting the dmarc_enable_forensic control line at any point in
40842 your exim config.  If you don't tell exim to send them, it will not
40843 send them.)
40844
40845 There are no options to either control.  Both must appear before
40846 the DATA acl.
40847
40848 . subsection
40849
40850 DMARC checks cam be run on incoming SMTP  messages by using the
40851 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
40852 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
40853 condition.  Putting this condition in the ACLs is required in order
40854 for a DMARC check to actually occur.  All of the variables are set
40855 up before the DATA ACL, but there is no actual DMARC check that
40856 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
40857
40858 The &"dmarc_status"& condition takes a list of strings on its
40859 right-hand side.  These strings describe recommended action based
40860 on the DMARC check.  To understand what the policy recommendations
40861 mean, refer to the DMARC website above.  Valid strings are:
40862 .display
40863 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40864 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40865 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40866 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40867 &'norecord    '& No policy section in the DMARC record for this sender domain.
40868 &'nofrom      '& Unable to determine the domain of the sender.
40869 &'temperror   '& Library error or dns error.
40870 &'off         '& The DMARC check was disabled for this email.
40871 .endd
40872 You can prefix each string with an exclamation mark to invert its
40873 meaning, for example "!accept" will match all results but
40874 "accept".  The string list is evaluated left-to-right in a
40875 short-circuit fashion.  When a string matches the outcome of the
40876 DMARC check, the condition succeeds.  If none of the listed
40877 strings matches the outcome of the DMARC check, the condition
40878 fails.
40879
40880 Of course, you can also use any other lookup method that Exim
40881 supports, including LDAP, Postgres, MySQL, etc, as long as the
40882 result is a list of colon-separated strings.
40883
40884 Performing the check sets up information used by the
40885 &%authresults%& expansion item.
40886
40887 Several expansion variables are set before the DATA ACL is
40888 processed, and you can use them in this ACL.  The following
40889 expansion variables are available:
40890
40891 .vlist
40892 .vitem &$dmarc_status$&
40893 .vindex &$dmarc_status$&
40894 .cindex DMARC result
40895 A one word status indicating what the DMARC library
40896 thinks of the email.  It is a combination of the results of
40897 DMARC record lookup and the SPF/DKIM/DMARC processing results
40898 (if a DMARC record was found).  The actual policy declared
40899 in the DMARC record is in a separate expansion variable.
40900
40901 .vitem &$dmarc_status_text$&
40902 .vindex &$dmarc_status_text$&
40903 Slightly longer, human readable status.
40904
40905 .vitem &$dmarc_used_domain$&
40906 .vindex &$dmarc_used_domain$&
40907 The domain which DMARC used to look up the DMARC policy record.
40908
40909 .vitem &$dmarc_domain_policy$&
40910 .vindex &$dmarc_domain_policy$&
40911 The policy declared in the DMARC record.  Valid values
40912 are "none", "reject" and "quarantine".  It is blank when there
40913 is any error, including no DMARC record.
40914 .endlist
40915
40916 . subsection
40917
40918 By default, Exim's DMARC configuration is intended to be
40919 non-intrusive and conservative.  To facilitate this, Exim will not
40920 create any type of logging files without explicit configuration by
40921 you, the admin.  Nor will Exim send out any emails/reports about
40922 DMARC issues without explicit configuration by you, the admin (other
40923 than typical bounce messages that may come about due to ACL
40924 processing or failure delivery issues).
40925
40926 In order to log statistics suitable to be imported by the opendmarc
40927 tools, you need to:
40928 .ilist
40929 Configure the global option &%dmarc_history_file%&
40930 .next
40931 Configure cron jobs to call the appropriate opendmarc history
40932 import scripts and truncating the dmarc_history_file
40933 .endlist
40934
40935 In order to send forensic reports, you need to:
40936 .ilist
40937 Configure the global option &%dmarc_forensic_sender%&
40938 .next
40939 Configure, somewhere before the DATA ACL, the control option to
40940 enable sending DMARC forensic reports
40941 .endlist
40942
40943 . subsection
40944
40945 Example usage:
40946 .code
40947 (RCPT ACL)
40948   warn    domains        = +local_domains
40949           hosts          = +local_hosts
40950           control        = dmarc_disable_verify
40951
40952   warn    !domains       = +screwed_up_dmarc_records
40953           control        = dmarc_enable_forensic
40954
40955   warn    condition      = (lookup if destined to mailing list)
40956           set acl_m_mailing_list = 1
40957
40958 (DATA ACL)
40959   warn    dmarc_status   = accept : none : off
40960           !authenticated = *
40961           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40962
40963   warn    dmarc_status   = !accept
40964           !authenticated = *
40965           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40966
40967   warn    dmarc_status   = quarantine
40968           !authenticated = *
40969           set $acl_m_quarantine = 1
40970           # Do something in a transport with this flag variable
40971
40972   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40973           condition      = ${if eq{$acl_m_mailing_list}{1}}
40974           message        = Messages from $dmarc_used_domain break mailing lists
40975
40976   deny    dmarc_status   = reject
40977           !authenticated = *
40978           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40979
40980   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40981 .endd
40982
40983
40984
40985
40986
40987 . ////////////////////////////////////////////////////////////////////////////
40988 . ////////////////////////////////////////////////////////////////////////////
40989
40990 .chapter "Proxies" "CHAPproxies" &&&
40991          "Proxy support"
40992 .cindex "proxy support"
40993 .cindex "proxy" "access via"
40994
40995 A proxy is an intermediate system through which communication is passed.
40996 Proxies may provide a security, availability or load-distribution function.
40997
40998
40999 .section "Inbound proxies" SECTproxyInbound
41000 .cindex proxy inbound
41001 .cindex proxy "server side"
41002 .cindex proxy "Proxy protocol"
41003 .cindex "Proxy protocol" proxy
41004
41005 Exim has support for receiving inbound SMTP connections via a proxy
41006 that uses &"Proxy Protocol"& to speak to it.
41007 To include this support, include &"SUPPORT_PROXY=yes"&
41008 in Local/Makefile.
41009
41010 It was built on the HAProxy specification, found at
41011 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41012
41013 The purpose of this facility is so that an application load balancer,
41014 such as HAProxy, can sit in front of several Exim servers
41015 to distribute load.
41016 Exim uses the local protocol communication with the proxy to obtain
41017 the remote SMTP system IP address and port information.
41018 There is no logging if a host passes or
41019 fails Proxy Protocol negotiation, but it can easily be determined and
41020 recorded in an ACL (example is below).
41021
41022 Use of a proxy is enabled by setting the &%hosts_proxy%&
41023 main configuration option to a hostlist; connections from these
41024 hosts will use Proxy Protocol.
41025 Exim supports both version 1 and version 2 of the Proxy Protocol and
41026 automatically determines which version is in use.
41027
41028 The Proxy Protocol header is the first data received on a TCP connection
41029 and is inserted before any TLS-on-connect handshake from the client; Exim
41030 negotiates TLS between Exim-as-server and the remote client, not between
41031 Exim and the proxy server.
41032
41033 The following expansion variables are usable
41034 (&"internal"& and &"external"& here refer to the interfaces
41035 of the proxy):
41036 .display
41037 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41038 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41039 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41040 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41041 &'proxy_session            '& boolean: SMTP connection via proxy
41042 .endd
41043 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41044 there was a protocol error.
41045 The variables &$sender_host_address$& and &$sender_host_port$&
41046 will have values for the actual client system, not the proxy.
41047
41048 Since the real connections are all coming from the proxy, and the
41049 per host connection tracking is done before Proxy Protocol is
41050 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41051 handle all of the parallel volume you expect per inbound proxy.
41052 With the option set so high, you lose the ability
41053 to protect your server from many connections from one IP.
41054 In order to prevent your server from overload, you
41055 need to add a per connection ratelimit to your connect ACL.
41056 A possible solution is:
41057 .display
41058   # Set max number of connections per host
41059   LIMIT   = 5
41060   # Or do some kind of IP lookup in a flat file or database
41061   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41062
41063   defer   message        = Too many connections from this IP right now
41064           ratelimit      = LIMIT / 5s / per_conn / strict
41065 .endd
41066
41067
41068
41069 .section "Outbound proxies" SECTproxySOCKS
41070 .cindex proxy outbound
41071 .cindex proxy "client side"
41072 .cindex proxy SOCKS
41073 .cindex SOCKS proxy
41074 Exim has support for sending outbound SMTP via a proxy
41075 using a protocol called SOCKS5 (defined by RFC1928).
41076 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41077 Local/Makefile.
41078
41079 Use of a proxy is enabled by setting the &%socks_proxy%& option
41080 on an smtp transport.
41081 The option value is expanded and should then be a list
41082 (colon-separated by default) of proxy specifiers.
41083 Each proxy specifier is a list
41084 (space-separated by default) where the initial element
41085 is an IP address and any subsequent elements are options.
41086
41087 Options are a string <name>=<value>.
41088 The list of options is in the following table:
41089 .display
41090 &'auth   '& authentication method
41091 &'name   '& authentication username
41092 &'pass   '& authentication password
41093 &'port   '& tcp port
41094 &'tmo    '& connection timeout
41095 &'pri    '& priority
41096 &'weight '& selection bias
41097 .endd
41098
41099 More details on each of these options follows:
41100
41101 .ilist
41102 .cindex authentication "to proxy"
41103 .cindex proxy authentication
41104 &%auth%&: Either &"none"& (default) or &"name"&.
41105 Using &"name"& selects username/password authentication per RFC 1929
41106 for access to the proxy.
41107 Default is &"none"&.
41108 .next
41109 &%name%&: sets the username for the &"name"& authentication method.
41110 Default is empty.
41111 .next
41112 &%pass%&: sets the password for the &"name"& authentication method.
41113 Default is empty.
41114 .next
41115 &%port%&: the TCP port number to use for the connection to the proxy.
41116 Default is 1080.
41117 .next
41118 &%tmo%&: sets a connection timeout in seconds for this proxy.
41119 Default is 5.
41120 .next
41121 &%pri%&: specifies a priority for the proxy within the list,
41122 higher values being tried first.
41123 The default priority is 1.
41124 .next
41125 &%weight%&: specifies a selection bias.
41126 Within a priority set servers are queried in a random fashion,
41127 weighted by this value.
41128 The default value for selection bias is 1.
41129 .endlist
41130
41131 Proxies from the list are tried according to their priority
41132 and weight settings until one responds.  The timeout for the
41133 overall connection applies to the set of proxied attempts.
41134
41135 .section Logging SECTproxyLog
41136 To log the (local) IP of a proxy in the incoming or delivery logline,
41137 add &"+proxy"& to the &%log_selector%& option.
41138 This will add a component tagged with &"PRX="& to the line.
41139
41140 . ////////////////////////////////////////////////////////////////////////////
41141 . ////////////////////////////////////////////////////////////////////////////
41142
41143 .chapter "Internationalisation" "CHAPi18n" &&&
41144          "Internationalisation""
41145 .cindex internationalisation "email address"
41146 .cindex EAI
41147 .cindex i18n
41148 .cindex utf8 "mail name handling"
41149
41150 Exim has support for Internationalised mail names.
41151 To include this it must be built with SUPPORT_I18N and the libidn library.
41152 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41153
41154 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41155 instead of it) then IDNA2008 is supported; this adds an extra library
41156 requirement, upon libidn2.
41157
41158 .section "MTA operations" SECTi18nMTA
41159 .cindex SMTPUTF8 "ESMTP option"
41160 The main configuration option &%smtputf8_advertise_hosts%& specifies
41161 a host list.  If this matches the sending host and
41162 accept_8bitmime is true (the default) then the ESMTP option
41163 SMTPUTF8 will be advertised.
41164
41165 If the sender specifies the SMTPUTF8 option on a MAIL command
41166 international handling for the message is enabled and
41167 the expansion variable &$message_smtputf8$& will have value TRUE.
41168
41169 The option &%allow_utf8_domains%& is set to true for this
41170 message. All DNS lookups are converted to a-label form
41171 whatever the setting of &%allow_utf8_domains%&
41172 when Exim is built with SUPPORT_I18N.
41173
41174 Both localparts and domain are maintained as the original
41175 UTF-8 form internally; any comparison or regular-expression use will
41176 require appropriate care.  Filenames created, eg. by
41177 the appendfile transport, will have UTF-8 names.
41178
41179 HELO names sent by the smtp transport will have any UTF-8
41180 components expanded to a-label form,
41181 and any certificate name checks will be done using the a-label
41182 form of the name.
41183
41184 .cindex log protocol
41185 .cindex SMTPUTF8 logging
41186 .cindex i18n logging
41187 Log lines and Received-by: header lines will acquire a "utf8"
41188 prefix on the protocol element, eg. utf8esmtp.
41189
41190 The following expansion operators can be used:
41191 .code
41192 ${utf8_domain_to_alabel:str}
41193 ${utf8_domain_from_alabel:str}
41194 ${utf8_localpart_to_alabel:str}
41195 ${utf8_localpart_from_alabel:str}
41196 .endd
41197
41198 .cindex utf8 "address downconversion"
41199 .cindex i18n "utf8 address downconversion"
41200 The RCPT ACL
41201 may use the following modifier:
41202 .display
41203 control = utf8_downconvert
41204 control = utf8_downconvert/<value>
41205 .endd
41206 This sets a flag requiring that addresses are converted to
41207 a-label form before smtp delivery, for use in a
41208 Message Submission Agent context.
41209 If a value is appended it may be:
41210 .display
41211 &`1  `& (default) mandatory downconversion
41212 &`0  `& no downconversion
41213 &`-1 `& if SMTPUTF8 not supported by destination host
41214 .endd
41215
41216 If mua_wrapper is set, the utf8_downconvert control
41217 is initially set to -1.
41218
41219 The smtp transport has an option &%utf8_downconvert%&.
41220 If set it must expand to one of the three values described above,
41221 and it overrides any previously set value.
41222
41223
41224 There is no explicit support for VRFY and EXPN.
41225 Configurations supporting these should inspect
41226 &$smtp_command_argument$& for an SMTPUTF8 argument.
41227
41228 There is no support for LMTP on Unix sockets.
41229 Using the "lmtp" protocol option on an smtp transport,
41230 for LMTP over TCP, should work as expected.
41231
41232 There is no support for DSN unitext handling,
41233 and no provision for converting logging from or to UTF-8.
41234
41235
41236
41237 .section "MDA operations" SECTi18nMDA
41238 To aid in constructing names suitable for IMAP folders
41239 the following expansion operator can be used:
41240 .code
41241 ${imapfolder {<string>} {<sep>} {<specials>}}
41242 .endd
41243
41244 The string is converted from the charset specified by
41245 the "headers charset" command (in a filter file)
41246 or &%headers_charset%& main configuration option (otherwise),
41247 to the
41248 modified UTF-7 encoding specified by RFC 2060,
41249 with the following exception: All occurrences of <sep>
41250 (which has to be a single character)
41251 are replaced with periods ("."), and all periods and slashes that are not
41252 <sep> and are not in the <specials> string are BASE64 encoded.
41253
41254 The third argument can be omitted, defaulting to an empty string.
41255 The second argument can be omitted, defaulting to "/".
41256
41257 This is the encoding used by Courier for Maildir names on disk, and followed
41258 by many other IMAP servers.
41259
41260 Examples:
41261 .display
41262 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41263 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41264 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41265 .endd
41266
41267 Note that the source charset setting is vital, and also that characters
41268 must be representable in UTF-16.
41269
41270
41271 . ////////////////////////////////////////////////////////////////////////////
41272 . ////////////////////////////////////////////////////////////////////////////
41273
41274 .chapter "Events" "CHAPevents" &&&
41275          "Events"
41276 .cindex events
41277
41278 The events mechanism in Exim can be used to intercept processing at a number
41279 of points.  It was originally invented to give a way to do customised logging
41280 actions (for example, to a database) but can also be used to modify some
41281 processing actions.
41282
41283 Most installations will never need to use Events.
41284 The support can be left out of a build by defining DISABLE_EVENT=yes
41285 in &_Local/Makefile_&.
41286
41287 There are two major classes of events: main and transport.
41288 The main configuration option &%event_action%& controls reception events;
41289 a transport option &%event_action%& controls delivery events.
41290
41291 Both options are a string which is expanded when the event fires.
41292 An example might look like:
41293 .cindex logging custom
41294 .code
41295 event_action = ${if eq {msg:delivery}{$event_name} \
41296 {${lookup pgsql {SELECT * FROM record_Delivery( \
41297     '${quote_pgsql:$sender_address_domain}',\
41298     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41299     '${quote_pgsql:$domain}', \
41300     '${quote_pgsql:${lc:$local_part}}', \
41301     '${quote_pgsql:$host_address}', \
41302     '${quote_pgsql:${lc:$host}}', \
41303     '${quote_pgsql:$message_exim_id}')}} \
41304 } {}}
41305 .endd
41306
41307 Events have names which correspond to the point in process at which they fire.
41308 The name is placed in the variable &$event_name$& and the event action
41309 expansion must check this, as it will be called for every possible event type.
41310
41311 .new
41312 The current list of events is:
41313 .wen
41314 .display
41315 &`dane:fail              after    transport  `& per connection
41316 &`msg:complete           after    main       `& per message
41317 &`msg:defer              after    transport  `& per message per delivery try
41318 &`msg:delivery           after    transport  `& per recipient
41319 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41320 &`msg:rcpt:defer         after    transport  `& per recipient
41321 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41322 &`msg:fail:delivery      after    transport  `& per recipient
41323 &`msg:fail:internal      after    main       `& per recipient
41324 &`tcp:connect            before   transport  `& per connection
41325 &`tcp:close              after    transport  `& per connection
41326 &`tls:cert               before   both       `& per certificate in verification chain
41327 &`smtp:connect           after    transport  `& per connection
41328 &`smtp:ehlo              after    transport  `& per connection
41329 .endd
41330 New event types may be added in future.
41331
41332 The event name is a colon-separated list, defining the type of
41333 event in a tree of possibilities.  It may be used as a list
41334 or just matched on as a whole.  There will be no spaces in the name.
41335
41336 The second column in the table above describes whether the event fires
41337 before or after the action is associates with.  Those which fire before
41338 can be used to affect that action (more on this below).
41339
41340 The third column in the table above says what section of the configuration
41341 should define the event action.
41342
41343 An additional variable, &$event_data$&, is filled with information varying
41344 with the event type:
41345 .display
41346 &`dane:fail            `& failure reason
41347 &`msg:defer            `& error string
41348 &`msg:delivery         `& smtp confirmation message
41349 &`msg:fail:internal    `& failure reason
41350 &`msg:fail:delivery    `& smtp error message
41351 &`msg:host:defer       `& error string
41352 &`msg:rcpt:host:defer  `& error string
41353 &`msg:rcpt:defer       `& error string
41354 &`tls:cert             `& verification chain depth
41355 &`smtp:connect         `& smtp banner
41356 &`smtp:ehlo            `& smtp ehlo response
41357 .endd
41358
41359 The :defer events populate one extra variable: &$event_defer_errno$&.
41360
41361 For complex operations an ACL expansion can be used in &%event_action%&
41362 however due to the multiple contexts that Exim operates in during
41363 the course of its processing:
41364 .ilist
41365 variables set in transport events will not be visible outside that
41366 transport call
41367 .next
41368 acl_m variables in a server context are lost on a new connection,
41369 and after smtp helo/ehlo/mail/starttls/rset commands
41370 .endlist
41371 Using an ACL expansion with the logwrite modifier can be
41372 a useful way of writing to the main log.
41373
41374 The expansion of the event_action option should normally
41375 return an empty string.  Should it return anything else the
41376 following will be forced:
41377 .display
41378 &`tcp:connect      `&  do not connect
41379 &`tls:cert         `&  refuse verification
41380 &`smtp:connect     `&  close connection
41381 .endd
41382 All other message types ignore the result string, and
41383 no other use is made of it.
41384
41385 For a tcp:connect event, if the connection is being made to a proxy
41386 then the address and port variables will be that of the proxy and not
41387 the target system.
41388
41389 For tls:cert events, if GnuTLS is in use this will trigger only per
41390 chain element received on the connection.
41391 For OpenSSL it will trigger for every chain element including those
41392 loaded locally.
41393
41394 . ////////////////////////////////////////////////////////////////////////////
41395 . ////////////////////////////////////////////////////////////////////////////
41396
41397 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41398          "Adding drivers or lookups"
41399 .cindex "adding drivers"
41400 .cindex "new drivers, adding"
41401 .cindex "drivers" "adding new"
41402 The following actions have to be taken in order to add a new router, transport,
41403 authenticator, or lookup type to Exim:
41404
41405 .olist
41406 Choose a name for the driver or lookup type that does not conflict with any
41407 existing name; I will use &"newdriver"& in what follows.
41408 .next
41409 Add to &_src/EDITME_& the line:
41410 .display
41411 <&'type'&>&`_NEWDRIVER=yes`&
41412 .endd
41413 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41414 code is not to be included in the binary by default, comment this line out. You
41415 should also add any relevant comments about the driver or lookup type.
41416 .next
41417 Add to &_src/config.h.defaults_& the line:
41418 .code
41419 #define <type>_NEWDRIVER
41420 .endd
41421 .next
41422 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41423 and create a table entry as is done for all the other drivers and lookup types.
41424 .next
41425 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41426 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41427 Add your &`NEWDRIVER`& to that list.
41428 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41429 simple form that most lookups have.
41430 .next
41431 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41432 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41433 driver or lookup type and add it to the definition of OBJ.
41434 .next
41435 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41436 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41437 .next
41438 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41439 &_src_&.
41440 .next
41441 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41442 as for other drivers and lookups.
41443 .endlist
41444
41445 Then all you need to do is write the code! A good way to start is to make a
41446 proforma by copying an existing module of the same type, globally changing all
41447 occurrences of the name, and cutting out most of the code. Note that any
41448 options you create must be listed in alphabetical order, because the tables are
41449 searched using a binary chop procedure.
41450
41451 There is a &_README_& file in each of the sub-directories of &_src_& describing
41452 the interface that is expected.
41453
41454
41455
41456
41457 . ////////////////////////////////////////////////////////////////////////////
41458 . ////////////////////////////////////////////////////////////////////////////
41459
41460 . /////////////////////////////////////////////////////////////////////////////
41461 . These lines are processing instructions for the Simple DocBook Processor that
41462 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41463 . PDFs than using xmlto and fop. They will be ignored by all other XML
41464 . processors.
41465 . /////////////////////////////////////////////////////////////////////////////
41466
41467 .literal xml
41468 <?sdop
41469   format="newpage"
41470   foot_right_recto="&chaptertitle;"
41471   foot_right_verso="&chaptertitle;"
41472 ?>
41473 .literal off
41474
41475 .makeindex "Options index"   "option"
41476 .makeindex "Variables index" "variable"
41477 .makeindex "Concept index"   "concept"
41478
41479
41480 . /////////////////////////////////////////////////////////////////////////////
41481 . /////////////////////////////////////////////////////////////////////////////