68ad1691e5f8846ff64aa54ce8a317e99cdd61d4
[users/jgh/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.93"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 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"
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 .cindex "hints database" "remembering routing"
4514 The hints database that remembers which messages are waiting for specific hosts
4515 is updated, as if delivery to those hosts had been deferred. After this is
4516 complete, a second, normal queue scan happens, with routing and delivery taking
4517 place as normal. Messages that are routed to the same host should mostly be
4518 delivered down a single SMTP
4519 .cindex "SMTP" "passed connection"
4520 .cindex "SMTP" "multiple deliveries"
4521 .cindex "multiple SMTP deliveries"
4522 connection because of the hints that were set up during the first queue scan.
4523 This option may be useful for hosts that are connected to the Internet
4524 intermittently.
4525
4526 .vitem &%-q[q]i...%&
4527 .oindex "&%-qi%&"
4528 .cindex "queue" "initial delivery"
4529 If the &'i'& flag is present, the queue runner runs delivery processes only for
4530 those messages that haven't previously been tried. (&'i'& stands for &"initial
4531 delivery"&.) This can be helpful if you are putting messages in the queue using
4532 &%-odq%& and want a queue runner just to process the new messages.
4533
4534 .vitem &%-q[q][i]f...%&
4535 .oindex "&%-qf%&"
4536 .cindex "queue" "forcing delivery"
4537 .cindex "delivery" "forcing in queue run"
4538 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4539 message, whereas without &'f'& only those non-frozen addresses that have passed
4540 their retry times are tried.
4541
4542 .vitem &%-q[q][i]ff...%&
4543 .oindex "&%-qff%&"
4544 .cindex "frozen messages" "forcing delivery"
4545 If &'ff'& is present, a delivery attempt is forced for every message, whether
4546 frozen or not.
4547
4548 .vitem &%-q[q][i][f[f]]l%&
4549 .oindex "&%-ql%&"
4550 .cindex "queue" "local deliveries only"
4551 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4552 be done. If a message requires any remote deliveries, it remains in the queue
4553 for later delivery.
4554
4555 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4556 .oindex "&%-qG%&"
4557 .cindex queue named
4558 .cindex "named queues"
4559 .cindex "queue" "delivering specific messages"
4560 If the &'G'& flag and a name is present, the queue runner operates on the
4561 queue with the given name rather than the default queue.
4562 The name should not contain a &'/'& character.
4563 For a periodic queue run (see below)
4564 append to the name a slash and a time value.
4565
4566 If other commandline options specify an action, a &'-qG<name>'& option
4567 will specify a queue to operate on.
4568 For example:
4569 .code
4570 exim -bp -qGquarantine
4571 mailq -qGquarantine
4572 exim -qGoffpeak -Rf @special.domain.example
4573 .endd
4574
4575 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4576 When scanning the queue, Exim can be made to skip over messages whose ids are
4577 lexically less than a given value by following the &%-q%& option with a
4578 starting message id. For example:
4579 .code
4580 exim -q 0t5C6f-0000c8-00
4581 .endd
4582 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4583 second message id is given, messages whose ids are lexically greater than it
4584 are also skipped. If the same id is given twice, for example,
4585 .code
4586 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4587 .endd
4588 just one delivery process is started, for that message. This differs from
4589 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4590 that it counts as a delivery from a queue run. Note that the selection
4591 mechanism does not affect the order in which the messages are scanned. There
4592 are also other ways of selecting specific sets of messages for delivery in a
4593 queue run &-- see &%-R%& and &%-S%&.
4594
4595 .vitem &%-q%&<&'qflags'&><&'time'&>
4596 .cindex "queue runner" "starting periodically"
4597 .cindex "periodic queue running"
4598 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4599 starting a queue runner process at intervals specified by the given time value
4600 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4601 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4602 single daemon process handles both functions. A common way of starting up a
4603 combined daemon at system boot time is to use a command such as
4604 .code
4605 /usr/exim/bin/exim -bd -q30m
4606 .endd
4607 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4608 process every 30 minutes.
4609
4610 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4611 pid file is written unless one is explicitly requested by the &%-oP%& option.
4612
4613 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4614 .oindex "&%-qR%&"
4615 This option is synonymous with &%-R%&. It is provided for Sendmail
4616 compatibility.
4617
4618 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4619 .oindex "&%-qS%&"
4620 This option is synonymous with &%-S%&.
4621
4622 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4623 .oindex "&%-R%&"
4624 .cindex "queue runner" "for specific recipients"
4625 .cindex "delivery" "to given domain"
4626 .cindex "domain" "delivery to"
4627 The <&'rsflags'&> may be empty, in which case the white space before the string
4628 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4629 which are the possible values for <&'rsflags'&>. White space is required if
4630 <&'rsflags'&> is not empty.
4631
4632 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4633 perform a single queue run, except that, when scanning the messages on the
4634 queue, Exim processes only those that have at least one undelivered recipient
4635 address containing the given string, which is checked in a case-independent
4636 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4637 regular expression; otherwise it is a literal string.
4638
4639 If you want to do periodic queue runs for messages with specific recipients,
4640 you can combine &%-R%& with &%-q%& and a time value. For example:
4641 .code
4642 exim -q25m -R @special.domain.example
4643 .endd
4644 This example does a queue run for messages with recipients in the given domain
4645 every 25 minutes. Any additional flags that are specified with &%-q%& are
4646 applied to each queue run.
4647
4648 Once a message is selected for delivery by this mechanism, all its addresses
4649 are processed. For the first selected message, Exim overrides any retry
4650 information and forces a delivery attempt for each undelivered address. This
4651 means that if delivery of any address in the first message is successful, any
4652 existing retry information is deleted, and so delivery attempts for that
4653 address in subsequently selected messages (which are processed without forcing)
4654 will run. However, if delivery of any address does not succeed, the retry
4655 information is updated, and in subsequently selected messages, the failing
4656 address will be skipped.
4657
4658 .cindex "frozen messages" "forcing delivery"
4659 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4660 all selected messages, not just the first; frozen messages are included when
4661 &'ff'& is present.
4662
4663 The &%-R%& option makes it straightforward to initiate delivery of all messages
4664 to a given domain after a host has been down for some time. When the SMTP
4665 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4666 effect is to run Exim with the &%-R%& option, but it can be configured to run
4667 an arbitrary command instead.
4668
4669 .vitem &%-r%&
4670 .oindex "&%-r%&"
4671 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4672
4673 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4674 .oindex "&%-S%&"
4675 .cindex "delivery" "from given sender"
4676 .cindex "queue runner" "for specific senders"
4677 This option acts like &%-R%& except that it checks the string against each
4678 message's sender instead of against the recipients. If &%-R%& is also set, both
4679 conditions must be met for a message to be selected. If either of the options
4680 has &'f'& or &'ff'& in its flags, the associated action is taken.
4681
4682 .vitem &%-Tqt%&&~<&'times'&>
4683 .oindex "&%-Tqt%&"
4684 This is an option that is exclusively for use by the Exim testing suite. It is not
4685 recognized when Exim is run normally. It allows for the setting up of explicit
4686 &"queue times"& so that various warning/retry features can be tested.
4687
4688 .vitem &%-t%&
4689 .oindex "&%-t%&"
4690 .cindex "recipient" "extracting from header lines"
4691 .cindex "&'Bcc:'& header line"
4692 .cindex "&'Cc:'& header line"
4693 .cindex "&'To:'& header line"
4694 When Exim is receiving a locally-generated, non-SMTP message on its standard
4695 input, the &%-t%& option causes the recipients of the message to be obtained
4696 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4697 from the command arguments. The addresses are extracted before any rewriting
4698 takes place and the &'Bcc:'& header line, if present, is then removed.
4699
4700 .cindex "Sendmail compatibility" "&%-t%& option"
4701 If the command has any arguments, they specify addresses to which the message
4702 is &'not'& to be delivered. That is, the argument addresses are removed from
4703 the recipients list obtained from the headers. This is compatible with Smail 3
4704 and in accordance with the documented behaviour of several versions of
4705 Sendmail, as described in man pages on a number of operating systems (e.g.
4706 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4707 argument addresses to those obtained from the headers, and the O'Reilly
4708 Sendmail book documents it that way. Exim can be made to add argument addresses
4709 instead of subtracting them by setting the option
4710 &%extract_addresses_remove_arguments%& false.
4711
4712 .cindex "&%Resent-%& header lines" "with &%-t%&"
4713 If there are any &%Resent-%& header lines in the message, Exim extracts
4714 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4715 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4716 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4717 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4718
4719 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4720 message is resent several times). The RFC also specifies that they should be
4721 added at the front of the message, and separated by &'Received:'& lines. It is
4722 not at all clear how &%-t%& should operate in the present of multiple sets,
4723 nor indeed exactly what constitutes a &"set"&.
4724 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4725 are often added at the end of the header, and if a message is resent more than
4726 once, it is common for the original set of &%Resent-%& headers to be renamed as
4727 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4728
4729 .vitem &%-ti%&
4730 .oindex "&%-ti%&"
4731 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4732 compatibility with Sendmail.
4733
4734 .vitem &%-tls-on-connect%&
4735 .oindex "&%-tls-on-connect%&"
4736 .cindex "TLS" "use without STARTTLS"
4737 .cindex "TLS" "automatic start"
4738 This option is available when Exim is compiled with TLS support. It forces all
4739 incoming SMTP connections to behave as if the incoming port is listed in the
4740 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4741 &<<CHAPTLS>>& for further details.
4742
4743
4744 .vitem &%-U%&
4745 .oindex "&%-U%&"
4746 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4747 Sendmail uses this option for &"initial message submission"&, and its
4748 documentation states that in future releases, it may complain about
4749 syntactically invalid messages rather than fixing them when this flag is not
4750 set. Exim ignores this option.
4751
4752 .vitem &%-v%&
4753 .oindex "&%-v%&"
4754 This option causes Exim to write information to the standard error stream,
4755 describing what it is doing. In particular, it shows the log lines for
4756 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4757 dialogue is shown. Some of the log lines shown may not actually be written to
4758 the log if the setting of &%log_selector%& discards them. Any relevant
4759 selectors are shown with each log line. If none are shown, the logging is
4760 unconditional.
4761
4762 .vitem &%-x%&
4763 .oindex "&%-x%&"
4764 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4765 National Language Support extended characters in the body of the mail item"&).
4766 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4767 this option.
4768
4769 .vitem &%-X%&&~<&'logfile'&>
4770 .oindex "&%-X%&"
4771 This option is interpreted by Sendmail to cause debug information to be sent
4772 to the named file.  It is ignored by Exim.
4773
4774 .vitem &%-z%&&~<&'log-line'&>
4775 .oindex "&%-z%&"
4776 This option writes its argument to Exim's logfile.
4777 Use is restricted to administrators; the intent is for operational notes.
4778 Quotes should be used to maintain a multi-word item as a single argument,
4779 under most shells.
4780 .endlist
4781
4782 .ecindex IIDclo1
4783 .ecindex IIDclo2
4784
4785
4786 . ////////////////////////////////////////////////////////////////////////////
4787 . Insert a stylized DocBook comment here, to identify the end of the command
4788 . line options. This is for the benefit of the Perl script that automatically
4789 . creates a man page for the options.
4790 . ////////////////////////////////////////////////////////////////////////////
4791
4792 .literal xml
4793 <!-- === End of command line options === -->
4794 .literal off
4795
4796
4797
4798
4799
4800 . ////////////////////////////////////////////////////////////////////////////
4801 . ////////////////////////////////////////////////////////////////////////////
4802
4803
4804 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4805          "The runtime configuration file"
4806
4807 .cindex "runtime configuration"
4808 .cindex "configuration file" "general description"
4809 .cindex "CONFIGURE_FILE"
4810 .cindex "configuration file" "errors in"
4811 .cindex "error" "in configuration file"
4812 .cindex "return code" "for bad configuration"
4813 Exim uses a single runtime configuration file that is read whenever an Exim
4814 binary is executed. Note that in normal operation, this happens frequently,
4815 because Exim is designed to operate in a distributed manner, without central
4816 control.
4817
4818 If a syntax error is detected while reading the configuration file, Exim
4819 writes a message on the standard error, and exits with a non-zero return code.
4820 The message is also written to the panic log. &*Note*&: Only simple syntax
4821 errors can be detected at this time. The values of any expanded options are
4822 not checked until the expansion happens, even when the expansion does not
4823 actually alter the string.
4824
4825 The name of the configuration file is compiled into the binary for security
4826 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4827 most configurations, this specifies a single file. However, it is permitted to
4828 give a colon-separated list of filenames, in which case Exim uses the first
4829 existing file in the list.
4830
4831 .cindex "EXIM_USER"
4832 .cindex "EXIM_GROUP"
4833 .cindex "CONFIGURE_OWNER"
4834 .cindex "CONFIGURE_GROUP"
4835 .cindex "configuration file" "ownership"
4836 .cindex "ownership" "configuration file"
4837 The runtime configuration file must be owned by root or by the user that is
4838 specified at compile time by the CONFIGURE_OWNER option (if set). The
4839 configuration file must not be world-writeable, or group-writeable unless its
4840 group is the root group or the one specified at compile time by the
4841 CONFIGURE_GROUP option.
4842
4843 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4844 to root, anybody who is able to edit the runtime configuration file has an
4845 easy way to run commands as root. If you specify a user or group in the
4846 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4847 who are members of that group will trivially be able to obtain root privileges.
4848
4849 Up to Exim version 4.72, the runtime configuration file was also permitted to
4850 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4851 since it offered a simple privilege escalation for any attacker who managed to
4852 compromise the Exim user account.
4853
4854 A default configuration file, which will work correctly in simple situations,
4855 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4856 defines just one filename, the installation process copies the default
4857 configuration to a new file of that name if it did not previously exist. If
4858 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4859 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4860 configuration.
4861
4862
4863
4864 .section "Using a different configuration file" "SECID40"
4865 .cindex "configuration file" "alternate"
4866 A one-off alternate configuration can be specified by the &%-C%& command line
4867 option, which may specify a single file or a list of files. However, when
4868 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4869 unless the argument for &%-C%& is identical to the built-in value from
4870 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4871 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4872 is useful mainly for checking the syntax of configuration files before
4873 installing them. No owner or group checks are done on a configuration file
4874 specified by &%-C%&, if root privilege has been dropped.
4875
4876 Even the Exim user is not trusted to specify an arbitrary configuration file
4877 with the &%-C%& option to be used with root privileges, unless that file is
4878 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4879 testing a configuration using &%-C%& right through message reception and
4880 delivery, even if the caller is root. The reception works, but by that time,
4881 Exim is running as the Exim user, so when it re-execs to regain privilege for
4882 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4883 can test reception and delivery using two separate commands (one to put a
4884 message in the queue, using &%-odq%&, and another to do the delivery, using
4885 &%-M%&).
4886
4887 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4888 prefix string with which any file named in a &%-C%& command line option must
4889 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4890 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4891 filename can be used with &%-C%&.
4892
4893 One-off changes to a configuration can be specified by the &%-D%& command line
4894 option, which defines and overrides values for macros used inside the
4895 configuration file. However, like &%-C%&, the use of this option by a
4896 non-privileged user causes Exim to discard its root privilege.
4897 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4898 completely disabled, and its use causes an immediate error exit.
4899
4900 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4901 to declare certain macro names trusted, such that root privilege will not
4902 necessarily be discarded.
4903 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4904 considered safe and, if &%-D%& only supplies macros from this list, and the
4905 values are acceptable, then Exim will not give up root privilege if the caller
4906 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4907 transition mechanism and is expected to be removed in the future.  Acceptable
4908 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4909
4910 Some sites may wish to use the same Exim binary on different machines that
4911 share a file system, but to use different configuration files on each machine.
4912 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4913 looks for a file whose name is the configuration filename followed by a dot
4914 and the machine's node name, as obtained from the &[uname()]& function. If this
4915 file does not exist, the standard name is tried. This processing occurs for
4916 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4917
4918 In some esoteric situations different versions of Exim may be run under
4919 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4920 help with this. See the comments in &_src/EDITME_& for details.
4921
4922
4923
4924 .section "Configuration file format" "SECTconffilfor"
4925 .cindex "configuration file" "format of"
4926 .cindex "format" "configuration file"
4927 Exim's configuration file is divided into a number of different parts. General
4928 option settings must always appear at the start of the file. The other parts
4929 are all optional, and may appear in any order. Each part other than the first
4930 is introduced by the word &"begin"& followed by at least one literal
4931 space, and the name of the part. The optional parts are:
4932
4933 .ilist
4934 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4935 &<<CHAPACL>>&).
4936 .next
4937 .cindex "AUTH" "configuration"
4938 &'authenticators'&: Configuration settings for the authenticator drivers. These
4939 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4940 .next
4941 &'routers'&: Configuration settings for the router drivers. Routers process
4942 addresses and determine how the message is to be delivered (see chapters
4943 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4944 .next
4945 &'transports'&: Configuration settings for the transport drivers. Transports
4946 define mechanisms for copying messages to destinations (see chapters
4947 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4948 .next
4949 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4950 If there is no retry section, or if it is empty (that is, no retry rules are
4951 defined), Exim will not retry deliveries. In this situation, temporary errors
4952 are treated the same as permanent errors. Retry rules are discussed in chapter
4953 &<<CHAPretry>>&.
4954 .next
4955 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4956 when new addresses are generated during delivery. Rewriting is discussed in
4957 chapter &<<CHAPrewrite>>&.
4958 .next
4959 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4960 want to use this feature, you must set
4961 .code
4962 LOCAL_SCAN_HAS_OPTIONS=yes
4963 .endd
4964 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4965 facility are given in chapter &<<CHAPlocalscan>>&.
4966 .endlist
4967
4968 .cindex "configuration file" "leading white space in"
4969 .cindex "configuration file" "trailing white space in"
4970 .cindex "white space" "in configuration file"
4971 Leading and trailing white space in configuration lines is always ignored.
4972
4973 Blank lines in the file, and lines starting with a # character (ignoring
4974 leading white space) are treated as comments and are ignored. &*Note*&: A
4975 # character other than at the beginning of a line is not treated specially,
4976 and does not introduce a comment.
4977
4978 Any non-comment line can be continued by ending it with a backslash. Note that
4979 the general rule for white space means that trailing white space after the
4980 backslash and leading white space at the start of continuation
4981 lines is ignored. Comment lines beginning with # (but not empty lines) may
4982 appear in the middle of a sequence of continuation lines.
4983
4984 A convenient way to create a configuration file is to start from the
4985 default, which is supplied in &_src/configure.default_&, and add, delete, or
4986 change settings as required.
4987
4988 The ACLs, retry rules, and rewriting rules have their own syntax which is
4989 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4990 respectively. The other parts of the configuration file have some syntactic
4991 items in common, and these are described below, from section &<<SECTcos>>&
4992 onwards. Before that, the inclusion, macro, and conditional facilities are
4993 described.
4994
4995
4996
4997 .section "File inclusions in the configuration file" "SECID41"
4998 .cindex "inclusions in configuration file"
4999 .cindex "configuration file" "including other files"
5000 .cindex "&`.include`& in configuration file"
5001 .cindex "&`.include_if_exists`& in configuration file"
5002 You can include other files inside Exim's runtime configuration file by
5003 using this syntax:
5004 .display
5005 &`.include`& <&'filename'&>
5006 &`.include_if_exists`& <&'filename'&>
5007 .endd
5008 on a line by itself. Double quotes round the filename are optional. If you use
5009 the first form, a configuration error occurs if the file does not exist; the
5010 second form does nothing for non-existent files.
5011 The first form allows a relative name. It is resolved relative to
5012 the directory of the including file. For the second form an absolute filename
5013 is required.
5014
5015 Includes may be nested to any depth, but remember that Exim reads its
5016 configuration file often, so it is a good idea to keep them to a minimum.
5017 If you change the contents of an included file, you must HUP the daemon,
5018 because an included file is read only when the configuration itself is read.
5019
5020 The processing of inclusions happens early, at a physical line level, so, like
5021 comment lines, an inclusion can be used in the middle of an option setting,
5022 for example:
5023 .code
5024 hosts_lookup = a.b.c \
5025                .include /some/file
5026 .endd
5027 Include processing happens after macro processing (see below). Its effect is to
5028 process the lines of the included file as if they occurred inline where the
5029 inclusion appears.
5030
5031
5032
5033 .section "Macros in the configuration file" "SECTmacrodefs"
5034 .cindex "macro" "description of"
5035 .cindex "configuration file" "macros"
5036 If a line in the main part of the configuration (that is, before the first
5037 &"begin"& line) begins with an upper case letter, it is taken as a macro
5038 definition, and must be of the form
5039 .display
5040 <&'name'&> = <&'rest of line'&>
5041 .endd
5042 The name must consist of letters, digits, and underscores, and need not all be
5043 in upper case, though that is recommended. The rest of the line, including any
5044 continuations, is the replacement text, and has leading and trailing white
5045 space removed. Quotes are not removed. The replacement text can never end with
5046 a backslash character, but this doesn't seem to be a serious limitation.
5047
5048 Macros may also be defined between router, transport, authenticator, or ACL
5049 definitions. They may not, however, be defined within an individual driver or
5050 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5051
5052 .section "Macro substitution" "SECID42"
5053 Once a macro is defined, all subsequent lines in the file (and any included
5054 files) are scanned for the macro name; if there are several macros, the line is
5055 scanned for each, in turn, in the order in which the macros are defined. The
5056 replacement text is not re-scanned for the current macro, though it is scanned
5057 for subsequently defined macros. For this reason, a macro name may not contain
5058 the name of a previously defined macro as a substring. You could, for example,
5059 define
5060 .display
5061 &`ABCD_XYZ = `&<&'something'&>
5062 &`ABCD = `&<&'something else'&>
5063 .endd
5064 but putting the definitions in the opposite order would provoke a configuration
5065 error. Macro expansion is applied to individual physical lines from the file,
5066 before checking for line continuation or file inclusion (see above). If a line
5067 consists solely of a macro name, and the expansion of the macro is empty, the
5068 line is ignored. A macro at the start of a line may turn the line into a
5069 comment line or a &`.include`& line.
5070
5071
5072 .section "Redefining macros" "SECID43"
5073 Once defined, the value of a macro can be redefined later in the configuration
5074 (or in an included file). Redefinition is specified by using &'=='& instead of
5075 &'='&. For example:
5076 .code
5077 MAC =  initial value
5078 ...
5079 MAC == updated value
5080 .endd
5081 Redefinition does not alter the order in which the macros are applied to the
5082 subsequent lines of the configuration file. It is still the same order in which
5083 the macros were originally defined. All that changes is the macro's value.
5084 Redefinition makes it possible to accumulate values. For example:
5085 .code
5086 MAC =  initial value
5087 ...
5088 MAC == MAC and something added
5089 .endd
5090 This can be helpful in situations where the configuration file is built
5091 from a number of other files.
5092
5093 .section "Overriding macro values" "SECID44"
5094 The values set for macros in the configuration file can be overridden by the
5095 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5096 used, unless called by root or the Exim user. A definition on the command line
5097 using the &%-D%& option causes all definitions and redefinitions within the
5098 file to be ignored.
5099
5100
5101
5102 .section "Example of macro usage" "SECID45"
5103 As an example of macro usage, consider a configuration where aliases are looked
5104 up in a MySQL database. It helps to keep the file less cluttered if long
5105 strings such as SQL statements are defined separately as macros, for example:
5106 .code
5107 ALIAS_QUERY = select mailbox from user where \
5108               login='${quote_mysql:$local_part}';
5109 .endd
5110 This can then be used in a &(redirect)& router setting like this:
5111 .code
5112 data = ${lookup mysql{ALIAS_QUERY}}
5113 .endd
5114 In earlier versions of Exim macros were sometimes used for domain, host, or
5115 address lists. In Exim 4 these are handled better by named lists &-- see
5116 section &<<SECTnamedlists>>&.
5117
5118
5119 .section "Builtin macros" "SECTbuiltinmacros"
5120 Exim defines some macros depending on facilities available, which may
5121 differ due to build-time definitions and from one release to another.
5122 All of these macros start with an underscore.
5123 They can be used to conditionally include parts of a configuration
5124 (see below).
5125
5126 The following classes of macros are defined:
5127 .display
5128 &` _HAVE_*                    `&  build-time defines
5129 &` _DRIVER_ROUTER_*           `&  router drivers
5130 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5131 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5132 &` _LOG_*                     `&  log_selector values
5133 &` _OPT_MAIN_*                `&  main config options
5134 &` _OPT_ROUTERS_*             `&  generic router options
5135 &` _OPT_TRANSPORTS_*          `&  generic transport options
5136 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5137 &` _OPT_ROUTER_*_*            `&  private router options
5138 &` _OPT_TRANSPORT_*_*         `&  private transport options
5139 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5140 .endd
5141
5142 Use an &"exim -bP macros"& command to get the list of macros.
5143
5144
5145 .section "Conditional skips in the configuration file" "SECID46"
5146 .cindex "configuration file" "conditional skips"
5147 .cindex "&`.ifdef`&"
5148 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5149 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5150 portions of the configuration file. The processing happens whenever the file is
5151 read (that is, when an Exim binary starts to run).
5152
5153 The implementation is very simple. Instances of the first four directives must
5154 be followed by text that includes the names of one or macros. The condition
5155 that is tested is whether or not any macro substitution has taken place in the
5156 line. Thus:
5157 .code
5158 .ifdef AAA
5159 message_size_limit = 50M
5160 .else
5161 message_size_limit = 100M
5162 .endif
5163 .endd
5164 sets a message size limit of 50M if the macro &`AAA`& is defined
5165 (or &`A`& or &`AA`&), and 100M
5166 otherwise. If there is more than one macro named on the line, the condition
5167 is true if any of them are defined. That is, it is an &"or"& condition. To
5168 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5169
5170 Although you can use a macro expansion to generate one of these directives,
5171 it is not very useful, because the condition &"there was a macro substitution
5172 in this line"& will always be true.
5173
5174 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5175 to clarify complicated nestings.
5176
5177
5178
5179 .section "Common option syntax" "SECTcos"
5180 .cindex "common option syntax"
5181 .cindex "syntax of common options"
5182 .cindex "configuration file" "common option syntax"
5183 For the main set of options, driver options, and &[local_scan()]& options,
5184 each setting is on a line by itself, and starts with a name consisting of
5185 lower-case letters and underscores. Many options require a data value, and in
5186 these cases the name must be followed by an equals sign (with optional white
5187 space) and then the value. For example:
5188 .code
5189 qualify_domain = mydomain.example.com
5190 .endd
5191 .cindex "hiding configuration option values"
5192 .cindex "configuration options" "hiding value of"
5193 .cindex "options" "hiding value of"
5194 Some option settings may contain sensitive data, for example, passwords for
5195 accessing databases. To stop non-admin users from using the &%-bP%& command
5196 line option to read these values, you can precede the option settings with the
5197 word &"hide"&. For example:
5198 .code
5199 hide mysql_servers = localhost/users/admin/secret-password
5200 .endd
5201 For non-admin users, such options are displayed like this:
5202 .code
5203 mysql_servers = <value not displayable>
5204 .endd
5205 If &"hide"& is used on a driver option, it hides the value of that option on
5206 all instances of the same driver.
5207
5208 The following sections describe the syntax used for the different data types
5209 that are found in option settings.
5210
5211
5212 .section "Boolean options" "SECID47"
5213 .cindex "format" "boolean"
5214 .cindex "boolean configuration values"
5215 .oindex "&%no_%&&'xxx'&"
5216 .oindex "&%not_%&&'xxx'&"
5217 Options whose type is given as boolean are on/off switches. There are two
5218 different ways of specifying such options: with and without a data value. If
5219 the option name is specified on its own without data, the switch is turned on;
5220 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5221 boolean options may be followed by an equals sign and one of the words
5222 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5223 the following two settings have exactly the same effect:
5224 .code
5225 queue_only
5226 queue_only = true
5227 .endd
5228 The following two lines also have the same (opposite) effect:
5229 .code
5230 no_queue_only
5231 queue_only = false
5232 .endd
5233 You can use whichever syntax you prefer.
5234
5235
5236
5237
5238 .section "Integer values" "SECID48"
5239 .cindex "integer configuration values"
5240 .cindex "format" "integer"
5241 If an option's type is given as &"integer"&, the value can be given in decimal,
5242 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5243 number is assumed. Otherwise, it is treated as an octal number unless it starts
5244 with the characters &"0x"&, in which case the remainder is interpreted as a
5245 hexadecimal number.
5246
5247 If an integer value is followed by the letter K, it is multiplied by 1024; if
5248 it is followed by the letter M, it is multiplied by 1024x1024;
5249 if by the letter G, 1024x1024x1024.
5250 When the values
5251 of integer option settings are output, values which are an exact multiple of
5252 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5253 and M. The printing style is independent of the actual input format that was
5254 used.
5255
5256
5257 .section "Octal integer values" "SECID49"
5258 .cindex "integer format"
5259 .cindex "format" "octal integer"
5260 If an option's type is given as &"octal integer"&, its value is always
5261 interpreted as an octal number, whether or not it starts with the digit zero.
5262 Such options are always output in octal.
5263
5264
5265 .section "Fixed point numbers" "SECID50"
5266 .cindex "fixed point configuration values"
5267 .cindex "format" "fixed point"
5268 If an option's type is given as &"fixed-point"&, its value must be a decimal
5269 integer, optionally followed by a decimal point and up to three further digits.
5270
5271
5272
5273 .section "Time intervals" "SECTtimeformat"
5274 .cindex "time interval" "specifying in configuration"
5275 .cindex "format" "time interval"
5276 A time interval is specified as a sequence of numbers, each followed by one of
5277 the following letters, with no intervening white space:
5278
5279 .table2 30pt
5280 .irow &%s%& seconds
5281 .irow &%m%& minutes
5282 .irow &%h%& hours
5283 .irow &%d%& days
5284 .irow &%w%& weeks
5285 .endtable
5286
5287 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5288 intervals are output in the same format. Exim does not restrict the values; it
5289 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5290
5291
5292
5293 .section "String values" "SECTstrings"
5294 .cindex "string" "format of configuration values"
5295 .cindex "format" "string"
5296 If an option's type is specified as &"string"&, the value can be specified with
5297 or without double-quotes. If it does not start with a double-quote, the value
5298 consists of the remainder of the line plus any continuation lines, starting at
5299 the first character after any leading white space, with trailing white space
5300 removed, and with no interpretation of the characters in the string. Because
5301 Exim removes comment lines (those beginning with #) at an early stage, they can
5302 appear in the middle of a multi-line string. The following two settings are
5303 therefore equivalent:
5304 .code
5305 trusted_users = uucp:mail
5306 trusted_users = uucp:\
5307                 # This comment line is ignored
5308                 mail
5309 .endd
5310 .cindex "string" "quoted"
5311 .cindex "escape characters in quoted strings"
5312 If a string does start with a double-quote, it must end with a closing
5313 double-quote, and any backslash characters other than those used for line
5314 continuation are interpreted as escape characters, as follows:
5315
5316 .table2 100pt
5317 .irow &`\\`&                     "single backslash"
5318 .irow &`\n`&                     "newline"
5319 .irow &`\r`&                     "carriage return"
5320 .irow &`\t`&                     "tab"
5321 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5322 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5323                                    character"
5324 .endtable
5325
5326 If a backslash is followed by some other character, including a double-quote
5327 character, that character replaces the pair.
5328
5329 Quoting is necessary only if you want to make use of the backslash escapes to
5330 insert special characters, or if you need to specify a value with leading or
5331 trailing spaces. These cases are rare, so quoting is almost never needed in
5332 current versions of Exim. In versions of Exim before 3.14, quoting was required
5333 in order to continue lines, so you may come across older configuration files
5334 and examples that apparently quote unnecessarily.
5335
5336
5337 .section "Expanded strings" "SECID51"
5338 .cindex "expansion" "definition of"
5339 Some strings in the configuration file are subjected to &'string expansion'&,
5340 by which means various parts of the string may be changed according to the
5341 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5342 is as just described; in particular, the handling of backslashes in quoted
5343 strings is done as part of the input process, before expansion takes place.
5344 However, backslash is also an escape character for the expander, so any
5345 backslashes that are required for that reason must be doubled if they are
5346 within a quoted configuration string.
5347
5348
5349 .section "User and group names" "SECID52"
5350 .cindex "user name" "format of"
5351 .cindex "format" "user name"
5352 .cindex "groups" "name format"
5353 .cindex "format" "group name"
5354 User and group names are specified as strings, using the syntax described
5355 above, but the strings are interpreted specially. A user or group name must
5356 either consist entirely of digits, or be a name that can be looked up using the
5357 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5358
5359
5360 .section "List construction" "SECTlistconstruct"
5361 .cindex "list" "syntax of in configuration"
5362 .cindex "format" "list item in configuration"
5363 .cindex "string" "list, definition of"
5364 The data for some configuration options is a list of items, with colon as the
5365 default separator. Many of these options are shown with type &"string list"& in
5366 the descriptions later in this document. Others are listed as &"domain list"&,
5367 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5368 are all the same; however, those other than &"string list"& are subject to
5369 particular kinds of interpretation, as described in chapter
5370 &<<CHAPdomhosaddlists>>&.
5371
5372 In all these cases, the entire list is treated as a single string as far as the
5373 input syntax is concerned. The &%trusted_users%& setting in section
5374 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5375 in a list, it must be entered as two colons. Leading and trailing white space
5376 on each item in a list is ignored. This makes it possible to include items that
5377 start with a colon, and in particular, certain forms of IPv6 address. For
5378 example, the list
5379 .code
5380 local_interfaces = 127.0.0.1 : ::::1
5381 .endd
5382 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5383
5384 &*Note*&: Although leading and trailing white space is ignored in individual
5385 list items, it is not ignored when parsing the list. The space after the first
5386 colon in the example above is necessary. If it were not there, the list would
5387 be interpreted as the two items 127.0.0.1:: and 1.
5388
5389 .section "Changing list separators" "SECTlistsepchange"
5390 .cindex "list separator" "changing"
5391 .cindex "IPv6" "addresses in lists"
5392 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5393 introduced to allow the separator character to be changed. If a list begins
5394 with a left angle bracket, followed by any punctuation character, that
5395 character is used instead of colon as the list separator. For example, the list
5396 above can be rewritten to use a semicolon separator like this:
5397 .code
5398 local_interfaces = <; 127.0.0.1 ; ::1
5399 .endd
5400 This facility applies to all lists, with the exception of the list in
5401 &%log_file_path%&. It is recommended that the use of non-colon separators be
5402 confined to circumstances where they really are needed.
5403
5404 .cindex "list separator" "newline as"
5405 .cindex "newline" "as list separator"
5406 It is also possible to use newline and other control characters (those with
5407 code values less than 32, plus DEL) as separators in lists. Such separators
5408 must be provided literally at the time the list is processed. For options that
5409 are string-expanded, you can write the separator using a normal escape
5410 sequence. This will be processed by the expander before the string is
5411 interpreted as a list. For example, if a newline-separated list of domains is
5412 generated by a lookup, you can process it directly by a line such as this:
5413 .code
5414 domains = <\n ${lookup mysql{.....}}
5415 .endd
5416 This avoids having to change the list separator in such data. You are unlikely
5417 to want to use a control character as a separator in an option that is not
5418 expanded, because the value is literal text. However, it can be done by giving
5419 the value in quotes. For example:
5420 .code
5421 local_interfaces = "<\n 127.0.0.1 \n ::1"
5422 .endd
5423 Unlike printing character separators, which can be included in list items by
5424 doubling, it is not possible to include a control character as data when it is
5425 set as the separator. Two such characters in succession are interpreted as
5426 enclosing an empty list item.
5427
5428
5429
5430 .section "Empty items in lists" "SECTempitelis"
5431 .cindex "list" "empty item in"
5432 An empty item at the end of a list is always ignored. In other words, trailing
5433 separator characters are ignored. Thus, the list in
5434 .code
5435 senders = user@domain :
5436 .endd
5437 contains only a single item. If you want to include an empty string as one item
5438 in a list, it must not be the last item. For example, this list contains three
5439 items, the second of which is empty:
5440 .code
5441 senders = user1@domain : : user2@domain
5442 .endd
5443 &*Note*&: There must be white space between the two colons, as otherwise they
5444 are interpreted as representing a single colon data character (and the list
5445 would then contain just one item). If you want to specify a list that contains
5446 just one, empty item, you can do it as in this example:
5447 .code
5448 senders = :
5449 .endd
5450 In this case, the first item is empty, and the second is discarded because it
5451 is at the end of the list.
5452
5453
5454
5455
5456 .section "Format of driver configurations" "SECTfordricon"
5457 .cindex "drivers" "configuration format"
5458 There are separate parts in the configuration for defining routers, transports,
5459 and authenticators. In each part, you are defining a number of driver
5460 instances, each with its own set of options. Each driver instance is defined by
5461 a sequence of lines like this:
5462 .display
5463 <&'instance name'&>:
5464   <&'option'&>
5465   ...
5466   <&'option'&>
5467 .endd
5468 In the following example, the instance name is &(localuser)&, and it is
5469 followed by three options settings:
5470 .code
5471 localuser:
5472   driver = accept
5473   check_local_user
5474   transport = local_delivery
5475 .endd
5476 For each driver instance, you specify which Exim code module it uses &-- by the
5477 setting of the &%driver%& option &-- and (optionally) some configuration
5478 settings. For example, in the case of transports, if you want a transport to
5479 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5480 a local file you would use the &(appendfile)& driver. Each of the drivers is
5481 described in detail in its own separate chapter later in this manual.
5482
5483 You can have several routers, transports, or authenticators that are based on
5484 the same underlying driver (each must have a different instance name).
5485
5486 The order in which routers are defined is important, because addresses are
5487 passed to individual routers one by one, in order. The order in which
5488 transports are defined does not matter at all. The order in which
5489 authenticators are defined is used only when Exim, as a client, is searching
5490 them to find one that matches an authentication mechanism offered by the
5491 server.
5492
5493 .cindex "generic options"
5494 .cindex "options" "generic &-- definition of"
5495 Within a driver instance definition, there are two kinds of option: &'generic'&
5496 and &'private'&. The generic options are those that apply to all drivers of the
5497 same type (that is, all routers, all transports or all authenticators). The
5498 &%driver%& option is a generic option that must appear in every definition.
5499 .cindex "private options"
5500 The private options are special for each driver, and none need appear, because
5501 they all have default values.
5502
5503 The options may appear in any order, except that the &%driver%& option must
5504 precede any private options, since these depend on the particular driver. For
5505 this reason, it is recommended that &%driver%& always be the first option.
5506
5507 Driver instance names, which are used for reference in log entries and
5508 elsewhere, can be any sequence of letters, digits, and underscores (starting
5509 with a letter) and must be unique among drivers of the same type. A router and
5510 a transport (for example) can each have the same name, but no two router
5511 instances can have the same name. The name of a driver instance should not be
5512 confused with the name of the underlying driver module. For example, the
5513 configuration lines:
5514 .code
5515 remote_smtp:
5516   driver = smtp
5517 .endd
5518 create an instance of the &(smtp)& transport driver whose name is
5519 &(remote_smtp)&. The same driver code can be used more than once, with
5520 different instance names and different option settings each time. A second
5521 instance of the &(smtp)& transport, with different options, might be defined
5522 thus:
5523 .code
5524 special_smtp:
5525   driver = smtp
5526   port = 1234
5527   command_timeout = 10s
5528 .endd
5529 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5530 these transport instances from routers, and these names would appear in log
5531 lines.
5532
5533 Comment lines may be present in the middle of driver specifications. The full
5534 list of option settings for any particular driver instance, including all the
5535 defaulted values, can be extracted by making use of the &%-bP%& command line
5536 option.
5537
5538
5539
5540
5541
5542
5543 . ////////////////////////////////////////////////////////////////////////////
5544 . ////////////////////////////////////////////////////////////////////////////
5545
5546 .chapter "The default configuration file" "CHAPdefconfil"
5547 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5548 .cindex "default" "configuration file &""walk through""&"
5549 The default configuration file supplied with Exim as &_src/configure.default_&
5550 is sufficient for a host with simple mail requirements. As an introduction to
5551 the way Exim is configured, this chapter &"walks through"& the default
5552 configuration, giving brief explanations of the settings. Detailed descriptions
5553 of the options are given in subsequent chapters. The default configuration file
5554 itself contains extensive comments about ways you might want to modify the
5555 initial settings. However, note that there are many options that are not
5556 mentioned at all in the default configuration.
5557
5558
5559
5560 .section "Macros" "SECTdefconfmacros"
5561 All macros should be defined before any options.
5562
5563 One macro is specified, but commented out, in the default configuration:
5564 .code
5565 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5566 .endd
5567 If all off-site mail is expected to be delivered to a "smarthost", then set the
5568 hostname here and uncomment the macro.  This will affect which router is used
5569 later on.  If this is left commented out, then Exim will perform direct-to-MX
5570 deliveries using a &(dnslookup)& router.
5571
5572 In addition to macros defined here, Exim includes a number of built-in macros
5573 to enable configuration to be guarded by a binary built with support for a
5574 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5575
5576
5577 .section "Main configuration settings" "SECTdefconfmain"
5578 The main (global) configuration option settings section must always come first
5579 in the file, after the macros.
5580 The first thing you'll see in the file, after some initial comments, is the line
5581 .code
5582 # primary_hostname =
5583 .endd
5584 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5585 to know the official, fully qualified name of your host, and this is where you
5586 can specify it. However, in most cases you do not need to set this option. When
5587 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5588
5589 The first three non-comment configuration lines are as follows:
5590 .code
5591 domainlist local_domains    = @
5592 domainlist relay_to_domains =
5593 hostlist   relay_from_hosts = 127.0.0.1
5594 .endd
5595 These are not, in fact, option settings. They are definitions of two named
5596 domain lists and one named host list. Exim allows you to give names to lists of
5597 domains, hosts, and email addresses, in order to make it easier to manage the
5598 configuration file (see section &<<SECTnamedlists>>&).
5599
5600 The first line defines a domain list called &'local_domains'&; this is used
5601 later in the configuration to identify domains that are to be delivered
5602 on the local host.
5603
5604 .cindex "@ in a domain list"
5605 There is just one item in this list, the string &"@"&. This is a special form
5606 of entry which means &"the name of the local host"&. Thus, if the local host is
5607 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5608 be delivered locally. Because the local host's name is referenced indirectly,
5609 the same configuration file can be used on different hosts.
5610
5611 The second line defines a domain list called &'relay_to_domains'&, but the
5612 list itself is empty. Later in the configuration we will come to the part that
5613 controls mail relaying through the local host; it allows relaying to any
5614 domains in this list. By default, therefore, no relaying on the basis of a mail
5615 domain is permitted.
5616
5617 The third line defines a host list called &'relay_from_hosts'&. This list is
5618 used later in the configuration to permit relaying from any host or IP address
5619 that matches the list. The default contains just the IP address of the IPv4
5620 loopback interface, which means that processes on the local host are able to
5621 submit mail for relaying by sending it over TCP/IP to that interface. No other
5622 hosts are permitted to submit messages for relaying.
5623
5624 Just to be sure there's no misunderstanding: at this point in the configuration
5625 we aren't actually setting up any controls. We are just defining some domains
5626 and hosts that will be used in the controls that are specified later.
5627
5628 The next two configuration lines are genuine option settings:
5629 .code
5630 acl_smtp_rcpt = acl_check_rcpt
5631 acl_smtp_data = acl_check_data
5632 .endd
5633 These options specify &'Access Control Lists'& (ACLs) that are to be used
5634 during an incoming SMTP session for every recipient of a message (every RCPT
5635 command), and after the contents of the message have been received,
5636 respectively. The names of the lists are &'acl_check_rcpt'& and
5637 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5638 section of the configuration. The RCPT ACL controls which recipients are
5639 accepted for an incoming message &-- if a configuration does not provide an ACL
5640 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5641 contents of a message to be checked.
5642
5643 Two commented-out option settings are next:
5644 .code
5645 # av_scanner = clamd:/tmp/clamd
5646 # spamd_address = 127.0.0.1 783
5647 .endd
5648 These are example settings that can be used when Exim is compiled with the
5649 content-scanning extension. The first specifies the interface to the virus
5650 scanner, and the second specifies the interface to SpamAssassin. Further
5651 details are given in chapter &<<CHAPexiscan>>&.
5652
5653 Three more commented-out option settings follow:
5654 .code
5655 # tls_advertise_hosts = *
5656 # tls_certificate = /etc/ssl/exim.crt
5657 # tls_privatekey = /etc/ssl/exim.pem
5658 .endd
5659 These are example settings that can be used when Exim is compiled with
5660 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5661 first one specifies the list of clients that are allowed to use TLS when
5662 connecting to this server; in this case, the wildcard means all clients. The
5663 other options specify where Exim should find its TLS certificate and private
5664 key, which together prove the server's identity to any clients that connect.
5665 More details are given in chapter &<<CHAPTLS>>&.
5666
5667 Another two commented-out option settings follow:
5668 .code
5669 # daemon_smtp_ports = 25 : 465 : 587
5670 # tls_on_connect_ports = 465
5671 .endd
5672 .cindex "port" "465 and 587"
5673 .cindex "port" "for message submission"
5674 .cindex "message" "submission, ports for"
5675 .cindex "submissions protocol"
5676 .cindex "smtps protocol"
5677 .cindex "ssmtp protocol"
5678 .cindex "SMTP" "submissions protocol"
5679 .cindex "SMTP" "ssmtp protocol"
5680 .cindex "SMTP" "smtps protocol"
5681 These options provide better support for roaming users who wish to use this
5682 server for message submission. They are not much use unless you have turned on
5683 TLS (as described in the previous paragraph) and authentication (about which
5684 more in section &<<SECTdefconfauth>>&).
5685 Mail submission from mail clients (MUAs) should be separate from inbound mail
5686 to your domain (MX delivery) for various good reasons (eg, ability to impose
5687 much saner TLS protocol and ciphersuite requirements without unintended
5688 consequences).
5689 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5690 which uses STARTTLS, so this is the &"submission"& port.
5691 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5692 which should be used in preference to 587.
5693 You should also consider deploying SRV records to help clients find
5694 these ports.
5695 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5696
5697 Two more commented-out options settings follow:
5698 .code
5699 # qualify_domain =
5700 # qualify_recipient =
5701 .endd
5702 The first of these specifies a domain that Exim uses when it constructs a
5703 complete email address from a local login name. This is often needed when Exim
5704 receives a message from a local process. If you do not set &%qualify_domain%&,
5705 the value of &%primary_hostname%& is used. If you set both of these options,
5706 you can have different qualification domains for sender and recipient
5707 addresses. If you set only the first one, its value is used in both cases.
5708
5709 .cindex "domain literal" "recognizing format"
5710 The following line must be uncommented if you want Exim to recognize
5711 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5712 (an IP address within square brackets) instead of a named domain.
5713 .code
5714 # allow_domain_literals
5715 .endd
5716 The RFCs still require this form, but many people think that in the modern
5717 Internet it makes little sense to permit mail to be sent to specific hosts by
5718 quoting their IP addresses. This ancient format has been used by people who
5719 try to abuse hosts by using them for unwanted relaying. However, some
5720 people believe there are circumstances (for example, messages addressed to
5721 &'postmaster'&) where domain literals are still useful.
5722
5723 The next configuration line is a kind of trigger guard:
5724 .code
5725 never_users = root
5726 .endd
5727 It specifies that no delivery must ever be run as the root user. The normal
5728 convention is to set up &'root'& as an alias for the system administrator. This
5729 setting is a guard against slips in the configuration.
5730 The list of users specified by &%never_users%& is not, however, the complete
5731 list; the build-time configuration in &_Local/Makefile_& has an option called
5732 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5733 contents of &%never_users%& are added to this list. By default
5734 FIXED_NEVER_USERS also specifies root.
5735
5736 When a remote host connects to Exim in order to send mail, the only information
5737 Exim has about the host's identity is its IP address. The next configuration
5738 line,
5739 .code
5740 host_lookup = *
5741 .endd
5742 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5743 in order to get a host name. This improves the quality of the logging
5744 information, but if you feel it is too expensive, you can remove it entirely,
5745 or restrict the lookup to hosts on &"nearby"& networks.
5746 Note that it is not always possible to find a host name from an IP address,
5747 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5748 unreachable.
5749
5750 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5751 1413 (hence their names):
5752 .code
5753 rfc1413_hosts = *
5754 rfc1413_query_timeout = 0s
5755 .endd
5756 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5757 Few hosts offer RFC1413 service these days; calls have to be
5758 terminated by a timeout and this needlessly delays the startup
5759 of an incoming SMTP connection.
5760 If you have hosts for which you trust RFC1413 and need this
5761 information, you can change this.
5762
5763 This line enables an efficiency SMTP option.  It is negotiated by clients
5764 and not expected to cause problems but can be disabled if needed.
5765 .code
5766 prdr_enable = true
5767 .endd
5768
5769 When Exim receives messages over SMTP connections, it expects all addresses to
5770 be fully qualified with a domain, as required by the SMTP definition. However,
5771 if you are running a server to which simple clients submit messages, you may
5772 find that they send unqualified addresses. The two commented-out options:
5773 .code
5774 # sender_unqualified_hosts =
5775 # recipient_unqualified_hosts =
5776 .endd
5777 show how you can specify hosts that are permitted to send unqualified sender
5778 and recipient addresses, respectively.
5779
5780 The &%log_selector%& option is used to increase the detail of logging
5781 over the default:
5782 .code
5783 log_selector = +smtp_protocol_error +smtp_syntax_error \
5784                +tls_certificate_verified
5785 .endd
5786
5787 The &%percent_hack_domains%& option is also commented out:
5788 .code
5789 # percent_hack_domains =
5790 .endd
5791 It provides a list of domains for which the &"percent hack"& is to operate.
5792 This is an almost obsolete form of explicit email routing. If you do not know
5793 anything about it, you can safely ignore this topic.
5794
5795 The next two settings in the main part of the default configuration are
5796 concerned with messages that have been &"frozen"& on Exim's queue. When a
5797 message is frozen, Exim no longer continues to try to deliver it. Freezing
5798 occurs when a bounce message encounters a permanent failure because the sender
5799 address of the original message that caused the bounce is invalid, so the
5800 bounce cannot be delivered. This is probably the most common case, but there
5801 are also other conditions that cause freezing, and frozen messages are not
5802 always bounce messages.
5803 .code
5804 ignore_bounce_errors_after = 2d
5805 timeout_frozen_after = 7d
5806 .endd
5807 The first of these options specifies that failing bounce messages are to be
5808 discarded after 2 days in the queue. The second specifies that any frozen
5809 message (whether a bounce message or not) is to be timed out (and discarded)
5810 after a week. In this configuration, the first setting ensures that no failing
5811 bounce message ever lasts a week.
5812
5813 Exim queues it's messages in a spool directory. If you expect to have
5814 large queues, you may consider using this option. It splits the spool
5815 directory into subdirectories to avoid file system degradation from
5816 many files in a single directory, resulting in better performance.
5817 Manual manipulation of queued messages becomes more complex (though fortunately
5818 not often needed).
5819 .code
5820 # split_spool_directory = true
5821 .endd
5822
5823 In an ideal world everybody follows the standards. For non-ASCII
5824 messages RFC 2047 is a standard, allowing a maximum line length of 76
5825 characters. Exim adheres that standard and won't process messages which
5826 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5827 In particular, the Exim maintainers have had multiple reports of
5828 problems from Russian administrators of issues until they disable this
5829 check, because of some popular, yet buggy, mail composition software.
5830 .code
5831 # check_rfc2047_length = false
5832 .endd
5833
5834 If you need to be strictly RFC compliant you may wish to disable the
5835 8BITMIME advertisement. Use this, if you exchange mails with systems
5836 that are not 8-bit clean.
5837 .code
5838 # accept_8bitmime = false
5839 .endd
5840
5841 Libraries you use may depend on specific environment settings.  This
5842 imposes a security risk (e.g. PATH). There are two lists:
5843 &%keep_environment%& for the variables to import as they are, and
5844 &%add_environment%& for variables we want to set to a fixed value.
5845 Note that TZ is handled separately, by the $%timezone%$ runtime
5846 option and by the TIMEZONE_DEFAULT buildtime option.
5847 .code
5848 # keep_environment = ^LDAP
5849 # add_environment = PATH=/usr/bin::/bin
5850 .endd
5851
5852
5853 .section "ACL configuration" "SECID54"
5854 .cindex "default" "ACLs"
5855 .cindex "&ACL;" "default configuration"
5856 In the default configuration, the ACL section follows the main configuration.
5857 It starts with the line
5858 .code
5859 begin acl
5860 .endd
5861 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5862 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5863 and &%acl_smtp_data%& above.
5864
5865 .cindex "RCPT" "ACL for"
5866 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5867 RCPT command specifies one of the message's recipients. The ACL statements
5868 are considered in order, until the recipient address is either accepted or
5869 rejected. The RCPT command is then accepted or rejected, according to the
5870 result of the ACL processing.
5871 .code
5872 acl_check_rcpt:
5873 .endd
5874 This line, consisting of a name terminated by a colon, marks the start of the
5875 ACL, and names it.
5876 .code
5877 accept  hosts = :
5878 .endd
5879 This ACL statement accepts the recipient if the sending host matches the list.
5880 But what does that strange list mean? It doesn't actually contain any host
5881 names or IP addresses. The presence of the colon puts an empty item in the
5882 list; Exim matches this only if the incoming message did not come from a remote
5883 host, because in that case, the remote hostname is empty. The colon is
5884 important. Without it, the list itself is empty, and can never match anything.
5885
5886 What this statement is doing is to accept unconditionally all recipients in
5887 messages that are submitted by SMTP from local processes using the standard
5888 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5889 manner.
5890 .code
5891 deny    message       = Restricted characters in address
5892         domains       = +local_domains
5893         local_parts   = ^[.] : ^.*[@%!/|]
5894
5895 deny    message       = Restricted characters in address
5896         domains       = !+local_domains
5897         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5898 .endd
5899 These statements are concerned with local parts that contain any of the
5900 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5901 Although these characters are entirely legal in local parts (in the case of
5902 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5903 in Internet mail addresses.
5904
5905 The first three have in the past been associated with explicitly routed
5906 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5907 option). Addresses containing these characters are regularly tried by spammers
5908 in an attempt to bypass relaying restrictions, and also by open relay testing
5909 programs. Unless you really need them it is safest to reject these characters
5910 at this early stage. This configuration is heavy-handed in rejecting these
5911 characters for all messages it accepts from remote hosts. This is a deliberate
5912 policy of being as safe as possible.
5913
5914 The first rule above is stricter, and is applied to messages that are addressed
5915 to one of the local domains handled by this host. This is implemented by the
5916 first condition, which restricts it to domains that are listed in the
5917 &'local_domains'& domain list. The &"+"& character is used to indicate a
5918 reference to a named list. In this configuration, there is just one domain in
5919 &'local_domains'&, but in general there may be many.
5920
5921 The second condition on the first statement uses two regular expressions to
5922 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5923 or &"|"&. If you have local accounts that include these characters, you will
5924 have to modify this rule.
5925
5926 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5927 allows them because they have been encountered in practice. (Consider the
5928 common convention of local parts constructed as
5929 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5930 the author of Exim, who has no second initial.) However, a local part starting
5931 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5932 filename (for example, for a mailing list). This is also true for local parts
5933 that contain slashes. A pipe symbol can also be troublesome if the local part
5934 is incorporated unthinkingly into a shell command line.
5935
5936 The second rule above applies to all other domains, and is less strict. This
5937 allows your own users to send outgoing messages to sites that use slashes
5938 and vertical bars in their local parts. It blocks local parts that begin
5939 with a dot, slash, or vertical bar, but allows these characters within the
5940 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5941 and &"!"& is blocked, as before. The motivation here is to prevent your users
5942 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5943 .code
5944 accept  local_parts   = postmaster
5945         domains       = +local_domains
5946 .endd
5947 This statement, which has two conditions, accepts an incoming address if the
5948 local part is &'postmaster'& and the domain is one of those listed in the
5949 &'local_domains'& domain list. The &"+"& character is used to indicate a
5950 reference to a named list. In this configuration, there is just one domain in
5951 &'local_domains'&, but in general there may be many.
5952
5953 The presence of this statement means that mail to postmaster is never blocked
5954 by any of the subsequent tests. This can be helpful while sorting out problems
5955 in cases where the subsequent tests are incorrectly denying access.
5956 .code
5957 require verify        = sender
5958 .endd
5959 This statement requires the sender address to be verified before any subsequent
5960 ACL statement can be used. If verification fails, the incoming recipient
5961 address is refused. Verification consists of trying to route the address, to
5962 see if a bounce message could be delivered to it. In the case of remote
5963 addresses, basic verification checks only the domain, but &'callouts'& can be
5964 used for more verification if required. Section &<<SECTaddressverification>>&
5965 discusses the details of address verification.
5966 .code
5967 accept  hosts         = +relay_from_hosts
5968         control       = submission
5969 .endd
5970 This statement accepts the address if the message is coming from one of the
5971 hosts that are defined as being allowed to relay through this host. Recipient
5972 verification is omitted here, because in many cases the clients are dumb MUAs
5973 that do not cope well with SMTP error responses. For the same reason, the
5974 second line specifies &"submission mode"& for messages that are accepted. This
5975 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5976 messages that are deficient in some way, for example, because they lack a
5977 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5978 probably add recipient verification here, and disable submission mode.
5979 .code
5980 accept  authenticated = *
5981         control       = submission
5982 .endd
5983 This statement accepts the address if the client host has authenticated itself.
5984 Submission mode is again specified, on the grounds that such messages are most
5985 likely to come from MUAs. The default configuration does not define any
5986 authenticators, though it does include some nearly complete commented-out
5987 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5988 fact authenticate until you complete the authenticator definitions.
5989 .code
5990 require message = relay not permitted
5991         domains = +local_domains : +relay_to_domains
5992 .endd
5993 This statement rejects the address if its domain is neither a local domain nor
5994 one of the domains for which this host is a relay.
5995 .code
5996 require verify = recipient
5997 .endd
5998 This statement requires the recipient address to be verified; if verification
5999 fails, the address is rejected.
6000 .code
6001 # deny    message     = rejected because $sender_host_address \
6002 #                       is in a black list at $dnslist_domain\n\
6003 #                       $dnslist_text
6004 #         dnslists    = black.list.example
6005 #
6006 # warn    dnslists    = black.list.example
6007 #         add_header  = X-Warning: $sender_host_address is in \
6008 #                       a black list at $dnslist_domain
6009 #         log_message = found in $dnslist_domain
6010 .endd
6011 These commented-out lines are examples of how you could configure Exim to check
6012 sending hosts against a DNS black list. The first statement rejects messages
6013 from blacklisted hosts, whereas the second just inserts a warning header
6014 line.
6015 .code
6016 # require verify = csa
6017 .endd
6018 This commented-out line is an example of how you could turn on client SMTP
6019 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6020 records.
6021 .code
6022 accept
6023 .endd
6024 The final statement in the first ACL unconditionally accepts any recipient
6025 address that has successfully passed all the previous tests.
6026 .code
6027 acl_check_data:
6028 .endd
6029 This line marks the start of the second ACL, and names it. Most of the contents
6030 of this ACL are commented out:
6031 .code
6032 # deny    malware   = *
6033 #         message   = This message contains a virus \
6034 #                     ($malware_name).
6035 .endd
6036 These lines are examples of how to arrange for messages to be scanned for
6037 viruses when Exim has been compiled with the content-scanning extension, and a
6038 suitable virus scanner is installed. If the message is found to contain a
6039 virus, it is rejected with the given custom error message.
6040 .code
6041 # warn    spam      = nobody
6042 #         message   = X-Spam_score: $spam_score\n\
6043 #                     X-Spam_score_int: $spam_score_int\n\
6044 #                     X-Spam_bar: $spam_bar\n\
6045 #                     X-Spam_report: $spam_report
6046 .endd
6047 These lines are an example of how to arrange for messages to be scanned by
6048 SpamAssassin when Exim has been compiled with the content-scanning extension,
6049 and SpamAssassin has been installed. The SpamAssassin check is run with
6050 &`nobody`& as its user parameter, and the results are added to the message as a
6051 series of extra header line. In this case, the message is not rejected,
6052 whatever the spam score.
6053 .code
6054 accept
6055 .endd
6056 This final line in the DATA ACL accepts the message unconditionally.
6057
6058
6059 .section "Router configuration" "SECID55"
6060 .cindex "default" "routers"
6061 .cindex "routers" "default"
6062 The router configuration comes next in the default configuration, introduced
6063 by the line
6064 .code
6065 begin routers
6066 .endd
6067 Routers are the modules in Exim that make decisions about where to send
6068 messages. An address is passed to each router, in turn, until it is either
6069 accepted, or failed. This means that the order in which you define the routers
6070 matters. Each router is fully described in its own chapter later in this
6071 manual. Here we give only brief overviews.
6072 .code
6073 # domain_literal:
6074 #   driver = ipliteral
6075 #   domains = !+local_domains
6076 #   transport = remote_smtp
6077 .endd
6078 .cindex "domain literal" "default router"
6079 This router is commented out because the majority of sites do not want to
6080 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6081 you uncomment this router, you also need to uncomment the setting of
6082 &%allow_domain_literals%& in the main part of the configuration.
6083
6084 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6085 macro has been defined, per
6086 .code
6087 .ifdef ROUTER_SMARTHOST
6088 smarthost:
6089 #...
6090 .else
6091 dnslookup:
6092 #...
6093 .endif
6094 .endd
6095
6096 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6097 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6098 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6099 skip these routers because of the &%domains%& option.
6100
6101 .code
6102 smarthost:
6103   driver = manualroute
6104   domains = ! +local_domains
6105   transport = smarthost_smtp
6106   route_data = ROUTER_SMARTHOST
6107   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6108   no_more
6109 .endd
6110 This router only handles mail which is not to any local domains; this is
6111 specified by the line
6112 .code
6113 domains = ! +local_domains
6114 .endd
6115 The &%domains%& option lists the domains to which this router applies, but the
6116 exclamation mark is a negation sign, so the router is used only for domains
6117 that are not in the domain list called &'local_domains'& (which was defined at
6118 the start of the configuration). The plus sign before &'local_domains'&
6119 indicates that it is referring to a named list. Addresses in other domains are
6120 passed on to the following routers.
6121
6122 The name of the router driver is &(manualroute)& because we are manually
6123 specifying how mail should be routed onwards, instead of using DNS MX.
6124 While the name of this router instance is arbitrary, the &%driver%& option must
6125 be one of the driver modules that is in the Exim binary.
6126
6127 With no pre-conditions other than &%domains%&, all mail for non-local domains
6128 will be handled by this router, and the &%no_more%& setting will ensure that no
6129 other routers will be used for messages matching the pre-conditions.  See
6130 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6131 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6132 and the macro supplies the value; the address is then queued for the
6133 &(smarthost_smtp)& transport.
6134
6135 .code
6136 dnslookup:
6137   driver = dnslookup
6138   domains = ! +local_domains
6139   transport = remote_smtp
6140   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6141   no_more
6142 .endd
6143 The &%domains%& option behaves as per smarthost, above.
6144
6145 The name of the router driver is &(dnslookup)&,
6146 and is specified by the &%driver%& option. Do not be confused by the fact that
6147 the name of this router instance is the same as the name of the driver. The
6148 instance name is arbitrary, but the name set in the &%driver%& option must be
6149 one of the driver modules that is in the Exim binary.
6150
6151 The &(dnslookup)& router routes addresses by looking up their domains in the
6152 DNS in order to obtain a list of hosts to which the address is routed. If the
6153 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6154 specified by the &%transport%& option. If the router does not find the domain
6155 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6156 the address fails and is bounced.
6157
6158 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6159 be entirely ignored. This option is present because a number of cases have been
6160 encountered where MX records in the DNS point to host names
6161 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6162 Completely ignoring these IP addresses causes Exim to fail to route the
6163 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6164 continue to try to deliver the message periodically until the address timed
6165 out.
6166 .code
6167 system_aliases:
6168   driver = redirect
6169   allow_fail
6170   allow_defer
6171   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6172 # user = exim
6173   file_transport = address_file
6174   pipe_transport = address_pipe
6175 .endd
6176 Control reaches this and subsequent routers only for addresses in the local
6177 domains. This router checks to see whether the local part is defined as an
6178 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6179 data that it looks up from that file. If no data is found for the local part,
6180 the value of the &%data%& option is empty, causing the address to be passed to
6181 the next router.
6182
6183 &_/etc/aliases_& is a conventional name for the system aliases file that is
6184 often used. That is why it is referenced by from the default configuration
6185 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6186 &_Local/Makefile_& before building Exim.
6187 .code
6188 userforward:
6189   driver = redirect
6190   check_local_user
6191 # local_part_suffix = +* : -*
6192 # local_part_suffix_optional
6193   file = $home/.forward
6194 # allow_filter
6195   no_verify
6196   no_expn
6197   check_ancestor
6198   file_transport = address_file
6199   pipe_transport = address_pipe
6200   reply_transport = address_reply
6201 .endd
6202 This is the most complicated router in the default configuration. It is another
6203 redirection router, but this time it is looking for forwarding data set up by
6204 individual users. The &%check_local_user%& setting specifies a check that the
6205 local part of the address is the login name of a local user. If it is not, the
6206 router is skipped. The two commented options that follow &%check_local_user%&,
6207 namely:
6208 .code
6209 # local_part_suffix = +* : -*
6210 # local_part_suffix_optional
6211 .endd
6212 .vindex "&$local_part_suffix$&"
6213 show how you can specify the recognition of local part suffixes. If the first
6214 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6215 by any sequence of characters, is removed from the local part and placed in the
6216 variable &$local_part_suffix$&. The second suffix option specifies that the
6217 presence of a suffix in the local part is optional. When a suffix is present,
6218 the check for a local login uses the local part with the suffix removed.
6219
6220 When a local user account is found, the file called &_.forward_& in the user's
6221 home directory is consulted. If it does not exist, or is empty, the router
6222 declines. Otherwise, the contents of &_.forward_& are interpreted as
6223 redirection data (see chapter &<<CHAPredirect>>& for more details).
6224
6225 .cindex "Sieve filter" "enabling in default router"
6226 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6227 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6228 is commented out by default), the contents of the file are interpreted as a set
6229 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6230 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6231 separate document entitled &'Exim's interfaces to mail filtering'&.
6232
6233 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6234 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6235 There are two reasons for doing this:
6236
6237 .olist
6238 Whether or not a local user has a &_.forward_& file is not really relevant when
6239 checking an address for validity; it makes sense not to waste resources doing
6240 unnecessary work.
6241 .next
6242 More importantly, when Exim is verifying addresses or handling an EXPN
6243 command during an SMTP session, it is running as the Exim user, not as root.
6244 The group is the Exim group, and no additional groups are set up.
6245 It may therefore not be possible for Exim to read users' &_.forward_& files at
6246 this time.
6247 .endlist
6248
6249 The setting of &%check_ancestor%& prevents the router from generating a new
6250 address that is the same as any previous address that was redirected. (This
6251 works round a problem concerning a bad interaction between aliasing and
6252 forwarding &-- see section &<<SECTredlocmai>>&).
6253
6254 The final three option settings specify the transports that are to be used when
6255 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6256 auto-reply, respectively. For example, if a &_.forward_& file contains
6257 .code
6258 a.nother@elsewhere.example, /home/spqr/archive
6259 .endd
6260 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6261 transport.
6262 .code
6263 localuser:
6264   driver = accept
6265   check_local_user
6266 # local_part_suffix = +* : -*
6267 # local_part_suffix_optional
6268   transport = local_delivery
6269 .endd
6270 The final router sets up delivery into local mailboxes, provided that the local
6271 part is the name of a local login, by accepting the address and assigning it to
6272 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6273 routers, so the address is bounced. The commented suffix settings fulfil the
6274 same purpose as they do for the &(userforward)& router.
6275
6276
6277 .section "Transport configuration" "SECID56"
6278 .cindex "default" "transports"
6279 .cindex "transports" "default"
6280 Transports define mechanisms for actually delivering messages. They operate
6281 only when referenced from routers, so the order in which they are defined does
6282 not matter. The transports section of the configuration starts with
6283 .code
6284 begin transports
6285 .endd
6286 Two remote transports and four local transports are defined.
6287 .code
6288 remote_smtp:
6289   driver = smtp
6290   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6291 .ifdef _HAVE_PRDR
6292   hosts_try_prdr = *
6293 .endif
6294 .endd
6295 This transport is used for delivering messages over SMTP connections.
6296 The list of remote hosts comes from the router.
6297 The &%message_size_limit%& usage is a hack to avoid sending on messages
6298 with over-long lines.
6299
6300 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6301 negotiated between client and server and not expected to cause problems
6302 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6303 use of the &%hosts_try_prdr%& configuration option.
6304
6305 The other remote transport is used when delivering to a specific smarthost
6306 with whom there must be some kind of existing relationship, instead of the
6307 usual federated system.
6308
6309 .code
6310 smarthost_smtp:
6311   driver = smtp
6312   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6313   multi_domain
6314   #
6315 .ifdef _HAVE_TLS
6316   # Comment out any of these which you have to, then file a Support
6317   # request with your smarthost provider to get things fixed:
6318   hosts_require_tls = *
6319   tls_verify_hosts = *
6320   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6321   # have to comment it out then this will at least log whether you succeed
6322   # or not:
6323   tls_try_verify_hosts = *
6324   #
6325   # The SNI name should match the name which we'll expect to verify;
6326   # many mail systems don't use SNI and this doesn't matter, but if it does,
6327   # we need to send a name which the remote site will recognize.
6328   # This _should_ be the name which the smarthost operators specified as
6329   # the hostname for sending your mail to.
6330   tls_sni = ROUTER_SMARTHOST
6331   #
6332 .ifdef _HAVE_OPENSSL
6333   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6334 .endif
6335 .ifdef _HAVE_GNUTLS
6336   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6337 .endif
6338 .endif
6339 .ifdef _HAVE_PRDR
6340   hosts_try_prdr = *
6341 .endif
6342 .endd
6343 After the same &%message_size_limit%& hack, we then specify that this Transport
6344 can handle messages to multiple domains in one run.  The assumption here is
6345 that you're routing all non-local mail to the same place and that place is
6346 happy to take all messages from you as quickly as possible.
6347 All other options depend upon built-in macros; if Exim was built without TLS support
6348 then no other options are defined.
6349 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6350 and versions using the &%tls_require_ciphers%& option, where the value to be
6351 used depends upon the library providing TLS.
6352 Beyond that, the options adopt the stance that you should have TLS support available
6353 from your smarthost on today's Internet, so we turn on requiring TLS for the
6354 mail to be delivered, and requiring that the certificate be valid, and match
6355 the expected hostname.  The &%tls_sni%& option can be used by service providers
6356 to select an appropriate certificate to present to you and here we re-use the
6357 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6358 You want to specify the hostname which you'll expect to validate for, and that
6359 should not be subject to insecure tampering via DNS results.
6360
6361 For the &%hosts_try_prdr%& option see the previous transport.
6362
6363 All other options are defaulted.
6364 .code
6365 local_delivery:
6366   driver = appendfile
6367   file = /var/mail/$local_part_verified
6368   delivery_date_add
6369   envelope_to_add
6370   return_path_add
6371 # group = mail
6372 # mode = 0660
6373 .endd
6374 This &(appendfile)& transport is used for local delivery to user mailboxes in
6375 traditional BSD mailbox format.
6376
6377 .new
6378 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6379 as it is provided by a potential bad actor.
6380 Instead we use &$local_part_verified$&,
6381 the result of looking up &$local_part$& in the user database
6382 (done by using &%check_local_user%& in the the router).
6383 .wen
6384
6385 By default &(appendfile)& runs under the uid and gid of the
6386 local user, which requires the sticky bit to be set on the &_/var/mail_&
6387 directory. Some systems use the alternative approach of running mail deliveries
6388 under a particular group instead of using the sticky bit. The commented options
6389 show how this can be done.
6390
6391 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6392 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6393 similarly-named options above.
6394 .code
6395 address_pipe:
6396   driver = pipe
6397   return_output
6398 .endd
6399 This transport is used for handling deliveries to pipes that are generated by
6400 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6401 option specifies that any output on stdout or stderr generated by the pipe is to
6402 be returned to the sender.
6403 .code
6404 address_file:
6405   driver = appendfile
6406   delivery_date_add
6407   envelope_to_add
6408   return_path_add
6409 .endd
6410 This transport is used for handling deliveries to files that are generated by
6411 redirection. The name of the file is not specified in this instance of
6412 &(appendfile)&, because it comes from the &(redirect)& router.
6413 .code
6414 address_reply:
6415   driver = autoreply
6416 .endd
6417 This transport is used for handling automatic replies generated by users'
6418 filter files.
6419
6420
6421
6422 .section "Default retry rule" "SECID57"
6423 .cindex "retry" "default rule"
6424 .cindex "default" "retry rule"
6425 The retry section of the configuration file contains rules which affect the way
6426 Exim retries deliveries that cannot be completed at the first attempt. It is
6427 introduced by the line
6428 .code
6429 begin retry
6430 .endd
6431 In the default configuration, there is just one rule, which applies to all
6432 errors:
6433 .code
6434 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6435 .endd
6436 This causes any temporarily failing address to be retried every 15 minutes for
6437 2 hours, then at intervals starting at one hour and increasing by a factor of
6438 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6439 is not delivered after 4 days of temporary failure, it is bounced. The time is
6440 measured from first failure, not from the time the message was received.
6441
6442 If the retry section is removed from the configuration, or is empty (that is,
6443 if no retry rules are defined), Exim will not retry deliveries. This turns
6444 temporary errors into permanent errors.
6445
6446
6447 .section "Rewriting configuration" "SECID58"
6448 The rewriting section of the configuration, introduced by
6449 .code
6450 begin rewrite
6451 .endd
6452 contains rules for rewriting addresses in messages as they arrive. There are no
6453 rewriting rules in the default configuration file.
6454
6455
6456
6457 .section "Authenticators configuration" "SECTdefconfauth"
6458 .cindex "AUTH" "configuration"
6459 The authenticators section of the configuration, introduced by
6460 .code
6461 begin authenticators
6462 .endd
6463 defines mechanisms for the use of the SMTP AUTH command. The default
6464 configuration file contains two commented-out example authenticators
6465 which support plaintext username/password authentication using the
6466 standard PLAIN mechanism and the traditional but non-standard LOGIN
6467 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6468 to support most MUA software.
6469
6470 The example PLAIN authenticator looks like this:
6471 .code
6472 #PLAIN:
6473 #  driver                  = plaintext
6474 #  server_set_id           = $auth2
6475 #  server_prompts          = :
6476 #  server_condition        = Authentication is not yet configured
6477 #  server_advertise_condition = ${if def:tls_in_cipher }
6478 .endd
6479 And the example LOGIN authenticator looks like this:
6480 .code
6481 #LOGIN:
6482 #  driver                  = plaintext
6483 #  server_set_id           = $auth1
6484 #  server_prompts          = <| Username: | Password:
6485 #  server_condition        = Authentication is not yet configured
6486 #  server_advertise_condition = ${if def:tls_in_cipher }
6487 .endd
6488
6489 The &%server_set_id%& option makes Exim remember the authenticated username
6490 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6491 &%server_prompts%& option configures the &(plaintext)& authenticator so
6492 that it implements the details of the specific authentication mechanism,
6493 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6494 when Exim offers authentication to clients; in the examples, this is only
6495 when TLS or SSL has been started, so to enable the authenticators you also
6496 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6497
6498 The &%server_condition%& setting defines how to verify that the username and
6499 password are correct. In the examples it just produces an error message.
6500 To make the authenticators work, you can use a string expansion
6501 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6502
6503 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6504 usercode and password are in different positions.
6505 Chapter &<<CHAPplaintext>>& covers both.
6506
6507 .ecindex IIDconfiwal
6508
6509
6510
6511 . ////////////////////////////////////////////////////////////////////////////
6512 . ////////////////////////////////////////////////////////////////////////////
6513
6514 .chapter "Regular expressions" "CHAPregexp"
6515
6516 .cindex "regular expressions" "library"
6517 .cindex "PCRE"
6518 Exim supports the use of regular expressions in many of its options. It
6519 uses the PCRE regular expression library; this provides regular expression
6520 matching that is compatible with Perl 5. The syntax and semantics of
6521 regular expressions is discussed in
6522 online Perl manpages, in
6523 many Perl reference books, and also in
6524 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6525 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6526 . --- the http: URL here redirects to another page with the ISBN in the URL
6527 . --- where trying to use https: just redirects back to http:, so sticking
6528 . --- to the old URL for now.  2018-09-07.
6529
6530 The documentation for the syntax and semantics of the regular expressions that
6531 are supported by PCRE is included in the PCRE distribution, and no further
6532 description is included here. The PCRE functions are called from Exim using
6533 the default option settings (that is, with no PCRE options set), except that
6534 the PCRE_CASELESS option is set when the matching is required to be
6535 case-insensitive.
6536
6537 In most cases, when a regular expression is required in an Exim configuration,
6538 it has to start with a circumflex, in order to distinguish it from plain text
6539 or an &"ends with"& wildcard. In this example of a configuration setting, the
6540 second item in the colon-separated list is a regular expression.
6541 .code
6542 domains = a.b.c : ^\\d{3} : *.y.z : ...
6543 .endd
6544 The doubling of the backslash is required because of string expansion that
6545 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6546 of this issue, and a way of avoiding the need for doubling backslashes. The
6547 regular expression that is eventually used in this example contains just one
6548 backslash. The circumflex is included in the regular expression, and has the
6549 normal effect of &"anchoring"& it to the start of the string that is being
6550 matched.
6551
6552 There are, however, two cases where a circumflex is not required for the
6553 recognition of a regular expression: these are the &%match%& condition in a
6554 string expansion, and the &%matches%& condition in an Exim filter file. In
6555 these cases, the relevant string is always treated as a regular expression; if
6556 it does not start with a circumflex, the expression is not anchored, and can
6557 match anywhere in the subject string.
6558
6559 In all cases, if you want a regular expression to match at the end of a string,
6560 you must code the $ metacharacter to indicate this. For example:
6561 .code
6562 domains = ^\\d{3}\\.example
6563 .endd
6564 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6565 You need to use:
6566 .code
6567 domains = ^\\d{3}\\.example\$
6568 .endd
6569 if you want &'example'& to be the top-level domain. The backslash before the
6570 $ is needed because string expansion also interprets dollar characters.
6571
6572
6573
6574 . ////////////////////////////////////////////////////////////////////////////
6575 . ////////////////////////////////////////////////////////////////////////////
6576
6577 .chapter "File and database lookups" "CHAPfdlookup"
6578 .scindex IIDfidalo1 "file" "lookups"
6579 .scindex IIDfidalo2 "database" "lookups"
6580 .cindex "lookup" "description of"
6581 Exim can be configured to look up data in files or databases as it processes
6582 messages. Two different kinds of syntax are used:
6583
6584 .olist
6585 A string that is to be expanded may contain explicit lookup requests. These
6586 cause parts of the string to be replaced by data that is obtained from the
6587 lookup. Lookups of this type are conditional expansion items. Different results
6588 can be defined for the cases of lookup success and failure. See chapter
6589 &<<CHAPexpand>>&, where string expansions are described in detail.
6590 The key for the lookup is specified as part of the string expansion.
6591 .next
6592 Lists of domains, hosts, and email addresses can contain lookup requests as a
6593 way of avoiding excessively long linear lists. In this case, the data that is
6594 returned by the lookup is often (but not always) discarded; whether the lookup
6595 succeeds or fails is what really counts. These kinds of list are described in
6596 chapter &<<CHAPdomhosaddlists>>&.
6597 The key for the lookup is given by the context in which the list is expanded.
6598 .endlist
6599
6600 String expansions, lists, and lookups interact with each other in such a way
6601 that there is no order in which to describe any one of them that does not
6602 involve references to the others. Each of these three chapters makes more sense
6603 if you have read the other two first. If you are reading this for the first
6604 time, be aware that some of it will make a lot more sense after you have read
6605 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6606
6607 .section "Examples of different lookup syntax" "SECID60"
6608 It is easy to confuse the two different kinds of lookup, especially as the
6609 lists that may contain the second kind are always expanded before being
6610 processed as lists. Therefore, they may also contain lookups of the first kind.
6611 Be careful to distinguish between the following two examples:
6612 .code
6613 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6614 domains = lsearch;/some/file
6615 .endd
6616 The first uses a string expansion, the result of which must be a domain list.
6617 No strings have been specified for a successful or a failing lookup; the
6618 defaults in this case are the looked-up data and an empty string, respectively.
6619 The expansion takes place before the string is processed as a list, and the
6620 file that is searched could contain lines like this:
6621 .code
6622 192.168.3.4: domain1:domain2:...
6623 192.168.1.9: domain3:domain4:...
6624 .endd
6625 When the lookup succeeds, the result of the expansion is a list of domains (and
6626 possibly other types of item that are allowed in domain lists).
6627
6628 In the second example, the lookup is a single item in a domain list. It causes
6629 Exim to use a lookup to see if the domain that is being processed can be found
6630 in the file. The file could contains lines like this:
6631 .code
6632 domain1:
6633 domain2:
6634 .endd
6635 Any data that follows the keys is not relevant when checking that the domain
6636 matches the list item.
6637
6638 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6639 Consider a file containing lines like this:
6640 .code
6641 192.168.5.6: lsearch;/another/file
6642 .endd
6643 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6644 first &%domains%& setting above generates the second setting, which therefore
6645 causes a second lookup to occur.
6646
6647 The rest of this chapter describes the different lookup types that are
6648 available. Any of them can be used in any part of the configuration where a
6649 lookup is permitted.
6650
6651
6652 .section "Lookup types" "SECID61"
6653 .cindex "lookup" "types of"
6654 .cindex "single-key lookup" "definition of"
6655 Two different types of data lookup are implemented:
6656
6657 .ilist
6658 The &'single-key'& type requires the specification of a file in which to look,
6659 and a single key to search for. The key must be a non-empty string for the
6660 lookup to succeed. The lookup type determines how the file is searched.
6661 .next
6662 .cindex "query-style lookup" "definition of"
6663 The &'query-style'& type accepts a generalized database query. No particular
6664 key value is assumed by Exim for query-style lookups. You can use whichever
6665 Exim variables you need to construct the database query.
6666 .endlist
6667
6668 The code for each lookup type is in a separate source file that is included in
6669 the binary of Exim only if the corresponding compile-time option is set. The
6670 default settings in &_src/EDITME_& are:
6671 .code
6672 LOOKUP_DBM=yes
6673 LOOKUP_LSEARCH=yes
6674 .endd
6675 which means that only linear searching and DBM lookups are included by default.
6676 For some types of lookup (e.g. SQL databases), you need to install appropriate
6677 libraries and header files before building Exim.
6678
6679
6680
6681
6682 .section "Single-key lookup types" "SECTsinglekeylookups"
6683 .cindex "lookup" "single-key types"
6684 .cindex "single-key lookup" "list of types"
6685 The following single-key lookup types are implemented:
6686
6687 .ilist
6688 .cindex "cdb" "description of"
6689 .cindex "lookup" "cdb"
6690 .cindex "binary zero" "in lookup key"
6691 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6692 string without a terminating binary zero. The cdb format is designed for
6693 indexed files that are read frequently and never updated, except by total
6694 re-creation. As such, it is particularly suitable for large files containing
6695 aliases or other indexed data referenced by an MTA. Information about cdb and
6696 tools for building the files can be found in several places:
6697 .display
6698 &url(https://cr.yp.to/cdb.html)
6699 &url(https://www.corpit.ru/mjt/tinycdb.html)
6700 &url(https://packages.debian.org/stable/utils/freecdb)
6701 &url(https://github.com/philpennock/cdbtools) (in Go)
6702 .endd
6703 A cdb distribution is not needed in order to build Exim with cdb support,
6704 because the code for reading cdb files is included directly in Exim itself.
6705 However, no means of building or testing cdb files is provided with Exim, so
6706 you need to obtain a cdb distribution in order to do this.
6707 .next
6708 .cindex "DBM" "lookup type"
6709 .cindex "lookup" "dbm"
6710 .cindex "binary zero" "in lookup key"
6711 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6712 DBM file by looking up the record with the given key. A terminating binary
6713 zero is included in the key that is passed to the DBM library. See section
6714 &<<SECTdb>>& for a discussion of DBM libraries.
6715
6716 .cindex "Berkeley DB library" "file format"
6717 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6718 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6719 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6720 the DB_UNKNOWN option. This enables it to handle any of the types of database
6721 that the library supports, and can be useful for accessing DBM files created by
6722 other applications. (For earlier DB versions, DB_HASH is always used.)
6723 .next
6724 .cindex "lookup" "dbmjz"
6725 .cindex "lookup" "dbm &-- embedded NULs"
6726 .cindex "sasldb2"
6727 .cindex "dbmjz lookup type"
6728 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6729 interpreted as an Exim list; the elements of the list are joined together with
6730 ASCII NUL characters to form the lookup key.  An example usage would be to
6731 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6732 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6733 &(cram_md5)& authenticator.
6734 .next
6735 .cindex "lookup" "dbmnz"
6736 .cindex "lookup" "dbm &-- terminating zero"
6737 .cindex "binary zero" "in lookup key"
6738 .cindex "Courier"
6739 .cindex "&_/etc/userdbshadow.dat_&"
6740 .cindex "dbmnz lookup type"
6741 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6742 is not included in the key that is passed to the DBM library. You may need this
6743 if you want to look up data in files that are created by or shared with some
6744 other application that does not use terminating zeros. For example, you need to
6745 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6746 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6747 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6748 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6749 .next
6750 .cindex "lookup" "dsearch"
6751 .cindex "dsearch lookup type"
6752 &(dsearch)&: The given file must be a directory; this is searched for an entry
6753 whose name is the key by calling the &[lstat()]& function. The key may not
6754 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6755 the lookup is the name of the entry, which may be a file, directory,
6756 symbolic link, or any other kind of directory entry. An example of how this
6757 lookup can be used to support virtual domains is given in section
6758 &<<SECTvirtualdomains>>&.
6759 .next
6760 .cindex "lookup" "iplsearch"
6761 .cindex "iplsearch lookup type"
6762 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6763 terminated by a colon or white space or the end of the line. The keys in the
6764 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6765 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6766 being interpreted as a key terminator. For example:
6767 .code
6768 1.2.3.4:           data for 1.2.3.4
6769 192.168.0.0/16:    data for 192.168.0.0/16
6770 "abcd::cdab":      data for abcd::cdab
6771 "abcd:abcd::/32"   data for abcd:abcd::/32
6772 .endd
6773 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6774 file is searched linearly, using the CIDR masks where present, until a matching
6775 key is found. The first key that matches is used; there is no attempt to find a
6776 &"best"& match. Apart from the way the keys are matched, the processing for
6777 &(iplsearch)& is the same as for &(lsearch)&.
6778
6779 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6780 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6781 lookup types support only literal keys.
6782
6783 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6784 the implicit key is the host's IP address rather than its name (see section
6785 &<<SECThoslispatsikey>>&).
6786
6787 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6788 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6789 notation before executing the lookup.)
6790 .next
6791 .cindex lookup json
6792 .cindex json "lookup type"
6793 .cindex JSON expansions
6794 &(json)&: The given file is a text file with a JSON structure.
6795 An element of the structure is extracted, defined by the search key.
6796 The key is a list of subelement selectors
6797 (colon-separated by default but changeable in the usual way)
6798 which are applied in turn to select smaller and smaller portions
6799 of the JSON structure.
6800 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6801 nunbered array element is selected.
6802 Otherwise it must apply to a JSON object; the named element is selected.
6803 The final resulting element can be a simple JSON type or a JSON object
6804 or array; for the latter two a string-representation os the JSON
6805 is returned.
6806 For elements of type string, the returned value is de-quoted.
6807 .next
6808 .cindex "linear search"
6809 .cindex "lookup" "lsearch"
6810 .cindex "lsearch lookup type"
6811 .cindex "case sensitivity" "in lsearch lookup"
6812 &(lsearch)&: The given file is a text file that is searched linearly for a
6813 line beginning with the search key, terminated by a colon or white space or the
6814 end of the line. The search is case-insensitive; that is, upper and lower case
6815 letters are treated as the same. The first occurrence of the key that is found
6816 in the file is used.
6817
6818 White space between the key and the colon is permitted. The remainder of the
6819 line, with leading and trailing white space removed, is the data. This can be
6820 continued onto subsequent lines by starting them with any amount of white
6821 space, but only a single space character is included in the data at such a
6822 junction. If the data begins with a colon, the key must be terminated by a
6823 colon, for example:
6824 .code
6825 baduser:  :fail:
6826 .endd
6827 Empty lines and lines beginning with # are ignored, even if they occur in the
6828 middle of an item. This is the traditional textual format of alias files. Note
6829 that the keys in an &(lsearch)& file are literal strings. There is no
6830 wildcarding of any kind.
6831
6832 .cindex "lookup" "lsearch &-- colons in keys"
6833 .cindex "white space" "in lsearch key"
6834 In most &(lsearch)& files, keys are not required to contain colons or #
6835 characters, or white space. However, if you need this feature, it is available.
6836 If a key begins with a doublequote character, it is terminated only by a
6837 matching quote (or end of line), and the normal escaping rules apply to its
6838 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6839 quoted keys (exactly as for unquoted keys). There is no special handling of
6840 quotes for the data part of an &(lsearch)& line.
6841
6842 .next
6843 .cindex "NIS lookup type"
6844 .cindex "lookup" "NIS"
6845 .cindex "binary zero" "in lookup key"
6846 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6847 the given key, without a terminating binary zero. There is a variant called
6848 &(nis0)& which does include the terminating binary zero in the key. This is
6849 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6850 aliases; the full map names must be used.
6851
6852 .next
6853 .cindex "wildlsearch lookup type"
6854 .cindex "lookup" "wildlsearch"
6855 .cindex "nwildlsearch lookup type"
6856 .cindex "lookup" "nwildlsearch"
6857 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6858 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6859 the file may be wildcarded. The difference between these two lookup types is
6860 that for &(wildlsearch)&, each key in the file is string-expanded before being
6861 used, whereas for &(nwildlsearch)&, no expansion takes place.
6862
6863 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6864 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6865 file that are regular expressions can be made case-sensitive by the use of
6866 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6867
6868 . ==== As this is a nested list, any displays it contains must be indented
6869 . ==== as otherwise they are too far to the left.
6870
6871 .olist
6872 The string may begin with an asterisk to mean &"ends with"&. For example:
6873 .code
6874     *.a.b.c       data for anything.a.b.c
6875     *fish         data for anythingfish
6876 .endd
6877 .next
6878 The string may begin with a circumflex to indicate a regular expression. For
6879 example, for &(wildlsearch)&:
6880 .code
6881     ^\N\d+\.a\.b\N    data for <digits>.a.b
6882 .endd
6883 Note the use of &`\N`& to disable expansion of the contents of the regular
6884 expression. If you are using &(nwildlsearch)&, where the keys are not
6885 string-expanded, the equivalent entry is:
6886 .code
6887     ^\d+\.a\.b        data for <digits>.a.b
6888 .endd
6889 The case-insensitive flag is set at the start of compiling the regular
6890 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6891 For example, to make the entire pattern case-sensitive:
6892 .code
6893     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6894 .endd
6895
6896 If the regular expression contains white space or colon characters, you must
6897 either quote it (see &(lsearch)& above), or represent these characters in other
6898 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6899 colon. This may be easier than quoting, because if you quote, you have to
6900 escape all the backslashes inside the quotes.
6901
6902 &*Note*&: It is not possible to capture substrings in a regular expression
6903 match for later use, because the results of all lookups are cached. If a lookup
6904 is repeated, the result is taken from the cache, and no actual pattern matching
6905 takes place. The values of all the numeric variables are unset after a
6906 &((n)wildlsearch)& match.
6907
6908 .next
6909 Although I cannot see it being of much use, the general matching function that
6910 is used to implement &((n)wildlsearch)& means that the string may begin with a
6911 lookup name terminated by a semicolon, and followed by lookup data. For
6912 example:
6913 .code
6914     cdb;/some/file  data for keys that match the file
6915 .endd
6916 The data that is obtained from the nested lookup is discarded.
6917 .endlist olist
6918
6919 Keys that do not match any of these patterns are interpreted literally. The
6920 continuation rules for the data are the same as for &(lsearch)&, and keys may
6921 be followed by optional colons.
6922
6923 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6924 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6925 lookup types support only literal keys.
6926
6927 .next
6928 .cindex "lookup" "spf"
6929 If Exim is built with SPF support, manual lookups can be done
6930 (as opposed to the standard ACL condition method.
6931 For details see section &<<SECSPF>>&.
6932 .endlist ilist
6933
6934
6935 .section "Query-style lookup types" "SECTquerystylelookups"
6936 .cindex "lookup" "query-style types"
6937 .cindex "query-style lookup" "list of types"
6938 The supported query-style lookup types are listed below. Further details about
6939 many of them are given in later sections.
6940
6941 .ilist
6942 .cindex "DNS" "as a lookup type"
6943 .cindex "lookup" "DNS"
6944 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6945 are given in the supplied query. The resulting data is the contents of the
6946 records. See section &<<SECTdnsdb>>&.
6947 .next
6948 .cindex "InterBase lookup type"
6949 .cindex "lookup" "InterBase"
6950 &(ibase)&: This does a lookup in an InterBase database.
6951 .next
6952 .cindex "LDAP" "lookup type"
6953 .cindex "lookup" "LDAP"
6954 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6955 returns attributes from a single entry. There is a variant called &(ldapm)&
6956 that permits values from multiple entries to be returned. A third variant
6957 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6958 any attribute values. See section &<<SECTldap>>&.
6959 .next
6960 .cindex "MySQL" "lookup type"
6961 .cindex "lookup" "MySQL"
6962 &(mysql)&: The format of the query is an SQL statement that is passed to a
6963 MySQL database. See section &<<SECTsql>>&.
6964 .next
6965 .cindex "NIS+ lookup type"
6966 .cindex "lookup" "NIS+"
6967 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6968 the field to be returned. See section &<<SECTnisplus>>&.
6969 .next
6970 .cindex "Oracle" "lookup type"
6971 .cindex "lookup" "Oracle"
6972 &(oracle)&: The format of the query is an SQL statement that is passed to an
6973 Oracle database. See section &<<SECTsql>>&.
6974 .next
6975 .cindex "lookup" "passwd"
6976 .cindex "passwd lookup type"
6977 .cindex "&_/etc/passwd_&"
6978 &(passwd)& is a query-style lookup with queries that are just user names. The
6979 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6980 success, the result string is the same as you would get from an &(lsearch)&
6981 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6982 password value. For example:
6983 .code
6984 *:42:42:King Rat:/home/kr:/bin/bash
6985 .endd
6986 .next
6987 .cindex "PostgreSQL lookup type"
6988 .cindex "lookup" "PostgreSQL"
6989 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6990 PostgreSQL database. See section &<<SECTsql>>&.
6991
6992 .next
6993 .cindex "Redis lookup type"
6994 .cindex lookup Redis
6995 &(redis)&: The format of the query is either a simple get or simple set,
6996 passed to a Redis database. See section &<<SECTsql>>&.
6997
6998 .next
6999 .cindex "sqlite lookup type"
7000 .cindex "lookup" "sqlite"
7001 &(sqlite)&: The format of the query is a filename followed by an SQL statement
7002 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7003
7004 .next
7005 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7006 not likely to be useful in normal operation.
7007 .next
7008 .cindex "whoson lookup type"
7009 .cindex "lookup" "whoson"
7010 . --- still http:-only, 2018-09-07
7011 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7012 allows a server to check whether a particular (dynamically allocated) IP
7013 address is currently allocated to a known (trusted) user and, optionally, to
7014 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7015 at one time for &"POP before SMTP"& authentication, but that approach has been
7016 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7017 &"POP before SMTP"& checking using ACL statements such as
7018 .code
7019 require condition = \
7020   ${lookup whoson {$sender_host_address}{yes}{no}}
7021 .endd
7022 The query consists of a single IP address. The value returned is the name of
7023 the authenticated user, which is stored in the variable &$value$&. However, in
7024 this example, the data in &$value$& is not used; the result of the lookup is
7025 one of the fixed strings &"yes"& or &"no"&.
7026 .endlist
7027
7028
7029
7030 .section "Temporary errors in lookups" "SECID63"
7031 .cindex "lookup" "temporary error in"
7032 Lookup functions can return temporary error codes if the lookup cannot be
7033 completed. For example, an SQL or LDAP database might be unavailable. For this
7034 reason, it is not advisable to use a lookup that might do this for critical
7035 options such as a list of local domains.
7036
7037 When a lookup cannot be completed in a router or transport, delivery
7038 of the message (to the relevant address) is deferred, as for any other
7039 temporary error. In other circumstances Exim may assume the lookup has failed,
7040 or may give up altogether.
7041
7042
7043
7044 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7045 .cindex "wildcard lookups"
7046 .cindex "lookup" "default values"
7047 .cindex "lookup" "wildcard"
7048 .cindex "lookup" "* added to type"
7049 .cindex "default" "in single-key lookups"
7050 In this context, a &"default value"& is a value specified by the administrator
7051 that is to be used if a lookup fails.
7052
7053 &*Note:*& This section applies only to single-key lookups. For query-style
7054 lookups, the facilities of the query language must be used. An attempt to
7055 specify a default for a query-style lookup provokes an error.
7056
7057 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7058 and the initial lookup fails, the key &"*"& is looked up in the file to
7059 provide a default value. See also the section on partial matching below.
7060
7061 .cindex "*@ with single-key lookup"
7062 .cindex "lookup" "*@ added to type"
7063 .cindex "alias file" "per-domain default"
7064 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7065 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7066 character, a second lookup is done with everything before the last @ replaced
7067 by *. This makes it possible to provide per-domain defaults in alias files
7068 that include the domains in the keys. If the second lookup fails (or doesn't
7069 take place because there is no @ in the key), &"*"& is looked up.
7070 For example, a &(redirect)& router might contain:
7071 .code
7072 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7073 .endd
7074 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7075 looks up these keys, in this order:
7076 .code
7077 jane@eyre.example
7078 *@eyre.example
7079 *
7080 .endd
7081 The data is taken from whichever key it finds first. &*Note*&: In an
7082 &(lsearch)& file, this does not mean the first of these keys in the file. A
7083 complete scan is done for each key, and only if it is not found at all does
7084 Exim move on to try the next key.
7085
7086
7087
7088 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7089 .cindex "partial matching"
7090 .cindex "wildcard lookups"
7091 .cindex "lookup" "partial matching"
7092 .cindex "lookup" "wildcard"
7093 .cindex "asterisk" "in search type"
7094 The normal operation of a single-key lookup is to search the file for an exact
7095 match with the given key. However, in a number of situations where domains are
7096 being looked up, it is useful to be able to do partial matching. In this case,
7097 information in the file that has a key starting with &"*."& is matched by any
7098 domain that ends with the components that follow the full stop. For example, if
7099 a key in a DBM file is
7100 .code
7101 *.dates.fict.example
7102 .endd
7103 then when partial matching is enabled this is matched by (amongst others)
7104 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7105 by &'dates.fict.example'&, if that does not appear as a separate key in the
7106 file.
7107
7108 &*Note*&: Partial matching is not available for query-style lookups. It is
7109 also not available for any lookup items in address lists (see section
7110 &<<SECTaddresslist>>&).
7111
7112 Partial matching is implemented by doing a series of separate lookups using
7113 keys constructed by modifying the original subject key. This means that it can
7114 be used with any of the single-key lookup types, provided that
7115 partial matching keys
7116 beginning with a special prefix (default &"*."&) are included in the data file.
7117 Keys in the file that do not begin with the prefix are matched only by
7118 unmodified subject keys when partial matching is in use.
7119
7120 Partial matching is requested by adding the string &"partial-"& to the front of
7121 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7122 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7123 is added at the start of the subject key, and it is looked up again. If that
7124 fails, further lookups are tried with dot-separated components removed from the
7125 start of the subject key, one-by-one, and &"*."& added on the front of what
7126 remains.
7127
7128 A minimum number of two non-* components are required. This can be adjusted
7129 by including a number before the hyphen in the search type. For example,
7130 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7131 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7132 subject key is &'2250.dates.fict.example'& then the following keys are looked
7133 up when the minimum number of non-* components is two:
7134 .code
7135 2250.dates.fict.example
7136 *.2250.dates.fict.example
7137 *.dates.fict.example
7138 *.fict.example
7139 .endd
7140 As soon as one key in the sequence is successfully looked up, the lookup
7141 finishes.
7142
7143 .cindex "lookup" "partial matching &-- changing prefix"
7144 .cindex "prefix" "for partial matching"
7145 The use of &"*."& as the partial matching prefix is a default that can be
7146 changed. The motivation for this feature is to allow Exim to operate with file
7147 formats that are used by other MTAs. A different prefix can be supplied in
7148 parentheses instead of the hyphen after &"partial"&. For example:
7149 .code
7150 domains = partial(.)lsearch;/some/file
7151 .endd
7152 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7153 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7154 components is unchanged). The prefix may consist of any punctuation characters
7155 other than a closing parenthesis. It may be empty, for example:
7156 .code
7157 domains = partial1()cdb;/some/file
7158 .endd
7159 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7160 &`a.b.c`&, &`b.c`&, and &`c`&.
7161
7162 If &"partial0"& is specified, what happens at the end (when the lookup with
7163 just one non-wild component has failed, and the original key is shortened right
7164 down to the null string) depends on the prefix:
7165
7166 .ilist
7167 If the prefix has zero length, the whole lookup fails.
7168 .next
7169 If the prefix has length 1, a lookup for just the prefix is done. For
7170 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7171 .next
7172 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7173 remainder is looked up. With the default prefix, therefore, the final lookup is
7174 for &"*"& on its own.
7175 .next
7176 Otherwise, the whole prefix is looked up.
7177 .endlist
7178
7179
7180 If the search type ends in &"*"& or &"*@"& (see section
7181 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7182 this implies happens after all partial lookups have failed. If &"partial0"& is
7183 specified, adding &"*"& to the search type has no effect with the default
7184 prefix, because the &"*"& key is already included in the sequence of partial
7185 lookups. However, there might be a use for lookup types such as
7186 &"partial0(.)lsearch*"&.
7187
7188 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7189 in domain lists and the like. Partial matching works only in terms of
7190 dot-separated components; a key such as &`*fict.example`&
7191 in a database file is useless, because the asterisk in a partial matching
7192 subject key is always followed by a dot.
7193
7194
7195
7196
7197 .section "Lookup caching" "SECID64"
7198 .cindex "lookup" "caching"
7199 .cindex "caching" "lookup data"
7200 Exim caches all lookup results in order to avoid needless repetition of
7201 lookups. However, because (apart from the daemon) Exim operates as a collection
7202 of independent, short-lived processes, this caching applies only within a
7203 single Exim process. There is no inter-process lookup caching facility.
7204
7205 For single-key lookups, Exim keeps the relevant files open in case there is
7206 another lookup that needs them. In some types of configuration this can lead to
7207 many files being kept open for messages with many recipients. To avoid hitting
7208 the operating system limit on the number of simultaneously open files, Exim
7209 closes the least recently used file when it needs to open more files than its
7210 own internal limit, which can be changed via the &%lookup_open_max%& option.
7211
7212 The single-key lookup files are closed and the lookup caches are flushed at
7213 strategic points during delivery &-- for example, after all routing is
7214 complete.
7215
7216
7217
7218
7219 .section "Quoting lookup data" "SECID65"
7220 .cindex "lookup" "quoting"
7221 .cindex "quoting" "in lookups"
7222 When data from an incoming message is included in a query-style lookup, there
7223 is the possibility of special characters in the data messing up the syntax of
7224 the query. For example, a NIS+ query that contains
7225 .code
7226 [name=$local_part]
7227 .endd
7228 will be broken if the local part happens to contain a closing square bracket.
7229 For NIS+, data can be enclosed in double quotes like this:
7230 .code
7231 [name="$local_part"]
7232 .endd
7233 but this still leaves the problem of a double quote in the data. The rule for
7234 NIS+ is that double quotes must be doubled. Other lookup types have different
7235 rules, and to cope with the differing requirements, an expansion operator
7236 of the following form is provided:
7237 .code
7238 ${quote_<lookup-type>:<string>}
7239 .endd
7240 For example, the safest way to write the NIS+ query is
7241 .code
7242 [name="${quote_nisplus:$local_part}"]
7243 .endd
7244 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7245 operator can be used for all lookup types, but has no effect for single-key
7246 lookups, since no quoting is ever needed in their key strings.
7247
7248
7249
7250
7251 .section "More about dnsdb" "SECTdnsdb"
7252 .cindex "dnsdb lookup"
7253 .cindex "lookup" "dnsdb"
7254 .cindex "DNS" "as a lookup type"
7255 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7256 of a record type and a domain name, separated by an equals sign. For example,
7257 an expansion string could contain:
7258 .code
7259 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7260 .endd
7261 If the lookup succeeds, the result is placed in &$value$&, which in this case
7262 is used on its own as the result. If the lookup does not succeed, the
7263 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7264 &<<SECTforexpfai>>& for an explanation of what this means.
7265
7266 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7267 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7268 If no type is given, TXT is assumed.
7269
7270 For any record type, if multiple records are found, the data is returned as a
7271 concatenation, with newline as the default separator. The order, of course,
7272 depends on the DNS resolver. You can specify a different separator character
7273 between multiple records by putting a right angle-bracket followed immediately
7274 by the new separator at the start of the query. For example:
7275 .code
7276 ${lookup dnsdb{>: a=host1.example}}
7277 .endd
7278 It is permitted to specify a space as the separator character. Further
7279 white space is ignored.
7280 For lookup types that return multiple fields per record,
7281 an alternate field separator can be specified using a comma after the main
7282 separator character, followed immediately by the field separator.
7283
7284 .cindex "PTR record" "in &(dnsdb)& lookup"
7285 When the type is PTR,
7286 the data can be an IP address, written as normal; inversion and the addition of
7287 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7288 .code
7289 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7290 .endd
7291 If the data for a PTR record is not a syntactically valid IP address, it is not
7292 altered and nothing is added.
7293
7294 .cindex "MX record" "in &(dnsdb)& lookup"
7295 .cindex "SRV record" "in &(dnsdb)& lookup"
7296 For an MX lookup, both the preference value and the host name are returned for
7297 each record, separated by a space. For an SRV lookup, the priority, weight,
7298 port, and host name are returned for each record, separated by spaces.
7299 The field separator can be modified as above.
7300
7301 .cindex "TXT record" "in &(dnsdb)& lookup"
7302 .cindex "SPF record" "in &(dnsdb)& lookup"
7303 For TXT records with multiple items of data, only the first item is returned,
7304 unless a field separator is specified.
7305 To concatenate items without a separator, use a semicolon instead.
7306 For SPF records the
7307 default behaviour is to concatenate multiple items without using a separator.
7308 .code
7309 ${lookup dnsdb{>\n,: txt=a.b.example}}
7310 ${lookup dnsdb{>\n; txt=a.b.example}}
7311 ${lookup dnsdb{spf=example.org}}
7312 .endd
7313 It is permitted to specify a space as the separator character. Further
7314 white space is ignored.
7315
7316 .cindex "SOA record" "in &(dnsdb)& lookup"
7317 For an SOA lookup, while no result is obtained the lookup is redone with
7318 successively more leading components dropped from the given domain.
7319 Only the primary-nameserver field is returned unless a field separator is
7320 specified.
7321 .code
7322 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7323 .endd
7324
7325 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7326 .cindex "dnsdb modifiers"
7327 .cindex "modifiers" "dnsdb"
7328 .cindex "options" "dnsdb"
7329 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7330 each followed by a comma,
7331 that may appear before the record type.
7332
7333 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7334 temporary DNS error for any of them, the behaviour is controlled by
7335 a defer-option modifier.
7336 The possible keywords are
7337 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7338 With &"strict"& behaviour, any temporary DNS error causes the
7339 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7340 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7341 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7342 error causes the whole lookup to defer only if none of the other lookups
7343 succeed. The default is &"lax"&, so the following lookups are equivalent:
7344 .code
7345 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7346 ${lookup dnsdb{a=one.host.com:two.host.com}}
7347 .endd
7348 Thus, in the default case, as long as at least one of the DNS lookups
7349 yields some data, the lookup succeeds.
7350
7351 .cindex "DNSSEC" "dns lookup"
7352 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7353 The possible keywords are
7354 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7355 With &"strict"& or &"lax"& DNSSEC information is requested
7356 with the lookup.
7357 With &"strict"& a response from the DNS resolver that
7358 is not labelled as authenticated data
7359 is treated as equivalent to a temporary DNS error.
7360 The default is &"lax"&.
7361
7362 See also the &$lookup_dnssec_authenticated$& variable.
7363
7364 .cindex timeout "dns lookup"
7365 .cindex "DNS" timeout
7366 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7367 The form is &"retrans_VAL"& where VAL is an Exim time specification
7368 (e.g. &"5s"&).
7369 The default value is set by the main configuration option &%dns_retrans%&.
7370
7371 Retries for the dnsdb lookup can be controlled by a retry modifier.
7372 The form if &"retry_VAL"& where VAL is an integer.
7373 The default count is set by the main configuration option &%dns_retry%&.
7374
7375 .cindex caching "of dns lookup"
7376 .cindex TTL "of dns lookup"
7377 .cindex DNS TTL
7378 Dnsdb lookup results are cached within a single process (and its children).
7379 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7380 value of the set of returned DNS records.
7381
7382
7383 .section "Pseudo dnsdb record types" "SECID66"
7384 .cindex "MX record" "in &(dnsdb)& lookup"
7385 By default, both the preference value and the host name are returned for
7386 each MX record, separated by a space. If you want only host names, you can use
7387 the pseudo-type MXH:
7388 .code
7389 ${lookup dnsdb{mxh=a.b.example}}
7390 .endd
7391 In this case, the preference values are omitted, and just the host names are
7392 returned.
7393
7394 .cindex "name server for enclosing domain"
7395 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7396 records on the given domain, but if none are found, it removes the first
7397 component of the domain name, and tries again. This process continues until NS
7398 records are found or there are no more components left (or there is a DNS
7399 error). In other words, it may return the name servers for a top-level domain,
7400 but it never returns the root name servers. If there are no NS records for the
7401 top-level domain, the lookup fails. Consider these examples:
7402 .code
7403 ${lookup dnsdb{zns=xxx.quercite.com}}
7404 ${lookup dnsdb{zns=xxx.edu}}
7405 .endd
7406 Assuming that in each case there are no NS records for the full domain name,
7407 the first returns the name servers for &%quercite.com%&, and the second returns
7408 the name servers for &%edu%&.
7409
7410 You should be careful about how you use this lookup because, unless the
7411 top-level domain does not exist, the lookup always returns some host names. The
7412 sort of use to which this might be put is for seeing if the name servers for a
7413 given domain are on a blacklist. You can probably assume that the name servers
7414 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7415 such a list.
7416
7417 .cindex "CSA" "in &(dnsdb)& lookup"
7418 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7419 records according to the CSA rules, which are described in section
7420 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7421 not sufficient because of the extra parent domain search behaviour of CSA. The
7422 result of a successful lookup such as:
7423 .code
7424 ${lookup dnsdb {csa=$sender_helo_name}}
7425 .endd
7426 has two space-separated fields: an authorization code and a target host name.
7427 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7428 authorization required but absent, or &"?"& for unknown.
7429
7430 .cindex "A+" "in &(dnsdb)& lookup"
7431 The pseudo-type A+ performs an AAAA
7432 and then an A lookup.  All results are returned; defer processing
7433 (see below) is handled separately for each lookup.  Example:
7434 .code
7435 ${lookup dnsdb {>; a+=$sender_helo_name}}
7436 .endd
7437
7438
7439 .section "Multiple dnsdb lookups" "SECID67"
7440 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7441 However, you can specify a list of domains or IP addresses in a single
7442 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7443 the default separator, but with the ability to change this. For example:
7444 .code
7445 ${lookup dnsdb{one.domain.com:two.domain.com}}
7446 ${lookup dnsdb{a=one.host.com:two.host.com}}
7447 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7448 .endd
7449 In order to retain backwards compatibility, there is one special case: if
7450 the lookup type is PTR and no change of separator is specified, Exim looks
7451 to see if the rest of the string is precisely one IPv6 address. In this
7452 case, it does not treat it as a list.
7453
7454 The data from each lookup is concatenated, with newline separators by default,
7455 in the same way that multiple DNS records for a single item are handled. A
7456 different separator can be specified, as described above.
7457
7458
7459
7460
7461 .section "More about LDAP" "SECTldap"
7462 .cindex "LDAP" "lookup, more about"
7463 .cindex "lookup" "LDAP"
7464 .cindex "Solaris" "LDAP"
7465 The original LDAP implementation came from the University of Michigan; this has
7466 become &"Open LDAP"&, and there are now two different releases. Another
7467 implementation comes from Netscape, and Solaris 7 and subsequent releases
7468 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7469 the lookup function level, their error handling is different. For this reason
7470 it is necessary to set a compile-time variable when building Exim with LDAP, to
7471 indicate which LDAP library is in use. One of the following should appear in
7472 your &_Local/Makefile_&:
7473 .code
7474 LDAP_LIB_TYPE=UMICHIGAN
7475 LDAP_LIB_TYPE=OPENLDAP1
7476 LDAP_LIB_TYPE=OPENLDAP2
7477 LDAP_LIB_TYPE=NETSCAPE
7478 LDAP_LIB_TYPE=SOLARIS
7479 .endd
7480 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7481 same interface as the University of Michigan version.
7482
7483 There are three LDAP lookup types in Exim. These behave slightly differently in
7484 the way they handle the results of a query:
7485
7486 .ilist
7487 &(ldap)& requires the result to contain just one entry; if there are more, it
7488 gives an error.
7489 .next
7490 &(ldapdn)& also requires the result to contain just one entry, but it is the
7491 Distinguished Name that is returned rather than any attribute values.
7492 .next
7493 &(ldapm)& permits the result to contain more than one entry; the attributes
7494 from all of them are returned.
7495 .endlist
7496
7497
7498 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7499 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7500 the data returned by a successful lookup is described in the next section.
7501 First we explain how LDAP queries are coded.
7502
7503
7504 .section "Format of LDAP queries" "SECTforldaque"
7505 .cindex "LDAP" "query format"
7506 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7507 the configuration of a &(redirect)& router one might have this setting:
7508 .code
7509 data = ${lookup ldap \
7510   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7511   c=UK?mailbox?base?}}
7512 .endd
7513 .cindex "LDAP" "with TLS"
7514 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7515 secure (encrypted) LDAP connections. The second of these ensures that an
7516 encrypted TLS connection is used.
7517
7518 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7519 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7520 See the &%ldap_start_tls%& option.
7521
7522 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7523 controlled. Every part of the TLS configuration can be configured by settings in
7524 &_exim.conf_&. Depending on the version of the client libraries installed on
7525 your system, some of the initialization may have required setting options in
7526 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7527 certificates. This revealed a nuance where the current UID that exim was
7528 running as could affect which config files it read. With Exim 4.83, these
7529 methods become optional, only taking effect if not specifically set in
7530 &_exim.conf_&.
7531
7532
7533 .section "LDAP quoting" "SECID68"
7534 .cindex "LDAP" "quoting"
7535 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7536 and the second because the LDAP query is represented as a URL. Furthermore,
7537 within an LDAP query, two different kinds of quoting are required. For this
7538 reason, there are two different LDAP-specific quoting operators.
7539
7540 The &%quote_ldap%& operator is designed for use on strings that are part of
7541 filter specifications. Conceptually, it first does the following conversions on
7542 the string:
7543 .code
7544 *   =>   \2A
7545 (   =>   \28
7546 )   =>   \29
7547 \   =>   \5C
7548 .endd
7549 in accordance with RFC 2254. The resulting string is then quoted according
7550 to the rules for URLs, that is, all non-alphanumeric characters except
7551 .code
7552 ! $ ' - . _ ( ) * +
7553 .endd
7554 are converted to their hex values, preceded by a percent sign. For example:
7555 .code
7556 ${quote_ldap: a(bc)*, a<yz>; }
7557 .endd
7558 yields
7559 .code
7560 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7561 .endd
7562 Removing the URL quoting, this is (with a leading and a trailing space):
7563 .code
7564 a\28bc\29\2A, a<yz>;
7565 .endd
7566 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7567 base DN specifications in queries. Conceptually, it first converts the string
7568 by inserting a backslash in front of any of the following characters:
7569 .code
7570 , + " \ < > ;
7571 .endd
7572 It also inserts a backslash before any leading spaces or # characters, and
7573 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7574 is then quoted according to the rules for URLs. For example:
7575 .code
7576 ${quote_ldap_dn: a(bc)*, a<yz>; }
7577 .endd
7578 yields
7579 .code
7580 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7581 .endd
7582 Removing the URL quoting, this is (with a trailing space):
7583 .code
7584 \ a(bc)*\, a\<yz\>\;\
7585 .endd
7586 There are some further comments about quoting in the section on LDAP
7587 authentication below.
7588
7589
7590 .section "LDAP connections" "SECID69"
7591 .cindex "LDAP" "connections"
7592 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7593 is in use, via a Unix domain socket. The example given above does not specify
7594 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7595 by starting it with
7596 .code
7597 ldap://<hostname>:<port>/...
7598 .endd
7599 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7600 used. When no server is specified in a query, a list of default servers is
7601 taken from the &%ldap_default_servers%& configuration option. This supplies a
7602 colon-separated list of servers which are tried in turn until one successfully
7603 handles a query, or there is a serious error. Successful handling either
7604 returns the requested data, or indicates that it does not exist. Serious errors
7605 are syntactical, or multiple values when only a single value is expected.
7606 Errors which cause the next server to be tried are connection failures, bind
7607 failures, and timeouts.
7608
7609 For each server name in the list, a port number can be given. The standard way
7610 of specifying a host and port is to use a colon separator (RFC 1738). Because
7611 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7612 doubled. For example
7613 .code
7614 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7615 .endd
7616 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7617 to the LDAP library with no server name, and the library's default (normally
7618 the local host) is used.
7619
7620 If you are using the OpenLDAP library, you can connect to an LDAP server using
7621 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7622 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7623 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7624 not available.
7625
7626 For this type of connection, instead of a host name for the server, a pathname
7627 for the socket is required, and the port number is not relevant. The pathname
7628 can be specified either as an item in &%ldap_default_servers%&, or inline in
7629 the query. In the former case, you can have settings such as
7630 .code
7631 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7632 .endd
7633 When the pathname is given in the query, you have to escape the slashes as
7634 &`%2F`& to fit in with the LDAP URL syntax. For example:
7635 .code
7636 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7637 .endd
7638 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7639 a pathname, it uses the Unix domain socket code, even if the query actually
7640 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7641 socket connection. This behaviour means that you can use a setting of
7642 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7643 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7644 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7645 backup host.
7646
7647 If an explicit &`ldapi`& type is given in a query when a host name is
7648 specified, an error is diagnosed. However, if there are more items in
7649 &%ldap_default_servers%&, they are tried. In other words:
7650
7651 .ilist
7652 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7653 interface.
7654 .next
7655 Using &`ldapi`& with a host name causes an error.
7656 .endlist
7657
7658
7659 Using &`ldapi`& with no host or path in the query, and no setting of
7660 &%ldap_default_servers%&, does whatever the library does by default.
7661
7662
7663
7664 .section "LDAP authentication and control information" "SECID70"
7665 .cindex "LDAP" "authentication"
7666 The LDAP URL syntax provides no way of passing authentication and other control
7667 information to the server. To make this possible, the URL in an LDAP query may
7668 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7669 spaces. If a value contains spaces it must be enclosed in double quotes, and
7670 when double quotes are used, backslash is interpreted in the usual way inside
7671 them. The following names are recognized:
7672 .display
7673 &`DEREFERENCE`&  set the dereferencing parameter
7674 &`NETTIME    `&  set a timeout for a network operation
7675 &`USER       `&  set the DN, for authenticating the LDAP bind
7676 &`PASS       `&  set the password, likewise
7677 &`REFERRALS  `&  set the referrals parameter
7678 &`SERVERS    `&  set alternate server list for this query only
7679 &`SIZE       `&  set the limit for the number of entries returned
7680 &`TIME       `&  set the maximum waiting time for a query
7681 .endd
7682 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7683 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7684 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7685 library from trying to follow referrals issued by the LDAP server.
7686
7687 .cindex LDAP timeout
7688 .cindex timeout "LDAP lookup"
7689 The name CONNECT is an obsolete name for NETTIME, retained for
7690 backwards compatibility. This timeout (specified as a number of seconds) is
7691 enforced from the client end for operations that can be carried out over a
7692 network. Specifically, it applies to network connections and calls to the
7693 &'ldap_result()'& function. If the value is greater than zero, it is used if
7694 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7695 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7696 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7697 Netscape SDK; for OpenLDAP no action is taken.
7698
7699 The TIME parameter (also a number of seconds) is passed to the server to
7700 set a server-side limit on the time taken to complete a search.
7701
7702 The SERVERS parameter allows you to specify an alternate list of ldap servers
7703 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7704 default list of ldap servers, and a single lookup can specify a single ldap
7705 server to use.  But when you need to do a lookup with a list of servers that is
7706 different than the default list (maybe different order, maybe a completely
7707 different set of servers), the SERVERS parameter allows you to specify this
7708 alternate list (colon-separated).
7709
7710 Here is an example of an LDAP query in an Exim lookup that uses some of these
7711 values. This is a single line, folded to fit on the page:
7712 .code
7713 ${lookup ldap
7714   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7715   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7716   {$value}fail}
7717 .endd
7718 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7719 any of the auxiliary data. Exim configuration settings that include lookups
7720 which contain password information should be preceded by &"hide"& to prevent
7721 non-admin users from using the &%-bP%& option to see their values.
7722
7723 The auxiliary data items may be given in any order. The default is no
7724 connection timeout (the system timeout is used), no user or password, no limit
7725 on the number of entries returned, and no time limit on queries.
7726
7727 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7728 removes any URL quoting that it may contain before passing it LDAP. Apparently
7729 some libraries do this for themselves, but some do not. Removing the URL
7730 quoting has two advantages:
7731
7732 .ilist
7733 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7734 DNs as with DNs inside actual queries.
7735 .next
7736 It permits spaces inside USER= DNs.
7737 .endlist
7738
7739 For example, a setting such as
7740 .code
7741 USER=cn=${quote_ldap_dn:$1}
7742 .endd
7743 should work even if &$1$& contains spaces.
7744
7745 Expanded data for the PASS= value should be quoted using the &%quote%&
7746 expansion operator, rather than the LDAP quote operators. The only reason this
7747 field needs quoting is to ensure that it conforms to the Exim syntax, which
7748 does not allow unquoted spaces. For example:
7749 .code
7750 PASS=${quote:$3}
7751 .endd
7752 The LDAP authentication mechanism can be used to check passwords as part of
7753 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7754 &<<CHAPexpand>>&.
7755
7756
7757
7758 .section "Format of data returned by LDAP" "SECID71"
7759 .cindex "LDAP" "returned data formats"
7760 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7761 as a sequence of values, for example
7762 .code
7763 cn=manager,o=University of Cambridge,c=UK
7764 .endd
7765 The &(ldap)& lookup type generates an error if more than one entry matches the
7766 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7767 the result between the data from different entries. It is possible for multiple
7768 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7769 you know that whatever values are returned all came from a single entry in the
7770 directory.
7771
7772 In the common case where you specify a single attribute in your LDAP query, the
7773 result is not quoted, and does not contain the attribute name. If the attribute
7774 has multiple values, they are separated by commas. Any comma that is
7775 part of an attribute's value is doubled.
7776
7777 If you specify multiple attributes, the result contains space-separated, quoted
7778 strings, each preceded by the attribute name and an equals sign. Within the
7779 quotes, the quote character, backslash, and newline are escaped with
7780 backslashes, and commas are used to separate multiple values for the attribute.
7781 Any commas in attribute values are doubled
7782 (permitting treatment of the values as a comma-separated list).
7783 Apart from the escaping, the string within quotes takes the same form as the
7784 output when a single attribute is requested. Specifying no attributes is the
7785 same as specifying all of an entry's attributes.
7786
7787 Here are some examples of the output format. The first line of each pair is an
7788 LDAP query, and the second is the data that is returned. The attribute called
7789 &%attr1%& has two values, one of them with an embedded comma, whereas
7790 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7791 (they have SUP &%attr%& in their schema definitions).
7792
7793 .code
7794 ldap:///o=base?attr1?sub?(uid=fred)
7795 value1.1,value1,,2
7796
7797 ldap:///o=base?attr2?sub?(uid=fred)
7798 value two
7799
7800 ldap:///o=base?attr?sub?(uid=fred)
7801 value1.1,value1,,2,value two
7802
7803 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7804 attr1="value1.1,value1,,2" attr2="value two"
7805
7806 ldap:///o=base??sub?(uid=fred)
7807 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7808 .endd
7809 You can
7810 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7811 results of LDAP lookups.
7812 The &%extract%& operator in string expansions can be used to pick out
7813 individual fields from data that consists of &'key'&=&'value'& pairs.
7814 The &%listextract%& operator should be used to pick out individual values
7815 of attributes, even when only a single value is expected.
7816 The doubling of embedded commas allows you to use the returned data as a
7817 comma separated list (using the "<," syntax for changing the input list separator).
7818
7819
7820
7821
7822 .section "More about NIS+" "SECTnisplus"
7823 .cindex "NIS+ lookup type"
7824 .cindex "lookup" "NIS+"
7825 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7826 and field name. If this is given, the result of a successful query is the
7827 contents of the named field; otherwise the result consists of a concatenation
7828 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7829 values containing spaces are quoted. For example, the query
7830 .code
7831 [name=mg1456],passwd.org_dir
7832 .endd
7833 might return the string
7834 .code
7835 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7836 home=/home/mg1456 shell=/bin/bash shadow=""
7837 .endd
7838 (split over two lines here to fit on the page), whereas
7839 .code
7840 [name=mg1456],passwd.org_dir:gcos
7841 .endd
7842 would just return
7843 .code
7844 Martin Guerre
7845 .endd
7846 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7847 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7848 operator is to double any quote characters within the text.
7849
7850
7851
7852 .section "SQL lookups" "SECTsql"
7853 .cindex "SQL lookup types"
7854 .cindex "MySQL" "lookup type"
7855 .cindex "PostgreSQL lookup type"
7856 .cindex "lookup" "MySQL"
7857 .cindex "lookup" "PostgreSQL"
7858 .cindex "Oracle" "lookup type"
7859 .cindex "lookup" "Oracle"
7860 .cindex "InterBase lookup type"
7861 .cindex "lookup" "InterBase"
7862 .cindex "Redis lookup type"
7863 .cindex lookup Redis
7864 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7865 and SQLite
7866 databases. Queries for these databases contain SQL statements, so an example
7867 might be
7868 .code
7869 ${lookup mysql{select mailbox from users where id='userx'}\
7870   {$value}fail}
7871 .endd
7872 If the result of the query contains more than one field, the data for each
7873 field in the row is returned, preceded by its name, so the result of
7874 .code
7875 ${lookup pgsql{select home,name from users where id='userx'}\
7876   {$value}}
7877 .endd
7878 might be
7879 .code
7880 home=/home/userx name="Mister X"
7881 .endd
7882 Empty values and values containing spaces are double quoted, with embedded
7883 quotes escaped by a backslash. If the result of the query contains just one
7884 field, the value is passed back verbatim, without a field name, for example:
7885 .code
7886 Mister X
7887 .endd
7888 If the result of the query yields more than one row, it is all concatenated,
7889 with a newline between the data for each row.
7890
7891
7892 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7893 .cindex "MySQL" "lookup type"
7894 .cindex "PostgreSQL lookup type"
7895 .cindex "lookup" "MySQL"
7896 .cindex "lookup" "PostgreSQL"
7897 .cindex "Oracle" "lookup type"
7898 .cindex "lookup" "Oracle"
7899 .cindex "InterBase lookup type"
7900 .cindex "lookup" "InterBase"
7901 .cindex "Redis lookup type"
7902 .cindex lookup Redis
7903 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7904 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7905 or &%redis_servers%&
7906 option (as appropriate) must be set to a colon-separated list of server
7907 information.
7908 (For MySQL and PostgreSQL, the global option need not be set if all
7909 queries contain their own server information &-- see section
7910 &<<SECTspeserque>>&.)
7911 For all but Redis
7912 each item in the list is a slash-separated list of four
7913 items: host name, database name, user name, and password. In the case of
7914 Oracle, the host name field is used for the &"service name"&, and the database
7915 name field is not used and should be empty. For example:
7916 .code
7917 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7918 .endd
7919 Because password data is sensitive, you should always precede the setting with
7920 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7921 option. Here is an example where two MySQL servers are listed:
7922 .code
7923 hide mysql_servers = localhost/users/root/secret:\
7924                      otherhost/users/root/othersecret
7925 .endd
7926 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7927 because this is a colon-separated list, the colon has to be doubled. For each
7928 query, these parameter groups are tried in order until a connection is made and
7929 a query is successfully processed. The result of a query may be that no data is
7930 found, but that is still a successful query. In other words, the list of
7931 servers provides a backup facility, not a list of different places to look.
7932
7933 For Redis the global option need not be specified if all queries contain their
7934 own server information &-- see section &<<SECTspeserque>>&.
7935 If specified, the option must be set to a colon-separated list of server
7936 information.
7937 Each item in the list is a slash-separated list of three items:
7938 host, database number, and password.
7939 .olist
7940 The host is required and may be either an IPv4 address and optional
7941 port number (separated by a colon, which needs doubling due to the
7942 higher-level list), or a Unix socket pathname enclosed in parentheses
7943 .next
7944 The database number is optional; if present that number is selected in the backend
7945 .next
7946 The password is optional; if present it is used to authenticate to the backend
7947 .endlist
7948
7949 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7950 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7951 respectively, and the characters single-quote, double-quote, and backslash
7952 itself are escaped with backslashes.
7953
7954 The &%quote_redis%& expansion operator
7955 escapes whitespace and backslash characters with a backslash.
7956
7957 .section "Specifying the server in the query" "SECTspeserque"
7958 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7959 it is possible to specify a list of servers with an individual query. This is
7960 done by starting the query with
7961 .display
7962 &`servers=`&&'server1:server2:server3:...'&&`;`&
7963 .endd
7964 Each item in the list may take one of two forms:
7965 .olist
7966 If it contains no slashes it is assumed to be just a host name. The appropriate
7967 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7968 of the same name, and the remaining parameters (database, user, password) are
7969 taken from there.
7970 .next
7971 If it contains any slashes, it is taken as a complete parameter set.
7972 .endlist
7973 The list of servers is used in exactly the same way as the global list.
7974 Once a connection to a server has happened and a query has been
7975 successfully executed, processing of the lookup ceases.
7976
7977 This feature is intended for use in master/slave situations where updates
7978 are occurring and you want to update the master rather than a slave. If the
7979 master is in the list as a backup for reading, you might have a global setting
7980 like this:
7981 .code
7982 mysql_servers = slave1/db/name/pw:\
7983                 slave2/db/name/pw:\
7984                 master/db/name/pw
7985 .endd
7986 In an updating lookup, you could then write:
7987 .code
7988 ${lookup mysql{servers=master; UPDATE ...} }
7989 .endd
7990 That query would then be sent only to the master server. If, on the other hand,
7991 the master is not to be used for reading, and so is not present in the global
7992 option, you can still update it by a query of this form:
7993 .code
7994 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7995 .endd
7996
7997
7998 .section "Special MySQL features" "SECID73"
7999 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8000 causes a connection to the server on the local host by means of a Unix domain
8001 socket. An alternate socket can be specified in parentheses.
8002 An option group name for MySQL option files can be specified in square brackets;
8003 the default value is &"exim"&.
8004 The full syntax of each item in &%mysql_servers%& is:
8005 .display
8006 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8007   <&'database'&>/<&'user'&>/<&'password'&>
8008 .endd
8009 Any of the four sub-parts of the first field can be omitted. For normal use on
8010 the local host it can be left blank or set to just &"localhost"&.
8011
8012 No database need be supplied &-- but if it is absent here, it must be given in
8013 the queries.
8014
8015 If a MySQL query is issued that does not request any data (an insert, update,
8016 or delete command), the result of the lookup is the number of rows affected.
8017
8018 &*Warning*&: This can be misleading. If an update does not actually change
8019 anything (for example, setting a field to the value it already has), the result
8020 is zero because no rows are affected.
8021
8022
8023 .section "Special PostgreSQL features" "SECID74"
8024 PostgreSQL lookups can also use Unix domain socket connections to the database.
8025 This is usually faster and costs less CPU time than a TCP/IP connection.
8026 However it can be used only if the mail server runs on the same machine as the
8027 database server. A configuration line for PostgreSQL via Unix domain sockets
8028 looks like this:
8029 .code
8030 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8031 .endd
8032 In other words, instead of supplying a host name, a path to the socket is
8033 given. The path name is enclosed in parentheses so that its slashes aren't
8034 visually confused with the delimiters for the other server parameters.
8035
8036 If a PostgreSQL query is issued that does not request any data (an insert,
8037 update, or delete command), the result of the lookup is the number of rows
8038 affected.
8039
8040 .section "More about SQLite" "SECTsqlite"
8041 .cindex "lookup" "SQLite"
8042 .cindex "sqlite lookup type"
8043 SQLite is different to the other SQL lookups because a filename is required in
8044 addition to the SQL query. An SQLite database is a single file, and there is no
8045 daemon as in the other SQL databases. The interface to Exim requires the name
8046 of the file, as an absolute path, to be given at the start of the query. It is
8047 separated from the query by white space. This means that the path name cannot
8048 contain white space. Here is a lookup expansion example:
8049 .code
8050 ${lookup sqlite {/some/thing/sqlitedb \
8051   select name from aliases where id='userx';}}
8052 .endd
8053 In a list, the syntax is similar. For example:
8054 .code
8055 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8056    select * from relays where ip='$sender_host_address';
8057 .endd
8058 The only character affected by the &%quote_sqlite%& operator is a single
8059 quote, which it doubles.
8060
8061 .cindex timeout SQLite
8062 .cindex sqlite "lookup timeout"
8063 The SQLite library handles multiple simultaneous accesses to the database
8064 internally. Multiple readers are permitted, but only one process can
8065 update at once. Attempts to access the database while it is being updated
8066 are rejected after a timeout period, during which the SQLite library
8067 waits for the lock to be released. In Exim, the default timeout is set
8068 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8069 option.
8070
8071 .section "More about Redis" "SECTredis"
8072 .cindex "lookup" "Redis"
8073 .cindex "redis lookup type"
8074 Redis is a non-SQL database. Commands are simple get and set.
8075 Examples:
8076 .code
8077 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8078 ${lookup redis{get keyname}}
8079 .endd
8080
8081 As of release 4.91, "lightweight" support for Redis Cluster is available.
8082 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8083 of which must be reachable from the running exim instance. If the cluster has
8084 master/slave replication, the list must contain all the master and slave
8085 servers.
8086
8087 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8088 immediately follow the redirection but treats the response as a DEFER, moving on
8089 to the next server in the &%redis_servers%& list until the correct server is
8090 reached.
8091
8092 .ecindex IIDfidalo1
8093 .ecindex IIDfidalo2
8094
8095
8096 . ////////////////////////////////////////////////////////////////////////////
8097 . ////////////////////////////////////////////////////////////////////////////
8098
8099 .chapter "Domain, host, address, and local part lists" &&&
8100          "CHAPdomhosaddlists" &&&
8101          "Domain, host, and address lists"
8102 .scindex IIDdohoadli "lists of domains; hosts; etc."
8103 A number of Exim configuration options contain lists of domains, hosts,
8104 email addresses, or local parts. For example, the &%hold_domains%& option
8105 contains a list of domains whose delivery is currently suspended. These lists
8106 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8107 arguments to expansion conditions such as &%match_domain%&.
8108
8109 Each item in one of these lists is a pattern to be matched against a domain,
8110 host, email address, or local part, respectively. In the sections below, the
8111 different types of pattern for each case are described, but first we cover some
8112 general facilities that apply to all four kinds of list.
8113
8114 Note that other parts of Exim use a &'string list'& which does not
8115 support all the complexity available in
8116 domain, host, address and local part lists.
8117
8118
8119
8120 .section "Expansion of lists" "SECTlistexpand"
8121 .cindex "expansion" "of lists"
8122 Each list is expanded as a single string before it is used.
8123
8124 &'Exception: the router headers_remove option, where list-item
8125 splitting is done before string-expansion.'&
8126
8127 The result of
8128 expansion must be a list, possibly containing empty items, which is split up
8129 into separate items for matching. By default, colon is the separator character,
8130 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8131 &<<SECTempitelis>>& for details of the list syntax; the second of these
8132 discusses the way to specify empty list items.
8133
8134
8135 If the string expansion is forced to fail, Exim behaves as if the item it is
8136 testing (domain, host, address, or local part) is not in the list. Other
8137 expansion failures cause temporary errors.
8138
8139 If an item in a list is a regular expression, backslashes, dollars and possibly
8140 other special characters in the expression must be protected against
8141 misinterpretation by the string expander. The easiest way to do this is to use
8142 the &`\N`& expansion feature to indicate that the contents of the regular
8143 expression should not be expanded. For example, in an ACL you might have:
8144 .code
8145 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8146                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8147 .endd
8148 The first item is a regular expression that is protected from expansion by
8149 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8150 senders based on the receiving domain.
8151
8152
8153
8154
8155 .section "Negated items in lists" "SECID76"
8156 .cindex "list" "negation"
8157 .cindex "negation" "in lists"
8158 Items in a list may be positive or negative. Negative items are indicated by a
8159 leading exclamation mark, which may be followed by optional white space. A list
8160 defines a set of items (domains, etc). When Exim processes one of these lists,
8161 it is trying to find out whether a domain, host, address, or local part
8162 (respectively) is in the set that is defined by the list. It works like this:
8163
8164 The list is scanned from left to right. If a positive item is matched, the
8165 subject that is being checked is in the set; if a negative item is matched, the
8166 subject is not in the set. If the end of the list is reached without the
8167 subject having matched any of the patterns, it is in the set if the last item
8168 was a negative one, but not if it was a positive one. For example, the list in
8169 .code
8170 domainlist relay_to_domains = !a.b.c : *.b.c
8171 .endd
8172 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8173 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8174 list is positive. However, if the setting were
8175 .code
8176 domainlist relay_to_domains = !a.b.c
8177 .endd
8178 then all domains other than &'a.b.c'& would match because the last item in the
8179 list is negative. In other words, a list that ends with a negative item behaves
8180 as if it had an extra item &`:*`& on the end.
8181
8182 Another way of thinking about positive and negative items in lists is to read
8183 the connector as &"or"& after a positive item and as &"and"& after a negative
8184 item.
8185
8186
8187
8188 .section "File names in lists" "SECTfilnamlis"
8189 .cindex "list" "filename in"
8190 If an item in a domain, host, address, or local part list is an absolute
8191 filename (beginning with a slash character), each line of the file is read and
8192 processed as if it were an independent item in the list, except that further
8193 filenames are not allowed,
8194 and no expansion of the data from the file takes place.
8195 Empty lines in the file are ignored, and the file may also contain comment
8196 lines:
8197
8198 .ilist
8199 For domain and host lists, if a # character appears anywhere in a line of the
8200 file, it and all following characters are ignored.
8201 .next
8202 Because local parts may legitimately contain # characters, a comment in an
8203 address list or local part list file is recognized only if # is preceded by
8204 white space or the start of the line. For example:
8205 .code
8206 not#comment@x.y.z   # but this is a comment
8207 .endd
8208 .endlist
8209
8210 Putting a filename in a list has the same effect as inserting each line of the
8211 file as an item in the list (blank lines and comments excepted). However, there
8212 is one important difference: the file is read each time the list is processed,
8213 so if its contents vary over time, Exim's behaviour changes.
8214
8215 If a filename is preceded by an exclamation mark, the sense of any match
8216 within the file is inverted. For example, if
8217 .code
8218 hold_domains = !/etc/nohold-domains
8219 .endd
8220 and the file contains the lines
8221 .code
8222 !a.b.c
8223 *.b.c
8224 .endd
8225 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8226 any domain matching &`*.b.c`& is not.
8227
8228
8229
8230 .section "An lsearch file is not an out-of-line list" "SECID77"
8231 As will be described in the sections that follow, lookups can be used in lists
8232 to provide indexed methods of checking list membership. There has been some
8233 confusion about the way &(lsearch)& lookups work in lists. Because
8234 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8235 sometimes thought that it is allowed to contain wild cards and other kinds of
8236 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8237 always fixed strings, just as for any other single-key lookup type.
8238
8239 If you want to use a file to contain wild-card patterns that form part of a
8240 list, just give the filename on its own, without a search type, as described
8241 in the previous section. You could also use the &(wildlsearch)& or
8242 &(nwildlsearch)&, but there is no advantage in doing this.
8243
8244
8245
8246
8247 .section "Named lists" "SECTnamedlists"
8248 .cindex "named lists"
8249 .cindex "list" "named"
8250 A list of domains, hosts, email addresses, or local parts can be given a name
8251 which is then used to refer to the list elsewhere in the configuration. This is
8252 particularly convenient if the same list is required in several different
8253 places. It also allows lists to be given meaningful names, which can improve
8254 the readability of the configuration. For example, it is conventional to define
8255 a domain list called &'local_domains'& for all the domains that are handled
8256 locally on a host, using a configuration line such as
8257 .code
8258 domainlist local_domains = localhost:my.dom.example
8259 .endd
8260 Named lists are referenced by giving their name preceded by a plus sign, so,
8261 for example, a router that is intended to handle local domains would be
8262 configured with the line
8263 .code
8264 domains = +local_domains
8265 .endd
8266 The first router in a configuration is often one that handles all domains
8267 except the local ones, using a configuration with a negated item like this:
8268 .code
8269 dnslookup:
8270   driver = dnslookup
8271   domains = ! +local_domains
8272   transport = remote_smtp
8273   no_more
8274 .endd
8275 The four kinds of named list are created by configuration lines starting with
8276 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8277 respectively. Then there follows the name that you are defining, followed by an
8278 equals sign and the list itself. For example:
8279 .code
8280 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8281 addresslist bad_senders = cdb;/etc/badsenders
8282 .endd
8283 A named list may refer to other named lists:
8284 .code
8285 domainlist  dom1 = first.example : second.example
8286 domainlist  dom2 = +dom1 : third.example
8287 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8288 .endd
8289 &*Warning*&: If the last item in a referenced list is a negative one, the
8290 effect may not be what you intended, because the negation does not propagate
8291 out to the higher level. For example, consider:
8292 .code
8293 domainlist  dom1 = !a.b
8294 domainlist  dom2 = +dom1 : *.b
8295 .endd
8296 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8297 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8298 means it matches the second list as well. The effect is not the same as
8299 .code
8300 domainlist  dom2 = !a.b : *.b
8301 .endd
8302 where &'x.y'& does not match. It's best to avoid negation altogether in
8303 referenced lists if you can.
8304
8305 .new
8306 .cindex "hiding named list values"
8307 .cindex "named lists" "hiding value of"
8308 Some named list definitions may contain sensitive data, for example, passwords for
8309 accessing databases. To stop non-admin users from using the &%-bP%& command
8310 line option to read these values, you can precede the definition with the
8311 word &"hide"&. For example:
8312 .code
8313 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8314 .endd
8315 .wen
8316
8317
8318 Named lists may have a performance advantage. When Exim is routing an
8319 address or checking an incoming message, it caches the result of tests on named
8320 lists. So, if you have a setting such as
8321 .code
8322 domains = +local_domains
8323 .endd
8324 on several of your routers
8325 or in several ACL statements,
8326 the actual test is done only for the first one. However, the caching works only
8327 if there are no expansions within the list itself or any sublists that it
8328 references. In other words, caching happens only for lists that are known to be
8329 the same each time they are referenced.
8330
8331 By default, there may be up to 16 named lists of each type. This limit can be
8332 extended by changing a compile-time variable. The use of domain and host lists
8333 is recommended for concepts such as local domains, relay domains, and relay
8334 hosts. The default configuration is set up like this.
8335
8336
8337
8338 .section "Named lists compared with macros" "SECID78"
8339 .cindex "list" "named compared with macro"
8340 .cindex "macro" "compared with named list"
8341 At first sight, named lists might seem to be no different from macros in the
8342 configuration file. However, macros are just textual substitutions. If you
8343 write
8344 .code
8345 ALIST = host1 : host2
8346 auth_advertise_hosts = !ALIST
8347 .endd
8348 it probably won't do what you want, because that is exactly the same as
8349 .code
8350 auth_advertise_hosts = !host1 : host2
8351 .endd
8352 Notice that the second host name is not negated. However, if you use a host
8353 list, and write
8354 .code
8355 hostlist alist = host1 : host2
8356 auth_advertise_hosts = ! +alist
8357 .endd
8358 the negation applies to the whole list, and so that is equivalent to
8359 .code
8360 auth_advertise_hosts = !host1 : !host2
8361 .endd
8362
8363
8364 .section "Named list caching" "SECID79"
8365 .cindex "list" "caching of named"
8366 .cindex "caching" "named lists"
8367 While processing a message, Exim caches the result of checking a named list if
8368 it is sure that the list is the same each time. In practice, this means that
8369 the cache operates only if the list contains no $ characters, which guarantees
8370 that it will not change when it is expanded. Sometimes, however, you may have
8371 an expanded list that you know will be the same each time within a given
8372 message. For example:
8373 .code
8374 domainlist special_domains = \
8375            ${lookup{$sender_host_address}cdb{/some/file}}
8376 .endd
8377 This provides a list of domains that depends only on the sending host's IP
8378 address. If this domain list is referenced a number of times (for example,
8379 in several ACL lines, or in several routers) the result of the check is not
8380 cached by default, because Exim does not know that it is going to be the
8381 same list each time.
8382
8383 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8384 cache the result anyway. For example:
8385 .code
8386 domainlist_cache special_domains = ${lookup{...
8387 .endd
8388 If you do this, you should be absolutely sure that caching is going to do
8389 the right thing in all cases. When in doubt, leave it out.
8390
8391
8392
8393 .section "Domain lists" "SECTdomainlist"
8394 .cindex "domain list" "patterns for"
8395 .cindex "list" "domain list"
8396 Domain lists contain patterns that are to be matched against a mail domain.
8397 The following types of item may appear in domain lists:
8398
8399 .ilist
8400 .cindex "primary host name"
8401 .cindex "host name" "matched in domain list"
8402 .oindex "&%primary_hostname%&"
8403 .cindex "domain list" "matching primary host name"
8404 .cindex "@ in a domain list"
8405 If a pattern consists of a single @ character, it matches the local host name,
8406 as set by the &%primary_hostname%& option (or defaulted). This makes it
8407 possible to use the same configuration file on several different hosts that
8408 differ only in their names.
8409 .next
8410 .cindex "@[] in a domain list"
8411 .cindex "domain list" "matching local IP interfaces"
8412 .cindex "domain literal"
8413 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8414 in square brackets (as in an email address that contains a domain literal), but
8415 only if that IP address is recognized as local for email routing purposes. The
8416 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8417 control which of a host's several IP addresses are treated as local.
8418 In today's Internet, the use of domain literals is controversial.
8419 .next
8420 .cindex "@mx_any"
8421 .cindex "@mx_primary"
8422 .cindex "@mx_secondary"
8423 .cindex "domain list" "matching MX pointers to local host"
8424 If a pattern consists of the string &`@mx_any`& it matches any domain that
8425 has an MX record pointing to the local host or to any host that is listed in
8426 .oindex "&%hosts_treat_as_local%&"
8427 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8428 are similar, except that the first matches only when a primary MX target is the
8429 local host, and the second only when no primary MX target is the local host,
8430 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8431 preference value &-- there may of course be more than one of them.
8432
8433 The MX lookup that takes place when matching a pattern of this type is
8434 performed with the resolver options for widening names turned off. Thus, for
8435 example, a single-component domain will &'not'& be expanded by adding the
8436 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8437 options of the &(dnslookup)& router for a discussion of domain widening.
8438
8439 Sometimes you may want to ignore certain IP addresses when using one of these
8440 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8441 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8442 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8443 on a router). For example:
8444 .code
8445 domains = @mx_any/ignore=127.0.0.1
8446 .endd
8447 This example matches any domain that has an MX record pointing to one of
8448 the local host's IP addresses other than 127.0.0.1.
8449
8450 The list of IP addresses is in fact processed by the same code that processes
8451 host lists, so it may contain CIDR-coded network specifications and it may also
8452 contain negative items.
8453
8454 Because the list of IP addresses is a sublist within a domain list, you have to
8455 be careful about delimiters if there is more than one address. Like any other
8456 list, the default delimiter can be changed. Thus, you might have:
8457 .code
8458 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8459           an.other.domain : ...
8460 .endd
8461 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8462 involved, it is easiest to change the delimiter for the main list as well:
8463 .code
8464 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8465           an.other.domain ? ...
8466 .endd
8467 .next
8468 .cindex "asterisk" "in domain list"
8469 .cindex "domain list" "asterisk in"
8470 .cindex "domain list" "matching &""ends with""&"
8471 If a pattern starts with an asterisk, the remaining characters of the pattern
8472 are compared with the terminating characters of the domain. The use of &"*"& in
8473 domain lists differs from its use in partial matching lookups. In a domain
8474 list, the character following the asterisk need not be a dot, whereas partial
8475 matching works only in terms of dot-separated components. For example, a domain
8476 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8477 &'cipher.key.ex'&.
8478
8479 .next
8480 .cindex "regular expressions" "in domain list"
8481 .cindex "domain list" "matching regular expression"
8482 If a pattern starts with a circumflex character, it is treated as a regular
8483 expression, and matched against the domain using a regular expression matching
8484 function. The circumflex is treated as part of the regular expression.
8485 Email domains are case-independent, so this regular expression match is by
8486 default case-independent, but you can make it case-dependent by starting it
8487 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8488 are given in chapter &<<CHAPregexp>>&.
8489
8490 &*Warning*&: Because domain lists are expanded before being processed, you
8491 must escape any backslash and dollar characters in the regular expression, or
8492 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8493 it is not to be expanded (unless you really do want to build a regular
8494 expression by expansion, of course).
8495 .next
8496 .cindex "lookup" "in domain list"
8497 .cindex "domain list" "matching by lookup"
8498 If a pattern starts with the name of a single-key lookup type followed by a
8499 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8500 must be a filename in a suitable format for the lookup type. For example, for
8501 &"cdb;"& it must be an absolute path:
8502 .code
8503 domains = cdb;/etc/mail/local_domains.cdb
8504 .endd
8505 The appropriate type of lookup is done on the file using the domain name as the
8506 key. In most cases, the data that is looked up is not used; Exim is interested
8507 only in whether or not the key is present in the file. However, when a lookup
8508 is used for the &%domains%& option on a router
8509 or a &%domains%& condition in an ACL statement, the data is preserved in the
8510 &$domain_data$& variable and can be referred to in other router options or
8511 other statements in the same ACL.
8512
8513 .next
8514 Any of the single-key lookup type names may be preceded by
8515 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8516 .code
8517 domains = partial-dbm;/partial/domains
8518 .endd
8519 This causes partial matching logic to be invoked; a description of how this
8520 works is given in section &<<SECTpartiallookup>>&.
8521
8522 .next
8523 .cindex "asterisk" "in lookup type"
8524 Any of the single-key lookup types may be followed by an asterisk. This causes
8525 a default lookup for a key consisting of a single asterisk to be done if the
8526 original lookup fails. This is not a useful feature when using a domain list to
8527 select particular domains (because any domain would match), but it might have
8528 value if the result of the lookup is being used via the &$domain_data$&
8529 expansion variable.
8530 .next
8531 If the pattern starts with the name of a query-style lookup type followed by a
8532 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8533 pattern must be an appropriate query for the lookup type, as described in
8534 chapter &<<CHAPfdlookup>>&. For example:
8535 .code
8536 hold_domains = mysql;select domain from holdlist \
8537   where domain = '${quote_mysql:$domain}';
8538 .endd
8539 In most cases, the data that is looked up is not used (so for an SQL query, for
8540 example, it doesn't matter what field you select). Exim is interested only in
8541 whether or not the query succeeds. However, when a lookup is used for the
8542 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8543 variable and can be referred to in other options.
8544 .next
8545 .cindex "domain list" "matching literal domain name"
8546 If none of the above cases apply, a caseless textual comparison is made
8547 between the pattern and the domain.
8548 .endlist
8549
8550 Here is an example that uses several different kinds of pattern:
8551 .code
8552 domainlist funny_domains = \
8553   @ : \
8554   lib.unseen.edu : \
8555   *.foundation.fict.example : \
8556   \N^[1-2]\d{3}\.fict\.example$\N : \
8557   partial-dbm;/opt/data/penguin/book : \
8558   nis;domains.byname : \
8559   nisplus;[name=$domain,status=local],domains.org_dir
8560 .endd
8561 There are obvious processing trade-offs among the various matching modes. Using
8562 an asterisk is faster than a regular expression, and listing a few names
8563 explicitly probably is too. The use of a file or database lookup is expensive,
8564 but may be the only option if hundreds of names are required. Because the
8565 patterns are tested in order, it makes sense to put the most commonly matched
8566 patterns earlier.
8567
8568
8569
8570 .section "Host lists" "SECThostlist"
8571 .cindex "host list" "patterns in"
8572 .cindex "list" "host list"
8573 Host lists are used to control what remote hosts are allowed to do. For
8574 example, some hosts may be allowed to use the local host as a relay, and some
8575 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8576 two different ways, by name or by IP address. In a host list, some types of
8577 pattern are matched to a host name, and some are matched to an IP address.
8578 You need to be particularly careful with this when single-key lookups are
8579 involved, to ensure that the right value is being used as the key.
8580
8581
8582 .section "Special host list patterns" "SECID80"
8583 .cindex "empty item in hosts list"
8584 .cindex "host list" "empty string in"
8585 If a host list item is the empty string, it matches only when no remote host is
8586 involved. This is the case when a message is being received from a local
8587 process using SMTP on the standard input, that is, when a TCP/IP connection is
8588 not used.
8589
8590 .cindex "asterisk" "in host list"
8591 The special pattern &"*"& in a host list matches any host or no host. Neither
8592 the IP address nor the name is actually inspected.
8593
8594
8595
8596 .section "Host list patterns that match by IP address" "SECThoslispatip"
8597 .cindex "host list" "matching IP addresses"
8598 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8599 the incoming address actually appears in the IPv6 host as
8600 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8601 list, it is converted into a traditional IPv4 address first. (Not all operating
8602 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8603 concerns.)
8604
8605 The following types of pattern in a host list check the remote host by
8606 inspecting its IP address:
8607
8608 .ilist
8609 If the pattern is a plain domain name (not a regular expression, not starting
8610 with *, not a lookup of any kind), Exim calls the operating system function
8611 to find the associated IP address(es). Exim uses the newer
8612 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8613 This typically causes a forward DNS lookup of the name. The result is compared
8614 with the IP address of the subject host.
8615
8616 If there is a temporary problem (such as a DNS timeout) with the host name
8617 lookup, a temporary error occurs. For example, if the list is being used in an
8618 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8619 temporary SMTP error code. If no IP address can be found for the host name,
8620 what happens is described in section &<<SECTbehipnot>>& below.
8621
8622 .next
8623 .cindex "@ in a host list"
8624 If the pattern is &"@"&, the primary host name is substituted and used as a
8625 domain name, as just described.
8626
8627 .next
8628 If the pattern is an IP address, it is matched against the IP address of the
8629 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8630 IPv6 addresses can be given in colon-separated format, but the colons have to
8631 be doubled so as not to be taken as item separators when the default list
8632 separator is used. IPv6 addresses are recognized even when Exim is compiled
8633 without IPv6 support. This means that if they appear in a host list on an
8634 IPv4-only host, Exim will not treat them as host names. They are just addresses
8635 that can never match a client host.
8636
8637 .next
8638 .cindex "@[] in a host list"
8639 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8640 the local host. For example, if the local host is an IPv4 host with one
8641 interface address 10.45.23.56, these two ACL statements have the same effect:
8642 .code
8643 accept hosts = 127.0.0.1 : 10.45.23.56
8644 accept hosts = @[]
8645 .endd
8646 .next
8647 .cindex "CIDR notation"
8648 If the pattern is an IP address followed by a slash and a mask length (for
8649 example 10.11.42.0/24), it is matched against the IP address of the subject
8650 host under the given mask. This allows, an entire network of hosts to be
8651 included (or excluded) by a single item. The mask uses CIDR notation; it
8652 specifies the number of address bits that must match, starting from the most
8653 significant end of the address.
8654
8655 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8656 of a range of addresses. It is the number of bits in the network portion of the
8657 address. The above example specifies a 24-bit netmask, so it matches all 256
8658 addresses in the 10.11.42.0 network. An item such as
8659 .code
8660 192.168.23.236/31
8661 .endd
8662 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8663 32 for an IPv4 address is the same as no mask at all; just a single address
8664 matches.
8665
8666 Here is another example which shows an IPv4 and an IPv6 network:
8667 .code
8668 recipient_unqualified_hosts = 192.168.0.0/16: \
8669                               3ffe::ffff::836f::::/48
8670 .endd
8671 The doubling of list separator characters applies only when these items
8672 appear inline in a host list. It is not required when indirecting via a file.
8673 For example:
8674 .code
8675 recipient_unqualified_hosts = /opt/exim/unqualnets
8676 .endd
8677 could make use of a file containing
8678 .code
8679 172.16.0.0/12
8680 3ffe:ffff:836f::/48
8681 .endd
8682 to have exactly the same effect as the previous example. When listing IPv6
8683 addresses inline, it is usually more convenient to use the facility for
8684 changing separator characters. This list contains the same two networks:
8685 .code
8686 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8687                                  3ffe:ffff:836f::/48
8688 .endd
8689 The separator is changed to semicolon by the leading &"<;"& at the start of the
8690 list.
8691 .endlist
8692
8693
8694
8695 .section "Host list patterns for single-key lookups by host address" &&&
8696          "SECThoslispatsikey"
8697 .cindex "host list" "lookup of IP address"
8698 When a host is to be identified by a single-key lookup of its complete IP
8699 address, the pattern takes this form:
8700 .display
8701 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8702 .endd
8703 For example:
8704 .code
8705 hosts_lookup = net-cdb;/hosts-by-ip.db
8706 .endd
8707 The text form of the IP address of the subject host is used as the lookup key.
8708 IPv6 addresses are converted to an unabbreviated form, using lower case
8709 letters, with dots as separators because colon is the key terminator in
8710 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8711 quoting the keys, but this is a facility that was added later.] The data
8712 returned by the lookup is not used.
8713
8714 .cindex "IP address" "masking"
8715 .cindex "host list" "masked IP address"
8716 Single-key lookups can also be performed using masked IP addresses, using
8717 patterns of this form:
8718 .display
8719 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8720 .endd
8721 For example:
8722 .code
8723 net24-dbm;/networks.db
8724 .endd
8725 The IP address of the subject host is masked using <&'number'&> as the mask
8726 length. A textual string is constructed from the masked value, followed by the
8727 mask, and this is used as the lookup key. For example, if the host's IP address
8728 is 192.168.34.6, the key that is looked up for the above example is
8729 &"192.168.34.0/24"&.
8730
8731 When an IPv6 address is converted to a string, dots are normally used instead
8732 of colons, so that keys in &(lsearch)& files need not contain colons (which
8733 terminate &(lsearch)& keys). This was implemented some time before the ability
8734 to quote keys was made available in &(lsearch)& files. However, the more
8735 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8736 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8737 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8738 converted using colons and not dots.
8739 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8740 addresses are always used.
8741 The latter are converted to IPv4 addresses, in dotted-quad form.
8742
8743 Ideally, it would be nice to tidy up this anomalous situation by changing to
8744 colons in all cases, given that quoting is now available for &(lsearch)&.
8745 However, this would be an incompatible change that might break some existing
8746 configurations.
8747
8748 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8749 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8750 the former case the key strings include the mask value, whereas in the latter
8751 case the IP address is used on its own.
8752
8753
8754
8755 .section "Host list patterns that match by host name" "SECThoslispatnam"
8756 .cindex "host" "lookup failures"
8757 .cindex "unknown host name"
8758 .cindex "host list" "matching host name"
8759 There are several types of pattern that require Exim to know the name of the
8760 remote host. These are either wildcard patterns or lookups by name. (If a
8761 complete hostname is given without any wildcarding, it is used to find an IP
8762 address to match against, as described in section &<<SECThoslispatip>>&
8763 above.)
8764
8765 If the remote host name is not already known when Exim encounters one of these
8766 patterns, it has to be found from the IP address.
8767 Although many sites on the Internet are conscientious about maintaining reverse
8768 DNS data for their hosts, there are also many that do not do this.
8769 Consequently, a name cannot always be found, and this may lead to unwanted
8770 effects. Take care when configuring host lists with wildcarded name patterns.
8771 Consider what will happen if a name cannot be found.
8772
8773 Because of the problems of determining host names from IP addresses, matching
8774 against host names is not as common as matching against IP addresses.
8775
8776 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8777 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8778 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8779 are done can be changed by setting the &%host_lookup_order%& option. For
8780 security, once Exim has found one or more names, it looks up the IP addresses
8781 for these names and compares them with the IP address that it started with.
8782 Only those names whose IP addresses match are accepted. Any other names are
8783 discarded. If no names are left, Exim behaves as if the host name cannot be
8784 found. In the most common case there is only one name and one IP address.
8785
8786 There are some options that control what happens if a host name cannot be
8787 found. These are described in section &<<SECTbehipnot>>& below.
8788
8789 .cindex "host" "alias for"
8790 .cindex "alias for host"
8791 As a result of aliasing, hosts may have more than one name. When processing any
8792 of the following types of pattern, all the host's names are checked:
8793
8794 .ilist
8795 .cindex "asterisk" "in host list"
8796 If a pattern starts with &"*"& the remainder of the item must match the end of
8797 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8798 &'.b.c'&. This special simple form is provided because this is a very common
8799 requirement. Other kinds of wildcarding require the use of a regular
8800 expression.
8801 .next
8802 .cindex "regular expressions" "in host list"
8803 .cindex "host list" "regular expression in"
8804 If the item starts with &"^"& it is taken to be a regular expression which is
8805 matched against the host name. Host names are case-independent, so this regular
8806 expression match is by default case-independent, but you can make it
8807 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8808 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8809 example,
8810 .code
8811 ^(a|b)\.c\.d$
8812 .endd
8813 is a regular expression that matches either of the two hosts &'a.c.d'& or
8814 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8815 that backslash and dollar characters are not misinterpreted as part of the
8816 string expansion. The simplest way to do this is to use &`\N`& to mark that
8817 part of the string as non-expandable. For example:
8818 .code
8819 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8820 .endd
8821 &*Warning*&: If you want to match a complete host name, you must include the
8822 &`$`& terminating metacharacter in the regular expression, as in the above
8823 example. Without it, a match at the start of the host name is all that is
8824 required.
8825 .endlist
8826
8827
8828
8829
8830 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8831 .cindex "host" "lookup failures, permanent"
8832 While processing a host list, Exim may need to look up an IP address from a
8833 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8834 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8835 behaviour when it fails to find the information it is seeking is the same.
8836
8837 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8838 apply to temporary DNS errors, whose handling is described in the next section.
8839
8840 .cindex "&`+include_unknown`&"
8841 .cindex "&`+ignore_unknown`&"
8842 Exim parses a host list from left to right. If it encounters a permanent
8843 lookup failure in any item in the host list before it has found a match,
8844 Exim treats it as a failure and the default behavior is as if the host
8845 does not match the list. This may not always be what you want to happen.
8846 To change Exim's behaviour, the special items &`+include_unknown`& or
8847 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8848 not recognized in an indirected file).
8849
8850 .ilist
8851 If any item that follows &`+include_unknown`& requires information that
8852 cannot found, Exim behaves as if the host does match the list. For example,
8853 .code
8854 host_reject_connection = +include_unknown:*.enemy.ex
8855 .endd
8856 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8857 any hosts whose name it cannot find.
8858
8859 .next
8860 If any item that follows &`+ignore_unknown`& requires information that cannot
8861 be found, Exim ignores that item and proceeds to the rest of the list. For
8862 example:
8863 .code
8864 accept hosts = +ignore_unknown : friend.example : \
8865                192.168.4.5
8866 .endd
8867 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8868 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8869 name can be found for 192.168.4.5, it is rejected.
8870 .endlist
8871
8872 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8873 list. The effect of each one lasts until the next, or until the end of the
8874 list.
8875
8876 .section "Mixing wildcarded host names and addresses in host lists" &&&
8877          "SECTmixwilhos"
8878 .cindex "host list" "mixing names and addresses in"
8879
8880 This section explains the host/ip processing logic with the same concepts
8881 as the previous section, but specifically addresses what happens when a
8882 wildcarded hostname is one of the items in the hostlist.
8883
8884 .ilist
8885 If you have name lookups or wildcarded host names and
8886 IP addresses in the same host list, you should normally put the IP
8887 addresses first. For example, in an ACL you could have:
8888 .code
8889 accept hosts = 10.9.8.7 : *.friend.example
8890 .endd
8891 The reason you normally would order it this way lies in the
8892 left-to-right way that Exim processes lists.  It can test IP addresses
8893 without doing any DNS lookups, but when it reaches an item that requires
8894 a host name, it fails if it cannot find a host name to compare with the
8895 pattern. If the above list is given in the opposite order, the
8896 &%accept%& statement fails for a host whose name cannot be found, even
8897 if its IP address is 10.9.8.7.
8898
8899 .next
8900 If you really do want to do the name check first, and still recognize the IP
8901 address, you can rewrite the ACL like this:
8902 .code
8903 accept hosts = *.friend.example
8904 accept hosts = 10.9.8.7
8905 .endd
8906 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8907 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8908 &`+ignore_unknown`&, which was discussed in depth in the first example in
8909 this section.
8910 .endlist
8911
8912
8913 .section "Temporary DNS errors when looking up host information" &&&
8914          "SECTtemdnserr"
8915 .cindex "host" "lookup failures, temporary"
8916 .cindex "&`+include_defer`&"
8917 .cindex "&`+ignore_defer`&"
8918 A temporary DNS lookup failure normally causes a defer action (except when
8919 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8920 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8921 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8922 section. These options should be used with care, probably only in non-critical
8923 host lists such as whitelists.
8924
8925
8926
8927 .section "Host list patterns for single-key lookups by host name" &&&
8928          "SECThoslispatnamsk"
8929 .cindex "unknown host name"
8930 .cindex "host list" "matching host name"
8931 If a pattern is of the form
8932 .display
8933 <&'single-key-search-type'&>;<&'search-data'&>
8934 .endd
8935 for example
8936 .code
8937 dbm;/host/accept/list
8938 .endd
8939 a single-key lookup is performed, using the host name as its key. If the
8940 lookup succeeds, the host matches the item. The actual data that is looked up
8941 is not used.
8942
8943 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8944 keys in the file, not IP addresses. If you want to do lookups based on IP
8945 addresses, you must precede the search type with &"net-"& (see section
8946 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8947 two items in the same list, one doing an address lookup and one doing a name
8948 lookup, both using the same file.
8949
8950
8951
8952 .section "Host list patterns for query-style lookups" "SECID81"
8953 If a pattern is of the form
8954 .display
8955 <&'query-style-search-type'&>;<&'query'&>
8956 .endd
8957 the query is obeyed, and if it succeeds, the host matches the item. The actual
8958 data that is looked up is not used. The variables &$sender_host_address$& and
8959 &$sender_host_name$& can be used in the query. For example:
8960 .code
8961 hosts_lookup = pgsql;\
8962   select ip from hostlist where ip='$sender_host_address'
8963 .endd
8964 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8965 can use the &%sg%& expansion item to change this if you need to. If you want to
8966 use masked IP addresses in database queries, you can use the &%mask%& expansion
8967 operator.
8968
8969 If the query contains a reference to &$sender_host_name$&, Exim automatically
8970 looks up the host name if it has not already done so. (See section
8971 &<<SECThoslispatnam>>& for comments on finding host names.)
8972
8973 Historical note: prior to release 4.30, Exim would always attempt to find a
8974 host name before running the query, unless the search type was preceded by
8975 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8976 still recognized for query-style lookups, but its presence or absence has no
8977 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8978 See section &<<SECThoslispatsikey>>&.)
8979
8980
8981
8982
8983
8984 .section "Address lists" "SECTaddresslist"
8985 .cindex "list" "address list"
8986 .cindex "address list" "empty item"
8987 .cindex "address list" "patterns"
8988 Address lists contain patterns that are matched against mail addresses. There
8989 is one special case to be considered: the sender address of a bounce message is
8990 always empty. You can test for this by providing an empty item in an address
8991 list. For example, you can set up a router to process bounce messages by
8992 using this option setting:
8993 .code
8994 senders = :
8995 .endd
8996 The presence of the colon creates an empty item. If you do not provide any
8997 data, the list is empty and matches nothing. The empty sender can also be
8998 detected by a regular expression that matches an empty string,
8999 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9000
9001 Non-empty items in an address list can be straightforward email addresses. For
9002 example:
9003 .code
9004 senders = jbc@askone.example : hs@anacreon.example
9005 .endd
9006 A certain amount of wildcarding is permitted. If a pattern contains an @
9007 character, but is not a regular expression and does not begin with a
9008 semicolon-terminated lookup type (described below), the local part of the
9009 subject address is compared with the local part of the pattern, which may start
9010 with an asterisk. If the local parts match, the domain is checked in exactly
9011 the same way as for a pattern in a domain list. For example, the domain can be
9012 wildcarded, refer to a named list, or be a lookup:
9013 .code
9014 deny senders = *@*.spamming.site:\
9015                *@+hostile_domains:\
9016                bozo@partial-lsearch;/list/of/dodgy/sites:\
9017                *@dbm;/bad/domains.db
9018 .endd
9019 .cindex "local part" "starting with !"
9020 .cindex "address list" "local part starting with !"
9021 If a local part that begins with an exclamation mark is required, it has to be
9022 specified using a regular expression, because otherwise the exclamation mark is
9023 treated as a sign of negation, as is standard in lists.
9024
9025 If a non-empty pattern that is not a regular expression or a lookup does not
9026 contain an @ character, it is matched against the domain part of the subject
9027 address. The only two formats that are recognized this way are a literal
9028 domain, or a domain pattern that starts with *. In both these cases, the effect
9029 is the same as if &`*@`& preceded the pattern. For example:
9030 .code
9031 deny senders = enemy.domain : *.enemy.domain
9032 .endd
9033
9034 The following kinds of more complicated address list pattern can match any
9035 address, including the empty address that is characteristic of bounce message
9036 senders:
9037
9038 .ilist
9039 .cindex "regular expressions" "in address list"
9040 .cindex "address list" "regular expression in"
9041 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9042 done against the complete address, with the pattern as the regular expression.
9043 You must take care that backslash and dollar characters are not misinterpreted
9044 as part of the string expansion. The simplest way to do this is to use &`\N`&
9045 to mark that part of the string as non-expandable. For example:
9046 .code
9047 deny senders = \N^.*this.*@example\.com$\N : \
9048                \N^\d{8}.+@spamhaus.example$\N : ...
9049 .endd
9050 The &`\N`& sequences are removed by the expansion, so these items do indeed
9051 start with &"^"& by the time they are being interpreted as address patterns.
9052
9053 .next
9054 .cindex "address list" "lookup for complete address"
9055 Complete addresses can be looked up by using a pattern that starts with a
9056 lookup type terminated by a semicolon, followed by the data for the lookup. For
9057 example:
9058 .code
9059 deny senders = cdb;/etc/blocked.senders : \
9060   mysql;select address from blocked where \
9061   address='${quote_mysql:$sender_address}'
9062 .endd
9063 Both query-style and single-key lookup types can be used. For a single-key
9064 lookup type, Exim uses the complete address as the key. However, empty keys are
9065 not supported for single-key lookups, so a match against the empty address
9066 always fails. This restriction does not apply to query-style lookups.
9067
9068 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9069 cannot be used, and is ignored if specified, with an entry being written to the
9070 panic log.
9071 .cindex "*@ with single-key lookup"
9072 However, you can configure lookup defaults, as described in section
9073 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9074 default. For example, with this lookup:
9075 .code
9076 accept senders = lsearch*@;/some/file
9077 .endd
9078 the file could contains lines like this:
9079 .code
9080 user1@domain1.example
9081 *@domain2.example
9082 .endd
9083 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9084 that are tried is:
9085 .code
9086 nimrod@jaeger.example
9087 *@jaeger.example
9088 *
9089 .endd
9090 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9091 would mean that every address matches, thus rendering the test useless.
9092
9093 &*Warning 2*&: Do not confuse these two kinds of item:
9094 .code
9095 deny recipients = dbm*@;/some/file
9096 deny recipients = *@dbm;/some/file
9097 .endd
9098 The first does a whole address lookup, with defaulting, as just described,
9099 because it starts with a lookup type. The second matches the local part and
9100 domain independently, as described in a bullet point below.
9101 .endlist
9102
9103
9104 The following kinds of address list pattern can match only non-empty addresses.
9105 If the subject address is empty, a match against any of these pattern types
9106 always fails.
9107
9108
9109 .ilist
9110 .cindex "@@ with single-key lookup"
9111 .cindex "address list" "@@ lookup type"
9112 .cindex "address list" "split local part and domain"
9113 If a pattern starts with &"@@"& followed by a single-key lookup item
9114 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9115 split into a local part and a domain. The domain is looked up in the file. If
9116 it is not found, there is no match. If it is found, the data that is looked up
9117 from the file is treated as a colon-separated list of local part patterns, each
9118 of which is matched against the subject local part in turn.
9119
9120 .cindex "asterisk" "in address list"
9121 The lookup may be a partial one, and/or one involving a search for a default
9122 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9123 patterns that are looked up can be regular expressions or begin with &"*"&, or
9124 even be further lookups. They may also be independently negated. For example,
9125 with
9126 .code
9127 deny senders = @@dbm;/etc/reject-by-domain
9128 .endd
9129 the data from which the DBM file is built could contain lines like
9130 .code
9131 baddomain.com:  !postmaster : *
9132 .endd
9133 to reject all senders except &%postmaster%& from that domain.
9134
9135 .cindex "local part" "starting with !"
9136 If a local part that actually begins with an exclamation mark is required, it
9137 has to be specified using a regular expression. In &(lsearch)& files, an entry
9138 may be split over several lines by indenting the second and subsequent lines,
9139 but the separating colon must still be included at line breaks. White space
9140 surrounding the colons is ignored. For example:
9141 .code
9142 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9143   spammer3 : spammer4
9144 .endd
9145 As in all colon-separated lists in Exim, a colon can be included in an item by
9146 doubling.
9147
9148 If the last item in the list starts with a right angle-bracket, the remainder
9149 of the item is taken as a new key to look up in order to obtain a continuation
9150 list of local parts. The new key can be any sequence of characters. Thus one
9151 might have entries like
9152 .code
9153 aol.com: spammer1 : spammer 2 : >*
9154 xyz.com: spammer3 : >*
9155 *:       ^\d{8}$
9156 .endd
9157 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9158 local parts for all domains, in addition to the specific local parts listed for
9159 each domain. Of course, using this feature costs another lookup each time a
9160 chain is followed, but the effort needed to maintain the data is reduced.
9161
9162 .cindex "loop" "in lookups"
9163 It is possible to construct loops using this facility, and in order to catch
9164 them, the chains may be no more than fifty items long.
9165
9166 .next
9167 The @@<&'lookup'&> style of item can also be used with a query-style
9168 lookup, but in this case, the chaining facility is not available. The lookup
9169 can only return a single list of local parts.
9170 .endlist
9171
9172 &*Warning*&: There is an important difference between the address list items
9173 in these two examples:
9174 .code
9175 senders = +my_list
9176 senders = *@+my_list
9177 .endd
9178 In the first one, &`my_list`& is a named address list, whereas in the second
9179 example it is a named domain list.
9180
9181
9182
9183
9184 .section "Case of letters in address lists" "SECTcasletadd"
9185 .cindex "case of local parts"
9186 .cindex "address list" "case forcing"
9187 .cindex "case forcing in address lists"
9188 Domains in email addresses are always handled caselessly, but for local parts
9189 case may be significant on some systems (see &%caseful_local_part%& for how
9190 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9191 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9192 blocking lists should be done in a case-independent manner. Since most address
9193 lists in Exim are used for this kind of control, Exim attempts to do this by
9194 default.
9195
9196 The domain portion of an address is always lowercased before matching it to an
9197 address list. The local part is lowercased by default, and any string
9198 comparisons that take place are done caselessly. This means that the data in
9199 the address list itself, in files included as plain filenames, and in any file
9200 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9201 keys in files that are looked up by a search type other than &(lsearch)& (which
9202 works caselessly) must be in lower case, because these lookups are not
9203 case-independent.
9204
9205 .cindex "&`+caseful`&"
9206 To allow for the possibility of caseful address list matching, if an item in
9207 an address list is the string &"+caseful"&, the original case of the local
9208 part is restored for any comparisons that follow, and string comparisons are no
9209 longer case-independent. This does not affect the domain, which remains in
9210 lower case. However, although independent matches on the domain alone are still
9211 performed caselessly, regular expressions that match against an entire address
9212 become case-sensitive after &"+caseful"& has been seen.
9213
9214
9215
9216 .section "Local part lists" "SECTlocparlis"
9217 .cindex "list" "local part list"
9218 .cindex "local part" "list"
9219 Case-sensitivity in local part lists is handled in the same way as for address
9220 lists, as just described. The &"+caseful"& item can be used if required. In a
9221 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9222 set false, the subject is lowercased and the matching is initially
9223 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9224 matching in the local part list, but not elsewhere in the router. If
9225 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9226 option is case-sensitive from the start.
9227
9228 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9229 comments are handled in the same way as address lists &-- they are recognized
9230 only if the # is preceded by white space or the start of the line.
9231 Otherwise, local part lists are matched in the same way as domain lists, except
9232 that the special items that refer to the local host (&`@`&, &`@[]`&,
9233 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9234 Refer to section &<<SECTdomainlist>>& for details of the other available item
9235 types.
9236 .ecindex IIDdohoadli
9237
9238
9239
9240
9241 . ////////////////////////////////////////////////////////////////////////////
9242 . ////////////////////////////////////////////////////////////////////////////
9243
9244 .chapter "String expansions" "CHAPexpand"
9245 .scindex IIDstrexp "expansion" "of strings"
9246 Many strings in Exim's runtime configuration are expanded before use. Some of
9247 them are expanded every time they are used; others are expanded only once.
9248
9249 When a string is being expanded it is copied verbatim from left to right except
9250 .cindex expansion "string concatenation"
9251 when a dollar or backslash character is encountered. A dollar specifies the
9252 start of a portion of the string that is interpreted and replaced as described
9253 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9254 escape character, as described in the following section.
9255
9256 Whether a string is expanded depends upon the context.  Usually this is solely
9257 dependent upon the option for which a value is sought; in this documentation,
9258 options for which string expansion is performed are marked with &dagger; after
9259 the data type.  ACL rules always expand strings.  A couple of expansion
9260 conditions do not expand some of the brace-delimited branches, for security
9261 reasons,
9262 .cindex "tainted data" expansion
9263 .cindex expansion "tainted data"
9264 and expansion of data deriving from the sender (&"tainted data"&)
9265 is not permitted.
9266
9267
9268
9269 .section "Literal text in expanded strings" "SECTlittext"
9270 .cindex "expansion" "including literal text"
9271 An uninterpreted dollar can be included in an expanded string by putting a
9272 backslash in front of it. A backslash can be used to prevent any special
9273 character being treated specially in an expansion, including backslash itself.
9274 If the string appears in quotes in the configuration file, two backslashes are
9275 required because the quotes themselves cause interpretation of backslashes when
9276 the string is read in (see section &<<SECTstrings>>&).
9277
9278 .cindex "expansion" "non-expandable substrings"
9279 A portion of the string can specified as non-expandable by placing it between
9280 two occurrences of &`\N`&. This is particularly useful for protecting regular
9281 expressions, which often contain backslashes and dollar signs. For example:
9282 .code
9283 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9284 .endd
9285 On encountering the first &`\N`&, the expander copies subsequent characters
9286 without interpretation until it reaches the next &`\N`& or the end of the
9287 string.
9288
9289
9290
9291 .section "Character escape sequences in expanded strings" "SECID82"
9292 .cindex "expansion" "escape sequences"
9293 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9294 expanded string is recognized as an escape sequence for the character newline,
9295 carriage return, or tab, respectively. A backslash followed by up to three
9296 octal digits is recognized as an octal encoding for a single character, and a
9297 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9298 encoding.
9299
9300 These escape sequences are also recognized in quoted strings when they are read
9301 in. Their interpretation in expansions as well is useful for unquoted strings,
9302 and for other cases such as looked-up strings that are then expanded.
9303
9304
9305 .section "Testing string expansions" "SECID83"
9306 .cindex "expansion" "testing"
9307 .cindex "testing" "string expansion"
9308 .oindex "&%-be%&"
9309 Many expansions can be tested by calling Exim with the &%-be%& option. This
9310 takes the command arguments, or lines from the standard input if there are no
9311 arguments, runs them through the string expansion code, and writes the results
9312 to the standard output. Variables based on configuration values are set up, but
9313 since no message is being processed, variables such as &$local_part$& have no
9314 value. Nevertheless the &%-be%& option can be useful for checking out file and
9315 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9316 and &%nhash%&.
9317
9318 Exim gives up its root privilege when it is called with the &%-be%& option, and
9319 instead runs under the uid and gid it was called with, to prevent users from
9320 using &%-be%& for reading files to which they do not have access.
9321
9322 .oindex "&%-bem%&"
9323 If you want to test expansions that include variables whose values are taken
9324 from a message, there are two other options that can be used. The &%-bem%&
9325 option is like &%-be%& except that it is followed by a filename. The file is
9326 read as a message before doing the test expansions. For example:
9327 .code
9328 exim -bem /tmp/test.message '$h_subject:'
9329 .endd
9330 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9331 Exim message identifier. For example:
9332 .code
9333 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9334 .endd
9335 This loads the message from Exim's spool before doing the test expansions, and
9336 is therefore restricted to admin users.
9337
9338
9339 .section "Forced expansion failure" "SECTforexpfai"
9340 .cindex "expansion" "forced failure"
9341 A number of expansions that are described in the following section have
9342 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9343 (which are sometimes called &"curly brackets"&). Which of the two strings is
9344 used depends on some condition that is evaluated as part of the expansion. If,
9345 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9346 the entire string expansion fails in a way that can be detected by the code
9347 that requested the expansion. This is called &"forced expansion failure"&, and
9348 its consequences depend on the circumstances. In some cases it is no different
9349 from any other expansion failure, but in others a different action may be
9350 taken. Such variations are mentioned in the documentation of the option that is
9351 being expanded.
9352
9353
9354
9355
9356 .section "Expansion items" "SECTexpansionitems"
9357 The following items are recognized in expanded strings. White space may be used
9358 between sub-items that are keywords or substrings enclosed in braces inside an
9359 outer set of braces, to improve readability. &*Warning*&: Within braces,
9360 white space is significant.
9361
9362 .vlist
9363 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9364 .cindex "expansion" "variables"
9365 Substitute the contents of the named variable, for example:
9366 .code
9367 $local_part
9368 ${domain}
9369 .endd
9370 The second form can be used to separate the name from subsequent alphanumeric
9371 characters. This form (using braces) is available only for variables; it does
9372 &'not'& apply to message headers. The names of the variables are given in
9373 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9374 given, the expansion fails.
9375
9376 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9377 .cindex "expansion" "operators"
9378 The string is first itself expanded, and then the operation specified by
9379 <&'op'&> is applied to it. For example:
9380 .code
9381 ${lc:$local_part}
9382 .endd
9383 The string starts with the first character after the colon, which may be
9384 leading white space. A list of operators is given in section &<<SECTexpop>>&
9385 below. The operator notation is used for simple expansion items that have just
9386 one argument, because it reduces the number of braces and therefore makes the
9387 string easier to understand.
9388
9389 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9390 This item inserts &"basic"& header lines. It is described with the &%header%&
9391 expansion item below.
9392
9393
9394 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9395 .cindex "expansion" "calling an acl"
9396 .cindex "&%acl%&" "call from expansion"
9397 The name and zero to nine argument strings are first expanded separately.  The expanded
9398 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9399 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9400 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9401 and may use the variables; if another acl expansion is used the values
9402 are restored after it returns.  If the ACL sets
9403 a value using a "message =" modifier and returns accept or deny, the value becomes
9404 the result of the expansion.
9405 If no message is set and the ACL returns accept or deny
9406 the expansion result is an empty string.
9407 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9408
9409
9410 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9411 .cindex authentication "results header"
9412 .cindex headers "authentication-results:"
9413 .cindex authentication "expansion item"
9414 This item returns a string suitable for insertion as an
9415 &'Authentication-Results:'&
9416 header line.
9417 The given <&'authserv-id'&> is included in the result; typically this
9418 will be a domain name identifying the system performing the authentications.
9419 Methods that might be present in the result include:
9420 .code
9421 none
9422 iprev
9423 auth
9424 spf
9425 dkim
9426 .endd
9427
9428 Example use (as an ACL modifier):
9429 .code
9430       add_header = :at_start:${authresults {$primary_hostname}}
9431 .endd
9432 This is safe even if no authentication results are available.
9433
9434
9435 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9436        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9437 .cindex "expansion" "extracting certificate fields"
9438 .cindex "&%certextract%&" "certificate fields"
9439 .cindex "certificate" "extracting fields"
9440 The <&'certificate'&> must be a variable of type certificate.
9441 The field name is expanded and used to retrieve the relevant field from
9442 the certificate.  Supported fields are:
9443 .display
9444 &`version        `&
9445 &`serial_number  `&
9446 &`subject        `& RFC4514 DN
9447 &`issuer         `& RFC4514 DN
9448 &`notbefore      `& time
9449 &`notafter       `& time
9450 &`sig_algorithm  `&
9451 &`signature      `&
9452 &`subj_altname   `& tagged list
9453 &`ocsp_uri       `& list
9454 &`crl_uri        `& list
9455 .endd
9456 If the field is found,
9457 <&'string2'&> is expanded, and replaces the whole item;
9458 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9459 variable &$value$& contains the value that has been extracted. Afterwards, it
9460 is restored to any previous value it might have had.
9461
9462 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9463 key is not found. If {<&'string2'&>} is also omitted, the value that was
9464 extracted is used.
9465
9466 Some field names take optional modifiers, appended and separated by commas.
9467
9468 The field selectors marked as "RFC4514" above
9469 output a Distinguished Name string which is
9470 not quite
9471 parseable by Exim as a comma-separated tagged list
9472 (the exceptions being elements containing commas).
9473 RDN elements of a single type may be selected by
9474 a modifier of the type label; if so the expansion
9475 result is a list (newline-separated by default).
9476 The separator may be changed by another modifier of
9477 a right angle-bracket followed immediately by the new separator.
9478 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9479
9480 The field selectors marked as "time" above
9481 take an optional modifier of "int"
9482 for which the result is the number of seconds since epoch.
9483 Otherwise the result is a human-readable string
9484 in the timezone selected by the main "timezone" option.
9485
9486 The field selectors marked as "list" above return a list,
9487 newline-separated by default,
9488 (embedded separator characters in elements are doubled).
9489 The separator may be changed by a modifier of
9490 a right angle-bracket followed immediately by the new separator.
9491
9492 The field selectors marked as "tagged" above
9493 prefix each list element with a type string and an equals sign.
9494 Elements of only one type may be selected by a modifier
9495 which is one of "dns", "uri" or "mail";
9496 if so the element tags are omitted.
9497
9498 If not otherwise noted field values are presented in human-readable form.
9499
9500 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9501        {*&<&'arg'&>&*}...}*&"
9502 .cindex &%dlfunc%&
9503 This expansion dynamically loads and then calls a locally-written C function.
9504 This functionality is available only if Exim is compiled with
9505 .code
9506 EXPAND_DLFUNC=yes
9507 .endd
9508 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9509 object so that it doesn't reload the same object file in the same Exim process
9510 (but of course Exim does start new processes frequently).
9511
9512 There may be from zero to eight arguments to the function.
9513
9514 When compiling
9515 a local function that is to be called in this way,
9516 first &_DLFUNC_IMPL_& should be defined,
9517 and second &_local_scan.h_& should be included.
9518 The Exim variables and functions that are defined by that API
9519 are also available for dynamically loaded functions. The function itself
9520 must have the following type:
9521 .code
9522 int dlfunction(uschar **yield, int argc, uschar *argv[])
9523 .endd
9524 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9525 function should return one of the following values:
9526
9527 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9528 into the expanded string that is being built.
9529
9530 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9531 from &'yield'&, if it is set.
9532
9533 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9534 taken from &'yield'& if it is set.
9535
9536 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9537
9538 When compiling a function that is to be used in this way with gcc,
9539 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9540 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9541
9542
9543 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9544 .cindex "expansion" "extracting value from environment"
9545 .cindex "environment" "values from"
9546 The key is first expanded separately, and leading and trailing white space
9547 removed.
9548 This is then searched for as a name in the environment.
9549 If a variable is found then its value is placed in &$value$&
9550 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9551
9552 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9553 appear, for example:
9554 .code
9555 ${env{USER}{$value} fail }
9556 .endd
9557 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9558 {<&'string1'&>} must be present for &"fail"& to be recognized.
9559
9560 If {<&'string2'&>} is omitted an empty string is substituted on
9561 search failure.
9562 If {<&'string1'&>} is omitted the search result is substituted on
9563 search success.
9564
9565 The environment is adjusted by the &%keep_environment%& and
9566 &%add_environment%& main section options.
9567
9568
9569 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9570        {*&<&'string3'&>&*}}*&"
9571 .cindex "expansion" "extracting substrings by key"
9572 .cindex "&%extract%&" "substrings by key"
9573 The key and <&'string1'&> are first expanded separately. Leading and trailing
9574 white space is removed from the key (but not from any of the strings). The key
9575 must not be empty and must not consist entirely of digits.
9576 The expanded <&'string1'&> must be of the form:
9577 .display
9578 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9579 .endd
9580 .vindex "&$value$&"
9581 where the equals signs and spaces (but not both) are optional. If any of the
9582 values contain white space, they must be enclosed in double quotes, and any
9583 values that are enclosed in double quotes are subject to escape processing as
9584 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9585 for the value that corresponds to the key. The search is case-insensitive. If
9586 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9587 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9588 variable &$value$& contains the value that has been extracted. Afterwards, it
9589 is restored to any previous value it might have had.
9590
9591 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9592 key is not found. If {<&'string2'&>} is also omitted, the value that was
9593 extracted is used. Thus, for example, these two expansions are identical, and
9594 yield &"2001"&:
9595 .code
9596 ${extract{gid}{uid=1984 gid=2001}}
9597 ${extract{gid}{uid=1984 gid=2001}{$value}}
9598 .endd
9599 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9600 appear, for example:
9601 .code
9602 ${extract{Z}{A=... B=...}{$value} fail }
9603 .endd
9604 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9605 {<&'string2'&>} must be present for &"fail"& to be recognized.
9606
9607 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9608        {*&<&'string3'&>&*}}*&" &&&
9609        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9610        {*&<&'string3'&>&*}}*&"
9611 .cindex "expansion" "extracting from JSON object"
9612 .cindex JSON expansions
9613 The key and <&'string1'&> are first expanded separately. Leading and trailing
9614 white space is removed from the key (but not from any of the strings). The key
9615 must not be empty and must not consist entirely of digits.
9616 The expanded <&'string1'&> must be of the form:
9617 .display
9618 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9619 .endd
9620 .vindex "&$value$&"
9621 The braces, commas and colons, and the quoting of the member name are required;
9622 the spaces are optional.
9623 Matching of the key against the member names is done case-sensitively.
9624 For the &"json"& variant,
9625 if a returned value is a JSON string, it retains its leading and
9626 trailing quotes.
9627 For the &"jsons"& variant, which is intended for use with JSON strings, the
9628 leading and trailing quotes are removed from the returned value.
9629 . XXX should be a UTF-8 compare
9630
9631 The results of matching are handled as above.
9632
9633
9634 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9635         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9636 .cindex "expansion" "extracting substrings by number"
9637 .cindex "&%extract%&" "substrings by number"
9638 The <&'number'&> argument must consist entirely of decimal digits,
9639 apart from leading and trailing white space, which is ignored.
9640 This is what distinguishes this form of &%extract%& from the previous kind. It
9641 behaves in the same way, except that, instead of extracting a named field, it
9642 extracts from <&'string1'&> the field whose number is given as the first
9643 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9644 <&'string3'&> as before.
9645
9646 The fields in the string are separated by any one of the characters in the
9647 separator string. These may include space or tab characters.
9648 The first field is numbered one. If the number is negative, the fields are
9649 counted from the end of the string, with the rightmost one numbered -1. If the
9650 number given is zero, the entire string is returned. If the modulus of the
9651 number is greater than the number of fields in the string, the result is the
9652 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9653 provided. For example:
9654 .code
9655 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9656 .endd
9657 yields &"42"&, and
9658 .code
9659 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9660 .endd
9661 yields &"99"&. Two successive separators mean that the field between them is
9662 empty (for example, the fifth field above).
9663
9664
9665 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9666         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9667        "&*${extract jsons{*&<&'number'&>&*}}&&&
9668         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9669 .cindex "expansion" "extracting from JSON array"
9670 .cindex JSON expansions
9671 The <&'number'&> argument must consist entirely of decimal digits,
9672 apart from leading and trailing white space, which is ignored.
9673
9674 Field selection and result handling is as above;
9675 there is no choice of field separator.
9676 For the &"json"& variant,
9677 if a returned value is a JSON string, it retains its leading and
9678 trailing quotes.
9679 For the &"jsons"& variant, which is intended for use with JSON strings, the
9680 leading and trailing quotes are removed from the returned value.
9681
9682
9683 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9684 .cindex "list" "selecting by condition"
9685 .cindex "expansion" "selecting from list by condition"
9686 .vindex "&$item$&"
9687 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9688 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9689 For each item
9690 in this list, its value is place in &$item$&, and then the condition is
9691 evaluated. If the condition is true, &$item$& is added to the output as an
9692 item in a new list; if the condition is false, the item is discarded. The
9693 separator used for the output list is the same as the one used for the
9694 input, but a separator setting is not included in the output. For example:
9695 .code
9696 ${filter{a:b:c}{!eq{$item}{b}}}
9697 .endd
9698 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9699 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9700
9701
9702 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9703 .cindex "hash function" "textual"
9704 .cindex "expansion" "textual hash"
9705 This is a textual hashing function, and was the first to be implemented in
9706 early versions of Exim. In current releases, there are other hashing functions
9707 (numeric, MD5, and SHA-1), which are described below.
9708
9709 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9710 <&'n'&>. If you are using fixed values for these numbers, that is, if
9711 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9712 use the simpler operator notation that avoids some of the braces:
9713 .code
9714 ${hash_<n>_<m>:<string>}
9715 .endd
9716 The second number is optional (in both notations). If <&'n'&> is greater than
9717 or equal to the length of the string, the expansion item returns the string.
9718 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9719 function to the string. The new string consists of characters taken from the
9720 first <&'m'&> characters of the string
9721 .code
9722 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9723 .endd
9724 If <&'m'&> is not present the value 26 is used, so that only lower case
9725 letters appear. For example:
9726 .display
9727 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9728 &`$hash{5}{monty}}           `&   yields  &`monty`&
9729 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9730 .endd
9731
9732 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9733         &*$h_*&<&'header&~name'&>&*:*&" &&&
9734        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9735         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9736        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9737         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9738        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9739         &*$rh_*&<&'header&~name'&>&*:*&"
9740 .cindex "expansion" "header insertion"
9741 .vindex "&$header_$&"
9742 .vindex "&$bheader_$&"
9743 .vindex "&$lheader_$&"
9744 .vindex "&$rheader_$&"
9745 .cindex "header lines" "in expansion strings"
9746 .cindex "header lines" "character sets"
9747 .cindex "header lines" "decoding"
9748 Substitute the contents of the named message header line, for example
9749 .code
9750 $header_reply-to:
9751 .endd
9752 The newline that terminates a header line is not included in the expansion, but
9753 internal newlines (caused by splitting the header line over several physical
9754 lines) may be present.
9755
9756 The difference between the four pairs of expansions is in the way
9757 the data in the header line is interpreted.
9758
9759 .ilist
9760 .cindex "white space" "in header lines"
9761 &%rheader%& gives the original &"raw"& content of the header line, with no
9762 processing at all, and without the removal of leading and trailing white space.
9763
9764 .next
9765 .cindex "list" "of header lines"
9766 &%lheader%& gives a colon-separated list, one element per header when there
9767 are multiple headers with a given name.
9768 Any embedded colon characters within an element are doubled, so normal Exim
9769 list-processing facilities can be used.
9770 The terminating newline of each element is removed; in other respects
9771 the content is &"raw"&.
9772
9773 .next
9774 .cindex "base64 encoding" "in header lines"
9775 &%bheader%& removes leading and trailing white space, and then decodes base64
9776 or quoted-printable MIME &"words"& within the header text, but does no
9777 character set translation. If decoding of what looks superficially like a MIME
9778 &"word"& fails, the raw string is returned. If decoding
9779 .cindex "binary zero" "in header line"
9780 produces a binary zero character, it is replaced by a question mark &-- this is
9781 what Exim does for binary zeros that are actually received in header lines.
9782
9783 .next
9784 &%header%& tries to translate the string as decoded by &%bheader%& to a
9785 standard character set. This is an attempt to produce the same string as would
9786 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9787 returned. Translation is attempted only on operating systems that support the
9788 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9789 a system Makefile or in &_Local/Makefile_&.
9790 .endlist ilist
9791
9792 In a filter file, the target character set for &%header%& can be specified by a
9793 command of the following form:
9794 .code
9795 headers charset "UTF-8"
9796 .endd
9797 This command affects all references to &$h_$& (or &$header_$&) expansions in
9798 subsequently obeyed filter commands. In the absence of this command, the target
9799 character set in a filter is taken from the setting of the &%headers_charset%&
9800 option in the runtime configuration. The value of this option defaults to the
9801 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9802 ISO-8859-1.
9803
9804 Header names follow the syntax of RFC 2822, which states that they may contain
9805 any printing characters except space and colon. Consequently, curly brackets
9806 &'do not'& terminate header names, and should not be used to enclose them as
9807 if they were variables. Attempting to do so causes a syntax error.
9808
9809 Only header lines that are common to all copies of a message are visible to
9810 this mechanism. These are the original header lines that are received with the
9811 message, and any that are added by an ACL statement or by a system
9812 filter. Header lines that are added to a particular copy of a message by a
9813 router or transport are not accessible.
9814
9815 For incoming SMTP messages, no header lines are visible in
9816 ACLs that are obeyed before the data phase completes,
9817 because the header structure is not set up until the message is received.
9818 They are visible in DKIM, PRDR and DATA ACLs.
9819 Header lines that are added in a RCPT ACL (for example)
9820 are saved until the message's incoming header lines are available, at which
9821 point they are added.
9822 When any of the above ACLs ar
9823 running, however, header lines added by earlier ACLs are visible.
9824
9825 Upper case and lower case letters are synonymous in header names. If the
9826 following character is white space, the terminating colon may be omitted, but
9827 this is not recommended, because you may then forget it when it is needed. When
9828 white space terminates the header name, this white space is included in the
9829 expanded string.  If the message does not contain the given header, the
9830 expansion item is replaced by an empty string. (See the &%def%& condition in
9831 section &<<SECTexpcond>>& for a means of testing for the existence of a
9832 header.)
9833
9834 If there is more than one header with the same name, they are all concatenated
9835 to form the substitution string, up to a maximum length of 64K. Unless
9836 &%rheader%& is being used, leading and trailing white space is removed from
9837 each header before concatenation, and a completely empty header is ignored. A
9838 newline character is then inserted between non-empty headers, but there is no
9839 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9840 those headers that contain lists of addresses, a comma is also inserted at the
9841 junctions between headers. This does not happen for the &%rheader%& expansion.
9842
9843 .new
9844 .cindex "tainted data"
9845 When the headers are from an incoming message,
9846 the result of expanding any of these variables is tainted.
9847 .wen
9848
9849
9850 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9851 .cindex "expansion" "hmac hashing"
9852 .cindex &%hmac%&
9853 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9854 shared secret and some text into a message authentication code, as specified in
9855 RFC 2104. This differs from &`${md5:secret_text...}`& or
9856 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9857 cryptographic hash, allowing for authentication that is not possible with MD5
9858 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9859 present. For example:
9860 .code
9861 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9862 .endd
9863 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9864 produces:
9865 .code
9866 dd97e3ba5d1a61b5006108f8c8252953
9867 .endd
9868 As an example of how this might be used, you might put in the main part of
9869 an Exim configuration:
9870 .code
9871 SPAMSCAN_SECRET=cohgheeLei2thahw
9872 .endd
9873 In a router or a transport you could then have:
9874 .code
9875 headers_add = \
9876   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9877   ${hmac{md5}{SPAMSCAN_SECRET}\
9878   {${primary_hostname},${message_exim_id},$h_message-id:}}
9879 .endd
9880 Then given a message, you can check where it was scanned by looking at the
9881 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9882 this header line is authentic by recomputing the authentication code from the
9883 host name, message ID and the &'Message-id:'& header line. This can be done
9884 using Exim's &%-be%& option, or by other means, for example, by using the
9885 &'hmac_md5_hex()'& function in Perl.
9886
9887
9888 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9889 .cindex "expansion" "conditional"
9890 .cindex "&%if%&, expansion item"
9891 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9892 item; otherwise <&'string2'&> is used. The available conditions are described
9893 in section &<<SECTexpcond>>& below. For example:
9894 .code
9895 ${if eq {$local_part}{postmaster} {yes}{no} }
9896 .endd
9897 The second string need not be present; if it is not and the condition is not
9898 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9899 be present instead of the second string (without any curly brackets). In this
9900 case, the expansion is forced to fail if the condition is not true (see section
9901 &<<SECTforexpfai>>&).
9902
9903 If both strings are omitted, the result is the string &`true`& if the condition
9904 is true, and the empty string if the condition is false. This makes it less
9905 cumbersome to write custom ACL and router conditions. For example, instead of
9906 .code
9907 condition = ${if >{$acl_m4}{3}{true}{false}}
9908 .endd
9909 you can use
9910 .code
9911 condition = ${if >{$acl_m4}{3}}
9912 .endd
9913
9914
9915
9916 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9917 .cindex expansion "imap folder"
9918 .cindex "&%imapfolder%& expansion item"
9919 This item converts a (possibly multilevel, or with non-ASCII characters)
9920 folder specification to a Maildir name for filesystem use.
9921 For information on internationalisation support see &<<SECTi18nMDA>>&.
9922
9923
9924
9925 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9926 .cindex "expansion" "string truncation"
9927 .cindex "&%length%& expansion item"
9928 The &%length%& item is used to extract the initial portion of a string. Both
9929 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9930 you are using a fixed value for the number, that is, if <&'string1'&> does not
9931 change when expanded, you can use the simpler operator notation that avoids
9932 some of the braces:
9933 .code
9934 ${length_<n>:<string>}
9935 .endd
9936 The result of this item is either the first <&'n'&> bytes or the whole
9937 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9938 &%strlen%&, which gives the length of a string.
9939 All measurement is done in bytes and is not UTF-8 aware.
9940
9941
9942 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9943         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9944 .cindex "expansion" "extracting list elements by number"
9945 .cindex "&%listextract%&" "extract list elements by number"
9946 .cindex "list" "extracting elements by number"
9947 The <&'number'&> argument must consist entirely of decimal digits,
9948 apart from an optional leading minus,
9949 and leading and trailing white space (which is ignored).
9950
9951 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9952 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9953
9954 The first field of the list is numbered one.
9955 If the number is negative, the fields are
9956 counted from the end of the list, with the rightmost one numbered -1.
9957 The numbered element of the list is extracted and placed in &$value$&,
9958 then <&'string2'&> is expanded as the result.
9959
9960 If the modulus of the
9961 number is zero or greater than the number of fields in the string,
9962 the result is the expansion of <&'string3'&>.
9963
9964 For example:
9965 .code
9966 ${listextract{2}{x:42:99}}
9967 .endd
9968 yields &"42"&, and
9969 .code
9970 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9971 .endd
9972 yields &"result: 42"&.
9973
9974 If {<&'string3'&>} is omitted, an empty string is used for string3.
9975 If {<&'string2'&>} is also omitted, the value that was
9976 extracted is used.
9977 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9978
9979
9980 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9981         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9982 This is the first of one of two different types of lookup item, which are both
9983 described in the next item.
9984
9985 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9986         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9987 .cindex "expansion" "lookup in"
9988 .cindex "file" "lookups"
9989 .cindex "lookup" "in expanded string"
9990 The two forms of lookup item specify data lookups in files and databases, as
9991 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9992 lookups, and the second is used for query-style lookups. The <&'key'&>,
9993 <&'file'&>, and <&'query'&> strings are expanded before use.
9994
9995 If there is any white space in a lookup item which is part of a filter command,
9996 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9997 other place where white space is significant, the lookup item must be enclosed
9998 in double quotes. The use of data lookups in users' filter files may be locked
9999 out by the system administrator.
10000
10001 .vindex "&$value$&"
10002 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10003 During its expansion, the variable &$value$& contains the data returned by the
10004 lookup. Afterwards it reverts to the value it had previously (at the outer
10005 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10006 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10007 string on failure. If <&'string2'&> is provided, it can itself be a nested
10008 lookup, thus providing a mechanism for looking up a default value when the
10009 original lookup fails.
10010
10011 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10012 data for the outer lookup while the parameters of the second lookup are
10013 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10014 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10015 appear, and in this case, if the lookup fails, the entire expansion is forced
10016 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10017 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10018 successful lookup, and nothing in the case of failure.
10019
10020 For single-key lookups, the string &"partial"& is permitted to precede the
10021 search type in order to do partial matching, and * or *@ may follow a search
10022 type to request default lookups if the key does not match (see sections
10023 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10024
10025 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10026 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10027 and non-wild parts of the key during the expansion of the replacement text.
10028 They return to their previous values at the end of the lookup item.
10029
10030 This example looks up the postmaster alias in the conventional alias file:
10031 .code
10032 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10033 .endd
10034 This example uses NIS+ to look up the full name of the user corresponding to
10035 the local part of an address, forcing the expansion to fail if it is not found:
10036 .code
10037 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10038   {$value}fail}
10039 .endd
10040
10041
10042 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10043 .cindex "expansion" "list creation"
10044 .vindex "&$item$&"
10045 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10046 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10047 For each item
10048 in this list, its value is place in &$item$&, and then <&'string2'&> is
10049 expanded and added to the output as an item in a new list. The separator used
10050 for the output list is the same as the one used for the input, but a separator
10051 setting is not included in the output. For example:
10052 .code
10053 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10054 .endd
10055 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10056 value of &$item$& is restored to what it was before. See also the &%filter%&
10057 and &%reduce%& expansion items.
10058
10059 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10060 .cindex "expansion" "numeric hash"
10061 .cindex "hash function" "numeric"
10062 The three strings are expanded; the first two must yield numbers. Call them
10063 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10064 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10065 can use the simpler operator notation that avoids some of the braces:
10066 .code
10067 ${nhash_<n>_<m>:<string>}
10068 .endd
10069 The second number is optional (in both notations). If there is only one number,
10070 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10071 processed by a div/mod hash function that returns two numbers, separated by a
10072 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10073 example,
10074 .code
10075 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10076 .endd
10077 returns the string &"6/33"&.
10078
10079
10080
10081 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10082 .cindex "Perl" "use in expanded string"
10083 .cindex "expansion" "calling Perl from"
10084 This item is available only if Exim has been built to include an embedded Perl
10085 interpreter. The subroutine name and the arguments are first separately
10086 expanded, and then the Perl subroutine is called with those arguments. No
10087 additional arguments need be given; the maximum number permitted, including the
10088 name of the subroutine, is nine.
10089
10090 The return value of the subroutine is inserted into the expanded string, unless
10091 the return value is &%undef%&. In that case, the expansion fails in the same
10092 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10093 Whatever you return is evaluated in a scalar context. For example, if you
10094 return the name of a Perl vector, the return value is the size of the vector,
10095 not its contents.
10096
10097 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10098 with the error message that was passed to &%die%&. More details of the embedded
10099 Perl facility are given in chapter &<<CHAPperl>>&.
10100
10101 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10102 out the use of this expansion item in filter files.
10103
10104
10105 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10106 .cindex "&%prvs%& expansion item"
10107 The first argument is a complete email address and the second is secret
10108 keystring. The third argument, specifying a key number, is optional. If absent,
10109 it defaults to 0. The result of the expansion is a prvs-signed email address,
10110 to be typically used with the &%return_path%& option on an &(smtp)& transport
10111 as part of a bounce address tag validation (BATV) scheme. For more discussion
10112 and an example, see section &<<SECTverifyPRVS>>&.
10113
10114 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10115         {*&<&'string'&>&*}}*&"
10116 .cindex "&%prvscheck%& expansion item"
10117 This expansion item is the complement of the &%prvs%& item. It is used for
10118 checking prvs-signed addresses. If the expansion of the first argument does not
10119 yield a syntactically valid prvs-signed address, the whole item expands to the
10120 empty string. When the first argument does expand to a syntactically valid
10121 prvs-signed address, the second argument is expanded, with the prvs-decoded
10122 version of the address and the key number extracted from the address in the
10123 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10124
10125 These two variables can be used in the expansion of the second argument to
10126 retrieve the secret. The validity of the prvs-signed address is then checked
10127 against the secret. The result is stored in the variable &$prvscheck_result$&,
10128 which is empty for failure or &"1"& for success.
10129
10130 The third argument is optional; if it is missing, it defaults to an empty
10131 string. This argument is now expanded. If the result is an empty string, the
10132 result of the expansion is the decoded version of the address. This is the case
10133 whether or not the signature was valid. Otherwise, the result of the expansion
10134 is the expansion of the third argument.
10135
10136 All three variables can be used in the expansion of the third argument.
10137 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10138 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10139
10140 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10141 .cindex "expansion" "inserting an entire file"
10142 .cindex "file" "inserting into expansion"
10143 .cindex "&%readfile%& expansion item"
10144 The filename and end-of-line string are first expanded separately. The file is
10145 then read, and its contents replace the entire item. All newline characters in
10146 the file are replaced by the end-of-line string if it is present. Otherwise,
10147 newlines are left in the string.
10148 String expansion is not applied to the contents of the file. If you want this,
10149 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10150 the string expansion fails.
10151
10152 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10153 locks out the use of this expansion item in filter files.
10154
10155
10156
10157 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10158         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10159 .cindex "expansion" "inserting from a socket"
10160 .cindex "socket, use of in expansion"
10161 .cindex "&%readsocket%& expansion item"
10162 This item inserts data from a Unix domain or TCP socket into the expanded
10163 string. The minimal way of using it uses just two arguments, as in these
10164 examples:
10165 .code
10166 ${readsocket{/socket/name}{request string}}
10167 ${readsocket{inet:some.host:1234}{request string}}
10168 .endd
10169 For a Unix domain socket, the first substring must be the path to the socket.
10170 For an Internet socket, the first substring must contain &`inet:`& followed by
10171 a host name or IP address, followed by a colon and a port, which can be a
10172 number or the name of a TCP port in &_/etc/services_&. An IP address may
10173 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10174 example:
10175 .code
10176 ${readsocket{inet:[::1]:1234}{request string}}
10177 .endd
10178 Only a single host name may be given, but if looking it up yields more than
10179 one IP address, they are each tried in turn until a connection is made. For
10180 both kinds of socket, Exim makes a connection, writes the request string
10181 unless it is an empty string; and no terminating NUL is ever sent)
10182 and reads from the socket until an end-of-file
10183 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10184 extend what can be done. Firstly, you can vary the timeout. For example:
10185 .code
10186 ${readsocket{/socket/name}{request string}{3s}}
10187 .endd
10188
10189 The third argument is a list of options, of which the first element is the timeout
10190 and must be present if the argument is given.
10191 Further elements are options of form &'name=value'&.
10192 Two option types is currently recognised: shutdown and tls.
10193 The first defines whether (the default)
10194 or not a shutdown is done on the connection after sending the request.
10195 Example, to not do so (preferred, eg. by some webservers):
10196 .code
10197 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10198 .endd
10199 The second, tls, controls the use of TLS on the connection.  Example:
10200 .code
10201 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10202 .endd
10203 The default is to not use TLS.
10204 If it is enabled, a shutdown as descripbed above is never done.
10205
10206 A fourth argument allows you to change any newlines that are in the data
10207 that is read, in the same way as for &%readfile%& (see above). This example
10208 turns them into spaces:
10209 .code
10210 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10211 .endd
10212 As with all expansions, the substrings are expanded before the processing
10213 happens. Errors in these sub-expansions cause the expansion to fail. In
10214 addition, the following errors can occur:
10215
10216 .ilist
10217 Failure to create a socket file descriptor;
10218 .next
10219 Failure to connect the socket;
10220 .next
10221 Failure to write the request string;
10222 .next
10223 Timeout on reading from the socket.
10224 .endlist
10225
10226 By default, any of these errors causes the expansion to fail. However, if
10227 you supply a fifth substring, it is expanded and used when any of the above
10228 errors occurs. For example:
10229 .code
10230 ${readsocket{/socket/name}{request string}{3s}{\n}\
10231   {socket failure}}
10232 .endd
10233 You can test for the existence of a Unix domain socket by wrapping this
10234 expansion in &`${if exists`&, but there is a race condition between that test
10235 and the actual opening of the socket, so it is safer to use the fifth argument
10236 if you want to be absolutely sure of avoiding an expansion error for a
10237 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10238
10239 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10240 locks out the use of this expansion item in filter files.
10241
10242
10243 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10244 .cindex "expansion" "reducing a list to a scalar"
10245 .cindex "list" "reducing to a scalar"
10246 .vindex "&$value$&"
10247 .vindex "&$item$&"
10248 This operation reduces a list to a single, scalar string. After expansion,
10249 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10250 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10251 Then <&'string2'&> is expanded and
10252 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10253 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10254 them. The result of that expansion is assigned to &$value$& before the next
10255 iteration. When the end of the list is reached, the final value of &$value$& is
10256 added to the expansion output. The &%reduce%& expansion item can be used in a
10257 number of ways. For example, to add up a list of numbers:
10258 .code
10259 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10260 .endd
10261 The result of that expansion would be &`6`&. The maximum of a list of numbers
10262 can be found:
10263 .code
10264 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10265 .endd
10266 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10267 restored to what they were before. See also the &%filter%& and &%map%&
10268 expansion items.
10269
10270 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10271 This item inserts &"raw"& header lines. It is described with the &%header%&
10272 expansion item in section &<<SECTexpansionitems>>& above.
10273
10274 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10275         {*&<&'string2'&>&*}}*&"
10276 .cindex "expansion" "running a command"
10277 .cindex "&%run%& expansion item"
10278 The command and its arguments are first expanded as one string. The string is
10279 split apart into individual arguments by spaces, and then the command is run
10280 in a separate process, but under the same uid and gid.  As in other command
10281 executions from Exim, a shell is not used by default. If the command requires
10282 a shell, you must explicitly code it.
10283
10284 Since the arguments are split by spaces, when there is a variable expansion
10285 which has an empty result, it will cause the situation that the argument will
10286 simply be omitted when the program is actually executed by Exim. If the
10287 script/program requires a specific number of arguments and the expanded
10288 variable could possibly result in this empty expansion, the variable must be
10289 quoted. This is more difficult if the expanded variable itself could result
10290 in a string containing quotes, because it would interfere with the quotes
10291 around the command arguments. A possible guard against this is to wrap the
10292 variable in the &%sg%& operator to change any quote marks to some other
10293 character.
10294
10295 The standard input for the command exists, but is empty. The standard output
10296 and standard error are set to the same file descriptor.
10297 .cindex "return code" "from &%run%& expansion"
10298 .vindex "&$value$&"
10299 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10300 and replaces the entire item; during this expansion, the standard output/error
10301 from the command is in the variable &$value$&. If the command fails,
10302 <&'string2'&>, if present, is expanded and used. Once again, during the
10303 expansion, the standard output/error from the command is in the variable
10304 &$value$&.
10305
10306 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10307 can be the word &"fail"& (not in braces) to force expansion failure if the
10308 command does not succeed. If both strings are omitted, the result is contents
10309 of the standard output/error on success, and nothing on failure.
10310
10311 .vindex "&$run_in_acl$&"
10312 The standard output/error of the command is put in the variable &$value$&.
10313 In this ACL example, the output of a command is logged for the admin to
10314 troubleshoot:
10315 .code
10316 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10317       log_message  = Output of id: $value
10318 .endd
10319 If the command requires shell idioms, such as the > redirect operator, the
10320 shell must be invoked directly, such as with:
10321 .code
10322 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10323 .endd
10324
10325 .vindex "&$runrc$&"
10326 The return code from the command is put in the variable &$runrc$&, and this
10327 remains set afterwards, so in a filter file you can do things like this:
10328 .code
10329 if "${run{x y z}{}}$runrc" is 1 then ...
10330   elif $runrc is 2 then ...
10331   ...
10332 endif
10333 .endd
10334 If execution of the command fails (for example, the command does not exist),
10335 the return code is 127 &-- the same code that shells use for non-existent
10336 commands.
10337
10338 &*Warning*&: In a router or transport, you cannot assume the order in which
10339 option values are expanded, except for those preconditions whose order of
10340 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10341 by the expansion of one option, and use it in another.
10342
10343 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10344 out the use of this expansion item in filter files.
10345
10346
10347 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10348 .cindex "expansion" "string substitution"
10349 .cindex "&%sg%& expansion item"
10350 This item works like Perl's substitution operator (s) with the global (/g)
10351 option; hence its name. However, unlike the Perl equivalent, Exim does not
10352 modify the subject string; instead it returns the modified string for insertion
10353 into the overall expansion. The item takes three arguments: the subject string,
10354 a regular expression, and a substitution string. For example:
10355 .code
10356 ${sg{abcdefabcdef}{abc}{xyz}}
10357 .endd
10358 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10359 if any $, } or \ characters are required in the regular expression or in the
10360 substitution string, they have to be escaped. For example:
10361 .code
10362 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10363 .endd
10364 yields &"defabc"&, and
10365 .code
10366 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10367 .endd
10368 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10369 the regular expression from string expansion.
10370
10371 The regular expression is compiled in 8-bit mode, working against bytes
10372 rather than any Unicode-aware character handling.
10373
10374
10375 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10376 .cindex sorting "a list"
10377 .cindex list sorting
10378 .cindex expansion "list sorting"
10379 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10380 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10381 The <&'comparator'&> argument is interpreted as the operator
10382 of a two-argument expansion condition.
10383 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10384 The comparison should return true when applied to two values
10385 if the first value should sort before the second value.
10386 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10387 the element being placed in &$item$&,
10388 to give values for comparison.
10389
10390 The item result is a sorted list,
10391 with the original list separator,
10392 of the list elements (in full) of the original.
10393
10394 Examples:
10395 .code
10396 ${sort{3:2:1:4}{<}{$item}}
10397 .endd
10398 sorts a list of numbers, and
10399 .code
10400 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10401 .endd
10402 will sort an MX lookup into priority order.
10403
10404
10405 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10406 .cindex "&%substr%& expansion item"
10407 .cindex "substring extraction"
10408 .cindex "expansion" "substring extraction"
10409 The three strings are expanded; the first two must yield numbers. Call them
10410 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10411 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10412 can use the simpler operator notation that avoids some of the braces:
10413 .code
10414 ${substr_<n>_<m>:<string>}
10415 .endd
10416 The second number is optional (in both notations).
10417 If it is absent in the simpler format, the preceding underscore must also be
10418 omitted.
10419
10420 The &%substr%& item can be used to extract more general substrings than
10421 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10422 length required. For example
10423 .code
10424 ${substr{3}{2}{$local_part}}
10425 .endd
10426 If the starting offset is greater than the string length the result is the
10427 null string; if the length plus starting offset is greater than the string
10428 length, the result is the right-hand part of the string, starting from the
10429 given offset. The first byte (character) in the string has offset zero.
10430
10431 The &%substr%& expansion item can take negative offset values to count
10432 from the right-hand end of its operand. The last byte (character) is offset -1,
10433 the second-last is offset -2, and so on. Thus, for example,
10434 .code
10435 ${substr{-5}{2}{1234567}}
10436 .endd
10437 yields &"34"&. If the absolute value of a negative offset is greater than the
10438 length of the string, the substring starts at the beginning of the string, and
10439 the length is reduced by the amount of overshoot. Thus, for example,
10440 .code
10441 ${substr{-5}{2}{12}}
10442 .endd
10443 yields an empty string, but
10444 .code
10445 ${substr{-3}{2}{12}}
10446 .endd
10447 yields &"1"&.
10448
10449 When the second number is omitted from &%substr%&, the remainder of the string
10450 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10451 string preceding the offset point are taken. For example, an offset of -1 and
10452 no length, as in these semantically identical examples:
10453 .code
10454 ${substr_-1:abcde}
10455 ${substr{-1}{abcde}}
10456 .endd
10457 yields all but the last character of the string, that is, &"abcd"&.
10458
10459 All measurement is done in bytes and is not UTF-8 aware.
10460
10461
10462
10463 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10464         {*&<&'replacements'&>&*}}*&"
10465 .cindex "expansion" "character translation"
10466 .cindex "&%tr%& expansion item"
10467 This item does single-character (in bytes) translation on its subject string. The second
10468 argument is a list of characters to be translated in the subject string. Each
10469 matching character is replaced by the corresponding character from the
10470 replacement list. For example
10471 .code
10472 ${tr{abcdea}{ac}{13}}
10473 .endd
10474 yields &`1b3de1`&. If there are duplicates in the second character string, the
10475 last occurrence is used. If the third string is shorter than the second, its
10476 last character is replicated. However, if it is empty, no translation takes
10477 place.
10478
10479 All character handling is done in bytes and is not UTF-8 aware.
10480
10481 .endlist
10482
10483
10484
10485 .section "Expansion operators" "SECTexpop"
10486 .cindex "expansion" "operators"
10487 For expansion items that perform transformations on a single argument string,
10488 the &"operator"& notation is used because it is simpler and uses fewer braces.
10489 The substring is first expanded before the operation is applied to it. The
10490 following operations can be performed:
10491
10492 .vlist
10493 .vitem &*${address:*&<&'string'&>&*}*&
10494 .cindex "expansion" "RFC 2822 address handling"
10495 .cindex "&%address%& expansion item"
10496 The string is interpreted as an RFC 2822 address, as it might appear in a
10497 header line, and the effective address is extracted from it. If the string does
10498 not parse successfully, the result is empty.
10499
10500 The parsing correctly handles SMTPUTF8 Unicode in the string.
10501
10502
10503 .vitem &*${addresses:*&<&'string'&>&*}*&
10504 .cindex "expansion" "RFC 2822 address handling"
10505 .cindex "&%addresses%& expansion item"
10506 The string (after expansion) is interpreted as a list of addresses in RFC
10507 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10508 operative address (&'local-part@domain'&) is extracted from each item, and the
10509 result of the expansion is a colon-separated list, with appropriate
10510 doubling of colons should any happen to be present in the email addresses.
10511 Syntactically invalid RFC2822 address items are omitted from the output.
10512
10513 It is possible to specify a character other than colon for the output
10514 separator by starting the string with > followed by the new separator
10515 character. For example:
10516 .code
10517 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10518 .endd
10519 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10520 first, so if the expanded string starts with >, it may change the output
10521 separator unintentionally. This can be avoided by setting the output
10522 separator explicitly:
10523 .code
10524 ${addresses:>:$h_from:}
10525 .endd
10526
10527 Compare the &%address%& (singular)
10528 expansion item, which extracts the working address from a single RFC2822
10529 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10530 processing lists.
10531
10532 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10533 a strict interpretation of header line formatting.  Exim parses the bare,
10534 unquoted portion of an email address and if it finds a comma, treats it as an
10535 email address separator. For the example header line:
10536 .code
10537 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10538 .endd
10539 The first example below demonstrates that Q-encoded email addresses are parsed
10540 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10541 It does not see the comma because it's still encoded as "=2C".  The second
10542 example below is passed the contents of &`$header_from:`&, meaning it gets
10543 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10544 The third example shows that the presence of a comma is skipped when it is
10545 quoted.  The fourth example shows SMTPUTF8 handling.
10546 .code
10547 # exim -be '${addresses:From: \
10548 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10549 user@example.com
10550 # exim -be '${addresses:From: Last, First <user@example.com>}'
10551 Last:user@example.com
10552 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10553 user@example.com
10554 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10555 フィリップ@example.jp
10556 .endd
10557
10558 .vitem &*${base32:*&<&'digits'&>&*}*&
10559 .cindex "&%base32%& expansion item"
10560 .cindex "expansion" "conversion to base 32"
10561 The string must consist entirely of decimal digits. The number is converted to
10562 base 32 and output as a (empty, for zero) string of characters.
10563 Only lowercase letters are used.
10564
10565 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10566 .cindex "&%base32d%& expansion item"
10567 .cindex "expansion" "conversion to base 32"
10568 The string must consist entirely of base-32 digits.
10569 The number is converted to decimal and output as a string.
10570
10571 .vitem &*${base62:*&<&'digits'&>&*}*&
10572 .cindex "&%base62%& expansion item"
10573 .cindex "expansion" "conversion to base 62"
10574 The string must consist entirely of decimal digits. The number is converted to
10575 base 62 and output as a string of six characters, including leading zeros. In
10576 the few operating environments where Exim uses base 36 instead of base 62 for
10577 its message identifiers (because those systems do not have case-sensitive
10578 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10579 to be absolutely clear: this is &'not'& base64 encoding.
10580
10581 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10582 .cindex "&%base62d%& expansion item"
10583 .cindex "expansion" "conversion to base 62"
10584 The string must consist entirely of base-62 digits, or, in operating
10585 environments where Exim uses base 36 instead of base 62 for its message
10586 identifiers, base-36 digits. The number is converted to decimal and output as a
10587 string.
10588
10589 .vitem &*${base64:*&<&'string'&>&*}*&
10590 .cindex "expansion" "base64 encoding"
10591 .cindex "base64 encoding" "in string expansion"
10592 .cindex "&%base64%& expansion item"
10593 .cindex certificate "base64 of DER"
10594 This operator converts a string into one that is base64 encoded.
10595
10596 If the string is a single variable of type certificate,
10597 returns the base64 encoding of the DER form of the certificate.
10598
10599
10600 .vitem &*${base64d:*&<&'string'&>&*}*&
10601 .cindex "expansion" "base64 decoding"
10602 .cindex "base64 decoding" "in string expansion"
10603 .cindex "&%base64d%& expansion item"
10604 This operator converts a base64-encoded string into the un-coded form.
10605
10606
10607 .vitem &*${domain:*&<&'string'&>&*}*&
10608 .cindex "domain" "extraction"
10609 .cindex "expansion" "domain extraction"
10610 The string is interpreted as an RFC 2822 address and the domain is extracted
10611 from it. If the string does not parse successfully, the result is empty.
10612
10613
10614 .vitem &*${escape:*&<&'string'&>&*}*&
10615 .cindex "expansion" "escaping non-printing characters"
10616 .cindex "&%escape%& expansion item"
10617 If the string contains any non-printing characters, they are converted to
10618 escape sequences starting with a backslash. Whether characters with the most
10619 significant bit set (so-called &"8-bit characters"&) count as printing or not
10620 is controlled by the &%print_topbitchars%& option.
10621
10622 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10623 .cindex "expansion" "escaping 8-bit characters"
10624 .cindex "&%escape8bit%& expansion item"
10625 If the string contains and characters with the most significant bit set,
10626 they are converted to escape sequences starting with a backslash.
10627 Backslashes and DEL characters are also converted.
10628
10629
10630 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10631 .cindex "expansion" "expression evaluation"
10632 .cindex "expansion" "arithmetic expression"
10633 .cindex "&%eval%& expansion item"
10634 These items supports simple arithmetic and bitwise logical operations in
10635 expansion strings. The string (after expansion) must be a conventional
10636 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10637 logical operators, and parentheses. All operations are carried out using
10638 integer arithmetic. The operator priorities are as follows (the same as in the
10639 C programming language):
10640 .table2 70pt 300pt
10641 .irow &'highest:'& "not (~), negate (-)"
10642 .irow ""   "multiply (*), divide (/), remainder (%)"
10643 .irow ""   "plus (+), minus (-)"
10644 .irow ""   "shift-left (<<), shift-right (>>)"
10645 .irow ""   "and (&&)"
10646 .irow ""   "xor (^)"
10647 .irow &'lowest:'&  "or (|)"
10648 .endtable
10649 Binary operators with the same priority are evaluated from left to right. White
10650 space is permitted before or after operators.
10651
10652 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10653 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10654 decimal, even if they start with a leading zero; hexadecimal numbers are not
10655 permitted. This can be useful when processing numbers extracted from dates or
10656 times, which often do have leading zeros.
10657
10658 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10659 or 1024*1024*1024,
10660 respectively. Negative numbers are supported. The result of the computation is
10661 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10662
10663 .display
10664 &`${eval:1+1}            `&  yields 2
10665 &`${eval:1+2*3}          `&  yields 7
10666 &`${eval:(1+2)*3}        `&  yields 9
10667 &`${eval:2+42%5}         `&  yields 4
10668 &`${eval:0xc&amp;5}          `&  yields 4
10669 &`${eval:0xc|5}          `&  yields 13
10670 &`${eval:0xc^5}          `&  yields 9
10671 &`${eval:0xc>>1}         `&  yields 6
10672 &`${eval:0xc<<1}         `&  yields 24
10673 &`${eval:~255&amp;0x1234}    `&  yields 4608
10674 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10675 .endd
10676
10677 As a more realistic example, in an ACL you might have
10678 .code
10679 deny   message = Too many bad recipients
10680        condition =                    \
10681          ${if and {                   \
10682            {>{$rcpt_count}{10}}       \
10683            {                          \
10684            <                          \
10685              {$recipients_count}      \
10686              {${eval:$rcpt_count/2}}  \
10687            }                          \
10688          }{yes}{no}}
10689 .endd
10690 The condition is true if there have been more than 10 RCPT commands and
10691 fewer than half of them have resulted in a valid recipient.
10692
10693
10694 .vitem &*${expand:*&<&'string'&>&*}*&
10695 .cindex "expansion" "re-expansion of substring"
10696 The &%expand%& operator causes a string to be expanded for a second time. For
10697 example,
10698 .code
10699 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10700 .endd
10701 first looks up a string in a file while expanding the operand for &%expand%&,
10702 and then re-expands what it has found.
10703
10704
10705 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10706 .cindex "Unicode"
10707 .cindex "UTF-8" "conversion from"
10708 .cindex "expansion" "UTF-8 conversion"
10709 .cindex "&%from_utf8%& expansion item"
10710 The world is slowly moving towards Unicode, although there are no standards for
10711 email yet. However, other applications (including some databases) are starting
10712 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10713 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10714 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10715 the result is an undefined sequence of bytes.
10716
10717 Unicode code points with values less than 256 are compatible with ASCII and
10718 ISO-8859-1 (also known as Latin-1).
10719 For example, character 169 is the copyright symbol in both cases, though the
10720 way it is encoded is different. In UTF-8, more than one byte is needed for
10721 characters with code values greater than 127, whereas ISO-8859-1 is a
10722 single-byte encoding (but thereby limited to 256 characters). This makes
10723 translation from UTF-8 to ISO-8859-1 straightforward.
10724
10725
10726 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10727 .cindex "hash function" "textual"
10728 .cindex "expansion" "textual hash"
10729 The &%hash%& operator is a simpler interface to the hashing function that can
10730 be used when the two parameters are fixed numbers (as opposed to strings that
10731 change when expanded). The effect is the same as
10732 .code
10733 ${hash{<n>}{<m>}{<string>}}
10734 .endd
10735 See the description of the general &%hash%& item above for details. The
10736 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10737
10738
10739
10740 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10741 .cindex "base64 encoding" "conversion from hex"
10742 .cindex "expansion" "hex to base64"
10743 .cindex "&%hex2b64%& expansion item"
10744 This operator converts a hex string into one that is base64 encoded. This can
10745 be useful for processing the output of the various hashing functions.
10746
10747
10748
10749 .vitem &*${hexquote:*&<&'string'&>&*}*&
10750 .cindex "quoting" "hex-encoded unprintable characters"
10751 .cindex "&%hexquote%& expansion item"
10752 This operator converts non-printable characters in a string into a hex
10753 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10754 as is, and other byte values are converted to &`\xNN`&, for example, a
10755 byte value 127 is converted to &`\x7f`&.
10756
10757
10758 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10759 .cindex "&%ipv6denorm%& expansion item"
10760 .cindex "IP address" normalisation
10761 This expands an IPv6 address to a full eight-element colon-separated set
10762 of hex digits including leading zeroes.
10763 A trailing ipv4-style dotted-decimal set is converted to hex.
10764 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10765
10766 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10767 .cindex "&%ipv6norm%& expansion item"
10768 .cindex "IP address" normalisation
10769 .cindex "IP address" "canonical form"
10770 This converts an IPv6 address to canonical form.
10771 Leading zeroes of groups are omitted, and the longest
10772 set of zero-valued groups is replaced with a double colon.
10773 A trailing ipv4-style dotted-decimal set is converted to hex.
10774 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10775
10776
10777 .vitem &*${lc:*&<&'string'&>&*}*&
10778 .cindex "case forcing in strings"
10779 .cindex "string" "case forcing"
10780 .cindex "lower casing"
10781 .cindex "expansion" "case forcing"
10782 .cindex "&%lc%& expansion item"
10783 This forces the letters in the string into lower-case, for example:
10784 .code
10785 ${lc:$local_part}
10786 .endd
10787 Case is defined per the system C locale.
10788
10789 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10790 .cindex "expansion" "string truncation"
10791 .cindex "&%length%& expansion item"
10792 The &%length%& operator is a simpler interface to the &%length%& function that
10793 can be used when the parameter is a fixed number (as opposed to a string that
10794 changes when expanded). The effect is the same as
10795 .code
10796 ${length{<number>}{<string>}}
10797 .endd
10798 See the description of the general &%length%& item above for details. Note that
10799 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10800 when &%length%& is used as an operator.
10801 All measurement is done in bytes and is not UTF-8 aware.
10802
10803
10804 .vitem &*${listcount:*&<&'string'&>&*}*&
10805 .cindex "expansion" "list item count"
10806 .cindex "list" "item count"
10807 .cindex "list" "count of items"
10808 .cindex "&%listcount%& expansion item"
10809 The string is interpreted as a list and the number of items is returned.
10810
10811
10812 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10813 .cindex "expansion" "named list"
10814 .cindex "&%listnamed%& expansion item"
10815 The name is interpreted as a named list and the content of the list is returned,
10816 expanding any referenced lists, re-quoting as needed for colon-separation.
10817 If the optional type is given it must be one of "a", "d", "h" or "l"
10818 and selects address-, domain-, host- or localpart- lists to search among respectively.
10819 Otherwise all types are searched in an undefined order and the first
10820 matching list is returned.
10821
10822
10823 .vitem &*${local_part:*&<&'string'&>&*}*&
10824 .cindex "expansion" "local part extraction"
10825 .cindex "&%local_part%& expansion item"
10826 The string is interpreted as an RFC 2822 address and the local part is
10827 extracted from it. If the string does not parse successfully, the result is
10828 empty.
10829 The parsing correctly handles SMTPUTF8 Unicode in the string.
10830
10831
10832 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10833 .cindex "masked IP address"
10834 .cindex "IP address" "masking"
10835 .cindex "CIDR notation"
10836 .cindex "expansion" "IP address masking"
10837 .cindex "&%mask%& expansion item"
10838 If the form of the string to be operated on is not an IP address followed by a
10839 slash and an integer (that is, a network address in CIDR notation), the
10840 expansion fails. Otherwise, this operator converts the IP address to binary,
10841 masks off the least significant bits according to the bit count, and converts
10842 the result back to text, with mask appended. For example,
10843 .code
10844 ${mask:10.111.131.206/28}
10845 .endd
10846 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10847 be mostly used for looking up masked addresses in files, the result for an IPv6
10848 address uses dots to separate components instead of colons, because colon
10849 terminates a key string in lsearch files. So, for example,
10850 .code
10851 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10852 .endd
10853 returns the string
10854 .code
10855 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10856 .endd
10857 Letters in IPv6 addresses are always output in lower case.
10858
10859
10860 .vitem &*${md5:*&<&'string'&>&*}*&
10861 .cindex "MD5 hash"
10862 .cindex "expansion" "MD5 hash"
10863 .cindex certificate fingerprint
10864 .cindex "&%md5%& expansion item"
10865 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10866 as a 32-digit hexadecimal number, in which any letters are in lower case.
10867
10868 If the string is a single variable of type certificate,
10869 returns the MD5 hash fingerprint of the certificate.
10870
10871
10872 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10873 .cindex "expansion" "numeric hash"
10874 .cindex "hash function" "numeric"
10875 The &%nhash%& operator is a simpler interface to the numeric hashing function
10876 that can be used when the two parameters are fixed numbers (as opposed to
10877 strings that change when expanded). The effect is the same as
10878 .code
10879 ${nhash{<n>}{<m>}{<string>}}
10880 .endd
10881 See the description of the general &%nhash%& item above for details.
10882
10883
10884 .vitem &*${quote:*&<&'string'&>&*}*&
10885 .cindex "quoting" "in string expansions"
10886 .cindex "expansion" "quoting"
10887 .cindex "&%quote%& expansion item"
10888 The &%quote%& operator puts its argument into double quotes if it
10889 is an empty string or
10890 contains anything other than letters, digits, underscores, dots, and hyphens.
10891 Any occurrences of double quotes and backslashes are escaped with a backslash.
10892 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10893 respectively For example,
10894 .code
10895 ${quote:ab"*"cd}
10896 .endd
10897 becomes
10898 .code
10899 "ab\"*\"cd"
10900 .endd
10901 The place where this is useful is when the argument is a substitution from a
10902 variable or a message header.
10903
10904 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10905 .cindex "&%quote_local_part%& expansion item"
10906 This operator is like &%quote%&, except that it quotes the string only if
10907 required to do so by the rules of RFC 2822 for quoting local parts. For
10908 example, a plus sign would not cause quoting (but it would for &%quote%&).
10909 If you are creating a new email address from the contents of &$local_part$&
10910 (or any other unknown data), you should always use this operator.
10911
10912 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10913 will likely use the quoting form.
10914 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10915
10916
10917 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10918 .cindex "quoting" "lookup-specific"
10919 This operator applies lookup-specific quoting rules to the string. Each
10920 query-style lookup type has its own quoting rules which are described with
10921 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10922 .code
10923 ${quote_ldap:two * two}
10924 .endd
10925 returns
10926 .code
10927 two%20%5C2A%20two
10928 .endd
10929 For single-key lookup types, no quoting is ever necessary and this operator
10930 yields an unchanged string.
10931
10932
10933 .vitem &*${randint:*&<&'n'&>&*}*&
10934 .cindex "random number"
10935 This operator returns a somewhat random number which is less than the
10936 supplied number and is at least 0.  The quality of this randomness depends
10937 on how Exim was built; the values are not suitable for keying material.
10938 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10939 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10940 for versions of GnuTLS with that function.
10941 Otherwise, the implementation may be arc4random(), random() seeded by
10942 srandomdev() or srandom(), or a custom implementation even weaker than
10943 random().
10944
10945
10946 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10947 .cindex "expansion" "IP address"
10948 This operator reverses an IP address; for IPv4 addresses, the result is in
10949 dotted-quad decimal form, while for IPv6 addresses the result is in
10950 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10951 for DNS.  For example,
10952 .code
10953 ${reverse_ip:192.0.2.4}
10954 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10955 .endd
10956 returns
10957 .code
10958 4.2.0.192
10959 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
10960 .endd
10961
10962
10963 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10964 .cindex "expansion" "RFC 2047"
10965 .cindex "RFC 2047" "expansion operator"
10966 .cindex "&%rfc2047%& expansion item"
10967 This operator encodes text according to the rules of RFC 2047. This is an
10968 encoding that is used in header lines to encode non-ASCII characters. It is
10969 assumed that the input string is in the encoding specified by the
10970 &%headers_charset%& option, which gets its default at build time. If the string
10971 contains only characters in the range 33&--126, and no instances of the
10972 characters
10973 .code
10974 ? = ( ) < > @ , ; : \ " . [ ] _
10975 .endd
10976 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10977 string, using as many &"encoded words"& as necessary to encode all the
10978 characters.
10979
10980
10981 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10982 .cindex "expansion" "RFC 2047"
10983 .cindex "RFC 2047" "decoding"
10984 .cindex "&%rfc2047d%& expansion item"
10985 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10986 bytes are replaced by question marks. Characters are converted into the
10987 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10988 not recognized unless &%check_rfc2047_length%& is set false.
10989
10990 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10991 access a header line, RFC 2047 decoding is done automatically. You do not need
10992 to use this operator as well.
10993
10994
10995
10996 .vitem &*${rxquote:*&<&'string'&>&*}*&
10997 .cindex "quoting" "in regular expressions"
10998 .cindex "regular expressions" "quoting"
10999 .cindex "&%rxquote%& expansion item"
11000 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11001 characters in its argument. This is useful when substituting the values of
11002 variables or headers inside regular expressions.
11003
11004
11005 .vitem &*${sha1:*&<&'string'&>&*}*&
11006 .cindex "SHA-1 hash"
11007 .cindex "expansion" "SHA-1 hashing"
11008 .cindex certificate fingerprint
11009 .cindex "&%sha1%& expansion item"
11010 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11011 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11012
11013 If the string is a single variable of type certificate,
11014 returns the SHA-1 hash fingerprint of the certificate.
11015
11016
11017 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11018        &*${sha2:*&<&'string'&>&*}*& &&&
11019        &*${sha2_<n>:*&<&'string'&>&*}*&
11020 .cindex "SHA-256 hash"
11021 .cindex "SHA-2 hash"
11022 .cindex certificate fingerprint
11023 .cindex "expansion" "SHA-256 hashing"
11024 .cindex "&%sha256%& expansion item"
11025 .cindex "&%sha2%& expansion item"
11026 The &%sha256%& operator computes the SHA-256 hash value of the string
11027 and returns
11028 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11029
11030 If the string is a single variable of type certificate,
11031 returns the SHA-256 hash fingerprint of the certificate.
11032
11033 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11034 (except for certificates, which are not supported).
11035 Finally, if an underbar
11036 and a number is appended it specifies the output length, selecting a
11037 member of the SHA-2 family of hash functions.
11038 Values of 256, 384 and 512 are accepted, with 256 being the default.
11039
11040
11041 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11042        &*${sha3_<n>:*&<&'string'&>&*}*&
11043 .cindex "SHA3 hash"
11044 .cindex "expansion" "SHA3 hashing"
11045 .cindex "&%sha3%& expansion item"
11046 The &%sha3%& operator computes the SHA3-256 hash value of the string
11047 and returns
11048 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11049
11050 If a number is appended, separated by an underbar, it specifies
11051 the output length.  Values of 224, 256, 384 and 512 are accepted;
11052 with 256 being the default.
11053
11054 The &%sha3%& expansion item is only supported if Exim has been
11055 compiled with GnuTLS 3.5.0 or later,
11056 or OpenSSL 1.1.1 or later.
11057 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11058
11059
11060 .vitem &*${stat:*&<&'string'&>&*}*&
11061 .cindex "expansion" "statting a file"
11062 .cindex "file" "extracting characteristics"
11063 .cindex "&%stat%& expansion item"
11064 The string, after expansion, must be a file path. A call to the &[stat()]&
11065 function is made for this path. If &[stat()]& fails, an error occurs and the
11066 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11067 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11068 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11069 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11070 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11071 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11072 can extract individual fields using the &%extract%& expansion item.
11073
11074 The use of the &%stat%& expansion in users' filter files can be locked out by
11075 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11076 systems for files larger than 2GB.
11077
11078 .vitem &*${str2b64:*&<&'string'&>&*}*&
11079 .cindex "&%str2b64%& expansion item"
11080 Now deprecated, a synonym for the &%base64%& expansion operator.
11081
11082
11083
11084 .vitem &*${strlen:*&<&'string'&>&*}*&
11085 .cindex "expansion" "string length"
11086 .cindex "string" "length in expansion"
11087 .cindex "&%strlen%& expansion item"
11088 The item is replace by the length of the expanded string, expressed as a
11089 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11090 All measurement is done in bytes and is not UTF-8 aware.
11091
11092
11093 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11094 .cindex "&%substr%& expansion item"
11095 .cindex "substring extraction"
11096 .cindex "expansion" "substring expansion"
11097 The &%substr%& operator is a simpler interface to the &%substr%& function that
11098 can be used when the two parameters are fixed numbers (as opposed to strings
11099 that change when expanded). The effect is the same as
11100 .code
11101 ${substr{<start>}{<length>}{<string>}}
11102 .endd
11103 See the description of the general &%substr%& item above for details. The
11104 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11105 All measurement is done in bytes and is not UTF-8 aware.
11106
11107 .vitem &*${time_eval:*&<&'string'&>&*}*&
11108 .cindex "&%time_eval%& expansion item"
11109 .cindex "time interval" "decoding"
11110 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11111 seconds.
11112
11113 .vitem &*${time_interval:*&<&'string'&>&*}*&
11114 .cindex "&%time_interval%& expansion item"
11115 .cindex "time interval" "formatting"
11116 The argument (after sub-expansion) must be a sequence of decimal digits that
11117 represents an interval of time as a number of seconds. It is converted into a
11118 number of larger units and output in Exim's normal time format, for example,
11119 &`1w3d4h2m6s`&.
11120
11121 .vitem &*${uc:*&<&'string'&>&*}*&
11122 .cindex "case forcing in strings"
11123 .cindex "string" "case forcing"
11124 .cindex "upper casing"
11125 .cindex "expansion" "case forcing"
11126 .cindex "&%uc%& expansion item"
11127 This forces the letters in the string into upper-case.
11128 Case is defined per the system C locale.
11129
11130 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11131 .cindex "correction of invalid utf-8 sequences in strings"
11132 .cindex "utf-8" "utf-8 sequences"
11133 .cindex "incorrect utf-8"
11134 .cindex "expansion" "utf-8 forcing"
11135 .cindex "&%utf8clean%& expansion item"
11136 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11137 In versions of Exim before 4.92, this did not correctly do so for a truncated
11138 final codepoint's encoding, and the character would be silently dropped.
11139 If you must handle detection of this scenario across both sets of Exim behavior,
11140 the complexity will depend upon the task.
11141 For instance, to detect if the first character is multibyte and a 1-byte
11142 extraction can be successfully used as a path component (as is common for
11143 dividing up delivery folders), you might use:
11144 .code
11145 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11146 .endd
11147 (which will false-positive if the first character of the local part is a
11148 literal question mark).
11149
11150 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11151        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11152        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11153        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11154 .cindex expansion UTF-8
11155 .cindex UTF-8 expansion
11156 .cindex EAI
11157 .cindex internationalisation
11158 .cindex "&%utf8_domain_to_alabel%& expansion item"
11159 .cindex "&%utf8_domain_from_alabel%& expansion item"
11160 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11161 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11162 These convert EAI mail name components between UTF-8 and a-label forms.
11163 For information on internationalisation support see &<<SECTi18nMTA>>&.
11164 .endlist
11165
11166
11167
11168
11169
11170
11171 .section "Expansion conditions" "SECTexpcond"
11172 .scindex IIDexpcond "expansion" "conditions"
11173 The following conditions are available for testing by the &%${if%& construct
11174 while expanding strings:
11175
11176 .vlist
11177 .vitem &*!*&<&'condition'&>
11178 .cindex "expansion" "negating a condition"
11179 .cindex "negation" "in expansion condition"
11180 Preceding any condition with an exclamation mark negates the result of the
11181 condition.
11182
11183 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11184 .cindex "numeric comparison"
11185 .cindex "expansion" "numeric comparison"
11186 There are a number of symbolic operators for doing numeric comparisons. They
11187 are:
11188 .display
11189 &`=   `&   equal
11190 &`==  `&   equal
11191 &`>   `&   greater
11192 &`>=  `&   greater or equal
11193 &`<   `&   less
11194 &`<=  `&   less or equal
11195 .endd
11196 For example:
11197 .code
11198 ${if >{$message_size}{10M} ...
11199 .endd
11200 Note that the general negation operator provides for inequality testing. The
11201 two strings must take the form of optionally signed decimal integers,
11202 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11203 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11204 As a special case, the numerical value of an empty string is taken as
11205 zero.
11206
11207 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11208 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11209 10M, not if 10M is larger than &$message_size$&.
11210
11211
11212 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11213         {*&<&'arg2'&>&*}...}*&
11214 .cindex "expansion" "calling an acl"
11215 .cindex "&%acl%&" "expansion condition"
11216 The name and zero to nine argument strings are first expanded separately.  The expanded
11217 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11218 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11219 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11220 and may use the variables; if another acl expansion is used the values
11221 are restored after it returns.  If the ACL sets
11222 a value using a "message =" modifier the variable $value becomes
11223 the result of the expansion, otherwise it is empty.
11224 If the ACL returns accept the condition is true; if deny, false.
11225 If the ACL returns defer the result is a forced-fail.
11226
11227 .vitem &*bool&~{*&<&'string'&>&*}*&
11228 .cindex "expansion" "boolean parsing"
11229 .cindex "&%bool%& expansion condition"
11230 This condition turns a string holding a true or false representation into
11231 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11232 (case-insensitively); also integer numbers map to true if non-zero,
11233 false if zero.
11234 An empty string is treated as false.
11235 Leading and trailing whitespace is ignored;
11236 thus a string consisting only of whitespace is false.
11237 All other string values will result in expansion failure.
11238
11239 When combined with ACL variables, this expansion condition will let you
11240 make decisions in one place and act on those decisions in another place.
11241 For example:
11242 .code
11243 ${if bool{$acl_m_privileged_sender} ...
11244 .endd
11245
11246
11247 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11248 .cindex "expansion" "boolean parsing"
11249 .cindex "&%bool_lax%& expansion condition"
11250 Like &%bool%&, this condition turns a string into a boolean state.  But
11251 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11252 loose definition that the Router &%condition%& option uses.  The empty string
11253 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11254 true.  Leading and trailing whitespace is ignored.
11255
11256 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11257
11258 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11259 .cindex "expansion" "encrypted comparison"
11260 .cindex "encrypted strings, comparing"
11261 .cindex "&%crypteq%& expansion condition"
11262 This condition is included in the Exim binary if it is built to support any
11263 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11264 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11265 included in the binary.
11266
11267 The &%crypteq%& condition has two arguments. The first is encrypted and
11268 compared against the second, which is already encrypted. The second string may
11269 be in the LDAP form for storing encrypted strings, which starts with the
11270 encryption type in curly brackets, followed by the data. If the second string
11271 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11272 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11273 Typically this will be a field from a password file. An example of an encrypted
11274 string in LDAP form is:
11275 .code
11276 {md5}CY9rzUYh03PK3k6DJie09g==
11277 .endd
11278 If such a string appears directly in an expansion, the curly brackets have to
11279 be quoted, because they are part of the expansion syntax. For example:
11280 .code
11281 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11282 .endd
11283 The following encryption types (whose names are matched case-independently) are
11284 supported:
11285
11286 .ilist
11287 .cindex "MD5 hash"
11288 .cindex "base64 encoding" "in encrypted password"
11289 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11290 printable characters to compare with the remainder of the second string. If the
11291 length of the comparison string is 24, Exim assumes that it is base64 encoded
11292 (as in the above example). If the length is 32, Exim assumes that it is a
11293 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11294 comparison fails.
11295
11296 .next
11297 .cindex "SHA-1 hash"
11298 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11299 printable characters to compare with the remainder of the second string. If the
11300 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11301 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11302 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11303
11304 .next
11305 .cindex "&[crypt()]&"
11306 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11307 only the first eight characters of the password. However, in modern operating
11308 systems this is no longer true, and in many cases the entire password is used,
11309 whatever its length.
11310
11311 .next
11312 .cindex "&[crypt16()]&"
11313 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11314 use up to 16 characters of the password in some operating systems. Again, in
11315 modern operating systems, more characters may be used.
11316 .endlist
11317 Exim has its own version of &[crypt16()]&, which is just a double call to
11318 &[crypt()]&. For operating systems that have their own version, setting
11319 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11320 operating system version instead of its own. This option is set by default in
11321 the OS-dependent &_Makefile_& for those operating systems that are known to
11322 support &[crypt16()]&.
11323
11324 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11325 it was not using the same algorithm as some operating systems' versions. It
11326 turns out that as well as &[crypt16()]& there is a function called
11327 &[bigcrypt()]& in some operating systems. This may or may not use the same
11328 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11329
11330 However, since there is now a move away from the traditional &[crypt()]&
11331 functions towards using SHA1 and other algorithms, tidying up this area of
11332 Exim is seen as very low priority.
11333
11334 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11335 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11336 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11337 default is &`{crypt}`&. Whatever the default, you can always use either
11338 function by specifying it explicitly in curly brackets.
11339
11340 .vitem &*def:*&<&'variable&~name'&>
11341 .cindex "expansion" "checking for empty variable"
11342 .cindex "&%def%& expansion condition"
11343 The &%def%& condition must be followed by the name of one of the expansion
11344 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11345 variable does not contain the empty string. For example:
11346 .code
11347 ${if def:sender_ident {from $sender_ident}}
11348 .endd
11349 Note that the variable name is given without a leading &%$%& character. If the
11350 variable does not exist, the expansion fails.
11351
11352 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11353         &~&*def:h_*&<&'header&~name'&>&*:*&"
11354 .cindex "expansion" "checking header line existence"
11355 This condition is true if a message is being processed and the named header
11356 exists in the message. For example,
11357 .code
11358 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11359 .endd
11360 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11361 the header name must be terminated by a colon if white space does not follow.
11362
11363 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11364        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11365 .cindex "string" "comparison"
11366 .cindex "expansion" "string comparison"
11367 .cindex "&%eq%& expansion condition"
11368 .cindex "&%eqi%& expansion condition"
11369 The two substrings are first expanded. The condition is true if the two
11370 resulting strings are identical. For &%eq%& the comparison includes the case of
11371 letters, whereas for &%eqi%& the comparison is case-independent, where
11372 case is defined per the system C locale.
11373
11374 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11375 .cindex "expansion" "file existence test"
11376 .cindex "file" "existence test"
11377 .cindex "&%exists%&, expansion condition"
11378 The substring is first expanded and then interpreted as an absolute path. The
11379 condition is true if the named file (or directory) exists. The existence test
11380 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11381 users' filter files may be locked out by the system administrator.
11382
11383 .vitem &*first_delivery*&
11384 .cindex "delivery" "first"
11385 .cindex "first delivery"
11386 .cindex "expansion" "first delivery test"
11387 .cindex "&%first_delivery%& expansion condition"
11388 This condition, which has no data, is true during a message's first delivery
11389 attempt. It is false during any subsequent delivery attempts.
11390
11391
11392 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11393        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11394 .cindex "list" "iterative conditions"
11395 .cindex "expansion" "&*forall*& condition"
11396 .cindex "expansion" "&*forany*& condition"
11397 .vindex "&$item$&"
11398 These conditions iterate over a list. The first argument is expanded to form
11399 the list. By default, the list separator is a colon, but it can be changed by
11400 the normal method (&<<SECTlistsepchange>>&).
11401 The second argument is interpreted as a condition that is to
11402 be applied to each item in the list in turn. During the interpretation of the
11403 condition, the current list item is placed in a variable called &$item$&.
11404 .ilist
11405 For &*forany*&, interpretation stops if the condition is true for any item, and
11406 the result of the whole condition is true. If the condition is false for all
11407 items in the list, the overall condition is false.
11408 .next
11409 For &*forall*&, interpretation stops if the condition is false for any item,
11410 and the result of the whole condition is false. If the condition is true for
11411 all items in the list, the overall condition is true.
11412 .endlist
11413 Note that negation of &*forany*& means that the condition must be false for all
11414 items for the overall condition to succeed, and negation of &*forall*& means
11415 that the condition must be false for at least one item. In this example, the
11416 list separator is changed to a comma:
11417 .code
11418 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11419 .endd
11420 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11421 being processed, to enable these expansion items to be nested.
11422
11423 To scan a named list, expand it with the &*listnamed*& operator.
11424
11425 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11426        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11427        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11428        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11429 .cindex JSON "iterative conditions"
11430 .cindex JSON expansions
11431 .cindex expansion "&*forall_json*& condition"
11432 .cindex expansion "&*forany_json*& condition"
11433 .cindex expansion "&*forall_jsons*& condition"
11434 .cindex expansion "&*forany_jsons*& condition"
11435 As for the above, except that the first argument must, after expansion,
11436 be a JSON array.
11437 The array separator is not changeable.
11438 For the &"jsons"& variants the elements are expected to be JSON strings
11439 and have their quotes removed before the evaluation of the condition.
11440
11441
11442
11443 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11444        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11445 .cindex "string" "comparison"
11446 .cindex "expansion" "string comparison"
11447 .cindex "&%ge%& expansion condition"
11448 .cindex "&%gei%& expansion condition"
11449 The two substrings are first expanded. The condition is true if the first
11450 string is lexically greater than or equal to the second string. For &%ge%& the
11451 comparison includes the case of letters, whereas for &%gei%& the comparison is
11452 case-independent.
11453 Case and collation order are defined per the system C locale.
11454
11455 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11456        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11457 .cindex "string" "comparison"
11458 .cindex "expansion" "string comparison"
11459 .cindex "&%gt%& expansion condition"
11460 .cindex "&%gti%& expansion condition"
11461 The two substrings are first expanded. The condition is true if the first
11462 string is lexically greater than the second string. For &%gt%& the comparison
11463 includes the case of letters, whereas for &%gti%& the comparison is
11464 case-independent.
11465 Case and collation order are defined per the system C locale.
11466
11467 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11468        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11469 .cindex "string" "comparison"
11470 .cindex "list" "iterative conditions"
11471 Both strings are expanded; the second string is treated as a list of simple
11472 strings; if the first string is a member of the second, then the condition
11473 is true.
11474 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11475
11476 These are simpler to use versions of the more powerful &*forany*& condition.
11477 Examples, and the &*forany*& equivalents:
11478 .code
11479 ${if inlist{needle}{foo:needle:bar}}
11480   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11481 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11482   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11483 .endd
11484
11485 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11486        &*isip4&~{*&<&'string'&>&*}*& &&&
11487        &*isip6&~{*&<&'string'&>&*}*&
11488 .cindex "IP address" "testing string format"
11489 .cindex "string" "testing for IP address"
11490 .cindex "&%isip%& expansion condition"
11491 .cindex "&%isip4%& expansion condition"
11492 .cindex "&%isip6%& expansion condition"
11493 The substring is first expanded, and then tested to see if it has the form of
11494 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11495 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11496
11497 For an IPv4 address, the test is for four dot-separated components, each of
11498 which consists of from one to three digits. For an IPv6 address, up to eight
11499 colon-separated components are permitted, each containing from one to four
11500 hexadecimal digits. There may be fewer than eight components if an empty
11501 component (adjacent colons) is present. Only one empty component is permitted.
11502
11503 &*Note*&: The checks used to be just on the form of the address; actual numerical
11504 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11505 check.
11506 This is no longer the case.
11507
11508 The main use of these tests is to distinguish between IP addresses and
11509 host names, or between IPv4 and IPv6 addresses. For example, you could use
11510 .code
11511 ${if isip4{$sender_host_address}...
11512 .endd
11513 to test which IP version an incoming SMTP connection is using.
11514
11515 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11516 .cindex "LDAP" "use for authentication"
11517 .cindex "expansion" "LDAP authentication test"
11518 .cindex "&%ldapauth%& expansion condition"
11519 This condition supports user authentication using LDAP. See section
11520 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11521 queries. For this use, the query must contain a user name and password. The
11522 query itself is not used, and can be empty. The condition is true if the
11523 password is not empty, and the user name and password are accepted by the LDAP
11524 server. An empty password is rejected without calling LDAP because LDAP binds
11525 with an empty password are considered anonymous regardless of the username, and
11526 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11527 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11528 this can be used.
11529
11530
11531 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11532        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11533 .cindex "string" "comparison"
11534 .cindex "expansion" "string comparison"
11535 .cindex "&%le%& expansion condition"
11536 .cindex "&%lei%& expansion condition"
11537 The two substrings are first expanded. The condition is true if the first
11538 string is lexically less than or equal to the second string. For &%le%& the
11539 comparison includes the case of letters, whereas for &%lei%& the comparison is
11540 case-independent.
11541 Case and collation order are defined per the system C locale.
11542
11543 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11544        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11545 .cindex "string" "comparison"
11546 .cindex "expansion" "string comparison"
11547 .cindex "&%lt%& expansion condition"
11548 .cindex "&%lti%& expansion condition"
11549 The two substrings are first expanded. The condition is true if the first
11550 string is lexically less than the second string. For &%lt%& the comparison
11551 includes the case of letters, whereas for &%lti%& the comparison is
11552 case-independent.
11553 Case and collation order are defined per the system C locale.
11554
11555
11556 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11557 .cindex "expansion" "regular expression comparison"
11558 .cindex "regular expressions" "match in expanded string"
11559 .cindex "&%match%& expansion condition"
11560 The two substrings are first expanded. The second is then treated as a regular
11561 expression and applied to the first. Because of the pre-expansion, if the
11562 regular expression contains dollar, or backslash characters, they must be
11563 escaped. Care must also be taken if the regular expression contains braces
11564 (curly brackets). A closing brace must be escaped so that it is not taken as a
11565 premature termination of <&'string2'&>. The easiest approach is to use the
11566 &`\N`& feature to disable expansion of the regular expression.
11567 For example,
11568 .code
11569 ${if match {$local_part}{\N^\d{3}\N} ...
11570 .endd
11571 If the whole expansion string is in double quotes, further escaping of
11572 backslashes is also required.
11573
11574 The condition is true if the regular expression match succeeds.
11575 The regular expression is not required to begin with a circumflex
11576 metacharacter, but if there is no circumflex, the expression is not anchored,
11577 and it may match anywhere in the subject, not just at the start. If you want
11578 the pattern to match at the end of the subject, you must include the &`$`&
11579 metacharacter at an appropriate point.
11580 All character handling is done in bytes and is not UTF-8 aware,
11581 but we might change this in a future Exim release.
11582
11583 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11584 At the start of an &%if%& expansion the values of the numeric variable
11585 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11586 succeeds causes them to be reset to the substrings of that condition and they
11587 will have these values during the expansion of the success string. At the end
11588 of the &%if%& expansion, the previous values are restored. After testing a
11589 combination of conditions using &%or%&, the subsequent values of the numeric
11590 variables are those of the condition that succeeded.
11591
11592 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11593 .cindex "&%match_address%& expansion condition"
11594 See &*match_local_part*&.
11595
11596 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11597 .cindex "&%match_domain%& expansion condition"
11598 See &*match_local_part*&.
11599
11600 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11601 .cindex "&%match_ip%& expansion condition"
11602 This condition matches an IP address to a list of IP address patterns. It must
11603 be followed by two argument strings. The first (after expansion) must be an IP
11604 address or an empty string. The second (not expanded) is a restricted host
11605 list that can match only an IP address, not a host name. For example:
11606 .code
11607 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11608 .endd
11609 The specific types of host list item that are permitted in the list are:
11610
11611 .ilist
11612 An IP address, optionally with a CIDR mask.
11613 .next
11614 A single asterisk, which matches any IP address.
11615 .next
11616 An empty item, which matches only if the IP address is empty. This could be
11617 useful for testing for a locally submitted message or one from specific hosts
11618 in a single test such as
11619 . ==== As this is a nested list, any displays it contains must be indented
11620 . ==== as otherwise they are too far to the left. This comment applies to
11621 . ==== the use of xmlto plus fop. There's no problem when formatting with
11622 . ==== sdop, with or without the extra indent.
11623 .code
11624   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11625 .endd
11626 where the first item in the list is the empty string.
11627 .next
11628 The item @[] matches any of the local host's interface addresses.
11629 .next
11630 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11631 even if &`net-`& is not specified. There is never any attempt to turn the IP
11632 address into a host name. The most common type of linear search for
11633 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11634 masks. For example:
11635 .code
11636   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11637 .endd
11638 It is of course possible to use other kinds of lookup, and in such a case, you
11639 do need to specify the &`net-`& prefix if you want to specify a specific
11640 address mask, for example:
11641 .code
11642   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11643 .endd
11644 However, unless you are combining a &%match_ip%& condition with others, it is
11645 just as easy to use the fact that a lookup is itself a condition, and write:
11646 .code
11647   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11648 .endd
11649 .endlist ilist
11650
11651 Note that <&'string2'&> is not itself subject to string expansion, unless
11652 Exim was built with the EXPAND_LISTMATCH_RHS option.
11653
11654 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11655
11656 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11657 .cindex "domain list" "in expansion condition"
11658 .cindex "address list" "in expansion condition"
11659 .cindex "local part" "list, in expansion condition"
11660 .cindex "&%match_local_part%& expansion condition"
11661 This condition, together with &%match_address%& and &%match_domain%&, make it
11662 possible to test domain, address, and local part lists within expansions. Each
11663 condition requires two arguments: an item and a list to match. A trivial
11664 example is:
11665 .code
11666 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11667 .endd
11668 In each case, the second argument may contain any of the allowable items for a
11669 list of the appropriate type. Also, because the second argument
11670 is a standard form of list, it is possible to refer to a named list.
11671 Thus, you can use conditions like this:
11672 .code
11673 ${if match_domain{$domain}{+local_domains}{...
11674 .endd
11675 .cindex "&`+caseful`&"
11676 For address lists, the matching starts off caselessly, but the &`+caseful`&
11677 item can be used, as in all address lists, to cause subsequent items to
11678 have their local parts matched casefully. Domains are always matched
11679 caselessly.
11680
11681 Note that <&'string2'&> is not itself subject to string expansion, unless
11682 Exim was built with the EXPAND_LISTMATCH_RHS option.
11683
11684 &*Note*&: Host lists are &'not'& supported in this way. This is because
11685 hosts have two identities: a name and an IP address, and it is not clear
11686 how to specify cleanly how such a test would work. However, IP addresses can be
11687 matched using &%match_ip%&.
11688
11689 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11690 .cindex "PAM authentication"
11691 .cindex "AUTH" "with PAM"
11692 .cindex "Solaris" "PAM support"
11693 .cindex "expansion" "PAM authentication test"
11694 .cindex "&%pam%& expansion condition"
11695 &'Pluggable Authentication Modules'&
11696 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11697 available in the latest releases of Solaris and in some GNU/Linux
11698 distributions. The Exim support, which is intended for use in conjunction with
11699 the SMTP AUTH command, is available only if Exim is compiled with
11700 .code
11701 SUPPORT_PAM=yes
11702 .endd
11703 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11704 in some releases of GNU/Linux &%-ldl%& is also needed.
11705
11706 The argument string is first expanded, and the result must be a
11707 colon-separated list of strings. Leading and trailing white space is ignored.
11708 The PAM module is initialized with the service name &"exim"& and the user name
11709 taken from the first item in the colon-separated data string (<&'string1'&>).
11710 The remaining items in the data string are passed over in response to requests
11711 from the authentication function. In the simple case there will only be one
11712 request, for a password, so the data consists of just two strings.
11713
11714 There can be problems if any of the strings are permitted to contain colon
11715 characters. In the usual way, these have to be doubled to avoid being taken as
11716 separators. If the data is being inserted from a variable, the &%sg%& expansion
11717 item can be used to double any existing colons. For example, the configuration
11718 of a LOGIN authenticator might contain this setting:
11719 .code
11720 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11721 .endd
11722 For a PLAIN authenticator you could use:
11723 .code
11724 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11725 .endd
11726 In some operating systems, PAM authentication can be done only from a process
11727 running as root. Since Exim is running as the Exim user when receiving
11728 messages, this means that PAM cannot be used directly in those systems.
11729 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11730
11731
11732 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11733 .cindex "&'pwcheck'& daemon"
11734 .cindex "Cyrus"
11735 .cindex "expansion" "&'pwcheck'& authentication test"
11736 .cindex "&%pwcheck%& expansion condition"
11737 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11738 This is one way of making it possible for passwords to be checked by a process
11739 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11740 deprecated. Its replacement is &'saslauthd'& (see below).
11741
11742 The pwcheck support is not included in Exim by default. You need to specify
11743 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11744 building Exim. For example:
11745 .code
11746 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11747 .endd
11748 You do not need to install the full Cyrus software suite in order to use
11749 the pwcheck daemon. You can compile and install just the daemon alone
11750 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11751 access to the &_/var/pwcheck_& directory.
11752
11753 The &%pwcheck%& condition takes one argument, which must be the user name and
11754 password, separated by a colon. For example, in a LOGIN authenticator
11755 configuration, you might have this:
11756 .code
11757 server_condition = ${if pwcheck{$auth1:$auth2}}
11758 .endd
11759 Again, for a PLAIN authenticator configuration, this would be:
11760 .code
11761 server_condition = ${if pwcheck{$auth2:$auth3}}
11762 .endd
11763 .vitem &*queue_running*&
11764 .cindex "queue runner" "detecting when delivering from"
11765 .cindex "expansion" "queue runner test"
11766 .cindex "&%queue_running%& expansion condition"
11767 This condition, which has no data, is true during delivery attempts that are
11768 initiated by queue runner processes, and false otherwise.
11769
11770
11771 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11772 .cindex "Radius"
11773 .cindex "expansion" "Radius authentication"
11774 .cindex "&%radius%& expansion condition"
11775 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11776 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11777 the Radius client configuration file in order to build Exim with Radius
11778 support.
11779
11780 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11781 library, using the original API. If you are using release 0.4.0 or later of
11782 this library, you need to set
11783 .code
11784 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11785 .endd
11786 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11787 &%libradius%& library that comes with FreeBSD. To do this, set
11788 .code
11789 RADIUS_LIB_TYPE=RADLIB
11790 .endd
11791 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11792 You may also have to supply a suitable setting in EXTRALIBS so that the
11793 Radius library can be found when Exim is linked.
11794
11795 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11796 Radius client library, which calls the Radius server. The condition is true if
11797 the authentication is successful. For example:
11798 .code
11799 server_condition = ${if radius{<arguments>}}
11800 .endd
11801
11802
11803 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11804         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11805 .cindex "&'saslauthd'& daemon"
11806 .cindex "Cyrus"
11807 .cindex "expansion" "&'saslauthd'& authentication test"
11808 .cindex "&%saslauthd%& expansion condition"
11809 This condition supports user authentication using the Cyrus &'saslauthd'&
11810 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11811 Using this daemon is one way of making it possible for passwords to be checked
11812 by a process that is not running as root.
11813
11814 The saslauthd support is not included in Exim by default. You need to specify
11815 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11816 building Exim. For example:
11817 .code
11818 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11819 .endd
11820 You do not need to install the full Cyrus software suite in order to use
11821 the saslauthd daemon. You can compile and install just the daemon alone
11822 from the Cyrus SASL library.
11823
11824 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11825 two are mandatory. For example:
11826 .code
11827 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11828 .endd
11829 The service and the realm are optional (which is why the arguments are enclosed
11830 in their own set of braces). For details of the meaning of the service and
11831 realm, and how to run the daemon, consult the Cyrus documentation.
11832 .endlist vlist
11833
11834
11835
11836 .section "Combining expansion conditions" "SECID84"
11837 .cindex "expansion" "combining conditions"
11838 Several conditions can be tested at once by combining them using the &%and%&
11839 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11840 conditions on their own, and precede their lists of sub-conditions. Each
11841 sub-condition must be enclosed in braces within the overall braces that contain
11842 the list. No repetition of &%if%& is used.
11843
11844
11845 .vlist
11846 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11847 .cindex "&""or""& expansion condition"
11848 .cindex "expansion" "&""or""& of conditions"
11849 The sub-conditions are evaluated from left to right. The condition is true if
11850 any one of the sub-conditions is true.
11851 For example,
11852 .code
11853 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11854 .endd
11855 When a true sub-condition is found, the following ones are parsed but not
11856 evaluated. If there are several &"match"& sub-conditions the values of the
11857 numeric variables afterwards are taken from the first one that succeeds.
11858
11859 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11860 .cindex "&""and""& expansion condition"
11861 .cindex "expansion" "&""and""& of conditions"
11862 The sub-conditions are evaluated from left to right. The condition is true if
11863 all of the sub-conditions are true. If there are several &"match"&
11864 sub-conditions, the values of the numeric variables afterwards are taken from
11865 the last one. When a false sub-condition is found, the following ones are
11866 parsed but not evaluated.
11867 .endlist
11868 .ecindex IIDexpcond
11869
11870
11871
11872
11873 .section "Expansion variables" "SECTexpvar"
11874 .cindex "expansion" "variables, list of"
11875 This section contains an alphabetical list of all the expansion variables. Some
11876 of them are available only when Exim is compiled with specific options such as
11877 support for TLS or the content scanning extension.
11878
11879 .vlist
11880 .vitem "&$0$&, &$1$&, etc"
11881 .cindex "numerical variables (&$1$& &$2$& etc)"
11882 When a &%match%& expansion condition succeeds, these variables contain the
11883 captured substrings identified by the regular expression during subsequent
11884 processing of the success string of the containing &%if%& expansion item.
11885 In the expansion condition case
11886 they do not retain their values afterwards; in fact, their previous
11887 values are restored at the end of processing an &%if%& item. The numerical
11888 variables may also be set externally by some other matching process which
11889 precedes the expansion of the string. For example, the commands available in
11890 Exim filter files include an &%if%& command with its own regular expression
11891 matching condition.
11892
11893 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11894 Within an acl condition, expansion condition or expansion item
11895 any arguments are copied to these variables,
11896 any unused variables being made empty.
11897
11898 .vitem "&$acl_c...$&"
11899 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11900 can be given any name that starts with &$acl_c$& and is at least six characters
11901 long, but the sixth character must be either a digit or an underscore. For
11902 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11903 variables persist throughout the lifetime of an SMTP connection. They can be
11904 used to pass information between ACLs and between different invocations of the
11905 same ACL. When a message is received, the values of these variables are saved
11906 with the message, and can be accessed by filters, routers, and transports
11907 during subsequent delivery.
11908
11909 .vitem "&$acl_m...$&"
11910 These variables are like the &$acl_c...$& variables, except that their values
11911 are reset after a message has been received. Thus, if several messages are
11912 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11913 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11914 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11915 message is received, the values of these variables are saved with the message,
11916 and can be accessed by filters, routers, and transports during subsequent
11917 delivery.
11918
11919 .vitem &$acl_narg$&
11920 Within an acl condition, expansion condition or expansion item
11921 this variable has the number of arguments.
11922
11923 .vitem &$acl_verify_message$&
11924 .vindex "&$acl_verify_message$&"
11925 After an address verification has failed, this variable contains the failure
11926 message. It retains its value for use in subsequent modifiers. The message can
11927 be preserved by coding like this:
11928 .code
11929 warn !verify = sender
11930      set acl_m0 = $acl_verify_message
11931 .endd
11932 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11933 &%log_message%& modifiers, to include information about the verification
11934 failure.
11935
11936 .vitem &$address_data$&
11937 .vindex "&$address_data$&"
11938 This variable is set by means of the &%address_data%& option in routers. The
11939 value then remains with the address while it is processed by subsequent routers
11940 and eventually a transport. If the transport is handling multiple addresses,
11941 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11942 for more details. &*Note*&: The contents of &$address_data$& are visible in
11943 user filter files.
11944
11945 If &$address_data$& is set when the routers are called from an ACL to verify
11946 a recipient address, the final value is still in the variable for subsequent
11947 conditions and modifiers of the ACL statement. If routing the address caused it
11948 to be redirected to just one address, the child address is also routed as part
11949 of the verification, and in this case the final value of &$address_data$& is
11950 from the child's routing.
11951
11952 If &$address_data$& is set when the routers are called from an ACL to verify a
11953 sender address, the final value is also preserved, but this time in
11954 &$sender_address_data$&, to distinguish it from data from a recipient
11955 address.
11956
11957 In both cases (recipient and sender verification), the value does not persist
11958 after the end of the current ACL statement. If you want to preserve
11959 these values for longer, you can save them in ACL variables.
11960
11961 .vitem &$address_file$&
11962 .vindex "&$address_file$&"
11963 When, as a result of aliasing, forwarding, or filtering, a message is directed
11964 to a specific file, this variable holds the name of the file when the transport
11965 is running. At other times, the variable is empty. For example, using the
11966 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11967 .code
11968 /home/r2d2/savemail
11969 .endd
11970 then when the &(address_file)& transport is running, &$address_file$&
11971 contains the text string &`/home/r2d2/savemail`&.
11972 .cindex "Sieve filter" "value of &$address_file$&"
11973 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11974 then up to the transport configuration to generate an appropriate absolute path
11975 to the relevant file.
11976
11977 .vitem &$address_pipe$&
11978 .vindex "&$address_pipe$&"
11979 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11980 this variable holds the pipe command when the transport is running.
11981
11982 .vitem "&$auth1$& &-- &$auth3$&"
11983 .vindex "&$auth1$&, &$auth2$&, etc"
11984 These variables are used in SMTP authenticators (see chapters
11985 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11986
11987 .vitem &$authenticated_id$&
11988 .cindex "authentication" "id"
11989 .vindex "&$authenticated_id$&"
11990 When a server successfully authenticates a client it may be configured to
11991 preserve some of the authentication information in the variable
11992 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11993 user/password authenticator configuration might preserve the user name for use
11994 in the routers. Note that this is not the same information that is saved in
11995 &$sender_host_authenticated$&.
11996
11997 When a message is submitted locally (that is, not over a TCP connection)
11998 the value of &$authenticated_id$& is normally the login name of the calling
11999 process. However, a trusted user can override this by means of the &%-oMai%&
12000 command line option.
12001 This second case also sets up information used by the
12002 &$authresults$& expansion item.
12003
12004 .vitem &$authenticated_fail_id$&
12005 .cindex "authentication" "fail" "id"
12006 .vindex "&$authenticated_fail_id$&"
12007 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12008 will contain the failed authentication id. If more than one authentication
12009 id is attempted, it will contain only the last one. The variable is
12010 available for processing in the ACL's, generally the quit or notquit ACL.
12011 A message to a local recipient could still be accepted without requiring
12012 authentication, which means this variable could also be visible in all of
12013 the ACL's as well.
12014
12015
12016 .vitem &$authenticated_sender$&
12017 .cindex "sender" "authenticated"
12018 .cindex "authentication" "sender"
12019 .cindex "AUTH" "on MAIL command"
12020 .vindex "&$authenticated_sender$&"
12021 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12022 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12023 described in section &<<SECTauthparamail>>&. Unless the data is the string
12024 &"<>"&, it is set as the authenticated sender of the message, and the value is
12025 available during delivery in the &$authenticated_sender$& variable. If the
12026 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12027
12028 .vindex "&$qualify_domain$&"
12029 When a message is submitted locally (that is, not over a TCP connection), the
12030 value of &$authenticated_sender$& is an address constructed from the login
12031 name of the calling process and &$qualify_domain$&, except that a trusted user
12032 can override this by means of the &%-oMas%& command line option.
12033
12034
12035 .vitem &$authentication_failed$&
12036 .cindex "authentication" "failure"
12037 .vindex "&$authentication_failed$&"
12038 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12039 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12040 possible to distinguish between &"did not try to authenticate"&
12041 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12042 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12043 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12044 negative response to an AUTH command, including (for example) an attempt to use
12045 an undefined mechanism.
12046
12047 .vitem &$av_failed$&
12048 .cindex "content scanning" "AV scanner failure"
12049 This variable is available when Exim is compiled with the content-scanning
12050 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12051 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12052 the ACL malware condition.
12053
12054 .vitem &$body_linecount$&
12055 .cindex "message body" "line count"
12056 .cindex "body of message" "line count"
12057 .vindex "&$body_linecount$&"
12058 When a message is being received or delivered, this variable contains the
12059 number of lines in the message's body. See also &$message_linecount$&.
12060
12061 .vitem &$body_zerocount$&
12062 .cindex "message body" "binary zero count"
12063 .cindex "body of message" "binary zero count"
12064 .cindex "binary zero" "in message body"
12065 .vindex "&$body_zerocount$&"
12066 When a message is being received or delivered, this variable contains the
12067 number of binary zero bytes (ASCII NULs) in the message's body.
12068
12069 .vitem &$bounce_recipient$&
12070 .vindex "&$bounce_recipient$&"
12071 This is set to the recipient address of a bounce message while Exim is creating
12072 it. It is useful if a customized bounce message text file is in use (see
12073 chapter &<<CHAPemsgcust>>&).
12074
12075 .vitem &$bounce_return_size_limit$&
12076 .vindex "&$bounce_return_size_limit$&"
12077 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12078 up to a multiple of 1000. It is useful when a customized error message text
12079 file is in use (see chapter &<<CHAPemsgcust>>&).
12080
12081 .vitem &$caller_gid$&
12082 .cindex "gid (group id)" "caller"
12083 .vindex "&$caller_gid$&"
12084 The real group id under which the process that called Exim was running. This is
12085 not the same as the group id of the originator of a message (see
12086 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12087 incarnation normally contains the Exim gid.
12088
12089 .vitem &$caller_uid$&
12090 .cindex "uid (user id)" "caller"
12091 .vindex "&$caller_uid$&"
12092 The real user id under which the process that called Exim was running. This is
12093 not the same as the user id of the originator of a message (see
12094 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12095 incarnation normally contains the Exim uid.
12096
12097 .vitem &$callout_address$&
12098 .vindex "&$callout_address$&"
12099 After a callout for verification, spamd or malware daemon service, the
12100 address that was connected to.
12101
12102 .vitem &$compile_number$&
12103 .vindex "&$compile_number$&"
12104 The building process for Exim keeps a count of the number
12105 of times it has been compiled. This serves to distinguish different
12106 compilations of the same version of Exim.
12107
12108 .vitem &$config_dir$&
12109 .vindex "&$config_dir$&"
12110 The directory name of the main configuration file. That is, the content of
12111 &$config_file$& with the last component stripped. The value does not
12112 contain the trailing slash. If &$config_file$& does not contain a slash,
12113 &$config_dir$& is ".".
12114
12115 .vitem &$config_file$&
12116 .vindex "&$config_file$&"
12117 The name of the main configuration file Exim is using.
12118
12119 .vitem &$dmarc_domain_policy$& &&&
12120        &$dmarc_status$& &&&
12121        &$dmarc_status_text$& &&&
12122        &$dmarc_used_domains$&
12123 Results of DMARC verification.
12124 For details see section &<<SECDMARC>>&.
12125
12126 .vitem &$dkim_verify_status$&
12127 Results of DKIM verification.
12128 For details see section &<<SECDKIMVFY>>&.
12129
12130 .vitem &$dkim_cur_signer$& &&&
12131        &$dkim_verify_reason$& &&&
12132        &$dkim_domain$& &&&
12133        &$dkim_identity$& &&&
12134        &$dkim_selector$& &&&
12135        &$dkim_algo$& &&&
12136        &$dkim_canon_body$& &&&
12137        &$dkim_canon_headers$& &&&
12138        &$dkim_copiedheaders$& &&&
12139        &$dkim_bodylength$& &&&
12140        &$dkim_created$& &&&
12141        &$dkim_expires$& &&&
12142        &$dkim_headernames$& &&&
12143        &$dkim_key_testing$& &&&
12144        &$dkim_key_nosubdomains$& &&&
12145        &$dkim_key_srvtype$& &&&
12146        &$dkim_key_granularity$& &&&
12147        &$dkim_key_notes$& &&&
12148        &$dkim_key_length$&
12149 These variables are only available within the DKIM ACL.
12150 For details see section &<<SECDKIMVFY>>&.
12151
12152 .vitem &$dkim_signers$&
12153 .vindex &$dkim_signers$&
12154 When a message has been received this variable contains
12155 a colon-separated list of signer domains and identities for the message.
12156 For details see section &<<SECDKIMVFY>>&.
12157
12158 .vitem &$dnslist_domain$& &&&
12159        &$dnslist_matched$& &&&
12160        &$dnslist_text$& &&&
12161        &$dnslist_value$&
12162 .vindex "&$dnslist_domain$&"
12163 .vindex "&$dnslist_matched$&"
12164 .vindex "&$dnslist_text$&"
12165 .vindex "&$dnslist_value$&"
12166 .cindex "black list (DNS)"
12167 When a DNS (black) list lookup succeeds, these variables are set to contain
12168 the following data from the lookup: the list's domain name, the key that was
12169 looked up, the contents of any associated TXT record, and the value from the
12170 main A record. See section &<<SECID204>>& for more details.
12171
12172 .vitem &$domain$&
12173 .vindex "&$domain$&"
12174 When an address is being routed, or delivered on its own, this variable
12175 contains the domain. Uppercase letters in the domain are converted into lower
12176 case for &$domain$&.
12177
12178 Global address rewriting happens when a message is received, so the value of
12179 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12180 is set during user filtering, but not during system filtering, because a
12181 message may have many recipients and the system filter is called just once.
12182
12183 When more than one address is being delivered at once (for example, several
12184 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12185 have the same domain. Transports can be restricted to handling only one domain
12186 at a time if the value of &$domain$& is required at transport time &-- this is
12187 the default for local transports. For further details of the environment in
12188 which local transports are run, see chapter &<<CHAPenvironment>>&.
12189
12190 .oindex "&%delay_warning_condition%&"
12191 At the end of a delivery, if all deferred addresses have the same domain, it is
12192 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12193
12194 The &$domain$& variable is also used in some other circumstances:
12195
12196 .ilist
12197 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12198 the recipient address. The domain of the &'sender'& address is in
12199 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12200 normally set during the running of the MAIL ACL. However, if the sender address
12201 is verified with a callout during the MAIL ACL, the sender domain is placed in
12202 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12203 the &(smtp)& transport.
12204
12205 .next
12206 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12207 &$domain$& contains the domain portion of the address that is being rewritten;
12208 it can be used in the expansion of the replacement address, for example, to
12209 rewrite domains by file lookup.
12210
12211 .next
12212 With one important exception, whenever a domain list is being scanned,
12213 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12214 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12215 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12216 that, in a RCPT ACL, the sender domain list can be dependent on the
12217 recipient domain (which is what is in &$domain$& at this time).
12218
12219 .next
12220 .cindex "ETRN" "value of &$domain$&"
12221 .oindex "&%smtp_etrn_command%&"
12222 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12223 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12224 .endlist
12225
12226 .new
12227 .cindex "tainted data"
12228 If the origin of the data is an incoming message,
12229 the result of expanding this variable is tainted.
12230 See also &$domain_verified$&.
12231 .wen
12232
12233
12234 .vitem &$domain_data$&
12235 .vindex "&$domain_data$&"
12236 When the &%domains%& option on a router matches a domain by
12237 means of a lookup, the data read by the lookup is available during the running
12238 of the router as &$domain_data$&. In addition, if the driver routes the
12239 address to a transport, the value is available in that transport. If the
12240 transport is handling multiple addresses, the value from the first address is
12241 used.
12242
12243 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12244 domain by means of a lookup. The data read by the lookup is available during
12245 the rest of the ACL statement. In all other situations, this variable expands
12246 to nothing.
12247
12248 .vitem &$exim_gid$&
12249 .vindex "&$exim_gid$&"
12250 This variable contains the numerical value of the Exim group id.
12251
12252 .vitem &$exim_path$&
12253 .vindex "&$exim_path$&"
12254 This variable contains the path to the Exim binary.
12255
12256 .vitem &$exim_uid$&
12257 .vindex "&$exim_uid$&"
12258 This variable contains the numerical value of the Exim user id.
12259
12260 .vitem &$exim_version$&
12261 .vindex "&$exim_version$&"
12262 This variable contains the version string of the Exim build.
12263 The first character is a major version number, currently 4.
12264 Then after a dot, the next group of digits is a minor version number.
12265 There may be other characters following the minor version.
12266 This value may be overridden by the &%exim_version%& main config option.
12267
12268 .vitem &$header_$&<&'name'&>
12269 This is not strictly an expansion variable. It is expansion syntax for
12270 inserting the message header line with the given name. Note that the name must
12271 be terminated by colon or white space, because it may contain a wide variety of
12272 characters. Note also that braces must &'not'& be used.
12273 See the full description in section &<<SECTexpansionitems>>& above.
12274
12275 .vitem &$headers_added$&
12276 .vindex "&$headers_added$&"
12277 Within an ACL this variable contains the headers added so far by
12278 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12279 The headers are a newline-separated list.
12280
12281 .vitem &$home$&
12282 .vindex "&$home$&"
12283 When the &%check_local_user%& option is set for a router, the user's home
12284 directory is placed in &$home$& when the check succeeds. In particular, this
12285 means it is set during the running of users' filter files. A router may also
12286 explicitly set a home directory for use by a transport; this can be overridden
12287 by a setting on the transport itself.
12288
12289 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12290 of the environment variable HOME, which is subject to the
12291 &%keep_environment%& and &%add_environment%& main config options.
12292
12293 .vitem &$host$&
12294 .vindex "&$host$&"
12295 If a router assigns an address to a transport (any transport), and passes a
12296 list of hosts with the address, the value of &$host$& when the transport starts
12297 to run is the name of the first host on the list. Note that this applies both
12298 to local and remote transports.
12299
12300 .cindex "transport" "filter"
12301 .cindex "filter" "transport filter"
12302 For the &(smtp)& transport, if there is more than one host, the value of
12303 &$host$& changes as the transport works its way through the list. In
12304 particular, when the &(smtp)& transport is expanding its options for encryption
12305 using TLS, or for specifying a transport filter (see chapter
12306 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12307 is connected.
12308
12309 When used in the client part of an authenticator configuration (see chapter
12310 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12311 client is connected.
12312
12313
12314 .vitem &$host_address$&
12315 .vindex "&$host_address$&"
12316 This variable is set to the remote host's IP address whenever &$host$& is set
12317 for a remote connection. It is also set to the IP address that is being checked
12318 when the &%ignore_target_hosts%& option is being processed.
12319
12320 .vitem &$host_data$&
12321 .vindex "&$host_data$&"
12322 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12323 result of the lookup is made available in the &$host_data$& variable. This
12324 allows you, for example, to do things like this:
12325 .code
12326 deny  hosts = net-lsearch;/some/file
12327 message = $host_data
12328 .endd
12329 .vitem &$host_lookup_deferred$&
12330 .cindex "host name" "lookup, failure of"
12331 .vindex "&$host_lookup_deferred$&"
12332 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12333 message comes from a remote host and there is an attempt to look up the host's
12334 name from its IP address, and the attempt is not successful, one of these
12335 variables is set to &"1"&.
12336
12337 .ilist
12338 If the lookup receives a definite negative response (for example, a DNS lookup
12339 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12340
12341 .next
12342 If there is any kind of problem during the lookup, such that Exim cannot
12343 tell whether or not the host name is defined (for example, a timeout for a DNS
12344 lookup), &$host_lookup_deferred$& is set to &"1"&.
12345 .endlist ilist
12346
12347 Looking up a host's name from its IP address consists of more than just a
12348 single reverse lookup. Exim checks that a forward lookup of at least one of the
12349 names it receives from a reverse lookup yields the original IP address. If this
12350 is not the case, Exim does not accept the looked up name(s), and
12351 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12352 IP address (for example, the existence of a PTR record in the DNS) is not
12353 sufficient on its own for the success of a host name lookup. If the reverse
12354 lookup succeeds, but there is a lookup problem such as a timeout when checking
12355 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12356 &"1"&. See also &$sender_host_name$&.
12357
12358 .cindex authentication "expansion item"
12359 Performing these checks sets up information used by the
12360 &%authresults%& expansion item.
12361
12362
12363 .vitem &$host_lookup_failed$&
12364 .vindex "&$host_lookup_failed$&"
12365 See &$host_lookup_deferred$&.
12366
12367 .vitem &$host_port$&
12368 .vindex "&$host_port$&"
12369 This variable is set to the remote host's TCP port whenever &$host$& is set
12370 for an outbound connection.
12371
12372 .vitem &$initial_cwd$&
12373 .vindex "&$initial_cwd$&
12374 This variable contains the full path name of the initial working
12375 directory of the current Exim process. This may differ from the current
12376 working directory, as Exim changes this to "/" during early startup, and
12377 to &$spool_directory$& later.
12378
12379 .vitem &$inode$&
12380 .vindex "&$inode$&"
12381 The only time this variable is set is while expanding the &%directory_file%&
12382 option in the &(appendfile)& transport. The variable contains the inode number
12383 of the temporary file which is about to be renamed. It can be used to construct
12384 a unique name for the file.
12385
12386 .vitem &$interface_address$&
12387 .vindex "&$interface_address$&"
12388 This is an obsolete name for &$received_ip_address$&.
12389
12390 .vitem &$interface_port$&
12391 .vindex "&$interface_port$&"
12392 This is an obsolete name for &$received_port$&.
12393
12394 .vitem &$item$&
12395 .vindex "&$item$&"
12396 This variable is used during the expansion of &*forall*& and &*forany*&
12397 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12398 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12399 empty.
12400
12401 .vitem &$ldap_dn$&
12402 .vindex "&$ldap_dn$&"
12403 This variable, which is available only when Exim is compiled with LDAP support,
12404 contains the DN from the last entry in the most recently successful LDAP
12405 lookup.
12406
12407 .vitem &$load_average$&
12408 .vindex "&$load_average$&"
12409 This variable contains the system load average, multiplied by 1000 so that it
12410 is an integer. For example, if the load average is 0.21, the value of the
12411 variable is 210. The value is recomputed every time the variable is referenced.
12412
12413 .vitem &$local_part$&
12414 .vindex "&$local_part$&"
12415 When an address is being routed, or delivered on its own, this
12416 variable contains the local part. When a number of addresses are being
12417 delivered together (for example, multiple RCPT commands in an SMTP
12418 session), &$local_part$& is not set.
12419
12420 Global address rewriting happens when a message is received, so the value of
12421 &$local_part$& during routing and delivery is the value after rewriting.
12422 &$local_part$& is set during user filtering, but not during system filtering,
12423 because a message may have many recipients and the system filter is called just
12424 once.
12425
12426 .new
12427 .cindex "tainted data"
12428 If the origin of the data is an incoming message,
12429 the result of expanding this variable is tainted.
12430
12431 &*Warning*&: the content of this variable is usually provided by a potential
12432 attacker.
12433 Consider carefully the implications of using it unvalidated as a name
12434 for file access.
12435 This presents issues for users' &_.forward_& and filter files.
12436 For traditional full user accounts, use &%check_local_users%& and the
12437 &$local_part_verified$& variable rather than this one.
12438 For virtual users, store a suitable pathname component in the database
12439 which is used for account name validation, and use that retrieved value
12440 rather than this variable.
12441 If needed, use a router &%address_data%& or &%set%& option for
12442 the retrieved data.
12443 .wen
12444
12445 .vindex "&$local_part_prefix$&"
12446 .vindex "&$local_part_suffix$&"
12447 .cindex affix variables
12448 If a local part prefix or suffix has been recognized, it is not included in the
12449 value of &$local_part$& during routing and subsequent delivery. The values of
12450 any prefix or suffix are in &$local_part_prefix$& and
12451 &$local_part_suffix$&, respectively.
12452
12453 When a message is being delivered to a file, pipe, or autoreply transport as a
12454 result of aliasing or forwarding, &$local_part$& is set to the local part of
12455 the parent address, not to the filename or command (see &$address_file$& and
12456 &$address_pipe$&).
12457
12458 When an ACL is running for a RCPT command, &$local_part$& contains the
12459 local part of the recipient address.
12460
12461 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12462 &$local_part$& contains the local part of the address that is being rewritten;
12463 it can be used in the expansion of the replacement address, for example.
12464
12465 In all cases, all quoting is removed from the local part. For example, for both
12466 the addresses
12467 .code
12468 "abc:xyz"@test.example
12469 abc\:xyz@test.example
12470 .endd
12471 the value of &$local_part$& is
12472 .code
12473 abc:xyz
12474 .endd
12475 If you use &$local_part$& to create another address, you should always wrap it
12476 inside a quoting operator. For example, in a &(redirect)& router you could
12477 have:
12478 .code
12479 data = ${quote_local_part:$local_part}@new.domain.example
12480 .endd
12481 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12482 to process local parts in a case-dependent manner in a router, you can set the
12483 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12484
12485 .vitem &$local_part_data$&
12486 .vindex "&$local_part_data$&"
12487 When the &%local_parts%& option on a router matches a local part by means of a
12488 lookup, the data read by the lookup is available during the running of the
12489 router as &$local_part_data$&. In addition, if the driver routes the address
12490 to a transport, the value is available in that transport. If the transport is
12491 handling multiple addresses, the value from the first address is used.
12492
12493 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12494 matches a local part by means of a lookup. The data read by the lookup is
12495 available during the rest of the ACL statement. In all other situations, this
12496 variable expands to nothing.
12497
12498 .vitem &$local_part_prefix$&
12499 .vindex "&$local_part_prefix$&"
12500 .cindex affix variables
12501 When an address is being routed or delivered, and a
12502 specific prefix for the local part was recognized, it is available in this
12503 variable, having been removed from &$local_part$&.
12504
12505 .vitem &$local_part_suffix$&
12506 .vindex "&$local_part_suffix$&"
12507 When an address is being routed or delivered, and a
12508 specific suffix for the local part was recognized, it is available in this
12509 variable, having been removed from &$local_part$&.
12510
12511 .new
12512 .vitem &$local_part_verified$&
12513 .vindex "&$local_part_verified$&"
12514 If the router generic option &%check_local_part%& has run successfully,
12515 this variable has the user database version of &$local_part$&.
12516 Such values are not tainted and hence usable for building file names.
12517 .wen
12518
12519 .vitem &$local_scan_data$&
12520 .vindex "&$local_scan_data$&"
12521 This variable contains the text returned by the &[local_scan()]& function when
12522 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12523
12524 .vitem &$local_user_gid$&
12525 .vindex "&$local_user_gid$&"
12526 See &$local_user_uid$&.
12527
12528 .vitem &$local_user_uid$&
12529 .vindex "&$local_user_uid$&"
12530 This variable and &$local_user_gid$& are set to the uid and gid after the
12531 &%check_local_user%& router precondition succeeds. This means that their values
12532 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12533 and &%condition%&), for the &%address_data%& expansion, and for any
12534 router-specific expansions. At all other times, the values in these variables
12535 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12536
12537 .vitem &$localhost_number$&
12538 .vindex "&$localhost_number$&"
12539 This contains the expanded value of the
12540 &%localhost_number%& option. The expansion happens after the main options have
12541 been read.
12542
12543 .vitem &$log_inodes$&
12544 .vindex "&$log_inodes$&"
12545 The number of free inodes in the disk partition where Exim's
12546 log files are being written. The value is recalculated whenever the variable is
12547 referenced. If the relevant file system does not have the concept of inodes,
12548 the value of is -1. See also the &%check_log_inodes%& option.
12549
12550 .vitem &$log_space$&
12551 .vindex "&$log_space$&"
12552 The amount of free space (as a number of kilobytes) in the disk
12553 partition where Exim's log files are being written. The value is recalculated
12554 whenever the variable is referenced. If the operating system does not have the
12555 ability to find the amount of free space (only true for experimental systems),
12556 the space value is -1. See also the &%check_log_space%& option.
12557
12558
12559 .vitem &$lookup_dnssec_authenticated$&
12560 .vindex "&$lookup_dnssec_authenticated$&"
12561 This variable is set after a DNS lookup done by
12562 a dnsdb lookup expansion, dnslookup router or smtp transport.
12563 .cindex "DNS" "DNSSEC"
12564 It will be empty if &(DNSSEC)& was not requested,
12565 &"no"& if the result was not labelled as authenticated data
12566 and &"yes"& if it was.
12567 Results that are labelled as authoritative answer that match
12568 the &%dns_trust_aa%& configuration variable count also
12569 as authenticated data.
12570
12571 .vitem &$mailstore_basename$&
12572 .vindex "&$mailstore_basename$&"
12573 This variable is set only when doing deliveries in &"mailstore"& format in the
12574 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12575 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12576 contains the basename of the files that are being written, that is, the name
12577 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12578 variable is empty.
12579
12580 .vitem &$malware_name$&
12581 .vindex "&$malware_name$&"
12582 This variable is available when Exim is compiled with the
12583 content-scanning extension. It is set to the name of the virus that was found
12584 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12585
12586 .vitem &$max_received_linelength$&
12587 .vindex "&$max_received_linelength$&"
12588 .cindex "maximum" "line length"
12589 .cindex "line length" "maximum"
12590 This variable contains the number of bytes in the longest line that was
12591 received as part of the message, not counting the line termination
12592 character(s).
12593 It is not valid if the &%spool_files_wireformat%& option is used.
12594
12595 .vitem &$message_age$&
12596 .cindex "message" "age of"
12597 .vindex "&$message_age$&"
12598 This variable is set at the start of a delivery attempt to contain the number
12599 of seconds since the message was received. It does not change during a single
12600 delivery attempt.
12601
12602 .vitem &$message_body$&
12603 .cindex "body of message" "expansion variable"
12604 .cindex "message body" "in expansion"
12605 .cindex "binary zero" "in message body"
12606 .vindex "&$message_body$&"
12607 .oindex "&%message_body_visible%&"
12608 This variable contains the initial portion of a message's body while it is
12609 being delivered, and is intended mainly for use in filter files. The maximum
12610 number of characters of the body that are put into the variable is set by the
12611 &%message_body_visible%& configuration option; the default is 500.
12612
12613 .oindex "&%message_body_newlines%&"
12614 By default, newlines are converted into spaces in &$message_body$&, to make it
12615 easier to search for phrases that might be split over a line break. However,
12616 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12617 zeros are always converted into spaces.
12618
12619 .vitem &$message_body_end$&
12620 .cindex "body of message" "expansion variable"
12621 .cindex "message body" "in expansion"
12622 .vindex "&$message_body_end$&"
12623 This variable contains the final portion of a message's
12624 body while it is being delivered. The format and maximum size are as for
12625 &$message_body$&.
12626
12627 .vitem &$message_body_size$&
12628 .cindex "body of message" "size"
12629 .cindex "message body" "size"
12630 .vindex "&$message_body_size$&"
12631 When a message is being delivered, this variable contains the size of the body
12632 in bytes. The count starts from the character after the blank line that
12633 separates the body from the header. Newlines are included in the count. See
12634 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12635
12636 If the spool file is wireformat
12637 (see the &%spool_files_wireformat%& main option)
12638 the CRLF line-terminators are included in the count.
12639
12640 .vitem &$message_exim_id$&
12641 .vindex "&$message_exim_id$&"
12642 When a message is being received or delivered, this variable contains the
12643 unique message id that is generated and used by Exim to identify the message.
12644 An id is not created for a message until after its header has been successfully
12645 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12646 line; it is the local id that Exim assigns to the message, for example:
12647 &`1BXTIK-0001yO-VA`&.
12648
12649 .vitem &$message_headers$&
12650 .vindex &$message_headers$&
12651 This variable contains a concatenation of all the header lines when a message
12652 is being processed, except for lines added by routers or transports. The header
12653 lines are separated by newline characters. Their contents are decoded in the
12654 same way as a header line that is inserted by &%bheader%&.
12655
12656 .vitem &$message_headers_raw$&
12657 .vindex &$message_headers_raw$&
12658 This variable is like &$message_headers$& except that no processing of the
12659 contents of header lines is done.
12660
12661 .vitem &$message_id$&
12662 This is an old name for &$message_exim_id$&. It is now deprecated.
12663
12664 .vitem &$message_linecount$&
12665 .vindex "&$message_linecount$&"
12666 This variable contains the total number of lines in the header and body of the
12667 message. Compare &$body_linecount$&, which is the count for the body only.
12668 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12669 number of lines received. Before delivery happens (that is, before filters,
12670 routers, and transports run) the count is increased to include the
12671 &'Received:'& header line that Exim standardly adds, and also any other header
12672 lines that are added by ACLs. The blank line that separates the message header
12673 from the body is not counted.
12674
12675 As with the special case of &$message_size$&, during the expansion of the
12676 appendfile transport's maildir_tag option in maildir format, the value of
12677 &$message_linecount$& is the precise size of the number of newlines in the
12678 file that has been written (minus one for the blank line between the
12679 header and the body).
12680
12681 Here is an example of the use of this variable in a DATA ACL:
12682 .code
12683 deny message   = Too many lines in message header
12684      condition = \
12685       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12686 .endd
12687 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12688 message has not yet been received.
12689
12690 This variable is not valid if the &%spool_files_wireformat%& option is used.
12691
12692 .vitem &$message_size$&
12693 .cindex "size" "of message"
12694 .cindex "message" "size"
12695 .vindex "&$message_size$&"
12696 When a message is being processed, this variable contains its size in bytes. In
12697 most cases, the size includes those headers that were received with the
12698 message, but not those (such as &'Envelope-to:'&) that are added to individual
12699 deliveries as they are written. However, there is one special case: during the
12700 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12701 doing a delivery in maildir format, the value of &$message_size$& is the
12702 precise size of the file that has been written. See also
12703 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12704
12705 .cindex "RCPT" "value of &$message_size$&"
12706 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12707 contains the size supplied on the MAIL command, or -1 if no size was given. The
12708 value may not, of course, be truthful.
12709
12710 .vitem &$mime_$&&'xxx'&
12711 A number of variables whose names start with &$mime$& are
12712 available when Exim is compiled with the content-scanning extension. For
12713 details, see section &<<SECTscanmimepart>>&.
12714
12715 .vitem "&$n0$& &-- &$n9$&"
12716 These variables are counters that can be incremented by means
12717 of the &%add%& command in filter files.
12718
12719 .vitem &$original_domain$&
12720 .vindex "&$domain$&"
12721 .vindex "&$original_domain$&"
12722 When a top-level address is being processed for delivery, this contains the
12723 same value as &$domain$&. However, if a &"child"& address (for example,
12724 generated by an alias, forward, or filter file) is being processed, this
12725 variable contains the domain of the original address (lower cased). This
12726 differs from &$parent_domain$& only when there is more than one level of
12727 aliasing or forwarding. When more than one address is being delivered in a
12728 single transport run, &$original_domain$& is not set.
12729
12730 If a new address is created by means of a &%deliver%& command in a system
12731 filter, it is set up with an artificial &"parent"& address. This has the local
12732 part &'system-filter'& and the default qualify domain.
12733
12734 .vitem &$original_local_part$&
12735 .vindex "&$local_part$&"
12736 .vindex "&$original_local_part$&"
12737 When a top-level address is being processed for delivery, this contains the
12738 same value as &$local_part$&, unless a prefix or suffix was removed from the
12739 local part, because &$original_local_part$& always contains the full local
12740 part. When a &"child"& address (for example, generated by an alias, forward, or
12741 filter file) is being processed, this variable contains the full local part of
12742 the original address.
12743
12744 If the router that did the redirection processed the local part
12745 case-insensitively, the value in &$original_local_part$& is in lower case.
12746 This variable differs from &$parent_local_part$& only when there is more than
12747 one level of aliasing or forwarding. When more than one address is being
12748 delivered in a single transport run, &$original_local_part$& is not set.
12749
12750 If a new address is created by means of a &%deliver%& command in a system
12751 filter, it is set up with an artificial &"parent"& address. This has the local
12752 part &'system-filter'& and the default qualify domain.
12753
12754 .vitem &$originator_gid$&
12755 .cindex "gid (group id)" "of originating user"
12756 .cindex "sender" "gid"
12757 .vindex "&$caller_gid$&"
12758 .vindex "&$originator_gid$&"
12759 This variable contains the value of &$caller_gid$& that was set when the
12760 message was received. For messages received via the command line, this is the
12761 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12762 normally the gid of the Exim user.
12763
12764 .vitem &$originator_uid$&
12765 .cindex "uid (user id)" "of originating user"
12766 .cindex "sender" "uid"
12767 .vindex "&$caller_uid$&"
12768 .vindex "&$originator_uid$&"
12769 The value of &$caller_uid$& that was set when the message was received. For
12770 messages received via the command line, this is the uid of the sending user.
12771 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12772 user.
12773
12774 .vitem &$parent_domain$&
12775 .vindex "&$parent_domain$&"
12776 This variable is similar to &$original_domain$& (see
12777 above), except that it refers to the immediately preceding parent address.
12778
12779 .vitem &$parent_local_part$&
12780 .vindex "&$parent_local_part$&"
12781 This variable is similar to &$original_local_part$&
12782 (see above), except that it refers to the immediately preceding parent address.
12783
12784 .vitem &$pid$&
12785 .cindex "pid (process id)" "of current process"
12786 .vindex "&$pid$&"
12787 This variable contains the current process id.
12788
12789 .vitem &$pipe_addresses$&
12790 .cindex "filter" "transport filter"
12791 .cindex "transport" "filter"
12792 .vindex "&$pipe_addresses$&"
12793 This is not an expansion variable, but is mentioned here because the string
12794 &`$pipe_addresses`& is handled specially in the command specification for the
12795 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12796 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12797 It cannot be used in general expansion strings, and provokes an &"unknown
12798 variable"& error if encountered.
12799
12800 .vitem &$primary_hostname$&
12801 .vindex "&$primary_hostname$&"
12802 This variable contains the value set by &%primary_hostname%& in the
12803 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12804 a single-component name, Exim calls &[gethostbyname()]& (or
12805 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12806 qualified host name. See also &$smtp_active_hostname$&.
12807
12808
12809 .vitem &$proxy_external_address$& &&&
12810        &$proxy_external_port$& &&&
12811        &$proxy_local_address$& &&&
12812        &$proxy_local_port$& &&&
12813        &$proxy_session$&
12814 These variables are only available when built with Proxy Protocol
12815 or SOCKS5 support.
12816 For details see chapter &<<SECTproxyInbound>>&.
12817
12818 .vitem &$prdr_requested$&
12819 .cindex "PRDR" "variable for"
12820 This variable is set to &"yes"& if PRDR was requested by the client for the
12821 current message, otherwise &"no"&.
12822
12823 .vitem &$prvscheck_address$&
12824 This variable is used in conjunction with the &%prvscheck%& expansion item,
12825 which is described in sections &<<SECTexpansionitems>>& and
12826 &<<SECTverifyPRVS>>&.
12827
12828 .vitem &$prvscheck_keynum$&
12829 This variable is used in conjunction with the &%prvscheck%& expansion item,
12830 which is described in sections &<<SECTexpansionitems>>& and
12831 &<<SECTverifyPRVS>>&.
12832
12833 .vitem &$prvscheck_result$&
12834 This variable is used in conjunction with the &%prvscheck%& expansion item,
12835 which is described in sections &<<SECTexpansionitems>>& and
12836 &<<SECTverifyPRVS>>&.
12837
12838 .vitem &$qualify_domain$&
12839 .vindex "&$qualify_domain$&"
12840 The value set for the &%qualify_domain%& option in the configuration file.
12841
12842 .vitem &$qualify_recipient$&
12843 .vindex "&$qualify_recipient$&"
12844 The value set for the &%qualify_recipient%& option in the configuration file,
12845 or if not set, the value of &$qualify_domain$&.
12846
12847 .vitem &$queue_name$&
12848 .vindex &$queue_name$&
12849 .cindex "named queues"
12850 .cindex queues named
12851 The name of the spool queue in use; empty for the default queue.
12852
12853 .vitem &$r_...$&
12854 .vindex &$r_...$&
12855 .cindex router variables
12856 Values can be placed in these variables by the &%set%& option of a router.
12857 They can be given any name that starts with &$r_$&.
12858 The values persist for the address being handled through subsequent routers
12859 and the eventual transport.
12860
12861 .vitem &$rcpt_count$&
12862 .vindex "&$rcpt_count$&"
12863 When a message is being received by SMTP, this variable contains the number of
12864 RCPT commands received for the current message. If this variable is used in a
12865 RCPT ACL, its value includes the current command.
12866
12867 .vitem &$rcpt_defer_count$&
12868 .vindex "&$rcpt_defer_count$&"
12869 .cindex "4&'xx'& responses" "count of"
12870 When a message is being received by SMTP, this variable contains the number of
12871 RCPT commands in the current message that have previously been rejected with a
12872 temporary (4&'xx'&) response.
12873
12874 .vitem &$rcpt_fail_count$&
12875 .vindex "&$rcpt_fail_count$&"
12876 When a message is being received by SMTP, this variable contains the number of
12877 RCPT commands in the current message that have previously been rejected with a
12878 permanent (5&'xx'&) response.
12879
12880 .vitem &$received_count$&
12881 .vindex "&$received_count$&"
12882 This variable contains the number of &'Received:'& header lines in the message,
12883 including the one added by Exim (so its value is always greater than zero). It
12884 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12885 delivering.
12886
12887 .vitem &$received_for$&
12888 .vindex "&$received_for$&"
12889 If there is only a single recipient address in an incoming message, this
12890 variable contains that address when the &'Received:'& header line is being
12891 built. The value is copied after recipient rewriting has happened, but before
12892 the &[local_scan()]& function is run.
12893
12894 .vitem &$received_ip_address$&
12895 .vindex "&$received_ip_address$&"
12896 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12897 variable is set to the address of the local IP interface, and &$received_port$&
12898 is set to the local port number. (The remote IP address and port are in
12899 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12900 the port value is -1 unless it has been set using the &%-oMi%& command line
12901 option.
12902
12903 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12904 could be used, for example, to make the filename for a TLS certificate depend
12905 on which interface and/or port is being used for the incoming connection. The
12906 values of &$received_ip_address$& and &$received_port$& are saved with any
12907 messages that are received, thus making these variables available at delivery
12908 time.
12909 For outbound connections see &$sending_ip_address$&.
12910
12911 .vitem &$received_port$&
12912 .vindex "&$received_port$&"
12913 See &$received_ip_address$&.
12914
12915 .vitem &$received_protocol$&
12916 .vindex "&$received_protocol$&"
12917 When a message is being processed, this variable contains the name of the
12918 protocol by which it was received. Most of the names used by Exim are defined
12919 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12920 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12921 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12922 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12923 connection and the client was successfully authenticated.
12924
12925 Exim uses the protocol name &"smtps"& for the case when encryption is
12926 automatically set up on connection without the use of STARTTLS (see
12927 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12928 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12929 where the client initially uses EHLO, sets up an encrypted connection using
12930 STARTTLS, and then uses HELO afterwards.
12931
12932 The &%-oMr%& option provides a way of specifying a custom protocol name for
12933 messages that are injected locally by trusted callers. This is commonly used to
12934 identify messages that are being re-injected after some kind of scanning.
12935
12936 .vitem &$received_time$&
12937 .vindex "&$received_time$&"
12938 This variable contains the date and time when the current message was received,
12939 as a number of seconds since the start of the Unix epoch.
12940
12941 .vitem &$recipient_data$&
12942 .vindex "&$recipient_data$&"
12943 This variable is set after an indexing lookup success in an ACL &%recipients%&
12944 condition. It contains the data from the lookup, and the value remains set
12945 until the next &%recipients%& test. Thus, you can do things like this:
12946 .display
12947 &`require recipients  = cdb*@;/some/file`&
12948 &`deny    `&&'some further test involving'& &`$recipient_data`&
12949 .endd
12950 &*Warning*&: This variable is set only when a lookup is used as an indexing
12951 method in the address list, using the semicolon syntax as in the example above.
12952 The variable is not set for a lookup that is used as part of the string
12953 expansion that all such lists undergo before being interpreted.
12954
12955 .vitem &$recipient_verify_failure$&
12956 .vindex "&$recipient_verify_failure$&"
12957 In an ACL, when a recipient verification fails, this variable contains
12958 information about the failure. It is set to one of the following words:
12959
12960 .ilist
12961 &"qualify"&: The address was unqualified (no domain), and the message
12962 was neither local nor came from an exempted host.
12963
12964 .next
12965 &"route"&: Routing failed.
12966
12967 .next
12968 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12969 or before the MAIL command (that is, on initial connection, HELO, or
12970 MAIL).
12971
12972 .next
12973 &"recipient"&: The RCPT command in a callout was rejected.
12974 .next
12975
12976 &"postmaster"&: The postmaster check in a callout was rejected.
12977 .endlist
12978
12979 The main use of this variable is expected to be to distinguish between
12980 rejections of MAIL and rejections of RCPT.
12981
12982 .vitem &$recipients$&
12983 .vindex "&$recipients$&"
12984 This variable contains a list of envelope recipients for a message. A comma and
12985 a space separate the addresses in the replacement text. However, the variable
12986 is not generally available, to prevent exposure of Bcc recipients in
12987 unprivileged users' filter files. You can use &$recipients$& only in these
12988 cases:
12989
12990 .olist
12991 In a system filter file.
12992 .next
12993 In the ACLs associated with the DATA command and with non-SMTP messages, that
12994 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12995 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12996 &%acl_not_smtp_mime%&.
12997 .next
12998 From within a &[local_scan()]& function.
12999 .endlist
13000
13001
13002 .vitem &$recipients_count$&
13003 .vindex "&$recipients_count$&"
13004 When a message is being processed, this variable contains the number of
13005 envelope recipients that came with the message. Duplicates are not excluded
13006 from the count. While a message is being received over SMTP, the number
13007 increases for each accepted recipient. It can be referenced in an ACL.
13008
13009
13010 .vitem &$regex_match_string$&
13011 .vindex "&$regex_match_string$&"
13012 This variable is set to contain the matching regular expression after a
13013 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13014
13015 .vitem "&$regex1$&, &$regex2$&, etc"
13016 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13017 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13018 these variables contain the
13019 captured substrings identified by the regular expression.
13020
13021
13022 .vitem &$reply_address$&
13023 .vindex "&$reply_address$&"
13024 When a message is being processed, this variable contains the contents of the
13025 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13026 contents of the &'From:'& header line. Apart from the removal of leading
13027 white space, the value is not processed in any way. In particular, no RFC 2047
13028 decoding or character code translation takes place.
13029
13030 .vitem &$return_path$&
13031 .vindex "&$return_path$&"
13032 When a message is being delivered, this variable contains the return path &--
13033 the sender field that will be sent as part of the envelope. It is not enclosed
13034 in <> characters. At the start of routing an address, &$return_path$& has the
13035 same value as &$sender_address$&, but if, for example, an incoming message to a
13036 mailing list has been expanded by a router which specifies a different address
13037 for bounce messages, &$return_path$& subsequently contains the new bounce
13038 address, whereas &$sender_address$& always contains the original sender address
13039 that was received with the message. In other words, &$sender_address$& contains
13040 the incoming envelope sender, and &$return_path$& contains the outgoing
13041 envelope sender.
13042
13043 .vitem &$return_size_limit$&
13044 .vindex "&$return_size_limit$&"
13045 This is an obsolete name for &$bounce_return_size_limit$&.
13046
13047 .vitem &$router_name$&
13048 .cindex "router" "name"
13049 .cindex "name" "of router"
13050 .vindex "&$router_name$&"
13051 During the running of a router this variable contains its name.
13052
13053 .vitem &$runrc$&
13054 .cindex "return code" "from &%run%& expansion"
13055 .vindex "&$runrc$&"
13056 This variable contains the return code from a command that is run by the
13057 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13058 assume the order in which option values are expanded, except for those
13059 preconditions whose order of testing is documented. Therefore, you cannot
13060 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13061 another.
13062
13063 .vitem &$self_hostname$&
13064 .oindex "&%self%&" "value of host name"
13065 .vindex "&$self_hostname$&"
13066 When an address is routed to a supposedly remote host that turns out to be the
13067 local host, what happens is controlled by the &%self%& generic router option.
13068 One of its values causes the address to be passed to another router. When this
13069 happens, &$self_hostname$& is set to the name of the local host that the
13070 original router encountered. In other circumstances its contents are null.
13071
13072 .vitem &$sender_address$&
13073 .vindex "&$sender_address$&"
13074 When a message is being processed, this variable contains the sender's address
13075 that was received in the message's envelope. The case of letters in the address
13076 is retained, in both the local part and the domain. For bounce messages, the
13077 value of this variable is the empty string. See also &$return_path$&.
13078
13079 .vitem &$sender_address_data$&
13080 .vindex "&$address_data$&"
13081 .vindex "&$sender_address_data$&"
13082 If &$address_data$& is set when the routers are called from an ACL to verify a
13083 sender address, the final value is preserved in &$sender_address_data$&, to
13084 distinguish it from data from a recipient address. The value does not persist
13085 after the end of the current ACL statement. If you want to preserve it for
13086 longer, you can save it in an ACL variable.
13087
13088 .vitem &$sender_address_domain$&
13089 .vindex "&$sender_address_domain$&"
13090 The domain portion of &$sender_address$&.
13091
13092 .vitem &$sender_address_local_part$&
13093 .vindex "&$sender_address_local_part$&"
13094 The local part portion of &$sender_address$&.
13095
13096 .vitem &$sender_data$&
13097 .vindex "&$sender_data$&"
13098 This variable is set after a lookup success in an ACL &%senders%& condition or
13099 in a router &%senders%& option. It contains the data from the lookup, and the
13100 value remains set until the next &%senders%& test. Thus, you can do things like
13101 this:
13102 .display
13103 &`require senders      = cdb*@;/some/file`&
13104 &`deny    `&&'some further test involving'& &`$sender_data`&
13105 .endd
13106 &*Warning*&: This variable is set only when a lookup is used as an indexing
13107 method in the address list, using the semicolon syntax as in the example above.
13108 The variable is not set for a lookup that is used as part of the string
13109 expansion that all such lists undergo before being interpreted.
13110
13111 .vitem &$sender_fullhost$&
13112 .vindex "&$sender_fullhost$&"
13113 When a message is received from a remote host, this variable contains the host
13114 name and IP address in a single string. It ends with the IP address in square
13115 brackets, followed by a colon and a port number if the logging of ports is
13116 enabled. The format of the rest of the string depends on whether the host
13117 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13118 looking up its IP address. (Looking up the IP address can be forced by the
13119 &%host_lookup%& option, independent of verification.) A plain host name at the
13120 start of the string is a verified host name; if this is not present,
13121 verification either failed or was not requested. A host name in parentheses is
13122 the argument of a HELO or EHLO command. This is omitted if it is identical to
13123 the verified host name or to the host's IP address in square brackets.
13124
13125 .vitem &$sender_helo_dnssec$&
13126 .vindex "&$sender_helo_dnssec$&"
13127 This boolean variable is true if a successful HELO verification was
13128 .cindex "DNS" "DNSSEC"
13129 done using DNS information the resolver library stated was authenticated data.
13130
13131 .vitem &$sender_helo_name$&
13132 .vindex "&$sender_helo_name$&"
13133 When a message is received from a remote host that has issued a HELO or EHLO
13134 command, the argument of that command is placed in this variable. It is also
13135 set if HELO or EHLO is used when a message is received using SMTP locally via
13136 the &%-bs%& or &%-bS%& options.
13137
13138 .vitem &$sender_host_address$&
13139 .vindex "&$sender_host_address$&"
13140 When a message is received from a remote host using SMTP,
13141 this variable contains that
13142 host's IP address. For locally non-SMTP submitted messages, it is empty.
13143
13144 .vitem &$sender_host_authenticated$&
13145 .vindex "&$sender_host_authenticated$&"
13146 This variable contains the name (not the public name) of the authenticator
13147 driver that successfully authenticated the client from which the message was
13148 received. It is empty if there was no successful authentication. See also
13149 &$authenticated_id$&.
13150
13151 .vitem &$sender_host_dnssec$&
13152 .vindex "&$sender_host_dnssec$&"
13153 If an attempt to populate &$sender_host_name$& has been made
13154 (by reference, &%hosts_lookup%& or
13155 otherwise) then this boolean will have been set true if, and only if, the
13156 resolver library states that both
13157 the reverse and forward DNS were authenticated data.  At all
13158 other times, this variable is false.
13159
13160 .cindex "DNS" "DNSSEC"
13161 It is likely that you will need to coerce DNSSEC support on in the resolver
13162 library, by setting:
13163 .code
13164 dns_dnssec_ok = 1
13165 .endd
13166
13167 Exim does not perform DNSSEC validation itself, instead leaving that to a
13168 validating resolver (e.g. unbound, or bind with suitable configuration).
13169
13170 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13171 mechanism in the list, then this variable will be false.
13172
13173 This requires that your system resolver library support EDNS0 (and that
13174 DNSSEC flags exist in the system headers).  If the resolver silently drops
13175 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13176 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13177
13178
13179 .vitem &$sender_host_name$&
13180 .vindex "&$sender_host_name$&"
13181 When a message is received from a remote host, this variable contains the
13182 host's name as obtained by looking up its IP address. For messages received by
13183 other means, this variable is empty.
13184
13185 .vindex "&$host_lookup_failed$&"
13186 If the host name has not previously been looked up, a reference to
13187 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13188 A looked up name is accepted only if it leads back to the original IP address
13189 via a forward lookup. If either the reverse or the forward lookup fails to find
13190 any data, or if the forward lookup does not yield the original IP address,
13191 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13192
13193 .vindex "&$host_lookup_deferred$&"
13194 However, if either of the lookups cannot be completed (for example, there is a
13195 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13196 &$host_lookup_failed$& remains set to &"0"&.
13197
13198 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13199 host name again if there is a subsequent reference to &$sender_host_name$&
13200 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13201 is set to &"1"&.
13202
13203 Exim does not automatically look up every calling host's name. If you want
13204 maximum efficiency, you should arrange your configuration so that it avoids
13205 these lookups altogether. The lookup happens only if one or more of the
13206 following are true:
13207
13208 .ilist
13209 A string containing &$sender_host_name$& is expanded.
13210 .next
13211 The calling host matches the list in &%host_lookup%&. In the default
13212 configuration, this option is set to *, so it must be changed if lookups are
13213 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13214 .next
13215 Exim needs the host name in order to test an item in a host list. The items
13216 that require this are described in sections &<<SECThoslispatnam>>& and
13217 &<<SECThoslispatnamsk>>&.
13218 .next
13219 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13220 In this case, the host name is required to compare with the name quoted in any
13221 EHLO or HELO commands that the client issues.
13222 .next
13223 The remote host issues a EHLO or HELO command that quotes one of the
13224 domains in &%helo_lookup_domains%&. The default value of this option is
13225 . ==== As this is a nested list, any displays it contains must be indented
13226 . ==== as otherwise they are too far to the left.
13227 .code
13228   helo_lookup_domains = @ : @[]
13229 .endd
13230 which causes a lookup if a remote host (incorrectly) gives the server's name or
13231 IP address in an EHLO or HELO command.
13232 .endlist
13233
13234
13235 .vitem &$sender_host_port$&
13236 .vindex "&$sender_host_port$&"
13237 When a message is received from a remote host, this variable contains the port
13238 number that was used on the remote host.
13239
13240 .vitem &$sender_ident$&
13241 .vindex "&$sender_ident$&"
13242 When a message is received from a remote host, this variable contains the
13243 identification received in response to an RFC 1413 request. When a message has
13244 been received locally, this variable contains the login name of the user that
13245 called Exim.
13246
13247 .vitem &$sender_rate_$&&'xxx'&
13248 A number of variables whose names begin &$sender_rate_$& are set as part of the
13249 &%ratelimit%& ACL condition. Details are given in section
13250 &<<SECTratelimiting>>&.
13251
13252 .vitem &$sender_rcvhost$&
13253 .cindex "DNS" "reverse lookup"
13254 .cindex "reverse DNS lookup"
13255 .vindex "&$sender_rcvhost$&"
13256 This is provided specifically for use in &'Received:'& headers. It starts with
13257 either the verified host name (as obtained from a reverse DNS lookup) or, if
13258 there is no verified host name, the IP address in square brackets. After that
13259 there may be text in parentheses. When the first item is a verified host name,
13260 the first thing in the parentheses is the IP address in square brackets,
13261 followed by a colon and a port number if port logging is enabled. When the
13262 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13263 the parentheses.
13264
13265 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13266 was used and its argument was not identical to the real host name or IP
13267 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13268 all three items are present in the parentheses, a newline and tab are inserted
13269 into the string, to improve the formatting of the &'Received:'& header.
13270
13271 .vitem &$sender_verify_failure$&
13272 .vindex "&$sender_verify_failure$&"
13273 In an ACL, when a sender verification fails, this variable contains information
13274 about the failure. The details are the same as for
13275 &$recipient_verify_failure$&.
13276
13277 .vitem &$sending_ip_address$&
13278 .vindex "&$sending_ip_address$&"
13279 This variable is set whenever an outgoing SMTP connection to another host has
13280 been set up. It contains the IP address of the local interface that is being
13281 used. This is useful if a host that has more than one IP address wants to take
13282 on different personalities depending on which one is being used. For incoming
13283 connections, see &$received_ip_address$&.
13284
13285 .vitem &$sending_port$&
13286 .vindex "&$sending_port$&"
13287 This variable is set whenever an outgoing SMTP connection to another host has
13288 been set up. It contains the local port that is being used. For incoming
13289 connections, see &$received_port$&.
13290
13291 .vitem &$smtp_active_hostname$&
13292 .vindex "&$smtp_active_hostname$&"
13293 During an incoming SMTP session, this variable contains the value of the active
13294 host name, as specified by the &%smtp_active_hostname%& option. The value of
13295 &$smtp_active_hostname$& is saved with any message that is received, so its
13296 value can be consulted during routing and delivery.
13297
13298 .vitem &$smtp_command$&
13299 .vindex "&$smtp_command$&"
13300 During the processing of an incoming SMTP command, this variable contains the
13301 entire command. This makes it possible to distinguish between HELO and EHLO in
13302 the HELO ACL, and also to distinguish between commands such as these:
13303 .code
13304 MAIL FROM:<>
13305 MAIL FROM: <>
13306 .endd
13307 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13308 command, the address in &$smtp_command$& is the original address before any
13309 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13310 the address after SMTP-time rewriting.
13311
13312 .vitem &$smtp_command_argument$&
13313 .cindex "SMTP" "command, argument for"
13314 .vindex "&$smtp_command_argument$&"
13315 While an ACL is running to check an SMTP command, this variable contains the
13316 argument, that is, the text that follows the command name, with leading white
13317 space removed. Following the introduction of &$smtp_command$&, this variable is
13318 somewhat redundant, but is retained for backwards compatibility.
13319
13320 .vitem &$smtp_command_history$&
13321 .cindex SMTP "command history"
13322 .vindex "&$smtp_command_history$&"
13323 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13324 received, in time-order left to right.  Only a limited number of commands
13325 are remembered.
13326
13327 .vitem &$smtp_count_at_connection_start$&
13328 .vindex "&$smtp_count_at_connection_start$&"
13329 This variable is set greater than zero only in processes spawned by the Exim
13330 daemon for handling incoming SMTP connections. The name is deliberately long,
13331 in order to emphasize what the contents are. When the daemon accepts a new
13332 connection, it increments this variable. A copy of the variable is passed to
13333 the child process that handles the connection, but its value is fixed, and
13334 never changes. It is only an approximation of how many incoming connections
13335 there actually are, because many other connections may come and go while a
13336 single connection is being processed. When a child process terminates, the
13337 daemon decrements its copy of the variable.
13338
13339 .vitem "&$sn0$& &-- &$sn9$&"
13340 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13341 that were current at the end of the system filter file. This allows a system
13342 filter file to set values that can be tested in users' filter files. For
13343 example, a system filter could set a value indicating how likely it is that a
13344 message is junk mail.
13345
13346 .vitem &$spam_$&&'xxx'&
13347 A number of variables whose names start with &$spam$& are available when Exim
13348 is compiled with the content-scanning extension. For details, see section
13349 &<<SECTscanspamass>>&.
13350
13351 .vitem &$spf_header_comment$& &&&
13352        &$spf_received$& &&&
13353        &$spf_result$& &&&
13354        &$spf_result_guessed$& &&&
13355        &$spf_smtp_comment$&
13356 These variables are only available if Exim is built with SPF support.
13357 For details see section &<<SECSPF>>&.
13358
13359 .vitem &$spool_directory$&
13360 .vindex "&$spool_directory$&"
13361 The name of Exim's spool directory.
13362
13363 .vitem &$spool_inodes$&
13364 .vindex "&$spool_inodes$&"
13365 The number of free inodes in the disk partition where Exim's spool files are
13366 being written. The value is recalculated whenever the variable is referenced.
13367 If the relevant file system does not have the concept of inodes, the value of
13368 is -1. See also the &%check_spool_inodes%& option.
13369
13370 .vitem &$spool_space$&
13371 .vindex "&$spool_space$&"
13372 The amount of free space (as a number of kilobytes) in the disk partition where
13373 Exim's spool files are being written. The value is recalculated whenever the
13374 variable is referenced. If the operating system does not have the ability to
13375 find the amount of free space (only true for experimental systems), the space
13376 value is -1. For example, to check in an ACL that there is at least 50
13377 megabytes free on the spool, you could write:
13378 .code
13379 condition = ${if > {$spool_space}{50000}}
13380 .endd
13381 See also the &%check_spool_space%& option.
13382
13383
13384 .vitem &$thisaddress$&
13385 .vindex "&$thisaddress$&"
13386 This variable is set only during the processing of the &%foranyaddress%&
13387 command in a filter file. Its use is explained in the description of that
13388 command, which can be found in the separate document entitled &'Exim's
13389 interfaces to mail filtering'&.
13390
13391 .vitem &$tls_in_bits$&
13392 .vindex "&$tls_in_bits$&"
13393 Contains an approximation of the TLS cipher's bit-strength
13394 on the inbound connection; the meaning of
13395 this depends upon the TLS implementation used.
13396 If TLS has not been negotiated, the value will be 0.
13397 The value of this is automatically fed into the Cyrus SASL authenticator
13398 when acting as a server, to specify the "external SSF" (a SASL term).
13399
13400 The deprecated &$tls_bits$& variable refers to the inbound side
13401 except when used in the context of an outbound SMTP delivery, when it refers to
13402 the outbound.
13403
13404 .vitem &$tls_out_bits$&
13405 .vindex "&$tls_out_bits$&"
13406 Contains an approximation of the TLS cipher's bit-strength
13407 on an outbound SMTP connection; the meaning of
13408 this depends upon the TLS implementation used.
13409 If TLS has not been negotiated, the value will be 0.
13410
13411 .vitem &$tls_in_ourcert$&
13412 .vindex "&$tls_in_ourcert$&"
13413 .cindex certificate variables
13414 This variable refers to the certificate presented to the peer of an
13415 inbound connection when the message was received.
13416 It is only useful as the argument of a
13417 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13418 or a &%def%& condition.
13419
13420 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13421 when a list of more than one
13422 file is used for &%tls_certificate%&, this variable is not reliable.
13423 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13424
13425 .vitem &$tls_in_peercert$&
13426 .vindex "&$tls_in_peercert$&"
13427 This variable refers to the certificate presented by the peer of an
13428 inbound connection when the message was received.
13429 It is only useful as the argument of a
13430 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13431 or a &%def%& condition.
13432 If certificate verification fails it may refer to a failing chain element
13433 which is not the leaf.
13434
13435 .vitem &$tls_out_ourcert$&
13436 .vindex "&$tls_out_ourcert$&"
13437 This variable refers to the certificate presented to the peer of an
13438 outbound connection.  It is only useful as the argument of a
13439 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13440 or a &%def%& condition.
13441
13442 .vitem &$tls_out_peercert$&
13443 .vindex "&$tls_out_peercert$&"
13444 This variable refers to the certificate presented by the peer of an
13445 outbound connection.  It is only useful as the argument of a
13446 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13447 or a &%def%& condition.
13448 If certificate verification fails it may refer to a failing chain element
13449 which is not the leaf.
13450
13451 .vitem &$tls_in_certificate_verified$&
13452 .vindex "&$tls_in_certificate_verified$&"
13453 This variable is set to &"1"& if a TLS certificate was verified when the
13454 message was received, and &"0"& otherwise.
13455
13456 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13457 except when used in the context of an outbound SMTP delivery, when it refers to
13458 the outbound.
13459
13460 .vitem &$tls_out_certificate_verified$&
13461 .vindex "&$tls_out_certificate_verified$&"
13462 This variable is set to &"1"& if a TLS certificate was verified when an
13463 outbound SMTP connection was made,
13464 and &"0"& otherwise.
13465
13466 .vitem &$tls_in_cipher$&
13467 .vindex "&$tls_in_cipher$&"
13468 .vindex "&$tls_cipher$&"
13469 When a message is received from a remote host over an encrypted SMTP
13470 connection, this variable is set to the cipher suite that was negotiated, for
13471 example DES-CBC3-SHA. In other circumstances, in particular, for message
13472 received over unencrypted connections, the variable is empty. Testing
13473 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13474 non-encrypted connections during ACL processing.
13475
13476 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13477 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13478 becomes the same as &$tls_out_cipher$&.
13479
13480 .vitem &$tls_in_cipher_std$&
13481 .vindex "&$tls_in_cipher_std$&"
13482 As above, but returning the RFC standard name for the cipher suite.
13483
13484 .vitem &$tls_out_cipher$&
13485 .vindex "&$tls_out_cipher$&"
13486 This variable is
13487 cleared before any outgoing SMTP connection is made,
13488 and then set to the outgoing cipher suite if one is negotiated. See chapter
13489 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13490 details of the &(smtp)& transport.
13491
13492 .vitem &$tls_out_cipher_std$&
13493 .vindex "&$tls_out_cipher_std$&"
13494 As above, but returning the RFC standard name for the cipher suite.
13495
13496 .vitem &$tls_out_dane$&
13497 .vindex &$tls_out_dane$&
13498 DANE active status.  See section &<<SECDANE>>&.
13499
13500 .vitem &$tls_in_ocsp$&
13501 .vindex "&$tls_in_ocsp$&"
13502 When a message is received from a remote client connection
13503 the result of any OCSP request from the client is encoded in this variable:
13504 .code
13505 0 OCSP proof was not requested (default value)
13506 1 No response to request
13507 2 Response not verified
13508 3 Verification failed
13509 4 Verification succeeded
13510 .endd
13511
13512 .vitem &$tls_out_ocsp$&
13513 .vindex "&$tls_out_ocsp$&"
13514 When a message is sent to a remote host connection
13515 the result of any OCSP request made is encoded in this variable.
13516 See &$tls_in_ocsp$& for values.
13517
13518 .vitem &$tls_in_peerdn$&
13519 .vindex "&$tls_in_peerdn$&"
13520 .vindex "&$tls_peerdn$&"
13521 .cindex certificate "extracting fields"
13522 When a message is received from a remote host over an encrypted SMTP
13523 connection, and Exim is configured to request a certificate from the client,
13524 the value of the Distinguished Name of the certificate is made available in the
13525 &$tls_in_peerdn$& during subsequent processing.
13526 If certificate verification fails it may refer to a failing chain element
13527 which is not the leaf.
13528
13529 The deprecated &$tls_peerdn$& variable refers to the inbound side
13530 except when used in the context of an outbound SMTP delivery, when it refers to
13531 the outbound.
13532
13533 .vitem &$tls_out_peerdn$&
13534 .vindex "&$tls_out_peerdn$&"
13535 When a message is being delivered to a remote host over an encrypted SMTP
13536 connection, and Exim is configured to request a certificate from the server,
13537 the value of the Distinguished Name of the certificate is made available in the
13538 &$tls_out_peerdn$& during subsequent processing.
13539 If certificate verification fails it may refer to a failing chain element
13540 which is not the leaf.
13541
13542 .vitem &$tls_in_sni$&
13543 .vindex "&$tls_in_sni$&"
13544 .vindex "&$tls_sni$&"
13545 .cindex "TLS" "Server Name Indication"
13546 When a TLS session is being established, if the client sends the Server
13547 Name Indication extension, the value will be placed in this variable.
13548 If the variable appears in &%tls_certificate%& then this option and
13549 some others, described in &<<SECTtlssni>>&,
13550 will be re-expanded early in the TLS session, to permit
13551 a different certificate to be presented (and optionally a different key to be
13552 used) to the client, based upon the value of the SNI extension.
13553
13554 The deprecated &$tls_sni$& variable refers to the inbound side
13555 except when used in the context of an outbound SMTP delivery, when it refers to
13556 the outbound.
13557
13558 .vitem &$tls_out_sni$&
13559 .vindex "&$tls_out_sni$&"
13560 .cindex "TLS" "Server Name Indication"
13561 During outbound
13562 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13563 the transport.
13564
13565 .vitem &$tls_out_tlsa_usage$&
13566 .vindex &$tls_out_tlsa_usage$&
13567 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13568
13569 .vitem &$tls_in_ver$&
13570 .vindex "&$tls_in_ver$&"
13571 When a message is received from a remote host over an encrypted SMTP connection
13572 this variable is set to the protocol version, eg &'TLS1.2'&.
13573
13574 .vitem &$tls_out_ver$&
13575 .vindex "&$tls_out_ver$&"
13576 When a message is being delivered to a remote host over an encrypted SMTP connection
13577 this variable is set to the protocol version.
13578
13579
13580 .vitem &$tod_bsdinbox$&
13581 .vindex "&$tod_bsdinbox$&"
13582 The time of day and the date, in the format required for BSD-style mailbox
13583 files, for example: Thu Oct 17 17:14:09 1995.
13584
13585 .vitem &$tod_epoch$&
13586 .vindex "&$tod_epoch$&"
13587 The time and date as a number of seconds since the start of the Unix epoch.
13588
13589 .vitem &$tod_epoch_l$&
13590 .vindex "&$tod_epoch_l$&"
13591 The time and date as a number of microseconds since the start of the Unix epoch.
13592
13593 .vitem &$tod_full$&
13594 .vindex "&$tod_full$&"
13595 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13596 +0100. The timezone is always given as a numerical offset from UTC, with
13597 positive values used for timezones that are ahead (east) of UTC, and negative
13598 values for those that are behind (west).
13599
13600 .vitem &$tod_log$&
13601 .vindex "&$tod_log$&"
13602 The time and date in the format used for writing Exim's log files, for example:
13603 1995-10-12 15:32:29, but without a timezone.
13604
13605 .vitem &$tod_logfile$&
13606 .vindex "&$tod_logfile$&"
13607 This variable contains the date in the format yyyymmdd. This is the format that
13608 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13609 flag.
13610
13611 .vitem &$tod_zone$&
13612 .vindex "&$tod_zone$&"
13613 This variable contains the numerical value of the local timezone, for example:
13614 -0500.
13615
13616 .vitem &$tod_zulu$&
13617 .vindex "&$tod_zulu$&"
13618 This variable contains the UTC date and time in &"Zulu"& format, as specified
13619 by ISO 8601, for example: 20030221154023Z.
13620
13621 .vitem &$transport_name$&
13622 .cindex "transport" "name"
13623 .cindex "name" "of transport"
13624 .vindex "&$transport_name$&"
13625 During the running of a transport, this variable contains its name.
13626
13627 .vitem &$value$&
13628 .vindex "&$value$&"
13629 This variable contains the result of an expansion lookup, extraction operation,
13630 or external command, as described above. It is also used during a
13631 &*reduce*& expansion.
13632
13633 .vitem &$verify_mode$&
13634 .vindex "&$verify_mode$&"
13635 While a router or transport is being run in verify mode or for cutthrough delivery,
13636 contains "S" for sender-verification or "R" for recipient-verification.
13637 Otherwise, empty.
13638
13639 .vitem &$version_number$&
13640 .vindex "&$version_number$&"
13641 The version number of Exim. Same as &$exim_version$&, may be overridden
13642 by the &%exim_version%& main config option.
13643
13644 .vitem &$warn_message_delay$&
13645 .vindex "&$warn_message_delay$&"
13646 This variable is set only during the creation of a message warning about a
13647 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13648
13649 .vitem &$warn_message_recipients$&
13650 .vindex "&$warn_message_recipients$&"
13651 This variable is set only during the creation of a message warning about a
13652 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13653 .endlist
13654 .ecindex IIDstrexp
13655
13656
13657
13658 . ////////////////////////////////////////////////////////////////////////////
13659 . ////////////////////////////////////////////////////////////////////////////
13660
13661 .chapter "Embedded Perl" "CHAPperl"
13662 .scindex IIDperl "Perl" "calling from Exim"
13663 Exim can be built to include an embedded Perl interpreter. When this is done,
13664 Perl subroutines can be called as part of the string expansion process. To make
13665 use of the Perl support, you need version 5.004 or later of Perl installed on
13666 your system. To include the embedded interpreter in the Exim binary, include
13667 the line
13668 .code
13669 EXIM_PERL = perl.o
13670 .endd
13671 in your &_Local/Makefile_& and then build Exim in the normal way.
13672
13673
13674 .section "Setting up so Perl can be used" "SECID85"
13675 .oindex "&%perl_startup%&"
13676 Access to Perl subroutines is via a global configuration option called
13677 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13678 no &%perl_startup%& option in the Exim configuration file then no Perl
13679 interpreter is started and there is almost no overhead for Exim (since none of
13680 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13681 option then the associated value is taken to be Perl code which is executed in
13682 a newly created Perl interpreter.
13683
13684 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13685 need backslashes before any characters to escape special meanings. The option
13686 should usually be something like
13687 .code
13688 perl_startup = do '/etc/exim.pl'
13689 .endd
13690 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13691 use from Exim. Exim can be configured either to start up a Perl interpreter as
13692 soon as it is entered, or to wait until the first time it is needed. Starting
13693 the interpreter at the beginning ensures that it is done while Exim still has
13694 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13695 fact used in a particular run. Also, note that this does not mean that Exim is
13696 necessarily running as root when Perl is called at a later time. By default,
13697 the interpreter is started only when it is needed, but this can be changed in
13698 two ways:
13699
13700 .ilist
13701 .oindex "&%perl_at_start%&"
13702 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13703 a startup when Exim is entered.
13704 .next
13705 The command line option &%-ps%& also requests a startup when Exim is entered,
13706 overriding the setting of &%perl_at_start%&.
13707 .endlist
13708
13709 There is also a command line option &%-pd%& (for delay) which suppresses the
13710 initial startup, even if &%perl_at_start%& is set.
13711
13712 .ilist
13713 .oindex "&%perl_taintmode%&"
13714 .cindex "Perl" "taintmode"
13715 To provide more security executing Perl code via the embedded Perl
13716 interpreter, the &%perl_taintmode%& option can be set. This enables the
13717 taint mode of the Perl interpreter. You are encouraged to set this
13718 option to a true value. To avoid breaking existing installations, it
13719 defaults to false.
13720
13721
13722 .section "Calling Perl subroutines" "SECID86"
13723 When the configuration file includes a &%perl_startup%& option you can make use
13724 of the string expansion item to call the Perl subroutines that are defined
13725 by the &%perl_startup%& code. The operator is used in any of the following
13726 forms:
13727 .code
13728 ${perl{foo}}
13729 ${perl{foo}{argument}}
13730 ${perl{foo}{argument1}{argument2} ... }
13731 .endd
13732 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13733 arguments may be passed. Passing more than this results in an expansion failure
13734 with an error message of the form
13735 .code
13736 Too many arguments passed to Perl subroutine "foo" (max is 8)
13737 .endd
13738 The return value of the Perl subroutine is evaluated in a scalar context before
13739 it is passed back to Exim to be inserted into the expanded string. If the
13740 return value is &'undef'&, the expansion is forced to fail in the same way as
13741 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13742 by obeying Perl's &%die%& function, the expansion fails with the error message
13743 that was passed to &%die%&.
13744
13745
13746 .section "Calling Exim functions from Perl" "SECID87"
13747 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13748 is available to call back into Exim's string expansion function. For example,
13749 the Perl code
13750 .code
13751 my $lp = Exim::expand_string('$local_part');
13752 .endd
13753 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13754 Note those are single quotes and not double quotes to protect against
13755 &$local_part$& being interpolated as a Perl variable.
13756
13757 If the string expansion is forced to fail by a &"fail"& item, the result of
13758 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13759 expansion string, the Perl call from the original expansion string fails with
13760 an appropriate error message, in the same way as if &%die%& were used.
13761
13762 .cindex "debugging" "from embedded Perl"
13763 .cindex "log" "writing from embedded Perl"
13764 Two other Exim functions are available for use from within Perl code.
13765 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13766 debugging is enabled. If you want a newline at the end, you must supply it.
13767 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13768 timestamp. In this case, you should not supply a terminating newline.
13769
13770
13771 .section "Use of standard output and error by Perl" "SECID88"
13772 .cindex "Perl" "standard output and error"
13773 You should not write to the standard error or output streams from within your
13774 Perl code, as it is not defined how these are set up. In versions of Exim
13775 before 4.50, it is possible for the standard output or error to refer to the
13776 SMTP connection during message reception via the daemon. Writing to this stream
13777 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13778 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13779 avoided, but the output is lost.
13780
13781 .cindex "Perl" "use of &%warn%&"
13782 The Perl &%warn%& statement writes to the standard error stream by default.
13783 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13784 you have no control. When Exim starts up the Perl interpreter, it arranges for
13785 output from the &%warn%& statement to be written to the Exim main log. You can
13786 change this by including appropriate Perl magic somewhere in your Perl code.
13787 For example, to discard &%warn%& output completely, you need this:
13788 .code
13789 $SIG{__WARN__} = sub { };
13790 .endd
13791 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13792 example, the code for the subroutine is empty, so it does nothing, but you can
13793 include any Perl code that you like. The text of the &%warn%& message is passed
13794 as the first subroutine argument.
13795 .ecindex IIDperl
13796
13797
13798 . ////////////////////////////////////////////////////////////////////////////
13799 . ////////////////////////////////////////////////////////////////////////////
13800
13801 .chapter "Starting the daemon and the use of network interfaces" &&&
13802          "CHAPinterfaces" &&&
13803          "Starting the daemon"
13804 .cindex "daemon" "starting"
13805 .cindex "interface" "listening"
13806 .cindex "network interface"
13807 .cindex "interface" "network"
13808 .cindex "IP address" "for listening"
13809 .cindex "daemon" "listening IP addresses"
13810 .cindex "TCP/IP" "setting listening interfaces"
13811 .cindex "TCP/IP" "setting listening ports"
13812 A host that is connected to a TCP/IP network may have one or more physical
13813 hardware network interfaces. Each of these interfaces may be configured as one
13814 or more &"logical"& interfaces, which are the entities that a program actually
13815 works with. Each of these logical interfaces is associated with an IP address.
13816 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13817 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13818 knowledge about the host's interfaces for use in three different circumstances:
13819
13820 .olist
13821 When a listening daemon is started, Exim needs to know which interfaces
13822 and ports to listen on.
13823 .next
13824 When Exim is routing an address, it needs to know which IP addresses
13825 are associated with local interfaces. This is required for the correct
13826 processing of MX lists by removing the local host and others with the
13827 same or higher priority values. Also, Exim needs to detect cases
13828 when an address is routed to an IP address that in fact belongs to the
13829 local host. Unless the &%self%& router option or the &%allow_localhost%&
13830 option of the smtp transport is set (as appropriate), this is treated
13831 as an error situation.
13832 .next
13833 When Exim connects to a remote host, it may need to know which interface to use
13834 for the outgoing connection.
13835 .endlist
13836
13837
13838 Exim's default behaviour is likely to be appropriate in the vast majority
13839 of cases. If your host has only one interface, and you want all its IP
13840 addresses to be treated in the same way, and you are using only the
13841 standard SMTP port, you should not need to take any special action. The
13842 rest of this chapter does not apply to you.
13843
13844 In a more complicated situation you may want to listen only on certain
13845 interfaces, or on different ports, and for this reason there are a number of
13846 options that can be used to influence Exim's behaviour. The rest of this
13847 chapter describes how they operate.
13848
13849 When a message is received over TCP/IP, the interface and port that were
13850 actually used are set in &$received_ip_address$& and &$received_port$&.
13851
13852
13853
13854 .section "Starting a listening daemon" "SECID89"
13855 When a listening daemon is started (by means of the &%-bd%& command line
13856 option), the interfaces and ports on which it listens are controlled by the
13857 following options:
13858
13859 .ilist
13860 &%daemon_smtp_ports%& contains a list of default ports
13861 or service names.
13862 (For backward compatibility, this option can also be specified in the singular.)
13863 .next
13864 &%local_interfaces%& contains list of interface IP addresses on which to
13865 listen. Each item may optionally also specify a port.
13866 .endlist
13867
13868 The default list separator in both cases is a colon, but this can be changed as
13869 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13870 it is usually best to change the separator to avoid having to double all the
13871 colons. For example:
13872 .code
13873 local_interfaces = <; 127.0.0.1 ; \
13874                       192.168.23.65 ; \
13875                       ::1 ; \
13876                       3ffe:ffff:836f::fe86:a061
13877 .endd
13878 There are two different formats for specifying a port along with an IP address
13879 in &%local_interfaces%&:
13880
13881 .olist
13882 The port is added onto the address with a dot separator. For example, to listen
13883 on port 1234 on two different IP addresses:
13884 .code
13885 local_interfaces = <; 192.168.23.65.1234 ; \
13886                       3ffe:ffff:836f::fe86:a061.1234
13887 .endd
13888 .next
13889 The IP address is enclosed in square brackets, and the port is added
13890 with a colon separator, for example:
13891 .code
13892 local_interfaces = <; [192.168.23.65]:1234 ; \
13893                       [3ffe:ffff:836f::fe86:a061]:1234
13894 .endd
13895 .endlist
13896
13897 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13898 default setting contains just one port:
13899 .code
13900 daemon_smtp_ports = smtp
13901 .endd
13902 If more than one port is listed, each interface that does not have its own port
13903 specified listens on all of them. Ports that are listed in
13904 &%daemon_smtp_ports%& can be identified either by name (defined in
13905 &_/etc/services_&) or by number. However, when ports are given with individual
13906 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13907
13908
13909
13910 .section "Special IP listening addresses" "SECID90"
13911 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13912 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13913 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13914 instead of setting up separate listening sockets for each interface. The
13915 default value of &%local_interfaces%& is
13916 .code
13917 local_interfaces = 0.0.0.0
13918 .endd
13919 when Exim is built without IPv6 support; otherwise it is:
13920 .code
13921 local_interfaces = <; ::0 ; 0.0.0.0
13922 .endd
13923 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13924
13925
13926
13927 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13928 The &%-oX%& command line option can be used to override the values of
13929 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13930 instance. Another way of doing this would be to use macros and the &%-D%&
13931 option. However, &%-oX%& can be used by any admin user, whereas modification of
13932 the runtime configuration by &%-D%& is allowed only when the caller is root or
13933 exim.
13934
13935 The value of &%-oX%& is a list of items. The default colon separator can be
13936 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13937 If there are any items that do not
13938 contain dots or colons (that is, are not IP addresses), the value of
13939 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13940 items that do contain dots or colons, the value of &%local_interfaces%& is
13941 replaced by those items. Thus, for example,
13942 .code
13943 -oX 1225
13944 .endd
13945 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13946 whereas
13947 .code
13948 -oX 192.168.34.5.1125
13949 .endd
13950 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13951 (However, since &%local_interfaces%& now contains no items without ports, the
13952 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13953
13954
13955
13956 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13957 .cindex "submissions protocol"
13958 .cindex "ssmtp protocol"
13959 .cindex "smtps protocol"
13960 .cindex "SMTP" "ssmtp protocol"
13961 .cindex "SMTP" "smtps protocol"
13962 Exim supports the use of TLS-on-connect, used by mail clients in the
13963 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13964 For some years, IETF Standards Track documents only blessed the
13965 STARTTLS-based Submission service (port 587) while common practice was to support
13966 the same feature set on port 465, but using TLS-on-connect.
13967 If your installation needs to provide service to mail clients
13968 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13969 the 465 TCP ports.
13970
13971 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13972 service names, connections to those ports must first establish TLS, before
13973 proceeding to the application layer use of the SMTP protocol.
13974
13975 The common use of this option is expected to be
13976 .code
13977 tls_on_connect_ports = 465
13978 .endd
13979 per RFC 8314.
13980 There is also a command line option &%-tls-on-connect%&, which forces all ports
13981 to behave in this way when a daemon is started.
13982
13983 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13984 daemon to listen on those ports. You must still specify them in
13985 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13986 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13987 connections via the daemon.)
13988
13989
13990
13991
13992 .section "IPv6 address scopes" "SECID92"
13993 .cindex "IPv6" "address scopes"
13994 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13995 can, in principle, have the same link-local IPv6 address on different
13996 interfaces. Thus, additional information is needed, over and above the IP
13997 address, to distinguish individual interfaces. A convention of using a
13998 percent sign followed by something (often the interface name) has been
13999 adopted in some cases, leading to addresses like this:
14000 .code
14001 fe80::202:b3ff:fe03:45c1%eth0
14002 .endd
14003 To accommodate this usage, a percent sign followed by an arbitrary string is
14004 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14005 to convert a textual IPv6 address for actual use. This function recognizes the
14006 percent convention in operating systems that support it, and it processes the
14007 address appropriately. Unfortunately, some older libraries have problems with
14008 &[getaddrinfo()]&. If
14009 .code
14010 IPV6_USE_INET_PTON=yes
14011 .endd
14012 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14013 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14014 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14015 function.) Of course, this means that the additional functionality of
14016 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14017
14018 .section "Disabling IPv6" "SECID93"
14019 .cindex "IPv6" "disabling"
14020 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14021 run on a host whose kernel does not support IPv6. The binary will fall back to
14022 using IPv4, but it may waste resources looking up AAAA records, and trying to
14023 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14024 .oindex "&%disable_ipv6%&"
14025 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14026 activities take place. AAAA records are never looked up, and any IPv6 addresses
14027 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14028 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14029 to handle IPv6 literal addresses.
14030
14031 On the other hand, when IPv6 is in use, there may be times when you want to
14032 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14033 option to globally suppress the lookup of AAAA records for specified domains,
14034 and you can use the &%ignore_target_hosts%& generic router option to ignore
14035 IPv6 addresses in an individual router.
14036
14037
14038
14039 .section "Examples of starting a listening daemon" "SECID94"
14040 The default case in an IPv6 environment is
14041 .code
14042 daemon_smtp_ports = smtp
14043 local_interfaces = <; ::0 ; 0.0.0.0
14044 .endd
14045 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14046 Either one or two sockets may be used, depending on the characteristics of
14047 the TCP/IP stack. (This is complicated and messy; for more information,
14048 read the comments in the &_daemon.c_& source file.)
14049
14050 To specify listening on ports 25 and 26 on all interfaces:
14051 .code
14052 daemon_smtp_ports = 25 : 26
14053 .endd
14054 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14055 .code
14056 local_interfaces = <; ::0.25     ; ::0.26 \
14057                       0.0.0.0.25 ; 0.0.0.0.26
14058 .endd
14059 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14060 IPv4 loopback address only:
14061 .code
14062 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14063 .endd
14064 To specify listening on the default port on specific interfaces only:
14065 .code
14066 local_interfaces = 10.0.0.67 : 192.168.34.67
14067 .endd
14068 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14069
14070
14071
14072 .section "Recognizing the local host" "SECTreclocipadd"
14073 The &%local_interfaces%& option is also used when Exim needs to determine
14074 whether or not an IP address refers to the local host. That is, the IP
14075 addresses of all the interfaces on which a daemon is listening are always
14076 treated as local.
14077
14078 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14079 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14080 available interfaces from the operating system, and extracts the relevant
14081 (that is, IPv4 or IPv6) addresses to use for checking.
14082
14083 Some systems set up large numbers of virtual interfaces in order to provide
14084 many virtual web servers. In this situation, you may want to listen for
14085 email on only a few of the available interfaces, but nevertheless treat all
14086 interfaces as local when routing. You can do this by setting
14087 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14088 &"all"& wildcard values. These addresses are recognized as local, but are not
14089 used for listening. Consider this example:
14090 .code
14091 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14092                       192.168.53.235 ; \
14093                       3ffe:2101:12:1:a00:20ff:fe86:a061
14094
14095 extra_local_interfaces = <; ::0 ; 0.0.0.0
14096 .endd
14097 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14098 address, but all available interface addresses are treated as local when
14099 Exim is routing.
14100
14101 In some environments the local host name may be in an MX list, but with an IP
14102 address that is not assigned to any local interface. In other cases it may be
14103 desirable to treat other host names as if they referred to the local host. Both
14104 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14105 This contains host names rather than IP addresses. When a host is referenced
14106 during routing, either via an MX record or directly, it is treated as the local
14107 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14108 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14109
14110
14111
14112 .section "Delivering to a remote host" "SECID95"
14113 Delivery to a remote host is handled by the smtp transport. By default, it
14114 allows the system's TCP/IP functions to choose which interface to use (if
14115 there is more than one) when connecting to a remote host. However, the
14116 &%interface%& option can be set to specify which interface is used. See the
14117 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14118 details.
14119
14120
14121
14122
14123 . ////////////////////////////////////////////////////////////////////////////
14124 . ////////////////////////////////////////////////////////////////////////////
14125
14126 .chapter "Main configuration" "CHAPmainconfig"
14127 .scindex IIDconfima "configuration file" "main section"
14128 .scindex IIDmaiconf "main configuration"
14129 The first part of the runtime configuration file contains three types of item:
14130
14131 .ilist
14132 Macro definitions: These lines start with an upper case letter. See section
14133 &<<SECTmacrodefs>>& for details of macro processing.
14134 .next
14135 Named list definitions: These lines start with one of the words &"domainlist"&,
14136 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14137 section &<<SECTnamedlists>>&.
14138 .next
14139 Main configuration settings: Each setting occupies one line of the file
14140 (with possible continuations). If any setting is preceded by the word
14141 &"hide"&, the &%-bP%& command line option displays its value to admin users
14142 only. See section &<<SECTcos>>& for a description of the syntax of these option
14143 settings.
14144 .endlist
14145
14146 This chapter specifies all the main configuration options, along with their
14147 types and default values. For ease of finding a particular option, they appear
14148 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14149 are now so many options, they are first listed briefly in functional groups, as
14150 an aid to finding the name of the option you are looking for. Some options are
14151 listed in more than one group.
14152
14153 .section "Miscellaneous" "SECID96"
14154 .table2
14155 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14156 .row &%debug_store%&                 "do extra internal checks"
14157 .row &%disable_ipv6%&                "do no IPv6 processing"
14158 .row &%keep_malformed%&              "for broken files &-- should not happen"
14159 .row &%localhost_number%&            "for unique message ids in clusters"
14160 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14161 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14162 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14163 .row &%print_topbitchars%&           "top-bit characters are printing"
14164 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14165 .row &%timezone%&                    "force time zone"
14166 .endtable
14167
14168
14169 .section "Exim parameters" "SECID97"
14170 .table2
14171 .row &%exim_group%&                  "override compiled-in value"
14172 .row &%exim_path%&                   "override compiled-in value"
14173 .row &%exim_user%&                   "override compiled-in value"
14174 .row &%primary_hostname%&            "default from &[uname()]&"
14175 .row &%split_spool_directory%&       "use multiple directories"
14176 .row &%spool_directory%&             "override compiled-in value"
14177 .endtable
14178
14179
14180
14181 .section "Privilege controls" "SECID98"
14182 .table2
14183 .row &%admin_groups%&                "groups that are Exim admin users"
14184 .row &%commandline_checks_require_admin%& "require admin for various checks"
14185 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14186 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14187 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14188 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14189 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14190 .row &%never_users%&                 "do not run deliveries as these"
14191 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14192 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14193 .row &%trusted_groups%&              "groups that are trusted"
14194 .row &%trusted_users%&               "users that are trusted"
14195 .endtable
14196
14197
14198
14199 .section "Logging" "SECID99"
14200 .table2
14201 .row &%event_action%&                "custom logging"
14202 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14203 .row &%log_file_path%&               "override compiled-in value"
14204 .row &%log_selector%&                "set/unset optional logging"
14205 .row &%log_timezone%&                "add timezone to log lines"
14206 .row &%message_logs%&                "create per-message logs"
14207 .row &%preserve_message_logs%&       "after message completion"
14208 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14209 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14210 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14211 .row &%syslog_facility%&             "set syslog &""facility""& field"
14212 .row &%syslog_pid%&                  "pid in syslog lines"
14213 .row &%syslog_processname%&          "set syslog &""ident""& field"
14214 .row &%syslog_timestamp%&            "timestamp syslog lines"
14215 .row &%write_rejectlog%&             "control use of message log"
14216 .endtable
14217
14218
14219
14220 .section "Frozen messages" "SECID100"
14221 .table2
14222 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14223 .row &%freeze_tell%&                 "send message when freezing"
14224 .row &%move_frozen_messages%&        "to another directory"
14225 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14226 .endtable
14227
14228
14229
14230 .section "Data lookups" "SECID101"
14231 .table2
14232 .row &%ibase_servers%&               "InterBase servers"
14233 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14234 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14235 .row &%ldap_cert_file%&              "client cert file for LDAP"
14236 .row &%ldap_cert_key%&               "client key file for LDAP"
14237 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14238 .row &%ldap_default_servers%&        "used if no server in query"
14239 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14240 .row &%ldap_start_tls%&              "require TLS within LDAP"
14241 .row &%ldap_version%&                "set protocol version"
14242 .row &%lookup_open_max%&             "lookup files held open"
14243 .row &%mysql_servers%&               "default MySQL servers"
14244 .row &%oracle_servers%&              "Oracle servers"
14245 .row &%pgsql_servers%&               "default PostgreSQL servers"
14246 .row &%sqlite_lock_timeout%&         "as it says"
14247 .endtable
14248
14249
14250
14251 .section "Message ids" "SECID102"
14252 .table2
14253 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14254 .row &%message_id_header_text%&      "ditto"
14255 .endtable
14256
14257
14258
14259 .section "Embedded Perl Startup" "SECID103"
14260 .table2
14261 .row &%perl_at_start%&               "always start the interpreter"
14262 .row &%perl_startup%&                "code to obey when starting Perl"
14263 .row &%perl_taintmode%&              "enable taint mode in Perl"
14264 .endtable
14265
14266
14267
14268 .section "Daemon" "SECID104"
14269 .table2
14270 .row &%daemon_smtp_ports%&           "default ports"
14271 .row &%daemon_startup_retries%&      "number of times to retry"
14272 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14273 .row &%extra_local_interfaces%&      "not necessarily listened on"
14274 .row &%local_interfaces%&            "on which to listen, with optional ports"
14275 .row &%pid_file_path%&               "override compiled-in value"
14276 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14277 .endtable
14278
14279
14280
14281 .section "Resource control" "SECID105"
14282 .table2
14283 .row &%check_log_inodes%&            "before accepting a message"
14284 .row &%check_log_space%&             "before accepting a message"
14285 .row &%check_spool_inodes%&          "before accepting a message"
14286 .row &%check_spool_space%&           "before accepting a message"
14287 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14288 .row &%queue_only_load%&             "queue incoming if load high"
14289 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14290 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14291 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14292 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14293 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14294 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14295 .row &%smtp_accept_max_per_connection%& "messages per connection"
14296 .row &%smtp_accept_max_per_host%&    "connections from one host"
14297 .row &%smtp_accept_queue%&           "queue mail if more connections"
14298 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14299                                            connection"
14300 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14301 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14302 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14303 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14304 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14305 .endtable
14306
14307
14308
14309 .section "Policy controls" "SECID106"
14310 .table2
14311 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14312 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14313 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14314 .row &%acl_smtp_auth%&               "ACL for AUTH"
14315 .row &%acl_smtp_connect%&            "ACL for connection"
14316 .row &%acl_smtp_data%&               "ACL for DATA"
14317 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14318 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14319 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14320 .row &%acl_smtp_expn%&               "ACL for EXPN"
14321 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14322 .row &%acl_smtp_mail%&               "ACL for MAIL"
14323 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14324 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14325 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14326 .row &%acl_smtp_predata%&            "ACL for start of data"
14327 .row &%acl_smtp_quit%&               "ACL for QUIT"
14328 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14329 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14330 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14331 .row &%av_scanner%&                  "specify virus scanner"
14332 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14333                                       words""&"
14334 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14335 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14336 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14337 .row &%header_maxsize%&              "total size of message header"
14338 .row &%header_line_maxsize%&         "individual header line limit"
14339 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14340 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14341 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14342 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14343 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14344 .row &%host_lookup%&                 "host name looked up for these hosts"
14345 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14346 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14347 .row &%host_reject_connection%&      "reject connection from these hosts"
14348 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14349 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14350 .row &%message_size_limit%&          "for all messages"
14351 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14352 .row &%spamd_address%&               "set interface to SpamAssassin"
14353 .row &%strict_acl_vars%&             "object to unset ACL variables"
14354 .endtable
14355
14356
14357
14358 .section "Callout cache" "SECID107"
14359 .table2
14360 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14361                                          item"
14362 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14363                                          item"
14364 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14365 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14366 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14367 .endtable
14368
14369
14370
14371 .section "TLS" "SECID108"
14372 .table2
14373 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14374 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14375 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14376 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14377 .row &%tls_certificate%&             "location of server certificate"
14378 .row &%tls_crl%&                     "certificate revocation list"
14379 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14380 .row &%tls_dhparam%&                 "DH parameters for server"
14381 .row &%tls_eccurve%&                 "EC curve selection for server"
14382 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14383 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14384 .row &%tls_privatekey%&              "location of server private key"
14385 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14386 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14387 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14388 .row &%tls_verify_certificates%&     "expected client certificates"
14389 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14390 .endtable
14391
14392
14393
14394 .section "Local user handling" "SECID109"
14395 .table2
14396 .row &%finduser_retries%&            "useful in NIS environments"
14397 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14398 .row &%gecos_pattern%&               "ditto"
14399 .row &%max_username_length%&         "for systems that truncate"
14400 .row &%unknown_login%&               "used when no login name found"
14401 .row &%unknown_username%&            "ditto"
14402 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14403 .row &%uucp_from_sender%&            "ditto"
14404 .endtable
14405
14406
14407
14408 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14409 .table2
14410 .row &%header_maxsize%&              "total size of message header"
14411 .row &%header_line_maxsize%&         "individual header line limit"
14412 .row &%message_size_limit%&          "applies to all messages"
14413 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14414 .row &%received_header_text%&        "expanded to make &'Received:'&"
14415 .row &%received_headers_max%&        "for mail loop detection"
14416 .row &%recipients_max%&              "limit per message"
14417 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14418 .endtable
14419
14420
14421
14422
14423 .section "Non-SMTP incoming messages" "SECID111"
14424 .table2
14425 .row &%receive_timeout%&             "for non-SMTP messages"
14426 .endtable
14427
14428
14429
14430
14431
14432 .section "Incoming SMTP messages" "SECID112"
14433 See also the &'Policy controls'& section above.
14434
14435 .table2
14436 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14437 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14438 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14439 .row &%host_lookup%&                 "host name looked up for these hosts"
14440 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14441 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14442 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14443 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14444 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14445 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14446 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14447 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14448 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14449 .row &%smtp_accept_max_per_connection%& "messages per connection"
14450 .row &%smtp_accept_max_per_host%&    "connections from one host"
14451 .row &%smtp_accept_queue%&           "queue mail if more connections"
14452 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14453                                            connection"
14454 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14455 .row &%smtp_active_hostname%&        "host name to use in messages"
14456 .row &%smtp_banner%&                 "text for welcome banner"
14457 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14458 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14459 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14460 .row &%smtp_etrn_command%&           "what to run for ETRN"
14461 .row &%smtp_etrn_serialize%&         "only one at once"
14462 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14463 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14464 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14465 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14466 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14467 .row &%smtp_receive_timeout%&        "per command or data line"
14468 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14469 .row &%smtp_return_error_details%&   "give detail on rejections"
14470 .endtable
14471
14472
14473
14474 .section "SMTP extensions" "SECID113"
14475 .table2
14476 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14477 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14478 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14479 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14480 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14481 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14482 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14483 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14484 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14485 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14486 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14487 .endtable
14488
14489
14490
14491 .section "Processing messages" "SECID114"
14492 .table2
14493 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14494 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14495 .row &%allow_utf8_domains%&          "in addresses"
14496 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14497                                       words""&"
14498 .row &%delivery_date_remove%&        "from incoming messages"
14499 .row &%envelope_to_remove%&          "from incoming messages"
14500 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14501 .row &%headers_charset%&             "default for translations"
14502 .row &%qualify_domain%&              "default for senders"
14503 .row &%qualify_recipient%&           "default for recipients"
14504 .row &%return_path_remove%&          "from incoming messages"
14505 .row &%strip_excess_angle_brackets%& "in addresses"
14506 .row &%strip_trailing_dot%&          "at end of addresses"
14507 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14508 .endtable
14509
14510
14511
14512 .section "System filter" "SECID115"
14513 .table2
14514 .row &%system_filter%&               "locate system filter"
14515 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14516                                             directory"
14517 .row &%system_filter_file_transport%& "transport for delivery to a file"
14518 .row &%system_filter_group%&         "group for filter running"
14519 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14520 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14521 .row &%system_filter_user%&          "user for filter running"
14522 .endtable
14523
14524
14525
14526 .section "Routing and delivery" "SECID116"
14527 .table2
14528 .row &%disable_ipv6%&                "do no IPv6 processing"
14529 .row &%dns_again_means_nonexist%&    "for broken domains"
14530 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14531 .row &%dns_dnssec_ok%&               "parameter for resolver"
14532 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14533 .row &%dns_retrans%&                 "parameter for resolver"
14534 .row &%dns_retry%&                   "parameter for resolver"
14535 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14536 .row &%dns_use_edns0%&               "parameter for resolver"
14537 .row &%hold_domains%&                "hold delivery for these domains"
14538 .row &%local_interfaces%&            "for routing checks"
14539 .row &%queue_domains%&               "no immediate delivery for these"
14540 .row &%queue_only%&                  "no immediate delivery at all"
14541 .row &%queue_only_file%&             "no immediate delivery if file exists"
14542 .row &%queue_only_load%&             "no immediate delivery if load is high"
14543 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14544 .row &%queue_only_override%&         "allow command line to override"
14545 .row &%queue_run_in_order%&          "order of arrival"
14546 .row &%queue_run_max%&               "of simultaneous queue runners"
14547 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14548 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14549 .row &%remote_sort_domains%&         "order of remote deliveries"
14550 .row &%retry_data_expire%&           "timeout for retry data"
14551 .row &%retry_interval_max%&          "safety net for retry rules"
14552 .endtable
14553
14554
14555
14556 .section "Bounce and warning messages" "SECID117"
14557 .table2
14558 .row &%bounce_message_file%&         "content of bounce"
14559 .row &%bounce_message_text%&         "content of bounce"
14560 .row &%bounce_return_body%&          "include body if returning message"
14561 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14562 .row &%bounce_return_message%&       "include original message in bounce"
14563 .row &%bounce_return_size_limit%&    "limit on returned message"
14564 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14565 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14566 .row &%errors_copy%&                 "copy bounce messages"
14567 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14568 .row &%delay_warning%&               "time schedule"
14569 .row &%delay_warning_condition%&     "condition for warning messages"
14570 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14571 .row &%smtp_return_error_details%&   "give detail on rejections"
14572 .row &%warn_message_file%&           "content of warning message"
14573 .endtable
14574
14575
14576
14577 .section "Alphabetical list of main options" "SECTalomo"
14578 Those options that undergo string expansion before use are marked with
14579 &dagger;.
14580
14581 .option accept_8bitmime main boolean true
14582 .cindex "8BITMIME"
14583 .cindex "8-bit characters"
14584 .cindex "log" "selectors"
14585 .cindex "log" "8BITMIME"
14586 This option causes Exim to send 8BITMIME in its response to an SMTP
14587 EHLO command, and to accept the BODY= parameter on MAIL commands.
14588 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14589 takes no steps to do anything special with messages received by this route.
14590
14591 Historically Exim kept this option off by default, but the maintainers
14592 feel that in today's Internet, this causes more problems than it solves.
14593 It now defaults to true.
14594 A more detailed analysis of the issues is provided by Dan Bernstein:
14595 .display
14596 &url(https://cr.yp.to/smtp/8bitmime.html)
14597 .endd
14598
14599 To log received 8BITMIME status use
14600 .code
14601 log_selector = +8bitmime
14602 .endd
14603
14604 .option acl_not_smtp main string&!! unset
14605 .cindex "&ACL;" "for non-SMTP messages"
14606 .cindex "non-SMTP messages" "ACLs for"
14607 This option defines the ACL that is run when a non-SMTP message has been
14608 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14609 further details.
14610
14611 .option acl_not_smtp_mime main string&!! unset
14612 This option defines the ACL that is run for individual MIME parts of non-SMTP
14613 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14614 SMTP messages.
14615
14616 .option acl_not_smtp_start main string&!! unset
14617 .cindex "&ACL;" "at start of non-SMTP message"
14618 .cindex "non-SMTP messages" "ACLs for"
14619 This option defines the ACL that is run before Exim starts reading a
14620 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14621
14622 .option acl_smtp_auth main string&!! unset
14623 .cindex "&ACL;" "setting up for SMTP commands"
14624 .cindex "AUTH" "ACL for"
14625 This option defines the ACL that is run when an SMTP AUTH command is
14626 received. See chapter &<<CHAPACL>>& for further details.
14627
14628 .option acl_smtp_connect main string&!! unset
14629 .cindex "&ACL;" "on SMTP connection"
14630 This option defines the ACL that is run when an SMTP connection is received.
14631 See chapter &<<CHAPACL>>& for further details.
14632
14633 .option acl_smtp_data main string&!! unset
14634 .cindex "DATA" "ACL for"
14635 This option defines the ACL that is run after an SMTP DATA command has been
14636 processed and the message itself has been received, but before the final
14637 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14638
14639 .option acl_smtp_data_prdr main string&!! accept
14640 .cindex "PRDR" "ACL for"
14641 .cindex "DATA" "PRDR ACL for"
14642 .cindex "&ACL;" "PRDR-related"
14643 .cindex "&ACL;" "per-user data processing"
14644 This option defines the ACL that,
14645 if the PRDR feature has been negotiated,
14646 is run for each recipient after an SMTP DATA command has been
14647 processed and the message itself has been received, but before the
14648 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14649
14650 .option acl_smtp_dkim main string&!! unset
14651 .cindex DKIM "ACL for"
14652 This option defines the ACL that is run for each DKIM signature
14653 (by default, or as specified in the dkim_verify_signers option)
14654 of a received message.
14655 See section &<<SECDKIMVFY>>& for further details.
14656
14657 .option acl_smtp_etrn main string&!! unset
14658 .cindex "ETRN" "ACL for"
14659 This option defines the ACL that is run when an SMTP ETRN command is
14660 received. See chapter &<<CHAPACL>>& for further details.
14661
14662 .option acl_smtp_expn main string&!! unset
14663 .cindex "EXPN" "ACL for"
14664 This option defines the ACL that is run when an SMTP EXPN command is
14665 received. See chapter &<<CHAPACL>>& for further details.
14666
14667 .option acl_smtp_helo main string&!! unset
14668 .cindex "EHLO" "ACL for"
14669 .cindex "HELO" "ACL for"
14670 This option defines the ACL that is run when an SMTP EHLO or HELO
14671 command is received. See chapter &<<CHAPACL>>& for further details.
14672
14673
14674 .option acl_smtp_mail main string&!! unset
14675 .cindex "MAIL" "ACL for"
14676 This option defines the ACL that is run when an SMTP MAIL command is
14677 received. See chapter &<<CHAPACL>>& for further details.
14678
14679 .option acl_smtp_mailauth main string&!! unset
14680 .cindex "AUTH" "on MAIL command"
14681 This option defines the ACL that is run when there is an AUTH parameter on
14682 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14683 &<<CHAPSMTPAUTH>>& for details of authentication.
14684
14685 .option acl_smtp_mime main string&!! unset
14686 .cindex "MIME content scanning" "ACL for"
14687 This option is available when Exim is built with the content-scanning
14688 extension. It defines the ACL that is run for each MIME part in a message. See
14689 section &<<SECTscanmimepart>>& for details.
14690
14691 .option acl_smtp_notquit main string&!! unset
14692 .cindex "not-QUIT, ACL for"
14693 This option defines the ACL that is run when an SMTP session
14694 ends without a QUIT command being received.
14695 See chapter &<<CHAPACL>>& for further details.
14696
14697 .option acl_smtp_predata main string&!! unset
14698 This option defines the ACL that is run when an SMTP DATA command is
14699 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14700 further details.
14701
14702 .option acl_smtp_quit main string&!! unset
14703 .cindex "QUIT, ACL for"
14704 This option defines the ACL that is run when an SMTP QUIT command is
14705 received. See chapter &<<CHAPACL>>& for further details.
14706
14707 .option acl_smtp_rcpt main string&!! unset
14708 .cindex "RCPT" "ACL for"
14709 This option defines the ACL that is run when an SMTP RCPT command is
14710 received. See chapter &<<CHAPACL>>& for further details.
14711
14712 .option acl_smtp_starttls main string&!! unset
14713 .cindex "STARTTLS, ACL for"
14714 This option defines the ACL that is run when an SMTP STARTTLS command is
14715 received. See chapter &<<CHAPACL>>& for further details.
14716
14717 .option acl_smtp_vrfy main string&!! unset
14718 .cindex "VRFY" "ACL for"
14719 This option defines the ACL that is run when an SMTP VRFY command is
14720 received. See chapter &<<CHAPACL>>& for further details.
14721
14722 .option add_environment main "string list" empty
14723 .cindex "environment" "set values"
14724 This option adds individual environment variables that the
14725 currently linked libraries and programs in child processes may use.
14726 Each list element should be of the form &"name=value"&.
14727
14728 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14729
14730 .option admin_groups main "string list&!!" unset
14731 .cindex "admin user"
14732 This option is expanded just once, at the start of Exim's processing. If the
14733 current group or any of the supplementary groups of an Exim caller is in this
14734 colon-separated list, the caller has admin privileges. If all your system
14735 programmers are in a specific group, for example, you can give them all Exim
14736 admin privileges by putting that group in &%admin_groups%&. However, this does
14737 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14738 To permit this, you have to add individuals to the Exim group.
14739
14740 .option allow_domain_literals main boolean false
14741 .cindex "domain literal"
14742 If this option is set, the RFC 2822 domain literal format is permitted in
14743 email addresses. The option is not set by default, because the domain literal
14744 format is not normally required these days, and few people know about it. It
14745 has, however, been exploited by mail abusers.
14746
14747 Unfortunately, it seems that some DNS black list maintainers are using this
14748 format to report black listing to postmasters. If you want to accept messages
14749 addressed to your hosts by IP address, you need to set
14750 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14751 domains (defined in the named domain list &%local_domains%& in the default
14752 configuration). This &"magic string"& matches the domain literal form of all
14753 the local host's IP addresses.
14754
14755
14756 .option allow_mx_to_ip main boolean false
14757 .cindex "MX record" "pointing to IP address"
14758 It appears that more and more DNS zone administrators are breaking the rules
14759 and putting domain names that look like IP addresses on the right hand side of
14760 MX records. Exim follows the rules and rejects this, giving an error message
14761 that explains the misconfiguration. However, some other MTAs support this
14762 practice, so to avoid &"Why can't Exim do this?"& complaints,
14763 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14764 recommended, except when you have no other choice.
14765
14766 .option allow_utf8_domains main boolean false
14767 .cindex "domain" "UTF-8 characters in"
14768 .cindex "UTF-8" "in domain name"
14769 Lots of discussion is going on about internationalized domain names. One
14770 camp is strongly in favour of just using UTF-8 characters, and it seems
14771 that at least two other MTAs permit this.
14772 This option allows Exim users to experiment if they wish.
14773
14774 If it is set true, Exim's domain parsing function allows valid
14775 UTF-8 multicharacters to appear in domain name components, in addition to
14776 letters, digits, and hyphens.
14777
14778 If Exim is built with internationalization support
14779 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
14780 this option can be left as default.
14781 Without that,
14782 if you want to look up such domain names in the DNS, you must also
14783 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14784 suitable setting is:
14785 .code
14786 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14787   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14788 .endd
14789 Alternatively, you can just disable this feature by setting
14790 .code
14791 dns_check_names_pattern =
14792 .endd
14793 That is, set the option to an empty string so that no check is done.
14794
14795
14796 .option auth_advertise_hosts main "host list&!!" *
14797 .cindex "authentication" "advertising"
14798 .cindex "AUTH" "advertising"
14799 If any server authentication mechanisms are configured, Exim advertises them in
14800 response to an EHLO command only if the calling host matches this list.
14801 Otherwise, Exim does not advertise AUTH.
14802 Exim does not accept AUTH commands from clients to which it has not
14803 advertised the availability of AUTH. The advertising of individual
14804 authentication mechanisms can be controlled by the use of the
14805 &%server_advertise_condition%& generic authenticator option on the individual
14806 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14807
14808 Certain mail clients (for example, Netscape) require the user to provide a name
14809 and password for authentication if AUTH is advertised, even though it may
14810 not be needed (the host may accept messages from hosts on its local LAN without
14811 authentication, for example). The &%auth_advertise_hosts%& option can be used
14812 to make these clients more friendly by excluding them from the set of hosts to
14813 which Exim advertises AUTH.
14814
14815 .cindex "AUTH" "advertising when encrypted"
14816 If you want to advertise the availability of AUTH only when the connection
14817 is encrypted using TLS, you can make use of the fact that the value of this
14818 option is expanded, with a setting like this:
14819 .code
14820 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14821 .endd
14822 .vindex "&$tls_in_cipher$&"
14823 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14824 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14825 expansion is *, which matches all hosts.
14826
14827
14828 .option auto_thaw main time 0s
14829 .cindex "thawing messages"
14830 .cindex "unfreezing messages"
14831 If this option is set to a time greater than zero, a queue runner will try a
14832 new delivery attempt on any frozen message, other than a bounce message, if
14833 this much time has passed since it was frozen. This may result in the message
14834 being re-frozen if nothing has changed since the last attempt. It is a way of
14835 saying &"keep on trying, even though there are big problems"&.
14836
14837 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14838 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14839 thought to be very useful any more, and its use should probably be avoided.
14840
14841
14842 .option av_scanner main string "see below"
14843 This option is available if Exim is built with the content-scanning extension.
14844 It specifies which anti-virus scanner to use. The default value is:
14845 .code
14846 sophie:/var/run/sophie
14847 .endd
14848 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14849 before use. See section &<<SECTscanvirus>>& for further details.
14850
14851
14852 .option bi_command main string unset
14853 .oindex "&%-bi%&"
14854 This option supplies the name of a command that is run when Exim is called with
14855 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14856 just the command name, it is not a complete command line. If an argument is
14857 required, it must come from the &%-oA%& command line option.
14858
14859
14860 .option bounce_message_file main string unset
14861 .cindex "bounce message" "customizing"
14862 .cindex "customizing" "bounce message"
14863 This option defines a template file containing paragraphs of text to be used
14864 for constructing bounce messages.  Details of the file's contents are given in
14865 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14866
14867
14868 .option bounce_message_text main string unset
14869 When this option is set, its contents are included in the default bounce
14870 message immediately after &"This message was created automatically by mail
14871 delivery software."& It is not used if &%bounce_message_file%& is set.
14872
14873 .option bounce_return_body main boolean true
14874 .cindex "bounce message" "including body"
14875 This option controls whether the body of an incoming message is included in a
14876 bounce message when &%bounce_return_message%& is true. The default setting
14877 causes the entire message, both header and body, to be returned (subject to the
14878 value of &%bounce_return_size_limit%&). If this option is false, only the
14879 message header is included. In the case of a non-SMTP message containing an
14880 error that is detected during reception, only those header lines preceding the
14881 point at which the error was detected are returned.
14882 .cindex "bounce message" "including original"
14883
14884 .option bounce_return_linesize_limit main integer 998
14885 .cindex "size" "of bounce lines, limit"
14886 .cindex "bounce message" "line length limit"
14887 .cindex "limit" "bounce message line length"
14888 This option sets a limit in bytes on the line length of messages
14889 that are returned to senders due to delivery problems,
14890 when &%bounce_return_message%& is true.
14891 The default value corresponds to RFC limits.
14892 If the message being returned has lines longer than this value it is
14893 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14894
14895 The option also applies to bounces returned when an error is detected
14896 during reception of a message.
14897 In this case lines from the original are truncated.
14898
14899 The option does not apply to messages generated by an &(autoreply)& transport.
14900
14901
14902 .option bounce_return_message main boolean true
14903 If this option is set false, none of the original message is included in
14904 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14905 &%bounce_return_body%&.
14906
14907
14908 .option bounce_return_size_limit main integer 100K
14909 .cindex "size" "of bounce, limit"
14910 .cindex "bounce message" "size limit"
14911 .cindex "limit" "bounce message size"
14912 This option sets a limit in bytes on the size of messages that are returned to
14913 senders as part of bounce messages when &%bounce_return_message%& is true. The
14914 limit should be less than the value of the global &%message_size_limit%& and of
14915 any &%message_size_limit%& settings on transports, to allow for the bounce text
14916 that Exim generates. If this option is set to zero there is no limit.
14917
14918 When the body of any message that is to be included in a bounce message is
14919 greater than the limit, it is truncated, and a comment pointing this out is
14920 added at the top. The actual cutoff may be greater than the value given, owing
14921 to the use of buffering for transferring the message in chunks (typically 8K in
14922 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14923 messages.
14924
14925 .option bounce_sender_authentication main string unset
14926 .cindex "bounce message" "sender authentication"
14927 .cindex "authentication" "bounce message"
14928 .cindex "AUTH" "on bounce message"
14929 This option provides an authenticated sender address that is sent with any
14930 bounce messages generated by Exim that are sent over an authenticated SMTP
14931 connection. A typical setting might be:
14932 .code
14933 bounce_sender_authentication = mailer-daemon@my.domain.example
14934 .endd
14935 which would cause bounce messages to be sent using the SMTP command:
14936 .code
14937 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14938 .endd
14939 The value of &%bounce_sender_authentication%& must always be a complete email
14940 address.
14941
14942 .option callout_domain_negative_expire main time 3h
14943 .cindex "caching" "callout timeouts"
14944 .cindex "callout" "caching timeouts"
14945 This option specifies the expiry time for negative callout cache data for a
14946 domain. See section &<<SECTcallver>>& for details of callout verification, and
14947 section &<<SECTcallvercache>>& for details of the caching.
14948
14949
14950 .option callout_domain_positive_expire main time 7d
14951 This option specifies the expiry time for positive callout cache data for a
14952 domain. See section &<<SECTcallver>>& for details of callout verification, and
14953 section &<<SECTcallvercache>>& for details of the caching.
14954
14955
14956 .option callout_negative_expire main time 2h
14957 This option specifies the expiry time for negative callout cache data for an
14958 address. See section &<<SECTcallver>>& for details of callout verification, and
14959 section &<<SECTcallvercache>>& for details of the caching.
14960
14961
14962 .option callout_positive_expire main time 24h
14963 This option specifies the expiry time for positive callout cache data for an
14964 address. See section &<<SECTcallver>>& for details of callout verification, and
14965 section &<<SECTcallvercache>>& for details of the caching.
14966
14967
14968 .option callout_random_local_part main string&!! "see below"
14969 This option defines the &"random"& local part that can be used as part of
14970 callout verification. The default value is
14971 .code
14972 $primary_hostname-$tod_epoch-testing
14973 .endd
14974 See section &<<CALLaddparcall>>& for details of how this value is used.
14975
14976
14977 .option check_log_inodes main integer 100
14978 See &%check_spool_space%& below.
14979
14980
14981 .option check_log_space main integer 10M
14982 See &%check_spool_space%& below.
14983
14984 .oindex "&%check_rfc2047_length%&"
14985 .cindex "RFC 2047" "disabling length check"
14986 .option check_rfc2047_length main boolean true
14987 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14988 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14989 word; strings to be encoded that exceed this length are supposed to use
14990 multiple encoded words. By default, Exim does not recognize encoded words that
14991 exceed the maximum length. However, it seems that some software, in violation
14992 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14993 set false, Exim recognizes encoded words of any length.
14994
14995
14996 .option check_spool_inodes main integer 100
14997 See &%check_spool_space%& below.
14998
14999
15000 .option check_spool_space main integer 10M
15001 .cindex "checking disk space"
15002 .cindex "disk space, checking"
15003 .cindex "spool directory" "checking space"
15004 The four &%check_...%& options allow for checking of disk resources before a
15005 message is accepted.
15006
15007 .vindex "&$log_inodes$&"
15008 .vindex "&$log_space$&"
15009 .vindex "&$spool_inodes$&"
15010 .vindex "&$spool_space$&"
15011 When any of these options are nonzero, they apply to all incoming messages. If you
15012 want to apply different checks to different kinds of message, you can do so by
15013 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15014 &$spool_space$& in an ACL with appropriate additional conditions.
15015
15016
15017 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15018 either value is greater than zero, for example:
15019 .code
15020 check_spool_space = 100M
15021 check_spool_inodes = 100
15022 .endd
15023 The spool partition is the one that contains the directory defined by
15024 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15025 transit.
15026
15027 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15028 files are written if either is greater than zero. These should be set only if
15029 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15030
15031 If there is less space or fewer inodes than requested, Exim refuses to accept
15032 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15033 error response to the MAIL command. If ESMTP is in use and there was a
15034 SIZE parameter on the MAIL command, its value is added to the
15035 &%check_spool_space%& value, and the check is performed even if
15036 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15037
15038 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15039 number of kilobytes (though specified in bytes).
15040 If a non-multiple of 1024 is specified, it is rounded up.
15041
15042 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15043 failure a message is written to stderr and Exim exits with a non-zero code, as
15044 it obviously cannot send an error message of any kind.
15045
15046 There is a slight performance penalty for these checks.
15047 Versions of Exim preceding 4.88 had these disabled by default;
15048 high-rate installations confident they will never run out of resources
15049 may wish to deliberately disable them.
15050
15051 .option chunking_advertise_hosts main "host list&!!" *
15052 .cindex CHUNKING advertisement
15053 .cindex "RFC 3030" "CHUNKING"
15054 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15055 these hosts.
15056 Hosts may use the BDAT command as an alternate to DATA.
15057
15058 .option commandline_checks_require_admin main boolean &`false`&
15059 .cindex "restricting access to features"
15060 This option restricts various basic checking features to require an
15061 administrative user.
15062 This affects most of the &%-b*%& options, such as &%-be%&.
15063
15064 .option debug_store main boolean &`false`&
15065 .cindex debugging "memory corruption"
15066 .cindex memory debugging
15067 This option, when true, enables extra checking in Exim's internal memory
15068 management.  For use when a memory corruption issue is being investigated,
15069 it should normally be left as default.
15070
15071 .option daemon_smtp_ports main string &`smtp`&
15072 .cindex "port" "for daemon"
15073 .cindex "TCP/IP" "setting listening ports"
15074 This option specifies one or more default SMTP ports on which the Exim daemon
15075 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15076 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15077
15078 .option daemon_startup_retries main integer 9
15079 .cindex "daemon startup, retrying"
15080 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15081 the daemon at startup when it cannot immediately bind a listening socket
15082 (typically because the socket is already in use): &%daemon_startup_retries%&
15083 defines the number of retries after the first failure, and
15084 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15085
15086 .option daemon_startup_sleep main time 30s
15087 See &%daemon_startup_retries%&.
15088
15089 .option delay_warning main "time list" 24h
15090 .cindex "warning of delay"
15091 .cindex "delay warning, specifying"
15092 .cindex "queue" "delay warning"
15093 When a message is delayed, Exim sends a warning message to the sender at
15094 intervals specified by this option. The data is a colon-separated list of times
15095 after which to send warning messages. If the value of the option is an empty
15096 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15097 message has been in the queue for longer than the last time, the last interval
15098 between the times is used to compute subsequent warning times. For example,
15099 with
15100 .code
15101 delay_warning = 4h:8h:24h
15102 .endd
15103 the first message is sent after 4 hours, the second after 8 hours, and
15104 the third one after 24 hours. After that, messages are sent every 16 hours,
15105 because that is the interval between the last two times on the list. If you set
15106 just one time, it specifies the repeat interval. For example, with:
15107 .code
15108 delay_warning = 6h
15109 .endd
15110 messages are repeated every six hours. To stop warnings after a given time, set
15111 a very large time at the end of the list. For example:
15112 .code
15113 delay_warning = 2h:12h:99d
15114 .endd
15115 Note that the option is only evaluated at the time a delivery attempt fails,
15116 which depends on retry and queue-runner configuration.
15117 Typically retries will be configured more frequently than warning messages.
15118
15119 .option delay_warning_condition main string&!! "see below"
15120 .vindex "&$domain$&"
15121 The string is expanded at the time a warning message might be sent. If all the
15122 deferred addresses have the same domain, it is set in &$domain$& during the
15123 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15124 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15125 &"false"& (the comparison being done caselessly) then the warning message is
15126 not sent. The default is:
15127 .code
15128 delay_warning_condition = ${if or {\
15129   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15130   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15131   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15132   } {no}{yes}}
15133 .endd
15134 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15135 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15136 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15137 &"auto-replied"& in an &'Auto-Submitted:'& header.
15138
15139 .option deliver_drop_privilege main boolean false
15140 .cindex "unprivileged delivery"
15141 .cindex "delivery" "unprivileged"
15142 If this option is set true, Exim drops its root privilege at the start of a
15143 delivery process, and runs as the Exim user throughout. This severely restricts
15144 the kinds of local delivery that are possible, but is viable in certain types
15145 of configuration. There is a discussion about the use of root privilege in
15146 chapter &<<CHAPsecurity>>&.
15147
15148 .option deliver_queue_load_max main fixed-point unset
15149 .cindex "load average"
15150 .cindex "queue runner" "abandoning"
15151 When this option is set, a queue run is abandoned if the system load average
15152 becomes greater than the value of the option. The option has no effect on
15153 ancient operating systems on which Exim cannot determine the load average.
15154 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15155
15156
15157 .option delivery_date_remove main boolean true
15158 .cindex "&'Delivery-date:'& header line"
15159 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15160 message when it is delivered, in exactly the same way as &'Return-path:'& is
15161 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15162 should not be present in incoming messages, and this option causes them to be
15163 removed at the time the message is received, to avoid any problems that might
15164 occur when a delivered message is subsequently sent on to some other recipient.
15165
15166 .option disable_fsync main boolean false
15167 .cindex "&[fsync()]&, disabling"
15168 This option is available only if Exim was built with the compile-time option
15169 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15170 a runtime configuration generates an &"unknown option"& error. You should not
15171 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15172 really, really, really understand what you are doing. &'No pre-compiled
15173 distributions of Exim should ever make this option available.'&
15174
15175 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15176 updated files' data to be written to disc before continuing. Unexpected events
15177 such as crashes and power outages may cause data to be lost or scrambled.
15178 Here be Dragons. &*Beware.*&
15179
15180
15181 .option disable_ipv6 main boolean false
15182 .cindex "IPv6" "disabling"
15183 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15184 activities take place. AAAA records are never looked up, and any IPv6 addresses
15185 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15186 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15187 to handle IPv6 literal addresses.
15188
15189
15190 .new
15191 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15192 .cindex DKIM "selecting signature algorithms"
15193 This option gives a list of hash types which are acceptable in signatures,
15194 .wen
15195 and an order of processing.
15196 Signatures with algorithms not in the list will be ignored.
15197
15198 Acceptable values include:
15199 .code
15200 sha1
15201 sha256
15202 sha512
15203 .endd
15204
15205 Note that the acceptance of sha1 violates RFC 8301.
15206
15207 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15208 This option gives a list of key types which are acceptable in signatures,
15209 and an order of processing.
15210 Signatures with algorithms not in the list will be ignored.
15211
15212 .option dkim_verify_minimal main boolean false
15213 If set to true, verification of signatures will terminate after the
15214 first success.
15215
15216 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15217 .cindex DKIM "controlling calls to the ACL"
15218 This option gives a list of DKIM domains for which the DKIM ACL is run.
15219 It is expanded after the message is received; by default it runs
15220 the ACL once for each signature in the message.
15221 See section &<<SECDKIMVFY>>&.
15222
15223
15224 .option dns_again_means_nonexist main "domain list&!!" unset
15225 .cindex "DNS" "&""try again""& response; overriding"
15226 DNS lookups give a &"try again"& response for the DNS errors
15227 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15228 keep trying to deliver a message, or to give repeated temporary errors to
15229 incoming mail. Sometimes the effect is caused by a badly set up name server and
15230 may persist for a long time. If a domain which exhibits this problem matches
15231 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15232 This option should be used with care. You can make it apply to reverse lookups
15233 by a setting such as this:
15234 .code
15235 dns_again_means_nonexist = *.in-addr.arpa
15236 .endd
15237 This option applies to all DNS lookups that Exim does. It also applies when the
15238 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15239 since these are most likely to be caused by DNS lookup problems. The
15240 &(dnslookup)& router has some options of its own for controlling what happens
15241 when lookups for MX or SRV records give temporary errors. These more specific
15242 options are applied after this global option.
15243
15244 .option dns_check_names_pattern main string "see below"
15245 .cindex "DNS" "pre-check of name syntax"
15246 When this option is set to a non-empty string, it causes Exim to check domain
15247 names for characters that are not allowed in host names before handing them to
15248 the DNS resolver, because some resolvers give temporary errors for names that
15249 contain unusual characters. If a domain name contains any unwanted characters,
15250 a &"not found"& result is forced, and the resolver is not called. The check is
15251 done by matching the domain name against a regular expression, which is the
15252 value of this option. The default pattern is
15253 .code
15254 dns_check_names_pattern = \
15255   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15256 .endd
15257 which permits only letters, digits, slashes, and hyphens in components, but
15258 they must start and end with a letter or digit. Slashes are not, in fact,
15259 permitted in host names, but they are found in certain NS records (which can be
15260 accessed in Exim by using a &%dnsdb%& lookup). If you set
15261 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15262 empty string.
15263
15264 .option dns_csa_search_limit main integer 5
15265 This option controls the depth of parental searching for CSA SRV records in the
15266 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15267
15268 .option dns_csa_use_reverse main boolean true
15269 This option controls whether or not an IP address, given as a CSA domain, is
15270 reversed and looked up in the reverse DNS, as described in more detail in
15271 section &<<SECTverifyCSA>>&.
15272
15273 .option dns_cname_loops main integer 1
15274 .cindex DNS "CNAME following"
15275 This option controls the following of CNAME chains, needed if the resolver does
15276 not do it internally.
15277 As of 2018 most should, and the default can be left.
15278 If you have an ancient one, a value of 10 is likely needed.
15279
15280 The default value of one CNAME-follow is needed
15281 thanks to the observed return for an MX request,
15282 given no MX presence but a CNAME to an A, of the CNAME.
15283
15284
15285 .option dns_dnssec_ok main integer -1
15286 .cindex "DNS" "resolver options"
15287 .cindex "DNS" "DNSSEC"
15288 If this option is set to a non-negative number then Exim will initialise the
15289 DNS resolver library to either use or not use DNSSEC, overriding the system
15290 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15291
15292 If the resolver library does not support DNSSEC then this option has no effect.
15293
15294
15295 .option dns_ipv4_lookup main "domain list&!!" unset
15296 .cindex "IPv6" "DNS lookup for AAAA records"
15297 .cindex "DNS" "IPv6 lookup for AAAA records"
15298 .cindex DNS "IPv6 disabling"
15299 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15300 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15301 (A records) when trying to find IP addresses for hosts, unless the host's
15302 domain matches this list.
15303
15304 This is a fudge to help with name servers that give big delays or otherwise do
15305 not work for the AAAA record type. In due course, when the world's name
15306 servers have all been upgraded, there should be no need for this option.
15307 Note that all lookups, including those done for verification, are affected;
15308 this will result in verify failure for IPv6 connections or ones using names
15309 only valid for IPv6 addresses.
15310
15311
15312 .option dns_retrans main time 0s
15313 .cindex "DNS" "resolver options"
15314 .cindex timeout "dns lookup"
15315 .cindex "DNS" timeout
15316 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15317 retransmission and retry parameters for DNS lookups. Values of zero (the
15318 defaults) leave the system default settings unchanged. The first value is the
15319 time between retries, and the second is the number of retries. It isn't
15320 totally clear exactly how these settings affect the total time a DNS lookup may
15321 take. I haven't found any documentation about timeouts on DNS lookups; these
15322 parameter values are available in the external resolver interface structure,
15323 but nowhere does it seem to describe how they are used or what you might want
15324 to set in them.
15325 See also the &%slow_lookup_log%& option.
15326
15327
15328 .option dns_retry main integer 0
15329 See &%dns_retrans%& above.
15330
15331
15332 .option dns_trust_aa main "domain list&!!" unset
15333 .cindex "DNS" "resolver options"
15334 .cindex "DNS" "DNSSEC"
15335 If this option is set then lookup results marked with the AA bit
15336 (Authoritative Answer) are trusted the same way as if they were
15337 DNSSEC-verified. The authority section's name of the answer must
15338 match with this expanded domain list.
15339
15340 Use this option only if you talk directly to a resolver that is
15341 authoritative for some zones and does not set the AD (Authentic Data)
15342 bit in the answer. Some DNS servers may have an configuration option to
15343 mark the answers from their own zones as verified (they set the AD bit).
15344 Others do not have this option. It is considered as poor practice using
15345 a resolver that is an authoritative server for some zones.
15346
15347 Use this option only if you really have to (e.g. if you want
15348 to use DANE for remote delivery to a server that is listed in the DNS
15349 zones that your resolver is authoritative for).
15350
15351 If the DNS answer packet has the AA bit set and contains resource record
15352 in the answer section, the name of the first NS record appearing in the
15353 authority section is compared against the list. If the answer packet is
15354 authoritative but the answer section is empty, the name of the first SOA
15355 record in the authoritative section is used instead.
15356
15357 .cindex "DNS" "resolver options"
15358 .option dns_use_edns0 main integer -1
15359 .cindex "DNS" "resolver options"
15360 .cindex "DNS" "EDNS0"
15361 .cindex "DNS" "OpenBSD
15362 If this option is set to a non-negative number then Exim will initialise the
15363 DNS resolver library to either use or not use EDNS0 extensions, overriding
15364 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15365 on.
15366
15367 If the resolver library does not support EDNS0 then this option has no effect.
15368
15369 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15370 means that DNSSEC will not work with Exim on that platform either, unless Exim
15371 is linked against an alternative DNS client library.
15372
15373
15374 .option drop_cr main boolean false
15375 This is an obsolete option that is now a no-op. It used to affect the way Exim
15376 handled CR and LF characters in incoming messages. What happens now is
15377 described in section &<<SECTlineendings>>&.
15378
15379 .option dsn_advertise_hosts main "host list&!!" unset
15380 .cindex "bounce messages" "success"
15381 .cindex "DSN" "success"
15382 .cindex "Delivery Status Notification" "success"
15383 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15384 and accepted from, these hosts.
15385 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15386 and RET and ORCPT options on MAIL FROM commands.
15387 A NOTIFY=SUCCESS option requests success-DSN messages.
15388 A NOTIFY= option with no argument requests that no delay or failure DSNs
15389 are sent.
15390
15391 .option dsn_from main "string&!!" "see below"
15392 .cindex "&'From:'& header line" "in bounces"
15393 .cindex "bounce messages" "&'From:'& line, specifying"
15394 This option can be used to vary the contents of &'From:'& header lines in
15395 bounces and other automatically generated messages (&"Delivery Status
15396 Notifications"& &-- hence the name of the option). The default setting is:
15397 .code
15398 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15399 .endd
15400 The value is expanded every time it is needed. If the expansion fails, a
15401 panic is logged, and the default value is used.
15402
15403 .option envelope_to_remove main boolean true
15404 .cindex "&'Envelope-to:'& header line"
15405 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15406 message when it is delivered, in exactly the same way as &'Return-path:'& is
15407 handled. &'Envelope-to:'& records the original recipient address from the
15408 message's envelope that caused the delivery to happen. Such headers should not
15409 be present in incoming messages, and this option causes them to be removed at
15410 the time the message is received, to avoid any problems that might occur when a
15411 delivered message is subsequently sent on to some other recipient.
15412
15413
15414 .option errors_copy main "string list&!!" unset
15415 .cindex "bounce message" "copy to other address"
15416 .cindex "copy of bounce message"
15417 Setting this option causes Exim to send bcc copies of bounce messages that it
15418 generates to other addresses. &*Note*&: This does not apply to bounce messages
15419 coming from elsewhere. The value of the option is a colon-separated list of
15420 items. Each item consists of a pattern, terminated by white space, followed by
15421 a comma-separated list of email addresses. If a pattern contains spaces, it
15422 must be enclosed in double quotes.
15423
15424 Each pattern is processed in the same way as a single item in an address list
15425 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15426 the bounce message, the message is copied to the addresses on the list. The
15427 items are scanned in order, and once a matching one is found, no further items
15428 are examined. For example:
15429 .code
15430 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15431               rqps@mydomain   hostmaster@mydomain.example,\
15432                               postmaster@mydomain.example
15433 .endd
15434 .vindex "&$domain$&"
15435 .vindex "&$local_part$&"
15436 The address list is expanded before use. The expansion variables &$local_part$&
15437 and &$domain$& are set from the original recipient of the error message, and if
15438 there was any wildcard matching in the pattern, the expansion
15439 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15440 variables &$0$&, &$1$&, etc. are set in the normal way.
15441
15442
15443 .option errors_reply_to main string unset
15444 .cindex "bounce message" "&'Reply-to:'& in"
15445 By default, Exim's bounce and delivery warning messages contain the header line
15446 .display
15447 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15448 .endd
15449 .oindex &%quota_warn_message%&
15450 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15451 A warning message that is generated by the &%quota_warn_message%& option in an
15452 &(appendfile)& transport may contain its own &'From:'& header line that
15453 overrides the default.
15454
15455 Experience shows that people reply to bounce messages. If the
15456 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15457 and warning messages. For example:
15458 .code
15459 errors_reply_to = postmaster@my.domain.example
15460 .endd
15461 The value of the option is not expanded. It must specify a valid RFC 2822
15462 address. However, if a warning message that is generated by the
15463 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15464 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15465 not used.
15466
15467
15468 .option event_action main string&!! unset
15469 .cindex events
15470 This option declares a string to be expanded for Exim's events mechanism.
15471 For details see chapter &<<CHAPevents>>&.
15472
15473
15474 .option exim_group main string "compile-time configured"
15475 .cindex "gid (group id)" "Exim's own"
15476 .cindex "Exim group"
15477 This option changes the gid under which Exim runs when it gives up root
15478 privilege. The default value is compiled into the binary. The value of this
15479 option is used only when &%exim_user%& is also set. Unless it consists entirely
15480 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15481 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15482 security issues.
15483
15484
15485 .option exim_path main string "see below"
15486 .cindex "Exim binary, path name"
15487 This option specifies the path name of the Exim binary, which is used when Exim
15488 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15489 the directory configured at compile time by the BIN_DIRECTORY setting. It
15490 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15491 other place.
15492 &*Warning*&: Do not use a macro to define the value of this option, because
15493 you will break those Exim utilities that scan the configuration file to find
15494 where the binary is. (They then use the &%-bP%& option to extract option
15495 settings such as the value of &%spool_directory%&.)
15496
15497
15498 .option exim_user main string "compile-time configured"
15499 .cindex "uid (user id)" "Exim's own"
15500 .cindex "Exim user"
15501 This option changes the uid under which Exim runs when it gives up root
15502 privilege. The default value is compiled into the binary. Ownership of the run
15503 time configuration file and the use of the &%-C%& and &%-D%& command line
15504 options is checked against the values in the binary, not what is set here.
15505
15506 Unless it consists entirely of digits, the string is looked up using
15507 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15508 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15509 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15510
15511
15512 .option exim_version main string "current version"
15513 .cindex "Exim version"
15514 .cindex customizing "version number"
15515 .cindex "version number of Exim" override
15516 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15517 various places.  Use with care; this may fool stupid security scanners.
15518
15519
15520 .option extra_local_interfaces main "string list" unset
15521 This option defines network interfaces that are to be considered local when
15522 routing, but which are not used for listening by the daemon. See section
15523 &<<SECTreclocipadd>>& for details.
15524
15525
15526 . Allow this long option name to split; give it unsplit as a fifth argument
15527 . for the automatic .oindex that is generated by .option.
15528
15529 .option "extract_addresses_remove_arguments" main boolean true &&&
15530          extract_addresses_remove_arguments
15531 .oindex "&%-t%&"
15532 .cindex "command line" "addresses with &%-t%&"
15533 .cindex "Sendmail compatibility" "&%-t%& option"
15534 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15535 are present on the command line when the &%-t%& option is used to build an
15536 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15537 line addresses are removed from the recipients list. This is also how Smail
15538 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15539 command line addresses are added to those obtained from the header lines. When
15540 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15541 argument headers. If it is set false, Exim adds rather than removes argument
15542 addresses.
15543
15544
15545 .option finduser_retries main integer 0
15546 .cindex "NIS, retrying user lookups"
15547 On systems running NIS or other schemes in which user and group information is
15548 distributed from a remote system, there can be times when &[getpwnam()]& and
15549 related functions fail, even when given valid data, because things time out.
15550 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15551 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15552 many extra times to find a user or a group, waiting for one second between
15553 retries.
15554
15555 .cindex "&_/etc/passwd_&" "multiple reading of"
15556 You should not set this option greater than zero if your user information is in
15557 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15558 search the file multiple times for non-existent users, and also cause delay.
15559
15560
15561
15562 .option freeze_tell main "string list, comma separated" unset
15563 .cindex "freezing messages" "sending a message when freezing"
15564 On encountering certain errors, or when configured to do so in a system filter,
15565 ACL, or special router, Exim freezes a message. This means that no further
15566 delivery attempts take place until an administrator thaws the message, or the
15567 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15568 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15569 warning message whenever it freezes something, unless the message it is
15570 freezing is a locally-generated bounce message. (Without this exception there
15571 is the possibility of looping.) The warning message is sent to the addresses
15572 supplied as the comma-separated value of this option. If several of the
15573 message's addresses cause freezing, only a single message is sent. If the
15574 freezing was automatic, the reason(s) for freezing can be found in the message
15575 log. If you configure freezing in a filter or ACL, you must arrange for any
15576 logging that you require.
15577
15578
15579 .option gecos_name main string&!! unset
15580 .cindex "HP-UX"
15581 .cindex "&""gecos""& field, parsing"
15582 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15583 password file to hold other information in addition to users' real names. Exim
15584 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15585 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15586 of the field are used unchanged, except that, if an ampersand is encountered,
15587 it is replaced by the user's login name with the first character forced to
15588 upper case, since this is a convention that is observed on many systems.
15589
15590 When these options are set, &%gecos_pattern%& is treated as a regular
15591 expression that is to be applied to the field (again with && replaced by the
15592 login name), and if it matches, &%gecos_name%& is expanded and used as the
15593 user's name.
15594
15595 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15596 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15597 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15598 name terminates at the first comma, the following can be used:
15599 .code
15600 gecos_pattern = ([^,]*)
15601 gecos_name = $1
15602 .endd
15603
15604 .option gecos_pattern main string unset
15605 See &%gecos_name%& above.
15606
15607
15608 .option gnutls_compat_mode main boolean unset
15609 This option controls whether GnuTLS is used in compatibility mode in an Exim
15610 server. This reduces security slightly, but improves interworking with older
15611 implementations of TLS.
15612
15613
15614 .option gnutls_allow_auto_pkcs11 main boolean unset
15615 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15616 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15617
15618 See
15619 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15620 for documentation.
15621
15622
15623
15624 .option headers_charset main string "see below"
15625 This option sets a default character set for translating from encoded MIME
15626 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15627 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15628 ultimate default is ISO-8859-1. For more details see the description of header
15629 insertions in section &<<SECTexpansionitems>>&.
15630
15631
15632
15633 .option header_maxsize main integer "see below"
15634 .cindex "header section" "maximum size of"
15635 .cindex "limit" "size of message header section"
15636 This option controls the overall maximum size of a message's header
15637 section. The default is the value of HEADER_MAXSIZE in
15638 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15639 sections are rejected.
15640
15641
15642 .option header_line_maxsize main integer 0
15643 .cindex "header lines" "maximum size of"
15644 .cindex "limit" "size of one header line"
15645 This option limits the length of any individual header line in a message, after
15646 all the continuations have been joined together. Messages with individual
15647 header lines that are longer than the limit are rejected. The default value of
15648 zero means &"no limit"&.
15649
15650
15651
15652
15653 .option helo_accept_junk_hosts main "host list&!!" unset
15654 .cindex "HELO" "accepting junk data"
15655 .cindex "EHLO" "accepting junk data"
15656 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15657 mail, and gives an error response for invalid data. Unfortunately, there are
15658 some SMTP clients that send syntactic junk. They can be accommodated by setting
15659 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15660 if you want to do semantic checking.
15661 See also &%helo_allow_chars%& for a way of extending the permitted character
15662 set.
15663
15664
15665 .option helo_allow_chars main string unset
15666 .cindex "HELO" "underscores in"
15667 .cindex "EHLO" "underscores in"
15668 .cindex "underscore in EHLO/HELO"
15669 This option can be set to a string of rogue characters that are permitted in
15670 all EHLO and HELO names in addition to the standard letters, digits,
15671 hyphens, and dots. If you really must allow underscores, you can set
15672 .code
15673 helo_allow_chars = _
15674 .endd
15675 Note that the value is one string, not a list.
15676
15677
15678 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15679 .cindex "HELO" "forcing reverse lookup"
15680 .cindex "EHLO" "forcing reverse lookup"
15681 If the domain given by a client in a HELO or EHLO command matches this
15682 list, a reverse lookup is done in order to establish the host's true name. The
15683 default forces a lookup if the client host gives the server's name or any of
15684 its IP addresses (in brackets), something that broken clients have been seen to
15685 do.
15686
15687
15688 .option helo_try_verify_hosts main "host list&!!" unset
15689 .cindex "HELO verifying" "optional"
15690 .cindex "EHLO" "verifying, optional"
15691 By default, Exim just checks the syntax of HELO and EHLO commands (see
15692 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15693 to do more extensive checking of the data supplied by these commands. The ACL
15694 condition &`verify = helo`& is provided to make this possible.
15695 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15696 to force the check to occur. From release 4.53 onwards, this is no longer
15697 necessary. If the check has not been done before &`verify = helo`& is
15698 encountered, it is done at that time. Consequently, this option is obsolete.
15699 Its specification is retained here for backwards compatibility.
15700
15701 When an EHLO or HELO command is received, if the calling host matches
15702 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15703 EHLO command either:
15704
15705 .ilist
15706 is an IP literal matching the calling address of the host, or
15707 .next
15708 .cindex "DNS" "reverse lookup"
15709 .cindex "reverse DNS lookup"
15710 matches the host name that Exim obtains by doing a reverse lookup of the
15711 calling host address, or
15712 .next
15713 when looked up in DNS yields the calling host address.
15714 .endlist
15715
15716 However, the EHLO or HELO command is not rejected if any of the checks
15717 fail. Processing continues, but the result of the check is remembered, and can
15718 be detected later in an ACL by the &`verify = helo`& condition.
15719
15720 If DNS was used for successful verification, the variable
15721 .cindex "DNS" "DNSSEC"
15722 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15723
15724 .option helo_verify_hosts main "host list&!!" unset
15725 .cindex "HELO verifying" "mandatory"
15726 .cindex "EHLO" "verifying, mandatory"
15727 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15728 backwards compatibility. For hosts that match this option, Exim checks the host
15729 name given in the HELO or EHLO in the same way as for
15730 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15731 rejected with a 550 error, and entries are written to the main and reject logs.
15732 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15733 error.
15734
15735 .option hold_domains main "domain list&!!" unset
15736 .cindex "domain" "delaying delivery"
15737 .cindex "delivery" "delaying certain domains"
15738 This option allows mail for particular domains to be held in the queue
15739 manually. The option is overridden if a message delivery is forced with the
15740 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15741 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15742 item in &%hold_domains%&, no routing or delivery for that address is done, and
15743 it is deferred every time the message is looked at.
15744
15745 This option is intended as a temporary operational measure for delaying the
15746 delivery of mail while some problem is being sorted out, or some new
15747 configuration tested. If you just want to delay the processing of some
15748 domains until a queue run occurs, you should use &%queue_domains%& or
15749 &%queue_smtp_domains%&, not &%hold_domains%&.
15750
15751 A setting of &%hold_domains%& does not override Exim's code for removing
15752 messages from the queue if they have been there longer than the longest retry
15753 time in any retry rule. If you want to hold messages for longer than the normal
15754 retry times, insert a dummy retry rule with a long retry time.
15755
15756
15757 .option host_lookup main "host list&!!" unset
15758 .cindex "host name" "lookup, forcing"
15759 Exim does not look up the name of a calling host from its IP address unless it
15760 is required to compare against some host list, or the host matches
15761 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15762 option (which normally contains IP addresses rather than host names). The
15763 default configuration file contains
15764 .code
15765 host_lookup = *
15766 .endd
15767 which causes a lookup to happen for all hosts. If the expense of these lookups
15768 is felt to be too great, the setting can be changed or removed.
15769
15770 After a successful reverse lookup, Exim does a forward lookup on the name it
15771 has obtained, to verify that it yields the IP address that it started with. If
15772 this check fails, Exim behaves as if the name lookup failed.
15773
15774 .vindex "&$host_lookup_failed$&"
15775 .vindex "&$sender_host_name$&"
15776 After any kind of failure, the host name (in &$sender_host_name$&) remains
15777 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15778 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15779 &`verify = reverse_host_lookup`& in ACLs.
15780
15781
15782 .option host_lookup_order main "string list" &`bydns:byaddr`&
15783 This option specifies the order of different lookup methods when Exim is trying
15784 to find a host name from an IP address. The default is to do a DNS lookup
15785 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15786 if that fails. You can change the order of these lookups, or omit one entirely,
15787 if you want.
15788
15789 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15790 multiple PTR records in the DNS and the IP address is not listed in
15791 &_/etc/hosts_&. Different operating systems give different results in this
15792 case. That is why the default tries a DNS lookup first.
15793
15794
15795
15796 .option host_reject_connection main "host list&!!" unset
15797 .cindex "host" "rejecting connections from"
15798 If this option is set, incoming SMTP calls from the hosts listed are rejected
15799 as soon as the connection is made.
15800 This option is obsolete, and retained only for backward compatibility, because
15801 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15802 connections immediately.
15803
15804 The ability to give an immediate rejection (either by this option or using an
15805 ACL) is provided for use in unusual cases. Many hosts will just try again,
15806 sometimes without much delay. Normally, it is better to use an ACL to reject
15807 incoming messages at a later stage, such as after RCPT commands. See
15808 chapter &<<CHAPACL>>&.
15809
15810
15811 .option hosts_connection_nolog main "host list&!!" unset
15812 .cindex "host" "not logging connections from"
15813 This option defines a list of hosts for which connection logging does not
15814 happen, even though the &%smtp_connection%& log selector is set. For example,
15815 you might want not to log SMTP connections from local processes, or from
15816 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15817 the daemon; you should therefore strive to restrict its value to a short inline
15818 list of IP addresses and networks. To disable logging SMTP connections from
15819 local processes, you must create a host list with an empty item. For example:
15820 .code
15821 hosts_connection_nolog = :
15822 .endd
15823 If the &%smtp_connection%& log selector is not set, this option has no effect.
15824
15825
15826
15827 .option hosts_proxy main "host list&!!" unset
15828 .cindex proxy "proxy protocol"
15829 This option enables use of Proxy Protocol proxies for incoming
15830 connections.  For details see section &<<SECTproxyInbound>>&.
15831
15832
15833 .option hosts_treat_as_local main "domain list&!!" unset
15834 .cindex "local host" "domains treated as"
15835 .cindex "host" "treated as local"
15836 If this option is set, any host names that match the domain list are treated as
15837 if they were the local host when Exim is scanning host lists obtained from MX
15838 records
15839 or other sources. Note that the value of this option is a domain list, not a
15840 host list, because it is always used to check host names, not IP addresses.
15841
15842 This option also applies when Exim is matching the special items
15843 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15844 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15845 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15846 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15847 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15848 interfaces and recognizing the local host.
15849
15850
15851 .option ibase_servers main "string list" unset
15852 .cindex "InterBase" "server list"
15853 This option provides a list of InterBase servers and associated connection data,
15854 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15855 The option is available only if Exim has been built with InterBase support.
15856
15857
15858
15859 .option ignore_bounce_errors_after main time 10w
15860 .cindex "bounce message" "discarding"
15861 .cindex "discarding bounce message"
15862 This option affects the processing of bounce messages that cannot be delivered,
15863 that is, those that suffer a permanent delivery failure. (Bounce messages that
15864 suffer temporary delivery failures are of course retried in the usual way.)
15865
15866 After a permanent delivery failure, bounce messages are frozen,
15867 because there is no sender to whom they can be returned. When a frozen bounce
15868 message has been in the queue for more than the given time, it is unfrozen at
15869 the next queue run, and a further delivery is attempted. If delivery fails
15870 again, the bounce message is discarded. This makes it possible to keep failed
15871 bounce messages around for a shorter time than the normal maximum retry time
15872 for frozen messages. For example,
15873 .code
15874 ignore_bounce_errors_after = 12h
15875 .endd
15876 retries failed bounce message deliveries after 12 hours, discarding any further
15877 failures. If the value of this option is set to a zero time period, bounce
15878 failures are discarded immediately. Setting a very long time (as in the default
15879 value) has the effect of disabling this option. For ways of automatically
15880 dealing with other kinds of frozen message, see &%auto_thaw%& and
15881 &%timeout_frozen_after%&.
15882
15883
15884 .option ignore_fromline_hosts main "host list&!!" unset
15885 .cindex "&""From""& line"
15886 .cindex "UUCP" "&""From""& line"
15887 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15888 the headers of a message. By default this is treated as the start of the
15889 message's body, which means that any following headers are not recognized as
15890 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15891 match those hosts that insist on sending it. If the sender is actually a local
15892 process rather than a remote host, and is using &%-bs%& to inject the messages,
15893 &%ignore_fromline_local%& must be set to achieve this effect.
15894
15895
15896 .option ignore_fromline_local main boolean false
15897 See &%ignore_fromline_hosts%& above.
15898
15899 .option keep_environment main "string list" unset
15900 .cindex "environment" "values from"
15901 This option contains a string list of environment variables to keep.
15902 You have to trust these variables or you have to be sure that
15903 these variables do not impose any security risk. Keep in mind that
15904 during the startup phase Exim is running with an effective UID 0 in most
15905 installations. As the default value is an empty list, the default
15906 environment for using libraries, running embedded Perl code, or running
15907 external binaries is empty, and does not not even contain PATH or HOME.
15908
15909 Actually the list is interpreted as a list of patterns
15910 (&<<SECTlistexpand>>&), except that it is not expanded first.
15911
15912 WARNING: Macro substitution is still done first, so having a macro
15913 FOO and having FOO_HOME in your &%keep_environment%& option may have
15914 unexpected results. You may work around this using a regular expression
15915 that does not match the macro name: ^[F]OO_HOME$.
15916
15917 Current versions of Exim issue a warning during startup if you do not mention
15918 &%keep_environment%& in your runtime configuration file and if your
15919 current environment is not empty. Future versions may not issue that warning
15920 anymore.
15921
15922 See the &%add_environment%& main config option for a way to set
15923 environment variables to a fixed value.  The environment for &(pipe)&
15924 transports is handled separately, see section &<<SECTpipeenv>>& for
15925 details.
15926
15927
15928 .option keep_malformed main time 4d
15929 This option specifies the length of time to keep messages whose spool files
15930 have been corrupted in some way. This should, of course, never happen. At the
15931 next attempt to deliver such a message, it gets removed. The incident is
15932 logged.
15933
15934
15935 .option ldap_ca_cert_dir main string unset
15936 .cindex "LDAP", "TLS CA certificate directory"
15937 .cindex certificate "directory for LDAP"
15938 This option indicates which directory contains CA certificates for verifying
15939 a TLS certificate presented by an LDAP server.
15940 While Exim does not provide a default value, your SSL library may.
15941 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15942 and constrained to be a directory.
15943
15944
15945 .option ldap_ca_cert_file main string unset
15946 .cindex "LDAP", "TLS CA certificate file"
15947 .cindex certificate "file for LDAP"
15948 This option indicates which file contains CA certificates for verifying
15949 a TLS certificate presented by an LDAP server.
15950 While Exim does not provide a default value, your SSL library may.
15951 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15952 and constrained to be a file.
15953
15954
15955 .option ldap_cert_file main string unset
15956 .cindex "LDAP" "TLS client certificate file"
15957 .cindex certificate "file for LDAP"
15958 This option indicates which file contains an TLS client certificate which
15959 Exim should present to the LDAP server during TLS negotiation.
15960 Should be used together with &%ldap_cert_key%&.
15961
15962
15963 .option ldap_cert_key main string unset
15964 .cindex "LDAP" "TLS client key file"
15965 .cindex certificate "key for LDAP"
15966 This option indicates which file contains the secret/private key to use
15967 to prove identity to the LDAP server during TLS negotiation.
15968 Should be used together with &%ldap_cert_file%&, which contains the
15969 identity to be proven.
15970
15971
15972 .option ldap_cipher_suite main string unset
15973 .cindex "LDAP" "TLS cipher suite"
15974 This controls the TLS cipher-suite negotiation during TLS negotiation with
15975 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15976 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15977
15978
15979 .option ldap_default_servers main "string list" unset
15980 .cindex "LDAP" "default servers"
15981 This option provides a list of LDAP servers which are tried in turn when an
15982 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15983 details of LDAP queries. This option is available only when Exim has been built
15984 with LDAP support.
15985
15986
15987 .option ldap_require_cert main string unset.
15988 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15989 This should be one of the values "hard", "demand", "allow", "try" or "never".
15990 A value other than one of these is interpreted as "never".
15991 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15992 Although Exim does not set a default, the LDAP library probably defaults
15993 to hard/demand.
15994
15995
15996 .option ldap_start_tls main boolean false
15997 .cindex "LDAP" "whether or not to negotiate TLS"
15998 If set, Exim will attempt to negotiate TLS with the LDAP server when
15999 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16000 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16001 of SSL-on-connect.
16002 In the event of failure to negotiate TLS, the action taken is controlled
16003 by &%ldap_require_cert%&.
16004 This option is ignored for &`ldapi`& connections.
16005
16006
16007 .option ldap_version main integer unset
16008 .cindex "LDAP" "protocol version, forcing"
16009 This option can be used to force Exim to set a specific protocol version for
16010 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16011 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16012 the LDAP headers; otherwise it is 2. This option is available only when Exim
16013 has been built with LDAP support.
16014
16015
16016
16017 .option local_from_check main boolean true
16018 .cindex "&'Sender:'& header line" "disabling addition of"
16019 .cindex "&'From:'& header line" "disabling checking of"
16020 When a message is submitted locally (that is, not over a TCP/IP connection) by
16021 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16022 checks that the &'From:'& header line matches the login of the calling user and
16023 the domain specified by &%qualify_domain%&.
16024
16025 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16026 locally submitted message is automatically qualified by Exim, unless the
16027 &%-bnq%& command line option is used.
16028
16029 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16030 on the local part. If the &'From:'& header line does not match, Exim adds a
16031 &'Sender:'& header with an address constructed from the calling user's login
16032 and the default qualify domain.
16033
16034 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16035 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16036 &'Sender:'& header lines supplied by untrusted users, you must also set
16037 &%local_sender_retain%& to be true.
16038
16039 .cindex "envelope from"
16040 .cindex "envelope sender"
16041 These options affect only the header lines in the message. The envelope sender
16042 is still forced to be the login id at the qualify domain unless
16043 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16044
16045 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16046 request similar header line checking. See section &<<SECTthesenhea>>&, which
16047 has more details about &'Sender:'& processing.
16048
16049
16050
16051
16052 .option local_from_prefix main string unset
16053 When Exim checks the &'From:'& header line of locally submitted messages for
16054 matching the login id (see &%local_from_check%& above), it can be configured to
16055 ignore certain prefixes and suffixes in the local part of the address. This is
16056 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16057 appropriate lists, in the same form as the &%local_part_prefix%& and
16058 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16059 example, if
16060 .code
16061 local_from_prefix = *-
16062 .endd
16063 is set, a &'From:'& line containing
16064 .code
16065 From: anything-user@your.domain.example
16066 .endd
16067 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16068 matches the actual sender address that is constructed from the login name and
16069 qualify domain.
16070
16071
16072 .option local_from_suffix main string unset
16073 See &%local_from_prefix%& above.
16074
16075
16076 .option local_interfaces main "string list" "see below"
16077 This option controls which network interfaces are used by the daemon for
16078 listening; they are also used to identify the local host when routing. Chapter
16079 &<<CHAPinterfaces>>& contains a full description of this option and the related
16080 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16081 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16082 &%local_interfaces%& is
16083 .code
16084 local_interfaces = 0.0.0.0
16085 .endd
16086 when Exim is built without IPv6 support; otherwise it is
16087 .code
16088 local_interfaces = <; ::0 ; 0.0.0.0
16089 .endd
16090
16091 .option local_scan_timeout main time 5m
16092 .cindex "timeout" "for &[local_scan()]& function"
16093 .cindex "&[local_scan()]& function" "timeout"
16094 This timeout applies to the &[local_scan()]& function (see chapter
16095 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16096 the incoming message is rejected with a temporary error if it is an SMTP
16097 message. For a non-SMTP message, the message is dropped and Exim ends with a
16098 non-zero code. The incident is logged on the main and reject logs.
16099
16100
16101
16102 .option local_sender_retain main boolean false
16103 .cindex "&'Sender:'& header line" "retaining from local submission"
16104 When a message is submitted locally (that is, not over a TCP/IP connection) by
16105 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16106 do not want this to happen, you must set &%local_sender_retain%&, and you must
16107 also set &%local_from_check%& to be false (Exim will complain if you do not).
16108 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16109 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16110
16111
16112
16113
16114 .option localhost_number main string&!! unset
16115 .cindex "host" "locally unique number for"
16116 .cindex "message ids" "with multiple hosts"
16117 .vindex "&$localhost_number$&"
16118 Exim's message ids are normally unique only within the local host. If
16119 uniqueness among a set of hosts is required, each host must set a different
16120 value for the &%localhost_number%& option. The string is expanded immediately
16121 after reading the configuration file (so that a number can be computed from the
16122 host name, for example) and the result of the expansion must be a number in the
16123 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16124 systems). This is available in subsequent string expansions via the variable
16125 &$localhost_number$&. When &%localhost_number is set%&, the final two
16126 characters of the message id, instead of just being a fractional part of the
16127 time, are computed from the time and the local host number as described in
16128 section &<<SECTmessiden>>&.
16129
16130
16131
16132 .option log_file_path main "string list&!!" "set at compile time"
16133 .cindex "log" "file path for"
16134 This option sets the path which is used to determine the names of Exim's log
16135 files, or indicates that logging is to be to syslog, or both. It is expanded
16136 when Exim is entered, so it can, for example, contain a reference to the host
16137 name. If no specific path is set for the log files at compile or runtime,
16138 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16139 they are written in a sub-directory called &_log_& in Exim's spool directory.
16140 A path must start with a slash.
16141 To send to syslog, use the word &"syslog"&.
16142 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16143 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16144 used. If this string is fixed at your installation (contains no expansion
16145 variables) it is recommended that you do not set this option in the
16146 configuration file, but instead supply the path using LOG_FILE_PATH in
16147 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16148 early on &-- in particular, failure to read the configuration file.
16149
16150
16151 .option log_selector main string unset
16152 .cindex "log" "selectors"
16153 This option can be used to reduce or increase the number of things that Exim
16154 writes to its log files. Its argument is made up of names preceded by plus or
16155 minus characters. For example:
16156 .code
16157 log_selector = +arguments -retry_defer
16158 .endd
16159 A list of possible names and what they control is given in the chapter on
16160 logging, in section &<<SECTlogselector>>&.
16161
16162
16163 .option log_timezone main boolean false
16164 .cindex "log" "timezone for entries"
16165 .vindex "&$tod_log$&"
16166 .vindex "&$tod_zone$&"
16167 By default, the timestamps on log lines are in local time without the
16168 timezone. This means that if your timezone changes twice a year, the timestamps
16169 in log lines are ambiguous for an hour when the clocks go back. One way of
16170 avoiding this problem is to set the timezone to UTC. An alternative is to set
16171 &%log_timezone%& true. This turns on the addition of the timezone offset to
16172 timestamps in log lines. Turning on this option can add quite a lot to the size
16173 of log files because each line is extended by 6 characters. Note that the
16174 &$tod_log$& variable contains the log timestamp without the zone, but there is
16175 another variable called &$tod_zone$& that contains just the timezone offset.
16176
16177
16178 .option lookup_open_max main integer 25
16179 .cindex "too many open files"
16180 .cindex "open files, too many"
16181 .cindex "file" "too many open"
16182 .cindex "lookup" "maximum open files"
16183 .cindex "limit" "open files for lookups"
16184 This option limits the number of simultaneously open files for single-key
16185 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16186 Exim normally keeps these files open during routing, because often the same
16187 file is required several times. If the limit is reached, Exim closes the least
16188 recently used file. Note that if you are using the &'ndbm'& library, it
16189 actually opens two files for each logical DBM database, though it still counts
16190 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16191 open files"& errors with NDBM, you need to reduce the value of
16192 &%lookup_open_max%&.
16193
16194
16195 .option max_username_length main integer 0
16196 .cindex "length of login name"
16197 .cindex "user name" "maximum length"
16198 .cindex "limit" "user name length"
16199 Some operating systems are broken in that they truncate long arguments to
16200 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16201 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16202 an argument that is longer behaves as if &[getpwnam()]& failed.
16203
16204
16205 .option message_body_newlines main bool false
16206 .cindex "message body" "newlines in variables"
16207 .cindex "newline" "in message body variables"
16208 .vindex "&$message_body$&"
16209 .vindex "&$message_body_end$&"
16210 By default, newlines in the message body are replaced by spaces when setting
16211 the &$message_body$& and &$message_body_end$& expansion variables. If this
16212 option is set true, this no longer happens.
16213
16214
16215 .option message_body_visible main integer 500
16216 .cindex "body of message" "visible size"
16217 .cindex "message body" "visible size"
16218 .vindex "&$message_body$&"
16219 .vindex "&$message_body_end$&"
16220 This option specifies how much of a message's body is to be included in the
16221 &$message_body$& and &$message_body_end$& expansion variables.
16222
16223
16224 .option message_id_header_domain main string&!! unset
16225 .cindex "&'Message-ID:'& header line"
16226 If this option is set, the string is expanded and used as the right hand side
16227 (domain) of the &'Message-ID:'& header that Exim creates if a
16228 locally-originated incoming message does not have one. &"Locally-originated"&
16229 means &"not received over TCP/IP."&
16230 Otherwise, the primary host name is used.
16231 Only letters, digits, dot and hyphen are accepted; any other characters are
16232 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16233 empty string, the option is ignored.
16234
16235
16236 .option message_id_header_text main string&!! unset
16237 If this variable is set, the string is expanded and used to augment the text of
16238 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16239 message does not have one. The text of this header is required by RFC 2822 to
16240 take the form of an address. By default, Exim uses its internal message id as
16241 the local part, and the primary host name as the domain. If this option is set,
16242 it is expanded, and provided the expansion is not forced to fail, and does not
16243 yield an empty string, the result is inserted into the header immediately
16244 before the @, separated from the internal message id by a dot. Any characters
16245 that are illegal in an address are automatically converted into hyphens. This
16246 means that variables such as &$tod_log$& can be used, because the spaces and
16247 colons will become hyphens.
16248
16249
16250 .option message_logs main boolean true
16251 .cindex "message logs" "disabling"
16252 .cindex "log" "message log; disabling"
16253 If this option is turned off, per-message log files are not created in the
16254 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16255 Exim, by reducing the number of files involved in handling a message from a
16256 minimum of four (header spool file, body spool file, delivery journal, and
16257 per-message log) to three. The other major I/O activity is Exim's main log,
16258 which is not affected by this option.
16259
16260
16261 .option message_size_limit main string&!! 50M
16262 .cindex "message" "size limit"
16263 .cindex "limit" "message size"
16264 .cindex "size" "of message, limit"
16265 This option limits the maximum size of message that Exim will process. The
16266 value is expanded for each incoming connection so, for example, it can be made
16267 to depend on the IP address of the remote host for messages arriving via
16268 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16269 optionally followed by K or M.
16270
16271 &*Note*&: This limit cannot be made to depend on a message's sender or any
16272 other properties of an individual message, because it has to be advertised in
16273 the server's response to EHLO. String expansion failure causes a temporary
16274 error. A value of zero means no limit, but its use is not recommended. See also
16275 &%bounce_return_size_limit%&.
16276
16277 Incoming SMTP messages are failed with a 552 error if the limit is
16278 exceeded; locally-generated messages either get a stderr message or a delivery
16279 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16280 an oversized message is logged in both the main and the reject logs. See also
16281 the generic transport option &%message_size_limit%&, which limits the size of
16282 message that an individual transport can process.
16283
16284 If you use a virus-scanner and set this option to to a value larger than the
16285 maximum size that your virus-scanner is configured to support, you may get
16286 failures triggered by large mails.  The right size to configure for the
16287 virus-scanner depends upon what data is passed and the options in use but it's
16288 probably safest to just set it to a little larger than this value.  E.g., with a
16289 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16290 some problems may result.
16291
16292 A value of 0 will disable size limit checking; Exim will still advertise the
16293 SIZE extension in an EHLO response, but without a limit, so as to permit
16294 SMTP clients to still indicate the message size along with the MAIL verb.
16295
16296
16297 .option move_frozen_messages main boolean false
16298 .cindex "frozen messages" "moving"
16299 This option, which is available only if Exim has been built with the setting
16300 .code
16301 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16302 .endd
16303 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16304 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16305 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16306 standard utilities for handling such moved messages, and they do not show up in
16307 lists generated by &%-bp%& or by the Exim monitor.
16308
16309
16310 .option mua_wrapper main boolean false
16311 Setting this option true causes Exim to run in a very restrictive mode in which
16312 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16313 contains a full description of this facility.
16314
16315
16316
16317 .option mysql_servers main "string list" unset
16318 .cindex "MySQL" "server list"
16319 This option provides a list of MySQL servers and associated connection data, to
16320 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16321 option is available only if Exim has been built with MySQL support.
16322
16323
16324 .option never_users main "string list&!!" unset
16325 This option is expanded just once, at the start of Exim's processing. Local
16326 message deliveries are normally run in processes that are setuid to the
16327 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16328 It is usually desirable to prevent any deliveries from running as root, as a
16329 safety precaution.
16330
16331 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16332 list of users that must not be used for local deliveries. This list is fixed in
16333 the binary and cannot be overridden by the configuration file. By default, it
16334 contains just the single user name &"root"&. The &%never_users%& runtime option
16335 can be used to add more users to the fixed list.
16336
16337 If a message is to be delivered as one of the users on the fixed list or the
16338 &%never_users%& list, an error occurs, and delivery is deferred. A common
16339 example is
16340 .code
16341 never_users = root:daemon:bin
16342 .endd
16343 Including root is redundant if it is also on the fixed list, but it does no
16344 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16345 transport driver.
16346
16347
16348 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16349 .cindex "OpenSSL "compatibility options"
16350 This option allows an administrator to adjust the SSL options applied
16351 by OpenSSL to connections.  It is given as a space-separated list of items,
16352 each one to be +added or -subtracted from the current value.
16353
16354 This option is only available if Exim is built against OpenSSL.  The values
16355 available for this option vary according to the age of your OpenSSL install.
16356 The &"all"& value controls a subset of flags which are available, typically
16357 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16358 list the values known on your system and Exim should support all the
16359 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16360 names lose the leading &"SSL_OP_"& and are lower-cased.
16361
16362 Note that adjusting the options can have severe impact upon the security of
16363 SSL as used by Exim.  It is possible to disable safety checks and shoot
16364 yourself in the foot in various unpleasant ways.  This option should not be
16365 adjusted lightly.  An unrecognised item will be detected at startup, by
16366 invoking Exim with the &%-bV%& flag.
16367
16368 The option affects Exim operating both as a server and as a client.
16369
16370 Historical note: prior to release 4.80, Exim defaulted this value to
16371 "+dont_insert_empty_fragments", which may still be needed for compatibility
16372 with some clients, but which lowers security by increasing exposure to
16373 some now infamous attacks.
16374
16375 Examples:
16376 .code
16377 # Make both old MS and old Eudora happy:
16378 openssl_options = -all +microsoft_big_sslv3_buffer \
16379                        +dont_insert_empty_fragments
16380
16381 # Disable older protocol versions:
16382 openssl_options = +no_sslv2 +no_sslv3
16383 .endd
16384
16385 Possible options may include:
16386 .ilist
16387 &`all`&
16388 .next
16389 &`allow_unsafe_legacy_renegotiation`&
16390 .next
16391 &`cipher_server_preference`&
16392 .next
16393 &`dont_insert_empty_fragments`&
16394 .next
16395 &`ephemeral_rsa`&
16396 .next
16397 &`legacy_server_connect`&
16398 .next
16399 &`microsoft_big_sslv3_buffer`&
16400 .next
16401 &`microsoft_sess_id_bug`&
16402 .next
16403 &`msie_sslv2_rsa_padding`&
16404 .next
16405 &`netscape_challenge_bug`&
16406 .next
16407 &`netscape_reuse_cipher_change_bug`&
16408 .next
16409 &`no_compression`&
16410 .next
16411 &`no_session_resumption_on_renegotiation`&
16412 .next
16413 &`no_sslv2`&
16414 .next
16415 &`no_sslv3`&
16416 .next
16417 &`no_ticket`&
16418 .next
16419 &`no_tlsv1`&
16420 .next
16421 &`no_tlsv1_1`&
16422 .next
16423 &`no_tlsv1_2`&
16424 .next
16425 &`safari_ecdhe_ecdsa_bug`&
16426 .next
16427 &`single_dh_use`&
16428 .next
16429 &`single_ecdh_use`&
16430 .next
16431 &`ssleay_080_client_dh_bug`&
16432 .next
16433 &`sslref2_reuse_cert_type_bug`&
16434 .next
16435 &`tls_block_padding_bug`&
16436 .next
16437 &`tls_d5_bug`&
16438 .next
16439 &`tls_rollback_bug`&
16440 .endlist
16441
16442 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16443 all clients connecting using the MacOS SecureTransport TLS facility prior
16444 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16445 to negotiate TLS then this option value might help, provided that your OpenSSL
16446 release is new enough to contain this work-around.  This may be a situation
16447 where you have to upgrade OpenSSL to get buggy clients working.
16448
16449
16450 .option oracle_servers main "string list" unset
16451 .cindex "Oracle" "server list"
16452 This option provides a list of Oracle servers and associated connection data,
16453 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16454 The option is available only if Exim has been built with Oracle support.
16455
16456
16457 .option percent_hack_domains main "domain list&!!" unset
16458 .cindex "&""percent hack""&"
16459 .cindex "source routing" "in email address"
16460 .cindex "address" "source-routed"
16461 The &"percent hack"& is the convention whereby a local part containing a
16462 percent sign is re-interpreted as a new email address, with the percent
16463 replaced by @. This is sometimes called &"source routing"&, though that term is
16464 also applied to RFC 2822 addresses that begin with an @ character. If this
16465 option is set, Exim implements the percent facility for those domains listed,
16466 but no others. This happens before an incoming SMTP address is tested against
16467 an ACL.
16468
16469 &*Warning*&: The &"percent hack"& has often been abused by people who are
16470 trying to get round relaying restrictions. For this reason, it is best avoided
16471 if at all possible. Unfortunately, a number of less security-conscious MTAs
16472 implement it unconditionally. If you are running Exim on a gateway host, and
16473 routing mail through to internal MTAs without processing the local parts, it is
16474 a good idea to reject recipient addresses with percent characters in their
16475 local parts. Exim's default configuration does this.
16476
16477
16478 .option perl_at_start main boolean false
16479 .cindex "Perl"
16480 This option is available only when Exim is built with an embedded Perl
16481 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16482
16483
16484 .option perl_startup main string unset
16485 .cindex "Perl"
16486 This option is available only when Exim is built with an embedded Perl
16487 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16488
16489 .option perl_taintmode main boolean false
16490 .cindex "Perl"
16491 This option enables the taint mode of the embedded Perl interpreter.
16492
16493
16494 .option pgsql_servers main "string list" unset
16495 .cindex "PostgreSQL lookup type" "server list"
16496 This option provides a list of PostgreSQL servers and associated connection
16497 data, to be used in conjunction with &(pgsql)& lookups (see section
16498 &<<SECID72>>&). The option is available only if Exim has been built with
16499 PostgreSQL support.
16500
16501
16502 .option pid_file_path main string&!! "set at compile time"
16503 .cindex "daemon" "pid file path"
16504 .cindex "pid file, path for"
16505 This option sets the name of the file to which the Exim daemon writes its
16506 process id. The string is expanded, so it can contain, for example, references
16507 to the host name:
16508 .code
16509 pid_file_path = /var/log/$primary_hostname/exim.pid
16510 .endd
16511 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16512 spool directory.
16513 The value set by the option can be overridden by the &%-oP%& command line
16514 option. A pid file is not written if a &"non-standard"& daemon is run by means
16515 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16516
16517
16518 .option pipelining_advertise_hosts main "host list&!!" *
16519 .cindex "PIPELINING" "suppressing advertising"
16520 This option can be used to suppress the advertisement of the SMTP
16521 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16522 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16523 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16524 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16525 that clients will use it; &"out of order"& commands that are &"expected"& do
16526 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16527
16528 .option pipelining_connect_advertise_hosts main "host list&!!" *
16529 .cindex "pipelining" "early connection"
16530 .cindex "pipelining" PIPE_CONNECT
16531 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16532 this option controls which hosts the facility is advertised to
16533 and from which pipeline early-connection (before MAIL) SMTP
16534 commands are acceptable.
16535 When used, the pipelining saves on roundtrip times.
16536
16537 See also the &%hosts_pipe_connect%& smtp transport option.
16538
16539 Currently the option name &"X_PIPE_CONNECT"& is used.
16540
16541
16542 .option prdr_enable main boolean false
16543 .cindex "PRDR" "enabling on server"
16544 This option can be used to enable the Per-Recipient Data Response extension
16545 to SMTP, defined by Eric Hall.
16546 If the option is set, PRDR is advertised by Exim when operating as a server.
16547 If the client requests PRDR, and more than one recipient, for a message
16548 an additional ACL is called for each recipient after the message content
16549 is received.  See section &<<SECTPRDRACL>>&.
16550
16551 .option preserve_message_logs main boolean false
16552 .cindex "message logs" "preserving"
16553 If this option is set, message log files are not deleted when messages are
16554 completed. Instead, they are moved to a sub-directory of the spool directory
16555 called &_msglog.OLD_&, where they remain available for statistical or debugging
16556 purposes. This is a dangerous option to set on systems with any appreciable
16557 volume of mail. Use with care!
16558
16559
16560 .option primary_hostname main string "see below"
16561 .cindex "name" "of local host"
16562 .cindex "host" "name of local"
16563 .cindex "local host" "name of"
16564 .vindex "&$primary_hostname$&"
16565 This specifies the name of the current host. It is used in the default EHLO or
16566 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16567 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16568 The value is also used by default in some SMTP response messages from an Exim
16569 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16570
16571 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16572 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16573 contains only one component, Exim passes it to &[gethostbyname()]& (or
16574 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16575 version. The variable &$primary_hostname$& contains the host name, whether set
16576 explicitly by this option, or defaulted.
16577
16578
16579 .option print_topbitchars main boolean false
16580 .cindex "printing characters"
16581 .cindex "8-bit characters"
16582 By default, Exim considers only those characters whose codes lie in the range
16583 32&--126 to be printing characters. In a number of circumstances (for example,
16584 when writing log entries) non-printing characters are converted into escape
16585 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16586 is set, code values of 128 and above are also considered to be printing
16587 characters.
16588
16589 This option also affects the header syntax checks performed by the
16590 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16591 the user's full name when constructing From: and Sender: addresses (as
16592 described in section &<<SECTconstr>>&). Setting this option can cause
16593 Exim to generate eight bit message headers that do not conform to the
16594 standards.
16595
16596
16597 .option process_log_path main string unset
16598 .cindex "process log path"
16599 .cindex "log" "process log"
16600 .cindex "&'exiwhat'&"
16601 This option sets the name of the file to which an Exim process writes its
16602 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16603 utility script. If this option is unset, the file called &_exim-process.info_&
16604 in Exim's spool directory is used. The ability to specify the name explicitly
16605 can be useful in environments where two different Exims are running, using
16606 different spool directories.
16607
16608
16609 .option prod_requires_admin main boolean true
16610 .cindex "restricting access to features"
16611 .oindex "&%-M%&"
16612 .oindex "&%-R%&"
16613 .oindex "&%-q%&"
16614 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16615 admin user unless &%prod_requires_admin%& is set false. See also
16616 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16617
16618
16619 .option qualify_domain main string "see below"
16620 .cindex "domain" "for qualifying addresses"
16621 .cindex "address" "qualification"
16622 This option specifies the domain name that is added to any envelope sender
16623 addresses that do not have a domain qualification. It also applies to
16624 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16625 are accepted by default only for locally-generated messages. Qualification is
16626 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16627 locally-generated messages, unless the &%-bnq%& command line option is used.
16628
16629 Messages from external sources must always contain fully qualified addresses,
16630 unless the sending host matches &%sender_unqualified_hosts%& or
16631 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16632 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16633 necessary. Internally, Exim always works with fully qualified envelope
16634 addresses. If &%qualify_domain%& is not set, it defaults to the
16635 &%primary_hostname%& value.
16636
16637
16638 .option qualify_recipient main string "see below"
16639 This option allows you to specify a different domain for qualifying recipient
16640 addresses to the one that is used for senders. See &%qualify_domain%& above.
16641
16642
16643
16644 .option queue_domains main "domain list&!!" unset
16645 .cindex "domain" "specifying non-immediate delivery"
16646 .cindex "queueing incoming messages"
16647 .cindex "message" "queueing certain domains"
16648 This option lists domains for which immediate delivery is not required.
16649 A delivery process is started whenever a message is received, but only those
16650 domains that do not match are processed. All other deliveries wait until the
16651 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16652
16653
16654 .option queue_list_requires_admin main boolean true
16655 .cindex "restricting access to features"
16656 .oindex "&%-bp%&"
16657 The &%-bp%& command-line option, which lists the messages that are on the
16658 queue, requires the caller to be an admin user unless
16659 &%queue_list_requires_admin%& is set false.
16660 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16661
16662
16663 .option queue_only main boolean false
16664 .cindex "queueing incoming messages"
16665 .cindex "message" "queueing unconditionally"
16666 If &%queue_only%& is set, a delivery process is not automatically started
16667 whenever a message is received. Instead, the message waits in the queue for the
16668 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16669 delivered immediately when certain conditions (such as heavy load) occur.
16670
16671 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16672 and &%-odi%& command line options override &%queue_only%& unless
16673 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16674 &%queue_only_load%&, and &%smtp_accept_queue%&.
16675
16676
16677 .option queue_only_file main string unset
16678 .cindex "queueing incoming messages"
16679 .cindex "message" "queueing by file existence"
16680 This option can be set to a colon-separated list of absolute path names, each
16681 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16682 it tests for the existence of each listed path using a call to &[stat()]&. For
16683 each path that exists, the corresponding queueing option is set.
16684 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16685 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16686 .code
16687 queue_only_file = smtp/some/file
16688 .endd
16689 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16690 &_/some/file_& exists.
16691
16692
16693 .option queue_only_load main fixed-point unset
16694 .cindex "load average"
16695 .cindex "queueing incoming messages"
16696 .cindex "message" "queueing by load"
16697 If the system load average is higher than this value, incoming messages from
16698 all sources are queued, and no automatic deliveries are started. If this
16699 happens during local or remote SMTP input, all subsequent messages received on
16700 the same SMTP connection are queued by default, whatever happens to the load in
16701 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16702 false.
16703
16704 Deliveries will subsequently be performed by queue runner processes. This
16705 option has no effect on ancient operating systems on which Exim cannot
16706 determine the load average. See also &%deliver_queue_load_max%& and
16707 &%smtp_load_reserve%&.
16708
16709
16710 .option queue_only_load_latch main boolean true
16711 .cindex "load average" "re-evaluating per message"
16712 When this option is true (the default), once one message has been queued
16713 because the load average is higher than the value set by &%queue_only_load%&,
16714 all subsequent messages received on the same SMTP connection are also queued.
16715 This is a deliberate choice; even though the load average may fall below the
16716 threshold, it doesn't seem right to deliver later messages on the same
16717 connection when not delivering earlier ones. However, there are special
16718 circumstances such as very long-lived connections from scanning appliances
16719 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16720 should be set false. This causes the value of the load average to be
16721 re-evaluated for each message.
16722
16723
16724 .option queue_only_override main boolean true
16725 .cindex "queueing incoming messages"
16726 When this option is true, the &%-od%&&'x'& command line options override the
16727 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16728 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16729 to override; they are accepted, but ignored.
16730
16731
16732 .option queue_run_in_order main boolean false
16733 .cindex "queue runner" "processing messages in order"
16734 If this option is set, queue runs happen in order of message arrival instead of
16735 in an arbitrary order. For this to happen, a complete list of the entire queue
16736 must be set up before the deliveries start. When the queue is all held in a
16737 single directory (the default), a single list is created for both the ordered
16738 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16739 single list is not created when &%queue_run_in_order%& is false. In this case,
16740 the sub-directories are processed one at a time (in a random order), and this
16741 avoids setting up one huge list for the whole queue. Thus, setting
16742 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16743 when the queue is large, because of the extra work in setting up the single,
16744 large list. In most situations, &%queue_run_in_order%& should not be set.
16745
16746
16747
16748 .option queue_run_max main integer&!! 5
16749 .cindex "queue runner" "maximum number of"
16750 This controls the maximum number of queue runner processes that an Exim daemon
16751 can run simultaneously. This does not mean that it starts them all at once,
16752 but rather that if the maximum number are still running when the time comes to
16753 start another one, it refrains from starting another one. This can happen with
16754 very large queues and/or very sluggish deliveries. This option does not,
16755 however, interlock with other processes, so additional queue runners can be
16756 started by other means, or by killing and restarting the daemon.
16757
16758 Setting this option to zero does not suppress queue runs; rather, it disables
16759 the limit, allowing any number of simultaneous queue runner processes to be
16760 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16761 the daemon's command line.
16762
16763 .cindex queues named
16764 .cindex "named queues"
16765 To set limits for different named queues use
16766 an expansion depending on the &$queue_name$& variable.
16767
16768 .option queue_smtp_domains main "domain list&!!" unset
16769 .cindex "queueing incoming messages"
16770 .cindex "message" "queueing remote deliveries"
16771 .cindex "first pass routing"
16772 When this option is set, a delivery process is started whenever a message is
16773 received, routing is performed, and local deliveries take place.
16774 However, if any SMTP deliveries are required for domains that match
16775 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16776 message waits in the queue for the next queue run. Since routing of the message
16777 has taken place, Exim knows to which remote hosts it must be delivered, and so
16778 when the queue run happens, multiple messages for the same host are delivered
16779 over a single SMTP connection. The &%-odqs%& command line option causes all
16780 SMTP deliveries to be queued in this way, and is equivalent to setting
16781 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16782 &%queue_domains%&.
16783
16784
16785 .option receive_timeout main time 0s
16786 .cindex "timeout" "for non-SMTP input"
16787 This option sets the timeout for accepting a non-SMTP message, that is, the
16788 maximum time that Exim waits when reading a message on the standard input. If
16789 the value is zero, it will wait forever. This setting is overridden by the
16790 &%-or%& command line option. The timeout for incoming SMTP messages is
16791 controlled by &%smtp_receive_timeout%&.
16792
16793 .option received_header_text main string&!! "see below"
16794 .cindex "customizing" "&'Received:'& header"
16795 .cindex "&'Received:'& header line" "customizing"
16796 This string defines the contents of the &'Received:'& message header that is
16797 added to each message, except for the timestamp, which is automatically added
16798 on at the end (preceded by a semicolon). The string is expanded each time it is
16799 used. If the expansion yields an empty string, no &'Received:'& header line is
16800 added to the message. Otherwise, the string should start with the text
16801 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16802 header lines.
16803 The default setting is:
16804
16805 .code
16806 received_header_text = Received: \
16807   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16808     {${if def:sender_ident \
16809       {from ${quote_local_part:$sender_ident} }}\
16810         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16811   by $primary_hostname \
16812   ${if def:received_protocol {with $received_protocol }}\
16813   ${if def:tls_ver           { ($tls_ver)}}\
16814   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16815   (Exim $version_number)\n\t\
16816   ${if def:sender_address \
16817   {(envelope-from <$sender_address>)\n\t}}\
16818   id $message_exim_id\
16819   ${if def:received_for {\n\tfor $received_for}}
16820 .endd
16821
16822 The reference to the TLS cipher is omitted when Exim is built without TLS
16823 support. The use of conditional expansions ensures that this works for both
16824 locally generated messages and messages received from remote hosts, giving
16825 header lines such as the following:
16826 .code
16827 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16828 by marley.carol.example with esmtp (Exim 4.00)
16829 (envelope-from <bob@carol.example>)
16830 id 16IOWa-00019l-00
16831 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16832 Received: by scrooge.carol.example with local (Exim 4.00)
16833 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16834 .endd
16835 Until the body of the message has been received, the timestamp is the time when
16836 the message started to be received. Once the body has arrived, and all policy
16837 checks have taken place, the timestamp is updated to the time at which the
16838 message was accepted.
16839
16840
16841 .option received_headers_max main integer 30
16842 .cindex "loop" "prevention"
16843 .cindex "mail loop prevention"
16844 .cindex "&'Received:'& header line" "counting"
16845 When a message is to be delivered, the number of &'Received:'& headers is
16846 counted, and if it is greater than this parameter, a mail loop is assumed to
16847 have occurred, the delivery is abandoned, and an error message is generated.
16848 This applies to both local and remote deliveries.
16849
16850
16851 .option recipient_unqualified_hosts main "host list&!!" unset
16852 .cindex "unqualified addresses"
16853 .cindex "host" "unqualified addresses from"
16854 This option lists those hosts from which Exim is prepared to accept unqualified
16855 recipient addresses in message envelopes. The addresses are made fully
16856 qualified by the addition of the &%qualify_recipient%& value. This option also
16857 affects message header lines. Exim does not reject unqualified recipient
16858 addresses in headers, but it qualifies them only if the message came from a
16859 host that matches &%recipient_unqualified_hosts%&,
16860 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16861 option was not set.
16862
16863
16864 .option recipients_max main integer 0
16865 .cindex "limit" "number of recipients"
16866 .cindex "recipient" "maximum number"
16867 If this option is set greater than zero, it specifies the maximum number of
16868 original recipients for any message. Additional recipients that are generated
16869 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16870 all recipients over the limit; earlier recipients are delivered as normal.
16871 Non-SMTP messages with too many recipients are failed, and no deliveries are
16872 done.
16873
16874 .cindex "RCPT" "maximum number of incoming"
16875 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16876 RCPT commands in a single message.
16877
16878
16879 .option recipients_max_reject main boolean false
16880 If this option is set true, Exim rejects SMTP messages containing too many
16881 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16882 error to the eventual DATA command. Otherwise (the default) it gives a 452
16883 error to the surplus RCPT commands and accepts the message on behalf of the
16884 initial set of recipients. The remote server should then re-send the message
16885 for the remaining recipients at a later time.
16886
16887
16888 .option remote_max_parallel main integer 2
16889 .cindex "delivery" "parallelism for remote"
16890 This option controls parallel delivery of one message to a number of remote
16891 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16892 does all the remote deliveries for a message one by one. Otherwise, if a single
16893 message has to be delivered to more than one remote host, or if several copies
16894 have to be sent to the same remote host, up to &%remote_max_parallel%&
16895 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16896 deliveries are required, the maximum number of processes are started, and as
16897 each one finishes, another is begun. The order of starting processes is the
16898 same as if sequential delivery were being done, and can be controlled by the
16899 &%remote_sort_domains%& option. If parallel delivery takes place while running
16900 with debugging turned on, the debugging output from each delivery process is
16901 tagged with its process id.
16902
16903 This option controls only the maximum number of parallel deliveries for one
16904 message in one Exim delivery process. Because Exim has no central queue
16905 manager, there is no way of controlling the total number of simultaneous
16906 deliveries if the configuration allows a delivery attempt as soon as a message
16907 is received.
16908
16909 .cindex "number of deliveries"
16910 .cindex "delivery" "maximum number of"
16911 If you want to control the total number of deliveries on the system, you
16912 need to set the &%queue_only%& option. This ensures that all incoming messages
16913 are added to the queue without starting a delivery process. Then set up an Exim
16914 daemon to start queue runner processes at appropriate intervals (probably
16915 fairly often, for example, every minute), and limit the total number of queue
16916 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16917 delivers only one message at a time, the maximum number of deliveries that can
16918 then take place at once is &%queue_run_max%& multiplied by
16919 &%remote_max_parallel%&.
16920
16921 If it is purely remote deliveries you want to control, use
16922 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16923 doing the SMTP routing before queueing, so that several messages for the same
16924 host will eventually get delivered down the same connection.
16925
16926
16927 .option remote_sort_domains main "domain list&!!" unset
16928 .cindex "sorting remote deliveries"
16929 .cindex "delivery" "sorting remote"
16930 When there are a number of remote deliveries for a message, they are sorted by
16931 domain into the order given by this list. For example,
16932 .code
16933 remote_sort_domains = *.cam.ac.uk:*.uk
16934 .endd
16935 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16936 then to those in the &%uk%& domain, then to any others.
16937
16938
16939 .option retry_data_expire main time 7d
16940 .cindex "hints database" "data expiry"
16941 This option sets a &"use before"& time on retry information in Exim's hints
16942 database. Any older retry data is ignored. This means that, for example, once a
16943 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16944 past failures.
16945
16946
16947 .option retry_interval_max main time 24h
16948 .cindex "retry" "limit on interval"
16949 .cindex "limit" "on retry interval"
16950 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16951 intervals between delivery attempts for messages that cannot be delivered
16952 straight away. This option sets an overall limit to the length of time between
16953 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16954 the default value.
16955
16956
16957 .option return_path_remove main boolean true
16958 .cindex "&'Return-path:'& header line" "removing"
16959 RFC 2821, section 4.4, states that an SMTP server must insert a
16960 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16961 The &'Return-path:'& header preserves the sender address as received in the
16962 MAIL command. This description implies that this header should not be present
16963 in an incoming message. If &%return_path_remove%& is true, any existing
16964 &'Return-path:'& headers are removed from messages at the time they are
16965 received. Exim's transports have options for adding &'Return-path:'& headers at
16966 the time of delivery. They are normally used only for final local deliveries.
16967
16968
16969 .option return_size_limit main integer 100K
16970 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16971
16972
16973 .option rfc1413_hosts main "host list&!!" @[]
16974 .cindex "RFC 1413"
16975 .cindex "host" "for RFC 1413 calls"
16976 RFC 1413 identification calls are made to any client host which matches
16977 an item in the list.
16978 The default value specifies just this host, being any local interface
16979 for the system.
16980
16981 .option rfc1413_query_timeout main time 0s
16982 .cindex "RFC 1413" "query timeout"
16983 .cindex "timeout" "for RFC 1413 call"
16984 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16985 no RFC 1413 calls are ever made.
16986
16987
16988 .option sender_unqualified_hosts main "host list&!!" unset
16989 .cindex "unqualified addresses"
16990 .cindex "host" "unqualified addresses from"
16991 This option lists those hosts from which Exim is prepared to accept unqualified
16992 sender addresses. The addresses are made fully qualified by the addition of
16993 &%qualify_domain%&. This option also affects message header lines. Exim does
16994 not reject unqualified addresses in headers that contain sender addresses, but
16995 it qualifies them only if the message came from a host that matches
16996 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16997 using TCP/IP), and the &%-bnq%& option was not set.
16998
16999
17000 .option slow_lookup_log main integer 0
17001 .cindex "logging" "slow lookups"
17002 .cindex "dns" "logging slow lookups"
17003 This option controls logging of slow lookups.
17004 If the value is nonzero it is taken as a number of milliseconds
17005 and lookups taking longer than this are logged.
17006 Currently this applies only to DNS lookups.
17007
17008
17009
17010 .option smtp_accept_keepalive main boolean true
17011 .cindex "keepalive" "on incoming connection"
17012 This option controls the setting of the SO_KEEPALIVE option on incoming
17013 TCP/IP socket connections. When set, it causes the kernel to probe idle
17014 connections periodically, by sending packets with &"old"& sequence numbers. The
17015 other end of the connection should send an acknowledgment if the connection is
17016 still okay or a reset if the connection has been aborted. The reason for doing
17017 this is that it has the beneficial effect of freeing up certain types of
17018 connection that can get stuck when the remote host is disconnected without
17019 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17020 hours to detect unreachable hosts.
17021
17022
17023
17024 .option smtp_accept_max main integer 20
17025 .cindex "limit" "incoming SMTP connections"
17026 .cindex "SMTP" "incoming connection count"
17027 .cindex "inetd"
17028 This option specifies the maximum number of simultaneous incoming SMTP calls
17029 that Exim will accept. It applies only to the listening daemon; there is no
17030 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17031 value is set to zero, no limit is applied. However, it is required to be
17032 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17033 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17034
17035 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17036 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17037 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17038 and &%smtp_load_reserve%& are then checked before accepting the connection.
17039
17040
17041 .option smtp_accept_max_nonmail main integer 10
17042 .cindex "limit" "non-mail SMTP commands"
17043 .cindex "SMTP" "limiting non-mail commands"
17044 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17045 the connection if there are too many. This option defines &"too many"&. The
17046 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17047 client looping sending EHLO, for example. The check is applied only if the
17048 client host matches &%smtp_accept_max_nonmail_hosts%&.
17049
17050 When a new message is expected, one occurrence of RSET is not counted. This
17051 allows a client to send one RSET between messages (this is not necessary,
17052 but some clients do it). Exim also allows one uncounted occurrence of HELO
17053 or EHLO, and one occurrence of STARTTLS between messages. After
17054 starting up a TLS session, another EHLO is expected, and so it too is not
17055 counted. The first occurrence of AUTH in a connection, or immediately
17056 following STARTTLS is not counted. Otherwise, all commands other than
17057 MAIL, RCPT, DATA, and QUIT are counted.
17058
17059
17060 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17061 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17062 check by setting this option. The default value makes it apply to all hosts. By
17063 changing the value, you can exclude any badly-behaved hosts that you have to
17064 live with.
17065
17066
17067 . Allow this long option name to split; give it unsplit as a fifth argument
17068 . for the automatic .oindex that is generated by .option.
17069 . We insert " &~&~" which is both pretty nasty visually and results in
17070 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17071 . zero-width-space, which would be nicer visually and results in (at least)
17072 . html that Firefox will split on when it's forced to reflow (rather than
17073 . inserting a horizontal scrollbar).  However, the text is still not
17074 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17075 . the option name to split.
17076
17077 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17078          smtp_accept_max_per_connection
17079 .cindex "SMTP" "limiting incoming message count"
17080 .cindex "limit" "messages per SMTP connection"
17081 The value of this option limits the number of MAIL commands that Exim is
17082 prepared to accept over a single SMTP connection, whether or not each command
17083 results in the transfer of a message. After the limit is reached, a 421
17084 response is given to subsequent MAIL commands. This limit is a safety
17085 precaution against a client that goes mad (incidents of this type have been
17086 seen).
17087
17088
17089 .option smtp_accept_max_per_host main string&!! unset
17090 .cindex "limit" "SMTP connections from one host"
17091 .cindex "host" "limiting SMTP connections from"
17092 This option restricts the number of simultaneous IP connections from a single
17093 host (strictly, from a single IP address) to the Exim daemon. The option is
17094 expanded, to enable different limits to be applied to different hosts by
17095 reference to &$sender_host_address$&. Once the limit is reached, additional
17096 connection attempts from the same host are rejected with error code 421. This
17097 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17098 of zero imposes no limit. If this option is set greater than zero, it is
17099 required that &%smtp_accept_max%& be non-zero.
17100
17101 &*Warning*&: When setting this option you should not use any expansion
17102 constructions that take an appreciable amount of time. The expansion and test
17103 happen in the main daemon loop, in order to reject additional connections
17104 without forking additional processes (otherwise a denial-of-service attack
17105 could cause a vast number or processes to be created). While the daemon is
17106 doing this processing, it cannot accept any other incoming connections.
17107
17108
17109
17110 .option smtp_accept_queue main integer 0
17111 .cindex "SMTP" "incoming connection count"
17112 .cindex "queueing incoming messages"
17113 .cindex "message" "queueing by SMTP connection count"
17114 If the number of simultaneous incoming SMTP connections being handled via the
17115 listening daemon exceeds this value, messages received by SMTP are just placed
17116 in the queue; no delivery processes are started automatically. The count is
17117 fixed at the start of an SMTP connection. It cannot be updated in the
17118 subprocess that receives messages, and so the queueing or not queueing applies
17119 to all messages received in the same connection.
17120
17121 A value of zero implies no limit, and clearly any non-zero value is useful only
17122 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17123 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17124 various &%-od%&&'x'& command line options.
17125
17126
17127 . See the comment on smtp_accept_max_per_connection
17128
17129 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17130          smtp_accept_queue_per_connection
17131 .cindex "queueing incoming messages"
17132 .cindex "message" "queueing by message count"
17133 This option limits the number of delivery processes that Exim starts
17134 automatically when receiving messages via SMTP, whether via the daemon or by
17135 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17136 and the number of messages received in a single SMTP session exceeds this
17137 number, subsequent messages are placed in the queue, but no delivery processes
17138 are started. This helps to limit the number of Exim processes when a server
17139 restarts after downtime and there is a lot of mail waiting for it on other
17140 systems. On large systems, the default should probably be increased, and on
17141 dial-in client systems it should probably be set to zero (that is, disabled).
17142
17143
17144 .option smtp_accept_reserve main integer 0
17145 .cindex "SMTP" "incoming call count"
17146 .cindex "host" "reserved"
17147 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17148 number of SMTP connections that are reserved for connections from the hosts
17149 that are specified in &%smtp_reserve_hosts%&. The value set in
17150 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17151 restricted to this number of connections; the option specifies a minimum number
17152 of connection slots for them, not a maximum. It is a guarantee that this group
17153 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17154 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17155 individual host.
17156
17157 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17158 set to 5, once there are 45 active connections (from any hosts), new
17159 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17160 provided the other criteria for acceptance are met.
17161
17162
17163 .option smtp_active_hostname main string&!! unset
17164 .cindex "host" "name in SMTP responses"
17165 .cindex "SMTP" "host name in responses"
17166 .vindex "&$primary_hostname$&"
17167 This option is provided for multi-homed servers that want to masquerade as
17168 several different hosts. At the start of an incoming SMTP connection, its value
17169 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17170 responses. For example, it is used as domain name in the response to an
17171 incoming HELO or EHLO command.
17172
17173 .vindex "&$smtp_active_hostname$&"
17174 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17175 is saved with any messages that are received. It is therefore available for use
17176 in routers and transports when the message is later delivered.
17177
17178 If this option is unset, or if its expansion is forced to fail, or if the
17179 expansion results in an empty string, the value of &$primary_hostname$& is
17180 used. Other expansion failures cause a message to be written to the main and
17181 panic logs, and the SMTP command receives a temporary error. Typically, the
17182 value of &%smtp_active_hostname%& depends on the incoming interface address.
17183 For example:
17184 .code
17185 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17186   {cox.mydomain}{box.mydomain}}
17187 .endd
17188
17189 Although &$smtp_active_hostname$& is primarily concerned with incoming
17190 messages, it is also used as the default for HELO commands in callout
17191 verification if there is no remote transport from which to obtain a
17192 &%helo_data%& value.
17193
17194 .option smtp_banner main string&!! "see below"
17195 .cindex "SMTP" "welcome banner"
17196 .cindex "banner for SMTP"
17197 .cindex "welcome banner for SMTP"
17198 .cindex "customizing" "SMTP banner"
17199 This string, which is expanded every time it is used, is output as the initial
17200 positive response to an SMTP connection. The default setting is:
17201 .code
17202 smtp_banner = $smtp_active_hostname ESMTP Exim \
17203   $version_number $tod_full
17204 .endd
17205 Failure to expand the string causes a panic error. If you want to create a
17206 multiline response to the initial SMTP connection, use &"\n"& in the string at
17207 appropriate points, but not at the end. Note that the 220 code is not included
17208 in this string. Exim adds it automatically (several times in the case of a
17209 multiline response).
17210
17211
17212 .option smtp_check_spool_space main boolean true
17213 .cindex "checking disk space"
17214 .cindex "disk space, checking"
17215 .cindex "spool directory" "checking space"
17216 When this option is set, if an incoming SMTP session encounters the SIZE
17217 option on a MAIL command, it checks that there is enough space in the
17218 spool directory's partition to accept a message of that size, while still
17219 leaving free the amount specified by &%check_spool_space%& (even if that value
17220 is zero). If there isn't enough space, a temporary error code is returned.
17221
17222
17223 .option smtp_connect_backlog main integer 20
17224 .cindex "connection backlog"
17225 .cindex "SMTP" "connection backlog"
17226 .cindex "backlog of connections"
17227 This option specifies a maximum number of waiting SMTP connections. Exim passes
17228 this value to the TCP/IP system when it sets up its listener. Once this number
17229 of connections are waiting for the daemon's attention, subsequent connection
17230 attempts are refused at the TCP/IP level. At least, that is what the manuals
17231 say; in some circumstances such connection attempts have been observed to time
17232 out instead. For large systems it is probably a good idea to increase the
17233 value (to 50, say). It also gives some protection against denial-of-service
17234 attacks by SYN flooding.
17235
17236
17237 .option smtp_enforce_sync main boolean true
17238 .cindex "SMTP" "synchronization checking"
17239 .cindex "synchronization checking in SMTP"
17240 The SMTP protocol specification requires the client to wait for a response from
17241 the server at certain points in the dialogue. Without PIPELINING these
17242 synchronization points are after every command; with PIPELINING they are
17243 fewer, but they still exist.
17244
17245 Some spamming sites send out a complete set of SMTP commands without waiting
17246 for any response. Exim protects against this by rejecting a message if the
17247 client has sent further input when it should not have. The error response &"554
17248 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17249 for this error cannot be perfect because of transmission delays (unexpected
17250 input may be on its way but not yet received when Exim checks). However, it
17251 does detect many instances.
17252
17253 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17254 If you want to disable the check selectively (for example, only for certain
17255 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17256 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17257
17258
17259
17260 .option smtp_etrn_command main string&!! unset
17261 .cindex "ETRN" "command to be run"
17262 .vindex "&$domain$&"
17263 If this option is set, the given command is run whenever an SMTP ETRN
17264 command is received from a host that is permitted to issue such commands (see
17265 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17266 are independently expanded. The expansion variable &$domain$& is set to the
17267 argument of the ETRN command, and no syntax checking is done on it. For
17268 example:
17269 .code
17270 smtp_etrn_command = /etc/etrn_command $domain \
17271                     $sender_host_address
17272 .endd
17273 A new process is created to run the command, but Exim does not wait for it to
17274 complete. Consequently, its status cannot be checked. If the command cannot be
17275 run, a line is written to the panic log, but the ETRN caller still receives
17276 a 250 success response. Exim is normally running under its own uid when
17277 receiving SMTP, so it is not possible for it to change the uid before running
17278 the command.
17279
17280
17281 .option smtp_etrn_serialize main boolean true
17282 .cindex "ETRN" "serializing"
17283 When this option is set, it prevents the simultaneous execution of more than
17284 one identical command as a result of ETRN in an SMTP connection. See
17285 section &<<SECTETRN>>& for details.
17286
17287
17288 .option smtp_load_reserve main fixed-point unset
17289 .cindex "load average"
17290 If the system load average ever gets higher than this, incoming SMTP calls are
17291 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17292 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17293 the load is over the limit. The option has no effect on ancient operating
17294 systems on which Exim cannot determine the load average. See also
17295 &%deliver_queue_load_max%& and &%queue_only_load%&.
17296
17297
17298
17299 .option smtp_max_synprot_errors main integer 3
17300 .cindex "SMTP" "limiting syntax and protocol errors"
17301 .cindex "limit" "SMTP syntax and protocol errors"
17302 Exim rejects SMTP commands that contain syntax or protocol errors. In
17303 particular, a syntactically invalid email address, as in this command:
17304 .code
17305 RCPT TO:<abc xyz@a.b.c>
17306 .endd
17307 causes immediate rejection of the command, before any other tests are done.
17308 (The ACL cannot be run if there is no valid address to set up for it.) An
17309 example of a protocol error is receiving RCPT before MAIL. If there are
17310 too many syntax or protocol errors in one SMTP session, the connection is
17311 dropped. The limit is set by this option.
17312
17313 .cindex "PIPELINING" "expected errors"
17314 When the PIPELINING extension to SMTP is in use, some protocol errors are
17315 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17316 Exim assumes that PIPELINING will be used if it advertises it (see
17317 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17318 not count towards the limit.
17319
17320
17321
17322 .option smtp_max_unknown_commands main integer 3
17323 .cindex "SMTP" "limiting unknown commands"
17324 .cindex "limit" "unknown SMTP commands"
17325 If there are too many unrecognized commands in an incoming SMTP session, an
17326 Exim server drops the connection. This is a defence against some kinds of abuse
17327 that subvert web
17328 clients
17329 into making connections to SMTP ports; in these circumstances, a number of
17330 non-SMTP command lines are sent first.
17331
17332
17333
17334 .option smtp_ratelimit_hosts main "host list&!!" unset
17335 .cindex "SMTP" "rate limiting"
17336 .cindex "limit" "rate of message arrival"
17337 .cindex "RCPT" "rate limiting"
17338 Some sites find it helpful to be able to limit the rate at which certain hosts
17339 can send them messages, and the rate at which an individual message can specify
17340 recipients.
17341
17342 Exim has two rate-limiting facilities. This section describes the older
17343 facility, which can limit rates within a single connection. The newer
17344 &%ratelimit%& ACL condition can limit rates across all connections. See section
17345 &<<SECTratelimiting>>& for details of the newer facility.
17346
17347 When a host matches &%smtp_ratelimit_hosts%&, the values of
17348 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17349 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17350 respectively. Each option, if set, must contain a set of four comma-separated
17351 values:
17352
17353 .ilist
17354 A threshold, before which there is no rate limiting.
17355 .next
17356 An initial time delay. Unlike other times in Exim, numbers with decimal
17357 fractional parts are allowed here.
17358 .next
17359 A factor by which to increase the delay each time.
17360 .next
17361 A maximum value for the delay. This should normally be less than 5 minutes,
17362 because after that time, the client is liable to timeout the SMTP command.
17363 .endlist
17364
17365 For example, these settings have been used successfully at the site which
17366 first suggested this feature, for controlling mail from their customers:
17367 .code
17368 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17369 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17370 .endd
17371 The first setting specifies delays that are applied to MAIL commands after
17372 two have been received over a single connection. The initial delay is 0.5
17373 seconds, increasing by a factor of 1.05 each time. The second setting applies
17374 delays to RCPT commands when more than four occur in a single message.
17375
17376
17377 .option smtp_ratelimit_mail main string unset
17378 See &%smtp_ratelimit_hosts%& above.
17379
17380
17381 .option smtp_ratelimit_rcpt main string unset
17382 See &%smtp_ratelimit_hosts%& above.
17383
17384
17385 .option smtp_receive_timeout main time&!! 5m
17386 .cindex "timeout" "for SMTP input"
17387 .cindex "SMTP" "input timeout"
17388 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17389 input, including batch SMTP. If a line of input (either an SMTP command or a
17390 data line) is not received within this time, the SMTP connection is dropped and
17391 the message is abandoned.
17392 A line is written to the log containing one of the following messages:
17393 .code
17394 SMTP command timeout on connection from...
17395 SMTP data timeout on connection from...
17396 .endd
17397 The former means that Exim was expecting to read an SMTP command; the latter
17398 means that it was in the DATA phase, reading the contents of a message.
17399
17400 If the first character of the option is a &"$"& the option is
17401 expanded before use and may depend on
17402 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17403
17404
17405 .oindex "&%-os%&"
17406 The value set by this option can be overridden by the
17407 &%-os%& command-line option. A setting of zero time disables the timeout, but
17408 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17409 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17410 timeout is controlled by &%receive_timeout%& and &%-or%&.
17411
17412
17413 .option smtp_reserve_hosts main "host list&!!" unset
17414 This option defines hosts for which SMTP connections are reserved; see
17415 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17416
17417
17418 .option smtp_return_error_details main boolean false
17419 .cindex "SMTP" "details policy failures"
17420 .cindex "policy control" "rejection, returning details"
17421 In the default state, Exim uses bland messages such as
17422 &"Administrative prohibition"& when it rejects SMTP commands for policy
17423 reasons. Many sysadmins like this because it gives away little information
17424 to spammers. However, some other sysadmins who are applying strict checking
17425 policies want to give out much fuller information about failures. Setting
17426 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17427 example, instead of &"Administrative prohibition"&, it might give:
17428 .code
17429 550-Rejected after DATA: '>' missing at end of address:
17430 550 failing address in "From" header is: <user@dom.ain
17431 .endd
17432
17433
17434 .option smtputf8_advertise_hosts main "host list&!!" *
17435 .cindex "SMTPUTF8" "advertising"
17436 When Exim is built with support for internationalised mail names,
17437 the availability thereof is advertised in
17438 response to EHLO only to those client hosts that match this option. See
17439 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17440
17441
17442 .option spamd_address main string "127.0.0.1 783"
17443 This option is available when Exim is compiled with the content-scanning
17444 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17445 See section &<<SECTscanspamass>>& for more details.
17446
17447
17448
17449 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17450 This option is available when Exim is compiled with SPF support.
17451 See section &<<SECSPF>>& for more details.
17452
17453
17454
17455 .option split_spool_directory main boolean false
17456 .cindex "multiple spool directories"
17457 .cindex "spool directory" "split"
17458 .cindex "directories, multiple"
17459 If this option is set, it causes Exim to split its input directory into 62
17460 subdirectories, each with a single alphanumeric character as its name. The
17461 sixth character of the message id is used to allocate messages to
17462 subdirectories; this is the least significant base-62 digit of the time of
17463 arrival of the message.
17464
17465 Splitting up the spool in this way may provide better performance on systems
17466 where there are long mail queues, by reducing the number of files in any one
17467 directory. The msglog directory is also split up in a similar way to the input
17468 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17469 are still placed in the single directory &_msglog.OLD_&.
17470
17471 It is not necessary to take any special action for existing messages when
17472 changing &%split_spool_directory%&. Exim notices messages that are in the
17473 &"wrong"& place, and continues to process them. If the option is turned off
17474 after a period of being on, the subdirectories will eventually empty and be
17475 automatically deleted.
17476
17477 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17478 changes. Instead of creating a list of all messages in the queue, and then
17479 trying to deliver each one, in turn, it constructs a list of those in one
17480 sub-directory and tries to deliver them, before moving on to the next
17481 sub-directory. The sub-directories are processed in a random order. This
17482 spreads out the scanning of the input directories, and uses less memory. It is
17483 particularly beneficial when there are lots of messages in the queue. However,
17484 if &%queue_run_in_order%& is set, none of this new processing happens. The
17485 entire queue has to be scanned and sorted before any deliveries can start.
17486
17487
17488 .option spool_directory main string&!! "set at compile time"
17489 .cindex "spool directory" "path to"
17490 This defines the directory in which Exim keeps its spool, that is, the messages
17491 it is waiting to deliver. The default value is taken from the compile-time
17492 configuration setting, if there is one. If not, this option must be set. The
17493 string is expanded, so it can contain, for example, a reference to
17494 &$primary_hostname$&.
17495
17496 If the spool directory name is fixed on your installation, it is recommended
17497 that you set it at build time rather than from this option, particularly if the
17498 log files are being written to the spool directory (see &%log_file_path%&).
17499 Otherwise log files cannot be used for errors that are detected early on, such
17500 as failures in the configuration file.
17501
17502 By using this option to override the compiled-in path, it is possible to run
17503 tests of Exim without using the standard spool.
17504
17505 .option spool_wireformat main boolean false
17506 .cindex "spool directory" "file formats"
17507 If this option is set, Exim may for some messages use an alternative format
17508 for data-files in the spool which matches the wire format.
17509 Doing this permits more efficient message reception and transmission.
17510 Currently it is only done for messages received using the ESMTP CHUNKING
17511 option.
17512
17513 The following variables will not have useful values:
17514 .code
17515 $max_received_linelength
17516 $body_linecount
17517 $body_zerocount
17518 .endd
17519
17520 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17521 and any external programs which are passed a reference to a message data file
17522 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17523 will need to be aware of the different formats potentially available.
17524
17525 Using any of the ACL conditions noted will negate the reception benefit
17526 (as a Unix-mbox-format file is constructed for them).
17527 The transmission benefit is maintained.
17528
17529 .option sqlite_lock_timeout main time 5s
17530 .cindex "sqlite lookup type" "lock timeout"
17531 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17532 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17533
17534 .option strict_acl_vars main boolean false
17535 .cindex "&ACL;" "variables, handling unset"
17536 This option controls what happens if a syntactically valid but undefined ACL
17537 variable is referenced. If it is false (the default), an empty string
17538 is substituted; if it is true, an error is generated. See section
17539 &<<SECTaclvariables>>& for details of ACL variables.
17540
17541 .option strip_excess_angle_brackets main boolean false
17542 .cindex "angle brackets, excess"
17543 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17544 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17545 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17546 passed on to another MTA, the excess angle brackets are not passed on. If this
17547 option is not set, multiple pairs of angle brackets cause a syntax error.
17548
17549
17550 .option strip_trailing_dot main boolean false
17551 .cindex "trailing dot on domain"
17552 .cindex "dot" "trailing on domain"
17553 If this option is set, a trailing dot at the end of a domain in an address is
17554 ignored. If this is in the envelope and the message is passed on to another
17555 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17556 domain causes a syntax error.
17557 However, addresses in header lines are checked only when an ACL requests header
17558 syntax checking.
17559
17560
17561 .option syslog_duplication main boolean true
17562 .cindex "syslog" "duplicate log lines; suppressing"
17563 When Exim is logging to syslog, it writes the log lines for its three
17564 separate logs at different syslog priorities so that they can in principle
17565 be separated on the logging hosts. Some installations do not require this
17566 separation, and in those cases, the duplication of certain log lines is a
17567 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17568 particular log line is written to syslog. For lines that normally go to
17569 both the main log and the reject log, the reject log version (possibly
17570 containing message header lines) is written, at LOG_NOTICE priority.
17571 Lines that normally go to both the main and the panic log are written at
17572 the LOG_ALERT priority.
17573
17574
17575 .option syslog_facility main string unset
17576 .cindex "syslog" "facility; setting"
17577 This option sets the syslog &"facility"& name, used when Exim is logging to
17578 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17579 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17580 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17581 details of Exim's logging.
17582
17583
17584 .option syslog_pid main boolean true
17585 .cindex "syslog" "pid"
17586 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17587 omitted when these lines are sent to syslog. (Syslog normally prefixes
17588 the log lines with the PID of the logging process automatically.) You need
17589 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17590 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17591
17592
17593
17594 .option syslog_processname main string &`exim`&
17595 .cindex "syslog" "process name; setting"
17596 This option sets the syslog &"ident"& name, used when Exim is logging to
17597 syslog. The value must be no longer than 32 characters. See chapter
17598 &<<CHAPlog>>& for details of Exim's logging.
17599
17600
17601
17602 .option syslog_timestamp main boolean true
17603 .cindex "syslog" "timestamps"
17604 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17605 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17606 details of Exim's logging.
17607
17608
17609 .option system_filter main string&!! unset
17610 .cindex "filter" "system filter"
17611 .cindex "system filter" "specifying"
17612 .cindex "Sieve filter" "not available for system filter"
17613 This option specifies an Exim filter file that is applied to all messages at
17614 the start of each delivery attempt, before any routing is done. System filters
17615 must be Exim filters; they cannot be Sieve filters. If the system filter
17616 generates any deliveries to files or pipes, or any new mail messages, the
17617 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17618 which transports are to be used. Details of this facility are given in chapter
17619 &<<CHAPsystemfilter>>&.
17620 A forced expansion failure results in no filter operation.
17621
17622
17623 .option system_filter_directory_transport main string&!! unset
17624 .vindex "&$address_file$&"
17625 This sets the name of the transport driver that is to be used when the
17626 &%save%& command in a system message filter specifies a path ending in &"/"&,
17627 implying delivery of each message into a separate file in some directory.
17628 During the delivery, the variable &$address_file$& contains the path name.
17629
17630
17631 .option system_filter_file_transport main string&!! unset
17632 .cindex "file" "transport for system filter"
17633 This sets the name of the transport driver that is to be used when the &%save%&
17634 command in a system message filter specifies a path not ending in &"/"&. During
17635 the delivery, the variable &$address_file$& contains the path name.
17636
17637 .option system_filter_group main string unset
17638 .cindex "gid (group id)" "system filter"
17639 This option is used only when &%system_filter_user%& is also set. It sets the
17640 gid under which the system filter is run, overriding any gid that is associated
17641 with the user. The value may be numerical or symbolic.
17642
17643 .option system_filter_pipe_transport main string&!! unset
17644 .cindex "&(pipe)& transport" "for system filter"
17645 .vindex "&$address_pipe$&"
17646 This specifies the transport driver that is to be used when a &%pipe%& command
17647 is used in a system filter. During the delivery, the variable &$address_pipe$&
17648 contains the pipe command.
17649
17650
17651 .option system_filter_reply_transport main string&!! unset
17652 .cindex "&(autoreply)& transport" "for system filter"
17653 This specifies the transport driver that is to be used when a &%mail%& command
17654 is used in a system filter.
17655
17656
17657 .option system_filter_user main string unset
17658 .cindex "uid (user id)" "system filter"
17659 If this option is set to root, the system filter is run in the main Exim
17660 delivery process, as root.  Otherwise, the system filter runs in a separate
17661 process, as the given user, defaulting to the Exim run-time user.
17662 Unless the string consists entirely of digits, it
17663 is looked up in the password data. Failure to find the named user causes a
17664 configuration error. The gid is either taken from the password data, or
17665 specified by &%system_filter_group%&. When the uid is specified numerically,
17666 &%system_filter_group%& is required to be set.
17667
17668 If the system filter generates any pipe, file, or reply deliveries, the uid
17669 under which the filter is run is used when transporting them, unless a
17670 transport option overrides.
17671
17672
17673 .option tcp_nodelay main boolean true
17674 .cindex "daemon" "TCP_NODELAY on sockets"
17675 .cindex "Nagle algorithm"
17676 .cindex "TCP_NODELAY on listening sockets"
17677 If this option is set false, it stops the Exim daemon setting the
17678 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17679 turns off the &"Nagle algorithm"&, which is a way of improving network
17680 performance in interactive (character-by-character) situations. Turning it off
17681 should improve Exim's performance a bit, so that is what happens by default.
17682 However, it appears that some broken clients cannot cope, and time out. Hence
17683 this option. It affects only those sockets that are set up for listening by the
17684 daemon. Sockets created by the smtp transport for delivering mail always set
17685 TCP_NODELAY.
17686
17687
17688 .option timeout_frozen_after main time 0s
17689 .cindex "frozen messages" "timing out"
17690 .cindex "timeout" "frozen messages"
17691 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17692 message of any kind that has been in the queue for longer than the given time
17693 is automatically cancelled at the next queue run. If the frozen message is a
17694 bounce message, it is just discarded; otherwise, a bounce is sent to the
17695 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17696 If you want to timeout frozen bounce messages earlier than other kinds of
17697 frozen message, see &%ignore_bounce_errors_after%&.
17698
17699 &*Note:*& the default value of zero means no timeouts; with this setting,
17700 frozen messages remain in the queue forever (except for any frozen bounce
17701 messages that are released by &%ignore_bounce_errors_after%&).
17702
17703
17704 .option timezone main string unset
17705 .cindex "timezone, setting"
17706 .cindex "environment" "values from"
17707 The value of &%timezone%& is used to set the environment variable TZ while
17708 running Exim (if it is different on entry). This ensures that all timestamps
17709 created by Exim are in the required timezone. If you want all your timestamps
17710 to be in UTC (aka GMT) you should set
17711 .code
17712 timezone = UTC
17713 .endd
17714 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17715 or, if that is not set, from the value of the TZ environment variable when Exim
17716 is built. If &%timezone%& is set to the empty string, either at build or run
17717 time, any existing TZ variable is removed from the environment when Exim
17718 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17719 unfortunately not all, operating systems.
17720
17721
17722 .option tls_advertise_hosts main "host list&!!" *
17723 .cindex "TLS" "advertising"
17724 .cindex "encryption" "on SMTP connection"
17725 .cindex "SMTP" "encrypted connection"
17726 When Exim is built with support for TLS encrypted connections, the availability
17727 of the STARTTLS command to set up an encrypted session is advertised in
17728 response to EHLO only to those client hosts that match this option. See
17729 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17730 Note that the default value requires that a certificate be supplied
17731 using the &%tls_certificate%& option.  If TLS support for incoming connections
17732 is not required the &%tls_advertise_hosts%& option should be set empty.
17733
17734
17735 .option tls_certificate main string list&!! unset
17736 .cindex "TLS" "server certificate; location of"
17737 .cindex "certificate" "server, location of"
17738 The value of this option is expanded, and must then be a list of absolute paths to
17739 files which contain the server's certificates (in PEM format).
17740 Commonly only one file is needed.
17741 The server's private key is also
17742 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17743 &<<CHAPTLS>>& for further details.
17744
17745 &*Note*&: The certificates defined by this option are used only when Exim is
17746 receiving incoming messages as a server. If you want to supply certificates for
17747 use when sending messages as a client, you must set the &%tls_certificate%&
17748 option in the relevant &(smtp)& transport.
17749
17750 &*Note*&: If you use filenames based on IP addresses, change the list
17751 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
17752
17753 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17754 when a list of more than one
17755 file is used, the &$tls_in_ourcert$& variable is unreliable.
17756 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
17757
17758 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17759 if the OpenSSL build supports TLS extensions and the TLS client sends the
17760 Server Name Indication extension, then this option and others documented in
17761 &<<SECTtlssni>>& will be re-expanded.
17762
17763 If this option is unset or empty a fresh self-signed certificate will be
17764 generated for every connection.
17765
17766 .option tls_crl main string&!! unset
17767 .cindex "TLS" "server certificate revocation list"
17768 .cindex "certificate" "revocation list for server"
17769 This option specifies a certificate revocation list. The expanded value must
17770 be the name of a file that contains CRLs in PEM format.
17771
17772 Under OpenSSL the option can specify a directory with CRL files.
17773
17774 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17775 for each signing element of the certificate chain (i.e. all but the leaf).
17776 For the file variant this can be multiple PEM blocks in the one file.
17777
17778 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17779
17780
17781 .option tls_dh_max_bits main integer 2236
17782 .cindex "TLS" "D-H bit count"
17783 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17784 the chosen TLS library.  That value might prove to be too high for
17785 interoperability.  This option provides a maximum clamp on the value
17786 suggested, trading off security for interoperability.
17787
17788 The value must be at least 1024.
17789
17790 The value 2236 was chosen because, at time of adding the option, it was the
17791 hard-coded maximum value supported by the NSS cryptographic library, as used
17792 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17793
17794 If you prefer more security and are willing to break some clients, raise this
17795 number.
17796
17797 Note that the value passed to GnuTLS for *generating* a new prime may be a
17798 little less than this figure, because GnuTLS is inexact and may produce a
17799 larger prime than requested.
17800
17801
17802 .option tls_dhparam main string&!! unset
17803 .cindex "TLS" "D-H parameters for server"
17804 The value of this option is expanded and indicates the source of DH parameters
17805 to be used by Exim.
17806
17807 This option is ignored for GnuTLS version 3.6.0 and later.
17808 The library manages parameter negotiation internally.
17809
17810 &*Note: The Exim Maintainers strongly recommend,
17811 for other TLS library versions,
17812 using a filename with site-generated
17813 local DH parameters*&, which has been supported across all versions of Exim.  The
17814 other specific constants available are a fallback so that even when
17815 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17816
17817 If &%tls_dhparam%& is a filename starting with a &`/`&,
17818 then it names a file from which DH
17819 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17820 PKCS#3 representation of the DH prime.  If the file does not exist, for
17821 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17822 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17823 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17824 and treated as though the &%tls_dhparam%& were set to "none".
17825
17826 If this option expands to the string "none", then no DH parameters will be
17827 loaded by Exim.
17828
17829 If this option expands to the string "historic" and Exim is using GnuTLS, then
17830 Exim will attempt to load a file from inside the spool directory.  If the file
17831 does not exist, Exim will attempt to create it.
17832 See section &<<SECTgnutlsparam>>& for further details.
17833
17834 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17835 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17836
17837 In older versions of Exim the default was the 2048 bit prime described in section
17838 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17839 in IKE is assigned number 23.
17840
17841 Otherwise, the option must expand to the name used by Exim for any of a number
17842 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17843 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17844 the number used by IKE, or "default" which corresponds to
17845 &`exim.dev.20160529.3`&.
17846
17847 The available standard primes are:
17848 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17849 &`ike1`&, &`ike2`&, &`ike5`&,
17850 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17851 &`ike22`&, &`ike23`& and &`ike24`&.
17852
17853 The available additional primes are:
17854 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17855
17856 Some of these will be too small to be accepted by clients.
17857 Some may be too large to be accepted by clients.
17858 The open cryptographic community has suspicions about the integrity of some
17859 of the later IKE values, which led into RFC7919 providing new fixed constants
17860 (the "ffdhe" identifiers).
17861
17862 At this point, all of the "ike" values should be considered obsolete;
17863 they're still in Exim to avoid breaking unusual configurations, but are
17864 candidates for removal the next time we have backwards-incompatible changes.
17865
17866 The TLS protocol does not negotiate an acceptable size for this; clients tend
17867 to hard-drop connections if what is offered by the server is unacceptable,
17868 whether too large or too small, and there's no provision for the client to
17869 tell the server what these constraints are.  Thus, as a server operator, you
17870 need to make an educated guess as to what is most likely to work for your
17871 userbase.
17872
17873 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17874 is most likely to maximise interoperability.  The upper bound comes from
17875 applications using the Mozilla Network Security Services (NSS) library, which
17876 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17877 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17878 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17879 acceptable bound from 1024 to 2048.
17880
17881
17882 .option tls_eccurve main string&!! &`auto`&
17883 .cindex TLS "EC cryptography"
17884 This option selects a EC curve for use by Exim when used with OpenSSL.
17885 It has no effect when Exim is used with GnuTLS.
17886
17887 After expansion it must contain a valid EC curve parameter, such as
17888 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17889 for valid selections.
17890
17891 For OpenSSL versions before (and not including) 1.0.2, the string
17892 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17893 &`auto`& tells the library to choose.
17894
17895 If the option expands to an empty string, no EC curves will be enabled.
17896
17897
17898 .option tls_ocsp_file main string&!! unset
17899 .cindex TLS "certificate status"
17900 .cindex TLS "OCSP proof file"
17901 This option
17902 must if set expand to the absolute path to a file which contains a current
17903 status proof for the server's certificate, as obtained from the
17904 Certificate Authority.
17905
17906 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17907 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
17908
17909 For OpenSSL 1.1.0 or later, and
17910 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
17911 of files, to match a list given for the &%tls_certificate%& option.
17912 The ordering of the two lists must match.
17913 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
17914
17915 The file(s) should be in DER format,
17916 except for GnuTLS 3.6.3 or later
17917 or for OpenSSL,
17918 when an optional filetype prefix can be used.
17919 The prefix must be one of "DER" or "PEM", followed by
17920 a single space.  If one is used it sets the format for subsequent
17921 files in the list; the initial format is DER.
17922 If multiple proofs are wanted, for multiple chain elements
17923 (this only works under TLS1.3)
17924 they must be coded as a combined OCSP response.
17925
17926 Although GnuTLS will accept PEM files with multiple separate
17927 PEM blobs (ie. separate OCSP responses), it sends them in the
17928 TLS Certificate record interleaved with the certificates of the chain;
17929 although a GnuTLS client is happy with that, an OpenSSL client is not.
17930
17931 .option tls_on_connect_ports main "string list" unset
17932 .cindex SSMTP
17933 .cindex SMTPS
17934 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17935 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17936 set up without waiting for the client to issue a STARTTLS command. For
17937 further details, see section &<<SECTsupobssmt>>&.
17938
17939
17940
17941 .option tls_privatekey main string list&!! unset
17942 .cindex "TLS" "server private key; location of"
17943 The value of this option is expanded, and must then be a list of absolute paths to
17944 files which contains the server's private keys.
17945 If this option is unset, or if
17946 the expansion is forced to fail, or the result is an empty string, the private
17947 key is assumed to be in the same file as the server's certificates. See chapter
17948 &<<CHAPTLS>>& for further details.
17949
17950 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17951
17952
17953 .option tls_remember_esmtp main boolean false
17954 .cindex "TLS" "esmtp state; remembering"
17955 .cindex "TLS" "broken clients"
17956 If this option is set true, Exim violates the RFCs by remembering that it is in
17957 &"esmtp"& state after successfully negotiating a TLS session. This provides
17958 support for broken clients that fail to send a new EHLO after starting a
17959 TLS session.
17960
17961
17962 .option tls_require_ciphers main string&!! unset
17963 .cindex "TLS" "requiring specific ciphers"
17964 .cindex "cipher" "requiring specific"
17965 This option controls which ciphers can be used for incoming TLS connections.
17966 The &(smtp)& transport has an option of the same name for controlling outgoing
17967 connections. This option is expanded for each connection, so can be varied for
17968 different clients if required. The value of this option must be a list of
17969 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17970 in somewhat different ways. If GnuTLS is being used, the client controls the
17971 preference order of the available ciphers. Details are given in sections
17972 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17973
17974
17975 .option tls_try_verify_hosts main "host list&!!" unset
17976 .cindex "TLS" "client certificate verification"
17977 .cindex "certificate" "verification of client"
17978 See &%tls_verify_hosts%& below.
17979
17980
17981 .option tls_verify_certificates main string&!! system
17982 .cindex "TLS" "client certificate verification"
17983 .cindex "certificate" "verification of client"
17984 The value of this option is expanded, and must then be either the
17985 word "system"
17986 or the absolute path to
17987 a file or directory containing permitted certificates for clients that
17988 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17989
17990 The "system" value for the option will use a
17991 system default location compiled into the SSL library.
17992 This is not available for GnuTLS versions preceding 3.0.20,
17993 and will be taken as empty; an explicit location
17994 must be specified.
17995
17996 The use of a directory for the option value is not available for GnuTLS versions
17997 preceding 3.3.6 and a single file must be used.
17998
17999 With OpenSSL the certificates specified
18000 explicitly
18001 either by file or directory
18002 are added to those given by the system default location.
18003
18004 These certificates should be for the certificate authorities trusted, rather
18005 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18006 the value is a file then the certificates are sent by Exim as a server to
18007 connecting clients, defining the list of accepted certificate authorities.
18008 Thus the values defined should be considered public data.  To avoid this,
18009 use the explicit directory version.
18010
18011 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18012
18013 A forced expansion failure or setting to an empty string is equivalent to
18014 being unset.
18015
18016
18017 .option tls_verify_hosts main "host list&!!" unset
18018 .cindex "TLS" "client certificate verification"
18019 .cindex "certificate" "verification of client"
18020 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18021 certificates from clients. The expected certificates are defined by
18022 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18023 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18024 &%tls_verify_certificates%& is not set.
18025
18026 Any client that matches &%tls_verify_hosts%& is constrained by
18027 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18028 present one of the listed certificates. If it does not, the connection is
18029 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18030 the host to use TLS. It can still send SMTP commands through unencrypted
18031 connections. Forcing a client to use TLS has to be done separately using an
18032 ACL to reject inappropriate commands when the connection is not encrypted.
18033
18034 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18035 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18036 certificate and checks it against &%tls_verify_certificates%&, but does not
18037 abort the connection if there is no certificate or if it does not match. This
18038 state can be detected in an ACL, which makes it possible to implement policies
18039 such as &"accept for relay only if a verified certificate has been received,
18040 but accept for local delivery if encrypted, even without a verified
18041 certificate"&.
18042
18043 Client hosts that match neither of these lists are not asked to present
18044 certificates.
18045
18046
18047 .option trusted_groups main "string list&!!" unset
18048 .cindex "trusted groups"
18049 .cindex "groups" "trusted"
18050 This option is expanded just once, at the start of Exim's processing. If this
18051 option is set, any process that is running in one of the listed groups, or
18052 which has one of them as a supplementary group, is trusted. The groups can be
18053 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18054 details of what trusted callers are permitted to do. If neither
18055 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18056 are trusted.
18057
18058 .option trusted_users main "string list&!!" unset
18059 .cindex "trusted users"
18060 .cindex "user" "trusted"
18061 This option is expanded just once, at the start of Exim's processing. If this
18062 option is set, any process that is running as one of the listed users is
18063 trusted. The users can be specified numerically or by name. See section
18064 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18065 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18066 Exim user are trusted.
18067
18068 .option unknown_login main string&!! unset
18069 .cindex "uid (user id)" "unknown caller"
18070 .vindex "&$caller_uid$&"
18071 This is a specialized feature for use in unusual configurations. By default, if
18072 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18073 gives up. The &%unknown_login%& option can be used to set a login name to be
18074 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18075 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18076 is used for the user's real name (gecos field), unless this has been set by the
18077 &%-F%& option.
18078
18079 .option unknown_username main string unset
18080 See &%unknown_login%&.
18081
18082 .option untrusted_set_sender main "address list&!!" unset
18083 .cindex "trusted users"
18084 .cindex "sender" "setting by untrusted user"
18085 .cindex "untrusted user setting sender"
18086 .cindex "user" "untrusted setting sender"
18087 .cindex "envelope from"
18088 .cindex "envelope sender"
18089 When an untrusted user submits a message to Exim using the standard input, Exim
18090 normally creates an envelope sender address from the user's login and the
18091 default qualification domain. Data from the &%-f%& option (for setting envelope
18092 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18093 is used) is ignored.
18094
18095 However, untrusted users are permitted to set an empty envelope sender address,
18096 to declare that a message should never generate any bounces. For example:
18097 .code
18098 exim -f '<>' user@domain.example
18099 .endd
18100 .vindex "&$sender_ident$&"
18101 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18102 other envelope sender addresses in a controlled way. When it is set, untrusted
18103 users are allowed to set envelope sender addresses that match any of the
18104 patterns in the list. Like all address lists, the string is expanded. The
18105 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18106 users to setting senders that start with their login ids
18107 followed by a hyphen
18108 by a setting like this:
18109 .code
18110 untrusted_set_sender = ^$sender_ident-
18111 .endd
18112 If you want to allow untrusted users to set envelope sender addresses without
18113 restriction, you can use
18114 .code
18115 untrusted_set_sender = *
18116 .endd
18117 The &%untrusted_set_sender%& option applies to all forms of local input, but
18118 only to the setting of the envelope sender. It does not permit untrusted users
18119 to use the other options which trusted user can use to override message
18120 parameters. Furthermore, it does not stop Exim from removing an existing
18121 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18122 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18123 overriding these actions. The handling of the &'Sender:'& header is also
18124 described in section &<<SECTthesenhea>>&.
18125
18126 The log line for a message's arrival shows the envelope sender following
18127 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18128 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18129 envelope sender address, the user's login is shown in parentheses after the
18130 sender address.
18131
18132
18133 .option uucp_from_pattern main string "see below"
18134 .cindex "&""From""& line"
18135 .cindex "UUCP" "&""From""& line"
18136 Some applications that pass messages to an MTA via a command line interface use
18137 an initial line starting with &"From&~"& to pass the envelope sender. In
18138 particular, this is used by UUCP software. Exim recognizes such a line by means
18139 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18140 matches, the sender address is constructed by expanding the contents of
18141 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18142 default pattern recognizes lines in the following two forms:
18143 .code
18144 From ph10 Fri Jan  5 12:35 GMT 1996
18145 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18146 .endd
18147 The pattern can be seen by running
18148 .code
18149 exim -bP uucp_from_pattern
18150 .endd
18151 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18152 year in the second case. The first word after &"From&~"& is matched in the
18153 regular expression by a parenthesized subpattern. The default value for
18154 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18155 (&"ph10"& in the example above) as the message's sender. See also
18156 &%ignore_fromline_hosts%&.
18157
18158
18159 .option uucp_from_sender main string&!! &`$1`&
18160 See &%uucp_from_pattern%& above.
18161
18162
18163 .option warn_message_file main string unset
18164 .cindex "warning of delay" "customizing the message"
18165 .cindex "customizing" "warning message"
18166 This option defines a template file containing paragraphs of text to be used
18167 for constructing the warning message which is sent by Exim when a message has
18168 been in the queue for a specified amount of time, as specified by
18169 &%delay_warning%&. Details of the file's contents are given in chapter
18170 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
18171
18172
18173 .option write_rejectlog main boolean true
18174 .cindex "reject log" "disabling"
18175 If this option is set false, Exim no longer writes anything to the reject log.
18176 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18177 .ecindex IIDconfima
18178 .ecindex IIDmaiconf
18179
18180
18181
18182
18183 . ////////////////////////////////////////////////////////////////////////////
18184 . ////////////////////////////////////////////////////////////////////////////
18185
18186 .chapter "Generic options for routers" "CHAProutergeneric"
18187 .scindex IIDgenoprou1 "options" "generic; for routers"
18188 .scindex IIDgenoprou2 "generic options" "router"
18189 This chapter describes the generic options that apply to all routers.
18190 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18191
18192 For a general description of how a router operates, see sections
18193 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18194 which the preconditions are tested. The order of expansion of the options that
18195 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18196 &%headers_remove%&, &%transport%&.
18197
18198
18199
18200 .option address_data routers string&!! unset
18201 .cindex "router" "data attached to address"
18202 The string is expanded just before the router is run, that is, after all the
18203 precondition tests have succeeded. If the expansion is forced to fail, the
18204 router declines, the value of &%address_data%& remains unchanged, and the
18205 &%more%& option controls what happens next. Other expansion failures cause
18206 delivery of the address to be deferred.
18207
18208 .vindex "&$address_data$&"
18209 When the expansion succeeds, the value is retained with the address, and can be
18210 accessed using the variable &$address_data$& in the current router, subsequent
18211 routers, and the eventual transport.
18212
18213 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18214 that runs a user's filter file, the contents of &$address_data$& are accessible
18215 in the filter. This is not normally a problem, because such data is usually
18216 either not confidential or it &"belongs"& to the current user, but if you do
18217 put confidential data into &$address_data$& you need to remember this point.
18218
18219 Even if the router declines or passes, the value of &$address_data$& remains
18220 with the address, though it can be changed by another &%address_data%& setting
18221 on a subsequent router. If a router generates child addresses, the value of
18222 &$address_data$& propagates to them. This also applies to the special kind of
18223 &"child"& that is generated by a router with the &%unseen%& option.
18224
18225 The idea of &%address_data%& is that you can use it to look up a lot of data
18226 for the address once, and then pick out parts of the data later. For example,
18227 you could use a single LDAP lookup to return a string of the form
18228 .code
18229 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18230 .endd
18231 In the transport you could pick out the mailbox by a setting such as
18232 .code
18233 file = ${extract{mailbox}{$address_data}}
18234 .endd
18235 This makes the configuration file less messy, and also reduces the number of
18236 lookups (though Exim does cache lookups).
18237
18238 See also the &%set%& option below.
18239
18240 .vindex "&$sender_address_data$&"
18241 .vindex "&$address_data$&"
18242 The &%address_data%& facility is also useful as a means of passing information
18243 from one router to another, and from a router to a transport. In addition, if
18244 &$address_data$& is set by a router when verifying a recipient address from an
18245 ACL, it remains available for use in the rest of the ACL statement. After
18246 verifying a sender, the value is transferred to &$sender_address_data$&.
18247
18248
18249
18250 .option address_test routers&!? boolean true
18251 .oindex "&%-bt%&"
18252 .cindex "router" "skipping when address testing"
18253 If this option is set false, the router is skipped when routing is being tested
18254 by means of the &%-bt%& command line option. This can be a convenience when
18255 your first router sends messages to an external scanner, because it saves you
18256 having to set the &"already scanned"& indicator when testing real address
18257 routing.
18258
18259
18260
18261 .option cannot_route_message routers string&!! unset
18262 .cindex "router" "customizing &""cannot route""& message"
18263 .cindex "customizing" "&""cannot route""& message"
18264 This option specifies a text message that is used when an address cannot be
18265 routed because Exim has run out of routers. The default message is
18266 &"Unrouteable address"&. This option is useful only on routers that have
18267 &%more%& set false, or on the very last router in a configuration, because the
18268 value that is used is taken from the last router that is considered. This
18269 includes a router that is skipped because its preconditions are not met, as
18270 well as a router that declines. For example, using the default configuration,
18271 you could put:
18272 .code
18273 cannot_route_message = Remote domain not found in DNS
18274 .endd
18275 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18276 and
18277 .code
18278 cannot_route_message = Unknown local user
18279 .endd
18280 on the final router that checks for local users. If string expansion fails for
18281 this option, the default message is used. Unless the expansion failure was
18282 explicitly forced, a message about the failure is written to the main and panic
18283 logs, in addition to the normal message about the routing failure.
18284
18285
18286 .option caseful_local_part routers boolean false
18287 .cindex "case of local parts"
18288 .cindex "router" "case of local parts"
18289 By default, routers handle the local parts of addresses in a case-insensitive
18290 manner, though the actual case is preserved for transmission with the message.
18291 If you want the case of letters to be significant in a router, you must set
18292 this option true. For individual router options that contain address or local
18293 part lists (for example, &%local_parts%&), case-sensitive matching can be
18294 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18295 more details.
18296
18297 .vindex "&$local_part$&"
18298 .vindex "&$original_local_part$&"
18299 .vindex "&$parent_local_part$&"
18300 The value of the &$local_part$& variable is forced to lower case while a
18301 router is running unless &%caseful_local_part%& is set. When a router assigns
18302 an address to a transport, the value of &$local_part$& when the transport runs
18303 is the same as it was in the router. Similarly, when a router generates child
18304 addresses by aliasing or forwarding, the values of &$original_local_part$&
18305 and &$parent_local_part$& are those that were used by the redirecting router.
18306
18307 This option applies to the processing of an address by a router. When a
18308 recipient address is being processed in an ACL, there is a separate &%control%&
18309 modifier that can be used to specify case-sensitive processing within the ACL
18310 (see section &<<SECTcontrols>>&).
18311
18312
18313
18314 .option check_local_user routers&!? boolean false
18315 .cindex "local user, checking in router"
18316 .cindex "router" "checking for local user"
18317 .cindex "&_/etc/passwd_&"
18318 .vindex "&$home$&"
18319 When this option is true, Exim checks that the local part of the recipient
18320 address (with affixes removed if relevant) is the name of an account on the
18321 local system. The check is done by calling the &[getpwnam()]& function rather
18322 than trying to read &_/etc/passwd_& directly. This means that other methods of
18323 holding password data (such as NIS) are supported. If the local part is a local
18324 user, &$home$& is set from the password data, and can be tested in other
18325 preconditions that are evaluated after this one (the order of evaluation is
18326 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18327 overridden by &%router_home_directory%&. If the local part is not a local user,
18328 the router is skipped.
18329
18330 If you want to check that the local part is either the name of a local user
18331 or matches something else, you cannot combine &%check_local_user%& with a
18332 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18333 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18334 setting to achieve this. For example:
18335 .code
18336 local_parts = passwd;$local_part : lsearch;/etc/other/users
18337 .endd
18338 Note, however, that the side effects of &%check_local_user%& (such as setting
18339 up a home directory) do not occur when a &(passwd)& lookup is used in a
18340 &%local_parts%& (or any other) precondition.
18341
18342
18343
18344 .option condition routers&!? string&!! unset
18345 .cindex "router" "customized precondition"
18346 This option specifies a general precondition test that has to succeed for the
18347 router to be called. The &%condition%& option is the last precondition to be
18348 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18349 result is a forced failure, or an empty string, or one of the strings &"0"& or
18350 &"no"& or &"false"& (checked without regard to the case of the letters), the
18351 router is skipped, and the address is offered to the next one.
18352
18353 If the result is any other value, the router is run (as this is the last
18354 precondition to be evaluated, all the other preconditions must be true).
18355
18356 This option is unusual in that multiple &%condition%& options may be present.
18357 All &%condition%& options must succeed.
18358
18359 The &%condition%& option provides a means of applying custom conditions to the
18360 running of routers. Note that in the case of a simple conditional expansion,
18361 the default expansion values are exactly what is wanted. For example:
18362 .code
18363 condition = ${if >{$message_age}{600}}
18364 .endd
18365 Because of the default behaviour of the string expansion, this is equivalent to
18366 .code
18367 condition = ${if >{$message_age}{600}{true}{}}
18368 .endd
18369
18370 A multiple condition example, which succeeds:
18371 .code
18372 condition = ${if >{$message_age}{600}}
18373 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18374 condition = foobar
18375 .endd
18376
18377 If the expansion fails (other than forced failure) delivery is deferred. Some
18378 of the other precondition options are common special cases that could in fact
18379 be specified using &%condition%&.
18380
18381 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18382 are far older, and use one set of semantics.  ACLs are newer and when
18383 they were created, the ACL &%condition%& process was given far stricter
18384 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18385 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18386 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18387 Router rules processing behavior.
18388
18389 This is best illustrated in an example:
18390 .code
18391 # If used in an ACL condition will fail with a syntax error, but
18392 # in a router condition any extra characters are treated as a string
18393
18394 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18395 true {yes} {no}}
18396
18397 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18398  {yes} {no}}
18399 .endd
18400 In each example above, the &%if%& statement actually ends after
18401 &"{google.com}}"&.  Since no true or false braces were defined, the
18402 default &%if%& behavior is to return a boolean true or a null answer
18403 (which evaluates to false). The rest of the line is then treated as a
18404 string. So the first example resulted in the boolean answer &"true"&
18405 with the string &" {yes} {no}}"& appended to it. The second example
18406 resulted in the null output (indicating false) with the string
18407 &" {yes} {no}}"& appended to it.
18408
18409 In fact you can put excess forward braces in too.  In the router
18410 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18411 mean something, like after a &"$"& or when required as part of a
18412 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18413 string characters.
18414
18415 Thus, in a Router, the above expansion strings will both always evaluate
18416 true, as the result of expansion is a non-empty string which doesn't
18417 match an explicit false value.  This can be tricky to debug.  By
18418 contrast, in an ACL either of those strings will always result in an
18419 expansion error because the result doesn't look sufficiently boolean.
18420
18421
18422 .option debug_print routers string&!! unset
18423 .cindex "testing" "variables in drivers"
18424 If this option is set and debugging is enabled (see the &%-d%& command line
18425 option) or in address-testing mode (see the &%-bt%& command line option),
18426 the string is expanded and included in the debugging output.
18427 If expansion of the string fails, the error message is written to the debugging
18428 output, and Exim carries on processing.
18429 This option is provided to help with checking out the values of variables and
18430 so on when debugging router configurations. For example, if a &%condition%&
18431 option appears not to be working, &%debug_print%& can be used to output the
18432 variables it references. The output happens after checks for &%domains%&,
18433 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18434 are tested. A newline is added to the text if it does not end with one.
18435 The variable &$router_name$& contains the name of the router.
18436
18437
18438
18439 .option disable_logging routers boolean false
18440 If this option is set true, nothing is logged for any routing errors
18441 or for any deliveries caused by this router. You should not set this option
18442 unless you really, really know what you are doing. See also the generic
18443 transport option of the same name.
18444
18445 .option dnssec_request_domains routers "domain list&!!" *
18446 .cindex "MX record" "security"
18447 .cindex "DNSSEC" "MX lookup"
18448 .cindex "security" "MX lookup"
18449 .cindex "DNS" "DNSSEC"
18450 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18451 the dnssec request bit set.
18452 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18453
18454 .option dnssec_require_domains routers "domain list&!!" unset
18455 .cindex "MX record" "security"
18456 .cindex "DNSSEC" "MX lookup"
18457 .cindex "security" "MX lookup"
18458 .cindex "DNS" "DNSSEC"
18459 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18460 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18461 (AD bit) set will be ignored and logged as a host-lookup failure.
18462 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18463
18464
18465 .option domains routers&!? "domain list&!!" unset
18466 .cindex "router" "restricting to specific domains"
18467 .vindex "&$domain_data$&"
18468 If this option is set, the router is skipped unless the current domain matches
18469 the list. If the match is achieved by means of a file lookup, the data that the
18470 lookup returned for the domain is placed in &$domain_data$& for use in string
18471 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18472 a list of the order in which preconditions are evaluated.
18473
18474
18475
18476 .option driver routers string unset
18477 This option must always be set. It specifies which of the available routers is
18478 to be used.
18479
18480
18481 .option dsn_lasthop routers boolean false
18482 .cindex "DSN" "success"
18483 .cindex "Delivery Status Notification" "success"
18484 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18485 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18486 instead send a success DSN as if the next hop does not support DSN.
18487 Not effective on redirect routers.
18488
18489
18490
18491 .option errors_to routers string&!! unset
18492 .cindex "envelope from"
18493 .cindex "envelope sender"
18494 .cindex "router" "changing address for errors"
18495 If a router successfully handles an address, it may assign the address to a
18496 transport for delivery or it may generate child addresses. In both cases, if
18497 there is a delivery problem during later processing, the resulting bounce
18498 message is sent to the address that results from expanding this string,
18499 provided that the address verifies successfully. The &%errors_to%& option is
18500 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18501
18502 The &%errors_to%& setting associated with an address can be overridden if it
18503 subsequently passes through other routers that have their own &%errors_to%&
18504 settings, or if the message is delivered by a transport with a &%return_path%&
18505 setting.
18506
18507 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18508 the expansion fails to verify, the errors address associated with the incoming
18509 address is used. At top level, this is the envelope sender. A non-forced
18510 expansion failure causes delivery to be deferred.
18511
18512 If an address for which &%errors_to%& has been set ends up being delivered over
18513 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18514 any bounces that are generated by other MTAs on the delivery route are also
18515 sent there. You can set &%errors_to%& to the empty string by either of these
18516 settings:
18517 .code
18518 errors_to =
18519 errors_to = ""
18520 .endd
18521 An expansion item that yields an empty string has the same effect. If you do
18522 this, a locally detected delivery error for addresses processed by this router
18523 no longer gives rise to a bounce message; the error is discarded. If the
18524 address is delivered to a remote host, the return path is set to &`<>`&, unless
18525 overridden by the &%return_path%& option on the transport.
18526
18527 .vindex "&$address_data$&"
18528 If for some reason you want to discard local errors, but use a non-empty
18529 MAIL command for remote delivery, you can preserve the original return
18530 path in &$address_data$& in the router, and reinstate it in the transport by
18531 setting &%return_path%&.
18532
18533 The most common use of &%errors_to%& is to direct mailing list bounces to the
18534 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18535 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18536
18537
18538
18539 .option expn routers&!? boolean true
18540 .cindex "address" "testing"
18541 .cindex "testing" "addresses"
18542 .cindex "EXPN" "router skipping"
18543 .cindex "router" "skipping for EXPN"
18544 If this option is turned off, the router is skipped when testing an address
18545 as a result of processing an SMTP EXPN command. You might, for example,
18546 want to turn it off on a router for users' &_.forward_& files, while leaving it
18547 on for the system alias file.
18548 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18549 are evaluated.
18550
18551 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18552 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18553 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18554
18555
18556
18557 .option fail_verify routers boolean false
18558 .cindex "router" "forcing verification failure"
18559 Setting this option has the effect of setting both &%fail_verify_sender%& and
18560 &%fail_verify_recipient%& to the same value.
18561
18562
18563
18564 .option fail_verify_recipient routers boolean false
18565 If this option is true and an address is accepted by this router when
18566 verifying a recipient, verification fails.
18567
18568
18569
18570 .option fail_verify_sender routers boolean false
18571 If this option is true and an address is accepted by this router when
18572 verifying a sender, verification fails.
18573
18574
18575
18576 .option fallback_hosts routers "string list" unset
18577 .cindex "router" "fallback hosts"
18578 .cindex "fallback" "hosts specified on router"
18579 String expansion is not applied to this option. The argument must be a
18580 colon-separated list of host names or IP addresses. The list separator can be
18581 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18582 each name or address. In fact, the format of each item is exactly the same as
18583 defined for the list of hosts in a &(manualroute)& router (see section
18584 &<<SECTformatonehostitem>>&).
18585
18586 If a router queues an address for a remote transport, this host list is
18587 associated with the address, and used instead of the transport's fallback host
18588 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18589 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18590 transport for further details.
18591
18592
18593 .option group routers string&!! "see below"
18594 .cindex "gid (group id)" "local delivery"
18595 .cindex "local transports" "uid and gid"
18596 .cindex "transport" "local"
18597 .cindex "router" "setting group"
18598 When a router queues an address for a transport, and the transport does not
18599 specify a group, the group given here is used when running the delivery
18600 process.
18601 The group may be specified numerically or by name. If expansion fails, the
18602 error is logged and delivery is deferred.
18603 The default is unset, unless &%check_local_user%& is set, when the default
18604 is taken from the password information. See also &%initgroups%& and &%user%&
18605 and the discussion in chapter &<<CHAPenvironment>>&.
18606
18607
18608
18609 .option headers_add routers list&!! unset
18610 .cindex "header lines" "adding"
18611 .cindex "router" "adding header lines"
18612 This option specifies a list of text headers,
18613 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18614 that is associated with any addresses that are accepted by the router.
18615 Each item is separately expanded, at routing time.  However, this
18616 option has no effect when an address is just being verified. The way in which
18617 the text is used to add header lines at transport time is described in section
18618 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18619 message is in the process of being transported. This means that references to
18620 header lines in string expansions in the transport's configuration do not
18621 &"see"& the added header lines.
18622
18623 The &%headers_add%& option is expanded after &%errors_to%&, but before
18624 &%headers_remove%& and &%transport%&. If an item is empty, or if
18625 an item expansion is forced to fail, the item has no effect. Other expansion
18626 failures are treated as configuration errors.
18627
18628 Unlike most options, &%headers_add%& can be specified multiple times
18629 for a router; all listed headers are added.
18630
18631 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18632 router that has the &%one_time%& option set.
18633
18634 .cindex "duplicate addresses"
18635 .oindex "&%unseen%&"
18636 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18637 additions are deleted when the address is passed on to subsequent routers.
18638 For a &%redirect%& router, if a generated address is the same as the incoming
18639 address, this can lead to duplicate addresses with different header
18640 modifications. Exim does not do duplicate deliveries (except, in certain
18641 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18642 which of the duplicates is discarded, so this ambiguous situation should be
18643 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18644
18645
18646
18647 .option headers_remove routers list&!! unset
18648 .cindex "header lines" "removing"
18649 .cindex "router" "removing header lines"
18650 This option specifies a list of text headers,
18651 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18652 that is associated with any addresses that are accepted by the router.
18653 Each item is separately expanded, at routing time.  However, this
18654 option has no effect when an address is just being verified. The way in which
18655 the text is used to remove header lines at transport time is described in
18656 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18657 the message is in the process of being transported. This means that references
18658 to header lines in string expansions in the transport's configuration still
18659 &"see"& the original header lines.
18660
18661 The &%headers_remove%& option is expanded after &%errors_to%& and
18662 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18663 the item has no effect. Other expansion failures are treated as configuration
18664 errors.
18665
18666 Unlike most options, &%headers_remove%& can be specified multiple times
18667 for a router; all listed headers are removed.
18668
18669 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18670 router that has the &%one_time%& option set.
18671
18672 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18673 removal requests are deleted when the address is passed on to subsequent
18674 routers, and this can lead to problems with duplicates -- see the similar
18675 warning for &%headers_add%& above.
18676
18677 &*Warning 3*&: Because of the separate expansion of the list items,
18678 items that contain a list separator must have it doubled.
18679 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18680
18681
18682
18683 .option ignore_target_hosts routers "host list&!!" unset
18684 .cindex "IP address" "discarding"
18685 .cindex "router" "discarding IP addresses"
18686 Although this option is a host list, it should normally contain IP address
18687 entries rather than names. If any host that is looked up by the router has an
18688 IP address that matches an item in this list, Exim behaves as if that IP
18689 address did not exist. This option allows you to cope with rogue DNS entries
18690 like
18691 .code
18692 remote.domain.example.  A  127.0.0.1
18693 .endd
18694 by setting
18695 .code
18696 ignore_target_hosts = 127.0.0.1
18697 .endd
18698 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18699 discarded in this way, the router declines. In a conventional configuration, an
18700 attempt to mail to such a domain would normally provoke the &"unrouteable
18701 domain"& error, and an attempt to verify an address in the domain would fail.
18702 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18703 router declines if presented with one of the listed addresses.
18704
18705 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18706 means of the first or the second of the following settings, respectively:
18707 .code
18708 ignore_target_hosts = 0.0.0.0/0
18709 ignore_target_hosts = <; 0::0/0
18710 .endd
18711 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18712 in the second line matches all IPv6 addresses.
18713
18714 This option may also be useful for ignoring link-local and site-local IPv6
18715 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18716 is expanded before use as a list, it is possible to make it dependent on the
18717 domain that is being routed.
18718
18719 .vindex "&$host_address$&"
18720 During its expansion, &$host_address$& is set to the IP address that is being
18721 checked.
18722
18723 .option initgroups routers boolean false
18724 .cindex "additional groups"
18725 .cindex "groups" "additional"
18726 .cindex "local transports" "uid and gid"
18727 .cindex "transport" "local"
18728 If the router queues an address for a transport, and this option is true, and
18729 the uid supplied by the router is not overridden by the transport, the
18730 &[initgroups()]& function is called when running the transport to ensure that
18731 any additional groups associated with the uid are set up. See also &%group%&
18732 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18733
18734
18735
18736 .option local_part_prefix routers&!? "string list" unset
18737 .cindex affix "router precondition"
18738 .cindex "router" "prefix for local part"
18739 .cindex "prefix" "for local part, used in router"
18740 If this option is set, the router is skipped unless the local part starts with
18741 one of the given strings, or &%local_part_prefix_optional%& is true. See
18742 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18743 evaluated.
18744
18745 The list is scanned from left to right, and the first prefix that matches is
18746 used. A limited form of wildcard is available; if the prefix begins with an
18747 asterisk, it matches the longest possible sequence of arbitrary characters at
18748 the start of the local part. An asterisk should therefore always be followed by
18749 some character that does not occur in normal local parts.
18750 .cindex "multiple mailboxes"
18751 .cindex "mailbox" "multiple"
18752 Wildcarding can be used to set up multiple user mailboxes, as described in
18753 section &<<SECTmulbox>>&.
18754
18755 .vindex "&$local_part$&"
18756 .vindex "&$local_part_prefix$&"
18757 During the testing of the &%local_parts%& option, and while the router is
18758 running, the prefix is removed from the local part, and is available in the
18759 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18760 the router accepts the address, this remains true during subsequent delivery by
18761 a transport. In particular, the local part that is transmitted in the RCPT
18762 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18763 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18764 the relevant transport.
18765
18766 When an address is being verified, &%local_part_prefix%& affects only the
18767 behaviour of the router. If the callout feature of verification is in use, this
18768 means that the full address, including the prefix, will be used during the
18769 callout.
18770
18771 The prefix facility is commonly used to handle local parts of the form
18772 &%owner-something%&. Another common use is to support local parts of the form
18773 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18774 to tell a user their forwarding is broken &-- by placing a router like this one
18775 immediately before the router that handles &_.forward_& files:
18776 .code
18777 real_localuser:
18778   driver = accept
18779   local_part_prefix = real-
18780   check_local_user
18781   transport = local_delivery
18782 .endd
18783 For security, it would probably be a good idea to restrict the use of this
18784 router to locally-generated messages, using a condition such as this:
18785 .code
18786   condition = ${if match {$sender_host_address}\
18787                          {\N^(|127\.0\.0\.1)$\N}}
18788 .endd
18789
18790 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18791 both conditions must be met if not optional. Care must be taken if wildcards
18792 are used in both a prefix and a suffix on the same router. Different
18793 separator characters must be used to avoid ambiguity.
18794
18795
18796 .option local_part_prefix_optional routers boolean false
18797 See &%local_part_prefix%& above.
18798
18799
18800
18801 .option local_part_suffix routers&!? "string list" unset
18802 .cindex "router" "suffix for local part"
18803 .cindex "suffix for local part" "used in router"
18804 This option operates in the same way as &%local_part_prefix%&, except that the
18805 local part must end (rather than start) with the given string, the
18806 &%local_part_suffix_optional%& option determines whether the suffix is
18807 mandatory, and the wildcard * character, if present, must be the last
18808 character of the suffix. This option facility is commonly used to handle local
18809 parts of the form &%something-request%& and multiple user mailboxes of the form
18810 &%username-foo%&.
18811
18812
18813 .option local_part_suffix_optional routers boolean false
18814 See &%local_part_suffix%& above.
18815
18816
18817
18818 .option local_parts routers&!? "local part list&!!" unset
18819 .cindex "router" "restricting to specific local parts"
18820 .cindex "local part" "checking in router"
18821 The router is run only if the local part of the address matches the list.
18822 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18823 are evaluated, and
18824 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18825 string is expanded, it is possible to make it depend on the domain, for
18826 example:
18827 .code
18828 local_parts = dbm;/usr/local/specials/$domain
18829 .endd
18830 .vindex "&$local_part_data$&"
18831 If the match is achieved by a lookup, the data that the lookup returned
18832 for the local part is placed in the variable &$local_part_data$& for use in
18833 expansions of the router's private options. You might use this option, for
18834 example, if you have a large number of local virtual domains, and you want to
18835 send all postmaster mail to the same place without having to set up an alias in
18836 each virtual domain:
18837 .code
18838 postmaster:
18839   driver = redirect
18840   local_parts = postmaster
18841   data = postmaster@real.domain.example
18842 .endd
18843
18844
18845 .option log_as_local routers boolean "see below"
18846 .cindex "log" "delivery line"
18847 .cindex "delivery" "log line format"
18848 Exim has two logging styles for delivery, the idea being to make local
18849 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18850 recipient address is given just as the local part, without a domain. The use of
18851 this style is controlled by this option. It defaults to true for the &(accept)&
18852 router, and false for all the others. This option applies only when a
18853 router assigns an address to a transport. It has no effect on routers that
18854 redirect addresses.
18855
18856
18857
18858 .option more routers boolean&!! true
18859 The result of string expansion for this option must be a valid boolean value,
18860 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18861 result causes an error, and delivery is deferred. If the expansion is forced to
18862 fail, the default value for the option (true) is used. Other failures cause
18863 delivery to be deferred.
18864
18865 If this option is set false, and the router declines to handle the address, no
18866 further routers are tried, routing fails, and the address is bounced.
18867 .oindex "&%self%&"
18868 However, if the router explicitly passes an address to the following router by
18869 means of the setting
18870 .code
18871 self = pass
18872 .endd
18873 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18874 does not affect the behaviour if one of the precondition tests fails. In that
18875 case, the address is always passed to the next router.
18876
18877 Note that &%address_data%& is not considered to be a precondition. If its
18878 expansion is forced to fail, the router declines, and the value of &%more%&
18879 controls what happens next.
18880
18881
18882 .option pass_on_timeout routers boolean false
18883 .cindex "timeout" "of router"
18884 .cindex "router" "timeout"
18885 If a router times out during a host lookup, it normally causes deferral of the
18886 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18887 router, overriding &%no_more%&. This may be helpful for systems that are
18888 intermittently connected to the Internet, or those that want to pass to a smart
18889 host any messages that cannot immediately be delivered.
18890
18891 There are occasional other temporary errors that can occur while doing DNS
18892 lookups. They are treated in the same way as a timeout, and this option
18893 applies to all of them.
18894
18895
18896
18897 .option pass_router routers string unset
18898 .cindex "router" "go to after &""pass""&"
18899 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18900 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18901 routing to continue, and overriding a false setting of &%more%&. When one of
18902 these routers returns &"pass"&, the address is normally handed on to the next
18903 router in sequence. This can be changed by setting &%pass_router%& to the name
18904 of another router. However (unlike &%redirect_router%&) the named router must
18905 be below the current router, to avoid loops. Note that this option applies only
18906 to the special case of &"pass"&. It does not apply when a router returns
18907 &"decline"& because it cannot handle an address.
18908
18909
18910
18911 .option redirect_router routers string unset
18912 .cindex "router" "start at after redirection"
18913 Sometimes an administrator knows that it is pointless to reprocess addresses
18914 generated from alias or forward files with the same router again. For
18915 example, if an alias file translates real names into login ids there is no
18916 point searching the alias file a second time, especially if it is a large file.
18917
18918 The &%redirect_router%& option can be set to the name of any router instance.
18919 It causes the routing of any generated addresses to start at the named router
18920 instead of at the first router. This option has no effect if the router in
18921 which it is set does not generate new addresses.
18922
18923
18924
18925 .option require_files routers&!? "string list&!!" unset
18926 .cindex "file" "requiring for router"
18927 .cindex "router" "requiring file existence"
18928 This option provides a general mechanism for predicating the running of a
18929 router on the existence or non-existence of certain files or directories.
18930 Before running a router, as one of its precondition tests, Exim works its way
18931 through the &%require_files%& list, expanding each item separately.
18932
18933 Because the list is split before expansion, any colons in expansion items must
18934 be doubled, or the facility for using a different list separator must be used
18935 (&<<SECTlistsepchange>>&).
18936 If any expansion is forced to fail, the item is ignored. Other expansion
18937 failures cause routing of the address to be deferred.
18938
18939 If any expanded string is empty, it is ignored. Otherwise, except as described
18940 below, each string must be a fully qualified file path, optionally preceded by
18941 &"!"&. The paths are passed to the &[stat()]& function to test for the
18942 existence of the files or directories. The router is skipped if any paths not
18943 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18944
18945 .cindex "NFS"
18946 If &[stat()]& cannot determine whether a file exists or not, delivery of
18947 the message is deferred. This can happen when NFS-mounted filesystems are
18948 unavailable.
18949
18950 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18951 options, so you cannot use it to check for the existence of a file in which to
18952 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18953 full list of the order in which preconditions are evaluated.) However, as
18954 these options are all expanded, you can use the &%exists%& expansion condition
18955 to make such tests. The &%require_files%& option is intended for checking files
18956 that the router may be going to use internally, or which are needed by a
18957 transport (e.g., &_.procmailrc_&).
18958
18959 During delivery, the &[stat()]& function is run as root, but there is a
18960 facility for some checking of the accessibility of a file by another user.
18961 This is not a proper permissions check, but just a &"rough"& check that
18962 operates as follows:
18963
18964 If an item in a &%require_files%& list does not contain any forward slash
18965 characters, it is taken to be the user (and optional group, separated by a
18966 comma) to be checked for subsequent files in the list. If no group is specified
18967 but the user is specified symbolically, the gid associated with the uid is
18968 used. For example:
18969 .code
18970 require_files = mail:/some/file
18971 require_files = $local_part:$home/.procmailrc
18972 .endd
18973 If a user or group name in a &%require_files%& list does not exist, the
18974 &%require_files%& condition fails.
18975
18976 Exim performs the check by scanning along the components of the file path, and
18977 checking the access for the given uid and gid. It checks for &"x"& access on
18978 directories, and &"r"& access on the final file. Note that this means that file
18979 access control lists, if the operating system has them, are ignored.
18980
18981 &*Warning 1*&: When the router is being run to verify addresses for an
18982 incoming SMTP message, Exim is not running as root, but under its own uid. This
18983 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18984 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18985 user is not permitted to read one of the directories on the file's path.
18986
18987 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18988 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18989 without root access. In this case, if a check for access by a particular user
18990 is requested, Exim creates a subprocess that runs as that user, and tries the
18991 check again in that process.
18992
18993 The default action for handling an unresolved EACCES is to consider it to
18994 be caused by a configuration error, and routing is deferred because the
18995 existence or non-existence of the file cannot be determined. However, in some
18996 circumstances it may be desirable to treat this condition as if the file did
18997 not exist. If the filename (or the exclamation mark that precedes the filename
18998 for non-existence) is preceded by a plus sign, the EACCES error is treated
18999 as if the file did not exist. For example:
19000 .code
19001 require_files = +/some/file
19002 .endd
19003 If the router is not an essential part of verification (for example, it
19004 handles users' &_.forward_& files), another solution is to set the &%verify%&
19005 option false so that the router is skipped when verifying.
19006
19007
19008
19009 .option retry_use_local_part routers boolean "see below"
19010 .cindex "hints database" "retry keys"
19011 .cindex "local part" "in retry keys"
19012 When a delivery suffers a temporary routing failure, a retry record is created
19013 in Exim's hints database. For addresses whose routing depends only on the
19014 domain, the key for the retry record should not involve the local part, but for
19015 other addresses, both the domain and the local part should be included.
19016 Usually, remote routing is of the former kind, and local routing is of the
19017 latter kind.
19018
19019 This option controls whether the local part is used to form the key for retry
19020 hints for addresses that suffer temporary errors while being handled by this
19021 router. The default value is true for any router that has any of
19022 &%check_local_user%&,
19023 &%local_parts%&,
19024 &%condition%&,
19025 &%local_part_prefix%&,
19026 &%local_part_suffix%&,
19027 &%senders%& or
19028 &%require_files%&
19029 set, and false otherwise. Note that this option does not apply to hints keys
19030 for transport delays; they are controlled by a generic transport option of the
19031 same name.
19032
19033 Failing to set this option when it is needed
19034 (because a remote router handles only some of the local-parts for a domain)
19035 can result in incorrect error messages being generated.
19036
19037 The setting of &%retry_use_local_part%& applies only to the router on which it
19038 appears. If the router generates child addresses, they are routed
19039 independently; this setting does not become attached to them.
19040
19041
19042
19043 .option router_home_directory routers string&!! unset
19044 .cindex "router" "home directory for"
19045 .cindex "home directory" "for router"
19046 .vindex "&$home$&"
19047 This option sets a home directory for use while the router is running. (Compare
19048 &%transport_home_directory%&, which sets a home directory for later
19049 transporting.) In particular, if used on a &(redirect)& router, this option
19050 sets a value for &$home$& while a filter is running. The value is expanded;
19051 forced expansion failure causes the option to be ignored &-- other failures
19052 cause the router to defer.
19053
19054 Expansion of &%router_home_directory%& happens immediately after the
19055 &%check_local_user%& test (if configured), before any further expansions take
19056 place.
19057 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19058 are evaluated.)
19059 While the router is running, &%router_home_directory%& overrides the value of
19060 &$home$& that came from &%check_local_user%&.
19061
19062 When a router accepts an address and assigns it to a local transport (including
19063 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19064 delivery), the home directory setting for the transport is taken from the first
19065 of these values that is set:
19066
19067 .ilist
19068 The &%home_directory%& option on the transport;
19069 .next
19070 The &%transport_home_directory%& option on the router;
19071 .next
19072 The password data if &%check_local_user%& is set on the router;
19073 .next
19074 The &%router_home_directory%& option on the router.
19075 .endlist
19076
19077 In other words, &%router_home_directory%& overrides the password data for the
19078 router, but not for the transport.
19079
19080
19081
19082 .option self routers string freeze
19083 .cindex "MX record" "pointing to local host"
19084 .cindex "local host" "MX pointing to"
19085 This option applies to those routers that use a recipient address to find a
19086 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19087 and &(manualroute)& routers.
19088 Certain configurations of the &(queryprogram)& router can also specify a list
19089 of remote hosts.
19090 Usually such routers are configured to send the message to a remote host via an
19091 &(smtp)& transport. The &%self%& option specifies what happens when the first
19092 host on the list turns out to be the local host.
19093 The way in which Exim checks for the local host is described in section
19094 &<<SECTreclocipadd>>&.
19095
19096 Normally this situation indicates either an error in Exim's configuration (for
19097 example, the router should be configured not to process this domain), or an
19098 error in the DNS (for example, the MX should not point to this host). For this
19099 reason, the default action is to log the incident, defer the address, and
19100 freeze the message. The following alternatives are provided for use in special
19101 cases:
19102
19103 .vlist
19104 .vitem &%defer%&
19105 Delivery of the message is tried again later, but the message is not frozen.
19106
19107 .vitem "&%reroute%&: <&'domain'&>"
19108 The domain is changed to the given domain, and the address is passed back to
19109 be reprocessed by the routers. No rewriting of headers takes place. This
19110 behaviour is essentially a redirection.
19111
19112 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19113 The domain is changed to the given domain, and the address is passed back to be
19114 reprocessed by the routers. Any headers that contain the original domain are
19115 rewritten.
19116
19117 .vitem &%pass%&
19118 .oindex "&%more%&"
19119 .vindex "&$self_hostname$&"
19120 The router passes the address to the next router, or to the router named in the
19121 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19122 subsequent routing and delivery, the variable &$self_hostname$& contains the
19123 name of the local host that the router encountered. This can be used to
19124 distinguish between different cases for hosts with multiple names. The
19125 combination
19126 .code
19127 self = pass
19128 no_more
19129 .endd
19130 ensures that only those addresses that routed to the local host are passed on.
19131 Without &%no_more%&, addresses that were declined for other reasons would also
19132 be passed to the next router.
19133
19134 .vitem &%fail%&
19135 Delivery fails and an error report is generated.
19136
19137 .vitem &%send%&
19138 .cindex "local host" "sending to"
19139 The anomaly is ignored and the address is queued for the transport. This
19140 setting should be used with extreme caution. For an &(smtp)& transport, it
19141 makes sense only in cases where the program that is listening on the SMTP port
19142 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19143 different configuration file that handles the domain in another way.
19144 .endlist
19145
19146
19147
19148 .option senders routers&!? "address list&!!" unset
19149 .cindex "router" "checking senders"
19150 If this option is set, the router is skipped unless the message's sender
19151 address matches something on the list.
19152 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19153 are evaluated.
19154
19155 There are issues concerning verification when the running of routers is
19156 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19157 setting, it sets the sender to the null string. When using the &%-bt%& option
19158 to check a configuration file, it is necessary also to use the &%-f%& option to
19159 set an appropriate sender. For incoming mail, the sender is unset when
19160 verifying the sender, but is available when verifying any recipients. If the
19161 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19162 matters.
19163
19164
19165 .option set routers "string list" unset
19166 .cindex router variables
19167 This option may be used multiple times on a router;
19168 because of this the list aspect is mostly irrelevant.
19169 The list separator is a semicolon but can be changed in the
19170 usual way.
19171
19172 Each list-element given must be of the form &"name = value"&
19173 and the names used must start with the string &"r_"&.
19174 Values containing a list-separator should have them doubled.
19175 When a router runs, the strings are evaluated in order,
19176 to create variables which are added to the set associated with
19177 the address.
19178 The variable is set with the expansion of the value.
19179 The variables can be used by the router options
19180 (not including any preconditions)
19181 and by the transport.
19182 Later definitions of a given named variable will override former ones.
19183 Variable use is via the usual &$r_...$& syntax.
19184
19185 This is similar to the &%address_data%& option, except that
19186 many independent variables can be used, with choice of naming.
19187
19188
19189 .option translate_ip_address routers string&!! unset
19190 .cindex "IP address" "translating"
19191 .cindex "packet radio"
19192 .cindex "router" "IP address translation"
19193 There exist some rare networking situations (for example, packet radio) where
19194 it is helpful to be able to translate IP addresses generated by normal routing
19195 mechanisms into other IP addresses, thus performing a kind of manual IP
19196 routing. This should be done only if the normal IP routing of the TCP/IP stack
19197 is inadequate or broken. Because this is an extremely uncommon requirement, the
19198 code to support this option is not included in the Exim binary unless
19199 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19200
19201 .vindex "&$host_address$&"
19202 The &%translate_ip_address%& string is expanded for every IP address generated
19203 by the router, with the generated address set in &$host_address$&. If the
19204 expansion is forced to fail, no action is taken.
19205 For any other expansion error, delivery of the message is deferred.
19206 If the result of the expansion is an IP address, that replaces the original
19207 address; otherwise the result is assumed to be a host name &-- this is looked
19208 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19209 produce one or more replacement IP addresses. For example, to subvert all IP
19210 addresses in some specific networks, this could be added to a router:
19211 .code
19212 translate_ip_address = \
19213   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19214     {$value}fail}}
19215 .endd
19216 The file would contain lines like
19217 .code
19218 10.2.3.128/26    some.host
19219 10.8.4.34/26     10.44.8.15
19220 .endd
19221 You should not make use of this facility unless you really understand what you
19222 are doing.
19223
19224
19225
19226 .option transport routers string&!! unset
19227 This option specifies the transport to be used when a router accepts an address
19228 and sets it up for delivery. A transport is never needed if a router is used
19229 only for verification. The value of the option is expanded at routing time,
19230 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19231 and result must be the name of one of the configured transports. If it is not,
19232 delivery is deferred.
19233
19234 The &%transport%& option is not used by the &(redirect)& router, but it does
19235 have some private options that set up transports for pipe and file deliveries
19236 (see chapter &<<CHAPredirect>>&).
19237
19238
19239
19240 .option transport_current_directory routers string&!! unset
19241 .cindex "current directory for local transport"
19242 This option associates a current directory with any address that is routed
19243 to a local transport. This can happen either because a transport is
19244 explicitly configured for the router, or because it generates a delivery to a
19245 file or a pipe. During the delivery process (that is, at transport time), this
19246 option string is expanded and is set as the current directory, unless
19247 overridden by a setting on the transport.
19248 If the expansion fails for any reason, including forced failure, an error is
19249 logged, and delivery is deferred.
19250 See chapter &<<CHAPenvironment>>& for details of the local delivery
19251 environment.
19252
19253
19254
19255
19256 .option transport_home_directory routers string&!! "see below"
19257 .cindex "home directory" "for local transport"
19258 This option associates a home directory with any address that is routed to a
19259 local transport. This can happen either because a transport is explicitly
19260 configured for the router, or because it generates a delivery to a file or a
19261 pipe. During the delivery process (that is, at transport time), the option
19262 string is expanded and is set as the home directory, unless overridden by a
19263 setting of &%home_directory%& on the transport.
19264 If the expansion fails for any reason, including forced failure, an error is
19265 logged, and delivery is deferred.
19266
19267 If the transport does not specify a home directory, and
19268 &%transport_home_directory%& is not set for the router, the home directory for
19269 the transport is taken from the password data if &%check_local_user%& is set for
19270 the router. Otherwise it is taken from &%router_home_directory%& if that option
19271 is set; if not, no home directory is set for the transport.
19272
19273 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19274 environment.
19275
19276
19277
19278
19279 .option unseen routers boolean&!! false
19280 .cindex "router" "carrying on after success"
19281 The result of string expansion for this option must be a valid boolean value,
19282 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19283 result causes an error, and delivery is deferred. If the expansion is forced to
19284 fail, the default value for the option (false) is used. Other failures cause
19285 delivery to be deferred.
19286
19287 When this option is set true, routing does not cease if the router accepts the
19288 address. Instead, a copy of the incoming address is passed to the next router,
19289 overriding a false setting of &%more%&. There is little point in setting
19290 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19291 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19292 sometimes true and sometimes false).
19293
19294 .cindex "copy of message (&%unseen%& option)"
19295 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19296 qualifier in filter files. It can be used to cause copies of messages to be
19297 delivered to some other destination, while also carrying out a normal delivery.
19298 In effect, the current address is made into a &"parent"& that has two children
19299 &-- one that is delivered as specified by this router, and a clone that goes on
19300 to be routed further. For this reason, &%unseen%& may not be combined with the
19301 &%one_time%& option in a &(redirect)& router.
19302
19303 &*Warning*&: Header lines added to the address (or specified for removal) by
19304 this router or by previous routers affect the &"unseen"& copy of the message
19305 only. The clone that continues to be processed by further routers starts with
19306 no added headers and none specified for removal. For a &%redirect%& router, if
19307 a generated address is the same as the incoming address, this can lead to
19308 duplicate addresses with different header modifications. Exim does not do
19309 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19310 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19311 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19312 &%redirect%& router may be of help.
19313
19314 Unlike the handling of header modifications, any data that was set by the
19315 &%address_data%& option in the current or previous routers &'is'& passed on to
19316 subsequent routers.
19317
19318
19319 .option user routers string&!! "see below"
19320 .cindex "uid (user id)" "local delivery"
19321 .cindex "local transports" "uid and gid"
19322 .cindex "transport" "local"
19323 .cindex "router" "user for filter processing"
19324 .cindex "filter" "user for processing"
19325 When a router queues an address for a transport, and the transport does not
19326 specify a user, the user given here is used when running the delivery process.
19327 The user may be specified numerically or by name. If expansion fails, the
19328 error is logged and delivery is deferred.
19329 This user is also used by the &(redirect)& router when running a filter file.
19330 The default is unset, except when &%check_local_user%& is set. In this case,
19331 the default is taken from the password information. If the user is specified as
19332 a name, and &%group%& is not set, the group associated with the user is used.
19333 See also &%initgroups%& and &%group%& and the discussion in chapter
19334 &<<CHAPenvironment>>&.
19335
19336
19337
19338 .option verify routers&!? boolean true
19339 Setting this option has the effect of setting &%verify_sender%& and
19340 &%verify_recipient%& to the same value.
19341
19342
19343 .option verify_only routers&!? boolean false
19344 .cindex "EXPN" "with &%verify_only%&"
19345 .oindex "&%-bv%&"
19346 .cindex "router" "used only when verifying"
19347 If this option is set, the router is used only when verifying an address,
19348 delivering in cutthrough mode or
19349 testing with the &%-bv%& option, not when actually doing a delivery, testing
19350 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19351 restricted to verifying only senders or recipients by means of
19352 &%verify_sender%& and &%verify_recipient%&.
19353
19354 &*Warning*&: When the router is being run to verify addresses for an incoming
19355 SMTP message, Exim is not running as root, but under its own uid. If the router
19356 accesses any files, you need to make sure that they are accessible to the Exim
19357 user or group.
19358
19359
19360 .option verify_recipient routers&!? boolean true
19361 If this option is false, the router is skipped when verifying recipient
19362 addresses,
19363 delivering in cutthrough mode
19364 or testing recipient verification using &%-bv%&.
19365 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19366 are evaluated.
19367 See also the &$verify_mode$& variable.
19368
19369
19370 .option verify_sender routers&!? boolean true
19371 If this option is false, the router is skipped when verifying sender addresses
19372 or testing sender verification using &%-bvs%&.
19373 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19374 are evaluated.
19375 See also the &$verify_mode$& variable.
19376 .ecindex IIDgenoprou1
19377 .ecindex IIDgenoprou2
19378
19379
19380
19381
19382
19383
19384 . ////////////////////////////////////////////////////////////////////////////
19385 . ////////////////////////////////////////////////////////////////////////////
19386
19387 .chapter "The accept router" "CHID4"
19388 .cindex "&(accept)& router"
19389 .cindex "routers" "&(accept)&"
19390 The &(accept)& router has no private options of its own. Unless it is being
19391 used purely for verification (see &%verify_only%&) a transport is required to
19392 be defined by the generic &%transport%& option. If the preconditions that are
19393 specified by generic options are met, the router accepts the address and queues
19394 it for the given transport. The most common use of this router is for setting
19395 up deliveries to local mailboxes. For example:
19396 .code
19397 localusers:
19398   driver = accept
19399   domains = mydomain.example
19400   check_local_user
19401   transport = local_delivery
19402 .endd
19403 The &%domains%& condition in this example checks the domain of the address, and
19404 &%check_local_user%& checks that the local part is the login of a local user.
19405 When both preconditions are met, the &(accept)& router runs, and queues the
19406 address for the &(local_delivery)& transport.
19407
19408
19409
19410
19411
19412
19413 . ////////////////////////////////////////////////////////////////////////////
19414 . ////////////////////////////////////////////////////////////////////////////
19415
19416 .chapter "The dnslookup router" "CHAPdnslookup"
19417 .scindex IIDdnsrou1 "&(dnslookup)& router"
19418 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19419 The &(dnslookup)& router looks up the hosts that handle mail for the
19420 recipient's domain in the DNS. A transport must always be set for this router,
19421 unless &%verify_only%& is set.
19422
19423 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19424 SRV records. If none are found, or if SRV support is not configured,
19425 MX records are looked up. If no MX records exist, address records are sought.
19426 However, &%mx_domains%& can be set to disable the direct use of address
19427 records.
19428
19429 MX records of equal priority are sorted by Exim into a random order. Exim then
19430 looks for address records for the host names obtained from MX or SRV records.
19431 When a host has more than one IP address, they are sorted into a random order,
19432 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19433 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19434 generic option, the router declines.
19435
19436 Unless they have the highest priority (lowest MX value), MX records that point
19437 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19438 are discarded, together with any other MX records of equal or lower priority.
19439
19440 .cindex "MX record" "pointing to local host"
19441 .cindex "local host" "MX pointing to"
19442 .oindex "&%self%&" "in &(dnslookup)& router"
19443 If the host pointed to by the highest priority MX record, or looked up as an
19444 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19445 happens is controlled by the generic &%self%& option.
19446
19447
19448 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19449 There have been problems with DNS servers when SRV records are looked up.
19450 Some misbehaving servers return a DNS error or timeout when a non-existent
19451 SRV record is sought. Similar problems have in the past been reported for
19452 MX records. The global &%dns_again_means_nonexist%& option can help with this
19453 problem, but it is heavy-handed because it is a global option.
19454
19455 For this reason, there are two options, &%srv_fail_domains%& and
19456 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19457 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19458 an attempt to look up an SRV or MX record causes one of these results, and the
19459 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19460 such record"&. In the case of an SRV lookup, this means that the router
19461 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19462 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19463 case routing fails.
19464
19465
19466 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19467 .cindex "&(dnslookup)& router" "declines"
19468 There are a few cases where a &(dnslookup)& router will decline to accept
19469 an address; if such a router is expected to handle "all remaining non-local
19470 domains", then it is important to set &%no_more%&.
19471
19472 The router will defer rather than decline if the domain
19473 is found in the &%fail_defer_domains%& router option.
19474
19475 Reasons for a &(dnslookup)& router to decline currently include:
19476 .ilist
19477 The domain does not exist in DNS
19478 .next
19479 The domain exists but the MX record's host part is just "."; this is a common
19480 convention (borrowed from SRV) used to indicate that there is no such service
19481 for this domain and to not fall back to trying A/AAAA records.
19482 .next
19483 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19484 .next
19485 MX record points to a non-existent host.
19486 .next
19487 MX record points to an IP address and the main section option
19488 &%allow_mx_to_ip%& is not set.
19489 .next
19490 MX records exist and point to valid hosts, but all hosts resolve only to
19491 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19492 .next
19493 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19494 &%dns_check_names_pattern%& for handling one variant of this)
19495 .next
19496 &%check_secondary_mx%& is set on this router but the local host can
19497 not be found in the MX records (see below)
19498 .endlist
19499
19500
19501
19502
19503 .section "Private options for dnslookup" "SECID118"
19504 .cindex "options" "&(dnslookup)& router"
19505 The private options for the &(dnslookup)& router are as follows:
19506
19507 .option check_secondary_mx dnslookup boolean false
19508 .cindex "MX record" "checking for secondary"
19509 If this option is set, the router declines unless the local host is found in
19510 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19511 process domains for which the local host is a secondary mail exchanger
19512 differently to other domains. The way in which Exim decides whether a host is
19513 the local host is described in section &<<SECTreclocipadd>>&.
19514
19515
19516 .option check_srv dnslookup string&!! unset
19517 .cindex "SRV record" "enabling use of"
19518 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19519 addition to MX and address records. The support is disabled by default. To
19520 enable SRV support, set the &%check_srv%& option to the name of the service
19521 required. For example,
19522 .code
19523 check_srv = smtp
19524 .endd
19525 looks for SRV records that refer to the normal smtp service. The option is
19526 expanded, so the service name can vary from message to message or address
19527 to address. This might be helpful if SRV records are being used for a
19528 submission service. If the expansion is forced to fail, the &%check_srv%&
19529 option is ignored, and the router proceeds to look for MX records in the
19530 normal way.
19531
19532 When the expansion succeeds, the router searches first for SRV records for
19533 the given service (it assumes TCP protocol). A single SRV record with a
19534 host name that consists of just a single dot indicates &"no such service for
19535 this domain"&; if this is encountered, the router declines. If other kinds of
19536 SRV record are found, they are used to construct a host list for delivery
19537 according to the rules of RFC 2782. MX records are not sought in this case.
19538
19539 When no SRV records are found, MX records (and address records) are sought in
19540 the traditional way. In other words, SRV records take precedence over MX
19541 records, just as MX records take precedence over address records. Note that
19542 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19543 defined it. It is apparently believed that MX records are sufficient for email
19544 and that SRV records should not be used for this purpose. However, SRV records
19545 have an additional &"weight"& feature which some people might find useful when
19546 trying to split an SMTP load between hosts of different power.
19547
19548 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19549 when there is a DNS lookup error.
19550
19551
19552
19553
19554 .option fail_defer_domains dnslookup "domain list&!!" unset
19555 .cindex "MX record" "not found"
19556 DNS lookups for domains matching &%fail_defer_domains%&
19557 which find no matching record will cause the router to defer
19558 rather than the default behaviour of decline.
19559 This maybe be useful for queueing messages for a newly created
19560 domain while the DNS configuration is not ready.
19561 However, it will result in any message with mistyped domains
19562 also being queued.
19563
19564
19565 .option ipv4_only "string&!!" unset
19566 .cindex IPv6 disabling
19567 .cindex DNS "IPv6 disabling"
19568 The string is expanded, and if the result is anything but a forced failure,
19569 or an empty string, or one of the strings “0” or “no” or “false”
19570 (checked without regard to the case of the letters),
19571 only A records are used.
19572
19573 .option ipv4_prefer "string&!!" unset
19574 .cindex IPv4 preference
19575 .cindex DNS "IPv4 preference"
19576 The string is expanded, and if the result is anything but a forced failure,
19577 or an empty string, or one of the strings “0” or “no” or “false”
19578 (checked without regard to the case of the letters),
19579 A records are sorted before AAAA records (inverting the default).
19580
19581 .option mx_domains dnslookup "domain list&!!" unset
19582 .cindex "MX record" "required to exist"
19583 .cindex "SRV record" "required to exist"
19584 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19585 record in order to be recognized. (The name of this option could be improved.)
19586 For example, if all the mail hosts in &'fict.example'& are known to have MX
19587 records, except for those in &'discworld.fict.example'&, you could use this
19588 setting:
19589 .code
19590 mx_domains = ! *.discworld.fict.example : *.fict.example
19591 .endd
19592 This specifies that messages addressed to a domain that matches the list but
19593 has no MX record should be bounced immediately instead of being routed using
19594 the address record.
19595
19596
19597 .option mx_fail_domains dnslookup "domain list&!!" unset
19598 If the DNS lookup for MX records for one of the domains in this list causes a
19599 DNS lookup error, Exim behaves as if no MX records were found. See section
19600 &<<SECTprowitdnsloo>>& for more discussion.
19601
19602
19603
19604
19605 .option qualify_single dnslookup boolean true
19606 .cindex "DNS" "resolver options"
19607 .cindex "DNS" "qualifying single-component names"
19608 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19609 lookups. Typically, but not standardly, this causes the resolver to qualify
19610 single-component names with the default domain. For example, on a machine
19611 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19612 &'thesaurus.ref.example'& inside the resolver. For details of what your
19613 resolver actually does, consult your man pages for &'resolver'& and
19614 &'resolv.conf'&.
19615
19616
19617
19618 .option rewrite_headers dnslookup boolean true
19619 .cindex "rewriting" "header lines"
19620 .cindex "header lines" "rewriting"
19621 If the domain name in the address that is being processed is not fully
19622 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19623 an address is specified as &'dormouse@teaparty'&, the domain might be
19624 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19625 occur as a result of setting the &%widen_domains%& option. If
19626 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19627 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19628 header lines of the message are rewritten with the full domain name.
19629
19630 This option should be turned off only when it is known that no message is
19631 ever going to be sent outside an environment where the abbreviation makes
19632 sense.
19633
19634 When an MX record is looked up in the DNS and matches a wildcard record, name
19635 servers normally return a record containing the name that has been looked up,
19636 making it impossible to detect whether a wildcard was present or not. However,
19637 some name servers have recently been seen to return the wildcard entry. If the
19638 name returned by a DNS lookup begins with an asterisk, it is not used for
19639 header rewriting.
19640
19641
19642 .option same_domain_copy_routing dnslookup boolean false
19643 .cindex "address" "copying routing"
19644 Addresses with the same domain are normally routed by the &(dnslookup)& router
19645 to the same list of hosts. However, this cannot be presumed, because the router
19646 options and preconditions may refer to the local part of the address. By
19647 default, therefore, Exim routes each address in a message independently. DNS
19648 servers run caches, so repeated DNS lookups are not normally expensive, and in
19649 any case, personal messages rarely have more than a few recipients.
19650
19651 If you are running mailing lists with large numbers of subscribers at the same
19652 domain, and you are using a &(dnslookup)& router which is independent of the
19653 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19654 lookups for identical domains in one message. In this case, when &(dnslookup)&
19655 routes an address to a remote transport, any other unrouted addresses in the
19656 message that have the same domain are automatically given the same routing
19657 without processing them independently,
19658 provided the following conditions are met:
19659
19660 .ilist
19661 No router that processed the address specified &%headers_add%& or
19662 &%headers_remove%&.
19663 .next
19664 The router did not change the address in any way, for example, by &"widening"&
19665 the domain.
19666 .endlist
19667
19668
19669
19670
19671 .option search_parents dnslookup boolean false
19672 .cindex "DNS" "resolver options"
19673 When this option is true, the resolver option RES_DNSRCH is set for DNS
19674 lookups. This is different from the &%qualify_single%& option in that it
19675 applies to domains containing dots. Typically, but not standardly, it causes
19676 the resolver to search for the name in the current domain and in parent
19677 domains. For example, on a machine in the &'fict.example'& domain, if looking
19678 up &'teaparty.wonderland'& failed, the resolver would try
19679 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19680 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19681
19682 Setting this option true can cause problems in domains that have a wildcard MX
19683 record, because any domain that does not have its own MX record matches the
19684 local wildcard.
19685
19686
19687
19688 .option srv_fail_domains dnslookup "domain list&!!" unset
19689 If the DNS lookup for SRV records for one of the domains in this list causes a
19690 DNS lookup error, Exim behaves as if no SRV records were found. See section
19691 &<<SECTprowitdnsloo>>& for more discussion.
19692
19693
19694
19695
19696 .option widen_domains dnslookup "string list" unset
19697 .cindex "domain" "partial; widening"
19698 If a DNS lookup fails and this option is set, each of its strings in turn is
19699 added onto the end of the domain, and the lookup is tried again. For example,
19700 if
19701 .code
19702 widen_domains = fict.example:ref.example
19703 .endd
19704 is set and a lookup of &'klingon.dictionary'& fails,
19705 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19706 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19707 and &%search_parents%& options can cause some widening to be undertaken inside
19708 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19709 when verifying, unless &%rewrite_headers%& is false (not the default).
19710
19711
19712 .section "Effect of qualify_single and search_parents" "SECID119"
19713 When a domain from an envelope recipient is changed by the resolver as a result
19714 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19715 corresponding address in the message's header lines unless &%rewrite_headers%&
19716 is set false. Exim then re-routes the address, using the full domain.
19717
19718 These two options affect only the DNS lookup that takes place inside the router
19719 for the domain of the address that is being routed. They do not affect lookups
19720 such as that implied by
19721 .code
19722 domains = @mx_any
19723 .endd
19724 that may happen while processing a router precondition before the router is
19725 entered. No widening ever takes place for these lookups.
19726 .ecindex IIDdnsrou1
19727 .ecindex IIDdnsrou2
19728
19729
19730
19731
19732
19733
19734
19735
19736
19737 . ////////////////////////////////////////////////////////////////////////////
19738 . ////////////////////////////////////////////////////////////////////////////
19739
19740 .chapter "The ipliteral router" "CHID5"
19741 .cindex "&(ipliteral)& router"
19742 .cindex "domain literal" "routing"
19743 .cindex "routers" "&(ipliteral)&"
19744 This router has no private options. Unless it is being used purely for
19745 verification (see &%verify_only%&) a transport is required to be defined by the
19746 generic &%transport%& option. The router accepts the address if its domain part
19747 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19748 router handles the address
19749 .code
19750 root@[192.168.1.1]
19751 .endd
19752 by setting up delivery to the host with that IP address. IPv4 domain literals
19753 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19754 are similar, but the address is preceded by &`ipv6:`&. For example:
19755 .code
19756 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19757 .endd
19758 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19759 grounds that sooner or later somebody will try it.
19760
19761 .oindex "&%self%&" "in &(ipliteral)& router"
19762 If the IP address matches something in &%ignore_target_hosts%&, the router
19763 declines. If an IP literal turns out to refer to the local host, the generic
19764 &%self%& option determines what happens.
19765
19766 The RFCs require support for domain literals; however, their use is
19767 controversial in today's Internet. If you want to use this router, you must
19768 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19769 Exim will not recognize the domain literal syntax in addresses.
19770
19771
19772
19773 . ////////////////////////////////////////////////////////////////////////////
19774 . ////////////////////////////////////////////////////////////////////////////
19775
19776 .chapter "The iplookup router" "CHID6"
19777 .cindex "&(iplookup)& router"
19778 .cindex "routers" "&(iplookup)&"
19779 The &(iplookup)& router was written to fulfil a specific requirement in
19780 Cambridge University (which in fact no longer exists). For this reason, it is
19781 not included in the binary of Exim by default. If you want to include it, you
19782 must set
19783 .code
19784 ROUTER_IPLOOKUP=yes
19785 .endd
19786 in your &_Local/Makefile_& configuration file.
19787
19788 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19789 connection to one or more specific hosts. The host can then return the same or
19790 a different address &-- in effect rewriting the recipient address in the
19791 message's envelope. The new address is then passed on to subsequent routers. If
19792 this process fails, the address can be passed on to other routers, or delivery
19793 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19794 must not be specified for it.
19795
19796 .cindex "options" "&(iplookup)& router"
19797 .option hosts iplookup string unset
19798 This option must be supplied. Its value is a colon-separated list of host
19799 names. The hosts are looked up using &[gethostbyname()]&
19800 (or &[getipnodebyname()]& when available)
19801 and are tried in order until one responds to the query. If none respond, what
19802 happens is controlled by &%optional%&.
19803
19804
19805 .option optional iplookup boolean false
19806 If &%optional%& is true, if no response is obtained from any host, the address
19807 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19808 delivery to the address is deferred.
19809
19810
19811 .option port iplookup integer 0
19812 .cindex "port" "&(iplookup)& router"
19813 This option must be supplied. It specifies the port number for the TCP or UDP
19814 call.
19815
19816
19817 .option protocol iplookup string udp
19818 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19819 protocols is to be used.
19820
19821
19822 .option query iplookup string&!! "see below"
19823 This defines the content of the query that is sent to the remote hosts. The
19824 default value is:
19825 .code
19826 $local_part@$domain $local_part@$domain
19827 .endd
19828 The repetition serves as a way of checking that a response is to the correct
19829 query in the default case (see &%response_pattern%& below).
19830
19831
19832 .option reroute iplookup string&!! unset
19833 If this option is not set, the rerouted address is precisely the byte string
19834 returned by the remote host, up to the first white space, if any. If set, the
19835 string is expanded to form the rerouted address. It can include parts matched
19836 in the response by &%response_pattern%& by means of numeric variables such as
19837 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19838 whether or not a pattern is in use. In all cases, the rerouted address must end
19839 up in the form &'local_part@domain'&.
19840
19841
19842 .option response_pattern iplookup string unset
19843 This option can be set to a regular expression that is applied to the string
19844 returned from the remote host. If the pattern does not match the response, the
19845 router declines. If &%response_pattern%& is not set, no checking of the
19846 response is done, unless the query was defaulted, in which case there is a
19847 check that the text returned after the first white space is the original
19848 address. This checks that the answer that has been received is in response to
19849 the correct question. For example, if the response is just a new domain, the
19850 following could be used:
19851 .code
19852 response_pattern = ^([^@]+)$
19853 reroute = $local_part@$1
19854 .endd
19855
19856 .option timeout iplookup time 5s
19857 This specifies the amount of time to wait for a response from the remote
19858 machine. The same timeout is used for the &[connect()]& function for a TCP
19859 call. It does not apply to UDP.
19860
19861
19862
19863
19864 . ////////////////////////////////////////////////////////////////////////////
19865 . ////////////////////////////////////////////////////////////////////////////
19866
19867 .chapter "The manualroute router" "CHID7"
19868 .scindex IIDmanrou1 "&(manualroute)& router"
19869 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19870 .cindex "domain" "manually routing"
19871 The &(manualroute)& router is so-called because it provides a way of manually
19872 routing an address according to its domain. It is mainly used when you want to
19873 route addresses to remote hosts according to your own rules, bypassing the
19874 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19875 route to local transports, a facility that may be useful if you want to save
19876 messages for dial-in hosts in local files.
19877
19878 The &(manualroute)& router compares a list of domain patterns with the domain
19879 it is trying to route. If there is no match, the router declines. Each pattern
19880 has associated with it a list of hosts and some other optional data, which may
19881 include a transport. The combination of a pattern and its data is called a
19882 &"routing rule"&. For patterns that do not have an associated transport, the
19883 generic &%transport%& option must specify a transport, unless the router is
19884 being used purely for verification (see &%verify_only%&).
19885
19886 .vindex "&$host$&"
19887 In the case of verification, matching the domain pattern is sufficient for the
19888 router to accept the address. When actually routing an address for delivery,
19889 an address that matches a domain pattern is queued for the associated
19890 transport. If the transport is not a local one, a host list must be associated
19891 with the pattern; IP addresses are looked up for the hosts, and these are
19892 passed to the transport along with the mail address. For local transports, a
19893 host list is optional. If it is present, it is passed in &$host$& as a single
19894 text string.
19895
19896 The list of routing rules can be provided as an inline string in
19897 &%route_list%&, or the data can be obtained by looking up the domain in a file
19898 or database by setting &%route_data%&. Only one of these settings may appear in
19899 any one instance of &(manualroute)&. The format of routing rules is described
19900 below, following the list of private options.
19901
19902
19903 .section "Private options for manualroute" "SECTprioptman"
19904
19905 .cindex "options" "&(manualroute)& router"
19906 The private options for the &(manualroute)& router are as follows:
19907
19908 .option host_all_ignored manualroute string defer
19909 See &%host_find_failed%&.
19910
19911 .option host_find_failed manualroute string freeze
19912 This option controls what happens when &(manualroute)& tries to find an IP
19913 address for a host, and the host does not exist. The option can be set to one
19914 of the following values:
19915 .code
19916 decline
19917 defer
19918 fail
19919 freeze
19920 ignore
19921 pass
19922 .endd
19923 The default (&"freeze"&) assumes that this state is a serious configuration
19924 error. The difference between &"pass"& and &"decline"& is that the former
19925 forces the address to be passed to the next router (or the router defined by
19926 &%pass_router%&),
19927 .oindex "&%more%&"
19928 overriding &%no_more%&, whereas the latter passes the address to the next
19929 router only if &%more%& is true.
19930
19931 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19932 cannot be found. If all the hosts in the list are ignored, the behaviour is
19933 controlled by the &%host_all_ignored%& option. This takes the same values
19934 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19935
19936 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19937 state; if a host lookup gets a temporary error, delivery is deferred unless the
19938 generic &%pass_on_timeout%& option is set.
19939
19940
19941 .option hosts_randomize manualroute boolean false
19942 .cindex "randomized host list"
19943 .cindex "host" "list of; randomized"
19944 If this option is set, the order of the items in a host list in a routing rule
19945 is randomized each time the list is used, unless an option in the routing rule
19946 overrides (see below). Randomizing the order of a host list can be used to do
19947 crude load sharing. However, if more than one mail address is routed by the
19948 same router to the same host list, the host lists are considered to be the same
19949 (even though they may be randomized into different orders) for the purpose of
19950 deciding whether to batch the deliveries into a single SMTP transaction.
19951
19952 When &%hosts_randomize%& is true, a host list may be split
19953 into groups whose order is separately randomized. This makes it possible to
19954 set up MX-like behaviour. The boundaries between groups are indicated by an
19955 item that is just &`+`& in the host list. For example:
19956 .code
19957 route_list = * host1:host2:host3:+:host4:host5
19958 .endd
19959 The order of the first three hosts and the order of the last two hosts is
19960 randomized for each use, but the first three always end up before the last two.
19961 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19962 randomized host list is passed to an &(smtp)& transport that also has
19963 &%hosts_randomize set%&, the list is not re-randomized.
19964
19965
19966 .option route_data manualroute string&!! unset
19967 If this option is set, it must expand to yield the data part of a routing rule.
19968 Typically, the expansion string includes a lookup based on the domain. For
19969 example:
19970 .code
19971 route_data = ${lookup{$domain}dbm{/etc/routes}}
19972 .endd
19973 If the expansion is forced to fail, or the result is an empty string, the
19974 router declines. Other kinds of expansion failure cause delivery to be
19975 deferred.
19976
19977
19978 .option route_list manualroute "string list" unset
19979 This string is a list of routing rules, in the form defined below. Note that,
19980 unlike most string lists, the items are separated by semicolons. This is so
19981 that they may contain colon-separated host lists.
19982
19983
19984 .option same_domain_copy_routing manualroute boolean false
19985 .cindex "address" "copying routing"
19986 Addresses with the same domain are normally routed by the &(manualroute)&
19987 router to the same list of hosts. However, this cannot be presumed, because the
19988 router options and preconditions may refer to the local part of the address. By
19989 default, therefore, Exim routes each address in a message independently. DNS
19990 servers run caches, so repeated DNS lookups are not normally expensive, and in
19991 any case, personal messages rarely have more than a few recipients.
19992
19993 If you are running mailing lists with large numbers of subscribers at the same
19994 domain, and you are using a &(manualroute)& router which is independent of the
19995 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19996 lookups for identical domains in one message. In this case, when
19997 &(manualroute)& routes an address to a remote transport, any other unrouted
19998 addresses in the message that have the same domain are automatically given the
19999 same routing without processing them independently. However, this is only done
20000 if &%headers_add%& and &%headers_remove%& are unset.
20001
20002
20003
20004
20005 .section "Routing rules in route_list" "SECID120"
20006 The value of &%route_list%& is a string consisting of a sequence of routing
20007 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20008 entered as two semicolons. Alternatively, the list separator can be changed as
20009 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20010 Empty rules are ignored. The format of each rule is
20011 .display
20012 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20013 .endd
20014 The following example contains two rules, each with a simple domain pattern and
20015 no options:
20016 .code
20017 route_list = \
20018   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20019   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20020 .endd
20021 The three parts of a rule are separated by white space. The pattern and the
20022 list of hosts can be enclosed in quotes if necessary, and if they are, the
20023 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20024 single domain pattern, which is the only mandatory item in the rule. The
20025 pattern is in the same format as one item in a domain list (see section
20026 &<<SECTdomainlist>>&),
20027 except that it may not be the name of an interpolated file.
20028 That is, it may be wildcarded, or a regular expression, or a file or database
20029 lookup (with semicolons doubled, because of the use of semicolon as a separator
20030 in a &%route_list%&).
20031
20032 The rules in &%route_list%& are searched in order until one of the patterns
20033 matches the domain that is being routed. The list of hosts and then options are
20034 then used as described below. If there is no match, the router declines. When
20035 &%route_list%& is set, &%route_data%& must not be set.
20036
20037
20038
20039 .section "Routing rules in route_data" "SECID121"
20040 The use of &%route_list%& is convenient when there are only a small number of
20041 routing rules. For larger numbers, it is easier to use a file or database to
20042 hold the routing information, and use the &%route_data%& option instead.
20043 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20044 Most commonly, &%route_data%& is set as a string that contains an
20045 expansion lookup. For example, suppose we place two routing rules in a file
20046 like this:
20047 .code
20048 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20049 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20050 .endd
20051 This data can be accessed by setting
20052 .code
20053 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20054 .endd
20055 Failure of the lookup results in an empty string, causing the router to
20056 decline. However, you do not have to use a lookup in &%route_data%&. The only
20057 requirement is that the result of expanding the string is a list of hosts,
20058 possibly followed by options, separated by white space. The list of hosts must
20059 be enclosed in quotes if it contains white space.
20060
20061
20062
20063
20064 .section "Format of the list of hosts" "SECID122"
20065 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20066 always separately expanded before use. If the expansion fails, the router
20067 declines. The result of the expansion must be a colon-separated list of names
20068 and/or IP addresses, optionally also including ports.
20069 If the list is written with spaces, it must be protected with quotes.
20070 The format of each item
20071 in the list is described in the next section. The list separator can be changed
20072 as described in section &<<SECTlistsepchange>>&.
20073
20074 If the list of hosts was obtained from a &%route_list%& item, the following
20075 variables are set during its expansion:
20076
20077 .ilist
20078 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20079 If the domain was matched against a regular expression, the numeric variables
20080 &$1$&, &$2$&, etc. may be set. For example:
20081 .code
20082 route_list = ^domain(\d+)   host-$1.text.example
20083 .endd
20084 .next
20085 &$0$& is always set to the entire domain.
20086 .next
20087 &$1$& is also set when partial matching is done in a file lookup.
20088
20089 .next
20090 .vindex "&$value$&"
20091 If the pattern that matched the domain was a lookup item, the data that was
20092 looked up is available in the expansion variable &$value$&. For example:
20093 .code
20094 route_list = lsearch;;/some/file.routes  $value
20095 .endd
20096 .endlist
20097
20098 Note the doubling of the semicolon in the pattern that is necessary because
20099 semicolon is the default route list separator.
20100
20101
20102
20103 .section "Format of one host item" "SECTformatonehostitem"
20104 Each item in the list of hosts is either a host name or an IP address,
20105 optionally with an attached port number. When no port is given, an IP address
20106 is not enclosed in brackets. When a port is specified, it overrides the port
20107 specification on the transport. The port is separated from the name or address
20108 by a colon. This leads to some complications:
20109
20110 .ilist
20111 Because colon is the default separator for the list of hosts, either
20112 the colon that specifies a port must be doubled, or the list separator must
20113 be changed. The following two examples have the same effect:
20114 .code
20115 route_list = * "host1.tld::1225 : host2.tld::1226"
20116 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20117 .endd
20118 .next
20119 When IPv6 addresses are involved, it gets worse, because they contain
20120 colons of their own. To make this case easier, it is permitted to
20121 enclose an IP address (either v4 or v6) in square brackets if a port
20122 number follows. For example:
20123 .code
20124 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20125 .endd
20126 .endlist
20127
20128 .section "How the list of hosts is used" "SECThostshowused"
20129 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20130 the hosts is tried, in the order specified, when carrying out the SMTP
20131 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20132 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20133 transport.
20134
20135 Hosts may be listed by name or by IP address. An unadorned name in the list of
20136 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20137 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20138 records in the DNS. For example:
20139 .code
20140 route_list = *  x.y.z:p.q.r/MX:e.f.g
20141 .endd
20142 If this feature is used with a port specifier, the port must come last. For
20143 example:
20144 .code
20145 route_list = *  dom1.tld/mx::1225
20146 .endd
20147 If the &%hosts_randomize%& option is set, the order of the items in the list is
20148 randomized before any lookups are done. Exim then scans the list; for any name
20149 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20150 be an interface on the local host and the item is not the first in the list,
20151 Exim discards it and any subsequent items. If it is the first item, what
20152 happens is controlled by the
20153 .oindex "&%self%&" "in &(manualroute)& router"
20154 &%self%& option of the router.
20155
20156 A name on the list that is followed by &`/MX`& is replaced with the list of
20157 hosts obtained by looking up MX records for the name. This is always a DNS
20158 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20159 below) are not relevant here. The order of these hosts is determined by the
20160 preference values in the MX records, according to the usual rules. Because
20161 randomizing happens before the MX lookup, it does not affect the order that is
20162 defined by MX preferences.
20163
20164 If the local host is present in the sublist obtained from MX records, but is
20165 not the most preferred host in that list, it and any equally or less
20166 preferred hosts are removed before the sublist is inserted into the main list.
20167
20168 If the local host is the most preferred host in the MX list, what happens
20169 depends on where in the original list of hosts the &`/MX`& item appears. If it
20170 is not the first item (that is, there are previous hosts in the main list),
20171 Exim discards this name and any subsequent items in the main list.
20172
20173 If the MX item is first in the list of hosts, and the local host is the
20174 most preferred host, what happens is controlled by the &%self%& option of the
20175 router.
20176
20177 DNS failures when lookup up the MX records are treated in the same way as DNS
20178 failures when looking up IP addresses: &%pass_on_timeout%& and
20179 &%host_find_failed%& are used when relevant.
20180
20181 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20182 whether obtained from an MX lookup or not.
20183
20184
20185
20186 .section "How the options are used" "SECThowoptused"
20187 The options are a sequence of words, space-separated.
20188 One of the words can be the name of a transport; this overrides the
20189 &%transport%& option on the router for this particular routing rule only. The
20190 other words (if present) control randomization of the list of hosts on a
20191 per-rule basis, and how the IP addresses of the hosts are to be found when
20192 routing to a remote transport. These options are as follows:
20193
20194 .ilist
20195 &%randomize%&: randomize the order of the hosts in this list, overriding the
20196 setting of &%hosts_randomize%& for this routing rule only.
20197 .next
20198 &%no_randomize%&: do not randomize the order of the hosts in this list,
20199 overriding the setting of &%hosts_randomize%& for this routing rule only.
20200 .next
20201 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20202 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20203 also look in &_/etc/hosts_& or other sources of information.
20204 .next
20205 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20206 no address records are found. If there is a temporary DNS error (such as a
20207 timeout), delivery is deferred.
20208 .next
20209 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20210 .next
20211 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20212 .endlist
20213
20214 For example:
20215 .code
20216 route_list = domain1  host1:host2:host3  randomize bydns;\
20217              domain2  host4:host5
20218 .endd
20219 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20220 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20221 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20222 or &[gethostbyname()]&, and the result of the lookup is the result of that
20223 call.
20224
20225 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20226 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20227 instead of TRY_AGAIN. That is why the default action is to try a DNS
20228 lookup first. Only if that gives a definite &"no such host"& is the local
20229 function called.
20230
20231 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20232 inadvertent constraint that a transport name as an option had to be the last
20233 option specified.
20234
20235
20236
20237 If no IP address for a host can be found, what happens is controlled by the
20238 &%host_find_failed%& option.
20239
20240 .vindex "&$host$&"
20241 When an address is routed to a local transport, IP addresses are not looked up.
20242 The host list is passed to the transport in the &$host$& variable.
20243
20244
20245
20246 .section "Manualroute examples" "SECID123"
20247 In some of the examples that follow, the presence of the &%remote_smtp%&
20248 transport, as defined in the default configuration file, is assumed:
20249
20250 .ilist
20251 .cindex "smart host" "example router"
20252 The &(manualroute)& router can be used to forward all external mail to a
20253 &'smart host'&. If you have set up, in the main part of the configuration, a
20254 named domain list that contains your local domains, for example:
20255 .code
20256 domainlist local_domains = my.domain.example
20257 .endd
20258 You can arrange for all other domains to be routed to a smart host by making
20259 your first router something like this:
20260 .code
20261 smart_route:
20262   driver = manualroute
20263   domains = !+local_domains
20264   transport = remote_smtp
20265   route_list = * smarthost.ref.example
20266 .endd
20267 This causes all non-local addresses to be sent to the single host
20268 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20269 they are tried in order
20270 (but you can use &%hosts_randomize%& to vary the order each time).
20271 Another way of configuring the same thing is this:
20272 .code
20273 smart_route:
20274   driver = manualroute
20275   transport = remote_smtp
20276   route_list = !+local_domains  smarthost.ref.example
20277 .endd
20278 There is no difference in behaviour between these two routers as they stand.
20279 However, they behave differently if &%no_more%& is added to them. In the first
20280 example, the router is skipped if the domain does not match the &%domains%&
20281 precondition; the following router is always tried. If the router runs, it
20282 always matches the domain and so can never decline. Therefore, &%no_more%&
20283 would have no effect. In the second case, the router is never skipped; it
20284 always runs. However, if it doesn't match the domain, it declines. In this case
20285 &%no_more%& would prevent subsequent routers from running.
20286
20287 .next
20288 .cindex "mail hub example"
20289 A &'mail hub'& is a host which receives mail for a number of domains via MX
20290 records in the DNS and delivers it via its own private routing mechanism. Often
20291 the final destinations are behind a firewall, with the mail hub being the one
20292 machine that can connect to machines both inside and outside the firewall. The
20293 &(manualroute)& router is usually used on a mail hub to route incoming messages
20294 to the correct hosts. For a small number of domains, the routing can be inline,
20295 using the &%route_list%& option, but for a larger number a file or database
20296 lookup is easier to manage.
20297
20298 If the domain names are in fact the names of the machines to which the mail is
20299 to be sent by the mail hub, the configuration can be quite simple. For
20300 example:
20301 .code
20302 hub_route:
20303   driver = manualroute
20304   transport = remote_smtp
20305   route_list = *.rhodes.tvs.example  $domain
20306 .endd
20307 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20308 whose names are the same as the mail domains. A similar approach can be taken
20309 if the host name can be obtained from the domain name by a string manipulation
20310 that the expansion facilities can handle. Otherwise, a lookup based on the
20311 domain can be used to find the host:
20312 .code
20313 through_firewall:
20314   driver = manualroute
20315   transport = remote_smtp
20316   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20317 .endd
20318 The result of the lookup must be the name or IP address of the host (or
20319 hosts) to which the address is to be routed. If the lookup fails, the route
20320 data is empty, causing the router to decline. The address then passes to the
20321 next router.
20322
20323 .next
20324 .cindex "batched SMTP output example"
20325 .cindex "SMTP" "batched outgoing; example"
20326 You can use &(manualroute)& to deliver messages to pipes or files in batched
20327 SMTP format for onward transportation by some other means. This is one way of
20328 storing mail for a dial-up host when it is not connected. The route list entry
20329 can be as simple as a single domain name in a configuration like this:
20330 .code
20331 save_in_file:
20332   driver = manualroute
20333   transport = batchsmtp_appendfile
20334   route_list = saved.domain.example
20335 .endd
20336 though often a pattern is used to pick up more than one domain. If there are
20337 several domains or groups of domains with different transport requirements,
20338 different transports can be listed in the routing information:
20339 .code
20340 save_in_file:
20341   driver = manualroute
20342   route_list = \
20343     *.saved.domain1.example  $domain  batch_appendfile; \
20344     *.saved.domain2.example  \
20345       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20346       batch_pipe
20347 .endd
20348 .vindex "&$domain$&"
20349 .vindex "&$host$&"
20350 The first of these just passes the domain in the &$host$& variable, which
20351 doesn't achieve much (since it is also in &$domain$&), but the second does a
20352 file lookup to find a value to pass, causing the router to decline to handle
20353 the address if the lookup fails.
20354
20355 .next
20356 .cindex "UUCP" "example of router for"
20357 Routing mail directly to UUCP software is a specific case of the use of
20358 &(manualroute)& in a gateway to another mail environment. This is an example of
20359 one way it can be done:
20360 .code
20361 # Transport
20362 uucp:
20363   driver = pipe
20364   user = nobody
20365   command = /usr/local/bin/uux -r - \
20366     ${substr_-5:$host}!rmail ${local_part}
20367   return_fail_output = true
20368
20369 # Router
20370 uucphost:
20371   transport = uucp
20372   driver = manualroute
20373   route_data = \
20374     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20375 .endd
20376 The file &_/usr/local/exim/uucphosts_& contains entries like
20377 .code
20378 darksite.ethereal.example:           darksite.UUCP
20379 .endd
20380 It can be set up more simply without adding and removing &".UUCP"& but this way
20381 makes clear the distinction between the domain name
20382 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20383 .endlist
20384 .ecindex IIDmanrou1
20385 .ecindex IIDmanrou2
20386
20387
20388
20389
20390
20391
20392
20393
20394 . ////////////////////////////////////////////////////////////////////////////
20395 . ////////////////////////////////////////////////////////////////////////////
20396
20397 .chapter "The queryprogram router" "CHAPdriverlast"
20398 .scindex IIDquerou1 "&(queryprogram)& router"
20399 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20400 .cindex "routing" "by external program"
20401 The &(queryprogram)& router routes an address by running an external command
20402 and acting on its output. This is an expensive way to route, and is intended
20403 mainly for use in lightly-loaded systems, or for performing experiments.
20404 However, if it is possible to use the precondition options (&%domains%&,
20405 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20406 be used in special cases, even on a busy host. There are the following private
20407 options:
20408 .cindex "options" "&(queryprogram)& router"
20409
20410 .option command queryprogram string&!! unset
20411 This option must be set. It specifies the command that is to be run. The
20412 command is split up into a command name and arguments, and then each is
20413 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20414 &<<CHAPpipetransport>>&).
20415
20416
20417 .option command_group queryprogram string unset
20418 .cindex "gid (group id)" "in &(queryprogram)& router"
20419 This option specifies a gid to be set when running the command while routing an
20420 address for deliver. It must be set if &%command_user%& specifies a numerical
20421 uid. If it begins with a digit, it is interpreted as the numerical value of the
20422 gid. Otherwise it is looked up using &[getgrnam()]&.
20423
20424
20425 .option command_user queryprogram string unset
20426 .cindex "uid (user id)" "for &(queryprogram)&"
20427 This option must be set. It specifies the uid which is set when running the
20428 command while routing an address for delivery. If the value begins with a digit,
20429 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20430 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20431 not set, a value for the gid also.
20432
20433 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20434 root, which it does during a normal delivery in a conventional configuration.
20435 However, when an address is being verified during message reception, Exim is
20436 usually running as the Exim user, not as root. If the &(queryprogram)& router
20437 is called from a non-root process, Exim cannot change uid or gid before running
20438 the command. In this circumstance the command runs under the current uid and
20439 gid.
20440
20441
20442 .option current_directory queryprogram string /
20443 This option specifies an absolute path which is made the current directory
20444 before running the command.
20445
20446
20447 .option timeout queryprogram time 1h
20448 If the command does not complete within the timeout period, its process group
20449 is killed and the message is frozen. A value of zero time specifies no
20450 timeout.
20451
20452
20453 The standard output of the command is connected to a pipe, which is read when
20454 the command terminates. It should consist of a single line of output,
20455 containing up to five fields, separated by white space. The maximum length of
20456 the line is 1023 characters. Longer lines are silently truncated. The first
20457 field is one of the following words (case-insensitive):
20458
20459 .ilist
20460 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20461 below).
20462 .next
20463 &'Decline'&: the router declines; pass the address to the next router, unless
20464 &%no_more%& is set.
20465 .next
20466 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20467 subsequent text on the line is an error message. If the router is run as part
20468 of address verification during an incoming SMTP message, the message is
20469 included in the SMTP response.
20470 .next
20471 &'Defer'&: routing could not be completed at this time; try again later. Any
20472 subsequent text on the line is an error message which is logged. It is not
20473 included in any SMTP response.
20474 .next
20475 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20476 .next
20477 &'Pass'&: pass the address to the next router (or the router specified by
20478 &%pass_router%&), overriding &%no_more%&.
20479 .next
20480 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20481 new addresses, which are routed independently, starting with the first router,
20482 or the router specified by &%redirect_router%&, if set.
20483 .endlist
20484
20485 When the first word is &'accept'&, the remainder of the line consists of a
20486 number of keyed data values, as follows (split into two lines here, to fit on
20487 the page):
20488 .code
20489 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20490 LOOKUP=byname|bydns DATA=<text>
20491 .endd
20492 The data items can be given in any order, and all are optional. If no transport
20493 is included, the transport specified by the generic &%transport%& option is
20494 used. The list of hosts and the lookup type are needed only if the transport is
20495 an &(smtp)& transport that does not itself supply a list of hosts.
20496
20497 The format of the list of hosts is the same as for the &(manualroute)& router.
20498 As well as host names and IP addresses with optional port numbers, as described
20499 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20500 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20501 (see section &<<SECThostshowused>>&).
20502
20503 If the lookup type is not specified, Exim behaves as follows when trying to
20504 find an IP address for each host: First, a DNS lookup is done. If this yields
20505 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20506 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20507 result of the lookup is the result of that call.
20508
20509 .vindex "&$address_data$&"
20510 If the DATA field is set, its value is placed in the &$address_data$&
20511 variable. For example, this return line
20512 .code
20513 accept hosts=x1.y.example:x2.y.example data="rule1"
20514 .endd
20515 routes the address to the default transport, passing a list of two hosts. When
20516 the transport runs, the string &"rule1"& is in &$address_data$&.
20517 .ecindex IIDquerou1
20518 .ecindex IIDquerou2
20519
20520
20521
20522
20523 . ////////////////////////////////////////////////////////////////////////////
20524 . ////////////////////////////////////////////////////////////////////////////
20525
20526 .chapter "The redirect router" "CHAPredirect"
20527 .scindex IIDredrou1 "&(redirect)& router"
20528 .scindex IIDredrou2 "routers" "&(redirect)&"
20529 .cindex "alias file" "in a &(redirect)& router"
20530 .cindex "address redirection" "&(redirect)& router"
20531 The &(redirect)& router handles several kinds of address redirection. Its most
20532 common uses are for resolving local part aliases from a central alias file
20533 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20534 files, but it has many other potential uses. The incoming address can be
20535 redirected in several different ways:
20536
20537 .ilist
20538 It can be replaced by one or more new addresses which are themselves routed
20539 independently.
20540 .next
20541 It can be routed to be delivered to a given file or directory.
20542 .next
20543 It can be routed to be delivered to a specified pipe command.
20544 .next
20545 It can cause an automatic reply to be generated.
20546 .next
20547 It can be forced to fail, optionally with a custom error message.
20548 .next
20549 It can be temporarily deferred, optionally with a custom message.
20550 .next
20551 It can be discarded.
20552 .endlist
20553
20554 The generic &%transport%& option must not be set for &(redirect)& routers.
20555 However, there are some private options which define transports for delivery to
20556 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20557 &%pipe_transport%& and &%reply_transport%& descriptions below.
20558
20559 If success DSNs have been requested
20560 .cindex "DSN" "success"
20561 .cindex "Delivery Status Notification" "success"
20562 redirection triggers one and the DSN options are not passed any further.
20563
20564
20565
20566 .section "Redirection data" "SECID124"
20567 The router operates by interpreting a text string which it obtains either by
20568 expanding the contents of the &%data%& option, or by reading the entire
20569 contents of a file whose name is given in the &%file%& option. These two
20570 options are mutually exclusive. The first is commonly used for handling system
20571 aliases, in a configuration like this:
20572 .code
20573 system_aliases:
20574   driver = redirect
20575   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20576 .endd
20577 If the lookup fails, the expanded string in this example is empty. When the
20578 expansion of &%data%& results in an empty string, the router declines. A forced
20579 expansion failure also causes the router to decline; other expansion failures
20580 cause delivery to be deferred.
20581
20582 A configuration using &%file%& is commonly used for handling users'
20583 &_.forward_& files, like this:
20584 .code
20585 userforward:
20586   driver = redirect
20587   check_local_user
20588   file = $home/.forward
20589   no_verify
20590 .endd
20591 If the file does not exist, or causes no action to be taken (for example, it is
20592 empty or consists only of comments), the router declines. &*Warning*&: This
20593 is not the case when the file contains syntactically valid items that happen to
20594 yield empty addresses, for example, items containing only RFC 2822 address
20595 comments.
20596
20597 .new
20598 .cindex "tainted data" "in filenames"
20599 .cindex redirect "tainted data"
20600 Tainted data may not be used for a filename.
20601
20602 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20603 directly for redirection,
20604 as they are provided by a potential attacker.
20605 In the examples above, &$local_part$& is used for looking up data held locally
20606 on the system, and not used directly (the second example derives &$home$& via
20607 the passsword file or database, using &$local_part$&).
20608 .wen
20609
20610
20611
20612 .section "Forward files and address verification" "SECID125"
20613 .cindex "address redirection" "while verifying"
20614 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20615 &_.forward_& files, as in the example above. There are two reasons for this:
20616
20617 .ilist
20618 When Exim is receiving an incoming SMTP message from a remote host, it is
20619 running under the Exim uid, not as root. Exim is unable to change uid to read
20620 the file as the user, and it may not be able to read it as the Exim user. So in
20621 practice the router may not be able to operate.
20622 .next
20623 However, even when the router can operate, the existence of a &_.forward_& file
20624 is unimportant when verifying an address. What should be checked is whether the
20625 local part is a valid user name or not. Cutting out the redirection processing
20626 saves some resources.
20627 .endlist
20628
20629
20630
20631
20632
20633
20634 .section "Interpreting redirection data" "SECID126"
20635 .cindex "Sieve filter" "specifying in redirection data"
20636 .cindex "filter" "specifying in redirection data"
20637 The contents of the data string, whether obtained from &%data%& or &%file%&,
20638 can be interpreted in two different ways:
20639
20640 .ilist
20641 If the &%allow_filter%& option is set true, and the data begins with the text
20642 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20643 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20644 respectively. Details of the syntax and semantics of filter files are described
20645 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20646 document is intended for use by end users.
20647 .next
20648 Otherwise, the data must be a comma-separated list of redirection items, as
20649 described in the next section.
20650 .endlist
20651
20652 When a message is redirected to a file (a &"mail folder"&), the filename given
20653 in a non-filter redirection list must always be an absolute path. A filter may
20654 generate a relative path &-- how this is handled depends on the transport's
20655 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20656 for the &(appendfile)& transport.
20657
20658
20659
20660 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20661 .cindex "address redirection" "non-filter list items"
20662 When the redirection data is not an Exim or Sieve filter, for example, if it
20663 comes from a conventional alias or forward file, it consists of a list of
20664 addresses, filenames, pipe commands, or certain special items (see section
20665 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20666 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20667 depending on their default values. The items in the list are separated by
20668 commas or newlines.
20669 If a comma is required in an item, the entire item must be enclosed in double
20670 quotes.
20671
20672 Lines starting with a # character are comments, and are ignored, and # may
20673 also appear following a comma, in which case everything between the # and the
20674 next newline character is ignored.
20675
20676 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20677 double quotes are retained because some forms of mail address require their use
20678 (but never to enclose the entire address). In the following description,
20679 &"item"& refers to what remains after any surrounding double quotes have been
20680 removed.
20681
20682 .vindex "&$local_part$&"
20683 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20684 and the expansion contains a reference to &$local_part$&, you should make use
20685 of the &%quote_local_part%& expansion operator, in case the local part contains
20686 special characters. For example, to redirect all mail for the domain
20687 &'obsolete.example'&, retaining the existing local part, you could use this
20688 setting:
20689 .code
20690 data = ${quote_local_part:$local_part}@newdomain.example
20691 .endd
20692
20693
20694 .section "Redirecting to a local mailbox" "SECTredlocmai"
20695 .cindex "routing" "loops in"
20696 .cindex "loop" "while routing, avoidance of"
20697 .cindex "address redirection" "to local mailbox"
20698 A redirection item may safely be the same as the address currently under
20699 consideration. This does not cause a routing loop, because a router is
20700 automatically skipped if any ancestor of the address that is being processed
20701 is the same as the current address and was processed by the current router.
20702 Such an address is therefore passed to the following routers, so it is handled
20703 as if there were no redirection. When making this loop-avoidance test, the
20704 complete local part, including any prefix or suffix, is used.
20705
20706 .cindex "address redirection" "local part without domain"
20707 Specifying the same local part without a domain is a common usage in personal
20708 filter files when the user wants to have messages delivered to the local
20709 mailbox and also forwarded elsewhere. For example, the user whose login is
20710 &'cleo'& might have a &_.forward_& file containing this:
20711 .code
20712 cleo, cleopatra@egypt.example
20713 .endd
20714 .cindex "backslash in alias file"
20715 .cindex "alias file" "backslash in"
20716 For compatibility with other MTAs, such unqualified local parts may be
20717 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20718 it does make a difference if more than one domain is being handled
20719 synonymously.
20720
20721 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20722 2822 address that does not include a domain, the item is qualified using the
20723 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20724 addresses are qualified using the value in &%qualify_recipient%&, but you can
20725 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20726
20727 Care must be taken if there are alias names for local users.
20728 Consider an MTA handling a single local domain where the system alias file
20729 contains:
20730 .code
20731 Sam.Reman: spqr
20732 .endd
20733 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20734 messages in the local mailbox, and also forward copies elsewhere. He creates
20735 this forward file:
20736 .code
20737 Sam.Reman, spqr@reme.elsewhere.example
20738 .endd
20739 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20740 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20741 second time round, because it has previously routed it,
20742 and the following routers presumably cannot handle the alias. The forward file
20743 should really contain
20744 .code
20745 spqr, spqr@reme.elsewhere.example
20746 .endd
20747 but because this is such a common error, the &%check_ancestor%& option (see
20748 below) exists to provide a way to get round it. This is normally set on a
20749 &(redirect)& router that is handling users' &_.forward_& files.
20750
20751
20752
20753 .section "Special items in redirection lists" "SECTspecitredli"
20754 In addition to addresses, the following types of item may appear in redirection
20755 lists (that is, in non-filter redirection data):
20756
20757 .ilist
20758 .cindex "pipe" "in redirection list"
20759 .cindex "address redirection" "to pipe"
20760 An item is treated as a pipe command if it begins with &"|"& and does not parse
20761 as a valid RFC 2822 address that includes a domain. A transport for running the
20762 command must be specified by the &%pipe_transport%& option.
20763 Normally, either the router or the transport specifies a user and a group under
20764 which to run the delivery. The default is to use the Exim user and group.
20765
20766 Single or double quotes can be used for enclosing the individual arguments of
20767 the pipe command; no interpretation of escapes is done for single quotes. If
20768 the command contains a comma character, it is necessary to put the whole item
20769 in double quotes, for example:
20770 .code
20771 "|/some/command ready,steady,go"
20772 .endd
20773 since items in redirection lists are terminated by commas. Do not, however,
20774 quote just the command. An item such as
20775 .code
20776 |"/some/command ready,steady,go"
20777 .endd
20778 is interpreted as a pipe with a rather strange command name, and no arguments.
20779
20780 Note that the above example assumes that the text comes from a lookup source
20781 of some sort, so that the quotes are part of the data.  If composing a
20782 redirect router with a &%data%& option directly specifying this command, the
20783 quotes will be used by the configuration parser to define the extent of one
20784 string, but will not be passed down into the redirect router itself.  There
20785 are two main approaches to get around this: escape quotes to be part of the
20786 data itself, or avoid using this mechanism and instead create a custom
20787 transport with the &%command%& option set and reference that transport from
20788 an &%accept%& router.
20789
20790 .next
20791 .cindex "file" "in redirection list"
20792 .cindex "address redirection" "to file"
20793 An item is interpreted as a path name if it begins with &"/"& and does not
20794 parse as a valid RFC 2822 address that includes a domain. For example,
20795 .code
20796 /home/world/minbari
20797 .endd
20798 is treated as a filename, but
20799 .code
20800 /s=molari/o=babylon/@x400gate.way
20801 .endd
20802 is treated as an address. For a filename, a transport must be specified using
20803 the &%file_transport%& option. However, if the generated path name ends with a
20804 forward slash character, it is interpreted as a directory name rather than a
20805 filename, and &%directory_transport%& is used instead.
20806
20807 Normally, either the router or the transport specifies a user and a group under
20808 which to run the delivery. The default is to use the Exim user and group.
20809
20810 .cindex "&_/dev/null_&"
20811 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20812 bypassed at a high level, and the log entry shows &"**bypassed**"&
20813 instead of a transport name. In this case the user and group are not used.
20814
20815 .next
20816 .cindex "included address list"
20817 .cindex "address redirection" "included external list"
20818 If an item is of the form
20819 .code
20820 :include:<path name>
20821 .endd
20822 a list of further items is taken from the given file and included at that
20823 point. &*Note*&: Such a file can not be a filter file; it is just an
20824 out-of-line addition to the list. The items in the included list are separated
20825 by commas or newlines and are not subject to expansion. If this is the first
20826 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20827 the alias name. This example is incorrect:
20828 .code
20829 list1    :include:/opt/lists/list1
20830 .endd
20831 It must be given as
20832 .code
20833 list1:   :include:/opt/lists/list1
20834 .endd
20835 .new
20836 .cindex "tainted data" "in filenames"
20837 .cindex redirect "tainted data"
20838 Tainted data may not be used for a filename.
20839 .wen
20840 .next
20841 .cindex "address redirection" "to black hole"
20842 .cindex "delivery" "discard"
20843 .cindex "delivery" "blackhole"
20844 .cindex "black hole"
20845 .cindex "abandoning mail"
20846 Sometimes you want to throw away mail to a particular local part.  Making the
20847 &%data%& option expand to an empty string does not work, because that causes
20848 the router to decline. Instead, the alias item
20849 .code
20850 :blackhole:
20851 .endd
20852 can be used. It does what its name implies. No delivery is
20853 done, and no error message is generated. This has the same effect as specifying
20854 &_/dev/null_& as a destination, but it can be independently disabled.
20855
20856 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20857 delivery is done for the original local part, even if other redirection items
20858 are present. If you are generating a multi-item list (for example, by reading a
20859 database) and need the ability to provide a no-op item, you must use
20860 &_/dev/null_&.
20861
20862 .next
20863 .cindex "delivery" "forcing failure"
20864 .cindex "delivery" "forcing deferral"
20865 .cindex "failing delivery" "forcing"
20866 .cindex "deferred delivery, forcing"
20867 .cindex "customizing" "failure message"
20868 An attempt to deliver a particular address can be deferred or forced to fail by
20869 redirection items of the form
20870 .code
20871 :defer:
20872 :fail:
20873 .endd
20874 respectively. When a redirection list contains such an item, it applies
20875 to the entire redirection; any other items in the list are ignored. Any
20876 text following &':fail:'& or &':defer:'& is placed in the error text
20877 associated with the failure. For example, an alias file might contain:
20878 .code
20879 X.Employee:  :fail: Gone away, no forwarding address
20880 .endd
20881 In the case of an address that is being verified from an ACL or as the subject
20882 of a
20883 .cindex "VRFY" "error text, display of"
20884 VRFY command, the text is included in the SMTP error response by
20885 default.
20886 .cindex "EXPN" "error text, display of"
20887 The text is not included in the response to an EXPN command. In non-SMTP cases
20888 the text is included in the error message that Exim generates.
20889
20890 .cindex "SMTP" "error codes"
20891 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20892 &':fail:'&. However, if the message starts with three digits followed by a
20893 space, optionally followed by an extended code of the form &'n.n.n'&, also
20894 followed by a space, and the very first digit is the same as the default error
20895 code, the code from the message is used instead. If the very first digit is
20896 incorrect, a panic error is logged, and the default code is used. You can
20897 suppress the use of the supplied code in a redirect router by setting the
20898 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20899 ignored.
20900
20901 .vindex "&$acl_verify_message$&"
20902 In an ACL, an explicitly provided message overrides the default, but the
20903 default message is available in the variable &$acl_verify_message$& and can
20904 therefore be included in a custom message if this is desired.
20905
20906 Normally the error text is the rest of the redirection list &-- a comma does
20907 not terminate it &-- but a newline does act as a terminator. Newlines are not
20908 normally present in alias expansions. In &(lsearch)& lookups they are removed
20909 as part of the continuation process, but they may exist in other kinds of
20910 lookup and in &':include:'& files.
20911
20912 During routing for message delivery (as opposed to verification), a redirection
20913 containing &':fail:'& causes an immediate failure of the incoming address,
20914 whereas &':defer:'& causes the message to remain in the queue so that a
20915 subsequent delivery attempt can happen at a later time. If an address is
20916 deferred for too long, it will ultimately fail, because the normal retry
20917 rules still apply.
20918
20919 .next
20920 .cindex "alias file" "exception to default"
20921 Sometimes it is useful to use a single-key search type with a default (see
20922 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20923 for exceptions to the default. These can be handled by aliasing them to
20924 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20925 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20926 results in an empty redirection list has the same effect.
20927 .endlist
20928
20929
20930 .section "Duplicate addresses" "SECTdupaddr"
20931 .cindex "duplicate addresses"
20932 .cindex "address duplicate, discarding"
20933 .cindex "pipe" "duplicated"
20934 Exim removes duplicate addresses from the list to which it is delivering, so as
20935 to deliver just one copy to each address. This does not apply to deliveries
20936 routed to pipes by different immediate parent addresses, but an indirect
20937 aliasing scheme of the type
20938 .code
20939 pipe:       |/some/command $local_part
20940 localpart1: pipe
20941 localpart2: pipe
20942 .endd
20943 does not work with a message that is addressed to both local parts, because
20944 when the second is aliased to the intermediate local part &"pipe"& it gets
20945 discarded as being the same as a previously handled address. However, a scheme
20946 such as
20947 .code
20948 localpart1: |/some/command $local_part
20949 localpart2: |/some/command $local_part
20950 .endd
20951 does result in two different pipe deliveries, because the immediate parents of
20952 the pipes are distinct.
20953
20954
20955
20956 .section "Repeated redirection expansion" "SECID128"
20957 .cindex "repeated redirection expansion"
20958 .cindex "address redirection" "repeated for each delivery attempt"
20959 When a message cannot be delivered to all of its recipients immediately,
20960 leading to two or more delivery attempts, redirection expansion is carried out
20961 afresh each time for those addresses whose children were not all previously
20962 delivered. If redirection is being used as a mailing list, this can lead to new
20963 members of the list receiving copies of old messages. The &%one_time%& option
20964 can be used to avoid this.
20965
20966
20967 .section "Errors in redirection lists" "SECID129"
20968 .cindex "address redirection" "errors"
20969 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20970 error is skipped, and an entry is written to the main log. This may be useful
20971 for mailing lists that are automatically managed. Otherwise, if an error is
20972 detected while generating the list of new addresses, the original address is
20973 deferred. See also &%syntax_errors_to%&.
20974
20975
20976
20977 .section "Private options for the redirect router" "SECID130"
20978
20979 .cindex "options" "&(redirect)& router"
20980 The private options for the &(redirect)& router are as follows:
20981
20982
20983 .option allow_defer redirect boolean false
20984 Setting this option allows the use of &':defer:'& in non-filter redirection
20985 data, or the &%defer%& command in an Exim filter file.
20986
20987
20988 .option allow_fail redirect boolean false
20989 .cindex "failing delivery" "from filter"
20990 If this option is true, the &':fail:'& item can be used in a redirection list,
20991 and the &%fail%& command may be used in an Exim filter file.
20992
20993
20994 .option allow_filter redirect boolean false
20995 .cindex "filter" "enabling use of"
20996 .cindex "Sieve filter" "enabling use of"
20997 Setting this option allows Exim to interpret redirection data that starts with
20998 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20999 are some features of Exim filter files that some administrators may wish to
21000 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21001
21002 It is also possible to lock out Exim filters or Sieve filters while allowing
21003 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21004
21005
21006 The filter is run using the uid and gid set by the generic &%user%& and
21007 &%group%& options. These take their defaults from the password data if
21008 &%check_local_user%& is set, so in the normal case of users' personal filter
21009 files, the filter is run as the relevant user. When &%allow_filter%& is set
21010 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21011
21012
21013
21014 .option allow_freeze redirect boolean false
21015 .cindex "freezing messages" "allowing in filter"
21016 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21017 This command is more normally encountered in system filters, and is disabled by
21018 default for redirection filters because it isn't something you usually want to
21019 let ordinary users do.
21020
21021
21022
21023 .option check_ancestor redirect boolean false
21024 This option is concerned with handling generated addresses that are the same
21025 as some address in the list of redirection ancestors of the current address.
21026 Although it is turned off by default in the code, it is set in the default
21027 configuration file for handling users' &_.forward_& files. It is recommended
21028 for this use of the &(redirect)& router.
21029
21030 When &%check_ancestor%& is set, if a generated address (including the domain)
21031 is the same as any ancestor of the current address, it is replaced by a copy of
21032 the current address. This helps in the case where local part A is aliased to B,
21033 and B has a &_.forward_& file pointing back to A. For example, within a single
21034 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21035 &_&~jb/.forward_& contains:
21036 .code
21037 \Joe.Bloggs, <other item(s)>
21038 .endd
21039 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21040 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21041 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21042 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21043 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21044 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21045 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21046 original address. See also the &%repeat_use%& option below.
21047
21048
21049 .option check_group redirect boolean "see below"
21050 When the &%file%& option is used, the group owner of the file is checked only
21051 when this option is set. The permitted groups are those listed in the
21052 &%owngroups%& option, together with the user's default group if
21053 &%check_local_user%& is set. If the file has the wrong group, routing is
21054 deferred. The default setting for this option is true if &%check_local_user%&
21055 is set and the &%modemask%& option permits the group write bit, or if the
21056 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21057
21058
21059
21060 .option check_owner redirect boolean "see below"
21061 When the &%file%& option is used, the owner of the file is checked only when
21062 this option is set. If &%check_local_user%& is set, the local user is
21063 permitted; otherwise the owner must be one of those listed in the &%owners%&
21064 option. The default value for this option is true if &%check_local_user%& or
21065 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21066
21067
21068 .option data redirect string&!! unset
21069 This option is mutually exclusive with &%file%&. One or other of them must be
21070 set, but not both. The contents of &%data%& are expanded, and then used as the
21071 list of forwarding items, or as a set of filtering instructions. If the
21072 expansion is forced to fail, or the result is an empty string or a string that
21073 has no effect (consists entirely of comments), the router declines.
21074
21075 When filtering instructions are used, the string must begin with &"#Exim
21076 filter"&, and all comments in the string, including this initial one, must be
21077 terminated with newline characters. For example:
21078 .code
21079 data = #Exim filter\n\
21080        if $h_to: contains Exim then save $home/mail/exim endif
21081 .endd
21082 If you are reading the data from a database where newlines cannot be included,
21083 you can use the &${sg}$& expansion item to turn the escape string of your
21084 choice into a newline.
21085
21086
21087 .option directory_transport redirect string&!! unset
21088 A &(redirect)& router sets up a direct delivery to a directory when a path name
21089 ending with a slash is specified as a new &"address"&. The transport used is
21090 specified by this option, which, after expansion, must be the name of a
21091 configured transport. This should normally be an &(appendfile)& transport.
21092
21093
21094 .option file redirect string&!! unset
21095 This option specifies the name of a file that contains the redirection data. It
21096 is mutually exclusive with the &%data%& option. The string is expanded before
21097 use; if the expansion is forced to fail, the router declines. Other expansion
21098 failures cause delivery to be deferred. The result of a successful expansion
21099 must be an absolute path. The entire file is read and used as the redirection
21100 data. If the data is an empty string or a string that has no effect (consists
21101 entirely of comments), the router declines.
21102
21103 .cindex "NFS" "checking for file existence"
21104 If the attempt to open the file fails with a &"does not exist"& error, Exim
21105 runs a check on the containing directory,
21106 unless &%ignore_enotdir%& is true (see below).
21107 If the directory does not appear to exist, delivery is deferred. This can
21108 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21109 is a mount problem. If the containing directory does exist, but the file does
21110 not, the router declines.
21111
21112
21113 .option file_transport redirect string&!! unset
21114 .vindex "&$address_file$&"
21115 A &(redirect)& router sets up a direct delivery to a file when a path name not
21116 ending in a slash is specified as a new &"address"&. The transport used is
21117 specified by this option, which, after expansion, must be the name of a
21118 configured transport. This should normally be an &(appendfile)& transport. When
21119 it is running, the filename is in &$address_file$&.
21120
21121
21122 .option filter_prepend_home redirect boolean true
21123 When this option is true, if a &(save)& command in an Exim filter specifies a
21124 relative path, and &$home$& is defined, it is automatically prepended to the
21125 relative path. If this option is set false, this action does not happen. The
21126 relative path is then passed to the transport unmodified.
21127
21128
21129 .option forbid_blackhole redirect boolean false
21130 .cindex "restricting access to features"
21131 .cindex "filter" "locking out certain features"
21132 If this option is true, the &':blackhole:'& item may not appear in a
21133 redirection list.
21134
21135
21136 .option forbid_exim_filter redirect boolean false
21137 .cindex "restricting access to features"
21138 .cindex "filter" "locking out certain features"
21139 If this option is set true, only Sieve filters are permitted when
21140 &%allow_filter%& is true.
21141
21142
21143
21144
21145 .option forbid_file redirect boolean false
21146 .cindex "restricting access to features"
21147 .cindex "delivery" "to file; forbidding"
21148 .cindex "filter" "locking out certain features"
21149 .cindex "Sieve filter" "forbidding delivery to a file"
21150 .cindex "Sieve filter" "&""keep""& facility; disabling"
21151 If this option is true, this router may not generate a new address that
21152 specifies delivery to a local file or directory, either from a filter or from a
21153 conventional forward file. This option is forced to be true if &%one_time%& is
21154 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21155 locks out the Sieve's &"keep"& facility.
21156
21157
21158 .option forbid_filter_dlfunc redirect boolean false
21159 .cindex "restricting access to features"
21160 .cindex "filter" "locking out certain features"
21161 If this option is true, string expansions in Exim filters are not allowed to
21162 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21163 functions.
21164
21165 .option forbid_filter_existstest redirect boolean false
21166 .cindex "restricting access to features"
21167 .cindex "filter" "locking out certain features"
21168 .cindex "expansion" "statting a file"
21169 If this option is true, string expansions in Exim filters are not allowed to
21170 make use of the &%exists%& condition or the &%stat%& expansion item.
21171
21172 .option forbid_filter_logwrite redirect boolean false
21173 .cindex "restricting access to features"
21174 .cindex "filter" "locking out certain features"
21175 If this option is true, use of the logging facility in Exim filters is not
21176 permitted. Logging is in any case available only if the filter is being run
21177 under some unprivileged uid (which is normally the case for ordinary users'
21178 &_.forward_& files).
21179
21180
21181 .option forbid_filter_lookup redirect boolean false
21182 .cindex "restricting access to features"
21183 .cindex "filter" "locking out certain features"
21184 If this option is true, string expansions in Exim filter files are not allowed
21185 to make use of &%lookup%& items.
21186
21187
21188 .option forbid_filter_perl redirect boolean false
21189 .cindex "restricting access to features"
21190 .cindex "filter" "locking out certain features"
21191 This option has an effect only if Exim is built with embedded Perl support. If
21192 it is true, string expansions in Exim filter files are not allowed to make use
21193 of the embedded Perl support.
21194
21195
21196 .option forbid_filter_readfile redirect boolean false
21197 .cindex "restricting access to features"
21198 .cindex "filter" "locking out certain features"
21199 If this option is true, string expansions in Exim filter files are not allowed
21200 to make use of &%readfile%& items.
21201
21202
21203 .option forbid_filter_readsocket 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 &%readsocket%& items.
21208
21209
21210 .option forbid_filter_reply redirect boolean false
21211 .cindex "restricting access to features"
21212 .cindex "filter" "locking out certain features"
21213 If this option is true, this router may not generate an automatic reply
21214 message. Automatic replies can be generated only from Exim or Sieve filter
21215 files, not from traditional forward files. This option is forced to be true if
21216 &%one_time%& is set.
21217
21218
21219 .option forbid_filter_run redirect boolean false
21220 .cindex "restricting access to features"
21221 .cindex "filter" "locking out certain features"
21222 If this option is true, string expansions in Exim filter files are not allowed
21223 to make use of &%run%& items.
21224
21225
21226 .option forbid_include redirect boolean false
21227 .cindex "restricting access to features"
21228 .cindex "filter" "locking out certain features"
21229 If this option is true, items of the form
21230 .code
21231 :include:<path name>
21232 .endd
21233 are not permitted in non-filter redirection lists.
21234
21235
21236 .option forbid_pipe redirect boolean false
21237 .cindex "restricting access to features"
21238 .cindex "filter" "locking out certain features"
21239 .cindex "delivery" "to pipe; forbidding"
21240 If this option is true, this router may not generate a new address which
21241 specifies delivery to a pipe, either from an Exim filter or from a conventional
21242 forward file. This option is forced to be true if &%one_time%& is set.
21243
21244
21245 .option forbid_sieve_filter redirect boolean false
21246 .cindex "restricting access to features"
21247 .cindex "filter" "locking out certain features"
21248 If this option is set true, only Exim filters are permitted when
21249 &%allow_filter%& is true.
21250
21251
21252 .cindex "SMTP" "error codes"
21253 .option forbid_smtp_code redirect boolean false
21254 If this option is set true, any SMTP error codes that are present at the start
21255 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21256 the default codes (451 and 550, respectively) are always used.
21257
21258
21259
21260
21261 .option hide_child_in_errmsg redirect boolean false
21262 .cindex "bounce message" "redirection details; suppressing"
21263 If this option is true, it prevents Exim from quoting a child address if it
21264 generates a bounce or delay message for it. Instead it says &"an address
21265 generated from <&'the top level address'&>"&. Of course, this applies only to
21266 bounces generated locally. If a message is forwarded to another host, &'its'&
21267 bounce may well quote the generated address.
21268
21269
21270 .option ignore_eacces redirect boolean false
21271 .cindex "EACCES"
21272 If this option is set and an attempt to open a redirection file yields the
21273 EACCES error (permission denied), the &(redirect)& router behaves as if the
21274 file did not exist.
21275
21276
21277 .option ignore_enotdir redirect boolean false
21278 .cindex "ENOTDIR"
21279 If this option is set and an attempt to open a redirection file yields the
21280 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21281 router behaves as if the file did not exist.
21282
21283 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21284 router that has the &%file%& option set discovers that the file does not exist
21285 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21286 against unmounted NFS directories. If the parent can not be statted, delivery
21287 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21288 is set, because that option tells Exim to ignore &"something on the path is not
21289 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21290 that some operating systems give ENOENT where others give ENOTDIR.
21291
21292
21293
21294 .option include_directory redirect string unset
21295 If this option is set, the path names of any &':include:'& items in a
21296 redirection list must start with this directory.
21297
21298
21299 .option modemask redirect "octal integer" 022
21300 This specifies mode bits which must not be set for a file specified by the
21301 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21302
21303
21304 .option one_time redirect boolean false
21305 .cindex "one-time aliasing/forwarding expansion"
21306 .cindex "alias file" "one-time expansion"
21307 .cindex "forward file" "one-time expansion"
21308 .cindex "mailing lists" "one-time expansion"
21309 .cindex "address redirection" "one-time expansion"
21310 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21311 files each time it tries to deliver a message causes a problem when one or more
21312 of the generated addresses fails be delivered at the first attempt. The problem
21313 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21314 but of what happens when the redirection list changes during the time that the
21315 message is on Exim's queue. This is particularly true in the case of mailing
21316 lists, where new subscribers might receive copies of messages that were posted
21317 before they subscribed.
21318
21319 If &%one_time%& is set and any addresses generated by the router fail to
21320 deliver at the first attempt, the failing addresses are added to the message as
21321 &"top level"& addresses, and the parent address that generated them is marked
21322 &"delivered"&. Thus, redirection does not happen again at the next delivery
21323 attempt.
21324
21325 &*Warning 1*&: Any header line addition or removal that is specified by this
21326 router would be lost if delivery did not succeed at the first attempt. For this
21327 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21328 permitted when &%one_time%& is set.
21329
21330 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21331 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21332 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21333
21334 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21335 &%one_time%&.
21336
21337 The original top-level address is remembered with each of the generated
21338 addresses, and is output in any log messages. However, any intermediate parent
21339 addresses are not recorded. This makes a difference to the log only if
21340 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21341 typically be used for mailing lists, where there is normally just one level of
21342 expansion.
21343
21344
21345 .option owners redirect "string list" unset
21346 .cindex "ownership" "alias file"
21347 .cindex "ownership" "forward file"
21348 .cindex "alias file" "ownership"
21349 .cindex "forward file" "ownership"
21350 This specifies a list of permitted owners for the file specified by &%file%&.
21351 This list is in addition to the local user when &%check_local_user%& is set.
21352 See &%check_owner%& above.
21353
21354
21355 .option owngroups redirect "string list" unset
21356 This specifies a list of permitted groups for the file specified by &%file%&.
21357 The list is in addition to the local user's primary group when
21358 &%check_local_user%& is set. See &%check_group%& above.
21359
21360
21361 .option pipe_transport redirect string&!! unset
21362 .vindex "&$address_pipe$&"
21363 A &(redirect)& router sets up a direct delivery to a pipe when a string
21364 starting with a vertical bar character is specified as a new &"address"&. The
21365 transport used is specified by this option, which, after expansion, must be the
21366 name of a configured transport. This should normally be a &(pipe)& transport.
21367 When the transport is run, the pipe command is in &$address_pipe$&.
21368
21369
21370 .option qualify_domain redirect string&!! unset
21371 .vindex "&$qualify_recipient$&"
21372 If this option is set, and an unqualified address (one without a domain) is
21373 generated, and that address would normally be qualified by the global setting
21374 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21375 expanding this string. If the expansion fails, the router declines. If you want
21376 to revert to the default, you can have the expansion generate
21377 &$qualify_recipient$&.
21378
21379 This option applies to all unqualified addresses generated by Exim filters,
21380 but for traditional &_.forward_& files, it applies only to addresses that are
21381 not preceded by a backslash. Sieve filters cannot generate unqualified
21382 addresses.
21383
21384 .option qualify_preserve_domain redirect boolean false
21385 .cindex "domain" "in redirection; preserving"
21386 .cindex "preserving domain in redirection"
21387 .cindex "address redirection" "domain; preserving"
21388 If this option is set, the router's local &%qualify_domain%& option must not be
21389 set (a configuration error occurs if it is). If an unqualified address (one
21390 without a domain) is generated, it is qualified with the domain of the parent
21391 address (the immediately preceding ancestor) instead of the global
21392 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21393 this applies whether or not the address is preceded by a backslash.
21394
21395
21396 .option repeat_use redirect boolean true
21397 If this option is set false, the router is skipped for a child address that has
21398 any ancestor that was routed by this router. This test happens before any of
21399 the other preconditions are tested. Exim's default anti-looping rules skip
21400 only when the ancestor is the same as the current address. See also
21401 &%check_ancestor%& above and the generic &%redirect_router%& option.
21402
21403
21404 .option reply_transport redirect string&!! unset
21405 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21406 &%vacation%& command is used in a filter file. The transport used is specified
21407 by this option, which, after expansion, must be the name of a configured
21408 transport. This should normally be an &(autoreply)& transport. Other transports
21409 are unlikely to do anything sensible or useful.
21410
21411
21412 .option rewrite redirect boolean true
21413 .cindex "address redirection" "disabling rewriting"
21414 If this option is set false, addresses generated by the router are not
21415 subject to address rewriting. Otherwise, they are treated like new addresses
21416 and are rewritten according to the global rewriting rules.
21417
21418
21419 .option sieve_subaddress redirect string&!! unset
21420 The value of this option is passed to a Sieve filter to specify the
21421 :subaddress part of an address.
21422
21423 .option sieve_useraddress redirect string&!! unset
21424 The value of this option is passed to a Sieve filter to specify the :user part
21425 of an address. However, if it is unset, the entire original local part
21426 (including any prefix or suffix) is used for :user.
21427
21428
21429 .option sieve_vacation_directory redirect string&!! unset
21430 .cindex "Sieve filter" "vacation directory"
21431 To enable the &"vacation"& extension for Sieve filters, you must set
21432 &%sieve_vacation_directory%& to the directory where vacation databases are held
21433 (do not put anything else in that directory), and ensure that the
21434 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21435 needs their own directory; Exim will create it if necessary.
21436
21437
21438
21439 .option skip_syntax_errors redirect boolean false
21440 .cindex "forward file" "broken"
21441 .cindex "address redirection" "broken files"
21442 .cindex "alias file" "broken"
21443 .cindex "broken alias or forward files"
21444 .cindex "ignoring faulty addresses"
21445 .cindex "skipping faulty addresses"
21446 .cindex "error" "skipping bad syntax"
21447 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21448 non-filter redirection data are skipped, and each failing address is logged. If
21449 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21450 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21451 are expanded and placed at the head of the error message generated by
21452 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21453 be the same address as the generic &%errors_to%& option. The
21454 &%skip_syntax_errors%& option is often used when handling mailing lists.
21455
21456 If all the addresses in a redirection list are skipped because of syntax
21457 errors, the router declines to handle the original address, and it is passed to
21458 the following routers.
21459
21460 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21461 error in the filter causes filtering to be abandoned without any action being
21462 taken. The incident is logged, and the router declines to handle the address,
21463 so it is passed to the following routers.
21464
21465 .cindex "Sieve filter" "syntax errors in"
21466 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21467 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21468 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21469
21470 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21471 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21472 option, used with an address that does not get redirected, can be used to
21473 notify users of these errors, by means of a router like this:
21474 .code
21475 userforward:
21476   driver = redirect
21477   allow_filter
21478   check_local_user
21479   file = $home/.forward
21480   file_transport = address_file
21481   pipe_transport = address_pipe
21482   reply_transport = address_reply
21483   no_verify
21484   skip_syntax_errors
21485   syntax_errors_to = real-$local_part@$domain
21486   syntax_errors_text = \
21487    This is an automatically generated message. An error has\n\
21488    been found in your .forward file. Details of the error are\n\
21489    reported below. While this error persists, you will receive\n\
21490    a copy of this message for every message that is addressed\n\
21491    to you. If your .forward file is a filter file, or if it is\n\
21492    a non-filter file containing no valid forwarding addresses,\n\
21493    a copy of each incoming message will be put in your normal\n\
21494    mailbox. If a non-filter file contains at least one valid\n\
21495    forwarding address, forwarding to the valid addresses will\n\
21496    happen, and those will be the only deliveries that occur.
21497 .endd
21498 You also need a router to ensure that local addresses that are prefixed by
21499 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21500 put this immediately before the &(userforward)& router:
21501 .code
21502 real_localuser:
21503   driver = accept
21504   check_local_user
21505   local_part_prefix = real-
21506   transport = local_delivery
21507 .endd
21508 For security, it would probably be a good idea to restrict the use of this
21509 router to locally-generated messages, using a condition such as this:
21510 .code
21511   condition = ${if match {$sender_host_address}\
21512                          {\N^(|127\.0\.0\.1)$\N}}
21513 .endd
21514
21515
21516 .option syntax_errors_text redirect string&!! unset
21517 See &%skip_syntax_errors%& above.
21518
21519
21520 .option syntax_errors_to redirect string unset
21521 See &%skip_syntax_errors%& above.
21522 .ecindex IIDredrou1
21523 .ecindex IIDredrou2
21524
21525
21526
21527
21528
21529
21530 . ////////////////////////////////////////////////////////////////////////////
21531 . ////////////////////////////////////////////////////////////////////////////
21532
21533 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21534          "Environment for local transports"
21535 .scindex IIDenvlotra1 "local transports" "environment for"
21536 .scindex IIDenvlotra2 "environment" "local transports"
21537 .scindex IIDenvlotra3 "transport" "local; environment for"
21538 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21539 transport can be thought of as similar to a pipe.) Exim always runs transports
21540 in subprocesses, under specified uids and gids. Typical deliveries to local
21541 mailboxes run under the uid and gid of the local user.
21542
21543 Exim also sets a specific current directory while running the transport; for
21544 some transports a home directory setting is also relevant. The &(pipe)&
21545 transport is the only one that sets up environment variables; see section
21546 &<<SECTpipeenv>>& for details.
21547
21548 The values used for the uid, gid, and the directories may come from several
21549 different places. In many cases, the router that handles the address associates
21550 settings with that address as a result of its &%check_local_user%&, &%group%&,
21551 or &%user%& options. However, values may also be given in the transport's own
21552 configuration, and these override anything that comes from the router.
21553
21554
21555
21556 .section "Concurrent deliveries" "SECID131"
21557 .cindex "concurrent deliveries"
21558 .cindex "simultaneous deliveries"
21559 If two different messages for the same local recipient arrive more or less
21560 simultaneously, the two delivery processes are likely to run concurrently. When
21561 the &(appendfile)& transport is used to write to a file, Exim applies locking
21562 rules to stop concurrent processes from writing to the same file at the same
21563 time.
21564
21565 However, when you use a &(pipe)& transport, it is up to you to arrange any
21566 locking that is needed. Here is a silly example:
21567 .code
21568 my_transport:
21569   driver = pipe
21570   command = /bin/sh -c 'cat >>/some/file'
21571 .endd
21572 This is supposed to write the message at the end of the file. However, if two
21573 messages arrive at the same time, the file will be scrambled. You can use the
21574 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21575 file using the same algorithm that Exim itself uses.
21576
21577
21578
21579
21580 .section "Uids and gids" "SECTenvuidgid"
21581 .cindex "local transports" "uid and gid"
21582 .cindex "transport" "local; uid and gid"
21583 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21584 overrides any group that the router set in the address, even if &%user%& is not
21585 set for the transport. This makes it possible, for example, to run local mail
21586 delivery under the uid of the recipient (set by the router), but in a special
21587 group (set by the transport). For example:
21588 .code
21589 # Routers ...
21590 # User/group are set by check_local_user in this router
21591 local_users:
21592   driver = accept
21593   check_local_user
21594   transport = group_delivery
21595
21596 # Transports ...
21597 # This transport overrides the group
21598 group_delivery:
21599   driver = appendfile
21600   file = /var/spool/mail/$local_part
21601   group = mail
21602 .endd
21603 If &%user%& is set for a transport, its value overrides what is set in the
21604 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21605 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21606 set.
21607
21608 .oindex "&%initgroups%&"
21609 When the uid is taken from the transport's configuration, the &[initgroups()]&
21610 function is called for the groups associated with that uid if the
21611 &%initgroups%& option is set for the transport. When the uid is not specified
21612 by the transport, but is associated with the address by a router, the option
21613 for calling &[initgroups()]& is taken from the router configuration.
21614
21615 .cindex "&(pipe)& transport" "uid for"
21616 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21617 is set and &%user%& is not set, the uid of the process that called Exim to
21618 receive the message is used, and if &%group%& is not set, the corresponding
21619 original gid is also used.
21620
21621 This is the detailed preference order for obtaining a gid; the first of the
21622 following that is set is used:
21623
21624 .ilist
21625 A &%group%& setting of the transport;
21626 .next
21627 A &%group%& setting of the router;
21628 .next
21629 A gid associated with a user setting of the router, either as a result of
21630 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21631 .next
21632 The group associated with a non-numeric &%user%& setting of the transport;
21633 .next
21634 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21635 the uid is the creator's uid;
21636 .next
21637 The Exim gid if the Exim uid is being used as a default.
21638 .endlist
21639
21640 If, for example, the user is specified numerically on the router and there are
21641 no group settings, no gid is available. In this situation, an error occurs.
21642 This is different for the uid, for which there always is an ultimate default.
21643 The first of the following that is set is used:
21644
21645 .ilist
21646 A &%user%& setting of the transport;
21647 .next
21648 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21649 .next
21650 A &%user%& setting of the router;
21651 .next
21652 A &%check_local_user%& setting of the router;
21653 .next
21654 The Exim uid.
21655 .endlist
21656
21657 Of course, an error will still occur if the uid that is chosen is on the
21658 &%never_users%& list.
21659
21660
21661
21662
21663
21664 .section "Current and home directories" "SECID132"
21665 .cindex "current directory for local transport"
21666 .cindex "home directory" "for local transport"
21667 .cindex "transport" "local; home directory for"
21668 .cindex "transport" "local; current directory for"
21669 Routers may set current and home directories for local transports by means of
21670 the &%transport_current_directory%& and &%transport_home_directory%& options.
21671 However, if the transport's &%current_directory%& or &%home_directory%& options
21672 are set, they override the router's values. In detail, the home directory
21673 for a local transport is taken from the first of these values that is set:
21674
21675 .ilist
21676 The &%home_directory%& option on the transport;
21677 .next
21678 The &%transport_home_directory%& option on the router;
21679 .next
21680 The password data if &%check_local_user%& is set on the router;
21681 .next
21682 The &%router_home_directory%& option on the router.
21683 .endlist
21684
21685 The current directory is taken from the first of these values that is set:
21686
21687 .ilist
21688 The &%current_directory%& option on the transport;
21689 .next
21690 The &%transport_current_directory%& option on the router.
21691 .endlist
21692
21693
21694 If neither the router nor the transport sets a current directory, Exim uses the
21695 value of the home directory, if it is set. Otherwise it sets the current
21696 directory to &_/_& before running a local transport.
21697
21698
21699
21700 .section "Expansion variables derived from the address" "SECID133"
21701 .vindex "&$domain$&"
21702 .vindex "&$local_part$&"
21703 .vindex "&$original_domain$&"
21704 Normally a local delivery is handling a single address, and in that case the
21705 variables such as &$domain$& and &$local_part$& are set during local
21706 deliveries. However, in some circumstances more than one address may be handled
21707 at once (for example, while writing batch SMTP for onward transmission by some
21708 other means). In this case, the variables associated with the local part are
21709 never set, &$domain$& is set only if all the addresses have the same domain,
21710 and &$original_domain$& is never set.
21711 .ecindex IIDenvlotra1
21712 .ecindex IIDenvlotra2
21713 .ecindex IIDenvlotra3
21714
21715
21716
21717
21718
21719
21720
21721 . ////////////////////////////////////////////////////////////////////////////
21722 . ////////////////////////////////////////////////////////////////////////////
21723
21724 .chapter "Generic options for transports" "CHAPtransportgeneric"
21725 .scindex IIDgenoptra1 "generic options" "transport"
21726 .scindex IIDgenoptra2 "options" "generic; for transports"
21727 .scindex IIDgenoptra3 "transport" "generic options for"
21728 The following generic options apply to all transports:
21729
21730
21731 .option body_only transports boolean false
21732 .cindex "transport" "body only"
21733 .cindex "message" "transporting body only"
21734 .cindex "body of message" "transporting"
21735 If this option is set, the message's headers are not transported. It is
21736 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21737 or &(pipe)& transports, the settings of &%message_prefix%& and
21738 &%message_suffix%& should be checked, because this option does not
21739 automatically suppress them.
21740
21741
21742 .option current_directory transports string&!! unset
21743 .cindex "transport" "current directory for"
21744 This specifies the current directory that is to be set while running the
21745 transport, overriding any value that may have been set by the router.
21746 If the expansion fails for any reason, including forced failure, an error is
21747 logged, and delivery is deferred.
21748
21749
21750 .option disable_logging transports boolean false
21751 If this option is set true, nothing is logged for any
21752 deliveries by the transport or for any
21753 transport errors. You should not set this option unless you really, really know
21754 what you are doing.
21755
21756
21757 .option debug_print transports string&!! unset
21758 .cindex "testing" "variables in drivers"
21759 If this option is set and debugging is enabled (see the &%-d%& command line
21760 option), the string is expanded and included in the debugging output when the
21761 transport is run.
21762 If expansion of the string fails, the error message is written to the debugging
21763 output, and Exim carries on processing.
21764 This facility is provided to help with checking out the values of variables and
21765 so on when debugging driver configurations. For example, if a &%headers_add%&
21766 option is not working properly, &%debug_print%& could be used to output the
21767 variables it references. A newline is added to the text if it does not end with
21768 one.
21769 The variables &$transport_name$& and &$router_name$& contain the name of the
21770 transport and the router that called it.
21771
21772 .option delivery_date_add transports boolean false
21773 .cindex "&'Delivery-date:'& header line"
21774 If this option is true, a &'Delivery-date:'& header is added to the message.
21775 This gives the actual time the delivery was made. As this is not a standard
21776 header, Exim has a configuration option (&%delivery_date_remove%&) which
21777 requests its removal from incoming messages, so that delivered messages can
21778 safely be resent to other recipients.
21779
21780
21781 .option driver transports string unset
21782 This specifies which of the available transport drivers is to be used.
21783 There is no default, and this option must be set for every transport.
21784
21785
21786 .option envelope_to_add transports boolean false
21787 .cindex "&'Envelope-to:'& header line"
21788 If this option is true, an &'Envelope-to:'& header is added to the message.
21789 This gives the original address(es) in the incoming envelope that caused this
21790 delivery to happen. More than one address may be present if the transport is
21791 configured to handle several addresses at once, or if more than one original
21792 address was redirected to the same final address. As this is not a standard
21793 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21794 its removal from incoming messages, so that delivered messages can safely be
21795 resent to other recipients.
21796
21797
21798 .option event_action transports string&!! unset
21799 .cindex events
21800 This option declares a string to be expanded for Exim's events mechanism.
21801 For details see chapter &<<CHAPevents>>&.
21802
21803
21804 .option group transports string&!! "Exim group"
21805 .cindex "transport" "group; specifying"
21806 This option specifies a gid for running the transport process, overriding any
21807 value that the router supplies, and also overriding any value associated with
21808 &%user%& (see below).
21809
21810
21811 .option headers_add transports list&!! unset
21812 .cindex "header lines" "adding in transport"
21813 .cindex "transport" "header lines; adding"
21814 This option specifies a list of text headers,
21815 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21816 which are (separately) expanded and added to the header
21817 portion of a message as it is transported, as described in section
21818 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21819 routers. If the result of the expansion is an empty string, or if the expansion
21820 is forced to fail, no action is taken. Other expansion failures are treated as
21821 errors and cause the delivery to be deferred.
21822
21823 Unlike most options, &%headers_add%& can be specified multiple times
21824 for a transport; all listed headers are added.
21825
21826
21827 .option headers_only transports boolean false
21828 .cindex "transport" "header lines only"
21829 .cindex "message" "transporting headers only"
21830 .cindex "header lines" "transporting"
21831 If this option is set, the message's body is not transported. It is mutually
21832 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21833 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21834 checked, since this option does not automatically suppress them.
21835
21836
21837 .option headers_remove transports list&!! unset
21838 .cindex "header lines" "removing"
21839 .cindex "transport" "header lines; removing"
21840 This option specifies a list of header names,
21841 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21842 these headers are omitted from the message as it is transported, as described
21843 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21844 routers.
21845 Each list item is separately expanded.
21846 If the result of the expansion is an empty string, or if the expansion
21847 is forced to fail, no action is taken. Other expansion failures are treated as
21848 errors and cause the delivery to be deferred.
21849
21850 Unlike most options, &%headers_remove%& can be specified multiple times
21851 for a transport; all listed headers are removed.
21852
21853 &*Warning*&: Because of the separate expansion of the list items,
21854 items that contain a list separator must have it doubled.
21855 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21856
21857
21858
21859 .option headers_rewrite transports string unset
21860 .cindex "transport" "header lines; rewriting"
21861 .cindex "rewriting" "at transport time"
21862 This option allows addresses in header lines to be rewritten at transport time,
21863 that is, as the message is being copied to its destination. The contents of the
21864 option are a colon-separated list of rewriting rules. Each rule is in exactly
21865 the same form as one of the general rewriting rules that are applied when a
21866 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21867 example,
21868 .code
21869 headers_rewrite = a@b c@d f : \
21870                   x@y w@z
21871 .endd
21872 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21873 &'w@z'& in all address-bearing header lines. The rules are applied to the
21874 header lines just before they are written out at transport time, so they affect
21875 only those copies of the message that pass through the transport. However, only
21876 the message's original header lines, and any that were added by a system
21877 filter, are rewritten. If a router or transport adds header lines, they are not
21878 affected by this option. These rewriting rules are &'not'& applied to the
21879 envelope. You can change the return path using &%return_path%&, but you cannot
21880 change envelope recipients at this time.
21881
21882
21883 .option home_directory transports string&!! unset
21884 .cindex "transport" "home directory for"
21885 .vindex "&$home$&"
21886 This option specifies a home directory setting for a local transport,
21887 overriding any value that may be set by the router. The home directory is
21888 placed in &$home$& while expanding the transport's private options. It is also
21889 used as the current directory if no current directory is set by the
21890 &%current_directory%& option on the transport or the
21891 &%transport_current_directory%& option on the router. If the expansion fails
21892 for any reason, including forced failure, an error is logged, and delivery is
21893 deferred.
21894
21895
21896 .option initgroups transports boolean false
21897 .cindex "additional groups"
21898 .cindex "groups" "additional"
21899 .cindex "transport" "group; additional"
21900 If this option is true and the uid for the delivery process is provided by the
21901 transport, the &[initgroups()]& function is called when running the transport
21902 to ensure that any additional groups associated with the uid are set up.
21903
21904
21905 .option max_parallel transports integer&!! unset
21906 .cindex limit "transport parallelism"
21907 .cindex transport "parallel processes"
21908 .cindex transport "concurrency limit"
21909 .cindex "delivery" "parallelism for transport"
21910 If this option is set and expands to an integer greater than zero
21911 it limits the number of concurrent runs of the transport.
21912 The control does not apply to shadow transports.
21913
21914 .cindex "hints database" "transport concurrency control"
21915 Exim implements this control by means of a hints database in which a record is
21916 incremented whenever a transport process is being created. The record
21917 is decremented and possibly removed when the process terminates.
21918 Obviously there is scope for
21919 records to get left lying around if there is a system or program crash. To
21920 guard against this, Exim ignores any records that are more than six hours old.
21921
21922 If you use this option, you should also arrange to delete the
21923 relevant hints database whenever your system reboots. The names of the files
21924 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21925 may be one or two files, depending on the type of DBM in use. The same files
21926 are used for ETRN and smtp transport serialization.
21927
21928
21929 .option message_size_limit transports string&!! 0
21930 .cindex "limit" "message size per transport"
21931 .cindex "size" "of message, limit"
21932 .cindex "transport" "message size; limiting"
21933 This option controls the size of messages passed through the transport. It is
21934 expanded before use; the result of the expansion must be a sequence of decimal
21935 digits, optionally followed by K or M. If the expansion fails for any reason,
21936 including forced failure, or if the result is not of the required form,
21937 delivery is deferred. If the value is greater than zero and the size of a
21938 message exceeds this limit, the address is failed. If there is any chance that
21939 the resulting bounce message could be routed to the same transport, you should
21940 ensure that &%return_size_limit%& is less than the transport's
21941 &%message_size_limit%&, as otherwise the bounce message will fail to get
21942 delivered.
21943
21944
21945
21946 .option rcpt_include_affixes transports boolean false
21947 .cindex "prefix" "for local part, including in envelope"
21948 .cindex "suffix for local part" "including in envelope"
21949 .cindex "local part" "prefix"
21950 .cindex "local part" "suffix"
21951 When this option is false (the default), and an address that has had any
21952 affixes (prefixes or suffixes) removed from the local part is delivered by any
21953 form of SMTP or LMTP, the affixes are not included. For example, if a router
21954 that contains
21955 .code
21956 local_part_prefix = *-
21957 .endd
21958 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21959 is delivered with
21960 .code
21961 RCPT TO:<xyz@some.domain>
21962 .endd
21963 This is also the case when an ACL-time callout is being used to verify a
21964 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21965 whole local part is included in the RCPT command. This option applies to BSMTP
21966 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21967 &(lmtp)& and &(smtp)& transports.
21968
21969
21970 .option retry_use_local_part transports boolean "see below"
21971 .cindex "hints database" "retry keys"
21972 When a delivery suffers a temporary failure, a retry record is created
21973 in Exim's hints database. For remote deliveries, the key for the retry record
21974 is based on the name and/or IP address of the failing remote host. For local
21975 deliveries, the key is normally the entire address, including both the local
21976 part and the domain. This is suitable for most common cases of local delivery
21977 temporary failure &-- for example, exceeding a mailbox quota should delay only
21978 deliveries to that mailbox, not to the whole domain.
21979
21980 However, in some special cases you may want to treat a temporary local delivery
21981 as a failure associated with the domain, and not with a particular local part.
21982 (For example, if you are storing all mail for some domain in files.) You can do
21983 this by setting &%retry_use_local_part%& false.
21984
21985 For all the local transports, its default value is true. For remote transports,
21986 the default value is false for tidiness, but changing the value has no effect
21987 on a remote transport in the current implementation.
21988
21989
21990 .option return_path transports string&!! unset
21991 .cindex "envelope sender"
21992 .cindex "envelope from"
21993 .cindex "transport" "return path; changing"
21994 .cindex "return path" "changing in transport"
21995 If this option is set, the string is expanded at transport time and replaces
21996 the existing return path (envelope sender) value in the copy of the message
21997 that is being delivered. An empty return path is permitted. This feature is
21998 designed for remote deliveries, where the value of this option is used in the
21999 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22000 only effect is to change the address that is placed in the &'Return-path:'&
22001 header line, if one is added to the message (see the next option).
22002
22003 &*Note:*& A changed return path is not logged unless you add
22004 &%return_path_on_delivery%& to the log selector.
22005
22006 .vindex "&$return_path$&"
22007 The expansion can refer to the existing value via &$return_path$&. This is
22008 either the message's envelope sender, or an address set by the
22009 &%errors_to%& option on a router. If the expansion is forced to fail, no
22010 replacement occurs; if it fails for another reason, delivery is deferred. This
22011 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22012 section &<<SECTverp>>&.
22013
22014 &*Note*&: If a delivery error is detected locally, including the case when a
22015 remote server rejects a message at SMTP time, the bounce message is not sent to
22016 the value of this option. It is sent to the previously set errors address.
22017 This defaults to the incoming sender address, but can be changed by setting
22018 &%errors_to%& in a router.
22019
22020
22021
22022 .option return_path_add transports boolean false
22023 .cindex "&'Return-path:'& header line"
22024 If this option is true, a &'Return-path:'& header is added to the message.
22025 Although the return path is normally available in the prefix line of BSD
22026 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22027 have easy access to it.
22028
22029 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22030 the delivery SMTP server makes the final delivery"&. This implies that this
22031 header should not be present in incoming messages. Exim has a configuration
22032 option, &%return_path_remove%&, which requests removal of this header from
22033 incoming messages, so that delivered messages can safely be resent to other
22034 recipients.
22035
22036
22037 .option shadow_condition transports string&!! unset
22038 See &%shadow_transport%& below.
22039
22040
22041 .option shadow_transport transports string unset
22042 .cindex "shadow transport"
22043 .cindex "transport" "shadow"
22044 A local transport may set the &%shadow_transport%& option to the name of
22045 another local transport. Shadow remote transports are not supported.
22046
22047 Whenever a delivery to the main transport succeeds, and either
22048 &%shadow_condition%& is unset, or its expansion does not result in the empty
22049 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22050 passed to the shadow transport, with the same delivery address or addresses. If
22051 expansion fails, no action is taken except that non-forced expansion failures
22052 cause a log line to be written.
22053
22054 The result of the shadow transport is discarded and does not affect the
22055 subsequent processing of the message. Only a single level of shadowing is
22056 provided; the &%shadow_transport%& option is ignored on any transport when it
22057 is running as a shadow. Options concerned with output from pipes are also
22058 ignored. The log line for the successful delivery has an item added on the end,
22059 of the form
22060 .code
22061 ST=<shadow transport name>
22062 .endd
22063 If the shadow transport did not succeed, the error message is put in
22064 parentheses afterwards. Shadow transports can be used for a number of different
22065 purposes, including keeping more detailed log information than Exim normally
22066 provides, and implementing automatic acknowledgment policies based on message
22067 headers that some sites insist on.
22068
22069
22070 .option transport_filter transports string&!! unset
22071 .cindex "transport" "filter"
22072 .cindex "filter" "transport filter"
22073 This option sets up a filtering (in the Unix shell sense) process for messages
22074 at transport time. It should not be confused with mail filtering as set up by
22075 individual users or via a system filter.
22076 If unset, or expanding to an empty string, no filtering is done.
22077
22078 When the message is about to be written out, the command specified by
22079 &%transport_filter%& is started up in a separate, parallel process, and
22080 the entire message, including the header lines, is passed to it on its standard
22081 input (this in fact is done from a third process, to avoid deadlock). The
22082 command must be specified as an absolute path.
22083
22084 The lines of the message that are written to the transport filter are
22085 terminated by newline (&"\n"&). The message is passed to the filter before any
22086 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22087 lines beginning with a dot, and also before any processing implied by the
22088 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22089 &(pipe)& transports.
22090
22091 The standard error for the filter process is set to the same destination as its
22092 standard output; this is read and written to the message's ultimate
22093 destination. The process that writes the message to the filter, the
22094 filter itself, and the original process that reads the result and delivers it
22095 are all run in parallel, like a shell pipeline.
22096
22097 The filter can perform any transformations it likes, but of course should take
22098 care not to break RFC 2822 syntax. Exim does not check the result, except to
22099 test for a final newline when SMTP is in use. All messages transmitted over
22100 SMTP must end with a newline, so Exim supplies one if it is missing.
22101
22102 .cindex "content scanning" "per user"
22103 A transport filter can be used to provide content-scanning on a per-user basis
22104 at delivery time if the only required effect of the scan is to modify the
22105 message. For example, a content scan could insert a new header line containing
22106 a spam score. This could be interpreted by a filter in the user's MUA. It is
22107 not possible to discard a message at this stage.
22108
22109 .cindex "SMTP" "SIZE"
22110 A problem might arise if the filter increases the size of a message that is
22111 being sent down an SMTP connection. If the receiving SMTP server has indicated
22112 support for the SIZE parameter, Exim will have sent the size of the message
22113 at the start of the SMTP session. If what is actually sent is substantially
22114 more, the server might reject the message. This can be worked round by setting
22115 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22116 additions to the message, or to disable the use of SIZE altogether.
22117
22118 .vindex "&$pipe_addresses$&"
22119 The value of the &%transport_filter%& option is the command string for starting
22120 the filter, which is run directly from Exim, not under a shell. The string is
22121 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22122 Exim breaks it up into arguments and then expands each argument separately (see
22123 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22124 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22125 of arguments, one for each address that applies to this delivery. (This isn't
22126 an ideal name for this feature here, but as it was already implemented for the
22127 &(pipe)& transport, it seemed sensible not to change it.)
22128
22129 .vindex "&$host$&"
22130 .vindex "&$host_address$&"
22131 The expansion variables &$host$& and &$host_address$& are available when the
22132 transport is a remote one. They contain the name and IP address of the host to
22133 which the message is being sent. For example:
22134 .code
22135 transport_filter = /some/directory/transport-filter.pl \
22136   $host $host_address $sender_address $pipe_addresses
22137 .endd
22138
22139 Two problems arise if you want to use more complicated expansion items to
22140 generate transport filter commands, both of which due to the fact that the
22141 command is split up &'before'& expansion.
22142 .ilist
22143 If an expansion item contains white space, you must quote it, so that it is all
22144 part of the same command item. If the entire option setting is one such
22145 expansion item, you have to take care what kind of quoting you use. For
22146 example:
22147 .code
22148 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22149 .endd
22150 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22151 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22152 stripped by Exim when it read the option's value. When the value is used, if
22153 the single quotes were missing, the line would be split into two items,
22154 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22155 Exim tried to expand the first one.
22156 .next
22157 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22158 expansion cannot generate multiple arguments, or a command name followed by
22159 arguments. Consider this example:
22160 .code
22161 transport_filter = ${lookup{$host}lsearch{/a/file}\
22162                     {$value}{/bin/cat}}
22163 .endd
22164 The result of the lookup is interpreted as the name of the command, even
22165 if it contains white space. The simplest way round this is to use a shell:
22166 .code
22167 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22168                                {$value}{/bin/cat}}
22169 .endd
22170 .endlist
22171
22172 The filter process is run under the same uid and gid as the normal delivery.
22173 For remote deliveries this is the Exim uid/gid by default. The command should
22174 normally yield a zero return code. Transport filters are not supposed to fail.
22175 A non-zero code is taken to mean that the transport filter encountered some
22176 serious problem. Delivery of the message is deferred; the message remains on
22177 the queue and is tried again later. It is not possible to cause a message to be
22178 bounced from a transport filter.
22179
22180 If a transport filter is set on an autoreply transport, the original message is
22181 passed through the filter as it is being copied into the newly generated
22182 message, which happens if the &%return_message%& option is set.
22183
22184
22185 .option transport_filter_timeout transports time 5m
22186 .cindex "transport" "filter, timeout"
22187 When Exim is reading the output of a transport filter, it applies a timeout
22188 that can be set by this option. Exceeding the timeout is normally treated as a
22189 temporary delivery failure. However, if a transport filter is used with a
22190 &(pipe)& transport, a timeout in the transport filter is treated in the same
22191 way as a timeout in the pipe command itself. By default, a timeout is a hard
22192 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22193 becomes a temporary error.
22194
22195
22196 .option user transports string&!! "Exim user"
22197 .cindex "uid (user id)" "local delivery"
22198 .cindex "transport" "user, specifying"
22199 This option specifies the user under whose uid the delivery process is to be
22200 run, overriding any uid that may have been set by the router. If the user is
22201 given as a name, the uid is looked up from the password data, and the
22202 associated group is taken as the value of the gid to be used if the &%group%&
22203 option is not set.
22204
22205 For deliveries that use local transports, a user and group are normally
22206 specified explicitly or implicitly (for example, as a result of
22207 &%check_local_user%&) by the router or transport.
22208
22209 .cindex "hints database" "access by remote transport"
22210 For remote transports, you should leave this option unset unless you really are
22211 sure you know what you are doing. When a remote transport is running, it needs
22212 to be able to access Exim's hints databases, because each host may have its own
22213 retry data.
22214 .ecindex IIDgenoptra1
22215 .ecindex IIDgenoptra2
22216 .ecindex IIDgenoptra3
22217
22218
22219
22220
22221
22222
22223 . ////////////////////////////////////////////////////////////////////////////
22224 . ////////////////////////////////////////////////////////////////////////////
22225
22226 .chapter "Address batching in local transports" "CHAPbatching" &&&
22227          "Address batching"
22228 .cindex "transport" "local; address batching in"
22229 The only remote transport (&(smtp)&) is normally configured to handle more than
22230 one address at a time, so that when several addresses are routed to the same
22231 remote host, just one copy of the message is sent. Local transports, however,
22232 normally handle one address at a time. That is, a separate instance of the
22233 transport is run for each address that is routed to the transport. A separate
22234 copy of the message is delivered each time.
22235
22236 .cindex "batched local delivery"
22237 .oindex "&%batch_max%&"
22238 .oindex "&%batch_id%&"
22239 In special cases, it may be desirable to handle several addresses at once in a
22240 local transport, for example:
22241
22242 .ilist
22243 In an &(appendfile)& transport, when storing messages in files for later
22244 delivery by some other means, a single copy of the message with multiple
22245 recipients saves space.
22246 .next
22247 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22248 a single copy saves time, and is the normal way LMTP is expected to work.
22249 .next
22250 In a &(pipe)& transport, when passing the message
22251 to a scanner program or
22252 to some other delivery mechanism such as UUCP, multiple recipients may be
22253 acceptable.
22254 .endlist
22255
22256 These three local transports all have the same options for controlling multiple
22257 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22258 repeating the information for each transport, these options are described here.
22259
22260 The &%batch_max%& option specifies the maximum number of addresses that can be
22261 delivered together in a single run of the transport. Its default value is one
22262 (no batching). When more than one address is routed to a transport that has a
22263 &%batch_max%& value greater than one, the addresses are delivered in a batch
22264 (that is, in a single run of the transport with multiple recipients), subject
22265 to certain conditions:
22266
22267 .ilist
22268 .vindex "&$local_part$&"
22269 If any of the transport's options contain a reference to &$local_part$&, no
22270 batching is possible.
22271 .next
22272 .vindex "&$domain$&"
22273 If any of the transport's options contain a reference to &$domain$&, only
22274 addresses with the same domain are batched.
22275 .next
22276 .cindex "customizing" "batching condition"
22277 If &%batch_id%& is set, it is expanded for each address, and only those
22278 addresses with the same expanded value are batched. This allows you to specify
22279 customized batching conditions. Failure of the expansion for any reason,
22280 including forced failure, disables batching, but it does not stop the delivery
22281 from taking place.
22282 .next
22283 Batched addresses must also have the same errors address (where to send
22284 delivery errors), the same header additions and removals, the same user and
22285 group for the transport, and if a host list is present, the first host must
22286 be the same.
22287 .endlist
22288
22289 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22290 both when the file or pipe command is specified in the transport, and when it
22291 is specified by a &(redirect)& router, but all the batched addresses must of
22292 course be routed to the same file or pipe command. These two transports have an
22293 option called &%use_bsmtp%&, which causes them to deliver the message in
22294 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22295 &%check_string%& and &%escape_string%& options are forced to the values
22296 .code
22297 check_string = "."
22298 escape_string = ".."
22299 .endd
22300 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22301 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22302 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22303
22304 .cindex "&'Envelope-to:'& header line"
22305 If the generic &%envelope_to_add%& option is set for a batching transport, the
22306 &'Envelope-to:'& header that is added to the message contains all the addresses
22307 that are being processed together. If you are using a batching &(appendfile)&
22308 transport without &%use_bsmtp%&, the only way to preserve the recipient
22309 addresses is to set the &%envelope_to_add%& option.
22310
22311 .cindex "&(pipe)& transport" "with multiple addresses"
22312 .vindex "&$pipe_addresses$&"
22313 If you are using a &(pipe)& transport without BSMTP, and setting the
22314 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22315 the command. This is not a true variable; it is a bit of magic that causes each
22316 of the recipient addresses to be inserted into the command as a separate
22317 argument. This provides a way of accessing all the addresses that are being
22318 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22319 are specified by a &(redirect)& router.
22320
22321
22322
22323
22324 . ////////////////////////////////////////////////////////////////////////////
22325 . ////////////////////////////////////////////////////////////////////////////
22326
22327 .chapter "The appendfile transport" "CHAPappendfile"
22328 .scindex IIDapptra1 "&(appendfile)& transport"
22329 .scindex IIDapptra2 "transports" "&(appendfile)&"
22330 .cindex "directory creation"
22331 .cindex "creating directories"
22332 The &(appendfile)& transport delivers a message by appending it to an existing
22333 file, or by creating an entirely new file in a specified directory. Single
22334 files to which messages are appended can be in the traditional Unix mailbox
22335 format, or optionally in the MBX format supported by the Pine MUA and
22336 University of Washington IMAP daemon, &'inter alia'&. When each message is
22337 being delivered as a separate file, &"maildir"& format can optionally be used
22338 to give added protection against failures that happen part-way through the
22339 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22340 supported. For all file formats, Exim attempts to create as many levels of
22341 directory as necessary, provided that &%create_directory%& is set.
22342
22343 The code for the optional formats is not included in the Exim binary by
22344 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22345 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22346 included.
22347
22348 .cindex "quota" "system"
22349 Exim recognizes system quota errors, and generates an appropriate message. Exim
22350 also supports its own quota control within the transport, for use when the
22351 system facility is unavailable or cannot be used for some reason.
22352
22353 If there is an error while appending to a file (for example, quota exceeded or
22354 partition filled), Exim attempts to reset the file's length and last
22355 modification time back to what they were before. If there is an error while
22356 creating an entirely new file, the new file is removed.
22357
22358 Before appending to a file, a number of security checks are made, and the
22359 file is locked. A detailed description is given below, after the list of
22360 private options.
22361
22362 The &(appendfile)& transport is most commonly used for local deliveries to
22363 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22364 putting messages into files for remote delivery by some means other than Exim.
22365 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22366 option).
22367
22368
22369
22370 .section "The file and directory options" "SECTfildiropt"
22371 The &%file%& option specifies a single file, to which the message is appended;
22372 the &%directory%& option specifies a directory, in which a new file containing
22373 the message is created. Only one of these two options can be set, and for
22374 normal deliveries to mailboxes, one of them &'must'& be set.
22375
22376 .vindex "&$address_file$&"
22377 .vindex "&$local_part$&"
22378 However, &(appendfile)& is also used for delivering messages to files or
22379 directories whose names (or parts of names) are obtained from alias,
22380 forwarding, or filtering operations (for example, a &%save%& command in a
22381 user's Exim filter). When such a transport is running, &$local_part$& contains
22382 the local part that was aliased or forwarded, and &$address_file$& contains the
22383 name (or partial name) of the file or directory generated by the redirection
22384 operation. There are two cases:
22385
22386 .ilist
22387 If neither &%file%& nor &%directory%& is set, the redirection operation
22388 must specify an absolute path (one that begins with &`/`&). This is the most
22389 common case when users with local accounts use filtering to sort mail into
22390 different folders. See for example, the &(address_file)& transport in the
22391 default configuration. If the path ends with a slash, it is assumed to be the
22392 name of a directory. A delivery to a directory can also be forced by setting
22393 &%maildir_format%& or &%mailstore_format%&.
22394 .next
22395 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22396 used to determine the file or directory name for the delivery. Normally, the
22397 contents of &$address_file$& are used in some way in the string expansion.
22398 .endlist
22399 .new
22400 .cindex "tainted data" "in filenames"
22401 .cindex appendfile "tainted data"
22402 Tainted data may not be used for a file or directory name.
22403 This means that, for instance, &$local_part$& cannot be used directly
22404 as a component of a path.  It can however be used as the key for a lookup
22405 which returns a path (or component).
22406 .wen
22407
22408
22409 .cindex "Sieve filter" "configuring &(appendfile)&"
22410 .cindex "Sieve filter" "relative mailbox path handling"
22411 As an example of the second case, consider an environment where users do not
22412 have home directories. They may be permitted to use Exim filter commands of the
22413 form:
22414 .code
22415 save folder23
22416 .endd
22417 or Sieve filter commands of the form:
22418 .code
22419 require "fileinto";
22420 fileinto "folder23";
22421 .endd
22422 In this situation, the expansion of &%file%& or &%directory%& in the transport
22423 must transform the relative path into an appropriate absolute filename. In the
22424 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22425 is used as a result of a &"keep"& action in the filter. This example shows one
22426 way of handling this requirement:
22427 .code
22428 file = ${if eq{$address_file}{inbox} \
22429             {/var/mail/$local_part} \
22430             {${if eq{${substr_0_1:$address_file}}{/} \
22431                   {$address_file} \
22432                   {$home/mail/$address_file} \
22433             }} \
22434        }
22435 .endd
22436 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22437 location, absolute paths are used without change, and other folders are in the
22438 &_mail_& directory within the home directory.
22439
22440 &*Note 1*&: While processing an Exim filter, a relative path such as
22441 &_folder23_& is turned into an absolute path if a home directory is known to
22442 the router. In particular, this is the case if &%check_local_user%& is set. If
22443 you want to prevent this happening at routing time, you can set
22444 &%router_home_directory%& empty. This forces the router to pass the relative
22445 path to the transport.
22446
22447 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22448 the &%file%& or &%directory%& option is still used if it is set.
22449
22450
22451
22452
22453 .section "Private options for appendfile" "SECID134"
22454 .cindex "options" "&(appendfile)& transport"
22455
22456
22457
22458 .option allow_fifo appendfile boolean false
22459 .cindex "fifo (named pipe)"
22460 .cindex "named pipe (fifo)"
22461 .cindex "pipe" "named (fifo)"
22462 Setting this option permits delivery to named pipes (FIFOs) as well as to
22463 regular files. If no process is reading the named pipe at delivery time, the
22464 delivery is deferred.
22465
22466
22467 .option allow_symlink appendfile boolean false
22468 .cindex "symbolic link" "to mailbox"
22469 .cindex "mailbox" "symbolic link"
22470 By default, &(appendfile)& will not deliver if the path name for the file is
22471 that of a symbolic link. Setting this option relaxes that constraint, but there
22472 are security issues involved in the use of symbolic links. Be sure you know
22473 what you are doing if you set this. Details of exactly what this option affects
22474 are included in the discussion which follows this list of options.
22475
22476
22477 .option batch_id appendfile string&!! unset
22478 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22479 However, batching is automatically disabled for &(appendfile)& deliveries that
22480 happen as a result of forwarding or aliasing or other redirection directly to a
22481 file.
22482
22483
22484 .option batch_max appendfile integer 1
22485 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22486
22487
22488 .option check_group appendfile boolean false
22489 When this option is set, the group owner of the file defined by the &%file%&
22490 option is checked to see that it is the same as the group under which the
22491 delivery process is running. The default setting is false because the default
22492 file mode is 0600, which means that the group is irrelevant.
22493
22494
22495 .option check_owner appendfile boolean true
22496 When this option is set, the owner of the file defined by the &%file%& option
22497 is checked to ensure that it is the same as the user under which the delivery
22498 process is running.
22499
22500
22501 .option check_string appendfile string "see below"
22502 .cindex "&""From""& line"
22503 As &(appendfile)& writes the message, the start of each line is tested for
22504 matching &%check_string%&, and if it does, the initial matching characters are
22505 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22506 a literal string, not a regular expression, and the case of any letters it
22507 contains is significant.
22508
22509 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22510 are forced to &"."& and &".."& respectively, and any settings in the
22511 configuration are ignored. Otherwise, they default to &"From&~"& and
22512 &">From&~"& when the &%file%& option is set, and unset when any of the
22513 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22514
22515 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22516 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22517 &"From&~"& indicates the start of a new message. All four options need changing
22518 if another format is used. For example, to deliver to mailboxes in MMDF format:
22519 .cindex "MMDF format mailbox"
22520 .cindex "mailbox" "MMDF format"
22521 .code
22522 check_string = "\1\1\1\1\n"
22523 escape_string = "\1\1\1\1 \n"
22524 message_prefix = "\1\1\1\1\n"
22525 message_suffix = "\1\1\1\1\n"
22526 .endd
22527 .option create_directory appendfile boolean true
22528 .cindex "directory creation"
22529 When this option is true, Exim attempts to create any missing superior
22530 directories for the file that it is about to write. A created directory's mode
22531 is given by the &%directory_mode%& option.
22532
22533 The group ownership of a newly created directory is highly dependent on the
22534 operating system (and possibly the file system) that is being used. For
22535 example, in Solaris, if the parent directory has the setgid bit set, its group
22536 is propagated to the child; if not, the currently set group is used. However,
22537 in FreeBSD, the parent's group is always used.
22538
22539
22540
22541 .option create_file appendfile string anywhere
22542 This option constrains the location of files and directories that are created
22543 by this transport. It applies to files defined by the &%file%& option and
22544 directories defined by the &%directory%& option. In the case of maildir
22545 delivery, it applies to the top level directory, not the maildir directories
22546 beneath.
22547
22548 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22549 &"belowhome"&. In the second and third cases, a home directory must have been
22550 set for the transport. This option is not useful when an explicit filename is
22551 given for normal mailbox deliveries. It is intended for the case when filenames
22552 are generated from users' &_.forward_& files. These are usually handled
22553 by an &(appendfile)& transport called &%address_file%&. See also
22554 &%file_must_exist%&.
22555
22556
22557 .option directory appendfile string&!! unset
22558 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22559 or &%directory%& must be set, unless the delivery is the direct result of a
22560 redirection (see section &<<SECTfildiropt>>&).
22561
22562 When &%directory%& is set, the string is expanded, and the message is delivered
22563 into a new file or files in or below the given directory, instead of being
22564 appended to a single mailbox file. A number of different formats are provided
22565 (see &%maildir_format%& and &%mailstore_format%&), and see section
22566 &<<SECTopdir>>& for further details of this form of delivery.
22567
22568
22569 .option directory_file appendfile string&!! "see below"
22570 .cindex "base62"
22571 .vindex "&$inode$&"
22572 When &%directory%& is set, but neither &%maildir_format%& nor
22573 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22574 whose name is obtained by expanding this string. The default value is:
22575 .code
22576 q${base62:$tod_epoch}-$inode
22577 .endd
22578 This generates a unique name from the current time, in base 62 form, and the
22579 inode of the file. The variable &$inode$& is available only when expanding this
22580 option.
22581
22582
22583 .option directory_mode appendfile "octal integer" 0700
22584 If &(appendfile)& creates any directories as a result of the
22585 &%create_directory%& option, their mode is specified by this option.
22586
22587
22588 .option escape_string appendfile string "see description"
22589 See &%check_string%& above.
22590
22591
22592 .option file appendfile string&!! unset
22593 This option is mutually exclusive with the &%directory%& option, but one of
22594 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22595 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22596 specifies a single file, to which the message is appended. One or more of
22597 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22598 &%file%&.
22599
22600 .cindex "NFS" "lock file"
22601 .cindex "locking files"
22602 .cindex "lock files"
22603 If you are using more than one host to deliver over NFS into the same
22604 mailboxes, you should always use lock files.
22605
22606 The string value is expanded for each delivery, and must yield an absolute
22607 path. The most common settings of this option are variations on one of these
22608 examples:
22609 .code
22610 file = /var/spool/mail/$local_part
22611 file = /home/$local_part/inbox
22612 file = $home/inbox
22613 .endd
22614 .cindex "&""sticky""& bit"
22615 In the first example, all deliveries are done into the same directory. If Exim
22616 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22617 create a file in the directory, so the &"sticky"& bit must be turned on for
22618 deliveries to be possible, or alternatively the &%group%& option can be used to
22619 run the delivery under a group id which has write access to the directory.
22620
22621
22622
22623 .option file_format appendfile string unset
22624 .cindex "file" "mailbox; checking existing format"
22625 This option requests the transport to check the format of an existing file
22626 before adding to it. The check consists of matching a specific string at the
22627 start of the file. The value of the option consists of an even number of
22628 colon-separated strings. The first of each pair is the test string, and the
22629 second is the name of a transport. If the transport associated with a matched
22630 string is not the current transport, control is passed over to the other
22631 transport. For example, suppose the standard &(local_delivery)& transport has
22632 this added to it:
22633 .code
22634 file_format = "From       : local_delivery :\
22635                \1\1\1\1\n : local_mmdf_delivery"
22636 .endd
22637 Mailboxes that begin with &"From"& are still handled by this transport, but if
22638 a mailbox begins with four binary ones followed by a newline, control is passed
22639 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22640 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22641 is assumed to match the current transport. If the start of a mailbox doesn't
22642 match any string, or if the transport named for a given string is not defined,
22643 delivery is deferred.
22644
22645
22646 .option file_must_exist appendfile boolean false
22647 If this option is true, the file specified by the &%file%& option must exist.
22648 A temporary error occurs if it does not, causing delivery to be deferred.
22649 If this option is false, the file is created if it does not exist.
22650
22651
22652 .option lock_fcntl_timeout appendfile time 0s
22653 .cindex "timeout" "mailbox locking"
22654 .cindex "mailbox" "locking, blocking and non-blocking"
22655 .cindex "locking files"
22656 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22657 when locking an open mailbox file. If the call fails, the delivery process
22658 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22659 Non-blocking calls are used so that the file is not kept open during the wait
22660 for the lock; the reason for this is to make it as safe as possible for
22661 deliveries over NFS in the case when processes might be accessing an NFS
22662 mailbox without using a lock file. This should not be done, but
22663 misunderstandings and hence misconfigurations are not unknown.
22664
22665 On a busy system, however, the performance of a non-blocking lock approach is
22666 not as good as using a blocking lock with a timeout. In this case, the waiting
22667 is done inside the system call, and Exim's delivery process acquires the lock
22668 and can proceed as soon as the previous lock holder releases it.
22669
22670 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22671 timeout, are used. There may still be some retrying: the maximum number of
22672 retries is
22673 .code
22674 (lock_retries * lock_interval) / lock_fcntl_timeout
22675 .endd
22676 rounded up to the next whole number. In other words, the total time during
22677 which &(appendfile)& is trying to get a lock is roughly the same, unless
22678 &%lock_fcntl_timeout%& is set very large.
22679
22680 You should consider setting this option if you are getting a lot of delayed
22681 local deliveries because of errors of the form
22682 .code
22683 failed to lock mailbox /some/file (fcntl)
22684 .endd
22685
22686 .option lock_flock_timeout appendfile time 0s
22687 This timeout applies to file locking when using &[flock()]& (see
22688 &%use_flock%&); the timeout operates in a similar manner to
22689 &%lock_fcntl_timeout%&.
22690
22691
22692 .option lock_interval appendfile time 3s
22693 This specifies the time to wait between attempts to lock the file. See below
22694 for details of locking.
22695
22696
22697 .option lock_retries appendfile integer 10
22698 This specifies the maximum number of attempts to lock the file. A value of zero
22699 is treated as 1. See below for details of locking.
22700
22701
22702 .option lockfile_mode appendfile "octal integer" 0600
22703 This specifies the mode of the created lock file, when a lock file is being
22704 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22705
22706
22707 .option lockfile_timeout appendfile time 30m
22708 .cindex "timeout" "mailbox locking"
22709 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22710 exists and is older than this value, it is assumed to have been left behind by
22711 accident, and Exim attempts to remove it.
22712
22713
22714 .option mailbox_filecount appendfile string&!! unset
22715 .cindex "mailbox" "specifying size of"
22716 .cindex "size" "of mailbox"
22717 If this option is set, it is expanded, and the result is taken as the current
22718 number of files in the mailbox. It must be a decimal number, optionally
22719 followed by K or M. This provides a way of obtaining this information from an
22720 external source that maintains the data.
22721
22722
22723 .option mailbox_size appendfile string&!! unset
22724 .cindex "mailbox" "specifying size of"
22725 .cindex "size" "of mailbox"
22726 If this option is set, it is expanded, and the result is taken as the current
22727 size the mailbox. It must be a decimal number, optionally followed by K or M.
22728 This provides a way of obtaining this information from an external source that
22729 maintains the data. This is likely to be helpful for maildir deliveries where
22730 it is computationally expensive to compute the size of a mailbox.
22731
22732
22733
22734 .option maildir_format appendfile boolean false
22735 .cindex "maildir format" "specifying"
22736 If this option is set with the &%directory%& option, the delivery is into a new
22737 file, in the &"maildir"& format that is used by other mail software. When the
22738 transport is activated directly from a &(redirect)& router (for example, the
22739 &(address_file)& transport in the default configuration), setting
22740 &%maildir_format%& causes the path received from the router to be treated as a
22741 directory, whether or not it ends with &`/`&. This option is available only if
22742 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22743 &<<SECTmaildirdelivery>>& below for further details.
22744
22745
22746 .option maildir_quota_directory_regex appendfile string "See below"
22747 .cindex "maildir format" "quota; directories included in"
22748 .cindex "quota" "maildir; directories included in"
22749 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22750 a regular expression for specifying directories, relative to the quota
22751 directory (see &%quota_directory%&), that should be included in the quota
22752 calculation. The default value is:
22753 .code
22754 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22755 .endd
22756 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22757 (directories whose names begin with a dot). If you want to exclude the
22758 &_Trash_&
22759 folder from the count (as some sites do), you need to change this setting to
22760 .code
22761 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22762 .endd
22763 This uses a negative lookahead in the regular expression to exclude the
22764 directory whose name is &_.Trash_&. When a directory is excluded from quota
22765 calculations, quota processing is bypassed for any messages that are delivered
22766 directly into that directory.
22767
22768
22769 .option maildir_retries appendfile integer 10
22770 This option specifies the number of times to retry when writing a file in
22771 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22772
22773
22774 .option maildir_tag appendfile string&!! unset
22775 This option applies only to deliveries in maildir format, and is described in
22776 section &<<SECTmaildirdelivery>>& below.
22777
22778
22779 .option maildir_use_size_file appendfile&!! boolean false
22780 .cindex "maildir format" "&_maildirsize_& file"
22781 The result of string expansion for this option must be a valid boolean value.
22782 If it is true, it enables support for &_maildirsize_& files. Exim
22783 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22784 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22785 value is zero. See &%maildir_quota_directory_regex%& above and section
22786 &<<SECTmaildirdelivery>>& below for further details.
22787
22788 .option maildirfolder_create_regex appendfile string unset
22789 .cindex "maildir format" "&_maildirfolder_& file"
22790 .cindex "&_maildirfolder_&, creating"
22791 The value of this option is a regular expression. If it is unset, it has no
22792 effect. Otherwise, before a maildir delivery takes place, the pattern is
22793 matched against the name of the maildir directory, that is, the directory
22794 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22795 delivery. If there is a match, Exim checks for the existence of a file called
22796 &_maildirfolder_& in the directory, and creates it if it does not exist.
22797 See section &<<SECTmaildirdelivery>>& for more details.
22798
22799
22800 .option mailstore_format appendfile boolean false
22801 .cindex "mailstore format" "specifying"
22802 If this option is set with the &%directory%& option, the delivery is into two
22803 new files in  &"mailstore"& format. The option is available only if
22804 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22805 below for further details.
22806
22807
22808 .option mailstore_prefix appendfile string&!! unset
22809 This option applies only to deliveries in mailstore format, and is described in
22810 section &<<SECTopdir>>& below.
22811
22812
22813 .option mailstore_suffix appendfile string&!! unset
22814 This option applies only to deliveries in mailstore format, and is described in
22815 section &<<SECTopdir>>& below.
22816
22817
22818 .option mbx_format appendfile boolean false
22819 .cindex "locking files"
22820 .cindex "file" "locking"
22821 .cindex "file" "MBX format"
22822 .cindex "MBX format, specifying"
22823 This option is available only if Exim has been compiled with SUPPORT_MBX
22824 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22825 the message is appended to the mailbox file in MBX format instead of
22826 traditional Unix format. This format is supported by Pine4 and its associated
22827 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22828
22829 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22830 automatically changed by the use of &%mbx_format%&. They should normally be set
22831 empty when using MBX format, so this option almost always appears in this
22832 combination:
22833 .code
22834 mbx_format = true
22835 message_prefix =
22836 message_suffix =
22837 .endd
22838 If none of the locking options are mentioned in the configuration,
22839 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22840 is possible to specify the other kinds of locking with &%mbx_format%&, but
22841 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22842 interworks with &'c-client'&, providing for shared access to the mailbox. It
22843 should not be used if any program that does not use this form of locking is
22844 going to access the mailbox, nor should it be used if the mailbox file is NFS
22845 mounted, because it works only when the mailbox is accessed from a single host.
22846
22847 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22848 the standard version of &'c-client'&, because as long as it has a mailbox open
22849 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22850 append messages to it.
22851
22852
22853 .option message_prefix appendfile string&!! "see below"
22854 .cindex "&""From""& line"
22855 The string specified here is expanded and output at the start of every message.
22856 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22857 in which case it is:
22858 .code
22859 message_prefix = "From ${if def:return_path{$return_path}\
22860   {MAILER-DAEMON}} $tod_bsdinbox\n"
22861 .endd
22862 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22863 &`\n`& to &`\r\n`& in &%message_prefix%&.
22864
22865 .option message_suffix appendfile string&!! "see below"
22866 The string specified here is expanded and output at the end of every message.
22867 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22868 in which case it is a single newline character. The suffix can be suppressed by
22869 setting
22870 .code
22871 message_suffix =
22872 .endd
22873 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22874 &`\n`& to &`\r\n`& in &%message_suffix%&.
22875
22876 .option mode appendfile "octal integer" 0600
22877 If the output file is created, it is given this mode. If it already exists and
22878 has wider permissions, they are reduced to this mode. If it has narrower
22879 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22880 if the delivery is the result of a &%save%& command in a filter file specifying
22881 a particular mode, the mode of the output file is always forced to take that
22882 value, and this option is ignored.
22883
22884
22885 .option mode_fail_narrower appendfile boolean true
22886 This option applies in the case when an existing mailbox file has a narrower
22887 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22888 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22889 continues with the delivery attempt, using the existing mode of the file.
22890
22891
22892 .option notify_comsat appendfile boolean false
22893 If this option is true, the &'comsat'& daemon is notified after every
22894 successful delivery to a user mailbox. This is the daemon that notifies logged
22895 on users about incoming mail.
22896
22897
22898 .option quota appendfile string&!! unset
22899 .cindex "quota" "imposed by Exim"
22900 This option imposes a limit on the size of the file to which Exim is appending,
22901 or to the total space used in the directory tree when the &%directory%& option
22902 is set. In the latter case, computation of the space used is expensive, because
22903 all the files in the directory (and any sub-directories) have to be
22904 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22905 &%maildir_use_size_file%& for ways to avoid this in environments where users
22906 have no shell access to their mailboxes).
22907
22908 As there is no interlock against two simultaneous deliveries into a
22909 multi-file mailbox, it is possible for the quota to be overrun in this case.
22910 For single-file mailboxes, of course, an interlock is a necessity.
22911
22912 A file's size is taken as its &'used'& value. Because of blocking effects, this
22913 may be a lot less than the actual amount of disk space allocated to the file.
22914 If the sizes of a number of files are being added up, the rounding effect can
22915 become quite noticeable, especially on systems that have large block sizes.
22916 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22917 the obvious value which users understand most easily.
22918
22919 The value of the option is expanded, and must then be a numerical value
22920 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22921 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22922 and further option modifiers. If Exim is running on a system with
22923 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22924 be handled.
22925
22926 The option modifier &%no_check%& can be used to force delivery even if the over
22927 quota condition is met. The quota gets updated as usual.
22928
22929 &*Note*&: A value of zero is interpreted as &"no quota"&.
22930
22931 The expansion happens while Exim is running as root, before it changes uid for
22932 the delivery. This means that files that are inaccessible to the end user can
22933 be used to hold quota values that are looked up in the expansion. When delivery
22934 fails because this quota is exceeded, the handling of the error is as for
22935 system quota failures.
22936
22937 By default, Exim's quota checking mimics system quotas, and restricts the
22938 mailbox to the specified maximum size, though the value is not accurate to the
22939 last byte, owing to separator lines and additional headers that may get added
22940 during message delivery. When a mailbox is nearly full, large messages may get
22941 refused even though small ones are accepted, because the size of the current
22942 message is added to the quota when the check is made. This behaviour can be
22943 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22944 for exceeding the quota does not include the current message. Thus, deliveries
22945 continue until the quota has been exceeded; thereafter, no further messages are
22946 delivered. See also &%quota_warn_threshold%&.
22947
22948
22949 .option quota_directory appendfile string&!! unset
22950 This option defines the directory to check for quota purposes when delivering
22951 into individual files. The default is the delivery directory, or, if a file
22952 called &_maildirfolder_& exists in a maildir directory, the parent of the
22953 delivery directory.
22954
22955
22956 .option quota_filecount appendfile string&!! 0
22957 This option applies when the &%directory%& option is set. It limits the total
22958 number of files in the directory (compare the inode limit in system quotas). It
22959 can only be used if &%quota%& is also set. The value is expanded; an expansion
22960 failure causes delivery to be deferred. A value of zero is interpreted as
22961 &"no quota"&.
22962
22963 The option modifier &%no_check%& can be used to force delivery even if the over
22964 quota condition is met. The quota gets updated as usual.
22965
22966 .option quota_is_inclusive appendfile boolean true
22967 See &%quota%& above.
22968
22969
22970 .option quota_size_regex appendfile string unset
22971 This option applies when one of the delivery modes that writes a separate file
22972 for each message is being used. When Exim wants to find the size of one of
22973 these files in order to test the quota, it first checks &%quota_size_regex%&.
22974 If this is set to a regular expression that matches the filename, and it
22975 captures one string, that string is interpreted as a representation of the
22976 file's size. The value of &%quota_size_regex%& is not expanded.
22977
22978 This feature is useful only when users have no shell access to their mailboxes
22979 &-- otherwise they could defeat the quota simply by renaming the files. This
22980 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22981 the file length to the filename. For example:
22982 .code
22983 maildir_tag = ,S=$message_size
22984 quota_size_regex = ,S=(\d+)
22985 .endd
22986 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22987 number of lines in the message.
22988
22989 The regular expression should not assume that the length is at the end of the
22990 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22991 sometimes add other information onto the ends of message filenames.
22992
22993 Section &<<SECID136>>& contains further information.
22994
22995 This option should not be used when other message-handling software
22996 may duplicate messages by making hardlinks to the files.  When that is done Exim
22997 will count the message size once for each filename, in contrast with the actual
22998 disk usage.  When the option is not set, calculating total usage requires
22999 a system-call per file to get the size; the number of links is then available also
23000 as is used to adjust the effective size.
23001
23002
23003 .option quota_warn_message appendfile string&!! "see below"
23004 See below for the use of this option. If it is not set when
23005 &%quota_warn_threshold%& is set, it defaults to
23006 .code
23007 quota_warn_message = "\
23008   To: $local_part@$domain\n\
23009   Subject: Your mailbox\n\n\
23010   This message is automatically created \
23011   by mail delivery software.\n\n\
23012   The size of your mailbox has exceeded \
23013   a warning threshold that is\n\
23014   set by the system administrator.\n"
23015 .endd
23016
23017
23018 .option quota_warn_threshold appendfile string&!! 0
23019 .cindex "quota" "warning threshold"
23020 .cindex "mailbox" "size warning"
23021 .cindex "size" "of mailbox"
23022 This option is expanded in the same way as &%quota%& (see above). If the
23023 resulting value is greater than zero, and delivery of the message causes the
23024 size of the file or total space in the directory tree to cross the given
23025 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23026 may be specified as a percentage of it by following the value with a percent
23027 sign. For example:
23028 .code
23029 quota = 10M
23030 quota_warn_threshold = 75%
23031 .endd
23032 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23033 percent sign is ignored.
23034
23035 The warning message itself is specified by the &%quota_warn_message%& option,
23036 and it must start with a &'To:'& header line containing the recipient(s) of the
23037 warning message. These do not necessarily have to include the recipient(s) of
23038 the original message. A &'Subject:'& line should also normally be supplied. You
23039 can include any other header lines that you want. If you do not include a
23040 &'From:'& line, the default is:
23041 .code
23042 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23043 .endd
23044 .oindex &%errors_reply_to%&
23045 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23046 option.
23047
23048 The &%quota%& option does not have to be set in order to use this option; they
23049 are independent of one another except when the threshold is specified as a
23050 percentage.
23051
23052
23053 .option use_bsmtp appendfile boolean false
23054 .cindex "envelope from"
23055 .cindex "envelope sender"
23056 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23057 format, with the envelope sender and recipient(s) included as SMTP commands. If
23058 you want to include a leading HELO command with such messages, you can do
23059 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23060 for details of batch SMTP.
23061
23062
23063 .option use_crlf appendfile boolean false
23064 .cindex "carriage return"
23065 .cindex "linefeed"
23066 This option causes lines to be terminated with the two-character CRLF sequence
23067 (carriage return, linefeed) instead of just a linefeed character. In the case
23068 of batched SMTP, the byte sequence written to the file is then an exact image
23069 of what would be sent down a real SMTP connection.
23070
23071 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23072 (which are used to supply the traditional &"From&~"& and blank line separators
23073 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23074 carriage return characters if these are needed. In cases where these options
23075 have non-empty defaults, the values end with a single linefeed, so they must be
23076 changed to end with &`\r\n`& if &%use_crlf%& is set.
23077
23078
23079 .option use_fcntl_lock appendfile boolean "see below"
23080 This option controls the use of the &[fcntl()]& function to lock a file for
23081 exclusive use when a message is being appended. It is set by default unless
23082 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23083 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23084 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23085
23086
23087 .option use_flock_lock appendfile boolean false
23088 This option is provided to support the use of &[flock()]& for file locking, for
23089 the few situations where it is needed. Most modern operating systems support
23090 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23091 each other. Exim uses &[fcntl()]& locking by default.
23092
23093 This option is required only if you are using an operating system where
23094 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23095 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23096 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23097
23098 .cindex "Solaris" "&[flock()]& support"
23099 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23100 have it (and some, I think, provide a not quite right version built on top of
23101 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23102 the ability to use it, and any attempt to do so will cause a configuration
23103 error.
23104
23105 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23106 is just being mapped onto &[fcntl()]& by the OS).
23107
23108
23109 .option use_lockfile appendfile boolean "see below"
23110 If this option is turned off, Exim does not attempt to create a lock file when
23111 appending to a mailbox file. In this situation, the only locking is by
23112 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23113 sure that every MUA that is ever going to look at your users' mailboxes uses
23114 &[fcntl()]& rather than a lock file, and even then only when you are not
23115 delivering over NFS from more than one host.
23116
23117 .cindex "NFS" "lock file"
23118 In order to append to an NFS file safely from more than one host, it is
23119 necessary to take out a lock &'before'& opening the file, and the lock file
23120 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23121 file corruption.
23122
23123 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23124 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23125 except when &%mbx_format%& is set.
23126
23127
23128 .option use_mbx_lock appendfile boolean "see below"
23129 This option is available only if Exim has been compiled with SUPPORT_MBX
23130 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23131 locking rules be used. It is set by default if &%mbx_format%& is set and none
23132 of the locking options are mentioned in the configuration. The locking rules
23133 are the same as are used by the &'c-client'& library that underlies Pine and
23134 the IMAP4 and POP daemons that come with it (see the discussion below). The
23135 rules allow for shared access to the mailbox. However, this kind of locking
23136 does not work when the mailbox is NFS mounted.
23137
23138 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23139 &%use_flock_lock%& to control what kind of locking is used in implementing the
23140 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23141 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23142
23143
23144
23145
23146 .section "Operational details for appending" "SECTopappend"
23147 .cindex "appending to a file"
23148 .cindex "file" "appending"
23149 Before appending to a file, the following preparations are made:
23150
23151 .ilist
23152 If the name of the file is &_/dev/null_&, no action is taken, and a success
23153 return is given.
23154
23155 .next
23156 .cindex "directory creation"
23157 If any directories on the file's path are missing, Exim creates them if the
23158 &%create_directory%& option is set. A created directory's mode is given by the
23159 &%directory_mode%& option.
23160
23161 .next
23162 If &%file_format%& is set, the format of an existing file is checked. If this
23163 indicates that a different transport should be used, control is passed to that
23164 transport.
23165
23166 .next
23167 .cindex "file" "locking"
23168 .cindex "locking files"
23169 .cindex "NFS" "lock file"
23170 If &%use_lockfile%& is set, a lock file is built in a way that will work
23171 reliably over NFS, as follows:
23172
23173 .olist
23174 Create a &"hitching post"& file whose name is that of the lock file with the
23175 current time, primary host name, and process id added, by opening for writing
23176 as a new file. If this fails with an access error, delivery is deferred.
23177 .next
23178 Close the hitching post file, and hard link it to the lock filename.
23179 .next
23180 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23181 Unlink the hitching post name.
23182 .next
23183 Otherwise, use &[stat()]& to get information about the hitching post file, and
23184 then unlink hitching post name. If the number of links is exactly two, creation
23185 of the lock file succeeded but something (for example, an NFS server crash and
23186 restart) caused this fact not to be communicated to the &[link()]& call.
23187 .next
23188 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23189 up to &%lock_retries%& times. However, since any program that writes to a
23190 mailbox should complete its task very quickly, it is reasonable to time out old
23191 lock files that are normally the result of user agent and system crashes. If an
23192 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23193 it before trying again.
23194 .endlist olist
23195
23196 .next
23197 A call is made to &[lstat()]& to discover whether the main file exists, and if
23198 so, what its characteristics are. If &[lstat()]& fails for any reason other
23199 than non-existence, delivery is deferred.
23200
23201 .next
23202 .cindex "symbolic link" "to mailbox"
23203 .cindex "mailbox" "symbolic link"
23204 If the file does exist and is a symbolic link, delivery is deferred, unless the
23205 &%allow_symlink%& option is set, in which case the ownership of the link is
23206 checked, and then &[stat()]& is called to find out about the real file, which
23207 is then subjected to the checks below. The check on the top-level link
23208 ownership prevents one user creating a link for another's mailbox in a sticky
23209 directory, though allowing symbolic links in this case is definitely not a good
23210 idea. If there is a chain of symbolic links, the intermediate ones are not
23211 checked.
23212
23213 .next
23214 If the file already exists but is not a regular file, or if the file's owner
23215 and group (if the group is being checked &-- see &%check_group%& above) are
23216 different from the user and group under which the delivery is running,
23217 delivery is deferred.
23218
23219 .next
23220 If the file's permissions are more generous than specified, they are reduced.
23221 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23222 is set false, in which case the delivery is tried using the existing
23223 permissions.
23224
23225 .next
23226 The file's inode number is saved, and the file is then opened for appending.
23227 If this fails because the file has vanished, &(appendfile)& behaves as if it
23228 hadn't existed (see below). For any other failures, delivery is deferred.
23229
23230 .next
23231 If the file is opened successfully, check that the inode number hasn't
23232 changed, that it is still a regular file, and that the owner and permissions
23233 have not changed. If anything is wrong, defer delivery and freeze the message.
23234
23235 .next
23236 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23237 option is set. Otherwise, check that the file is being created in a permitted
23238 directory if the &%create_file%& option is set (deferring on failure), and then
23239 open for writing as a new file, with the O_EXCL and O_CREAT options,
23240 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23241 set). In this case, which can happen if the link points to a non-existent file,
23242 the file is opened for writing using O_CREAT but not O_EXCL, because
23243 that prevents link following.
23244
23245 .next
23246 .cindex "loop" "while file testing"
23247 If opening fails because the file exists, obey the tests given above for
23248 existing files. However, to avoid looping in a situation where the file is
23249 being continuously created and destroyed, the exists/not-exists loop is broken
23250 after 10 repetitions, and the message is then frozen.
23251
23252 .next
23253 If opening fails with any other error, defer delivery.
23254
23255 .next
23256 .cindex "file" "locking"
23257 .cindex "locking files"
23258 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23259 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23260 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23261 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23262 file, and an exclusive lock on the file whose name is
23263 .code
23264 /tmp/.<device-number>.<inode-number>
23265 .endd
23266 using the device and inode numbers of the open mailbox file, in accordance with
23267 the MBX locking rules. This file is created with a mode that is specified by
23268 the &%lockfile_mode%& option.
23269
23270 If Exim fails to lock the file, there are two possible courses of action,
23271 depending on the value of the locking timeout. This is obtained from
23272 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23273
23274 If the timeout value is zero, the file is closed, Exim waits for
23275 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23276 to lock it again. This happens up to &%lock_retries%& times, after which the
23277 delivery is deferred.
23278
23279 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23280 &[flock()]& are used (with the given timeout), so there has already been some
23281 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23282 immediately. It retries up to
23283 .code
23284 (lock_retries * lock_interval) / <timeout>
23285 .endd
23286 times (rounded up).
23287 .endlist
23288
23289 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23290 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23291
23292
23293 .section "Operational details for delivery to a new file" "SECTopdir"
23294 .cindex "delivery" "to single file"
23295 .cindex "&""From""& line"
23296 When the &%directory%& option is set instead of &%file%&, each message is
23297 delivered into a newly-created file or set of files. When &(appendfile)& is
23298 activated directly from a &(redirect)& router, neither &%file%& nor
23299 &%directory%& is normally set, because the path for delivery is supplied by the
23300 router. (See for example, the &(address_file)& transport in the default
23301 configuration.) In this case, delivery is to a new file if either the path name
23302 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23303
23304 No locking is required while writing the message to a new file, so the various
23305 locking options of the transport are ignored. The &"From"& line that by default
23306 separates messages in a single file is not normally needed, nor is the escaping
23307 of message lines that start with &"From"&, and there is no need to ensure a
23308 newline at the end of each message. Consequently, the default values for
23309 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23310 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23311
23312 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23313 the files in the delivery directory by default. However, you can specify a
23314 different directory by setting &%quota_directory%&. Also, for maildir
23315 deliveries (see below) the &_maildirfolder_& convention is honoured.
23316
23317
23318 .cindex "maildir format"
23319 .cindex "mailstore format"
23320 There are three different ways in which delivery to individual files can be
23321 done, controlled by the settings of the &%maildir_format%& and
23322 &%mailstore_format%& options. Note that code to support maildir or mailstore
23323 formats is not included in the binary unless SUPPORT_MAILDIR or
23324 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23325
23326 .cindex "directory creation"
23327 In all three cases an attempt is made to create the directory and any necessary
23328 sub-directories if they do not exist, provided that the &%create_directory%&
23329 option is set (the default). The location of a created directory can be
23330 constrained by setting &%create_file%&. A created directory's mode is given by
23331 the &%directory_mode%& option. If creation fails, or if the
23332 &%create_directory%& option is not set when creation is required, delivery is
23333 deferred.
23334
23335
23336
23337 .section "Maildir delivery" "SECTmaildirdelivery"
23338 .cindex "maildir format" "description of"
23339 If the &%maildir_format%& option is true, Exim delivers each message by writing
23340 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23341 directory that is defined by the &%directory%& option (the &"delivery
23342 directory"&). If the delivery is successful, the file is renamed into the
23343 &_new_& subdirectory.
23344
23345 In the filename, <&'stime'&> is the current time of day in seconds, and
23346 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23347 Exim checks that the time-of-day clock has moved on by at least one microsecond
23348 before terminating the delivery process. This guarantees uniqueness for the
23349 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23350 opening it. If any response other than ENOENT (does not exist) is given,
23351 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23352
23353 Before Exim carries out a maildir delivery, it ensures that subdirectories
23354 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23355 do not exist, Exim tries to create them and any superior directories in their
23356 path, subject to the &%create_directory%& and &%create_file%& options. If the
23357 &%maildirfolder_create_regex%& option is set, and the regular expression it
23358 contains matches the delivery directory, Exim also ensures that a file called
23359 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23360 &_maildirfolder_& file cannot be created, delivery is deferred.
23361
23362 These features make it possible to use Exim to create all the necessary files
23363 and directories in a maildir mailbox, including subdirectories for maildir++
23364 folders. Consider this example:
23365 .code
23366 maildir_format = true
23367 directory = /var/mail/$local_part\
23368            ${if eq{$local_part_suffix}{}{}\
23369            {/.${substr_1:$local_part_suffix}}}
23370 maildirfolder_create_regex = /\.[^/]+$
23371 .endd
23372 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23373 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23374 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23375 not match this name, so Exim will not look for or create the file
23376 &_/var/mail/pimbo/maildirfolder_&, though it will create
23377 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23378
23379 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23380 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23381 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23382 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23383 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23384
23385 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23386 not inadvertently match the toplevel maildir directory, because a
23387 &_maildirfolder_& file at top level would completely break quota calculations.
23388
23389 .cindex "quota" "in maildir delivery"
23390 .cindex "maildir++"
23391 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23392 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23393 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23394 Exim assumes the directory is a maildir++ folder directory, which is one level
23395 down from the user's top level mailbox directory. This causes it to start at
23396 the parent directory instead of the current directory when calculating the
23397 amount of space used.
23398
23399 One problem with delivering into a multi-file mailbox is that it is
23400 computationally expensive to compute the size of the mailbox for quota
23401 checking. Various approaches have been taken to reduce the amount of work
23402 needed. The next two sections describe two of them. A third alternative is to
23403 use some external process for maintaining the size data, and use the expansion
23404 of the &%mailbox_size%& option as a way of importing it into Exim.
23405
23406
23407
23408
23409 .section "Using tags to record message sizes" "SECID135"
23410 If &%maildir_tag%& is set, the string is expanded for each delivery.
23411 When the maildir file is renamed into the &_new_& sub-directory, the
23412 tag is added to its name. However, if adding the tag takes the length of the
23413 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23414 the tag is dropped and the maildir file is created with no tag.
23415
23416
23417 .vindex "&$message_size$&"
23418 Tags can be used to encode the size of files in their names; see
23419 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23420 happens after the message has been written. The value of the &$message_size$&
23421 variable is set to the number of bytes actually written. If the expansion is
23422 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23423 be deferred. The expanded tag may contain any printing characters except &"/"&.
23424 Non-printing characters in the string are ignored; if the resulting string is
23425 empty, it is ignored. If it starts with an alphanumeric character, a leading
23426 colon is inserted; this default has not proven to be the path that popular
23427 maildir implementations have chosen (but changing it in Exim would break
23428 backwards compatibility).
23429
23430 For one common implementation, you might set:
23431 .code
23432 maildir_tag = ,S=${message_size}
23433 .endd
23434 but you should check the documentation of the other software to be sure.
23435
23436 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23437 as this allows Exim to extract the size from your tag, instead of having to
23438 &[stat()]& each message file.
23439
23440
23441 .section "Using a maildirsize file" "SECID136"
23442 .cindex "quota" "in maildir delivery"
23443 .cindex "maildir format" "&_maildirsize_& file"
23444 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23445 storing quota and message size information in a file called &_maildirsize_&
23446 within the toplevel maildir directory. If this file does not exist, Exim
23447 creates it, setting the quota from the &%quota%& option of the transport. If
23448 the maildir directory itself does not exist, it is created before any attempt
23449 to write a &_maildirsize_& file.
23450
23451 The &_maildirsize_& file is used to hold information about the sizes of
23452 messages in the maildir, thus speeding up quota calculations. The quota value
23453 in the file is just a cache; if the quota is changed in the transport, the new
23454 value overrides the cached value when the next message is delivered. The cache
23455 is maintained for the benefit of other programs that access the maildir and
23456 need to know the quota.
23457
23458 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23459 file is maintained (with a zero quota setting), but no quota is imposed.
23460
23461 A regular expression is available for controlling which directories in the
23462 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23463 See the description of the &%maildir_quota_directory_regex%& option above for
23464 details.
23465
23466
23467 .section "Mailstore delivery" "SECID137"
23468 .cindex "mailstore format" "description of"
23469 If the &%mailstore_format%& option is true, each message is written as two
23470 files in the given directory. A unique base name is constructed from the
23471 message id and the current delivery process, and the files that are written use
23472 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23473 contains the message's envelope, and the &_.msg_& file contains the message
23474 itself. The base name is placed in the variable &$mailstore_basename$&.
23475
23476 During delivery, the envelope is first written to a file with the suffix
23477 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23478 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23479 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23480 file before accessing either of them. An alternative approach is to wait for
23481 the absence of a &_.tmp_& file.
23482
23483 The envelope file starts with any text defined by the &%mailstore_prefix%&
23484 option, expanded and terminated by a newline if there isn't one. Then follows
23485 the sender address on one line, then all the recipient addresses, one per line.
23486 There can be more than one recipient only if the &%batch_max%& option is set
23487 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23488 appended to the file, followed by a newline if it does not end with one.
23489
23490 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23491 failure, it is ignored. Other expansion errors are treated as serious
23492 configuration errors, and delivery is deferred. The variable
23493 &$mailstore_basename$& is available for use during these expansions.
23494
23495
23496 .section "Non-special new file delivery" "SECID138"
23497 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23498 file is created directly in the named directory. For example, when delivering
23499 messages into files in batched SMTP format for later delivery to some host (see
23500 section &<<SECTbatchSMTP>>&), a setting such as
23501 .code
23502 directory = /var/bsmtp/$host
23503 .endd
23504 might be used. A message is written to a file with a temporary name, which is
23505 then renamed when the delivery is complete. The final name is obtained by
23506 expanding the contents of the &%directory_file%& option.
23507 .ecindex IIDapptra1
23508 .ecindex IIDapptra2
23509
23510
23511
23512
23513
23514
23515 . ////////////////////////////////////////////////////////////////////////////
23516 . ////////////////////////////////////////////////////////////////////////////
23517
23518 .chapter "The autoreply transport" "CHID8"
23519 .scindex IIDauttra1 "transports" "&(autoreply)&"
23520 .scindex IIDauttra2 "&(autoreply)& transport"
23521 The &(autoreply)& transport is not a true transport in that it does not cause
23522 the message to be transmitted. Instead, it generates a new mail message as an
23523 automatic reply to the incoming message. &'References:'& and
23524 &'Auto-Submitted:'& header lines are included. These are constructed according
23525 to the rules in RFCs 2822 and 3834, respectively.
23526
23527 If the router that passes the message to this transport does not have the
23528 &%unseen%& option set, the original message (for the current recipient) is not
23529 delivered anywhere. However, when the &%unseen%& option is set on the router
23530 that passes the message to this transport, routing of the address continues, so
23531 another router can set up a normal message delivery.
23532
23533
23534 The &(autoreply)& transport is usually run as the result of mail filtering, a
23535 &"vacation"& message being the standard example. However, it can also be run
23536 directly from a router like any other transport. To reduce the possibility of
23537 message cascades, messages created by the &(autoreply)& transport always have
23538 empty envelope sender addresses, like bounce messages.
23539
23540 The parameters of the message to be sent can be specified in the configuration
23541 by options described below. However, these are used only when the address
23542 passed to the transport does not contain its own reply information. When the
23543 transport is run as a consequence of a
23544 &%mail%&
23545 or &%vacation%& command in a filter file, the parameters of the message are
23546 supplied by the filter, and passed with the address. The transport's options
23547 that define the message are then ignored (so they are not usually set in this
23548 case). The message is specified entirely by the filter or by the transport; it
23549 is never built from a mixture of options. However, the &%file_optional%&,
23550 &%mode%&, and &%return_message%& options apply in all cases.
23551
23552 &(Autoreply)& is implemented as a local transport. When used as a result of a
23553 command in a user's filter file, &(autoreply)& normally runs under the uid and
23554 gid of the user, and with appropriate current and home directories (see chapter
23555 &<<CHAPenvironment>>&).
23556
23557 There is a subtle difference between routing a message to a &(pipe)& transport
23558 that generates some text to be returned to the sender, and routing it to an
23559 &(autoreply)& transport. This difference is noticeable only if more than one
23560 address from the same message is so handled. In the case of a pipe, the
23561 separate outputs from the different addresses are gathered up and returned to
23562 the sender in a single message, whereas if &(autoreply)& is used, a separate
23563 message is generated for each address that is passed to it.
23564
23565 Non-printing characters are not permitted in the header lines generated for the
23566 message that &(autoreply)& creates, with the exception of newlines that are
23567 immediately followed by white space. If any non-printing characters are found,
23568 the transport defers.
23569 Whether characters with the top bit set count as printing characters or not is
23570 controlled by the &%print_topbitchars%& global option.
23571
23572 If any of the generic options for manipulating headers (for example,
23573 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23574 of the original message that is included in the generated message when
23575 &%return_message%& is set. They do not apply to the generated message itself.
23576
23577 .vindex "&$sender_address$&"
23578 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23579 the message, indicating that there were no recipients, it does not treat this
23580 as an error. This means that autoreplies sent to &$sender_address$& when this
23581 is empty (because the incoming message is a bounce message) do not cause
23582 problems. They are just discarded.
23583
23584
23585
23586 .section "Private options for autoreply" "SECID139"
23587 .cindex "options" "&(autoreply)& transport"
23588
23589 .option bcc autoreply string&!! unset
23590 This specifies the addresses that are to receive &"blind carbon copies"& of the
23591 message when the message is specified by the transport.
23592
23593
23594 .option cc autoreply string&!! unset
23595 This specifies recipients of the message and the contents of the &'Cc:'& header
23596 when the message is specified by the transport.
23597
23598
23599 .option file autoreply string&!! unset
23600 The contents of the file are sent as the body of the message when the message
23601 is specified by the transport. If both &%file%& and &%text%& are set, the text
23602 string comes first.
23603
23604
23605 .option file_expand autoreply boolean false
23606 If this is set, the contents of the file named by the &%file%& option are
23607 subjected to string expansion as they are added to the message.
23608
23609
23610 .option file_optional autoreply boolean false
23611 If this option is true, no error is generated if the file named by the &%file%&
23612 option or passed with the address does not exist or cannot be read.
23613
23614
23615 .option from autoreply string&!! unset
23616 This specifies the contents of the &'From:'& header when the message is
23617 specified by the transport.
23618
23619
23620 .option headers autoreply string&!! unset
23621 This specifies additional RFC 2822 headers that are to be added to the message
23622 when the message is specified by the transport. Several can be given by using
23623 &"\n"& to separate them. There is no check on the format.
23624
23625
23626 .option log autoreply string&!! unset
23627 This option names a file in which a record of every message sent is logged when
23628 the message is specified by the transport.
23629
23630
23631 .option mode autoreply "octal integer" 0600
23632 If either the log file or the &"once"& file has to be created, this mode is
23633 used.
23634
23635
23636 .option never_mail autoreply "address list&!!" unset
23637 If any run of the transport creates a message with a recipient that matches any
23638 item in the list, that recipient is quietly discarded. If all recipients are
23639 discarded, no message is created. This applies both when the recipients are
23640 generated by a filter and when they are specified in the transport.
23641
23642
23643
23644 .option once autoreply string&!! unset
23645 This option names a file or DBM database in which a record of each &'To:'&
23646 recipient is kept when the message is specified by the transport. &*Note*&:
23647 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23648
23649 If &%once%& is unset, or is set to an empty string, the message is always sent.
23650 By default, if &%once%& is set to a non-empty filename, the message
23651 is not sent if a potential recipient is already listed in the database.
23652 However, if the &%once_repeat%& option specifies a time greater than zero, the
23653 message is sent if that much time has elapsed since a message was last sent to
23654 this recipient. A setting of zero time for &%once_repeat%& (the default)
23655 prevents a message from being sent a second time &-- in this case, zero means
23656 infinity.
23657
23658 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23659 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23660 greater than zero, it changes the way Exim implements the &%once%& option.
23661 Instead of using a DBM file to record every recipient it sends to, it uses a
23662 regular file, whose size will never get larger than the given value.
23663
23664 In the file, Exim keeps a linear list of recipient addresses and the times at
23665 which they were sent messages. If the file is full when a new address needs to
23666 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23667 means that a given recipient may receive multiple messages, but at
23668 unpredictable intervals that depend on the rate of turnover of addresses in the
23669 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23670
23671
23672 .option once_file_size autoreply integer 0
23673 See &%once%& above.
23674
23675
23676 .option once_repeat autoreply time&!! 0s
23677 See &%once%& above.
23678 After expansion, the value of this option must be a valid time value.
23679
23680
23681 .option reply_to autoreply string&!! unset
23682 This specifies the contents of the &'Reply-To:'& header when the message is
23683 specified by the transport.
23684
23685
23686 .option return_message autoreply boolean false
23687 If this is set, a copy of the original message is returned with the new
23688 message, subject to the maximum size set in the &%return_size_limit%& global
23689 configuration option.
23690
23691
23692 .option subject autoreply string&!! unset
23693 This specifies the contents of the &'Subject:'& header when the message is
23694 specified by the transport. It is tempting to quote the original subject in
23695 automatic responses. For example:
23696 .code
23697 subject = Re: $h_subject:
23698 .endd
23699 There is a danger in doing this, however. It may allow a third party to
23700 subscribe your users to an opt-in mailing list, provided that the list accepts
23701 bounce messages as subscription confirmations. Well-managed lists require a
23702 non-bounce message to confirm a subscription, so the danger is relatively
23703 small.
23704
23705
23706
23707 .option text autoreply string&!! unset
23708 This specifies a single string to be used as the body of the message when the
23709 message is specified by the transport. If both &%text%& and &%file%& are set,
23710 the text comes first.
23711
23712
23713 .option to autoreply string&!! unset
23714 This specifies recipients of the message and the contents of the &'To:'& header
23715 when the message is specified by the transport.
23716 .ecindex IIDauttra1
23717 .ecindex IIDauttra2
23718
23719
23720
23721
23722 . ////////////////////////////////////////////////////////////////////////////
23723 . ////////////////////////////////////////////////////////////////////////////
23724
23725 .chapter "The lmtp transport" "CHAPLMTP"
23726 .cindex "transports" "&(lmtp)&"
23727 .cindex "&(lmtp)& transport"
23728 .cindex "LMTP" "over a pipe"
23729 .cindex "LMTP" "over a socket"
23730 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23731 specified command
23732 or by interacting with a Unix domain socket.
23733 This transport is something of a cross between the &(pipe)& and &(smtp)&
23734 transports. Exim also has support for using LMTP over TCP/IP; this is
23735 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23736 to be of minority interest, the default build-time configure in &_src/EDITME_&
23737 has it commented out. You need to ensure that
23738 .code
23739 TRANSPORT_LMTP=yes
23740 .endd
23741 .cindex "options" "&(lmtp)& transport"
23742 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23743 included in the Exim binary. The private options of the &(lmtp)& transport are
23744 as follows:
23745
23746 .option batch_id lmtp string&!! unset
23747 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23748
23749
23750 .option batch_max lmtp integer 1
23751 This limits the number of addresses that can be handled in a single delivery.
23752 Most LMTP servers can handle several addresses at once, so it is normally a
23753 good idea to increase this value. See the description of local delivery
23754 batching in chapter &<<CHAPbatching>>&.
23755
23756
23757 .option command lmtp string&!! unset
23758 This option must be set if &%socket%& is not set. The string is a command which
23759 is run in a separate process. It is split up into a command name and list of
23760 arguments, each of which is separately expanded (so expansion cannot change the
23761 number of arguments). The command is run directly, not via a shell. The message
23762 is passed to the new process using the standard input and output to operate the
23763 LMTP protocol.
23764
23765 .option ignore_quota lmtp boolean false
23766 .cindex "LMTP" "ignoring quota errors"
23767 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23768 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23769 in its response to the LHLO command.
23770
23771 .option socket lmtp string&!! unset
23772 This option must be set if &%command%& is not set. The result of expansion must
23773 be the name of a Unix domain socket. The transport connects to the socket and
23774 delivers the message to it using the LMTP protocol.
23775
23776
23777 .option timeout lmtp time 5m
23778 The transport is aborted if the created process or Unix domain socket does not
23779 respond to LMTP commands or message input within this timeout. Delivery
23780 is deferred, and will be tried again later. Here is an example of a typical
23781 LMTP transport:
23782 .code
23783 lmtp:
23784   driver = lmtp
23785   command = /some/local/lmtp/delivery/program
23786   batch_max = 20
23787   user = exim
23788 .endd
23789 This delivers up to 20 addresses at a time, in a mixture of domains if
23790 necessary, running as the user &'exim'&.
23791
23792
23793
23794 . ////////////////////////////////////////////////////////////////////////////
23795 . ////////////////////////////////////////////////////////////////////////////
23796
23797 .chapter "The pipe transport" "CHAPpipetransport"
23798 .scindex IIDpiptra1 "transports" "&(pipe)&"
23799 .scindex IIDpiptra2 "&(pipe)& transport"
23800 The &(pipe)& transport is used to deliver messages via a pipe to a command
23801 running in another process. One example is the use of &(pipe)& as a
23802 pseudo-remote transport for passing messages to some other delivery mechanism
23803 (such as UUCP). Another is the use by individual users to automatically process
23804 their incoming messages. The &(pipe)& transport can be used in one of the
23805 following ways:
23806
23807 .ilist
23808 .vindex "&$local_part$&"
23809 A router routes one address to a transport in the normal way, and the
23810 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23811 contains the local part of the address (as usual), and the command that is run
23812 is specified by the &%command%& option on the transport.
23813 .next
23814 .vindex "&$pipe_addresses$&"
23815 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23816 transport can handle more than one address in a single run. In this case, when
23817 more than one address is routed to the transport, &$local_part$& is not set
23818 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23819 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23820 that are routed to the transport.
23821 .next
23822 .vindex "&$address_pipe$&"
23823 A router redirects an address directly to a pipe command (for example, from an
23824 alias or forward file). In this case, &$address_pipe$& contains the text of the
23825 pipe command, and the &%command%& option on the transport is ignored unless
23826 &%force_command%& is set. If only one address is being transported
23827 (&%batch_max%& is not greater than one, or only one address was redirected to
23828 this pipe command), &$local_part$& contains the local part that was redirected.
23829 .endlist
23830
23831
23832 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23833 deliver messages over pipes using the LMTP interactive protocol. This is
23834 implemented by the &(lmtp)& transport.
23835
23836 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23837 &_.forward_& file, the command runs under the uid and gid of that user. In
23838 other cases, the uid and gid have to be specified explicitly, either on the
23839 transport or on the router that handles the address. Current and &"home"&
23840 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23841 details of the local delivery environment and chapter &<<CHAPbatching>>&
23842 for a discussion of local delivery batching.
23843
23844 .new
23845 .cindex "tainted data" "in pipe command"
23846 .cindex pipe "tainted data"
23847 Tainted data may not be used for the command name.
23848 .wen
23849
23850
23851 .section "Concurrent delivery" "SECID140"
23852 If two messages arrive at almost the same time, and both are routed to a pipe
23853 delivery, the two pipe transports may be run concurrently. You must ensure that
23854 any pipe commands you set up are robust against this happening. If the commands
23855 write to a file, the &%exim_lock%& utility might be of use.
23856 Alternatively the &%max_parallel%& option could be used with a value
23857 of "1" to enforce serialization.
23858
23859
23860
23861
23862 .section "Returned status and data" "SECID141"
23863 .cindex "&(pipe)& transport" "returned data"
23864 If the command exits with a non-zero return code, the delivery is deemed to
23865 have failed, unless either the &%ignore_status%& option is set (in which case
23866 the return code is treated as zero), or the return code is one of those listed
23867 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23868 later"&. In this case, delivery is deferred. Details of a permanent failure are
23869 logged, but are not included in the bounce message, which merely contains
23870 &"local delivery failed"&.
23871
23872 If the command exits on a signal and the &%freeze_signal%& option is set then
23873 the message will be frozen in the queue. If that option is not set, a bounce
23874 will be sent as normal.
23875
23876 If the return code is greater than 128 and the command being run is a shell
23877 script, it normally means that the script was terminated by a signal whose
23878 value is the return code minus 128. The &%freeze_signal%& option does not
23879 apply in this case.
23880
23881 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23882 return code is set to 127. This is the value that a shell returns if it is
23883 asked to run a non-existent command. The wording for the log line suggests that
23884 a non-existent command may be the problem.
23885
23886 The &%return_output%& option can affect the result of a pipe delivery. If it is
23887 set and the command produces any output on its standard output or standard
23888 error streams, the command is considered to have failed, even if it gave a zero
23889 return code or if &%ignore_status%& is set. The output from the command is
23890 included as part of the bounce message. The &%return_fail_output%& option is
23891 similar, except that output is returned only when the command exits with a
23892 failure return code, that is, a value other than zero or a code that matches
23893 &%temp_errors%&.
23894
23895
23896
23897 .section "How the command is run" "SECThowcommandrun"
23898 .cindex "&(pipe)& transport" "path for command"
23899 The command line is (by default) broken down into a command name and arguments
23900 by the &(pipe)& transport itself. The &%allow_commands%& and
23901 &%restrict_to_path%& options can be used to restrict the commands that may be
23902 run.
23903
23904 .cindex "quoting" "in pipe command"
23905 Unquoted arguments are delimited by white space. If an argument appears in
23906 double quotes, backslash is interpreted as an escape character in the usual
23907 way. If an argument appears in single quotes, no escaping is done.
23908
23909 String expansion is applied to the command line except when it comes from a
23910 traditional &_.forward_& file (commands from a filter file are expanded). The
23911 expansion is applied to each argument in turn rather than to the whole line.
23912 For this reason, any string expansion item that contains white space must be
23913 quoted so as to be contained within a single argument. A setting such as
23914 .code
23915 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23916 .endd
23917 will not work, because the expansion item gets split between several
23918 arguments. You have to write
23919 .code
23920 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23921 .endd
23922 to ensure that it is all in one argument. The expansion is done in this way,
23923 argument by argument, so that the number of arguments cannot be changed as a
23924 result of expansion, and quotes or backslashes in inserted variables do not
23925 interact with external quoting. However, this leads to problems if you want to
23926 generate multiple arguments (or the command name plus arguments) from a single
23927 expansion. In this situation, the simplest solution is to use a shell. For
23928 example:
23929 .code
23930 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23931 .endd
23932
23933 .cindex "transport" "filter"
23934 .cindex "filter" "transport filter"
23935 .vindex "&$pipe_addresses$&"
23936 Special handling takes place when an argument consists of precisely the text
23937 &`$pipe_addresses`& (no quotes).
23938 This is not a general expansion variable; the only
23939 place this string is recognized is when it appears as an argument for a pipe or
23940 transport filter command. It causes each address that is being handled to be
23941 inserted in the argument list at that point &'as a separate argument'&. This
23942 avoids any problems with spaces or shell metacharacters, and is of use when a
23943 &(pipe)& transport is handling groups of addresses in a batch.
23944
23945 If &%force_command%& is enabled on the transport, special handling takes place
23946 for an argument that consists of precisely the text &`$address_pipe`&.  It
23947 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23948 argument is inserted in the argument list at that point
23949 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23950 the only item in the argument; in fact, if it were then &%force_command%&
23951 should behave as a no-op.  Rather, it should be used to adjust the command
23952 run while preserving the argument vector separation.
23953
23954 After splitting up into arguments and expansion, the resulting command is run
23955 in a subprocess directly from the transport, &'not'& under a shell. The
23956 message that is being delivered is supplied on the standard input, and the
23957 standard output and standard error are both connected to a single pipe that is
23958 read by Exim. The &%max_output%& option controls how much output the command
23959 may produce, and the &%return_output%& and &%return_fail_output%& options
23960 control what is done with it.
23961
23962 Not running the command under a shell (by default) lessens the security risks
23963 in cases when a command from a user's filter file is built out of data that was
23964 taken from an incoming message. If a shell is required, it can of course be
23965 explicitly specified as the command to be run. However, there are circumstances
23966 where existing commands (for example, in &_.forward_& files) expect to be run
23967 under a shell and cannot easily be modified. To allow for these cases, there is
23968 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23969 works. Instead of breaking up the command line as just described, it expands it
23970 as a single string and passes the result to &_/bin/sh_&. The
23971 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23972 with &%use_shell%&, and the whole mechanism is inherently less secure.
23973
23974
23975
23976 .section "Environment variables" "SECTpipeenv"
23977 .cindex "&(pipe)& transport" "environment for command"
23978 .cindex "environment" "&(pipe)& transport"
23979 The environment variables listed below are set up when the command is invoked.
23980 This list is a compromise for maximum compatibility with other MTAs. Note that
23981 the &%environment%& option can be used to add additional variables to this
23982 environment. The environment for the &(pipe)& transport is not subject
23983 to the &%add_environment%& and &%keep_environment%& main config options.
23984 .display
23985 &`DOMAIN            `&   the domain of the address
23986 &`HOME              `&   the home directory, if set
23987 &`HOST              `&   the host name when called from a router (see below)
23988 &`LOCAL_PART        `&   see below
23989 &`LOCAL_PART_PREFIX `&   see below
23990 &`LOCAL_PART_SUFFIX `&   see below
23991 &`LOGNAME           `&   see below
23992 &`MESSAGE_ID        `&   Exim's local ID for the message
23993 &`PATH              `&   as specified by the &%path%& option below
23994 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23995 &`RECIPIENT         `&   the complete recipient address
23996 &`SENDER            `&   the sender of the message (empty if a bounce)
23997 &`SHELL             `&   &`/bin/sh`&
23998 &`TZ                `&   the value of the &%timezone%& option, if set
23999 &`USER              `&   see below
24000 .endd
24001 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24002 router, LOCAL_PART is set to the local part of the address. When it is
24003 called as a result of a forward or alias expansion, LOCAL_PART is set to
24004 the local part of the address that was expanded. In both cases, any affixes are
24005 removed from the local part, and made available in LOCAL_PART_PREFIX and
24006 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24007 same value as LOCAL_PART for compatibility with other MTAs.
24008
24009 .cindex "HOST"
24010 HOST is set only when a &(pipe)& transport is called from a router that
24011 associates hosts with an address, typically when using &(pipe)& as a
24012 pseudo-remote transport. HOST is set to the first host name specified by
24013 the router.
24014
24015 .cindex "HOME"
24016 If the transport's generic &%home_directory%& option is set, its value is used
24017 for the HOME environment variable. Otherwise, a home directory may be set
24018 by the router's &%transport_home_directory%& option, which defaults to the
24019 user's home directory if &%check_local_user%& is set.
24020
24021
24022 .section "Private options for pipe" "SECID142"
24023 .cindex "options" "&(pipe)& transport"
24024
24025
24026
24027 .option allow_commands pipe "string list&!!" unset
24028 .cindex "&(pipe)& transport" "permitted commands"
24029 The string is expanded, and is then interpreted as a colon-separated list of
24030 permitted commands. If &%restrict_to_path%& is not set, the only commands
24031 permitted are those in the &%allow_commands%& list. They need not be absolute
24032 paths; the &%path%& option is still used for relative paths. If
24033 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24034 in the &%allow_commands%& list, or a name without any slashes that is found on
24035 the path. In other words, if neither &%allow_commands%& nor
24036 &%restrict_to_path%& is set, there is no restriction on the command, but
24037 otherwise only commands that are permitted by one or the other are allowed. For
24038 example, if
24039 .code
24040 allow_commands = /usr/bin/vacation
24041 .endd
24042 and &%restrict_to_path%& is not set, the only permitted command is
24043 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24044 &%use_shell%& is set.
24045
24046
24047 .option batch_id pipe string&!! unset
24048 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24049
24050
24051 .option batch_max pipe integer 1
24052 This limits the number of addresses that can be handled in a single delivery.
24053 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24054
24055
24056 .option check_string pipe string unset
24057 As &(pipe)& writes the message, the start of each line is tested for matching
24058 &%check_string%&, and if it does, the initial matching characters are replaced
24059 by the contents of &%escape_string%&, provided both are set. The value of
24060 &%check_string%& is a literal string, not a regular expression, and the case of
24061 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24062 of &%check_string%& and &%escape_string%& are forced to values that implement
24063 the SMTP escaping protocol. Any settings made in the configuration file are
24064 ignored.
24065
24066
24067 .option command pipe string&!! unset
24068 This option need not be set when &(pipe)& is being used to deliver to pipes
24069 obtained directly from address redirections. In other cases, the option must be
24070 set, to provide a command to be run. It need not yield an absolute path (see
24071 the &%path%& option below). The command is split up into separate arguments by
24072 Exim, and each argument is separately expanded, as described in section
24073 &<<SECThowcommandrun>>& above.
24074
24075
24076 .option environment pipe string&!! unset
24077 .cindex "&(pipe)& transport" "environment for command"
24078 .cindex "environment" "&(pipe)& transport"
24079 This option is used to add additional variables to the environment in which the
24080 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24081 a string which is expanded, and then interpreted as a colon-separated list of
24082 environment settings of the form <&'name'&>=<&'value'&>.
24083
24084
24085 .option escape_string pipe string unset
24086 See &%check_string%& above.
24087
24088
24089 .option freeze_exec_fail pipe boolean false
24090 .cindex "exec failure"
24091 .cindex "failure of exec"
24092 .cindex "&(pipe)& transport" "failure of exec"
24093 Failure to exec the command in a pipe transport is by default treated like
24094 any other failure while running the command. However, if &%freeze_exec_fail%&
24095 is set, failure to exec is treated specially, and causes the message to be
24096 frozen, whatever the setting of &%ignore_status%&.
24097
24098
24099 .option freeze_signal pipe boolean false
24100 .cindex "signal exit"
24101 .cindex "&(pipe)& transport", "signal exit"
24102 Normally if the process run by a command in a pipe transport exits on a signal,
24103 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24104 frozen in Exim's queue instead.
24105
24106
24107 .option force_command pipe boolean false
24108 .cindex "force command"
24109 .cindex "&(pipe)& transport", "force command"
24110 Normally when a router redirects an address directly to a pipe command
24111 the &%command%& option on the transport is ignored.  If &%force_command%&
24112 is set, the &%command%& option will used. This is especially
24113 useful for forcing a wrapper or additional argument to be added to the
24114 command. For example:
24115 .code
24116 command = /usr/bin/remote_exec myhost -- $address_pipe
24117 force_command
24118 .endd
24119
24120 Note that &$address_pipe$& is handled specially in &%command%& when
24121 &%force_command%& is set, expanding out to the original argument vector as
24122 separate items, similarly to a Unix shell &`"$@"`& construct.
24123
24124
24125 .option ignore_status pipe boolean false
24126 If this option is true, the status returned by the subprocess that is set up to
24127 run the command is ignored, and Exim behaves as if zero had been returned.
24128 Otherwise, a non-zero status or termination by signal causes an error return
24129 from the transport unless the status value is one of those listed in
24130 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24131
24132 &*Note*&: This option does not apply to timeouts, which do not return a status.
24133 See the &%timeout_defer%& option for how timeouts are handled.
24134
24135
24136 .option log_defer_output pipe boolean false
24137 .cindex "&(pipe)& transport" "logging output"
24138 If this option is set, and the status returned by the command is
24139 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24140 and any output was produced on stdout or stderr, the first line of it is
24141 written to the main log.
24142
24143
24144 .option log_fail_output pipe boolean false
24145 If this option is set, and the command returns any output on stdout or
24146 stderr, and also ends with a return code that is neither zero nor one of
24147 the return codes listed in &%temp_errors%& (that is, the delivery
24148 failed), the first line of output is written to the main log. This
24149 option and &%log_output%& are mutually exclusive.  Only one of them may
24150 be set.
24151
24152
24153 .option log_output pipe boolean false
24154 If this option is set and the command returns any output on stdout or
24155 stderr, the first line of output is written to the main log, whatever
24156 the return code. This option and &%log_fail_output%& are mutually
24157 exclusive. Only one of them may be set.
24158
24159
24160 .option max_output pipe integer 20K
24161 This specifies the maximum amount of output that the command may produce on its
24162 standard output and standard error file combined. If the limit is exceeded, the
24163 process running the command is killed. This is intended as a safety measure to
24164 catch runaway processes. The limit is applied independently of the settings of
24165 the options that control what is done with such output (for example,
24166 &%return_output%&). Because of buffering effects, the amount of output may
24167 exceed the limit by a small amount before Exim notices.
24168
24169
24170 .option message_prefix pipe string&!! "see below"
24171 The string specified here is expanded and output at the start of every message.
24172 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24173 .code
24174 message_prefix = \
24175   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24176   ${tod_bsdinbox}\n
24177 .endd
24178 .cindex "Cyrus"
24179 .cindex "&%tmail%&"
24180 .cindex "&""From""& line"
24181 This is required by the commonly used &_/usr/bin/vacation_& program.
24182 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24183 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24184 setting
24185 .code
24186 message_prefix =
24187 .endd
24188 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24189 &`\n`& to &`\r\n`& in &%message_prefix%&.
24190
24191
24192 .option message_suffix pipe string&!! "see below"
24193 The string specified here is expanded and output at the end of every message.
24194 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24195 The suffix can be suppressed by setting
24196 .code
24197 message_suffix =
24198 .endd
24199 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24200 &`\n`& to &`\r\n`& in &%message_suffix%&.
24201
24202
24203 .option path pipe string&!! "/bin:/usr/bin"
24204 This option is expanded and
24205 specifies the string that is set up in the PATH environment
24206 variable of the subprocess.
24207 If the &%command%& option does not yield an absolute path name, the command is
24208 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24209 apply to a command specified as a transport filter.
24210
24211
24212 .option permit_coredump pipe boolean false
24213 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24214 a core-dump of a pipe command, enable this command.  This enables core-dumps
24215 during delivery and affects both the Exim binary and the pipe command run.
24216 It is recommended that this option remain off unless and until you have a need
24217 for it and that this only be enabled when needed, as the risk of excessive
24218 resource consumption can be quite high.  Note also that Exim is typically
24219 installed as a setuid binary and most operating systems will inhibit coredumps
24220 of these by default, so further OS-specific action may be required.
24221
24222
24223 .option pipe_as_creator pipe boolean false
24224 .cindex "uid (user id)" "local delivery"
24225 If the generic &%user%& option is not set and this option is true, the delivery
24226 process is run under the uid that was in force when Exim was originally called
24227 to accept the message. If the group id is not otherwise set (via the generic
24228 &%group%& option), the gid that was in force when Exim was originally called to
24229 accept the message is used.
24230
24231
24232 .option restrict_to_path pipe boolean false
24233 When this option is set, any command name not listed in &%allow_commands%& must
24234 contain no slashes. The command is searched for only in the directories listed
24235 in the &%path%& option. This option is intended for use in the case when a pipe
24236 command has been generated from a user's &_.forward_& file. This is usually
24237 handled by a &(pipe)& transport called &%address_pipe%&.
24238
24239
24240 .option return_fail_output pipe boolean false
24241 If this option is true, and the command produced any output and ended with a
24242 return code other than zero or one of the codes listed in &%temp_errors%& (that
24243 is, the delivery failed), the output is returned in the bounce message.
24244 However, if the message has a null sender (that is, it is itself a bounce
24245 message), output from the command is discarded. This option and
24246 &%return_output%& are mutually exclusive. Only one of them may be set.
24247
24248
24249
24250 .option return_output pipe boolean false
24251 If this option is true, and the command produced any output, the delivery is
24252 deemed to have failed whatever the return code from the command, and the output
24253 is returned in the bounce message. Otherwise, the output is just discarded.
24254 However, if the message has a null sender (that is, it is a bounce message),
24255 output from the command is always discarded, whatever the setting of this
24256 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24257 of them may be set.
24258
24259
24260
24261 .option temp_errors pipe "string list" "see below"
24262 .cindex "&(pipe)& transport" "temporary failure"
24263 This option contains either a colon-separated list of numbers, or a single
24264 asterisk. If &%ignore_status%& is false
24265 and &%return_output%& is not set,
24266 and the command exits with a non-zero return code, the failure is treated as
24267 temporary and the delivery is deferred if the return code matches one of the
24268 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24269 codes are treated as permanent errors. The default setting contains the codes
24270 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24271 compiled on a system that does not define these macros, it assumes values of 75
24272 and 73, respectively.
24273
24274
24275 .option timeout pipe time 1h
24276 If the command fails to complete within this time, it is killed. This normally
24277 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24278 specifies no timeout. In order to ensure that any subprocesses created by the
24279 command are also killed, Exim makes the initial process a process group leader,
24280 and kills the whole process group on a timeout. However, this can be defeated
24281 if one of the processes starts a new process group.
24282
24283 .option timeout_defer pipe boolean false
24284 A timeout in a &(pipe)& transport, either in the command that the transport
24285 runs, or in a transport filter that is associated with it, is by default
24286 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24287 is set true, both kinds of timeout become temporary errors, causing the
24288 delivery to be deferred.
24289
24290 .option umask pipe "octal integer" 022
24291 This specifies the umask setting for the subprocess that runs the command.
24292
24293
24294 .option use_bsmtp pipe boolean false
24295 .cindex "envelope sender"
24296 If this option is set true, the &(pipe)& transport writes messages in &"batch
24297 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24298 commands. If you want to include a leading HELO command with such messages,
24299 you can do so by setting the &%message_prefix%& option. See section
24300 &<<SECTbatchSMTP>>& for details of batch SMTP.
24301
24302 .option use_classresources pipe boolean false
24303 .cindex "class resources (BSD)"
24304 This option is available only when Exim is running on FreeBSD, NetBSD, or
24305 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24306 resource limits when a &(pipe)& transport is run to perform a delivery. The
24307 limits for the uid under which the pipe is to run are obtained from the login
24308 class database.
24309
24310
24311 .option use_crlf pipe boolean false
24312 .cindex "carriage return"
24313 .cindex "linefeed"
24314 This option causes lines to be terminated with the two-character CRLF sequence
24315 (carriage return, linefeed) instead of just a linefeed character. In the case
24316 of batched SMTP, the byte sequence written to the pipe is then an exact image
24317 of what would be sent down a real SMTP connection.
24318
24319 The contents of the &%message_prefix%& and &%message_suffix%& options are
24320 written verbatim, so must contain their own carriage return characters if these
24321 are needed. When &%use_bsmtp%& is not set, the default values for both
24322 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24323 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24324
24325
24326 .option use_shell pipe boolean false
24327 .vindex "&$pipe_addresses$&"
24328 If this option is set, it causes the command to be passed to &_/bin/sh_&
24329 instead of being run directly from the transport, as described in section
24330 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24331 where the command is expected to be run under a shell and cannot easily be
24332 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24333 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24334 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24335 its &%-c%& option.
24336
24337
24338
24339 .section "Using an external local delivery agent" "SECID143"
24340 .cindex "local delivery" "using an external agent"
24341 .cindex "&'procmail'&"
24342 .cindex "external local delivery"
24343 .cindex "delivery" "&'procmail'&"
24344 .cindex "delivery" "by external agent"
24345 The &(pipe)& transport can be used to pass all messages that require local
24346 delivery to a separate local delivery agent such as &%procmail%&. When doing
24347 this, care must be taken to ensure that the pipe is run under an appropriate
24348 uid and gid. In some configurations one wants this to be a uid that is trusted
24349 by the delivery agent to supply the correct sender of the message. It may be
24350 necessary to recompile or reconfigure the delivery agent so that it trusts an
24351 appropriate user. The following is an example transport and router
24352 configuration for &%procmail%&:
24353 .code
24354 # transport
24355 procmail_pipe:
24356   driver = pipe
24357   command = /usr/local/bin/procmail -d $local_part
24358   return_path_add
24359   delivery_date_add
24360   envelope_to_add
24361   check_string = "From "
24362   escape_string = ">From "
24363   umask = 077
24364   user = $local_part
24365   group = mail
24366
24367 # router
24368 procmail:
24369   driver = accept
24370   check_local_user
24371   transport = procmail_pipe
24372 .endd
24373 In this example, the pipe is run as the local user, but with the group set to
24374 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24375 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24376 user to supply a correct sender address. If you do not specify either a
24377 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24378 home directory is the user's home directory by default.
24379
24380 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24381 .code
24382 IFS=" "
24383 .endd
24384 as shown in some &%procmail%& documentation, because Exim does not by default
24385 use a shell to run pipe commands.
24386
24387 .cindex "Cyrus"
24388 The next example shows a transport and a router for a system where local
24389 deliveries are handled by the Cyrus IMAP server.
24390 .code
24391 # transport
24392 local_delivery_cyrus:
24393   driver = pipe
24394   command = /usr/cyrus/bin/deliver \
24395             -m ${substr_1:$local_part_suffix} -- $local_part
24396   user = cyrus
24397   group = mail
24398   return_output
24399   log_output
24400   message_prefix =
24401   message_suffix =
24402
24403 # router
24404 local_user_cyrus:
24405   driver = accept
24406   check_local_user
24407   local_part_suffix = .*
24408   transport = local_delivery_cyrus
24409 .endd
24410 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24411 &%return_output%& to cause any text written by Cyrus to be returned to the
24412 sender.
24413 .ecindex IIDpiptra1
24414 .ecindex IIDpiptra2
24415
24416
24417 . ////////////////////////////////////////////////////////////////////////////
24418 . ////////////////////////////////////////////////////////////////////////////
24419
24420 .chapter "The smtp transport" "CHAPsmtptrans"
24421 .scindex IIDsmttra1 "transports" "&(smtp)&"
24422 .scindex IIDsmttra2 "&(smtp)& transport"
24423 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24424 or LMTP protocol. The list of hosts to try can either be taken from the address
24425 that is being processed (having been set up by the router), or specified
24426 explicitly for the transport. Timeout and retry processing (see chapter
24427 &<<CHAPretry>>&) is applied to each IP address independently.
24428
24429
24430 .section "Multiple messages on a single connection" "SECID144"
24431 The sending of multiple messages over a single TCP/IP connection can arise in
24432 two ways:
24433
24434 .ilist
24435 If a message contains more than &%max_rcpt%& (see below) addresses that are
24436 routed to the same host, more than one copy of the message has to be sent to
24437 that host. In this situation, multiple copies may be sent in a single run of
24438 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24439 does when it has too many addresses to send in one message also depends on the
24440 value of the global &%remote_max_parallel%& option. Details are given in
24441 section &<<SECToutSMTPTCP>>&.)
24442 .next
24443 .cindex "hints database" "remembering routing"
24444 When a message has been successfully delivered over a TCP/IP connection, Exim
24445 looks in its hints database to see if there are any other messages awaiting a
24446 connection to the same host. If there are, a new delivery process is started
24447 for one of them, and the current TCP/IP connection is passed on to it. The new
24448 process may in turn send multiple copies and possibly create yet another
24449 process.
24450 .endlist
24451
24452
24453 For each copy sent over the same TCP/IP connection, a sequence counter is
24454 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24455 no further messages are sent over that connection.
24456
24457
24458
24459 .section "Use of the $host and $host_address variables" "SECID145"
24460 .vindex "&$host$&"
24461 .vindex "&$host_address$&"
24462 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24463 &$host_address$& are the name and IP address of the first host on the host list
24464 passed by the router. However, when the transport is about to connect to a
24465 specific host, and while it is connected to that host, &$host$& and
24466 &$host_address$& are set to the values for that host. These are the values
24467 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24468 &%serialize_hosts%&, and the various TLS options are expanded.
24469
24470
24471 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24472 .vindex &$tls_bits$&
24473 .vindex &$tls_cipher$&
24474 .vindex &$tls_peerdn$&
24475 .vindex &$tls_sni$&
24476 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24477 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24478 are the values that were set when the message was received.
24479 These are the values that are used for options that are expanded before any
24480 SMTP connections are made. Just before each connection is made, these four
24481 variables are emptied. If TLS is subsequently started, they are set to the
24482 appropriate values for the outgoing connection, and these are the values that
24483 are in force when any authenticators are run and when the
24484 &%authenticated_sender%& option is expanded.
24485
24486 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24487 and will be removed in a future release.
24488
24489
24490 .section "Private options for smtp" "SECID146"
24491 .cindex "options" "&(smtp)& transport"
24492 The private options of the &(smtp)& transport are as follows:
24493
24494
24495 .option address_retry_include_sender smtp boolean true
24496 .cindex "4&'xx'& responses" "retrying after"
24497 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24498 is the combination of sender and recipient that is delayed in subsequent queue
24499 runs until the retry time is reached. You can delay the recipient without
24500 reference to the sender (which is what earlier versions of Exim did), by
24501 setting &%address_retry_include_sender%& false. However, this can lead to
24502 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24503
24504 .option allow_localhost smtp boolean false
24505 .cindex "local host" "sending to"
24506 .cindex "fallback" "hosts specified on transport"
24507 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24508 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24509 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24510 the delivery anyway. This should be used only in special cases when the
24511 configuration ensures that no looping will result (for example, a differently
24512 configured Exim is listening on the port to which the message is sent).
24513
24514
24515 .option authenticated_sender smtp string&!! unset
24516 .cindex "Cyrus"
24517 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24518 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24519 overriding any existing authenticated sender value. If the string expansion is
24520 forced to fail, the option is ignored. Other expansion failures cause delivery
24521 to be deferred. If the result of expansion is an empty string, that is also
24522 ignored.
24523
24524 The expansion happens after the outgoing connection has been made and TLS
24525 started, if required. This means that the &$host$&, &$host_address$&,
24526 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24527 particular connection.
24528
24529 If the SMTP session is not authenticated, the expansion of
24530 &%authenticated_sender%& still happens (and can cause the delivery to be
24531 deferred if it fails), but no AUTH= item is added to MAIL commands
24532 unless &%authenticated_sender_force%& is true.
24533
24534 This option allows you to use the &(smtp)& transport in LMTP mode to
24535 deliver mail to Cyrus IMAP and provide the proper local part as the
24536 &"authenticated sender"&, via a setting such as:
24537 .code
24538 authenticated_sender = $local_part
24539 .endd
24540 This removes the need for IMAP subfolders to be assigned special ACLs to
24541 allow direct delivery to those subfolders.
24542
24543 Because of expected uses such as that just described for Cyrus (when no
24544 domain is involved), there is no checking on the syntax of the provided
24545 value.
24546
24547
24548 .option authenticated_sender_force smtp boolean false
24549 If this option is set true, the &%authenticated_sender%& option's value
24550 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24551 authenticated as a client.
24552
24553
24554 .option command_timeout smtp time 5m
24555 This sets a timeout for receiving a response to an SMTP command that has been
24556 sent out. It is also used when waiting for the initial banner line from the
24557 remote host. Its value must not be zero.
24558
24559
24560 .option connect_timeout smtp time 5m
24561 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24562 to a remote host. A setting of zero allows the system timeout (typically
24563 several minutes) to act. To have any effect, the value of this option must be
24564 less than the system timeout. However, it has been observed that on some
24565 systems there is no system timeout, which is why the default value for this
24566 option is 5 minutes, a value recommended by RFC 1123.
24567
24568
24569 .option connection_max_messages smtp integer 500
24570 .cindex "SMTP" "passed connection"
24571 .cindex "SMTP" "multiple deliveries"
24572 .cindex "multiple SMTP deliveries"
24573 This controls the maximum number of separate message deliveries that are sent
24574 over a single TCP/IP connection. If the value is zero, there is no limit.
24575 For testing purposes, this value can be overridden by the &%-oB%& command line
24576 option.
24577
24578
24579 .option dane_require_tls_ciphers smtp string&!! unset
24580 .cindex "TLS" "requiring specific ciphers for DANE"
24581 .cindex "cipher" "requiring specific"
24582 .cindex DANE "TLS ciphers"
24583 This option may be used to override &%tls_require_ciphers%& for connections
24584 where DANE has been determined to be in effect.
24585 If not set, then &%tls_require_ciphers%& will be used.
24586 Normal SMTP delivery is not able to make strong demands of TLS cipher
24587 configuration, because delivery will fall back to plaintext.  Once DANE has
24588 been determined to be in effect, there is no plaintext fallback and making the
24589 TLS cipherlist configuration stronger will increase security, rather than
24590 counter-intuitively decreasing it.
24591 If the option expands to be empty or is forced to fail, then it will
24592 be treated as unset and &%tls_require_ciphers%& will be used instead.
24593
24594
24595 .option data_timeout smtp time 5m
24596 This sets a timeout for the transmission of each block in the data portion of
24597 the message. As a result, the overall timeout for a message depends on the size
24598 of the message. Its value must not be zero. See also &%final_timeout%&.
24599
24600
24601 .option dkim_canon smtp string&!! unset
24602 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24603 .option dkim_domain smtp string list&!! unset
24604 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24605 .option dkim_hash smtp string&!! sha256
24606 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24607 .option dkim_identity smtp string&!! unset
24608 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24609 .option dkim_private_key smtp string&!! unset
24610 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24611 .option dkim_selector smtp string&!! unset
24612 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24613 .option dkim_strict smtp string&!! unset
24614 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24615 .option dkim_sign_headers smtp string&!! "per RFC"
24616 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24617 .option dkim_timestamps smtp string&!! unset
24618 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24619
24620
24621 .option delay_after_cutoff smtp boolean true
24622 .cindex "final cutoff" "retries, controlling"
24623 .cindex retry "final cutoff"
24624 This option controls what happens when all remote IP addresses for a given
24625 domain have been inaccessible for so long that they have passed their retry
24626 cutoff times.
24627
24628 In the default state, if the next retry time has not been reached for any of
24629 them, the address is bounced without trying any deliveries. In other words,
24630 Exim delays retrying an IP address after the final cutoff time until a new
24631 retry time is reached, and can therefore bounce an address without ever trying
24632 a delivery, when machines have been down for a long time. Some people are
24633 unhappy at this prospect, so...
24634
24635 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24636 addresses are past their final cutoff time, Exim tries to deliver to those
24637 IP addresses that have not been tried since the message arrived. If there are
24638 none, of if they all fail, the address is bounced. In other words, it does not
24639 delay when a new message arrives, but immediately tries those expired IP
24640 addresses that haven't been tried since the message arrived. If there is a
24641 continuous stream of messages for the dead hosts, unsetting
24642 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24643 to them.
24644
24645
24646 .option dns_qualify_single smtp boolean true
24647 If the &%hosts%& or &%fallback_hosts%& option is being used,
24648 and the &%gethostbyname%& option is false,
24649 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24650 in chapter &<<CHAPdnslookup>>& for more details.
24651
24652
24653 .option dns_search_parents smtp boolean false
24654 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24655 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24656 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24657 details.
24658
24659
24660 .option dnssec_request_domains smtp "domain list&!!" *
24661 .cindex "MX record" "security"
24662 .cindex "DNSSEC" "MX lookup"
24663 .cindex "security" "MX lookup"
24664 .cindex "DNS" "DNSSEC"
24665 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24666 the dnssec request bit set. Setting this transport option is only useful if the
24667 transport overrides or sets the host names. See the &%dnssec_request_domains%&
24668 router option.
24669
24670
24671
24672 .option dnssec_require_domains smtp "domain list&!!" unset
24673 .cindex "MX record" "security"
24674 .cindex "DNSSEC" "MX lookup"
24675 .cindex "security" "MX lookup"
24676 .cindex "DNS" "DNSSEC"
24677 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24678 the dnssec request bit set.  Setting this transport option is only
24679 useful if the transport overrides or sets the host names. See the
24680 &%dnssec_require_domains%& router option.
24681
24682
24683
24684 .option dscp smtp string&!! unset
24685 .cindex "DCSP" "outbound"
24686 This option causes the DSCP value associated with a socket to be set to one
24687 of a number of fixed strings or to numeric value.
24688 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24689 Common values include &`throughput`&, &`mincost`&, and on newer systems
24690 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24691
24692 The outbound packets from Exim will be marked with this value in the header
24693 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24694 that these values will have any effect, not be stripped by networking
24695 equipment, or do much of anything without cooperation with your Network
24696 Engineer and those of all network operators between the source and destination.
24697
24698
24699 .option fallback_hosts smtp "string list" unset
24700 .cindex "fallback" "hosts specified on transport"
24701 String expansion is not applied to this option. The argument must be a
24702 colon-separated list of host names or IP addresses, optionally also including
24703 port numbers, though the separator can be changed, as described in section
24704 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24705 item in a &%route_list%& setting for the &(manualroute)& router, as described
24706 in section &<<SECTformatonehostitem>>&.
24707
24708 Fallback hosts can also be specified on routers, which associate them with the
24709 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24710 &%fallback_hosts%& specified on the transport is used only if the address does
24711 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24712 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24713 However, &%hosts_randomize%& does apply to fallback host lists.
24714
24715 If Exim is unable to deliver to any of the hosts for a particular address, and
24716 the errors are not permanent rejections, the address is put on a separate
24717 transport queue with its host list replaced by the fallback hosts, unless the
24718 address was routed via MX records and the current host was in the original MX
24719 list. In that situation, the fallback host list is not used.
24720
24721 Once normal deliveries are complete, the fallback queue is delivered by
24722 re-running the same transports with the new host lists. If several failing
24723 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24724 copy of the message is sent.
24725
24726 The resolution of the host names on the fallback list is controlled by the
24727 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24728 both to cases when the host list comes with the address and when it is taken
24729 from &%hosts%&. This option provides a &"use a smart host only if delivery
24730 fails"& facility.
24731
24732
24733 .option final_timeout smtp time 10m
24734 This is the timeout that applies while waiting for the response to the final
24735 line containing just &"."& that terminates a message. Its value must not be
24736 zero.
24737
24738 .option gethostbyname smtp boolean false
24739 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24740 being used, names are looked up using &[gethostbyname()]&
24741 (or &[getipnodebyname()]& when available)
24742 instead of using the DNS. Of course, that function may in fact use the DNS, but
24743 it may also consult other sources of information such as &_/etc/hosts_&.
24744
24745 .option gnutls_compat_mode smtp boolean unset
24746 This option controls whether GnuTLS is used in compatibility mode in an Exim
24747 server. This reduces security slightly, but improves interworking with older
24748 implementations of TLS.
24749
24750 .option helo_data smtp string&!! "see below"
24751 .cindex "HELO" "argument, setting"
24752 .cindex "EHLO" "argument, setting"
24753 .cindex "LHLO argument setting"
24754 The value of this option is expanded after a connection to a another host has
24755 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24756 command that starts the outgoing SMTP or LMTP session. The default value of the
24757 option is:
24758 .code
24759 $primary_hostname
24760 .endd
24761 During the expansion, the variables &$host$& and &$host_address$& are set to
24762 the identity of the remote host, and the variables &$sending_ip_address$& and
24763 &$sending_port$& are set to the local IP address and port number that are being
24764 used. These variables can be used to generate different values for different
24765 servers or different local IP addresses. For example, if you want the string
24766 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24767 interface address, you could use this:
24768 .code
24769 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24770   {$primary_hostname}}
24771 .endd
24772 The use of &%helo_data%& applies both to sending messages and when doing
24773 callouts.
24774
24775 .option hosts smtp "string list&!!" unset
24776 Hosts are associated with an address by a router such as &(dnslookup)&, which
24777 finds the hosts by looking up the address domain in the DNS, or by
24778 &(manualroute)&, which has lists of hosts in its configuration. However,
24779 email addresses can be passed to the &(smtp)& transport by any router, and not
24780 all of them can provide an associated list of hosts.
24781
24782 The &%hosts%& option specifies a list of hosts to be used if the address being
24783 processed does not have any hosts associated with it. The hosts specified by
24784 &%hosts%& are also used, whether or not the address has its own hosts, if
24785 &%hosts_override%& is set.
24786
24787 The string is first expanded, before being interpreted as a colon-separated
24788 list of host names or IP addresses, possibly including port numbers. The
24789 separator may be changed to something other than colon, as described in section
24790 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24791 item in a &%route_list%& setting for the &(manualroute)& router, as described
24792 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24793 of the &(manualroute)& router is not available here.
24794
24795 If the expansion fails, delivery is deferred. Unless the failure was caused by
24796 the inability to complete a lookup, the error is logged to the panic log as
24797 well as the main log. Host names are looked up either by searching directly for
24798 address records in the DNS or by calling &[gethostbyname()]& (or
24799 &[getipnodebyname()]& when available), depending on the setting of the
24800 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24801 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24802 address are used.
24803
24804 During delivery, the hosts are tried in order, subject to their retry status,
24805 unless &%hosts_randomize%& is set.
24806
24807
24808 .option hosts_avoid_esmtp smtp "host list&!!" unset
24809 .cindex "ESMTP, avoiding use of"
24810 .cindex "HELO" "forcing use of"
24811 .cindex "EHLO" "avoiding use of"
24812 .cindex "PIPELINING" "avoiding the use of"
24813 This option is for use with broken hosts that announce ESMTP facilities (for
24814 example, PIPELINING) and then fail to implement them properly. When a host
24815 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24816 start of the SMTP session. This means that it cannot use any of the ESMTP
24817 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24818
24819
24820 .option hosts_avoid_pipelining smtp "host list&!!" unset
24821 .cindex "PIPELINING" "avoiding the use of"
24822 Exim will not use the SMTP PIPELINING extension when delivering to any host
24823 that matches this list, even if the server host advertises PIPELINING support.
24824
24825 .option hosts_pipe_connect smtp "host list&!!" unset
24826 .cindex "pipelining" "early connection"
24827 .cindex "pipelining" PIPE_CONNECT
24828 If Exim is built with the SUPPORT_PIPE_CONNECT build option
24829 this option controls which to hosts the facility watched for
24830 and recorded, and used for subsequent connections.
24831
24832 The retry hints database is used for the record,
24833 and records are subject to the &%retry_data_expire%& option.
24834 When used, the pipelining saves on roundtrip times.
24835 It also turns SMTP into a client-first protocol
24836 so combines well with TCP Fast Open.
24837
24838 See also the &%pipelining_connect_advertise_hosts%& main option.
24839
24840 Note:
24841 When the facility is used, the transport &%helo_data%& option
24842 will be expanded before the &$sending_ip_address$& variable
24843 is filled in.
24844 A check is made for the use of that variable, without the
24845 presence of a &"def:"& test on it, but suitably complex coding
24846 can avoid the check and produce unexpected results.
24847 You have been warned.
24848
24849
24850 .option hosts_avoid_tls smtp "host list&!!" unset
24851 .cindex "TLS" "avoiding for certain hosts"
24852 Exim will not try to start a TLS session when delivering to any host that
24853 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24854
24855 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24856 .cindex "TLS" "avoiding for certain hosts"
24857 Exim will not try to start a TLS session for a verify callout,
24858 or when delivering in cutthrough mode,
24859 to any host that matches this list.
24860
24861
24862 .option hosts_max_try smtp integer 5
24863 .cindex "host" "maximum number to try"
24864 .cindex "limit" "number of hosts tried"
24865 .cindex "limit" "number of MX tried"
24866 .cindex "MX record" "maximum tried"
24867 This option limits the number of IP addresses that are tried for any one
24868 delivery in cases where there are temporary delivery errors. Section
24869 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24870
24871
24872 .option hosts_max_try_hardlimit smtp integer 50
24873 This is an additional check on the maximum number of IP addresses that Exim
24874 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24875 why it exists.
24876
24877
24878
24879 .option hosts_nopass_tls smtp "host list&!!" unset
24880 .cindex "TLS" "passing connection"
24881 .cindex "multiple SMTP deliveries"
24882 .cindex "TLS" "multiple message deliveries"
24883 For any host that matches this list, a connection on which a TLS session has
24884 been started will not be passed to a new delivery process for sending another
24885 message on the same connection. See section &<<SECTmulmessam>>& for an
24886 explanation of when this might be needed.
24887
24888 .option hosts_noproxy_tls smtp "host list&!!" unset
24889 .cindex "TLS" "passing connection"
24890 .cindex "multiple SMTP deliveries"
24891 .cindex "TLS" "multiple message deliveries"
24892 For any host that matches this list, a TLS session which has
24893 been started will not be passed to a new delivery process for sending another
24894 message on the same session.
24895
24896 The traditional implementation closes down TLS and re-starts it in the new
24897 process, on the same open TCP connection, for each successive message
24898 sent.  If permitted by this option a pipe to to the new process is set up
24899 instead, and the original process maintains the TLS connection and proxies
24900 the SMTP connection from and to the new process and any subsequents.
24901 The new process has no access to TLS information, so cannot include it in
24902 logging.
24903
24904
24905
24906 .option hosts_override smtp boolean false
24907 If this option is set and the &%hosts%& option is also set, any hosts that are
24908 attached to the address are ignored, and instead the hosts specified by the
24909 &%hosts%& option are always used. This option does not apply to
24910 &%fallback_hosts%&.
24911
24912
24913 .option hosts_randomize smtp boolean false
24914 .cindex "randomized host list"
24915 .cindex "host" "list of; randomized"
24916 .cindex "fallback" "randomized hosts"
24917 If this option is set, and either the list of hosts is taken from the
24918 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24919 were not obtained from MX records (this includes fallback hosts from the
24920 router), and were not randomized by the router, the order of trying the hosts
24921 is randomized each time the transport runs. Randomizing the order of a host
24922 list can be used to do crude load sharing.
24923
24924 When &%hosts_randomize%& is true, a host list may be split into groups whose
24925 order is separately randomized. This makes it possible to set up MX-like
24926 behaviour. The boundaries between groups are indicated by an item that is just
24927 &`+`& in the host list. For example:
24928 .code
24929 hosts = host1:host2:host3:+:host4:host5
24930 .endd
24931 The order of the first three hosts and the order of the last two hosts is
24932 randomized for each use, but the first three always end up before the last two.
24933 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24934
24935 .option hosts_require_auth smtp "host list&!!" unset
24936 .cindex "authentication" "required by client"
24937 This option provides a list of servers for which authentication must succeed
24938 before Exim will try to transfer a message. If authentication fails for
24939 servers which are not in this list, Exim tries to send unauthenticated. If
24940 authentication fails for one of these servers, delivery is deferred. This
24941 temporary error is detectable in the retry rules, so it can be turned into a
24942 hard failure if required. See also &%hosts_try_auth%&, and chapter
24943 &<<CHAPSMTPAUTH>>& for details of authentication.
24944
24945
24946 .option hosts_request_ocsp smtp "host list&!!" *
24947 .cindex "TLS" "requiring for certain servers"
24948 Exim will request a Certificate Status on a
24949 TLS session for any host that matches this list.
24950 &%tls_verify_certificates%& should also be set for the transport.
24951
24952 .option hosts_require_dane smtp "host list&!!" unset
24953 .cindex DANE "transport options"
24954 .cindex DANE "requiring for certain servers"
24955 If built with DANE support, Exim  will require that a DNSSEC-validated
24956 TLSA record is present for any host matching the list,
24957 and that a DANE-verified TLS connection is made. See
24958 the &%dnssec_request_domains%& router and transport options.
24959 There will be no fallback to in-clear communication.
24960 See section &<<SECDANE>>&.
24961
24962 .option hosts_require_ocsp smtp "host list&!!" unset
24963 .cindex "TLS" "requiring for certain servers"
24964 Exim will request, and check for a valid Certificate Status being given, on a
24965 TLS session for any host that matches this list.
24966 &%tls_verify_certificates%& should also be set for the transport.
24967
24968 .option hosts_require_tls smtp "host list&!!" unset
24969 .cindex "TLS" "requiring for certain servers"
24970 Exim will insist on using a TLS session when delivering to any host that
24971 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24972 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24973 incoming messages, use an appropriate ACL.
24974
24975 .option hosts_try_auth smtp "host list&!!" unset
24976 .cindex "authentication" "optional in client"
24977 This option provides a list of servers to which, provided they announce
24978 authentication support, Exim will attempt to authenticate as a client when it
24979 connects. If authentication fails, Exim will try to transfer the message
24980 unauthenticated. See also &%hosts_require_auth%&, and chapter
24981 &<<CHAPSMTPAUTH>>& for details of authentication.
24982
24983 .option hosts_try_chunking smtp "host list&!!" *
24984 .cindex CHUNKING "enabling, in client"
24985 .cindex BDAT "SMTP command"
24986 .cindex "RFC 3030" "CHUNKING"
24987 This option provides a list of servers to which, provided they announce
24988 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24989 .new
24990 Unless DKIM signing is being done,
24991 .wen
24992 BDAT will not be used in conjunction with a transport filter.
24993
24994 .option hosts_try_dane smtp "host list&!!" *
24995 .cindex DANE "transport options"
24996 .cindex DANE "attempting for certain servers"
24997 If built with DANE support, Exim  will require that a DNSSEC-validated
24998 TLSA record is present for any host matching the list,
24999 and that a DANE-verified TLS connection is made. See
25000 the &%dnssec_request_domains%& router and transport options.
25001 There will be no fallback to in-clear communication.
25002 See section &<<SECDANE>>&.
25003
25004 .option hosts_try_fastopen smtp "host list&!!" *
25005 .cindex "fast open, TCP" "enabling, in client"
25006 .cindex "TCP Fast Open" "enabling, in client"
25007 .cindex "RFC 7413" "TCP Fast Open"
25008 This option provides a list of servers to which, provided
25009 the facility is supported by this system, Exim will attempt to
25010 perform a TCP Fast Open.
25011 No data is sent on the SYN segment but, if the remote server also
25012 supports the facility, it can send its SMTP banner immediately after
25013 the SYN,ACK segment.  This can save up to one round-trip time.
25014
25015 The facility is only active for previously-contacted servers,
25016 as the initiator must present a cookie in the SYN segment.
25017
25018 On (at least some) current Linux distributions the facility must be enabled
25019 in the kernel by the sysadmin before the support is usable.
25020 There is no option for control of the server side; if the system supports
25021 it it is always enabled.  Note that lengthy operations in the connect ACL,
25022 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25023
25024 .option hosts_try_prdr smtp "host list&!!" *
25025 .cindex "PRDR" "enabling, optional in client"
25026 This option provides a list of servers to which, provided they announce
25027 PRDR support, Exim will attempt to negotiate PRDR
25028 for multi-recipient messages.
25029 The option can usually be left as default.
25030
25031 .option interface smtp "string list&!!" unset
25032 .cindex "bind IP address"
25033 .cindex "IP address" "binding"
25034 .vindex "&$host$&"
25035 .vindex "&$host_address$&"
25036 This option specifies which interface to bind to when making an outgoing SMTP
25037 call. The value is an IP address, not an interface name such as
25038 &`eth0`&. Do not confuse this with the interface address that was used when a
25039 message was received, which is in &$received_ip_address$&, formerly known as
25040 &$interface_address$&. The name was changed to minimize confusion with the
25041 outgoing interface address. There is no variable that contains an outgoing
25042 interface address because, unless it is set by this option, its value is
25043 unknown.
25044
25045 During the expansion of the &%interface%& option the variables &$host$& and
25046 &$host_address$& refer to the host to which a connection is about to be made
25047 during the expansion of the string. Forced expansion failure, or an empty
25048 string result causes the option to be ignored. Otherwise, after expansion, the
25049 string must be a list of IP addresses, colon-separated by default, but the
25050 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25051 For example:
25052 .code
25053 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25054 .endd
25055 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25056 connection. If none of them are the correct type, the option is ignored. If
25057 &%interface%& is not set, or is ignored, the system's IP functions choose which
25058 interface to use if the host has more than one.
25059
25060
25061 .option keepalive smtp boolean true
25062 .cindex "keepalive" "on outgoing connection"
25063 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25064 connections. When set, it causes the kernel to probe idle connections
25065 periodically, by sending packets with &"old"& sequence numbers. The other end
25066 of the connection should send a acknowledgment if the connection is still okay
25067 or a reset if the connection has been aborted. The reason for doing this is
25068 that it has the beneficial effect of freeing up certain types of connection
25069 that can get stuck when the remote host is disconnected without tidying up the
25070 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25071 unreachable hosts.
25072
25073
25074 .option lmtp_ignore_quota smtp boolean false
25075 .cindex "LMTP" "ignoring quota errors"
25076 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25077 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25078 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25079
25080 .option max_rcpt smtp integer 100
25081 .cindex "RCPT" "maximum number of outgoing"
25082 This option limits the number of RCPT commands that are sent in a single
25083 SMTP message transaction. Each set of addresses is treated independently, and
25084 so can cause parallel connections to the same host if &%remote_max_parallel%&
25085 permits this.
25086
25087
25088 .option multi_domain smtp boolean&!! true
25089 .vindex "&$domain$&"
25090 When this option is set, the &(smtp)& transport can handle a number of
25091 addresses containing a mixture of different domains provided they all resolve
25092 to the same list of hosts. Turning the option off restricts the transport to
25093 handling only one domain at a time. This is useful if you want to use
25094 &$domain$& in an expansion for the transport, because it is set only when there
25095 is a single domain involved in a remote delivery.
25096
25097 It is expanded per-address and can depend on any of
25098 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25099 &$host$&, &$host_address$& and &$host_port$&.
25100
25101 .option port smtp string&!! "see below"
25102 .cindex "port" "sending TCP/IP"
25103 .cindex "TCP/IP" "setting outgoing port"
25104 This option specifies the TCP/IP port on the server to which Exim connects.
25105 &*Note:*& Do not confuse this with the port that was used when a message was
25106 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25107 The name was changed to minimize confusion with the outgoing port. There is no
25108 variable that contains an outgoing port.
25109
25110 If the value of this option begins with a digit it is taken as a port number;
25111 otherwise it is looked up using &[getservbyname()]&. The default value is
25112 normally &"smtp"&,
25113 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25114 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25115 If the expansion fails, or if a port number cannot be found, delivery
25116 is deferred.
25117
25118 Note that at least one Linux distribution has been seen failing
25119 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25120
25121
25122
25123 .option protocol smtp string smtp
25124 .cindex "LMTP" "over TCP/IP"
25125 .cindex "ssmtp protocol" "outbound"
25126 .cindex "TLS" "SSL-on-connect outbound"
25127 .vindex "&$port$&"
25128 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25129 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25130 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25131 deliveries into closed message stores. Exim also has support for running LMTP
25132 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25133
25134 If this option is set to &"smtps"&, the default value for the &%port%& option
25135 changes to &"smtps"&, and the transport initiates TLS immediately after
25136 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25137 The Internet standards bodies used to strongly discourage use of this mode,
25138 but as of RFC 8314 it is perferred over STARTTLS for message submission
25139 (as distinct from MTA-MTA communication).
25140
25141
25142 .option retry_include_ip_address smtp boolean&!! true
25143 Exim normally includes both the host name and the IP address in the key it
25144 constructs for indexing retry data after a temporary delivery failure. This
25145 means that when one of several IP addresses for a host is failing, it gets
25146 tried periodically (controlled by the retry rules), but use of the other IP
25147 addresses is not affected.
25148
25149 However, in some dialup environments hosts are assigned a different IP address
25150 each time they connect. In this situation the use of the IP address as part of
25151 the retry key leads to undesirable behaviour. Setting this option false causes
25152 Exim to use only the host name.
25153 Since it is expanded it can be made to depend on the host or domain.
25154
25155
25156 .option serialize_hosts smtp "host list&!!" unset
25157 .cindex "serializing connections"
25158 .cindex "host" "serializing connections"
25159 Because Exim operates in a distributed manner, if several messages for the same
25160 host arrive at around the same time, more than one simultaneous connection to
25161 the remote host can occur. This is not usually a problem except when there is a
25162 slow link between the hosts. In that situation it may be helpful to restrict
25163 Exim to one connection at a time. This can be done by setting
25164 &%serialize_hosts%& to match the relevant hosts.
25165
25166 .cindex "hints database" "serializing deliveries to a host"
25167 Exim implements serialization by means of a hints database in which a record is
25168 written whenever a process connects to one of the restricted hosts. The record
25169 is deleted when the connection is completed. Obviously there is scope for
25170 records to get left lying around if there is a system or program crash. To
25171 guard against this, Exim ignores any records that are more than six hours old.
25172
25173 If you set up this kind of serialization, you should also arrange to delete the
25174 relevant hints database whenever your system reboots. The names of the files
25175 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25176 may be one or two files, depending on the type of DBM in use. The same files
25177 are used for ETRN serialization.
25178
25179 See also the &%max_parallel%& generic transport option.
25180
25181
25182 .option size_addition smtp integer 1024
25183 .cindex "SMTP" "SIZE"
25184 .cindex "message" "size issue for transport filter"
25185 .cindex "size" "of message"
25186 .cindex "transport" "filter"
25187 .cindex "filter" "transport filter"
25188 If a remote SMTP server indicates that it supports the SIZE option of the
25189 MAIL command, Exim uses this to pass over the message size at the start of
25190 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25191 sends, to allow for headers and other text that may be added during delivery by
25192 configuration options or in a transport filter. It may be necessary to increase
25193 this if a lot of text is added to messages.
25194
25195 Alternatively, if the value of &%size_addition%& is set negative, it disables
25196 the use of the SIZE option altogether.
25197
25198
25199 .option socks_proxy smtp string&!! unset
25200 .cindex proxy SOCKS
25201 This option enables use of SOCKS proxies for connections made by the
25202 transport.  For details see section &<<SECTproxySOCKS>>&.
25203
25204
25205 .option tls_certificate smtp string&!! unset
25206 .cindex "TLS" "client certificate, location of"
25207 .cindex "certificate" "client, location of"
25208 .vindex "&$host$&"
25209 .vindex "&$host_address$&"
25210 The value of this option must be the absolute path to a file which contains the
25211 client's certificate, for possible use when sending a message over an encrypted
25212 connection. The values of &$host$& and &$host_address$& are set to the name and
25213 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25214 details of TLS.
25215
25216 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25217 certificate when sending messages as a client. The global option of the same
25218 name specifies the certificate for Exim as a server; it is not automatically
25219 assumed that the same certificate should be used when Exim is operating as a
25220 client.
25221
25222
25223 .option tls_crl smtp string&!! unset
25224 .cindex "TLS" "client certificate revocation list"
25225 .cindex "certificate" "revocation list for client"
25226 This option specifies a certificate revocation list. The expanded value must
25227 be the name of a file that contains a CRL in PEM format.
25228
25229
25230 .option tls_dh_min_bits smtp integer 1024
25231 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25232 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25233 key agreement is negotiated, the server will provide a large prime number
25234 for use.  This option establishes the minimum acceptable size of that number.
25235 If the parameter offered by the server is too small, then the TLS handshake
25236 will fail.
25237
25238 Only supported when using GnuTLS.
25239
25240
25241 .option tls_privatekey smtp string&!! unset
25242 .cindex "TLS" "client private key, location of"
25243 .vindex "&$host$&"
25244 .vindex "&$host_address$&"
25245 The value of this option must be the absolute path to a file which contains the
25246 client's private key. This is used when sending a message over an encrypted
25247 connection using a client certificate. The values of &$host$& and
25248 &$host_address$& are set to the name and address of the server during the
25249 expansion. If this option is unset, or the expansion is forced to fail, or the
25250 result is an empty string, the private key is assumed to be in the same file as
25251 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25252
25253
25254 .option tls_require_ciphers smtp string&!! unset
25255 .cindex "TLS" "requiring specific ciphers"
25256 .cindex "cipher" "requiring specific"
25257 .vindex "&$host$&"
25258 .vindex "&$host_address$&"
25259 The value of this option must be a list of permitted cipher suites, for use
25260 when setting up an outgoing encrypted connection. (There is a global option of
25261 the same name for controlling incoming connections.) The values of &$host$& and
25262 &$host_address$& are set to the name and address of the server during the
25263 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25264 is used in different ways by OpenSSL and GnuTLS (see sections
25265 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25266 ciphers is a preference order.
25267
25268
25269
25270 .option tls_sni smtp string&!! unset
25271 .cindex "TLS" "Server Name Indication"
25272 .vindex "&$tls_sni$&"
25273 If this option is set then it sets the $tls_out_sni variable and causes any
25274 TLS session to pass this value as the Server Name Indication extension to
25275 the remote side, which can be used by the remote side to select an appropriate
25276 certificate and private key for the session.
25277
25278 See &<<SECTtlssni>>& for more information.
25279
25280 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25281 TLS extensions.
25282
25283
25284
25285
25286 .option tls_tempfail_tryclear smtp boolean true
25287 .cindex "4&'xx'& responses" "to STARTTLS"
25288 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25289 setting up a TLS session, this option determines whether or not Exim should try
25290 to deliver the message unencrypted. If it is set false, delivery to the
25291 current host is deferred; if there are other hosts, they are tried. If this
25292 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25293 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25294 TLS negotiation fails, Exim closes the current connection (because it is in an
25295 unknown state), opens a new one to the same host, and then tries the delivery
25296 in clear.
25297
25298
25299 .option tls_try_verify_hosts smtp "host list&!!" *
25300 .cindex "TLS" "server certificate verification"
25301 .cindex "certificate" "verification of server"
25302 This option gives a list of hosts for which, on encrypted connections,
25303 certificate verification will be tried but need not succeed.
25304 The &%tls_verify_certificates%& option must also be set.
25305 Note that unless the host is in this list
25306 TLS connections will be denied to hosts using self-signed certificates
25307 when &%tls_verify_certificates%& is matched.
25308 The &$tls_out_certificate_verified$& variable is set when
25309 certificate verification succeeds.
25310
25311
25312 .option tls_verify_cert_hostnames smtp "host list&!!" *
25313 .cindex "TLS" "server certificate hostname verification"
25314 .cindex "certificate" "verification of server"
25315 This option give a list of hosts for which,
25316 while verifying the server certificate,
25317 checks will be included on the host name
25318 (note that this will generally be the result of a DNS MX lookup)
25319 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25320 limited to being the initial component of a 3-or-more component FQDN.
25321
25322 There is no equivalent checking on client certificates.
25323
25324
25325 .option tls_verify_certificates smtp string&!! system
25326 .cindex "TLS" "server certificate verification"
25327 .cindex "certificate" "verification of server"
25328 .vindex "&$host$&"
25329 .vindex "&$host_address$&"
25330 The value of this option must be either the
25331 word "system"
25332 or the absolute path to
25333 a file or directory containing permitted certificates for servers,
25334 for use when setting up an encrypted connection.
25335
25336 The "system" value for the option will use a location compiled into the SSL library.
25337 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25338 is taken as empty and an explicit location
25339 must be specified.
25340
25341 The use of a directory for the option value is not available for GnuTLS versions
25342 preceding 3.3.6 and a single file must be used.
25343
25344 With OpenSSL the certificates specified
25345 explicitly
25346 either by file or directory
25347 are added to those given by the system default location.
25348
25349 The values of &$host$& and
25350 &$host_address$& are set to the name and address of the server during the
25351 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25352
25353 For back-compatibility,
25354 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25355 (a single-colon empty list counts as being set)
25356 and certificate verification fails the TLS connection is closed.
25357
25358
25359 .option tls_verify_hosts smtp "host list&!!" unset
25360 .cindex "TLS" "server certificate verification"
25361 .cindex "certificate" "verification of server"
25362 This option gives a list of hosts for which, on encrypted connections,
25363 certificate verification must succeed.
25364 The &%tls_verify_certificates%& option must also be set.
25365 If both this option and &%tls_try_verify_hosts%& are unset
25366 operation is as if this option selected all hosts.
25367
25368 .option utf8_downconvert smtp integer!! unset
25369 .cindex utf8 "address downconversion"
25370 .cindex i18n "utf8 address downconversion"
25371 If built with internationalization support,
25372 this option controls conversion of UTF-8 in message addresses
25373 to a-label form.
25374 For details see section &<<SECTi18nMTA>>&.
25375
25376
25377
25378
25379 .section "How the limits for the number of hosts to try are used" &&&
25380          "SECTvalhosmax"
25381 .cindex "host" "maximum number to try"
25382 .cindex "limit" "hosts; maximum number tried"
25383 There are two options that are concerned with the number of hosts that are
25384 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25385 &%hosts_max_try_hardlimit%&.
25386
25387
25388 The &%hosts_max_try%& option limits the number of hosts that are tried
25389 for a single delivery. However, despite the term &"host"& in its name, the
25390 option actually applies to each IP address independently. In other words, a
25391 multihomed host is treated as several independent hosts, just as it is for
25392 retrying.
25393
25394 Many of the larger ISPs have multiple MX records which often point to
25395 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25396 created as a result of routing one of these domains.
25397
25398 Trying every single IP address on such a long list does not seem sensible; if
25399 several at the top of the list fail, it is reasonable to assume there is some
25400 problem that is likely to affect all of them. Roughly speaking, the value of
25401 &%hosts_max_try%& is the maximum number that are tried before deferring the
25402 delivery. However, the logic cannot be quite that simple.
25403
25404 Firstly, IP addresses that are skipped because their retry times have not
25405 arrived do not count, and in addition, addresses that are past their retry
25406 limits are also not counted, even when they are tried. This means that when
25407 some IP addresses are past their retry limits, more than the value of
25408 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25409 that all IP addresses are considered before timing out an email address (but
25410 see below for an exception).
25411
25412 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25413 list to see if there is a subsequent host with a different (higher valued) MX.
25414 If there is, that host is considered next, and the current IP address is used
25415 but not counted. This behaviour helps in the case of a domain with a retry rule
25416 that hardly ever delays any hosts, as is now explained:
25417
25418 Consider the case of a long list of hosts with one MX value, and a few with a
25419 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25420 hosts at the top of the list are tried at first. With the default retry rule,
25421 which specifies increasing retry times, the higher MX hosts are eventually
25422 tried when those at the top of the list are skipped because they have not
25423 reached their retry times.
25424
25425 However, it is common practice to put a fixed short retry time on domains for
25426 large ISPs, on the grounds that their servers are rarely down for very long.
25427 Unfortunately, these are exactly the domains that tend to resolve to long lists
25428 of hosts. The short retry time means that the lowest MX hosts are tried every
25429 time. The attempts may be in a different order because of random sorting, but
25430 without the special MX check, the higher MX hosts would never be tried until
25431 all the lower MX hosts had timed out (which might be several days), because
25432 there are always some lower MX hosts that have reached their retry times. With
25433 the special check, Exim considers at least one IP address from each MX value at
25434 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25435 reached.
25436
25437 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25438 particular, Exim normally eventually tries all the IP addresses before timing
25439 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25440 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25441 been set up with hundreds of IP addresses for some domains. It can
25442 take a very long time indeed for an address to time out in these cases.
25443
25444 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25445 Exim never tries more than this number of IP addresses; if it hits this limit
25446 and they are all timed out, the email address is bounced, even though not all
25447 possible IP addresses have been tried.
25448 .ecindex IIDsmttra1
25449 .ecindex IIDsmttra2
25450
25451
25452
25453
25454
25455 . ////////////////////////////////////////////////////////////////////////////
25456 . ////////////////////////////////////////////////////////////////////////////
25457
25458 .chapter "Address rewriting" "CHAPrewrite"
25459 .scindex IIDaddrew "rewriting" "addresses"
25460 There are some circumstances in which Exim automatically rewrites domains in
25461 addresses. The two most common are when an address is given without a domain
25462 (referred to as an &"unqualified address"&) or when an address contains an
25463 abbreviated domain that is expanded by DNS lookup.
25464
25465 Unqualified envelope addresses are accepted only for locally submitted
25466 messages, or for messages that are received from hosts matching
25467 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25468 appropriate. Unqualified addresses in header lines are qualified if they are in
25469 locally submitted messages, or messages from hosts that are permitted to send
25470 unqualified envelope addresses. Otherwise, unqualified addresses in header
25471 lines are neither qualified nor rewritten.
25472
25473 One situation in which Exim does &'not'& automatically rewrite a domain is
25474 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25475 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25476 do this. The new RFCs do not contain this suggestion.
25477
25478
25479 .section "Explicitly configured address rewriting" "SECID147"
25480 This chapter describes the rewriting rules that can be used in the
25481 main rewrite section of the configuration file, and also in the generic
25482 &%headers_rewrite%& option that can be set on any transport.
25483
25484 Some people believe that configured address rewriting is a Mortal Sin.
25485 Others believe that life is not possible without it. Exim provides the
25486 facility; you do not have to use it.
25487
25488 The main rewriting rules that appear in the &"rewrite"& section of the
25489 configuration file are applied to addresses in incoming messages, both envelope
25490 addresses and addresses in header lines. Each rule specifies the types of
25491 address to which it applies.
25492
25493 Whether or not addresses in header lines are rewritten depends on the origin of
25494 the headers and the type of rewriting. Global rewriting, that is, rewriting
25495 rules from the rewrite section of the configuration file, is applied only to
25496 those headers that were received with the message. Header lines that are added
25497 by ACLs or by a system filter or by individual routers or transports (which
25498 are specific to individual recipient addresses) are not rewritten by the global
25499 rules.
25500
25501 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25502 applies all headers except those added by routers and transports. That is, as
25503 well as the headers that were received with the message, it also applies to
25504 headers that were added by an ACL or a system filter.
25505
25506
25507 In general, rewriting addresses from your own system or domain has some
25508 legitimacy. Rewriting other addresses should be done only with great care and
25509 in special circumstances. The author of Exim believes that rewriting should be
25510 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25511 Although it can sometimes be used as a routing tool, this is very strongly
25512 discouraged.
25513
25514 There are two commonly encountered circumstances where rewriting is used, as
25515 illustrated by these examples:
25516
25517 .ilist
25518 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25519 exchange mail with each other behind a firewall, but there is only a single
25520 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25521 &'hitch.fict.example'& when sending mail off-site.
25522 .next
25523 A host rewrites the local parts of its own users so that, for example,
25524 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25525 .endlist
25526
25527
25528
25529 .section "When does rewriting happen?" "SECID148"
25530 .cindex "rewriting" "timing of"
25531 .cindex "&ACL;" "rewriting addresses in"
25532 Configured address rewriting can take place at several different stages of a
25533 message's processing.
25534
25535 .vindex "&$sender_address$&"
25536 At the start of an ACL for MAIL, the sender address may have been rewritten
25537 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25538 ordinary rewrite rules have yet been applied. If, however, the sender address
25539 is verified in the ACL, it is rewritten before verification, and remains
25540 rewritten thereafter. The subsequent value of &$sender_address$& is the
25541 rewritten address. This also applies if sender verification happens in a
25542 RCPT ACL. Otherwise, when the sender address is not verified, it is
25543 rewritten as soon as a message's header lines have been received.
25544
25545 .vindex "&$domain$&"
25546 .vindex "&$local_part$&"
25547 Similarly, at the start of an ACL for RCPT, the current recipient's address
25548 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25549 rewrite rules have yet been applied to it. However, the behaviour is different
25550 from the sender address when a recipient is verified. The address is rewritten
25551 for the verification, but the rewriting is not remembered at this stage. The
25552 value of &$local_part$& and &$domain$& after verification are always the same
25553 as they were before (that is, they contain the unrewritten &-- except for
25554 SMTP-time rewriting &-- address).
25555
25556 As soon as a message's header lines have been received, all the envelope
25557 recipient addresses are permanently rewritten, and rewriting is also applied to
25558 the addresses in the header lines (if configured). This happens before adding
25559 any header lines that were specified in MAIL or RCPT ACLs, and
25560 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25561 before the DATA ACL and &[local_scan()]& functions are run.
25562
25563 When an address is being routed, either for delivery or for verification,
25564 rewriting is applied immediately to child addresses that are generated by
25565 redirection, unless &%no_rewrite%& is set on the router.
25566
25567 .cindex "envelope from"
25568 .cindex "envelope sender" "rewriting at transport time"
25569 .cindex "rewriting" "at transport time"
25570 .cindex "header lines" "rewriting at transport time"
25571 At transport time, additional rewriting of addresses in header lines can be
25572 specified by setting the generic &%headers_rewrite%& option on a transport.
25573 This option contains rules that are identical in form to those in the rewrite
25574 section of the configuration file. They are applied to the original message
25575 header lines and any that were added by ACLs or a system filter. They are not
25576 applied to header lines that are added by routers or the transport.
25577
25578 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25579 transport option. However, it is not possible to rewrite envelope recipients at
25580 transport time.
25581
25582
25583
25584
25585 .section "Testing the rewriting rules that apply on input" "SECID149"
25586 .cindex "rewriting" "testing"
25587 .cindex "testing" "rewriting"
25588 Exim's input rewriting configuration appears in a part of the runtime
25589 configuration file headed by &"begin rewrite"&. It can be tested by the
25590 &%-brw%& command line option. This takes an address (which can be a full RFC
25591 2822 address) as its argument. The output is a list of how the address would be
25592 transformed by the rewriting rules for each of the different places it might
25593 appear in an incoming message, that is, for each different header and for the
25594 envelope sender and recipient fields. For example,
25595 .code
25596 exim -brw ph10@exim.workshop.example
25597 .endd
25598 might produce the output
25599 .code
25600 sender: Philip.Hazel@exim.workshop.example
25601 from: Philip.Hazel@exim.workshop.example
25602 to: ph10@exim.workshop.example
25603 cc: ph10@exim.workshop.example
25604 bcc: ph10@exim.workshop.example
25605 reply-to: Philip.Hazel@exim.workshop.example
25606 env-from: Philip.Hazel@exim.workshop.example
25607 env-to: ph10@exim.workshop.example
25608 .endd
25609 which shows that rewriting has been set up for that address when used in any of
25610 the source fields, but not when it appears as a recipient address. At the
25611 present time, there is no equivalent way of testing rewriting rules that are
25612 set for a particular transport.
25613
25614
25615 .section "Rewriting rules" "SECID150"
25616 .cindex "rewriting" "rules"
25617 The rewrite section of the configuration file consists of lines of rewriting
25618 rules in the form
25619 .display
25620 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25621 .endd
25622 Rewriting rules that are specified for the &%headers_rewrite%& generic
25623 transport option are given as a colon-separated list. Each item in the list
25624 takes the same form as a line in the main rewriting configuration (except that
25625 any colons must be doubled, of course).
25626
25627 The formats of source patterns and replacement strings are described below.
25628 Each is terminated by white space, unless enclosed in double quotes, in which
25629 case normal quoting conventions apply inside the quotes. The flags are single
25630 characters which may appear in any order. Spaces and tabs between them are
25631 ignored.
25632
25633 For each address that could potentially be rewritten, the rules are scanned in
25634 order, and replacements for the address from earlier rules can themselves be
25635 replaced by later rules (but see the &"q"& and &"R"& flags).
25636
25637 The order in which addresses are rewritten is undefined, may change between
25638 releases, and must not be relied on, with one exception: when a message is
25639 received, the envelope sender is always rewritten first, before any header
25640 lines are rewritten. For example, the replacement string for a rewrite of an
25641 address in &'To:'& must not assume that the message's address in &'From:'& has
25642 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25643 that the envelope sender has already been rewritten.
25644
25645 .vindex "&$domain$&"
25646 .vindex "&$local_part$&"
25647 The variables &$local_part$& and &$domain$& can be used in the replacement
25648 string to refer to the address that is being rewritten. Note that lookup-driven
25649 rewriting can be done by a rule of the form
25650 .code
25651 *@*   ${lookup ...
25652 .endd
25653 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25654 refer to the address that is being rewritten.
25655
25656
25657 .section "Rewriting patterns" "SECID151"
25658 .cindex "rewriting" "patterns"
25659 .cindex "address list" "in a rewriting pattern"
25660 The source pattern in a rewriting rule is any item which may appear in an
25661 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25662 single-item address list, which means that it is expanded before being tested
25663 against the address. As always, if you use a regular expression as a pattern,
25664 you must take care to escape dollar and backslash characters, or use the &`\N`&
25665 facility to suppress string expansion within the regular expression.
25666
25667 Domains in patterns should be given in lower case. Local parts in patterns are
25668 case-sensitive. If you want to do case-insensitive matching of local parts, you
25669 can use a regular expression that starts with &`^(?i)`&.
25670
25671 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25672 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25673 depending on the type of match which occurred. These can be used in the
25674 replacement string to insert portions of the incoming address. &$0$& always
25675 refers to the complete incoming address. When a regular expression is used, the
25676 numerical variables are set from its capturing subexpressions. For other types
25677 of pattern they are set as follows:
25678
25679 .ilist
25680 If a local part or domain starts with an asterisk, the numerical variables
25681 refer to the character strings matched by asterisks, with &$1$& associated with
25682 the first asterisk, and &$2$& with the second, if present. For example, if the
25683 pattern
25684 .code
25685 *queen@*.fict.example
25686 .endd
25687 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25688 .code
25689 $0 = hearts-queen@wonderland.fict.example
25690 $1 = hearts-
25691 $2 = wonderland
25692 .endd
25693 Note that if the local part does not start with an asterisk, but the domain
25694 does, it is &$1$& that contains the wild part of the domain.
25695
25696 .next
25697 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25698 of the domain are placed in the next available numerical variables. Suppose,
25699 for example, that the address &'foo@bar.baz.example'& is processed by a
25700 rewriting rule of the form
25701 .display
25702 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25703 .endd
25704 and the key in the file that matches the domain is &`*.baz.example`&. Then
25705 .code
25706 $1 = foo
25707 $2 = bar
25708 $3 = baz.example
25709 .endd
25710 If the address &'foo@baz.example'& is looked up, this matches the same
25711 wildcard file entry, and in this case &$2$& is set to the empty string, but
25712 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25713 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25714 whole domain. For non-partial domain lookups, no numerical variables are set.
25715 .endlist
25716
25717
25718 .section "Rewriting replacements" "SECID152"
25719 .cindex "rewriting" "replacements"
25720 If the replacement string for a rule is a single asterisk, addresses that
25721 match the pattern and the flags are &'not'& rewritten, and no subsequent
25722 rewriting rules are scanned. For example,
25723 .code
25724 hatta@lookingglass.fict.example  *  f
25725 .endd
25726 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25727 &'From:'& headers.
25728
25729 .vindex "&$domain$&"
25730 .vindex "&$local_part$&"
25731 If the replacement string is not a single asterisk, it is expanded, and must
25732 yield a fully qualified address. Within the expansion, the variables
25733 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25734 Any letters they contain retain their original case &-- they are not lower
25735 cased. The numerical variables are set up according to the type of pattern that
25736 matched the address, as described above. If the expansion is forced to fail by
25737 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25738 current rule is abandoned, but subsequent rules may take effect. Any other
25739 expansion failure causes the entire rewriting operation to be abandoned, and an
25740 entry written to the panic log.
25741
25742
25743
25744 .section "Rewriting flags" "SECID153"
25745 There are three different kinds of flag that may appear on rewriting rules:
25746
25747 .ilist
25748 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25749 c, f, h, r, s, t.
25750 .next
25751 A flag that specifies rewriting at SMTP time: S.
25752 .next
25753 Flags that control the rewriting process: Q, q, R, w.
25754 .endlist
25755
25756 For rules that are part of the &%headers_rewrite%& generic transport option,
25757 E, F, T, and S are not permitted.
25758
25759
25760
25761 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25762          "SECID154"
25763 .cindex "rewriting" "flags"
25764 If none of the following flag letters, nor the &"S"& flag (see section
25765 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25766 and to both the sender and recipient fields of the envelope, whereas a
25767 transport-time rewriting rule just applies to all headers. Otherwise, the
25768 rewriting rule is skipped unless the relevant addresses are being processed.
25769 .display
25770 &`E`&       rewrite all envelope fields
25771 &`F`&       rewrite the envelope From field
25772 &`T`&       rewrite the envelope To field
25773 &`b`&       rewrite the &'Bcc:'& header
25774 &`c`&       rewrite the &'Cc:'& header
25775 &`f`&       rewrite the &'From:'& header
25776 &`h`&       rewrite all headers
25777 &`r`&       rewrite the &'Reply-To:'& header
25778 &`s`&       rewrite the &'Sender:'& header
25779 &`t`&       rewrite the &'To:'& header
25780 .endd
25781 "All headers" means all of the headers listed above that can be selected
25782 individually, plus their &'Resent-'& versions. It does not include
25783 other headers such as &'Subject:'& etc.
25784
25785 You should be particularly careful about rewriting &'Sender:'& headers, and
25786 restrict this to special known cases in your own domains.
25787
25788
25789 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25790 .cindex "SMTP" "rewriting malformed addresses"
25791 .cindex "RCPT" "rewriting argument of"
25792 .cindex "MAIL" "rewriting argument of"
25793 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25794 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25795 before any other processing; even before syntax checking. The pattern is
25796 required to be a regular expression, and it is matched against the whole of the
25797 data for the command, including any surrounding angle brackets.
25798
25799 .vindex "&$domain$&"
25800 .vindex "&$local_part$&"
25801 This form of rewrite rule allows for the handling of addresses that are not
25802 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25803 input). Because the input is not required to be a syntactically valid address,
25804 the variables &$local_part$& and &$domain$& are not available during the
25805 expansion of the replacement string. The result of rewriting replaces the
25806 original address in the MAIL or RCPT command.
25807
25808
25809 .section "Flags controlling the rewriting process" "SECID155"
25810 There are four flags which control the way the rewriting process works. These
25811 take effect only when a rule is invoked, that is, when the address is of the
25812 correct type (matches the flags) and matches the pattern:
25813
25814 .ilist
25815 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25816 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25817 absence of &"Q"& the rewritten address must always include a domain.
25818 .next
25819 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25820 even if no rewriting actually takes place because of a &"fail"& in the
25821 expansion. The &"q"& flag is not effective if the address is of the wrong type
25822 (does not match the flags) or does not match the pattern.
25823 .next
25824 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25825 address, up to ten times. It can be combined with the &"q"& flag, to stop
25826 rewriting once it fails to match (after at least one successful rewrite).
25827 .next
25828 .cindex "rewriting" "whole addresses"
25829 When an address in a header is rewritten, the rewriting normally applies only
25830 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25831 left unchanged. For example, rewriting might change
25832 .code
25833 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25834 .endd
25835 into
25836 .code
25837 From: Ford Prefect <prefectf@hitch.fict.example>
25838 .endd
25839 .cindex "RFC 2047"
25840 Sometimes there is a need to replace the whole address item, and this can be
25841 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25842 causes an address in a header line to be rewritten, the entire address is
25843 replaced, not just the working part. The replacement must be a complete RFC
25844 2822 address, including the angle brackets if necessary. If text outside angle
25845 brackets contains a character whose value is greater than 126 or less than 32
25846 (except for tab), the text is encoded according to RFC 2047. The character set
25847 is taken from &%headers_charset%&, which gets its default at build time.
25848
25849 When the &"w"& flag is set on a rule that causes an envelope address to be
25850 rewritten, all but the working part of the replacement address is discarded.
25851 .endlist
25852
25853
25854 .section "Rewriting examples" "SECID156"
25855 Here is an example of the two common rewriting paradigms:
25856 .code
25857 *@*.hitch.fict.example  $1@hitch.fict.example
25858 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25859                      {$value}fail}@hitch.fict.example bctfrF
25860 .endd
25861 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25862 the string expansion to fail if the lookup does not succeed. In this context it
25863 has the effect of leaving the original address unchanged, but Exim goes on to
25864 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25865 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25866 explicitly, which would cause the rewritten address to be the same as before,
25867 at the cost of a small bit of processing. Not supplying either of these is an
25868 error, since the rewritten address would then contain no local part.
25869
25870 The first example above replaces the domain with a superior, more general
25871 domain. This may not be desirable for certain local parts. If the rule
25872 .code
25873 root@*.hitch.fict.example  *
25874 .endd
25875 were inserted before the first rule, rewriting would be suppressed for the
25876 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25877
25878 Rewriting can be made conditional on a number of tests, by making use of
25879 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25880 messages that originate outside the local host:
25881 .code
25882 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25883                          {$1@hitch.fict.example}fail}"
25884 .endd
25885 The replacement string is quoted in this example because it contains white
25886 space.
25887
25888 .cindex "rewriting" "bang paths"
25889 .cindex "bang paths" "rewriting"
25890 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25891 an address it treats it as an unqualified local part which it qualifies with
25892 the local qualification domain (if the source of the message is local or if the
25893 remote host is permitted to send unqualified addresses). Rewriting can
25894 sometimes be used to handle simple bang paths with a fixed number of
25895 components. For example, the rule
25896 .code
25897 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25898 .endd
25899 rewrites a two-component bang path &'host.name!user'& as the domain address
25900 &'user@host.name'&. However, there is a security implication in using this as
25901 a global rewriting rule for envelope addresses. It can provide a backdoor
25902 method for using your system as a relay, because the incoming addresses appear
25903 to be local. If the bang path addresses are received via SMTP, it is safer to
25904 use the &"S"& flag to rewrite them as they are received, so that relay checking
25905 can be done on the rewritten addresses.
25906 .ecindex IIDaddrew
25907
25908
25909
25910
25911
25912 . ////////////////////////////////////////////////////////////////////////////
25913 . ////////////////////////////////////////////////////////////////////////////
25914
25915 .chapter "Retry configuration" "CHAPretry"
25916 .scindex IIDretconf1 "retry" "configuration, description of"
25917 .scindex IIDregconf2 "configuration file" "retry section"
25918 The &"retry"& section of the runtime configuration file contains a list of
25919 retry rules that control how often Exim tries to deliver messages that cannot
25920 be delivered at the first attempt. If there are no retry rules (the section is
25921 empty or not present), there are no retries. In this situation, temporary
25922 errors are treated as permanent. The default configuration contains a single,
25923 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25924 line option can be used to test which retry rule will be used for a given
25925 address, domain and error.
25926
25927 The most common cause of retries is temporary failure to deliver to a remote
25928 host because the host is down, or inaccessible because of a network problem.
25929 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25930 address) basis, not on a per-message basis. Thus, if one message has recently
25931 been delayed, delivery of a new message to the same host is not immediately
25932 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25933 log selector is set, the message
25934 .cindex "retry" "time not reached"
25935 &"retry time not reached"& is written to the main log whenever a delivery is
25936 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25937 the handling of errors during remote deliveries.
25938
25939 Retry processing applies to routing as well as to delivering, except as covered
25940 in the next paragraph. The retry rules do not distinguish between these
25941 actions. It is not possible, for example, to specify different behaviour for
25942 failures to route the domain &'snark.fict.example'& and failures to deliver to
25943 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25944 added complication, so did not implement it. However, although they share the
25945 same retry rule, the actual retry times for routing and transporting a given
25946 domain are maintained independently.
25947
25948 When a delivery is not part of a queue run (typically an immediate delivery on
25949 receipt of a message), the routers are always run, and local deliveries are
25950 always attempted, even if retry times are set for them. This makes for better
25951 behaviour if one particular message is causing problems (for example, causing
25952 quota overflow, or provoking an error in a filter file). If such a delivery
25953 suffers a temporary failure, the retry data is updated as normal, and
25954 subsequent delivery attempts from queue runs occur only when the retry time for
25955 the local address is reached.
25956
25957 .section "Changing retry rules" "SECID157"
25958 If you change the retry rules in your configuration, you should consider
25959 whether or not to delete the retry data that is stored in Exim's spool area in
25960 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25961 always safe; that is why they are called &"hints"&.
25962
25963 The hints retry data contains suggested retry times based on the previous
25964 rules. In the case of a long-running problem with a remote host, it might
25965 record the fact that the host has timed out. If your new rules increase the
25966 timeout time for such a host, you should definitely remove the old retry data
25967 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25968 messages that it should now be retaining.
25969
25970
25971
25972 .section "Format of retry rules" "SECID158"
25973 .cindex "retry" "rules"
25974 Each retry rule occupies one line and consists of three or four parts,
25975 separated by white space: a pattern, an error name, an optional list of sender
25976 addresses, and a list of retry parameters. The pattern and sender lists must be
25977 enclosed in double quotes if they contain white space. The rules are searched
25978 in order until one is found where the pattern, error name, and sender list (if
25979 present) match the failing host or address, the error that occurred, and the
25980 message's sender, respectively.
25981
25982
25983 The pattern is any single item that may appear in an address list (see section
25984 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25985 which means that it is expanded before being tested against the address that
25986 has been delayed. A negated address list item is permitted. Address
25987 list processing treats a plain domain name as if it were preceded by &"*@"&,
25988 which makes it possible for many retry rules to start with just a domain. For
25989 example,
25990 .code
25991 lookingglass.fict.example        *  F,24h,30m;
25992 .endd
25993 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25994 whereas
25995 .code
25996 alice@lookingglass.fict.example  *  F,24h,30m;
25997 .endd
25998 applies only to temporary failures involving the local part &%alice%&.
25999 In practice, almost all rules start with a domain name pattern without a local
26000 part.
26001
26002 .cindex "regular expressions" "in retry rules"
26003 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26004 must match a complete address, not just a domain, because that is how regular
26005 expressions work in address lists.
26006 .display
26007 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26008 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26009 .endd
26010
26011
26012 .section "Choosing which retry rule to use for address errors" "SECID159"
26013 When Exim is looking for a retry rule after a routing attempt has failed (for
26014 example, after a DNS timeout), each line in the retry configuration is tested
26015 against the complete address only if &%retry_use_local_part%& is set for the
26016 router. Otherwise, only the domain is used, except when matching against a
26017 regular expression, when the local part of the address is replaced with &"*"&.
26018 A domain on its own can match a domain pattern, or a pattern that starts with
26019 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26020 &%check_local_user%& is true, and false for other routers.
26021
26022 Similarly, when Exim is looking for a retry rule after a local delivery has
26023 failed (for example, after a mailbox full error), each line in the retry
26024 configuration is tested against the complete address only if
26025 &%retry_use_local_part%& is set for the transport (it defaults true for all
26026 local transports).
26027
26028 .cindex "4&'xx'& responses" "retry rules for"
26029 However, when Exim is looking for a retry rule after a remote delivery attempt
26030 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26031 whole address is always used as the key when searching the retry rules. The
26032 rule that is found is used to create a retry time for the combination of the
26033 failing address and the message's sender. It is the combination of sender and
26034 recipient that is delayed in subsequent queue runs until its retry time is
26035 reached. You can delay the recipient without regard to the sender by setting
26036 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26037 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26038 commands.
26039
26040
26041
26042 .section "Choosing which retry rule to use for host and message errors" &&&
26043          "SECID160"
26044 For a temporary error that is not related to an individual address (for
26045 example, a connection timeout), each line in the retry configuration is checked
26046 twice. First, the name of the remote host is used as a domain name (preceded by
26047 &"*@"& when matching a regular expression). If this does not match the line,
26048 the domain from the email address is tried in a similar fashion. For example,
26049 suppose the MX records for &'a.b.c.example'& are
26050 .code
26051 a.b.c.example  MX  5  x.y.z.example
26052                MX  6  p.q.r.example
26053                MX  7  m.n.o.example
26054 .endd
26055 and the retry rules are
26056 .code
26057 p.q.r.example    *      F,24h,30m;
26058 a.b.c.example    *      F,4d,45m;
26059 .endd
26060 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26061 first rule matches neither the host nor the domain, so Exim looks at the second
26062 rule. This does not match the host, but it does match the domain, so it is used
26063 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26064 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26065 first retry rule is used, because it matches the host.
26066
26067 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26068 first rule to determine retry times, but for all the other hosts for the domain
26069 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26070 routing to &'a.b.c.example'& suffers a temporary failure.
26071
26072 &*Note*&: The host name is used when matching the patterns, not its IP address.
26073 However, if a message is routed directly to an IP address without the use of a
26074 host name, for example, if a &(manualroute)& router contains a setting such as:
26075 .code
26076 route_list = *.a.example  192.168.34.23
26077 .endd
26078 then the &"host name"& that is used when searching for a retry rule is the
26079 textual form of the IP address.
26080
26081 .section "Retry rules for specific errors" "SECID161"
26082 .cindex "retry" "specific errors; specifying"
26083 The second field in a retry rule is the name of a particular error, or an
26084 asterisk, which matches any error. The errors that can be tested for are:
26085
26086 .vlist
26087 .vitem &%auth_failed%&
26088 Authentication failed when trying to send to a host in the
26089 &%hosts_require_auth%& list in an &(smtp)& transport.
26090
26091 .vitem &%data_4xx%&
26092 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26093 after the command, or after sending the message's data.
26094
26095 .vitem &%mail_4xx%&
26096 A 4&'xx'& error was received for an outgoing MAIL command.
26097
26098 .vitem &%rcpt_4xx%&
26099 A 4&'xx'& error was received for an outgoing RCPT command.
26100 .endlist
26101
26102 For the three 4&'xx'& errors, either the first or both of the x's can be given
26103 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26104 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26105 and have retries every ten minutes with a one-hour timeout, you could set up a
26106 retry rule of this form:
26107 .code
26108 the.domain.name  rcpt_452   F,1h,10m
26109 .endd
26110 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26111 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26112
26113 .vlist
26114 .vitem &%lost_connection%&
26115 A server unexpectedly closed the SMTP connection. There may, of course,
26116 legitimate reasons for this (host died, network died), but if it repeats a lot
26117 for the same host, it indicates something odd.
26118
26119 .vitem &%lookup%&
26120 A DNS lookup for a host failed.
26121 Note that a &%dnslookup%& router will need to have matched
26122 its &%fail_defer_domains%& option for this retry type to be usable.
26123 Also note that a &%manualroute%& router will probably need
26124 its &%host_find_failed%& option set to &%defer%&.
26125
26126 .vitem &%refused_MX%&
26127 A connection to a host obtained from an MX record was refused.
26128
26129 .vitem &%refused_A%&
26130 A connection to a host not obtained from an MX record was refused.
26131
26132 .vitem &%refused%&
26133 A connection was refused.
26134
26135 .vitem &%timeout_connect_MX%&
26136 A connection attempt to a host obtained from an MX record timed out.
26137
26138 .vitem &%timeout_connect_A%&
26139 A connection attempt to a host not obtained from an MX record timed out.
26140
26141 .vitem &%timeout_connect%&
26142 A connection attempt timed out.
26143
26144 .vitem &%timeout_MX%&
26145 There was a timeout while connecting or during an SMTP session with a host
26146 obtained from an MX record.
26147
26148 .vitem &%timeout_A%&
26149 There was a timeout while connecting or during an SMTP session with a host not
26150 obtained from an MX record.
26151
26152 .vitem &%timeout%&
26153 There was a timeout while connecting or during an SMTP session.
26154
26155 .vitem &%tls_required%&
26156 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26157 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26158 to STARTTLS, or there was a problem setting up the TLS connection.
26159
26160 .vitem &%quota%&
26161 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26162 transport.
26163
26164 .vitem &%quota_%&<&'time'&>
26165 .cindex "quota" "error testing in retry rule"
26166 .cindex "retry" "quota error testing"
26167 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26168 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26169 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26170 for four days.
26171 .endlist
26172
26173 .cindex "mailbox" "time of last read"
26174 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26175 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26176 it should be based on the last time that the user accessed the mailbox.
26177 However, it is not always possible to determine this. Exim uses the following
26178 heuristic rules:
26179
26180 .ilist
26181 If the mailbox is a single file, the time of last access (the &"atime"&) is
26182 used. As no new messages are being delivered (because the mailbox is over
26183 quota), Exim does not access the file, so this is the time of last user access.
26184 .next
26185 .cindex "maildir format" "time of last read"
26186 For a maildir delivery, the time of last modification of the &_new_&
26187 subdirectory is used. As the mailbox is over quota, no new files are created in
26188 the &_new_& subdirectory, because no new messages are being delivered. Any
26189 change to the &_new_& subdirectory is therefore assumed to be the result of an
26190 MUA moving a new message to the &_cur_& directory when it is first read. The
26191 time that is used is therefore the last time that the user read a new message.
26192 .next
26193 For other kinds of multi-file mailbox, the time of last access cannot be
26194 obtained, so a retry rule that uses this type of error field is never matched.
26195 .endlist
26196
26197 The quota errors apply both to system-enforced quotas and to Exim's own quota
26198 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26199 when a local delivery is deferred because a partition is full (the ENOSPC
26200 error).
26201
26202
26203
26204 .section "Retry rules for specified senders" "SECID162"
26205 .cindex "retry" "rules; sender-specific"
26206 You can specify retry rules that apply only when the failing message has a
26207 specific sender. In particular, this can be used to define retry rules that
26208 apply only to bounce messages. The third item in a retry rule can be of this
26209 form:
26210 .display
26211 &`senders=`&<&'address list'&>
26212 .endd
26213 The retry timings themselves are then the fourth item. For example:
26214 .code
26215 *   rcpt_4xx   senders=:   F,1h,30m
26216 .endd
26217 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26218 host. If the address list contains white space, it must be enclosed in quotes.
26219 For example:
26220 .code
26221 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26222 .endd
26223 &*Warning*&: This facility can be unhelpful if it is used for host errors
26224 (which do not depend on the recipient). The reason is that the sender is used
26225 only to match the retry rule. Once the rule has been found for a host error,
26226 its contents are used to set a retry time for the host, and this will apply to
26227 all messages, not just those with specific senders.
26228
26229 When testing retry rules using &%-brt%&, you can supply a sender using the
26230 &%-f%& command line option, like this:
26231 .code
26232 exim -f "" -brt user@dom.ain
26233 .endd
26234 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26235 list is never matched.
26236
26237
26238
26239
26240
26241 .section "Retry parameters" "SECID163"
26242 .cindex "retry" "parameters in rules"
26243 The third (or fourth, if a senders list is present) field in a retry rule is a
26244 sequence of retry parameter sets, separated by semicolons. Each set consists of
26245 .display
26246 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26247 .endd
26248 The letter identifies the algorithm for computing a new retry time; the cutoff
26249 time is the time beyond which this algorithm no longer applies, and the
26250 arguments vary the algorithm's action. The cutoff time is measured from the
26251 time that the first failure for the domain (combined with the local part if
26252 relevant) was detected, not from the time the message was received.
26253
26254 .cindex "retry" "algorithms"
26255 .cindex "retry" "fixed intervals"
26256 .cindex "retry" "increasing intervals"
26257 .cindex "retry" "random intervals"
26258 The available algorithms are:
26259
26260 .ilist
26261 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26262 the interval.
26263 .next
26264 &'G'&: retry at geometrically increasing intervals. The first argument
26265 specifies a starting value for the interval, and the second a multiplier, which
26266 is used to increase the size of the interval at each retry.
26267 .next
26268 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26269 retry, the previous interval is multiplied by the factor in order to get a
26270 maximum for the next interval. The minimum interval is the first argument of
26271 the parameter, and an actual interval is chosen randomly between them. Such a
26272 rule has been found to be helpful in cluster configurations when all the
26273 members of the cluster restart at once, and may therefore synchronize their
26274 queue processing times.
26275 .endlist
26276
26277 When computing the next retry time, the algorithm definitions are scanned in
26278 order until one whose cutoff time has not yet passed is reached. This is then
26279 used to compute a new retry time that is later than the current time. In the
26280 case of fixed interval retries, this simply means adding the interval to the
26281 current time. For geometrically increasing intervals, retry intervals are
26282 computed from the rule's parameters until one that is greater than the previous
26283 interval is found. The main configuration variable
26284 .cindex "limit" "retry interval"
26285 .cindex "retry" "interval, maximum"
26286 .oindex "&%retry_interval_max%&"
26287 &%retry_interval_max%& limits the maximum interval between retries. It
26288 cannot be set greater than &`24h`&, which is its default value.
26289
26290 A single remote domain may have a number of hosts associated with it, and each
26291 host may have more than one IP address. Retry algorithms are selected on the
26292 basis of the domain name, but are applied to each IP address independently. If,
26293 for example, a host has two IP addresses and one is unusable, Exim will
26294 generate retry times for it and will not try to use it until its next retry
26295 time comes. Thus the good IP address is likely to be tried first most of the
26296 time.
26297
26298 .cindex "hints database" "use for retrying"
26299 Retry times are hints rather than promises. Exim does not make any attempt to
26300 run deliveries exactly at the computed times. Instead, a queue runner process
26301 starts delivery processes for delayed messages periodically, and these attempt
26302 new deliveries only for those addresses that have passed their next retry time.
26303 If a new message arrives for a deferred address, an immediate delivery attempt
26304 occurs only if the address has passed its retry time. In the absence of new
26305 messages, the minimum time between retries is the interval between queue runner
26306 processes. There is not much point in setting retry times of five minutes if
26307 your queue runners happen only once an hour, unless there are a significant
26308 number of incoming messages (which might be the case on a system that is
26309 sending everything to a smart host, for example).
26310
26311 The data in the retry hints database can be inspected by using the
26312 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26313 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26314 &'exinext'& utility script can be used to find out what the next retry times
26315 are for the hosts associated with a particular mail domain, and also for local
26316 deliveries that have been deferred.
26317
26318
26319 .section "Retry rule examples" "SECID164"
26320 Here are some example retry rules:
26321 .code
26322 alice@wonderland.fict.example quota_5d  F,7d,3h
26323 wonderland.fict.example       quota_5d
26324 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26325 lookingglass.fict.example     *         F,24h,30m;
26326 *                 refused_A   F,2h,20m;
26327 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26328 .endd
26329 The first rule sets up special handling for mail to
26330 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26331 mailbox has not been read for at least 5 days. Retries continue every three
26332 hours for 7 days. The second rule handles over-quota errors for all other local
26333 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26334 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26335 fail are bounced immediately if the mailbox has not been read for at least 5
26336 days.
26337
26338 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26339 happen every 15 minutes for an hour, then with geometrically increasing
26340 intervals until two days have passed since a delivery first failed. After the
26341 first hour there is a delay of one hour, then two hours, then four hours, and
26342 so on (this is a rather extreme example).
26343
26344 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26345 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26346 all other domains, with special action for connection refusal from hosts that
26347 were not obtained from an MX record.
26348
26349 The final rule in a retry configuration should always have asterisks in the
26350 first two fields so as to provide a general catch-all for any addresses that do
26351 not have their own special handling. This example tries every 15 minutes for 2
26352 hours, then with intervals starting at one hour and increasing by a factor of
26353 1.5 up to 16 hours, then every 8 hours up to 5 days.
26354
26355
26356
26357 .section "Timeout of retry data" "SECID165"
26358 .cindex "timeout" "of retry data"
26359 .oindex "&%retry_data_expire%&"
26360 .cindex "hints database" "data expiry"
26361 .cindex "retry" "timeout of data"
26362 Exim timestamps the data that it writes to its retry hints database. When it
26363 consults the data during a delivery it ignores any that is older than the value
26364 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26365 been tried for 7 days, Exim will try to deliver to it immediately a message
26366 arrives, and if that fails, it will calculate a retry time as if it were
26367 failing for the first time.
26368
26369 This improves the behaviour for messages routed to rarely-used hosts such as MX
26370 backups. If such a host was down at one time, and happens to be down again when
26371 Exim tries a month later, using the old retry data would imply that it had been
26372 down all the time, which is not a justified assumption.
26373
26374 If a host really is permanently dead, this behaviour causes a burst of retries
26375 every now and again, but only if messages routed to it are rare. If there is a
26376 message at least once every 7 days the retry data never expires.
26377
26378
26379
26380
26381 .section "Long-term failures" "SECID166"
26382 .cindex "delivery failure, long-term"
26383 .cindex "retry" "after long-term failure"
26384 Special processing happens when an email address has been failing for so long
26385 that the cutoff time for the last algorithm is reached. For example, using the
26386 default retry rule:
26387 .code
26388 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26389 .endd
26390 the cutoff time is four days. Reaching the retry cutoff is independent of how
26391 long any specific message has been failing; it is the length of continuous
26392 failure for the recipient address that counts.
26393
26394 When the cutoff time is reached for a local delivery, or for all the IP
26395 addresses associated with a remote delivery, a subsequent delivery failure
26396 causes Exim to give up on the address, and a bounce message is generated.
26397 In order to cater for new messages that use the failing address, a next retry
26398 time is still computed from the final algorithm, and is used as follows:
26399
26400 For local deliveries, one delivery attempt is always made for any subsequent
26401 messages. If this delivery fails, the address fails immediately. The
26402 post-cutoff retry time is not used.
26403
26404 .cindex "final cutoff" "retries, controlling"
26405 .cindex retry "final cutoff"
26406 If the delivery is remote, there are two possibilities, controlled by the
26407 .oindex "&%delay_after_cutoff%&"
26408 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26409 default. Until the post-cutoff retry time for one of the IP addresses,
26410 as set by the &%retry_data_expire%& option, is
26411 reached, the failing email address is bounced immediately, without a delivery
26412 attempt taking place. After that time, one new delivery attempt is made to
26413 those IP addresses that are past their retry times, and if that still fails,
26414 the address is bounced and new retry times are computed.
26415
26416 In other words, when all the hosts for a given email address have been failing
26417 for a long time, Exim bounces rather then defers until one of the hosts' retry
26418 times is reached. Then it tries once, and bounces if that attempt fails. This
26419 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26420 to a broken destination, but if the host does recover, Exim will eventually
26421 notice.
26422
26423 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26424 addresses are past their final cutoff time, Exim tries to deliver to those IP
26425 addresses that have not been tried since the message arrived. If there are
26426 no suitable IP addresses, or if they all fail, the address is bounced. In other
26427 words, it does not delay when a new message arrives, but tries the expired
26428 addresses immediately, unless they have been tried since the message arrived.
26429 If there is a continuous stream of messages for the failing domains, setting
26430 &%delay_after_cutoff%& false means that there will be many more attempts to
26431 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26432 true.
26433
26434 .section "Deliveries that work intermittently" "SECID167"
26435 .cindex "retry" "intermittently working deliveries"
26436 Some additional logic is needed to cope with cases where a host is
26437 intermittently available, or when a message has some attribute that prevents
26438 its delivery when others to the same address get through. In this situation,
26439 because some messages are successfully delivered, the &"retry clock"& for the
26440 host or address keeps getting reset by the successful deliveries, and so
26441 failing messages remain in the queue for ever because the cutoff time is never
26442 reached.
26443
26444 Two exceptional actions are applied to prevent this happening. The first
26445 applies to errors that are related to a message rather than a remote host.
26446 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26447 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26448 commands, and quota failures. For this type of error, if a message's arrival
26449 time is earlier than the &"first failed"& time for the error, the earlier time
26450 is used when scanning the retry rules to decide when to try next and when to
26451 time out the address.
26452
26453 The exceptional second action applies in all cases. If a message has been on
26454 the queue for longer than the cutoff time of any applicable retry rule for a
26455 given address, a delivery is attempted for that address, even if it is not yet
26456 time, and if this delivery fails, the address is timed out. A new retry time is
26457 not computed in this case, so that other messages for the same address are
26458 considered immediately.
26459 .ecindex IIDretconf1
26460 .ecindex IIDregconf2
26461
26462
26463
26464
26465
26466
26467 . ////////////////////////////////////////////////////////////////////////////
26468 . ////////////////////////////////////////////////////////////////////////////
26469
26470 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26471 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26472 .scindex IIDauthconf2 "authentication"
26473 The &"authenticators"& section of Exim's runtime configuration is concerned
26474 with SMTP authentication. This facility is an extension to the SMTP protocol,
26475 described in RFC 2554, which allows a client SMTP host to authenticate itself
26476 to a server. This is a common way for a server to recognize clients that are
26477 permitted to use it as a relay. SMTP authentication is not of relevance to the
26478 transfer of mail between servers that have no managerial connection with each
26479 other.
26480
26481 .cindex "AUTH" "description of"
26482 Very briefly, the way SMTP authentication works is as follows:
26483
26484 .ilist
26485 The server advertises a number of authentication &'mechanisms'& in response to
26486 the client's EHLO command.
26487 .next
26488 The client issues an AUTH command, naming a specific mechanism. The command
26489 may, optionally, contain some authentication data.
26490 .next
26491 The server may issue one or more &'challenges'&, to which the client must send
26492 appropriate responses. In simple authentication mechanisms, the challenges are
26493 just prompts for user names and passwords. The server does not have to issue
26494 any challenges &-- in some mechanisms the relevant data may all be transmitted
26495 with the AUTH command.
26496 .next
26497 The server either accepts or denies authentication.
26498 .next
26499 If authentication succeeds, the client may optionally make use of the AUTH
26500 option on the MAIL command to pass an authenticated sender in subsequent
26501 mail transactions. Authentication lasts for the remainder of the SMTP
26502 connection.
26503 .next
26504 If authentication fails, the client may give up, or it may try a different
26505 authentication mechanism, or it may try transferring mail over the
26506 unauthenticated connection.
26507 .endlist
26508
26509 If you are setting up a client, and want to know which authentication
26510 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26511 SMTP port) on the server, and issue an EHLO command. The response to this
26512 includes the list of supported mechanisms. For example:
26513 .display
26514 &`$ `&&*&`telnet server.example 25`&*&
26515 &`Trying 192.168.34.25...`&
26516 &`Connected to server.example.`&
26517 &`Escape character is &#x0027;^]&#x0027;.`&
26518 &`220 server.example ESMTP Exim 4.20 ...`&
26519 &*&`ehlo client.example`&*&
26520 &`250-server.example Hello client.example [10.8.4.5]`&
26521 &`250-SIZE 52428800`&
26522 &`250-PIPELINING`&
26523 &`250-AUTH PLAIN`&
26524 &`250 HELP`&
26525 .endd
26526 The second-last line of this example output shows that the server supports
26527 authentication using the PLAIN mechanism. In Exim, the different authentication
26528 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26529 routers and transports, which authenticators are included in the binary is
26530 controlled by build-time definitions. The following are currently available,
26531 included by setting
26532 .code
26533 AUTH_CRAM_MD5=yes
26534 AUTH_CYRUS_SASL=yes
26535 AUTH_DOVECOT=yes
26536 AUTH_EXTERNAL=yes
26537 AUTH_GSASL=yes
26538 AUTH_HEIMDAL_GSSAPI=yes
26539 AUTH_PLAINTEXT=yes
26540 AUTH_SPA=yes
26541 AUTH_TLS=yes
26542 .endd
26543 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26544 authentication mechanism (RFC 2195), and the second provides an interface to
26545 the Cyrus SASL authentication library.
26546 The third is an interface to Dovecot's authentication system, delegating the
26547 work via a socket interface.
26548 The fourth provides for negotiation of authentication done via non-SMTP means,
26549 as defined by RFC 4422 Appendix A.
26550 The fifth provides an interface to the GNU SASL authentication library, which
26551 provides mechanisms but typically not data sources.
26552 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26553 supporting setting a server keytab.
26554 The seventh can be configured to support
26555 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26556 not formally documented, but used by several MUAs.
26557 The eighth authenticator
26558 supports Microsoft's &'Secure Password Authentication'& mechanism.
26559 The last is an Exim authenticator but not an SMTP one;
26560 instead it can use information from a TLS negotiation.
26561
26562 The authenticators are configured using the same syntax as other drivers (see
26563 section &<<SECTfordricon>>&). If no authenticators are required, no
26564 authentication section need be present in the configuration file. Each
26565 authenticator can in principle have both server and client functions. When Exim
26566 is receiving SMTP mail, it is acting as a server; when it is sending out
26567 messages over SMTP, it is acting as a client. Authenticator configuration
26568 options are provided for use in both these circumstances.
26569
26570 To make it clear which options apply to which situation, the prefixes
26571 &%server_%& and &%client_%& are used on option names that are specific to
26572 either the server or the client function, respectively. Server and client
26573 functions are disabled if none of their options are set. If an authenticator is
26574 to be used for both server and client functions, a single definition, using
26575 both sets of options, is required. For example:
26576 .code
26577 cram:
26578   driver = cram_md5
26579   public_name = CRAM-MD5
26580   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26581   client_name = ph10
26582   client_secret = secret2
26583 .endd
26584 The &%server_%& option is used when Exim is acting as a server, and the
26585 &%client_%& options when it is acting as a client.
26586
26587 Descriptions of the individual authenticators are given in subsequent chapters.
26588 The remainder of this chapter covers the generic options for the
26589 authenticators, followed by general discussion of the way authentication works
26590 in Exim.
26591
26592 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26593 per-mechanism basis.  Please read carefully to determine which variables hold
26594 account labels such as usercodes and which hold passwords or other
26595 authenticating data.
26596
26597 Note that some mechanisms support two different identifiers for accounts: the
26598 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26599 and &'authz'& are commonly encountered.  The American spelling is standard here.
26600 Conceptually, authentication data such as passwords are tied to the identifier
26601 used to authenticate; servers may have rules to permit one user to act as a
26602 second user, so that after login the session is treated as though that second
26603 user had logged in.  That second user is the &'authorization id'&.  A robust
26604 configuration might confirm that the &'authz'& field is empty or matches the
26605 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26606 as verified data, the &'authz'& as an unverified request which the server might
26607 choose to honour.
26608
26609 A &'realm'& is a text string, typically a domain name, presented by a server
26610 to a client to help it select an account and credentials to use.  In some
26611 mechanisms, the client and server provably agree on the realm, but clients
26612 typically can not treat the realm as secure data to be blindly trusted.
26613
26614
26615
26616 .section "Generic options for authenticators" "SECID168"
26617 .cindex "authentication" "generic options"
26618 .cindex "options" "generic; for authenticators"
26619
26620 .option client_condition authenticators string&!! unset
26621 When Exim is authenticating as a client, it skips any authenticator whose
26622 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26623 used, for example, to skip plain text authenticators when the connection is not
26624 encrypted by a setting such as:
26625 .code
26626 client_condition = ${if !eq{$tls_out_cipher}{}}
26627 .endd
26628
26629
26630 .option client_set_id authenticators string&!! unset
26631 When client authentication succeeds, this condition is expanded; the
26632 result is used in the log lines for outbound messages.
26633 Typically it will be the user name used for authentication.
26634
26635
26636 .option driver authenticators string unset
26637 This option must always be set. It specifies which of the available
26638 authenticators is to be used.
26639
26640
26641 .option public_name authenticators string unset
26642 This option specifies the name of the authentication mechanism that the driver
26643 implements, and by which it is known to the outside world. These names should
26644 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26645 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26646 defaults to the driver's instance name.
26647
26648
26649 .option server_advertise_condition authenticators string&!! unset
26650 When a server is about to advertise an authentication mechanism, the condition
26651 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26652 mechanism is not advertised.
26653 If the expansion fails, the mechanism is not advertised. If the failure was not
26654 forced, and was not caused by a lookup defer, the incident is logged.
26655 See section &<<SECTauthexiser>>& below for further discussion.
26656
26657
26658 .option server_condition authenticators string&!! unset
26659 This option must be set for a &%plaintext%& server authenticator, where it
26660 is used directly to control authentication. See section &<<SECTplainserver>>&
26661 for details.
26662
26663 For the &(gsasl)& authenticator, this option is required for various
26664 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26665
26666 For the other authenticators, &%server_condition%& can be used as an additional
26667 authentication or authorization mechanism that is applied after the other
26668 authenticator conditions succeed. If it is set, it is expanded when the
26669 authenticator would otherwise return a success code. If the expansion is forced
26670 to fail, authentication fails. Any other expansion failure causes a temporary
26671 error code to be returned. If the result of a successful expansion is an empty
26672 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26673 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26674 other result, a temporary error code is returned, with the expanded string as
26675 the error text.
26676
26677
26678 .option server_debug_print authenticators string&!! unset
26679 If this option is set and authentication debugging is enabled (see the &%-d%&
26680 command line option), the string is expanded and included in the debugging
26681 output when the authenticator is run as a server. This can help with checking
26682 out the values of variables.
26683 If expansion of the string fails, the error message is written to the debugging
26684 output, and Exim carries on processing.
26685
26686
26687 .option server_set_id authenticators string&!! unset
26688 .vindex "&$authenticated_id$&"
26689 .vindex "&$authenticated_fail_id$&"
26690 When an Exim server successfully authenticates a client, this string is
26691 expanded using data from the authentication, and preserved for any incoming
26692 messages in the variable &$authenticated_id$&. It is also included in the log
26693 lines for incoming messages. For example, a user/password authenticator
26694 configuration might preserve the user name that was used to authenticate, and
26695 refer to it subsequently during delivery of the message.
26696 On a failing authentication the expansion result is instead saved in
26697 the &$authenticated_fail_id$& variable.
26698 If expansion fails, the option is ignored.
26699
26700
26701 .option server_mail_auth_condition authenticators string&!! unset
26702 This option allows a server to discard authenticated sender addresses supplied
26703 as part of MAIL commands in SMTP connections that are authenticated by the
26704 driver on which &%server_mail_auth_condition%& is set. The option is not used
26705 as part of the authentication process; instead its (unexpanded) value is
26706 remembered for later use.
26707 How it is used is described in the following section.
26708
26709
26710
26711
26712
26713 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26714 .cindex "authentication" "sender; authenticated"
26715 .cindex "AUTH" "on MAIL command"
26716 When a client supplied an AUTH= item on a MAIL command, Exim applies
26717 the following checks before accepting it as the authenticated sender of the
26718 message:
26719
26720 .ilist
26721 If the connection is not using extended SMTP (that is, HELO was used rather
26722 than EHLO), the use of AUTH= is a syntax error.
26723 .next
26724 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26725 .next
26726 .vindex "&$authenticated_sender$&"
26727 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26728 running, the value of &$authenticated_sender$& is set to the value obtained
26729 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26730 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26731 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26732 given for the MAIL command.
26733 .next
26734 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26735 is accepted and placed in &$authenticated_sender$& only if the client has
26736 authenticated.
26737 .next
26738 If the AUTH= value was accepted by either of the two previous rules, and
26739 the client has authenticated, and the authenticator has a setting for the
26740 &%server_mail_auth_condition%&, the condition is checked at this point. The
26741 valued that was saved from the authenticator is expanded. If the expansion
26742 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26743 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26744 the value of &$authenticated_sender$& is retained and passed on with the
26745 message.
26746 .endlist
26747
26748
26749 When &$authenticated_sender$& is set for a message, it is passed on to other
26750 hosts to which Exim authenticates as a client. Do not confuse this value with
26751 &$authenticated_id$&, which is a string obtained from the authentication
26752 process, and which is not usually a complete email address.
26753
26754 .vindex "&$sender_address$&"
26755 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26756 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26757 therefore make use of &$authenticated_sender$&. The converse is not true: the
26758 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26759 ACL is run.
26760
26761
26762
26763 .section "Authentication on an Exim server" "SECTauthexiser"
26764 .cindex "authentication" "on an Exim server"
26765 When Exim receives an EHLO command, it advertises the public names of those
26766 authenticators that are configured as servers, subject to the following
26767 conditions:
26768
26769 .ilist
26770 The client host must match &%auth_advertise_hosts%& (default *).
26771 .next
26772 It the &%server_advertise_condition%& option is set, its expansion must not
26773 yield the empty string, &"0"&, &"no"&, or &"false"&.
26774 .endlist
26775
26776 The order in which the authenticators are defined controls the order in which
26777 the mechanisms are advertised.
26778
26779 Some mail clients (for example, some versions of Netscape) require the user to
26780 provide a name and password for authentication whenever AUTH is advertised,
26781 even though authentication may not in fact be needed (for example, Exim may be
26782 set up to allow unconditional relaying from the client by an IP address check).
26783 You can make such clients more friendly by not advertising AUTH to them.
26784 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26785 that runs for RCPT) to relay without authentication, you should set
26786 .code
26787 auth_advertise_hosts = ! 10.9.8.0/24
26788 .endd
26789 so that no authentication mechanisms are advertised to them.
26790
26791 The &%server_advertise_condition%& controls the advertisement of individual
26792 authentication mechanisms. For example, it can be used to restrict the
26793 advertisement of a particular mechanism to encrypted connections, by a setting
26794 such as:
26795 .code
26796 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26797 .endd
26798 .vindex "&$tls_in_cipher$&"
26799 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26800 yields &"yes"&, which allows the advertisement to happen.
26801
26802 When an Exim server receives an AUTH command from a client, it rejects it
26803 immediately if AUTH was not advertised in response to an earlier EHLO
26804 command. This is the case if
26805
26806 .ilist
26807 The client host does not match &%auth_advertise_hosts%&; or
26808 .next
26809 No authenticators are configured with server options; or
26810 .next
26811 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26812 server authenticators.
26813 .endlist
26814
26815
26816 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26817 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26818 AUTH is accepted from any client host.
26819
26820 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26821 server authentication mechanism that was advertised in response to EHLO and
26822 that matches the one named in the AUTH command. If it finds one, it runs
26823 the appropriate authentication protocol, and authentication either succeeds or
26824 fails. If there is no matching advertised mechanism, the AUTH command is
26825 rejected with a 504 error.
26826
26827 .vindex "&$received_protocol$&"
26828 .vindex "&$sender_host_authenticated$&"
26829 When a message is received from an authenticated host, the value of
26830 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26831 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26832 public name) of the authenticator driver that successfully authenticated the
26833 client from which the message was received. This variable is empty if there was
26834 no successful authentication.
26835
26836 .cindex authentication "expansion item"
26837 Successful authentication sets up information used by the
26838 &%authresults%& expansion item.
26839
26840
26841
26842
26843 .section "Testing server authentication" "SECID169"
26844 .cindex "authentication" "testing a server"
26845 .cindex "AUTH" "testing a server"
26846 .cindex "base64 encoding" "creating authentication test data"
26847 Exim's &%-bh%& option can be useful for testing server authentication
26848 configurations. The data for the AUTH command has to be sent using base64
26849 encoding. A quick way to produce such data for testing is the following Perl
26850 script:
26851 .code
26852 use MIME::Base64;
26853 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26854 .endd
26855 .cindex "binary zero" "in authentication data"
26856 This interprets its argument as a Perl string, and then encodes it. The
26857 interpretation as a Perl string allows binary zeros, which are required for
26858 some kinds of authentication, to be included in the data. For example, a
26859 command line to run this script on such data might be
26860 .code
26861 encode '\0user\0password'
26862 .endd
26863 Note the use of single quotes to prevent the shell interpreting the
26864 backslashes, so that they can be interpreted by Perl to specify characters
26865 whose code value is zero.
26866
26867 &*Warning 1*&: If either of the user or password strings starts with an octal
26868 digit, you must use three zeros instead of one after the leading backslash. If
26869 you do not, the octal digit that starts your string will be incorrectly
26870 interpreted as part of the code for the first character.
26871
26872 &*Warning 2*&: If there are characters in the strings that Perl interprets
26873 specially, you must use a Perl escape to prevent them being misinterpreted. For
26874 example, a command such as
26875 .code
26876 encode '\0user@domain.com\0pas$$word'
26877 .endd
26878 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26879
26880 If you have the &%mimencode%& command installed, another way to do produce
26881 base64-encoded strings is to run the command
26882 .code
26883 echo -e -n `\0user\0password' | mimencode
26884 .endd
26885 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26886 in the argument, and the &%-n%& option specifies no newline at the end of its
26887 output. However, not all versions of &%echo%& recognize these options, so you
26888 should check your version before relying on this suggestion.
26889
26890
26891
26892 .section "Authentication by an Exim client" "SECID170"
26893 .cindex "authentication" "on an Exim client"
26894 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26895 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26896 announces support for authentication, and the host matches an entry in either
26897 of these options, Exim (as a client) tries to authenticate as follows:
26898
26899 .ilist
26900 For each authenticator that is configured as a client, in the order in which
26901 they are defined in the configuration, it searches the authentication
26902 mechanisms announced by the server for one whose name matches the public name
26903 of the authenticator.
26904 .next
26905 .vindex "&$host$&"
26906 .vindex "&$host_address$&"
26907 When it finds one that matches, it runs the authenticator's client code. The
26908 variables &$host$& and &$host_address$& are available for any string expansions
26909 that the client might do. They are set to the server's name and IP address. If
26910 any expansion is forced to fail, the authentication attempt is abandoned, and
26911 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26912 delivery to be deferred.
26913 .next
26914 If the result of the authentication attempt is a temporary error or a timeout,
26915 Exim abandons trying to send the message to the host for the moment. It will
26916 try again later. If there are any backup hosts available, they are tried in the
26917 usual way.
26918 .next
26919 If the response to authentication is a permanent error (5&'xx'& code), Exim
26920 carries on searching the list of authenticators and tries another one if
26921 possible. If all authentication attempts give permanent errors, or if there are
26922 no attempts because no mechanisms match (or option expansions force failure),
26923 what happens depends on whether the host matches &%hosts_require_auth%& or
26924 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26925 delivery is deferred. The error can be detected in the retry rules, and thereby
26926 turned into a permanent error if you wish. In the second case, Exim tries to
26927 deliver the message unauthenticated.
26928 .endlist
26929
26930 Note that the hostlist test for whether to do authentication can be
26931 confused if name-IP lookups change between the time the peer is decided
26932 upon and the time that the transport runs.  For example, with a manualroute
26933 router given a host name, and with DNS "round-robin" used by that name: if
26934 the local resolver cache times out between the router and the transport
26935 running, the transport may get an IP for the name for its authentication
26936 check which does not match the connection peer IP.
26937 No authentication will then be done, despite the names being identical.
26938
26939 For such cases use a separate transport which always authenticates.
26940
26941 .cindex "AUTH" "on MAIL command"
26942 When Exim has authenticated itself to a remote server, it adds the AUTH
26943 parameter to the MAIL commands it sends, if it has an authenticated sender for
26944 the message. If the message came from a remote host, the authenticated sender
26945 is the one that was receiving on an incoming MAIL command, provided that the
26946 incoming connection was authenticated and the &%server_mail_auth%& condition
26947 allowed the authenticated sender to be retained. If a local process calls Exim
26948 to send a message, the sender address that is built from the login name and
26949 &%qualify_domain%& is treated as authenticated. However, if the
26950 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26951 the authenticated sender that was received with the message.
26952 .ecindex IIDauthconf1
26953 .ecindex IIDauthconf2
26954
26955
26956
26957
26958
26959
26960 . ////////////////////////////////////////////////////////////////////////////
26961 . ////////////////////////////////////////////////////////////////////////////
26962
26963 .chapter "The plaintext authenticator" "CHAPplaintext"
26964 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26965 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26966 The &(plaintext)& authenticator can be configured to support the PLAIN and
26967 LOGIN authentication mechanisms, both of which transfer authentication data as
26968 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26969 security risk; you are strongly advised to insist on the use of SMTP encryption
26970 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26971 use unencrypted plain text, you should not use the same passwords for SMTP
26972 connections as you do for login accounts.
26973
26974 .section "Avoiding cleartext use" "SECTplain_TLS"
26975 The following generic option settings will disable &(plaintext)& authenticators when
26976 TLS is not being used:
26977 .code
26978   server_advertise_condition = ${if def:tls_in_cipher }
26979   client_condition =           ${if def:tls_out_cipher}
26980 .endd
26981
26982 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
26983 but is still vulnerable to a Man In The Middle attack unless certificates
26984 (including their names) have been properly verified.
26985
26986 .section "Plaintext server options" "SECID171"
26987 .cindex "options" "&(plaintext)& authenticator (server)"
26988 When configured as a server, &(plaintext)& uses the following options:
26989
26990 .option server_condition authenticators string&!! unset
26991 This is actually a global authentication option, but it must be set in order to
26992 configure the &(plaintext)& driver as a server. Its use is described below.
26993
26994 .option server_prompts plaintext "string list&!!" unset
26995 The contents of this option, after expansion, must be a colon-separated list of
26996 prompt strings. If expansion fails, a temporary authentication rejection is
26997 given.
26998
26999 .section "Using plaintext in a server" "SECTplainserver"
27000 .cindex "AUTH" "in &(plaintext)& authenticator"
27001 .cindex "binary zero" "in &(plaintext)& authenticator"
27002 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27003         "in &(plaintext)& authenticator"
27004 .vindex "&$auth1$&, &$auth2$&, etc"
27005 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27006
27007 When running as a server, &(plaintext)& performs the authentication test by
27008 expanding a string. The data sent by the client with the AUTH command, or in
27009 response to subsequent prompts, is base64 encoded, and so may contain any byte
27010 values when decoded. If any data is supplied with the command, it is treated as
27011 a list of strings, separated by NULs (binary zeros), the first three of which
27012 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27013 (neither LOGIN nor PLAIN uses more than three strings).
27014
27015 For compatibility with previous releases of Exim, the values are also placed in
27016 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27017 variables for this purpose is now deprecated, as it can lead to confusion in
27018 string expansions that also use them for other things.
27019
27020 If there are more strings in &%server_prompts%& than the number of strings
27021 supplied with the AUTH command, the remaining prompts are used to obtain more
27022 data. Each response from the client may be a list of NUL-separated strings.
27023
27024 .vindex "&$authenticated_id$&"
27025 Once a sufficient number of data strings have been received,
27026 &%server_condition%& is expanded. If the expansion is forced to fail,
27027 authentication fails. Any other expansion failure causes a temporary error code
27028 to be returned. If the result of a successful expansion is an empty string,
27029 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27030 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27031 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27032 For any other result, a temporary error code is returned, with the expanded
27033 string as the error text.
27034
27035 &*Warning*&: If you use a lookup in the expansion to find the user's
27036 password, be sure to make the authentication fail if the user is unknown.
27037 There are good and bad examples at the end of the next section.
27038
27039
27040
27041 .section "The PLAIN authentication mechanism" "SECID172"
27042 .cindex "PLAIN authentication mechanism"
27043 .cindex "authentication" "PLAIN mechanism"
27044 .cindex "binary zero" "in &(plaintext)& authenticator"
27045 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27046 sent as one item of data (that is, one combined string containing two NUL
27047 separators). The data is sent either as part of the AUTH command, or
27048 subsequently in response to an empty prompt from the server.
27049
27050 The second and third strings are a user name and a corresponding password.
27051 Using a single fixed user name and password as an example, this could be
27052 configured as follows:
27053 .code
27054 fixed_plain:
27055   driver = plaintext
27056   public_name = PLAIN
27057   server_prompts = :
27058   server_condition = \
27059     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27060   server_set_id = $auth2
27061 .endd
27062 Note that the default result strings from &%if%& (&"true"& or an empty string)
27063 are exactly what we want here, so they need not be specified. Obviously, if the
27064 password contains expansion-significant characters such as dollar, backslash,
27065 or closing brace, they have to be escaped.
27066
27067 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27068 the end of a string list are ignored). If all the data comes as part of the
27069 AUTH command, as is commonly the case, the prompt is not used. This
27070 authenticator is advertised in the response to EHLO as
27071 .code
27072 250-AUTH PLAIN
27073 .endd
27074 and a client host can authenticate itself by sending the command
27075 .code
27076 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27077 .endd
27078 As this contains three strings (more than the number of prompts), no further
27079 data is required from the client. Alternatively, the client may just send
27080 .code
27081 AUTH PLAIN
27082 .endd
27083 to initiate authentication, in which case the server replies with an empty
27084 prompt. The client must respond with the combined data string.
27085
27086 The data string is base64 encoded, as required by the RFC. This example,
27087 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27088 represents a zero byte. This is split up into three strings, the first of which
27089 is empty. The &%server_condition%& option in the authenticator checks that the
27090 second two are &`username`& and &`mysecret`& respectively.
27091
27092 Having just one fixed user name and password, as in this example, is not very
27093 realistic, though for a small organization with only a handful of
27094 authenticating clients it could make sense.
27095
27096 A more sophisticated instance of this authenticator could use the user name in
27097 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27098 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27099 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27100 This is an incorrect example:
27101 .code
27102 server_condition = \
27103   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27104 .endd
27105 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27106 which it then compares to the supplied password (&$auth3$&). Why is this example
27107 incorrect? It works fine for existing users, but consider what happens if a
27108 non-existent user name is given. The lookup fails, but as no success/failure
27109 strings are given for the lookup, it yields an empty string. Thus, to defeat
27110 the authentication, all a client has to do is to supply a non-existent user
27111 name and an empty password. The correct way of writing this test is:
27112 .code
27113 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27114   {${if eq{$value}{$auth3}}} {false}}
27115 .endd
27116 In this case, if the lookup succeeds, the result is checked; if the lookup
27117 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27118 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27119 always fails if its second argument is empty. However, the second way of
27120 writing the test makes the logic clearer.
27121
27122
27123 .section "The LOGIN authentication mechanism" "SECID173"
27124 .cindex "LOGIN authentication mechanism"
27125 .cindex "authentication" "LOGIN mechanism"
27126 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27127 in a number of programs. No data is sent with the AUTH command. Instead, a
27128 user name and password are supplied separately, in response to prompts. The
27129 plaintext authenticator can be configured to support this as in this example:
27130 .code
27131 fixed_login:
27132   driver = plaintext
27133   public_name = LOGIN
27134   server_prompts = User Name : Password
27135   server_condition = \
27136     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27137   server_set_id = $auth1
27138 .endd
27139 Because of the way plaintext operates, this authenticator accepts data supplied
27140 with the AUTH command (in contravention of the specification of LOGIN), but
27141 if the client does not supply it (as is the case for LOGIN clients), the prompt
27142 strings are used to obtain two data items.
27143
27144 Some clients are very particular about the precise text of the prompts. For
27145 example, Outlook Express is reported to recognize only &"Username:"& and
27146 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27147 strings. It uses the &%ldapauth%& expansion condition to check the user
27148 name and password by binding to an LDAP server:
27149 .code
27150 login:
27151   driver = plaintext
27152   public_name = LOGIN
27153   server_prompts = Username:: : Password::
27154   server_condition = ${if and{{ \
27155     !eq{}{$auth1} }{ \
27156     ldapauth{\
27157       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27158       pass=${quote:$auth2} \
27159       ldap://ldap.example.org/} }} }
27160   server_set_id = uid=$auth1,ou=people,o=example.org
27161 .endd
27162 We have to check that the username is not empty before using it, because LDAP
27163 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27164 operator to correctly quote the DN for authentication. However, the basic
27165 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27166 correct one to use for the password, because quoting is needed only to make
27167 the password conform to the Exim syntax. At the LDAP level, the password is an
27168 uninterpreted string.
27169
27170
27171 .section "Support for different kinds of authentication" "SECID174"
27172 A number of string expansion features are provided for the purpose of
27173 interfacing to different ways of user authentication. These include checking
27174 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27175 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27176 &<<SECTexpcond>>&.
27177
27178
27179
27180
27181 .section "Using plaintext in a client" "SECID175"
27182 .cindex "options" "&(plaintext)& authenticator (client)"
27183 The &(plaintext)& authenticator has two client options:
27184
27185 .option client_ignore_invalid_base64 plaintext boolean false
27186 If the client receives a server prompt that is not a valid base64 string,
27187 authentication is abandoned by default. However, if this option is set true,
27188 the error in the challenge is ignored and the client sends the response as
27189 usual.
27190
27191 .option client_send plaintext string&!! unset
27192 The string is a colon-separated list of authentication data strings. Each
27193 string is independently expanded before being sent to the server. The first
27194 string is sent with the AUTH command; any more strings are sent in response
27195 to prompts from the server. Before each string is expanded, the value of the
27196 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27197 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27198 way. Thus, the prompt that is received in response to sending the first string
27199 (with the AUTH command) can be used in the expansion of the second string, and
27200 so on. If an invalid base64 string is received when
27201 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27202 &$auth$&<&'n'&> variable.
27203
27204 &*Note*&: You cannot use expansion to create multiple strings, because
27205 splitting takes priority and happens first.
27206
27207 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27208 the data, further processing is applied to each string before it is sent. If
27209 there are any single circumflex characters in the string, they are converted to
27210 NULs. Should an actual circumflex be required as data, it must be doubled in
27211 the string.
27212
27213 This is an example of a client configuration that implements the PLAIN
27214 authentication mechanism with a fixed user name and password:
27215 .code
27216 fixed_plain:
27217   driver = plaintext
27218   public_name = PLAIN
27219   client_send = ^username^mysecret
27220 .endd
27221 The lack of colons means that the entire text is sent with the AUTH
27222 command, with the circumflex characters converted to NULs. A similar example
27223 that uses the LOGIN mechanism is:
27224 .code
27225 fixed_login:
27226   driver = plaintext
27227   public_name = LOGIN
27228   client_send = : username : mysecret
27229 .endd
27230 The initial colon means that the first string is empty, so no data is sent with
27231 the AUTH command itself. The remaining strings are sent in response to
27232 prompts.
27233 .ecindex IIDplaiauth1
27234 .ecindex IIDplaiauth2
27235
27236
27237
27238
27239 . ////////////////////////////////////////////////////////////////////////////
27240 . ////////////////////////////////////////////////////////////////////////////
27241
27242 .chapter "The cram_md5 authenticator" "CHID9"
27243 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27244 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27245 .cindex "CRAM-MD5 authentication mechanism"
27246 .cindex "authentication" "CRAM-MD5 mechanism"
27247 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27248 sends a challenge string to the client, and the response consists of a user
27249 name and the CRAM-MD5 digest of the challenge string combined with a secret
27250 string (password) which is known to both server and client. Thus, the secret
27251 is not sent over the network as plain text, which makes this authenticator more
27252 secure than &(plaintext)&. However, the downside is that the secret has to be
27253 available in plain text at either end.
27254
27255
27256 .section "Using cram_md5 as a server" "SECID176"
27257 .cindex "options" "&(cram_md5)& authenticator (server)"
27258 This authenticator has one server option, which must be set to configure the
27259 authenticator as a server:
27260
27261 .option server_secret cram_md5 string&!! unset
27262 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27263 When the server receives the client's response, the user name is placed in
27264 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27265 obtain the password for that user. The server then computes the CRAM-MD5 digest
27266 that the client should have sent, and checks that it received the correct
27267 string. If the expansion of &%server_secret%& is forced to fail, authentication
27268 fails. If the expansion fails for some other reason, a temporary error code is
27269 returned to the client.
27270
27271 For compatibility with previous releases of Exim, the user name is also placed
27272 in &$1$&. However, the use of this variables for this purpose is now
27273 deprecated, as it can lead to confusion in string expansions that also use
27274 numeric variables for other things.
27275
27276 For example, the following authenticator checks that the user name given by the
27277 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27278 user name, authentication fails.
27279 .code
27280 fixed_cram:
27281   driver = cram_md5
27282   public_name = CRAM-MD5
27283   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27284   server_set_id = $auth1
27285 .endd
27286 .vindex "&$authenticated_id$&"
27287 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27288 name in &$authenticated_id$&. A more typical configuration might look up the
27289 secret string in a file, using the user name as the key. For example:
27290 .code
27291 lookup_cram:
27292   driver = cram_md5
27293   public_name = CRAM-MD5
27294   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27295                   {$value}fail}
27296   server_set_id = $auth1
27297 .endd
27298 Note that this expansion explicitly forces failure if the lookup fails
27299 because &$auth1$& contains an unknown user name.
27300
27301 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27302 using the relevant libraries, you need to know the realm to specify in the
27303 lookup and then ask for the &"userPassword"& attribute for that user in that
27304 realm, with:
27305 .code
27306 cyrusless_crammd5:
27307   driver = cram_md5
27308   public_name = CRAM-MD5
27309   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27310                   dbmjz{/etc/sasldb2}{$value}fail}
27311   server_set_id = $auth1
27312 .endd
27313
27314 .section "Using cram_md5 as a client" "SECID177"
27315 .cindex "options" "&(cram_md5)& authenticator (client)"
27316 When used as a client, the &(cram_md5)& authenticator has two options:
27317
27318
27319
27320 .option client_name cram_md5 string&!! "the primary host name"
27321 This string is expanded, and the result used as the user name data when
27322 computing the response to the server's challenge.
27323
27324
27325 .option client_secret cram_md5 string&!! unset
27326 This option must be set for the authenticator to work as a client. Its value is
27327 expanded and the result used as the secret string when computing the response.
27328
27329
27330 .vindex "&$host$&"
27331 .vindex "&$host_address$&"
27332 Different user names and secrets can be used for different servers by referring
27333 to &$host$& or &$host_address$& in the options. Forced failure of either
27334 expansion string is treated as an indication that this authenticator is not
27335 prepared to handle this case. Exim moves on to the next configured client
27336 authenticator. Any other expansion failure causes Exim to give up trying to
27337 send the message to the current server.
27338
27339 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27340 strings, is:
27341 .code
27342 fixed_cram:
27343   driver = cram_md5
27344   public_name = CRAM-MD5
27345   client_name = ph10
27346   client_secret = secret
27347 .endd
27348 .ecindex IIDcramauth1
27349 .ecindex IIDcramauth2
27350
27351
27352
27353 . ////////////////////////////////////////////////////////////////////////////
27354 . ////////////////////////////////////////////////////////////////////////////
27355
27356 .chapter "The cyrus_sasl authenticator" "CHID10"
27357 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27358 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27359 .cindex "Cyrus" "SASL library"
27360 .cindex "Kerberos"
27361 The code for this authenticator was provided by Matthew Byng-Maddick while
27362 at A L Digital Ltd.
27363
27364 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27365 library implementation of the RFC 2222 (&"Simple Authentication and Security
27366 Layer"&). This library supports a number of authentication mechanisms,
27367 including PLAIN and LOGIN, but also several others that Exim does not support
27368 directly. In particular, there is support for Kerberos authentication.
27369
27370 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27371 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27372 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27373 name of the driver to determine which mechanism to support.
27374
27375 Where access to some kind of secret file is required, for example, in GSSAPI
27376 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27377 user, and that the Cyrus SASL library has no way of escalating privileges
27378 by default. You may also find you need to set environment variables,
27379 depending on the driver you are using.
27380
27381 The application name provided by Exim is &"exim"&, so various SASL options may
27382 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27383 Kerberos, note that because of limitations in the GSSAPI interface,
27384 changing the server keytab might need to be communicated down to the Kerberos
27385 layer independently. The mechanism for doing so is dependent upon the Kerberos
27386 implementation.
27387
27388 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27389 may be set to point to an alternative keytab file. Exim will pass this
27390 variable through from its own inherited environment when started as root or the
27391 Exim user. The keytab file needs to be readable by the Exim user.
27392 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27393 environment variable.  In practice, for those releases, the Cyrus authenticator
27394 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27395 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27396
27397
27398 .section "Using cyrus_sasl as a server" "SECID178"
27399 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27400 (on a successful authentication) into &$auth1$&. For compatibility with
27401 previous releases of Exim, the username is also placed in &$1$&. However, the
27402 use of this variable for this purpose is now deprecated, as it can lead to
27403 confusion in string expansions that also use numeric variables for other
27404 things.
27405
27406
27407 .option server_hostname cyrus_sasl string&!! "see below"
27408 This option selects the hostname that is used when communicating with the
27409 library. The default value is &`$primary_hostname`&. It is up to the underlying
27410 SASL plug-in what it does with this data.
27411
27412
27413 .option server_mech cyrus_sasl string "see below"
27414 This option selects the authentication mechanism this driver should use. The
27415 default is the value of the generic &%public_name%& option. This option allows
27416 you to use a different underlying mechanism from the advertised name. For
27417 example:
27418 .code
27419 sasl:
27420   driver = cyrus_sasl
27421   public_name = X-ANYTHING
27422   server_mech = CRAM-MD5
27423   server_set_id = $auth1
27424 .endd
27425
27426 .option server_realm cyrus_sasl string&!! unset
27427 This specifies the SASL realm that the server claims to be in.
27428
27429
27430 .option server_service cyrus_sasl string &`smtp`&
27431 This is the SASL service that the server claims to implement.
27432
27433
27434 For straightforward cases, you do not need to set any of the authenticator's
27435 private options. All you need to do is to specify an appropriate mechanism as
27436 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27437 PLAIN, you could have two authenticators as follows:
27438 .code
27439 sasl_cram_md5:
27440   driver = cyrus_sasl
27441   public_name = CRAM-MD5
27442   server_set_id = $auth1
27443
27444 sasl_plain:
27445   driver = cyrus_sasl
27446   public_name = PLAIN
27447   server_set_id = $auth2
27448 .endd
27449 Cyrus SASL does implement the LOGIN authentication method, even though it is
27450 not a standard method. It is disabled by default in the source distribution,
27451 but it is present in many binary distributions.
27452 .ecindex IIDcyrauth1
27453 .ecindex IIDcyrauth2
27454
27455
27456
27457
27458 . ////////////////////////////////////////////////////////////////////////////
27459 . ////////////////////////////////////////////////////////////////////////////
27460 .chapter "The dovecot authenticator" "CHAPdovecot"
27461 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27462 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27463 This authenticator is an interface to the authentication facility of the
27464 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27465 Note that Dovecot must be configured to use auth-client not auth-userdb.
27466 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27467 to use the same mechanisms for SMTP authentication. This is a server
27468 authenticator only. There is only one option:
27469
27470 .option server_socket dovecot string unset
27471
27472 This option must specify the UNIX socket that is the interface to Dovecot
27473 authentication. The &%public_name%& option must specify an authentication
27474 mechanism that Dovecot is configured to support. You can have several
27475 authenticators for different mechanisms. For example:
27476 .code
27477 dovecot_plain:
27478   driver = dovecot
27479   public_name = PLAIN
27480   server_socket = /var/run/dovecot/auth-client
27481   server_set_id = $auth1
27482
27483 dovecot_ntlm:
27484   driver = dovecot
27485   public_name = NTLM
27486   server_socket = /var/run/dovecot/auth-client
27487   server_set_id = $auth1
27488 .endd
27489 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27490 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27491 option is passed in the Dovecot authentication command. If, for a TLS
27492 connection, a client certificate has been verified, the &"valid-client-cert"&
27493 option is passed. When authentication succeeds, the identity of the user
27494 who authenticated is placed in &$auth1$&.
27495
27496 .new
27497 The Dovecot configuration to match the above wil look
27498 something like:
27499 .code
27500 conf.d/10-master.conf :-
27501
27502 service auth {
27503 ...
27504 #SASL
27505   unix_listener auth-client {
27506     mode = 0660
27507     user = mail
27508   }
27509 ...
27510 }
27511
27512 conf.d/10-auth.conf :-
27513
27514 auth_mechanisms = plain login ntlm
27515 .endd
27516 .wen
27517
27518 .ecindex IIDdcotauth1
27519 .ecindex IIDdcotauth2
27520
27521
27522 . ////////////////////////////////////////////////////////////////////////////
27523 . ////////////////////////////////////////////////////////////////////////////
27524 .chapter "The gsasl authenticator" "CHAPgsasl"
27525 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27526 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27527 .cindex "authentication" "GNU SASL"
27528 .cindex "authentication" "SASL"
27529 .cindex "authentication" "EXTERNAL"
27530 .cindex "authentication" "ANONYMOUS"
27531 .cindex "authentication" "PLAIN"
27532 .cindex "authentication" "LOGIN"
27533 .cindex "authentication" "DIGEST-MD5"
27534 .cindex "authentication" "CRAM-MD5"
27535 .cindex "authentication" "SCRAM-SHA-1"
27536 .cindex "authentication" "SCRAM-SHA-1-PLUS"
27537 .cindex "authentication" "SCRAM-SHA-256"
27538 .cindex "authentication" "SCRAM-SHA-256-PLUS"
27539 The &(gsasl)& authenticator provides integration for the GNU SASL
27540 library and the mechanisms it provides.  This is new as of the 4.80 release
27541 and there are a few areas where the library does not let Exim smoothly
27542 scale to handle future authentication mechanisms, so no guarantee can be
27543 made that any particular new authentication mechanism will be supported
27544 without code changes in Exim.
27545
27546 .new
27547 The library is expected to add support in an upcoming
27548 realease for the SCRAM-SHA-256 method.
27549 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27550 when this happens.
27551
27552
27553 .option client_authz gsasl string&!! unset
27554 This option can be used to supply an &'authorization id'&
27555 which is different to the &'authentication_id'& provided
27556 by &%client_username%& option.
27557 If unset or (after expansion) empty it is not used,
27558 which is the common case.
27559
27560 .option client_channelbinding gsasl boolean false
27561 See &%server_channelbinding%& below.
27562
27563 .option client_password gsasl string&!! unset
27564 This option is exapanded before use, and should result in
27565 the password to be used, in clear.
27566
27567 .option client_username gsasl string&!! unset
27568 This option is exapanded before use, and should result in
27569 the account name to be used.
27570 .wen
27571
27572 .new
27573 .option client_spassword gsasl string&!! unset
27574 If a SCRAM mechanism is being used and this option is set
27575 it is used in preference to &%client_password%&.
27576 The value after expansion should be
27577 a 40 (for SHA-1) or 64 (for SHA-256) character string
27578 with the PBKDF2-prepared password, hex-encoded.
27579 Note that this value will depend on the salt and iteration-count
27580 supplied by the server.
27581 .wen
27582
27583
27584
27585 .option server_channelbinding gsasl boolean false
27586 Do not set this true and rely on the properties
27587 without consulting a cryptographic engineer.
27588
27589 Some authentication mechanisms are able to use external context at both ends
27590 of the session to bind the authentication to that context, and fail the
27591 authentication process if that context differs.  Specifically, some TLS
27592 ciphersuites can provide identifying information about the cryptographic
27593 context.
27594
27595 This should have meant that certificate identity and verification becomes a
27596 non-issue, as a man-in-the-middle attack will cause the correct client and
27597 server to see different identifiers and authentication will fail.
27598
27599 .new
27600 This is
27601 only usable by mechanisms which support "channel binding"; at time of
27602 writing, that's the SCRAM family.
27603 When using this feature the "-PLUS" variants of the method names need to be used.
27604 .wen
27605
27606 This defaults off to ensure smooth upgrade across Exim releases, in case
27607 this option causes some clients to start failing.  Some future release
27608 of Exim might have switched the default to be true.
27609
27610 However, Channel Binding in TLS has proven to be vulnerable in current versions.
27611 Do not plan to rely upon this feature for security, ever, without consulting
27612 with a subject matter expert (a cryptographic engineer).
27613
27614
27615 .option server_hostname gsasl string&!! "see below"
27616 This option selects the hostname that is used when communicating with the
27617 library. The default value is &`$primary_hostname`&.
27618 Some mechanisms will use this data.
27619
27620
27621 .option server_mech gsasl string "see below"
27622 This option selects the authentication mechanism this driver should use. The
27623 default is the value of the generic &%public_name%& option. This option allows
27624 you to use a different underlying mechanism from the advertised name. For
27625 example:
27626 .code
27627 sasl:
27628   driver = gsasl
27629   public_name = X-ANYTHING
27630   server_mech = CRAM-MD5
27631   server_set_id = $auth1
27632 .endd
27633
27634
27635 .option server_password gsasl string&!! unset
27636 Various mechanisms need access to the cleartext password on the server, so
27637 that proof-of-possession can be demonstrated on the wire, without sending
27638 the password itself.
27639
27640 The data available for lookup varies per mechanism.
27641 In all cases, &$auth1$& is set to the &'authentication id'&.
27642 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27643 if available, else the empty string.
27644 The &$auth3$& variable will always be the &'realm'& if available,
27645 else the empty string.
27646
27647 A forced failure will cause authentication to defer.
27648
27649 If using this option, it may make sense to set the &%server_condition%&
27650 option to be simply "true".
27651
27652
27653 .option server_realm gsasl string&!! unset
27654 This specifies the SASL realm that the server claims to be in.
27655 Some mechanisms will use this data.
27656
27657
27658 .option server_scram_iter gsasl string&!! 4096
27659 This option provides data for the SCRAM family of mechanisms.
27660 .new
27661 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27662 when this option is expanded.
27663
27664 The result of expansion should be a decimal number,
27665 and represents both a lower-bound on the security, and
27666 a compute cost factor imposed on the client
27667 (if it does not cache results, or the server changes
27668 either the iteration count or the salt).
27669 A minimum value of 4096 is required by the standards
27670 for all current SCRAM mechanism variants.
27671 .wen
27672
27673 .option server_scram_salt gsasl string&!! unset
27674 This option provides data for the SCRAM family of mechanisms.
27675 .new
27676 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
27677 when this option is expanded.
27678 The value should be a base64-encoded string,
27679 of random data typically 4-to-16 bytes long.
27680 If unset or empty after expansion the library will provides a value for the
27681 protocol conversation.
27682 .wen
27683
27684
27685 .new
27686 .option server_key gsasl string&!! unset
27687 .option server_skey gsasl string&!! unset
27688 These options can be used for the SCRAM family of mechanisms
27689 to provide stored information related to a password,
27690 the storage of which is preferable to plaintext.
27691
27692 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
27693 &%server_skey%& is StoredKey.
27694
27695 They are only available for version 1.9.0 (or later) of the gsasl library.
27696 When this is so, the macros
27697 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
27698 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
27699 will be defined.
27700
27701 The &$authN$& variables are available when these options are expanded.
27702
27703 If set, the results of expansion should for each
27704 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
27705 of base64-coded data, and will be used in preference to the
27706 &%server_password%& option.
27707 If unset or not of the right length, &%server_password%& will be used.
27708
27709 The libgsasl library release includes a utility &'gsasl'& which can be used
27710 to generate these values.
27711 .wen
27712
27713
27714 .option server_service gsasl string &`smtp`&
27715 This is the SASL service that the server claims to implement.
27716 Some mechanisms will use this data.
27717
27718
27719 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27720 .vindex "&$auth1$&, &$auth2$&, etc"
27721 These may be set when evaluating specific options, as detailed above.
27722 They will also be set when evaluating &%server_condition%&.
27723
27724 Unless otherwise stated below, the &(gsasl)& integration will use the following
27725 meanings for these variables:
27726
27727 .ilist
27728 .vindex "&$auth1$&"
27729 &$auth1$&: the &'authentication id'&
27730 .next
27731 .vindex "&$auth2$&"
27732 &$auth2$&: the &'authorization id'&
27733 .next
27734 .vindex "&$auth3$&"
27735 &$auth3$&: the &'realm'&
27736 .endlist
27737
27738 On a per-mechanism basis:
27739
27740 .ilist
27741 .cindex "authentication" "EXTERNAL"
27742 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27743 the &%server_condition%& option must be present.
27744 .next
27745 .cindex "authentication" "ANONYMOUS"
27746 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27747 the &%server_condition%& option must be present.
27748 .next
27749 .cindex "authentication" "GSSAPI"
27750 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27751 &$auth2$& will be set to the &'authorization id'&,
27752 the &%server_condition%& option must be present.
27753 .endlist
27754
27755 An &'anonymous token'& is something passed along as an unauthenticated
27756 identifier; this is analogous to FTP anonymous authentication passing an
27757 email address, or software-identifier@, as the "password".
27758
27759
27760 An example showing the password having the realm specified in the callback
27761 and demonstrating a Cyrus SASL to GSASL migration approach is:
27762 .code
27763 gsasl_cyrusless_crammd5:
27764   driver = gsasl
27765   public_name = CRAM-MD5
27766   server_realm = imap.example.org
27767   server_password = ${lookup{$auth1:$auth3:userPassword}\
27768                     dbmjz{/etc/sasldb2}{$value}fail}
27769   server_set_id = ${quote:$auth1}
27770   server_condition = yes
27771 .endd
27772
27773
27774 . ////////////////////////////////////////////////////////////////////////////
27775 . ////////////////////////////////////////////////////////////////////////////
27776
27777 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27778 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27779 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27780 .cindex "authentication" "GSSAPI"
27781 .cindex "authentication" "Kerberos"
27782 The &(heimdal_gssapi)& authenticator provides server integration for the
27783 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27784 reliably.
27785
27786 .option server_hostname heimdal_gssapi string&!! "see below"
27787 This option selects the hostname that is used, with &%server_service%&,
27788 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27789 identifier.  The default value is &`$primary_hostname`&.
27790
27791 .option server_keytab heimdal_gssapi string&!! unset
27792 If set, then Heimdal will not use the system default keytab (typically
27793 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27794 The value should be a pathname, with no &"file:"& prefix.
27795
27796 .option server_service heimdal_gssapi string&!! "smtp"
27797 This option specifies the service identifier used, in conjunction with
27798 &%server_hostname%&, for building the identifier for finding credentials
27799 from the keytab.
27800
27801
27802 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27803 Beware that these variables will typically include a realm, thus will appear
27804 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27805 not verified, so a malicious client can set it to anything.
27806
27807 The &$auth1$& field should be safely trustable as a value from the Key
27808 Distribution Center.  Note that these are not quite email addresses.
27809 Each identifier is for a role, and so the left-hand-side may include a
27810 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27811
27812 .vindex "&$auth1$&, &$auth2$&, etc"
27813 .ilist
27814 .vindex "&$auth1$&"
27815 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27816 .next
27817 .vindex "&$auth2$&"
27818 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27819 authentication.  If that was empty, this will also be set to the
27820 GSS Display Name.
27821 .endlist
27822
27823
27824 . ////////////////////////////////////////////////////////////////////////////
27825 . ////////////////////////////////////////////////////////////////////////////
27826
27827 .chapter "The spa authenticator" "CHAPspa"
27828 .scindex IIDspaauth1 "&(spa)& authenticator"
27829 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27830 .cindex "authentication" "Microsoft Secure Password"
27831 .cindex "authentication" "NTLM"
27832 .cindex "Microsoft Secure Password Authentication"
27833 .cindex "NTLM authentication"
27834 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27835 Password Authentication'& mechanism,
27836 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27837 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27838 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27839 server side was subsequently contributed by Tom Kistner. The mechanism works as
27840 follows:
27841
27842 .ilist
27843 After the AUTH command has been accepted, the client sends an SPA
27844 authentication request based on the user name and optional domain.
27845 .next
27846 The server sends back a challenge.
27847 .next
27848 The client builds a challenge response which makes use of the user's password
27849 and sends it to the server, which then accepts or rejects it.
27850 .endlist
27851
27852 Encryption is used to protect the password in transit.
27853
27854
27855
27856 .section "Using spa as a server" "SECID179"
27857 .cindex "options" "&(spa)& authenticator (server)"
27858 The &(spa)& authenticator has just one server option:
27859
27860 .option server_password spa string&!! unset
27861 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27862 This option is expanded, and the result must be the cleartext password for the
27863 authenticating user, whose name is at this point in &$auth1$&. For
27864 compatibility with previous releases of Exim, the user name is also placed in
27865 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27866 it can lead to confusion in string expansions that also use numeric variables
27867 for other things. For example:
27868 .code
27869 spa:
27870   driver = spa
27871   public_name = NTLM
27872   server_password = \
27873     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27874 .endd
27875 If the expansion is forced to fail, authentication fails. Any other expansion
27876 failure causes a temporary error code to be returned.
27877
27878
27879
27880
27881
27882 .section "Using spa as a client" "SECID180"
27883 .cindex "options" "&(spa)& authenticator (client)"
27884 The &(spa)& authenticator has the following client options:
27885
27886
27887
27888 .option client_domain spa string&!! unset
27889 This option specifies an optional domain for the authentication.
27890
27891
27892 .option client_password spa string&!! unset
27893 This option specifies the user's password, and must be set.
27894
27895
27896 .option client_username spa string&!! unset
27897 This option specifies the user name, and must be set. Here is an example of a
27898 configuration of this authenticator for use with the mail servers at
27899 &'msn.com'&:
27900 .code
27901 msn:
27902   driver = spa
27903   public_name = MSN
27904   client_username = msn/msn_username
27905   client_password = msn_plaintext_password
27906   client_domain = DOMAIN_OR_UNSET
27907 .endd
27908 .ecindex IIDspaauth1
27909 .ecindex IIDspaauth2
27910
27911
27912
27913
27914
27915 . ////////////////////////////////////////////////////////////////////////////
27916 . ////////////////////////////////////////////////////////////////////////////
27917
27918 .chapter "The external authenticator" "CHAPexternauth"
27919 .scindex IIDexternauth1 "&(external)& authenticator"
27920 .scindex IIDexternauth2 "authenticators" "&(external)&"
27921 .cindex "authentication" "Client Certificate"
27922 .cindex "authentication" "X509"
27923 .cindex "Certificate-based authentication"
27924 The &(external)& authenticator provides support for
27925 authentication based on non-SMTP information.
27926 The specification is in RFC 4422 Appendix A
27927 (&url(https://tools.ietf.org/html/rfc4422)).
27928 It is only a transport and negotiation mechanism;
27929 the process of authentication is entirely controlled
27930 by the server configuration.
27931
27932 The client presents an identity in-clear.
27933 It is probably wise for a server to only advertise,
27934 and for clients to only attempt,
27935 this authentication method on a secure (eg. under TLS) connection.
27936
27937 One possible use, compatible with the
27938 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27939 is for using X509 client certificates.
27940
27941 It thus overlaps in function with the TLS authenticator
27942 (see &<<CHAPtlsauth>>&)
27943 but is a full SMTP SASL authenticator
27944 rather than being implicit for TLS-connection carried
27945 client certificates only.
27946
27947 The examples and discussion in this chapter assume that
27948 client-certificate authentication is being done.
27949
27950 The client must present a certificate,
27951 for which it must have been requested via the
27952 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27953 (see &<<CHAPTLS>>&).
27954 For authentication to be effective the certificate should be
27955 verifiable against a trust-anchor certificate known to the server.
27956
27957 .section "External options" "SECTexternsoptions"
27958 .cindex "options" "&(external)& authenticator (server)"
27959 The &(external)& authenticator has two server options:
27960
27961 .option server_param2 external string&!! unset
27962 .option server_param3 external string&!! unset
27963 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27964 These options are expanded before the &%server_condition%& option
27965 and the result are placed in &$auth2$& and &$auth3$& resectively.
27966 If the expansion is forced to fail, authentication fails. Any other expansion
27967 failure causes a temporary error code to be returned.
27968
27969 They can be used to clarify the coding of a complex &%server_condition%&.
27970
27971 .section "Using external in a server" "SECTexternserver"
27972 .cindex "AUTH" "in &(external)& authenticator"
27973 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27974         "in &(external)& authenticator"
27975 .vindex "&$auth1$&, &$auth2$&, etc"
27976 .cindex "base64 encoding" "in &(external)& authenticator"
27977
27978 When running as a server, &(external)& performs the authentication test by
27979 expanding a string. The data sent by the client with the AUTH command, or in
27980 response to subsequent prompts, is base64 encoded, and so may contain any byte
27981 values when decoded. The decoded value is treated as
27982 an identity for authentication and
27983 placed in the expansion variable &$auth1$&.
27984
27985 For compatibility with previous releases of Exim, the value is also placed in
27986 the expansion variable &$1$&. However, the use of this
27987 variable for this purpose is now deprecated, as it can lead to confusion in
27988 string expansions that also use them for other things.
27989
27990 .vindex "&$authenticated_id$&"
27991 Once an identity has been received,
27992 &%server_condition%& is expanded. If the expansion is forced to fail,
27993 authentication fails. Any other expansion failure causes a temporary error code
27994 to be returned. If the result of a successful expansion is an empty string,
27995 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27996 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27997 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27998 For any other result, a temporary error code is returned, with the expanded
27999 string as the error text.
28000
28001 Example:
28002 .code
28003 ext_ccert_san_mail:
28004   driver =            external
28005   public_name =       EXTERNAL
28006
28007   server_advertise_condition = $tls_in_certificate_verified
28008   server_param2 =     ${certextract {subj_altname,mail,>:} \
28009                                     {$tls_in_peercert}}
28010   server_condition =  ${if forany {$auth2} \
28011                             {eq {$item}{$auth1}}}
28012   server_set_id =     $auth1
28013 .endd
28014 This accepts a client certificate that is verifiable against any
28015 of your configured trust-anchors
28016 (which usually means the full set of public CAs)
28017 and which has a mail-SAN matching the claimed identity sent by the client.
28018
28019 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28020 The account name is therefore guessable by an opponent.
28021 TLS 1.3 protects both server and client certificates, and is not vulnerable
28022 in this way.
28023
28024
28025 .section "Using external in a client" "SECTexternclient"
28026 .cindex "options" "&(external)& authenticator (client)"
28027 The &(external)& authenticator has one client option:
28028
28029 .option client_send external string&!! unset
28030 This option is expanded and sent with the AUTH command as the
28031 identity being asserted.
28032
28033 Example:
28034 .code
28035 ext_ccert:
28036   driver =      external
28037   public_name = EXTERNAL
28038
28039   client_condition = ${if !eq{$tls_out_cipher}{}}
28040   client_send = myaccount@smarthost.example.net
28041 .endd
28042
28043
28044 .ecindex IIDexternauth1
28045 .ecindex IIDexternauth2
28046
28047
28048
28049
28050
28051 . ////////////////////////////////////////////////////////////////////////////
28052 . ////////////////////////////////////////////////////////////////////////////
28053
28054 .chapter "The tls authenticator" "CHAPtlsauth"
28055 .scindex IIDtlsauth1 "&(tls)& authenticator"
28056 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28057 .cindex "authentication" "Client Certificate"
28058 .cindex "authentication" "X509"
28059 .cindex "Certificate-based authentication"
28060 The &(tls)& authenticator provides server support for
28061 authentication based on client certificates.
28062
28063 It is not an SMTP authentication mechanism and is not
28064 advertised by the server as part of the SMTP EHLO response.
28065 It is an Exim authenticator in the sense that it affects
28066 the protocol element of the log line, can be tested for
28067 by the &%authenticated%& ACL condition, and can set
28068 the &$authenticated_id$& variable.
28069
28070 The client must present a verifiable certificate,
28071 for which it must have been requested via the
28072 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28073 (see &<<CHAPTLS>>&).
28074
28075 If an authenticator of this type is configured it is
28076 run before any SMTP-level communication is done,
28077 and can authenticate the connection.
28078 If it does, SMTP authentication is not offered.
28079
28080 A maximum of one authenticator of this type may be present.
28081
28082
28083 .cindex "options" "&(tls)& authenticator (server)"
28084 The &(tls)& authenticator has three server options:
28085
28086 .option server_param1 tls string&!! unset
28087 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28088 This option is expanded after the TLS negotiation and
28089 the result is placed in &$auth1$&.
28090 If the expansion is forced to fail, authentication fails. Any other expansion
28091 failure causes a temporary error code to be returned.
28092
28093 .option server_param2 tls string&!! unset
28094 .option server_param3 tls string&!! unset
28095 As above, for &$auth2$& and &$auth3$&.
28096
28097 &%server_param1%& may also be spelled &%server_param%&.
28098
28099
28100 Example:
28101 .code
28102 tls:
28103   driver = tls
28104   server_param1 =     ${certextract {subj_altname,mail,>:} \
28105                                     {$tls_in_peercert}}
28106   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28107                                  {forany {$auth1} \
28108                             {!= {0} \
28109                                 {${lookup ldap{ldap:///\
28110                          mailname=${quote_ldap_dn:${lc:$item}},\
28111                          ou=users,LDAP_DC?mailid} {$value}{0} \
28112                        }    }  } }}}
28113   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28114 .endd
28115 This accepts a client certificate that is verifiable against any
28116 of your configured trust-anchors
28117 (which usually means the full set of public CAs)
28118 and which has a SAN with a good account name.
28119
28120 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28121 The account name is therefore guessable by an opponent.
28122 TLS 1.3 protects both server and client certificates, and is not vulnerable
28123 in this way.
28124 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28125
28126 . An alternative might use
28127 . .code
28128 .   server_param1 = ${sha256:$tls_in_peercert}
28129 . .endd
28130 . to require one of a set of specific certs that define a given account
28131 . (the verification is still required, but mostly irrelevant).
28132 . This would help for per-device use.
28133 .
28134 . However, for the future we really need support for checking a
28135 . user cert in LDAP - which probably wants a base-64 DER.
28136
28137 .ecindex IIDtlsauth1
28138 .ecindex IIDtlsauth2
28139
28140
28141 Note that because authentication is traditionally an SMTP operation,
28142 the &%authenticated%& ACL condition cannot be used in
28143 a connect- or helo-ACL.
28144
28145
28146
28147 . ////////////////////////////////////////////////////////////////////////////
28148 . ////////////////////////////////////////////////////////////////////////////
28149
28150 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28151          "Encrypted SMTP connections"
28152 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28153 .scindex IIDencsmtp2 "SMTP" "encryption"
28154 .cindex "TLS" "on SMTP connection"
28155 .cindex "OpenSSL"
28156 .cindex "GnuTLS"
28157 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28158 Sockets Layer), is implemented by making use of the OpenSSL library or the
28159 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28160 cryptographic code in the Exim distribution itself for implementing TLS. In
28161 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28162 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28163 You also need to understand the basic concepts of encryption at a managerial
28164 level, and in particular, the way that public keys, private keys, and
28165 certificates are used.
28166
28167 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28168 connection is established, the client issues a STARTTLS command. If the
28169 server accepts this, the client and the server negotiate an encryption
28170 mechanism. If the negotiation succeeds, the data that subsequently passes
28171 between them is encrypted.
28172
28173 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28174 and if so, what cipher suite is in use, whether the client supplied a
28175 certificate, and whether or not that certificate was verified. This makes it
28176 possible for an Exim server to deny or accept certain commands based on the
28177 encryption state.
28178
28179 &*Warning*&: Certain types of firewall and certain anti-virus products can
28180 disrupt TLS connections. You need to turn off SMTP scanning for these products
28181 in order to get TLS to work.
28182
28183
28184
28185 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28186          "SECID284"
28187 .cindex "submissions protocol"
28188 .cindex "ssmtp protocol"
28189 .cindex "smtps protocol"
28190 .cindex "SMTP" "submissions protocol"
28191 .cindex "SMTP" "ssmtp protocol"
28192 .cindex "SMTP" "smtps protocol"
28193 The history of port numbers for TLS in SMTP is a little messy and has been
28194 contentious.  As of RFC 8314, the common practice of using the historically
28195 allocated port 465 for "email submission but with TLS immediately upon connect
28196 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28197 by them in preference to STARTTLS.
28198
28199 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28200 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28201 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28202
28203 This approach was, for a while, officially abandoned when encrypted SMTP was
28204 standardized, but many clients kept using it, even as the TCP port number was
28205 reassigned for other use.
28206 Thus you may encounter guidance claiming that you shouldn't enable use of
28207 this port.
28208 In practice, a number of mail-clients have only ever supported submissions,
28209 not submission with STARTTLS upgrade.
28210 Ideally, offer both submission (587) and submissions (465) service.
28211
28212 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28213 global option. Its value must be a list of port numbers;
28214 the most common use is expected to be:
28215 .code
28216 tls_on_connect_ports = 465
28217 .endd
28218 The port numbers specified by this option apply to all SMTP connections, both
28219 via the daemon and via &'inetd'&. You still need to specify all the ports that
28220 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28221 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28222 an extra port &-- rather, it specifies different behaviour on a port that is
28223 defined elsewhere.
28224
28225 There is also a &%-tls-on-connect%& command line option. This overrides
28226 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28227
28228
28229
28230
28231
28232
28233 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28234 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28235 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28236 To build Exim to use OpenSSL you need to set
28237 .code
28238 USE_OPENSSL=yes
28239 .endd
28240 in Local/Makefile.
28241
28242 To build Exim to use GnuTLS, you need to set
28243 .code
28244 USE_GNUTLS=yes
28245 .endd
28246 in Local/Makefile.
28247
28248 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28249 include files and libraries for GnuTLS can be found.
28250
28251 There are some differences in usage when using GnuTLS instead of OpenSSL:
28252
28253 .ilist
28254 The &%tls_verify_certificates%& option
28255 cannot be the path of a directory
28256 for GnuTLS versions before 3.3.6
28257 (for later versions, or OpenSSL, it can be either).
28258 .next
28259 The default value for &%tls_dhparam%& differs for historical reasons.
28260 .next
28261 .vindex "&$tls_in_peerdn$&"
28262 .vindex "&$tls_out_peerdn$&"
28263 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28264 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28265 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28266 .next
28267 OpenSSL identifies cipher suites using hyphens as separators, for example:
28268 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28269 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28270 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28271 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28272 to handle its own older variants) when processing lists of cipher suites in the
28273 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28274 option).
28275 .next
28276 The &%tls_require_ciphers%& options operate differently, as described in the
28277 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28278 .next
28279 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28280 When using OpenSSL, this option is ignored.
28281 (If an API is found to let OpenSSL be configured in this way,
28282 let the Exim Maintainers know and we'll likely use it).
28283 .next
28284 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28285 main option, it must be ordered to match the &%tls_certificate%& list.
28286 .next
28287 Some other recently added features may only be available in one or the other.
28288 This should be documented with the feature.  If the documentation does not
28289 explicitly state that the feature is infeasible in the other TLS
28290 implementation, then patches are welcome.
28291 .endlist
28292
28293
28294 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28295 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28296 an explicit path; if the latter, then the text about generation still applies,
28297 but not the chosen filename.
28298 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28299 See the documentation of &%tls_dhparam%& for more information.
28300
28301 GnuTLS uses D-H parameters that may take a substantial amount of time
28302 to compute. It is unreasonable to re-compute them for every TLS session.
28303 Therefore, Exim keeps this data in a file in its spool directory, called
28304 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28305 of bits requested.
28306 The file is owned by the Exim user and is readable only by
28307 its owner. Every Exim process that start up GnuTLS reads the D-H
28308 parameters from this file. If the file does not exist, the first Exim process
28309 that needs it computes the data and writes it to a temporary file which is
28310 renamed once it is complete. It does not matter if several Exim processes do
28311 this simultaneously (apart from wasting a few resources). Once a file is in
28312 place, new Exim processes immediately start using it.
28313
28314 For maximum security, the parameters that are stored in this file should be
28315 recalculated periodically, the frequency depending on your paranoia level.
28316 If you are avoiding using the fixed D-H primes published in RFCs, then you
28317 are concerned about some advanced attacks and will wish to do this; if you do
28318 not regenerate then you might as well stick to the standard primes.
28319
28320 Arranging this is easy in principle; just delete the file when you want new
28321 values to be computed. However, there may be a problem. The calculation of new
28322 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28323 If the system is not very active, &_/dev/random_& may delay returning data
28324 until enough randomness (entropy) is available. This may cause Exim to hang for
28325 a substantial amount of time, causing timeouts on incoming connections.
28326
28327 The solution is to generate the parameters externally to Exim. They are stored
28328 in &_gnutls-params-N_& in PEM format, which means that they can be
28329 generated externally using the &(certtool)& command that is part of GnuTLS.
28330
28331 To replace the parameters with new ones, instead of deleting the file
28332 and letting Exim re-create it, you can generate new parameters using
28333 &(certtool)& and, when this has been done, replace Exim's cache file by
28334 renaming. The relevant commands are something like this:
28335 .code
28336 # ls
28337 [ look for file; assume gnutls-params-2236 is the most recent ]
28338 # rm -f new-params
28339 # touch new-params
28340 # chown exim:exim new-params
28341 # chmod 0600 new-params
28342 # certtool --generate-dh-params --bits 2236 >>new-params
28343 # openssl dhparam -noout -text -in new-params | head
28344 [ check the first line, make sure it's not more than 2236;
28345   if it is, then go back to the start ("rm") and repeat
28346   until the size generated is at most the size requested ]
28347 # chmod 0400 new-params
28348 # mv new-params gnutls-params-2236
28349 .endd
28350 If Exim never has to generate the parameters itself, the possibility of
28351 stalling is removed.
28352
28353 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28354 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28355 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28356 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28357 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28358 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28359 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28360 which applies to all D-H usage, client or server.  If the value returned by
28361 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28362 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28363 limit, which is still much higher than Exim historically used.
28364
28365 The filename and bits used will change as the GnuTLS maintainers change the
28366 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28367 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28368 2432 bits, while NSS is limited to 2236 bits.
28369
28370 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28371 increase the chance of the generated prime actually being within acceptable
28372 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28373 procedure above.  There is no sane procedure available to Exim to double-check
28374 the size of the generated prime, so it might still be too large.
28375
28376
28377 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28378 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28379 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28380 There is a function in the OpenSSL library that can be passed a list of cipher
28381 suites before the cipher negotiation takes place. This specifies which ciphers
28382 are acceptable for TLS versions prior to 1.3.
28383 The list is colon separated and may contain names like
28384 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28385 directly to this function call.
28386 Many systems will install the OpenSSL manual-pages, so you may have
28387 &'ciphers(1)'& available to you.
28388 The following quotation from the OpenSSL
28389 documentation specifies what forms of item are allowed in the cipher string:
28390
28391 .ilist
28392 It can consist of a single cipher suite such as RC4-SHA.
28393 .next
28394 It can represent a list of cipher suites containing a certain algorithm,
28395 or cipher suites of a certain type. For example SHA1 represents all
28396 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28397 SSL v3 algorithms.
28398 .next
28399 Lists of cipher suites can be combined in a single cipher string using
28400 the + character. This is used as a logical and operation. For example
28401 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28402 algorithms.
28403 .endlist
28404
28405 Each cipher string can be optionally preceded by one of the characters &`!`&,
28406 &`-`& or &`+`&.
28407 .ilist
28408 If &`!`& is used, the ciphers are permanently deleted from the list. The
28409 ciphers deleted can never reappear in the list even if they are explicitly
28410 stated.
28411 .next
28412 If &`-`& is used, the ciphers are deleted from the list, but some or all
28413 of the ciphers can be added again by later options.
28414 .next
28415 If &`+`& is used, the ciphers are moved to the end of the list. This
28416 option does not add any new ciphers; it just moves matching existing ones.
28417 .endlist
28418
28419 If none of these characters is present, the string is interpreted as
28420 a list of ciphers to be appended to the current preference list. If the list
28421 includes any ciphers already present they will be ignored: that is, they will
28422 not be moved to the end of the list.
28423 .endlist
28424
28425 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28426 string:
28427 .code
28428 # note single-quotes to get ! past any shell history expansion
28429 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28430 .endd
28431
28432 This example will let the library defaults be permitted on the MX port, where
28433 there's probably no identity verification anyway, but ups the ante on the
28434 submission ports where the administrator might have some influence on the
28435 choice of clients used:
28436 .code
28437 # OpenSSL variant; see man ciphers(1)
28438 tls_require_ciphers = ${if =={$received_port}{25}\
28439                            {DEFAULT}\
28440                            {HIGH:!MD5:!SHA1}}
28441 .endd
28442
28443 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28444 .code
28445 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28446 .endd
28447
28448 For TLS version 1.3 the control available is less fine-grained
28449 and Exim does not provide access to it at present.
28450 The value of the &%tls_require_ciphers%& option is ignored when
28451 TLS version 1.3 is negotiated.
28452
28453 As of writing the library default cipher suite list for TLSv1.3 is
28454 .code
28455 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28456 .endd
28457
28458
28459 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28460          "SECTreqciphgnu"
28461 .cindex "GnuTLS" "specifying parameters for"
28462 .cindex "TLS" "specifying ciphers (GnuTLS)"
28463 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28464 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28465 .cindex "TLS" "specifying protocols (GnuTLS)"
28466 .cindex "TLS" "specifying priority string (GnuTLS)"
28467 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28468 The GnuTLS library allows the caller to provide a "priority string", documented
28469 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28470 ciphersuite specification in OpenSSL.
28471
28472 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28473 and controls both protocols and ciphers.
28474
28475 The &%tls_require_ciphers%& option is available both as an global option,
28476 controlling how Exim behaves as a server, and also as an option of the
28477 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28478 the value is string expanded.  The resulting string is not an Exim list and
28479 the string is given to the GnuTLS library, so that Exim does not need to be
28480 aware of future feature enhancements of GnuTLS.
28481
28482 Documentation of the strings accepted may be found in the GnuTLS manual, under
28483 "Priority strings".  This is online as
28484 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28485 but beware that this relates to GnuTLS 3, which may be newer than the version
28486 installed on your system.  If you are using GnuTLS 3,
28487 then the example code
28488 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28489 on that site can be used to test a given string.
28490
28491 For example:
28492 .code
28493 # Disable older versions of protocols
28494 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28495 .endd
28496
28497 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28498 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28499 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28500
28501 This example will let the library defaults be permitted on the MX port, where
28502 there's probably no identity verification anyway, and lowers security further
28503 by increasing compatibility; but this ups the ante on the submission ports
28504 where the administrator might have some influence on the choice of clients
28505 used:
28506 .code
28507 # GnuTLS variant
28508 tls_require_ciphers = ${if =={$received_port}{25}\
28509                            {NORMAL:%COMPAT}\
28510                            {SECURE128}}
28511 .endd
28512
28513
28514 .section "Configuring an Exim server to use TLS" "SECID182"
28515 .cindex "TLS" "configuring an Exim server"
28516 When Exim has been built with TLS support, it advertises the availability of
28517 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28518 but not to any others. The default value of this option is *, which means
28519 that STARTTLS is always advertised.  Set it to blank to never advertise;
28520 this is reasonable for systems that want to use TLS only as a client.
28521
28522 If STARTTLS is to be used you
28523 need to set some other options in order to make TLS available.
28524
28525 If a client issues a STARTTLS command and there is some configuration
28526 problem in the server, the command is rejected with a 454 error. If the client
28527 persists in trying to issue SMTP commands, all except QUIT are rejected
28528 with the error
28529 .code
28530 554 Security failure
28531 .endd
28532 If a STARTTLS command is issued within an existing TLS session, it is
28533 rejected with a 554 error code.
28534
28535 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28536 must be set to match some hosts. The default is * which matches all hosts.
28537
28538 If this is all you do, TLS encryption will be enabled but not authentication -
28539 meaning that the peer has no assurance it is actually you he is talking to.
28540 You gain protection from a passive sniffer listening on the wire but not
28541 from someone able to intercept the communication.
28542
28543 Further protection requires some further configuration at the server end.
28544
28545 To make TLS work you need to set, in the server,
28546 .code
28547 tls_certificate = /some/file/name
28548 tls_privatekey = /some/file/name
28549 .endd
28550 These options are, in fact, expanded strings, so you can make them depend on
28551 the identity of the client that is connected if you wish. The first file
28552 contains the server's X509 certificate, and the second contains the private key
28553 that goes with it. These files need to be
28554 PEM format and readable by the Exim user, and must
28555 always be given as full path names.
28556 The key must not be password-protected.
28557 They can be the same file if both the
28558 certificate and the key are contained within it. If &%tls_privatekey%& is not
28559 set, or if its expansion is forced to fail or results in an empty string, this
28560 is assumed to be the case. The certificate file may also contain intermediate
28561 certificates that need to be sent to the client to enable it to authenticate
28562 the server's certificate.
28563
28564 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28565 colon-separated lists of file paths.  Ciphers using given authentication
28566 algorithms require the presence of a suitable certificate to supply the
28567 public-key.  The server selects among the certificates to present to the
28568 client depending on the selected cipher, hence the priority ordering for
28569 ciphers will affect which certificate is used.
28570
28571 If you do not understand about certificates and keys, please try to find a
28572 source of this background information, which is not Exim-specific. (There are a
28573 few comments below in section &<<SECTcerandall>>&.)
28574
28575 &*Note*&: These options do not apply when Exim is operating as a client &--
28576 they apply only in the case of a server. If you need to use a certificate in an
28577 Exim client, you must set the options of the same names in an &(smtp)&
28578 transport.
28579
28580 With just these options, an Exim server will be able to use TLS. It does not
28581 require the client to have a certificate (but see below for how to insist on
28582 this). There is one other option that may be needed in other situations. If
28583 .code
28584 tls_dhparam = /some/file/name
28585 .endd
28586 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28587 with the parameters contained in the file.
28588 Set this to &`none`& to disable use of DH entirely, by making no prime
28589 available:
28590 .code
28591 tls_dhparam = none
28592 .endd
28593 This may also be set to a string identifying a standard prime to be used for
28594 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28595 used is &`ike23`&.  There are a few standard primes available, see the
28596 documentation for &%tls_dhparam%& for the complete list.
28597
28598 See the command
28599 .code
28600 openssl dhparam
28601 .endd
28602 for a way of generating file data.
28603
28604 The strings supplied for these three options are expanded every time a client
28605 host connects. It is therefore possible to use different certificates and keys
28606 for different hosts, if you so wish, by making use of the client's IP address
28607 in &$sender_host_address$& to control the expansion. If a string expansion is
28608 forced to fail, Exim behaves as if the option is not set.
28609
28610 .cindex "cipher" "logging"
28611 .cindex "log" "TLS cipher"
28612 .vindex "&$tls_in_cipher$&"
28613 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28614 an incoming TLS connection. It is included in the &'Received:'& header of an
28615 incoming message (by default &-- you can, of course, change this), and it is
28616 also included in the log line that records a message's arrival, keyed by
28617 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28618 condition can be used to test for specific cipher suites in ACLs.
28619
28620 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28621 can check the name of the cipher suite and vary their actions accordingly. The
28622 cipher suite names vary, depending on which TLS library is being used. For
28623 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28624 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28625 documentation for more details.
28626
28627 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28628 (again depending on the &%tls_cipher%& log selector).
28629
28630
28631 .section "Requesting and verifying client certificates" "SECID183"
28632 .cindex "certificate" "verification of client"
28633 .cindex "TLS" "client certificate verification"
28634 If you want an Exim server to request a certificate when negotiating a TLS
28635 session with a client, you must set either &%tls_verify_hosts%& or
28636 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28637 apply to all TLS connections. For any host that matches one of these options,
28638 Exim requests a certificate as part of the setup of the TLS session. The
28639 contents of the certificate are verified by comparing it with a list of
28640 expected trust-anchors or certificates.
28641 These may be the system default set (depending on library version),
28642 an explicit file or,
28643 depending on library version, a directory, identified by
28644 &%tls_verify_certificates%&.
28645
28646 A file can contain multiple certificates, concatenated end to end. If a
28647 directory is used
28648 (OpenSSL only),
28649 each certificate must be in a separate file, with a name (or a symbolic link)
28650 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28651 certificate. You can compute the relevant hash by running the command
28652 .code
28653 openssl x509 -hash -noout -in /cert/file
28654 .endd
28655 where &_/cert/file_& contains a single certificate.
28656
28657 There is no checking of names of the client against the certificate
28658 Subject Name or Subject Alternate Names.
28659
28660 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28661 what happens if the client does not supply a certificate, or if the certificate
28662 does not match any of the certificates in the collection named by
28663 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28664 attempt to set up a TLS session is aborted, and the incoming connection is
28665 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28666 session continues. ACLs that run for subsequent SMTP commands can detect the
28667 fact that no certificate was verified, and vary their actions accordingly. For
28668 example, you can insist on a certificate before accepting a message for
28669 relaying, but not when the message is destined for local delivery.
28670
28671 .vindex "&$tls_in_peerdn$&"
28672 When a client supplies a certificate (whether it verifies or not), the value of
28673 the Distinguished Name of the certificate is made available in the variable
28674 &$tls_in_peerdn$& during subsequent processing of the message.
28675
28676 .cindex "log" "distinguished name"
28677 Because it is often a long text string, it is not included in the log line or
28678 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28679 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28680 &%received_header_text%& to change the &'Received:'& header. When no
28681 certificate is supplied, &$tls_in_peerdn$& is empty.
28682
28683
28684 .section "Revoked certificates" "SECID184"
28685 .cindex "TLS" "revoked certificates"
28686 .cindex "revocation list"
28687 .cindex "certificate" "revocation list"
28688 .cindex "OCSP" "stapling"
28689 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28690 certificates are revoked. If you have such a list, you can pass it to an Exim
28691 server using the global option called &%tls_crl%& and to an Exim client using
28692 an identically named option for the &(smtp)& transport. In each case, the value
28693 of the option is expanded and must then be the name of a file that contains a
28694 CRL in PEM format.
28695 The downside is that clients have to periodically re-download a potentially huge
28696 file from every certificate authority they know of.
28697
28698 The way with most moving parts at query time is Online Certificate
28699 Status Protocol (OCSP), where the client verifies the certificate
28700 against an OCSP server run by the CA.  This lets the CA track all
28701 usage of the certs.  It requires running software with access to the
28702 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28703 is based on HTTP and can be proxied accordingly.
28704
28705 The only widespread OCSP server implementation (known to this writer)
28706 comes as part of OpenSSL and aborts on an invalid request, such as
28707 connecting to the port and then disconnecting.  This requires
28708 re-entering the passphrase each time some random client does this.
28709
28710 The third way is OCSP Stapling; in this, the server using a certificate
28711 issued by the CA periodically requests an OCSP proof of validity from
28712 the OCSP server, then serves it up inline as part of the TLS
28713 negotiation.   This approach adds no extra round trips, does not let the
28714 CA track users, scales well with number of certs issued by the CA and is
28715 resilient to temporary OCSP server failures, as long as the server
28716 starts retrying to fetch an OCSP proof some time before its current
28717 proof expires.  The downside is that it requires server support.
28718
28719 Unless Exim is built with the support disabled,
28720 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28721 support for OCSP stapling is included.
28722
28723 There is a global option called &%tls_ocsp_file%&.
28724 The file specified therein is expected to be in DER format, and contain
28725 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28726 option will be re-expanded for SNI, if the &%tls_certificate%& option
28727 contains &`tls_in_sni`&, as per other TLS options.
28728
28729 Exim does not at this time implement any support for fetching a new OCSP
28730 proof.  The burden is on the administrator to handle this, outside of
28731 Exim.  The file specified should be replaced atomically, so that the
28732 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28733 on each connection, so a new file will be handled transparently on the
28734 next connection.
28735
28736 When built with OpenSSL Exim will check for a valid next update timestamp
28737 in the OCSP proof; if not present, or if the proof has expired, it will be
28738 ignored.
28739
28740 For the client to be able to verify the stapled OCSP the server must
28741 also supply, in its stapled information, any intermediate
28742 certificates for the chain leading to the OCSP proof from the signer
28743 of the server certificate.  There may be zero or one such. These
28744 intermediate certificates should be added to the server OCSP stapling
28745 file named by &%tls_ocsp_file%&.
28746
28747 Note that the proof only covers the terminal server certificate,
28748 not any of the chain from CA to it.
28749
28750 There is no current way to staple a proof for a client certificate.
28751
28752 .code
28753   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28754   OCSP server is supplied.  The server URL may be included in the
28755   server certificate, if the CA is helpful.
28756
28757   One failure mode seen was the OCSP Signer cert expiring before the end
28758   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28759   noted this as invalid overall, but the re-fetch script did not.
28760 .endd
28761
28762
28763
28764
28765 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
28766 .cindex "cipher" "logging"
28767 .cindex "log" "TLS cipher"
28768 .cindex "log" "distinguished name"
28769 .cindex "TLS" "configuring an Exim client"
28770 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28771 deliveries as well as to incoming, the latter one causing logging of the
28772 server certificate's DN. The remaining client configuration for TLS is all
28773 within the &(smtp)& transport.
28774
28775 It is not necessary to set any options to have TLS work in the &(smtp)&
28776 transport. If Exim is built with TLS support, and TLS is advertised by a
28777 server, the &(smtp)& transport always tries to start a TLS session. However,
28778 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28779 transport) to a list of server hosts for which TLS should not be used.
28780
28781 If you do not want Exim to attempt to send messages unencrypted when an attempt
28782 to set up an encrypted connection fails in any way, you can set
28783 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28784 those hosts, delivery is always deferred if an encrypted connection cannot be
28785 set up. If there are any other hosts for the address, they are tried in the
28786 usual way.
28787
28788 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28789 the message unencrypted. It always does this if the response to STARTTLS is
28790 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28791 session after a success response code, what happens is controlled by the
28792 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28793 delivery to this host is deferred, and other hosts (if available) are tried. If
28794 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28795 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28796 negotiation fails, Exim closes the current connection (because it is in an
28797 unknown state), opens a new one to the same host, and then tries the delivery
28798 unencrypted.
28799
28800 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28801 transport provide the client with a certificate, which is passed to the server
28802 if it requests it. If the server is Exim, it will request a certificate only if
28803 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28804
28805 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
28806 for client use (they are usable for server use).
28807 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
28808 in failed connections.
28809
28810 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28811 specifies a collection of expected server certificates.
28812 These may be
28813 the system default set (depending on library version),
28814 a file,
28815 or (depending on library version) a directory.
28816 The client verifies the server's certificate
28817 against this collection, taking into account any revoked certificates that are
28818 in the list defined by &%tls_crl%&.
28819 Failure to verify fails the TLS connection unless either of the
28820 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28821
28822 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28823 certificate verification to the listed servers.  Verification either must
28824 or need not succeed respectively.
28825
28826 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28827 checks are made: that the host name (the one in the DNS A record)
28828 is valid for the certificate.
28829 The option defaults to always checking.
28830
28831 The &(smtp)& transport has two OCSP-related options:
28832 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28833 is requested and required for the connection to proceed.  The default
28834 value is empty.
28835 &%hosts_request_ocsp%&; a host-list for which (additionally)
28836 a Certificate Status is requested (but not necessarily verified).  The default
28837 value is "*" meaning that requests are made unless configured
28838 otherwise.
28839
28840 The host(s) should also be in &%hosts_require_tls%&, and
28841 &%tls_verify_certificates%& configured for the transport,
28842 for OCSP to be relevant.
28843
28844 If
28845 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28846 list of permitted cipher suites. If either of these checks fails, delivery to
28847 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28848 alternative hosts, if any.
28849
28850  &*Note*&:
28851 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28852 is operating as a client. Exim does not assume that a server certificate (set
28853 by the global options of the same name) should also be used when operating as a
28854 client.
28855
28856 .vindex "&$host$&"
28857 .vindex "&$host_address$&"
28858 All the TLS options in the &(smtp)& transport are expanded before use, with
28859 &$host$& and &$host_address$& containing the name and address of the server to
28860 which the client is connected. Forced failure of an expansion causes Exim to
28861 behave as if the relevant option were unset.
28862
28863 .vindex &$tls_out_bits$&
28864 .vindex &$tls_out_cipher$&
28865 .vindex &$tls_out_peerdn$&
28866 .vindex &$tls_out_sni$&
28867 Before an SMTP connection is established, the
28868 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28869 variables are emptied. (Until the first connection, they contain the values
28870 that were set when the message was received.) If STARTTLS is subsequently
28871 successfully obeyed, these variables are set to the relevant values for the
28872 outgoing connection.
28873
28874
28875
28876 .section "Use of TLS Server Name Indication" "SECTtlssni"
28877 .cindex "TLS" "Server Name Indication"
28878 .vindex "&$tls_in_sni$&"
28879 .oindex "&%tls_in_sni%&"
28880 With TLS1.0 or above, there is an extension mechanism by which extra
28881 information can be included at various points in the protocol.  One of these
28882 extensions, documented in RFC 6066 (and before that RFC 4366) is
28883 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28884 client in the initial handshake, so that the server can examine the servername
28885 within and possibly choose to use different certificates and keys (and more)
28886 for this session.
28887
28888 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28889 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28890 address.
28891
28892 With SMTP to MX, there are the same problems here as in choosing the identity
28893 against which to validate a certificate: you can't rely on insecure DNS to
28894 provide the identity which you then cryptographically verify.  So this will
28895 be of limited use in that environment.
28896
28897 With SMTP to Submission, there is a well-defined hostname which clients are
28898 connecting to and can validate certificates against.  Thus clients &*can*&
28899 choose to include this information in the TLS negotiation.  If this becomes
28900 wide-spread, then hosters can choose to present different certificates to
28901 different clients.  Or even negotiate different cipher suites.
28902
28903 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28904 if not empty, will be sent on a TLS session as part of the handshake.  There's
28905 nothing more to it.  Choosing a sensible value not derived insecurely is the
28906 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28907 for the lifetime of the client connection (including during authentication).
28908
28909 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28910 received from a client.
28911 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28912
28913 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28914 option (prior to expansion) then the following options will be re-expanded
28915 during TLS session handshake, to permit alternative values to be chosen:
28916
28917 .ilist
28918 &%tls_certificate%&
28919 .next
28920 &%tls_crl%&
28921 .next
28922 &%tls_privatekey%&
28923 .next
28924 &%tls_verify_certificates%&
28925 .next
28926 &%tls_ocsp_file%&
28927 .endlist
28928
28929 Great care should be taken to deal with matters of case, various injection
28930 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28931 can always be referenced; it is important to remember that &$tls_in_sni$& is
28932 arbitrary unverified data provided prior to authentication.
28933 Further, the initial certificate is loaded before SNI has arrived, so
28934 an expansion for &%tls_certificate%& must have a default which is used
28935 when &$tls_in_sni$& is empty.
28936
28937 The Exim developers are proceeding cautiously and so far no other TLS options
28938 are re-expanded.
28939
28940 When Exim is built against OpenSSL, OpenSSL must have been built with support
28941 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28942 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28943 see &`-servername`& in the output, then OpenSSL has support.
28944
28945 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28946 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28947 built, then you have SNI support).
28948
28949
28950
28951 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28952          "SECTmulmessam"
28953 .cindex "multiple SMTP deliveries with TLS"
28954 .cindex "TLS" "multiple message deliveries"
28955 Exim sends multiple messages down the same TCP/IP connection by starting up
28956 an entirely new delivery process for each message, passing the socket from
28957 one process to the next. This implementation does not fit well with the use
28958 of TLS, because there is quite a lot of state information associated with a TLS
28959 connection, not just a socket identification. Passing all the state information
28960 to a new process is not feasible. Consequently, for sending using TLS Exim
28961 starts an additional proxy process for handling the encryption, piping the
28962 unencrypted data stream from and to the delivery processes.
28963
28964 An older mode of operation can be enabled on a per-host basis by the
28965 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28966 this list the proxy process described above is not used; instead Exim
28967 shuts down an existing TLS session being run by the delivery process
28968 before passing the socket to a new process. The new process may then
28969 try to start a new TLS session, and if successful, may try to re-authenticate
28970 if AUTH is in use, before sending the next message.
28971
28972 The RFC is not clear as to whether or not an SMTP session continues in clear
28973 after TLS has been shut down, or whether TLS may be restarted again later, as
28974 just described. However, if the server is Exim, this shutdown and
28975 reinitialization works. It is not known which (if any) other servers operate
28976 successfully if the client closes a TLS session and continues with unencrypted
28977 SMTP, but there are certainly some that do not work. For such servers, Exim
28978 should not pass the socket to another process, because the failure of the
28979 subsequent attempt to use it would cause Exim to record a temporary host error,
28980 and delay other deliveries to that host.
28981
28982 To test for this case, Exim sends an EHLO command to the server after
28983 closing down the TLS session. If this fails in any way, the connection is
28984 closed instead of being passed to a new delivery process, but no retry
28985 information is recorded.
28986
28987 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28988 &(smtp)& transport to match those hosts for which Exim should not pass
28989 connections to new processes if TLS has been used.
28990
28991
28992
28993
28994 .section "Certificates and all that" "SECTcerandall"
28995 .cindex "certificate" "references to discussion"
28996 In order to understand fully how TLS works, you need to know about
28997 certificates, certificate signing, and certificate authorities.
28998 This is a large topic and an introductory guide is unsuitable for the Exim
28999 reference manual, so instead we provide pointers to existing documentation.
29000
29001 The Apache web-server was for a long time the canonical guide, so their
29002 documentation is a good place to start; their SSL module's Introduction
29003 document is currently at
29004 .display
29005 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29006 .endd
29007 and their FAQ is at
29008 .display
29009 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29010 .endd
29011
29012 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29013 0-201-61598-3) in 2001, contains both introductory and more in-depth
29014 descriptions.
29015 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29016 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29017 Ivan is the author of the popular TLS testing tools at
29018 &url(https://www.ssllabs.com/).
29019
29020
29021 .section "Certificate chains" "SECID186"
29022 The file named by &%tls_certificate%& may contain more than one
29023 certificate. This is useful in the case where the certificate that is being
29024 sent is validated by an intermediate certificate which the other end does
29025 not have. Multiple certificates must be in the correct order in the file.
29026 First the host's certificate itself, then the first intermediate
29027 certificate to validate the issuer of the host certificate, then the next
29028 intermediate certificate to validate the issuer of the first intermediate
29029 certificate, and so on, until finally (optionally) the root certificate.
29030 The root certificate must already be trusted by the recipient for
29031 validation to succeed, of course, but if it's not preinstalled, sending the
29032 root certificate along with the rest makes it available for the user to
29033 install if the receiving end is a client MUA that can interact with a user.
29034
29035 Note that certificates using MD5 are unlikely to work on today's Internet;
29036 even if your libraries allow loading them for use in Exim when acting as a
29037 server, increasingly clients will not accept such certificates.  The error
29038 diagnostics in such a case can be frustratingly vague.
29039
29040
29041
29042 .section "Self-signed certificates" "SECID187"
29043 .cindex "certificate" "self-signed"
29044 You can create a self-signed certificate using the &'req'& command provided
29045 with OpenSSL, like this:
29046 . ==== Do not shorten the duration here without reading and considering
29047 . ==== the text below.  Please leave it at 9999 days.
29048 .code
29049 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29050             -days 9999 -nodes
29051 .endd
29052 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29053 delimited and so can be identified independently. The &%-days%& option
29054 specifies a period for which the certificate is valid. The &%-nodes%& option is
29055 important: if you do not set it, the key is encrypted with a passphrase
29056 that you are prompted for, and any use that is made of the key causes more
29057 prompting for the passphrase. This is not helpful if you are going to use
29058 this certificate and key in an MTA, where prompting is not possible.
29059
29060 . ==== I expect to still be working 26 years from now.  The less technical
29061 . ==== debt I create, in terms of storing up trouble for my later years, the
29062 . ==== happier I will be then.  We really have reached the point where we
29063 . ==== should start, at the very least, provoking thought and making folks
29064 . ==== pause before proceeding, instead of leaving all the fixes until two
29065 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29066 . ==== -pdp, 2012
29067 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29068 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29069 the above command might produce a date in the past.  Think carefully about
29070 the lifetime of the systems you're deploying, and either reduce the duration
29071 of the certificate or reconsider your platform deployment.  (At time of
29072 writing, reducing the duration is the most likely choice, but the inexorable
29073 progression of time takes us steadily towards an era where this will not
29074 be a sensible resolution).
29075
29076 A self-signed certificate made in this way is sufficient for testing, and
29077 may be adequate for all your requirements if you are mainly interested in
29078 encrypting transfers, and not in secure identification.
29079
29080 However, many clients require that the certificate presented by the server be a
29081 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29082 certificate. In this situation, the self-signed certificate described above
29083 must be installed on the client host as a trusted root &'certification
29084 authority'& (CA), and the certificate used by Exim must be a user certificate
29085 signed with that self-signed certificate.
29086
29087 For information on creating self-signed CA certificates and using them to sign
29088 user certificates, see the &'General implementation overview'& chapter of the
29089 Open-source PKI book, available online at
29090 &url(https://sourceforge.net/projects/ospkibook/).
29091 .ecindex IIDencsmtp1
29092 .ecindex IIDencsmtp2
29093
29094
29095
29096 .section DANE "SECDANE"
29097 .cindex DANE
29098 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29099 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29100 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29101 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29102 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29103 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29104
29105 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29106 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29107 by (a) is thought to be smaller than that of the set of root CAs.
29108
29109 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29110 fail to pass on a server's STARTTLS.
29111
29112 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29113 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29114 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29115
29116 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29117 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29118 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29119 DNSSEC.
29120 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29121 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29122
29123 There are no changes to Exim specific to server-side operation of DANE.
29124 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29125 in &_Local/Makefile_&.
29126 If it has been included, the macro "_HAVE_DANE" will be defined.
29127
29128 A TLSA record consist of 4 fields, the "Certificate Usage", the
29129 "Selector", the "Matching type", and the "Certificate Association Data".
29130 For a detailed description of the TLSA record see
29131 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29132
29133 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29134 These are the "Trust Anchor" and "End Entity" variants.
29135 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29136 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29137 this is appropriate for a single system, using a self-signed certificate.
29138 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29139 well-known one.
29140 A private CA at simplest is just a self-signed certificate (with certain
29141 attributes) which is used to sign server certificates, but running one securely
29142 does require careful arrangement.
29143 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29144 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29145 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29146 all of which point to a single TLSA record.
29147 DANE-TA and DANE-EE can both be used together.
29148
29149 Our recommendation is to use DANE with a certificate from a public CA,
29150 because this enables a variety of strategies for remote clients to verify
29151 your certificate.
29152 You can then publish information both via DANE and another technology,
29153 "MTA-STS", described below.
29154
29155 When you use DANE-TA to publish trust anchor information, you ask entities
29156 outside your administrative control to trust the Certificate Authority for
29157 connections to you.
29158 If using a private CA then you should expect others to still apply the
29159 technical criteria they'd use for a public CA to your certificates.
29160 In particular, you should probably try to follow current best practices for CA
29161 operation around hash algorithms and key sizes.
29162 Do not expect other organizations to lower their security expectations just
29163 because a particular profile might be reasonable for your own internal use.
29164
29165 When this text was last updated, this in practice means to avoid use of SHA-1
29166 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29167 than 4096, for interoperability); to use keyUsage fields correctly; to use
29168 random serial numbers.
29169 The list of requirements is subject to change as best practices evolve.
29170 If you're not already using a private CA, or it doesn't meet these
29171 requirements, then we encourage you to avoid all these issues and use a public
29172 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29173
29174 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29175 a "Matching Type" (3rd) field of SHA2-512(2).
29176
29177 For the "Certificate Authority Data" (4th) field, commands like
29178
29179 .code
29180   openssl x509 -pubkey -noout <certificate.pem \
29181   | openssl rsa -outform der -pubin 2>/dev/null \
29182   | openssl sha512 \
29183   | awk '{print $2}'
29184 .endd
29185
29186 are workable to create a hash of the certificate's public key.
29187
29188 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29189
29190 .code
29191   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29192 .endd
29193
29194 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29195 is useful for quickly generating TLSA records.
29196
29197
29198 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29199
29200 The Certificate issued by the CA published in the DANE-TA model should be
29201 issued using a strong hash algorithm.
29202 Exim, and importantly various other MTAs sending to you, will not
29203 re-enable hash algorithms which have been disabled by default in TLS
29204 libraries.
29205 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29206 interoperability (and probably the maximum too, in 2018).
29207
29208 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29209 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29210 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29211
29212 .code
29213   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29214                                  {= {4}{$tls_out_tlsa_usage}} } \
29215                          {*}{}}
29216 .endd
29217
29218 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29219 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29220 found. If the definition of &%hosts_request_ocsp%& includes the
29221 string "tls_out_tlsa_usage", they are re-expanded in time to
29222 control the OCSP request.
29223
29224 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29225 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29226
29227
29228 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29229 and &%dane_require_tls_ciphers%&.
29230 The &"require"& variant will result in failure if the target host is not
29231 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29232 the &%dnssec_request_domains%& router or transport option.
29233
29234 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29235
29236 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29237 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29238 will be required for the host.  If it does not, the host will not
29239 be used; there is no fallback to non-DANE or non-TLS.
29240
29241 If DANE is requested and usable, then the TLS cipher list configuration
29242 prefers to use the option &%dane_require_tls_ciphers%& and falls
29243 back to &%tls_require_ciphers%& only if that is unset.
29244 This lets you configure "decent crypto" for DANE and "better than nothing
29245 crypto" as the default.  Note though that while GnuTLS lets the string control
29246 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29247 limited to ciphersuite constraints.
29248
29249 If DANE is requested and useable (see above) the following transport options are ignored:
29250 .code
29251   hosts_require_tls
29252   tls_verify_hosts
29253   tls_try_verify_hosts
29254   tls_verify_certificates
29255   tls_crl
29256   tls_verify_cert_hostnames
29257 .endd
29258
29259 If DANE is not usable, whether requested or not, and CA-anchored
29260 verification evaluation is wanted, the above variables should be set appropriately.
29261
29262 The router and transport option &%dnssec_request_domains%& must not be
29263 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29264
29265 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29266
29267 There is a new variable &$tls_out_dane$& which will have "yes" if
29268 verification succeeded using DANE and "no" otherwise (only useful
29269 in combination with events; see &<<CHAPevents>>&),
29270 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29271
29272 .cindex DANE reporting
29273 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29274 to achieve DANE-verified connection, if one was either requested and offered, or
29275 required.  This is intended to support TLS-reporting as defined in
29276 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29277 The &$event_data$& will be one of the Result Types defined in
29278 Section 4.3 of that document.
29279
29280 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29281
29282 DANE is specified in published RFCs and decouples certificate authority trust
29283 selection from a "race to the bottom" of "you must trust everything for mail
29284 to get through".  There is an alternative technology called MTA-STS, which
29285 instead publishes MX trust anchor information on an HTTPS website.  At the
29286 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29287 Exim has no support for MTA-STS as a client, but Exim mail server operators
29288 can choose to publish information describing their TLS configuration using
29289 MTA-STS to let those clients who do use that protocol derive trust
29290 information.
29291
29292 The MTA-STS design requires a certificate from a public Certificate Authority
29293 which is recognized by clients sending to you.
29294 That selection of which CAs are trusted by others is outside your control.
29295
29296 The most interoperable course of action is probably to use
29297 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29298 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29299 records for DANE clients (such as Exim and Postfix) and to publish anchor
29300 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29301 domain itself (with caveats around occasionally broken MTA-STS because of
29302 incompatible specification changes prior to reaching RFC status).
29303
29304
29305
29306 . ////////////////////////////////////////////////////////////////////////////
29307 . ////////////////////////////////////////////////////////////////////////////
29308
29309 .chapter "Access control lists" "CHAPACL"
29310 .scindex IIDacl "&ACL;" "description"
29311 .cindex "control of incoming mail"
29312 .cindex "message" "controlling incoming"
29313 .cindex "policy control" "access control lists"
29314 Access Control Lists (ACLs) are defined in a separate section of the runtime
29315 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29316 name, terminated by a colon. Here is a complete ACL section that contains just
29317 one very small ACL:
29318 .code
29319 begin acl
29320 small_acl:
29321   accept   hosts = one.host.only
29322 .endd
29323 You can have as many lists as you like in the ACL section, and the order in
29324 which they appear does not matter. The lists are self-terminating.
29325
29326 The majority of ACLs are used to control Exim's behaviour when it receives
29327 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29328 when a local process submits a message using SMTP by specifying the &%-bs%&
29329 option. The most common use is for controlling which recipients are accepted
29330 in incoming messages. In addition, you can define an ACL that is used to check
29331 local non-SMTP messages. The default configuration file contains an example of
29332 a realistic ACL for checking RCPT commands. This is discussed in chapter
29333 &<<CHAPdefconfil>>&.
29334
29335
29336 .section "Testing ACLs" "SECID188"
29337 The &%-bh%& command line option provides a way of testing your ACL
29338 configuration locally by running a fake SMTP session with which you interact.
29339
29340
29341 .section "Specifying when ACLs are used" "SECID189"
29342 .cindex "&ACL;" "options for specifying"
29343 In order to cause an ACL to be used, you have to name it in one of the relevant
29344 options in the main part of the configuration. These options are:
29345 .cindex "AUTH" "ACL for"
29346 .cindex "DATA" "ACLs for"
29347 .cindex "ETRN" "ACL for"
29348 .cindex "EXPN" "ACL for"
29349 .cindex "HELO" "ACL for"
29350 .cindex "EHLO" "ACL for"
29351 .cindex "DKIM" "ACL for"
29352 .cindex "MAIL" "ACL for"
29353 .cindex "QUIT, ACL for"
29354 .cindex "RCPT" "ACL for"
29355 .cindex "STARTTLS, ACL for"
29356 .cindex "VRFY" "ACL for"
29357 .cindex "SMTP" "connection, ACL for"
29358 .cindex "non-SMTP messages" "ACLs for"
29359 .cindex "MIME content scanning" "ACL for"
29360 .cindex "PRDR" "ACL for"
29361
29362 .table2 140pt
29363 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29364 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29365 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29366 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29367 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29368 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29369 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29370 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29371 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29372 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29373 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29374 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29375 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29376 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29377 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29378 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29379 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29380 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29381 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29382 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29383 .endtable
29384
29385 For example, if you set
29386 .code
29387 acl_smtp_rcpt = small_acl
29388 .endd
29389 the little ACL defined above is used whenever Exim receives a RCPT command
29390 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29391 done when RCPT commands arrive. A rejection of RCPT should cause the
29392 sending MTA to give up on the recipient address contained in the RCPT
29393 command, whereas rejection at other times may cause the client MTA to keep on
29394 trying to deliver the message. It is therefore recommended that you do as much
29395 testing as possible at RCPT time.
29396
29397
29398 .section "The non-SMTP ACLs" "SECID190"
29399 .cindex "non-SMTP messages" "ACLs for"
29400 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29401 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29402 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29403 the state of the SMTP connection such as encryption and authentication) are not
29404 relevant and are forbidden in these ACLs. However, the sender and recipients
29405 are known, so the &%senders%& and &%sender_domains%& conditions and the
29406 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29407 &$authenticated_sender$& are also available. You can specify added header lines
29408 in any of these ACLs.
29409
29410 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29411 non-SMTP message, before any of the message has been read. (This is the
29412 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29413 batched SMTP input, it runs after the DATA command has been reached. The
29414 result of this ACL is ignored; it cannot be used to reject a message. If you
29415 really need to, you could set a value in an ACL variable here and reject based
29416 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29417 controls, and in particular, it can be used to set
29418 .code
29419 control = suppress_local_fixups
29420 .endd
29421 This cannot be used in the other non-SMTP ACLs because by the time they are
29422 run, it is too late.
29423
29424 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29425 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29426
29427 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29428 kind of rejection is treated as permanent, because there is no way of sending a
29429 temporary error for these kinds of message.
29430
29431
29432 .section "The SMTP connect ACL" "SECID191"
29433 .cindex "SMTP" "connection, ACL for"
29434 .oindex &%smtp_banner%&
29435 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29436 session, after the test specified by &%host_reject_connection%& (which is now
29437 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29438 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29439 the message override the banner message that is otherwise specified by the
29440 &%smtp_banner%& option.
29441
29442
29443 .section "The EHLO/HELO ACL" "SECID192"
29444 .cindex "EHLO" "ACL for"
29445 .cindex "HELO" "ACL for"
29446 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29447 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29448 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29449 Note that a client may issue more than one EHLO or HELO command in an SMTP
29450 session, and indeed is required to issue a new EHLO or HELO after successfully
29451 setting up encryption following a STARTTLS command.
29452
29453 Note also that a deny neither forces the client to go away nor means that
29454 mail will be refused on the connection.  Consider checking for
29455 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29456
29457 If the command is accepted by an &%accept%& verb that has a &%message%&
29458 modifier, the message may not contain more than one line (it will be truncated
29459 at the first newline and a panic logged if it does). Such a message cannot
29460 affect the EHLO options that are listed on the second and subsequent lines of
29461 an EHLO response.
29462
29463
29464 .section "The DATA ACLs" "SECID193"
29465 .cindex "DATA" "ACLs for"
29466 Two ACLs are associated with the DATA command, because it is two-stage
29467 command, with two responses being sent to the client.
29468 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29469 is obeyed. This gives you control after all the RCPT commands, but before
29470 the message itself is received. It offers the opportunity to give a negative
29471 response to the DATA command before the data is transmitted. Header lines
29472 added by MAIL or RCPT ACLs are not visible at this time, but any that
29473 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29474
29475 You cannot test the contents of the message, for example, to verify addresses
29476 in the headers, at RCPT time or when the DATA command is received. Such
29477 tests have to appear in the ACL that is run after the message itself has been
29478 received, before the final response to the DATA command is sent. This is
29479 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29480 associated with the DATA command.
29481
29482 .cindex CHUNKING "BDAT command"
29483 .cindex BDAT "SMTP command"
29484 .cindex "RFC 3030" CHUNKING
29485 If CHUNKING was advertised and a BDAT command sequence is received,
29486 the &%acl_smtp_predata%& ACL is not run.
29487 . XXX why not?  It should be possible, for the first BDAT.
29488 The &%acl_smtp_data%& is run after the last BDAT command and all of
29489 the data specified is received.
29490
29491 For both of these ACLs, it is not possible to reject individual recipients. An
29492 error response rejects the entire message. Unfortunately, it is known that some
29493 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29494 before or after the data) correctly &-- they keep the message on their queues
29495 and try again later, but that is their problem, though it does waste some of
29496 your resources.
29497
29498 The &%acl_smtp_data%& ACL is run after
29499 the &%acl_smtp_data_prdr%&,
29500 the &%acl_smtp_dkim%&
29501 and the &%acl_smtp_mime%& ACLs.
29502
29503 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29504 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29505 enabled (which is the default).
29506
29507 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29508 received, and is executed for each DKIM signature found in a message.  If not
29509 otherwise specified, the default action is to accept.
29510
29511 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29512
29513 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29514
29515
29516 .section "The SMTP MIME ACL" "SECID194"
29517 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29518 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29519
29520 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29521
29522
29523 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29524 .cindex "PRDR" "ACL for"
29525 .oindex "&%prdr_enable%&"
29526 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29527 with PRDR support enabled (which is the default).
29528 It becomes active only when the PRDR feature is negotiated between
29529 client and server for a message, and more than one recipient
29530 has been accepted.
29531
29532 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29533 has been received, and is executed once for each recipient of the message
29534 with &$local_part$& and &$domain$& valid.
29535 The test may accept, defer or deny for individual recipients.
29536 The &%acl_smtp_data%& will still be called after this ACL and
29537 can reject the message overall, even if this ACL has accepted it
29538 for some or all recipients.
29539
29540 PRDR may be used to support per-user content filtering.  Without it
29541 one must defer any recipient after the first that has a different
29542 content-filter configuration.  With PRDR, the RCPT-time check
29543 .cindex "PRDR" "variable for"
29544 for this can be disabled when the variable &$prdr_requested$&
29545 is &"yes"&.
29546 Any required difference in behaviour of the main DATA-time
29547 ACL should however depend on the PRDR-time ACL having run, as Exim
29548 will avoid doing so in some situations (e.g. single-recipient mails).
29549
29550 See also the &%prdr_enable%& global option
29551 and the &%hosts_try_prdr%& smtp transport option.
29552
29553 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29554 If the ACL is not defined, processing completes as if
29555 the feature was not requested by the client.
29556
29557 .section "The QUIT ACL" "SECTQUITACL"
29558 .cindex "QUIT, ACL for"
29559 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29560 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29561 does not in fact control any access.
29562 For this reason, it may only accept
29563 or warn as its final result.
29564
29565 This ACL can be used for tasks such as custom logging at the end of an SMTP
29566 session. For example, you can use ACL variables in other ACLs to count
29567 messages, recipients, etc., and log the totals at QUIT time using one or
29568 more &%logwrite%& modifiers on a &%warn%& verb.
29569
29570 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29571 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29572
29573 You do not need to have a final &%accept%&, but if you do, you can use a
29574 &%message%& modifier to specify custom text that is sent as part of the 221
29575 response to QUIT.
29576
29577 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29578 failure (for example, failure to open a log file, or when Exim is bombing out
29579 because it has detected an unrecoverable error), all SMTP commands from the
29580 client are given temporary error responses until QUIT is received or the
29581 connection is closed. In these special cases, the QUIT ACL does not run.
29582
29583
29584 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29585 .vindex &$acl_smtp_notquit$&
29586 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29587 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29588 trouble, such as being unable to write to its log files, this ACL is not run,
29589 because it might try to do things (such as write to log files) that make the
29590 situation even worse.
29591
29592 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29593 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29594 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29595 and &%warn%&.
29596
29597 .vindex &$smtp_notquit_reason$&
29598 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29599 to a string that indicates the reason for the termination of the SMTP
29600 connection. The possible values are:
29601 .table2
29602 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29603 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29604 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29605 .irow &`connection-lost`&          "The SMTP connection has been lost"
29606 .irow &`data-timeout`&             "Timeout while reading message data"
29607 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29608 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29609 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29610 .irow &`synchronization-error`&    "SMTP synchronization error"
29611 .irow &`tls-failed`&               "TLS failed to start"
29612 .endtable
29613 In most cases when an SMTP connection is closed without having received QUIT,
29614 Exim sends an SMTP response message before actually closing the connection.
29615 With the exception of the &`acl-drop`& case, the default message can be
29616 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29617 &%drop%& verb in another ACL, it is the message from the other ACL that is
29618 used.
29619
29620
29621 .section "Finding an ACL to use" "SECID195"
29622 .cindex "&ACL;" "finding which to use"
29623 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29624 you can use different ACLs in different circumstances. For example,
29625 .code
29626 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29627                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29628 .endd
29629 In the default configuration file there are some example settings for
29630 providing an RFC 4409 message &"submission"& service on port 587 and
29631 an RFC 8314 &"submissions"& service on port 465. You can use a string
29632 expansion like this to choose an ACL for MUAs on these ports which is
29633 more appropriate for this purpose than the default ACL on port 25.
29634
29635 The expanded string does not have to be the name of an ACL in the
29636 configuration file; there are other possibilities. Having expanded the
29637 string, Exim searches for an ACL as follows:
29638
29639 .ilist
29640 If the string begins with a slash, Exim uses it as a filename, and reads its
29641 contents as an ACL. The lines are processed in the same way as lines in the
29642 Exim configuration file. In particular, continuation lines are supported, blank
29643 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29644 If the file does not exist or cannot be read, an error occurs (typically
29645 causing a temporary failure of whatever caused the ACL to be run). For example:
29646 .code
29647 acl_smtp_data = /etc/acls/\
29648   ${lookup{$sender_host_address}lsearch\
29649   {/etc/acllist}{$value}{default}}
29650 .endd
29651 This looks up an ACL file to use on the basis of the host's IP address, falling
29652 back to a default if the lookup fails. If an ACL is successfully read from a
29653 file, it is retained in memory for the duration of the Exim process, so that it
29654 can be re-used without having to re-read the file.
29655 .next
29656 If the string does not start with a slash, and does not contain any spaces,
29657 Exim searches the ACL section of the configuration for an ACL whose name
29658 matches the string.
29659 .next
29660 If no named ACL is found, or if the string contains spaces, Exim parses
29661 the string as an inline ACL. This can save typing in cases where you just
29662 want to have something like
29663 .code
29664 acl_smtp_vrfy = accept
29665 .endd
29666 in order to allow free use of the VRFY command. Such a string may contain
29667 newlines; it is processed in the same way as an ACL that is read from a file.
29668 .endlist
29669
29670
29671
29672
29673 .section "ACL return codes" "SECID196"
29674 .cindex "&ACL;" "return codes"
29675 Except for the QUIT ACL, which does not affect the SMTP return code (see
29676 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29677 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29678 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29679 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29680 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29681 This also causes a 4&'xx'& return code.
29682
29683 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29684 &"deny"&, because there is no mechanism for passing temporary errors to the
29685 submitters of non-SMTP messages.
29686
29687
29688 ACLs that are relevant to message reception may also return &"discard"&. This
29689 has the effect of &"accept"&, but causes either the entire message or an
29690 individual recipient address to be discarded. In other words, it is a
29691 blackholing facility. Use it with care.
29692
29693 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29694 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29695 RCPT ACL is to discard just the one recipient address. If there are no
29696 recipients left when the message's data is received, the DATA ACL is not
29697 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29698 remaining recipients. The &"discard"& return is not permitted for the
29699 &%acl_smtp_predata%& ACL.
29700
29701 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29702 is done on the address and the result determines the SMTP response.
29703
29704
29705 .cindex "&[local_scan()]& function" "when all recipients discarded"
29706 The &[local_scan()]& function is always run, even if there are no remaining
29707 recipients; it may create new recipients.
29708
29709
29710
29711 .section "Unset ACL options" "SECID197"
29712 .cindex "&ACL;" "unset options"
29713 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29714 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29715 not defined at all. For any defined ACL, the default action when control
29716 reaches the end of the ACL statements is &"deny"&.
29717
29718 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29719 these two are ACLs that are used only for their side effects. They cannot be
29720 used to accept or reject anything.
29721
29722 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29723 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29724 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29725 when the ACL is not defined is &"accept"&.
29726
29727 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29728 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29729 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29730 messages over an SMTP connection. For an example, see the ACL in the default
29731 configuration file.
29732
29733
29734
29735
29736 .section "Data for message ACLs" "SECID198"
29737 .cindex "&ACL;" "data for message ACL"
29738 .vindex &$domain$&
29739 .vindex &$local_part$&
29740 .vindex &$sender_address$&
29741 .vindex &$sender_host_address$&
29742 .vindex &$smtp_command$&
29743 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29744 that contain information about the host and the message's sender (for example,
29745 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29746 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29747 &$local_part$& are set from the argument address. The entire SMTP command
29748 is available in &$smtp_command$&.
29749
29750 When an ACL for the AUTH parameter of MAIL is running, the variables that
29751 contain information about the host are set, but &$sender_address$& is not yet
29752 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29753 how it is used.
29754
29755 .vindex "&$message_size$&"
29756 The &$message_size$& variable is set to the value of the SIZE parameter on
29757 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29758 that parameter is not given. The value is updated to the true message size by
29759 the time the final DATA ACL is run (after the message data has been
29760 received).
29761
29762 .vindex "&$rcpt_count$&"
29763 .vindex "&$recipients_count$&"
29764 The &$rcpt_count$& variable increases by one for each RCPT command received.
29765 The &$recipients_count$& variable increases by one each time a RCPT command is
29766 accepted, so while an ACL for RCPT is being processed, it contains the number
29767 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29768 &$rcpt_count$& contains the total number of RCPT commands, and
29769 &$recipients_count$& contains the total number of accepted recipients.
29770
29771
29772
29773
29774
29775 .section "Data for non-message ACLs" "SECTdatfornon"
29776 .cindex "&ACL;" "data for non-message ACL"
29777 .vindex &$smtp_command_argument$&
29778 .vindex &$smtp_command$&
29779 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29780 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29781 and the entire SMTP command is available in &$smtp_command$&.
29782 These variables can be tested using a &%condition%& condition. For example,
29783 here is an ACL for use with AUTH, which insists that either the session is
29784 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29785 does not permit authentication methods that use cleartext passwords on
29786 unencrypted connections.
29787 .code
29788 acl_check_auth:
29789   accept encrypted = *
29790   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29791                      {CRAM-MD5}}
29792   deny   message   = TLS encryption or CRAM-MD5 required
29793 .endd
29794 (Another way of applying this restriction is to arrange for the authenticators
29795 that use cleartext passwords not to be advertised when the connection is not
29796 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29797 option to do this.)
29798
29799
29800
29801 .section "Format of an ACL" "SECID199"
29802 .cindex "&ACL;" "format of"
29803 .cindex "&ACL;" "verbs, definition of"
29804 An individual ACL consists of a number of statements. Each statement starts
29805 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29806 Modifiers can change the way the verb operates, define error and log messages,
29807 set variables, insert delays, and vary the processing of accepted messages.
29808
29809 If all the conditions are met, the verb is obeyed. The same condition may be
29810 used (with different arguments) more than once in the same statement. This
29811 provides a means of specifying an &"and"& conjunction between conditions. For
29812 example:
29813 .code
29814 deny  dnslists = list1.example
29815       dnslists = list2.example
29816 .endd
29817 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29818 the conditions and modifiers when it reaches a condition that fails. What
29819 happens then depends on the verb (and in one case, on a special modifier). Not
29820 all the conditions make sense at every testing point. For example, you cannot
29821 test a sender address in the ACL that is run for a VRFY command.
29822
29823
29824 .section "ACL verbs" "SECID200"
29825 The ACL verbs are as follows:
29826
29827 .ilist
29828 .cindex "&%accept%& ACL verb"
29829 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29830 of the conditions are not met, what happens depends on whether &%endpass%&
29831 appears among the conditions (for syntax see below). If the failing condition
29832 is before &%endpass%&, control is passed to the next ACL statement; if it is
29833 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29834 check a RCPT command:
29835 .code
29836 accept domains = +local_domains
29837        endpass
29838        verify = recipient
29839 .endd
29840 If the recipient domain does not match the &%domains%& condition, control
29841 passes to the next statement. If it does match, the recipient is verified, and
29842 the command is accepted if verification succeeds. However, if verification
29843 fails, the ACL yields &"deny"&, because the failing condition is after
29844 &%endpass%&.
29845
29846 The &%endpass%& feature has turned out to be confusing to many people, so its
29847 use is not recommended nowadays. It is always possible to rewrite an ACL so
29848 that &%endpass%& is not needed, and it is no longer used in the default
29849 configuration.
29850
29851 .cindex "&%message%& ACL modifier" "with &%accept%&"
29852 If a &%message%& modifier appears on an &%accept%& statement, its action
29853 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29854 (when an &%accept%& verb either accepts or passes control to the next
29855 statement), &%message%& can be used to vary the message that is sent when an
29856 SMTP command is accepted. For example, in a RCPT ACL you could have:
29857 .display
29858 &`accept  `&<&'some conditions'&>
29859 &`        message = OK, I will allow you through today`&
29860 .endd
29861 You can specify an SMTP response code, optionally followed by an &"extended
29862 response code"& at the start of the message, but the first digit must be the
29863 same as would be sent by default, which is 2 for an &%accept%& verb.
29864
29865 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29866 an error message that is used when access is denied. This behaviour is retained
29867 for backward compatibility, but current &"best practice"& is to avoid the use
29868 of &%endpass%&.
29869
29870
29871 .next
29872 .cindex "&%defer%& ACL verb"
29873 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29874 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29875 &%defer%& is the same as &%deny%&, because there is no way of sending a
29876 temporary error. For a RCPT command, &%defer%& is much the same as using a
29877 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29878 be used in any ACL, and even for a recipient it might be a simpler approach.
29879
29880
29881 .next
29882 .cindex "&%deny%& ACL verb"
29883 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29884 the conditions are not met, control is passed to the next ACL statement. For
29885 example,
29886 .code
29887 deny dnslists = blackholes.mail-abuse.org
29888 .endd
29889 rejects commands from hosts that are on a DNS black list.
29890
29891
29892 .next
29893 .cindex "&%discard%& ACL verb"
29894 &%discard%&: This verb behaves like &%accept%&, except that it returns
29895 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29896 that are concerned with receiving messages. When all the conditions are true,
29897 the sending entity receives a &"success"& response. However, &%discard%& causes
29898 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29899 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29900 message's recipients are discarded. Recipients that are discarded before DATA
29901 do not appear in the log line when the &%received_recipients%& log selector is set.
29902
29903 If the &%log_message%& modifier is set when &%discard%& operates,
29904 its contents are added to the line that is automatically written to the log.
29905 The &%message%& modifier operates exactly as it does for &%accept%&.
29906
29907
29908 .next
29909 .cindex "&%drop%& ACL verb"
29910 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29911 forcibly closed after the 5&'xx'& error message has been sent. For example:
29912 .code
29913 drop   message   = I don't take more than 20 RCPTs
29914        condition = ${if > {$rcpt_count}{20}}
29915 .endd
29916 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29917 The connection is always dropped after sending a 550 response.
29918
29919 .next
29920 .cindex "&%require%& ACL verb"
29921 &%require%&: If all the conditions are met, control is passed to the next ACL
29922 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29923 example, when checking a RCPT command,
29924 .code
29925 require message = Sender did not verify
29926         verify  = sender
29927 .endd
29928 passes control to subsequent statements only if the message's sender can be
29929 verified. Otherwise, it rejects the command. Note the positioning of the
29930 &%message%& modifier, before the &%verify%& condition. The reason for this is
29931 discussed in section &<<SECTcondmodproc>>&.
29932
29933 .next
29934 .cindex "&%warn%& ACL verb"
29935 &%warn%&: If all the conditions are true, a line specified by the
29936 &%log_message%& modifier is written to Exim's main log. Control always passes
29937 to the next ACL statement. If any condition is false, the log line is not
29938 written. If an identical log line is requested several times in the same
29939 message, only one copy is actually written to the log. If you want to force
29940 duplicates to be written, use the &%logwrite%& modifier instead.
29941
29942 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29943 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29944 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29945 first failing condition. There is more about adding header lines in section
29946 &<<SECTaddheadacl>>&.
29947
29948 If any condition on a &%warn%& statement cannot be completed (that is, there is
29949 some sort of defer), the log line specified by &%log_message%& is not written.
29950 This does not include the case of a forced failure from a lookup, which
29951 is considered to be a successful completion. After a defer, no further
29952 conditions or modifiers in the &%warn%& statement are processed. The incident
29953 is logged, and the ACL continues to be processed, from the next statement
29954 onwards.
29955
29956
29957 .vindex "&$acl_verify_message$&"
29958 When one of the &%warn%& conditions is an address verification that fails, the
29959 text of the verification failure message is in &$acl_verify_message$&. If you
29960 want this logged, you must set it up explicitly. For example:
29961 .code
29962 warn   !verify = sender
29963        log_message = sender verify failed: $acl_verify_message
29964 .endd
29965 .endlist
29966
29967 At the end of each ACL there is an implicit unconditional &%deny%&.
29968
29969 As you can see from the examples above, the conditions and modifiers are
29970 written one to a line, with the first one on the same line as the verb, and
29971 subsequent ones on following lines. If you have a very long condition, you can
29972 continue it onto several physical lines by the usual backslash continuation
29973 mechanism. It is conventional to align the conditions vertically.
29974
29975
29976
29977 .section "ACL variables" "SECTaclvariables"
29978 .cindex "&ACL;" "variables"
29979 There are some special variables that can be set during ACL processing. They
29980 can be used to pass information between different ACLs, different invocations
29981 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29982 transports, and filters that are used to deliver a message. The names of these
29983 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29984 an underscore, but the remainder of the name can be any sequence of
29985 alphanumeric characters and underscores that you choose. There is no limit on
29986 the number of ACL variables. The two sets act as follows:
29987 .ilist
29988 The values of those variables whose names begin with &$acl_c$& persist
29989 throughout an SMTP connection. They are never reset. Thus, a value that is set
29990 while receiving one message is still available when receiving the next message
29991 on the same SMTP connection.
29992 .next
29993 The values of those variables whose names begin with &$acl_m$& persist only
29994 while a message is being received. They are reset afterwards. They are also
29995 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29996 .endlist
29997
29998 When a message is accepted, the current values of all the ACL variables are
29999 preserved with the message and are subsequently made available at delivery
30000 time. The ACL variables are set by a modifier called &%set%&. For example:
30001 .code
30002 accept hosts = whatever
30003        set acl_m4 = some value
30004 accept authenticated = *
30005        set acl_c_auth = yes
30006 .endd
30007 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30008 be set. If you want to set a variable without taking any action, you can use a
30009 &%warn%& verb without any other modifiers or conditions.
30010
30011 .oindex &%strict_acl_vars%&
30012 What happens if a syntactically valid but undefined ACL variable is
30013 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30014 false (the default), an empty string is substituted; if it is true, an
30015 error is generated.
30016
30017 Versions of Exim before 4.64 have a limited set of numbered variables, but
30018 their names are compatible, so there is no problem with upgrading.
30019
30020
30021 .section "Condition and modifier processing" "SECTcondmodproc"
30022 .cindex "&ACL;" "conditions; processing"
30023 .cindex "&ACL;" "modifiers; processing"
30024 An exclamation mark preceding a condition negates its result. For example:
30025 .code
30026 deny   domains = *.dom.example
30027       !verify  = recipient
30028 .endd
30029 causes the ACL to return &"deny"& if the recipient domain ends in
30030 &'dom.example'& and the recipient address cannot be verified. Sometimes
30031 negation can be used on the right-hand side of a condition. For example, these
30032 two statements are equivalent:
30033 .code
30034 deny  hosts = !192.168.3.4
30035 deny !hosts =  192.168.3.4
30036 .endd
30037 However, for many conditions (&%verify%& being a good example), only left-hand
30038 side negation of the whole condition is possible.
30039
30040 The arguments of conditions and modifiers are expanded. A forced failure
30041 of an expansion causes a condition to be ignored, that is, it behaves as if the
30042 condition is true. Consider these two statements:
30043 .code
30044 accept  senders = ${lookup{$host_name}lsearch\
30045                   {/some/file}{$value}fail}
30046 accept  senders = ${lookup{$host_name}lsearch\
30047                   {/some/file}{$value}{}}
30048 .endd
30049 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30050 the returned list is searched, but if the lookup fails the behaviour is
30051 different in the two cases. The &%fail%& in the first statement causes the
30052 condition to be ignored, leaving no further conditions. The &%accept%& verb
30053 therefore succeeds. The second statement, however, generates an empty list when
30054 the lookup fails. No sender can match an empty list, so the condition fails,
30055 and therefore the &%accept%& also fails.
30056
30057 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30058 specify actions that are taken as the conditions for a statement are checked;
30059 others specify text for messages that are used when access is denied or a
30060 warning is generated. The &%control%& modifier affects the way an incoming
30061 message is handled.
30062
30063 The positioning of the modifiers in an ACL statement is important, because the
30064 processing of a verb ceases as soon as its outcome is known. Only those
30065 modifiers that have already been encountered will take effect. For example,
30066 consider this use of the &%message%& modifier:
30067 .code
30068 require message = Can't verify sender
30069         verify  = sender
30070         message = Can't verify recipient
30071         verify  = recipient
30072         message = This message cannot be used
30073 .endd
30074 If sender verification fails, Exim knows that the result of the statement is
30075 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30076 so its text is used as the error message. If sender verification succeeds, but
30077 recipient verification fails, the second message is used. If recipient
30078 verification succeeds, the third message becomes &"current"&, but is never used
30079 because there are no more conditions to cause failure.
30080
30081 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30082 modifier that is used, because all the conditions must be true for rejection to
30083 happen. Specifying more than one &%message%& modifier does not make sense, and
30084 the message can even be specified after all the conditions. For example:
30085 .code
30086 deny   hosts = ...
30087       !senders = *@my.domain.example
30088        message = Invalid sender from client host
30089 .endd
30090 The &"deny"& result does not happen until the end of the statement is reached,
30091 by which time Exim has set up the message.
30092
30093
30094
30095 .section "ACL modifiers" "SECTACLmodi"
30096 .cindex "&ACL;" "modifiers; list of"
30097 The ACL modifiers are as follows:
30098
30099 .vlist
30100 .vitem &*add_header*&&~=&~<&'text'&>
30101 This modifier specifies one or more header lines that are to be added to an
30102 incoming message, assuming, of course, that the message is ultimately
30103 accepted. For details, see section &<<SECTaddheadacl>>&.
30104
30105 .vitem &*continue*&&~=&~<&'text'&>
30106 .cindex "&%continue%& ACL modifier"
30107 .cindex "database" "updating in ACL"
30108 This modifier does nothing of itself, and processing of the ACL always
30109 continues with the next condition or modifier. The value of &%continue%& is in
30110 the side effects of expanding its argument. Typically this could be used to
30111 update a database. It is really just a syntactic tidiness, to avoid having to
30112 write rather ugly lines like this:
30113 .display
30114 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30115 .endd
30116 Instead, all you need is
30117 .display
30118 &`continue = `&<&'some expansion'&>
30119 .endd
30120
30121 .vitem &*control*&&~=&~<&'text'&>
30122 .cindex "&%control%& ACL modifier"
30123 This modifier affects the subsequent processing of the SMTP connection or of an
30124 incoming message that is accepted. The effect of the first type of control
30125 lasts for the duration of the connection, whereas the effect of the second type
30126 lasts only until the current message has been received. The message-specific
30127 controls always apply to the whole message, not to individual recipients,
30128 even if the &%control%& modifier appears in a RCPT ACL.
30129
30130 As there are now quite a few controls that can be applied, they are described
30131 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30132 in several different ways. For example:
30133
30134 . ==== As this is a nested list, any displays it contains must be indented
30135 . ==== as otherwise they are too far to the left. That comment applies only
30136 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30137 . ==== way.
30138
30139 .ilist
30140 It can be at the end of an &%accept%& statement:
30141 .code
30142     accept  ...some conditions
30143             control = queue_only
30144 .endd
30145 In this case, the control is applied when this statement yields &"accept"&, in
30146 other words, when the conditions are all true.
30147
30148 .next
30149 It can be in the middle of an &%accept%& statement:
30150 .code
30151     accept  ...some conditions...
30152             control = queue_only
30153             ...some more conditions...
30154 .endd
30155 If the first set of conditions are true, the control is applied, even if the
30156 statement does not accept because one of the second set of conditions is false.
30157 In this case, some subsequent statement must yield &"accept"& for the control
30158 to be relevant.
30159
30160 .next
30161 It can be used with &%warn%& to apply the control, leaving the
30162 decision about accepting or denying to a subsequent verb. For
30163 example:
30164 .code
30165     warn    ...some conditions...
30166             control = freeze
30167     accept  ...
30168 .endd
30169 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30170 &%logwrite%&, so it does not add anything to the message and does not write a
30171 log entry.
30172
30173 .next
30174 If you want to apply a control unconditionally, you can use it with a
30175 &%require%& verb. For example:
30176 .code
30177     require  control = no_multiline_responses
30178 .endd
30179 .endlist
30180
30181 .vitem &*delay*&&~=&~<&'time'&>
30182 .cindex "&%delay%& ACL modifier"
30183 .oindex "&%-bh%&"
30184 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30185 the time interval before proceeding. However, when testing Exim using the
30186 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30187 output instead). The time is given in the usual Exim notation, and the delay
30188 happens as soon as the modifier is processed. In an SMTP session, pending
30189 output is flushed before the delay is imposed.
30190
30191 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30192 example:
30193 .code
30194 deny    ...some conditions...
30195         delay = 30s
30196 .endd
30197 The delay happens if all the conditions are true, before the statement returns
30198 &"deny"&. Compare this with:
30199 .code
30200 deny    delay = 30s
30201         ...some conditions...
30202 .endd
30203 which waits for 30s before processing the conditions. The &%delay%& modifier
30204 can also be used with &%warn%& and together with &%control%&:
30205 .code
30206 warn    ...some conditions...
30207         delay = 2m
30208         control = freeze
30209 accept  ...
30210 .endd
30211
30212 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30213 responses to several commands are no longer buffered and sent in one packet (as
30214 they would normally be) because all output is flushed before imposing the
30215 delay. This optimization is disabled so that a number of small delays do not
30216 appear to the client as one large aggregated delay that might provoke an
30217 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30218 using a &%control%& modifier to set &%no_delay_flush%&.
30219
30220
30221 .vitem &*endpass*&
30222 .cindex "&%endpass%& ACL modifier"
30223 This modifier, which has no argument, is recognized only in &%accept%& and
30224 &%discard%& statements. It marks the boundary between the conditions whose
30225 failure causes control to pass to the next statement, and the conditions whose
30226 failure causes the ACL to return &"deny"&. This concept has proved to be
30227 confusing to some people, so the use of &%endpass%& is no longer recommended as
30228 &"best practice"&. See the description of &%accept%& above for more details.
30229
30230
30231 .vitem &*log_message*&&~=&~<&'text'&>
30232 .cindex "&%log_message%& ACL modifier"
30233 This modifier sets up a message that is used as part of the log message if the
30234 ACL denies access or a &%warn%& statement's conditions are true. For example:
30235 .code
30236 require log_message = wrong cipher suite $tls_in_cipher
30237         encrypted   = DES-CBC3-SHA
30238 .endd
30239 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30240 example:
30241 .display
30242 &`discard `&<&'some conditions'&>
30243 &`        log_message = Discarded $local_part@$domain because...`&
30244 .endd
30245 When access is denied, &%log_message%& adds to any underlying error message
30246 that may exist because of a condition failure. For example, while verifying a
30247 recipient address, a &':fail:'& redirection might have already set up a
30248 message.
30249
30250 The message may be defined before the conditions to which it applies, because
30251 the string expansion does not happen until Exim decides that access is to be
30252 denied. This means that any variables that are set by the condition are
30253 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30254 variables are set after a DNS black list lookup succeeds. If the expansion of
30255 &%log_message%& fails, or if the result is an empty string, the modifier is
30256 ignored.
30257
30258 .vindex "&$acl_verify_message$&"
30259 If you want to use a &%warn%& statement to log the result of an address
30260 verification, you can use &$acl_verify_message$& to include the verification
30261 error message.
30262
30263 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30264 the start of the logged message. If the same warning log message is requested
30265 more than once while receiving  a single email message, only one copy is
30266 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30267 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30268 is logged for a successful &%warn%& statement.
30269
30270 If &%log_message%& is not present and there is no underlying error message (for
30271 example, from the failure of address verification), but &%message%& is present,
30272 the &%message%& text is used for logging rejections. However, if any text for
30273 logging contains newlines, only the first line is logged. In the absence of
30274 both &%log_message%& and &%message%&, a default built-in message is used for
30275 logging rejections.
30276
30277
30278 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30279 .cindex "&%log_reject_target%& ACL modifier"
30280 .cindex "logging in ACL" "specifying which log"
30281 This modifier makes it possible to specify which logs are used for messages
30282 about ACL rejections. Its argument is a colon-separated list of words that can
30283 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30284 may be empty, in which case a rejection is not logged at all. For example, this
30285 ACL fragment writes no logging information when access is denied:
30286 .display
30287 &`deny `&<&'some conditions'&>
30288 &`     log_reject_target =`&
30289 .endd
30290 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30291 permanent and temporary rejections. Its effect lasts for the rest of the
30292 current ACL.
30293
30294
30295 .vitem &*logwrite*&&~=&~<&'text'&>
30296 .cindex "&%logwrite%& ACL modifier"
30297 .cindex "logging in ACL" "immediate"
30298 This modifier writes a message to a log file as soon as it is encountered when
30299 processing an ACL. (Compare &%log_message%&, which, except in the case of
30300 &%warn%& and &%discard%&, is used only if the ACL statement denies
30301 access.) The &%logwrite%& modifier can be used to log special incidents in
30302 ACLs. For example:
30303 .display
30304 &`accept `&<&'some special conditions'&>
30305 &`       control  = freeze`&
30306 &`       logwrite = froze message because ...`&
30307 .endd
30308 By default, the message is written to the main log. However, it may begin
30309 with a colon, followed by a comma-separated list of log names, and then
30310 another colon, to specify exactly which logs are to be written. For
30311 example:
30312 .code
30313 logwrite = :main,reject: text for main and reject logs
30314 logwrite = :panic: text for panic log only
30315 .endd
30316
30317
30318 .vitem &*message*&&~=&~<&'text'&>
30319 .cindex "&%message%& ACL modifier"
30320 This modifier sets up a text string that is expanded and used as a response
30321 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30322 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30323 there is some complication if &%endpass%& is involved; see the description of
30324 &%accept%& for details.)
30325
30326 The expansion of the message happens at the time Exim decides that the ACL is
30327 to end, not at the time it processes &%message%&. If the expansion fails, or
30328 generates an empty string, the modifier is ignored. Here is an example where
30329 &%message%& must be specified first, because the ACL ends with a rejection if
30330 the &%hosts%& condition fails:
30331 .code
30332 require  message = Host not recognized
30333          hosts = 10.0.0.0/8
30334 .endd
30335 (Once a condition has failed, no further conditions or modifiers are
30336 processed.)
30337
30338 .cindex "SMTP" "error codes"
30339 .oindex "&%smtp_banner%&
30340 For ACLs that are triggered by SMTP commands, the message is returned as part
30341 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30342 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30343 is accepted. In the case of the connect ACL, accepting with a message modifier
30344 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30345 accept message may not contain more than one line (otherwise it will be
30346 truncated at the first newline and a panic logged), and it cannot affect the
30347 EHLO options.
30348
30349 When SMTP is involved, the message may begin with an overriding response code,
30350 consisting of three digits optionally followed by an &"extended response code"&
30351 of the form &'n.n.n'&, each code being followed by a space. For example:
30352 .code
30353 deny  message = 599 1.2.3 Host not welcome
30354       hosts = 192.168.34.0/24
30355 .endd
30356 The first digit of the supplied response code must be the same as would be sent
30357 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30358 access, but for the predata ACL, note that the default success code is 354, not
30359 2&'xx'&.
30360
30361 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30362 the message modifier cannot override the 221 response code.
30363
30364 The text in a &%message%& modifier is literal; any quotes are taken as
30365 literals, but because the string is expanded, backslash escapes are processed
30366 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30367 response.
30368
30369 .vindex "&$acl_verify_message$&"
30370 For ACLs that are called by an &%acl =%& ACL condition, the message is
30371 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30372
30373 If &%message%& is used on a statement that verifies an address, the message
30374 specified overrides any message that is generated by the verification process.
30375 However, the original message is available in the variable
30376 &$acl_verify_message$&, so you can incorporate it into your message if you
30377 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30378 routers to be passed back as part of the SMTP response, you should either not
30379 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30380
30381 For compatibility with previous releases of Exim, a &%message%& modifier that
30382 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30383 modifier, but this usage is now deprecated. However, &%message%& acts only when
30384 all the conditions are true, wherever it appears in an ACL command, whereas
30385 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30386 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30387 effect.
30388
30389
30390 .vitem &*queue*&&~=&~<&'text'&>
30391 .cindex "&%queue%& ACL modifier"
30392 .cindex "named queues" "selecting in ACL"
30393 This modifier specifies the use of a named queue for spool files
30394 for the message.
30395 It can only be used before the message is received (i.e. not in
30396 the DATA ACL).
30397 This could be used, for example, for known high-volume burst sources
30398 of traffic, or for quarantine of messages.
30399 Separate queue-runner processes will be needed for named queues.
30400 If the text after expansion is empty, the default queue is used.
30401
30402
30403 .vitem &*remove_header*&&~=&~<&'text'&>
30404 This modifier specifies one or more header names in a colon-separated list
30405  that are to be removed from an incoming message, assuming, of course, that
30406 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30407
30408
30409 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30410 .cindex "&%set%& ACL modifier"
30411 This modifier puts a value into one of the ACL variables (see section
30412 &<<SECTaclvariables>>&).
30413
30414
30415 .vitem &*udpsend*&&~=&~<&'parameters'&>
30416 .cindex "UDP communications"
30417 This modifier sends a UDP packet, for purposes such as statistics
30418 collection or behaviour monitoring. The parameters are expanded, and
30419 the result of the expansion must be a colon-separated list consisting
30420 of a destination server, port number, and the packet contents. The
30421 server can be specified as a host name or IPv4 or IPv6 address. The
30422 separator can be changed with the usual angle bracket syntax. For
30423 example, you might want to collect information on which hosts connect
30424 when:
30425 .code
30426 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30427              $tod_zulu $sender_host_address
30428 .endd
30429 .endlist
30430
30431
30432
30433
30434 .section "Use of the control modifier" "SECTcontrols"
30435 .cindex "&%control%& ACL modifier"
30436 The &%control%& modifier supports the following settings:
30437
30438 .vlist
30439 .vitem &*control&~=&~allow_auth_unadvertised*&
30440 This modifier allows a client host to use the SMTP AUTH command even when it
30441 has not been advertised in response to EHLO. Furthermore, because there are
30442 apparently some really broken clients that do this, Exim will accept AUTH after
30443 HELO (rather than EHLO) when this control is set. It should be used only if you
30444 really need it, and you should limit its use to those broken clients that do
30445 not work without it. For example:
30446 .code
30447 warn hosts   = 192.168.34.25
30448      control = allow_auth_unadvertised
30449 .endd
30450 Normally, when an Exim server receives an AUTH command, it checks the name of
30451 the authentication mechanism that is given in the command to ensure that it
30452 matches an advertised mechanism. When this control is set, the check that a
30453 mechanism has been advertised is bypassed. Any configured mechanism can be used
30454 by the client. This control is permitted only in the connection and HELO ACLs.
30455
30456
30457 .vitem &*control&~=&~caseful_local_part*& &&&
30458        &*control&~=&~caselower_local_part*&
30459 .cindex "&ACL;" "case of local part in"
30460 .cindex "case of local parts"
30461 .vindex "&$local_part$&"
30462 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30463 (that is, during RCPT processing). By default, the contents of &$local_part$&
30464 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30465 any uppercase letters in the original local part are restored in &$local_part$&
30466 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30467 is encountered.
30468
30469 These controls affect only the current recipient. Moreover, they apply only to
30470 local part handling that takes place directly in the ACL (for example, as a key
30471 in lookups). If a test to verify the recipient is obeyed, the case-related
30472 handling of the local part during the verification is controlled by the router
30473 configuration (see the &%caseful_local_part%& generic router option).
30474
30475 This facility could be used, for example, to add a spam score to local parts
30476 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30477 spam score:
30478 .code
30479 warn  control = caseful_local_part
30480       set acl_m4 = ${eval:\
30481                      $acl_m4 + \
30482                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30483                     }
30484       control = caselower_local_part
30485 .endd
30486 Notice that we put back the lower cased version afterwards, assuming that
30487 is what is wanted for subsequent tests.
30488
30489
30490 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30491 .cindex "&ACL;" "cutthrough routing"
30492 .cindex "cutthrough" "requesting"
30493 This option requests delivery be attempted while the item is being received.
30494
30495 The option is usable in the RCPT ACL.
30496 If enabled for a message received via smtp and routed to an smtp transport,
30497 and only one transport, interface, destination host and port combination
30498 is used for all recipients of the message,
30499 then the delivery connection is made while the receiving connection is open
30500 and data is copied from one to the other.
30501
30502 An attempt to set this option for any recipient but the first
30503 for a mail will be quietly ignored.
30504 If a recipient-verify callout
30505 (with use_sender)
30506 connection is subsequently
30507 requested in the same ACL it is held open and used for
30508 any subsequent recipients and the data,
30509 otherwise one is made after the initial RCPT ACL completes.
30510
30511 Note that routers are used in verify mode,
30512 and cannot depend on content of received headers.
30513 Note also that headers cannot be
30514 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30515 Headers may be modified by routers (subject to the above) and transports.
30516 The &'Received-By:'& header is generated as soon as the body reception starts,
30517 rather than the traditional time after the full message is received;
30518 this will affect the timestamp.
30519
30520 All the usual ACLs are called; if one results in the message being
30521 rejected, all effort spent in delivery (including the costs on
30522 the ultimate destination) will be wasted.
30523 Note that in the case of data-time ACLs this includes the entire
30524 message body.
30525
30526 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30527 of outgoing messages is done, because it sends data to the ultimate destination
30528 before the entire message has been received from the source.
30529 It is not supported for messages received with the SMTP PRDR
30530 or CHUNKING
30531 options in use.
30532
30533 Should the ultimate destination system positively accept or reject the mail,
30534 a corresponding indication is given to the source system and nothing is queued.
30535 If the item is successfully delivered in cutthrough mode
30536 the delivery log lines are tagged with ">>" rather than "=>" and appear
30537 before the acceptance "<=" line.
30538
30539 If there is a temporary error the item is queued for later delivery in the
30540 usual fashion.
30541 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30542 to the control; the default value is &"spool"& and the alternate value
30543 &"pass"& copies an SMTP defer response from the target back to the initiator
30544 and does not queue the message.
30545 Note that this is independent of any recipient verify conditions in the ACL.
30546
30547 Delivery in this mode avoids the generation of a bounce mail to a
30548 (possibly faked)
30549 sender when the destination system is doing content-scan based rejection.
30550
30551
30552 .vitem &*control&~=&~debug/*&<&'options'&>
30553 .cindex "&ACL;" "enabling debug logging"
30554 .cindex "debugging" "enabling from an ACL"
30555 This control turns on debug logging, almost as though Exim had been invoked
30556 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30557 by default called &'debuglog'&.
30558 The filename can be adjusted with the &'tag'& option, which
30559 may access any variables already defined.  The logging may be adjusted with
30560 the &'opts'& option, which takes the same values as the &`-d`& command-line
30561 option.
30562 Logging started this way may be stopped, and the file removed,
30563 with the &'kill'& option.
30564 Some examples (which depend on variables that don't exist in all
30565 contexts):
30566 .code
30567       control = debug
30568       control = debug/tag=.$sender_host_address
30569       control = debug/opts=+expand+acl
30570       control = debug/tag=.$message_exim_id/opts=+expand
30571       control = debug/kill
30572 .endd
30573
30574
30575 .vitem &*control&~=&~dkim_disable_verify*&
30576 .cindex "disable DKIM verify"
30577 .cindex "DKIM" "disable verify"
30578 This control turns off DKIM verification processing entirely.  For details on
30579 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30580
30581
30582 .vitem &*control&~=&~dmarc_disable_verify*&
30583 .cindex "disable DMARC verify"
30584 .cindex "DMARC" "disable verify"
30585 This control turns off DMARC verification processing entirely.  For details on
30586 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
30587
30588
30589 .vitem &*control&~=&~dscp/*&<&'value'&>
30590 .cindex "&ACL;" "setting DSCP value"
30591 .cindex "DSCP" "inbound"
30592 This option causes the DSCP value associated with the socket for the inbound
30593 connection to be adjusted to a given value, given as one of a number of fixed
30594 strings or to numeric value.
30595 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30596 Common values include &`throughput`&, &`mincost`&, and on newer systems
30597 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30598
30599 The outbound packets from Exim will be marked with this value in the header
30600 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30601 that these values will have any effect, not be stripped by networking
30602 equipment, or do much of anything without cooperation with your Network
30603 Engineer and those of all network operators between the source and destination.
30604
30605
30606 .vitem &*control&~=&~enforce_sync*& &&&
30607        &*control&~=&~no_enforce_sync*&
30608 .cindex "SMTP" "synchronization checking"
30609 .cindex "synchronization checking in SMTP"
30610 These controls make it possible to be selective about when SMTP synchronization
30611 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30612 state of the switch (it is true by default). See the description of this option
30613 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30614
30615 The effect of these two controls lasts for the remainder of the SMTP
30616 connection. They can appear in any ACL except the one for the non-SMTP
30617 messages. The most straightforward place to put them is in the ACL defined by
30618 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30619 before the first synchronization check. The expected use is to turn off the
30620 synchronization checks for badly-behaved hosts that you nevertheless need to
30621 work with.
30622
30623
30624 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30625 .cindex "fake defer"
30626 .cindex "defer, fake"
30627 This control works in exactly the same way as &%fakereject%& (described below)
30628 except that it causes an SMTP 450 response after the message data instead of a
30629 550 response. You must take care when using &%fakedefer%& because it causes the
30630 messages to be duplicated when the sender retries. Therefore, you should not
30631 use &%fakedefer%& if the message is to be delivered normally.
30632
30633 .vitem &*control&~=&~fakereject/*&<&'message'&>
30634 .cindex "fake rejection"
30635 .cindex "rejection, fake"
30636 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30637 words, only when an SMTP message is being received. If Exim accepts the
30638 message, instead the final 250 response, a 550 rejection message is sent.
30639 However, Exim proceeds to deliver the message as normal. The control applies
30640 only to the current message, not to any subsequent ones that may be received in
30641 the same SMTP connection.
30642
30643 The text for the 550 response is taken from the &%control%& modifier. If no
30644 message is supplied, the following is used:
30645 .code
30646 550-Your message has been rejected but is being
30647 550-kept for evaluation.
30648 550-If it was a legitimate message, it may still be
30649 550 delivered to the target recipient(s).
30650 .endd
30651 This facility should be used with extreme caution.
30652
30653 .vitem &*control&~=&~freeze*&
30654 .cindex "frozen messages" "forcing in ACL"
30655 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30656 other words, only when a message is being received. If the message is accepted,
30657 it is placed on Exim's queue and frozen. The control applies only to the
30658 current message, not to any subsequent ones that may be received in the same
30659 SMTP connection.
30660
30661 This modifier can optionally be followed by &`/no_tell`&. If the global option
30662 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30663 is told about the freezing), provided all the &*control=freeze*& modifiers that
30664 are obeyed for the current message have the &`/no_tell`& option.
30665
30666 .vitem &*control&~=&~no_delay_flush*&
30667 .cindex "SMTP" "output flushing, disabling for delay"
30668 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30669 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30670 use. This control, as long as it is encountered before the &%delay%& modifier,
30671 disables such output flushing.
30672
30673 .vitem &*control&~=&~no_callout_flush*&
30674 .cindex "SMTP" "output flushing, disabling for callout"
30675 Exim normally flushes SMTP output before performing a callout in an ACL, to
30676 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30677 use. This control, as long as it is encountered before the &%verify%& condition
30678 that causes the callout, disables such output flushing.
30679
30680 .vitem &*control&~=&~no_mbox_unspool*&
30681 This control is available when Exim is compiled with the content scanning
30682 extension. Content scanning may require a copy of the current message, or parts
30683 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30684 or spam scanner. Normally, such copies are deleted when they are no longer
30685 needed. If this control is set, the copies are not deleted. The control applies
30686 only to the current message, not to any subsequent ones that may be received in
30687 the same SMTP connection. It is provided for debugging purposes and is unlikely
30688 to be useful in production.
30689
30690 .vitem &*control&~=&~no_multiline_responses*&
30691 .cindex "multiline responses, suppressing"
30692 This control is permitted for any ACL except the one for non-SMTP messages.
30693 It seems that there are broken clients in use that cannot handle multiline
30694 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30695
30696 If this control is set, multiline SMTP responses from ACL rejections are
30697 suppressed. One way of doing this would have been to put out these responses as
30698 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30699 (&"use multiline responses for more"& it says &-- ha!), and some of the
30700 responses might get close to that. So this facility, which is after all only a
30701 sop to broken clients, is implemented by doing two very easy things:
30702
30703 .ilist
30704 Extra information that is normally output as part of a rejection caused by
30705 sender verification failure is omitted. Only the final line (typically &"sender
30706 verification failed"&) is sent.
30707 .next
30708 If a &%message%& modifier supplies a multiline response, only the first
30709 line is output.
30710 .endlist
30711
30712 The setting of the switch can, of course, be made conditional on the
30713 calling host. Its effect lasts until the end of the SMTP connection.
30714
30715 .vitem &*control&~=&~no_pipelining*&
30716 .cindex "PIPELINING" "suppressing advertising"
30717 This control turns off the advertising of the PIPELINING extension to SMTP in
30718 the current session. To be useful, it must be obeyed before Exim sends its
30719 response to an EHLO command. Therefore, it should normally appear in an ACL
30720 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30721 &%pipelining_advertise_hosts%&.
30722
30723 .new
30724 .vitem &*control&~=&~queue/*&<&'options'&>*
30725 .vitem &*control&~=&~queue_only*&
30726 .oindex "&%queue%&"
30727 .oindex "&%queue_only%&"
30728 .cindex "queueing incoming messages"
30729 .cindex queueing "forcing in ACL"
30730 .cindex "first pass routing"
30731 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30732 other words, only when a message is being received. If the message is accepted,
30733 it is placed on Exim's queue and left there for delivery by a subsequent queue
30734 runner.
30735 If used with no options set,
30736 no immediate delivery process is started. In other words, it has the
30737 effect as the &%queue_only%& global option or &'-odq'& command-line option.
30738
30739 If the &'first_pass_route'& option is given then
30740 the behaviour is like the command-line &'-oqds'& option;
30741 a delivery process is started which stops short of making
30742 any SMTP delivery.  The benefit is that the hints database will be updated for
30743 the message being waiting for a specific host, and a later queue run will be
30744 able to send all such messages on a single connection.
30745
30746 The control only applies to the current message, not to any subsequent ones that
30747  may be received in the same SMTP connection.
30748 .wen
30749
30750 .vitem &*control&~=&~submission/*&<&'options'&>
30751 .cindex "message" "submission"
30752 .cindex "submission mode"
30753 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30754 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30755 the current message is a submission from a local MUA. In this case, Exim
30756 operates in &"submission mode"&, and applies certain fixups to the message if
30757 necessary. For example, it adds a &'Date:'& header line if one is not present.
30758 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30759 late (the message has already been created).
30760
30761 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30762 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30763 submission mode; the available options for this control are described there.
30764 The control applies only to the current message, not to any subsequent ones
30765 that may be received in the same SMTP connection.
30766
30767 .vitem &*control&~=&~suppress_local_fixups*&
30768 .cindex "submission fixups, suppressing"
30769 This control applies to locally submitted (non TCP/IP) messages, and is the
30770 complement of &`control = submission`&. It disables the fixups that are
30771 normally applied to locally-submitted messages. Specifically:
30772
30773 .ilist
30774 Any &'Sender:'& header line is left alone (in this respect, it is a
30775 dynamic version of &%local_sender_retain%&).
30776 .next
30777 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30778 .next
30779 There is no check that &'From:'& corresponds to the actual sender.
30780 .endlist ilist
30781
30782 This control may be useful when a remotely-originated message is accepted,
30783 passed to some scanning program, and then re-submitted for delivery. It can be
30784 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30785 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30786 data is read.
30787
30788 &*Note:*& This control applies only to the current message, not to any others
30789 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30790
30791 .vitem &*control&~=&~utf8_downconvert*&
30792 This control enables conversion of UTF-8 in message addresses
30793 to a-label form.
30794 For details see section &<<SECTi18nMTA>>&.
30795 .endlist vlist
30796
30797
30798 .section "Summary of message fixup control" "SECTsummesfix"
30799 All four possibilities for message fixups can be specified:
30800
30801 .ilist
30802 Locally submitted, fixups applied: the default.
30803 .next
30804 Locally submitted, no fixups applied: use
30805 &`control = suppress_local_fixups`&.
30806 .next
30807 Remotely submitted, no fixups applied: the default.
30808 .next
30809 Remotely submitted, fixups applied: use &`control = submission`&.
30810 .endlist
30811
30812
30813
30814 .section "Adding header lines in ACLs" "SECTaddheadacl"
30815 .cindex "header lines" "adding in an ACL"
30816 .cindex "header lines" "position of added lines"
30817 .cindex "&%add_header%& ACL modifier"
30818 The &%add_header%& modifier can be used to add one or more extra header lines
30819 to an incoming message, as in this example:
30820 .code
30821 warn dnslists = sbl.spamhaus.org : \
30822                 dialup.mail-abuse.org
30823      add_header = X-blacklisted-at: $dnslist_domain
30824 .endd
30825 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30826 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30827 receiving a message). The message must ultimately be accepted for
30828 &%add_header%& to have any significant effect. You can use &%add_header%& with
30829 any ACL verb, including &%deny%& (though this is potentially useful only in a
30830 RCPT ACL).
30831
30832 Headers will not be added to the message if the modifier is used in
30833 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30834
30835 Leading and trailing newlines are removed from
30836 the data for the &%add_header%& modifier; if it then
30837 contains one or more newlines that
30838 are not followed by a space or a tab, it is assumed to contain multiple header
30839 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30840 front of any line that is not a valid header line.
30841
30842 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30843 They are added to the message before processing the DATA and MIME ACLs.
30844 However, if an identical header line is requested more than once, only one copy
30845 is actually added to the message. Further header lines may be accumulated
30846 during the DATA and MIME ACLs, after which they are added to the message, again
30847 with duplicates suppressed. Thus, it is possible to add two identical header
30848 lines to an SMTP message, but only if one is added before DATA and one after.
30849 In the case of non-SMTP messages, new headers are accumulated during the
30850 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30851 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30852 are included in the entry that is written to the reject log.
30853
30854 .cindex "header lines" "added; visibility of"
30855 Header lines are not visible in string expansions
30856 of message headers
30857 until they are added to the
30858 message. It follows that header lines defined in the MAIL, RCPT, and predata
30859 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30860 header lines that are added by the DATA or MIME ACLs are not visible in those
30861 ACLs. Because of this restriction, you cannot use header lines as a way of
30862 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30863 this, you can use ACL variables, as described in section
30864 &<<SECTaclvariables>>&.
30865
30866 The list of headers yet to be added is given by the &%$headers_added%& variable.
30867
30868 The &%add_header%& modifier acts immediately as it is encountered during the
30869 processing of an ACL. Notice the difference between these two cases:
30870 .display
30871 &`accept add_header = ADDED: some text`&
30872 &`       `&<&'some condition'&>
30873
30874 &`accept `&<&'some condition'&>
30875 &`       add_header = ADDED: some text`&
30876 .endd
30877 In the first case, the header line is always added, whether or not the
30878 condition is true. In the second case, the header line is added only if the
30879 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30880 ACL statement. All those that are encountered before a condition fails are
30881 honoured.
30882
30883 .cindex "&%warn%& ACL verb"
30884 For compatibility with previous versions of Exim, a &%message%& modifier for a
30885 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30886 effect only if all the conditions are true, even if it appears before some of
30887 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30888 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30889 are present on a &%warn%& verb, both are processed according to their
30890 specifications.
30891
30892 By default, new header lines are added to a message at the end of the existing
30893 header lines. However, you can specify that any particular header line should
30894 be added right at the start (before all the &'Received:'& lines), immediately
30895 after the first block of &'Received:'& lines, or immediately before any line
30896 that is not a &'Received:'& or &'Resent-something:'& header.
30897
30898 This is done by specifying &":at_start:"&, &":after_received:"&, or
30899 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30900 header line, respectively. (Header text cannot start with a colon, as there has
30901 to be a header name first.) For example:
30902 .code
30903 warn add_header = \
30904        :after_received:X-My-Header: something or other...
30905 .endd
30906 If more than one header line is supplied in a single &%add_header%& modifier,
30907 each one is treated independently and can therefore be placed differently. If
30908 you add more than one line at the start, or after the Received: block, they end
30909 up in reverse order.
30910
30911 &*Warning*&: This facility currently applies only to header lines that are
30912 added in an ACL. It does NOT work for header lines that are added in a
30913 system filter or in a router or transport.
30914
30915
30916
30917 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30918 .cindex "header lines" "removing in an ACL"
30919 .cindex "header lines" "position of removed lines"
30920 .cindex "&%remove_header%& ACL modifier"
30921 The &%remove_header%& modifier can be used to remove one or more header lines
30922 from an incoming message, as in this example:
30923 .code
30924 warn   message        = Remove internal headers
30925        remove_header  = x-route-mail1 : x-route-mail2
30926 .endd
30927 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30928 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30929 receiving a message). The message must ultimately be accepted for
30930 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30931 with any ACL verb, including &%deny%&, though this is really not useful for
30932 any verb that doesn't result in a delivered message.
30933
30934 Headers will not be removed from the message if the modifier is used in
30935 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30936
30937 More than one header can be removed at the same time by using a colon separated
30938 list of header names. The header matching is case insensitive. Wildcards are
30939 not permitted, nor is list expansion performed, so you cannot use hostlists to
30940 create a list of headers, however both connection and message variable expansion
30941 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30942 .code
30943 warn   hosts           = +internal_hosts
30944        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30945 warn   message         = Remove internal headers
30946        remove_header   = $acl_c_ihdrs
30947 .endd
30948 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30949 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30950 If multiple header lines match, all are removed.
30951 There is no harm in attempting to remove the same header twice nor in removing
30952 a non-existent header. Further header lines to be removed may be accumulated
30953 during the DATA and MIME ACLs, after which they are removed from the message,
30954 if present. In the case of non-SMTP messages, headers to be removed are
30955 accumulated during the non-SMTP ACLs, and are removed from the message after
30956 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30957 ACL, there really is no effect because there is no logging of what headers
30958 would have been removed.
30959
30960 .cindex "header lines" "removed; visibility of"
30961 Header lines are not visible in string expansions until the DATA phase when it
30962 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30963 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30964 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30965 this restriction, you cannot use header lines as a way of controlling data
30966 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30967 you should instead use ACL variables, as described in section
30968 &<<SECTaclvariables>>&.
30969
30970 The &%remove_header%& modifier acts immediately as it is encountered during the
30971 processing of an ACL. Notice the difference between these two cases:
30972 .display
30973 &`accept remove_header = X-Internal`&
30974 &`       `&<&'some condition'&>
30975
30976 &`accept `&<&'some condition'&>
30977 &`       remove_header = X-Internal`&
30978 .endd
30979 In the first case, the header line is always removed, whether or not the
30980 condition is true. In the second case, the header line is removed only if the
30981 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30982 same ACL statement. All those that are encountered before a condition fails
30983 are honoured.
30984
30985 &*Warning*&: This facility currently applies only to header lines that are
30986 present during ACL processing. It does NOT remove header lines that are added
30987 in a system filter or in a router or transport.
30988
30989
30990
30991
30992 .section "ACL conditions" "SECTaclconditions"
30993 .cindex "&ACL;" "conditions; list of"
30994 Some of the conditions listed in this section are available only when Exim is
30995 compiled with the content-scanning extension. They are included here briefly
30996 for completeness. More detailed descriptions can be found in the discussion on
30997 content scanning in chapter &<<CHAPexiscan>>&.
30998
30999 Not all conditions are relevant in all circumstances. For example, testing
31000 senders and recipients does not make sense in an ACL that is being run as the
31001 result of the arrival of an ETRN command, and checks on message headers can be
31002 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31003 can use the same condition (with different parameters) more than once in the
31004 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31005 The conditions are as follows:
31006
31007
31008 .vlist
31009 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31010 .cindex "&ACL;" "nested"
31011 .cindex "&ACL;" "indirect"
31012 .cindex "&ACL;" "arguments"
31013 .cindex "&%acl%& ACL condition"
31014 The possible values of the argument are the same as for the
31015 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31016 &"accept"& the condition is true; if it returns &"deny"& the condition is
31017 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31018 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31019 condition false. This means that further processing of the &%warn%& verb
31020 ceases, but processing of the ACL continues.
31021
31022 If the argument is a named ACL, up to nine space-separated optional values
31023 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31024 and $acl_narg is set to the count of values.
31025 Previous values of these variables are restored after the call returns.
31026 The name and values are expanded separately.
31027 Note that spaces in complex expansions which are used as arguments
31028 will act as argument separators.
31029
31030 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31031 the connection is dropped. If it returns &"discard"&, the verb must be
31032 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31033 conditions are tested.
31034
31035 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31036 loops. This condition allows you to use different ACLs in different
31037 circumstances. For example, different ACLs can be used to handle RCPT commands
31038 for different local users or different local domains.
31039
31040 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31041 .cindex "&%authenticated%& ACL condition"
31042 .cindex "authentication" "ACL checking"
31043 .cindex "&ACL;" "testing for authentication"
31044 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31045 the name of the authenticator is tested against the list. To test for
31046 authentication by any authenticator, you can set
31047 .code
31048 authenticated = *
31049 .endd
31050
31051 .vitem &*condition&~=&~*&<&'string'&>
31052 .cindex "&%condition%& ACL condition"
31053 .cindex "customizing" "ACL condition"
31054 .cindex "&ACL;" "customized test"
31055 .cindex "&ACL;" "testing, customized"
31056 This feature allows you to make up custom conditions. If the result of
31057 expanding the string is an empty string, the number zero, or one of the strings
31058 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31059 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31060 any other value, some error is assumed to have occurred, and the ACL returns
31061 &"defer"&. However, if the expansion is forced to fail, the condition is
31062 ignored. The effect is to treat it as true, whether it is positive or
31063 negative.
31064
31065 .vitem &*decode&~=&~*&<&'location'&>
31066 .cindex "&%decode%& ACL condition"
31067 This condition is available only when Exim is compiled with the
31068 content-scanning extension, and it is allowed only in the ACL defined by
31069 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31070 If all goes well, the condition is true. It is false only if there are
31071 problems such as a syntax error or a memory shortage. For more details, see
31072 chapter &<<CHAPexiscan>>&.
31073
31074 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31075 .cindex "&%dnslists%& ACL condition"
31076 .cindex "DNS list" "in ACL"
31077 .cindex "black list (DNS)"
31078 .cindex "&ACL;" "testing a DNS list"
31079 This condition checks for entries in DNS black lists. These are also known as
31080 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31081 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31082 different variants of this condition to describe briefly here. See sections
31083 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31084
31085 .vitem &*domains&~=&~*&<&'domain&~list'&>
31086 .cindex "&%domains%& ACL condition"
31087 .cindex "domain" "ACL checking"
31088 .cindex "&ACL;" "testing a recipient domain"
31089 .vindex "&$domain_data$&"
31090 This condition is relevant only after a RCPT command. It checks that the domain
31091 of the recipient address is in the domain list. If percent-hack processing is
31092 enabled, it is done before this test is done. If the check succeeds with a
31093 lookup, the result of the lookup is placed in &$domain_data$& until the next
31094 &%domains%& test.
31095
31096 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31097 use &%domains%& in a DATA ACL.
31098
31099
31100 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31101 .cindex "&%encrypted%& ACL condition"
31102 .cindex "encryption" "checking in an ACL"
31103 .cindex "&ACL;" "testing for encryption"
31104 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31105 name of the cipher suite in use is tested against the list. To test for
31106 encryption without testing for any specific cipher suite(s), set
31107 .code
31108 encrypted = *
31109 .endd
31110
31111
31112 .vitem &*hosts&~=&~*&<&'host&~list'&>
31113 .cindex "&%hosts%& ACL condition"
31114 .cindex "host" "ACL checking"
31115 .cindex "&ACL;" "testing the client host"
31116 This condition tests that the calling host matches the host list. If you have
31117 name lookups or wildcarded host names and IP addresses in the same host list,
31118 you should normally put the IP addresses first. For example, you could have:
31119 .code
31120 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31121 .endd
31122 The lookup in this example uses the host name for its key. This is implied by
31123 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31124 and it wouldn't matter which way round you had these two items.)
31125
31126 The reason for the problem with host names lies in the left-to-right way that
31127 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31128 but when it reaches an item that requires a host name, it fails if it cannot
31129 find a host name to compare with the pattern. If the above list is given in the
31130 opposite order, the &%accept%& statement fails for a host whose name cannot be
31131 found, even if its IP address is 10.9.8.7.
31132
31133 If you really do want to do the name check first, and still recognize the IP
31134 address even if the name lookup fails, you can rewrite the ACL like this:
31135 .code
31136 accept hosts = dbm;/etc/friendly/hosts
31137 accept hosts = 10.9.8.7
31138 .endd
31139 The default action on failing to find the host name is to assume that the host
31140 is not in the list, so the first &%accept%& statement fails. The second
31141 statement can then check the IP address.
31142
31143 .vindex "&$host_data$&"
31144 If a &%hosts%& condition is satisfied by means of a lookup, the result
31145 of the lookup is made available in the &$host_data$& variable. This
31146 allows you, for example, to set up a statement like this:
31147 .code
31148 deny  hosts = net-lsearch;/some/file
31149 message = $host_data
31150 .endd
31151 which gives a custom error message for each denied host.
31152
31153 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31154 .cindex "&%local_parts%& ACL condition"
31155 .cindex "local part" "ACL checking"
31156 .cindex "&ACL;" "testing a local part"
31157 .vindex "&$local_part_data$&"
31158 This condition is relevant only after a RCPT command. It checks that the local
31159 part of the recipient address is in the list. If percent-hack processing is
31160 enabled, it is done before this test. If the check succeeds with a lookup, the
31161 result of the lookup is placed in &$local_part_data$&, which remains set until
31162 the next &%local_parts%& test.
31163
31164 .vitem &*malware&~=&~*&<&'option'&>
31165 .cindex "&%malware%& ACL condition"
31166 .cindex "&ACL;" "virus scanning"
31167 .cindex "&ACL;" "scanning for viruses"
31168 This condition is available only when Exim is compiled with the
31169 content-scanning extension
31170 and only after a DATA command.
31171 It causes the incoming message to be scanned for
31172 viruses. For details, see chapter &<<CHAPexiscan>>&.
31173
31174 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31175 .cindex "&%mime_regex%& ACL condition"
31176 .cindex "&ACL;" "testing by regex matching"
31177 This condition is available only when Exim is compiled with the
31178 content-scanning extension, and it is allowed only in the ACL defined by
31179 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31180 with any of the regular expressions. For details, see chapter
31181 &<<CHAPexiscan>>&.
31182
31183 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31184 .cindex "rate limiting"
31185 This condition can be used to limit the rate at which a user or host submits
31186 messages. Details are given in section &<<SECTratelimiting>>&.
31187
31188 .vitem &*recipients&~=&~*&<&'address&~list'&>
31189 .cindex "&%recipients%& ACL condition"
31190 .cindex "recipient" "ACL checking"
31191 .cindex "&ACL;" "testing a recipient"
31192 This condition is relevant only after a RCPT command. It checks the entire
31193 recipient address against a list of recipients.
31194
31195 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31196 .cindex "&%regex%& ACL condition"
31197 .cindex "&ACL;" "testing by regex matching"
31198 This condition is available only when Exim is compiled with the
31199 content-scanning extension, and is available only in the DATA, MIME, and
31200 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31201 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31202
31203 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31204 .cindex "&%sender_domains%& ACL condition"
31205 .cindex "sender" "ACL checking"
31206 .cindex "&ACL;" "testing a sender domain"
31207 .vindex "&$domain$&"
31208 .vindex "&$sender_address_domain$&"
31209 This condition tests the domain of the sender of the message against the given
31210 domain list. &*Note*&: The domain of the sender address is in
31211 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31212 of this condition. This is an exception to the general rule for testing domain
31213 lists. It is done this way so that, if this condition is used in an ACL for a
31214 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31215 influence the sender checking.
31216
31217 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31218 relaying, because sender addresses are easily, and commonly, forged.
31219
31220 .vitem &*senders&~=&~*&<&'address&~list'&>
31221 .cindex "&%senders%& ACL condition"
31222 .cindex "sender" "ACL checking"
31223 .cindex "&ACL;" "testing a sender"
31224 This condition tests the sender of the message against the given list. To test
31225 for a bounce message, which has an empty sender, set
31226 .code
31227 senders = :
31228 .endd
31229 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31230 relaying, because sender addresses are easily, and commonly, forged.
31231
31232 .vitem &*spam&~=&~*&<&'username'&>
31233 .cindex "&%spam%& ACL condition"
31234 .cindex "&ACL;" "scanning for spam"
31235 This condition is available only when Exim is compiled with the
31236 content-scanning extension. It causes the incoming message to be scanned by
31237 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31238
31239 .vitem &*verify&~=&~certificate*&
31240 .cindex "&%verify%& ACL condition"
31241 .cindex "TLS" "client certificate verification"
31242 .cindex "certificate" "verification of client"
31243 .cindex "&ACL;" "certificate verification"
31244 .cindex "&ACL;" "testing a TLS certificate"
31245 This condition is true in an SMTP session if the session is encrypted, and a
31246 certificate was received from the client, and the certificate was verified. The
31247 server requests a certificate only if the client matches &%tls_verify_hosts%&
31248 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31249
31250 .vitem &*verify&~=&~csa*&
31251 .cindex "CSA verification"
31252 This condition checks whether the sending host (the client) is authorized to
31253 send email. Details of how this works are given in section
31254 &<<SECTverifyCSA>>&.
31255
31256 .vitem &*verify&~=&~header_names_ascii*&
31257 .cindex "&%verify%& ACL condition"
31258 .cindex "&ACL;" "verifying header names only ASCII"
31259 .cindex "header lines" "verifying header names only ASCII"
31260 .cindex "verifying" "header names only ASCII"
31261 This condition is relevant only in an ACL that is run after a message has been
31262 received, that is, in an ACL specified by &%acl_smtp_data%& or
31263 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31264 there are no non-ASCII characters, also excluding control characters.  The
31265 allowable characters are decimal ASCII values 33 through 126.
31266
31267 Exim itself will handle headers with non-ASCII characters, but it can cause
31268 problems for downstream applications, so this option will allow their
31269 detection and rejection in the DATA ACL's.
31270
31271 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31272 .cindex "&%verify%& ACL condition"
31273 .cindex "&ACL;" "verifying sender in the header"
31274 .cindex "header lines" "verifying the sender in"
31275 .cindex "sender" "verifying in header"
31276 .cindex "verifying" "sender in header"
31277 This condition is relevant only in an ACL that is run after a message has been
31278 received, that is, in an ACL specified by &%acl_smtp_data%& or
31279 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31280 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31281 is loosely thought of as a &"sender"& address (hence the name of the test).
31282 However, an address that appears in one of these headers need not be an address
31283 that accepts bounce messages; only sender addresses in envelopes are required
31284 to accept bounces. Therefore, if you use the callout option on this check, you
31285 might want to arrange for a non-empty address in the MAIL command.
31286
31287 Details of address verification and the options are given later, starting at
31288 section &<<SECTaddressverification>>& (callouts are described in section
31289 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31290 condition to restrict it to bounce messages only:
31291 .code
31292 deny    senders = :
31293         message = A valid sender header is required for bounces
31294        !verify  = header_sender
31295 .endd
31296
31297 .vitem &*verify&~=&~header_syntax*&
31298 .cindex "&%verify%& ACL condition"
31299 .cindex "&ACL;" "verifying header syntax"
31300 .cindex "header lines" "verifying syntax"
31301 .cindex "verifying" "header syntax"
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 the syntax of all header lines that can contain
31305 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31306 and &'Bcc:'&), returning true if there are no problems.
31307 Unqualified addresses (local parts without domains) are
31308 permitted only in locally generated messages and from hosts that match
31309 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31310 appropriate.
31311
31312 Note that this condition is a syntax check only. However, a common spamming
31313 ploy used to be to send syntactically invalid headers such as
31314 .code
31315 To: @
31316 .endd
31317 and this condition can be used to reject such messages, though they are not as
31318 common as they used to be.
31319
31320 .vitem &*verify&~=&~helo*&
31321 .cindex "&%verify%& ACL condition"
31322 .cindex "&ACL;" "verifying HELO/EHLO"
31323 .cindex "HELO" "verifying"
31324 .cindex "EHLO" "verifying"
31325 .cindex "verifying" "EHLO"
31326 .cindex "verifying" "HELO"
31327 This condition is true if a HELO or EHLO command has been received from the
31328 client host, and its contents have been verified. If there has been no previous
31329 attempt to verify the HELO/EHLO contents, it is carried out when this
31330 condition is encountered. See the description of the &%helo_verify_hosts%& and
31331 &%helo_try_verify_hosts%& options for details of how to request verification
31332 independently of this condition, and for detail of the verification.
31333
31334 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31335 option), this condition is always true.
31336
31337
31338 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31339 .cindex "verifying" "not blind"
31340 .cindex "bcc recipients, verifying none"
31341 This condition checks that there are no blind (bcc) recipients in the message.
31342 Every envelope recipient must appear either in a &'To:'& header line or in a
31343 &'Cc:'& header line for this condition to be true. Local parts are checked
31344 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31345 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31346 used only in a DATA or non-SMTP ACL.
31347
31348 There is one possible option, &`case_insensitive`&.  If this is present then
31349 local parts are checked case-insensitively.
31350
31351 There are, of course, many legitimate messages that make use of blind (bcc)
31352 recipients. This check should not be used on its own for blocking messages.
31353
31354
31355 .vitem &*verify&~=&~recipient/*&<&'options'&>
31356 .cindex "&%verify%& ACL condition"
31357 .cindex "&ACL;" "verifying recipient"
31358 .cindex "recipient" "verifying"
31359 .cindex "verifying" "recipient"
31360 .vindex "&$address_data$&"
31361 This condition is relevant only after a RCPT command. It verifies the current
31362 recipient. Details of address verification are given later, starting at section
31363 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31364 of &$address_data$& is the last value that was set while routing the address.
31365 This applies even if the verification fails. When an address that is being
31366 verified is redirected to a single address, verification continues with the new
31367 address, and in that case, the subsequent value of &$address_data$& is the
31368 value for the child address.
31369
31370 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31371 .cindex "&%verify%& ACL condition"
31372 .cindex "&ACL;" "verifying host reverse lookup"
31373 .cindex "host" "verifying reverse lookup"
31374 This condition ensures that a verified host name has been looked up from the IP
31375 address of the client host. (This may have happened already if the host name
31376 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31377 Verification ensures that the host name obtained from a reverse DNS lookup, or
31378 one of its aliases, does, when it is itself looked up in the DNS, yield the
31379 original IP address.
31380
31381 There is one possible option, &`defer_ok`&.  If this is present and a
31382 DNS operation returns a temporary error, the verify condition succeeds.
31383
31384 If this condition is used for a locally generated message (that is, when there
31385 is no client host involved), it always succeeds.
31386
31387 .vitem &*verify&~=&~sender/*&<&'options'&>
31388 .cindex "&%verify%& ACL condition"
31389 .cindex "&ACL;" "verifying sender"
31390 .cindex "sender" "verifying"
31391 .cindex "verifying" "sender"
31392 This condition is relevant only after a MAIL or RCPT command, or after a
31393 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31394 the message's sender is empty (that is, this is a bounce message), the
31395 condition is true. Otherwise, the sender address is verified.
31396
31397 .vindex "&$address_data$&"
31398 .vindex "&$sender_address_data$&"
31399 If there is data in the &$address_data$& variable at the end of routing, its
31400 value is placed in &$sender_address_data$& at the end of verification. This
31401 value can be used in subsequent conditions and modifiers in the same ACL
31402 statement. It does not persist after the end of the current statement. If you
31403 want to preserve the value for longer, you can save it in an ACL variable.
31404
31405 Details of verification are given later, starting at section
31406 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31407 to avoid doing it more than once per message.
31408
31409 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31410 .cindex "&%verify%& ACL condition"
31411 This is a variation of the previous option, in which a modified address is
31412 verified as a sender.
31413
31414 Note that '/' is legal in local-parts; if the address may have such
31415 (eg. is generated from the received message)
31416 they must be protected from the options parsing by doubling:
31417 .code
31418 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31419 .endd
31420 .endlist
31421
31422
31423
31424 .section "Using DNS lists" "SECTmorednslists"
31425 .cindex "DNS list" "in ACL"
31426 .cindex "black list (DNS)"
31427 .cindex "&ACL;" "testing a DNS list"
31428 In its simplest form, the &%dnslists%& condition tests whether the calling host
31429 is on at least one of a number of DNS lists by looking up the inverted IP
31430 address in one or more DNS domains. (Note that DNS list domains are not mail
31431 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31432 special options instead.) For example, if the calling host's IP
31433 address is 192.168.62.43, and the ACL statement is
31434 .code
31435 deny dnslists = blackholes.mail-abuse.org : \
31436                 dialups.mail-abuse.org
31437 .endd
31438 the following records are looked up:
31439 .code
31440 43.62.168.192.blackholes.mail-abuse.org
31441 43.62.168.192.dialups.mail-abuse.org
31442 .endd
31443 As soon as Exim finds an existing DNS record, processing of the list stops.
31444 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31445 to test that a host is on more than one list (an &"and"& conjunction), you can
31446 use two separate conditions:
31447 .code
31448 deny dnslists = blackholes.mail-abuse.org
31449      dnslists = dialups.mail-abuse.org
31450 .endd
31451 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31452 behaves as if the host does not match the list item, that is, as if the DNS
31453 record does not exist. If there are further items in the DNS list, they are
31454 processed.
31455
31456 This is usually the required action when &%dnslists%& is used with &%deny%&
31457 (which is the most common usage), because it prevents a DNS failure from
31458 blocking mail. However, you can change this behaviour by putting one of the
31459 following special items in the list:
31460 .display
31461 &`+include_unknown `&   behave as if the item is on the list
31462 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31463 &`+defer_unknown   `&   give a temporary error
31464 .endd
31465 .cindex "&`+include_unknown`&"
31466 .cindex "&`+exclude_unknown`&"
31467 .cindex "&`+defer_unknown`&"
31468 Each of these applies to any subsequent items on the list. For example:
31469 .code
31470 deny dnslists = +defer_unknown : foo.bar.example
31471 .endd
31472 Testing the list of domains stops as soon as a match is found. If you want to
31473 warn for one list and block for another, you can use two different statements:
31474 .code
31475 deny  dnslists = blackholes.mail-abuse.org
31476 warn  message  = X-Warn: sending host is on dialups list
31477       dnslists = dialups.mail-abuse.org
31478 .endd
31479 .cindex caching "of dns lookup"
31480 .cindex DNS TTL
31481 DNS list lookups are cached by Exim for the duration of the SMTP session
31482 (but limited by the DNS return TTL value),
31483 so a lookup based on the IP address is done at most once for any incoming
31484 connection (assuming long-enough TTL).
31485 Exim does not share information between multiple incoming
31486 connections (but your local name server cache should be active).
31487
31488 There are a number of DNS lists to choose from, some commercial, some free,
31489 or free for small deployments.  An overview can be found at
31490 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31491
31492
31493
31494 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31495 .cindex "DNS list" "keyed by explicit IP address"
31496 By default, the IP address that is used in a DNS list lookup is the IP address
31497 of the calling host. However, you can specify another IP address by listing it
31498 after the domain name, introduced by a slash. For example:
31499 .code
31500 deny dnslists = black.list.tld/192.168.1.2
31501 .endd
31502 This feature is not very helpful with explicit IP addresses; it is intended for
31503 use with IP addresses that are looked up, for example, the IP addresses of the
31504 MX hosts or nameservers of an email sender address. For an example, see section
31505 &<<SECTmulkeyfor>>& below.
31506
31507
31508
31509
31510 .section "DNS lists keyed on domain names" "SECID202"
31511 .cindex "DNS list" "keyed by domain name"
31512 There are some lists that are keyed on domain names rather than inverted IP
31513 addresses (see, e.g., the &'domain based zones'& link at
31514 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31515 with these lists. You can change the name that is looked up in a DNS list by
31516 listing it after the domain name, introduced by a slash. For example,
31517 .code
31518 deny  message  = Sender's domain is listed at $dnslist_domain
31519       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31520 .endd
31521 This particular example is useful only in ACLs that are obeyed after the
31522 RCPT or DATA commands, when a sender address is available. If (for
31523 example) the message's sender is &'user@tld.example'& the name that is looked
31524 up by this example is
31525 .code
31526 tld.example.dsn.rfc-ignorant.org
31527 .endd
31528 A single &%dnslists%& condition can contain entries for both names and IP
31529 addresses. For example:
31530 .code
31531 deny dnslists = sbl.spamhaus.org : \
31532                 dsn.rfc-ignorant.org/$sender_address_domain
31533 .endd
31534 The first item checks the sending host's IP address; the second checks a domain
31535 name. The whole condition is true if either of the DNS lookups succeeds.
31536
31537
31538
31539
31540 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31541 .cindex "DNS list" "multiple keys for"
31542 The syntax described above for looking up explicitly-defined values (either
31543 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31544 name for the DNS list, what follows the slash can in fact be a list of items.
31545 As with all lists in Exim, the default separator is a colon. However, because
31546 this is a sublist within the list of DNS blacklist domains, it is necessary
31547 either to double the separators like this:
31548 .code
31549 dnslists = black.list.tld/name.1::name.2
31550 .endd
31551 or to change the separator character, like this:
31552 .code
31553 dnslists = black.list.tld/<;name.1;name.2
31554 .endd
31555 If an item in the list is an IP address, it is inverted before the DNS
31556 blacklist domain is appended. If it is not an IP address, no inversion
31557 occurs. Consider this condition:
31558 .code
31559 dnslists = black.list.tld/<;192.168.1.2;a.domain
31560 .endd
31561 The DNS lookups that occur are:
31562 .code
31563 2.1.168.192.black.list.tld
31564 a.domain.black.list.tld
31565 .endd
31566 Once a DNS record has been found (that matches a specific IP return
31567 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31568 are done. If there is a temporary DNS error, the rest of the sublist of domains
31569 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31570 only if no other DNS lookup in this sublist succeeds. In other words, a
31571 successful lookup for any of the items in the sublist overrides a temporary
31572 error for a previous item.
31573
31574 The ability to supply a list of items after the slash is in some sense just a
31575 syntactic convenience. These two examples have the same effect:
31576 .code
31577 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31578 dnslists = black.list.tld/a.domain::b.domain
31579 .endd
31580 However, when the data for the list is obtained from a lookup, the second form
31581 is usually much more convenient. Consider this example:
31582 .code
31583 deny message  = The mail servers for the domain \
31584                 $sender_address_domain \
31585                 are listed at $dnslist_domain ($dnslist_value); \
31586                 see $dnslist_text.
31587      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31588                                    ${lookup dnsdb {>|mxh=\
31589                                    $sender_address_domain} }} }
31590 .endd
31591 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31592 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31593 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31594 of expanding the condition might be something like this:
31595 .code
31596 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31597 .endd
31598 Thus, this example checks whether or not the IP addresses of the sender
31599 domain's mail servers are on the Spamhaus black list.
31600
31601 The key that was used for a successful DNS list lookup is put into the variable
31602 &$dnslist_matched$& (see section &<<SECID204>>&).
31603
31604
31605
31606
31607 .section "Data returned by DNS lists" "SECID203"
31608 .cindex "DNS list" "data returned from"
31609 DNS lists are constructed using address records in the DNS. The original RBL
31610 just used the address 127.0.0.1 on the right hand side of each record, but the
31611 RBL+ list and some other lists use a number of values with different meanings.
31612 The values used on the RBL+ list are:
31613 .display
31614 127.1.0.1  RBL
31615 127.1.0.2  DUL
31616 127.1.0.3  DUL and RBL
31617 127.1.0.4  RSS
31618 127.1.0.5  RSS and RBL
31619 127.1.0.6  RSS and DUL
31620 127.1.0.7  RSS and DUL and RBL
31621 .endd
31622 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31623 different values. Some DNS lists may return more than one address record;
31624 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31625
31626
31627 .section "Variables set from DNS lists" "SECID204"
31628 .cindex "expansion" "variables, set from DNS list"
31629 .cindex "DNS list" "variables set from"
31630 .vindex "&$dnslist_domain$&"
31631 .vindex "&$dnslist_matched$&"
31632 .vindex "&$dnslist_text$&"
31633 .vindex "&$dnslist_value$&"
31634 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31635 the name of the overall domain that matched (for example,
31636 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31637 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31638 the DNS record. When the key is an IP address, it is not reversed in
31639 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31640 cases, for example:
31641 .code
31642 deny dnslists = spamhaus.example
31643 .endd
31644 the key is also available in another variable (in this case,
31645 &$sender_host_address$&). In more complicated cases, however, this is not true.
31646 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31647 might generate a dnslists lookup like this:
31648 .code
31649 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31650 .endd
31651 If this condition succeeds, the value in &$dnslist_matched$& might be
31652 &`192.168.6.7`& (for example).
31653
31654 If more than one address record is returned by the DNS lookup, all the IP
31655 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31656 The variable &$dnslist_text$& contains the contents of any associated TXT
31657 record. For lists such as RBL+ the TXT record for a merged entry is often not
31658 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31659 information.
31660
31661 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31662 &-- although these appear before the condition in the ACL, they are not
31663 expanded until after it has failed. For example:
31664 .code
31665 deny    hosts = !+local_networks
31666         message = $sender_host_address is listed \
31667                   at $dnslist_domain
31668         dnslists = rbl-plus.mail-abuse.example
31669 .endd
31670
31671
31672
31673 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31674 .cindex "DNS list" "matching specific returned data"
31675 You can add an equals sign and an IP address after a &%dnslists%& domain name
31676 in order to restrict its action to DNS records with a matching right hand side.
31677 For example,
31678 .code
31679 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31680 .endd
31681 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31682 any address record is considered to be a match. For the moment, we assume
31683 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31684 describes how multiple records are handled.
31685
31686 More than one IP address may be given for checking, using a comma as a
31687 separator. These are alternatives &-- if any one of them matches, the
31688 &%dnslists%& condition is true. For example:
31689 .code
31690 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31691 .endd
31692 If you want to specify a constraining address list and also specify names or IP
31693 addresses to be looked up, the constraining address list must be specified
31694 first. For example:
31695 .code
31696 deny dnslists = dsn.rfc-ignorant.org\
31697                 =127.0.0.2/$sender_address_domain
31698 .endd
31699
31700 If the character &`&&`& is used instead of &`=`&, the comparison for each
31701 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31702 In other words, the listed addresses are used as bit masks. The comparison is
31703 true if all the bits in the mask are present in the address that is being
31704 tested. For example:
31705 .code
31706 dnslists = a.b.c&0.0.0.3
31707 .endd
31708 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31709 want to test whether one bit or another bit is present (as opposed to both
31710 being present), you must use multiple values. For example:
31711 .code
31712 dnslists = a.b.c&0.0.0.1,0.0.0.2
31713 .endd
31714 matches if the final component of the address is an odd number or two times
31715 an odd number.
31716
31717
31718
31719 .section "Negated DNS matching conditions" "SECID205"
31720 You can supply a negative list of IP addresses as part of a &%dnslists%&
31721 condition. Whereas
31722 .code
31723 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31724 .endd
31725 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31726 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31727 .code
31728 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31729 .endd
31730 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31731 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31732 words, the result of the test is inverted if an exclamation mark appears before
31733 the &`=`& (or the &`&&`&) sign.
31734
31735 &*Note*&: This kind of negation is not the same as negation in a domain,
31736 host, or address list (which is why the syntax is different).
31737
31738 If you are using just one list, the negation syntax does not gain you much. The
31739 previous example is precisely equivalent to
31740 .code
31741 deny  dnslists = a.b.c
31742      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31743 .endd
31744 However, if you are using multiple lists, the negation syntax is clearer.
31745 Consider this example:
31746 .code
31747 deny  dnslists = sbl.spamhaus.org : \
31748                  list.dsbl.org : \
31749                  dnsbl.njabl.org!=127.0.0.3 : \
31750                  relays.ordb.org
31751 .endd
31752 Using only positive lists, this would have to be:
31753 .code
31754 deny  dnslists = sbl.spamhaus.org : \
31755                  list.dsbl.org
31756 deny  dnslists = dnsbl.njabl.org
31757      !dnslists = dnsbl.njabl.org=127.0.0.3
31758 deny  dnslists = relays.ordb.org
31759 .endd
31760 which is less clear, and harder to maintain.
31761
31762
31763
31764
31765 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31766 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31767 thereby providing more than one IP address. When an item in a &%dnslists%& list
31768 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31769 the match to specific results from the DNS lookup, there are two ways in which
31770 the checking can be handled. For example, consider the condition:
31771 .code
31772 dnslists = a.b.c=127.0.0.1
31773 .endd
31774 What happens if the DNS lookup for the incoming IP address yields both
31775 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31776 condition true because at least one given value was found, or is it false
31777 because at least one of the found values was not listed? And how does this
31778 affect negated conditions? Both possibilities are provided for with the help of
31779 additional separators &`==`& and &`=&&`&.
31780
31781 .ilist
31782 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31783 IP addresses matches one of the listed addresses. For the example above, the
31784 condition is true because 127.0.0.1 matches.
31785 .next
31786 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31787 looked up IP addresses matches one of the listed addresses. If the condition is
31788 changed to:
31789 .code
31790 dnslists = a.b.c==127.0.0.1
31791 .endd
31792 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31793 false because 127.0.0.2 is not listed. You would need to have:
31794 .code
31795 dnslists = a.b.c==127.0.0.1,127.0.0.2
31796 .endd
31797 for the condition to be true.
31798 .endlist
31799
31800 When &`!`& is used to negate IP address matching, it inverts the result, giving
31801 the precise opposite of the behaviour above. Thus:
31802 .ilist
31803 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31804 addresses matches one of the listed addresses. Consider:
31805 .code
31806 dnslists = a.b.c!&0.0.0.1
31807 .endd
31808 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31809 false because 127.0.0.1 matches.
31810 .next
31811 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31812 looked up IP address that does not match. Consider:
31813 .code
31814 dnslists = a.b.c!=&0.0.0.1
31815 .endd
31816 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31817 true, because 127.0.0.2 does not match. You would need to have:
31818 .code
31819 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31820 .endd
31821 for the condition to be false.
31822 .endlist
31823 When the DNS lookup yields only a single IP address, there is no difference
31824 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31825
31826
31827
31828
31829 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31830 .cindex "DNS list" "information from merged"
31831 When the facility for restricting the matching IP values in a DNS list is used,
31832 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31833 the true reason for rejection. This happens when lists are merged and the IP
31834 address in the A record is used to distinguish them; unfortunately there is
31835 only one TXT record. One way round this is not to use merged lists, but that
31836 can be inefficient because it requires multiple DNS lookups where one would do
31837 in the vast majority of cases when the host of interest is not on any of the
31838 lists.
31839
31840 A less inefficient way of solving this problem is available. If
31841 two domain names, comma-separated, are given, the second is used first to
31842 do an initial check, making use of any IP value restrictions that are set.
31843 If there is a match, the first domain is used, without any IP value
31844 restrictions, to get the TXT record. As a byproduct of this, there is also
31845 a check that the IP being tested is indeed on the first list. The first
31846 domain is the one that is put in &$dnslist_domain$&. For example:
31847 .code
31848 deny message  = \
31849          rejected because $sender_host_address is blacklisted \
31850          at $dnslist_domain\n$dnslist_text
31851        dnslists = \
31852          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31853          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31854 .endd
31855 For the first blacklist item, this starts by doing a lookup in
31856 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31857 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31858 value, and as long as something is found, it looks for the corresponding TXT
31859 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31860 The second blacklist item is processed similarly.
31861
31862 If you are interested in more than one merged list, the same list must be
31863 given several times, but because the results of the DNS lookups are cached,
31864 the DNS calls themselves are not repeated. For example:
31865 .code
31866 deny dnslists = \
31867          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31868          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31869          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31870          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31871 .endd
31872 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31873 values matches (or if no record is found), this is the only lookup that is
31874 done. Only if there is a match is one of the more specific lists consulted.
31875
31876
31877
31878 .section "DNS lists and IPv6" "SECTmorednslistslast"
31879 .cindex "IPv6" "DNS black lists"
31880 .cindex "DNS list" "IPv6 usage"
31881 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31882 nibble by nibble. For example, if the calling host's IP address is
31883 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31884 .code
31885 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31886   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31887 .endd
31888 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31889 lists contain wildcard records, intended for IPv4, that interact badly with
31890 IPv6. For example, the DNS entry
31891 .code
31892 *.3.some.list.example.    A    127.0.0.1
31893 .endd
31894 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31895 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31896
31897 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31898 &%condition%& condition, as in this example:
31899 .code
31900 deny   condition = ${if isip4{$sender_host_address}}
31901        dnslists  = some.list.example
31902 .endd
31903
31904 If an explicit key is being used for a DNS lookup and it may be an IPv6
31905 address you should specify alternate list separators for both the outer
31906 (DNS list name) list and inner (lookup keys) list:
31907 .code
31908        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31909 .endd
31910
31911 .section "Rate limiting incoming messages" "SECTratelimiting"
31912 .cindex "rate limiting" "client sending"
31913 .cindex "limiting client sending rates"
31914 .oindex "&%smtp_ratelimit_*%&"
31915 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31916 which clients can send email. This is more powerful than the
31917 &%smtp_ratelimit_*%& options, because those options control the rate of
31918 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31919 works across all connections (concurrent and sequential) from the same client
31920 host. The syntax of the &%ratelimit%& condition is:
31921 .display
31922 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31923 .endd
31924 If the average client sending rate is less than &'m'& messages per time
31925 period &'p'& then the condition is false; otherwise it is true.
31926
31927 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31928 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31929 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31930 of &'p'&.
31931
31932 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31933 time interval, for example, &`8h`& for eight hours. A larger time constant
31934 means that it takes Exim longer to forget a client's past behaviour. The
31935 parameter &'m'& is the maximum number of messages that a client is permitted to
31936 send in each time interval. It also specifies the number of messages permitted
31937 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31938 constant, you can allow a client to send more messages in a burst without
31939 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31940 both small, messages must be sent at an even rate.
31941
31942 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31943 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31944 when deploying the &%ratelimit%& ACL condition. The script prints usage
31945 instructions when it is run with no arguments.
31946
31947 The key is used to look up the data for calculating the client's average
31948 sending rate. This data is stored in Exim's spool directory, alongside the
31949 retry and other hints databases. The default key is &$sender_host_address$&,
31950 which means Exim computes the sending rate of each client host IP address.
31951 By changing the key you can change how Exim identifies clients for the purpose
31952 of ratelimiting. For example, to limit the sending rate of each authenticated
31953 user, independent of the computer they are sending from, set the key to
31954 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31955 example, &$authenticated_id$& is only meaningful if the client has
31956 authenticated (which you can check with the &%authenticated%& ACL condition).
31957
31958 The lookup key does not have to identify clients: If you want to limit the
31959 rate at which a recipient receives messages, you can use the key
31960 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31961 ACL.
31962
31963 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31964 specifies what Exim measures the rate of, for example, messages or recipients
31965 or bytes. You can adjust the measurement using the &%unique=%& and/or
31966 &%count=%& options. You can also control when Exim updates the recorded rate
31967 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31968 separated by a slash, like the other parameters. They may appear in any order.
31969
31970 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31971 any options that alter the meaning of the stored data. The limit &'m'& is not
31972 stored, so you can alter the configured maximum rate and Exim will still
31973 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31974 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31975 behaviour. The lookup key is not affected by changes to the update mode and
31976 the &%count=%& option.
31977
31978
31979 .section "Ratelimit options for what is being measured" "ratoptmea"
31980 .cindex "rate limiting" "per_* options"
31981 The &%per_conn%& option limits the client's connection rate. It is not
31982 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31983 &%acl_not_smtp_start%& ACLs.
31984
31985 The &%per_mail%& option limits the client's rate of sending messages. This is
31986 the default if none of the &%per_*%& options is specified. It can be used in
31987 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31988 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31989
31990 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31991 the same ACLs as the &%per_mail%& option, though it is best to use this option
31992 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31993 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31994 in its MAIL command, which may be inaccurate or completely missing. You can
31995 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31996 in kilobytes, megabytes, or gigabytes, respectively.
31997
31998 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31999 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32000 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32001 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32002 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32003 in either case the rate limiting engine will see a message with many
32004 recipients as a large high-speed burst.
32005
32006 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32007 number of different recipients that the client has sent messages to in the
32008 last time period. That is, if the client repeatedly sends messages to the same
32009 recipient, its measured rate is not increased. This option can only be used in
32010 &%acl_smtp_rcpt%&.
32011
32012 The &%per_cmd%& option causes Exim to recompute the rate every time the
32013 condition is processed. This can be used to limit the rate of any SMTP
32014 command. If it is used in multiple ACLs it can limit the aggregate rate of
32015 multiple different commands.
32016
32017 The &%count=%& option can be used to alter how much Exim adds to the client's
32018 measured rate. For example, the &%per_byte%& option is equivalent to
32019 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32020 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32021 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32022
32023 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32024
32025
32026 .section "Ratelimit update modes" "ratoptupd"
32027 .cindex "rate limiting" "reading data without updating"
32028 You can specify one of three options with the &%ratelimit%& condition to
32029 control when its database is updated. This section describes the &%readonly%&
32030 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32031
32032 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32033 previously-computed rate to check against the limit.
32034
32035 For example, you can test the client's sending rate and deny it access (when
32036 it is too fast) in the connect ACL. If the client passes this check then it
32037 can go on to send a message, in which case its recorded rate will be updated
32038 in the MAIL ACL. Subsequent connections from the same client will check this
32039 new rate.
32040 .code
32041 acl_check_connect:
32042  deny ratelimit = 100 / 5m / readonly
32043     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32044                   (max $sender_rate_limit)
32045 # ...
32046 acl_check_mail:
32047  warn ratelimit = 100 / 5m / strict
32048     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32049                   (max $sender_rate_limit)
32050 .endd
32051
32052 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32053 processing a message then it may increase the client's measured rate more than
32054 it should. For example, this will happen if you check the &%per_rcpt%& option
32055 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32056 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32057 multiple update problems by using the &%readonly%& option on later ratelimit
32058 checks.
32059
32060 The &%per_*%& options described above do not make sense in some ACLs. If you
32061 use a &%per_*%& option in an ACL where it is not normally permitted then the
32062 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32063 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32064 next section) so you must specify the &%readonly%& option explicitly.
32065
32066
32067 .section "Ratelimit options for handling fast clients" "ratoptfast"
32068 .cindex "rate limiting" "strict and leaky modes"
32069 If a client's average rate is greater than the maximum, the rate limiting
32070 engine can react in two possible ways, depending on the presence of the
32071 &%strict%& or &%leaky%& update modes. This is independent of the other
32072 counter-measures (such as rejecting the message) that may be specified by the
32073 rest of the ACL.
32074
32075 The &%leaky%& (default) option means that the client's recorded rate is not
32076 updated if it is above the limit. The effect of this is that Exim measures the
32077 client's average rate of successfully sent email,
32078 up to the given limit.
32079 This is appropriate if the countermeasure when the condition is true
32080 consists of refusing the message, and
32081 is generally the better choice if you have clients that retry automatically.
32082 If the action when true is anything more complex then this option is
32083 likely not what is wanted.
32084
32085 The &%strict%& option means that the client's recorded rate is always
32086 updated. The effect of this is that Exim measures the client's average rate
32087 of attempts to send email, which can be much higher than the maximum it is
32088 actually allowed. If the client is over the limit it may be subjected to
32089 counter-measures by the ACL. It must slow down and allow sufficient time to
32090 pass that its computed rate falls below the maximum before it can send email
32091 again. The time (the number of smoothing periods) it must wait and not
32092 attempt to send mail can be calculated with this formula:
32093 .code
32094         ln(peakrate/maxrate)
32095 .endd
32096
32097
32098 .section "Limiting the rate of different events" "ratoptuniq"
32099 .cindex "rate limiting" "counting unique events"
32100 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32101 rate of different events. For example, the &%per_addr%& option uses this
32102 mechanism to count the number of different recipients that the client has
32103 sent messages to in the last time period; it is equivalent to
32104 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32105 measure the rate that a client uses different sender addresses with the
32106 options &`per_mail/unique=$sender_address`&.
32107
32108 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32109 has seen for that key. The whole set is thrown away when it is older than the
32110 rate smoothing period &'p'&, so each different event is counted at most once
32111 per period. In the &%leaky%& update mode, an event that causes the client to
32112 go over the limit is not added to the set, in the same way that the client's
32113 recorded rate is not updated in the same situation.
32114
32115 When you combine the &%unique=%& and &%readonly%& options, the specific
32116 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32117 rate.
32118
32119 The &%unique=%& mechanism needs more space in the ratelimit database than the
32120 other &%ratelimit%& options in order to store the event set. The number of
32121 unique values is potentially as large as the rate limit, so the extra space
32122 required increases with larger limits.
32123
32124 The uniqueification is not perfect: there is a small probability that Exim
32125 will think a new event has happened before. If the sender's rate is less than
32126 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32127 the measured rate can go above the limit, in which case Exim may under-count
32128 events by a significant margin. Fortunately, if the rate is high enough (2.7
32129 times the limit) that the false positive rate goes above 9%, then Exim will
32130 throw away the over-full event set before the measured rate falls below the
32131 limit. Therefore the only harm should be that exceptionally high sending rates
32132 are logged incorrectly; any countermeasures you configure will be as effective
32133 as intended.
32134
32135
32136 .section "Using rate limiting" "useratlim"
32137 Exim's other ACL facilities are used to define what counter-measures are taken
32138 when the rate limit is exceeded. This might be anything from logging a warning
32139 (for example, while measuring existing sending rates in order to define
32140 policy), through time delays to slow down fast senders, up to rejecting the
32141 message. For example:
32142 .code
32143 # Log all senders' rates
32144 warn ratelimit = 0 / 1h / strict
32145      log_message = Sender rate $sender_rate / $sender_rate_period
32146
32147 # Slow down fast senders; note the need to truncate $sender_rate
32148 # at the decimal point.
32149 warn ratelimit = 100 / 1h / per_rcpt / strict
32150      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32151                    $sender_rate_limit }s
32152
32153 # Keep authenticated users under control
32154 deny authenticated = *
32155      ratelimit = 100 / 1d / strict / $authenticated_id
32156
32157 # System-wide rate limit
32158 defer message = Sorry, too busy. Try again later.
32159      ratelimit = 10 / 1s / $primary_hostname
32160
32161 # Restrict incoming rate from each host, with a default
32162 # set using a macro and special cases looked up in a table.
32163 defer message = Sender rate exceeds $sender_rate_limit \
32164                messages per $sender_rate_period
32165      ratelimit = ${lookup {$sender_host_address} \
32166                    cdb {DB/ratelimits.cdb} \
32167                    {$value} {RATELIMIT} }
32168 .endd
32169 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32170 especially with the &%per_rcpt%& option, you may suffer from a performance
32171 bottleneck caused by locking on the ratelimit hints database. Apart from
32172 making your ACLs less complicated, you can reduce the problem by using a
32173 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32174 this means that Exim will lose its hints data after a reboot (including retry
32175 hints, the callout cache, and ratelimit data).
32176
32177
32178
32179 .section "Address verification" "SECTaddressverification"
32180 .cindex "verifying address" "options for"
32181 .cindex "policy control" "address verification"
32182 Several of the &%verify%& conditions described in section
32183 &<<SECTaclconditions>>& cause addresses to be verified. Section
32184 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32185 The verification conditions can be followed by options that modify the
32186 verification process. The options are separated from the keyword and from each
32187 other by slashes, and some of them contain parameters. For example:
32188 .code
32189 verify = sender/callout
32190 verify = recipient/defer_ok/callout=10s,defer_ok
32191 .endd
32192 The first stage of address verification, which always happens, is to run the
32193 address through the routers, in &"verify mode"&. Routers can detect the
32194 difference between verification and routing for delivery, and their actions can
32195 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32196 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32197 The available options are as follows:
32198
32199 .ilist
32200 If the &%callout%& option is specified, successful routing to one or more
32201 remote hosts is followed by a &"callout"& to those hosts as an additional
32202 check. Callouts and their sub-options are discussed in the next section.
32203 .next
32204 If there is a defer error while doing verification routing, the ACL
32205 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32206 options, the condition is forced to be true instead. Note that this is a main
32207 verification option as well as a suboption for callouts.
32208 .next
32209 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32210 discusses the reporting of sender address verification failures.
32211 .next
32212 The &%success_on_redirect%& option causes verification always to succeed
32213 immediately after a successful redirection. By default, if a redirection
32214 generates just one address, that address is also verified. See further
32215 discussion in section &<<SECTredirwhilveri>>&.
32216 .endlist
32217
32218 .cindex "verifying address" "differentiating failures"
32219 .vindex "&$recipient_verify_failure$&"
32220 .vindex "&$sender_verify_failure$&"
32221 .vindex "&$acl_verify_message$&"
32222 After an address verification failure, &$acl_verify_message$& contains the
32223 error message that is associated with the failure. It can be preserved by
32224 coding like this:
32225 .code
32226 warn  !verify = sender
32227        set acl_m0 = $acl_verify_message
32228 .endd
32229 If you are writing your own custom rejection message or log message when
32230 denying access, you can use this variable to include information about the
32231 verification failure.
32232
32233 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32234 appropriate) contains one of the following words:
32235
32236 .ilist
32237 &%qualify%&: The address was unqualified (no domain), and the message
32238 was neither local nor came from an exempted host.
32239 .next
32240 &%route%&: Routing failed.
32241 .next
32242 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32243 occurred at or before the MAIL command (that is, on initial
32244 connection, HELO, or MAIL).
32245 .next
32246 &%recipient%&: The RCPT command in a callout was rejected.
32247 .next
32248 &%postmaster%&: The postmaster check in a callout was rejected.
32249 .endlist
32250
32251 The main use of these variables is expected to be to distinguish between
32252 rejections of MAIL and rejections of RCPT in callouts.
32253
32254 The above variables may also be set after a &*successful*&
32255 address verification to:
32256
32257 .ilist
32258 &%random%&: A random local-part callout succeeded
32259 .endlist
32260
32261
32262
32263
32264 .section "Callout verification" "SECTcallver"
32265 .cindex "verifying address" "by callout"
32266 .cindex "callout" "verification"
32267 .cindex "SMTP" "callout verification"
32268 For non-local addresses, routing verifies the domain, but is unable to do any
32269 checking of the local part. There are situations where some means of verifying
32270 the local part is desirable. One way this can be done is to make an SMTP
32271 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32272 a subsequent host for a recipient address, to see if the host accepts the
32273 address. We use the term &'callout'& to cover both cases. Note that for a
32274 sender address, the callback is not to the client host that is trying to
32275 deliver the message, but to one of the hosts that accepts incoming mail for the
32276 sender's domain.
32277
32278 Exim does not do callouts by default. If you want them to happen, you must
32279 request them by setting appropriate options on the &%verify%& condition, as
32280 described below. This facility should be used with care, because it can add a
32281 lot of resource usage to the cost of verifying an address. However, Exim does
32282 cache the results of callouts, which helps to reduce the cost. Details of
32283 caching are in section &<<SECTcallvercache>>&.
32284
32285 Recipient callouts are usually used only between hosts that are controlled by
32286 the same administration. For example, a corporate gateway host could use
32287 callouts to check for valid recipients on an internal mailserver. A successful
32288 callout does not guarantee that a real delivery to the address would succeed;
32289 on the other hand, a failing callout does guarantee that a delivery would fail.
32290
32291 If the &%callout%& option is present on a condition that verifies an address, a
32292 second stage of verification occurs if the address is successfully routed to
32293 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32294 &(manualroute)& router, where the router specifies the hosts. However, if a
32295 router that does not set up hosts routes to an &(smtp)& transport with a
32296 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32297 &%hosts_override%& set, its hosts are always used, whether or not the router
32298 supplies a host list.
32299 Callouts are only supported on &(smtp)& transports.
32300
32301 The port that is used is taken from the transport, if it is specified and is a
32302 remote transport. (For routers that do verification only, no transport need be
32303 specified.) Otherwise, the default SMTP port is used. If a remote transport
32304 specifies an outgoing interface, this is used; otherwise the interface is not
32305 specified. Likewise, the text that is used for the HELO command is taken from
32306 the transport's &%helo_data%& option; if there is no transport, the value of
32307 &$smtp_active_hostname$& is used.
32308
32309 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32310 test whether a bounce message could be delivered to the sender address. The
32311 following SMTP commands are sent:
32312 .display
32313 &`HELO `&<&'local host name'&>
32314 &`MAIL FROM:<>`&
32315 &`RCPT TO:`&<&'the address to be tested'&>
32316 &`QUIT`&
32317 .endd
32318 LHLO is used instead of HELO if the transport's &%protocol%& option is
32319 set to &"lmtp"&.
32320
32321 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32322 settings.
32323
32324 A recipient callout check is similar. By default, it also uses an empty address
32325 for the sender. This default is chosen because most hosts do not make use of
32326 the sender address when verifying a recipient. Using the same address means
32327 that a single cache entry can be used for each recipient. Some sites, however,
32328 do make use of the sender address when verifying. These are catered for by the
32329 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32330
32331 If the response to the RCPT command is a 2&'xx'& code, the verification
32332 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32333 Exim tries the next host, if any. If there is a problem with all the remote
32334 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32335 &%callout%& option is given, in which case the condition is forced to succeed.
32336
32337 .cindex "SMTP" "output flushing, disabling for callout"
32338 A callout may take a little time. For this reason, Exim normally flushes SMTP
32339 output before performing a callout in an ACL, to avoid unexpected timeouts in
32340 clients when the SMTP PIPELINING extension is in use. The flushing can be
32341 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32342
32343
32344
32345
32346 .section "Additional parameters for callouts" "CALLaddparcall"
32347 .cindex "callout" "additional parameters for"
32348 The &%callout%& option can be followed by an equals sign and a number of
32349 optional parameters, separated by commas. For example:
32350 .code
32351 verify = recipient/callout=10s,defer_ok
32352 .endd
32353 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32354 separate verify options, is retained for backwards compatibility, but is now
32355 deprecated. The additional parameters for &%callout%& are as follows:
32356
32357
32358 .vlist
32359 .vitem <&'a&~time&~interval'&>
32360 .cindex "callout" "timeout, specifying"
32361 This specifies the timeout that applies for the callout attempt to each host.
32362 For example:
32363 .code
32364 verify = sender/callout=5s
32365 .endd
32366 The default is 30 seconds. The timeout is used for each response from the
32367 remote host. It is also used for the initial connection, unless overridden by
32368 the &%connect%& parameter.
32369
32370
32371 .vitem &*connect&~=&~*&<&'time&~interval'&>
32372 .cindex "callout" "connection timeout, specifying"
32373 This parameter makes it possible to set a different (usually smaller) timeout
32374 for making the SMTP connection. For example:
32375 .code
32376 verify = sender/callout=5s,connect=1s
32377 .endd
32378 If not specified, this timeout defaults to the general timeout value.
32379
32380 .vitem &*defer_ok*&
32381 .cindex "callout" "defer, action on"
32382 When this parameter is present, failure to contact any host, or any other kind
32383 of temporary error, is treated as success by the ACL. However, the cache is not
32384 updated in this circumstance.
32385
32386 .vitem &*fullpostmaster*&
32387 .cindex "callout" "full postmaster check"
32388 This operates like the &%postmaster%& option (see below), but if the check for
32389 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32390 accordance with the specification in RFC 2821. The RFC states that the
32391 unqualified address &'postmaster'& should be accepted.
32392
32393
32394 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32395 .cindex "callout" "sender when verifying header"
32396 When verifying addresses in header lines using the &%header_sender%&
32397 verification option, Exim behaves by default as if the addresses are envelope
32398 sender addresses from a message. Callout verification therefore tests to see
32399 whether a bounce message could be delivered, by using an empty address in the
32400 MAIL command. However, it is arguable that these addresses might never be used
32401 as envelope senders, and could therefore justifiably reject bounce messages
32402 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32403 address to use in the MAIL command. For example:
32404 .code
32405 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32406 .endd
32407 This parameter is available only for the &%header_sender%& verification option.
32408
32409
32410 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32411 .cindex "callout" "overall timeout, specifying"
32412 This parameter sets an overall timeout for performing a callout verification.
32413 For example:
32414 .code
32415 verify = sender/callout=5s,maxwait=30s
32416 .endd
32417 This timeout defaults to four times the callout timeout for individual SMTP
32418 commands. The overall timeout applies when there is more than one host that can
32419 be tried. The timeout is checked before trying the next host. This prevents
32420 very long delays if there are a large number of hosts and all are timing out
32421 (for example, when network connections are timing out).
32422
32423
32424 .vitem &*no_cache*&
32425 .cindex "callout" "cache, suppressing"
32426 .cindex "caching callout, suppressing"
32427 When this parameter is given, the callout cache is neither read nor updated.
32428
32429 .vitem &*postmaster*&
32430 .cindex "callout" "postmaster; checking"
32431 When this parameter is set, a successful callout check is followed by a similar
32432 check for the local part &'postmaster'& at the same domain. If this address is
32433 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32434 the postmaster check is recorded in a cache record; if it is a failure, this is
32435 used to fail subsequent callouts for the domain without a connection being
32436 made, until the cache record expires.
32437
32438 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32439 The postmaster check uses an empty sender in the MAIL command by default.
32440 You can use this parameter to do a postmaster check using a different address.
32441 For example:
32442 .code
32443 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32444 .endd
32445 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32446 one overrides. The &%postmaster%& parameter is equivalent to this example:
32447 .code
32448 require  verify = sender/callout=postmaster_mailfrom=
32449 .endd
32450 &*Warning*&: The caching arrangements for postmaster checking do not take
32451 account of the sender address. It is assumed that either the empty address or
32452 a fixed non-empty address will be used. All that Exim remembers is that the
32453 postmaster check for the domain succeeded or failed.
32454
32455
32456 .vitem &*random*&
32457 .cindex "callout" "&""random""& check"
32458 When this parameter is set, before doing the normal callout check, Exim does a
32459 check for a &"random"& local part at the same domain. The local part is not
32460 really random &-- it is defined by the expansion of the option
32461 &%callout_random_local_part%&, which defaults to
32462 .code
32463 $primary_hostname-$tod_epoch-testing
32464 .endd
32465 The idea here is to try to determine whether the remote host accepts all local
32466 parts without checking. If it does, there is no point in doing callouts for
32467 specific local parts. If the &"random"& check succeeds, the result is saved in
32468 a cache record, and used to force the current and subsequent callout checks to
32469 succeed without a connection being made, until the cache record expires.
32470
32471 .vitem &*use_postmaster*&
32472 .cindex "callout" "sender for recipient check"
32473 This parameter applies to recipient callouts only. For example:
32474 .code
32475 deny  !verify = recipient/callout=use_postmaster
32476 .endd
32477 .vindex "&$qualify_domain$&"
32478 It causes a non-empty postmaster address to be used in the MAIL command when
32479 performing the callout for the recipient, and also for a &"random"& check if
32480 that is configured. The local part of the address is &`postmaster`& and the
32481 domain is the contents of &$qualify_domain$&.
32482
32483 .vitem &*use_sender*&
32484 This option applies to recipient callouts only. For example:
32485 .code
32486 require  verify = recipient/callout=use_sender
32487 .endd
32488 It causes the message's actual sender address to be used in the MAIL
32489 command when performing the callout, instead of an empty address. There is no
32490 need to use this option unless you know that the called hosts make use of the
32491 sender when checking recipients. If used indiscriminately, it reduces the
32492 usefulness of callout caching.
32493
32494 .vitem &*hold*&
32495 This option applies to recipient callouts only. For example:
32496 .code
32497 require  verify = recipient/callout=use_sender,hold
32498 .endd
32499 It causes the connection to be held open and used for any further recipients
32500 and for eventual delivery (should that be done quickly).
32501 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32502 when that is used for the connections.
32503 The advantage is only gained if there are no callout cache hits
32504 (which could be enforced by the no_cache option),
32505 if the use_sender option is used,
32506 if neither the random nor the use_postmaster option is used,
32507 and if no other callouts intervene.
32508 .endlist
32509
32510 If you use any of the parameters that set a non-empty sender for the MAIL
32511 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32512 &%use_sender%&), you should think about possible loops. Recipient checking is
32513 usually done between two hosts that are under the same management, and the host
32514 that receives the callouts is not normally configured to do callouts itself.
32515 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32516 these circumstances.
32517
32518 However, if you use a non-empty sender address for a callout to an arbitrary
32519 host, there is the likelihood that the remote host will itself initiate a
32520 callout check back to your host. As it is checking what appears to be a message
32521 sender, it is likely to use an empty address in MAIL, thus avoiding a
32522 callout loop. However, to be on the safe side it would be best to set up your
32523 own ACLs so that they do not do sender verification checks when the recipient
32524 is the address you use for header sender or postmaster callout checking.
32525
32526 Another issue to think about when using non-empty senders for callouts is
32527 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32528 by the sender/recipient combination; thus, for any given recipient, many more
32529 actual callouts are performed than when an empty sender or postmaster is used.
32530
32531
32532
32533
32534 .section "Callout caching" "SECTcallvercache"
32535 .cindex "hints database" "callout cache"
32536 .cindex "callout" "cache, description of"
32537 .cindex "caching" "callout"
32538 Exim caches the results of callouts in order to reduce the amount of resources
32539 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32540 option. A hints database called &"callout"& is used for the cache. Two
32541 different record types are used: one records the result of a callout check for
32542 a specific address, and the other records information that applies to the
32543 entire domain (for example, that it accepts the local part &'postmaster'&).
32544
32545 When an original callout fails, a detailed SMTP error message is given about
32546 the failure. However, for subsequent failures use the cache data, this message
32547 is not available.
32548
32549 The expiry times for negative and positive address cache records are
32550 independent, and can be set by the global options &%callout_negative_expire%&
32551 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32552
32553 If a host gives a negative response to an SMTP connection, or rejects any
32554 commands up to and including
32555 .code
32556 MAIL FROM:<>
32557 .endd
32558 (but not including the MAIL command with a non-empty address),
32559 any callout attempt is bound to fail. Exim remembers such failures in a
32560 domain cache record, which it uses to fail callouts for the domain without
32561 making new connections, until the domain record times out. There are two
32562 separate expiry times for domain cache records:
32563 &%callout_domain_negative_expire%& (default 3h) and
32564 &%callout_domain_positive_expire%& (default 7d).
32565
32566 Domain records expire when the negative expiry time is reached if callouts
32567 cannot be made for the domain, or if the postmaster check failed.
32568 Otherwise, they expire when the positive expiry time is reached. This
32569 ensures that, for example, a host that stops accepting &"random"& local parts
32570 will eventually be noticed.
32571
32572 The callout caching mechanism is based on the domain of the address that is
32573 being tested. If the domain routes to several hosts, it is assumed that their
32574 behaviour will be the same.
32575
32576
32577
32578 .section "Sender address verification reporting" "SECTsenaddver"
32579 .cindex "verifying" "suppressing error details"
32580 See section &<<SECTaddressverification>>& for a general discussion of
32581 verification. When sender verification fails in an ACL, the details of the
32582 failure are given as additional output lines before the 550 response to the
32583 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32584 you might see:
32585 .code
32586 MAIL FROM:<xyz@abc.example>
32587 250 OK
32588 RCPT TO:<pqr@def.example>
32589 550-Verification failed for <xyz@abc.example>
32590 550-Called:   192.168.34.43
32591 550-Sent:     RCPT TO:<xyz@abc.example>
32592 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32593 550 Sender verification failed
32594 .endd
32595 If more than one RCPT command fails in the same way, the details are given
32596 only for the first of them. However, some administrators do not want to send
32597 out this much information. You can suppress the details by adding
32598 &`/no_details`& to the ACL statement that requests sender verification. For
32599 example:
32600 .code
32601 verify = sender/no_details
32602 .endd
32603
32604 .section "Redirection while verifying" "SECTredirwhilveri"
32605 .cindex "verifying" "redirection while"
32606 .cindex "address redirection" "while verifying"
32607 A dilemma arises when a local address is redirected by aliasing or forwarding
32608 during verification: should the generated addresses themselves be verified,
32609 or should the successful expansion of the original address be enough to verify
32610 it? By default, Exim takes the following pragmatic approach:
32611
32612 .ilist
32613 When an incoming address is redirected to just one child address, verification
32614 continues with the child address, and if that fails to verify, the original
32615 verification also fails.
32616 .next
32617 When an incoming address is redirected to more than one child address,
32618 verification does not continue. A success result is returned.
32619 .endlist
32620
32621 This seems the most reasonable behaviour for the common use of aliasing as a
32622 way of redirecting different local parts to the same mailbox. It means, for
32623 example, that a pair of alias entries of the form
32624 .code
32625 A.Wol:   aw123
32626 aw123:   :fail: Gone away, no forwarding address
32627 .endd
32628 work as expected, with both local parts causing verification failure. When a
32629 redirection generates more than one address, the behaviour is more like a
32630 mailing list, where the existence of the alias itself is sufficient for
32631 verification to succeed.
32632
32633 It is possible, however, to change the default behaviour so that all successful
32634 redirections count as successful verifications, however many new addresses are
32635 generated. This is specified by the &%success_on_redirect%& verification
32636 option. For example:
32637 .code
32638 require verify = recipient/success_on_redirect/callout=10s
32639 .endd
32640 In this example, verification succeeds if a router generates a new address, and
32641 the callout does not occur, because no address was routed to a remote host.
32642
32643 When verification is being tested via the &%-bv%& option, the treatment of
32644 redirections is as just described, unless the &%-v%& or any debugging option is
32645 also specified. In that case, full verification is done for every generated
32646 address and a report is output for each of them.
32647
32648
32649
32650 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32651 .cindex "CSA" "verifying"
32652 Client SMTP Authorization is a system that allows a site to advertise
32653 which machines are and are not permitted to send email. This is done by placing
32654 special SRV records in the DNS; these are looked up using the client's HELO
32655 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32656 Authorization checks in Exim are performed by the ACL condition:
32657 .code
32658 verify = csa
32659 .endd
32660 This fails if the client is not authorized. If there is a DNS problem, or if no
32661 valid CSA SRV record is found, or if the client is authorized, the condition
32662 succeeds. These three cases can be distinguished using the expansion variable
32663 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32664 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32665 be likely to cause problems for legitimate email.
32666
32667 The error messages produced by the CSA code include slightly more
32668 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32669 looking up the CSA SRV record, or problems looking up the CSA target
32670 address record. There are four reasons for &$csa_status$& being &"fail"&:
32671
32672 .ilist
32673 The client's host name is explicitly not authorized.
32674 .next
32675 The client's IP address does not match any of the CSA target IP addresses.
32676 .next
32677 The client's host name is authorized but it has no valid target IP addresses
32678 (for example, the target's addresses are IPv6 and the client is using IPv4).
32679 .next
32680 The client's host name has no CSA SRV record but a parent domain has asserted
32681 that all subdomains must be explicitly authorized.
32682 .endlist
32683
32684 The &%csa%& verification condition can take an argument which is the domain to
32685 use for the DNS query. The default is:
32686 .code
32687 verify = csa/$sender_helo_name
32688 .endd
32689 This implementation includes an extension to CSA. If the query domain
32690 is an address literal such as [192.0.2.95], or if it is a bare IP
32691 address, Exim searches for CSA SRV records in the reverse DNS as if
32692 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32693 meaningful to say:
32694 .code
32695 verify = csa/$sender_host_address
32696 .endd
32697 In fact, this is the check that Exim performs if the client does not say HELO.
32698 This extension can be turned off by setting the main configuration option
32699 &%dns_csa_use_reverse%& to be false.
32700
32701 If a CSA SRV record is not found for the domain itself, a search
32702 is performed through its parent domains for a record which might be
32703 making assertions about subdomains. The maximum depth of this search is limited
32704 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32705 default. Exim does not look for CSA SRV records in a top level domain, so the
32706 default settings handle HELO domains as long as seven
32707 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32708 of legitimate HELO domains.
32709
32710 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32711 direct SRV lookups, this is not sufficient because of the extra parent domain
32712 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32713 addresses into lookups in the reverse DNS space. The result of a successful
32714 lookup such as:
32715 .code
32716 ${lookup dnsdb {csa=$sender_helo_name}}
32717 .endd
32718 has two space-separated fields: an authorization code and a target host name.
32719 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32720 authorization required but absent, or &"?"& for unknown.
32721
32722
32723
32724
32725 .section "Bounce address tag validation" "SECTverifyPRVS"
32726 .cindex "BATV, verifying"
32727 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32728 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32729 Genuine incoming bounce messages should therefore always be addressed to
32730 recipients that have a valid tag. This scheme is a way of detecting unwanted
32731 bounce messages caused by sender address forgeries (often called &"collateral
32732 spam"&), because the recipients of such messages do not include valid tags.
32733
32734 There are two expansion items to help with the implementation of the BATV
32735 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32736 the original envelope sender address by using a simple key to add a hash of the
32737 address and some time-based randomizing information. The &%prvs%& expansion
32738 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32739 The syntax of these expansion items is described in section
32740 &<<SECTexpansionitems>>&.
32741 The validity period on signed addresses is seven days.
32742
32743 As an example, suppose the secret per-address keys are stored in an MySQL
32744 database. A query to look up the key for an address could be defined as a macro
32745 like this:
32746 .code
32747 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32748                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32749                 }{$value}}
32750 .endd
32751 Suppose also that the senders who make use of BATV are defined by an address
32752 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32753 use this:
32754 .code
32755 # Bounces: drop unsigned addresses for BATV senders
32756 deny message = This address does not send an unsigned reverse path
32757      senders = :
32758      recipients = +batv_senders
32759
32760 # Bounces: In case of prvs-signed address, check signature.
32761 deny message = Invalid reverse path signature.
32762      senders = :
32763      condition  = ${prvscheck {$local_part@$domain}\
32764                   {PRVSCHECK_SQL}{1}}
32765      !condition = $prvscheck_result
32766 .endd
32767 The first statement rejects recipients for bounce messages that are addressed
32768 to plain BATV sender addresses, because it is known that BATV senders do not
32769 send out messages with plain sender addresses. The second statement rejects
32770 recipients that are prvs-signed, but with invalid signatures (either because
32771 the key is wrong, or the signature has timed out).
32772
32773 A non-prvs-signed address is not rejected by the second statement, because the
32774 &%prvscheck%& expansion yields an empty string if its first argument is not a
32775 prvs-signed address, thus causing the &%condition%& condition to be false. If
32776 the first argument is a syntactically valid prvs-signed address, the yield is
32777 the third string (in this case &"1"&), whether or not the cryptographic and
32778 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32779 of the checks (empty for failure, &"1"& for success).
32780
32781 There is one more issue you must consider when implementing prvs-signing:
32782 you have to ensure that the routers accept prvs-signed addresses and
32783 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32784 router to remove the signature with a configuration along these lines:
32785 .code
32786 batv_redirect:
32787   driver = redirect
32788   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32789 .endd
32790 This works because, if the third argument of &%prvscheck%& is empty, the result
32791 of the expansion of a prvs-signed address is the decoded value of the original
32792 address. This router should probably be the first of your routers that handles
32793 local addresses.
32794
32795 To create BATV-signed addresses in the first place, a transport of this form
32796 can be used:
32797 .code
32798 external_smtp_batv:
32799   driver = smtp
32800   return_path = ${prvs {$return_path} \
32801                        {${lookup mysql{SELECT \
32802                        secret FROM batv_prvs WHERE \
32803                        sender='${quote_mysql:$sender_address}'} \
32804                        {$value}fail}}}
32805 .endd
32806 If no key can be found for the existing return path, no signing takes place.
32807
32808
32809
32810 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32811 .cindex "&ACL;" "relay control"
32812 .cindex "relaying" "control by ACL"
32813 .cindex "policy control" "relay control"
32814 An MTA is said to &'relay'& a message if it receives it from some host and
32815 delivers it directly to another host as a result of a remote address contained
32816 within it. Redirecting a local address via an alias or forward file and then
32817 passing the message on to another host is not relaying,
32818 .cindex "&""percent hack""&"
32819 but a redirection as a result of the &"percent hack"& is.
32820
32821 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32822 A host which is acting as a gateway or an MX backup is concerned with incoming
32823 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32824 a host which is acting as a smart host for a number of clients is concerned
32825 with outgoing relaying from those clients to the Internet at large. Often the
32826 same host is fulfilling both functions,
32827 . ///
32828 . as illustrated in the diagram below,
32829 . ///
32830 but in principle these two kinds of relaying are entirely independent. What is
32831 not wanted is the transmission of mail from arbitrary remote hosts through your
32832 system to arbitrary domains.
32833
32834
32835 You can implement relay control by means of suitable statements in the ACL that
32836 runs for each RCPT command. For convenience, it is often easiest to use
32837 Exim's named list facility to define the domains and hosts involved. For
32838 example, suppose you want to do the following:
32839
32840 .ilist
32841 Deliver a number of domains to mailboxes on the local host (or process them
32842 locally in some other way). Let's say these are &'my.dom1.example'& and
32843 &'my.dom2.example'&.
32844 .next
32845 Relay mail for a number of other domains for which you are the secondary MX.
32846 These might be &'friend1.example'& and &'friend2.example'&.
32847 .next
32848 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32849 Suppose your LAN is 192.168.45.0/24.
32850 .endlist
32851
32852
32853 In the main part of the configuration, you put the following definitions:
32854 .code
32855 domainlist local_domains    = my.dom1.example : my.dom2.example
32856 domainlist relay_to_domains = friend1.example : friend2.example
32857 hostlist   relay_from_hosts = 192.168.45.0/24
32858 .endd
32859 Now you can use these definitions in the ACL that is run for every RCPT
32860 command:
32861 .code
32862 acl_check_rcpt:
32863   accept domains = +local_domains : +relay_to_domains
32864   accept hosts   = +relay_from_hosts
32865 .endd
32866 The first statement accepts any RCPT command that contains an address in
32867 the local or relay domains. For any other domain, control passes to the second
32868 statement, which accepts the command only if it comes from one of the relay
32869 hosts. In practice, you will probably want to make your ACL more sophisticated
32870 than this, for example, by including sender and recipient verification. The
32871 default configuration includes a more comprehensive example, which is described
32872 in chapter &<<CHAPdefconfil>>&.
32873
32874
32875
32876 .section "Checking a relay configuration" "SECTcheralcon"
32877 .cindex "relaying" "checking control of"
32878 You can check the relay characteristics of your configuration in the same way
32879 that you can test any ACL behaviour for an incoming SMTP connection, by using
32880 the &%-bh%& option to run a fake SMTP session with which you interact.
32881 .ecindex IIDacl
32882
32883
32884
32885 . ////////////////////////////////////////////////////////////////////////////
32886 . ////////////////////////////////////////////////////////////////////////////
32887
32888 .chapter "Content scanning at ACL time" "CHAPexiscan"
32889 .scindex IIDcosca "content scanning" "at ACL time"
32890 The extension of Exim to include content scanning at ACL time, formerly known
32891 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32892 was integrated into the main source for Exim release 4.50, and Tom continues to
32893 maintain it. Most of the wording of this chapter is taken from Tom's
32894 specification.
32895
32896 It is also possible to scan the content of messages at other times. The
32897 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32898 scanning after all the ACLs have run. A transport filter can be used to scan
32899 messages at delivery time (see the &%transport_filter%& option, described in
32900 chapter &<<CHAPtransportgeneric>>&).
32901
32902 If you want to include the ACL-time content-scanning features when you compile
32903 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32904 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32905
32906 .ilist
32907 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32908 for all MIME parts for SMTP and non-SMTP messages, respectively.
32909 .next
32910 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32911 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32912 run at the end of message reception (the &%acl_smtp_data%& ACL).
32913 .next
32914 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32915 of messages, or parts of messages, for debugging purposes.
32916 .next
32917 Additional expansion variables that are set in the new ACL and by the new
32918 conditions.
32919 .next
32920 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32921 .endlist
32922
32923 Content-scanning is continually evolving, and new features are still being
32924 added. While such features are still unstable and liable to incompatible
32925 changes, they are made available in Exim by setting options whose names begin
32926 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32927 this manual. You can find out about them by reading the file called
32928 &_doc/experimental.txt_&.
32929
32930 All the content-scanning facilities work on a MBOX copy of the message that is
32931 temporarily created in a file called:
32932 .display
32933 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32934 .endd
32935 The &_.eml_& extension is a friendly hint to virus scanners that they can
32936 expect an MBOX-like structure inside that file. The file is created when the
32937 first content scanning facility is called. Subsequent calls to content
32938 scanning conditions open the same file again. The directory is recursively
32939 removed when the &%acl_smtp_data%& ACL has finished running, unless
32940 .code
32941 control = no_mbox_unspool
32942 .endd
32943 has been encountered. When the MIME ACL decodes files, they are put into the
32944 same directory by default.
32945
32946
32947
32948 .section "Scanning for viruses" "SECTscanvirus"
32949 .cindex "virus scanning"
32950 .cindex "content scanning" "for viruses"
32951 .cindex "content scanning" "the &%malware%& condition"
32952 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32953 It supports a &"generic"& interface to scanners called via the shell, and
32954 specialized interfaces for &"daemon"& type virus scanners, which are resident
32955 in memory and thus are much faster.
32956
32957 Since message data needs to have arrived,
32958 the condition may be only called in ACL defined by
32959 &%acl_smtp_data%&,
32960 &%acl_smtp_data_prdr%&,
32961 &%acl_smtp_mime%& or
32962 &%acl_smtp_dkim%&
32963
32964 A timeout of 2 minutes is applied to a scanner call (by default);
32965 if it expires then a defer action is taken.
32966
32967 .oindex "&%av_scanner%&"
32968 You can set the &%av_scanner%& option in the main part of the configuration
32969 to specify which scanner to use, together with any additional options that
32970 are needed. The basic syntax is as follows:
32971 .display
32972 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32973 .endd
32974 If you do not set &%av_scanner%&, it defaults to
32975 .code
32976 av_scanner = sophie:/var/run/sophie
32977 .endd
32978 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32979 before use.
32980 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32981 The following scanner types are supported in this release,
32982 though individual ones can be included or not at build time:
32983
32984 .vlist
32985 .vitem &%avast%&
32986 .cindex "virus scanners" "avast"
32987 This is the scanner daemon of Avast. It has been tested with Avast Core
32988 Security (currently at version 2.2.0).
32989 You can get a trial version at &url(https://www.avast.com) or for Linux
32990 at &url(https://www.avast.com/linux-server-antivirus).
32991 This scanner type takes one option,
32992 which can be either a full path to a UNIX socket,
32993 or host and port specifiers separated by white space.
32994 The host may be a name or an IP address; the port is either a
32995 single number or a pair of numbers with a dash between.
32996 A list of options may follow. These options are interpreted on the
32997 Exim's side of the malware scanner, or are given on separate lines to
32998 the daemon as options before the main scan command.
32999
33000 .cindex &`pass_unscanned`& "avast"
33001 If &`pass_unscanned`&
33002 is set, any files the Avast scanner can't scan (e.g.
33003 decompression bombs, or invalid archives) are considered clean. Use with
33004 care.
33005
33006 For example:
33007 .code
33008 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33009 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33010 av_scanner = avast:192.168.2.22 5036
33011 .endd
33012 If you omit the argument, the default path
33013 &_/var/run/avast/scan.sock_&
33014 is used.
33015 If you use a remote host,
33016 you need to make Exim's spool directory available to it,
33017 as the scanner is passed a file path, not file contents.
33018 For information about available commands and their options you may use
33019 .code
33020 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33021     FLAGS
33022     SENSITIVITY
33023     PACK
33024 .endd
33025
33026 If the scanner returns a temporary failure (e.g. license issues, or
33027 permission problems), the message is deferred and a paniclog entry is
33028 written.  The usual &`defer_ok`& option is available.
33029
33030 .vitem &%aveserver%&
33031 .cindex "virus scanners" "Kaspersky"
33032 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33033 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33034 which is the path to the daemon's UNIX socket. The default is shown in this
33035 example:
33036 .code
33037 av_scanner = aveserver:/var/run/aveserver
33038 .endd
33039
33040
33041 .vitem &%clamd%&
33042 .cindex "virus scanners" "clamd"
33043 This daemon-type scanner is GPL and free. You can get it at
33044 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33045 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33046 in the MIME ACL. This is no longer believed to be necessary.
33047
33048 The options are a list of server specifiers, which may be
33049 a UNIX socket specification,
33050 a TCP socket specification,
33051 or a (global) option.
33052
33053 A socket specification consists of a space-separated list.
33054 For a Unix socket the first element is a full path for the socket,
33055 for a TCP socket the first element is the IP address
33056 and the second a port number,
33057 Any further elements are per-server (non-global) options.
33058 These per-server options are supported:
33059 .code
33060 retry=<timespec>        Retry on connect fail
33061 .endd
33062
33063 The &`retry`& option specifies a time after which a single retry for
33064 a failed connect is made.  The default is to not retry.
33065
33066 If a Unix socket file is specified, only one server is supported.
33067
33068 Examples:
33069 .code
33070 av_scanner = clamd:/opt/clamd/socket
33071 av_scanner = clamd:192.0.2.3 1234
33072 av_scanner = clamd:192.0.2.3 1234:local
33073 av_scanner = clamd:192.0.2.3 1234 retry=10s
33074 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33075 .endd
33076 If the value of av_scanner points to a UNIX socket file or contains the
33077 &`local`&
33078 option, then the ClamAV interface will pass a filename containing the data
33079 to be scanned, which should normally result in less I/O happening and be
33080 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33081 Exim does not assume that there is a common filesystem with the remote host.
33082
33083 The final example shows that multiple TCP targets can be specified.  Exim will
33084 randomly use one for each incoming email (i.e. it load balances them).  Note
33085 that only TCP targets may be used if specifying a list of scanners; a UNIX
33086 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33087 unavailable, Exim will try the remaining one(s) until it finds one that works.
33088 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33089 not keep track of scanner state between multiple messages, and the scanner
33090 selection is random, so the message will get logged in the mainlog for each
33091 email that the down scanner gets chosen first (message wrapped to be readable):
33092 .code
33093 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33094    clamd: connection to localhost, port 3310 failed
33095    (Connection refused)
33096 .endd
33097
33098 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33099 contributing the code for this scanner.
33100
33101 .vitem &%cmdline%&
33102 .cindex "virus scanners" "command line interface"
33103 This is the keyword for the generic command line scanner interface. It can be
33104 used to attach virus scanners that are invoked from the shell. This scanner
33105 type takes 3 mandatory options:
33106
33107 .olist
33108 The full path and name of the scanner binary, with all command line options,
33109 and a placeholder (&`%s`&) for the directory to scan.
33110
33111 .next
33112 A regular expression to match against the STDOUT and STDERR output of the
33113 virus scanner. If the expression matches, a virus was found. You must make
33114 absolutely sure that this expression matches on &"virus found"&. This is called
33115 the &"trigger"& expression.
33116
33117 .next
33118 Another regular expression, containing exactly one pair of parentheses, to
33119 match the name of the virus found in the scanners output. This is called the
33120 &"name"& expression.
33121 .endlist olist
33122
33123 For example, Sophos Sweep reports a virus on a line like this:
33124 .code
33125 Virus 'W32/Magistr-B' found in file ./those.bat
33126 .endd
33127 For the trigger expression, we can match the phrase &"found in file"&. For the
33128 name expression, we want to extract the W32/Magistr-B string, so we can match
33129 for the single quotes left and right of it. Altogether, this makes the
33130 configuration setting:
33131 .code
33132 av_scanner = cmdline:\
33133              /path/to/sweep -ss -all -rec -archive %s:\
33134              found in file:'(.+)'
33135 .endd
33136 .vitem &%drweb%&
33137 .cindex "virus scanners" "DrWeb"
33138 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33139 takes one option,
33140 either a full path to a UNIX socket,
33141 or host and port specifiers separated by white space.
33142 The host may be a name or an IP address; the port is either a
33143 single number or a pair of numbers with a dash between.
33144 For example:
33145 .code
33146 av_scanner = drweb:/var/run/drwebd.sock
33147 av_scanner = drweb:192.168.2.20 31337
33148 .endd
33149 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33150 is used. Thanks to Alex Miller for contributing the code for this scanner.
33151
33152 .vitem &%f-protd%&
33153 .cindex "virus scanners" "f-protd"
33154 The f-protd scanner is accessed via HTTP over TCP.
33155 One argument is taken, being a space-separated hostname and port number
33156 (or port-range).
33157 For example:
33158 .code
33159 av_scanner = f-protd:localhost 10200-10204
33160 .endd
33161 If you omit the argument, the default values shown above are used.
33162
33163 .vitem &%f-prot6d%&
33164 .cindex "virus scanners" "f-prot6d"
33165 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33166 One argument is taken, being a space-separated hostname and port number.
33167 For example:
33168 .code
33169 av_scanner = f-prot6d:localhost 10200
33170 .endd
33171 If you omit the argument, the default values show above are used.
33172
33173 .vitem &%fsecure%&
33174 .cindex "virus scanners" "F-Secure"
33175 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33176 argument which is the path to a UNIX socket. For example:
33177 .code
33178 av_scanner = fsecure:/path/to/.fsav
33179 .endd
33180 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33181 Thelmen for contributing the code for this scanner.
33182
33183 .vitem &%kavdaemon%&
33184 .cindex "virus scanners" "Kaspersky"
33185 This is the scanner daemon of Kaspersky Version 4. This version of the
33186 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33187 scanner type takes one option, which is the path to the daemon's UNIX socket.
33188 For example:
33189 .code
33190 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33191 .endd
33192 The default path is &_/var/run/AvpCtl_&.
33193
33194 .vitem &%mksd%&
33195 .cindex "virus scanners" "mksd"
33196 This was a daemon type scanner that is aimed mainly at Polish users,
33197 though some documentation was available in English.
33198 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33199 and this appears to be a candidate for removal from Exim, unless
33200 we are informed of other virus scanners which use the same protocol
33201 to integrate.
33202 The only option for this scanner type is
33203 the maximum number of processes used simultaneously to scan the attachments,
33204 provided that mksd has
33205 been run with at least the same number of child processes. For example:
33206 .code
33207 av_scanner = mksd:2
33208 .endd
33209 You can safely omit this option (the default value is 1).
33210
33211 .vitem &%sock%&
33212 .cindex "virus scanners" "simple socket-connected"
33213 This is a general-purpose way of talking to simple scanner daemons
33214 running on the local machine.
33215 There are four options:
33216 an address (which may be an IP address and port, or the path of a Unix socket),
33217 a commandline to send (may include a single %s which will be replaced with
33218 the path to the mail file to be scanned),
33219 an RE to trigger on from the returned data,
33220 and an RE to extract malware_name from the returned data.
33221 For example:
33222 .code
33223 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33224 .endd
33225 Note that surrounding whitespace is stripped from each option, meaning
33226 there is no way to specify a trailing newline.
33227 The socket specifier and both regular-expressions are required.
33228 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33229 specify an empty element to get this.
33230
33231 .vitem &%sophie%&
33232 .cindex "virus scanners" "Sophos and Sophie"
33233 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33234 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33235 for this scanner type is the path to the UNIX socket that Sophie uses for
33236 client communication. For example:
33237 .code
33238 av_scanner = sophie:/tmp/sophie
33239 .endd
33240 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33241 the option.
33242 .endlist
33243
33244 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33245 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33246 ACL.
33247
33248 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33249 makes it possible to use different scanners. See further below for an example.
33250 The &%malware%& condition caches its results, so when you use it multiple times
33251 for the same message, the actual scanning process is only carried out once.
33252 However, using expandable items in &%av_scanner%& disables this caching, in
33253 which case each use of the &%malware%& condition causes a new scan of the
33254 message.
33255
33256 The &%malware%& condition takes a right-hand argument that is expanded before
33257 use and taken as a list, slash-separated by default.
33258 The first element can then be one of
33259
33260 .ilist
33261 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33262 The condition succeeds if a virus was found, and fail otherwise. This is the
33263 recommended usage.
33264 .next
33265 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33266 the condition fails immediately.
33267 .next
33268 A regular expression, in which case the message is scanned for viruses. The
33269 condition succeeds if a virus is found and its name matches the regular
33270 expression. This allows you to take special actions on certain types of virus.
33271 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33272 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33273 .endlist
33274
33275 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33276 messages even if there is a problem with the virus scanner.
33277 Otherwise, such a problem causes the ACL to defer.
33278
33279 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33280 specify a non-default timeout.  The default is two minutes.
33281 For example:
33282 .code
33283 malware = * / defer_ok / tmo=10s
33284 .endd
33285 A timeout causes the ACL to defer.
33286
33287 .vindex "&$callout_address$&"
33288 When a connection is made to the scanner the expansion variable &$callout_address$&
33289 is set to record the actual address used.
33290
33291 .vindex "&$malware_name$&"
33292 When a virus is found, the condition sets up an expansion variable called
33293 &$malware_name$& that contains the name of the virus. You can use it in a
33294 &%message%& modifier that specifies the error returned to the sender, and/or in
33295 logging data.
33296
33297 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33298 imposed by your anti-virus scanner.
33299
33300 Here is a very simple scanning example:
33301 .code
33302 deny message = This message contains malware ($malware_name)
33303      malware = *
33304 .endd
33305 The next example accepts messages when there is a problem with the scanner:
33306 .code
33307 deny message = This message contains malware ($malware_name)
33308      malware = */defer_ok
33309 .endd
33310 The next example shows how to use an ACL variable to scan with both sophie and
33311 aveserver. It assumes you have set:
33312 .code
33313 av_scanner = $acl_m0
33314 .endd
33315 in the main Exim configuration.
33316 .code
33317 deny message = This message contains malware ($malware_name)
33318      set acl_m0 = sophie
33319      malware = *
33320
33321 deny message = This message contains malware ($malware_name)
33322      set acl_m0 = aveserver
33323      malware = *
33324 .endd
33325
33326
33327 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33328 .cindex "content scanning" "for spam"
33329 .cindex "spam scanning"
33330 .cindex "SpamAssassin"
33331 .cindex "Rspamd"
33332 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33333 score and a report for the message.
33334 Support is also provided for Rspamd.
33335
33336 For more information about installation and configuration of SpamAssassin or
33337 Rspamd refer to their respective websites at
33338 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33339
33340 SpamAssassin can be installed with CPAN by running:
33341 .code
33342 perl -MCPAN -e 'install Mail::SpamAssassin'
33343 .endd
33344 SpamAssassin has its own set of configuration files. Please review its
33345 documentation to see how you can tweak it. The default installation should work
33346 nicely, however.
33347
33348 .oindex "&%spamd_address%&"
33349 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33350 intend to use an instance running on the local host you do not need to set
33351 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33352 you must set the &%spamd_address%& option in the global part of the Exim
33353 configuration as follows (example):
33354 .code
33355 spamd_address = 192.168.99.45 783
33356 .endd
33357 The SpamAssassin protocol relies on a TCP half-close from the client.
33358 If your SpamAssassin client side is running a Linux system with an
33359 iptables firewall, consider setting
33360 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33361 timeout, Exim uses when waiting for a response from the SpamAssassin
33362 server (currently defaulting to 120s).  With a lower value the Linux
33363 connection tracking may consider your half-closed connection as dead too
33364 soon.
33365
33366
33367 To use Rspamd (which by default listens on all local addresses
33368 on TCP port 11333)
33369 you should add &%variant=rspamd%& after the address/port pair, for example:
33370 .code
33371 spamd_address = 127.0.0.1 11333 variant=rspamd
33372 .endd
33373
33374 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33375 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33376 filename instead of an address/port pair:
33377 .code
33378 spamd_address = /var/run/spamd_socket
33379 .endd
33380 You can have multiple &%spamd%& servers to improve scalability. These can
33381 reside on other hardware reachable over the network. To specify multiple
33382 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33383 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33384 .code
33385 spamd_address = 192.168.2.10 783 : \
33386                 192.168.2.11 783 : \
33387                 192.168.2.12 783
33388 .endd
33389 Up to 32 &%spamd%& servers are supported.
33390 When a server fails to respond to the connection attempt, all other
33391 servers are tried until one succeeds. If no server responds, the &%spam%&
33392 condition defers.
33393
33394 Unix and TCP socket specifications may be mixed in any order.
33395 Each element of the list is a list itself, space-separated by default
33396 and changeable in the usual way (&<<SECTlistsepchange>>&);
33397 take care to not double the separator.
33398
33399 For TCP socket specifications a host name or IP (v4 or v6, but
33400 subject to list-separator quoting rules) address can be used,
33401 and the port can be one or a dash-separated pair.
33402 In the latter case, the range is tried in strict order.
33403
33404 Elements after the first for Unix sockets, or second for TCP socket,
33405 are options.
33406 The supported options are:
33407 .code
33408 pri=<priority>      Selection priority
33409 weight=<value>      Selection bias
33410 time=<start>-<end>  Use only between these times of day
33411 retry=<timespec>    Retry on connect fail
33412 tmo=<timespec>      Connection time limit
33413 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33414 .endd
33415
33416 The &`pri`& option specifies a priority for the server within the list,
33417 higher values being tried first.
33418 The default priority is 1.
33419
33420 The &`weight`& option specifies a selection bias.
33421 Within a priority set
33422 servers are queried in a random fashion, weighted by this value.
33423 The default value for selection bias is 1.
33424
33425 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33426 in the local time zone; each element being one or more digits.
33427 Either the seconds or both minutes and seconds, plus the leading &`.`&
33428 characters, may be omitted and will be taken as zero.
33429
33430 Timeout specifications for the &`retry`& and &`tmo`& options
33431 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33432
33433 The &`tmo`& option specifies an overall timeout for communication.
33434 The default value is two minutes.
33435
33436 The &`retry`& option specifies a time after which a single retry for
33437 a failed connect is made.
33438 The default is to not retry.
33439
33440 The &%spamd_address%& variable is expanded before use if it starts with
33441 a dollar sign. In this case, the expansion may return a string that is
33442 used as the list so that multiple spamd servers can be the result of an
33443 expansion.
33444
33445 .vindex "&$callout_address$&"
33446 When a connection is made to the server the expansion variable &$callout_address$&
33447 is set to record the actual address used.
33448
33449 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33450 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33451 .code
33452 deny message = This message was classified as SPAM
33453      spam = joe
33454 .endd
33455 The right-hand side of the &%spam%& condition specifies a name. This is
33456 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33457 to scan using a specific profile, but rather use the SpamAssassin system-wide
33458 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33459 Rspamd does not use this setting. However, you must put something on the
33460 right-hand side.
33461
33462 The name allows you to use per-domain or per-user antispam profiles in
33463 principle, but this is not straightforward in practice, because a message may
33464 have multiple recipients, not necessarily all in the same domain. Because the
33465 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
33466 read the contents of the message, the variables &$local_part$& and &$domain$&
33467 are not set.
33468 Careful enforcement of single-recipient messages
33469 (e.g. by responding with defer in the recipient ACL for all recipients
33470 after the first),
33471 or the use of PRDR,
33472 .cindex "PRDR" "use for per-user SpamAssassin profiles"
33473 are needed to use this feature.
33474
33475 The right-hand side of the &%spam%& condition is expanded before being used, so
33476 you can put lookups or conditions there. When the right-hand side evaluates to
33477 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
33478
33479
33480 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
33481 large ones may cause significant performance degradation. As most spam messages
33482 are quite small, it is recommended that you do not scan the big ones. For
33483 example:
33484 .code
33485 deny message = This message was classified as SPAM
33486      condition = ${if < {$message_size}{10K}}
33487      spam = nobody
33488 .endd
33489
33490 The &%spam%& condition returns true if the threshold specified in the user's
33491 SpamAssassin profile has been matched or exceeded. If you want to use the
33492 &%spam%& condition for its side effects (see the variables below), you can make
33493 it always return &"true"& by appending &`:true`& to the username.
33494
33495 .cindex "spam scanning" "returned variables"
33496 When the &%spam%& condition is run, it sets up a number of expansion
33497 variables.
33498 Except for &$spam_report$&,
33499 these variables are saved with the received message so are
33500 available for use at delivery time.
33501
33502 .vlist
33503 .vitem &$spam_score$&
33504 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
33505 for inclusion in log or reject messages.
33506
33507 .vitem &$spam_score_int$&
33508 The spam score of the message, multiplied by ten, as an integer value. For
33509 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33510 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33511 The integer value is useful for numeric comparisons in conditions.
33512
33513 .vitem &$spam_bar$&
33514 A string consisting of a number of &"+"& or &"-"& characters, representing the
33515 integer part of the spam score value. A spam score of 4.4 would have a
33516 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33517 headers, since MUAs can match on such strings. The maximum length of the
33518 spam bar is 50 characters.
33519
33520 .vitem &$spam_report$&
33521 A multiline text table, containing the full SpamAssassin report for the
33522 message. Useful for inclusion in headers or reject messages.
33523 This variable is only usable in a DATA-time ACL.
33524 Beware that SpamAssassin may return non-ASCII characters, especially
33525 when running in country-specific locales, which are not legal
33526 unencoded in headers.
33527
33528 .vitem &$spam_action$&
33529 For SpamAssassin either 'reject' or 'no action' depending on the
33530 spam score versus threshold.
33531 For Rspamd, the recommended action.
33532
33533 .endlist
33534
33535 The &%spam%& condition caches its results unless expansion in
33536 spamd_address was used. If you call it again with the same user name, it
33537 does not scan again, but rather returns the same values as before.
33538
33539 The &%spam%& condition returns DEFER if there is any error while running
33540 the message through SpamAssassin or if the expansion of spamd_address
33541 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33542 statement block), append &`/defer_ok`& to the right-hand side of the
33543 spam condition, like this:
33544 .code
33545 deny message = This message was classified as SPAM
33546      spam    = joe/defer_ok
33547 .endd
33548 This causes messages to be accepted even if there is a problem with &%spamd%&.
33549
33550 Here is a longer, commented example of the use of the &%spam%&
33551 condition:
33552 .code
33553 # put headers in all messages (no matter if spam or not)
33554 warn  spam = nobody:true
33555       add_header = X-Spam-Score: $spam_score ($spam_bar)
33556       add_header = X-Spam-Report: $spam_report
33557
33558 # add second subject line with *SPAM* marker when message
33559 # is over threshold
33560 warn  spam = nobody
33561       add_header = Subject: *SPAM* $h_Subject:
33562
33563 # reject spam at high scores (> 12)
33564 deny  message = This message scored $spam_score spam points.
33565       spam = nobody:true
33566       condition = ${if >{$spam_score_int}{120}{1}{0}}
33567 .endd
33568
33569
33570
33571 .section "Scanning MIME parts" "SECTscanmimepart"
33572 .cindex "content scanning" "MIME parts"
33573 .cindex "MIME content scanning"
33574 .oindex "&%acl_smtp_mime%&"
33575 .oindex "&%acl_not_smtp_mime%&"
33576 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33577 each MIME part of an SMTP message, including multipart types, in the sequence
33578 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33579 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33580 options may both refer to the same ACL if you want the same processing in both
33581 cases.
33582
33583 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33584 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33585 the case of a non-SMTP message. However, a MIME ACL is called only if the
33586 message contains a &'Content-Type:'& header line. When a call to a MIME
33587 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33588 result code is sent to the client. In the case of an SMTP message, the
33589 &%acl_smtp_data%& ACL is not called when this happens.
33590
33591 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33592 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33593 condition to match against the raw MIME part. You can also use the
33594 &%mime_regex%& condition to match against the decoded MIME part (see section
33595 &<<SECTscanregex>>&).
33596
33597 At the start of a MIME ACL, a number of variables are set from the header
33598 information for the relevant MIME part. These are described below. The contents
33599 of the MIME part are not by default decoded into a disk file except for MIME
33600 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33601 part into a disk file, you can use the &%decode%& condition. The general
33602 syntax is:
33603 .display
33604 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33605 .endd
33606 The right hand side is expanded before use. After expansion,
33607 the value can be:
33608
33609 .olist
33610 &"0"& or &"false"&, in which case no decoding is done.
33611 .next
33612 The string &"default"&. In that case, the file is put in the temporary
33613 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33614 a sequential filename consisting of the message id and a sequence number. The
33615 full path and name is available in &$mime_decoded_filename$& after decoding.
33616 .next
33617 A full path name starting with a slash. If the full name is an existing
33618 directory, it is used as a replacement for the default directory. The filename
33619 is then sequentially assigned. If the path does not exist, it is used as
33620 the full path and filename.
33621 .next
33622 If the string does not start with a slash, it is used as the
33623 filename, and the default path is then used.
33624 .endlist
33625 The &%decode%& condition normally succeeds. It is only false for syntax
33626 errors or unusual circumstances such as memory shortages. You can easily decode
33627 a file with its original, proposed filename using
33628 .code
33629 decode = $mime_filename
33630 .endd
33631 However, you should keep in mind that &$mime_filename$& might contain
33632 anything. If you place files outside of the default path, they are not
33633 automatically unlinked.
33634
33635 For RFC822 attachments (these are messages attached to messages, with a
33636 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33637 as for the primary message, only that the &$mime_is_rfc822$& expansion
33638 variable is set (see below). Attached messages are always decoded to disk
33639 before being checked, and the files are unlinked once the check is done.
33640
33641 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33642 used to match regular expressions against raw and decoded MIME parts,
33643 respectively. They are described in section &<<SECTscanregex>>&.
33644
33645 .cindex "MIME content scanning" "returned variables"
33646 The following list describes all expansion variables that are
33647 available in the MIME ACL:
33648
33649 .vlist
33650 .vitem &$mime_boundary$&
33651 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33652 have a boundary string, which is stored in this variable. If the current part
33653 has no boundary parameter in the &'Content-Type:'& header, this variable
33654 contains the empty string.
33655
33656 .vitem &$mime_charset$&
33657 This variable contains the character set identifier, if one was found in the
33658 &'Content-Type:'& header. Examples for charset identifiers are:
33659 .code
33660 us-ascii
33661 gb2312 (Chinese)
33662 iso-8859-1
33663 .endd
33664 Please note that this value is not normalized, so you should do matches
33665 case-insensitively.
33666
33667 .vitem &$mime_content_description$&
33668 This variable contains the normalized content of the &'Content-Description:'&
33669 header. It can contain a human-readable description of the parts content. Some
33670 implementations repeat the filename for attachments here, but they are usually
33671 only used for display purposes.
33672
33673 .vitem &$mime_content_disposition$&
33674 This variable contains the normalized content of the &'Content-Disposition:'&
33675 header. You can expect strings like &"attachment"& or &"inline"& here.
33676
33677 .vitem &$mime_content_id$&
33678 This variable contains the normalized content of the &'Content-ID:'& header.
33679 This is a unique ID that can be used to reference a part from another part.
33680
33681 .vitem &$mime_content_size$&
33682 This variable is set only after the &%decode%& modifier (see above) has been
33683 successfully run. It contains the size of the decoded part in kilobytes. The
33684 size is always rounded up to full kilobytes, so only a completely empty part
33685 has a &$mime_content_size$& of zero.
33686
33687 .vitem &$mime_content_transfer_encoding$&
33688 This variable contains the normalized content of the
33689 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33690 type. Typical values are &"base64"& and &"quoted-printable"&.
33691
33692 .vitem &$mime_content_type$&
33693 If the MIME part has a &'Content-Type:'& header, this variable contains its
33694 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33695 are some examples of popular MIME types, as they may appear in this variable:
33696 .code
33697 text/plain
33698 text/html
33699 application/octet-stream
33700 image/jpeg
33701 audio/midi
33702 .endd
33703 If the MIME part has no &'Content-Type:'& header, this variable contains the
33704 empty string.
33705
33706 .vitem &$mime_decoded_filename$&
33707 This variable is set only after the &%decode%& modifier (see above) has been
33708 successfully run. It contains the full path and filename of the file
33709 containing the decoded data.
33710 .endlist
33711
33712 .cindex "RFC 2047"
33713 .vlist
33714 .vitem &$mime_filename$&
33715 This is perhaps the most important of the MIME variables. It contains a
33716 proposed filename for an attachment, if one was found in either the
33717 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33718 RFC2047
33719 or RFC2231
33720 decoded, but no additional sanity checks are done.
33721  If no filename was
33722 found, this variable contains the empty string.
33723
33724 .vitem &$mime_is_coverletter$&
33725 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33726 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33727 content in the cover letter, while not restricting attachments at all.
33728
33729 The variable contains 1 (true) for a MIME part believed to be part of the
33730 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33731 follows:
33732
33733 .olist
33734 The outermost MIME part of a message is always a cover letter.
33735
33736 .next
33737 If a multipart/alternative or multipart/related MIME part is a cover letter,
33738 so are all MIME subparts within that multipart.
33739
33740 .next
33741 If any other multipart is a cover letter, the first subpart is a cover letter,
33742 and the rest are attachments.
33743
33744 .next
33745 All parts contained within an attachment multipart are attachments.
33746 .endlist olist
33747
33748 As an example, the following will ban &"HTML mail"& (including that sent with
33749 alternative plain text), while allowing HTML files to be attached. HTML
33750 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33751 .code
33752 deny message = HTML mail is not accepted here
33753 !condition = $mime_is_rfc822
33754 condition = $mime_is_coverletter
33755 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33756 .endd
33757 .vitem &$mime_is_multipart$&
33758 This variable has the value 1 (true) when the current part has the main type
33759 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33760 Since multipart entities only serve as containers for other parts, you may not
33761 want to carry out specific actions on them.
33762
33763 .vitem &$mime_is_rfc822$&
33764 This variable has the value 1 (true) if the current part is not a part of the
33765 checked message itself, but part of an attached message. Attached message
33766 decoding is fully recursive.
33767
33768 .vitem &$mime_part_count$&
33769 This variable is a counter that is raised for each processed MIME part. It
33770 starts at zero for the very first part (which is usually a multipart). The
33771 counter is per-message, so it is reset when processing RFC822 attachments (see
33772 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33773 complete, so you can use it in the DATA ACL to determine the number of MIME
33774 parts of a message. For non-MIME messages, this variable contains the value -1.
33775 .endlist
33776
33777
33778
33779 .section "Scanning with regular expressions" "SECTscanregex"
33780 .cindex "content scanning" "with regular expressions"
33781 .cindex "regular expressions" "content scanning with"
33782 You can specify your own custom regular expression matches on the full body of
33783 the message, or on individual MIME parts.
33784
33785 The &%regex%& condition takes one or more regular expressions as arguments and
33786 matches them against the full message (when called in the DATA ACL) or a raw
33787 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33788 linewise, with a maximum line length of 32K characters. That means you cannot
33789 have multiline matches with the &%regex%& condition.
33790
33791 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33792 to 32K of decoded content (the whole content at once, not linewise). If the
33793 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33794 is decoded automatically when &%mime_regex%& is executed (using default path
33795 and filename values). If the decoded data is larger than  32K, only the first
33796 32K characters are checked.
33797
33798 The regular expressions are passed as a colon-separated list. To include a
33799 literal colon, you must double it. Since the whole right-hand side string is
33800 expanded before being used, you must also escape dollar signs and backslashes
33801 with more backslashes, or use the &`\N`& facility to disable expansion.
33802 Here is a simple example that contains two regular expressions:
33803 .code
33804 deny message = contains blacklisted regex ($regex_match_string)
33805      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33806 .endd
33807 The conditions returns true if any one of the regular expressions matches. The
33808 &$regex_match_string$& expansion variable is then set up and contains the
33809 matching regular expression.
33810 The expansion variables &$regex1$& &$regex2$& etc
33811 are set to any substrings captured by the regular expression.
33812
33813 &*Warning*&: With large messages, these conditions can be fairly
33814 CPU-intensive.
33815
33816 .ecindex IIDcosca
33817
33818
33819
33820
33821 . ////////////////////////////////////////////////////////////////////////////
33822 . ////////////////////////////////////////////////////////////////////////////
33823
33824 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33825          "Local scan function"
33826 .scindex IIDlosca "&[local_scan()]& function" "description of"
33827 .cindex "customizing" "input scan using C function"
33828 .cindex "policy control" "by local scan function"
33829 In these days of email worms, viruses, and ever-increasing spam, some sites
33830 want to apply a lot of checking to messages before accepting them.
33831
33832 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33833 passing messages to external virus and spam scanning software. You can also do
33834 a certain amount in Exim itself through string expansions and the &%condition%&
33835 condition in the ACL that runs after the SMTP DATA command or the ACL for
33836 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33837
33838 To allow for further customization to a site's own requirements, there is the
33839 possibility of linking Exim with a private message scanning function, written
33840 in C. If you want to run code that is written in something other than C, you
33841 can of course use a little C stub to call it.
33842
33843 The local scan function is run once for every incoming message, at the point
33844 when Exim is just about to accept the message.
33845 It can therefore be used to control non-SMTP messages from local processes as
33846 well as messages arriving via SMTP.
33847
33848 Exim applies a timeout to calls of the local scan function, and there is an
33849 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33850 Zero means &"no timeout"&.
33851 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33852 before calling the local scan function, so that the most common types of crash
33853 are caught. If the timeout is exceeded or one of those signals is caught, the
33854 incoming message is rejected with a temporary error if it is an SMTP message.
33855 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33856 code. The incident is logged on the main and reject logs.
33857
33858
33859
33860 .section "Building Exim to use a local scan function" "SECID207"
33861 .cindex "&[local_scan()]& function" "building Exim to use"
33862 To make use of the local scan function feature, you must tell Exim where your
33863 function is before building Exim, by setting
33864 both HAVE_LOCAL_SCAN and
33865 LOCAL_SCAN_SOURCE in your
33866 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33867 directory, so you might set
33868 .code
33869 HAVE_LOCAL_SCAN=yes
33870 LOCAL_SCAN_SOURCE=Local/local_scan.c
33871 .endd
33872 for example. The function must be called &[local_scan()]&;
33873 .new
33874 the source file(s) for it should first #define LOCAL_SCAN
33875 and then #include "local_scan.h".
33876 .wen
33877 It is called by
33878 Exim after it has received a message, when the success return code is about to
33879 be sent. This is after all the ACLs have been run. The return code from your
33880 function controls whether the message is actually accepted or not. There is a
33881 commented template function (that just accepts the message) in the file
33882 _src/local_scan.c_.
33883
33884 If you want to make use of Exim's runtime configuration file to set options
33885 for your &[local_scan()]& function, you must also set
33886 .code
33887 LOCAL_SCAN_HAS_OPTIONS=yes
33888 .endd
33889 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33890
33891
33892
33893
33894 .section "API for local_scan()" "SECTapiforloc"
33895 .cindex "&[local_scan()]& function" "API description"
33896 .cindex &%dlfunc%& "API description"
33897 You must include this line near the start of your code:
33898 .code
33899 #include "local_scan.h"
33900 .endd
33901 This header file defines a number of variables and other values, and the
33902 prototype for the function itself. Exim is coded to use unsigned char values
33903 almost exclusively, and one of the things this header defines is a shorthand
33904 for &`unsigned char`& called &`uschar`&.
33905 It also contains the following macro definitions, to simplify casting character
33906 strings and pointers to character strings:
33907 .code
33908 #define CS   (char *)
33909 #define CCS  (const char *)
33910 #define CSS  (char **)
33911 #define US   (unsigned char *)
33912 #define CUS  (const unsigned char *)
33913 #define USS  (unsigned char **)
33914 .endd
33915 The function prototype for &[local_scan()]& is:
33916 .code
33917 extern int local_scan(int fd, uschar **return_text);
33918 .endd
33919 The arguments are as follows:
33920
33921 .ilist
33922 &%fd%& is a file descriptor for the file that contains the body of the message
33923 (the -D file). The file is open for reading and writing, but updating it is not
33924 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33925
33926 The descriptor is positioned at character 19 of the file, which is the first
33927 character of the body itself, because the first 19 characters are the message
33928 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33929 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33930 case this changes in some future version.
33931 .next
33932 &%return_text%& is an address which you can use to return a pointer to a text
33933 string at the end of the function. The value it points to on entry is NULL.
33934 .endlist
33935
33936 The function must return an &%int%& value which is one of the following macros:
33937
33938 .vlist
33939 .vitem &`LOCAL_SCAN_ACCEPT`&
33940 .vindex "&$local_scan_data$&"
33941 The message is accepted. If you pass back a string of text, it is saved with
33942 the message, and made available in the variable &$local_scan_data$&. No
33943 newlines are permitted (if there are any, they are turned into spaces) and the
33944 maximum length of text is 1000 characters.
33945
33946 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33947 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33948 queued without immediate delivery, and is frozen.
33949
33950 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33951 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33952 queued without immediate delivery.
33953
33954 .vitem &`LOCAL_SCAN_REJECT`&
33955 The message is rejected; the returned text is used as an error message which is
33956 passed back to the sender and which is also logged. Newlines are permitted &--
33957 they cause a multiline response for SMTP rejections, but are converted to
33958 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33959 used.
33960
33961 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33962 The message is temporarily rejected; the returned text is used as an error
33963 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33964 problem"& is used.
33965
33966 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33967 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33968 message is not written to the reject log. It has the effect of unsetting the
33969 &%rejected_header%& log selector for just this rejection. If
33970 &%rejected_header%& is already unset (see the discussion of the
33971 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33972 same as LOCAL_SCAN_REJECT.
33973
33974 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33975 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33976 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33977 .endlist
33978
33979 If the message is not being received by interactive SMTP, rejections are
33980 reported by writing to &%stderr%& or by sending an email, as configured by the
33981 &%-oe%& command line options.
33982
33983
33984
33985 .section "Configuration options for local_scan()" "SECTconoptloc"
33986 .cindex "&[local_scan()]& function" "configuration options"
33987 It is possible to have option settings in the main configuration file
33988 that set values in static variables in the &[local_scan()]& module. If you
33989 want to do this, you must have the line
33990 .code
33991 LOCAL_SCAN_HAS_OPTIONS=yes
33992 .endd
33993 in your &_Local/Makefile_& when you build Exim. (This line is in
33994 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33995 file, you must define static variables to hold the option values, and a table
33996 to define them.
33997
33998 The table must be a vector called &%local_scan_options%&, of type
33999 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34000 and a pointer to the variable that holds the value. The entries must appear in
34001 alphabetical order. Following &%local_scan_options%& you must also define a
34002 variable called &%local_scan_options_count%& that contains the number of
34003 entries in the table. Here is a short example, showing two kinds of option:
34004 .code
34005 static int my_integer_option = 42;
34006 static uschar *my_string_option = US"a default string";
34007
34008 optionlist local_scan_options[] = {
34009   { "my_integer", opt_int,       &my_integer_option },
34010   { "my_string",  opt_stringptr, &my_string_option }
34011 };
34012
34013 int local_scan_options_count =
34014   sizeof(local_scan_options)/sizeof(optionlist);
34015 .endd
34016 The values of the variables can now be changed from Exim's runtime
34017 configuration file by including a local scan section as in this example:
34018 .code
34019 begin local_scan
34020 my_integer = 99
34021 my_string = some string of text...
34022 .endd
34023 The available types of option data are as follows:
34024
34025 .vlist
34026 .vitem &*opt_bool*&
34027 This specifies a boolean (true/false) option. The address should point to a
34028 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34029 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34030 whether such a variable has been set at all, you can initialize it to
34031 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34032 values.)
34033
34034 .vitem &*opt_fixed*&
34035 This specifies a fixed point number, such as is used for load averages.
34036 The address should point to a variable of type &`int`&. The value is stored
34037 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34038
34039 .vitem &*opt_int*&
34040 This specifies an integer; the address should point to a variable of type
34041 &`int`&. The value may be specified in any of the integer formats accepted by
34042 Exim.
34043
34044 .vitem &*opt_mkint*&
34045 This is the same as &%opt_int%&, except that when such a value is output in a
34046 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34047 printed with the suffix K or M.
34048
34049 .vitem &*opt_octint*&
34050 This also specifies an integer, but the value is always interpreted as an
34051 octal integer, whether or not it starts with the digit zero, and it is
34052 always output in octal.
34053
34054 .vitem &*opt_stringptr*&
34055 This specifies a string value; the address must be a pointer to a
34056 variable that points to a string (for example, of type &`uschar *`&).
34057
34058 .vitem &*opt_time*&
34059 This specifies a time interval value. The address must point to a variable of
34060 type &`int`&. The value that is placed there is a number of seconds.
34061 .endlist
34062
34063 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34064 out the values of all the &[local_scan()]& options.
34065
34066
34067
34068 .section "Available Exim variables" "SECID208"
34069 .cindex "&[local_scan()]& function" "available Exim variables"
34070 The header &_local_scan.h_& gives you access to a number of C variables. These
34071 are the only ones that are guaranteed to be maintained from release to release.
34072 Note, however, that you can obtain the value of any Exim expansion variable,
34073 including &$recipients$&, by calling &'expand_string()'&. The exported
34074 C variables are as follows:
34075
34076 .vlist
34077 .vitem &*int&~body_linecount*&
34078 This variable contains the number of lines in the message's body.
34079 It is not valid if the &%spool_files_wireformat%& option is used.
34080
34081 .vitem &*int&~body_zerocount*&
34082 This variable contains the number of binary zero bytes in the message's body.
34083 It is not valid if the &%spool_files_wireformat%& option is used.
34084
34085 .vitem &*unsigned&~int&~debug_selector*&
34086 This variable is set to zero when no debugging is taking place. Otherwise, it
34087 is a bitmap of debugging selectors. Two bits are identified for use in
34088 &[local_scan()]&; they are defined as macros:
34089
34090 .ilist
34091 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34092 testing option that is not privileged &-- any caller may set it. All the
34093 other selector bits can be set only by admin users.
34094
34095 .next
34096 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34097 by the &`+local_scan`& debug selector. It is not included in the default set
34098 of debugging bits.
34099 .endlist ilist
34100
34101 Thus, to write to the debugging output only when &`+local_scan`& has been
34102 selected, you should use code like this:
34103 .code
34104 if ((debug_selector & D_local_scan) != 0)
34105   debug_printf("xxx", ...);
34106 .endd
34107 .vitem &*uschar&~*expand_string_message*&
34108 After a failing call to &'expand_string()'& (returned value NULL), the
34109 variable &%expand_string_message%& contains the error message, zero-terminated.
34110
34111 .vitem &*header_line&~*header_list*&
34112 A pointer to a chain of header lines. The &%header_line%& structure is
34113 discussed below.
34114
34115 .vitem &*header_line&~*header_last*&
34116 A pointer to the last of the header lines.
34117
34118 .vitem &*uschar&~*headers_charset*&
34119 The value of the &%headers_charset%& configuration option.
34120
34121 .vitem &*BOOL&~host_checking*&
34122 This variable is TRUE during a host checking session that is initiated by the
34123 &%-bh%& command line option.
34124
34125 .vitem &*uschar&~*interface_address*&
34126 The IP address of the interface that received the message, as a string. This
34127 is NULL for locally submitted messages.
34128
34129 .vitem &*int&~interface_port*&
34130 The port on which this message was received. When testing with the &%-bh%&
34131 command line option, the value of this variable is -1 unless a port has been
34132 specified via the &%-oMi%& option.
34133
34134 .vitem &*uschar&~*message_id*&
34135 This variable contains Exim's message id for the incoming message (the value of
34136 &$message_exim_id$&) as a zero-terminated string.
34137
34138 .vitem &*uschar&~*received_protocol*&
34139 The name of the protocol by which the message was received.
34140
34141 .vitem &*int&~recipients_count*&
34142 The number of accepted recipients.
34143
34144 .vitem &*recipient_item&~*recipients_list*&
34145 .cindex "recipient" "adding in local scan"
34146 .cindex "recipient" "removing in local scan"
34147 The list of accepted recipients, held in a vector of length
34148 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34149 can add additional recipients by calling &'receive_add_recipient()'& (see
34150 below). You can delete recipients by removing them from the vector and
34151 adjusting the value in &%recipients_count%&. In particular, by setting
34152 &%recipients_count%& to zero you remove all recipients. If you then return the
34153 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34154 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34155 and then call &'receive_add_recipient()'& as often as needed.
34156
34157 .vitem &*uschar&~*sender_address*&
34158 The envelope sender address. For bounce messages this is the empty string.
34159
34160 .vitem &*uschar&~*sender_host_address*&
34161 The IP address of the sending host, as a string. This is NULL for
34162 locally-submitted messages.
34163
34164 .vitem &*uschar&~*sender_host_authenticated*&
34165 The name of the authentication mechanism that was used, or NULL if the message
34166 was not received over an authenticated SMTP connection.
34167
34168 .vitem &*uschar&~*sender_host_name*&
34169 The name of the sending host, if known.
34170
34171 .vitem &*int&~sender_host_port*&
34172 The port on the sending host.
34173
34174 .vitem &*BOOL&~smtp_input*&
34175 This variable is TRUE for all SMTP input, including BSMTP.
34176
34177 .vitem &*BOOL&~smtp_batched_input*&
34178 This variable is TRUE for BSMTP input.
34179
34180 .vitem &*int&~store_pool*&
34181 The contents of this variable control which pool of memory is used for new
34182 requests. See section &<<SECTmemhanloc>>& for details.
34183 .endlist
34184
34185
34186 .section "Structure of header lines" "SECID209"
34187 The &%header_line%& structure contains the members listed below.
34188 You can add additional header lines by calling the &'header_add()'& function
34189 (see below). You can cause header lines to be ignored (deleted) by setting
34190 their type to *.
34191
34192
34193 .vlist
34194 .vitem &*struct&~header_line&~*next*&
34195 A pointer to the next header line, or NULL for the last line.
34196
34197 .vitem &*int&~type*&
34198 A code identifying certain headers that Exim recognizes. The codes are printing
34199 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34200 Notice in particular that any header line whose type is * is not transmitted
34201 with the message. This flagging is used for header lines that have been
34202 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34203 lines.) Effectively, * means &"deleted"&.
34204
34205 .vitem &*int&~slen*&
34206 The number of characters in the header line, including the terminating and any
34207 internal newlines.
34208
34209 .vitem &*uschar&~*text*&
34210 A pointer to the text of the header. It always ends with a newline, followed by
34211 a zero byte. Internal newlines are preserved.
34212 .endlist
34213
34214
34215
34216 .section "Structure of recipient items" "SECID210"
34217 The &%recipient_item%& structure contains these members:
34218
34219 .vlist
34220 .vitem &*uschar&~*address*&
34221 This is a pointer to the recipient address as it was received.
34222
34223 .vitem &*int&~pno*&
34224 This is used in later Exim processing when top level addresses are created by
34225 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34226 and must always contain -1 at this stage.
34227
34228 .vitem &*uschar&~*errors_to*&
34229 If this value is not NULL, bounce messages caused by failing to deliver to the
34230 recipient are sent to the address it contains. In other words, it overrides the
34231 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34232 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34233 an unqualified address, Exim qualifies it using the domain from
34234 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34235 is NULL for all recipients.
34236 .endlist
34237
34238
34239
34240 .section "Available Exim functions" "SECID211"
34241 .cindex "&[local_scan()]& function" "available Exim functions"
34242 The header &_local_scan.h_& gives you access to a number of Exim functions.
34243 These are the only ones that are guaranteed to be maintained from release to
34244 release:
34245
34246 .vlist
34247 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34248        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34249
34250 This function creates a child process that runs the command specified by
34251 &%argv%&. The environment for the process is specified by &%envp%&, which can
34252 be NULL if no environment variables are to be passed. A new umask is supplied
34253 for the process in &%newumask%&.
34254
34255 Pipes to the standard input and output of the new process are set up
34256 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34257 standard error is cloned to the standard output. If there are any file
34258 descriptors &"in the way"& in the new process, they are closed. If the final
34259 argument is TRUE, the new process is made into a process group leader.
34260
34261 The function returns the pid of the new process, or -1 if things go wrong.
34262
34263 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34264 This function waits for a child process to terminate, or for a timeout (in
34265 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34266 return value is as follows:
34267
34268 .ilist
34269 >= 0
34270
34271 The process terminated by a normal exit and the value is the process
34272 ending status.
34273
34274 .next
34275 < 0 and > &--256
34276
34277 The process was terminated by a signal and the value is the negation of the
34278 signal number.
34279
34280 .next
34281 &--256
34282
34283 The process timed out.
34284 .next
34285 &--257
34286
34287 The was some other error in wait(); &%errno%& is still set.
34288 .endlist
34289
34290 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34291 This function provide you with a means of submitting a new message to
34292 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34293 want, but this packages it all up for you.) The function creates a pipe,
34294 forks a subprocess that is running
34295 .code
34296 exim -t -oem -oi -f <>
34297 .endd
34298 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34299 that is connected to the standard input. The yield of the function is the PID
34300 of the subprocess. You can then write a message to the file descriptor, with
34301 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34302
34303 When you have finished, call &'child_close()'& to wait for the process to
34304 finish and to collect its ending status. A timeout value of zero is usually
34305 fine in this circumstance. Unless you have made a mistake with the recipient
34306 addresses, you should get a return code of zero.
34307
34308
34309 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34310        *sender_authentication)*&
34311 This function is a more sophisticated version of &'child_open()'&. The command
34312 that it runs is:
34313 .display
34314 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34315 .endd
34316 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34317
34318
34319 .vitem &*void&~debug_printf(char&~*,&~...)*&
34320 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34321 output is written to the standard error stream. If no debugging is selected,
34322 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34323 conditional on the &`local_scan`& debug selector by coding like this:
34324 .code
34325 if ((debug_selector & D_local_scan) != 0)
34326   debug_printf("xxx", ...);
34327 .endd
34328
34329 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34330 This is an interface to Exim's string expansion code. The return value is the
34331 expanded string, or NULL if there was an expansion failure.
34332 The C variable &%expand_string_message%& contains an error message after an
34333 expansion failure. If expansion does not change the string, the return value is
34334 the pointer to the input string. Otherwise, the return value points to a new
34335 block of memory that was obtained by a call to &'store_get()'&. See section
34336 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34337
34338 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34339 This function allows you to an add additional header line at the end of the
34340 existing ones. The first argument is the type, and should normally be a space
34341 character. The second argument is a format string and any number of
34342 substitution arguments as for &[sprintf()]&. You may include internal newlines
34343 if you want, and you must ensure that the string ends with a newline.
34344
34345 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34346         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34347 This function adds a new header line at a specified point in the header
34348 chain. The header itself is specified as for &'header_add()'&.
34349
34350 If &%name%& is NULL, the new header is added at the end of the chain if
34351 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34352 NULL, the header lines are searched for the first non-deleted header that
34353 matches the name. If one is found, the new header is added before it if
34354 &%after%& is false. If &%after%& is true, the new header is added after the
34355 found header and any adjacent subsequent ones with the same name (even if
34356 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34357 option controls where the header is added. If it is true, addition is at the
34358 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34359 headers, or at the top if there are no &'Received:'& headers, you could use
34360 .code
34361 header_add_at_position(TRUE, US"Received", TRUE,
34362   ' ', "X-xxx: ...");
34363 .endd
34364 Normally, there is always at least one non-deleted &'Received:'& header, but
34365 there may not be if &%received_header_text%& expands to an empty string.
34366
34367
34368 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34369 This function removes header lines. If &%occurrence%& is zero or negative, all
34370 occurrences of the header are removed. If occurrence is greater than zero, that
34371 particular instance of the header is removed. If no header(s) can be found that
34372 match the specification, the function does nothing.
34373
34374
34375 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34376         int&~length,&~BOOL&~notdel)*&"
34377 This function tests whether the given header has the given name. It is not just
34378 a string comparison, because white space is permitted between the name and the
34379 colon. If the &%notdel%& argument is true, a false return is forced for all
34380 &"deleted"& headers; otherwise they are not treated specially. For example:
34381 .code
34382 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34383 .endd
34384 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34385 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34386 This function base64-encodes a string, which is passed by address and length.
34387 The text may contain bytes of any value, including zero. The result is passed
34388 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34389 zero-terminated.
34390
34391 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34392 This function decodes a base64-encoded string. Its arguments are a
34393 zero-terminated base64-encoded string and the address of a variable that is set
34394 to point to the result, which is in dynamic memory. The length of the decoded
34395 string is the yield of the function. If the input is invalid base64 data, the
34396 yield is -1. A zero byte is added to the end of the output string to make it
34397 easy to interpret as a C string (assuming it contains no zeros of its own). The
34398 added zero byte is not included in the returned count.
34399
34400 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34401 This function checks for a match in a domain list. Domains are always
34402 matched caselessly. The return value is one of the following:
34403 .display
34404 &`OK     `& match succeeded
34405 &`FAIL   `& match failed
34406 &`DEFER  `& match deferred
34407 .endd
34408 DEFER is usually caused by some kind of lookup defer, such as the
34409 inability to contact a database.
34410
34411 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34412         BOOL&~caseless)*&"
34413 This function checks for a match in a local part list. The third argument
34414 controls case-sensitivity. The return values are as for
34415 &'lss_match_domain()'&.
34416
34417 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34418         BOOL&~caseless)*&"
34419 This function checks for a match in an address list. The third argument
34420 controls the case-sensitivity of the local part match. The domain is always
34421 matched caselessly. The return values are as for &'lss_match_domain()'&.
34422
34423 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34424         uschar&~*list)*&"
34425 This function checks for a match in a host list. The most common usage is
34426 expected to be
34427 .code
34428 lss_match_host(sender_host_name, sender_host_address, ...)
34429 .endd
34430 .vindex "&$sender_host_address$&"
34431 An empty address field matches an empty item in the host list. If the host name
34432 is NULL, the name corresponding to &$sender_host_address$& is automatically
34433 looked up if a host name is required to match an item in the list. The return
34434 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34435 returns ERROR in the case when it had to look up a host name, but the lookup
34436 failed.
34437
34438 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34439         *format,&~...)*&"
34440 This function writes to Exim's log files. The first argument should be zero (it
34441 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
34442 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
34443 them. It specifies to which log or logs the message is written. The remaining
34444 arguments are a format and relevant insertion arguments. The string should not
34445 contain any newlines, not even at the end.
34446
34447
34448 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
34449 This function adds an additional recipient to the message. The first argument
34450 is the recipient address. If it is unqualified (has no domain), it is qualified
34451 with the &%qualify_recipient%& domain. The second argument must always be -1.
34452
34453 This function does not allow you to specify a private &%errors_to%& address (as
34454 described with the structure of &%recipient_item%& above), because it pre-dates
34455 the addition of that field to the structure. However, it is easy to add such a
34456 value afterwards. For example:
34457 .code
34458  receive_add_recipient(US"monitor@mydom.example", -1);
34459  recipients_list[recipients_count-1].errors_to =
34460    US"postmaster@mydom.example";
34461 .endd
34462
34463 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
34464 This is a convenience function to remove a named recipient from the list of
34465 recipients. It returns true if a recipient was removed, and false if no
34466 matching recipient could be found. The argument must be a complete email
34467 address.
34468 .endlist
34469
34470
34471 .cindex "RFC 2047"
34472 .vlist
34473 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
34474   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
34475 This function decodes strings that are encoded according to RFC 2047. Typically
34476 these are the contents of header lines. First, each &"encoded word"& is decoded
34477 from the Q or B encoding into a byte-string. Then, if provided with the name of
34478 a charset encoding, and if the &[iconv()]& function is available, an attempt is
34479 made  to translate the result to the named character set. If this fails, the
34480 binary string is returned with an error message.
34481
34482 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
34483 maximum MIME word length is enforced. The third argument is the target
34484 encoding, or NULL if no translation is wanted.
34485
34486 .cindex "binary zero" "in RFC 2047 decoding"
34487 .cindex "RFC 2047" "binary zero in"
34488 If a binary zero is encountered in the decoded string, it is replaced by the
34489 contents of the &%zeroval%& argument. For use with Exim headers, the value must
34490 not be 0 because header lines are handled as zero-terminated strings.
34491
34492 The function returns the result of processing the string, zero-terminated; if
34493 &%lenptr%& is not NULL, the length of the result is set in the variable to
34494 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
34495
34496 If an error is encountered, the function returns NULL and uses the &%error%&
34497 argument to return an error message. The variable pointed to by &%error%& is
34498 set to NULL if there is no error; it may be set non-NULL even when the function
34499 returns a non-NULL value if decoding was successful, but there was a problem
34500 with translation.
34501
34502
34503 .vitem &*int&~smtp_fflush(void)*&
34504 This function is used in conjunction with &'smtp_printf()'&, as described
34505 below.
34506
34507 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
34508 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
34509 output stream. You should use this function only when there is an SMTP output
34510 stream, that is, when the incoming message is being received via interactive
34511 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
34512 is FALSE. If you want to test for an incoming message from another host (as
34513 opposed to a local process that used the &%-bs%& command line option), you can
34514 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34515 is involved.
34516
34517 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34518 output function, so it can be used for all forms of SMTP connection.
34519
34520 The second argument is used to request that the data be buffered
34521 (when TRUE) or flushed (along with any previously buffered, when FALSE).
34522 This is advisory only, but likely to save on system-calls and packets
34523 sent when a sequence of calls to the function are made.
34524
34525 The argument was added in Exim version 4.90 - changing the API/ABI.
34526 Nobody noticed until 4.93 was imminent, at which point the
34527 ABI version number was incremented.
34528
34529 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34530 must start with an appropriate response code: 550 if you are going to return
34531 LOCAL_SCAN_REJECT, 451 if you are going to return
34532 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34533 initial lines of a multi-line response, the code must be followed by a hyphen
34534 to indicate that the line is not the final response line. You must also ensure
34535 that the lines you write terminate with CRLF. For example:
34536 .code
34537 smtp_printf("550-this is some extra info\r\n");
34538 return LOCAL_SCAN_REJECT;
34539 .endd
34540 Note that you can also create multi-line responses by including newlines in
34541 the data returned via the &%return_text%& argument. The added value of using
34542 &'smtp_printf()'& is that, for instance, you could introduce delays between
34543 multiple output lines.
34544
34545 The &'smtp_printf()'& function does not return any error indication, because it
34546 does not
34547 guarantee a flush of
34548 pending output, and therefore does not test
34549 the state of the stream. (In the main code of Exim, flushing and error
34550 detection is done when Exim is ready for the next SMTP input command.) If
34551 you want to flush the output and check for an error (for example, the
34552 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34553 arguments. It flushes the output stream, and returns a non-zero value if there
34554 is an error.
34555
34556 .new
34557 .vitem &*void&~*store_get(int,BOOL)*&
34558 This function accesses Exim's internal store (memory) manager. It gets a new
34559 chunk of memory whose size is given by the first argument.
34560 The second argument should be given as TRUE if the memory will be used for
34561 data possibly coming from an attacker (eg. the message content),
34562 FALSE if it is locally-sourced.
34563 Exim bombs out if it ever
34564 runs out of memory. See the next section for a discussion of memory handling.
34565 .wen
34566
34567 .vitem &*void&~*store_get_perm(int,BOOL)*&
34568 This function is like &'store_get()'&, but it always gets memory from the
34569 permanent pool. See the next section for a discussion of memory handling.
34570
34571 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34572 See below.
34573
34574 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34575 See below.
34576
34577 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34578 These three functions create strings using Exim's dynamic memory facilities.
34579 The first makes a copy of an entire string. The second copies up to a maximum
34580 number of characters, indicated by the second argument. The third uses a format
34581 and insertion arguments to create a new string. In each case, the result is a
34582 pointer to a new string in the current memory pool. See the next section for
34583 more discussion.
34584 .endlist
34585
34586
34587
34588 .section "More about Exim's memory handling" "SECTmemhanloc"
34589 .cindex "&[local_scan()]& function" "memory handling"
34590 No function is provided for freeing memory, because that is never needed.
34591 The dynamic memory that Exim uses when receiving a message is automatically
34592 recycled if another message is received by the same process (this applies only
34593 to incoming SMTP connections &-- other input methods can supply only one
34594 message at a time). After receiving the last message, a reception process
34595 terminates.
34596
34597 Because it is recycled, the normal dynamic memory cannot be used for holding
34598 data that must be preserved over a number of incoming messages on the same SMTP
34599 connection. However, Exim in fact uses two pools of dynamic memory; the second
34600 one is not recycled, and can be used for this purpose.
34601
34602 If you want to allocate memory that remains available for subsequent messages
34603 in the same SMTP connection, you should set
34604 .code
34605 store_pool = POOL_PERM
34606 .endd
34607 before calling the function that does the allocation. There is no need to
34608 restore the value if you do not need to; however, if you do want to revert to
34609 the normal pool, you can either restore the previous value of &%store_pool%& or
34610 set it explicitly to POOL_MAIN.
34611
34612 The pool setting applies to all functions that get dynamic memory, including
34613 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34614 There is also a convenience function called &'store_get_perm()'& that gets a
34615 block of memory from the permanent pool while preserving the value of
34616 &%store_pool%&.
34617 .ecindex IIDlosca
34618
34619
34620
34621
34622 . ////////////////////////////////////////////////////////////////////////////
34623 . ////////////////////////////////////////////////////////////////////////////
34624
34625 .chapter "System-wide message filtering" "CHAPsystemfilter"
34626 .scindex IIDsysfil1 "filter" "system filter"
34627 .scindex IIDsysfil2 "filtering all mail"
34628 .scindex IIDsysfil3 "system filter"
34629 The previous chapters (on ACLs and the local scan function) describe checks
34630 that can be applied to messages before they are accepted by a host. There is
34631 also a mechanism for checking messages once they have been received, but before
34632 they are delivered. This is called the &'system filter'&.
34633
34634 The system filter operates in a similar manner to users' filter files, but it
34635 is run just once per message (however many recipients the message has).
34636 It should not normally be used as a substitute for routing, because &%deliver%&
34637 commands in a system router provide new envelope recipient addresses.
34638 The system filter must be an Exim filter. It cannot be a Sieve filter.
34639
34640 The system filter is run at the start of a delivery attempt, before any routing
34641 is done. If a message fails to be completely delivered at the first attempt,
34642 the system filter is run again at the start of every retry.
34643 If you want your filter to do something only once per message, you can make use
34644 of the &%first_delivery%& condition in an &%if%& command in the filter to
34645 prevent it happening on retries.
34646
34647 .vindex "&$domain$&"
34648 .vindex "&$local_part$&"
34649 &*Warning*&: Because the system filter runs just once, variables that are
34650 specific to individual recipient addresses, such as &$local_part$& and
34651 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34652 you want to run a centrally-specified filter for each recipient address
34653 independently, you can do so by setting up a suitable &(redirect)& router, as
34654 described in section &<<SECTperaddfil>>& below.
34655
34656
34657 .section "Specifying a system filter" "SECID212"
34658 .cindex "uid (user id)" "system filter"
34659 .cindex "gid (group id)" "system filter"
34660 The name of the file that contains the system filter must be specified by
34661 setting &%system_filter%&. If you want the filter to run under a uid and gid
34662 other than root, you must also set &%system_filter_user%& and
34663 &%system_filter_group%& as appropriate. For example:
34664 .code
34665 system_filter = /etc/mail/exim.filter
34666 system_filter_user = exim
34667 .endd
34668 If a system filter generates any deliveries directly to files or pipes (via the
34669 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34670 specified by setting &%system_filter_file_transport%& and
34671 &%system_filter_pipe_transport%&, respectively. Similarly,
34672 &%system_filter_reply_transport%& must be set to handle any messages generated
34673 by the &%reply%& command.
34674
34675
34676 .section "Testing a system filter" "SECID213"
34677 You can run simple tests of a system filter in the same way as for a user
34678 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34679 are permitted only in system filters are recognized.
34680
34681 If you want to test the combined effect of a system filter and a user filter,
34682 you can use both &%-bF%& and &%-bf%& on the same command line.
34683
34684
34685
34686 .section "Contents of a system filter" "SECID214"
34687 The language used to specify system filters is the same as for users' filter
34688 files. It is described in the separate end-user document &'Exim's interface to
34689 mail filtering'&. However, there are some additional features that are
34690 available only in system filters; these are described in subsequent sections.
34691 If they are encountered in a user's filter file or when testing with &%-bf%&,
34692 they cause errors.
34693
34694 .cindex "frozen messages" "manual thaw; testing in filter"
34695 There are two special conditions which, though available in users' filter
34696 files, are designed for use in system filters. The condition &%first_delivery%&
34697 is true only for the first attempt at delivering a message, and
34698 &%manually_thawed%& is true only if the message has been frozen, and
34699 subsequently thawed by an admin user. An explicit forced delivery counts as a
34700 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34701
34702 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34703 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34704 succeed, it will not be tried again.
34705 If you want Exim to retry an unseen delivery until it succeeds, you should
34706 arrange to set it up every time the filter runs.
34707
34708 When a system filter finishes running, the values of the variables &$n0$& &--
34709 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34710 users' filter files. Thus a system filter can, for example, set up &"scores"&
34711 to which users' filter files can refer.
34712
34713
34714
34715 .section "Additional variable for system filters" "SECID215"
34716 .vindex "&$recipients$&"
34717 The expansion variable &$recipients$&, containing a list of all the recipients
34718 of the message (separated by commas and white space), is available in system
34719 filters. It is not available in users' filters for privacy reasons.
34720
34721
34722
34723 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34724 .cindex "freezing messages"
34725 .cindex "message" "freezing"
34726 .cindex "message" "forced failure"
34727 .cindex "&%fail%&" "in system filter"
34728 .cindex "&%freeze%& in system filter"
34729 .cindex "&%defer%& in system filter"
34730 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34731 always available in system filters, but are not normally enabled in users'
34732 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34733 for the &(redirect)& router.) These commands can optionally be followed by the
34734 word &%text%& and a string containing an error message, for example:
34735 .code
34736 fail text "this message looks like spam to me"
34737 .endd
34738 The keyword &%text%& is optional if the next character is a double quote.
34739
34740 The &%defer%& command defers delivery of the original recipients of the
34741 message. The &%fail%& command causes all the original recipients to be failed,
34742 and a bounce message to be created. The &%freeze%& command suspends all
34743 delivery attempts for the original recipients. In all cases, any new deliveries
34744 that are specified by the filter are attempted as normal after the filter has
34745 run.
34746
34747 The &%freeze%& command is ignored if the message has been manually unfrozen and
34748 not manually frozen since. This means that automatic freezing by a system
34749 filter can be used as a way of checking out suspicious messages. If a message
34750 is found to be all right, manually unfreezing it allows it to be delivered.
34751
34752 .cindex "log" "&%fail%& command log line"
34753 .cindex "&%fail%&" "log line; reducing"
34754 The text given with a fail command is used as part of the bounce message as
34755 well as being written to the log. If the message is quite long, this can fill
34756 up a lot of log space when such failures are common. To reduce the size of the
34757 log message, Exim interprets the text in a special way if it starts with the
34758 two characters &`<<`& and contains &`>>`& later. The text between these two
34759 strings is written to the log, and the rest of the text is used in the bounce
34760 message. For example:
34761 .code
34762 fail "<<filter test 1>>Your message is rejected \
34763      because it contains attachments that we are \
34764      not prepared to receive."
34765 .endd
34766
34767 .cindex "loop" "caused by &%fail%&"
34768 Take great care with the &%fail%& command when basing the decision to fail on
34769 the contents of the message, because the bounce message will of course include
34770 the contents of the original message and will therefore trigger the &%fail%&
34771 command again (causing a mail loop) unless steps are taken to prevent this.
34772 Testing the &%error_message%& condition is one way to prevent this. You could
34773 use, for example
34774 .code
34775 if $message_body contains "this is spam" and not error_message
34776 then fail text "spam is not wanted here" endif
34777 .endd
34778 though of course that might let through unwanted bounce messages. The
34779 alternative is clever checking of the body and/or headers to detect bounces
34780 generated by the filter.
34781
34782 The interpretation of a system filter file ceases after a
34783 &%defer%&,
34784 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34785 set up earlier in the filter file are honoured, so you can use a sequence such
34786 as
34787 .code
34788 mail ...
34789 freeze
34790 .endd
34791 to send a specified message when the system filter is freezing (or deferring or
34792 failing) a message. The normal deliveries for the message do not, of course,
34793 take place.
34794
34795
34796
34797 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34798 .cindex "header lines" "adding; in system filter"
34799 .cindex "header lines" "removing; in system filter"
34800 .cindex "filter" "header lines; adding/removing"
34801 Two filter commands that are available only in system filters are:
34802 .code
34803 headers add <string>
34804 headers remove <string>
34805 .endd
34806 The argument for the &%headers add%& is a string that is expanded and then
34807 added to the end of the message's headers. It is the responsibility of the
34808 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34809 space is ignored, and if the string is otherwise empty, or if the expansion is
34810 forced to fail, the command has no effect.
34811
34812 You can use &"\n"& within the string, followed by white space, to specify
34813 continued header lines. More than one header may be added in one command by
34814 including &"\n"& within the string without any following white space. For
34815 example:
34816 .code
34817 headers add "X-header-1: ....\n  \
34818              continuation of X-header-1 ...\n\
34819              X-header-2: ...."
34820 .endd
34821 Note that the header line continuation white space after the first newline must
34822 be placed before the backslash that continues the input string, because white
34823 space after input continuations is ignored.
34824
34825 The argument for &%headers remove%& is a colon-separated list of header names.
34826 This command applies only to those headers that are stored with the message;
34827 those that are added at delivery time (such as &'Envelope-To:'& and
34828 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34829 header with the same name, they are all removed.
34830
34831 The &%headers%& command in a system filter makes an immediate change to the set
34832 of header lines that was received with the message (with possible additions
34833 from ACL processing). Subsequent commands in the system filter operate on the
34834 modified set, which also forms the basis for subsequent message delivery.
34835 Unless further modified during routing or transporting, this set of headers is
34836 used for all recipients of the message.
34837
34838 During routing and transporting, the variables that refer to the contents of
34839 header lines refer only to those lines that are in this set. Thus, header lines
34840 that are added by a system filter are visible to users' filter files and to all
34841 routers and transports. This contrasts with the manipulation of header lines by
34842 routers and transports, which is not immediate, but which instead is saved up
34843 until the message is actually being written (see section
34844 &<<SECTheadersaddrem>>&).
34845
34846 If the message is not delivered at the first attempt, header lines that were
34847 added by the system filter are stored with the message, and so are still
34848 present at the next delivery attempt. Header lines that were removed are still
34849 present, but marked &"deleted"& so that they are not transported with the
34850 message. For this reason, it is usual to make the &%headers%& command
34851 conditional on &%first_delivery%& so that the set of header lines is not
34852 modified more than once.
34853
34854 Because header modification in a system filter acts immediately, you have to
34855 use an indirect approach if you want to modify the contents of a header line.
34856 For example:
34857 .code
34858 headers add "Old-Subject: $h_subject:"
34859 headers remove "Subject"
34860 headers add "Subject: new subject (was: $h_old-subject:)"
34861 headers remove "Old-Subject"
34862 .endd
34863
34864
34865
34866 .section "Setting an errors address in a system filter" "SECID217"
34867 .cindex "envelope from"
34868 .cindex "envelope sender"
34869 In a system filter, if a &%deliver%& command is followed by
34870 .code
34871 errors_to <some address>
34872 .endd
34873 in order to change the envelope sender (and hence the error reporting) for that
34874 delivery, any address may be specified. (In a user filter, only the current
34875 user's address can be set.) For example, if some mail is being monitored, you
34876 might use
34877 .code
34878 unseen deliver monitor@spying.example errors_to root@local.example
34879 .endd
34880 to take a copy which would not be sent back to the normal error reporting
34881 address if its delivery failed.
34882
34883
34884
34885 .section "Per-address filtering" "SECTperaddfil"
34886 .vindex "&$domain$&"
34887 .vindex "&$local_part$&"
34888 In contrast to the system filter, which is run just once per message for each
34889 delivery attempt, it is also possible to set up a system-wide filtering
34890 operation that runs once for each recipient address. In this case, variables
34891 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34892 filter file could be made dependent on them. This is an example of a router
34893 which implements such a filter:
34894 .code
34895 central_filter:
34896   check_local_user
34897   driver = redirect
34898   domains = +local_domains
34899   file = /central/filters/$local_part
34900   no_verify
34901   allow_filter
34902   allow_freeze
34903 .endd
34904 The filter is run in a separate process under its own uid. Therefore, either
34905 &%check_local_user%& must be set (as above), in which case the filter is run as
34906 the local user, or the &%user%& option must be used to specify which user to
34907 use. If both are set, &%user%& overrides.
34908
34909 Care should be taken to ensure that none of the commands in the filter file
34910 specify a significant delivery if the message is to go on to be delivered to
34911 its intended recipient. The router will not then claim to have dealt with the
34912 address, so it will be passed on to subsequent routers to be delivered in the
34913 normal way.
34914 .ecindex IIDsysfil1
34915 .ecindex IIDsysfil2
34916 .ecindex IIDsysfil3
34917
34918
34919
34920
34921
34922
34923 . ////////////////////////////////////////////////////////////////////////////
34924 . ////////////////////////////////////////////////////////////////////////////
34925
34926 .chapter "Message processing" "CHAPmsgproc"
34927 .scindex IIDmesproc "message" "general processing"
34928 Exim performs various transformations on the sender and recipient addresses of
34929 all messages that it handles, and also on the messages' header lines. Some of
34930 these are optional and configurable, while others always take place. All of
34931 this processing, except rewriting as a result of routing, and the addition or
34932 removal of header lines while delivering, happens when a message is received,
34933 before it is placed on Exim's queue.
34934
34935 Some of the automatic processing takes place by default only for
34936 &"locally-originated"& messages. This adjective is used to describe messages
34937 that are not received over TCP/IP, but instead are passed to an Exim process on
34938 its standard input. This includes the interactive &"local SMTP"& case that is
34939 set up by the &%-bs%& command line option.
34940
34941 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34942 or ::1) are not considered to be locally-originated. Exim does not treat the
34943 loopback interface specially in any way.
34944
34945 If you want the loopback interface to be treated specially, you must ensure
34946 that there are appropriate entries in your ACLs.
34947
34948
34949
34950
34951 .section "Submission mode for non-local messages" "SECTsubmodnon"
34952 .cindex "message" "submission"
34953 .cindex "submission mode"
34954 Processing that happens automatically for locally-originated messages (unless
34955 &%suppress_local_fixups%& is set) can also be requested for messages that are
34956 received over TCP/IP. The term &"submission mode"& is used to describe this
34957 state. Submission mode is set by the modifier
34958 .code
34959 control = submission
34960 .endd
34961 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34962 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34963 a local submission, and is normally used when the source of the message is
34964 known to be an MUA running on a client host (as opposed to an MTA). For
34965 example, to set submission mode for messages originating on the IPv4 loopback
34966 interface, you could include the following in the MAIL ACL:
34967 .code
34968 warn  hosts = 127.0.0.1
34969       control = submission
34970 .endd
34971 .cindex "&%sender_retain%& submission option"
34972 There are some options that can be used when setting submission mode. A slash
34973 is used to separate options. For example:
34974 .code
34975 control = submission/sender_retain
34976 .endd
34977 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34978 true and &%local_from_check%& false for the current incoming message. The first
34979 of these allows an existing &'Sender:'& header in the message to remain, and
34980 the second suppresses the check to ensure that &'From:'& matches the
34981 authenticated sender. With this setting, Exim still fixes up messages by adding
34982 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34983 attempt to check sender authenticity in header lines.
34984
34985 When &%sender_retain%& is not set, a submission mode setting may specify a
34986 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34987 example:
34988 .code
34989 control = submission/domain=some.domain
34990 .endd
34991 The domain may be empty. How this value is used is described in sections
34992 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34993 that allows you to specify the user's full name for inclusion in a created
34994 &'Sender:'& or &'From:'& header line. For example:
34995 .code
34996 accept authenticated = *
34997        control = submission/domain=wonderland.example/\
34998                             name=${lookup {$authenticated_id} \
34999                                    lsearch {/etc/exim/namelist}}
35000 .endd
35001 Because the name may contain any characters, including slashes, the &%name%&
35002 option must be given last. The remainder of the string is used as the name. For
35003 the example above, if &_/etc/exim/namelist_& contains:
35004 .code
35005 bigegg:  Humpty Dumpty
35006 .endd
35007 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35008 line would be:
35009 .code
35010 Sender: Humpty Dumpty <bigegg@wonderland.example>
35011 .endd
35012 .cindex "return path" "in submission mode"
35013 By default, submission mode forces the return path to the same address as is
35014 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35015 specified, the return path is also left unchanged.
35016
35017 &*Note*&: The changes caused by submission mode take effect after the predata
35018 ACL. This means that any sender checks performed before the fix-ups use the
35019 untrusted sender address specified by the user, not the trusted sender address
35020 specified by submission mode. Although this might be slightly unexpected, it
35021 does mean that you can configure ACL checks to spot that a user is trying to
35022 spoof another's address.
35023
35024 .section "Line endings" "SECTlineendings"
35025 .cindex "line endings"
35026 .cindex "carriage return"
35027 .cindex "linefeed"
35028 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35029 linefeed) is the line ending for messages transmitted over the Internet using
35030 SMTP over TCP/IP. However, within individual operating systems, different
35031 conventions are used. For example, Unix-like systems use just LF, but others
35032 use CRLF or just CR.
35033
35034 Exim was designed for Unix-like systems, and internally, it stores messages
35035 using the system's convention of a single LF as a line terminator. When
35036 receiving a message, all line endings are translated to this standard format.
35037 Originally, it was thought that programs that passed messages directly to an
35038 MTA within an operating system would use that system's convention. Experience
35039 has shown that this is not the case; for example, there are Unix applications
35040 that use CRLF in this circumstance. For this reason, and for compatibility with
35041 other MTAs, the way Exim handles line endings for all messages is now as
35042 follows:
35043
35044 .ilist
35045 LF not preceded by CR is treated as a line ending.
35046 .next
35047 CR is treated as a line ending; if it is immediately followed by LF, the LF
35048 is ignored.
35049 .next
35050 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35051 nor a local message in the state where a line containing only a dot is a
35052 terminator.
35053 .next
35054 If a bare CR is encountered within a header line, an extra space is added after
35055 the line terminator so as not to end the header line. The reasoning behind this
35056 is that bare CRs in header lines are most likely either to be mistakes, or
35057 people trying to play silly games.
35058 .next
35059 If the first header line received in a message ends with CRLF, a subsequent
35060 bare LF in a header line is treated in the same way as a bare CR in a header
35061 line.
35062 .endlist
35063
35064
35065
35066
35067
35068 .section "Unqualified addresses" "SECID218"
35069 .cindex "unqualified addresses"
35070 .cindex "address" "qualification"
35071 By default, Exim expects every envelope address it receives from an external
35072 host to be fully qualified. Unqualified addresses cause negative responses to
35073 SMTP commands. However, because SMTP is used as a means of transporting
35074 messages from MUAs running on personal workstations, there is sometimes a
35075 requirement to accept unqualified addresses from specific hosts or IP networks.
35076
35077 Exim has two options that separately control which hosts may send unqualified
35078 sender or recipient addresses in SMTP commands, namely
35079 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35080 cases, if an unqualified address is accepted, it is qualified by adding the
35081 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35082
35083 .oindex "&%qualify_domain%&"
35084 .oindex "&%qualify_recipient%&"
35085 Unqualified addresses in header lines are automatically qualified for messages
35086 that are locally originated, unless the &%-bnq%& option is given on the command
35087 line. For messages received over SMTP, unqualified addresses in header lines
35088 are qualified only if unqualified addresses are permitted in SMTP commands. In
35089 other words, such qualification is also controlled by
35090 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35091
35092
35093
35094
35095 .section "The UUCP From line" "SECID219"
35096 .cindex "&""From""& line"
35097 .cindex "UUCP" "&""From""& line"
35098 .cindex "sender" "address"
35099 .oindex "&%uucp_from_pattern%&"
35100 .oindex "&%uucp_from_sender%&"
35101 .cindex "envelope from"
35102 .cindex "envelope sender"
35103 .cindex "Sendmail compatibility" "&""From""& line"
35104 Messages that have come from UUCP (and some other applications) often begin
35105 with a line containing the envelope sender and a timestamp, following the word
35106 &"From"&. Examples of two common formats are:
35107 .code
35108 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35109 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35110 .endd
35111 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35112 Exim recognizes such lines at the start of messages that are submitted to it
35113 via the command line (that is, on the standard input). It does not recognize
35114 such lines in incoming SMTP messages, unless the sending host matches
35115 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35116 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35117 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35118 default value matches the two common cases shown above and puts the address
35119 that follows &"From"& into &$1$&.
35120
35121 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35122 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35123 a trusted user, the message's sender address is constructed by expanding the
35124 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35125 then parsed as an RFC 2822 address. If there is no domain, the local part is
35126 qualified with &%qualify_domain%& unless it is the empty string. However, if
35127 the command line &%-f%& option is used, it overrides the &"From"& line.
35128
35129 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35130 sender address is not changed. This is also the case for incoming SMTP messages
35131 that are permitted to contain &"From"& lines.
35132
35133 Only one &"From"& line is recognized. If there is more than one, the second is
35134 treated as a data line that starts the body of the message, as it is not valid
35135 as a header line. This also happens if a &"From"& line is present in an
35136 incoming SMTP message from a source that is not permitted to send them.
35137
35138
35139
35140 .section "Resent- header lines" "SECID220"
35141 .cindex "&%Resent-%& header lines"
35142 .cindex "header lines" "Resent-"
35143 RFC 2822 makes provision for sets of header lines starting with the string
35144 &`Resent-`& to be added to a message when it is resent by the original
35145 recipient to somebody else. These headers are &'Resent-Date:'&,
35146 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35147 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35148
35149 .blockquote
35150 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35151 processing of replies or other such automatic actions on messages.'&
35152 .endblockquote
35153
35154 This leaves things a bit vague as far as other processing actions such as
35155 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35156 follows:
35157
35158 .ilist
35159 A &'Resent-From:'& line that just contains the login id of the submitting user
35160 is automatically rewritten in the same way as &'From:'& (see below).
35161 .next
35162 If there's a rewriting rule for a particular header line, it is also applied to
35163 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35164 &'From:'& also rewrites &'Resent-From:'&.
35165 .next
35166 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35167 also removed.
35168 .next
35169 For a locally-submitted message,
35170 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35171 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35172 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35173 included in log lines in this case.
35174 .next
35175 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35176 &%Resent-%& header lines are present.
35177 .endlist
35178
35179
35180
35181
35182 .section "The Auto-Submitted: header line" "SECID221"
35183 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35184 includes the header line:
35185 .code
35186 Auto-Submitted: auto-replied
35187 .endd
35188
35189 .section "The Bcc: header line" "SECID222"
35190 .cindex "&'Bcc:'& header line"
35191 If Exim is called with the &%-t%& option, to take recipient addresses from a
35192 message's header, it removes any &'Bcc:'& header line that may exist (after
35193 extracting its addresses). If &%-t%& is not present on the command line, any
35194 existing &'Bcc:'& is not removed.
35195
35196
35197 .section "The Date: header line" "SECID223"
35198 .cindex "&'Date:'& header line"
35199 .cindex "header lines" "Date:"
35200 If a locally-generated or submission-mode message has no &'Date:'& header line,
35201 Exim adds one, using the current date and time, unless the
35202 &%suppress_local_fixups%& control has been specified.
35203
35204 .section "The Delivery-date: header line" "SECID224"
35205 .cindex "&'Delivery-date:'& header line"
35206 .oindex "&%delivery_date_remove%&"
35207 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35208 set. Exim can be configured to add them to the final delivery of messages. (See
35209 the generic &%delivery_date_add%& transport option.) They should not be present
35210 in messages in transit. If the &%delivery_date_remove%& configuration option is
35211 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35212 messages.
35213
35214
35215 .section "The Envelope-to: header line" "SECID225"
35216 .cindex "&'Envelope-to:'& header line"
35217 .cindex "header lines" "Envelope-to:"
35218 .oindex "&%envelope_to_remove%&"
35219 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35220 Exim can be configured to add them to the final delivery of messages. (See the
35221 generic &%envelope_to_add%& transport option.) They should not be present in
35222 messages in transit. If the &%envelope_to_remove%& configuration option is set
35223 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35224 messages.
35225
35226
35227 .section "The From: header line" "SECTthefrohea"
35228 .cindex "&'From:'& header line"
35229 .cindex "header lines" "From:"
35230 .cindex "Sendmail compatibility" "&""From""& line"
35231 .cindex "message" "submission"
35232 .cindex "submission mode"
35233 If a submission-mode message does not contain a &'From:'& header line, Exim
35234 adds one if either of the following conditions is true:
35235
35236 .ilist
35237 The envelope sender address is not empty (that is, this is not a bounce
35238 message). The added header line copies the envelope sender address.
35239 .next
35240 .vindex "&$authenticated_id$&"
35241 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35242 .olist
35243 .vindex "&$qualify_domain$&"
35244 If no domain is specified by the submission control, the local part is
35245 &$authenticated_id$& and the domain is &$qualify_domain$&.
35246 .next
35247 If a non-empty domain is specified by the submission control, the local
35248 part is &$authenticated_id$&, and the domain is the specified domain.
35249 .next
35250 If an empty domain is specified by the submission control,
35251 &$authenticated_id$& is assumed to be the complete address.
35252 .endlist
35253 .endlist
35254
35255 A non-empty envelope sender takes precedence.
35256
35257 If a locally-generated incoming message does not contain a &'From:'& header
35258 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35259 containing the sender's address. The calling user's login name and full name
35260 are used to construct the address, as described in section &<<SECTconstr>>&.
35261 They are obtained from the password data by calling &[getpwuid()]& (but see the
35262 &%unknown_login%& configuration option). The address is qualified with
35263 &%qualify_domain%&.
35264
35265 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35266 &'From:'& header line containing just the unqualified login name of the calling
35267 user, this is replaced by an address containing the user's login name and full
35268 name as described in section &<<SECTconstr>>&.
35269
35270
35271 .section "The Message-ID: header line" "SECID226"
35272 .cindex "&'Message-ID:'& header line"
35273 .cindex "header lines" "Message-ID:"
35274 .cindex "message" "submission"
35275 .oindex "&%message_id_header_text%&"
35276 If a locally-generated or submission-mode incoming message does not contain a
35277 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35278 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35279 to the message. If there are any &'Resent-:'& headers in the message, it
35280 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35281 message id, preceded by the letter E to ensure it starts with a letter, and
35282 followed by @ and the primary host name. Additional information can be included
35283 in this header line by setting the &%message_id_header_text%& and/or
35284 &%message_id_header_domain%& options.
35285
35286
35287 .section "The Received: header line" "SECID227"
35288 .cindex "&'Received:'& header line"
35289 .cindex "header lines" "Received:"
35290 A &'Received:'& header line is added at the start of every message. The
35291 contents are defined by the &%received_header_text%& configuration option, and
35292 Exim automatically adds a semicolon and a timestamp to the configured string.
35293
35294 The &'Received:'& header is generated as soon as the message's header lines
35295 have been received. At this stage, the timestamp in the &'Received:'& header
35296 line is the time that the message started to be received. This is the value
35297 that is seen by the DATA ACL and by the &[local_scan()]& function.
35298
35299 Once a message is accepted, the timestamp in the &'Received:'& header line is
35300 changed to the time of acceptance, which is (apart from a small delay while the
35301 -H spool file is written) the earliest time at which delivery could start.
35302
35303
35304 .section "The References: header line" "SECID228"
35305 .cindex "&'References:'& header line"
35306 .cindex "header lines" "References:"
35307 Messages created by the &(autoreply)& transport include a &'References:'&
35308 header line. This is constructed according to the rules that are described in
35309 section 3.64 of RFC 2822 (which states that replies should contain such a
35310 header line), and section 3.14 of RFC 3834 (which states that automatic
35311 responses are not different in this respect). However, because some mail
35312 processing software does not cope well with very long header lines, no more
35313 than 12 message IDs are copied from the &'References:'& header line in the
35314 incoming message. If there are more than 12, the first one and then the final
35315 11 are copied, before adding the message ID of the incoming message.
35316
35317
35318
35319 .section "The Return-path: header line" "SECID229"
35320 .cindex "&'Return-path:'& header line"
35321 .cindex "header lines" "Return-path:"
35322 .oindex "&%return_path_remove%&"
35323 &'Return-path:'& header lines are defined as something an MTA may insert when
35324 it does the final delivery of messages. (See the generic &%return_path_add%&
35325 transport option.) Therefore, they should not be present in messages in
35326 transit. If the &%return_path_remove%& configuration option is set (the
35327 default), Exim removes &'Return-path:'& header lines from incoming messages.
35328
35329
35330
35331 .section "The Sender: header line" "SECTthesenhea"
35332 .cindex "&'Sender:'& header line"
35333 .cindex "message" "submission"
35334 .cindex "header lines" "Sender:"
35335 For a locally-originated message from an untrusted user, Exim may remove an
35336 existing &'Sender:'& header line, and it may add a new one. You can modify
35337 these actions by setting the &%local_sender_retain%& option true, the
35338 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35339 control setting.
35340
35341 When a local message is received from an untrusted user and
35342 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35343 control has not been set, a check is made to see if the address given in the
35344 &'From:'& header line is the correct (local) sender of the message. The address
35345 that is expected has the login name as the local part and the value of
35346 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35347 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35348 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35349 line is added to the message.
35350
35351 If you set &%local_from_check%& false, this checking does not occur. However,
35352 the removal of an existing &'Sender:'& line still happens, unless you also set
35353 &%local_sender_retain%& to be true. It is not possible to set both of these
35354 options true at the same time.
35355
35356 .cindex "submission mode"
35357 By default, no processing of &'Sender:'& header lines is done for messages
35358 received over TCP/IP or for messages submitted by trusted users. However, when
35359 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35360 not specified on the submission control, the following processing takes place:
35361
35362 .vindex "&$authenticated_id$&"
35363 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35364 authenticated, and &$authenticated_id$& is not empty, a sender address is
35365 created as follows:
35366
35367 .ilist
35368 .vindex "&$qualify_domain$&"
35369 If no domain is specified by the submission control, the local part is
35370 &$authenticated_id$& and the domain is &$qualify_domain$&.
35371 .next
35372 If a non-empty domain is specified by the submission control, the local part
35373 is &$authenticated_id$&, and the domain is the specified domain.
35374 .next
35375 If an empty domain is specified by the submission control,
35376 &$authenticated_id$& is assumed to be the complete address.
35377 .endlist
35378
35379 This address is compared with the address in the &'From:'& header line. If they
35380 are different, a &'Sender:'& header line containing the created address is
35381 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35382 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35383
35384 .cindex "return path" "created from &'Sender:'&"
35385 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35386 the message (the envelope sender address) is changed to be the same address,
35387 except in the case of submission mode when &%sender_retain%& is specified.
35388
35389
35390
35391 .section "Adding and removing header lines in routers and transports" &&&
35392          "SECTheadersaddrem"
35393 .cindex "header lines" "adding; in router or transport"
35394 .cindex "header lines" "removing; in router or transport"
35395 When a message is delivered, the addition and removal of header lines can be
35396 specified in a system filter, or on any of the routers and transports that
35397 process the message. Section &<<SECTaddremheasys>>& contains details about
35398 modifying headers in a system filter. Header lines can also be added in an ACL
35399 as a message is received (see section &<<SECTaddheadacl>>&).
35400
35401 In contrast to what happens in a system filter, header modifications that are
35402 specified on routers and transports apply only to the particular recipient
35403 addresses that are being processed by those routers and transports. These
35404 changes do not actually take place until a copy of the message is being
35405 transported. Therefore, they do not affect the basic set of header lines, and
35406 they do not affect the values of the variables that refer to header lines.
35407
35408 &*Note*&: In particular, this means that any expansions in the configuration of
35409 the transport cannot refer to the modified header lines, because such
35410 expansions all occur before the message is actually transported.
35411
35412 For both routers and transports, the argument of a &%headers_add%&
35413 option must be in the form of one or more RFC 2822 header lines, separated by
35414 newlines (coded as &"\n"&). For example:
35415 .code
35416 headers_add = X-added-header: added by $primary_hostname\n\
35417               X-added-second: another added header line
35418 .endd
35419 Exim does not check the syntax of these added header lines.
35420
35421 Multiple &%headers_add%& options for a single router or transport can be
35422 specified; the values will append to a single list of header lines.
35423 Each header-line is separately expanded.
35424
35425 The argument of a &%headers_remove%& option must consist of a colon-separated
35426 list of header names. This is confusing, because header names themselves are
35427 often terminated by colons. In this case, the colons are the list separators,
35428 not part of the names. For example:
35429 .code
35430 headers_remove = return-receipt-to:acknowledge-to
35431 .endd
35432
35433 Multiple &%headers_remove%& options for a single router or transport can be
35434 specified; the arguments will append to a single header-names list.
35435 Each item is separately expanded.
35436 Note that colons in complex expansions which are used to
35437 form all or part of a &%headers_remove%& list
35438 will act as list separators.
35439
35440 When &%headers_add%& or &%headers_remove%& is specified on a router,
35441 items are expanded at routing time,
35442 and then associated with all addresses that are
35443 accepted by that router, and also with any new addresses that it generates. If
35444 an address passes through several routers as a result of aliasing or
35445 forwarding, the changes are cumulative.
35446
35447 .oindex "&%unseen%&"
35448 However, this does not apply to multiple routers that result from the use of
35449 the &%unseen%& option. Any header modifications that were specified by the
35450 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
35451
35452 Addresses that end up with different &%headers_add%& or &%headers_remove%&
35453 settings cannot be delivered together in a batch, so a transport is always
35454 dealing with a set of addresses that have the same header-processing
35455 requirements.
35456
35457 The transport starts by writing the original set of header lines that arrived
35458 with the message, possibly modified by the system filter. As it writes out
35459 these lines, it consults the list of header names that were attached to the
35460 recipient address(es) by &%headers_remove%& options in routers, and it also
35461 consults the transport's own &%headers_remove%& option. Header lines whose
35462 names are on either of these lists are not written out. If there are multiple
35463 instances of any listed header, they are all skipped.
35464
35465 After the remaining original header lines have been written, new header
35466 lines that were specified by routers' &%headers_add%& options are written, in
35467 the order in which they were attached to the address. These are followed by any
35468 header lines specified by the transport's &%headers_add%& option.
35469
35470 This way of handling header line modifications in routers and transports has
35471 the following consequences:
35472
35473 .ilist
35474 The original set of header lines, possibly modified by the system filter,
35475 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
35476 to it, at all times.
35477 .next
35478 Header lines that are added by a router's
35479 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
35480 expansion syntax in subsequent routers or the transport.
35481 .next
35482 Conversely, header lines that are specified for removal by &%headers_remove%&
35483 in a router remain visible to subsequent routers and the transport.
35484 .next
35485 Headers added to an address by &%headers_add%& in a router cannot be removed by
35486 a later router or by a transport.
35487 .next
35488 An added header can refer to the contents of an original header that is to be
35489 removed, even it has the same name as the added header. For example:
35490 .code
35491 headers_remove = subject
35492 headers_add = Subject: new subject (was: $h_subject:)
35493 .endd
35494 .endlist
35495
35496 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
35497 for a &(redirect)& router that has the &%one_time%& option set.
35498
35499
35500
35501
35502
35503 .section "Constructed addresses" "SECTconstr"
35504 .cindex "address" "constructed"
35505 .cindex "constructed address"
35506 When Exim constructs a sender address for a locally-generated message, it uses
35507 the form
35508 .display
35509 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
35510 .endd
35511 For example:
35512 .code
35513 Zaphod Beeblebrox <zaphod@end.univ.example>
35514 .endd
35515 The user name is obtained from the &%-F%& command line option if set, or
35516 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
35517 &"gecos"& field from the password entry. If the &"gecos"& field contains an
35518 ampersand character, this is replaced by the login name with the first letter
35519 upper cased, as is conventional in a number of operating systems. See the
35520 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
35521 The &%unknown_username%& option can be used to specify user names in cases when
35522 there is no password file entry.
35523
35524 .cindex "RFC 2047"
35525 In all cases, the user name is made to conform to RFC 2822 by quoting all or
35526 parts of it if necessary. In addition, if it contains any non-printing
35527 characters, it is encoded as described in RFC 2047, which defines a way of
35528 including non-ASCII characters in header lines. The value of the
35529 &%headers_charset%& option specifies the name of the encoding that is used (the
35530 characters are assumed to be in this encoding). The setting of
35531 &%print_topbitchars%& controls whether characters with the top bit set (that
35532 is, with codes greater than 127) count as printing characters or not.
35533
35534
35535
35536 .section "Case of local parts" "SECID230"
35537 .cindex "case of local parts"
35538 .cindex "local part" "case of"
35539 RFC 2822 states that the case of letters in the local parts of addresses cannot
35540 be assumed to be non-significant. Exim preserves the case of local parts of
35541 addresses, but by default it uses a lower-cased form when it is routing,
35542 because on most Unix systems, usernames are in lower case and case-insensitive
35543 routing is required. However, any particular router can be made to use the
35544 original case for local parts by setting the &%caseful_local_part%& generic
35545 router option.
35546
35547 .cindex "mixed-case login names"
35548 If you must have mixed-case user names on your system, the best way to proceed,
35549 assuming you want case-independent handling of incoming email, is to set up
35550 your first router to convert incoming local parts in your domains to the
35551 correct case by means of a file lookup. For example:
35552 .code
35553 correct_case:
35554   driver = redirect
35555   domains = +local_domains
35556   data = ${lookup{$local_part}cdb\
35557               {/etc/usercased.cdb}{$value}fail}\
35558               @$domain
35559 .endd
35560 For this router, the local part is forced to lower case by the default action
35561 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35562 up a new local part in the correct case. If you then set &%caseful_local_part%&
35563 on any subsequent routers which process your domains, they will operate on
35564 local parts with the correct case in a case-sensitive manner.
35565
35566
35567
35568 .section "Dots in local parts" "SECID231"
35569 .cindex "dot" "in local part"
35570 .cindex "local part" "dots in"
35571 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35572 part may not begin or end with a dot, nor have two consecutive dots in the
35573 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35574 empty components for compatibility.
35575
35576
35577
35578 .section "Rewriting addresses" "SECID232"
35579 .cindex "rewriting" "addresses"
35580 Rewriting of sender and recipient addresses, and addresses in headers, can
35581 happen automatically, or as the result of configuration options, as described
35582 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35583 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35584
35585 Automatic rewriting includes qualification, as mentioned above. The other case
35586 in which it can happen is when an incomplete non-local domain is given. The
35587 routing process may cause this to be expanded into the full domain name. For
35588 example, a header such as
35589 .code
35590 To: hare@teaparty
35591 .endd
35592 might get rewritten as
35593 .code
35594 To: hare@teaparty.wonderland.fict.example
35595 .endd
35596 Rewriting as a result of routing is the one kind of message processing that
35597 does not happen at input time, as it cannot be done until the address has
35598 been routed.
35599
35600 Strictly, one should not do &'any'& deliveries of a message until all its
35601 addresses have been routed, in case any of the headers get changed as a
35602 result of routing. However, doing this in practice would hold up many
35603 deliveries for unreasonable amounts of time, just because one address could not
35604 immediately be routed. Exim therefore does not delay other deliveries when
35605 routing of one or more addresses is deferred.
35606 .ecindex IIDmesproc
35607
35608
35609
35610 . ////////////////////////////////////////////////////////////////////////////
35611 . ////////////////////////////////////////////////////////////////////////////
35612
35613 .chapter "SMTP processing" "CHAPSMTP"
35614 .scindex IIDsmtpproc1 "SMTP" "processing details"
35615 .scindex IIDsmtpproc2 "LMTP" "processing details"
35616 Exim supports a number of different ways of using the SMTP protocol, and its
35617 LMTP variant, which is an interactive protocol for transferring messages into a
35618 closed mail store application. This chapter contains details of how SMTP is
35619 processed. For incoming mail, the following are available:
35620
35621 .ilist
35622 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35623 .next
35624 SMTP over the standard input and output (the &%-bs%& option);
35625 .next
35626 Batched SMTP on the standard input (the &%-bS%& option).
35627 .endlist
35628
35629 For mail delivery, the following are available:
35630
35631 .ilist
35632 SMTP over TCP/IP (the &(smtp)& transport);
35633 .next
35634 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35635 &"lmtp"&);
35636 .next
35637 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35638 transport);
35639 .next
35640 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35641 the &%use_bsmtp%& option set).
35642 .endlist
35643
35644 &'Batched SMTP'& is the name for a process in which batches of messages are
35645 stored in or read from files (or pipes), in a format in which SMTP commands are
35646 used to contain the envelope information.
35647
35648
35649
35650 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35651 .cindex "SMTP" "outgoing over TCP/IP"
35652 .cindex "outgoing SMTP over TCP/IP"
35653 .cindex "LMTP" "over TCP/IP"
35654 .cindex "outgoing LMTP over TCP/IP"
35655 .cindex "EHLO"
35656 .cindex "HELO"
35657 .cindex "SIZE option on MAIL command"
35658 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35659 The &%protocol%& option selects which protocol is to be used, but the actual
35660 processing is the same in both cases.
35661
35662 If, in response to its EHLO command, Exim is told that the SIZE
35663 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35664 command. The value of <&'n'&> is the message size plus the value of the
35665 &%size_addition%& option (default 1024) to allow for additions to the message
35666 such as per-transport header lines, or changes made in a
35667 .cindex "transport" "filter"
35668 .cindex "filter" "transport filter"
35669 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35670 suppressed.
35671
35672 If the remote server advertises support for PIPELINING, Exim uses the
35673 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35674 required for the transaction.
35675
35676 If the remote server advertises support for the STARTTLS command, and Exim
35677 was built to support TLS encryption, it tries to start a TLS session unless the
35678 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35679 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35680 is called for verification.
35681
35682 If the remote server advertises support for the AUTH command, Exim scans
35683 the authenticators configuration for any suitable client settings, as described
35684 in chapter &<<CHAPSMTPAUTH>>&.
35685
35686 .cindex "carriage return"
35687 .cindex "linefeed"
35688 Responses from the remote host are supposed to be terminated by CR followed by
35689 LF. However, there are known to be hosts that do not send CR characters, so in
35690 order to be able to interwork with such hosts, Exim treats LF on its own as a
35691 line terminator.
35692
35693 If a message contains a number of different addresses, all those with the same
35694 characteristics (for example, the same envelope sender) that resolve to the
35695 same set of hosts, in the same order, are sent in a single SMTP transaction,
35696 even if they are for different domains, unless there are more than the setting
35697 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35698 they are split into groups containing no more than &%max_rcpt%&s addresses
35699 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35700 in parallel sessions. The order of hosts with identical MX values is not
35701 significant when checking whether addresses can be batched in this way.
35702
35703 When the &(smtp)& transport suffers a temporary failure that is not
35704 message-related, Exim updates its transport-specific database, which contains
35705 records indexed by host name that remember which messages are waiting for each
35706 particular host. It also updates the retry database with new retry times.
35707
35708 .cindex "hints database" "retry keys"
35709 Exim's retry hints are based on host name plus IP address, so if one address of
35710 a multi-homed host is broken, it will soon be skipped most of the time.
35711 See the next section for more detail about error handling.
35712
35713 .cindex "SMTP" "passed connection"
35714 .cindex "SMTP" "batching over TCP/IP"
35715 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35716 looks in the hints database for the transport to see if there are any queued
35717 messages waiting for the host to which it is connected. If it finds one, it
35718 creates a new Exim process using the &%-MC%& option (which can only be used by
35719 a process running as root or the Exim user) and passes the TCP/IP socket to it
35720 so that it can deliver another message using the same socket. The new process
35721 does only those deliveries that are routed to the connected host, and may in
35722 turn pass the socket on to a third process, and so on.
35723
35724 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35725 limit the number of messages sent down a single TCP/IP connection.
35726
35727 .cindex "asterisk" "after IP address"
35728 The second and subsequent messages delivered down an existing connection are
35729 identified in the main log by the addition of an asterisk after the closing
35730 square bracket of the IP address.
35731
35732
35733
35734
35735 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35736 .cindex "error" "in outgoing SMTP"
35737 .cindex "SMTP" "errors in outgoing"
35738 .cindex "host" "error"
35739 Three different kinds of error are recognized for outgoing SMTP: host errors,
35740 message errors, and recipient errors.
35741
35742 .vlist
35743 .vitem "&*Host errors*&"
35744 A host error is not associated with a particular message or with a
35745 particular recipient of a message. The host errors are:
35746
35747 .ilist
35748 Connection refused or timed out,
35749 .next
35750 Any error response code on connection,
35751 .next
35752 Any error response code to EHLO or HELO,
35753 .next
35754 Loss of connection at any time, except after &"."&,
35755 .next
35756 I/O errors at any time,
35757 .next
35758 Timeouts during the session, other than in response to MAIL, RCPT or
35759 the &"."& at the end of the data.
35760 .endlist ilist
35761
35762 For a host error, a permanent error response on connection, or in response to
35763 EHLO, causes all addresses routed to the host to be failed. Any other host
35764 error causes all addresses to be deferred, and retry data to be created for the
35765 host. It is not tried again, for any message, until its retry time arrives. If
35766 the current set of addresses are not all delivered in this run (to some
35767 alternative host), the message is added to the list of those waiting for this
35768 host, so if it is still undelivered when a subsequent successful delivery is
35769 made to the host, it will be sent down the same SMTP connection.
35770
35771 .vitem "&*Message errors*&"
35772 .cindex "message" "error"
35773 A message error is associated with a particular message when sent to a
35774 particular host, but not with a particular recipient of the message. The
35775 message errors are:
35776
35777 .ilist
35778 Any error response code to MAIL, DATA, or the &"."& that terminates
35779 the data,
35780 .next
35781 Timeout after MAIL,
35782 .next
35783 Timeout or loss of connection after the &"."& that terminates the data. A
35784 timeout after the DATA command itself is treated as a host error, as is loss of
35785 connection at any other time.
35786 .endlist ilist
35787
35788 For a message error, a permanent error response (5&'xx'&) causes all addresses
35789 to be failed, and a delivery error report to be returned to the sender. A
35790 temporary error response (4&'xx'&), or one of the timeouts, causes all
35791 addresses to be deferred. Retry data is not created for the host, but instead,
35792 a retry record for the combination of host plus message id is created. The
35793 message is not added to the list of those waiting for this host. This ensures
35794 that the failing message will not be sent to this host again until the retry
35795 time arrives. However, other messages that are routed to the host are not
35796 affected, so if it is some property of the message that is causing the error,
35797 it will not stop the delivery of other mail.
35798
35799 If the remote host specified support for the SIZE parameter in its response
35800 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35801 over-large message will cause a message error because the error arrives as a
35802 response to MAIL.
35803
35804 .vitem "&*Recipient errors*&"
35805 .cindex "recipient" "error"
35806 A recipient error is associated with a particular recipient of a message. The
35807 recipient errors are:
35808
35809 .ilist
35810 Any error response to RCPT,
35811 .next
35812 Timeout after RCPT.
35813 .endlist
35814
35815 For a recipient error, a permanent error response (5&'xx'&) causes the
35816 recipient address to be failed, and a bounce message to be returned to the
35817 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35818 address to be deferred, and routing retry data to be created for it. This is
35819 used to delay processing of the address in subsequent queue runs, until its
35820 routing retry time arrives. This applies to all messages, but because it
35821 operates only in queue runs, one attempt will be made to deliver a new message
35822 to the failing address before the delay starts to operate. This ensures that,
35823 if the failure is really related to the message rather than the recipient
35824 (&"message too big for this recipient"& is a possible example), other messages
35825 have a chance of getting delivered. If a delivery to the address does succeed,
35826 the retry information gets cleared, so all stuck messages get tried again, and
35827 the retry clock is reset.
35828
35829 The message is not added to the list of those waiting for this host. Use of the
35830 host for other messages is unaffected, and except in the case of a timeout,
35831 other recipients are processed independently, and may be successfully delivered
35832 in the current SMTP session. After a timeout it is of course impossible to
35833 proceed with the session, so all addresses get deferred. However, those other
35834 than the one that failed do not suffer any subsequent retry delays. Therefore,
35835 if one recipient is causing trouble, the others have a chance of getting
35836 through when a subsequent delivery attempt occurs before the failing
35837 recipient's retry time.
35838 .endlist
35839
35840 In all cases, if there are other hosts (or IP addresses) available for the
35841 current set of addresses (for example, from multiple MX records), they are
35842 tried in this run for any undelivered addresses, subject of course to their
35843 own retry data. In other words, recipient error retry data does not take effect
35844 until the next delivery attempt.
35845
35846 Some hosts have been observed to give temporary error responses to every
35847 MAIL command at certain times (&"insufficient space"& has been seen). It
35848 would be nice if such circumstances could be recognized, and defer data for the
35849 host itself created, but this is not possible within the current Exim design.
35850 What actually happens is that retry data for every (host, message) combination
35851 is created.
35852
35853 The reason that timeouts after MAIL and RCPT are treated specially is that
35854 these can sometimes arise as a result of the remote host's verification
35855 procedures. Exim makes this assumption, and treats them as if a temporary error
35856 response had been received. A timeout after &"."& is treated specially because
35857 it is known that some broken implementations fail to recognize the end of the
35858 message if the last character of the last line is a binary zero. Thus, it is
35859 helpful to treat this case as a message error.
35860
35861 Timeouts at other times are treated as host errors, assuming a problem with the
35862 host, or the connection to it. If a timeout after MAIL, RCPT,
35863 or &"."& is really a connection problem, the assumption is that at the next try
35864 the timeout is likely to occur at some other point in the dialogue, causing it
35865 then to be treated as a host error.
35866
35867 There is experimental evidence that some MTAs drop the connection after the
35868 terminating &"."& if they do not like the contents of the message for some
35869 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35870 should be given. That is why Exim treats this case as a message rather than a
35871 host error, in order not to delay other messages to the same host.
35872
35873
35874
35875
35876 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35877 .cindex "SMTP" "incoming over TCP/IP"
35878 .cindex "incoming SMTP over TCP/IP"
35879 .cindex "inetd"
35880 .cindex "daemon"
35881 Incoming SMTP messages can be accepted in one of two ways: by running a
35882 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35883 &_/etc/inetd.conf_& should be like this:
35884 .code
35885 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35886 .endd
35887 Exim distinguishes between this case and the case of a locally running user
35888 agent using the &%-bs%& option by checking whether or not the standard input is
35889 a socket. When it is, either the port must be privileged (less than 1024), or
35890 the caller must be root or the Exim user. If any other user passes a socket
35891 with an unprivileged port number, Exim prints a message on the standard error
35892 stream and exits with an error code.
35893
35894 By default, Exim does not make a log entry when a remote host connects or
35895 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35896 unexpected. It can be made to write such log entries by setting the
35897 &%smtp_connection%& log selector.
35898
35899 .cindex "carriage return"
35900 .cindex "linefeed"
35901 Commands from the remote host are supposed to be terminated by CR followed by
35902 LF. However, there are known to be hosts that do not send CR characters. In
35903 order to be able to interwork with such hosts, Exim treats LF on its own as a
35904 line terminator.
35905 Furthermore, because common code is used for receiving messages from all
35906 sources, a CR on its own is also interpreted as a line terminator. However, the
35907 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35908
35909 .cindex "EHLO" "invalid data"
35910 .cindex "HELO" "invalid data"
35911 One area that sometimes gives rise to problems concerns the EHLO or
35912 HELO commands. Some clients send syntactically invalid versions of these
35913 commands, which Exim rejects by default. (This is nothing to do with verifying
35914 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35915 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35916 match the broken hosts that send invalid commands.
35917
35918 .cindex "SIZE option on MAIL command"
35919 .cindex "MAIL" "SIZE option"
35920 The amount of disk space available is checked whenever SIZE is received on
35921 a MAIL command, independently of whether &%message_size_limit%& or
35922 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35923 false. A temporary error is given if there is not enough space. If
35924 &%check_spool_space%& is set, the check is for that amount of space plus the
35925 value given with SIZE, that is, it checks that the addition of the incoming
35926 message will not reduce the space below the threshold.
35927
35928 When a message is successfully received, Exim includes the local message id in
35929 its response to the final &"."& that terminates the data. If the remote host
35930 logs this text it can help with tracing what has happened to a message.
35931
35932 The Exim daemon can limit the number of simultaneous incoming connections it is
35933 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35934 number of simultaneous incoming connections from a single remote host (see the
35935 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35936 rejected using the SMTP temporary error code 421.
35937
35938 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35939 subprocess has finished, as this can get lost at busy times. Instead, it looks
35940 for completed subprocesses every time it wakes up. Provided there are other
35941 things happening (new incoming calls, starts of queue runs), completed
35942 processes will be noticed and tidied away. On very quiet systems you may
35943 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35944 it will be noticed when the daemon next wakes up.
35945
35946 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35947 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35948 high system load &-- for details see the &%smtp_accept_reserve%&,
35949 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35950 applies in both the daemon and &'inetd'& cases.
35951
35952 Exim normally starts a delivery process for each message received, though this
35953 can be varied by means of the &%-odq%& command line option and the
35954 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35955 number of simultaneously running delivery processes started in this way from
35956 SMTP input can be limited by the &%smtp_accept_queue%& and
35957 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35958 subsequently received messages are just put on the input queue without starting
35959 a delivery process.
35960
35961 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35962 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35963 started up from the &'inetd'& daemon, because in that case each connection is
35964 handled by an entirely independent Exim process. Control by load average is,
35965 however, available with &'inetd'&.
35966
35967 Exim can be configured to verify addresses in incoming SMTP commands as they
35968 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35969 to rewrite addresses at this time &-- before any syntax checking is done. See
35970 section &<<SECTrewriteS>>&.
35971
35972 Exim can also be configured to limit the rate at which a client host submits
35973 MAIL and RCPT commands in a single SMTP session. See the
35974 &%smtp_ratelimit_hosts%& option.
35975
35976
35977
35978 .section "Unrecognized SMTP commands" "SECID234"
35979 .cindex "SMTP" "unrecognized commands"
35980 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35981 commands during a single SMTP connection, it drops the connection after sending
35982 the error response to the last command. The default value for
35983 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35984 abuse that subvert web servers into making connections to SMTP ports; in these
35985 circumstances, a number of non-SMTP lines are sent first.
35986
35987
35988 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35989 .cindex "SMTP" "syntax errors"
35990 .cindex "SMTP" "protocol errors"
35991 A syntax error is detected if an SMTP command is recognized, but there is
35992 something syntactically wrong with its data, for example, a malformed email
35993 address in a RCPT command. Protocol errors include invalid command
35994 sequencing such as RCPT before MAIL. If Exim receives more than
35995 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35996 drops the connection after sending the error response to the last command. The
35997 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35998 broken clients that loop sending bad commands (yes, it has been seen).
35999
36000
36001
36002 .section "Use of non-mail SMTP commands" "SECID236"
36003 .cindex "SMTP" "non-mail commands"
36004 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36005 DATA. Exim counts such commands, and drops the connection if there are too
36006 many of them in a single SMTP session. This action catches some
36007 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36008 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36009 defines what &"too many"& means. Its default value is 10.
36010
36011 When a new message is expected, one occurrence of RSET is not counted. This
36012 allows a client to send one RSET between messages (this is not necessary,
36013 but some clients do it). Exim also allows one uncounted occurrence of HELO
36014 or EHLO, and one occurrence of STARTTLS between messages. After
36015 starting up a TLS session, another EHLO is expected, and so it too is not
36016 counted.
36017
36018 The first occurrence of AUTH in a connection, or immediately following
36019 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36020 RCPT, DATA, and QUIT are counted.
36021
36022 You can control which hosts are subject to the limit set by
36023 &%smtp_accept_max_nonmail%& by setting
36024 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36025 the limit apply to all hosts. This option means that you can exclude any
36026 specific badly-behaved hosts that you have to live with.
36027
36028
36029
36030
36031 .section "The VRFY and EXPN commands" "SECID237"
36032 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36033 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36034 appropriate) in order to decide whether the command should be accepted or not.
36035
36036 .cindex "VRFY" "processing"
36037 When no ACL is defined for VRFY, or if it rejects without
36038 setting an explicit response code, the command is accepted
36039 (with a 252 SMTP response code)
36040 in order to support awkward clients that do a VRFY before every RCPT.
36041 When VRFY is accepted, it runs exactly the same code as when Exim is
36042 called with the &%-bv%& option, and returns 250/451/550
36043 SMTP response codes.
36044
36045 .cindex "EXPN" "processing"
36046 If no ACL for EXPN is defined, the command is rejected.
36047 When EXPN is accepted, a single-level expansion of the address is done.
36048 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36049 than a verification (the &%-bv%& option). If an unqualified local part is given
36050 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36051 of VRFY and EXPN commands are logged on the main and reject logs, and
36052 VRFY verification failures are logged on the main log for consistency with
36053 RCPT failures.
36054
36055
36056
36057 .section "The ETRN command" "SECTETRN"
36058 .cindex "ETRN" "processing"
36059 RFC 1985 describes an SMTP command called ETRN that is designed to
36060 overcome the security problems of the TURN command (which has fallen into
36061 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36062 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36063 should be accepted or not. If no ACL is defined, the command is rejected.
36064
36065 The ETRN command is concerned with &"releasing"& messages that are awaiting
36066 delivery to certain hosts. As Exim does not organize its message queue by host,
36067 the only form of ETRN that is supported by default is the one where the
36068 text starts with the &"#"& prefix, in which case the remainder of the text is
36069 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36070 the &%-R%& option to happen, with the remainder of the ETRN text as its
36071 argument. For example,
36072 .code
36073 ETRN #brigadoon
36074 .endd
36075 runs the command
36076 .code
36077 exim -R brigadoon
36078 .endd
36079 which causes a delivery attempt on all messages with undelivered addresses
36080 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36081 default), Exim prevents the simultaneous execution of more than one queue run
36082 for the same argument string as a result of an ETRN command. This stops
36083 a misbehaving client from starting more than one queue runner at once.
36084
36085 .cindex "hints database" "ETRN serialization"
36086 Exim implements the serialization by means of a hints database in which a
36087 record is written whenever a process is started by ETRN, and deleted when
36088 the process completes. However, Exim does not keep the SMTP session waiting for
36089 the ETRN process to complete. Once ETRN is accepted, the client is sent
36090 a &"success"& return code. Obviously there is scope for hints records to get
36091 left lying around if there is a system or program crash. To guard against this,
36092 Exim ignores any records that are more than six hours old.
36093
36094 .oindex "&%smtp_etrn_command%&"
36095 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36096 used. This specifies a command that is run whenever ETRN is received,
36097 whatever the form of its argument. For
36098 example:
36099 .code
36100 smtp_etrn_command = /etc/etrn_command $domain \
36101                     $sender_host_address
36102 .endd
36103 .vindex "&$domain$&"
36104 The string is split up into arguments which are independently expanded. The
36105 expansion variable &$domain$& is set to the argument of the ETRN command,
36106 and no syntax checking is done on the contents of this argument. Exim does not
36107 wait for the command to complete, so its status code is not checked. Exim runs
36108 under its own uid and gid when receiving incoming SMTP, so it is not possible
36109 for it to change them before running the command.
36110
36111
36112
36113 .section "Incoming local SMTP" "SECID238"
36114 .cindex "SMTP" "local incoming"
36115 Some user agents use SMTP to pass messages to their local MTA using the
36116 standard input and output, as opposed to passing the envelope on the command
36117 line and writing the message to the standard input. This is supported by the
36118 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36119 messages over TCP/IP (including the use of ACLs), except that the envelope
36120 sender given in a MAIL command is ignored unless the caller is trusted. In
36121 an ACL you can detect this form of SMTP input by testing for an empty host
36122 identification. It is common to have this as the first line in the ACL that
36123 runs for RCPT commands:
36124 .code
36125 accept hosts = :
36126 .endd
36127 This accepts SMTP messages from local processes without doing any other tests.
36128
36129
36130
36131 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36132 .cindex "SMTP" "batched outgoing"
36133 .cindex "batched SMTP output"
36134 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36135 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36136 be output in BSMTP format. No SMTP responses are possible for this form of
36137 delivery. All it is doing is using SMTP commands as a way of transmitting the
36138 envelope along with the message.
36139
36140 The message is written to the file or pipe preceded by the SMTP commands
36141 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36142 the message that start with a dot have an extra dot added. The SMTP command
36143 HELO is not normally used. If it is required, the &%message_prefix%& option
36144 can be used to specify it.
36145
36146 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36147 one recipient address at a time by default. However, you can arrange for them
36148 to handle several addresses at once by setting the &%batch_max%& option. When
36149 this is done for BSMTP, messages may contain multiple RCPT commands. See
36150 chapter &<<CHAPbatching>>& for more details.
36151
36152 .vindex "&$host$&"
36153 When one or more addresses are routed to a BSMTP transport by a router that
36154 sets up a host list, the name of the first host on the list is available to the
36155 transport in the variable &$host$&. Here is an example of such a transport and
36156 router:
36157 .code
36158 begin routers
36159 route_append:
36160   driver = manualroute
36161   transport = smtp_appendfile
36162   route_list = domain.example  batch.host.example
36163
36164 begin transports
36165 smtp_appendfile:
36166   driver = appendfile
36167   directory = /var/bsmtp/$host
36168   batch_max = 1000
36169   use_bsmtp
36170   user = exim
36171 .endd
36172 This causes messages addressed to &'domain.example'& to be written in BSMTP
36173 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36174 message (unless there are more than 1000 recipients).
36175
36176
36177
36178 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36179 .cindex "SMTP" "batched incoming"
36180 .cindex "batched SMTP input"
36181 The &%-bS%& command line option causes Exim to accept one or more messages by
36182 reading SMTP on the standard input, but to generate no responses. If the caller
36183 is trusted, the senders in the MAIL commands are believed; otherwise the
36184 sender is always the caller of Exim. Unqualified senders and receivers are not
36185 rejected (there seems little point) but instead just get qualified. HELO
36186 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36187 as NOOP; QUIT quits.
36188
36189 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36190 ACL is run in the same way as for non-SMTP local input.
36191
36192 If an error is detected while reading a message, including a missing &"."& at
36193 the end, Exim gives up immediately. It writes details of the error to the
36194 standard output in a stylized way that the calling program should be able to
36195 make some use of automatically, for example:
36196 .code
36197 554 Unexpected end of file
36198 Transaction started in line 10
36199 Error detected in line 14
36200 .endd
36201 It writes a more verbose version, for human consumption, to the standard error
36202 file, for example:
36203 .code
36204 An error was detected while processing a file of BSMTP input.
36205 The error message was:
36206
36207 501 '>' missing at end of address
36208
36209 The SMTP transaction started in line 10.
36210 The error was detected in line 12.
36211 The SMTP command at fault was:
36212
36213 rcpt to:<malformed@in.com.plete
36214
36215 1 previous message was successfully processed.
36216 The rest of the batch was abandoned.
36217 .endd
36218 The return code from Exim is zero only if there were no errors. It is 1 if some
36219 messages were accepted before an error was detected, and 2 if no messages were
36220 accepted.
36221 .ecindex IIDsmtpproc1
36222 .ecindex IIDsmtpproc2
36223
36224
36225
36226 . ////////////////////////////////////////////////////////////////////////////
36227 . ////////////////////////////////////////////////////////////////////////////
36228
36229 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36230          "Customizing messages"
36231 When a message fails to be delivered, or remains in the queue for more than a
36232 configured amount of time, Exim sends a message to the original sender, or
36233 to an alternative configured address. The text of these messages is built into
36234 the code of Exim, but it is possible to change it, either by adding a single
36235 string, or by replacing each of the paragraphs by text supplied in a file.
36236
36237 The &'From:'& and &'To:'& header lines are automatically generated; you can
36238 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36239 option. Exim also adds the line
36240 .code
36241 Auto-Submitted: auto-generated
36242 .endd
36243 to all warning and bounce messages,
36244
36245
36246 .section "Customizing bounce messages" "SECID239"
36247 .cindex "customizing" "bounce message"
36248 .cindex "bounce message" "customizing"
36249 If &%bounce_message_text%& is set, its contents are included in the default
36250 message immediately after &"This message was created automatically by mail
36251 delivery software."& The string is not expanded. It is not used if
36252 &%bounce_message_file%& is set.
36253
36254 When &%bounce_message_file%& is set, it must point to a template file for
36255 constructing error messages. The file consists of a series of text items,
36256 separated by lines consisting of exactly four asterisks. If the file cannot be
36257 opened, default text is used and a message is written to the main and panic
36258 logs. If any text item in the file is empty, default text is used for that
36259 item.
36260
36261 .vindex "&$bounce_recipient$&"
36262 .vindex "&$bounce_return_size_limit$&"
36263 Each item of text that is read from the file is expanded, and there are two
36264 expansion variables which can be of use here: &$bounce_recipient$& is set to
36265 the recipient of an error message while it is being created, and
36266 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36267 option, rounded to a whole number.
36268
36269 The items must appear in the file in the following order:
36270
36271 .ilist
36272 The first item is included in the headers, and should include at least a
36273 &'Subject:'& header. Exim does not check the syntax of these headers.
36274 .next
36275 The second item forms the start of the error message. After it, Exim lists the
36276 failing addresses with their error messages.
36277 .next
36278 The third item is used to introduce any text from pipe transports that is to be
36279 returned to the sender. It is omitted if there is no such text.
36280 .next
36281 The fourth, fifth and sixth items will be ignored and may be empty.
36282 The fields exist for back-compatibility
36283 .endlist
36284
36285 The default state (&%bounce_message_file%& unset) is equivalent to the
36286 following file, in which the sixth item is empty. The &'Subject:'& and some
36287 other lines have been split in order to fit them on the page:
36288 .code
36289 Subject: Mail delivery failed
36290   ${if eq{$sender_address}{$bounce_recipient}
36291   {: returning message to sender}}
36292 ****
36293 This message was created automatically by mail delivery software.
36294
36295 A message ${if eq{$sender_address}{$bounce_recipient}
36296   {that you sent }{sent by
36297
36298 <$sender_address>
36299
36300 }}could not be delivered to all of its recipients.
36301 This is a permanent error. The following address(es) failed:
36302 ****
36303 The following text was generated during the delivery attempt(s):
36304 ****
36305 ------ This is a copy of the message, including all the headers.
36306   ------
36307 ****
36308 ------ The body of the message is $message_size characters long;
36309   only the first
36310 ------ $bounce_return_size_limit or so are included here.
36311 ****
36312 .endd
36313 .section "Customizing warning messages" "SECTcustwarn"
36314 .cindex "customizing" "warning message"
36315 .cindex "warning of delay" "customizing the message"
36316 The option &%warn_message_file%& can be pointed at a template file for use when
36317 warnings about message delays are created. In this case there are only three
36318 text sections:
36319
36320 .ilist
36321 The first item is included in the headers, and should include at least a
36322 &'Subject:'& header. Exim does not check the syntax of these headers.
36323 .next
36324 The second item forms the start of the warning message. After it, Exim lists
36325 the delayed addresses.
36326 .next
36327 The third item then ends the message.
36328 .endlist
36329
36330 The default state is equivalent to the following file, except that some lines
36331 have been split here, in order to fit them on the page:
36332 .code
36333 Subject: Warning: message $message_exim_id delayed
36334   $warn_message_delay
36335 ****
36336 This message was created automatically by mail delivery software.
36337
36338 A message ${if eq{$sender_address}{$warn_message_recipients}
36339 {that you sent }{sent by
36340
36341 <$sender_address>
36342
36343 }}has not been delivered to all of its recipients after
36344 more than $warn_message_delay in the queue on $primary_hostname.
36345
36346 The message identifier is:     $message_exim_id
36347 The subject of the message is: $h_subject
36348 The date of the message is:    $h_date
36349
36350 The following address(es) have not yet been delivered:
36351 ****
36352 No action is required on your part. Delivery attempts will
36353 continue for some time, and this warning may be repeated at
36354 intervals if the message remains undelivered. Eventually the
36355 mail delivery software will give up, and when that happens,
36356 the message will be returned to you.
36357 .endd
36358 .vindex "&$warn_message_delay$&"
36359 .vindex "&$warn_message_recipients$&"
36360 However, in the default state the subject and date lines are omitted if no
36361 appropriate headers exist. During the expansion of this file,
36362 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36363 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36364 of recipients for the warning message. There may be more than one if there are
36365 multiple addresses with different &%errors_to%& settings on the routers that
36366 handled them.
36367
36368
36369
36370
36371 . ////////////////////////////////////////////////////////////////////////////
36372 . ////////////////////////////////////////////////////////////////////////////
36373
36374 .chapter "Some common configuration settings" "CHAPcomconreq"
36375 This chapter discusses some configuration settings that seem to be fairly
36376 common. More examples and discussion can be found in the Exim book.
36377
36378
36379
36380 .section "Sending mail to a smart host" "SECID240"
36381 .cindex "smart host" "example router"
36382 If you want to send all mail for non-local domains to a &"smart host"&, you
36383 should replace the default &(dnslookup)& router with a router which does the
36384 routing explicitly:
36385 .code
36386 send_to_smart_host:
36387   driver = manualroute
36388   route_list = !+local_domains smart.host.name
36389   transport = remote_smtp
36390 .endd
36391 You can use the smart host's IP address instead of the name if you wish.
36392 If you are using Exim only to submit messages to a smart host, and not for
36393 receiving incoming messages, you can arrange for it to do the submission
36394 synchronously by setting the &%mua_wrapper%& option (see chapter
36395 &<<CHAPnonqueueing>>&).
36396
36397
36398
36399
36400 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36401 .cindex "mailing lists"
36402 Exim can be used to run simple mailing lists, but for large and/or complicated
36403 requirements, the use of additional specialized mailing list software such as
36404 Majordomo or Mailman is recommended.
36405
36406 The &(redirect)& router can be used to handle mailing lists where each list
36407 is maintained in a separate file, which can therefore be managed by an
36408 independent manager. The &%domains%& router option can be used to run these
36409 lists in a separate domain from normal mail. For example:
36410 .code
36411 lists:
36412   driver = redirect
36413   domains = lists.example
36414   file = /usr/lists/$local_part
36415   forbid_pipe
36416   forbid_file
36417   errors_to = $local_part-request@lists.example
36418   no_more
36419 .endd
36420 This router is skipped for domains other than &'lists.example'&. For addresses
36421 in that domain, it looks for a file that matches the local part. If there is no
36422 such file, the router declines, but because &%no_more%& is set, no subsequent
36423 routers are tried, and so the whole delivery fails.
36424
36425 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36426 expanded into a filename or a pipe delivery, which is usually inappropriate in
36427 a mailing list.
36428
36429 .oindex "&%errors_to%&"
36430 The &%errors_to%& option specifies that any delivery errors caused by addresses
36431 taken from a mailing list are to be sent to the given address rather than the
36432 original sender of the message. However, before acting on this, Exim verifies
36433 the error address, and ignores it if verification fails.
36434
36435 For example, using the configuration above, mail sent to
36436 &'dicts@lists.example'& is passed on to those addresses contained in
36437 &_/usr/lists/dicts_&, with error reports directed to
36438 &'dicts-request@lists.example'&, provided that this address can be verified.
36439 There could be a file called &_/usr/lists/dicts-request_& containing
36440 the address(es) of this particular list's manager(s), but other approaches,
36441 such as setting up an earlier router (possibly using the &%local_part_prefix%&
36442 or &%local_part_suffix%& options) to handle addresses of the form
36443 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
36444
36445
36446
36447 .section "Syntax errors in mailing lists" "SECID241"
36448 .cindex "mailing lists" "syntax errors in"
36449 If an entry in redirection data contains a syntax error, Exim normally defers
36450 delivery of the original address. That means that a syntax error in a mailing
36451 list holds up all deliveries to the list. This may not be appropriate when a
36452 list is being maintained automatically from data supplied by users, and the
36453 addresses are not rigorously checked.
36454
36455 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
36456 entries that fail to parse, noting the incident in the log. If in addition
36457 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
36458 whenever a broken address is skipped. It is usually appropriate to set
36459 &%syntax_errors_to%& to the same address as &%errors_to%&.
36460
36461
36462
36463 .section "Re-expansion of mailing lists" "SECID242"
36464 .cindex "mailing lists" "re-expansion of"
36465 Exim remembers every individual address to which a message has been delivered,
36466 in order to avoid duplication, but it normally stores only the original
36467 recipient addresses with a message. If all the deliveries to a mailing list
36468 cannot be done at the first attempt, the mailing list is re-expanded when the
36469 delivery is next tried. This means that alterations to the list are taken into
36470 account at each delivery attempt, so addresses that have been added to
36471 the list since the message arrived will therefore receive a copy of the
36472 message, even though it pre-dates their subscription.
36473
36474 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
36475 on the &(redirect)& router. If this is done, any addresses generated by the
36476 router that fail to deliver at the first attempt are added to the message as
36477 &"top level"& addresses, and the parent address that generated them is marked
36478 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
36479 subsequent delivery attempts. The disadvantage of this is that if any of the
36480 failing addresses are incorrect, correcting them in the file has no effect on
36481 pre-existing messages.
36482
36483 The original top-level address is remembered with each of the generated
36484 addresses, and is output in any log messages. However, any intermediate parent
36485 addresses are not recorded. This makes a difference to the log only if the
36486 &%all_parents%& selector is set, but for mailing lists there is normally only
36487 one level of expansion anyway.
36488
36489
36490
36491 .section "Closed mailing lists" "SECID243"
36492 .cindex "mailing lists" "closed"
36493 The examples so far have assumed open mailing lists, to which anybody may
36494 send mail. It is also possible to set up closed lists, where mail is accepted
36495 from specified senders only. This is done by making use of the generic
36496 &%senders%& option to restrict the router that handles the list.
36497
36498 The following example uses the same file as a list of recipients and as a list
36499 of permitted senders. It requires three routers:
36500 .code
36501 lists_request:
36502   driver = redirect
36503   domains = lists.example
36504   local_part_suffix = -request
36505   file = /usr/lists/$local_part$local_part_suffix
36506   no_more
36507
36508 lists_post:
36509   driver = redirect
36510   domains = lists.example
36511   senders = ${if exists {/usr/lists/$local_part}\
36512              {lsearch;/usr/lists/$local_part}{*}}
36513   file = /usr/lists/$local_part
36514   forbid_pipe
36515   forbid_file
36516   errors_to = $local_part-request@lists.example
36517   no_more
36518
36519 lists_closed:
36520   driver = redirect
36521   domains = lists.example
36522   allow_fail
36523   data = :fail: $local_part@lists.example is a closed mailing list
36524 .endd
36525 All three routers have the same &%domains%& setting, so for any other domains,
36526 they are all skipped. The first router runs only if the local part ends in
36527 &%-request%&. It handles messages to the list manager(s) by means of an open
36528 mailing list.
36529
36530 The second router runs only if the &%senders%& precondition is satisfied. It
36531 checks for the existence of a list that corresponds to the local part, and then
36532 checks that the sender is on the list by means of a linear search. It is
36533 necessary to check for the existence of the file before trying to search it,
36534 because otherwise Exim thinks there is a configuration error. If the file does
36535 not exist, the expansion of &%senders%& is *, which matches all senders. This
36536 means that the router runs, but because there is no list, declines, and
36537 &%no_more%& ensures that no further routers are run. The address fails with an
36538 &"unrouteable address"& error.
36539
36540 The third router runs only if the second router is skipped, which happens when
36541 a mailing list exists, but the sender is not on it. This router forcibly fails
36542 the address, giving a suitable error message.
36543
36544
36545
36546
36547 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36548 .cindex "VERP"
36549 .cindex "Variable Envelope Return Paths"
36550 .cindex "envelope from"
36551 .cindex "envelope sender"
36552 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36553 are a way of helping mailing list administrators discover which subscription
36554 address is the cause of a particular delivery failure. The idea is to encode
36555 the original recipient address in the outgoing envelope sender address, so that
36556 if the message is forwarded by another host and then subsequently bounces, the
36557 original recipient can be extracted from the recipient address of the bounce.
36558
36559 .oindex &%errors_to%&
36560 .oindex &%return_path%&
36561 Envelope sender addresses can be modified by Exim using two different
36562 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36563 list examples), or the &%return_path%& option on a transport. The second of
36564 these is effective only if the message is successfully delivered to another
36565 host; it is not used for errors detected on the local host (see the description
36566 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36567 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36568 .code
36569 verp_smtp:
36570   driver = smtp
36571   max_rcpt = 1
36572   return_path = \
36573     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36574       {$1-request+$local_part=$domain@your.dom.example}fail}
36575 .endd
36576 This has the effect of rewriting the return path (envelope sender) on outgoing
36577 SMTP messages, if the local part of the original return path ends in
36578 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36579 local part and domain of the recipient into the return path. Suppose, for
36580 example, that a message whose return path has been set to
36581 &'somelist-request@your.dom.example'& is sent to
36582 &'subscriber@other.dom.example'&. In the transport, the return path is
36583 rewritten as
36584 .code
36585 somelist-request+subscriber=other.dom.example@your.dom.example
36586 .endd
36587 .vindex "&$local_part$&"
36588 For this to work, you must tell Exim to send multiple copies of messages that
36589 have more than one recipient, so that each copy has just one recipient. This is
36590 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36591 might be sent to several different recipients in the same domain, in which case
36592 &$local_part$& is not available in the transport, because it is not unique.
36593
36594 Unless your host is doing nothing but mailing list deliveries, you should
36595 probably use a separate transport for the VERP deliveries, so as not to use
36596 extra resources in making one-per-recipient copies for other deliveries. This
36597 can easily be done by expanding the &%transport%& option in the router:
36598 .code
36599 dnslookup:
36600   driver = dnslookup
36601   domains = ! +local_domains
36602   transport = \
36603     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36604       {verp_smtp}{remote_smtp}}
36605   no_more
36606 .endd
36607 If you want to change the return path using &%errors_to%& in a router instead
36608 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36609 routers that handle mailing list addresses. This will ensure that all delivery
36610 errors, including those detected on the local host, are sent to the VERP
36611 address.
36612
36613 On a host that does no local deliveries and has no manual routing, only the
36614 &(dnslookup)& router needs to be changed. A special transport is not needed for
36615 SMTP deliveries. Every mailing list recipient has its own return path value,
36616 and so Exim must hand them to the transport one at a time. Here is an example
36617 of a &(dnslookup)& router that implements VERP:
36618 .code
36619 verp_dnslookup:
36620   driver = dnslookup
36621   domains = ! +local_domains
36622   transport = remote_smtp
36623   errors_to = \
36624     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36625      {$1-request+$local_part=$domain@your.dom.example}fail}
36626   no_more
36627 .endd
36628 Before you start sending out messages with VERPed return paths, you must also
36629 configure Exim to accept the bounce messages that come back to those paths.
36630 Typically this is done by setting a &%local_part_suffix%& option for a
36631 router, and using this to route the messages to wherever you want to handle
36632 them.
36633
36634 The overhead incurred in using VERP depends very much on the size of the
36635 message, the number of recipient addresses that resolve to the same remote
36636 host, and the speed of the connection over which the message is being sent. If
36637 a lot of addresses resolve to the same host and the connection is slow, sending
36638 a separate copy of the message for each address may take substantially longer
36639 than sending a single copy with many recipients (for which VERP cannot be
36640 used).
36641
36642
36643
36644
36645
36646
36647 .section "Virtual domains" "SECTvirtualdomains"
36648 .cindex "virtual domains"
36649 .cindex "domain" "virtual"
36650 The phrase &'virtual domain'& is unfortunately used with two rather different
36651 meanings:
36652
36653 .ilist
36654 A domain for which there are no real mailboxes; all valid local parts are
36655 aliases for other email addresses. Common examples are organizational
36656 top-level domains and &"vanity"& domains.
36657 .next
36658 One of a number of independent domains that are all handled by the same host,
36659 with mailboxes on that host, but where the mailbox owners do not necessarily
36660 have login accounts on that host.
36661 .endlist
36662
36663 The first usage is probably more common, and does seem more &"virtual"& than
36664 the second. This kind of domain can be handled in Exim with a straightforward
36665 aliasing router. One approach is to create a separate alias file for each
36666 virtual domain. Exim can test for the existence of the alias file to determine
36667 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36668 to a router of this form:
36669 .code
36670 virtual:
36671   driver = redirect
36672   domains = dsearch;/etc/mail/virtual
36673   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36674   no_more
36675 .endd
36676 The &%domains%& option specifies that the router is to be skipped, unless there
36677 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36678 domain that is being processed. When the router runs, it looks up the local
36679 part in the file to find a new address (or list of addresses). The &%no_more%&
36680 setting ensures that if the lookup fails (leading to &%data%& being an empty
36681 string), Exim gives up on the address without trying any subsequent routers.
36682
36683 This one router can handle all the virtual domains because the alias filenames
36684 follow a fixed pattern. Permissions can be arranged so that appropriate people
36685 can edit the different alias files. A successful aliasing operation results in
36686 a new envelope recipient address, which is then routed from scratch.
36687
36688 The other kind of &"virtual"& domain can also be handled in a straightforward
36689 way. One approach is to create a file for each domain containing a list of
36690 valid local parts, and use it in a router like this:
36691 .code
36692 my_domains:
36693   driver = accept
36694   domains = dsearch;/etc/mail/domains
36695   local_parts = lsearch;/etc/mail/domains/$domain
36696   transport = my_mailboxes
36697 .endd
36698 The address is accepted if there is a file for the domain, and the local part
36699 can be found in the file. The &%domains%& option is used to check for the
36700 file's existence because &%domains%& is tested before the &%local_parts%&
36701 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36702 because that option is tested after &%local_parts%&. The transport is as
36703 follows:
36704 .code
36705 my_mailboxes:
36706   driver = appendfile
36707   file = /var/mail/$domain/$local_part
36708   user = mail
36709 .endd
36710 This uses a directory of mailboxes for each domain. The &%user%& setting is
36711 required, to specify which uid is to be used for writing to the mailboxes.
36712
36713 The configuration shown here is just one example of how you might support this
36714 requirement. There are many other ways this kind of configuration can be set
36715 up, for example, by using a database instead of separate files to hold all the
36716 information about the domains.
36717
36718
36719
36720 .section "Multiple user mailboxes" "SECTmulbox"
36721 .cindex "multiple mailboxes"
36722 .cindex "mailbox" "multiple"
36723 .cindex "local part" "prefix"
36724 .cindex "local part" "suffix"
36725 Heavy email users often want to operate with multiple mailboxes, into which
36726 incoming mail is automatically sorted. A popular way of handling this is to
36727 allow users to use multiple sender addresses, so that replies can easily be
36728 identified. Users are permitted to add prefixes or suffixes to their local
36729 parts for this purpose. The wildcard facility of the generic router options
36730 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36731 example, consider this router:
36732 .code
36733 userforward:
36734   driver = redirect
36735   check_local_user
36736   file = $home/.forward
36737   local_part_suffix = -*
36738   local_part_suffix_optional
36739   allow_filter
36740 .endd
36741 .vindex "&$local_part_suffix$&"
36742 It runs a user's &_.forward_& file for all local parts of the form
36743 &'username-*'&. Within the filter file the user can distinguish different
36744 cases by testing the variable &$local_part_suffix$&. For example:
36745 .code
36746 if $local_part_suffix contains -special then
36747 save /home/$local_part/Mail/special
36748 endif
36749 .endd
36750 If the filter file does not exist, or does not deal with such addresses, they
36751 fall through to subsequent routers, and, assuming no subsequent use of the
36752 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36753 control over which suffixes are valid.
36754
36755 Alternatively, a suffix can be used to trigger the use of a different
36756 &_.forward_& file &-- which is the way a similar facility is implemented in
36757 another MTA:
36758 .code
36759 userforward:
36760   driver = redirect
36761   check_local_user
36762   file = $home/.forward$local_part_suffix
36763   local_part_suffix = -*
36764   local_part_suffix_optional
36765   allow_filter
36766 .endd
36767 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36768 example, &_.forward-special_& is used. Once again, if the appropriate file
36769 does not exist, or does not deal with the address, it is passed on to
36770 subsequent routers, which could, if required, look for an unqualified
36771 &_.forward_& file to use as a default.
36772
36773
36774
36775 .section "Simplified vacation processing" "SECID244"
36776 .cindex "vacation processing"
36777 The traditional way of running the &'vacation'& program is for a user to set up
36778 a pipe command in a &_.forward_& file
36779 (see section &<<SECTspecitredli>>& for syntax details).
36780 This is prone to error by inexperienced users. There are two features of Exim
36781 that can be used to make this process simpler for users:
36782
36783 .ilist
36784 A local part prefix such as &"vacation-"& can be specified on a router which
36785 can cause the message to be delivered directly to the &'vacation'& program, or
36786 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36787 &_.forward_& file are then much simpler. For example:
36788 .code
36789 spqr, vacation-spqr
36790 .endd
36791 .next
36792 The &%require_files%& generic router option can be used to trigger a
36793 vacation delivery by checking for the existence of a certain file in the
36794 user's home directory. The &%unseen%& generic option should also be used, to
36795 ensure that the original delivery also proceeds. In this case, all the user has
36796 to do is to create a file called, say, &_.vacation_&, containing a vacation
36797 message.
36798 .endlist
36799
36800 Another advantage of both these methods is that they both work even when the
36801 use of arbitrary pipes by users is locked out.
36802
36803
36804
36805 .section "Taking copies of mail" "SECID245"
36806 .cindex "message" "copying every"
36807 Some installations have policies that require archive copies of all messages to
36808 be made. A single copy of each message can easily be taken by an appropriate
36809 command in a system filter, which could, for example, use a different file for
36810 each day's messages.
36811
36812 There is also a shadow transport mechanism that can be used to take copies of
36813 messages that are successfully delivered by local transports, one copy per
36814 delivery. This could be used, &'inter alia'&, to implement automatic
36815 notification of delivery by sites that insist on doing such things.
36816
36817
36818
36819 .section "Intermittently connected hosts" "SECID246"
36820 .cindex "intermittently connected hosts"
36821 It has become quite common (because it is cheaper) for hosts to connect to the
36822 Internet periodically rather than remain connected all the time. The normal
36823 arrangement is that mail for such hosts accumulates on a system that is
36824 permanently connected.
36825
36826 Exim was designed for use on permanently connected hosts, and so it is not
36827 particularly well-suited to use in an intermittently connected environment.
36828 Nevertheless there are some features that can be used.
36829
36830
36831 .section "Exim on the upstream server host" "SECID247"
36832 It is tempting to arrange for incoming mail for the intermittently connected
36833 host to remain in Exim's queue until the client connects. However, this
36834 approach does not scale very well. Two different kinds of waiting message are
36835 being mixed up in the same queue &-- those that cannot be delivered because of
36836 some temporary problem, and those that are waiting for their destination host
36837 to connect. This makes it hard to manage the queue, as well as wasting
36838 resources, because each queue runner scans the entire queue.
36839
36840 A better approach is to separate off those messages that are waiting for an
36841 intermittently connected host. This can be done by delivering these messages
36842 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36843 format, from where they are transmitted by other software when their
36844 destination connects. This makes it easy to collect all the mail for one host
36845 in a single directory, and to apply local timeout rules on a per-message basis
36846 if required.
36847
36848 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36849 you are doing this, you should configure Exim with a long retry period for the
36850 intermittent host. For example:
36851 .code
36852 cheshire.wonderland.fict.example    *   F,5d,24h
36853 .endd
36854 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36855 which messages it has queued up for that host. Once the intermittent host comes
36856 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36857 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36858 causes all the queued up messages to be delivered, often down a single SMTP
36859 connection. While the host remains connected, any new messages get delivered
36860 immediately.
36861
36862 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36863 issued with a different IP address each time it connects, Exim's retry
36864 mechanisms on the holding host get confused, because the IP address is normally
36865 used as part of the key string for holding retry information. This can be
36866 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36867 Since this has disadvantages for permanently connected hosts, it is best to
36868 arrange a separate transport for the intermittently connected ones.
36869
36870
36871
36872 .section "Exim on the intermittently connected client host" "SECID248"
36873 The value of &%smtp_accept_queue_per_connection%& should probably be
36874 increased, or even set to zero (that is, disabled) on the intermittently
36875 connected host, so that all incoming messages down a single connection get
36876 delivered immediately.
36877
36878 .cindex "SMTP" "passed connection"
36879 .cindex "SMTP" "multiple deliveries"
36880 .cindex "multiple SMTP deliveries"
36881 .cindex "first pass routing"
36882 Mail waiting to be sent from an intermittently connected host will probably
36883 not have been routed, because without a connection DNS lookups are not
36884 possible. This means that if a normal queue run is done at connection time,
36885 each message is likely to be sent in a separate SMTP session. This can be
36886 avoided by starting the queue run with a command line option beginning with
36887 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36888 first pass, routing is done but no deliveries take place. The second pass is a
36889 normal queue run; since all the messages have been previously routed, those
36890 destined for the same host are likely to get sent as multiple deliveries in a
36891 single SMTP connection.
36892
36893
36894
36895 . ////////////////////////////////////////////////////////////////////////////
36896 . ////////////////////////////////////////////////////////////////////////////
36897
36898 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36899          "Exim as a non-queueing client"
36900 .cindex "client, non-queueing"
36901 .cindex "smart host" "suppressing queueing"
36902 On a personal computer, it is a common requirement for all
36903 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36904 configured to operate that way, for all the popular operating systems.
36905 However, there are some MUAs for Unix-like systems that cannot be so
36906 configured: they submit messages using the command line interface of
36907 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36908 messages this way.
36909
36910 If the personal computer runs continuously, there is no problem, because it can
36911 run a conventional MTA that handles delivery to the smart host, and deal with
36912 any delays via its queueing mechanism. However, if the computer does not run
36913 continuously or runs different operating systems at different times, queueing
36914 email is not desirable.
36915
36916 There is therefore a requirement for something that can provide the
36917 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36918 any queueing or retrying facilities. Furthermore, the delivery to the smart
36919 host should be synchronous, so that if it fails, the sending MUA is immediately
36920 informed. In other words, we want something that extends an MUA that submits
36921 to a local MTA via the command line so that it behaves like one that submits
36922 to a remote smart host using TCP/SMTP.
36923
36924 There are a number of applications (for example, there is one called &'ssmtp'&)
36925 that do this job. However, people have found them to be lacking in various
36926 ways. For instance, you might want to allow aliasing and forwarding to be done
36927 before sending a message to the smart host.
36928
36929 Exim already had the necessary infrastructure for doing this job. Just a few
36930 tweaks were needed to make it behave as required, though it is somewhat of an
36931 overkill to use a fully-featured MTA for this purpose.
36932
36933 .oindex "&%mua_wrapper%&"
36934 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36935 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36936 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36937 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36938 compatible router and transport configuration. Typically there will be just one
36939 router and one transport, sending everything to a smart host.
36940
36941 When run in MUA wrapping mode, the behaviour of Exim changes in the
36942 following ways:
36943
36944 .ilist
36945 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36946 In other words, the only way to submit messages is via the command line.
36947 .next
36948 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36949 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36950 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36951 does not finish until the delivery attempt is complete. If the delivery is
36952 successful, a zero return code is given.
36953 .next
36954 Address redirection is permitted, but the final routing for all addresses must
36955 be to the same remote transport, and to the same list of hosts. Furthermore,
36956 the return address (envelope sender) must be the same for all recipients, as
36957 must any added or deleted header lines. In other words, it must be possible to
36958 deliver the message in a single SMTP transaction, however many recipients there
36959 are.
36960 .next
36961 If these conditions are not met, or if routing any address results in a
36962 failure or defer status, or if Exim is unable to deliver all the recipients
36963 successfully to one of the smart hosts, delivery of the entire message fails.
36964 .next
36965 Because no queueing is allowed, all failures are treated as permanent; there
36966 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36967 smart host. Furthermore, because only a single yes/no response can be given to
36968 the caller, it is not possible to deliver to some recipients and not others. If
36969 there is an error (temporary or permanent) for any recipient, all are failed.
36970 .next
36971 If more than one smart host is listed, Exim will try another host after a
36972 connection failure or a timeout, in the normal way. However, if this kind of
36973 failure happens for all the hosts, the delivery fails.
36974 .next
36975 When delivery fails, an error message is written to the standard error stream
36976 (as well as to Exim's log), and Exim exits to the caller with a return code
36977 value 1. The message is expunged from Exim's spool files. No bounce messages
36978 are ever generated.
36979 .next
36980 No retry data is maintained, and any retry rules are ignored.
36981 .next
36982 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36983 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36984 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36985 .endlist
36986
36987 The overall effect is that Exim makes a single synchronous attempt to deliver
36988 the message, failing if there is any kind of problem. Because no local
36989 deliveries are done and no daemon can be run, Exim does not need root
36990 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36991 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36992 the advantages and disadvantages of running without root privilege.
36993
36994
36995
36996
36997 . ////////////////////////////////////////////////////////////////////////////
36998 . ////////////////////////////////////////////////////////////////////////////
36999
37000 .chapter "Log files" "CHAPlog"
37001 .scindex IIDloggen "log" "general description"
37002 .cindex "log" "types of"
37003 Exim writes three different logs, referred to as the main log, the reject log,
37004 and the panic log:
37005
37006 .ilist
37007 .cindex "main log"
37008 The main log records the arrival of each message and each delivery in a single
37009 line in each case. The format is as compact as possible, in an attempt to keep
37010 down the size of log files. Two-character flag sequences make it easy to pick
37011 out these lines. A number of other events are recorded in the main log. Some of
37012 them are optional, in which case the &%log_selector%& option controls whether
37013 they are included or not. A Perl script called &'eximstats'&, which does simple
37014 analysis of main log files, is provided in the Exim distribution (see section
37015 &<<SECTmailstat>>&).
37016 .next
37017 .cindex "reject log"
37018 The reject log records information from messages that are rejected as a result
37019 of a configuration option (that is, for policy reasons).
37020 The first line of each rejection is a copy of the line that is also written to
37021 the main log. Then, if the message's header has been read at the time the log
37022 is written, its contents are written to this log. Only the original header
37023 lines are available; header lines added by ACLs are not logged. You can use the
37024 reject log to check that your policy controls are working correctly; on a busy
37025 host this may be easier than scanning the main log for rejection messages. You
37026 can suppress the writing of the reject log by setting &%write_rejectlog%&
37027 false.
37028 .next
37029 .cindex "panic log"
37030 .cindex "system log"
37031 When certain serious errors occur, Exim writes entries to its panic log. If the
37032 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37033 are usually written to the main log as well, but can get lost amid the mass of
37034 other entries. The panic log should be empty under normal circumstances. It is
37035 therefore a good idea to check it (or to have a &'cron'& script check it)
37036 regularly, in order to become aware of any problems. When Exim cannot open its
37037 panic log, it tries as a last resort to write to the system log (syslog). This
37038 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37039 message itself is written at priority LOG_CRIT.
37040 .endlist
37041
37042 Every log line starts with a timestamp, in the format shown in the following
37043 example. Note that many of the examples shown in this chapter are line-wrapped.
37044 In the log file, this would be all on one line:
37045 .code
37046 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37047   by QUIT
37048 .endd
37049 By default, the timestamps are in the local timezone. There are two
37050 ways of changing this:
37051
37052 .ilist
37053 You can set the &%timezone%& option to a different time zone; in particular, if
37054 you set
37055 .code
37056 timezone = UTC
37057 .endd
37058 the timestamps will be in UTC (aka GMT).
37059 .next
37060 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37061 example:
37062 .code
37063 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37064 .endd
37065 .endlist
37066
37067 .cindex "log" "process ids in"
37068 .cindex "pid (process id)" "in log lines"
37069 Exim does not include its process id in log lines by default, but you can
37070 request that it does so by specifying the &`pid`& log selector (see section
37071 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37072 brackets, immediately after the time and date.
37073
37074
37075
37076
37077 .section "Where the logs are written" "SECTwhelogwri"
37078 .cindex "log" "destination"
37079 .cindex "log" "to file"
37080 .cindex "log" "to syslog"
37081 .cindex "syslog"
37082 The logs may be written to local files, or to syslog, or both. However, it
37083 should be noted that many syslog implementations use UDP as a transport, and
37084 are therefore unreliable in the sense that messages are not guaranteed to
37085 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37086 It has also been reported that on large log files (tens of megabytes) you may
37087 need to tweak syslog to prevent it syncing the file with each write &-- on
37088 Linux this has been seen to make syslog take 90% plus of CPU time.
37089
37090 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37091 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37092 configuration. This latter string is expanded, so it can contain, for example,
37093 references to the host name:
37094 .code
37095 log_file_path = /var/log/$primary_hostname/exim_%slog
37096 .endd
37097 It is generally advisable, however, to set the string in &_Local/Makefile_&
37098 rather than at runtime, because then the setting is available right from the
37099 start of Exim's execution. Otherwise, if there's something it wants to log
37100 before it has read the configuration file (for example, an error in the
37101 configuration file) it will not use the path you want, and may not be able to
37102 log at all.
37103
37104 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37105 list, currently limited to at most two items. This is one option where the
37106 facility for changing a list separator may not be used. The list must always be
37107 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37108 otherwise the item must either be an absolute path, containing &`%s`& at the
37109 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37110 implying the use of a default path.
37111
37112 When Exim encounters an empty item in the list, it searches the list defined by
37113 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37114 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37115 mean &"use the path specified at build time"&. It no such item exists, log
37116 files are written in the &_log_& subdirectory of the spool directory. This is
37117 equivalent to the setting:
37118 .code
37119 log_file_path = $spool_directory/log/%slog
37120 .endd
37121 If you do not specify anything at build time or runtime,
37122 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37123 that is where the logs are written.
37124
37125 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37126 are in use &-- see section &<<SECTdatlogfil>>& below.
37127
37128 Here are some examples of possible settings:
37129 .display
37130 &`LOG_FILE_PATH=syslog                    `& syslog only
37131 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37132 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37133 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37134 .endd
37135 If there are more than two paths in the list, the first is used and a panic
37136 error is logged.
37137
37138
37139
37140 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37141 .cindex "log" "cycling local files"
37142 .cindex "cycling logs"
37143 .cindex "&'exicyclog'&"
37144 .cindex "log" "local files; writing to"
37145 Some operating systems provide centralized and standardized methods for cycling
37146 log files. For those that do not, a utility script called &'exicyclog'& is
37147 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37148 main and reject logs each time it is called. The maximum number of old logs to
37149 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37150
37151 An Exim delivery process opens the main log when it first needs to write to it,
37152 and it keeps the file open in case subsequent entries are required &-- for
37153 example, if a number of different deliveries are being done for the same
37154 message. However, remote SMTP deliveries can take a long time, and this means
37155 that the file may be kept open long after it is renamed if &'exicyclog'& or
37156 something similar is being used to rename log files on a regular basis. To
37157 ensure that a switch of log files is noticed as soon as possible, Exim calls
37158 &[stat()]& on the main log's name before reusing an open file, and if the file
37159 does not exist, or its inode has changed, the old file is closed and Exim
37160 tries to open the main log from scratch. Thus, an old log file may remain open
37161 for quite some time, but no Exim processes should write to it once it has been
37162 renamed.
37163
37164
37165
37166 .section "Datestamped log files" "SECTdatlogfil"
37167 .cindex "log" "datestamped files"
37168 Instead of cycling the main and reject log files by renaming them
37169 periodically, some sites like to use files whose names contain a datestamp,
37170 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37171 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37172 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37173 point where the datestamp is required. For example:
37174 .code
37175 log_file_path = /var/spool/exim/log/%slog-%D
37176 log_file_path = /var/log/exim-%s-%D.log
37177 log_file_path = /var/spool/exim/log/%D-%slog
37178 log_file_path = /var/log/exim/%s.%M
37179 .endd
37180 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37181 examples of names generated by the above examples:
37182 .code
37183 /var/spool/exim/log/mainlog-20021225
37184 /var/log/exim-reject-20021225.log
37185 /var/spool/exim/log/20021225-mainlog
37186 /var/log/exim/main.200212
37187 .endd
37188 When this form of log file is specified, Exim automatically switches to new
37189 files at midnight. It does not make any attempt to compress old logs; you
37190 will need to write your own script if you require this. You should not
37191 run &'exicyclog'& with this form of logging.
37192
37193 The location of the panic log is also determined by &%log_file_path%&, but it
37194 is not datestamped, because rotation of the panic log does not make sense.
37195 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37196 the string. In addition, if it immediately follows a slash, a following
37197 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37198 character is removed. Thus, the four examples above would give these panic
37199 log names:
37200 .code
37201 /var/spool/exim/log/paniclog
37202 /var/log/exim-panic.log
37203 /var/spool/exim/log/paniclog
37204 /var/log/exim/panic
37205 .endd
37206
37207
37208 .section "Logging to syslog" "SECID249"
37209 .cindex "log" "syslog; writing to"
37210 The use of syslog does not change what Exim logs or the format of its messages,
37211 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37212 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37213 that, the same strings are written to syslog as to log files. The syslog
37214 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37215 by default, but you can change these by setting the &%syslog_facility%& and
37216 &%syslog_processname%& options, respectively. If Exim was compiled with
37217 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37218 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37219 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37220 the time and host name to each line.
37221 The three log streams are mapped onto syslog priorities as follows:
37222
37223 .ilist
37224 &'mainlog'& is mapped to LOG_INFO
37225 .next
37226 &'rejectlog'& is mapped to LOG_NOTICE
37227 .next
37228 &'paniclog'& is mapped to LOG_ALERT
37229 .endlist
37230
37231 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37232 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37233 these are routed by syslog to the same place. You can suppress this duplication
37234 by setting &%syslog_duplication%& false.
37235
37236 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37237 entries contain multiple lines when headers are included. To cope with both
37238 these cases, entries written to syslog are split into separate &[syslog()]&
37239 calls at each internal newline, and also after a maximum of
37240 870 data characters. (This allows for a total syslog line length of 1024, when
37241 additions such as timestamps are added.) If you are running a syslog
37242 replacement that can handle lines longer than the 1024 characters allowed by
37243 RFC 3164, you should set
37244 .code
37245 SYSLOG_LONG_LINES=yes
37246 .endd
37247 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37248 lines, but it still splits at internal newlines in &'reject'& log entries.
37249
37250 To make it easy to re-assemble split lines later, each component of a split
37251 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37252 where <&'n'&> is the component number and <&'m'&> is the total number of
37253 components in the entry. The / delimiter is used when the line was split
37254 because it was too long; if it was split because of an internal newline, the \
37255 delimiter is used. For example, supposing the length limit to be 50 instead of
37256 870, the following would be the result of a typical rejection message to
37257 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37258 name, and pid as added by syslog:
37259 .code
37260 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37261 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37262 [3/5]  when scanning for sender: missing or malformed lo
37263 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37264 [5/5] mple>)
37265 .endd
37266 The same error might cause the following lines to be written to &"rejectlog"&
37267 (LOG_NOTICE):
37268 .code
37269 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37270 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37271 [3/18] er when scanning for sender: missing or malformed
37272 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37273 [5\18] .example>)
37274 [6\18] Recipients: ph10@some.domain.cam.example
37275 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37276 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37277 [9\18]        id 16RdAL-0006pc-00
37278 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37279 [11\18] 09:43 +0100
37280 [12\18] F From: <>
37281 [13\18]   Subject: this is a test header
37282 [18\18]   X-something: this is another header
37283 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37284 [16\18] le>
37285 [17\18] B Bcc:
37286 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37287 .endd
37288 Log lines that are neither too long nor contain newlines are written to syslog
37289 without modification.
37290
37291 If only syslog is being used, the Exim monitor is unable to provide a log tail
37292 display, unless syslog is routing &'mainlog'& to a file on the local host and
37293 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37294 where it is.
37295
37296
37297
37298 .section "Log line flags" "SECID250"
37299 One line is written to the main log for each message received, and for each
37300 successful, unsuccessful, and delayed delivery. These lines can readily be
37301 picked out by the distinctive two-character flags that immediately follow the
37302 timestamp. The flags are:
37303 .display
37304 &`<=`&     message arrival
37305 &`(=`&     message fakereject
37306 &`=>`&     normal message delivery
37307 &`->`&     additional address in same delivery
37308 &`>>`&     cutthrough message delivery
37309 &`*>`&     delivery suppressed by &%-N%&
37310 &`**`&     delivery failed; address bounced
37311 &`==`&     delivery deferred; temporary problem
37312 .endd
37313
37314
37315 .section "Logging message reception" "SECID251"
37316 .cindex "log" "reception line"
37317 The format of the single-line entry in the main log that is written for every
37318 message received is shown in the basic example below, which is split over
37319 several lines in order to fit it on the page:
37320 .code
37321 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37322   H=mailer.fict.example [192.168.123.123] U=exim
37323   P=smtp S=5678 id=<incoming message id>
37324 .endd
37325 The address immediately following &"<="& is the envelope sender address. A
37326 bounce message is shown with the sender address &"<>"&, and if it is locally
37327 generated, this is followed by an item of the form
37328 .code
37329 R=<message id>
37330 .endd
37331 which is a reference to the message that caused the bounce to be sent.
37332
37333 .cindex "HELO"
37334 .cindex "EHLO"
37335 For messages from other hosts, the H and U fields identify the remote host and
37336 record the RFC 1413 identity of the user that sent the message, if one was
37337 received. The number given in square brackets is the IP address of the sending
37338 host. If there is a single, unparenthesized  host name in the H field, as
37339 above, it has been verified to correspond to the IP address (see the
37340 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37341 by the remote host in the SMTP HELO or EHLO command, and has not been
37342 verified. If verification yields a different name to that given for HELO or
37343 EHLO, the verified name appears first, followed by the HELO or EHLO
37344 name in parentheses.
37345
37346 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37347 without brackets, in the HELO or EHLO command, leading to entries in
37348 the log containing text like these examples:
37349 .code
37350 H=(10.21.32.43) [192.168.8.34]
37351 H=([10.21.32.43]) [192.168.8.34]
37352 .endd
37353 This can be confusing. Only the final address in square brackets can be relied
37354 on.
37355
37356 For locally generated messages (that is, messages not received over TCP/IP),
37357 the H field is omitted, and the U field contains the login name of the caller
37358 of Exim.
37359
37360 .cindex "authentication" "logging"
37361 .cindex "AUTH" "logging"
37362 For all messages, the P field specifies the protocol used to receive the
37363 message. This is the value that is stored in &$received_protocol$&. In the case
37364 of incoming SMTP messages, the value indicates whether or not any SMTP
37365 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37366 session was encrypted, there is an additional X field that records the cipher
37367 suite that was used.
37368
37369 .cindex log protocol
37370 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37371 hosts that have authenticated themselves using the SMTP AUTH command. The first
37372 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37373 there is an additional item A= followed by the name of the authenticator that
37374 was used. If an authenticated identification was set up by the authenticator's
37375 &%server_set_id%& option, this is logged too, separated by a colon from the
37376 authenticator name.
37377
37378 .cindex "size" "of message"
37379 The id field records the existing message id, if present. The size of the
37380 received message is given by the S field. When the message is delivered,
37381 headers may be removed or added, so that the size of delivered copies of the
37382 message may not correspond with this value (and indeed may be different to each
37383 other).
37384
37385 The &%log_selector%& option can be used to request the logging of additional
37386 data when a message is received. See section &<<SECTlogselector>>& below.
37387
37388
37389
37390 .section "Logging deliveries" "SECID252"
37391 .cindex "log" "delivery line"
37392 The format of the single-line entry in the main log that is written for every
37393 delivery is shown in one of the examples below, for local and remote
37394 deliveries, respectively. Each example has been split into multiple lines in order
37395 to fit it on the page:
37396 .code
37397 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37398   <marv@hitch.fict.example> R=localuser T=local_delivery
37399 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37400   monk@holistic.fict.example R=dnslookup T=remote_smtp
37401   H=holistic.fict.example [192.168.234.234]
37402 .endd
37403 For ordinary local deliveries, the original address is given in angle brackets
37404 after the final delivery address, which might be a pipe or a file. If
37405 intermediate address(es) exist between the original and the final address, the
37406 last of these is given in parentheses after the final address. The R and T
37407 fields record the router and transport that were used to process the address.
37408
37409 If SMTP AUTH was used for the delivery there is an additional item A=
37410 followed by the name of the authenticator that was used.
37411 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37412 option, this is logged too, separated by a colon from the authenticator name.
37413
37414 If a shadow transport was run after a successful local delivery, the log line
37415 for the successful delivery has an item added on the end, of the form
37416 .display
37417 &`ST=<`&&'shadow transport name'&&`>`&
37418 .endd
37419 If the shadow transport did not succeed, the error message is put in
37420 parentheses afterwards.
37421
37422 .cindex "asterisk" "after IP address"
37423 When more than one address is included in a single delivery (for example, two
37424 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37425 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37426 down a single SMTP connection, an asterisk follows the IP address in the log
37427 lines for the second and subsequent messages.
37428 When two or more messages are delivered down a single TLS connection, the
37429 DNS and some TLS-related information logged for the first message delivered
37430 will not be present in the log lines for the second and subsequent messages.
37431 TLS cipher information is still available.
37432
37433 .cindex "delivery" "cutthrough; logging"
37434 .cindex "cutthrough" "logging"
37435 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37436 line precedes the reception line, since cutthrough waits for a possible
37437 rejection from the destination in case it can reject the sourced item.
37438
37439 The generation of a reply message by a filter file gets logged as a
37440 &"delivery"& to the addressee, preceded by &">"&.
37441
37442 The &%log_selector%& option can be used to request the logging of additional
37443 data when a message is delivered. See section &<<SECTlogselector>>& below.
37444
37445
37446 .section "Discarded deliveries" "SECID253"
37447 .cindex "discarded messages"
37448 .cindex "message" "discarded"
37449 .cindex "delivery" "discarded; logging"
37450 When a message is discarded as a result of the command &"seen finish"& being
37451 obeyed in a filter file which generates no deliveries, a log entry of the form
37452 .code
37453 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
37454   <low.club@bridge.example> R=userforward
37455 .endd
37456 is written, to record why no deliveries are logged. When a message is discarded
37457 because it is aliased to &":blackhole:"& the log line is like this:
37458 .code
37459 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
37460   <hole@nowhere.example> R=blackhole_router
37461 .endd
37462
37463
37464 .section "Deferred deliveries" "SECID254"
37465 When a delivery is deferred, a line of the following form is logged:
37466 .code
37467 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
37468   R=dnslookup T=smtp defer (146): Connection refused
37469 .endd
37470 In the case of remote deliveries, the error is the one that was given for the
37471 last IP address that was tried. Details of individual SMTP failures are also
37472 written to the log, so the above line would be preceded by something like
37473 .code
37474 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
37475   mail1.endrest.example [192.168.239.239]: Connection refused
37476 .endd
37477 When a deferred address is skipped because its retry time has not been reached,
37478 a message is written to the log, but this can be suppressed by setting an
37479 appropriate value in &%log_selector%&.
37480
37481
37482
37483 .section "Delivery failures" "SECID255"
37484 .cindex "delivery" "failure; logging"
37485 If a delivery fails because an address cannot be routed, a line of the
37486 following form is logged:
37487 .code
37488 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
37489   <jim@trek99.example>: unknown mail domain
37490 .endd
37491 If a delivery fails at transport time, the router and transport are shown, and
37492 the response from the remote host is included, as in this example:
37493 .code
37494 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
37495   R=dnslookup T=remote_smtp: SMTP error from remote mailer
37496   after pipelined RCPT TO:<ace400@pb.example>: host
37497   pbmail3.py.example [192.168.63.111]: 553 5.3.0
37498   <ace400@pb.example>...Addressee unknown
37499 .endd
37500 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
37501 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
37502 disabling PIPELINING. The log lines for all forms of delivery failure are
37503 flagged with &`**`&.
37504
37505
37506
37507 .section "Fake deliveries" "SECID256"
37508 .cindex "delivery" "fake; logging"
37509 If a delivery does not actually take place because the &%-N%& option has been
37510 used to suppress it, a normal delivery line is written to the log, except that
37511 &"=>"& is replaced by &"*>"&.
37512
37513
37514
37515 .section "Completion" "SECID257"
37516 A line of the form
37517 .code
37518 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
37519 .endd
37520 is written to the main log when a message is about to be removed from the spool
37521 at the end of its processing.
37522
37523
37524
37525
37526 .section "Summary of Fields in Log Lines" "SECID258"
37527 .cindex "log" "summary of fields"
37528 A summary of the field identifiers that are used in log lines is shown in
37529 the following table:
37530 .display
37531 &`A   `&        authenticator name (and optional id and sender)
37532 &`C   `&        SMTP confirmation on delivery
37533 &`    `&        command list for &"no mail in SMTP session"&
37534 &`CV  `&        certificate verification status
37535 &`D   `&        duration of &"no mail in SMTP session"&
37536 &`DKIM`&        domain verified in incoming message
37537 &`DN  `&        distinguished name from peer certificate
37538 &`DS  `&        DNSSEC secured lookups
37539 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
37540 &`F   `&        sender address (on delivery lines)
37541 &`H   `&        host name and IP address
37542 &`I   `&        local interface used
37543 &`id  `&        message id (from header) for incoming message
37544 &`K   `&        CHUNKING extension used
37545 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37546 &`M8S `&        8BITMIME status for incoming message
37547 &`P   `&        on &`<=`& lines: protocol used
37548 &`    `&        on &`=>`& and &`**`& lines: return path
37549 &`PRDR`&        PRDR extension used
37550 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37551 &`Q   `&        alternate queue name
37552 &`QT  `&        on &`=>`& lines: time spent on queue so far
37553 &`    `&        on &"Completed"& lines: time spent on queue
37554 &`R   `&        on &`<=`& lines: reference for local bounce
37555 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37556 &`RT  `&        on &`<=`& lines: time taken for reception
37557 &`S   `&        size of message in bytes
37558 &`SNI `&        server name indication from TLS client hello
37559 &`ST  `&        shadow transport name
37560 &`T   `&        on &`<=`& lines: message subject (topic)
37561 &`TFO `&        connection took advantage of TCP Fast Open
37562 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37563 &`U   `&        local user or RFC 1413 identity
37564 &`X   `&        TLS cipher suite
37565 .endd
37566
37567
37568 .section "Other log entries" "SECID259"
37569 Various other types of log entry are written from time to time. Most should be
37570 self-explanatory. Among the more common are:
37571
37572 .ilist
37573 .cindex "retry" "time not reached"
37574 &'retry time not reached'&&~&~An address previously suffered a temporary error
37575 during routing or local delivery, and the time to retry has not yet arrived.
37576 This message is not written to an individual message log file unless it happens
37577 during the first delivery attempt.
37578 .next
37579 &'retry time not reached for any host'&&~&~An address previously suffered
37580 temporary errors during remote delivery, and the retry time has not yet arrived
37581 for any of the hosts to which it is routed.
37582 .next
37583 .cindex "spool directory" "file locked"
37584 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37585 some other Exim process is already working on the message. This can be quite
37586 common if queue running processes are started at frequent intervals. The
37587 &'exiwhat'& utility script can be used to find out what Exim processes are
37588 doing.
37589 .next
37590 .cindex "error" "ignored"
37591 &'error ignored'&&~&~There are several circumstances that give rise to this
37592 message:
37593 .olist
37594 Exim failed to deliver a bounce message whose age was greater than
37595 &%ignore_bounce_errors_after%&. The bounce was discarded.
37596 .next
37597 A filter file set up a delivery using the &"noerror"& option, and the delivery
37598 failed. The delivery was discarded.
37599 .next
37600 A delivery set up by a router configured with
37601 . ==== As this is a nested list, any displays it contains must be indented
37602 . ==== as otherwise they are too far to the left.
37603 .code
37604     errors_to = <>
37605 .endd
37606 failed. The delivery was discarded.
37607 .endlist olist
37608 .next
37609 .cindex DKIM "log line"
37610 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37611 logging and the message has a DKIM signature header.
37612 .endlist ilist
37613
37614
37615
37616
37617
37618 .section "Reducing or increasing what is logged" "SECTlogselector"
37619 .cindex "log" "selectors"
37620 By setting the &%log_selector%& global option, you can disable some of Exim's
37621 default logging, or you can request additional logging. The value of
37622 &%log_selector%& is made up of names preceded by plus or minus characters. For
37623 example:
37624 .code
37625 log_selector = +arguments -retry_defer
37626 .endd
37627 The list of optional log items is in the following table, with the default
37628 selection marked by asterisks:
37629 .display
37630 &` 8bitmime                   `&  received 8BITMIME status
37631 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37632 &` address_rewrite            `&  address rewriting
37633 &` all_parents                `&  all parents in => lines
37634 &` arguments                  `&  command line arguments
37635 &`*connection_reject          `&  connection rejections
37636 &`*delay_delivery             `&  immediate delivery delayed
37637 &` deliver_time               `&  time taken to attempt delivery
37638 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37639 &`*dkim                       `&  DKIM verified domain on <= lines
37640 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37641 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37642 &` dnssec                     `&  DNSSEC secured lookups
37643 &`*etrn                       `&  ETRN commands
37644 &`*host_lookup_failed         `&  as it says
37645 &` ident_timeout              `&  timeout for ident connection
37646 &` incoming_interface         `&  local interface on <= and => lines
37647 &` incoming_port              `&  remote port on <= lines
37648 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37649 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37650 &`*msg_id                     `&  on <= lines, Message-ID: header value
37651 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37652 &` outgoing_interface         `&  local interface on => lines
37653 &` outgoing_port              `&  add remote port to => lines
37654 &`*queue_run                  `&  start and end queue runs
37655 &` queue_time                 `&  time on queue for one recipient
37656 &` queue_time_overall         `&  time on queue for whole message
37657 &` pid                        `&  Exim process id
37658 &` pipelining                 `&  PIPELINING use, on <= and => lines
37659 &` proxy                      `&  proxy address on <= and => lines
37660 &` receive_time               `&  time taken to receive message
37661 &` received_recipients        `&  recipients on <= lines
37662 &` received_sender            `&  sender on <= lines
37663 &`*rejected_header            `&  header contents on reject log
37664 &`*retry_defer                `&  &"retry time not reached"&
37665 &` return_path_on_delivery    `&  put return path on => and ** lines
37666 &` sender_on_delivery         `&  add sender to => lines
37667 &`*sender_verify_fail         `&  sender verification failures
37668 &`*size_reject                `&  rejection because too big
37669 &`*skip_delivery              `&  delivery skipped in a queue run
37670 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37671 &` smtp_connection            `&  incoming SMTP connections
37672 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37673 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37674 &` smtp_no_mail               `&  session with no MAIL commands
37675 &` smtp_protocol_error        `&  SMTP protocol errors
37676 &` smtp_syntax_error          `&  SMTP syntax errors
37677 &` subject                    `&  contents of &'Subject:'& on <= lines
37678 &`*tls_certificate_verified   `&  certificate verification status
37679 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37680 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37681 &` tls_sni                    `&  TLS SNI on <= lines
37682 &` unknown_in_list            `&  DNS lookup failed in list match
37683
37684 &` all                        `&  all of the above
37685 .endd
37686 See also the &%slow_lookup_log%& main configuration option,
37687 section &<<SECID99>>&
37688
37689 More details on each of these items follows:
37690
37691 .ilist
37692 .cindex "8BITMIME"
37693 .cindex "log" "8BITMIME"
37694 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37695 which may help in tracking down interoperability issues with ancient MTAs
37696 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37697 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37698 &`7BIT`& and &`8BITMIME`& respectively.
37699 .next
37700 .cindex "&%warn%& ACL verb" "log when skipping"
37701 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37702 its conditions cannot be evaluated, a log line to this effect is written if
37703 this log selector is set.
37704 .next
37705 .cindex "log" "rewriting"
37706 .cindex "rewriting" "logging"
37707 &%address_rewrite%&: This applies both to global rewrites and per-transport
37708 rewrites, but not to rewrites in filters run as an unprivileged user (because
37709 such users cannot access the log).
37710 .next
37711 .cindex "log" "full parentage"
37712 &%all_parents%&: Normally only the original and final addresses are logged on
37713 delivery lines; with this selector, intermediate parents are given in
37714 parentheses between them.
37715 .next
37716 .cindex "log" "Exim arguments"
37717 .cindex "Exim arguments, logging"
37718 &%arguments%&: This causes Exim to write the arguments with which it was called
37719 to the main log, preceded by the current working directory. This is a debugging
37720 feature, added to make it easier to find out how certain MUAs call
37721 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37722 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37723 that are empty or that contain white space are quoted. Non-printing characters
37724 are shown as escape sequences. This facility cannot log unrecognized arguments,
37725 because the arguments are checked before the configuration file is read. The
37726 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37727 between the caller and Exim.
37728 .next
37729 .cindex "log" "connection rejections"
37730 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37731 connection is rejected, for whatever reason.
37732 .next
37733 .cindex "log" "delayed delivery"
37734 .cindex "delayed delivery, logging"
37735 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37736 started for an incoming message because the load is too high or too many
37737 messages were received on one connection. Logging does not occur if no delivery
37738 process is started because &%queue_only%& is set or &%-odq%& was used.
37739 .next
37740 .cindex "log" "delivery duration"
37741 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37742 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37743 If millisecond logging is enabled, short times will be shown with greater
37744 precision, eg. &`DT=0.304s`&.
37745 .next
37746 .cindex "log" "message size on delivery"
37747 .cindex "size" "of message"
37748 &%delivery_size%&: For each delivery, the size of message delivered is added to
37749 the &"=>"& line, tagged with S=.
37750 .next
37751 .cindex log "DKIM verification"
37752 .cindex DKIM "verification logging"
37753 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37754 verifies successfully a tag of DKIM is added, with one of the verified domains.
37755 .next
37756 .cindex log "DKIM verification"
37757 .cindex DKIM "verification logging"
37758 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37759 .next
37760 .cindex "log" "dnslist defer"
37761 .cindex "DNS list" "logging defer"
37762 .cindex "black list (DNS)"
37763 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37764 DNS black list suffers a temporary error.
37765 .next
37766 .cindex log dnssec
37767 .cindex dnssec logging
37768 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37769 dns lookups gave secure results a tag of DS is added.
37770 For acceptance this covers the reverse and forward lookups for host name verification.
37771 It does not cover helo-name verification.
37772 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37773 .next
37774 .cindex "log" "ETRN commands"
37775 .cindex "ETRN" "logging"
37776 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37777 is run to determine whether or not it is actually accepted. An invalid ETRN
37778 command, or one received within a message transaction is not logged by this
37779 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37780 .next
37781 .cindex "log" "host lookup failure"
37782 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37783 any addresses, or when a lookup of an IP address fails to find a host name, a
37784 log line is written. This logging does not apply to direct DNS lookups when
37785 routing email addresses, but it does apply to &"byname"& lookups.
37786 .next
37787 .cindex "log" "ident timeout"
37788 .cindex "RFC 1413" "logging timeout"
37789 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37790 client's ident port times out.
37791 .next
37792 .cindex "log" "incoming interface"
37793 .cindex "log" "local interface"
37794 .cindex "log" "local address and port"
37795 .cindex "TCP/IP" "logging local address and port"
37796 .cindex "interface" "logging"
37797 &%incoming_interface%&: The interface on which a message was received is added
37798 to the &"<="& line as an IP address in square brackets, tagged by I= and
37799 followed by a colon and the port number. The local interface and port are also
37800 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37801 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37802 The latter can be disabled by turning off the &%outgoing_interface%& option.
37803 .next
37804 .cindex log "incoming proxy address"
37805 .cindex proxy "logging proxy address"
37806 .cindex "TCP/IP" "logging proxy address"
37807 &%proxy%&: The internal (closest to the system running Exim) IP address
37808 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37809 on a proxied connection
37810 or the &"=>"& line for a message delivered on a proxied connection.
37811 See &<<SECTproxyInbound>>& for more information.
37812 .next
37813 .cindex "log" "incoming remote port"
37814 .cindex "port" "logging remote"
37815 .cindex "TCP/IP" "logging incoming remote port"
37816 .vindex "&$sender_fullhost$&"
37817 .vindex "&$sender_rcvhost$&"
37818 &%incoming_port%&: The remote port number from which a message was received is
37819 added to log entries and &'Received:'& header lines, following the IP address
37820 in square brackets, and separated from it by a colon. This is implemented by
37821 changing the value that is put in the &$sender_fullhost$& and
37822 &$sender_rcvhost$& variables. Recording the remote port number has become more
37823 important with the widening use of NAT (see RFC 2505).
37824 .next
37825 .cindex "log" "dropped connection"
37826 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37827 connection is unexpectedly dropped.
37828 .next
37829 .cindex "log" "millisecond timestamps"
37830 .cindex millisecond logging
37831 .cindex timestamps "millisecond, in logs"
37832 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37833 appended to the seconds value.
37834 .next
37835 .cindex "log" "message id"
37836 &%msg_id%&: The value of the Message-ID: header.
37837 .next
37838 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37839 This will be either because the message is a bounce, or was submitted locally
37840 (submission mode) without one.
37841 The field identifier will have an asterix appended: &"id*="&.
37842 .next
37843 .cindex "log" "outgoing interface"
37844 .cindex "log" "local interface"
37845 .cindex "log" "local address and port"
37846 .cindex "TCP/IP" "logging local address and port"
37847 .cindex "interface" "logging"
37848 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37849 interface on which a message was sent is added to delivery lines as an I= tag
37850 followed by IP address in square brackets. You can disable this by turning
37851 off the &%outgoing_interface%& option.
37852 .next
37853 .cindex "log" "outgoing remote port"
37854 .cindex "port" "logging outgoing remote"
37855 .cindex "TCP/IP" "logging outgoing remote port"
37856 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37857 containing => tags) following the IP address.
37858 The local port is also added if &%incoming_interface%& and
37859 &%outgoing_interface%& are both enabled.
37860 This option is not included in the default setting, because for most ordinary
37861 configurations, the remote port number is always 25 (the SMTP port), and the
37862 local port is a random ephemeral port.
37863 .next
37864 .cindex "log" "process ids in"
37865 .cindex "pid (process id)" "in log lines"
37866 &%pid%&: The current process id is added to every log line, in square brackets,
37867 immediately after the time and date.
37868 .next
37869 .cindex log pipelining
37870 .cindex pipelining "logging outgoing"
37871 &%pipelining%&: A field is added to delivery and accept
37872 log lines when the ESMTP PIPELINING extension was used.
37873 The field is a single "L".
37874
37875 On accept lines, where PIPELINING was offered but not used by the client,
37876 the field has a minus appended.
37877
37878 .cindex "pipelining" "early connection"
37879 If Exim is built with the SUPPORT_PIPE_CONNECT build option
37880 accept "L" fields have a period appended if the feature was
37881 offered but not used, or an asterisk appended if used.
37882 Delivery "L" fields have an asterisk appended if used.
37883
37884 .next
37885 .cindex "log" "queue run"
37886 .cindex "queue runner" "logging"
37887 &%queue_run%&: The start and end of every queue run are logged.
37888 .next
37889 .cindex "log" "queue time"
37890 &%queue_time%&: The amount of time the message has been in the queue on the
37891 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37892 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37893 includes reception time as well as the delivery time for the current address.
37894 This means that it may be longer than the difference between the arrival and
37895 delivery log line times, because the arrival log line is not written until the
37896 message has been successfully received.
37897 If millisecond logging is enabled, short times will be shown with greater
37898 precision, eg. &`QT=1.578s`&.
37899 .next
37900 &%queue_time_overall%&: The amount of time the message has been in the queue on
37901 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37902 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37903 message, so it includes reception time as well as the total delivery time.
37904 .next
37905 .cindex "log" "receive duration"
37906 &%receive_time%&: For each message, the amount of real time it has taken to
37907 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37908 If millisecond logging is enabled, short times will be shown with greater
37909 precision, eg. &`RT=0.204s`&.
37910 .next
37911 .cindex "log" "recipients"
37912 &%received_recipients%&: The recipients of a message are listed in the main log
37913 as soon as the message is received. The list appears at the end of the log line
37914 that is written when a message is received, preceded by the word &"for"&. The
37915 addresses are listed after they have been qualified, but before any rewriting
37916 has taken place.
37917 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37918 in the list.
37919 .next
37920 .cindex "log" "sender reception"
37921 &%received_sender%&: The unrewritten original sender of a message is added to
37922 the end of the log line that records the message's arrival, after the word
37923 &"from"& (before the recipients if &%received_recipients%& is also set).
37924 .next
37925 .cindex "log" "header lines for rejection"
37926 &%rejected_header%&: If a message's header has been received at the time a
37927 rejection is written to the reject log, the complete header is added to the
37928 log. Header logging can be turned off individually for messages that are
37929 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37930 .next
37931 .cindex "log" "retry defer"
37932 &%retry_defer%&: A log line is written if a delivery is deferred because a
37933 retry time has not yet been reached. However, this &"retry time not reached"&
37934 message is always omitted from individual message logs after the first delivery
37935 attempt.
37936 .next
37937 .cindex "log" "return path"
37938 &%return_path_on_delivery%&: The return path that is being transmitted with
37939 the message is included in delivery and bounce lines, using the tag P=.
37940 This is omitted if no delivery actually happens, for example, if routing fails,
37941 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37942 .next
37943 .cindex "log" "sender on delivery"
37944 &%sender_on_delivery%&: The message's sender address is added to every delivery
37945 and bounce line, tagged by F= (for &"from"&).
37946 This is the original sender that was received with the message; it is not
37947 necessarily the same as the outgoing return path.
37948 .next
37949 .cindex "log" "sender verify failure"
37950 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37951 gives details of a sender verification failure is not written. Log lines for
37952 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37953 detail is lost.
37954 .next
37955 .cindex "log" "size rejection"
37956 &%size_reject%&: A log line is written whenever a message is rejected because
37957 it is too big.
37958 .next
37959 .cindex "log" "frozen messages; skipped"
37960 .cindex "frozen messages" "logging skipping"
37961 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37962 queue run because it is frozen or because another process is already delivering
37963 it.
37964 .cindex "&""spool file is locked""&"
37965 The message that is written is &"spool file is locked"&.
37966 .next
37967 .cindex "log" "smtp confirmation"
37968 .cindex "SMTP" "logging confirmation"
37969 .cindex "LMTP" "logging confirmation"
37970 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37971 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37972 A number of MTAs (including Exim) return an identifying string in this
37973 response.
37974 .next
37975 .cindex "log" "SMTP connections"
37976 .cindex "SMTP" "logging connections"
37977 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37978 established or closed, unless the connection is from a host that matches
37979 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37980 only when the closure is unexpected.) This applies to connections from local
37981 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37982 dropped in the middle of a message, a log line is always written, whether or
37983 not this selector is set, but otherwise nothing is written at the start and end
37984 of connections unless this selector is enabled.
37985
37986 For TCP/IP connections to an Exim daemon, the current number of connections is
37987 included in the log message for each new connection, but note that the count is
37988 reset if the daemon is restarted.
37989 Also, because connections are closed (and the closure is logged) in
37990 subprocesses, the count may not include connections that have been closed but
37991 whose termination the daemon has not yet noticed. Thus, while it is possible to
37992 match up the opening and closing of connections in the log, the value of the
37993 logged counts may not be entirely accurate.
37994 .next
37995 .cindex "log" "SMTP transaction; incomplete"
37996 .cindex "SMTP" "logging incomplete transactions"
37997 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37998 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37999 and the message sender plus any accepted recipients are included in the log
38000 line. This can provide evidence of dictionary attacks.
38001 .next
38002 .cindex "log" "non-MAIL SMTP sessions"
38003 .cindex "MAIL" "logging session without"
38004 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38005 connection terminates without having issued a MAIL command. This includes both
38006 the case when the connection is dropped, and the case when QUIT is used. It
38007 does not include cases where the connection is rejected right at the start (by
38008 an ACL, or because there are too many connections, or whatever). These cases
38009 already have their own log lines.
38010
38011 The log line that is written contains the identity of the client in the usual
38012 way, followed by D= and a time, which records the duration of the connection.
38013 If the connection was authenticated, this fact is logged exactly as it is for
38014 an incoming message, with an A= item. If the connection was encrypted, CV=,
38015 DN=, and X= items may appear as they do for an incoming message, controlled by
38016 the same logging options.
38017
38018 Finally, if any SMTP commands were issued during the connection, a C= item
38019 is added to the line, listing the commands that were used. For example,
38020 .code
38021 C=EHLO,QUIT
38022 .endd
38023 shows that the client issued QUIT straight after EHLO. If there were fewer
38024 than 20 commands, they are all listed. If there were more than 20 commands,
38025 the last 20 are listed, preceded by &"..."&. However, with the default
38026 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38027 have been aborted before 20 non-mail commands are processed.
38028 .next
38029 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38030 colon-separated, is appended to the A= item for a message arrival or delivery
38031 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38032 was accepted or used.
38033 .next
38034 .cindex "log" "SMTP protocol error"
38035 .cindex "SMTP" "logging protocol error"
38036 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38037 encountered. Exim does not have perfect detection of all protocol errors
38038 because of transmission delays and the use of pipelining. If PIPELINING has
38039 been advertised to a client, an Exim server assumes that the client will use
38040 it, and therefore it does not count &"expected"& errors (for example, RCPT
38041 received after rejecting MAIL) as protocol errors.
38042 .next
38043 .cindex "SMTP" "logging syntax errors"
38044 .cindex "SMTP" "syntax errors; logging"
38045 .cindex "SMTP" "unknown command; logging"
38046 .cindex "log" "unknown SMTP command"
38047 .cindex "log" "SMTP syntax error"
38048 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38049 encountered. An unrecognized command is treated as a syntax error. For an
38050 external connection, the host identity is given; for an internal connection
38051 using &%-bs%& the sender identification (normally the calling user) is given.
38052 .next
38053 .cindex "log" "subject"
38054 .cindex "subject, logging"
38055 &%subject%&: The subject of the message is added to the arrival log line,
38056 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38057 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38058 specifies whether characters with values greater than 127 should be logged
38059 unchanged, or whether they should be rendered as escape sequences.
38060 .next
38061 .cindex "log" "certificate verification"
38062 .cindex log DANE
38063 .cindex DANE logging
38064 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38065 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38066 verified
38067 using a CA trust anchor,
38068 &`CA=dane`& if using a DNS trust anchor,
38069 and &`CV=no`& if not.
38070 .next
38071 .cindex "log" "TLS cipher"
38072 .cindex "TLS" "logging cipher"
38073 &%tls_cipher%&: When a message is sent or received over an encrypted
38074 connection, the cipher suite used is added to the log line, preceded by X=.
38075 .next
38076 .cindex "log" "TLS peer DN"
38077 .cindex "TLS" "logging peer DN"
38078 &%tls_peerdn%&: When a message is sent or received over an encrypted
38079 connection, and a certificate is supplied by the remote host, the peer DN is
38080 added to the log line, preceded by DN=.
38081 .next
38082 .cindex "log" "TLS SNI"
38083 .cindex "TLS" "logging SNI"
38084 &%tls_sni%&: When a message is received over an encrypted connection, and
38085 the remote host provided the Server Name Indication extension, the SNI is
38086 added to the log line, preceded by SNI=.
38087 .next
38088 .cindex "log" "DNS failure in list"
38089 &%unknown_in_list%&: This setting causes a log entry to be written when the
38090 result of a list match is failure because a DNS lookup failed.
38091 .endlist
38092
38093
38094 .section "Message log" "SECID260"
38095 .cindex "message" "log file for"
38096 .cindex "log" "message log; description of"
38097 .cindex "&_msglog_& directory"
38098 .oindex "&%preserve_message_logs%&"
38099 In addition to the general log files, Exim writes a log file for each message
38100 that it handles. The names of these per-message logs are the message ids, and
38101 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38102 message log contains copies of the log lines that apply to the message. This
38103 makes it easier to inspect the status of an individual message without having
38104 to search the main log. A message log is deleted when processing of the message
38105 is complete, unless &%preserve_message_logs%& is set, but this should be used
38106 only with great care because they can fill up your disk very quickly.
38107
38108 On a heavily loaded system, it may be desirable to disable the use of
38109 per-message logs, in order to reduce disk I/O. This can be done by setting the
38110 &%message_logs%& option false.
38111 .ecindex IIDloggen
38112
38113
38114
38115
38116 . ////////////////////////////////////////////////////////////////////////////
38117 . ////////////////////////////////////////////////////////////////////////////
38118
38119 .chapter "Exim utilities" "CHAPutils"
38120 .scindex IIDutils "utilities"
38121 A number of utility scripts and programs are supplied with Exim and are
38122 described in this chapter. There is also the Exim Monitor, which is covered in
38123 the next chapter. The utilities described here are:
38124
38125 .itable none 0 0 3  7* left  15* left  40* left
38126 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38127   "list what Exim processes are doing"
38128 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38129 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38130 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38131 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38132                                                 various criteria"
38133 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38134 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38135   "extract statistics from the log"
38136 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38137   "check address acceptance from given IP"
38138 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38139 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38140 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38141 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38142 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38143 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38144 .endtable
38145
38146 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38147 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38148 &url(https://duncanthrax.net/exilog/) for details.
38149
38150
38151
38152
38153 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38154 .cindex "&'exiwhat'&"
38155 .cindex "process, querying"
38156 .cindex "SIGUSR1"
38157 On operating systems that can restart a system call after receiving a signal
38158 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38159 a line describing what it is doing to the file &_exim-process.info_& in the
38160 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38161 processes it can find, having first emptied the file. It then waits for one
38162 second to allow the Exim processes to react before displaying the results. In
38163 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38164 send the signal to the Exim processes, so it is normally run as root.
38165
38166 &*Warning*&: This is not an efficient process. It is intended for occasional
38167 use by system administrators. It is not sensible, for example, to set up a
38168 script that sends SIGUSR1 signals to Exim processes at short intervals.
38169
38170
38171 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38172 varies in different operating systems. Not only are different options used,
38173 but the format of the output is different. For this reason, there are some
38174 system configuration options that configure exactly how &'exiwhat'& works. If
38175 it doesn't seem to be working for you, check the following compile-time
38176 options:
38177 .display
38178 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38179 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38180 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38181 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38182 .endd
38183 An example of typical output from &'exiwhat'& is
38184 .code
38185 164 daemon: -q1h, listening on port 25
38186 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38187 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38188   [10.19.42.42] (editor@ref.example)
38189 10592 handling incoming call from [192.168.243.242]
38190 10628 accepting a local non-SMTP message
38191 .endd
38192 The first number in the output line is the process number. The third line has
38193 been split here, in order to fit it on the page.
38194
38195
38196
38197 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38198 .cindex "&'exiqgrep'&"
38199 .cindex "queue" "grepping"
38200 This utility is a Perl script contributed by Matt Hubbard. It runs
38201 .code
38202 exim -bpu
38203 .endd
38204 or (in case &*-a*& switch is specified)
38205 .code
38206 exim -bp
38207 .endd
38208 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38209 contain alternate exim configuration the queue management might be using.
38210
38211 to obtain a queue listing, and then greps the output to select messages
38212 that match given criteria. The following selection options are available:
38213
38214 .vlist
38215 .vitem &*-f*&&~<&'regex'&>
38216 Match the sender address using a case-insensitive search. The field that is
38217 tested is enclosed in angle brackets, so you can test for bounce messages with
38218 .code
38219 exiqgrep -f '^<>$'
38220 .endd
38221 .vitem &*-r*&&~<&'regex'&>
38222 Match a recipient address using a case-insensitive search. The field that is
38223 tested is not enclosed in angle brackets.
38224
38225 .vitem &*-s*&&~<&'regex'&>
38226 Match against the size field.
38227
38228 .vitem &*-y*&&~<&'seconds'&>
38229 Match messages that are younger than the given time.
38230
38231 .vitem &*-o*&&~<&'seconds'&>
38232 Match messages that are older than the given time.
38233
38234 .vitem &*-z*&
38235 Match only frozen messages.
38236
38237 .vitem &*-x*&
38238 Match only non-frozen messages.
38239
38240 .vitem &*-G*&&~<&'queuename'&>
38241 Match only messages in the given queue.  Without this, the default queue is searched.
38242 .endlist
38243
38244 The following options control the format of the output:
38245
38246 .vlist
38247 .vitem &*-c*&
38248 Display only the count of matching messages.
38249
38250 .vitem &*-l*&
38251 Long format &-- display the full message information as output by Exim. This is
38252 the default.
38253
38254 .vitem &*-i*&
38255 Display message ids only.
38256
38257 .vitem &*-b*&
38258 Brief format &-- one line per message.
38259
38260 .vitem &*-R*&
38261 Display messages in reverse order.
38262
38263 .vitem &*-a*&
38264 Include delivered recipients in queue listing.
38265 .endlist
38266
38267 There is one more option, &%-h%&, which outputs a list of options.
38268
38269
38270
38271 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38272 .cindex "&'exiqsumm'&"
38273 .cindex "queue" "summary"
38274 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38275 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38276 running a command such as
38277 .code
38278 exim -bp | exiqsumm
38279 .endd
38280 The output consists of one line for each domain that has messages waiting for
38281 it, as in the following example:
38282 .code
38283 3   2322   74m   66m  msn.com.example
38284 .endd
38285 Each line lists the number of pending deliveries for a domain, their total
38286 volume, and the length of time that the oldest and the newest messages have
38287 been waiting. Note that the number of pending deliveries is greater than the
38288 number of messages when messages have more than one recipient.
38289
38290 A summary line is output at the end. By default the output is sorted on the
38291 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38292 the output to be sorted by oldest message and by count of messages,
38293 respectively. There are also three options that split the messages for each
38294 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38295 separates frozen messages, and &%-s%& separates messages according to their
38296 sender.
38297
38298 The output of &'exim -bp'& contains the original addresses in the message, so
38299 this also applies to the output from &'exiqsumm'&. No domains from addresses
38300 generated by aliasing or forwarding are included (unless the &%one_time%&
38301 option of the &(redirect)& router has been used to convert them into &"top
38302 level"& addresses).
38303
38304
38305
38306
38307 .section "Extracting specific information from the log (exigrep)" &&&
38308          "SECTextspeinf"
38309 .cindex "&'exigrep'&"
38310 .cindex "log" "extracts; grepping for"
38311 The &'exigrep'& utility is a Perl script that searches one or more main log
38312 files for entries that match a given pattern. When it finds a match, it
38313 extracts all the log entries for the relevant message, not just those that
38314 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38315 given message, or all mail for a given user, or for a given host, for example.
38316 The input files can be in Exim log format or syslog format.
38317 If a matching log line is not associated with a specific message, it is
38318 included in &'exigrep'&'s output without any additional lines. The usage is:
38319 .display
38320 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38321 .endd
38322 If no log filenames are given on the command line, the standard input is read.
38323
38324 The &%-t%& argument specifies a number of seconds. It adds an additional
38325 condition for message selection. Messages that are complete are shown only if
38326 they spent more than <&'n'&> seconds in the queue.
38327
38328 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38329 makes it case-sensitive. This may give a performance improvement when searching
38330 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38331 option; with &%-I%& they do not. In both cases it is possible to change the
38332 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38333
38334 The &%-l%& option means &"literal"&, that is, treat all characters in the
38335 pattern as standing for themselves. Otherwise the pattern must be a Perl
38336 regular expression.
38337
38338 The &%-v%& option inverts the matching condition. That is, a line is selected
38339 if it does &'not'& match the pattern.
38340
38341 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38342 that are generated as a result/response to a message that &'exigrep'& matched
38343 normally.
38344
38345 Example of &%-M%&:
38346 user_a sends a message to user_b, which generates a bounce back to user_b. If
38347 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38348 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38349 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38350 when searching for &"user_a"& will show both messages since the bounce is
38351 &"related"& to or a &"result"& of the first message that was found by the
38352 search term.
38353
38354 If the location of a &'zcat'& command is known from the definition of
38355 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38356 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38357 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38358 autodetection of some well known compression extensions.
38359
38360
38361 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38362 .cindex "&'exipick'&"
38363 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38364 lists messages from the queue according to a variety of criteria. For details
38365 of &'exipick'&'s facilities, run &'exipick'& with
38366 the &%--help%& option.
38367
38368
38369 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38370 .cindex "log" "cycling local files"
38371 .cindex "cycling logs"
38372 .cindex "&'exicyclog'&"
38373 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38374 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38375 you are using log files with datestamps in their names (see section
38376 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38377 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38378 There are two command line options for &'exicyclog'&:
38379 .ilist
38380 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38381 default that is set when Exim is built. The default default is 10.
38382 .next
38383 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38384 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38385 overriding the script's default, which is to find the setting from Exim's
38386 configuration.
38387 .endlist
38388
38389 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38390 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38391 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38392 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38393 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38394 logs are handled similarly.
38395
38396 If the limit is greater than 99, the script uses 3-digit numbers such as
38397 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38398 to one that is greater, or &'vice versa'&, you will have to fix the names of
38399 any existing log files.
38400
38401 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38402 the end are deleted. All files with numbers greater than 01 are compressed,
38403 using a compression command which is configured by the COMPRESS_COMMAND
38404 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38405 root &%crontab%& entry of the form
38406 .code
38407 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38408 .endd
38409 assuming you have used the name &"exim"& for the Exim user. You can run
38410 &'exicyclog'& as root if you wish, but there is no need.
38411
38412
38413
38414 .section "Mail statistics (eximstats)" "SECTmailstat"
38415 .cindex "statistics"
38416 .cindex "&'eximstats'&"
38417 A Perl script called &'eximstats'& is provided for extracting statistical
38418 information from log files. The output is either plain text, or HTML.
38419 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38420 . --- 404 error and everything else points to that.
38421
38422 The &'eximstats'& script has been hacked about quite a bit over time. The
38423 latest version is the result of some extensive revision by Steve Campbell. A
38424 lot of information is given by default, but there are options for suppressing
38425 various parts of it. Following any options, the arguments to the script are a
38426 list of files, which should be main log files. For example:
38427 .code
38428 eximstats -nr /var/spool/exim/log/mainlog.01
38429 .endd
38430 By default, &'eximstats'& extracts information about the number and volume of
38431 messages received from or delivered to various hosts. The information is sorted
38432 both by message count and by volume, and the top fifty hosts in each category
38433 are listed on the standard output. Similar information, based on email
38434 addresses or domains instead of hosts can be requested by means of various
38435 options. For messages delivered and received locally, similar statistics are
38436 also produced per user.
38437
38438 The output also includes total counts and statistics about delivery errors, and
38439 histograms showing the number of messages received and deliveries made in each
38440 hour of the day. A delivery with more than one address in its envelope (for
38441 example, an SMTP transaction with more than one RCPT command) is counted
38442 as a single delivery by &'eximstats'&.
38443
38444 Though normally more deliveries than receipts are reported (as messages may
38445 have multiple recipients), it is possible for &'eximstats'& to report more
38446 messages received than delivered, even though the queue is empty at the start
38447 and end of the period in question. If an incoming message contains no valid
38448 recipients, no deliveries are recorded for it. A bounce message is handled as
38449 an entirely separate message.
38450
38451 &'eximstats'& always outputs a grand total summary giving the volume and number
38452 of messages received and deliveries made, and the number of hosts involved in
38453 each case. It also outputs the number of messages that were delayed (that is,
38454 not completely delivered at the first attempt), and the number that had at
38455 least one address that failed.
38456
38457 The remainder of the output is in sections that can be independently disabled
38458 or modified by various options. It consists of a summary of deliveries by
38459 transport, histograms of messages received and delivered per time interval
38460 (default per hour), information about the time messages spent in the queue,
38461 a list of relayed messages, lists of the top fifty sending hosts, local
38462 senders, destination hosts, and destination local users by count and by volume,
38463 and a list of delivery errors that occurred.
38464
38465 The relay information lists messages that were actually relayed, that is, they
38466 came from a remote host and were directly delivered to some other remote host,
38467 without being processed (for example, for aliasing or forwarding) locally.
38468
38469 There are quite a few options for &'eximstats'& to control exactly what it
38470 outputs. These are documented in the Perl script itself, and can be extracted
38471 by running the command &(perldoc)& on the script. For example:
38472 .code
38473 perldoc /usr/exim/bin/eximstats
38474 .endd
38475
38476 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
38477 .cindex "&'exim_checkaccess'&"
38478 .cindex "policy control" "checking access"
38479 .cindex "checking access"
38480 The &%-bh%& command line argument allows you to run a fake SMTP session with
38481 debugging output, in order to check what Exim is doing when it is applying
38482 policy controls to incoming SMTP mail. However, not everybody is sufficiently
38483 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
38484 sometimes you just want to answer the question &"Does this address have
38485 access?"& without bothering with any further details.
38486
38487 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
38488 two arguments, an IP address and an email address:
38489 .code
38490 exim_checkaccess 10.9.8.7 A.User@a.domain.example
38491 .endd
38492 The utility runs a call to Exim with the &%-bh%& option, to test whether the
38493 given email address would be accepted in a RCPT command in a TCP/IP
38494 connection from the host with the given IP address. The output of the utility
38495 is either the word &"accepted"&, or the SMTP error response, for example:
38496 .code
38497 Rejected:
38498 550 Relay not permitted
38499 .endd
38500 When running this test, the utility uses &`<>`& as the envelope sender address
38501 for the MAIL command, but you can change this by providing additional
38502 options. These are passed directly to the Exim command. For example, to specify
38503 that the test is to be run with the sender address &'himself@there.example'&
38504 you can use:
38505 .code
38506 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
38507                  -f himself@there.example
38508 .endd
38509 Note that these additional Exim command line items must be given after the two
38510 mandatory arguments.
38511
38512 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
38513 while running its checks. You can run checks that include callouts by using
38514 &%-bhc%&, but this is not yet available in a &"packaged"& form.
38515
38516
38517
38518 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
38519 .cindex "DBM" "building dbm files"
38520 .cindex "building DBM files"
38521 .cindex "&'exim_dbmbuild'&"
38522 .cindex "lower casing"
38523 .cindex "binary zero" "in lookup key"
38524 The &'exim_dbmbuild'& program reads an input file containing keys and data in
38525 the format used by the &(lsearch)& lookup (see section
38526 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
38527 names as keys and the remainder of the information as data. The lower-casing
38528 can be prevented by calling the program with the &%-nolc%& option.
38529
38530 A terminating zero is included as part of the key string. This is expected by
38531 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
38532 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
38533 strings or the data strings. The &(dbmnz)& lookup type can be used with such
38534 files.
38535
38536 The program requires two arguments: the name of the input file (which can be a
38537 single hyphen to indicate the standard input), and the name of the output file.
38538 It creates the output under a temporary name, and then renames it if all went
38539 well.
38540
38541 .cindex "USE_DB"
38542 If the native DB interface is in use (USE_DB is set in a compile-time
38543 configuration file &-- this is common in free versions of Unix) the two
38544 filenames must be different, because in this mode the Berkeley DB functions
38545 create a single output file using exactly the name given. For example,
38546 .code
38547 exim_dbmbuild /etc/aliases /etc/aliases.db
38548 .endd
38549 reads the system alias file and creates a DBM version of it in
38550 &_/etc/aliases.db_&.
38551
38552 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38553 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38554 environment, the suffixes are added to the second argument of
38555 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38556 when the Berkeley functions are used in compatibility mode (though this is not
38557 recommended), because in that case it adds a &_.db_& suffix to the filename.
38558
38559 If a duplicate key is encountered, the program outputs a warning, and when it
38560 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38561 option is used. By default, only the first of a set of duplicates is used &--
38562 this makes it compatible with &(lsearch)& lookups. There is an option
38563 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38564 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38565 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38566 return code is 2.
38567
38568
38569
38570
38571 .section "Finding individual retry times (exinext)" "SECTfinindret"
38572 .cindex "retry" "times"
38573 .cindex "&'exinext'&"
38574 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38575 fish specific information out of the retry database. Given a mail domain (or a
38576 complete address), it looks up the hosts for that domain, and outputs any retry
38577 information for the hosts or for the domain. At present, the retry information
38578 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38579 output. For example:
38580 .code
38581 $ exinext piglet@milne.fict.example
38582 kanga.milne.example:192.168.8.1 error 146: Connection refused
38583   first failed: 21-Feb-1996 14:57:34
38584   last tried:   21-Feb-1996 14:57:34
38585   next try at:  21-Feb-1996 15:02:34
38586 roo.milne.example:192.168.8.3 error 146: Connection refused
38587   first failed: 20-Jan-1996 13:12:08
38588   last tried:   21-Feb-1996 11:42:03
38589   next try at:  21-Feb-1996 19:42:03
38590   past final cutoff time
38591 .endd
38592 You can also give &'exinext'& a local part, without a domain, and it
38593 will give any retry information for that local part in your default domain.
38594 A message id can be used to obtain retry information pertaining to a specific
38595 message. This exists only when an attempt to deliver a message to a remote host
38596 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38597 &'exinext'& is not particularly efficient, but then it is not expected to be
38598 run very often.
38599
38600 The &'exinext'& utility calls Exim to find out information such as the location
38601 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38602 passed on to the &'exim'& commands. The first specifies an alternate Exim
38603 configuration file, and the second sets macros for use within the configuration
38604 file. These features are mainly to help in testing, but might also be useful in
38605 environments where more than one configuration file is in use.
38606
38607
38608
38609 .section "Hints database maintenance" "SECThindatmai"
38610 .cindex "hints database" "maintenance"
38611 .cindex "maintaining Exim's hints database"
38612 Three utility programs are provided for maintaining the DBM files that Exim
38613 uses to contain its delivery hint information. Each program requires two
38614 arguments. The first specifies the name of Exim's spool directory, and the
38615 second is the name of the database it is to operate on. These are as follows:
38616
38617 .ilist
38618 &'retry'&: the database of retry information
38619 .next
38620 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38621 for remote hosts
38622 .next
38623 &'callout'&: the callout cache
38624 .next
38625 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38626 .next
38627 &'misc'&: other hints data
38628 .endlist
38629
38630 The &'misc'& database is used for
38631
38632 .ilist
38633 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38634 .next
38635 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38636 &(smtp)& transport)
38637 .next
38638 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38639 in a transport)
38640 .endlist
38641
38642
38643
38644 .section "exim_dumpdb" "SECID261"
38645 .cindex "&'exim_dumpdb'&"
38646 The entire contents of a database are written to the standard output by the
38647 &'exim_dumpdb'& program, which has no options or arguments other than the
38648 spool and database names. For example, to dump the retry database:
38649 .code
38650 exim_dumpdb /var/spool/exim retry
38651 .endd
38652 Two lines of output are produced for each entry:
38653 .code
38654 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38655 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38656 .endd
38657 The first item on the first line is the key of the record. It starts with one
38658 of the letters R, or T, depending on whether it refers to a routing or
38659 transport retry. For a local delivery, the next part is the local address; for
38660 a remote delivery it is the name of the remote host, followed by its failing IP
38661 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38662 transport). If the remote port is not the standard one (port 25), it is added
38663 to the IP address. Then there follows an error code, an additional error code,
38664 and a textual description of the error.
38665
38666 The three times on the second line are the time of first failure, the time of
38667 the last delivery attempt, and the computed time for the next attempt. The line
38668 ends with an asterisk if the cutoff time for the last retry rule has been
38669 exceeded.
38670
38671 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38672 consists of a host name followed by a list of ids for messages that are or were
38673 waiting to be delivered to that host. If there are a very large number for any
38674 one host, continuation records, with a sequence number added to the host name,
38675 may be seen. The data in these records is often out of date, because a message
38676 may be routed to several alternative hosts, and Exim makes no effort to keep
38677 cross-references.
38678
38679
38680
38681 .section "exim_tidydb" "SECID262"
38682 .cindex "&'exim_tidydb'&"
38683 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38684 database. If run with no options, it removes all records that are more than 30
38685 days old. The age is calculated from the date and time that the record was last
38686 updated. Note that, in the case of the retry database, it is &'not'& the time
38687 since the first delivery failure. Information about a host that has been down
38688 for more than 30 days will remain in the database, provided that the record is
38689 updated sufficiently often.
38690
38691 The cutoff date can be altered by means of the &%-t%& option, which must be
38692 followed by a time. For example, to remove all records older than a week from
38693 the retry database:
38694 .code
38695 exim_tidydb -t 7d /var/spool/exim retry
38696 .endd
38697 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38698 message ids. In the former these appear as data in records keyed by host &--
38699 they were messages that were waiting for that host &-- and in the latter they
38700 are the keys for retry information for messages that have suffered certain
38701 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38702 message ids in database records are those of messages that are still on the
38703 queue. Message ids for messages that no longer exist are removed from
38704 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38705 For the &'retry'& database, records whose keys are non-existent message ids are
38706 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38707 whenever it removes information from the database.
38708
38709 Certain records are automatically removed by Exim when they are no longer
38710 needed, but others are not. For example, if all the MX hosts for a domain are
38711 down, a retry record is created for each one. If the primary MX host comes back
38712 first, its record is removed when Exim successfully delivers to it, but the
38713 records for the others remain because Exim has not tried to use those hosts.
38714
38715 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38716 hints databases. You should do this at a quiet time of day, because it requires
38717 a database to be locked (and therefore inaccessible to Exim) while it does its
38718 work. Removing records from a DBM file does not normally make the file smaller,
38719 but all the common DBM libraries are able to re-use the space that is released.
38720 After an initial phase of increasing in size, the databases normally reach a
38721 point at which they no longer get any bigger, as long as they are regularly
38722 tidied.
38723
38724 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38725 databases is likely to keep on increasing.
38726
38727
38728
38729
38730 .section "exim_fixdb" "SECID263"
38731 .cindex "&'exim_fixdb'&"
38732 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38733 Its main use is for testing Exim, but it might also be occasionally useful for
38734 getting round problems in a live system. It has no options, and its interface
38735 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38736 key of a database record can then be entered, and the data for that record is
38737 displayed.
38738
38739 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38740 except the &'retry'& database, that is the only operation that can be carried
38741 out. For the &'retry'& database, each field is output preceded by a number, and
38742 data for individual fields can be changed by typing the field number followed
38743 by new data, for example:
38744 .code
38745 > 4 951102:1000
38746 .endd
38747 resets the time of the next delivery attempt. Time values are given as a
38748 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38749 used as optional separators.
38750
38751
38752
38753
38754 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38755 .cindex "mailbox" "maintenance"
38756 .cindex "&'exim_lock'&"
38757 .cindex "locking mailboxes"
38758 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38759 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38760 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38761 a user agent while investigating a problem. The utility requires the name of
38762 the file as its first argument. If the locking is successful, the second
38763 argument is run as a command (using C's &[system()]& function); if there is no
38764 second argument, the value of the SHELL environment variable is used; if this
38765 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38766 is unlocked and the utility ends. The following options are available:
38767
38768 .vlist
38769 .vitem &%-fcntl%&
38770 Use &[fcntl()]& locking on the open mailbox.
38771
38772 .vitem &%-flock%&
38773 Use &[flock()]& locking on the open mailbox, provided the operating system
38774 supports it.
38775
38776 .vitem &%-interval%&
38777 This must be followed by a number, which is a number of seconds; it sets the
38778 interval to sleep between retries (default 3).
38779
38780 .vitem &%-lockfile%&
38781 Create a lock file before opening the mailbox.
38782
38783 .vitem &%-mbx%&
38784 Lock the mailbox using MBX rules.
38785
38786 .vitem &%-q%&
38787 Suppress verification output.
38788
38789 .vitem &%-retries%&
38790 This must be followed by a number; it sets the number of times to try to get
38791 the lock (default 10).
38792
38793 .vitem &%-restore_time%&
38794 This option causes &%exim_lock%& to restore the modified and read times to the
38795 locked file before exiting. This allows you to access a locked mailbox (for
38796 example, to take a backup copy) without disturbing the times that the user
38797 subsequently sees.
38798
38799 .vitem &%-timeout%&
38800 This must be followed by a number, which is a number of seconds; it sets a
38801 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38802 default), a non-blocking call is used.
38803
38804 .vitem &%-v%&
38805 Generate verbose output.
38806 .endlist
38807
38808 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38809 default is to create a lock file and also to use &[fcntl()]& locking on the
38810 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38811 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38812 requires that the directory containing the file be writeable. Locking by lock
38813 file does not last forever; Exim assumes that a lock file is expired if it is
38814 more than 30 minutes old.
38815
38816 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38817 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38818 to be taken out on the open mailbox, and an exclusive lock on the file
38819 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38820 number of the mailbox file. When the locking is released, if an exclusive lock
38821 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38822
38823 The default output contains verification of the locking that takes place. The
38824 &%-v%& option causes some additional information to be given. The &%-q%& option
38825 suppresses all output except error messages.
38826
38827 A command such as
38828 .code
38829 exim_lock /var/spool/mail/spqr
38830 .endd
38831 runs an interactive shell while the file is locked, whereas
38832 .display
38833 &`exim_lock -q /var/spool/mail/spqr <<End`&
38834 <&'some commands'&>
38835 &`End`&
38836 .endd
38837 runs a specific non-interactive sequence of commands while the file is locked,
38838 suppressing all verification output. A single command can be run by a command
38839 such as
38840 .code
38841 exim_lock -q /var/spool/mail/spqr \
38842   "cp /var/spool/mail/spqr /some/where"
38843 .endd
38844 Note that if a command is supplied, it must be entirely contained within the
38845 second argument &-- hence the quotes.
38846 .ecindex IIDutils
38847
38848
38849 . ////////////////////////////////////////////////////////////////////////////
38850 . ////////////////////////////////////////////////////////////////////////////
38851
38852 .chapter "The Exim monitor" "CHAPeximon"
38853 .scindex IIDeximon "Exim monitor" "description"
38854 .cindex "X-windows"
38855 .cindex "&'eximon'&"
38856 .cindex "Local/eximon.conf"
38857 .cindex "&_exim_monitor/EDITME_&"
38858 The Exim monitor is an application which displays in an X window information
38859 about the state of Exim's queue and what Exim is doing. An admin user can
38860 perform certain operations on messages from this GUI interface; however all
38861 such facilities are also available from the command line, and indeed, the
38862 monitor itself makes use of the command line to perform any actions requested.
38863
38864
38865
38866 .section "Running the monitor" "SECID264"
38867 The monitor is started by running the script called &'eximon'&. This is a shell
38868 script that sets up a number of environment variables, and then runs the
38869 binary called &_eximon.bin_&. The default appearance of the monitor window can
38870 be changed by editing the &_Local/eximon.conf_& file created by editing
38871 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38872 parameters are for.
38873
38874 The parameters that get built into the &'eximon'& script can be overridden for
38875 a particular invocation by setting up environment variables of the same names,
38876 preceded by &`EXIMON_`&. For example, a shell command such as
38877 .code
38878 EXIMON_LOG_DEPTH=400 eximon
38879 .endd
38880 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38881 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38882 overrides the Exim log file configuration. This makes it possible to have
38883 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38884 syslog messages are routed to a file on the local host.
38885
38886 X resources can be used to change the appearance of the window in the normal
38887 way. For example, a resource setting of the form
38888 .code
38889 Eximon*background: gray94
38890 .endd
38891 changes the colour of the background to light grey rather than white. The
38892 stripcharts are drawn with both the data lines and the reference lines in
38893 black. This means that the reference lines are not visible when on top of the
38894 data. However, their colour can be changed by setting a resource called
38895 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38896 For example, if your X server is running Unix, you could set up lighter
38897 reference lines in the stripcharts by obeying
38898 .code
38899 xrdb -merge <<End
38900 Eximon*highlight: gray
38901 End
38902 .endd
38903 .cindex "admin user"
38904 In order to see the contents of messages in the queue, and to operate on them,
38905 &'eximon'& must either be run as root or by an admin user.
38906
38907 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38908 contain X11 resource parameters interpreted by the X11 library.  In addition,
38909 if the first parameter starts with the string "gdb" then it is removed and the
38910 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38911 versioned variants of gdb can be invoked).
38912
38913 The monitor's window is divided into three parts. The first contains one or
38914 more stripcharts and two action buttons, the second contains a &"tail"& of the
38915 main log file, and the third is a display of the queue of messages awaiting
38916 delivery, with two more action buttons. The following sections describe these
38917 different parts of the display.
38918
38919
38920
38921
38922 .section "The stripcharts" "SECID265"
38923 .cindex "stripchart"
38924 The first stripchart is always a count of messages in the queue. Its name can
38925 be configured by setting QUEUE_STRIPCHART_NAME in the
38926 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38927 configuration script by regular expression matches on log file entries, making
38928 it possible to display, for example, counts of messages delivered to certain
38929 hosts or using certain transports. The supplied defaults display counts of
38930 received and delivered messages, and of local and SMTP deliveries. The default
38931 period between stripchart updates is one minute; this can be adjusted by a
38932 parameter in the &_Local/eximon.conf_& file.
38933
38934 The stripchart displays rescale themselves automatically as the value they are
38935 displaying changes. There are always 10 horizontal lines in each chart; the
38936 title string indicates the value of each division when it is greater than one.
38937 For example, &"x2"& means that each division represents a value of 2.
38938
38939 It is also possible to have a stripchart which shows the percentage fullness of
38940 a particular disk partition, which is useful when local deliveries are confined
38941 to a single partition.
38942
38943 .cindex "&%statvfs%& function"
38944 This relies on the availability of the &[statvfs()]& function or equivalent in
38945 the operating system. Most, but not all versions of Unix that support Exim have
38946 this. For this particular stripchart, the top of the chart always represents
38947 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38948 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38949 &_Local/eximon.conf_& file.
38950
38951
38952
38953
38954 .section "Main action buttons" "SECID266"
38955 .cindex "size" "of monitor window"
38956 .cindex "Exim monitor" "window size"
38957 .cindex "window size"
38958 Below the stripcharts there is an action button for quitting the monitor. Next
38959 to this is another button marked &"Size"&. They are placed here so that
38960 shrinking the window to its default minimum size leaves just the queue count
38961 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38962 the window to expand to its maximum size, unless it is already at the maximum,
38963 in which case it is reduced to its minimum.
38964
38965 When expanding to the maximum, if the window cannot be fully seen where it
38966 currently is, it is moved back to where it was the last time it was at full
38967 size. When it is expanding from its minimum size, the old position is
38968 remembered, and next time it is reduced to the minimum it is moved back there.
38969
38970 The idea is that you can keep a reduced window just showing one or two
38971 stripcharts at a convenient place on your screen, easily expand it to show
38972 the full window when required, and just as easily put it back to what it was.
38973 The idea is copied from what the &'twm'& window manager does for its
38974 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38975 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38976
38977 Normally, the monitor starts up with the window at its full size, but it can be
38978 built so that it starts up with the window at its smallest size, by setting
38979 START_SMALL=yes in &_Local/eximon.conf_&.
38980
38981
38982
38983 .section "The log display" "SECID267"
38984 .cindex "log" "tail of; in monitor"
38985 The second section of the window is an area in which a display of the tail of
38986 the main log is maintained.
38987 To save space on the screen, the timestamp on each log line is shortened by
38988 removing the date and, if &%log_timezone%& is set, the timezone.
38989 The log tail is not available when the only destination for logging data is
38990 syslog, unless the syslog lines are routed to a local file whose name is passed
38991 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38992
38993 The log sub-window has a scroll bar at its lefthand side which can be used to
38994 move back to look at earlier text, and the up and down arrow keys also have a
38995 scrolling effect. The amount of log that is kept depends on the setting of
38996 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38997 to use. When this is full, the earlier 50% of data is discarded &-- this is
38998 much more efficient than throwing it away line by line. The sub-window also has
38999 a horizontal scroll bar for accessing the ends of long log lines. This is the
39000 only means of horizontal scrolling; the right and left arrow keys are not
39001 available. Text can be cut from this part of the window using the mouse in the
39002 normal way. The size of this subwindow is controlled by parameters in the
39003 configuration file &_Local/eximon.conf_&.
39004
39005 Searches of the text in the log window can be carried out by means of the ^R
39006 and ^S keystrokes, which default to a reverse and a forward search,
39007 respectively. The search covers only the text that is displayed in the window.
39008 It cannot go further back up the log.
39009
39010 The point from which the search starts is indicated by a caret marker. This is
39011 normally at the end of the text in the window, but can be positioned explicitly
39012 by pointing and clicking with the left mouse button, and is moved automatically
39013 by a successful search. If new text arrives in the window when it is scrolled
39014 back, the caret remains where it is, but if the window is not scrolled back,
39015 the caret is moved to the end of the new text.
39016
39017 Pressing ^R or ^S pops up a window into which the search text can be typed.
39018 There are buttons for selecting forward or reverse searching, for carrying out
39019 the search, and for cancelling. If the &"Search"& button is pressed, the search
39020 happens and the window remains so that further searches can be done. If the
39021 &"Return"& key is pressed, a single search is done and the window is closed. If
39022 ^C is typed the search is cancelled.
39023
39024 The searching facility is implemented using the facilities of the Athena text
39025 widget. By default this pops up a window containing both &"search"& and
39026 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39027 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39028 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39029 provided version of &%TextPop%& when the remaining parts of the text widget
39030 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39031 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39032 on these systems, at the expense of having unwanted items in the search popup
39033 window.
39034
39035
39036
39037 .section "The queue display" "SECID268"
39038 .cindex "queue" "display in monitor"
39039 The bottom section of the monitor window contains a list of all messages that
39040 are in the queue, which includes those currently being received or delivered,
39041 as well as those awaiting delivery. The size of this subwindow is controlled by
39042 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39043 at which it is updated is controlled by another parameter in the same file &--
39044 the default is 5 minutes, since queue scans can be quite expensive. However,
39045 there is an &"Update"& action button just above the display which can be used
39046 to force an update of the queue display at any time.
39047
39048 When a host is down for some time, a lot of pending mail can build up for it,
39049 and this can make it hard to deal with other messages in the queue. To help
39050 with this situation there is a button next to &"Update"& called &"Hide"&. If
39051 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39052 type anything in here and press &"Return"&, the text is added to a chain of
39053 such texts, and if every undelivered address in a message matches at least one
39054 of the texts, the message is not displayed.
39055
39056 If there is an address that does not match any of the texts, all the addresses
39057 are displayed as normal. The matching happens on the ends of addresses so, for
39058 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39059 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39060 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39061 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39062 a hide request is automatically cancelled after one hour.
39063
39064 While the dialogue box is displayed, you can't press any buttons or do anything
39065 else to the monitor window. For this reason, if you want to cut text from the
39066 queue display to use in the dialogue box, you have to do the cutting before
39067 pressing the &"Hide"& button.
39068
39069 The queue display contains, for each unhidden queued message, the length of
39070 time it has been in the queue, the size of the message, the message id, the
39071 message sender, and the first undelivered recipient, all on one line. If it is
39072 a bounce message, the sender is shown as &"<>"&. If there is more than one
39073 recipient to which the message has not yet been delivered, subsequent ones are
39074 listed on additional lines, up to a maximum configured number, following which
39075 an ellipsis is displayed. Recipients that have already received the message are
39076 not shown.
39077
39078 .cindex "frozen messages" "display"
39079 If a message is frozen, an asterisk is displayed at the left-hand side.
39080
39081 The queue display has a vertical scroll bar, and can also be scrolled by means
39082 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39083 The text searching facilities, as described above for the log window, are also
39084 available, but the caret is always moved to the end of the text when the queue
39085 display is updated.
39086
39087
39088
39089 .section "The queue menu" "SECID269"
39090 .cindex "queue" "menu in monitor"
39091 If the &%shift%& key is held down and the left button is clicked when the mouse
39092 pointer is over the text for any message, an action menu pops up, and the first
39093 line of the queue display for the message is highlighted. This does not affect
39094 any selected text.
39095
39096 If you want to use some other event for popping up the menu, you can set the
39097 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39098 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39099 value set in this parameter is a standard X event description. For example, to
39100 run eximon using &%ctrl%& rather than &%shift%& you could use
39101 .code
39102 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39103 .endd
39104 The title of the menu is the message id, and it contains entries which act as
39105 follows:
39106
39107 .ilist
39108 &'message log'&: The contents of the message log for the message are displayed
39109 in a new text window.
39110 .next
39111 &'headers'&: Information from the spool file that contains the envelope
39112 information and headers is displayed in a new text window. See chapter
39113 &<<CHAPspool>>& for a description of the format of spool files.
39114 .next
39115 &'body'&: The contents of the spool file containing the body of the message are
39116 displayed in a new text window. There is a default limit of 20,000 bytes to the
39117 amount of data displayed. This can be changed by setting the BODY_MAX
39118 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39119 .next
39120 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39121 delivery of the message. This causes an automatic thaw if the message is
39122 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39123 a new text window. The delivery is run in a separate process, to avoid holding
39124 up the monitor while the delivery proceeds.
39125 .next
39126 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39127 that the message be frozen.
39128 .next
39129 .cindex "thawing messages"
39130 .cindex "unfreezing messages"
39131 .cindex "frozen messages" "thawing"
39132 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39133 that the message be thawed.
39134 .next
39135 .cindex "delivery" "forcing failure"
39136 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39137 that Exim gives up trying to deliver the message. A bounce message is generated
39138 for any remaining undelivered addresses.
39139 .next
39140 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39141 that the message be deleted from the system without generating a bounce
39142 message.
39143 .next
39144 &'add recipient'&: A dialog box is displayed into which a recipient address can
39145 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39146 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39147 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39148 causes a call to Exim to be made using the &%-Mar%& option to request that an
39149 additional recipient be added to the message, unless the entry box is empty, in
39150 which case no action is taken.
39151 .next
39152 &'mark delivered'&: A dialog box is displayed into which a recipient address
39153 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39154 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39155 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39156 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39157 recipient address as already delivered, unless the entry box is empty, in which
39158 case no action is taken.
39159 .next
39160 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39161 mark all recipient addresses as already delivered.
39162 .next
39163 &'edit sender'&: A dialog box is displayed initialized with the current
39164 sender's address. Pressing RETURN causes a call to Exim to be made using the
39165 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39166 in which case no action is taken. If you want to set an empty sender (as in
39167 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39168 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39169 the address is qualified with that domain.
39170 .endlist
39171
39172 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39173 other cases when a call to Exim is made, if there is any output from Exim (in
39174 particular, if the command fails) a window containing the command and the
39175 output is displayed. Otherwise, the results of the action are normally apparent
39176 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39177 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39178 if no output is generated.
39179
39180 The queue display is automatically updated for actions such as freezing and
39181 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39182 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39183 force an update of the display after one of these actions.
39184
39185 In any text window that is displayed as result of a menu action, the normal
39186 cut-and-paste facility is available, and searching can be carried out using ^R
39187 and ^S, as described above for the log tail window.
39188 .ecindex IIDeximon
39189
39190
39191
39192
39193
39194 . ////////////////////////////////////////////////////////////////////////////
39195 . ////////////////////////////////////////////////////////////////////////////
39196
39197 .chapter "Security considerations" "CHAPsecurity"
39198 .scindex IIDsecurcon "security" "discussion of"
39199 This chapter discusses a number of issues concerned with security, some of
39200 which are also covered in other parts of this manual.
39201
39202 For reasons that this author does not understand, some people have promoted
39203 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39204 existence of this chapter in the documentation. However, the intent of the
39205 chapter is simply to describe the way Exim works in relation to certain
39206 security concerns, not to make any specific claims about the effectiveness of
39207 its security as compared with other MTAs.
39208
39209 What follows is a description of the way Exim is supposed to be. Best efforts
39210 have been made to try to ensure that the code agrees with the theory, but an
39211 absence of bugs can never be guaranteed. Any that are reported will get fixed
39212 as soon as possible.
39213
39214
39215 .section "Building a more &""hardened""& Exim" "SECID286"
39216 .cindex "security" "build-time features"
39217 There are a number of build-time options that can be set in &_Local/Makefile_&
39218 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39219 Exim administrator who does not have the root password, or by someone who has
39220 penetrated the Exim (but not the root) account. These options are as follows:
39221
39222 .ilist
39223 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39224 start of any filenames used with the &%-C%& option. When it is set, these
39225 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39226 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39227 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39228 default setting for &%ALT_CONFIG_PREFIX%&.
39229
39230 If the permitted configuration files are confined to a directory to
39231 which only root has access, this guards against someone who has broken
39232 into the Exim account from running a privileged Exim with an arbitrary
39233 configuration file, and using it to break into other accounts.
39234 .next
39235
39236 If a non-trusted configuration file (i.e. not the default configuration file
39237 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39238 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39239 the next item), then root privilege is retained only if the caller of Exim is
39240 root. This locks out the possibility of testing a configuration using &%-C%&
39241 right through message reception and delivery, even if the caller is root. The
39242 reception works, but by that time, Exim is running as the Exim user, so when
39243 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39244 privilege to be lost. However, root can test reception and delivery using two
39245 separate commands.
39246
39247 .next
39248 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39249 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39250 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39251 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39252 the restrictive side.  Requiring build-time selection of safe macros is onerous
39253 but this option is intended solely as a transition mechanism to permit
39254 previously-working configurations to continue to work after release 4.73.
39255 .next
39256 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39257 is disabled.
39258 .next
39259 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39260 never to be used for any deliveries. This is like the &%never_users%& runtime
39261 option, but it cannot be overridden; the runtime option adds additional users
39262 to the list. The default setting is &"root"&; this prevents a non-root user who
39263 is permitted to modify the runtime file from using Exim as a way to get root.
39264 .endlist
39265
39266
39267
39268 .section "Root privilege" "SECID270"
39269 .cindex "setuid"
39270 .cindex "root privilege"
39271 The Exim binary is normally setuid to root, which means that it gains root
39272 privilege (runs as root) when it starts execution. In some special cases (for
39273 example, when the daemon is not in use and there are no local deliveries), it
39274 may be possible to run Exim setuid to some user other than root. This is
39275 discussed in the next section. However, in most installations, root privilege
39276 is required for two things:
39277
39278 .ilist
39279 To set up a socket connected to the standard SMTP port (25) when initialising
39280 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39281 not required.
39282 .next
39283 To be able to change uid and gid in order to read users' &_.forward_& files and
39284 perform local deliveries as the receiving user or as specified in the
39285 configuration.
39286 .endlist
39287
39288 It is not necessary to be root to do any of the other things Exim does, such as
39289 receiving messages and delivering them externally over SMTP, and it is
39290 obviously more secure if Exim does not run as root except when necessary.
39291 For this reason, a user and group for Exim to use must be defined in
39292 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39293 group"&. Their values can be changed by the runtime configuration, though this
39294 is not recommended. Often a user called &'exim'& is used, but some sites use
39295 &'mail'& or another user name altogether.
39296
39297 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39298 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39299 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39300
39301 After a new Exim process has interpreted its command line options, it changes
39302 uid and gid in the following cases:
39303
39304 .ilist
39305 .oindex "&%-C%&"
39306 .oindex "&%-D%&"
39307 If the &%-C%& option is used to specify an alternate configuration file, or if
39308 the &%-D%& option is used to define macro values for the configuration, and the
39309 calling process is not running as root, the uid and gid are changed to those of
39310 the calling process.
39311 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39312 option may not be used at all.
39313 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39314 can be supplied if the calling process is running as root, the Exim run-time
39315 user or CONFIGURE_OWNER, if defined.
39316 .next
39317 .oindex "&%-be%&"
39318 .oindex "&%-bf%&"
39319 .oindex "&%-bF%&"
39320 If the expansion test option (&%-be%&) or one of the filter testing options
39321 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39322 calling process.
39323 .next
39324 If the process is not a daemon process or a queue runner process or a delivery
39325 process or a process for testing address routing (started with &%-bt%&), the
39326 uid and gid are changed to the Exim user and group. This means that Exim always
39327 runs under its own uid and gid when receiving messages. This also applies when
39328 testing address verification
39329 .oindex "&%-bv%&"
39330 .oindex "&%-bh%&"
39331 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39332 option).
39333 .next
39334 For a daemon, queue runner, delivery, or address testing process, the uid
39335 remains as root at this stage, but the gid is changed to the Exim group.
39336 .endlist
39337
39338 The processes that initially retain root privilege behave as follows:
39339
39340 .ilist
39341 A daemon process changes the gid to the Exim group and the uid to the Exim
39342 user after setting up one or more listening sockets. The &[initgroups()]&
39343 function is called, so that if the Exim user is in any additional groups, they
39344 will be used during message reception.
39345 .next
39346 A queue runner process retains root privilege throughout its execution. Its
39347 job is to fork a controlled sequence of delivery processes.
39348 .next
39349 A delivery process retains root privilege throughout most of its execution,
39350 but any actual deliveries (that is, the transports themselves) are run in
39351 subprocesses which always change to a non-root uid and gid. For local
39352 deliveries this is typically the uid and gid of the owner of the mailbox; for
39353 remote deliveries, the Exim uid and gid are used. Once all the delivery
39354 subprocesses have been run, a delivery process changes to the Exim uid and gid
39355 while doing post-delivery tidying up such as updating the retry database and
39356 generating bounce and warning messages.
39357
39358 While the recipient addresses in a message are being routed, the delivery
39359 process runs as root. However, if a user's filter file has to be processed,
39360 this is done in a subprocess that runs under the individual user's uid and
39361 gid. A system filter is run as root unless &%system_filter_user%& is set.
39362 .next
39363 A process that is testing addresses (the &%-bt%& option) runs as root so that
39364 the routing is done in the same environment as a message delivery.
39365 .endlist
39366
39367
39368
39369
39370 .section "Running Exim without privilege" "SECTrunexiwitpri"
39371 .cindex "privilege, running without"
39372 .cindex "unprivileged running"
39373 .cindex "root privilege" "running without"
39374 Some installations like to run Exim in an unprivileged state for more of its
39375 operation, for added security. Support for this mode of operation is provided
39376 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39377 gid are changed to the Exim user and group at the start of a delivery process
39378 (and also queue runner and address testing processes). This means that address
39379 routing is no longer run as root, and the deliveries themselves cannot change
39380 to any other uid.
39381
39382 .cindex SIGHUP
39383 .cindex "daemon" "restarting"
39384 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39385 that the daemon can still be started in the usual way, and it can respond
39386 correctly to SIGHUP because the re-invocation regains root privilege.
39387
39388 An alternative approach is to make Exim setuid to the Exim user and also setgid
39389 to the Exim group. If you do this, the daemon must be started from a root
39390 process. (Calling Exim from a root process makes it behave in the way it does
39391 when it is setuid root.) However, the daemon cannot restart itself after a
39392 SIGHUP signal because it cannot regain privilege.
39393
39394 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39395 stops Exim from trying to re-invoke itself to do a delivery after a message has
39396 been received. Such a re-invocation is a waste of resources because it has no
39397 effect.
39398
39399 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39400 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39401 to the Exim user seems a clean approach, but there is one complication:
39402
39403 In this style of operation, Exim is running with the real uid and gid set to
39404 those of the calling process, and the effective uid/gid set to Exim's values.
39405 Ideally, any association with the calling process' uid/gid should be dropped,
39406 that is, the real uid/gid should be reset to the effective values so as to
39407 discard any privileges that the caller may have. While some operating systems
39408 have a function that permits this action for a non-root effective uid, quite a
39409 number of them do not. Because of this lack of standardization, Exim does not
39410 address this problem at this time.
39411
39412 For this reason, the recommended approach for &"mostly unprivileged"& running
39413 is to keep the Exim binary setuid to root, and to set
39414 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39415 be used in the most straightforward way.
39416
39417 If you configure Exim not to run delivery processes as root, there are a
39418 number of restrictions on what you can do:
39419
39420 .ilist
39421 You can deliver only as the Exim user/group. You should  explicitly use the
39422 &%user%& and &%group%& options to override routers or local transports that
39423 normally deliver as the recipient. This makes sure that configurations that
39424 work in this mode function the same way in normal mode. Any implicit or
39425 explicit specification of another user causes an error.
39426 .next
39427 Use of &_.forward_& files is severely restricted, such that it is usually
39428 not worthwhile to include them in the configuration.
39429 .next
39430 Users who wish to use &_.forward_& would have to make their home directory and
39431 the file itself accessible to the Exim user. Pipe and append-to-file entries,
39432 and their equivalents in Exim filters, cannot be used. While they could be
39433 enabled in the Exim user's name, that would be insecure and not very useful.
39434 .next
39435 Unless the local user mailboxes are all owned by the Exim user (possible in
39436 some POP3 or IMAP-only environments):
39437
39438 .olist
39439 They must be owned by the Exim group and be writeable by that group. This
39440 implies you must set &%mode%& in the appendfile configuration, as well as the
39441 mode of the mailbox files themselves.
39442 .next
39443 You must set &%no_check_owner%&, since most or all of the files will not be
39444 owned by the Exim user.
39445 .next
39446 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
39447 on a newly created mailbox when unprivileged. This also implies that new
39448 mailboxes need to be created manually.
39449 .endlist olist
39450 .endlist ilist
39451
39452
39453 These restrictions severely restrict what can be done in local deliveries.
39454 However, there are no restrictions on remote deliveries. If you are running a
39455 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
39456 gives more security at essentially no cost.
39457
39458 If you are using the &%mua_wrapper%& facility (see chapter
39459 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
39460
39461
39462
39463
39464 .section "Delivering to local files" "SECID271"
39465 Full details of the checks applied by &(appendfile)& before it writes to a file
39466 are given in chapter &<<CHAPappendfile>>&.
39467
39468
39469
39470 .section "Running local commands" "SECTsecconslocalcmds"
39471 .cindex "security" "local commands"
39472 .cindex "security" "command injection attacks"
39473 There are a number of ways in which an administrator can configure Exim to run
39474 commands based upon received, untrustworthy, data. Further, in some
39475 configurations a user who can control a &_.forward_& file can also arrange to
39476 run commands. Configuration to check includes, but is not limited to:
39477
39478 .ilist
39479 Use of &%use_shell%& in the pipe transport: various forms of shell command
39480 injection may be possible with this option present. It is dangerous and should
39481 be used only with considerable caution. Consider constraints which whitelist
39482 allowed characters in a variable which is to be used in a pipe transport that
39483 has &%use_shell%& enabled.
39484 .next
39485 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
39486 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
39487 &_.forward_& files in a redirect router. If Exim is running on a central mail
39488 hub to which ordinary users do not have shell access, but home directories are
39489 NFS mounted (for instance) then administrators should review the list of these
39490 forbid options available, and should bear in mind that the options that may
39491 need forbidding can change as new features are added between releases.
39492 .next
39493 The &%${run...}%& expansion item does not use a shell by default, but
39494 administrators can configure use of &_/bin/sh_& as part of the command.
39495 Such invocations should be viewed with prejudicial suspicion.
39496 .next
39497 Administrators who use embedded Perl are advised to explore how Perl's
39498 taint checking might apply to their usage.
39499 .next
39500 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
39501 administrators are well advised to view its use with suspicion, in case (for
39502 instance) it allows a local-part to contain embedded Exim directives.
39503 .next
39504 Use of &%${match_local_part...}%& and friends becomes more dangerous if
39505 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
39506 each can reference arbitrary lists and files, rather than just being a list
39507 of opaque strings.
39508 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
39509 real-world security vulnerabilities caused by its use with untrustworthy data
39510 injected in, for SQL injection attacks.
39511 Consider the use of the &%inlisti%& expansion condition instead.
39512 .endlist
39513
39514
39515
39516
39517 .section "Trust in configuration data" "SECTsecconfdata"
39518 .cindex "security" "data sources"
39519 .cindex "security" "regular expressions"
39520 .cindex "regular expressions" "security"
39521 .cindex "PCRE" "security"
39522 If configuration data for Exim can come from untrustworthy sources, there
39523 are some issues to be aware of:
39524
39525 .ilist
39526 Use of &%${expand...}%& may provide a path for shell injection attacks.
39527 .next
39528 Letting untrusted data provide a regular expression is unwise.
39529 .next
39530 Using &%${match...}%& to apply a fixed regular expression against untrusted
39531 data may result in pathological behaviour within PCRE.  Be aware of what
39532 "backtracking" means and consider options for being more strict with a regular
39533 expression. Avenues to explore include limiting what can match (avoiding &`.`&
39534 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
39535 possessive quantifiers or just not using regular expressions against untrusted
39536 data.
39537 .next
39538 It can be important to correctly use &%${quote:...}%&,
39539 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
39540 items to ensure that data is correctly constructed.
39541 .next
39542 Some lookups might return multiple results, even though normal usage is only
39543 expected to yield one result.
39544 .endlist
39545
39546
39547
39548
39549 .section "IPv4 source routing" "SECID272"
39550 .cindex "source routing" "in IP packets"
39551 .cindex "IP source routing"
39552 Many operating systems suppress IP source-routed packets in the kernel, but
39553 some cannot be made to do this, so Exim does its own check. It logs incoming
39554 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39555 IPv6. No special checking is currently done.
39556
39557
39558
39559 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39560 Support for these SMTP commands is disabled by default. If required, they can
39561 be enabled by defining suitable ACLs.
39562
39563
39564
39565
39566 .section "Privileged users" "SECID274"
39567 .cindex "trusted users"
39568 .cindex "admin user"
39569 .cindex "privileged user"
39570 .cindex "user" "trusted"
39571 .cindex "user" "admin"
39572 Exim recognizes two sets of users with special privileges. Trusted users are
39573 able to submit new messages to Exim locally, but supply their own sender
39574 addresses and information about a sending host. For other users submitting
39575 local messages, Exim sets up the sender address from the uid, and doesn't
39576 permit a remote host to be specified.
39577
39578 .oindex "&%-f%&"
39579 However, an untrusted user is permitted to use the &%-f%& command line option
39580 in the special form &%-f <>%& to indicate that a delivery failure for the
39581 message should not cause an error report. This affects the message's envelope,
39582 but it does not affect the &'Sender:'& header. Untrusted users may also be
39583 permitted to use specific forms of address with the &%-f%& option by setting
39584 the &%untrusted_set_sender%& option.
39585
39586 Trusted users are used to run processes that receive mail messages from some
39587 other mail domain and pass them on to Exim for delivery either locally, or over
39588 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39589 as any user listed in the &%trusted_users%& configuration option, or under any
39590 group listed in the &%trusted_groups%& option.
39591
39592 Admin users are permitted to do things to the messages on Exim's queue. They
39593 can freeze or thaw messages, cause them to be returned to their senders, remove
39594 them entirely, or modify them in various ways. In addition, admin users can run
39595 the Exim monitor and see all the information it is capable of providing, which
39596 includes the contents of files on the spool.
39597
39598 .oindex "&%-M%&"
39599 .oindex "&%-q%&"
39600 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39601 delivery of messages on its queue is restricted to admin users. This
39602 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39603 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39604 queue is also restricted to admin users. This restriction can be relaxed by
39605 setting &%no_queue_list_requires_admin%&.
39606
39607 Exim recognizes an admin user if the calling process is running as root or as
39608 the Exim user or if any of the groups associated with the calling process is
39609 the Exim group. It is not necessary actually to be running under the Exim
39610 group. However, if admin users who are not root or the Exim user are to access
39611 the contents of files on the spool via the Exim monitor (which runs
39612 unprivileged), Exim must be built to allow group read access to its spool
39613 files.
39614
39615 By default, regular users are trusted to perform basic testing and
39616 introspection commands, as themselves.  This setting can be tightened by
39617 setting the &%commandline_checks_require_admin%& option.
39618 This affects most of the checking options,
39619 such as &%-be%& and anything else &%-b*%&.
39620
39621
39622 .section "Spool files" "SECID275"
39623 .cindex "spool directory" "files"
39624 Exim's spool directory and everything it contains is owned by the Exim user and
39625 set to the Exim group. The mode for spool files is defined in the
39626 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39627 any user who is a member of the Exim group can access these files.
39628
39629
39630
39631 .section "Use of argv[0]" "SECID276"
39632 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39633 of specific strings, Exim assumes certain options. For example, calling Exim
39634 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39635 to calling it with the option &%-bS%&. There are no security implications in
39636 this.
39637
39638
39639
39640 .section "Use of %f formatting" "SECID277"
39641 The only use made of &"%f"& by Exim is in formatting load average values. These
39642 are actually stored in integer variables as 1000 times the load average.
39643 Consequently, their range is limited and so therefore is the length of the
39644 converted output.
39645
39646
39647
39648 .section "Embedded Exim path" "SECID278"
39649 Exim uses its own path name, which is embedded in the code, only when it needs
39650 to re-exec in order to regain root privilege. Therefore, it is not root when it
39651 does so. If some bug allowed the path to get overwritten, it would lead to an
39652 arbitrary program's being run as exim, not as root.
39653
39654
39655
39656 .section "Dynamic module directory" "SECTdynmoddir"
39657 Any dynamically loadable modules must be installed into the directory
39658 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39659 loading it.
39660
39661
39662 .section "Use of sprintf()" "SECID279"
39663 .cindex "&[sprintf()]&"
39664 A large number of occurrences of &"sprintf"& in the code are actually calls to
39665 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39666 The intermediate formatting is done into a large fixed buffer by a function
39667 that runs through the format string itself, and checks the length of each
39668 conversion before performing it, thus preventing buffer overruns.
39669
39670 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39671 the output buffer is known to be sufficiently long to contain the converted
39672 string.
39673
39674
39675
39676 .section "Use of debug_printf() and log_write()" "SECID280"
39677 Arbitrary strings are passed to both these functions, but they do their
39678 formatting by calling the function &'string_vformat()'&, which runs through
39679 the format string itself, and checks the length of each conversion.
39680
39681
39682
39683 .section "Use of strcat() and strcpy()" "SECID281"
39684 These are used only in cases where the output buffer is known to be large
39685 enough to hold the result.
39686 .ecindex IIDsecurcon
39687
39688
39689
39690
39691 . ////////////////////////////////////////////////////////////////////////////
39692 . ////////////////////////////////////////////////////////////////////////////
39693
39694 .chapter "Format of spool files" "CHAPspool"
39695 .scindex IIDforspo1 "format" "spool files"
39696 .scindex IIDforspo2 "spool directory" "format of files"
39697 .scindex IIDforspo3 "spool files" "format of"
39698 .cindex "spool files" "editing"
39699 A message on Exim's queue consists of two files, whose names are the message id
39700 followed by -D and -H, respectively. The data portion of the message is kept in
39701 the -D file on its own. The message's envelope, status, and headers are all
39702 kept in the -H file, whose format is described in this chapter. Each of these
39703 two files contains the final component of its own name as its first line. This
39704 is insurance against disk crashes where the directory is lost but the files
39705 themselves are recoverable.
39706
39707 The file formats may be changed, or new formats added, at any release.
39708 Spool files are not intended as an interface to other programs
39709 and should not be used as such.
39710
39711 Some people are tempted into editing -D files in order to modify messages. You
39712 need to be extremely careful if you do this; it is not recommended and you are
39713 on your own if you do it. Here are some of the pitfalls:
39714
39715 .ilist
39716 You must ensure that Exim does not try to deliver the message while you are
39717 fiddling with it. The safest way is to take out a write lock on the -D file,
39718 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39719 place, the lock will be retained. If you write a new file and rename it, the
39720 lock will be lost at the instant of rename.
39721 .next
39722 .vindex "&$body_linecount$&"
39723 If you change the number of lines in the file, the value of
39724 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39725 cause incomplete transmission of messages or undeliverable messages.
39726 .next
39727 If the message is in MIME format, you must take care not to break it.
39728 .next
39729 If the message is cryptographically signed, any change will invalidate the
39730 signature.
39731 .endlist
39732 All in all, modifying -D files is fraught with danger.
39733
39734 Files whose names end with -J may also be seen in the &_input_& directory (or
39735 its subdirectories when &%split_spool_directory%& is set). These are journal
39736 files, used to record addresses to which the message has been delivered during
39737 the course of a delivery attempt. If there are still undelivered recipients at
39738 the end, the -H file is updated, and the -J file is deleted. If, however, there
39739 is some kind of crash (for example, a power outage) before this happens, the -J
39740 file remains in existence. When Exim next processes the message, it notices the
39741 -J file and uses it to update the -H file before starting the next delivery
39742 attempt.
39743
39744 Files whose names end with -K or .eml may also be seen in the spool.
39745 These are temporaries used for DKIM or malware processing, when that is used.
39746 They should be tidied up by normal operations; any old ones are probably
39747 relics of crashes and can be removed.
39748
39749 .section "Format of the -H file" "SECID282"
39750 .cindex "uid (user id)" "in spool file"
39751 .cindex "gid (group id)" "in spool file"
39752 The second line of the -H file contains the login name for the uid of the
39753 process that called Exim to read the message, followed by the numerical uid and
39754 gid. For a locally generated message, this is normally the user who sent the
39755 message. For a message received over TCP/IP via the daemon, it is
39756 normally the Exim user.
39757
39758 The third line of the file contains the address of the message's sender as
39759 transmitted in the envelope, contained in angle brackets. The sender address is
39760 empty for bounce messages. For incoming SMTP mail, the sender address is given
39761 in the MAIL command. For locally generated mail, the sender address is
39762 created by Exim from the login name of the current user and the configured
39763 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39764 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39765 &"<>"& or an address that matches &%untrusted_set_senders%&.
39766
39767 The fourth line contains two numbers. The first is the time that the message
39768 was received, in the conventional Unix form &-- the number of seconds since the
39769 start of the epoch. The second number is a count of the number of messages
39770 warning of delayed delivery that have been sent to the sender.
39771
39772 There follow a number of lines starting with a hyphen. These can appear in any
39773 order, and are omitted when not relevant:
39774
39775 .vlist
39776 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39777 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39778 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39779 recognized, to provide backward compatibility. In the old format, a line of
39780 this form is present for every ACL variable that is not empty. The number
39781 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39782 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39783 the data string for the variable. The string itself starts at the beginning of
39784 the next line, and is followed by a newline character. It may contain internal
39785 newlines.
39786
39787 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39788 A line of this form is present for every ACL connection variable that is
39789 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39790 The length is the length of the data string for the variable. The string itself
39791 starts at the beginning of the next line, and is followed by a newline
39792 character. It may contain internal newlines.
39793
39794 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39795 A line of this form is present for every ACL message variable that is defined.
39796 Note that there is a space between &%-aclm%& and the rest of the name. The
39797 length is the length of the data string for the variable. The string itself
39798 starts at the beginning of the next line, and is followed by a newline
39799 character. It may contain internal newlines.
39800
39801 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39802 This is present if, when the message was received over SMTP, the value of
39803 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39804
39805 .vitem &%-allow_unqualified_recipient%&
39806 This is present if unqualified recipient addresses are permitted in header
39807 lines (to stop such addresses from being qualified if rewriting occurs at
39808 transport time). Local messages that were input using &%-bnq%& and remote
39809 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39810
39811 .vitem &%-allow_unqualified_sender%&
39812 This is present if unqualified sender addresses are permitted in header lines
39813 (to stop such addresses from being qualified if rewriting occurs at transport
39814 time). Local messages that were input using &%-bnq%& and remote messages from
39815 hosts that match &%sender_unqualified_hosts%& set this flag.
39816
39817 .vitem "&%-auth_id%&&~<&'text'&>"
39818 The id information for a message received on an authenticated SMTP connection
39819 &-- the value of the &$authenticated_id$& variable.
39820
39821 .vitem "&%-auth_sender%&&~<&'address'&>"
39822 The address of an authenticated sender &-- the value of the
39823 &$authenticated_sender$& variable.
39824
39825 .vitem "&%-body_linecount%&&~<&'number'&>"
39826 This records the number of lines in the body of the message, and is
39827 present unless &%-spool_file_wireformat%& is.
39828
39829 .vitem "&%-body_zerocount%&&~<&'number'&>"
39830 This records the number of binary zero bytes in the body of the message, and is
39831 present if the number is greater than zero.
39832
39833 .vitem &%-deliver_firsttime%&
39834 This is written when a new message is first added to the spool. When the spool
39835 file is updated after a deferral, it is omitted.
39836
39837 .vitem "&%-frozen%&&~<&'time'&>"
39838 .cindex "frozen messages" "spool data"
39839 The message is frozen, and the freezing happened at <&'time'&>.
39840
39841 .vitem "&%-helo_name%&&~<&'text'&>"
39842 This records the host name as specified by a remote host in a HELO or EHLO
39843 command.
39844
39845 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39846 This records the IP address of the host from which the message was received and
39847 the remote port number that was used. It is omitted for locally generated
39848 messages.
39849
39850 .vitem "&%-host_auth%&&~<&'text'&>"
39851 If the message was received on an authenticated SMTP connection, this records
39852 the name of the authenticator &-- the value of the
39853 &$sender_host_authenticated$& variable.
39854
39855 .vitem &%-host_lookup_failed%&
39856 This is present if an attempt to look up the sending host's name from its IP
39857 address failed. It corresponds to the &$host_lookup_failed$& variable.
39858
39859 .vitem "&%-host_name%&&~<&'text'&>"
39860 .cindex "reverse DNS lookup"
39861 .cindex "DNS" "reverse lookup"
39862 This records the name of the remote host from which the message was received,
39863 if the host name was looked up from the IP address when the message was being
39864 received. It is not present if no reverse lookup was done.
39865
39866 .vitem "&%-ident%&&~<&'text'&>"
39867 For locally submitted messages, this records the login of the originating user,
39868 unless it was a trusted user and the &%-oMt%& option was used to specify an
39869 ident value. For messages received over TCP/IP, this records the ident string
39870 supplied by the remote host, if any.
39871
39872 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39873 This records the IP address of the local interface and the port number through
39874 which a message was received from a remote host. It is omitted for locally
39875 generated messages.
39876
39877 .vitem &%-local%&
39878 The message is from a local sender.
39879
39880 .vitem &%-localerror%&
39881 The message is a locally-generated bounce message.
39882
39883 .vitem "&%-local_scan%&&~<&'string'&>"
39884 This records the data string that was returned by the &[local_scan()]& function
39885 when the message was received &-- the value of the &$local_scan_data$&
39886 variable. It is omitted if no data was returned.
39887
39888 .vitem &%-manual_thaw%&
39889 The message was frozen but has been thawed manually, that is, by an explicit
39890 Exim command rather than via the auto-thaw process.
39891
39892 .vitem &%-N%&
39893 A testing delivery process was started using the &%-N%& option to suppress any
39894 actual deliveries, but delivery was deferred. At any further delivery attempts,
39895 &%-N%& is assumed.
39896
39897 .vitem &%-received_protocol%&
39898 This records the value of the &$received_protocol$& variable, which contains
39899 the name of the protocol by which the message was received.
39900
39901 .vitem &%-sender_set_untrusted%&
39902 The envelope sender of this message was set by an untrusted local caller (used
39903 to ensure that the caller is displayed in queue listings).
39904
39905 .vitem "&%-spam_score_int%&&~<&'number'&>"
39906 If a message was scanned by SpamAssassin, this is present. It records the value
39907 of &$spam_score_int$&.
39908
39909 .vitem &%-spool_file_wireformat%&
39910 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39911 rather than Unix-format.
39912 The line-ending is CRLF rather than newline.
39913 There is still, however, no leading-dot-stuffing.
39914
39915 .vitem &%-tls_certificate_verified%&
39916 A TLS certificate was received from the client that sent this message, and the
39917 certificate was verified by the server.
39918
39919 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39920 When the message was received over an encrypted connection, this records the
39921 name of the cipher suite that was used.
39922
39923 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39924 When the message was received over an encrypted connection, and a certificate
39925 was received from the client, this records the Distinguished Name from that
39926 certificate.
39927 .endlist
39928
39929 Any of the above may have an extra hyphen prepended, to indicate the the
39930 corresponding data is untrusted.
39931
39932 Following the options there is a list of those addresses to which the message
39933 is not to be delivered. This set of addresses is initialized from the command
39934 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39935 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39936 the address is added to this set. The addresses are kept internally as a
39937 balanced binary tree, and it is a representation of that tree which is written
39938 to the spool file. If an address is expanded via an alias or forward file, the
39939 original address is added to the tree when deliveries to all its child
39940 addresses are complete.
39941
39942 If the tree is empty, there is a single line in the spool file containing just
39943 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39944 Y or N, followed by an address. The address is the value for the node of the
39945 tree, and the letters indicate whether the node has a left branch and/or a
39946 right branch attached to it, respectively. If branches exist, they immediately
39947 follow. Here is an example of a three-node tree:
39948 .code
39949 YY darcy@austen.fict.example
39950 NN alice@wonderland.fict.example
39951 NN editor@thesaurus.ref.example
39952 .endd
39953 After the non-recipients tree, there is a list of the message's recipients.
39954 This is a simple list, preceded by a count. It includes all the original
39955 recipients of the message, including those to whom the message has already been
39956 delivered. In the simplest case, the list contains one address per line. For
39957 example:
39958 .code
39959 4
39960 editor@thesaurus.ref.example
39961 darcy@austen.fict.example
39962 rdo@foundation
39963 alice@wonderland.fict.example
39964 .endd
39965 However, when a child address has been added to the top-level addresses as a
39966 result of the use of the &%one_time%& option on a &(redirect)& router, each
39967 line is of the following form:
39968 .display
39969 <&'top-level address'&> <&'errors_to address'&> &&&
39970   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39971 .endd
39972 The 01 flag bit indicates the presence of the three other fields that follow
39973 the top-level address. Other bits may be used in future to support additional
39974 fields. The <&'parent number'&> is the offset in the recipients list of the
39975 original parent of the &"one time"& address. The first two fields are the
39976 envelope sender that is associated with this address and its length. If the
39977 length is zero, there is no special envelope sender (there are then two space
39978 characters in the line). A non-empty field can arise from a &(redirect)& router
39979 that has an &%errors_to%& setting.
39980
39981
39982 A blank line separates the envelope and status information from the headers
39983 which follow. A header may occupy several lines of the file, and to save effort
39984 when reading it in, each header is preceded by a number and an identifying
39985 character. The number is the number of characters in the header, including any
39986 embedded newlines and the terminating newline. The character is one of the
39987 following:
39988
39989 .table2 50pt
39990 .row <&'blank'&>         "header in which Exim has no special interest"
39991 .row &`B`&               "&'Bcc:'& header"
39992 .row &`C`&               "&'Cc:'& header"
39993 .row &`F`&               "&'From:'& header"
39994 .row &`I`&               "&'Message-id:'& header"
39995 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39996 .row &`R`&               "&'Reply-To:'& header"
39997 .row &`S`&               "&'Sender:'& header"
39998 .row &`T`&               "&'To:'& header"
39999 .row &`*`&               "replaced or deleted header"
40000 .endtable
40001
40002 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40003 purposes. They are not transmitted when the message is delivered. Here is a
40004 typical set of headers:
40005 .code
40006 111P Received: by hobbit.fict.example with local (Exim 4.00)
40007 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40008 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40009 038* X-rewrote-sender: bb@hobbit.fict.example
40010 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40011 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40012 099* To: alice@wonderland.fict.example, rdo@foundation,
40013 darcy@austen.fict.example, editor@thesaurus.ref.example
40014 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40015 darcy@austen.fict.example, editor@thesaurus.ref.example
40016 038  Date: Fri, 11 May 2001 10:28:59 +0100
40017 .endd
40018 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40019 &'To:'& header have been rewritten, the last one because routing expanded the
40020 unqualified domain &'foundation'&.
40021 .ecindex IIDforspo1
40022 .ecindex IIDforspo2
40023 .ecindex IIDforspo3
40024
40025 .section "Format of the -D file" "SECID282a"
40026 The data file is traditionally in Unix-standard format: lines are ended with
40027 an ASCII newline character.
40028 However, when the &%spool_wireformat%& main option is used some -D files
40029 can have an alternate format.
40030 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40031 The -D file lines (not including the first name-component line) are
40032 suitable for direct copying to the wire when transmitting using the
40033 ESMTP CHUNKING option, meaning lower processing overhead.
40034 Lines are terminated with an ASCII CRLF pair.
40035 There is no dot-stuffing (and no dot-termination).
40036
40037 . ////////////////////////////////////////////////////////////////////////////
40038 . ////////////////////////////////////////////////////////////////////////////
40039
40040 .chapter "DKIM, SPF and DMARC" "CHAPdkim" &&&
40041          "DKIM, SPF and DMARC Support"
40042
40043 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40044 .cindex "DKIM"
40045
40046 DKIM is a mechanism by which messages sent by some entity can be provably
40047 linked to a domain which that entity controls.  It permits reputation to
40048 be tracked on a per-domain basis, rather than merely upon source IP address.
40049 DKIM is documented in RFC 6376.
40050
40051 As DKIM relies on the message being unchanged in transit, messages handled
40052 by a mailing-list (which traditionally adds to the message) will not match
40053 any original DKIM signature.
40054
40055 DKIM support is compiled into Exim by default if TLS support is present.
40056 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40057
40058 Exim's DKIM implementation allows for
40059 .olist
40060 Signing outgoing messages: This function is implemented in the SMTP transport.
40061 It can co-exist with all other Exim features
40062 (including transport filters)
40063 except cutthrough delivery.
40064 .next
40065 Verifying signatures in incoming messages: This is implemented by an additional
40066 ACL (acl_smtp_dkim), which can be called several times per message, with
40067 different signature contexts.
40068 .endlist
40069
40070 In typical Exim style, the verification implementation does not include any
40071 default "policy". Instead it enables you to build your own policy using
40072 Exim's standard controls.
40073
40074 Please note that verification of DKIM signatures in incoming mail is turned
40075 on by default for logging (in the <= line) purposes.
40076
40077 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40078 When set, for each signature in incoming email,
40079 exim will log a line displaying the most important signature details, and the
40080 signature status. Here is an example (with line-breaks added for clarity):
40081 .code
40082 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40083     d=facebookmail.com s=q1-2009b
40084     c=relaxed/relaxed a=rsa-sha1
40085     i=@facebookmail.com t=1252484542 [verification succeeded]
40086 .endd
40087
40088 You might want to turn off DKIM verification processing entirely for internal
40089 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40090 control modifier. This should typically be done in the RCPT ACL, at points
40091 where you accept mail from relay sources (internal hosts or authenticated
40092 senders).
40093
40094
40095 .section "Signing outgoing messages" "SECDKIMSIGN"
40096 .cindex "DKIM" "signing"
40097
40098 For signing to be usable you must have published a DKIM record in DNS.
40099 Note that RFC 8301 (which does not cover EC keys) says:
40100 .code
40101 rsa-sha1 MUST NOT be used for signing or verifying.
40102
40103 Signers MUST use RSA keys of at least 1024 bits for all keys.
40104 Signers SHOULD use RSA keys of at least 2048 bits.
40105 .endd
40106
40107 Note also that the key content (the 'p=' field)
40108 in the DNS record is different between RSA and EC keys;
40109 for the former it is the base64 of the ASN.1 for the RSA public key
40110 (equivalent to the private-key .pem with the header/trailer stripped)
40111 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40112
40113 Signing is enabled by setting private options on the SMTP transport.
40114 These options take (expandable) strings as arguments.
40115
40116 .option dkim_domain smtp string list&!! unset
40117 The domain(s) you want to sign with.
40118 After expansion, this can be a list.
40119 Each element in turn,
40120 lowercased,
40121 is put into the &%$dkim_domain%& expansion variable
40122 while expanding the remaining signing options.
40123 If it is empty after expansion, DKIM signing is not done,
40124 and no error will result even if &%dkim_strict%& is set.
40125
40126 .option dkim_selector smtp string list&!! unset
40127 This sets the key selector string.
40128 After expansion, which can use &$dkim_domain$&, this can be a list.
40129 Each element in turn is put in the expansion
40130 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40131 option along with &%$dkim_domain%&.
40132 If the option is empty after expansion, DKIM signing is not done for this domain,
40133 and no error will result even if &%dkim_strict%& is set.
40134
40135 .option dkim_private_key smtp string&!! unset
40136 This sets the private key to use.
40137 You can use the &%$dkim_domain%& and
40138 &%$dkim_selector%& expansion variables to determine the private key to use.
40139 The result can either
40140 .ilist
40141 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40142 .next
40143 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40144 be a valid Ed25519 private key (same format as above)
40145 .next
40146 start with a slash, in which case it is treated as a file that contains
40147 the private key
40148 .next
40149 be "0", "false" or the empty string, in which case the message will not
40150 be signed. This case will not result in an error, even if &%dkim_strict%&
40151 is set.
40152 .endlist
40153
40154 To generate keys under OpenSSL:
40155 .code
40156 openssl genrsa -out dkim_rsa.private 2048
40157 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40158 .endd
40159 Take the base-64 lines from the output of the second command, concatenated,
40160 for the DNS TXT record.
40161 See section 3.6 of RFC6376 for the record specification.
40162
40163 Under GnuTLS:
40164 .code
40165 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40166 certtool --load-privkey=dkim_rsa.private --pubkey-info
40167 .endd
40168
40169 Note that RFC 8301 says:
40170 .code
40171 Signers MUST use RSA keys of at least 1024 bits for all keys.
40172 Signers SHOULD use RSA keys of at least 2048 bits.
40173 .endd
40174
40175 EC keys for DKIM are defined by RFC 8463.
40176 They are considerably smaller than RSA keys for equivalent protection.
40177 As they are a recent development, users should consider dual-signing
40178 (by setting a list of selectors, and an expansion for this option)
40179 for some transition period.
40180 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40181 for EC keys.
40182
40183 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40184 .code
40185 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40186 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40187 .endd
40188
40189 To produce the required public key value for a DNS record:
40190 .code
40191 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40192 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40193 .endd
40194
40195 Exim also supports an alternate format
40196 of Ed25519 keys in DNS which was a candidate during development
40197 of the standard, but not adopted.
40198 A future release will probably drop that support.
40199
40200 .option dkim_hash smtp string&!! sha256
40201 Can be set to any one of the supported hash methods, which are:
40202 .ilist
40203 &`sha1`& &-- should not be used, is old and insecure
40204 .next
40205 &`sha256`& &-- the default
40206 .next
40207 &`sha512`& &-- possibly more secure but less well supported
40208 .endlist
40209
40210 Note that RFC 8301 says:
40211 .code
40212 rsa-sha1 MUST NOT be used for signing or verifying.
40213 .endd
40214
40215 .option dkim_identity smtp string&!! unset
40216 If set after expansion, the value is used to set an "i=" tag in
40217 the signing header.  The DKIM standards restrict the permissible
40218 syntax of this optional tag to a mail address, with possibly-empty
40219 local part, an @, and a domain identical to or subdomain of the "d="
40220 tag value.  Note that Exim does not check the value.
40221
40222 .option dkim_canon smtp string&!! unset
40223 This option sets the canonicalization method used when signing a message.
40224 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40225 The option defaults to "relaxed" when unset. Note: the current implementation
40226 only supports signing with the same canonicalization method for both headers and body.
40227
40228 .option dkim_strict smtp string&!! unset
40229 This  option  defines  how  Exim  behaves  when  signing a message that
40230 should be signed fails for some reason.  When the expansion evaluates to
40231 either "1" or "true", Exim will defer. Otherwise Exim will send the message
40232 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40233 variables here.
40234
40235 .option dkim_sign_headers smtp string&!! "see below"
40236 If set, this option must expand to a colon-separated
40237 list of header names.
40238 Headers with these names, or the absence or such a header, will be included
40239 in the message signature.
40240 When unspecified, the header names listed in RFC4871 will be used,
40241 whether or not each header is present in the message.
40242 The default list is available for the expansion in the macro
40243 "_DKIM_SIGN_HEADERS".
40244
40245 If a name is repeated, multiple headers by that name (or the absence thereof)
40246 will be signed.  The textually later headers in the headers part of the
40247 message are signed first, if there are multiples.
40248
40249 A name can be prefixed with either an '=' or a '+' character.
40250 If an '=' prefix is used, all headers that are present with this name
40251 will be signed.
40252 If a '+' prefix if used, all headers that are present with this name
40253 will be signed, and one signature added for a missing header with the
40254 name will be appended.
40255
40256 .option dkim_timestamps smtp integer&!! unset
40257 This option controls the inclusion of timestamp information in the signature.
40258 If not set, no such information will be included.
40259 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40260 for the expiry tag
40261 (eg. 1209600 for two weeks);
40262 both creation (t=) and expiry (x=) tags will be included.
40263
40264 RFC 6376 lists these tags as RECOMMENDED.
40265
40266
40267 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40268 .cindex "DKIM" "verification"
40269
40270 Verification of DKIM signatures in SMTP incoming email is done for all
40271 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40272 .cindex DKIM "selecting signature algorithms"
40273 Individual classes of signature algorithm can be ignored by changing
40274 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40275 The &%dkim_verify_minimal%& option can be set to cease verification
40276 processing for a message once the first passing signature is found.
40277
40278 .cindex authentication "expansion item"
40279 Performing verification sets up information used by the
40280 &%authresults%& expansion item.
40281
40282 For most purposes the default option settings suffice and the remainder
40283 of this section can be ignored.
40284
40285 The results of verification are made available to the
40286 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40287 A missing ACL definition defaults to accept.
40288 By default, the ACL is called once for each
40289 syntactically(!) correct signature in the incoming message.
40290 If any ACL call does not accept, the message is not accepted.
40291 If a cutthrough delivery was in progress for the message, that is
40292 summarily dropped (having wasted the transmission effort).
40293
40294 To evaluate the verification result in the ACL
40295 a large number of expansion variables
40296 containing the signature status and its details are set up during the
40297 runtime of the ACL.
40298
40299 Calling the ACL only for existing signatures is not sufficient to build
40300 more advanced policies. For that reason, the main option
40301 &%dkim_verify_signers%&, and an expansion variable
40302 &%$dkim_signers%& exist.
40303
40304 The main option &%dkim_verify_signers%& can be set to a colon-separated
40305 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40306 called. It is expanded when the message has been received. At this point,
40307 the expansion variable &%$dkim_signers%& already contains a colon-separated
40308 list of signer domains and identities for the message. When
40309 &%dkim_verify_signers%& is not specified in the main configuration,
40310 it defaults as:
40311 .code
40312 dkim_verify_signers = $dkim_signers
40313 .endd
40314 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40315 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40316 call the ACL for known domains or identities. This would be achieved as follows:
40317 .code
40318 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40319 .endd
40320 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40321 and "ebay.com", plus all domains and identities that have signatures in the message.
40322 You can also be more creative in constructing your policy. For example:
40323 .code
40324 dkim_verify_signers = $sender_address_domain:$dkim_signers
40325 .endd
40326
40327 If a domain or identity is listed several times in the (expanded) value of
40328 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40329
40330 Note that if the option is set using untrustworthy data
40331 (such as the From: header)
40332 care should be taken to force lowercase for domains
40333 and for the domain part if identities.
40334 The default setting can be regarded as trustworthy in this respect.
40335
40336 If multiple signatures match a domain (or identity), the ACL is called once
40337 for each matching signature.
40338
40339
40340 Inside the DKIM ACL, the following expansion variables are
40341 available (from most to least important):
40342
40343
40344 .vlist
40345 .vitem &%$dkim_cur_signer%&
40346 The signer that is being evaluated in this ACL run. This can be a domain or
40347 an identity. This is one of the list items from the expanded main option
40348 &%dkim_verify_signers%& (see above).
40349
40350 .vitem &%$dkim_verify_status%&
40351 Within the DKIM ACL,
40352 a string describing the general status of the signature. One of
40353 .ilist
40354 &%none%&: There is no signature in the message for the current domain or
40355 identity (as reflected by &%$dkim_cur_signer%&).
40356 .next
40357 &%invalid%&: The signature could not be verified due to a processing error.
40358 More detail is available in &%$dkim_verify_reason%&.
40359 .next
40360 &%fail%&: Verification of the signature failed.  More detail is
40361 available in &%$dkim_verify_reason%&.
40362 .next
40363 &%pass%&: The signature passed verification. It is valid.
40364 .endlist
40365
40366 This variable can be overwritten using an ACL 'set' modifier.
40367 This might, for instance, be done to enforce a policy restriction on
40368 hash-method or key-size:
40369 .code
40370   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40371        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40372        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40373                                   {< {$dkim_key_length}{1024}}}}
40374        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40375        set dkim_verify_status = fail
40376        set dkim_verify_reason = hash too weak or key too short
40377 .endd
40378
40379 So long as a DKIM ACL is defined (it need do no more than accept),
40380 after all the DKIM ACL runs have completed, the value becomes a
40381 colon-separated list of the values after each run.
40382 This is maintained for the mime, prdr and data ACLs.
40383
40384 .vitem &%$dkim_verify_reason%&
40385 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40386 "fail" or "invalid". One of
40387 .ilist
40388 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40389 key for the domain could not be retrieved. This may be a temporary problem.
40390 .next
40391 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40392 record for the domain is syntactically invalid.
40393 .next
40394 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40395 body hash does not match the one specified in the signature header. This
40396 means that the message body was modified in transit.
40397 .next
40398 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40399 could not be verified. This may mean that headers were modified,
40400 re-written or otherwise changed in a way which is incompatible with
40401 DKIM verification. It may of course also mean that the signature is forged.
40402 .endlist
40403
40404 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40405
40406 .vitem &%$dkim_domain%&
40407 The signing domain. IMPORTANT: This variable is only populated if there is
40408 an actual signature in the message for the current domain or identity (as
40409 reflected by &%$dkim_cur_signer%&).
40410
40411 .vitem &%$dkim_identity%&
40412 The signing identity, if present. IMPORTANT: This variable is only populated
40413 if there is an actual signature in the message for the current domain or
40414 identity (as reflected by &%$dkim_cur_signer%&).
40415
40416 .vitem &%$dkim_selector%&
40417 The key record selector string.
40418
40419 .vitem &%$dkim_algo%&
40420 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
40421 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40422 may also be 'ed25519-sha256'.
40423 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40424 for EC keys.
40425
40426 Note that RFC 8301 says:
40427 .code
40428 rsa-sha1 MUST NOT be used for signing or verifying.
40429
40430 DKIM signatures identified as having been signed with historic
40431 algorithms (currently, rsa-sha1) have permanently failed evaluation
40432 .endd
40433
40434 To enforce this you must either have a DKIM ACL which checks this variable
40435 and overwrites the &$dkim_verify_status$& variable as discussed above,
40436 or have set the main option &%dkim_verify_hashes%& to exclude
40437 processing of such signatures.
40438
40439 .vitem &%$dkim_canon_body%&
40440 The body canonicalization method. One of 'relaxed' or 'simple'.
40441
40442 .vitem &%$dkim_canon_headers%&
40443 The header canonicalization method. One of 'relaxed' or 'simple'.
40444
40445 .vitem &%$dkim_copiedheaders%&
40446 A transcript of headers and their values which are included in the signature
40447 (copied from the 'z=' tag of the signature).
40448 Note that RFC6376 requires that verification fail if the From: header is
40449 not included in the signature.  Exim does not enforce this; sites wishing
40450 strict enforcement should code the check explicitly.
40451
40452 .vitem &%$dkim_bodylength%&
40453 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
40454 limit was set by the signer, "9999999999999" is returned. This makes sure
40455 that this variable always expands to an integer value.
40456 &*Note:*& The presence of the signature tag specifying a signing body length
40457 is one possible route to spoofing of valid DKIM signatures.
40458 A paranoid implementation might wish to regard signature where this variable
40459 shows less than the "no limit" return as being invalid.
40460
40461 .vitem &%$dkim_created%&
40462 UNIX timestamp reflecting the date and time when the signature was created.
40463 When this was not specified by the signer, "0" is returned.
40464
40465 .vitem &%$dkim_expires%&
40466 UNIX timestamp reflecting the date and time when the signer wants the
40467 signature to be treated as "expired". When this was not specified by the
40468 signer, "9999999999999" is returned. This makes it possible to do useful
40469 integer size comparisons against this value.
40470 Note that Exim does not check this value.
40471
40472 .vitem &%$dkim_headernames%&
40473 A colon-separated list of names of headers included in the signature.
40474
40475 .vitem &%$dkim_key_testing%&
40476 "1" if the key record has the "testing" flag set, "0" if not.
40477
40478 .vitem &%$dkim_key_nosubdomains%&
40479 "1" if the key record forbids subdomaining, "0" otherwise.
40480
40481 .vitem &%$dkim_key_srvtype%&
40482 Service type (tag s=) from the key record. Defaults to "*" if not specified
40483 in the key record.
40484
40485 .vitem &%$dkim_key_granularity%&
40486 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
40487 in the key record.
40488
40489 .vitem &%$dkim_key_notes%&
40490 Notes from the key record (tag n=).
40491
40492 .vitem &%$dkim_key_length%&
40493 Number of bits in the key.
40494
40495 Note that RFC 8301 says:
40496 .code
40497 Verifiers MUST NOT consider signatures using RSA keys of
40498 less than 1024 bits as valid signatures.
40499 .endd
40500
40501 To enforce this you must have a DKIM ACL which checks this variable
40502 and overwrites the &$dkim_verify_status$& variable as discussed above.
40503 As EC keys are much smaller, the check should only do this for RSA keys.
40504
40505 .endlist
40506
40507 In addition, two ACL conditions are provided:
40508
40509 .vlist
40510 .vitem &%dkim_signers%&
40511 ACL condition that checks a colon-separated list of domains or identities
40512 for a match against the domain or identity that the ACL is currently verifying
40513 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
40514 verb to a group of domains or identities. For example:
40515
40516 .code
40517 # Warn when Mail purportedly from GMail has no gmail signature
40518 warn log_message = GMail sender without gmail.com DKIM signature
40519      sender_domains = gmail.com
40520      dkim_signers = gmail.com
40521      dkim_status = none
40522 .endd
40523
40524 Note that the above does not check for a total lack of DKIM signing;
40525 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
40526
40527 .vitem &%dkim_status%&
40528 ACL condition that checks a colon-separated list of possible DKIM verification
40529 results against the actual result of verification. This is typically used
40530 to restrict an ACL verb to a list of verification outcomes, for example:
40531
40532 .code
40533 deny message = Mail from Paypal with invalid/missing signature
40534      sender_domains = paypal.com:paypal.de
40535      dkim_signers = paypal.com:paypal.de
40536      dkim_status = none:invalid:fail
40537 .endd
40538
40539 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
40540 see the documentation of the &%$dkim_verify_status%& expansion variable above
40541 for more information of what they mean.
40542 .endlist
40543
40544
40545
40546
40547 .section "SPF (Sender Policy Framework)" SECSPF
40548 .cindex SPF verification
40549
40550 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40551 messages with its domain in the envelope from, documented by RFC 7208.
40552 For more information on SPF see &url(http://www.open-spf.org), a static copy of
40553 the &url(http://openspf.org).
40554 . --- 2019-10-28: still not https, open-spf.org is told to be a
40555 . --- web-archive copy of the now dead openspf.org site
40556 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
40557 . --- discussion.
40558
40559 Messages sent by a system not authorised will fail checking of such assertions.
40560 This includes retransmissions done by traditional forwarders.
40561
40562 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40563 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40564 &url(https://www.libspf2.org/).
40565 There is no Exim involvement in the transmission of messages;
40566 publishing certain DNS records is all that is required.
40567
40568 For verification, an ACL condition and an expansion lookup are provided.
40569 .cindex authentication "expansion item"
40570 Performing verification sets up information used by the
40571 &%authresults%& expansion item.
40572
40573
40574 .cindex SPF "ACL condition"
40575 .cindex ACL "spf condition"
40576 The ACL condition "spf" can be used at or after the MAIL ACL.
40577 It takes as an argument a list of strings giving the outcome of the SPF check,
40578 and will succeed for any matching outcome.
40579 Valid strings are:
40580 .vlist
40581 .vitem &%pass%&
40582 The SPF check passed, the sending host is positively verified by SPF.
40583
40584 .vitem &%fail%&
40585 The SPF check failed, the sending host is NOT allowed to send mail for the
40586 domain in the envelope-from address.
40587
40588 .vitem &%softfail%&
40589 The SPF check failed, but the queried domain can't absolutely confirm that this
40590 is a forgery.
40591
40592 .vitem &%none%&
40593 The queried domain does not publish SPF records.
40594
40595 .vitem &%neutral%&
40596 The SPF check returned a "neutral" state.  This means the queried domain has
40597 published a SPF record, but wants to allow outside servers to send mail under
40598 its domain as well.  This should be treated like "none".
40599
40600 .vitem &%permerror%&
40601 This indicates a syntax error in the SPF record of the queried domain.
40602 You may deny messages when this occurs.
40603
40604 .vitem &%temperror%&
40605 This indicates a temporary error during all processing, including Exim's
40606 SPF processing.  You may defer messages when this occurs.
40607 .endlist
40608
40609 You can prefix each string with an exclamation mark to  invert
40610 its meaning,  for example  "!fail" will  match all  results but
40611 "fail".  The  string  list is  evaluated  left-to-right,  in a
40612 short-circuit fashion.
40613
40614 Example:
40615 .code
40616 deny spf = fail
40617      message = $sender_host_address is not allowed to send mail from \
40618                ${if def:sender_address_domain \
40619                     {$sender_address_domain}{$sender_helo_name}}.  \
40620                Please see http://www.open-spf.org/Why?scope=\
40621                ${if def:sender_address_domain {mfrom}{helo}};\
40622                identity=${if def:sender_address_domain \
40623                              {$sender_address}{$sender_helo_name}};\
40624                ip=$sender_host_address
40625 .endd
40626
40627 When the spf condition has run, it sets up several expansion
40628 variables:
40629
40630 .cindex SPF "verification variables"
40631 .vlist
40632 .vitem &$spf_header_comment$&
40633 .vindex &$spf_header_comment$&
40634   This contains a human-readable string describing the outcome
40635   of the SPF check. You can add it to a custom header or use
40636   it for logging purposes.
40637
40638 .vitem &$spf_received$&
40639 .vindex &$spf_received$&
40640   This contains a complete Received-SPF: header that can be
40641   added to the message. Please note that according to the SPF
40642   draft, this header must be added at the top of the header
40643   list. Please see section 10 on how you can do this.
40644
40645   Note: in case of "Best-guess" (see below), the convention is
40646   to put this string in a header called X-SPF-Guess: instead.
40647
40648 .vitem &$spf_result$&
40649 .vindex &$spf_result$&
40650   This contains the outcome of the SPF check in string form,
40651   one of pass, fail, softfail, none, neutral, permerror or
40652   temperror.
40653
40654 .vitem &$spf_result_guessed$&
40655 .vindex &$spf_result_guessed$&
40656   This boolean is true only if a best-guess operation was used
40657   and required in order to obtain a result.
40658
40659 .vitem &$spf_smtp_comment$&
40660 .vindex &$spf_smtp_comment$&
40661   This contains a string that can be used in a SMTP response
40662   to the calling party. Useful for "fail".
40663 .endlist
40664
40665
40666 .cindex SPF "ACL condition"
40667 .cindex ACL "spf_guess condition"
40668 .cindex SPF "best guess"
40669 In addition to SPF, you can also perform checks for so-called
40670 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40671 SPF, but it is supported by the same framework that enables SPF
40672 capability.
40673 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
40674 for a description of what it means.
40675 . --- 2019-10-28: still not https:
40676
40677 To access this feature, simply use the spf_guess condition in place
40678 of the spf one.  For example:
40679
40680 .code
40681 deny spf_guess = fail
40682      message = $sender_host_address doesn't look trustworthy to me
40683 .endd
40684
40685 In case you decide to reject messages based on this check, you
40686 should note that although it uses the same framework, "Best-guess"
40687 is not SPF, and therefore you should not mention SPF at all in your
40688 reject message.
40689
40690 When the spf_guess condition has run, it sets up the same expansion
40691 variables as when spf condition is run, described above.
40692
40693 Additionally, since Best-guess is not standardized, you may redefine
40694 what "Best-guess" means to you by redefining the main configuration
40695 &%spf_guess%& option.
40696 For example, the following:
40697
40698 .code
40699 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40700 .endd
40701
40702 would relax host matching rules to a broader network range.
40703
40704
40705 .cindex SPF "lookup expansion"
40706 .cindex lookup spf
40707 A lookup expansion is also available. It takes an email
40708 address as the key and an IP address
40709 (v4 or v6)
40710 as the database:
40711
40712 .code
40713   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40714 .endd
40715
40716 The lookup will return the same result strings as can appear in
40717 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40718
40719
40720
40721
40722
40723 .section DMARC SECDMARC
40724 .cindex DMARC verification
40725
40726 DMARC combines feedback from SPF, DKIM, and header From: in order
40727 to attempt to provide better indicators of the authenticity of an
40728 email.  This document does not explain the fundamentals; you
40729 should read and understand how it works by visiting the website at
40730 &url(http://www.dmarc.org/).
40731
40732 If Exim is built with DMARC support,
40733 the libopendmarc library is used.
40734
40735 For building Exim yourself, obtain the library from
40736 &url(http://sourceforge.net/projects/opendmarc/)
40737 to obtain a copy, or find it in your favorite package
40738 repository.  You will need to attend to the local/Makefile feature
40739 SUPPORT_DMARC and the associated LDFLAGS addition.
40740 This description assumes
40741 that headers will be in /usr/local/include, and that the libraries
40742 are in /usr/local/lib.
40743
40744 . subsection
40745
40746 There are three main-configuration options:
40747 .cindex DMARC "configuration options"
40748
40749 The &%dmarc_tld_file%& option
40750 .oindex &%dmarc_tld_file%&
40751 defines the location of a text file of valid
40752 top level domains the opendmarc library uses
40753 during domain parsing. Maintained by Mozilla,
40754 the most current version can be downloaded
40755 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
40756 See also the util/renew-opendmarc-tlds.sh script.
40757 .new
40758 The default for the option is unset.
40759 If not set, DMARC processing is disabled.
40760 .wen
40761
40762
40763 The &%dmarc_history_file%& option, if set
40764 .oindex &%dmarc_history_file%&
40765 defines the location of a file to log results
40766 of dmarc verification on inbound emails. The
40767 contents are importable by the opendmarc tools
40768 which will manage the data, send out DMARC
40769 reports, and expire the data. Make sure the
40770 directory of this file is writable by the user
40771 exim runs as.
40772 The default is unset.
40773
40774 The &%dmarc_forensic_sender%& option
40775 .oindex &%dmarc_forensic_sender%&
40776 defines an alternate email address to use when sending a
40777 forensic report detailing alignment failures
40778 if a sender domain's dmarc record specifies it
40779 and you have configured Exim to send them.
40780 If set, this is expanded and used for the
40781 From: header line; the address is extracted
40782 from it and used for the envelope from.
40783 If not set (the default), the From: header is expanded from
40784 the dsn_from option, and <> is used for the
40785 envelope from.
40786
40787 . I wish we had subsections...
40788
40789 .cindex DMARC controls
40790 By default, the DMARC processing will run for any remote,
40791 non-authenticated user.  It makes sense to only verify DMARC
40792 status of messages coming from remote, untrusted sources.  You can
40793 use standard conditions such as hosts, senders, etc, to decide that
40794 DMARC verification should *not* be performed for them and disable
40795 DMARC with an ACL control modifier:
40796 .code
40797   control = dmarc_disable_verify
40798 .endd
40799 A DMARC record can also specify a "forensic address", which gives
40800 exim an email address to submit reports about failed alignment.
40801 Exim does not do this by default because in certain conditions it
40802 results in unintended information leakage (what lists a user might
40803 be subscribed to, etc).  You must configure exim to submit forensic
40804 reports to the owner of the domain.  If the DMARC record contains a
40805 forensic address and you specify the control statement below, then
40806 exim will send these forensic emails.  It is also advised that you
40807 configure a &%dmarc_forensic_sender%& because the default sender address
40808 construction might be inadequate.
40809 .code
40810   control = dmarc_enable_forensic
40811 .endd
40812 (AGAIN: You can choose not to send these forensic reports by simply
40813 not putting the dmarc_enable_forensic control line at any point in
40814 your exim config.  If you don't tell exim to send them, it will not
40815 send them.)
40816
40817 There are no options to either control.  Both must appear before
40818 the DATA acl.
40819
40820 . subsection
40821
40822 DMARC checks cam be run on incoming SMTP  messages by using the
40823 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
40824 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
40825 condition.  Putting this condition in the ACLs is required in order
40826 for a DMARC check to actually occur.  All of the variables are set
40827 up before the DATA ACL, but there is no actual DMARC check that
40828 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
40829
40830 The &"dmarc_status"& condition takes a list of strings on its
40831 right-hand side.  These strings describe recommended action based
40832 on the DMARC check.  To understand what the policy recommendations
40833 mean, refer to the DMARC website above.  Valid strings are:
40834 .display
40835 &'accept      '& The DMARC check passed and the library recommends accepting the email.
40836 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
40837 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
40838 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
40839 &'norecord    '& No policy section in the DMARC record for this sender domain.
40840 &'nofrom      '& Unable to determine the domain of the sender.
40841 &'temperror   '& Library error or dns error.
40842 &'off         '& The DMARC check was disabled for this email.
40843 .endd
40844 You can prefix each string with an exclamation mark to invert its
40845 meaning, for example "!accept" will match all results but
40846 "accept".  The string list is evaluated left-to-right in a
40847 short-circuit fashion.  When a string matches the outcome of the
40848 DMARC check, the condition succeeds.  If none of the listed
40849 strings matches the outcome of the DMARC check, the condition
40850 fails.
40851
40852 Of course, you can also use any other lookup method that Exim
40853 supports, including LDAP, Postgres, MySQL, etc, as long as the
40854 result is a list of colon-separated strings.
40855
40856 Performing the check sets up information used by the
40857 &%authresults%& expansion item.
40858
40859 Several expansion variables are set before the DATA ACL is
40860 processed, and you can use them in this ACL.  The following
40861 expansion variables are available:
40862
40863 .vlist
40864 .vitem &$dmarc_status$&
40865 .vindex &$dmarc_status$&
40866 .cindex DMARC result
40867 A one word status indicating what the DMARC library
40868 thinks of the email.  It is a combination of the results of
40869 DMARC record lookup and the SPF/DKIM/DMARC processing results
40870 (if a DMARC record was found).  The actual policy declared
40871 in the DMARC record is in a separate expansion variable.
40872
40873 .vitem &$dmarc_status_text$&
40874 .vindex &$dmarc_status_text$&
40875 Slightly longer, human readable status.
40876
40877 .vitem &$dmarc_used_domain$&
40878 .vindex &$dmarc_used_domain$&
40879 The domain which DMARC used to look up the DMARC policy record.
40880
40881 .vitem &$dmarc_domain_policy$&
40882 .vindex &$dmarc_domain_policy$&
40883 The policy declared in the DMARC record.  Valid values
40884 are "none", "reject" and "quarantine".  It is blank when there
40885 is any error, including no DMARC record.
40886 .endlist
40887
40888 . subsection
40889
40890 By default, Exim's DMARC configuration is intended to be
40891 non-intrusive and conservative.  To facilitate this, Exim will not
40892 create any type of logging files without explicit configuration by
40893 you, the admin.  Nor will Exim send out any emails/reports about
40894 DMARC issues without explicit configuration by you, the admin (other
40895 than typical bounce messages that may come about due to ACL
40896 processing or failure delivery issues).
40897
40898 In order to log statistics suitable to be imported by the opendmarc
40899 tools, you need to:
40900 .ilist
40901 Configure the global option &%dmarc_history_file%&
40902 .next
40903 Configure cron jobs to call the appropriate opendmarc history
40904 import scripts and truncating the dmarc_history_file
40905 .endlist
40906
40907 In order to send forensic reports, you need to:
40908 .ilist
40909 Configure the global option &%dmarc_forensic_sender%&
40910 .next
40911 Configure, somewhere before the DATA ACL, the control option to
40912 enable sending DMARC forensic reports
40913 .endlist
40914
40915 . subsection
40916
40917 Example usage:
40918 .code
40919 (RCPT ACL)
40920   warn    domains        = +local_domains
40921           hosts          = +local_hosts
40922           control        = dmarc_disable_verify
40923
40924   warn    !domains       = +screwed_up_dmarc_records
40925           control        = dmarc_enable_forensic
40926
40927   warn    condition      = (lookup if destined to mailing list)
40928           set acl_m_mailing_list = 1
40929
40930 (DATA ACL)
40931   warn    dmarc_status   = accept : none : off
40932           !authenticated = *
40933           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
40934
40935   warn    dmarc_status   = !accept
40936           !authenticated = *
40937           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
40938
40939   warn    dmarc_status   = quarantine
40940           !authenticated = *
40941           set $acl_m_quarantine = 1
40942           # Do something in a transport with this flag variable
40943
40944   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
40945           condition      = ${if eq{$acl_m_mailing_list}{1}}
40946           message        = Messages from $dmarc_used_domain break mailing lists
40947
40948   deny    dmarc_status   = reject
40949           !authenticated = *
40950           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
40951
40952   warn    add_header     = :at_start:${authresults {$primary_hostname}}
40953 .endd
40954
40955
40956
40957
40958
40959 . ////////////////////////////////////////////////////////////////////////////
40960 . ////////////////////////////////////////////////////////////////////////////
40961
40962 .chapter "Proxies" "CHAPproxies" &&&
40963          "Proxy support"
40964 .cindex "proxy support"
40965 .cindex "proxy" "access via"
40966
40967 A proxy is an intermediate system through which communication is passed.
40968 Proxies may provide a security, availability or load-distribution function.
40969
40970
40971 .section "Inbound proxies" SECTproxyInbound
40972 .cindex proxy inbound
40973 .cindex proxy "server side"
40974 .cindex proxy "Proxy protocol"
40975 .cindex "Proxy protocol" proxy
40976
40977 Exim has support for receiving inbound SMTP connections via a proxy
40978 that uses &"Proxy Protocol"& to speak to it.
40979 To include this support, include &"SUPPORT_PROXY=yes"&
40980 in Local/Makefile.
40981
40982 It was built on the HAProxy specification, found at
40983 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40984
40985 The purpose of this facility is so that an application load balancer,
40986 such as HAProxy, can sit in front of several Exim servers
40987 to distribute load.
40988 Exim uses the local protocol communication with the proxy to obtain
40989 the remote SMTP system IP address and port information.
40990 There is no logging if a host passes or
40991 fails Proxy Protocol negotiation, but it can easily be determined and
40992 recorded in an ACL (example is below).
40993
40994 Use of a proxy is enabled by setting the &%hosts_proxy%&
40995 main configuration option to a hostlist; connections from these
40996 hosts will use Proxy Protocol.
40997 Exim supports both version 1 and version 2 of the Proxy Protocol and
40998 automatically determines which version is in use.
40999
41000 The Proxy Protocol header is the first data received on a TCP connection
41001 and is inserted before any TLS-on-connect handshake from the client; Exim
41002 negotiates TLS between Exim-as-server and the remote client, not between
41003 Exim and the proxy server.
41004
41005 The following expansion variables are usable
41006 (&"internal"& and &"external"& here refer to the interfaces
41007 of the proxy):
41008 .display
41009 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41010 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41011 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41012 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41013 &'proxy_session            '& boolean: SMTP connection via proxy
41014 .endd
41015 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41016 there was a protocol error.
41017 The variables &$sender_host_address$& and &$sender_host_port$&
41018 will have values for the actual client system, not the proxy.
41019
41020 Since the real connections are all coming from the proxy, and the
41021 per host connection tracking is done before Proxy Protocol is
41022 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41023 handle all of the parallel volume you expect per inbound proxy.
41024 With the option set so high, you lose the ability
41025 to protect your server from many connections from one IP.
41026 In order to prevent your server from overload, you
41027 need to add a per connection ratelimit to your connect ACL.
41028 A possible solution is:
41029 .display
41030   # Set max number of connections per host
41031   LIMIT   = 5
41032   # Or do some kind of IP lookup in a flat file or database
41033   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41034
41035   defer   message        = Too many connections from this IP right now
41036           ratelimit      = LIMIT / 5s / per_conn / strict
41037 .endd
41038
41039
41040
41041 .section "Outbound proxies" SECTproxySOCKS
41042 .cindex proxy outbound
41043 .cindex proxy "client side"
41044 .cindex proxy SOCKS
41045 .cindex SOCKS proxy
41046 Exim has support for sending outbound SMTP via a proxy
41047 using a protocol called SOCKS5 (defined by RFC1928).
41048 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41049 Local/Makefile.
41050
41051 Use of a proxy is enabled by setting the &%socks_proxy%& option
41052 on an smtp transport.
41053 The option value is expanded and should then be a list
41054 (colon-separated by default) of proxy specifiers.
41055 Each proxy specifier is a list
41056 (space-separated by default) where the initial element
41057 is an IP address and any subsequent elements are options.
41058
41059 Options are a string <name>=<value>.
41060 The list of options is in the following table:
41061 .display
41062 &'auth   '& authentication method
41063 &'name   '& authentication username
41064 &'pass   '& authentication password
41065 &'port   '& tcp port
41066 &'tmo    '& connection timeout
41067 &'pri    '& priority
41068 &'weight '& selection bias
41069 .endd
41070
41071 More details on each of these options follows:
41072
41073 .ilist
41074 .cindex authentication "to proxy"
41075 .cindex proxy authentication
41076 &%auth%&: Either &"none"& (default) or &"name"&.
41077 Using &"name"& selects username/password authentication per RFC 1929
41078 for access to the proxy.
41079 Default is &"none"&.
41080 .next
41081 &%name%&: sets the username for the &"name"& authentication method.
41082 Default is empty.
41083 .next
41084 &%pass%&: sets the password for the &"name"& authentication method.
41085 Default is empty.
41086 .next
41087 &%port%&: the TCP port number to use for the connection to the proxy.
41088 Default is 1080.
41089 .next
41090 &%tmo%&: sets a connection timeout in seconds for this proxy.
41091 Default is 5.
41092 .next
41093 &%pri%&: specifies a priority for the proxy within the list,
41094 higher values being tried first.
41095 The default priority is 1.
41096 .next
41097 &%weight%&: specifies a selection bias.
41098 Within a priority set servers are queried in a random fashion,
41099 weighted by this value.
41100 The default value for selection bias is 1.
41101 .endlist
41102
41103 Proxies from the list are tried according to their priority
41104 and weight settings until one responds.  The timeout for the
41105 overall connection applies to the set of proxied attempts.
41106
41107 .section Logging SECTproxyLog
41108 To log the (local) IP of a proxy in the incoming or delivery logline,
41109 add &"+proxy"& to the &%log_selector%& option.
41110 This will add a component tagged with &"PRX="& to the line.
41111
41112 . ////////////////////////////////////////////////////////////////////////////
41113 . ////////////////////////////////////////////////////////////////////////////
41114
41115 .chapter "Internationalisation" "CHAPi18n" &&&
41116          "Internationalisation""
41117 .cindex internationalisation "email address"
41118 .cindex EAI
41119 .cindex i18n
41120 .cindex utf8 "mail name handling"
41121
41122 Exim has support for Internationalised mail names.
41123 To include this it must be built with SUPPORT_I18N and the libidn library.
41124 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41125
41126 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41127 instead of it) then IDNA2008 is supported; this adds an extra library
41128 requirement, upon libidn2.
41129
41130 .section "MTA operations" SECTi18nMTA
41131 .cindex SMTPUTF8 "ESMTP option"
41132 The main configuration option &%smtputf8_advertise_hosts%& specifies
41133 a host list.  If this matches the sending host and
41134 accept_8bitmime is true (the default) then the ESMTP option
41135 SMTPUTF8 will be advertised.
41136
41137 If the sender specifies the SMTPUTF8 option on a MAIL command
41138 international handling for the message is enabled and
41139 the expansion variable &$message_smtputf8$& will have value TRUE.
41140
41141 The option &%allow_utf8_domains%& is set to true for this
41142 message. All DNS lookups are converted to a-label form
41143 whatever the setting of &%allow_utf8_domains%&
41144 when Exim is built with SUPPORT_I18N.
41145
41146 Both localparts and domain are maintained as the original
41147 UTF-8 form internally; any comparison or regular-expression use will
41148 require appropriate care.  Filenames created, eg. by
41149 the appendfile transport, will have UTF-8 names.
41150
41151 HELO names sent by the smtp transport will have any UTF-8
41152 components expanded to a-label form,
41153 and any certificate name checks will be done using the a-label
41154 form of the name.
41155
41156 .cindex log protocol
41157 .cindex SMTPUTF8 logging
41158 .cindex i18n logging
41159 Log lines and Received-by: header lines will acquire a "utf8"
41160 prefix on the protocol element, eg. utf8esmtp.
41161
41162 The following expansion operators can be used:
41163 .code
41164 ${utf8_domain_to_alabel:str}
41165 ${utf8_domain_from_alabel:str}
41166 ${utf8_localpart_to_alabel:str}
41167 ${utf8_localpart_from_alabel:str}
41168 .endd
41169
41170 .cindex utf8 "address downconversion"
41171 .cindex i18n "utf8 address downconversion"
41172 The RCPT ACL
41173 may use the following modifier:
41174 .display
41175 control = utf8_downconvert
41176 control = utf8_downconvert/<value>
41177 .endd
41178 This sets a flag requiring that addresses are converted to
41179 a-label form before smtp delivery, for use in a
41180 Message Submission Agent context.
41181 If a value is appended it may be:
41182 .display
41183 &`1  `& (default) mandatory downconversion
41184 &`0  `& no downconversion
41185 &`-1 `& if SMTPUTF8 not supported by destination host
41186 .endd
41187
41188 If mua_wrapper is set, the utf8_downconvert control
41189 is initially set to -1.
41190
41191 The smtp transport has an option &%utf8_downconvert%&.
41192 If set it must expand to one of the three values described above,
41193 and it overrides any previously set value.
41194
41195
41196 There is no explicit support for VRFY and EXPN.
41197 Configurations supporting these should inspect
41198 &$smtp_command_argument$& for an SMTPUTF8 argument.
41199
41200 There is no support for LMTP on Unix sockets.
41201 Using the "lmtp" protocol option on an smtp transport,
41202 for LMTP over TCP, should work as expected.
41203
41204 There is no support for DSN unitext handling,
41205 and no provision for converting logging from or to UTF-8.
41206
41207
41208
41209 .section "MDA operations" SECTi18nMDA
41210 To aid in constructing names suitable for IMAP folders
41211 the following expansion operator can be used:
41212 .code
41213 ${imapfolder {<string>} {<sep>} {<specials>}}
41214 .endd
41215
41216 The string is converted from the charset specified by
41217 the "headers charset" command (in a filter file)
41218 or &%headers_charset%& main configuration option (otherwise),
41219 to the
41220 modified UTF-7 encoding specified by RFC 2060,
41221 with the following exception: All occurrences of <sep>
41222 (which has to be a single character)
41223 are replaced with periods ("."), and all periods and slashes that are not
41224 <sep> and are not in the <specials> string are BASE64 encoded.
41225
41226 The third argument can be omitted, defaulting to an empty string.
41227 The second argument can be omitted, defaulting to "/".
41228
41229 This is the encoding used by Courier for Maildir names on disk, and followed
41230 by many other IMAP servers.
41231
41232 Examples:
41233 .display
41234 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41235 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41236 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41237 .endd
41238
41239 Note that the source charset setting is vital, and also that characters
41240 must be representable in UTF-16.
41241
41242
41243 . ////////////////////////////////////////////////////////////////////////////
41244 . ////////////////////////////////////////////////////////////////////////////
41245
41246 .chapter "Events" "CHAPevents" &&&
41247          "Events"
41248 .cindex events
41249
41250 The events mechanism in Exim can be used to intercept processing at a number
41251 of points.  It was originally invented to give a way to do customised logging
41252 actions (for example, to a database) but can also be used to modify some
41253 processing actions.
41254
41255 Most installations will never need to use Events.
41256 The support can be left out of a build by defining DISABLE_EVENT=yes
41257 in &_Local/Makefile_&.
41258
41259 There are two major classes of events: main and transport.
41260 The main configuration option &%event_action%& controls reception events;
41261 a transport option &%event_action%& controls delivery events.
41262
41263 Both options are a string which is expanded when the event fires.
41264 An example might look like:
41265 .cindex logging custom
41266 .code
41267 event_action = ${if eq {msg:delivery}{$event_name} \
41268 {${lookup pgsql {SELECT * FROM record_Delivery( \
41269     '${quote_pgsql:$sender_address_domain}',\
41270     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41271     '${quote_pgsql:$domain}', \
41272     '${quote_pgsql:${lc:$local_part}}', \
41273     '${quote_pgsql:$host_address}', \
41274     '${quote_pgsql:${lc:$host}}', \
41275     '${quote_pgsql:$message_exim_id}')}} \
41276 } {}}
41277 .endd
41278
41279 Events have names which correspond to the point in process at which they fire.
41280 The name is placed in the variable &$event_name$& and the event action
41281 expansion must check this, as it will be called for every possible event type.
41282
41283 .new
41284 The current list of events is:
41285 .wen
41286 .display
41287 &`dane:fail              after    transport  `& per connection
41288 &`msg:complete           after    main       `& per message
41289 &`msg:defer              after    transport  `& per message per delivery try
41290 &`msg:delivery           after    transport  `& per recipient
41291 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41292 &`msg:rcpt:defer         after    transport  `& per recipient
41293 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41294 &`msg:fail:delivery      after    transport  `& per recipient
41295 &`msg:fail:internal      after    main       `& per recipient
41296 &`tcp:connect            before   transport  `& per connection
41297 &`tcp:close              after    transport  `& per connection
41298 &`tls:cert               before   both       `& per certificate in verification chain
41299 &`smtp:connect           after    transport  `& per connection
41300 &`smtp:ehlo              after    transport  `& per connection
41301 .endd
41302 New event types may be added in future.
41303
41304 The event name is a colon-separated list, defining the type of
41305 event in a tree of possibilities.  It may be used as a list
41306 or just matched on as a whole.  There will be no spaces in the name.
41307
41308 The second column in the table above describes whether the event fires
41309 before or after the action is associates with.  Those which fire before
41310 can be used to affect that action (more on this below).
41311
41312 The third column in the table above says what section of the configuration
41313 should define the event action.
41314
41315 An additional variable, &$event_data$&, is filled with information varying
41316 with the event type:
41317 .display
41318 &`dane:fail            `& failure reason
41319 &`msg:defer            `& error string
41320 &`msg:delivery         `& smtp confirmation message
41321 &`msg:fail:internal    `& failure reason
41322 &`msg:fail:delivery    `& smtp error message
41323 &`msg:host:defer       `& error string
41324 &`msg:rcpt:host:defer  `& error string
41325 &`msg:rcpt:defer       `& error string
41326 &`tls:cert             `& verification chain depth
41327 &`smtp:connect         `& smtp banner
41328 &`smtp:ehlo            `& smtp ehlo response
41329 .endd
41330
41331 The :defer events populate one extra variable: &$event_defer_errno$&.
41332
41333 For complex operations an ACL expansion can be used in &%event_action%&
41334 however due to the multiple contexts that Exim operates in during
41335 the course of its processing:
41336 .ilist
41337 variables set in transport events will not be visible outside that
41338 transport call
41339 .next
41340 acl_m variables in a server context are lost on a new connection,
41341 and after smtp helo/ehlo/mail/starttls/rset commands
41342 .endlist
41343 Using an ACL expansion with the logwrite modifier can be
41344 a useful way of writing to the main log.
41345
41346 The expansion of the event_action option should normally
41347 return an empty string.  Should it return anything else the
41348 following will be forced:
41349 .display
41350 &`tcp:connect      `&  do not connect
41351 &`tls:cert         `&  refuse verification
41352 &`smtp:connect     `&  close connection
41353 .endd
41354 All other message types ignore the result string, and
41355 no other use is made of it.
41356
41357 For a tcp:connect event, if the connection is being made to a proxy
41358 then the address and port variables will be that of the proxy and not
41359 the target system.
41360
41361 For tls:cert events, if GnuTLS is in use this will trigger only per
41362 chain element received on the connection.
41363 For OpenSSL it will trigger for every chain element including those
41364 loaded locally.
41365
41366 . ////////////////////////////////////////////////////////////////////////////
41367 . ////////////////////////////////////////////////////////////////////////////
41368
41369 .chapter "Adding new drivers or lookup types" "CHID13" &&&
41370          "Adding drivers or lookups"
41371 .cindex "adding drivers"
41372 .cindex "new drivers, adding"
41373 .cindex "drivers" "adding new"
41374 The following actions have to be taken in order to add a new router, transport,
41375 authenticator, or lookup type to Exim:
41376
41377 .olist
41378 Choose a name for the driver or lookup type that does not conflict with any
41379 existing name; I will use &"newdriver"& in what follows.
41380 .next
41381 Add to &_src/EDITME_& the line:
41382 .display
41383 <&'type'&>&`_NEWDRIVER=yes`&
41384 .endd
41385 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
41386 code is not to be included in the binary by default, comment this line out. You
41387 should also add any relevant comments about the driver or lookup type.
41388 .next
41389 Add to &_src/config.h.defaults_& the line:
41390 .code
41391 #define <type>_NEWDRIVER
41392 .endd
41393 .next
41394 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
41395 and create a table entry as is done for all the other drivers and lookup types.
41396 .next
41397 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
41398 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
41399 Add your &`NEWDRIVER`& to that list.
41400 As long as the dynamic module would be named &_newdriver.so_&, you can use the
41401 simple form that most lookups have.
41402 .next
41403 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
41404 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
41405 driver or lookup type and add it to the definition of OBJ.
41406 .next
41407 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
41408 definition of OBJ_MACRO.  Add a set of line to do the compile also.
41409 .next
41410 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
41411 &_src_&.
41412 .next
41413 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
41414 as for other drivers and lookups.
41415 .endlist
41416
41417 Then all you need to do is write the code! A good way to start is to make a
41418 proforma by copying an existing module of the same type, globally changing all
41419 occurrences of the name, and cutting out most of the code. Note that any
41420 options you create must be listed in alphabetical order, because the tables are
41421 searched using a binary chop procedure.
41422
41423 There is a &_README_& file in each of the sub-directories of &_src_& describing
41424 the interface that is expected.
41425
41426
41427
41428
41429 . ////////////////////////////////////////////////////////////////////////////
41430 . ////////////////////////////////////////////////////////////////////////////
41431
41432 . /////////////////////////////////////////////////////////////////////////////
41433 . These lines are processing instructions for the Simple DocBook Processor that
41434 . Philip Hazel has developed as a less cumbersome way of making PostScript and
41435 . PDFs than using xmlto and fop. They will be ignored by all other XML
41436 . processors.
41437 . /////////////////////////////////////////////////////////////////////////////
41438
41439 .literal xml
41440 <?sdop
41441   format="newpage"
41442   foot_right_recto="&chaptertitle;"
41443   foot_right_verso="&chaptertitle;"
41444 ?>
41445 .literal off
41446
41447 .makeindex "Options index"   "option"
41448 .makeindex "Variables index" "variable"
41449 .makeindex "Concept index"   "concept"
41450
41451
41452 . /////////////////////////////////////////////////////////////////////////////
41453 . /////////////////////////////////////////////////////////////////////////////