5915a3af339abffa198de442c491851bc4ed3591
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.94"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2020
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .new
375 .cindex "documentation"
376 This edition of the Exim specification applies to version &version() of Exim.
377 Substantive changes from the &previousversion; edition are marked in some
378 renditions of this document; this paragraph is so marked if the rendition is
379 capable of showing a change indicator.
380 .wen
381
382 This document is very much a reference manual; it is not a tutorial. The reader
383 is expected to have some familiarity with the SMTP mail transfer protocol and
384 with general Unix system administration. Although there are some discussions
385 and examples in places, the information is mostly organized in a way that makes
386 it easy to look up, rather than in a natural order for sequential reading.
387 Furthermore, this manual aims to cover every aspect of Exim in detail, including
388 a number of rarely-used, special-purpose features that are unlikely to be of
389 very wide interest.
390
391 .cindex "books about Exim"
392 An &"easier"& discussion of Exim which provides more in-depth explanatory,
393 introductory, and tutorial material can be found in a book entitled &'The Exim
394 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
395 (&url(https://www.uit.co.uk/exim-book/)).
396
397 The book also contains a chapter that gives a general introduction to SMTP and
398 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
399 with the latest release of Exim. (Note that the earlier book about Exim,
400 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
401
402 .cindex "Debian" "information sources"
403 If you are using a Debian distribution of Exim, you will find information about
404 Debian-specific features in the file
405 &_/usr/share/doc/exim4-base/README.Debian_&.
406 The command &(man update-exim.conf)& is another source of Debian-specific
407 information.
408
409 .cindex "&_doc/NewStuff_&"
410 .cindex "&_doc/ChangeLog_&"
411 .cindex "change log"
412 As Exim develops, there may be features in newer versions that have not
413 yet made it into this document, which is updated only when the most significant
414 digit of the fractional part of the version number changes. Specifications of
415 new features that are not yet in this manual are placed in the file
416 &_doc/NewStuff_& in the Exim distribution.
417
418 Some features may be classified as &"experimental"&. These may change
419 incompatibly while they are developing, or even be withdrawn. For this reason,
420 they are not documented in this manual. Information about experimental features
421 can be found in the file &_doc/experimental.txt_&.
422
423 All changes to Exim (whether new features, bug fixes, or other kinds of
424 change) are noted briefly in the file called &_doc/ChangeLog_&.
425
426 .cindex "&_doc/spec.txt_&"
427 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
428 that it can easily be searched with a text editor. Other files in the &_doc_&
429 directory are:
430
431 .table2 100pt
432 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
433 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
434 .row &_exim.8_&              "a man page of Exim's command line options"
435 .row &_experimental.txt_&    "documentation of experimental features"
436 .row &_filter.txt_&          "specification of the filter language"
437 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
438 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
439 .row &_openssl.txt_&         "installing a current OpenSSL release"
440 .endtable
441
442 The main specification and the specification of the filtering language are also
443 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
444 &<<SECTavail>>& below tells you how to get hold of these.
445
446
447
448 .section "FTP site and websites" "SECID2"
449 .cindex "website"
450 .cindex "FTP site"
451 The primary site for Exim source distributions is the &%exim.org%& FTP site,
452 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
453 website, are hosted at the University of Cambridge.
454
455 .cindex "wiki"
456 .cindex "FAQ"
457 As well as Exim distribution tar files, the Exim website contains a number of
458 differently formatted versions of the documentation. A recent addition to the
459 online information is the Exim wiki (&url(https://wiki.exim.org)),
460 which contains what used to be a separate FAQ, as well as various other
461 examples, tips, and know-how that have been contributed by Exim users.
462 The wiki site should always redirect to the correct place, which is currently
463 provided by GitHub, and is open to editing by anyone with a GitHub account.
464
465 .cindex Bugzilla
466 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
467 this to report bugs, and also to add items to the wish list. Please search
468 first to check that you are not duplicating a previous entry.
469 Please do not ask for configuration help in the bug-tracker.
470
471
472 .section "Mailing lists" "SECID3"
473 .cindex "mailing lists" "for Exim users"
474 The following Exim mailing lists exist:
475
476 .table2 140pt
477 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
478 .row &'exim-users@exim.org'&      "General discussion list"
479 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
480 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
481 .endtable
482
483 You can subscribe to these lists, change your existing subscriptions, and view
484 or search the archives via the mailing lists link on the Exim home page.
485 .cindex "Debian" "mailing list for"
486 If you are using a Debian distribution of Exim, you may wish to subscribe to
487 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
488 via this web page:
489 .display
490 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
491 .endd
492 Please ask Debian-specific questions on that list and not on the general Exim
493 lists.
494
495 .section "Bug reports" "SECID5"
496 .cindex "bug reports"
497 .cindex "reporting bugs"
498 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
499 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
500 whether some behaviour is a bug or not, the best thing to do is to post a
501 message to the &'exim-dev'& mailing list and have it discussed.
502
503
504
505 .section "Where to find the Exim distribution" "SECTavail"
506 .cindex "FTP site"
507 .cindex "HTTPS download site"
508 .cindex "distribution" "FTP site"
509 .cindex "distribution" "https site"
510 The master distribution site for the Exim distribution is
511 .display
512 &url(https://downloads.exim.org/)
513 .endd
514 The service is available over HTTPS, HTTP and FTP.
515 We encourage people to migrate to HTTPS.
516
517 The content served at &url(https://downloads.exim.org/) is identical to the
518 content served at &url(https://ftp.exim.org/pub/exim) and
519 &url(ftp://ftp.exim.org/pub/exim).
520
521 If accessing via a hostname containing &'ftp'&, then the file references that
522 follow are relative to the &_exim_& directories at these sites.
523 If accessing via the hostname &'downloads'& then the subdirectories described
524 here are top-level directories.
525
526 There are now quite a number of independent mirror sites around
527 the world. Those that I know about are listed in the file called &_Mirrors_&.
528
529 Within the top exim directory there are subdirectories called &_exim3_& (for
530 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
531 distributions), and &_Testing_& for testing versions. In the &_exim4_&
532 subdirectory, the current release can always be found in files called
533 .display
534 &_exim-n.nn.tar.xz_&
535 &_exim-n.nn.tar.gz_&
536 &_exim-n.nn.tar.bz2_&
537 .endd
538 where &'n.nn'& is the highest such version number in the directory. The three
539 files contain identical data; the only difference is the type of compression.
540 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
541 most portable to old systems.
542
543 .cindex "distribution" "signing details"
544 .cindex "distribution" "public key"
545 .cindex "public key for signed distribution"
546 The distributions will be PGP signed by an individual key of the Release
547 Coordinator.  This key will have a uid containing an email address in the
548 &'exim.org'& domain and will have signatures from other people, including
549 other Exim maintainers.  We expect that the key will be in the "strong set" of
550 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
551 PGP keys, a version of which can be found in the release directory in the file
552 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
553 such as &'pool.sks-keyservers.net'&.
554
555 At the time of the last update, releases were being made by Jeremy Harris and signed
556 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
557 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
558 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
559
560 The signatures for the tar bundles are in:
561 .display
562 &_exim-n.nn.tar.xz.asc_&
563 &_exim-n.nn.tar.gz.asc_&
564 &_exim-n.nn.tar.bz2.asc_&
565 .endd
566 For each released version, the log of changes is made available in a
567 separate file in the directory &_ChangeLogs_& so that it is possible to
568 find out what has changed without having to download the entire distribution.
569
570 .cindex "documentation" "available formats"
571 The main distribution contains ASCII versions of this specification and other
572 documentation; other formats of the documents are available in separate files
573 inside the &_exim4_& directory of the FTP site:
574 .display
575 &_exim-html-n.nn.tar.gz_&
576 &_exim-pdf-n.nn.tar.gz_&
577 &_exim-postscript-n.nn.tar.gz_&
578 &_exim-texinfo-n.nn.tar.gz_&
579 .endd
580 These tar files contain only the &_doc_& directory, not the complete
581 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
582
583
584 .section "Limitations" "SECID6"
585 .ilist
586 .cindex "limitations of Exim"
587 .cindex "bang paths" "not handled by Exim"
588 Exim is designed for use as an Internet MTA, and therefore handles addresses in
589 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
590 simple two-component bang paths can be converted by a straightforward rewriting
591 configuration. This restriction does not prevent Exim from being interfaced to
592 UUCP as a transport mechanism, provided that domain addresses are used.
593 .next
594 .cindex "domainless addresses"
595 .cindex "address" "without domain"
596 Exim insists that every address it handles has a domain attached. For incoming
597 local messages, domainless addresses are automatically qualified with a
598 configured domain value. Configuration options specify from which remote
599 systems unqualified addresses are acceptable. These are then qualified on
600 arrival.
601 .next
602 .cindex "transport" "external"
603 .cindex "external transports"
604 The only external transport mechanisms that are currently implemented are SMTP
605 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
606 transport is available, and there are facilities for writing messages to files
607 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
608 to send messages to other transport mechanisms such as UUCP, provided they can
609 handle domain-style addresses. Batched SMTP input is also catered for.
610 .next
611 Exim is not designed for storing mail for dial-in hosts. When the volumes of
612 such mail are large, it is better to get the messages &"delivered"& into files
613 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
614 other means.
615 .next
616 Although Exim does have basic facilities for scanning incoming messages, these
617 are not comprehensive enough to do full virus or spam scanning. Such operations
618 are best carried out using additional specialized software packages. If you
619 compile Exim with the content-scanning extension, straightforward interfaces to
620 a number of common scanners are provided.
621 .endlist
622
623
624 .section "Runtime configuration" "SECID7"
625 Exim's runtime configuration is held in a single text file that is divided
626 into a number of sections. The entries in this file consist of keywords and
627 values, in the style of Smail 3 configuration files. A default configuration
628 file which is suitable for simple online installations is provided in the
629 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
630
631
632 .section "Calling interface" "SECID8"
633 .cindex "Sendmail compatibility" "command line interface"
634 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
635 can be a straight replacement for &_/usr/lib/sendmail_& or
636 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
637 about Sendmail in order to run Exim. For actions other than sending messages,
638 Sendmail-compatible options also exist, but those that produce output (for
639 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
640 format. There are also some additional options that are compatible with Smail
641 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
642 documents all Exim's command line options. This information is automatically
643 made into the man page that forms part of the Exim distribution.
644
645 Control of messages in the queue can be done via certain privileged command
646 line options. There is also an optional monitor program called &'eximon'&,
647 which displays current information in an X window, and which contains a menu
648 interface to Exim's command line administration options.
649
650
651
652 .section "Terminology" "SECID9"
653 .cindex "terminology definitions"
654 .cindex "body of message" "definition of"
655 The &'body'& of a message is the actual data that the sender wants to transmit.
656 It is the last part of a message and is separated from the &'header'& (see
657 below) by a blank line.
658
659 .cindex "bounce message" "definition of"
660 When a message cannot be delivered, it is normally returned to the sender in a
661 delivery failure message or a &"non-delivery report"& (NDR). The term
662 &'bounce'& is commonly used for this action, and the error reports are often
663 called &'bounce messages'&. This is a convenient shorthand for &"delivery
664 failure error report"&. Such messages have an empty sender address in the
665 message's &'envelope'& (see below) to ensure that they cannot themselves give
666 rise to further bounce messages.
667
668 The term &'default'& appears frequently in this manual. It is used to qualify a
669 value which is used in the absence of any setting in the configuration. It may
670 also qualify an action which is taken unless a configuration setting specifies
671 otherwise.
672
673 The term &'defer'& is used when the delivery of a message to a specific
674 destination cannot immediately take place for some reason (a remote host may be
675 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
676 until a later time.
677
678 The word &'domain'& is sometimes used to mean all but the first component of a
679 host's name. It is &'not'& used in that sense here, where it normally refers to
680 the part of an email address following the @ sign.
681
682 .cindex "envelope, definition of"
683 .cindex "sender" "definition of"
684 A message in transit has an associated &'envelope'&, as well as a header and a
685 body. The envelope contains a sender address (to which bounce messages should
686 be delivered), and any number of recipient addresses. References to the
687 sender or the recipients of a message usually mean the addresses in the
688 envelope. An MTA uses these addresses for delivery, and for returning bounce
689 messages, not the addresses that appear in the header lines.
690
691 .cindex "message" "header, definition of"
692 .cindex "header section" "definition of"
693 The &'header'& of a message is the first part of a message's text, consisting
694 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
695 &'Subject:'&, etc. Long header lines can be split over several text lines by
696 indenting the continuations. The header is separated from the body by a blank
697 line.
698
699 .cindex "local part" "definition of"
700 .cindex "domain" "definition of"
701 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
702 part of an email address that precedes the @ sign. The part that follows the
703 @ sign is called the &'domain'& or &'mail domain'&.
704
705 .cindex "local delivery" "definition of"
706 .cindex "remote delivery, definition of"
707 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
708 delivery to a file or a pipe on the local host from delivery by SMTP over
709 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
710 host it is running on are &'remote'&.
711
712 .cindex "return path" "definition of"
713 &'Return path'& is another name that is used for the sender address in a
714 message's envelope.
715
716 .cindex "queue" "definition of"
717 The term &'queue'& is used to refer to the set of messages awaiting delivery
718 because this term is in widespread use in the context of MTAs. However, in
719 Exim's case, the reality is more like a pool than a queue, because there is
720 normally no ordering of waiting messages.
721
722 .cindex "queue runner" "definition of"
723 The term &'queue runner'& is used to describe a process that scans the queue
724 and attempts to deliver those messages whose retry times have come. This term
725 is used by other MTAs and also relates to the command &%runq%&, but in Exim
726 the waiting messages are normally processed in an unpredictable order.
727
728 .cindex "spool directory" "definition of"
729 The term &'spool directory'& is used for a directory in which Exim keeps the
730 messages in its queue &-- that is, those that it is in the process of
731 delivering. This should not be confused with the directory in which local
732 mailboxes are stored, which is called a &"spool directory"& by some people. In
733 the Exim documentation, &"spool"& is always used in the first sense.
734
735
736
737
738
739
740 . ////////////////////////////////////////////////////////////////////////////
741 . ////////////////////////////////////////////////////////////////////////////
742
743 .chapter "Incorporated code" "CHID2"
744 .cindex "incorporated code"
745 .cindex "regular expressions" "library"
746 .cindex "PCRE"
747 .cindex "OpenDMARC"
748 A number of pieces of external code are included in the Exim distribution.
749
750 .ilist
751 Regular expressions are supported in the main Exim program and in the
752 Exim monitor using the freely-distributable PCRE library, copyright
753 &copy; University of Cambridge. The source to PCRE is no longer shipped with
754 Exim, so you will need to use the version of PCRE shipped with your system,
755 or obtain and install the full version of the library from
756 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
757 .next
758 .cindex "cdb" "acknowledgment"
759 Support for the cdb (Constant DataBase) lookup method is provided by code
760 contributed by Nigel Metheringham of (at the time he contributed it) Planet
761 Online Ltd. The implementation is completely contained within the code of Exim.
762 It does not link against an external cdb library. The code contains the
763 following statements:
764
765 .blockquote
766 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
767
768 This program is free software; you can redistribute it and/or modify it under
769 the terms of the GNU General Public License as published by the Free Software
770 Foundation; either version 2 of the License, or (at your option) any later
771 version.
772 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
773 the spec and sample code for cdb can be obtained from
774 &url(https://cr.yp.to/cdb.html). This implementation borrows
775 some code from Dan Bernstein's implementation (which has no license
776 restrictions applied to it).
777 .endblockquote
778 .next
779 .cindex "SPA authentication"
780 .cindex "Samba project"
781 .cindex "Microsoft Secure Password Authentication"
782 Client support for Microsoft's &'Secure Password Authentication'& is provided
783 by code contributed by Marc Prud'hommeaux. Server support was contributed by
784 Tom Kistner. This includes code taken from the Samba project, which is released
785 under the Gnu GPL.
786 .next
787 .cindex "Cyrus"
788 .cindex "&'pwcheck'& daemon"
789 .cindex "&'pwauthd'& daemon"
790 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
791 by code taken from the Cyrus-SASL library and adapted by Alexander S.
792 Sabourenkov. The permission notice appears below, in accordance with the
793 conditions expressed therein.
794
795 .blockquote
796 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
797
798 Redistribution and use in source and binary forms, with or without
799 modification, are permitted provided that the following conditions
800 are met:
801
802 .olist
803 Redistributions of source code must retain the above copyright
804 notice, this list of conditions and the following disclaimer.
805 .next
806 Redistributions in binary form must reproduce the above copyright
807 notice, this list of conditions and the following disclaimer in
808 the documentation and/or other materials provided with the
809 distribution.
810 .next
811 The name &"Carnegie Mellon University"& must not be used to
812 endorse or promote products derived from this software without
813 prior written permission. For permission or any other legal
814 details, please contact
815 .display
816               Office of Technology Transfer
817               Carnegie Mellon University
818               5000 Forbes Avenue
819               Pittsburgh, PA  15213-3890
820               (412) 268-4387, fax: (412) 268-7395
821               tech-transfer@andrew.cmu.edu
822 .endd
823 .next
824 Redistributions of any form whatsoever must retain the following
825 acknowledgment:
826
827 &"This product includes software developed by Computing Services
828 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
829
830 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
831 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
832 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
833 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
834 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
835 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
836 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
837 .endlist
838 .endblockquote
839
840 .next
841 .cindex "Exim monitor" "acknowledgment"
842 .cindex "X-windows"
843 .cindex "Athena"
844 The Exim Monitor program, which is an X-Window application, includes
845 modified versions of the Athena StripChart and TextPop widgets.
846 This code is copyright by DEC and MIT, and their permission notice appears
847 below, in accordance with the conditions expressed therein.
848
849 .blockquote
850 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
851 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
852
853 All Rights Reserved
854
855 Permission to use, copy, modify, and distribute this software and its
856 documentation for any purpose and without fee is hereby granted,
857 provided that the above copyright notice appear in all copies and that
858 both that copyright notice and this permission notice appear in
859 supporting documentation, and that the names of Digital or MIT not be
860 used in advertising or publicity pertaining to distribution of the
861 software without specific, written prior permission.
862
863 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
864 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
865 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
866 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
867 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
868 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
869 SOFTWARE.
870 .endblockquote
871
872 .next
873 .cindex "opendmarc" "acknowledgment"
874 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
875 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
876 derived code are indicated in the respective source files. The full OpenDMARC
877 license is provided in the LICENSE.opendmarc file contained in the distributed
878 source code.
879
880 .next
881 Many people have contributed code fragments, some large, some small, that were
882 not covered by any specific license requirements. It is assumed that the
883 contributors are happy to see their code incorporated into Exim under the GPL.
884 .endlist
885
886
887
888
889
890 . ////////////////////////////////////////////////////////////////////////////
891 . ////////////////////////////////////////////////////////////////////////////
892
893 .chapter "How Exim receives and delivers mail" "CHID11" &&&
894          "Receiving and delivering mail"
895
896
897 .section "Overall philosophy" "SECID10"
898 .cindex "design philosophy"
899 Exim is designed to work efficiently on systems that are permanently connected
900 to the Internet and are handling a general mix of mail. In such circumstances,
901 most messages can be delivered immediately. Consequently, Exim does not
902 maintain independent queues of messages for specific domains or hosts, though
903 it does try to send several messages in a single SMTP connection after a host
904 has been down, and it also maintains per-host retry information.
905
906
907 .section "Policy control" "SECID11"
908 .cindex "policy control" "overview"
909 Policy controls are now an important feature of MTAs that are connected to the
910 Internet. Perhaps their most important job is to stop MTAs from being abused as
911 &"open relays"& by misguided individuals who send out vast amounts of
912 unsolicited junk and want to disguise its source. Exim provides flexible
913 facilities for specifying policy controls on incoming mail:
914
915 .ilist
916 .cindex "&ACL;" "introduction"
917 Exim 4 (unlike previous versions of Exim) implements policy controls on
918 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
919 series of statements that may either grant or deny access. ACLs can be used at
920 several places in the SMTP dialogue while receiving a message from a remote
921 host. However, the most common places are after each RCPT command, and at the
922 very end of the message. The sysadmin can specify conditions for accepting or
923 rejecting individual recipients or the entire message, respectively, at these
924 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
925 error code.
926 .next
927 An ACL is also available for locally generated, non-SMTP messages. In this
928 case, the only available actions are to accept or deny the entire message.
929 .next
930 When Exim is compiled with the content-scanning extension, facilities are
931 provided in the ACL mechanism for passing the message to external virus and/or
932 spam scanning software. The result of such a scan is passed back to the ACL,
933 which can then use it to decide what to do with the message.
934 .next
935 When a message has been received, either from a remote host or from the local
936 host, but before the final acknowledgment has been sent, a locally supplied C
937 function called &[local_scan()]& can be run to inspect the message and decide
938 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
939 is accepted, the list of recipients can be modified by the function.
940 .next
941 Using the &[local_scan()]& mechanism is another way of calling external scanner
942 software. The &%SA-Exim%& add-on package works this way. It does not require
943 Exim to be compiled with the content-scanning extension.
944 .next
945 After a message has been accepted, a further checking mechanism is available in
946 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
947 runs at the start of every delivery process.
948 .endlist
949
950
951
952 .section "User filters" "SECID12"
953 .cindex "filter" "introduction"
954 .cindex "Sieve filter"
955 In a conventional Exim configuration, users are able to run private filters by
956 setting up appropriate &_.forward_& files in their home directories. See
957 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
958 configuration needed to support this, and the separate document entitled
959 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
960 of filtering are available:
961
962 .ilist
963 Sieve filters are written in the standard filtering language that is defined
964 by RFC 3028.
965 .next
966 Exim filters are written in a syntax that is unique to Exim, but which is more
967 powerful than Sieve, which it pre-dates.
968 .endlist
969
970 User filters are run as part of the routing process, described below.
971
972
973
974 .section "Message identification" "SECTmessiden"
975 .cindex "message ids" "details of format"
976 .cindex "format" "of message id"
977 .cindex "id of message"
978 .cindex "base62"
979 .cindex "base36"
980 .cindex "Darwin"
981 .cindex "Cygwin"
982 Every message handled by Exim is given a &'message id'& which is sixteen
983 characters long. It is divided into three parts, separated by hyphens, for
984 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
985 normally encoding numbers in base 62. However, in the Darwin operating
986 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
987 (avoiding the use of lower case letters) is used instead, because the message
988 id is used to construct filenames, and the names of files in those systems are
989 not always case-sensitive.
990
991 .cindex "pid (process id)" "re-use of"
992 The detail of the contents of the message id have changed as Exim has evolved.
993 Earlier versions relied on the operating system not re-using a process id (pid)
994 within one second. On modern operating systems, this assumption can no longer
995 be made, so the algorithm had to be changed. To retain backward compatibility,
996 the format of the message id was retained, which is why the following rules are
997 somewhat eccentric:
998
999 .ilist
1000 The first six characters of the message id are the time at which the message
1001 started to be received, to a granularity of one second. That is, this field
1002 contains the number of seconds since the start of the epoch (the normal Unix
1003 way of representing the date and time of day).
1004 .next
1005 After the first hyphen, the next six characters are the id of the process that
1006 received the message.
1007 .next
1008 There are two different possibilities for the final two characters:
1009 .olist
1010 .oindex "&%localhost_number%&"
1011 If &%localhost_number%& is not set, this value is the fractional part of the
1012 time of reception, normally in units of 1/2000 of a second, but for systems
1013 that must use base 36 instead of base 62 (because of case-insensitive file
1014 systems), the units are 1/1000 of a second.
1015 .next
1016 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1017 the fractional part of the time, which in this case is in units of 1/200
1018 (1/100) of a second.
1019 .endlist
1020 .endlist
1021
1022 After a message has been received, Exim waits for the clock to tick at the
1023 appropriate resolution before proceeding, so that if another message is
1024 received by the same process, or by another process with the same (re-used)
1025 pid, it is guaranteed that the time will be different. In most cases, the clock
1026 will already have ticked while the message was being received.
1027
1028
1029 .section "Receiving mail" "SECID13"
1030 .cindex "receiving mail"
1031 .cindex "message" "reception"
1032 The only way Exim can receive mail from another host is using SMTP over
1033 TCP/IP, in which case the sender and recipient addresses are transferred using
1034 SMTP commands. However, from a locally running process (such as a user's MUA),
1035 there are several possibilities:
1036
1037 .ilist
1038 If the process runs Exim with the &%-bm%& option, the message is read
1039 non-interactively (usually via a pipe), with the recipients taken from the
1040 command line, or from the body of the message if &%-t%& is also used.
1041 .next
1042 If the process runs Exim with the &%-bS%& option, the message is also read
1043 non-interactively, but in this case the recipients are listed at the start of
1044 the message in a series of SMTP RCPT commands, terminated by a DATA
1045 command. This is called &"batch SMTP"& format,
1046 but it isn't really SMTP. The SMTP commands are just another way of passing
1047 envelope addresses in a non-interactive submission.
1048 .next
1049 If the process runs Exim with the &%-bs%& option, the message is read
1050 interactively, using the SMTP protocol. A two-way pipe is normally used for
1051 passing data between the local process and the Exim process.
1052 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1053 example, the ACLs for SMTP commands are used for this form of submission.
1054 .next
1055 A local process may also make a TCP/IP call to the host's loopback address
1056 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1057 does not treat the loopback address specially. It treats all such connections
1058 in the same way as connections from other hosts.
1059 .endlist
1060
1061
1062 .cindex "message sender, constructed by Exim"
1063 .cindex "sender" "constructed by Exim"
1064 In the three cases that do not involve TCP/IP, the sender address is
1065 constructed from the login name of the user that called Exim and a default
1066 qualification domain (which can be set by the &%qualify_domain%& configuration
1067 option). For local or batch SMTP, a sender address that is passed using the
1068 SMTP MAIL command is ignored. However, the system administrator may allow
1069 certain users (&"trusted users"&) to specify a different sender addresses
1070 unconditionally, or all users to specify certain forms of different sender
1071 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1072 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1073 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1074 users to change sender addresses.
1075
1076 Messages received by either of the non-interactive mechanisms are subject to
1077 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1078 (either over TCP/IP or interacting with a local process) can be checked by a
1079 number of ACLs that operate at different times during the SMTP session. Either
1080 individual recipients or the entire message can be rejected if local policy
1081 requirements are not met. The &[local_scan()]& function (see chapter
1082 &<<CHAPlocalscan>>&) is run for all incoming messages.
1083
1084 Exim can be configured not to start a delivery process when a message is
1085 received; this can be unconditional, or depend on the number of incoming SMTP
1086 connections or the system load. In these situations, new messages wait on the
1087 queue until a queue runner process picks them up. However, in standard
1088 configurations under normal conditions, delivery is started as soon as a
1089 message is received.
1090
1091
1092
1093
1094
1095 .section "Handling an incoming message" "SECID14"
1096 .cindex "spool directory" "files that hold a message"
1097 .cindex "file" "how a message is held"
1098 When Exim accepts a message, it writes two files in its spool directory. The
1099 first contains the envelope information, the current status of the message, and
1100 the header lines, and the second contains the body of the message. The names of
1101 the two spool files consist of the message id, followed by &`-H`& for the
1102 file containing the envelope and header, and &`-D`& for the data file.
1103
1104 .cindex "spool directory" "&_input_& sub-directory"
1105 By default, all these message files are held in a single directory called
1106 &_input_& inside the general Exim spool directory. Some operating systems do
1107 not perform very well if the number of files in a directory gets large; to
1108 improve performance in such cases, the &%split_spool_directory%& option can be
1109 used. This causes Exim to split up the input files into 62 sub-directories
1110 whose names are single letters or digits. When this is done, the queue is
1111 processed one sub-directory at a time instead of all at once, which can improve
1112 overall performance even when there are not enough files in each directory to
1113 affect file system performance.
1114
1115 The envelope information consists of the address of the message's sender and
1116 the addresses of the recipients. This information is entirely separate from
1117 any addresses contained in the header lines. The status of the message includes
1118 a list of recipients who have already received the message. The format of the
1119 first spool file is described in chapter &<<CHAPspool>>&.
1120
1121 .cindex "rewriting" "addresses"
1122 Address rewriting that is specified in the rewrite section of the configuration
1123 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1124 both in the header lines and the envelope, at the time the message is accepted.
1125 If during the course of delivery additional addresses are generated (for
1126 example, via aliasing), these new addresses are rewritten as soon as they are
1127 generated. At the time a message is actually delivered (transported) further
1128 rewriting can take place; because this is a transport option, it can be
1129 different for different forms of delivery. It is also possible to specify the
1130 addition or removal of certain header lines at the time the message is
1131 delivered (see chapters &<<CHAProutergeneric>>& and
1132 &<<CHAPtransportgeneric>>&).
1133
1134
1135
1136 .section "Life of a message" "SECID15"
1137 .cindex "message" "life of"
1138 .cindex "message" "frozen"
1139 A message remains in the spool directory until it is completely delivered to
1140 its recipients or to an error address, or until it is deleted by an
1141 administrator or by the user who originally created it. In cases when delivery
1142 cannot proceed &-- for example when a message can neither be delivered to its
1143 recipients nor returned to its sender, the message is marked &"frozen"& on the
1144 spool, and no more deliveries are attempted.
1145
1146 .cindex "frozen messages" "thawing"
1147 .cindex "message" "thawing frozen"
1148 An administrator can &"thaw"& such messages when the problem has been
1149 corrected, and can also freeze individual messages by hand if necessary. In
1150 addition, an administrator can force a delivery error, causing a bounce message
1151 to be sent.
1152
1153 .oindex "&%timeout_frozen_after%&"
1154 .oindex "&%ignore_bounce_errors_after%&"
1155 There are options called &%ignore_bounce_errors_after%& and
1156 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1157 The first applies only to frozen bounces, the second to all frozen messages.
1158
1159 .cindex "message" "log file for"
1160 .cindex "log" "file for each message"
1161 While Exim is working on a message, it writes information about each delivery
1162 attempt to its main log file. This includes successful, unsuccessful, and
1163 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1164 lines are also written to a separate &'message log'& file for each message.
1165 These logs are solely for the benefit of the administrator and are normally
1166 deleted along with the spool files when processing of a message is complete.
1167 The use of individual message logs can be disabled by setting
1168 &%no_message_logs%&; this might give an improvement in performance on very busy
1169 systems.
1170
1171 .cindex "journal file"
1172 .cindex "file" "journal"
1173 All the information Exim itself needs to set up a delivery is kept in the first
1174 spool file, along with the header lines. When a successful delivery occurs, the
1175 address is immediately written at the end of a journal file, whose name is the
1176 message id followed by &`-J`&. At the end of a delivery run, if there are some
1177 addresses left to be tried again later, the first spool file (the &`-H`& file)
1178 is updated to indicate which these are, and the journal file is then deleted.
1179 Updating the spool file is done by writing a new file and renaming it, to
1180 minimize the possibility of data loss.
1181
1182 Should the system or Exim crash after a successful delivery but before
1183 the spool file has been updated, the journal is left lying around. The next
1184 time Exim attempts to deliver the message, it reads the journal file and
1185 updates the spool file before proceeding. This minimizes the chances of double
1186 deliveries caused by crashes.
1187
1188
1189
1190 .section "Processing an address for delivery" "SECTprocaddress"
1191 .cindex "drivers" "definition of"
1192 .cindex "router" "definition of"
1193 .cindex "transport" "definition of"
1194 The main delivery processing elements of Exim are called &'routers'& and
1195 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1196 number of them is provided in the source distribution, and compile-time options
1197 specify which ones are included in the binary. Runtime options specify which
1198 ones are actually used for delivering messages.
1199
1200 .cindex "drivers" "instance definition"
1201 Each driver that is specified in the runtime configuration is an &'instance'&
1202 of that particular driver type. Multiple instances are allowed; for example,
1203 you can set up several different &(smtp)& transports, each with different
1204 option values that might specify different ports or different timeouts. Each
1205 instance has its own identifying name. In what follows we will normally use the
1206 instance name when discussing one particular instance (that is, one specific
1207 configuration of the driver), and the generic driver name when discussing
1208 the driver's features in general.
1209
1210 A &'router'& is a driver that operates on an address, either determining how
1211 its delivery should happen, by assigning it to a specific transport, or
1212 converting the address into one or more new addresses (for example, via an
1213 alias file). A router may also explicitly choose to fail an address, causing it
1214 to be bounced.
1215
1216 A &'transport'& is a driver that transmits a copy of the message from Exim's
1217 spool to some destination. There are two kinds of transport: for a &'local'&
1218 transport, the destination is a file or a pipe on the local host, whereas for a
1219 &'remote'& transport the destination is some other host. A message is passed
1220 to a specific transport as a result of successful routing. If a message has
1221 several recipients, it may be passed to a number of different transports.
1222
1223 .cindex "preconditions" "definition of"
1224 An address is processed by passing it to each configured router instance in
1225 turn, subject to certain preconditions, until a router accepts the address or
1226 specifies that it should be bounced. We will describe this process in more
1227 detail shortly. First, as a simple example, we consider how each recipient
1228 address in a message is processed in a small configuration of three routers.
1229
1230 To make this a more concrete example, it is described in terms of some actual
1231 routers, but remember, this is only an example. You can configure Exim's
1232 routers in many different ways, and there may be any number of routers in a
1233 configuration.
1234
1235 The first router that is specified in a configuration is often one that handles
1236 addresses in domains that are not recognized specifically by the local host.
1237 Typically these are addresses for arbitrary domains on the Internet. A precondition
1238 is set up which looks for the special domains known to the host (for example,
1239 its own domain name), and the router is run for addresses that do &'not'&
1240 match. Typically, this is a router that looks up domains in the DNS in order to
1241 find the hosts to which this address routes. If it succeeds, the address is
1242 assigned to a suitable SMTP transport; if it does not succeed, the router is
1243 configured to fail the address.
1244
1245 The second router is reached only when the domain is recognized as one that
1246 &"belongs"& to the local host. This router does redirection &-- also known as
1247 aliasing and forwarding. When it generates one or more new addresses from the
1248 original, each of them is routed independently from the start. Otherwise, the
1249 router may cause an address to fail, or it may simply decline to handle the
1250 address, in which case the address is passed to the next router.
1251
1252 The final router in many configurations is one that checks to see if the
1253 address belongs to a local mailbox. The precondition may involve a check to
1254 see if the local part is the name of a login account, or it may look up the
1255 local part in a file or a database. If its preconditions are not met, or if
1256 the router declines, we have reached the end of the routers. When this happens,
1257 the address is bounced.
1258
1259
1260
1261 .section "Processing an address for verification" "SECID16"
1262 .cindex "router" "for verification"
1263 .cindex "verifying address" "overview"
1264 As well as being used to decide how to deliver to an address, Exim's routers
1265 are also used for &'address verification'&. Verification can be requested as
1266 one of the checks to be performed in an ACL for incoming messages, on both
1267 sender and recipient addresses, and it can be tested using the &%-bv%& and
1268 &%-bvs%& command line options.
1269
1270 When an address is being verified, the routers are run in &"verify mode"&. This
1271 does not affect the way the routers work, but it is a state that can be
1272 detected. By this means, a router can be skipped or made to behave differently
1273 when verifying. A common example is a configuration in which the first router
1274 sends all messages to a message-scanning program unless they have been
1275 previously scanned. Thus, the first router accepts all addresses without any
1276 checking, making it useless for verifying. Normally, the &%no_verify%& option
1277 would be set for such a router, causing it to be skipped in verify mode.
1278
1279
1280
1281
1282 .section "Running an individual router" "SECTrunindrou"
1283 .cindex "router" "running details"
1284 .cindex "preconditions" "checking"
1285 .cindex "router" "result of running"
1286 As explained in the example above, a number of preconditions are checked before
1287 running a router. If any are not met, the router is skipped, and the address is
1288 passed to the next router. When all the preconditions on a router &'are'& met,
1289 the router is run. What happens next depends on the outcome, which is one of
1290 the following:
1291
1292 .ilist
1293 &'accept'&: The router accepts the address, and either assigns it to a
1294 transport or generates one or more &"child"& addresses. Processing the
1295 original address ceases
1296 .oindex "&%unseen%&"
1297 unless the &%unseen%& option is set on the router. This option
1298 can be used to set up multiple deliveries with different routing (for example,
1299 for keeping archive copies of messages). When &%unseen%& is set, the address is
1300 passed to the next router. Normally, however, an &'accept'& return marks the
1301 end of routing.
1302
1303 Any child addresses generated by the router are processed independently,
1304 starting with the first router by default. It is possible to change this by
1305 setting the &%redirect_router%& option to specify which router to start at for
1306 child addresses. Unlike &%pass_router%& (see below) the router specified by
1307 &%redirect_router%& may be anywhere in the router configuration.
1308 .next
1309 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1310 requests that the address be passed to another router. By default, the address
1311 is passed to the next router, but this can be changed by setting the
1312 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1313 must be below the current router (to avoid loops).
1314 .next
1315 &'decline'&: The router declines to accept the address because it does not
1316 recognize it at all. By default, the address is passed to the next router, but
1317 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1318 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1319 &'decline'& into &'fail'&.
1320 .next
1321 &'fail'&: The router determines that the address should fail, and queues it for
1322 the generation of a bounce message. There is no further processing of the
1323 original address unless &%unseen%& is set on the router.
1324 .next
1325 &'defer'&: The router cannot handle the address at the present time. (A
1326 database may be offline, or a DNS lookup may have timed out.) No further
1327 processing of the address happens in this delivery attempt. It is tried again
1328 next time the message is considered for delivery.
1329 .next
1330 &'error'&: There is some error in the router (for example, a syntax error in
1331 its configuration). The action is as for defer.
1332 .endlist
1333
1334 If an address reaches the end of the routers without having been accepted by
1335 any of them, it is bounced as unrouteable. The default error message in this
1336 situation is &"unrouteable address"&, but you can set your own message by
1337 making use of the &%cannot_route_message%& option. This can be set for any
1338 router; the value from the last router that &"saw"& the address is used.
1339
1340 Sometimes while routing you want to fail a delivery when some conditions are
1341 met but others are not, instead of passing the address on for further routing.
1342 You can do this by having a second router that explicitly fails the delivery
1343 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1344 facility for this purpose.
1345
1346
1347 .section "Duplicate addresses" "SECID17"
1348 .cindex "case of local parts"
1349 .cindex "address duplicate, discarding"
1350 .cindex "duplicate addresses"
1351 Once routing is complete, Exim scans the addresses that are assigned to local
1352 and remote transports and discards any duplicates that it finds. During this
1353 check, local parts are treated case-sensitively. This happens only when
1354 actually delivering a message; when testing routers with &%-bt%&, all the
1355 routed addresses are shown.
1356
1357
1358
1359 .section "Router preconditions" "SECTrouprecon"
1360 .cindex "router" "preconditions, order of processing"
1361 .cindex "preconditions" "order of processing"
1362 The preconditions that are tested for each router are listed below, in the
1363 order in which they are tested. The individual configuration options are
1364 described in more detail in chapter &<<CHAProutergeneric>>&.
1365
1366 .ilist
1367 .cindex affix "router precondition"
1368 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1369 the local parts handled by the router may or must have certain prefixes and/or
1370 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1371 skipped. These conditions are tested first. When an affix is present, it is
1372 removed from the local part before further processing, including the evaluation
1373 of any other conditions.
1374 .next
1375 Routers can be designated for use only when not verifying an address, that is,
1376 only when routing it for delivery (or testing its delivery routing). If the
1377 &%verify%& option is set false, the router is skipped when Exim is verifying an
1378 address.
1379 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1380 &%verify_recipient%&, which independently control the use of the router for
1381 sender and recipient verification. You can set these options directly if
1382 you want a router to be used for only one type of verification.
1383 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1384 .next
1385 If the &%address_test%& option is set false, the router is skipped when Exim is
1386 run with the &%-bt%& option to test an address routing. This can be helpful
1387 when the first router sends all new messages to a scanner of some sort; it
1388 makes it possible to use &%-bt%& to test subsequent delivery routing without
1389 having to simulate the effect of the scanner.
1390 .next
1391 Routers can be designated for use only when verifying an address, as
1392 opposed to routing it for delivery. The &%verify_only%& option controls this.
1393 Again, cutthrough delivery counts as a verification.
1394 .next
1395 Individual routers can be explicitly skipped when running the routers to
1396 check an address given in the SMTP EXPN command (see the &%expn%& option).
1397 .next
1398 If the &%domains%& option is set, the domain of the address must be in the set
1399 of domains that it defines.
1400 .next
1401 .vindex "&$local_part_prefix$&"
1402 .vindex "&$local_part_prefix_v$&"
1403 .vindex "&$local_part$&"
1404 .vindex "&$local_part_suffix$&"
1405 .vindex "&$local_part_suffix_v$&"
1406 .cindex affix "router precondition"
1407 If the &%local_parts%& option is set, the local part of the address must be in
1408 the set of local parts that it defines. If &%local_part_prefix%& or
1409 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1410 part before this check. If you want to do precondition tests on local parts
1411 that include affixes, you can do so by using a &%condition%& option (see below)
1412 that uses the variables &$local_part$&, &$local_part_prefix$&,
1413 &$local_part_prefix_v$&, &$local_part_suffix$&
1414 and &$local_part_suffix_v$& as necessary.
1415 .next
1416 .vindex "&$local_user_uid$&"
1417 .vindex "&$local_user_gid$&"
1418 .vindex "&$home$&"
1419 If the &%check_local_user%& option is set, the local part must be the name of
1420 an account on the local host. If this check succeeds, the uid and gid of the
1421 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1422 user's home directory is placed in &$home$&; these values can be used in the
1423 remaining preconditions.
1424 .next
1425 If the &%router_home_directory%& option is set, it is expanded at this point,
1426 because it overrides the value of &$home$&. If this expansion were left till
1427 later, the value of &$home$& as set by &%check_local_user%& would be used in
1428 subsequent tests. Having two different values of &$home$& in the same router
1429 could lead to confusion.
1430 .next
1431 If the &%senders%& option is set, the envelope sender address must be in the
1432 set of addresses that it defines.
1433 .next
1434 If the &%require_files%& option is set, the existence or non-existence of
1435 specified files is tested.
1436 .next
1437 .cindex "customizing" "precondition"
1438 If the &%condition%& option is set, it is evaluated and tested. This option
1439 uses an expanded string to allow you to set up your own custom preconditions.
1440 Expanded strings are described in chapter &<<CHAPexpand>>&.
1441 .endlist
1442
1443
1444 Note that &%require_files%& comes near the end of the list, so you cannot use
1445 it to check for the existence of a file in which to lookup up a domain, local
1446 part, or sender. However, as these options are all expanded, you can use the
1447 &%exists%& expansion condition to make such tests within each condition. The
1448 &%require_files%& option is intended for checking files that the router may be
1449 going to use internally, or which are needed by a specific transport (for
1450 example, &_.procmailrc_&).
1451
1452
1453
1454 .section "Delivery in detail" "SECID18"
1455 .cindex "delivery" "in detail"
1456 When a message is to be delivered, the sequence of events is as follows:
1457
1458 .ilist
1459 If a system-wide filter file is specified, the message is passed to it. The
1460 filter may add recipients to the message, replace the recipients, discard the
1461 message, cause a new message to be generated, or cause the message delivery to
1462 fail. The format of the system filter file is the same as for Exim user filter
1463 files, described in the separate document entitled &'Exim's interfaces to mail
1464 filtering'&.
1465 .cindex "Sieve filter" "not available for system filter"
1466 (&*Note*&: Sieve cannot be used for system filter files.)
1467
1468 Some additional features are available in system filters &-- see chapter
1469 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1470 filter only once per delivery attempt, however many recipients it has. However,
1471 if there are several delivery attempts because one or more addresses could not
1472 be immediately delivered, the system filter is run each time. The filter
1473 condition &%first_delivery%& can be used to detect the first run of the system
1474 filter.
1475 .next
1476 Each recipient address is offered to each configured router, in turn, subject to
1477 its preconditions, until one is able to handle it. If no router can handle the
1478 address, that is, if they all decline, the address is failed. Because routers
1479 can be targeted at particular domains, several locally handled domains can be
1480 processed entirely independently of each other.
1481 .next
1482 .cindex "routing" "loops in"
1483 .cindex "loop" "while routing"
1484 A router that accepts an address may assign it to a local or a remote
1485 transport. However, the transport is not run at this time. Instead, the address
1486 is placed on a list for the particular transport, which will be run later.
1487 Alternatively, the router may generate one or more new addresses (typically
1488 from alias, forward, or filter files). New addresses are fed back into this
1489 process from the top, but in order to avoid loops, a router ignores any address
1490 which has an identically-named ancestor that was processed by itself.
1491 .next
1492 When all the routing has been done, addresses that have been successfully
1493 handled are passed to their assigned transports. When local transports are
1494 doing real local deliveries, they handle only one address at a time, but if a
1495 local transport is being used as a pseudo-remote transport (for example, to
1496 collect batched SMTP messages for transmission by some other means) multiple
1497 addresses can be handled. Remote transports can always handle more than one
1498 address at a time, but can be configured not to do so, or to restrict multiple
1499 addresses to the same domain.
1500 .next
1501 Each local delivery to a file or a pipe runs in a separate process under a
1502 non-privileged uid, and these deliveries are run one at a time. Remote
1503 deliveries also run in separate processes, normally under a uid that is private
1504 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1505 run in parallel. The maximum number of simultaneous remote deliveries for any
1506 one message is set by the &%remote_max_parallel%& option.
1507 The order in which deliveries are done is not defined, except that all local
1508 deliveries happen before any remote deliveries.
1509 .next
1510 .cindex "queue runner"
1511 When it encounters a local delivery during a queue run, Exim checks its retry
1512 database to see if there has been a previous temporary delivery failure for the
1513 address before running the local transport. If there was a previous failure,
1514 Exim does not attempt a new delivery until the retry time for the address is
1515 reached. However, this happens only for delivery attempts that are part of a
1516 queue run. Local deliveries are always attempted when delivery immediately
1517 follows message reception, even if retry times are set for them. This makes for
1518 better behaviour if one particular message is causing problems (for example,
1519 causing quota overflow, or provoking an error in a filter file).
1520 .next
1521 .cindex "delivery" "retry in remote transports"
1522 Remote transports do their own retry handling, since an address may be
1523 deliverable to one of a number of hosts, each of which may have a different
1524 retry time. If there have been previous temporary failures and no host has
1525 reached its retry time, no delivery is attempted, whether in a queue run or
1526 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1527 .next
1528 If there were any permanent errors, a bounce message is returned to an
1529 appropriate address (the sender in the common case), with details of the error
1530 for each failing address. Exim can be configured to send copies of bounce
1531 messages to other addresses.
1532 .next
1533 .cindex "delivery" "deferral"
1534 If one or more addresses suffered a temporary failure, the message is left on
1535 the queue, to be tried again later. Delivery of these addresses is said to be
1536 &'deferred'&.
1537 .next
1538 When all the recipient addresses have either been delivered or bounced,
1539 handling of the message is complete. The spool files and message log are
1540 deleted, though the message log can optionally be preserved if required.
1541 .endlist
1542
1543
1544
1545
1546 .section "Retry mechanism" "SECID19"
1547 .cindex "delivery" "retry mechanism"
1548 .cindex "retry" "description of mechanism"
1549 .cindex "queue runner"
1550 Exim's mechanism for retrying messages that fail to get delivered at the first
1551 attempt is the queue runner process. You must either run an Exim daemon that
1552 uses the &%-q%& option with a time interval to start queue runners at regular
1553 intervals or use some other means (such as &'cron'&) to start them. If you do
1554 not arrange for queue runners to be run, messages that fail temporarily at the
1555 first attempt will remain in your queue forever. A queue runner process works
1556 its way through the queue, one message at a time, trying each delivery that has
1557 passed its retry time.
1558 You can run several queue runners at once.
1559
1560 Exim uses a set of configured rules to determine when next to retry the failing
1561 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1562 should give up trying to deliver to the address, at which point it generates a
1563 bounce message. If no retry rules are set for a particular host, address, and
1564 error combination, no retries are attempted, and temporary errors are treated
1565 as permanent.
1566
1567
1568
1569 .section "Temporary delivery failure" "SECID20"
1570 .cindex "delivery" "temporary failure"
1571 There are many reasons why a message may not be immediately deliverable to a
1572 particular address. Failure to connect to a remote machine (because it, or the
1573 connection to it, is down) is one of the most common. Temporary failures may be
1574 detected during routing as well as during the transport stage of delivery.
1575 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1576 is on a file system where the user is over quota. Exim can be configured to
1577 impose its own quotas on local mailboxes; where system quotas are set they will
1578 also apply.
1579
1580 If a host is unreachable for a period of time, a number of messages may be
1581 waiting for it by the time it recovers, and sending them in a single SMTP
1582 connection is clearly beneficial. Whenever a delivery to a remote host is
1583 deferred,
1584 .cindex "hints database" "deferred deliveries"
1585 Exim makes a note in its hints database, and whenever a successful
1586 SMTP delivery has happened, it looks to see if any other messages are waiting
1587 for the same host. If any are found, they are sent over the same SMTP
1588 connection, subject to a configuration limit as to the maximum number in any
1589 one connection.
1590
1591
1592
1593 .section "Permanent delivery failure" "SECID21"
1594 .cindex "delivery" "permanent failure"
1595 .cindex "bounce message" "when generated"
1596 When a message cannot be delivered to some or all of its intended recipients, a
1597 bounce message is generated. Temporary delivery failures turn into permanent
1598 errors when their timeout expires. All the addresses that fail in a given
1599 delivery attempt are listed in a single message. If the original message has
1600 many recipients, it is possible for some addresses to fail in one delivery
1601 attempt and others to fail subsequently, giving rise to more than one bounce
1602 message. The wording of bounce messages can be customized by the administrator.
1603 See chapter &<<CHAPemsgcust>>& for details.
1604
1605 .cindex "&'X-Failed-Recipients:'& header line"
1606 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1607 failed addresses, for the benefit of programs that try to analyse such messages
1608 automatically.
1609
1610 .cindex "bounce message" "recipient of"
1611 A bounce message is normally sent to the sender of the original message, as
1612 obtained from the message's envelope. For incoming SMTP messages, this is the
1613 address given in the MAIL command. However, when an address is expanded via a
1614 forward or alias file, an alternative address can be specified for delivery
1615 failures of the generated addresses. For a mailing list expansion (see section
1616 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1617 of the list.
1618
1619
1620
1621 .section "Failures to deliver bounce messages" "SECID22"
1622 .cindex "bounce message" "failure to deliver"
1623 If a bounce message (either locally generated or received from a remote host)
1624 itself suffers a permanent delivery failure, the message is left in the queue,
1625 but it is frozen, awaiting the attention of an administrator. There are options
1626 that can be used to make Exim discard such failed messages, or to keep them
1627 for only a short time (see &%timeout_frozen_after%& and
1628 &%ignore_bounce_errors_after%&).
1629
1630
1631
1632
1633
1634 . ////////////////////////////////////////////////////////////////////////////
1635 . ////////////////////////////////////////////////////////////////////////////
1636
1637 .chapter "Building and installing Exim" "CHID3"
1638 .scindex IIDbuex "building Exim"
1639
1640 .section "Unpacking" "SECID23"
1641 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1642 creates a directory with the name of the current release (for example,
1643 &_exim-&version()_&) into which the following files are placed:
1644
1645 .table2 140pt
1646 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1647 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1648   documented"
1649 .irow &_LICENCE_&         "the GNU General Public Licence"
1650 .irow &_Makefile_&        "top-level make file"
1651 .irow &_NOTICE_&          "conditions for the use of Exim"
1652 .irow &_README_&          "list of files, directories and simple build &&&
1653   instructions"
1654 .endtable
1655
1656 Other files whose names begin with &_README_& may also be present. The
1657 following subdirectories are created:
1658
1659 .table2 140pt
1660 .irow &_Local_&           "an empty directory for local configuration files"
1661 .irow &_OS_&              "OS-specific files"
1662 .irow &_doc_&             "documentation files"
1663 .irow &_exim_monitor_&    "source files for the Exim monitor"
1664 .irow &_scripts_&         "scripts used in the build process"
1665 .irow &_src_&             "remaining source files"
1666 .irow &_util_&            "independent utilities"
1667 .endtable
1668
1669 The main utility programs are contained in the &_src_& directory and are built
1670 with the Exim binary. The &_util_& directory contains a few optional scripts
1671 that may be useful to some sites.
1672
1673
1674 .section "Multiple machine architectures and operating systems" "SECID24"
1675 .cindex "building Exim" "multiple OS/architectures"
1676 The building process for Exim is arranged to make it easy to build binaries for
1677 a number of different architectures and operating systems from the same set of
1678 source files. Compilation does not take place in the &_src_& directory.
1679 Instead, a &'build directory'& is created for each architecture and operating
1680 system.
1681 .cindex "symbolic link" "to build directory"
1682 Symbolic links to the sources are installed in this directory, which is where
1683 the actual building takes place. In most cases, Exim can discover the machine
1684 architecture and operating system for itself, but the defaults can be
1685 overridden if necessary.
1686 .cindex compiler requirements
1687 .cindex compiler version
1688 A C99-capable compiler will be required for the build.
1689
1690
1691 .section "PCRE library" "SECTpcre"
1692 .cindex "PCRE library"
1693 Exim no longer has an embedded PCRE library as the vast majority of
1694 modern systems include PCRE as a system library, although you may need to
1695 install the PCRE package or the PCRE development package for your operating
1696 system. If your system has a normal PCRE installation the Exim build
1697 process will need no further configuration. If the library or the
1698 headers are in an unusual location you will need to either set the PCRE_LIBS
1699 and INCLUDE directives appropriately,
1700 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1701 If your operating system has no
1702 PCRE support then you will need to obtain and build the current PCRE
1703 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1704 More information on PCRE is available at &url(https://www.pcre.org/).
1705
1706 .section "DBM libraries" "SECTdb"
1707 .cindex "DBM libraries" "discussion of"
1708 .cindex "hints database" "DBM files used for"
1709 Even if you do not use any DBM files in your configuration, Exim still needs a
1710 DBM library in order to operate, because it uses indexed files for its hints
1711 databases. Unfortunately, there are a number of DBM libraries in existence, and
1712 different operating systems often have different ones installed.
1713
1714 .cindex "Solaris" "DBM library for"
1715 .cindex "IRIX, DBM library for"
1716 .cindex "BSD, DBM library for"
1717 .cindex "Linux, DBM library for"
1718 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1719 Linux distribution, the DBM configuration should happen automatically, and you
1720 may be able to ignore this section. Otherwise, you may have to learn more than
1721 you would like about DBM libraries from what follows.
1722
1723 .cindex "&'ndbm'& DBM library"
1724 Licensed versions of Unix normally contain a library of DBM functions operating
1725 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1726 versions of Unix seem to vary in what they contain as standard. In particular,
1727 some early versions of Linux have no default DBM library, and different
1728 distributors have chosen to bundle different libraries with their packaged
1729 versions. However, the more recent releases seem to have standardized on the
1730 Berkeley DB library.
1731
1732 Different DBM libraries have different conventions for naming the files they
1733 use. When a program opens a file called &_dbmfile_&, there are several
1734 possibilities:
1735
1736 .olist
1737 A traditional &'ndbm'& implementation, such as that supplied as part of
1738 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1739 .next
1740 .cindex "&'gdbm'& DBM library"
1741 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1742 compatibility interface it makes two different hard links to it with names
1743 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1744 filename is used unmodified.
1745 .next
1746 .cindex "Berkeley DB library"
1747 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1748 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1749 programmer exactly the same as the traditional &'ndbm'& implementation.
1750 .next
1751 If the Berkeley package is used in its native mode, it operates on a single
1752 file called &_dbmfile_&; the programmer's interface is somewhat different to
1753 the traditional &'ndbm'& interface.
1754 .next
1755 To complicate things further, there are several very different versions of the
1756 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1757 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1758 Maintenance of some of the earlier releases has ceased. All versions of
1759 Berkeley DB could be obtained from
1760 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1761 page with far newer versions listed.
1762 It is probably wise to plan to move your storage configurations away from
1763 Berkeley DB format, as today there are smaller and simpler alternatives more
1764 suited to Exim's usage model.
1765 .next
1766 .cindex "&'tdb'& DBM library"
1767 Yet another DBM library, called &'tdb'&, is available from
1768 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1769 operates on a single file.
1770 .endlist
1771
1772 .cindex "USE_DB"
1773 .cindex "DBM libraries" "configuration for building"
1774 Exim and its utilities can be compiled to use any of these interfaces. In order
1775 to use any version of the Berkeley DB package in native mode, you must set
1776 USE_DB in an appropriate configuration file (typically
1777 &_Local/Makefile_&). For example:
1778 .code
1779 USE_DB=yes
1780 .endd
1781 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1782 error is diagnosed if you set more than one of these.
1783
1784 At the lowest level, the build-time configuration sets none of these options,
1785 thereby assuming an interface of type (1). However, some operating system
1786 configuration files (for example, those for the BSD operating systems and
1787 Linux) assume type (4) by setting USE_DB as their default, and the
1788 configuration files for Cygwin set USE_GDBM. Anything you set in
1789 &_Local/Makefile_&, however, overrides these system defaults.
1790
1791 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1792 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1793 in one of these lines:
1794 .code
1795 DBMLIB = -ldb
1796 DBMLIB = -ltdb
1797 .endd
1798 Settings like that will work if the DBM library is installed in the standard
1799 place. Sometimes it is not, and the library's header file may also not be in
1800 the default path. You may need to set INCLUDE to specify where the header
1801 file is, and to specify the path to the library more fully in DBMLIB, as in
1802 this example:
1803 .code
1804 INCLUDE=-I/usr/local/include/db-4.1
1805 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1806 .endd
1807 There is further detailed discussion about the various DBM libraries in the
1808 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1809
1810
1811
1812 .section "Pre-building configuration" "SECID25"
1813 .cindex "building Exim" "pre-building configuration"
1814 .cindex "configuration for building Exim"
1815 .cindex "&_Local/Makefile_&"
1816 .cindex "&_src/EDITME_&"
1817 Before building Exim, a local configuration file that specifies options
1818 independent of any operating system has to be created with the name
1819 &_Local/Makefile_&. A template for this file is supplied as the file
1820 &_src/EDITME_&, and it contains full descriptions of all the option settings
1821 therein. These descriptions are therefore not repeated here. If you are
1822 building Exim for the first time, the simplest thing to do is to copy
1823 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1824
1825 There are three settings that you must supply, because Exim will not build
1826 without them. They are the location of the runtime configuration file
1827 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1828 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1829 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1830 a colon-separated list of filenames; Exim uses the first of them that exists.
1831
1832 There are a few other parameters that can be specified either at build time or
1833 at runtime, to enable the same binary to be used on a number of different
1834 machines. However, if the locations of Exim's spool directory and log file
1835 directory (if not within the spool directory) are fixed, it is recommended that
1836 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1837 detected early in Exim's execution (such as a malformed configuration file) can
1838 be logged.
1839
1840 .cindex "content scanning" "specifying at build time"
1841 Exim's interfaces for calling virus and spam scanning software directly from
1842 access control lists are not compiled by default. If you want to include these
1843 facilities, you need to set
1844 .code
1845 WITH_CONTENT_SCAN=yes
1846 .endd
1847 in your &_Local/Makefile_&. For details of the facilities themselves, see
1848 chapter &<<CHAPexiscan>>&.
1849
1850
1851 .cindex "&_Local/eximon.conf_&"
1852 .cindex "&_exim_monitor/EDITME_&"
1853 If you are going to build the Exim monitor, a similar configuration process is
1854 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1855 your installation and saved under the name &_Local/eximon.conf_&. If you are
1856 happy with the default settings described in &_exim_monitor/EDITME_&,
1857 &_Local/eximon.conf_& can be empty, but it must exist.
1858
1859 This is all the configuration that is needed in straightforward cases for known
1860 operating systems. However, the building process is set up so that it is easy
1861 to override options that are set by default or by operating-system-specific
1862 configuration files, for example, to change the C compiler, which
1863 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1864 do this.
1865
1866
1867
1868 .section "Support for iconv()" "SECID26"
1869 .cindex "&[iconv()]& support"
1870 .cindex "RFC 2047"
1871 The contents of header lines in messages may be encoded according to the rules
1872 described RFC 2047. This makes it possible to transmit characters that are not
1873 in the ASCII character set, and to label them as being in a particular
1874 character set. When Exim is inspecting header lines by means of the &%$h_%&
1875 mechanism, it decodes them, and translates them into a specified character set
1876 (default is set at build time). The translation is possible only if the operating system
1877 supports the &[iconv()]& function.
1878
1879 However, some of the operating systems that supply &[iconv()]& do not support
1880 very many conversions. The GNU &%libiconv%& library (available from
1881 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1882 systems to remedy this deficiency, as well as on systems that do not supply
1883 &[iconv()]& at all. After installing &%libiconv%&, you should add
1884 .code
1885 HAVE_ICONV=yes
1886 .endd
1887 to your &_Local/Makefile_& and rebuild Exim.
1888
1889
1890
1891 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1892 .cindex "TLS" "including support for TLS"
1893 .cindex "encryption" "including support for"
1894 .cindex "OpenSSL" "building Exim with"
1895 .cindex "GnuTLS" "building Exim with"
1896 Exim is usually built to support encrypted SMTP connections, using the STARTTLS
1897 command as per RFC 2487. It can also support clients that expect to
1898 start a TLS session immediately on connection to a non-standard port (see the
1899 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1900 line option).
1901
1902 If you want to build Exim with TLS support, you must first install either the
1903 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1904 implementing SSL.
1905
1906 If you do not want TLS support you should set
1907 .code
1908 DISABLE_TLS=yes
1909 .endd
1910 in &_Local/Makefile_&.
1911
1912 If OpenSSL is installed, you should set
1913 .code
1914 USE_OPENSL=yes
1915 TLS_LIBS=-lssl -lcrypto
1916 .endd
1917 in &_Local/Makefile_&. You may also need to specify the locations of the
1918 OpenSSL library and include files. For example:
1919 .code
1920 USE_OPENSSL=yes
1921 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1922 TLS_INCLUDE=-I/usr/local/openssl/include/
1923 .endd
1924 .cindex "pkg-config" "OpenSSL"
1925 If you have &'pkg-config'& available, then instead you can just use:
1926 .code
1927 USE_OPENSSL=yes
1928 USE_OPENSSL_PC=openssl
1929 .endd
1930 .cindex "USE_GNUTLS"
1931 If GnuTLS is installed, you should set
1932 .code
1933 USE_GNUTLS=yes
1934 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1935 .endd
1936 in &_Local/Makefile_&, and again you may need to specify the locations of the
1937 library and include files. For example:
1938 .code
1939 USE_GNUTLS=yes
1940 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1941 TLS_INCLUDE=-I/usr/gnu/include
1942 .endd
1943 .cindex "pkg-config" "GnuTLS"
1944 If you have &'pkg-config'& available, then instead you can just use:
1945 .code
1946 USE_GNUTLS=yes
1947 USE_GNUTLS_PC=gnutls
1948 .endd
1949
1950 You do not need to set TLS_INCLUDE if the relevant directory is already
1951 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1952 given in chapter &<<CHAPTLS>>&.
1953
1954
1955
1956
1957 .section "Use of tcpwrappers" "SECID27"
1958
1959 .cindex "tcpwrappers, building Exim to support"
1960 .cindex "USE_TCP_WRAPPERS"
1961 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1962 .cindex "tcp_wrappers_daemon_name"
1963 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1964 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1965 alternative to Exim's own checking facilities for installations that are
1966 already making use of &'tcpwrappers'& for other purposes. To do this, you
1967 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1968 &_tcpd.h_& to be available at compile time, and also ensure that the library
1969 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1970 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1971 you might have
1972 .code
1973 USE_TCP_WRAPPERS=yes
1974 CFLAGS=-O -I/usr/local/include
1975 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1976 .endd
1977 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1978 files is &"exim"&. For example, the line
1979 .code
1980 exim : LOCAL  192.168.1.  .friendly.domain.example
1981 .endd
1982 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1983 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1984 All other connections are denied. The daemon name used by &'tcpwrappers'&
1985 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1986 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1987 configure file. Consult the &'tcpwrappers'& documentation for
1988 further details.
1989
1990
1991 .section "Including support for IPv6" "SECID28"
1992 .cindex "IPv6" "including support for"
1993 Exim contains code for use on systems that have IPv6 support. Setting
1994 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1995 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1996 where the IPv6 support is not fully integrated into the normal include and
1997 library files.
1998
1999 Two different types of DNS record for handling IPv6 addresses have been
2000 defined. AAAA records (analogous to A records for IPv4) are in use, and are
2001 currently seen as the mainstream. Another record type called A6 was proposed
2002 as better than AAAA because it had more flexibility. However, it was felt to be
2003 over-complex, and its status was reduced to &"experimental"&.
2004 Exim used to
2005 have a compile option for including A6 record support but this has now been
2006 withdrawn.
2007
2008
2009
2010 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2011 .cindex "lookup modules"
2012 .cindex "dynamic modules"
2013 .cindex ".so building"
2014 On some platforms, Exim supports not compiling all lookup types directly into
2015 the main binary, instead putting some into external modules which can be loaded
2016 on demand.
2017 This permits packagers to build Exim with support for lookups with extensive
2018 library dependencies without requiring all users to install all of those
2019 dependencies.
2020 Most, but not all, lookup types can be built this way.
2021
2022 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2023 installed; Exim will only load modules from that directory, as a security
2024 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2025 for your OS; see &_OS/Makefile-Linux_& for an example.
2026 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2027 see &_src/EDITME_& for details.
2028
2029 Then, for each module to be loaded dynamically, define the relevant
2030 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2031 For example, this will build in lsearch but load sqlite and mysql support
2032 on demand:
2033 .code
2034 LOOKUP_LSEARCH=yes
2035 LOOKUP_SQLITE=2
2036 LOOKUP_MYSQL=2
2037 .endd
2038
2039
2040 .section "The building process" "SECID29"
2041 .cindex "build directory"
2042 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2043 created, run &'make'& at the top level. It determines the architecture and
2044 operating system types, and creates a build directory if one does not exist.
2045 For example, on a Sun system running Solaris 8, the directory
2046 &_build-SunOS5-5.8-sparc_& is created.
2047 .cindex "symbolic link" "to source files"
2048 Symbolic links to relevant source files are installed in the build directory.
2049
2050 If this is the first time &'make'& has been run, it calls a script that builds
2051 a make file inside the build directory, using the configuration files from the
2052 &_Local_& directory. The new make file is then passed to another instance of
2053 &'make'&. This does the real work, building a number of utility scripts, and
2054 then compiling and linking the binaries for the Exim monitor (if configured), a
2055 number of utility programs, and finally Exim itself. The command &`make
2056 makefile`& can be used to force a rebuild of the make file in the build
2057 directory, should this ever be necessary.
2058
2059 If you have problems building Exim, check for any comments there may be in the
2060 &_README_& file concerning your operating system, and also take a look at the
2061 FAQ, where some common problems are covered.
2062
2063
2064
2065 .section 'Output from &"make"&' "SECID283"
2066 The output produced by the &'make'& process for compile lines is often very
2067 unreadable, because these lines can be very long. For this reason, the normal
2068 output is suppressed by default, and instead output similar to that which
2069 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2070 each module that is being compiled or linked. However, it is still possible to
2071 get the full output, by calling &'make'& like this:
2072 .code
2073 FULLECHO='' make -e
2074 .endd
2075 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2076 command reflection in &'make'&. When you ask for the full output, it is
2077 given in addition to the short output.
2078
2079
2080
2081 .section "Overriding build-time options for Exim" "SECToverride"
2082 .cindex "build-time options, overriding"
2083 The main make file that is created at the beginning of the building process
2084 consists of the concatenation of a number of files which set configuration
2085 values, followed by a fixed set of &'make'& instructions. If a value is set
2086 more than once, the last setting overrides any previous ones. This provides a
2087 convenient way of overriding defaults. The files that are concatenated are, in
2088 order:
2089 .display
2090 &_OS/Makefile-Default_&
2091 &_OS/Makefile-_&<&'ostype'&>
2092 &_Local/Makefile_&
2093 &_Local/Makefile-_&<&'ostype'&>
2094 &_Local/Makefile-_&<&'archtype'&>
2095 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2096 &_OS/Makefile-Base_&
2097 .endd
2098 .cindex "&_Local/Makefile_&"
2099 .cindex "building Exim" "operating system type"
2100 .cindex "building Exim" "architecture type"
2101 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2102 architecture type. &_Local/Makefile_& is required to exist, and the building
2103 process fails if it is absent. The other three &_Local_& files are optional,
2104 and are often not needed.
2105
2106 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2107 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2108 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2109 values are used, thereby providing a means of forcing particular settings.
2110 Otherwise, the scripts try to get values from the &%uname%& command. If this
2111 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2112 of &'ad hoc'& transformations are then applied, to produce the standard names
2113 that Exim expects. You can run these scripts directly from the shell in order
2114 to find out what values are being used on your system.
2115
2116
2117 &_OS/Makefile-Default_& contains comments about the variables that are set
2118 therein. Some (but not all) are mentioned below. If there is something that
2119 needs changing, review the contents of this file and the contents of the make
2120 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2121 default values are.
2122
2123
2124 .cindex "building Exim" "overriding default settings"
2125 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2126 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2127 need to change the original files. Instead, you should make the changes by
2128 putting the new values in an appropriate &_Local_& file. For example,
2129 .cindex "Tru64-Unix build-time settings"
2130 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2131 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2132 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2133 called with the option &%-std1%&, to make it recognize some of the features of
2134 Standard C that Exim uses. (Most other compilers recognize Standard C by
2135 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2136 containing the lines
2137 .code
2138 CC=cc
2139 CFLAGS=-std1
2140 .endd
2141 If you are compiling for just one operating system, it may be easier to put
2142 these lines directly into &_Local/Makefile_&.
2143
2144 Keeping all your local configuration settings separate from the distributed
2145 files makes it easy to transfer them to new versions of Exim simply by copying
2146 the contents of the &_Local_& directory.
2147
2148
2149 .cindex "NIS lookup type" "including support for"
2150 .cindex "NIS+ lookup type" "including support for"
2151 .cindex "LDAP" "including support for"
2152 .cindex "lookup" "inclusion in binary"
2153 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2154 lookup, but not all systems have these components installed, so the default is
2155 not to include the relevant code in the binary. All the different kinds of file
2156 and database lookup that Exim supports are implemented as separate code modules
2157 which are included only if the relevant compile-time options are set. In the
2158 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2159 .code
2160 LOOKUP_LDAP=yes
2161 LOOKUP_NIS=yes
2162 LOOKUP_NISPLUS=yes
2163 .endd
2164 and similar settings apply to the other lookup types. They are all listed in
2165 &_src/EDITME_&. In many cases the relevant include files and interface
2166 libraries need to be installed before compiling Exim.
2167 .cindex "cdb" "including support for"
2168 However, there are some optional lookup types (such as cdb) for which
2169 the code is entirely contained within Exim, and no external include
2170 files or libraries are required. When a lookup type is not included in the
2171 binary, attempts to configure Exim to use it cause runtime configuration
2172 errors.
2173
2174 .cindex "pkg-config" "lookups"
2175 .cindex "pkg-config" "authenticators"
2176 Many systems now use a tool called &'pkg-config'& to encapsulate information
2177 about how to compile against a library; Exim has some initial support for
2178 being able to use pkg-config for lookups and authenticators.  For any given
2179 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2180 variable with the &`_PC`& suffix in the name and assign as the value the
2181 name of the package to be queried.  The results of querying via the
2182 &'pkg-config'& command will be added to the appropriate Makefile variables
2183 with &`+=`& directives, so your version of &'make'& will need to support that
2184 syntax.  For instance:
2185 .code
2186 LOOKUP_SQLITE=yes
2187 LOOKUP_SQLITE_PC=sqlite3
2188 AUTH_GSASL=yes
2189 AUTH_GSASL_PC=libgsasl
2190 AUTH_HEIMDAL_GSSAPI=yes
2191 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2192 .endd
2193
2194 .cindex "Perl" "including support for"
2195 Exim can be linked with an embedded Perl interpreter, allowing Perl
2196 subroutines to be called during string expansion. To enable this facility,
2197 .code
2198 EXIM_PERL=perl.o
2199 .endd
2200 must be defined in &_Local/Makefile_&. Details of this facility are given in
2201 chapter &<<CHAPperl>>&.
2202
2203 .cindex "X11 libraries, location of"
2204 The location of the X11 libraries is something that varies a lot between
2205 operating systems, and there may be different versions of X11 to cope
2206 with. Exim itself makes no use of X11, but if you are compiling the Exim
2207 monitor, the X11 libraries must be available.
2208 The following three variables are set in &_OS/Makefile-Default_&:
2209 .code
2210 X11=/usr/X11R6
2211 XINCLUDE=-I$(X11)/include
2212 XLFLAGS=-L$(X11)/lib
2213 .endd
2214 These are overridden in some of the operating-system configuration files. For
2215 example, in &_OS/Makefile-SunOS5_& there is
2216 .code
2217 X11=/usr/openwin
2218 XINCLUDE=-I$(X11)/include
2219 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2220 .endd
2221 If you need to override the default setting for your operating system, place a
2222 definition of all three of these variables into your
2223 &_Local/Makefile-<ostype>_& file.
2224
2225 .cindex "EXTRALIBS"
2226 If you need to add any extra libraries to the link steps, these can be put in a
2227 variable called EXTRALIBS, which appears in all the link commands, but by
2228 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2229 command for linking the main Exim binary, and not for any associated utilities.
2230
2231 .cindex "DBM libraries" "configuration for building"
2232 There is also DBMLIB, which appears in the link commands for binaries that
2233 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2234 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2235 binary, and which can be used, for example, to include additional X11
2236 libraries.
2237
2238 .cindex "configuration file" "editing"
2239 The make file copes with rebuilding Exim correctly if any of the configuration
2240 files are edited. However, if an optional configuration file is deleted, it is
2241 necessary to touch the associated non-optional file (that is,
2242 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2243
2244
2245 .section "OS-specific header files" "SECID30"
2246 .cindex "&_os.h_&"
2247 .cindex "building Exim" "OS-specific C header files"
2248 The &_OS_& directory contains a number of files with names of the form
2249 &_os.h-<ostype>_&. These are system-specific C header files that should not
2250 normally need to be changed. There is a list of macro settings that are
2251 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2252 are porting Exim to a new operating system.
2253
2254
2255
2256 .section "Overriding build-time options for the monitor" "SECID31"
2257 .cindex "building Eximon"
2258 A similar process is used for overriding things when building the Exim monitor,
2259 where the files that are involved are
2260 .display
2261 &_OS/eximon.conf-Default_&
2262 &_OS/eximon.conf-_&<&'ostype'&>
2263 &_Local/eximon.conf_&
2264 &_Local/eximon.conf-_&<&'ostype'&>
2265 &_Local/eximon.conf-_&<&'archtype'&>
2266 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2267 .endd
2268 .cindex "&_Local/eximon.conf_&"
2269 As with Exim itself, the final three files need not exist, and in this case the
2270 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2271 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2272 variables of the same name, preceded by EXIMON_. For example, setting
2273 EXIMON_LOG_DEPTH in the environment overrides the value of
2274 LOG_DEPTH at runtime.
2275 .ecindex IIDbuex
2276
2277
2278 .section "Installing Exim binaries and scripts" "SECID32"
2279 .cindex "installing Exim"
2280 .cindex "BIN_DIRECTORY"
2281 The command &`make install`& runs the &(exim_install)& script with no
2282 arguments. The script copies binaries and utility scripts into the directory
2283 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2284 .cindex "setuid" "installing Exim with"
2285 The install script copies files only if they are newer than the files they are
2286 going to replace. The Exim binary is required to be owned by root and have the
2287 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2288 install`& as root so that it can set up the Exim binary in this way. However, in
2289 some special situations (for example, if a host is doing no local deliveries)
2290 it may be possible to run Exim without making the binary setuid root (see
2291 chapter &<<CHAPsecurity>>& for details).
2292
2293 .cindex "CONFIGURE_FILE"
2294 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2295 in &_Local/Makefile_&. If this names a single file, and the file does not
2296 exist, the default configuration file &_src/configure.default_& is copied there
2297 by the installation script. If a runtime configuration file already exists, it
2298 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2299 alternative files, no default is installed.
2300
2301 .cindex "system aliases file"
2302 .cindex "&_/etc/aliases_&"
2303 One change is made to the default configuration file when it is installed: the
2304 default configuration contains a router that references a system aliases file.
2305 The path to this file is set to the value specified by
2306 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2307 If the system aliases file does not exist, the installation script creates it,
2308 and outputs a comment to the user.
2309
2310 The created file contains no aliases, but it does contain comments about the
2311 aliases a site should normally have. Mail aliases have traditionally been
2312 kept in &_/etc/aliases_&. However, some operating systems are now using
2313 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2314 Exim's configuration if necessary.
2315
2316 The default configuration uses the local host's name as the only local domain,
2317 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2318 running as the local user. System aliases and &_.forward_& files in users' home
2319 directories are supported, but no NIS or NIS+ support is configured. Domains
2320 other than the name of the local host are routed using the DNS, with delivery
2321 over SMTP.
2322
2323 It is possible to install Exim for special purposes (such as building a binary
2324 distribution) in a private part of the file system. You can do this by a
2325 command such as
2326 .code
2327 make DESTDIR=/some/directory/ install
2328 .endd
2329 This has the effect of pre-pending the specified directory to all the file
2330 paths, except the name of the system aliases file that appears in the default
2331 configuration. (If a default alias file is created, its name &'is'& modified.)
2332 For backwards compatibility, ROOT is used if DESTDIR is not set,
2333 but this usage is deprecated.
2334
2335 .cindex "installing Exim" "what is not installed"
2336 Running &'make install'& does not copy the Exim 4 conversion script
2337 &'convert4r4'&. You will probably run this only once if you are
2338 upgrading from Exim 3. None of the documentation files in the &_doc_&
2339 directory are copied, except for the info files when you have set
2340 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2341
2342 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2343 to their names. The Exim binary itself, however, is handled differently. It is
2344 installed under a name that includes the version number and the compile number,
2345 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2346 called &_exim_& to point to the binary. If you are updating a previous version
2347 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2348 from the directory (as seen by other processes).
2349
2350 .cindex "installing Exim" "testing the script"
2351 If you want to see what the &'make install'& will do before running it for
2352 real, you can pass the &%-n%& option to the installation script by this
2353 command:
2354 .code
2355 make INSTALL_ARG=-n install
2356 .endd
2357 The contents of the variable INSTALL_ARG are passed to the installation
2358 script. You do not need to be root to run this test. Alternatively, you can run
2359 the installation script directly, but this must be from within the build
2360 directory. For example, from the top-level Exim directory you could use this
2361 command:
2362 .code
2363 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2364 .endd
2365 .cindex "installing Exim" "install script options"
2366 There are two other options that can be supplied to the installation script.
2367
2368 .ilist
2369 &%-no_chown%& bypasses the call to change the owner of the installed binary
2370 to root, and the call to make it a setuid binary.
2371 .next
2372 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2373 installed binary.
2374 .endlist
2375
2376 INSTALL_ARG can be used to pass these options to the script. For example:
2377 .code
2378 make INSTALL_ARG=-no_symlink install
2379 .endd
2380 The installation script can also be given arguments specifying which files are
2381 to be copied. For example, to install just the Exim binary, and nothing else,
2382 without creating the symbolic link, you could use:
2383 .code
2384 make INSTALL_ARG='-no_symlink exim' install
2385 .endd
2386
2387
2388
2389 .section "Installing info documentation" "SECTinsinfdoc"
2390 .cindex "installing Exim" "&'info'& documentation"
2391 Not all systems use the GNU &'info'& system for documentation, and for this
2392 reason, the Texinfo source of Exim's documentation is not included in the main
2393 distribution. Instead it is available separately from the FTP site (see section
2394 &<<SECTavail>>&).
2395
2396 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2397 source of the documentation is found in the source tree, running &`make
2398 install`& automatically builds the info files and installs them.
2399
2400
2401
2402 .section "Setting up the spool directory" "SECID33"
2403 .cindex "spool directory" "creating"
2404 When it starts up, Exim tries to create its spool directory if it does not
2405 exist. The Exim uid and gid are used for the owner and group of the spool
2406 directory. Sub-directories are automatically created in the spool directory as
2407 necessary.
2408
2409
2410
2411
2412 .section "Testing" "SECID34"
2413 .cindex "testing" "installation"
2414 Having installed Exim, you can check that the runtime configuration file is
2415 syntactically valid by running the following command, which assumes that the
2416 Exim binary directory is within your PATH environment variable:
2417 .code
2418 exim -bV
2419 .endd
2420 If there are any errors in the configuration file, Exim outputs error messages.
2421 Otherwise it outputs the version number and build date,
2422 the DBM library that is being used, and information about which drivers and
2423 other optional code modules are included in the binary.
2424 Some simple routing tests can be done by using the address testing option. For
2425 example,
2426 .display
2427 &`exim -bt`& <&'local username'&>
2428 .endd
2429 should verify that it recognizes a local mailbox, and
2430 .display
2431 &`exim -bt`& <&'remote address'&>
2432 .endd
2433 a remote one. Then try getting it to deliver mail, both locally and remotely.
2434 This can be done by passing messages directly to Exim, without going through a
2435 user agent. For example:
2436 .code
2437 exim -v postmaster@your.domain.example
2438 From: user@your.domain.example
2439 To: postmaster@your.domain.example
2440 Subject: Testing Exim
2441
2442 This is a test message.
2443 ^D
2444 .endd
2445 The &%-v%& option causes Exim to output some verification of what it is doing.
2446 In this case you should see copies of three log lines, one for the message's
2447 arrival, one for its delivery, and one containing &"Completed"&.
2448
2449 .cindex "delivery" "problems with"
2450 If you encounter problems, look at Exim's log files (&'mainlog'& and
2451 &'paniclog'&) to see if there is any relevant information there. Another source
2452 of information is running Exim with debugging turned on, by specifying the
2453 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2454 with debugging turned on by a command of the form
2455 .display
2456 &`exim -d -M`& <&'exim-message-id'&>
2457 .endd
2458 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2459 produces rather a lot of output, but you can cut this down to specific areas.
2460 For example, if you use &%-d-all+route%& only the debugging information
2461 relevant to routing is included. (See the &%-d%& option in chapter
2462 &<<CHAPcommandline>>& for more details.)
2463
2464 .cindex '&"sticky"& bit'
2465 .cindex "lock files"
2466 One specific problem that has shown up on some sites is the inability to do
2467 local deliveries into a shared mailbox directory, because it does not have the
2468 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2469 writing to a mailbox file, and if it cannot create the lock file, the delivery
2470 is deferred. You can get round this either by setting the &"sticky bit"& on the
2471 directory, or by setting a specific group for local deliveries and allowing
2472 that group to create files in the directory (see the comments above the
2473 &(local_delivery)& transport in the default configuration file). Another
2474 approach is to configure Exim not to use lock files, but just to rely on
2475 &[fcntl()]& locking instead. However, you should do this only if all user
2476 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2477 see chapter &<<CHAPappendfile>>&.
2478
2479 One thing that cannot be tested on a system that is already running an MTA is
2480 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2481 &%-oX%& option can be used to run an Exim daemon that listens on some other
2482 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2483 &'exim_checkaccess'& utility can be used to check out policy controls on
2484 incoming SMTP mail.
2485
2486 Testing a new version on a system that is already running Exim can most easily
2487 be done by building a binary with a different CONFIGURE_FILE setting. From
2488 within the runtime configuration, all other file and directory names
2489 that Exim uses can be altered, in order to keep it entirely clear of the
2490 production version.
2491
2492
2493 .section "Replacing another MTA with Exim" "SECID35"
2494 .cindex "replacing another MTA"
2495 Building and installing Exim for the first time does not of itself put it in
2496 general use. The name by which the system's MTA is called by mail user agents
2497 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2498 operating system), and it is necessary to make this name point to the &'exim'&
2499 binary in order to get the user agents to pass messages to Exim. This is
2500 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2501 or &_/usr/lib/sendmail_&
2502 .cindex "symbolic link" "to &'exim'& binary"
2503 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2504 privilege and executable status from the old MTA. It is then necessary to stop
2505 and restart the mailer daemon, if one is running.
2506
2507 .cindex "FreeBSD, MTA indirection"
2508 .cindex "&_/etc/mail/mailer.conf_&"
2509 Some operating systems have introduced alternative ways of switching MTAs. For
2510 example, if you are running FreeBSD, you need to edit the file
2511 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2512 described. A typical example of the contents of this file for running Exim is
2513 as follows:
2514 .code
2515 sendmail            /usr/exim/bin/exim
2516 send-mail           /usr/exim/bin/exim
2517 mailq               /usr/exim/bin/exim -bp
2518 newaliases          /usr/bin/true
2519 .endd
2520 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2521 your Exim installation is &"live"&. Check it by sending a message from your
2522 favourite user agent.
2523
2524 You should consider what to tell your users about the change of MTA. Exim may
2525 have different capabilities to what was previously running, and there are
2526 various operational differences such as the text of messages produced by
2527 command line options and in bounce messages. If you allow your users to make
2528 use of Exim's filtering capabilities, you should make the document entitled
2529 &'Exim's interface to mail filtering'& available to them.
2530
2531
2532
2533 .section "Upgrading Exim" "SECID36"
2534 .cindex "upgrading Exim"
2535 If you are already running Exim on your host, building and installing a new
2536 version automatically makes it available to MUAs, or any other programs that
2537 call the MTA directly. However, if you are running an Exim daemon, you do need
2538 .cindex restart "on HUP signal"
2539 .cindex signal "HUP, to restart"
2540 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2541 new binary. You do not need to stop processing mail in order to install a new
2542 version of Exim. The install script does not modify an existing runtime
2543 configuration file.
2544
2545
2546
2547
2548 .section "Stopping the Exim daemon on Solaris" "SECID37"
2549 .cindex "Solaris" "stopping Exim on"
2550 The standard command for stopping the mailer daemon on Solaris is
2551 .code
2552 /etc/init.d/sendmail stop
2553 .endd
2554 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2555 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2556 for the text &"sendmail"&; this is not present because the actual program name
2557 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2558 solution is to replace the line that finds the process id with something like
2559 .code
2560 pid=`cat /var/spool/exim/exim-daemon.pid`
2561 .endd
2562 to obtain the daemon's pid directly from the file that Exim saves it in.
2563
2564 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2565 still be received from local processes, and if automatic delivery is configured
2566 (the normal case), deliveries will still occur.
2567
2568
2569
2570
2571 . ////////////////////////////////////////////////////////////////////////////
2572 . ////////////////////////////////////////////////////////////////////////////
2573
2574 .chapter "The Exim command line" "CHAPcommandline"
2575 .scindex IIDclo1 "command line" "options"
2576 .scindex IIDclo2 "options" "command line"
2577 Exim's command line takes the standard Unix form of a sequence of options,
2578 each starting with a hyphen character, followed by a number of arguments. The
2579 options are compatible with the main options of Sendmail, and there are also
2580 some additional options, some of which are compatible with Smail 3. Certain
2581 combinations of options do not make sense, and provoke an error if used.
2582 The form of the arguments depends on which options are set.
2583
2584
2585 .section "Setting options by program name" "SECID38"
2586 .cindex "&'mailq'&"
2587 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2588 were present before any other options.
2589 The &%-bp%& option requests a listing of the contents of the mail queue on the
2590 standard output.
2591 This feature is for compatibility with some systems that contain a command of
2592 that name in one of the standard libraries, symbolically linked to
2593 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2594
2595 .cindex "&'rsmtp'&"
2596 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2597 were present before any other options, for compatibility with Smail. The
2598 &%-bS%& option is used for reading in a number of messages in batched SMTP
2599 format.
2600
2601 .cindex "&'rmail'&"
2602 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2603 &%-oee%& options were present before any other options, for compatibility with
2604 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2605
2606 .cindex "&'runq'&"
2607 .cindex "queue runner"
2608 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2609 were present before any other options, for compatibility with Smail. The &%-q%&
2610 option causes a single queue runner process to be started.
2611
2612 .cindex "&'newaliases'&"
2613 .cindex "alias file" "building"
2614 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2615 If Exim is called under the name &'newaliases'& it behaves as if the option
2616 &%-bi%& were present before any other options, for compatibility with Sendmail.
2617 This option is used for rebuilding Sendmail's alias file. Exim does not have
2618 the concept of a single alias file, but can be configured to run a given
2619 command if called with the &%-bi%& option.
2620
2621
2622 .section "Trusted and admin users" "SECTtrustedadmin"
2623 Some Exim options are available only to &'trusted users'& and others are
2624 available only to &'admin users'&. In the description below, the phrases &"Exim
2625 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2626 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2627 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2628
2629 .ilist
2630 .cindex "trusted users" "definition of"
2631 .cindex "user" "trusted definition of"
2632 The trusted users are root, the Exim user, any user listed in the
2633 &%trusted_users%& configuration option, and any user whose current group or any
2634 supplementary group is one of those listed in the &%trusted_groups%&
2635 configuration option. Note that the Exim group is not automatically trusted.
2636
2637 .cindex '&"From"& line'
2638 .cindex "envelope from"
2639 .cindex "envelope sender"
2640 Trusted users are always permitted to use the &%-f%& option or a leading
2641 &"From&~"& line to specify the envelope sender of a message that is passed to
2642 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2643 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2644 users to set envelope senders.
2645
2646 .cindex "&'From:'& header line"
2647 .cindex "&'Sender:'& header line"
2648 .cindex "header lines" "From:"
2649 .cindex "header lines" "Sender:"
2650 For a trusted user, there is never any check on the contents of the &'From:'&
2651 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2652 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2653
2654 Trusted users may also specify a host name, host address, interface address,
2655 protocol name, ident value, and authentication data when submitting a message
2656 locally. Thus, they are able to insert messages into Exim's queue locally that
2657 have the characteristics of messages received from a remote host. Untrusted
2658 users may in some circumstances use &%-f%&, but can never set the other values
2659 that are available to trusted users.
2660 .next
2661 .cindex "user" "admin definition of"
2662 .cindex "admin user" "definition of"
2663 The admin users are root, the Exim user, and any user that is a member of the
2664 Exim group or of any group listed in the &%admin_groups%& configuration option.
2665 The current group does not have to be one of these groups.
2666
2667 Admin users are permitted to list the queue, and to carry out certain
2668 operations on messages, for example, to force delivery failures. It is also
2669 necessary to be an admin user in order to see the full information provided by
2670 the Exim monitor, and full debugging output.
2671
2672 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2673 Exim to attempt delivery of messages on its queue is restricted to admin users.
2674 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2675 option false (that is, specifying &%no_prod_requires_admin%&).
2676
2677 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2678 is restricted to admin users unless &%queue_list_requires_admin%& is set
2679 false.
2680 .endlist
2681
2682
2683 &*Warning*&: If you configure your system so that admin users are able to
2684 edit Exim's configuration file, you are giving those users an easy way of
2685 getting root. There is further discussion of this issue at the start of chapter
2686 &<<CHAPconf>>&.
2687
2688
2689
2690
2691 .section "Command line options" "SECID39"
2692 Exim's command line options are described in alphabetical order below. If none
2693 of the options that specifies a specific action (such as starting the daemon or
2694 a queue runner, or testing an address, or receiving a message in a specific
2695 format, or listing the queue) are present, and there is at least one argument
2696 on the command line, &%-bm%& (accept a local message on the standard input,
2697 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2698 outputs a brief message about itself and exits.
2699
2700 . ////////////////////////////////////////////////////////////////////////////
2701 . Insert a stylized XML comment here, to identify the start of the command line
2702 . options. This is for the benefit of the Perl script that automatically
2703 . creates a man page for the options.
2704 . ////////////////////////////////////////////////////////////////////////////
2705
2706 .literal xml
2707 <!-- === Start of command line options === -->
2708 .literal off
2709
2710
2711 .vlist
2712 .vitem &%--%&
2713 .oindex "--"
2714 .cindex "options" "command line; terminating"
2715 This is a pseudo-option whose only purpose is to terminate the options and
2716 therefore to cause subsequent command line items to be treated as arguments
2717 rather than options, even if they begin with hyphens.
2718
2719 .vitem &%--help%&
2720 .oindex "&%--help%&"
2721 This option causes Exim to output a few sentences stating what it is.
2722 The same output is generated if the Exim binary is called with no options and
2723 no arguments.
2724
2725 .vitem &%--version%&
2726 .oindex "&%--version%&"
2727 This option is an alias for &%-bV%& and causes version information to be
2728 displayed.
2729
2730 .vitem &%-Ac%& &&&
2731        &%-Am%&
2732 .oindex "&%-Ac%&"
2733 .oindex "&%-Am%&"
2734 These options are used by Sendmail for selecting configuration files and are
2735 ignored by Exim.
2736
2737 .vitem &%-B%&<&'type'&>
2738 .oindex "&%-B%&"
2739 .cindex "8-bit characters"
2740 .cindex "Sendmail compatibility" "8-bit characters"
2741 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2742 clean; it ignores this option.
2743
2744 .vitem &%-bd%&
2745 .oindex "&%-bd%&"
2746 .cindex "daemon"
2747 .cindex "SMTP" "listener"
2748 .cindex "queue runner"
2749 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2750 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2751 that the daemon should also initiate periodic queue runs.
2752
2753 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2754 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2755 disconnect from the controlling terminal. When running this way, it can be
2756 stopped by pressing ctrl-C.
2757
2758 By default, Exim listens for incoming connections to the standard SMTP port on
2759 all the host's running interfaces. However, it is possible to listen on other
2760 ports, on multiple ports, and only on specific interfaces. Chapter
2761 &<<CHAPinterfaces>>& contains a description of the options that control this.
2762
2763 When a listening daemon
2764 .cindex "daemon" "process id (pid)"
2765 .cindex "pid (process id)" "of daemon"
2766 is started without the use of &%-oX%& (that is, without overriding the normal
2767 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2768 in Exim's spool directory. This location can be overridden by setting
2769 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2770 running as root.
2771
2772 When &%-oX%& is used on the command line to start a listening daemon, the
2773 process id is not written to the normal pid file path. However, &%-oP%& can be
2774 used to specify a path on the command line if a pid file is required.
2775
2776 The SIGHUP signal
2777 .cindex "SIGHUP"
2778 .cindex restart "on HUP signal"
2779 .cindex signal "HUP, to restart"
2780 .cindex "daemon" "restarting"
2781 .cindex signal "to reload configuration"
2782 .cindex daemon "reload configuration"
2783 .cindex reload configuration
2784 can be used to cause the daemon to re-execute itself. This should be done
2785 whenever Exim's configuration file, or any file that is incorporated into it by
2786 means of the &%.include%& facility, is changed, and also whenever a new version
2787 of Exim is installed. It is not necessary to do this when other files that are
2788 referenced from the configuration (for example, alias files) are changed,
2789 because these are reread each time they are used.
2790
2791 .vitem &%-bdf%&
2792 .oindex "&%-bdf%&"
2793 This option has the same effect as &%-bd%& except that it never disconnects
2794 from the controlling terminal, even when no debugging is specified.
2795
2796 .vitem &%-be%&
2797 .oindex "&%-be%&"
2798 .cindex "testing" "string expansion"
2799 .cindex "expansion" "testing"
2800 Run Exim in expansion testing mode. Exim discards its root privilege, to
2801 prevent ordinary users from using this mode to read otherwise inaccessible
2802 files. If no arguments are given, Exim runs interactively, prompting for lines
2803 of data. Otherwise, it processes each argument in turn.
2804
2805 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2806 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2807 used without command line arguments. If successful, it uses the &[readline()]&
2808 function, which provides extensive line-editing facilities, for reading the
2809 test data. A line history is supported.
2810
2811 Long expansion expressions can be split over several lines by using backslash
2812 continuations. As in Exim's runtime configuration, white space at the start of
2813 continuation lines is ignored. Each argument or data line is passed through the
2814 string expansion mechanism, and the result is output. Variable values from the
2815 configuration file (for example, &$qualify_domain$&) are available, but no
2816 message-specific values (such as &$message_exim_id$&) are set, because no message
2817 is being processed (but see &%-bem%& and &%-Mset%&).
2818
2819 &*Note*&: If you use this mechanism to test lookups, and you change the data
2820 files or databases you are using, you must exit and restart Exim before trying
2821 the same lookup again. Otherwise, because each Exim process caches the results
2822 of lookups, you will just get the same result as before.
2823
2824 Macro processing is done on lines before string-expansion: new macros can be
2825 defined and macros will be expanded.
2826 Because macros in the config file are often used for secrets, those are only
2827 available to admin users.
2828
2829 .vitem &%-bem%&&~<&'filename'&>
2830 .oindex "&%-bem%&"
2831 .cindex "testing" "string expansion"
2832 .cindex "expansion" "testing"
2833 This option operates like &%-be%& except that it must be followed by the name
2834 of a file. For example:
2835 .code
2836 exim -bem /tmp/testmessage
2837 .endd
2838 The file is read as a message (as if receiving a locally-submitted non-SMTP
2839 message) before any of the test expansions are done. Thus, message-specific
2840 variables such as &$message_size$& and &$header_from:$& are available. However,
2841 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2842 recipients are read from the headers in the normal way, and are shown in the
2843 &$recipients$& variable. Note that recipients cannot be given on the command
2844 line, because further arguments are taken as strings to expand (just like
2845 &%-be%&).
2846
2847 .vitem &%-bF%&&~<&'filename'&>
2848 .oindex "&%-bF%&"
2849 .cindex "system filter" "testing"
2850 .cindex "testing" "system filter"
2851 This option is the same as &%-bf%& except that it assumes that the filter being
2852 tested is a system filter. The additional commands that are available only in
2853 system filters are recognized.
2854
2855 .vitem &%-bf%&&~<&'filename'&>
2856 .oindex "&%-bf%&"
2857 .cindex "filter" "testing"
2858 .cindex "testing" "filter file"
2859 .cindex "forward file" "testing"
2860 .cindex "testing" "forward file"
2861 .cindex "Sieve filter" "testing"
2862 This option runs Exim in user filter testing mode; the file is the filter file
2863 to be tested, and a test message must be supplied on the standard input. If
2864 there are no message-dependent tests in the filter, an empty file can be
2865 supplied.
2866
2867 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2868 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2869 filter and a user filter in the same run. For example:
2870 .code
2871 exim -bF /system/filter -bf /user/filter </test/message
2872 .endd
2873 This is helpful when the system filter adds header lines or sets filter
2874 variables that are used by the user filter.
2875
2876 If the test filter file does not begin with one of the special lines
2877 .code
2878 # Exim filter
2879 # Sieve filter
2880 .endd
2881 it is taken to be a normal &_.forward_& file, and is tested for validity under
2882 that interpretation. See sections &<<SECTitenonfilred>>& to
2883 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2884 redirection lists.
2885
2886 The result of an Exim command that uses &%-bf%&, provided no errors are
2887 detected, is a list of the actions that Exim would try to take if presented
2888 with the message for real. More details of filter testing are given in the
2889 separate document entitled &'Exim's interfaces to mail filtering'&.
2890
2891 When testing a filter file,
2892 .cindex "&""From""& line"
2893 .cindex "envelope from"
2894 .cindex "envelope sender"
2895 .oindex "&%-f%&" "for filter testing"
2896 the envelope sender can be set by the &%-f%& option,
2897 or by a &"From&~"& line at the start of the test message. Various parameters
2898 that would normally be taken from the envelope recipient address of the message
2899 can be set by means of additional command line options (see the next four
2900 options).
2901
2902 .vitem &%-bfd%&&~<&'domain'&>
2903 .oindex "&%-bfd%&"
2904 .vindex "&$qualify_domain$&"
2905 This sets the domain of the recipient address when a filter file is being
2906 tested by means of the &%-bf%& option. The default is the value of
2907 &$qualify_domain$&.
2908
2909 .vitem &%-bfl%&&~<&'local&~part'&>
2910 .oindex "&%-bfl%&"
2911 This sets the local part of the recipient address when a filter file is being
2912 tested by means of the &%-bf%& option. The default is the username of the
2913 process that calls Exim. A local part should be specified with any prefix or
2914 suffix stripped, because that is how it appears to the filter when a message is
2915 actually being delivered.
2916
2917 .vitem &%-bfp%&&~<&'prefix'&>
2918 .oindex "&%-bfp%&"
2919 .cindex affix "filter testing"
2920 This sets the prefix of the local part of the recipient address when a filter
2921 file is being tested by means of the &%-bf%& option. The default is an empty
2922 prefix.
2923
2924 .vitem &%-bfs%&&~<&'suffix'&>
2925 .oindex "&%-bfs%&"
2926 .cindex affix "filter testing"
2927 This sets the suffix of the local part of the recipient address when a filter
2928 file is being tested by means of the &%-bf%& option. The default is an empty
2929 suffix.
2930
2931 .vitem &%-bh%&&~<&'IP&~address'&>
2932 .oindex "&%-bh%&"
2933 .cindex "testing" "incoming SMTP"
2934 .cindex "SMTP" "testing incoming"
2935 .cindex "testing" "relay control"
2936 .cindex "relaying" "testing configuration"
2937 .cindex "policy control" "testing"
2938 .cindex "debugging" "&%-bh%& option"
2939 This option runs a fake SMTP session as if from the given IP address, using the
2940 standard input and output. The IP address may include a port number at the end,
2941 after a full stop. For example:
2942 .code
2943 exim -bh 10.9.8.7.1234
2944 exim -bh fe80::a00:20ff:fe86:a061.5678
2945 .endd
2946 When an IPv6 address is given, it is converted into canonical form. In the case
2947 of the second example above, the value of &$sender_host_address$& after
2948 conversion to the canonical form is
2949 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2950
2951 Comments as to what is going on are written to the standard error file. These
2952 include lines beginning with &"LOG"& for anything that would have been logged.
2953 This facility is provided for testing configuration options for incoming
2954 messages, to make sure they implement the required policy. For example, you can
2955 test your relay controls using &%-bh%&.
2956
2957 &*Warning 1*&:
2958 .cindex "RFC 1413"
2959 You can test features of the configuration that rely on ident (RFC 1413)
2960 information by using the &%-oMt%& option. However, Exim cannot actually perform
2961 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2962 connection.
2963
2964 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2965 are also skipped when testing using &%-bh%&. If you want these callouts to
2966 occur, use &%-bhc%& instead.
2967
2968 Messages supplied during the testing session are discarded, and nothing is
2969 written to any of the real log files. There may be pauses when DNS (and other)
2970 lookups are taking place, and of course these may time out. The &%-oMi%& option
2971 can be used to specify a specific IP interface and port if this is important,
2972 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2973 session were authenticated.
2974
2975 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2976 output just states whether a given recipient address from a given host is
2977 acceptable or not. See section &<<SECTcheckaccess>>&.
2978
2979 Features such as authentication and encryption, where the client input is not
2980 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2981 specialized SMTP test program such as
2982 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2983
2984 .vitem &%-bhc%&&~<&'IP&~address'&>
2985 .oindex "&%-bhc%&"
2986 This option operates in the same way as &%-bh%&, except that address
2987 verification callouts are performed if required. This includes consulting and
2988 updating the callout cache database.
2989
2990 .vitem &%-bi%&
2991 .oindex "&%-bi%&"
2992 .cindex "alias file" "building"
2993 .cindex "building alias file"
2994 .cindex "Sendmail compatibility" "&%-bi%& option"
2995 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2996 Exim does not have the concept of a single alias file, and so it cannot mimic
2997 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2998 tend to appear in various scripts such as NIS make files, so the option must be
2999 recognized.
3000
3001 If &%-bi%& is encountered, the command specified by the &%bi_command%&
3002 configuration option is run, under the uid and gid of the caller of Exim. If
3003 the &%-oA%& option is used, its value is passed to the command as an argument.
3004 The command set by &%bi_command%& may not contain arguments. The command can
3005 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
3006 if this is required. If the &%bi_command%& option is not set, calling Exim with
3007 &%-bi%& is a no-op.
3008
3009 . // Keep :help first, then the rest in alphabetical order
3010 .vitem &%-bI:help%&
3011 .oindex "&%-bI:help%&"
3012 .cindex "querying exim information"
3013 We shall provide various options starting &`-bI:`& for querying Exim for
3014 information.  The output of many of these will be intended for machine
3015 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3016 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3017 options shall cause Exim to exit after producing the requested output.
3018
3019 .vitem &%-bI:dscp%&
3020 .oindex "&%-bI:dscp%&"
3021 .cindex "DSCP" "values"
3022 This option causes Exim to emit an alphabetically sorted list of all
3023 recognised DSCP names.
3024
3025 .vitem &%-bI:sieve%&
3026 .oindex "&%-bI:sieve%&"
3027 .cindex "Sieve filter" "capabilities"
3028 This option causes Exim to emit an alphabetically sorted list of all supported
3029 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3030 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3031 &`SIEVE`& capability response line.  As the precise list may depend upon
3032 compile-time build options, which this option will adapt to, this is the only
3033 way to guarantee a correct response.
3034
3035 .vitem &%-bm%&
3036 .oindex "&%-bm%&"
3037 .cindex "local message reception"
3038 This option runs an Exim receiving process that accepts an incoming,
3039 locally-generated message on the standard input. The recipients are given as the
3040 command arguments (except when &%-t%& is also present &-- see below). Each
3041 argument can be a comma-separated list of RFC 2822 addresses. This is the
3042 default option for selecting the overall action of an Exim call; it is assumed
3043 if no other conflicting option is present.
3044
3045 If any addresses in the message are unqualified (have no domain), they are
3046 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3047 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3048 suppressing this for special cases.
3049
3050 Policy checks on the contents of local messages can be enforced by means of
3051 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3052
3053 .cindex "return code" "for &%-bm%&"
3054 The return code is zero if the message is successfully accepted. Otherwise, the
3055 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3056
3057 The format
3058 .cindex "message" "format"
3059 .cindex "format" "message"
3060 .cindex "&""From""& line"
3061 .cindex "UUCP" "&""From""& line"
3062 .cindex "Sendmail compatibility" "&""From""& line"
3063 of the message must be as defined in RFC 2822, except that, for
3064 compatibility with Sendmail and Smail, a line in one of the forms
3065 .code
3066 From sender Fri Jan  5 12:55 GMT 1997
3067 From sender Fri, 5 Jan 97 12:55:01
3068 .endd
3069 (with the weekday optional, and possibly with additional text after the date)
3070 is permitted to appear at the start of the message. There appears to be no
3071 authoritative specification of the format of this line. Exim recognizes it by
3072 matching against the regular expression defined by the &%uucp_from_pattern%&
3073 option, which can be changed if necessary.
3074
3075 .oindex "&%-f%&" "overriding &""From""& line"
3076 The specified sender is treated as if it were given as the argument to the
3077 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3078 preference to the address taken from the message. The caller of Exim must be a
3079 trusted user for the sender of a message to be set in this way.
3080
3081 .vitem &%-bmalware%&&~<&'filename'&>
3082 .oindex "&%-bmalware%&"
3083 .cindex "testing", "malware"
3084 .cindex "malware scan test"
3085 This debugging option causes Exim to scan the given file or directory
3086 (depending on the used scanner interface),
3087 using the malware scanning framework.  The option of &%av_scanner%& influences
3088 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3089 the expansion should have defaults which apply to this invocation.  ACLs are
3090 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3091 will never be populated and &%-bmalware%& will fail.
3092
3093 Exim will have changed working directory before resolving the filename, so
3094 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3095 user when it tries to open the file, rather than as the invoking user.
3096 This option requires admin privileges.
3097
3098 The &%-bmalware%& option will not be extended to be more generally useful,
3099 there are better tools for file-scanning.  This option exists to help
3100 administrators verify their Exim and AV scanner configuration.
3101
3102 .vitem &%-bnq%&
3103 .oindex "&%-bnq%&"
3104 .cindex "address qualification, suppressing"
3105 By default, Exim automatically qualifies unqualified addresses (those
3106 without domains) that appear in messages that are submitted locally (that
3107 is, not over TCP/IP). This qualification applies both to addresses in
3108 envelopes, and addresses in header lines. Sender addresses are qualified using
3109 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3110 defaults to the value of &%qualify_domain%&).
3111
3112 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3113 being used to re-submit messages that originally came from remote hosts after
3114 content scanning, you probably do not want to qualify unqualified addresses in
3115 header lines. (Such lines will be present only if you have not enabled a header
3116 syntax check in the appropriate ACL.)
3117
3118 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3119 messages that originate on the local host. When this is used, unqualified
3120 addresses in the envelope provoke errors (causing message rejection) and
3121 unqualified addresses in header lines are left alone.
3122
3123
3124 .vitem &%-bP%&
3125 .oindex "&%-bP%&"
3126 .cindex "configuration options" "extracting"
3127 .cindex "options" "configuration &-- extracting"
3128 If this option is given with no arguments, it causes the values of all Exim's
3129 main configuration options to be written to the standard output. The values
3130 of one or more specific options can be requested by giving their names as
3131 arguments, for example:
3132 .code
3133 exim -bP qualify_domain hold_domains
3134 .endd
3135 .cindex "hiding configuration option values"
3136 .cindex "configuration options" "hiding value of"
3137 .cindex "options" "hiding value of"
3138 However, any option setting that is preceded by the word &"hide"& in the
3139 configuration file is not shown in full, except to an admin user. For other
3140 users, the output is as in this example:
3141 .code
3142 mysql_servers = <value not displayable>
3143 .endd
3144 If &%config%& is given as an argument, the config is
3145 output, as it was parsed, any include file resolved, any comment removed.
3146
3147 If &%config_file%& is given as an argument, the name of the runtime
3148 configuration file is output. (&%configure_file%& works too, for
3149 backward compatibility.)
3150 If a list of configuration files was supplied, the value that is output here
3151 is the name of the file that was actually used.
3152
3153 .cindex "options" "hiding name of"
3154 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3155 name will not be output.
3156
3157 .cindex "daemon" "process id (pid)"
3158 .cindex "pid (process id)" "of daemon"
3159 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3160 directories where log files and daemon pid files are written are output,
3161 respectively. If these values are unset, log files are written in a
3162 sub-directory of the spool directory called &%log%&, and the pid file is
3163 written directly into the spool directory.
3164
3165 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3166 .code
3167 exim -bP +local_domains
3168 .endd
3169 it searches for a matching named list of any type (domain, host, address, or
3170 local part) and outputs what it finds.
3171
3172 .cindex "options" "router &-- extracting"
3173 .cindex "options" "transport &-- extracting"
3174 .cindex "options" "authenticator &-- extracting"
3175 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3176 followed by the name of an appropriate driver instance, the option settings for
3177 that driver are output. For example:
3178 .code
3179 exim -bP transport local_delivery
3180 .endd
3181 The generic driver options are output first, followed by the driver's private
3182 options. A list of the names of drivers of a particular type can be obtained by
3183 using one of the words &%router_list%&, &%transport_list%&, or
3184 &%authenticator_list%&, and a complete list of all drivers with their option
3185 settings can be obtained by using &%routers%&, &%transports%&, or
3186 &%authenticators%&.
3187
3188 .cindex "environment"
3189 If &%environment%& is given as an argument, the set of environment
3190 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3191 variables.
3192
3193 .cindex "options" "macro &-- extracting"
3194 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3195 are available, similarly to the drivers.  Because macros are sometimes used
3196 for storing passwords, this option is restricted.
3197 The output format is one item per line.
3198 For the "-bP macro <name>" form, if no such macro is found
3199 the exit status will be nonzero.
3200
3201 .vitem &%-bp%&
3202 .oindex "&%-bp%&"
3203 .cindex "queue" "listing messages in"
3204 .cindex "listing" "messages in the queue"
3205 This option requests a listing of the contents of the mail queue on the
3206 standard output. If the &%-bp%& option is followed by a list of message ids,
3207 just those messages are listed. By default, this option can be used only by an
3208 admin user. However, the &%queue_list_requires_admin%& option can be set false
3209 to allow any user to see the queue.
3210
3211 Each message in the queue is displayed as in the following example:
3212 .code
3213 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3214           red.king@looking-glass.fict.example
3215           <other addresses>
3216 .endd
3217 .cindex "message" "size in queue listing"
3218 .cindex "size" "of message"
3219 The first line contains the length of time the message has been in the queue
3220 (in this case 25 minutes), the size of the message (2.9K), the unique local
3221 identifier for the message, and the message sender, as contained in the
3222 envelope. For bounce messages, the sender address is empty, and appears as
3223 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3224 the default sender address, the user's login name is shown in parentheses
3225 before the sender address.
3226
3227 .cindex "frozen messages" "in queue listing"
3228 If the message is frozen (attempts to deliver it are suspended) then the text
3229 &"*** frozen ***"& is displayed at the end of this line.
3230
3231 The recipients of the message (taken from the envelope, not the headers) are
3232 displayed on subsequent lines. Those addresses to which the message has already
3233 been delivered are marked with the letter D. If an original address gets
3234 expanded into several addresses via an alias or forward file, the original is
3235 displayed with a D only when deliveries for all of its child addresses are
3236 complete.
3237
3238
3239 .vitem &%-bpa%&
3240 .oindex "&%-bpa%&"
3241 This option operates like &%-bp%&, but in addition it shows delivered addresses
3242 that were generated from the original top level address(es) in each message by
3243 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3244 of just &"D"&.
3245
3246
3247 .vitem &%-bpc%&
3248 .oindex "&%-bpc%&"
3249 .cindex "queue" "count of messages on"
3250 This option counts the number of messages in the queue, and writes the total
3251 to the standard output. It is restricted to admin users, unless
3252 &%queue_list_requires_admin%& is set false.
3253
3254
3255 .vitem &%-bpr%&
3256 .oindex "&%-bpr%&"
3257 This option operates like &%-bp%&, but the output is not sorted into
3258 chronological order of message arrival. This can speed it up when there are
3259 lots of messages in the queue, and is particularly useful if the output is
3260 going to be post-processed in a way that doesn't need the sorting.
3261
3262 .vitem &%-bpra%&
3263 .oindex "&%-bpra%&"
3264 This option is a combination of &%-bpr%& and &%-bpa%&.
3265
3266 .vitem &%-bpru%&
3267 .oindex "&%-bpru%&"
3268 This option is a combination of &%-bpr%& and &%-bpu%&.
3269
3270
3271 .vitem &%-bpu%&
3272 .oindex "&%-bpu%&"
3273 This option operates like &%-bp%& but shows only undelivered top-level
3274 addresses for each message displayed. Addresses generated by aliasing or
3275 forwarding are not shown, unless the message was deferred after processing by a
3276 router with the &%one_time%& option set.
3277
3278
3279 .vitem &%-brt%&
3280 .oindex "&%-brt%&"
3281 .cindex "testing" "retry configuration"
3282 .cindex "retry" "configuration testing"
3283 This option is for testing retry rules, and it must be followed by up to three
3284 arguments. It causes Exim to look for a retry rule that matches the values
3285 and to write it to the standard output. For example:
3286 .code
3287 exim -brt bach.comp.mus.example
3288 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3289 .endd
3290 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3291 argument, which is required, can be a complete address in the form
3292 &'local_part@domain'&, or it can be just a domain name. If the second argument
3293 contains a dot, it is interpreted as an optional second domain name; if no
3294 retry rule is found for the first argument, the second is tried. This ties in
3295 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3296 rule is found that matches the host, one that matches the mail domain is
3297 sought. Finally, an argument that is the name of a specific delivery error, as
3298 used in setting up retry rules, can be given. For example:
3299 .code
3300 exim -brt haydn.comp.mus.example quota_3d
3301 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3302 .endd
3303
3304 .vitem &%-brw%&
3305 .oindex "&%-brw%&"
3306 .cindex "testing" "rewriting"
3307 .cindex "rewriting" "testing"
3308 This option is for testing address rewriting rules, and it must be followed by
3309 a single argument, consisting of either a local part without a domain, or a
3310 complete address with a fully qualified domain. Exim outputs how this address
3311 would be rewritten for each possible place it might appear. See chapter
3312 &<<CHAPrewrite>>& for further details.
3313
3314 .vitem &%-bS%&
3315 .oindex "&%-bS%&"
3316 .cindex "SMTP" "batched incoming"
3317 .cindex "batched SMTP input"
3318 This option is used for batched SMTP input, which is an alternative interface
3319 for non-interactive local message submission. A number of messages can be
3320 submitted in a single run. However, despite its name, this is not really SMTP
3321 input. Exim reads each message's envelope from SMTP commands on the standard
3322 input, but generates no responses. If the caller is trusted, or
3323 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3324 believed; otherwise the sender is always the caller of Exim.
3325
3326 The message itself is read from the standard input, in SMTP format (leading
3327 dots doubled), terminated by a line containing just a single dot. An error is
3328 provoked if the terminating dot is missing. A further message may then follow.
3329
3330 As for other local message submissions, the contents of incoming batch SMTP
3331 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3332 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3333 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3334
3335 Some other SMTP commands are recognized in the input. HELO and EHLO act
3336 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3337 QUIT quits, ignoring the rest of the standard input.
3338
3339 .cindex "return code" "for &%-bS%&"
3340 If any error is encountered, reports are written to the standard output and
3341 error streams, and Exim gives up immediately. The return code is 0 if no error
3342 was detected; it is 1 if one or more messages were accepted before the error
3343 was detected; otherwise it is 2.
3344
3345 More details of input using batched SMTP are given in section
3346 &<<SECTincomingbatchedSMTP>>&.
3347
3348 .vitem &%-bs%&
3349 .oindex "&%-bs%&"
3350 .cindex "SMTP" "local input"
3351 .cindex "local SMTP input"
3352 This option causes Exim to accept one or more messages by reading SMTP commands
3353 on the standard input, and producing SMTP replies on the standard output. SMTP
3354 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3355 Some user agents use this interface as a way of passing locally-generated
3356 messages to the MTA.
3357
3358 In
3359 .cindex "sender" "source of"
3360 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3361 set, the senders of messages are taken from the SMTP MAIL commands.
3362 Otherwise the content of these commands is ignored and the sender is set up as
3363 the calling user. Unqualified addresses are automatically qualified using
3364 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3365 &%-bnq%& option is used.
3366
3367 .cindex "inetd"
3368 The
3369 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3370 using a listening daemon. Exim can distinguish the two cases by checking
3371 whether the standard input is a TCP/IP socket. When Exim is called from
3372 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3373 above concerning senders and qualification do not apply. In this situation,
3374 Exim behaves in exactly the same way as it does when receiving a message via
3375 the listening daemon.
3376
3377 .vitem &%-bt%&
3378 .oindex "&%-bt%&"
3379 .cindex "testing" "addresses"
3380 .cindex "address" "testing"
3381 This option runs Exim in address testing mode, in which each argument is taken
3382 as a recipient address to be tested for deliverability. The results are
3383 written to the standard output. If a test fails, and the caller is not an admin
3384 user, no details of the failure are output, because these might contain
3385 sensitive information such as usernames and passwords for database lookups.
3386
3387 If no arguments are given, Exim runs in an interactive manner, prompting with a
3388 right angle bracket for addresses to be tested.
3389
3390 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3391 &[readline()]& function, because it is running as &'root'& and there are
3392 security issues.
3393
3394 Each address is handled as if it were the recipient address of a message
3395 (compare the &%-bv%& option). It is passed to the routers and the result is
3396 written to the standard output. However, any router that has
3397 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3398 genuine routing tests if your first router passes everything to a scanner
3399 program.
3400
3401 .cindex "return code" "for &%-bt%&"
3402 The return code is 2 if any address failed outright; it is 1 if no address
3403 failed outright but at least one could not be resolved for some reason. Return
3404 code 0 is given only when all addresses succeed.
3405
3406 .cindex "duplicate addresses"
3407 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3408 addresses after routing is complete, so that only one delivery takes place.
3409 This does not happen when testing with &%-bt%&; the full results of routing are
3410 always shown.
3411
3412 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3413 routers in the configuration makes any tests on the sender address of a
3414 message,
3415 .oindex "&%-f%&" "for address testing"
3416 you can use the &%-f%& option to set an appropriate sender when running
3417 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3418 default qualifying domain. However, if you have set up (for example) routers
3419 whose behaviour depends on the contents of an incoming message, you cannot test
3420 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3421 doing such tests.
3422
3423 .vitem &%-bV%&
3424 .oindex "&%-bV%&"
3425 .cindex "version number of Exim"
3426 This option causes Exim to write the current version number, compilation
3427 number, and compilation date of the &'exim'& binary to the standard output.
3428 It also lists the DBM library that is being used, the optional modules (such as
3429 specific lookup types), the drivers that are included in the binary, and the
3430 name of the runtime configuration file that is in use.
3431
3432 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3433 configuration file. However, this is a static check only. It cannot check
3434 values that are to be expanded. For example, although a misspelt ACL verb is
3435 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3436 alone to discover (for example) all the typos in the configuration; some
3437 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3438 dynamic testing facilities.
3439
3440 .vitem &%-bv%&
3441 .oindex "&%-bv%&"
3442 .cindex "verifying address" "using &%-bv%&"
3443 .cindex "address" "verification"
3444 This option runs Exim in address verification mode, in which each argument is
3445 taken as a recipient address to be verified by the routers. (This does
3446 not involve any verification callouts). During normal operation, verification
3447 happens mostly as a consequence processing a &%verify%& condition in an ACL
3448 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3449 including callouts, see the &%-bh%& and &%-bhc%& options.
3450
3451 If verification fails, and the caller is not an admin user, no details of the
3452 failure are output, because these might contain sensitive information such as
3453 usernames and passwords for database lookups.
3454
3455 If no arguments are given, Exim runs in an interactive manner, prompting with a
3456 right angle bracket for addresses to be verified.
3457
3458 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3459 &[readline()]& function, because it is running as &'exim'& and there are
3460 security issues.
3461
3462 Verification differs from address testing (the &%-bt%& option) in that routers
3463 that have &%no_verify%& set are skipped, and if the address is accepted by a
3464 router that has &%fail_verify%& set, verification fails. The address is
3465 verified as a recipient if &%-bv%& is used; to test verification for a sender
3466 address, &%-bvs%& should be used.
3467
3468 If the &%-v%& option is not set, the output consists of a single line for each
3469 address, stating whether it was verified or not, and giving a reason in the
3470 latter case. Without &%-v%&, generating more than one address by redirection
3471 causes verification to end successfully, without considering the generated
3472 addresses. However, if just one address is generated, processing continues,
3473 and the generated address must verify successfully for the overall verification
3474 to succeed.
3475
3476 When &%-v%& is set, more details are given of how the address has been handled,
3477 and in the case of address redirection, all the generated addresses are also
3478 considered. Verification may succeed for some and fail for others.
3479
3480 The
3481 .cindex "return code" "for &%-bv%&"
3482 return code is 2 if any address failed outright; it is 1 if no address
3483 failed outright but at least one could not be resolved for some reason. Return
3484 code 0 is given only when all addresses succeed.
3485
3486 If any of the routers in the configuration makes any tests on the sender
3487 address of a message, you should use the &%-f%& option to set an appropriate
3488 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3489 calling user at the default qualifying domain.
3490
3491 .vitem &%-bvs%&
3492 .oindex "&%-bvs%&"
3493 This option acts like &%-bv%&, but verifies the address as a sender rather
3494 than a recipient address. This affects any rewriting and qualification that
3495 might happen.
3496
3497 .vitem &%-bw%&
3498 .oindex "&%-bw%&"
3499 .cindex "daemon"
3500 .cindex "inetd"
3501 .cindex "inetd" "wait mode"
3502 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3503 similarly to the &%-bd%& option.  All port specifications on the command-line
3504 and in the configuration file are ignored.  Queue-running may not be specified.
3505
3506 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3507 listening for connections.  This permits the system to start up and have
3508 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3509 each port only when the first connection is received.
3510
3511 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3512 which the daemon will exit, which should cause inetd to listen once more.
3513
3514 .vitem &%-C%&&~<&'filelist'&>
3515 .oindex "&%-C%&"
3516 .cindex "configuration file" "alternate"
3517 .cindex "CONFIGURE_FILE"
3518 .cindex "alternate configuration file"
3519 This option causes Exim to find the runtime configuration file from the given
3520 list instead of from the list specified by the CONFIGURE_FILE
3521 compile-time setting. Usually, the list will consist of just a single filename,
3522 but it can be a colon-separated list of names. In this case, the first
3523 file that exists is used. Failure to open an existing file stops Exim from
3524 proceeding any further along the list, and an error is generated.
3525
3526 When this option is used by a caller other than root, and the list is different
3527 from the compiled-in list, Exim gives up its root privilege immediately, and
3528 runs with the real and effective uid and gid set to those of the caller.
3529 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3530 file contains a list of full pathnames, one per line, for configuration files
3531 which are trusted. Root privilege is retained for any configuration file so
3532 listed, as long as the caller is the Exim user (or the user specified in the
3533 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3534 not writeable by inappropriate users or groups.
3535
3536 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3537 configuration using &%-C%& right through message reception and delivery,
3538 even if the caller is root. The reception works, but by that time, Exim is
3539 running as the Exim user, so when it re-executes to regain privilege for the
3540 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3541 test reception and delivery using two separate commands (one to put a message
3542 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3543
3544 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3545 prefix string with which any file named in a &%-C%& command line option
3546 must start. In addition, the filename must not contain the sequence &`/../`&.
3547 However, if the value of the &%-C%& option is identical to the value of
3548 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3549 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3550 unset, any filename can be used with &%-C%&.
3551
3552 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3553 to a directory to which only root has access. This prevents someone who has
3554 broken into the Exim account from running a privileged Exim with an arbitrary
3555 configuration file.
3556
3557 The &%-C%& facility is useful for ensuring that configuration files are
3558 syntactically correct, but cannot be used for test deliveries, unless the
3559 caller is privileged, or unless it is an exotic configuration that does not
3560 require privilege. No check is made on the owner or group of the files
3561 specified by this option.
3562
3563
3564 .vitem &%-D%&<&'macro'&>=<&'value'&>
3565 .oindex "&%-D%&"
3566 .cindex "macro" "setting on command line"
3567 This option can be used to override macro definitions in the configuration file
3568 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3569 unprivileged caller, it causes Exim to give up its root privilege.
3570 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3571 completely disabled, and its use causes an immediate error exit.
3572
3573 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3574 colon-separated list of macros which are considered safe and, if &%-D%& only
3575 supplies macros from this list, and the values are acceptable, then Exim will
3576 not give up root privilege if the caller is root, the Exim run-time user, or
3577 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3578 to be removed in the future.  Acceptable values for the macros satisfy the
3579 regexp: &`^[A-Za-z0-9_/.-]*$`&
3580
3581 The entire option (including equals sign if present) must all be within one
3582 command line item. &%-D%& can be used to set the value of a macro to the empty
3583 string, in which case the equals sign is optional. These two commands are
3584 synonymous:
3585 .code
3586 exim -DABC  ...
3587 exim -DABC= ...
3588 .endd
3589 To include spaces in a macro definition item, quotes must be used. If you use
3590 quotes, spaces are permitted around the macro name and the equals sign. For
3591 example:
3592 .code
3593 exim '-D ABC = something' ...
3594 .endd
3595 &%-D%& may be repeated up to 10 times on a command line.
3596 Only macro names up to 22 letters long can be set.
3597
3598
3599 .vitem &%-d%&<&'debug&~options'&>
3600 .oindex "&%-d%&"
3601 .cindex "debugging" "list of selectors"
3602 .cindex "debugging" "&%-d%& option"
3603 This option causes debugging information to be written to the standard
3604 error stream. It is restricted to admin users because debugging output may show
3605 database queries that contain password information. Also, the details of users'
3606 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3607 writes an error message to the standard error stream and exits with a non-zero
3608 return code.
3609
3610 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3611 standard debugging data is output. This can be reduced, or increased to include
3612 some more rarely needed information, by directly following &%-d%& with a string
3613 made up of names preceded by plus or minus characters. These add or remove sets
3614 of debugging data, respectively. For example, &%-d+filter%& adds filter
3615 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3616 no spaces are allowed in the debug setting. The available debugging categories
3617 are:
3618 .display
3619 &`acl            `& ACL interpretation
3620 &`auth           `& authenticators
3621 &`deliver        `& general delivery logic
3622 &`dns            `& DNS lookups (see also resolver)
3623 &`dnsbl          `& DNS black list (aka RBL) code
3624 &`exec           `& arguments for &[execv()]& calls
3625 &`expand         `& detailed debugging for string expansions
3626 &`filter         `& filter handling
3627 &`hints_lookup   `& hints data lookups
3628 &`host_lookup    `& all types of name-to-IP address handling
3629 &`ident          `& ident lookup
3630 &`interface      `& lists of local interfaces
3631 &`lists          `& matching things in lists
3632 &`load           `& system load checks
3633 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3634                     &<<CHAPlocalscan>>&)
3635 &`lookup         `& general lookup code and all lookups
3636 &`memory         `& memory handling
3637 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3638 &`pid            `& modifier: add pid to debug output lines
3639 &`process_info   `& setting info for the process log
3640 &`queue_run      `& queue runs
3641 &`receive        `& general message reception logic
3642 &`resolver       `& turn on the DNS resolver's debugging output
3643 &`retry          `& retry handling
3644 &`rewrite        `& address rewriting
3645 &`route          `& address routing
3646 &`timestamp      `& modifier: add timestamp to debug output lines
3647 &`tls            `& TLS logic
3648 &`transport      `& transports
3649 &`uid            `& changes of uid/gid and looking up uid/gid
3650 &`verify         `& address verification logic
3651 &`all            `& almost all of the above (see below), and also &%-v%&
3652 .endd
3653 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3654 for &`-all`&. The reason for this is that &`+all`& is something that people
3655 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3656 is included, an awful lot of output that is very rarely of interest is
3657 generated, so it now has to be explicitly requested. However, &`-all`& does
3658 turn everything off.
3659
3660 .cindex "resolver, debugging output"
3661 .cindex "DNS resolver, debugging output"
3662 The &`resolver`& option produces output only if the DNS resolver was compiled
3663 with DEBUG enabled. This is not the case in some operating systems. Also,
3664 unfortunately, debugging output from the DNS resolver is written to stdout
3665 rather than stderr.
3666
3667 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3668 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3669 However, the &`pid`& selector is forced when debugging is turned on for a
3670 daemon, which then passes it on to any re-executed Exims. Exim also
3671 automatically adds the pid to debug lines when several remote deliveries are
3672 run in parallel.
3673
3674 The &`timestamp`& selector causes the current time to be inserted at the start
3675 of all debug output lines. This can be useful when trying to track down delays
3676 in processing.
3677
3678 .cindex debugging "UTF-8 in"
3679 .cindex UTF-8 "in debug output"
3680 The &`noutf8`& selector disables the use of
3681 UTF-8 line-drawing characters to group related information.
3682 When disabled. ascii-art is used instead.
3683 Using the &`+all`& option does not set this modifier,
3684
3685 If the &%debug_print%& option is set in any driver, it produces output whenever
3686 any debugging is selected, or if &%-v%& is used.
3687
3688 .vitem &%-dd%&<&'debug&~options'&>
3689 .oindex "&%-dd%&"
3690 This option behaves exactly like &%-d%& except when used on a command that
3691 starts a daemon process. In that case, debugging is turned off for the
3692 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3693 behaviour of the daemon without creating as much output as full debugging does.
3694
3695 .vitem &%-dropcr%&
3696 .oindex "&%-dropcr%&"
3697 This is an obsolete option that is now a no-op. It used to affect the way Exim
3698 handled CR and LF characters in incoming messages. What happens now is
3699 described in section &<<SECTlineendings>>&.
3700
3701 .vitem &%-E%&
3702 .oindex "&%-E%&"
3703 .cindex "bounce message" "generating"
3704 This option specifies that an incoming message is a locally-generated delivery
3705 failure report. It is used internally by Exim when handling delivery failures
3706 and is not intended for external use. Its only effect is to stop Exim
3707 generating certain messages to the postmaster, as otherwise message cascades
3708 could occur in some situations. As part of the same option, a message id may
3709 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3710 new message contains the id, following &"R="&, as a cross-reference.
3711
3712 .vitem &%-e%&&'x'&
3713 .oindex "&%-e%&&'x'&"
3714 There are a number of Sendmail options starting with &%-oe%& which seem to be
3715 called by various programs without the leading &%o%& in the option. For
3716 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3717 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3718
3719 .vitem &%-F%&&~<&'string'&>
3720 .oindex "&%-F%&"
3721 .cindex "sender" "name"
3722 .cindex "name" "of sender"
3723 This option sets the sender's full name for use when a locally-generated
3724 message is being accepted. In the absence of this option, the user's &'gecos'&
3725 entry from the password data is used. As users are generally permitted to alter
3726 their &'gecos'& entries, no security considerations are involved. White space
3727 between &%-F%& and the <&'string'&> is optional.
3728
3729 .vitem &%-f%&&~<&'address'&>
3730 .oindex "&%-f%&"
3731 .cindex "sender" "address"
3732 .cindex "address" "sender"
3733 .cindex "trusted users"
3734 .cindex "envelope from"
3735 .cindex "envelope sender"
3736 .cindex "user" "trusted"
3737 This option sets the address of the envelope sender of a locally-generated
3738 message (also known as the return path). The option can normally be used only
3739 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3740 users to use it.
3741
3742 Processes running as root or the Exim user are always trusted. Other
3743 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3744 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3745 of a local message is set to the caller's login name at the default qualify
3746 domain.
3747
3748 There is one exception to the restriction on the use of &%-f%&: an empty sender
3749 can be specified by any user, trusted or not, to create a message that can
3750 never provoke a bounce. An empty sender can be specified either as an empty
3751 string, or as a pair of angle brackets with nothing between them, as in these
3752 examples of shell commands:
3753 .code
3754 exim -f '<>' user@domain
3755 exim -f "" user@domain
3756 .endd
3757 In addition, the use of &%-f%& is not restricted when testing a filter file
3758 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3759 &%-bv%& options.
3760
3761 Allowing untrusted users to change the sender address does not of itself make
3762 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3763 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3764 though this can be overridden by setting &%no_local_from_check%&.
3765
3766 White
3767 .cindex "&""From""& line"
3768 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3769 given as two arguments or one combined argument). The sender of a
3770 locally-generated message can also be set (when permitted) by an initial
3771 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3772 if &%-f%& is also present, it overrides &"From&~"&.
3773
3774 .vitem &%-G%&
3775 .oindex "&%-G%&"
3776 .cindex "submission fixups, suppressing (command-line)"
3777 This option is equivalent to an ACL applying:
3778 .code
3779 control = suppress_local_fixups
3780 .endd
3781 for every message received.  Note that Sendmail will complain about such
3782 bad formatting, where Exim silently just does not fix it up.  This may change
3783 in future.
3784
3785 As this affects audit information, the caller must be a trusted user to use
3786 this option.
3787
3788 .vitem &%-h%&&~<&'number'&>
3789 .oindex "&%-h%&"
3790 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3791 This option is accepted for compatibility with Sendmail, but has no effect. (In
3792 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3793 headers.)
3794
3795 .vitem &%-i%&
3796 .oindex "&%-i%&"
3797 .cindex "Solaris" "&'mail'& command"
3798 .cindex "dot" "in incoming non-SMTP message"
3799 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3800 line by itself should not terminate an incoming, non-SMTP message. I can find
3801 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3802 command in Solaris 2.4 uses it. See also &%-ti%&.
3803
3804 .vitem &%-L%&&~<&'tag'&>
3805 .oindex "&%-L%&"
3806 .cindex "syslog" "process name; set with flag"
3807 This option is equivalent to setting &%syslog_processname%& in the config
3808 file and setting &%log_file_path%& to &`syslog`&.
3809 Its use is restricted to administrators.  The configuration file has to be
3810 read and parsed, to determine access rights, before this is set and takes
3811 effect, so early configuration file errors will not honour this flag.
3812
3813 The tag should not be longer than 32 characters.
3814
3815 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3816 .oindex "&%-M%&"
3817 .cindex "forcing delivery"
3818 .cindex "delivery" "forcing attempt"
3819 .cindex "frozen messages" "forcing delivery"
3820 This option requests Exim to run a delivery attempt on each message in turn. If
3821 any of the messages are frozen, they are automatically thawed before the
3822 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3823 and &%hold_domains%& are ignored.
3824
3825 Retry
3826 .cindex "hints database" "overriding retry hints"
3827 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3828 the normal retry time has not yet been reached. This option requires the caller
3829 to be an admin user. However, there is an option called &%prod_requires_admin%&
3830 which can be set false to relax this restriction (and also the same requirement
3831 for the &%-q%&, &%-R%&, and &%-S%& options).
3832
3833 The deliveries happen synchronously, that is, the original Exim process does
3834 not terminate until all the delivery attempts have finished. No output is
3835 produced unless there is a serious error. If you want to see what is happening,
3836 use the &%-v%& option as well, or inspect Exim's main log.
3837
3838 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3839 .oindex "&%-Mar%&"
3840 .cindex "message" "adding recipients"
3841 .cindex "recipient" "adding"
3842 This option requests Exim to add the addresses to the list of recipients of the
3843 message (&"ar"& for &"add recipients"&). The first argument must be a message
3844 id, and the remaining ones must be email addresses. However, if the message is
3845 active (in the middle of a delivery attempt), it is not altered. This option
3846 can be used only by an admin user.
3847
3848 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3849         &~<&'message&~id'&>"
3850 .oindex "&%-MC%&"
3851 .cindex "SMTP" "passed connection"
3852 .cindex "SMTP" "multiple deliveries"
3853 .cindex "multiple SMTP deliveries"
3854 This option is not intended for use by external callers. It is used internally
3855 by Exim to invoke another instance of itself to deliver a waiting message using
3856 an existing SMTP connection, which is passed as the standard input. Details are
3857 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3858 must be root or the Exim user in order to use it.
3859
3860 .vitem &%-MCA%&
3861 .oindex "&%-MCA%&"
3862 This option is not intended for use by external callers. It is used internally
3863 by Exim in conjunction with the &%-MC%& option. It signifies that the
3864 connection to the remote host has been authenticated.
3865
3866 .vitem &%-MCD%&
3867 .oindex "&%-MCD%&"
3868 This option is not intended for use by external callers. It is used internally
3869 by Exim in conjunction with the &%-MC%& option. It signifies that the
3870 remote host supports the ESMTP &_DSN_& extension.
3871
3872 .vitem &%-MCd%&
3873 .oindex "&%-MCd%&"
3874 This option is not intended for use by external callers. It is used internally
3875 by Exim in conjunction with the &%-d%& option
3876 to pass on an information string on the purpose of the process.
3877
3878 .vitem &%-MCG%&&~<&'queue&~name'&>
3879 .oindex "&%-MCG%&"
3880 This option is not intended for use by external callers. It is used internally
3881 by Exim in conjunction with the &%-MC%& option. It signifies that an
3882 alternate queue is used, named by the following argument.
3883
3884 .vitem &%-MCK%&
3885 .oindex "&%-MCK%&"
3886 This option is not intended for use by external callers. It is used internally
3887 by Exim in conjunction with the &%-MC%& option. It signifies that a
3888 remote host supports the ESMTP &_CHUNKING_& extension.
3889
3890 .vitem &%-MCP%&
3891 .oindex "&%-MCP%&"
3892 This option is not intended for use by external callers. It is used internally
3893 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3894 which Exim is connected supports pipelining.
3895
3896 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3897 .oindex "&%-MCQ%&"
3898 This option is not intended for use by external callers. It is used internally
3899 by Exim in conjunction with the &%-MC%& option when the original delivery was
3900 started by a queue runner. It passes on the process id of the queue runner,
3901 together with the file descriptor number of an open pipe. Closure of the pipe
3902 signals the final completion of the sequence of processes that are passing
3903 messages through the same SMTP connection.
3904
3905 .new
3906 .vitem &%-MCq%&&~<&'recipient&~address'&>&~<&'size'&>
3907 .oindex "&%-MCq%&"
3908 This option is not intended for use by external callers. It is used internally
3909 by Exim to implement quota checking for local users.
3910 .wen
3911
3912 .vitem &%-MCS%&
3913 .oindex "&%-MCS%&"
3914 This option is not intended for use by external callers. It is used internally
3915 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3916 ESMTP SIZE option should be used on messages delivered down the existing
3917 connection.
3918
3919 .vitem &%-MCT%&
3920 .oindex "&%-MCT%&"
3921 This option is not intended for use by external callers. It is used internally
3922 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3923 host to which Exim is connected supports TLS encryption.
3924
3925 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3926 .oindex "&%-MCt%&"
3927 This option is not intended for use by external callers. It is used internally
3928 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3929 connection is being proxied by a parent process for handling TLS encryption.
3930 The arguments give the local address and port being proxied, and the TLS cipher.
3931
3932 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3933 .oindex "&%-Mc%&"
3934 .cindex "hints database" "not overridden by &%-Mc%&"
3935 .cindex "delivery" "manually started &-- not forced"
3936 This option requests Exim to run a delivery attempt on each message, in turn,
3937 but unlike the &%-M%& option, it does check for retry hints, and respects any
3938 that are found. This option is not very useful to external callers. It is
3939 provided mainly for internal use by Exim when it needs to re-invoke itself in
3940 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3941 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3942 respects retry times and other options such as &%hold_domains%& that are
3943 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3944 If you want to run a specific delivery as if in a queue run, you should use
3945 &%-q%& with a message id argument. A distinction between queue run deliveries
3946 and other deliveries is made in one or two places.
3947
3948 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3949 .oindex "&%-Mes%&"
3950 .cindex "message" "changing sender"
3951 .cindex "sender" "changing"
3952 This option requests Exim to change the sender address in the message to the
3953 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3954 &"edit sender"&). There must be exactly two arguments. The first argument must
3955 be a message id, and the second one an email address. However, if the message
3956 is active (in the middle of a delivery attempt), its status is not altered.
3957 This option can be used only by an admin user.
3958
3959 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3960 .oindex "&%-Mf%&"
3961 .cindex "freezing messages"
3962 .cindex "message" "manually freezing"
3963 This option requests Exim to mark each listed message as &"frozen"&. This
3964 prevents any delivery attempts taking place until the message is &"thawed"&,
3965 either manually or as a result of the &%auto_thaw%& configuration option.
3966 However, if any of the messages are active (in the middle of a delivery
3967 attempt), their status is not altered. This option can be used only by an admin
3968 user.
3969
3970 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3971 .oindex "&%-Mg%&"
3972 .cindex "giving up on messages"
3973 .cindex "message" "abandoning delivery attempts"
3974 .cindex "delivery" "abandoning further attempts"
3975 This option requests Exim to give up trying to deliver the listed messages,
3976 including any that are frozen. However, if any of the messages are active,
3977 their status is not altered. For non-bounce messages, a delivery error message
3978 is sent to the sender, containing the text &"cancelled by administrator"&.
3979 Bounce messages are just discarded. This option can be used only by an admin
3980 user.
3981
3982 .vitem &%-MG%&&~<&'queue&~name'&>&~<&'message&~id'&>&~<&'message&~id'&>&~...
3983 .oindex "&%-MG%&"
3984 .cindex queue named
3985 .cindex "named queues" "moving messages"
3986 .cindex "queue" "moving messages"
3987 This option requests that each listed message be moved from its current
3988 queue to the given named queue.
3989 The destination queue name argument is required, but can be an empty
3990 string to define the default queue.
3991 If the messages are not currently located in the default queue,
3992 a &%-qG<name>%& option will be required to define the source queue.
3993
3994 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3995 .oindex "&%-Mmad%&"
3996 .cindex "delivery" "cancelling all"
3997 This option requests Exim to mark all the recipient addresses in the messages
3998 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3999 message is active (in the middle of a delivery attempt), its status is not
4000 altered. This option can be used only by an admin user.
4001
4002 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
4003 .oindex "&%-Mmd%&"
4004 .cindex "delivery" "cancelling by address"
4005 .cindex "recipient" "removing"
4006 .cindex "removing recipients"
4007 This option requests Exim to mark the given addresses as already delivered
4008 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
4009 the remaining ones must be email addresses. These are matched to recipient
4010 addresses in the message in a case-sensitive manner. If the message is active
4011 (in the middle of a delivery attempt), its status is not altered. This option
4012 can be used only by an admin user.
4013
4014 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4015 .oindex "&%-Mrm%&"
4016 .cindex "removing messages"
4017 .cindex "abandoning mail"
4018 .cindex "message" "manually discarding"
4019 This option requests Exim to remove the given messages from the queue. No
4020 bounce messages are sent; each message is simply forgotten. However, if any of
4021 the messages are active, their status is not altered. This option can be used
4022 only by an admin user or by the user who originally caused the message to be
4023 placed in the queue.
4024
4025 . .new
4026 . .vitem &%-MS%&
4027 . .oindex "&%-MS%&"
4028 . .cindex REQUIRETLS
4029 . This option is used to request REQUIRETLS processing on the message.
4030 . It is used internally by Exim in conjunction with -E when generating
4031 . a bounce message.
4032 . .wen
4033
4034 .vitem &%-Mset%&&~<&'message&~id'&>
4035 .oindex "&%-Mset%&"
4036 .cindex "testing" "string expansion"
4037 .cindex "expansion" "testing"
4038 This option is useful only in conjunction with &%-be%& (that is, when testing
4039 string expansions). Exim loads the given message from its spool before doing
4040 the test expansions, thus setting message-specific variables such as
4041 &$message_size$& and the header variables. The &$recipients$& variable is made
4042 available. This feature is provided to make it easier to test expansions that
4043 make use of these variables. However, this option can be used only by an admin
4044 user. See also &%-bem%&.
4045
4046 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4047 .oindex "&%-Mt%&"
4048 .cindex "thawing messages"
4049 .cindex "unfreezing messages"
4050 .cindex "frozen messages" "thawing"
4051 .cindex "message" "thawing frozen"
4052 This option requests Exim to &"thaw"& any of the listed messages that are
4053 &"frozen"&, so that delivery attempts can resume. However, if any of the
4054 messages are active, their status is not altered. This option can be used only
4055 by an admin user.
4056
4057 .vitem &%-Mvb%&&~<&'message&~id'&>
4058 .oindex "&%-Mvb%&"
4059 .cindex "listing" "message body"
4060 .cindex "message" "listing body of"
4061 This option causes the contents of the message body (-D) spool file to be
4062 written to the standard output. This option can be used only by an admin user.
4063
4064 .vitem &%-Mvc%&&~<&'message&~id'&>
4065 .oindex "&%-Mvc%&"
4066 .cindex "message" "listing in RFC 2822 format"
4067 .cindex "listing" "message in RFC 2822 format"
4068 This option causes a copy of the complete message (header lines plus body) to
4069 be written to the standard output in RFC 2822 format. This option can be used
4070 only by an admin user.
4071
4072 .vitem &%-Mvh%&&~<&'message&~id'&>
4073 .oindex "&%-Mvh%&"
4074 .cindex "listing" "message headers"
4075 .cindex "header lines" "listing"
4076 .cindex "message" "listing header lines"
4077 This option causes the contents of the message headers (-H) spool file to be
4078 written to the standard output. This option can be used only by an admin user.
4079
4080 .vitem &%-Mvl%&&~<&'message&~id'&>
4081 .oindex "&%-Mvl%&"
4082 .cindex "listing" "message log"
4083 .cindex "message" "listing message log"
4084 This option causes the contents of the message log spool file to be written to
4085 the standard output. This option can be used only by an admin user.
4086
4087 .vitem &%-m%&
4088 .oindex "&%-m%&"
4089 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4090 treats it that way too.
4091
4092 .vitem &%-N%&
4093 .oindex "&%-N%&"
4094 .cindex "debugging" "&%-N%& option"
4095 .cindex "debugging" "suppressing delivery"
4096 This is a debugging option that inhibits delivery of a message at the transport
4097 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4098 it just doesn't actually transport the message, but instead behaves as if it
4099 had successfully done so. However, it does not make any updates to the retry
4100 database, and the log entries for deliveries are flagged with &"*>"& rather
4101 than &"=>"&.
4102
4103 Because &%-N%& discards any message to which it applies, only root or the Exim
4104 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4105 words, an ordinary user can use it only when supplying an incoming message to
4106 which it will apply. Although transportation never fails when &%-N%& is set, an
4107 address may be deferred because of a configuration problem on a transport, or a
4108 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4109 the message, and applies to any subsequent delivery attempts that may happen
4110 for that message.
4111
4112 .vitem &%-n%&
4113 .oindex "&%-n%&"
4114 This option is interpreted by Sendmail to mean &"no aliasing"&.
4115 For normal modes of operation, it is ignored by Exim.
4116 When combined with &%-bP%& it makes the output more terse (suppresses
4117 option names, environment values and config pretty printing).
4118
4119 .vitem &%-O%&&~<&'data'&>
4120 .oindex "&%-O%&"
4121 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4122 Exim.
4123
4124 .vitem &%-oA%&&~<&'file&~name'&>
4125 .oindex "&%-oA%&"
4126 .cindex "Sendmail compatibility" "&%-oA%& option"
4127 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4128 alternative alias filename. Exim handles &%-bi%& differently; see the
4129 description above.
4130
4131 .vitem &%-oB%&&~<&'n'&>
4132 .oindex "&%-oB%&"
4133 .cindex "SMTP" "passed connection"
4134 .cindex "SMTP" "multiple deliveries"
4135 .cindex "multiple SMTP deliveries"
4136 This is a debugging option which limits the maximum number of messages that can
4137 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4138 transport. If <&'n'&> is omitted, the limit is set to 1.
4139
4140 .vitem &%-odb%&
4141 .oindex "&%-odb%&"
4142 .cindex "background delivery"
4143 .cindex "delivery" "in the background"
4144 This option applies to all modes in which Exim accepts incoming messages,
4145 including the listening daemon. It requests &"background"& delivery of such
4146 messages, which means that the accepting process automatically starts a
4147 delivery process for each message received, but does not wait for the delivery
4148 processes to finish.
4149
4150 When all the messages have been received, the reception process exits,
4151 leaving the delivery processes to finish in their own time. The standard output
4152 and error streams are closed at the start of each delivery process.
4153 This is the default action if none of the &%-od%& options are present.
4154
4155 If one of the queueing options in the configuration file
4156 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4157 overrides it if &%queue_only_override%& is set true, which is the default
4158 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4159
4160 .vitem &%-odf%&
4161 .oindex "&%-odf%&"
4162 .cindex "foreground delivery"
4163 .cindex "delivery" "in the foreground"
4164 This option requests &"foreground"& (synchronous) delivery when Exim has
4165 accepted a locally-generated message. (For the daemon it is exactly the same as
4166 &%-odb%&.) A delivery process is automatically started to deliver the message,
4167 and Exim waits for it to complete before proceeding.
4168
4169 The original Exim reception process does not finish until the delivery
4170 process for the final message has ended. The standard error stream is left open
4171 during deliveries.
4172
4173 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4174 false and one of the queueing options in the configuration file is in effect.
4175
4176 If there is a temporary delivery error during foreground delivery, the
4177 message is left in the queue for later delivery, and the original reception
4178 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4179 restricted configuration that never queues messages.
4180
4181
4182 .vitem &%-odi%&
4183 .oindex "&%-odi%&"
4184 This option is synonymous with &%-odf%&. It is provided for compatibility with
4185 Sendmail.
4186
4187 .vitem &%-odq%&
4188 .oindex "&%-odq%&"
4189 .cindex "non-immediate delivery"
4190 .cindex "delivery" "suppressing immediate"
4191 .cindex "queueing incoming messages"
4192 This option applies to all modes in which Exim accepts incoming messages,
4193 including the listening daemon. It specifies that the accepting process should
4194 not automatically start a delivery process for each message received. Messages
4195 are placed in the queue, and remain there until a subsequent queue runner
4196 process encounters them. There are several configuration options (such as
4197 &%queue_only%&) that can be used to queue incoming messages under certain
4198 conditions. This option overrides all of them and also &%-odqs%&. It always
4199 forces queueing.
4200
4201 .vitem &%-odqs%&
4202 .oindex "&%-odqs%&"
4203 .cindex "SMTP" "delaying delivery"
4204 .cindex "first pass routing"
4205 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4206 However, like &%-odb%& and &%-odi%&, this option has no effect if
4207 &%queue_only_override%& is false and one of the queueing options in the
4208 configuration file is in effect.
4209
4210 When &%-odqs%& does operate, a delivery process is started for each incoming
4211 message, in the background by default, but in the foreground if &%-odi%& is
4212 also present. The recipient addresses are routed, and local deliveries are done
4213 in the normal way. However, if any SMTP deliveries are required, they are not
4214 done at this time, so the message remains in the queue until a subsequent queue
4215 runner process encounters it. Because routing was done, Exim knows which
4216 messages are waiting for which hosts, and so a number of messages for the same
4217 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4218 configuration option has the same effect for specific domains. See also the
4219 &%-qq%& option.
4220
4221 .vitem &%-oee%&
4222 .oindex "&%-oee%&"
4223 .cindex "error" "reporting"
4224 If an error is detected while a non-SMTP message is being received (for
4225 example, a malformed address), the error is reported to the sender in a mail
4226 message.
4227
4228 .cindex "return code" "for &%-oee%&"
4229 Provided
4230 this error message is successfully sent, the Exim receiving process
4231 exits with a return code of zero. If not, the return code is 2 if the problem
4232 is that the original message has no recipients, or 1 for any other error.
4233 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4234
4235 .vitem &%-oem%&
4236 .oindex "&%-oem%&"
4237 .cindex "error" "reporting"
4238 .cindex "return code" "for &%-oem%&"
4239 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4240 return code, whether or not the error message was successfully sent.
4241 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4242
4243 .vitem &%-oep%&
4244 .oindex "&%-oep%&"
4245 .cindex "error" "reporting"
4246 If an error is detected while a non-SMTP message is being received, the
4247 error is reported by writing a message to the standard error file (stderr).
4248 .cindex "return code" "for &%-oep%&"
4249 The return code is 1 for all errors.
4250
4251 .vitem &%-oeq%&
4252 .oindex "&%-oeq%&"
4253 .cindex "error" "reporting"
4254 This option is supported for compatibility with Sendmail, but has the same
4255 effect as &%-oep%&.
4256
4257 .vitem &%-oew%&
4258 .oindex "&%-oew%&"
4259 .cindex "error" "reporting"
4260 This option is supported for compatibility with Sendmail, but has the same
4261 effect as &%-oem%&.
4262
4263 .vitem &%-oi%&
4264 .oindex "&%-oi%&"
4265 .cindex "dot" "in incoming non-SMTP message"
4266 This option, which has the same effect as &%-i%&, specifies that a dot on a
4267 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4268 single dot does terminate, though Exim does no special processing for other
4269 lines that start with a dot. This option is set by default if Exim is called as
4270 &'rmail'&. See also &%-ti%&.
4271
4272 .vitem &%-oitrue%&
4273 .oindex "&%-oitrue%&"
4274 This option is treated as synonymous with &%-oi%&.
4275
4276 .vitem &%-oMa%&&~<&'host&~address'&>
4277 .oindex "&%-oMa%&"
4278 .cindex "sender" "host address, specifying for local message"
4279 A number of options starting with &%-oM%& can be used to set values associated
4280 with remote hosts on locally-submitted messages (that is, messages not received
4281 over TCP/IP). These options can be used by any caller in conjunction with the
4282 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4283 other circumstances, they are ignored unless the caller is trusted.
4284
4285 The &%-oMa%& option sets the sender host address. This may include a port
4286 number at the end, after a full stop (period). For example:
4287 .code
4288 exim -bs -oMa 10.9.8.7.1234
4289 .endd
4290 An alternative syntax is to enclose the IP address in square brackets,
4291 followed by a colon and the port number:
4292 .code
4293 exim -bs -oMa [10.9.8.7]:1234
4294 .endd
4295 The IP address is placed in the &$sender_host_address$& variable, and the
4296 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4297 are present on the command line, the sender host IP address is taken from
4298 whichever one is last.
4299
4300 .vitem &%-oMaa%&&~<&'name'&>
4301 .oindex "&%-oMaa%&"
4302 .cindex "authentication" "name, specifying for local message"
4303 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4304 option sets the value of &$sender_host_authenticated$& (the authenticator
4305 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4306 This option can be used with &%-bh%& and &%-bs%& to set up an
4307 authenticated SMTP session without actually using the SMTP AUTH command.
4308
4309 .vitem &%-oMai%&&~<&'string'&>
4310 .oindex "&%-oMai%&"
4311 .cindex "authentication" "id, specifying for local message"
4312 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4313 option sets the value of &$authenticated_id$& (the id that was authenticated).
4314 This overrides the default value (the caller's login id, except with &%-bh%&,
4315 where there is no default) for messages from local sources. See chapter
4316 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4317
4318 .vitem &%-oMas%&&~<&'address'&>
4319 .oindex "&%-oMas%&"
4320 .cindex "authentication" "sender, specifying for local message"
4321 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4322 option sets the authenticated sender value in &$authenticated_sender$&. It
4323 overrides the sender address that is created from the caller's login id for
4324 messages from local sources, except when &%-bh%& is used, when there is no
4325 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4326 specified on a MAIL command overrides this value. See chapter
4327 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4328
4329 .vitem &%-oMi%&&~<&'interface&~address'&>
4330 .oindex "&%-oMi%&"
4331 .cindex "interface" "address, specifying for local message"
4332 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4333 option sets the IP interface address value. A port number may be included,
4334 using the same syntax as for &%-oMa%&. The interface address is placed in
4335 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4336
4337 .vitem &%-oMm%&&~<&'message&~reference'&>
4338 .oindex "&%-oMm%&"
4339 .cindex "message reference" "message reference, specifying for local message"
4340 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4341 option sets the message reference, e.g. message-id, and is logged during
4342 delivery. This is useful when some kind of audit trail is required to tie
4343 messages together. The format of the message reference is checked and will
4344 abort if the format is invalid. The option will only be accepted if exim is
4345 running in trusted mode, not as any regular user.
4346
4347 The best example of a message reference is when Exim sends a bounce message.
4348 The message reference is the message-id of the original message for which Exim
4349 is sending the bounce.
4350
4351 .vitem &%-oMr%&&~<&'protocol&~name'&>
4352 .oindex "&%-oMr%&"
4353 .cindex "protocol, specifying for local message"
4354 .vindex "&$received_protocol$&"
4355 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4356 option sets the received protocol value that is stored in
4357 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4358 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4359 SMTP protocol names (see the description of &$received_protocol$& in section
4360 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4361 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4362 be set by &%-oMr%&. Repeated use of this option is not supported.
4363
4364 .vitem &%-oMs%&&~<&'host&~name'&>
4365 .oindex "&%-oMs%&"
4366 .cindex "sender" "host name, specifying for local message"
4367 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4368 option sets the sender host name in &$sender_host_name$&. When this option is
4369 present, Exim does not attempt to look up a host name from an IP address; it
4370 uses the name it is given.
4371
4372 .vitem &%-oMt%&&~<&'ident&~string'&>
4373 .oindex "&%-oMt%&"
4374 .cindex "sender" "ident string, specifying for local message"
4375 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4376 option sets the sender ident value in &$sender_ident$&. The default setting for
4377 local callers is the login id of the calling process, except when &%-bh%& is
4378 used, when there is no default.
4379
4380 .vitem &%-om%&
4381 .oindex "&%-om%&"
4382 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4383 In Sendmail, this option means &"me too"&, indicating that the sender of a
4384 message should receive a copy of the message if the sender appears in an alias
4385 expansion. Exim always does this, so the option does nothing.
4386
4387 .vitem &%-oo%&
4388 .oindex "&%-oo%&"
4389 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4390 This option is ignored. In Sendmail it specifies &"old style headers"&,
4391 whatever that means.
4392
4393 .vitem &%-oP%&&~<&'path'&>
4394 .oindex "&%-oP%&"
4395 .cindex "pid (process id)" "of daemon"
4396 .cindex "daemon" "process id (pid)"
4397 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4398 value. The option specifies the file to which the process id of the daemon is
4399 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4400 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4401 because in those cases, the normal pid file is not used.
4402
4403 .vitem &%-oPX%&
4404 .oindex "&%-oPX%&"
4405 .cindex "pid (process id)" "of daemon"
4406 .cindex "daemon" "process id (pid)"
4407 This option is not intended for general use.
4408 The daemon uses it when terminating due to a SIGTEM, possibly in
4409 combination with &%-oP%&&~<&'path'&>.
4410 It causes the pid file to be removed.
4411
4412 .vitem &%-or%&&~<&'time'&>
4413 .oindex "&%-or%&"
4414 .cindex "timeout" "for non-SMTP input"
4415 This option sets a timeout value for incoming non-SMTP messages. If it is not
4416 set, Exim will wait forever for the standard input. The value can also be set
4417 by the &%receive_timeout%& option. The format used for specifying times is
4418 described in section &<<SECTtimeformat>>&.
4419
4420 .vitem &%-os%&&~<&'time'&>
4421 .oindex "&%-os%&"
4422 .cindex "timeout" "for SMTP input"
4423 .cindex "SMTP" "input timeout"
4424 This option sets a timeout value for incoming SMTP messages. The timeout
4425 applies to each SMTP command and block of data. The value can also be set by
4426 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4427 for specifying times is described in section &<<SECTtimeformat>>&.
4428
4429 .vitem &%-ov%&
4430 .oindex "&%-ov%&"
4431 This option has exactly the same effect as &%-v%&.
4432
4433 .vitem &%-oX%&&~<&'number&~or&~string'&>
4434 .oindex "&%-oX%&"
4435 .cindex "TCP/IP" "setting listening ports"
4436 .cindex "TCP/IP" "setting listening interfaces"
4437 .cindex "port" "receiving TCP/IP"
4438 This option is relevant only when the &%-bd%& (start listening daemon) option
4439 is also given. It controls which ports and interfaces the daemon uses. Details
4440 of the syntax, and how it interacts with configuration file options, are given
4441 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4442 file is written unless &%-oP%& is also present to specify a pid filename.
4443
4444 .vitem &%-pd%&
4445 .oindex "&%-pd%&"
4446 .cindex "Perl" "starting the interpreter"
4447 This option applies when an embedded Perl interpreter is linked with Exim (see
4448 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4449 option, forcing the starting of the interpreter to be delayed until it is
4450 needed.
4451
4452 .vitem &%-ps%&
4453 .oindex "&%-ps%&"
4454 .cindex "Perl" "starting the interpreter"
4455 This option applies when an embedded Perl interpreter is linked with Exim (see
4456 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4457 option, forcing the starting of the interpreter to occur as soon as Exim is
4458 started.
4459
4460 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4461 .oindex "&%-p%&"
4462 For compatibility with Sendmail, this option is equivalent to
4463 .display
4464 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4465 .endd
4466 It sets the incoming protocol and host name (for trusted callers). The
4467 host name and its colon can be omitted when only the protocol is to be set.
4468 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4469 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4470 or &`s`& using this option (but that does not seem a real limitation).
4471 Repeated use of this option is not supported.
4472
4473 .vitem &%-q%&
4474 .oindex "&%-q%&"
4475 .cindex "queue runner" "starting manually"
4476 This option is normally restricted to admin users. However, there is a
4477 configuration option called &%prod_requires_admin%& which can be set false to
4478 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4479 and &%-S%& options).
4480
4481 .cindex "queue runner" "description of operation"
4482 If other commandline options do not specify an action,
4483 the &%-q%& option starts one queue runner process. This scans the queue of
4484 waiting messages, and runs a delivery process for each one in turn. It waits
4485 for each delivery process to finish before starting the next one. A delivery
4486 process may not actually do any deliveries if the retry times for the addresses
4487 have not been reached. Use &%-qf%& (see below) if you want to override this.
4488
4489 If
4490 .cindex "SMTP" "passed connection"
4491 .cindex "SMTP" "multiple deliveries"
4492 .cindex "multiple SMTP deliveries"
4493 the delivery process spawns other processes to deliver other messages down
4494 passed SMTP connections, the queue runner waits for these to finish before
4495 proceeding.
4496
4497 When all the queued messages have been considered, the original queue runner
4498 process terminates. In other words, a single pass is made over the waiting
4499 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4500 this to be repeated periodically.
4501
4502 Exim processes the waiting messages in an unpredictable order. It isn't very
4503 random, but it is likely to be different each time, which is all that matters.
4504 If one particular message screws up a remote MTA, other messages to the same
4505 MTA have a chance of getting through if they get tried first.
4506
4507 It is possible to cause the messages to be processed in lexical message id
4508 order, which is essentially the order in which they arrived, by setting the
4509 &%queue_run_in_order%& option, but this is not recommended for normal use.
4510
4511 .vitem &%-q%&<&'qflags'&>
4512 The &%-q%& option may be followed by one or more flag letters that change its
4513 behaviour. They are all optional, but if more than one is present, they must
4514 appear in the correct order. Each flag is described in a separate item below.
4515
4516 .vitem &%-qq...%&
4517 .oindex "&%-qq%&"
4518 .cindex "queue" "double scanning"
4519 .cindex "queue" "routing"
4520 .cindex "routing" "whole queue before delivery"
4521 .cindex "first pass routing"
4522 .cindex "queue runner" "two phase"
4523 An option starting with &%-qq%& requests a two-stage queue run. In the first
4524 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4525 every domain. Addresses are routed, local deliveries happen, but no remote
4526 transports are run.
4527
4528 Performance will be best if the &%queue_run_in_order%& option is false.
4529 If that is so and the &%queue_fast_ramp%& option is true then
4530 in the first phase of the run,
4531 once a threshold number of messages are routed for a given host,
4532 a delivery process is forked in parallel with the rest of the scan.
4533
4534 .cindex "hints database" "remembering routing"
4535 The hints database that remembers which messages are waiting for specific hosts
4536 is updated, as if delivery to those hosts had been deferred. After this is
4537 complete, a second, normal queue scan happens, with routing and delivery taking
4538 place as normal. Messages that are routed to the same host should mostly be
4539 delivered down a single SMTP
4540 .cindex "SMTP" "passed connection"
4541 .cindex "SMTP" "multiple deliveries"
4542 .cindex "multiple SMTP deliveries"
4543 connection because of the hints that were set up during the first queue scan.
4544 This option may be useful for hosts that are connected to the Internet
4545 intermittently.
4546
4547 .vitem &%-q[q]i...%&
4548 .oindex "&%-qi%&"
4549 .cindex "queue" "initial delivery"
4550 If the &'i'& flag is present, the queue runner runs delivery processes only for
4551 those messages that haven't previously been tried. (&'i'& stands for &"initial
4552 delivery"&.) This can be helpful if you are putting messages in the queue using
4553 &%-odq%& and want a queue runner just to process the new messages.
4554
4555 .vitem &%-q[q][i]f...%&
4556 .oindex "&%-qf%&"
4557 .cindex "queue" "forcing delivery"
4558 .cindex "delivery" "forcing in queue run"
4559 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4560 message, whereas without &'f'& only those non-frozen addresses that have passed
4561 their retry times are tried.
4562
4563 .vitem &%-q[q][i]ff...%&
4564 .oindex "&%-qff%&"
4565 .cindex "frozen messages" "forcing delivery"
4566 If &'ff'& is present, a delivery attempt is forced for every message, whether
4567 frozen or not.
4568
4569 .vitem &%-q[q][i][f[f]]l%&
4570 .oindex "&%-ql%&"
4571 .cindex "queue" "local deliveries only"
4572 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4573 be done. If a message requires any remote deliveries, it remains in the queue
4574 for later delivery.
4575
4576 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4577 .oindex "&%-qG%&"
4578 .cindex queue named
4579 .cindex "named queues"  "deliver from"
4580 .cindex "queue" "delivering specific messages"
4581 If the &'G'& flag and a name is present, the queue runner operates on the
4582 queue with the given name rather than the default queue.
4583 The name should not contain a &'/'& character.
4584 For a periodic queue run (see below)
4585 append to the name a slash and a time value.
4586
4587 If other commandline options specify an action, a &'-qG<name>'& option
4588 will specify a queue to operate on.
4589 For example:
4590 .code
4591 exim -bp -qGquarantine
4592 mailq -qGquarantine
4593 exim -qGoffpeak -Rf @special.domain.example
4594 .endd
4595
4596 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4597 When scanning the queue, Exim can be made to skip over messages whose ids are
4598 lexically less than a given value by following the &%-q%& option with a
4599 starting message id. For example:
4600 .code
4601 exim -q 0t5C6f-0000c8-00
4602 .endd
4603 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4604 second message id is given, messages whose ids are lexically greater than it
4605 are also skipped. If the same id is given twice, for example,
4606 .code
4607 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4608 .endd
4609 just one delivery process is started, for that message. This differs from
4610 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4611 that it counts as a delivery from a queue run. Note that the selection
4612 mechanism does not affect the order in which the messages are scanned. There
4613 are also other ways of selecting specific sets of messages for delivery in a
4614 queue run &-- see &%-R%& and &%-S%&.
4615
4616 .vitem &%-q%&<&'qflags'&><&'time'&>
4617 .cindex "queue runner" "starting periodically"
4618 .cindex "periodic queue running"
4619 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4620 starting a queue runner process at intervals specified by the given time value
4621 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4622 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4623 single daemon process handles both functions. A common way of starting up a
4624 combined daemon at system boot time is to use a command such as
4625 .code
4626 /usr/exim/bin/exim -bd -q30m
4627 .endd
4628 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4629 process every 30 minutes.
4630
4631 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4632 pid file is written unless one is explicitly requested by the &%-oP%& option.
4633
4634 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4635 .oindex "&%-qR%&"
4636 This option is synonymous with &%-R%&. It is provided for Sendmail
4637 compatibility.
4638
4639 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4640 .oindex "&%-qS%&"
4641 This option is synonymous with &%-S%&.
4642
4643 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4644 .oindex "&%-R%&"
4645 .cindex "queue runner" "for specific recipients"
4646 .cindex "delivery" "to given domain"
4647 .cindex "domain" "delivery to"
4648 The <&'rsflags'&> may be empty, in which case the white space before the string
4649 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4650 which are the possible values for <&'rsflags'&>. White space is required if
4651 <&'rsflags'&> is not empty.
4652
4653 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4654 perform a single queue run, except that, when scanning the messages on the
4655 queue, Exim processes only those that have at least one undelivered recipient
4656 address containing the given string, which is checked in a case-independent
4657 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4658 regular expression; otherwise it is a literal string.
4659
4660 If you want to do periodic queue runs for messages with specific recipients,
4661 you can combine &%-R%& with &%-q%& and a time value. For example:
4662 .code
4663 exim -q25m -R @special.domain.example
4664 .endd
4665 This example does a queue run for messages with recipients in the given domain
4666 every 25 minutes. Any additional flags that are specified with &%-q%& are
4667 applied to each queue run.
4668
4669 Once a message is selected for delivery by this mechanism, all its addresses
4670 are processed. For the first selected message, Exim overrides any retry
4671 information and forces a delivery attempt for each undelivered address. This
4672 means that if delivery of any address in the first message is successful, any
4673 existing retry information is deleted, and so delivery attempts for that
4674 address in subsequently selected messages (which are processed without forcing)
4675 will run. However, if delivery of any address does not succeed, the retry
4676 information is updated, and in subsequently selected messages, the failing
4677 address will be skipped.
4678
4679 .cindex "frozen messages" "forcing delivery"
4680 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4681 all selected messages, not just the first; frozen messages are included when
4682 &'ff'& is present.
4683
4684 The &%-R%& option makes it straightforward to initiate delivery of all messages
4685 to a given domain after a host has been down for some time. When the SMTP
4686 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4687 effect is to run Exim with the &%-R%& option, but it can be configured to run
4688 an arbitrary command instead.
4689
4690 .vitem &%-r%&
4691 .oindex "&%-r%&"
4692 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4693
4694 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4695 .oindex "&%-S%&"
4696 .cindex "delivery" "from given sender"
4697 .cindex "queue runner" "for specific senders"
4698 This option acts like &%-R%& except that it checks the string against each
4699 message's sender instead of against the recipients. If &%-R%& is also set, both
4700 conditions must be met for a message to be selected. If either of the options
4701 has &'f'& or &'ff'& in its flags, the associated action is taken.
4702
4703 .vitem &%-Tqt%&&~<&'times'&>
4704 .oindex "&%-Tqt%&"
4705 This is an option that is exclusively for use by the Exim testing suite. It is not
4706 recognized when Exim is run normally. It allows for the setting up of explicit
4707 &"queue times"& so that various warning/retry features can be tested.
4708
4709 .vitem &%-t%&
4710 .oindex "&%-t%&"
4711 .cindex "recipient" "extracting from header lines"
4712 .cindex "&'Bcc:'& header line"
4713 .cindex "&'Cc:'& header line"
4714 .cindex "&'To:'& header line"
4715 When Exim is receiving a locally-generated, non-SMTP message on its standard
4716 input, the &%-t%& option causes the recipients of the message to be obtained
4717 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4718 from the command arguments. The addresses are extracted before any rewriting
4719 takes place and the &'Bcc:'& header line, if present, is then removed.
4720
4721 .cindex "Sendmail compatibility" "&%-t%& option"
4722 If the command has any arguments, they specify addresses to which the message
4723 is &'not'& to be delivered. That is, the argument addresses are removed from
4724 the recipients list obtained from the headers. This is compatible with Smail 3
4725 and in accordance with the documented behaviour of several versions of
4726 Sendmail, as described in man pages on a number of operating systems (e.g.
4727 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4728 argument addresses to those obtained from the headers, and the O'Reilly
4729 Sendmail book documents it that way. Exim can be made to add argument addresses
4730 instead of subtracting them by setting the option
4731 &%extract_addresses_remove_arguments%& false.
4732
4733 .cindex "&%Resent-%& header lines" "with &%-t%&"
4734 If there are any &%Resent-%& header lines in the message, Exim extracts
4735 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4736 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4737 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4738 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4739
4740 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4741 message is resent several times). The RFC also specifies that they should be
4742 added at the front of the message, and separated by &'Received:'& lines. It is
4743 not at all clear how &%-t%& should operate in the present of multiple sets,
4744 nor indeed exactly what constitutes a &"set"&.
4745 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4746 are often added at the end of the header, and if a message is resent more than
4747 once, it is common for the original set of &%Resent-%& headers to be renamed as
4748 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4749
4750 .vitem &%-ti%&
4751 .oindex "&%-ti%&"
4752 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4753 compatibility with Sendmail.
4754
4755 .vitem &%-tls-on-connect%&
4756 .oindex "&%-tls-on-connect%&"
4757 .cindex "TLS" "use without STARTTLS"
4758 .cindex "TLS" "automatic start"
4759 This option is available when Exim is compiled with TLS support. It forces all
4760 incoming SMTP connections to behave as if the incoming port is listed in the
4761 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4762 &<<CHAPTLS>>& for further details.
4763
4764
4765 .vitem &%-U%&
4766 .oindex "&%-U%&"
4767 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4768 Sendmail uses this option for &"initial message submission"&, and its
4769 documentation states that in future releases, it may complain about
4770 syntactically invalid messages rather than fixing them when this flag is not
4771 set. Exim ignores this option.
4772
4773 .vitem &%-v%&
4774 .oindex "&%-v%&"
4775 This option causes Exim to write information to the standard error stream,
4776 describing what it is doing. In particular, it shows the log lines for
4777 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4778 dialogue is shown. Some of the log lines shown may not actually be written to
4779 the log if the setting of &%log_selector%& discards them. Any relevant
4780 selectors are shown with each log line. If none are shown, the logging is
4781 unconditional.
4782
4783 .vitem &%-x%&
4784 .oindex "&%-x%&"
4785 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4786 National Language Support extended characters in the body of the mail item"&).
4787 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4788 this option.
4789
4790 .vitem &%-X%&&~<&'logfile'&>
4791 .oindex "&%-X%&"
4792 This option is interpreted by Sendmail to cause debug information to be sent
4793 to the named file.  It is ignored by Exim.
4794
4795 .vitem &%-z%&&~<&'log-line'&>
4796 .oindex "&%-z%&"
4797 This option writes its argument to Exim's logfile.
4798 Use is restricted to administrators; the intent is for operational notes.
4799 Quotes should be used to maintain a multi-word item as a single argument,
4800 under most shells.
4801 .endlist
4802
4803 .ecindex IIDclo1
4804 .ecindex IIDclo2
4805
4806
4807 . ////////////////////////////////////////////////////////////////////////////
4808 . Insert a stylized DocBook comment here, to identify the end of the command
4809 . line options. This is for the benefit of the Perl script that automatically
4810 . creates a man page for the options.
4811 . ////////////////////////////////////////////////////////////////////////////
4812
4813 .literal xml
4814 <!-- === End of command line options === -->
4815 .literal off
4816
4817
4818
4819
4820
4821 . ////////////////////////////////////////////////////////////////////////////
4822 . ////////////////////////////////////////////////////////////////////////////
4823
4824
4825 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4826          "The runtime configuration file"
4827
4828 .cindex "runtime configuration"
4829 .cindex "configuration file" "general description"
4830 .cindex "CONFIGURE_FILE"
4831 .cindex "configuration file" "errors in"
4832 .cindex "error" "in configuration file"
4833 .cindex "return code" "for bad configuration"
4834 Exim uses a single runtime configuration file that is read whenever an Exim
4835 binary is executed. Note that in normal operation, this happens frequently,
4836 because Exim is designed to operate in a distributed manner, without central
4837 control.
4838
4839 If a syntax error is detected while reading the configuration file, Exim
4840 writes a message on the standard error, and exits with a non-zero return code.
4841 The message is also written to the panic log. &*Note*&: Only simple syntax
4842 errors can be detected at this time. The values of any expanded options are
4843 not checked until the expansion happens, even when the expansion does not
4844 actually alter the string.
4845
4846 The name of the configuration file is compiled into the binary for security
4847 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4848 most configurations, this specifies a single file. However, it is permitted to
4849 give a colon-separated list of filenames, in which case Exim uses the first
4850 existing file in the list.
4851
4852 .cindex "EXIM_USER"
4853 .cindex "EXIM_GROUP"
4854 .cindex "CONFIGURE_OWNER"
4855 .cindex "CONFIGURE_GROUP"
4856 .cindex "configuration file" "ownership"
4857 .cindex "ownership" "configuration file"
4858 The runtime configuration file must be owned by root or by the user that is
4859 specified at compile time by the CONFIGURE_OWNER option (if set). The
4860 configuration file must not be world-writeable, or group-writeable unless its
4861 group is the root group or the one specified at compile time by the
4862 CONFIGURE_GROUP option.
4863
4864 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4865 to root, anybody who is able to edit the runtime configuration file has an
4866 easy way to run commands as root. If you specify a user or group in the
4867 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4868 who are members of that group will trivially be able to obtain root privileges.
4869
4870 Up to Exim version 4.72, the runtime configuration file was also permitted to
4871 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4872 since it offered a simple privilege escalation for any attacker who managed to
4873 compromise the Exim user account.
4874
4875 A default configuration file, which will work correctly in simple situations,
4876 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4877 defines just one filename, the installation process copies the default
4878 configuration to a new file of that name if it did not previously exist. If
4879 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4880 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4881 configuration.
4882
4883
4884
4885 .section "Using a different configuration file" "SECID40"
4886 .cindex "configuration file" "alternate"
4887 A one-off alternate configuration can be specified by the &%-C%& command line
4888 option, which may specify a single file or a list of files. However, when
4889 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4890 unless the argument for &%-C%& is identical to the built-in value from
4891 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4892 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4893 is useful mainly for checking the syntax of configuration files before
4894 installing them. No owner or group checks are done on a configuration file
4895 specified by &%-C%&, if root privilege has been dropped.
4896
4897 Even the Exim user is not trusted to specify an arbitrary configuration file
4898 with the &%-C%& option to be used with root privileges, unless that file is
4899 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4900 testing a configuration using &%-C%& right through message reception and
4901 delivery, even if the caller is root. The reception works, but by that time,
4902 Exim is running as the Exim user, so when it re-execs to regain privilege for
4903 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4904 can test reception and delivery using two separate commands (one to put a
4905 message in the queue, using &%-odq%&, and another to do the delivery, using
4906 &%-M%&).
4907
4908 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4909 prefix string with which any file named in a &%-C%& command line option must
4910 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4911 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4912 filename can be used with &%-C%&.
4913
4914 One-off changes to a configuration can be specified by the &%-D%& command line
4915 option, which defines and overrides values for macros used inside the
4916 configuration file. However, like &%-C%&, the use of this option by a
4917 non-privileged user causes Exim to discard its root privilege.
4918 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4919 completely disabled, and its use causes an immediate error exit.
4920
4921 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4922 to declare certain macro names trusted, such that root privilege will not
4923 necessarily be discarded.
4924 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4925 considered safe and, if &%-D%& only supplies macros from this list, and the
4926 values are acceptable, then Exim will not give up root privilege if the caller
4927 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4928 transition mechanism and is expected to be removed in the future.  Acceptable
4929 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4930
4931 Some sites may wish to use the same Exim binary on different machines that
4932 share a file system, but to use different configuration files on each machine.
4933 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4934 looks for a file whose name is the configuration filename followed by a dot
4935 and the machine's node name, as obtained from the &[uname()]& function. If this
4936 file does not exist, the standard name is tried. This processing occurs for
4937 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4938
4939 In some esoteric situations different versions of Exim may be run under
4940 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4941 help with this. See the comments in &_src/EDITME_& for details.
4942
4943
4944
4945 .section "Configuration file format" "SECTconffilfor"
4946 .cindex "configuration file" "format of"
4947 .cindex "format" "configuration file"
4948 Exim's configuration file is divided into a number of different parts. General
4949 option settings must always appear at the start of the file. The other parts
4950 are all optional, and may appear in any order. Each part other than the first
4951 is introduced by the word &"begin"& followed by at least one literal
4952 space, and the name of the part. The optional parts are:
4953
4954 .ilist
4955 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4956 &<<CHAPACL>>&).
4957 .next
4958 .cindex "AUTH" "configuration"
4959 &'authenticators'&: Configuration settings for the authenticator drivers. These
4960 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4961 .next
4962 &'routers'&: Configuration settings for the router drivers. Routers process
4963 addresses and determine how the message is to be delivered (see chapters
4964 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4965 .next
4966 &'transports'&: Configuration settings for the transport drivers. Transports
4967 define mechanisms for copying messages to destinations (see chapters
4968 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4969 .next
4970 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4971 If there is no retry section, or if it is empty (that is, no retry rules are
4972 defined), Exim will not retry deliveries. In this situation, temporary errors
4973 are treated the same as permanent errors. Retry rules are discussed in chapter
4974 &<<CHAPretry>>&.
4975 .next
4976 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4977 when new addresses are generated during delivery. Rewriting is discussed in
4978 chapter &<<CHAPrewrite>>&.
4979 .next
4980 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4981 want to use this feature, you must set
4982 .code
4983 LOCAL_SCAN_HAS_OPTIONS=yes
4984 .endd
4985 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4986 facility are given in chapter &<<CHAPlocalscan>>&.
4987 .endlist
4988
4989 .cindex "configuration file" "leading white space in"
4990 .cindex "configuration file" "trailing white space in"
4991 .cindex "white space" "in configuration file"
4992 Leading and trailing white space in configuration lines is always ignored.
4993
4994 Blank lines in the file, and lines starting with a # character (ignoring
4995 leading white space) are treated as comments and are ignored. &*Note*&: A
4996 # character other than at the beginning of a line is not treated specially,
4997 and does not introduce a comment.
4998
4999 Any non-comment line can be continued by ending it with a backslash. Note that
5000 the general rule for white space means that trailing white space after the
5001 backslash and leading white space at the start of continuation
5002 lines is ignored. Comment lines beginning with # (but not empty lines) may
5003 appear in the middle of a sequence of continuation lines.
5004
5005 A convenient way to create a configuration file is to start from the
5006 default, which is supplied in &_src/configure.default_&, and add, delete, or
5007 change settings as required.
5008
5009 The ACLs, retry rules, and rewriting rules have their own syntax which is
5010 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
5011 respectively. The other parts of the configuration file have some syntactic
5012 items in common, and these are described below, from section &<<SECTcos>>&
5013 onwards. Before that, the inclusion, macro, and conditional facilities are
5014 described.
5015
5016
5017
5018 .section "File inclusions in the configuration file" "SECID41"
5019 .cindex "inclusions in configuration file"
5020 .cindex "configuration file" "including other files"
5021 .cindex "&`.include`& in configuration file"
5022 .cindex "&`.include_if_exists`& in configuration file"
5023 You can include other files inside Exim's runtime configuration file by
5024 using this syntax:
5025 .display
5026 &`.include`& <&'filename'&>
5027 &`.include_if_exists`& <&'filename'&>
5028 .endd
5029 on a line by itself. Double quotes round the filename are optional. If you use
5030 the first form, a configuration error occurs if the file does not exist; the
5031 second form does nothing for non-existent files.
5032 The first form allows a relative name. It is resolved relative to
5033 the directory of the including file. For the second form an absolute filename
5034 is required.
5035
5036 Includes may be nested to any depth, but remember that Exim reads its
5037 configuration file often, so it is a good idea to keep them to a minimum.
5038 If you change the contents of an included file, you must HUP the daemon,
5039 because an included file is read only when the configuration itself is read.
5040
5041 The processing of inclusions happens early, at a physical line level, so, like
5042 comment lines, an inclusion can be used in the middle of an option setting,
5043 for example:
5044 .code
5045 hosts_lookup = a.b.c \
5046                .include /some/file
5047 .endd
5048 Include processing happens after macro processing (see below). Its effect is to
5049 process the lines of the included file as if they occurred inline where the
5050 inclusion appears.
5051
5052
5053
5054 .section "Macros in the configuration file" "SECTmacrodefs"
5055 .cindex "macro" "description of"
5056 .cindex "configuration file" "macros"
5057 If a line in the main part of the configuration (that is, before the first
5058 &"begin"& line) begins with an upper case letter, it is taken as a macro
5059 definition, and must be of the form
5060 .display
5061 <&'name'&> = <&'rest of line'&>
5062 .endd
5063 The name must consist of letters, digits, and underscores, and need not all be
5064 in upper case, though that is recommended. The rest of the line, including any
5065 continuations, is the replacement text, and has leading and trailing white
5066 space removed. Quotes are not removed. The replacement text can never end with
5067 a backslash character, but this doesn't seem to be a serious limitation.
5068
5069 Macros may also be defined between router, transport, authenticator, or ACL
5070 definitions. They may not, however, be defined within an individual driver or
5071 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5072
5073 .section "Macro substitution" "SECID42"
5074 Once a macro is defined, all subsequent lines in the file (and any included
5075 files) are scanned for the macro name; if there are several macros, the line is
5076 scanned for each, in turn, in the order in which the macros are defined. The
5077 replacement text is not re-scanned for the current macro, though it is scanned
5078 for subsequently defined macros. For this reason, a macro name may not contain
5079 the name of a previously defined macro as a substring. You could, for example,
5080 define
5081 .display
5082 &`ABCD_XYZ = `&<&'something'&>
5083 &`ABCD = `&<&'something else'&>
5084 .endd
5085 but putting the definitions in the opposite order would provoke a configuration
5086 error. Macro expansion is applied to individual physical lines from the file,
5087 before checking for line continuation or file inclusion (see above). If a line
5088 consists solely of a macro name, and the expansion of the macro is empty, the
5089 line is ignored. A macro at the start of a line may turn the line into a
5090 comment line or a &`.include`& line.
5091
5092
5093 .section "Redefining macros" "SECID43"
5094 Once defined, the value of a macro can be redefined later in the configuration
5095 (or in an included file). Redefinition is specified by using &'=='& instead of
5096 &'='&. For example:
5097 .code
5098 MAC =  initial value
5099 ...
5100 MAC == updated value
5101 .endd
5102 Redefinition does not alter the order in which the macros are applied to the
5103 subsequent lines of the configuration file. It is still the same order in which
5104 the macros were originally defined. All that changes is the macro's value.
5105 Redefinition makes it possible to accumulate values. For example:
5106 .code
5107 MAC =  initial value
5108 ...
5109 MAC == MAC and something added
5110 .endd
5111 This can be helpful in situations where the configuration file is built
5112 from a number of other files.
5113
5114 .section "Overriding macro values" "SECID44"
5115 The values set for macros in the configuration file can be overridden by the
5116 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5117 used, unless called by root or the Exim user. A definition on the command line
5118 using the &%-D%& option causes all definitions and redefinitions within the
5119 file to be ignored.
5120
5121
5122
5123 .section "Example of macro usage" "SECID45"
5124 As an example of macro usage, consider a configuration where aliases are looked
5125 up in a MySQL database. It helps to keep the file less cluttered if long
5126 strings such as SQL statements are defined separately as macros, for example:
5127 .code
5128 ALIAS_QUERY = select mailbox from user where \
5129               login='${quote_mysql:$local_part}';
5130 .endd
5131 This can then be used in a &(redirect)& router setting like this:
5132 .code
5133 data = ${lookup mysql{ALIAS_QUERY}}
5134 .endd
5135 In earlier versions of Exim macros were sometimes used for domain, host, or
5136 address lists. In Exim 4 these are handled better by named lists &-- see
5137 section &<<SECTnamedlists>>&.
5138
5139
5140 .section "Builtin macros" "SECTbuiltinmacros"
5141 Exim defines some macros depending on facilities available, which may
5142 differ due to build-time definitions and from one release to another.
5143 All of these macros start with an underscore.
5144 They can be used to conditionally include parts of a configuration
5145 (see below).
5146
5147 The following classes of macros are defined:
5148 .display
5149 &` _HAVE_*                    `&  build-time defines
5150 &` _DRIVER_ROUTER_*           `&  router drivers
5151 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5152 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5153 &` _LOG_*                     `&  log_selector values
5154 &` _OPT_MAIN_*                `&  main config options
5155 &` _OPT_ROUTERS_*             `&  generic router options
5156 &` _OPT_TRANSPORTS_*          `&  generic transport options
5157 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5158 &` _OPT_ROUTER_*_*            `&  private router options
5159 &` _OPT_TRANSPORT_*_*         `&  private transport options
5160 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5161 .endd
5162
5163 Use an &"exim -bP macros"& command to get the list of macros.
5164
5165
5166 .section "Conditional skips in the configuration file" "SECID46"
5167 .cindex "configuration file" "conditional skips"
5168 .cindex "&`.ifdef`&"
5169 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5170 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5171 portions of the configuration file. The processing happens whenever the file is
5172 read (that is, when an Exim binary starts to run).
5173
5174 The implementation is very simple. Instances of the first four directives must
5175 be followed by text that includes the names of one or macros. The condition
5176 that is tested is whether or not any macro substitution has taken place in the
5177 line. Thus:
5178 .code
5179 .ifdef AAA
5180 message_size_limit = 50M
5181 .else
5182 message_size_limit = 100M
5183 .endif
5184 .endd
5185 sets a message size limit of 50M if the macro &`AAA`& is defined
5186 (or &`A`& or &`AA`&), and 100M
5187 otherwise. If there is more than one macro named on the line, the condition
5188 is true if any of them are defined. That is, it is an &"or"& condition. To
5189 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5190
5191 Although you can use a macro expansion to generate one of these directives,
5192 it is not very useful, because the condition &"there was a macro substitution
5193 in this line"& will always be true.
5194
5195 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5196 to clarify complicated nestings.
5197
5198
5199
5200 .section "Common option syntax" "SECTcos"
5201 .cindex "common option syntax"
5202 .cindex "syntax of common options"
5203 .cindex "configuration file" "common option syntax"
5204 For the main set of options, driver options, and &[local_scan()]& options,
5205 each setting is on a line by itself, and starts with a name consisting of
5206 lower-case letters and underscores. Many options require a data value, and in
5207 these cases the name must be followed by an equals sign (with optional white
5208 space) and then the value. For example:
5209 .code
5210 qualify_domain = mydomain.example.com
5211 .endd
5212 .cindex "hiding configuration option values"
5213 .cindex "configuration options" "hiding value of"
5214 .cindex "options" "hiding value of"
5215 Some option settings may contain sensitive data, for example, passwords for
5216 accessing databases. To stop non-admin users from using the &%-bP%& command
5217 line option to read these values, you can precede the option settings with the
5218 word &"hide"&. For example:
5219 .code
5220 hide mysql_servers = localhost/users/admin/secret-password
5221 .endd
5222 For non-admin users, such options are displayed like this:
5223 .code
5224 mysql_servers = <value not displayable>
5225 .endd
5226 If &"hide"& is used on a driver option, it hides the value of that option on
5227 all instances of the same driver.
5228
5229 The following sections describe the syntax used for the different data types
5230 that are found in option settings.
5231
5232
5233 .section "Boolean options" "SECID47"
5234 .cindex "format" "boolean"
5235 .cindex "boolean configuration values"
5236 .oindex "&%no_%&&'xxx'&"
5237 .oindex "&%not_%&&'xxx'&"
5238 Options whose type is given as boolean are on/off switches. There are two
5239 different ways of specifying such options: with and without a data value. If
5240 the option name is specified on its own without data, the switch is turned on;
5241 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5242 boolean options may be followed by an equals sign and one of the words
5243 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5244 the following two settings have exactly the same effect:
5245 .code
5246 queue_only
5247 queue_only = true
5248 .endd
5249 The following two lines also have the same (opposite) effect:
5250 .code
5251 no_queue_only
5252 queue_only = false
5253 .endd
5254 You can use whichever syntax you prefer.
5255
5256
5257
5258
5259 .section "Integer values" "SECID48"
5260 .cindex "integer configuration values"
5261 .cindex "format" "integer"
5262 If an option's type is given as &"integer"&, the value can be given in decimal,
5263 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5264 number is assumed. Otherwise, it is treated as an octal number unless it starts
5265 with the characters &"0x"&, in which case the remainder is interpreted as a
5266 hexadecimal number.
5267
5268 If an integer value is followed by the letter K, it is multiplied by 1024; if
5269 it is followed by the letter M, it is multiplied by 1024x1024;
5270 if by the letter G, 1024x1024x1024.
5271 When the values
5272 of integer option settings are output, values which are an exact multiple of
5273 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5274 and M. The printing style is independent of the actual input format that was
5275 used.
5276
5277
5278 .section "Octal integer values" "SECID49"
5279 .cindex "integer format"
5280 .cindex "format" "octal integer"
5281 If an option's type is given as &"octal integer"&, its value is always
5282 interpreted as an octal number, whether or not it starts with the digit zero.
5283 Such options are always output in octal.
5284
5285
5286 .section "Fixed point numbers" "SECID50"
5287 .cindex "fixed point configuration values"
5288 .cindex "format" "fixed point"
5289 If an option's type is given as &"fixed-point"&, its value must be a decimal
5290 integer, optionally followed by a decimal point and up to three further digits.
5291
5292
5293
5294 .section "Time intervals" "SECTtimeformat"
5295 .cindex "time interval" "specifying in configuration"
5296 .cindex "format" "time interval"
5297 A time interval is specified as a sequence of numbers, each followed by one of
5298 the following letters, with no intervening white space:
5299
5300 .table2 30pt
5301 .irow &%s%& seconds
5302 .irow &%m%& minutes
5303 .irow &%h%& hours
5304 .irow &%d%& days
5305 .irow &%w%& weeks
5306 .endtable
5307
5308 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5309 intervals are output in the same format. Exim does not restrict the values; it
5310 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5311
5312
5313
5314 .section "String values" "SECTstrings"
5315 .cindex "string" "format of configuration values"
5316 .cindex "format" "string"
5317 If an option's type is specified as &"string"&, the value can be specified with
5318 or without double-quotes. If it does not start with a double-quote, the value
5319 consists of the remainder of the line plus any continuation lines, starting at
5320 the first character after any leading white space, with trailing white space
5321 removed, and with no interpretation of the characters in the string. Because
5322 Exim removes comment lines (those beginning with #) at an early stage, they can
5323 appear in the middle of a multi-line string. The following two settings are
5324 therefore equivalent:
5325 .code
5326 trusted_users = uucp:mail
5327 trusted_users = uucp:\
5328                 # This comment line is ignored
5329                 mail
5330 .endd
5331 .cindex "string" "quoted"
5332 .cindex "escape characters in quoted strings"
5333 If a string does start with a double-quote, it must end with a closing
5334 double-quote, and any backslash characters other than those used for line
5335 continuation are interpreted as escape characters, as follows:
5336
5337 .table2 100pt
5338 .irow &`\\`&                     "single backslash"
5339 .irow &`\n`&                     "newline"
5340 .irow &`\r`&                     "carriage return"
5341 .irow &`\t`&                     "tab"
5342 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5343 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5344                                    character"
5345 .endtable
5346
5347 If a backslash is followed by some other character, including a double-quote
5348 character, that character replaces the pair.
5349
5350 Quoting is necessary only if you want to make use of the backslash escapes to
5351 insert special characters, or if you need to specify a value with leading or
5352 trailing spaces. These cases are rare, so quoting is almost never needed in
5353 current versions of Exim. In versions of Exim before 3.14, quoting was required
5354 in order to continue lines, so you may come across older configuration files
5355 and examples that apparently quote unnecessarily.
5356
5357
5358 .section "Expanded strings" "SECID51"
5359 .cindex "expansion" "definition of"
5360 Some strings in the configuration file are subjected to &'string expansion'&,
5361 by which means various parts of the string may be changed according to the
5362 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5363 is as just described; in particular, the handling of backslashes in quoted
5364 strings is done as part of the input process, before expansion takes place.
5365 However, backslash is also an escape character for the expander, so any
5366 backslashes that are required for that reason must be doubled if they are
5367 within a quoted configuration string.
5368
5369
5370 .section "User and group names" "SECID52"
5371 .cindex "user name" "format of"
5372 .cindex "format" "user name"
5373 .cindex "groups" "name format"
5374 .cindex "format" "group name"
5375 User and group names are specified as strings, using the syntax described
5376 above, but the strings are interpreted specially. A user or group name must
5377 either consist entirely of digits, or be a name that can be looked up using the
5378 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5379
5380
5381 .section "List construction" "SECTlistconstruct"
5382 .cindex "list" "syntax of in configuration"
5383 .cindex "format" "list item in configuration"
5384 .cindex "string" "list, definition of"
5385 The data for some configuration options is a list of items, with colon as the
5386 default separator. Many of these options are shown with type &"string list"& in
5387 the descriptions later in this document. Others are listed as &"domain list"&,
5388 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5389 are all the same; however, those other than &"string list"& are subject to
5390 particular kinds of interpretation, as described in chapter
5391 &<<CHAPdomhosaddlists>>&.
5392
5393 In all these cases, the entire list is treated as a single string as far as the
5394 input syntax is concerned. The &%trusted_users%& setting in section
5395 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5396 in a list, it must be entered as two colons. Leading and trailing white space
5397 on each item in a list is ignored. This makes it possible to include items that
5398 start with a colon, and in particular, certain forms of IPv6 address. For
5399 example, the list
5400 .code
5401 local_interfaces = 127.0.0.1 : ::::1
5402 .endd
5403 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5404
5405 &*Note*&: Although leading and trailing white space is ignored in individual
5406 list items, it is not ignored when parsing the list. The space after the first
5407 colon in the example above is necessary. If it were not there, the list would
5408 be interpreted as the two items 127.0.0.1:: and 1.
5409
5410 .section "Changing list separators" "SECTlistsepchange"
5411 .cindex "list separator" "changing"
5412 .cindex "IPv6" "addresses in lists"
5413 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5414 introduced to allow the separator character to be changed. If a list begins
5415 with a left angle bracket, followed by any punctuation character, that
5416 character is used instead of colon as the list separator. For example, the list
5417 above can be rewritten to use a semicolon separator like this:
5418 .code
5419 local_interfaces = <; 127.0.0.1 ; ::1
5420 .endd
5421 This facility applies to all lists, with the exception of the list in
5422 &%log_file_path%&. It is recommended that the use of non-colon separators be
5423 confined to circumstances where they really are needed.
5424
5425 .cindex "list separator" "newline as"
5426 .cindex "newline" "as list separator"
5427 It is also possible to use newline and other control characters (those with
5428 code values less than 32, plus DEL) as separators in lists. Such separators
5429 must be provided literally at the time the list is processed. For options that
5430 are string-expanded, you can write the separator using a normal escape
5431 sequence. This will be processed by the expander before the string is
5432 interpreted as a list. For example, if a newline-separated list of domains is
5433 generated by a lookup, you can process it directly by a line such as this:
5434 .code
5435 domains = <\n ${lookup mysql{.....}}
5436 .endd
5437 This avoids having to change the list separator in such data. You are unlikely
5438 to want to use a control character as a separator in an option that is not
5439 expanded, because the value is literal text. However, it can be done by giving
5440 the value in quotes. For example:
5441 .code
5442 local_interfaces = "<\n 127.0.0.1 \n ::1"
5443 .endd
5444 Unlike printing character separators, which can be included in list items by
5445 doubling, it is not possible to include a control character as data when it is
5446 set as the separator. Two such characters in succession are interpreted as
5447 enclosing an empty list item.
5448
5449
5450
5451 .section "Empty items in lists" "SECTempitelis"
5452 .cindex "list" "empty item in"
5453 An empty item at the end of a list is always ignored. In other words, trailing
5454 separator characters are ignored. Thus, the list in
5455 .code
5456 senders = user@domain :
5457 .endd
5458 contains only a single item. If you want to include an empty string as one item
5459 in a list, it must not be the last item. For example, this list contains three
5460 items, the second of which is empty:
5461 .code
5462 senders = user1@domain : : user2@domain
5463 .endd
5464 &*Note*&: There must be white space between the two colons, as otherwise they
5465 are interpreted as representing a single colon data character (and the list
5466 would then contain just one item). If you want to specify a list that contains
5467 just one, empty item, you can do it as in this example:
5468 .code
5469 senders = :
5470 .endd
5471 In this case, the first item is empty, and the second is discarded because it
5472 is at the end of the list.
5473
5474
5475
5476
5477 .section "Format of driver configurations" "SECTfordricon"
5478 .cindex "drivers" "configuration format"
5479 There are separate parts in the configuration for defining routers, transports,
5480 and authenticators. In each part, you are defining a number of driver
5481 instances, each with its own set of options. Each driver instance is defined by
5482 a sequence of lines like this:
5483 .display
5484 <&'instance name'&>:
5485   <&'option'&>
5486   ...
5487   <&'option'&>
5488 .endd
5489 In the following example, the instance name is &(localuser)&, and it is
5490 followed by three options settings:
5491 .code
5492 localuser:
5493   driver = accept
5494   check_local_user
5495   transport = local_delivery
5496 .endd
5497 For each driver instance, you specify which Exim code module it uses &-- by the
5498 setting of the &%driver%& option &-- and (optionally) some configuration
5499 settings. For example, in the case of transports, if you want a transport to
5500 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5501 a local file you would use the &(appendfile)& driver. Each of the drivers is
5502 described in detail in its own separate chapter later in this manual.
5503
5504 You can have several routers, transports, or authenticators that are based on
5505 the same underlying driver (each must have a different instance name).
5506
5507 The order in which routers are defined is important, because addresses are
5508 passed to individual routers one by one, in order. The order in which
5509 transports are defined does not matter at all. The order in which
5510 authenticators are defined is used only when Exim, as a client, is searching
5511 them to find one that matches an authentication mechanism offered by the
5512 server.
5513
5514 .cindex "generic options"
5515 .cindex "options" "generic &-- definition of"
5516 Within a driver instance definition, there are two kinds of option: &'generic'&
5517 and &'private'&. The generic options are those that apply to all drivers of the
5518 same type (that is, all routers, all transports or all authenticators). The
5519 &%driver%& option is a generic option that must appear in every definition.
5520 .cindex "private options"
5521 The private options are special for each driver, and none need appear, because
5522 they all have default values.
5523
5524 The options may appear in any order, except that the &%driver%& option must
5525 precede any private options, since these depend on the particular driver. For
5526 this reason, it is recommended that &%driver%& always be the first option.
5527
5528 Driver instance names, which are used for reference in log entries and
5529 elsewhere, can be any sequence of letters, digits, and underscores (starting
5530 with a letter) and must be unique among drivers of the same type. A router and
5531 a transport (for example) can each have the same name, but no two router
5532 instances can have the same name. The name of a driver instance should not be
5533 confused with the name of the underlying driver module. For example, the
5534 configuration lines:
5535 .code
5536 remote_smtp:
5537   driver = smtp
5538 .endd
5539 create an instance of the &(smtp)& transport driver whose name is
5540 &(remote_smtp)&. The same driver code can be used more than once, with
5541 different instance names and different option settings each time. A second
5542 instance of the &(smtp)& transport, with different options, might be defined
5543 thus:
5544 .code
5545 special_smtp:
5546   driver = smtp
5547   port = 1234
5548   command_timeout = 10s
5549 .endd
5550 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5551 these transport instances from routers, and these names would appear in log
5552 lines.
5553
5554 Comment lines may be present in the middle of driver specifications. The full
5555 list of option settings for any particular driver instance, including all the
5556 defaulted values, can be extracted by making use of the &%-bP%& command line
5557 option.
5558
5559
5560
5561
5562
5563
5564 . ////////////////////////////////////////////////////////////////////////////
5565 . ////////////////////////////////////////////////////////////////////////////
5566
5567 .chapter "The default configuration file" "CHAPdefconfil"
5568 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5569 .cindex "default" "configuration file &""walk through""&"
5570 The default configuration file supplied with Exim as &_src/configure.default_&
5571 is sufficient for a host with simple mail requirements. As an introduction to
5572 the way Exim is configured, this chapter &"walks through"& the default
5573 configuration, giving brief explanations of the settings. Detailed descriptions
5574 of the options are given in subsequent chapters. The default configuration file
5575 itself contains extensive comments about ways you might want to modify the
5576 initial settings. However, note that there are many options that are not
5577 mentioned at all in the default configuration.
5578
5579
5580
5581 .section "Macros" "SECTdefconfmacros"
5582 All macros should be defined before any options.
5583
5584 One macro is specified, but commented out, in the default configuration:
5585 .code
5586 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5587 .endd
5588 If all off-site mail is expected to be delivered to a "smarthost", then set the
5589 hostname here and uncomment the macro.  This will affect which router is used
5590 later on.  If this is left commented out, then Exim will perform direct-to-MX
5591 deliveries using a &(dnslookup)& router.
5592
5593 In addition to macros defined here, Exim includes a number of built-in macros
5594 to enable configuration to be guarded by a binary built with support for a
5595 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5596
5597
5598 .section "Main configuration settings" "SECTdefconfmain"
5599 The main (global) configuration option settings section must always come first
5600 in the file, after the macros.
5601 The first thing you'll see in the file, after some initial comments, is the line
5602 .code
5603 # primary_hostname =
5604 .endd
5605 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5606 to know the official, fully qualified name of your host, and this is where you
5607 can specify it. However, in most cases you do not need to set this option. When
5608 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5609
5610 The first three non-comment configuration lines are as follows:
5611 .code
5612 domainlist local_domains    = @
5613 domainlist relay_to_domains =
5614 hostlist   relay_from_hosts = 127.0.0.1
5615 .endd
5616 These are not, in fact, option settings. They are definitions of two named
5617 domain lists and one named host list. Exim allows you to give names to lists of
5618 domains, hosts, and email addresses, in order to make it easier to manage the
5619 configuration file (see section &<<SECTnamedlists>>&).
5620
5621 The first line defines a domain list called &'local_domains'&; this is used
5622 later in the configuration to identify domains that are to be delivered
5623 on the local host.
5624
5625 .cindex "@ in a domain list"
5626 There is just one item in this list, the string &"@"&. This is a special form
5627 of entry which means &"the name of the local host"&. Thus, if the local host is
5628 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5629 be delivered locally. Because the local host's name is referenced indirectly,
5630 the same configuration file can be used on different hosts.
5631
5632 The second line defines a domain list called &'relay_to_domains'&, but the
5633 list itself is empty. Later in the configuration we will come to the part that
5634 controls mail relaying through the local host; it allows relaying to any
5635 domains in this list. By default, therefore, no relaying on the basis of a mail
5636 domain is permitted.
5637
5638 The third line defines a host list called &'relay_from_hosts'&. This list is
5639 used later in the configuration to permit relaying from any host or IP address
5640 that matches the list. The default contains just the IP address of the IPv4
5641 loopback interface, which means that processes on the local host are able to
5642 submit mail for relaying by sending it over TCP/IP to that interface. No other
5643 hosts are permitted to submit messages for relaying.
5644
5645 Just to be sure there's no misunderstanding: at this point in the configuration
5646 we aren't actually setting up any controls. We are just defining some domains
5647 and hosts that will be used in the controls that are specified later.
5648
5649 The next two configuration lines are genuine option settings:
5650 .code
5651 acl_smtp_rcpt = acl_check_rcpt
5652 acl_smtp_data = acl_check_data
5653 .endd
5654 These options specify &'Access Control Lists'& (ACLs) that are to be used
5655 during an incoming SMTP session for every recipient of a message (every RCPT
5656 command), and after the contents of the message have been received,
5657 respectively. The names of the lists are &'acl_check_rcpt'& and
5658 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5659 section of the configuration. The RCPT ACL controls which recipients are
5660 accepted for an incoming message &-- if a configuration does not provide an ACL
5661 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5662 contents of a message to be checked.
5663
5664 Two commented-out option settings are next:
5665 .code
5666 # av_scanner = clamd:/tmp/clamd
5667 # spamd_address = 127.0.0.1 783
5668 .endd
5669 These are example settings that can be used when Exim is compiled with the
5670 content-scanning extension. The first specifies the interface to the virus
5671 scanner, and the second specifies the interface to SpamAssassin. Further
5672 details are given in chapter &<<CHAPexiscan>>&.
5673
5674 Three more commented-out option settings follow:
5675 .code
5676 # tls_advertise_hosts = *
5677 # tls_certificate = /etc/ssl/exim.crt
5678 # tls_privatekey = /etc/ssl/exim.pem
5679 .endd
5680 These are example settings that can be used when Exim is compiled with
5681 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5682 first one specifies the list of clients that are allowed to use TLS when
5683 connecting to this server; in this case, the wildcard means all clients. The
5684 other options specify where Exim should find its TLS certificate and private
5685 key, which together prove the server's identity to any clients that connect.
5686 More details are given in chapter &<<CHAPTLS>>&.
5687
5688 Another two commented-out option settings follow:
5689 .code
5690 # daemon_smtp_ports = 25 : 465 : 587
5691 # tls_on_connect_ports = 465
5692 .endd
5693 .cindex "port" "465 and 587"
5694 .cindex "port" "for message submission"
5695 .cindex "message" "submission, ports for"
5696 .cindex "submissions protocol"
5697 .cindex "smtps protocol"
5698 .cindex "ssmtp protocol"
5699 .cindex "SMTP" "submissions protocol"
5700 .cindex "SMTP" "ssmtp protocol"
5701 .cindex "SMTP" "smtps protocol"
5702 These options provide better support for roaming users who wish to use this
5703 server for message submission. They are not much use unless you have turned on
5704 TLS (as described in the previous paragraph) and authentication (about which
5705 more in section &<<SECTdefconfauth>>&).
5706 Mail submission from mail clients (MUAs) should be separate from inbound mail
5707 to your domain (MX delivery) for various good reasons (eg, ability to impose
5708 much saner TLS protocol and ciphersuite requirements without unintended
5709 consequences).
5710 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5711 which uses STARTTLS, so this is the &"submission"& port.
5712 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5713 which should be used in preference to 587.
5714 You should also consider deploying SRV records to help clients find
5715 these ports.
5716 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5717
5718 Two more commented-out options settings follow:
5719 .code
5720 # qualify_domain =
5721 # qualify_recipient =
5722 .endd
5723 The first of these specifies a domain that Exim uses when it constructs a
5724 complete email address from a local login name. This is often needed when Exim
5725 receives a message from a local process. If you do not set &%qualify_domain%&,
5726 the value of &%primary_hostname%& is used. If you set both of these options,
5727 you can have different qualification domains for sender and recipient
5728 addresses. If you set only the first one, its value is used in both cases.
5729
5730 .cindex "domain literal" "recognizing format"
5731 The following line must be uncommented if you want Exim to recognize
5732 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5733 (an IP address within square brackets) instead of a named domain.
5734 .code
5735 # allow_domain_literals
5736 .endd
5737 The RFCs still require this form, but many people think that in the modern
5738 Internet it makes little sense to permit mail to be sent to specific hosts by
5739 quoting their IP addresses. This ancient format has been used by people who
5740 try to abuse hosts by using them for unwanted relaying. However, some
5741 people believe there are circumstances (for example, messages addressed to
5742 &'postmaster'&) where domain literals are still useful.
5743
5744 The next configuration line is a kind of trigger guard:
5745 .code
5746 never_users = root
5747 .endd
5748 It specifies that no delivery must ever be run as the root user. The normal
5749 convention is to set up &'root'& as an alias for the system administrator. This
5750 setting is a guard against slips in the configuration.
5751 The list of users specified by &%never_users%& is not, however, the complete
5752 list; the build-time configuration in &_Local/Makefile_& has an option called
5753 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5754 contents of &%never_users%& are added to this list. By default
5755 FIXED_NEVER_USERS also specifies root.
5756
5757 When a remote host connects to Exim in order to send mail, the only information
5758 Exim has about the host's identity is its IP address. The next configuration
5759 line,
5760 .code
5761 host_lookup = *
5762 .endd
5763 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5764 in order to get a host name. This improves the quality of the logging
5765 information, but if you feel it is too expensive, you can remove it entirely,
5766 or restrict the lookup to hosts on &"nearby"& networks.
5767 Note that it is not always possible to find a host name from an IP address,
5768 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5769 unreachable.
5770
5771 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5772 1413 (hence their names):
5773 .code
5774 rfc1413_hosts = *
5775 rfc1413_query_timeout = 0s
5776 .endd
5777 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5778 Few hosts offer RFC1413 service these days; calls have to be
5779 terminated by a timeout and this needlessly delays the startup
5780 of an incoming SMTP connection.
5781 If you have hosts for which you trust RFC1413 and need this
5782 information, you can change this.
5783
5784 This line enables an efficiency SMTP option.  It is negotiated by clients
5785 and not expected to cause problems but can be disabled if needed.
5786 .code
5787 prdr_enable = true
5788 .endd
5789
5790 When Exim receives messages over SMTP connections, it expects all addresses to
5791 be fully qualified with a domain, as required by the SMTP definition. However,
5792 if you are running a server to which simple clients submit messages, you may
5793 find that they send unqualified addresses. The two commented-out options:
5794 .code
5795 # sender_unqualified_hosts =
5796 # recipient_unqualified_hosts =
5797 .endd
5798 show how you can specify hosts that are permitted to send unqualified sender
5799 and recipient addresses, respectively.
5800
5801 The &%log_selector%& option is used to increase the detail of logging
5802 over the default:
5803 .code
5804 log_selector = +smtp_protocol_error +smtp_syntax_error \
5805                +tls_certificate_verified
5806 .endd
5807
5808 The &%percent_hack_domains%& option is also commented out:
5809 .code
5810 # percent_hack_domains =
5811 .endd
5812 It provides a list of domains for which the &"percent hack"& is to operate.
5813 This is an almost obsolete form of explicit email routing. If you do not know
5814 anything about it, you can safely ignore this topic.
5815
5816 The next two settings in the main part of the default configuration are
5817 concerned with messages that have been &"frozen"& on Exim's queue. When a
5818 message is frozen, Exim no longer continues to try to deliver it. Freezing
5819 occurs when a bounce message encounters a permanent failure because the sender
5820 address of the original message that caused the bounce is invalid, so the
5821 bounce cannot be delivered. This is probably the most common case, but there
5822 are also other conditions that cause freezing, and frozen messages are not
5823 always bounce messages.
5824 .code
5825 ignore_bounce_errors_after = 2d
5826 timeout_frozen_after = 7d
5827 .endd
5828 The first of these options specifies that failing bounce messages are to be
5829 discarded after 2 days in the queue. The second specifies that any frozen
5830 message (whether a bounce message or not) is to be timed out (and discarded)
5831 after a week. In this configuration, the first setting ensures that no failing
5832 bounce message ever lasts a week.
5833
5834 Exim queues it's messages in a spool directory. If you expect to have
5835 large queues, you may consider using this option. It splits the spool
5836 directory into subdirectories to avoid file system degradation from
5837 many files in a single directory, resulting in better performance.
5838 Manual manipulation of queued messages becomes more complex (though fortunately
5839 not often needed).
5840 .code
5841 # split_spool_directory = true
5842 .endd
5843
5844 In an ideal world everybody follows the standards. For non-ASCII
5845 messages RFC 2047 is a standard, allowing a maximum line length of 76
5846 characters. Exim adheres that standard and won't process messages which
5847 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5848 In particular, the Exim maintainers have had multiple reports of
5849 problems from Russian administrators of issues until they disable this
5850 check, because of some popular, yet buggy, mail composition software.
5851 .code
5852 # check_rfc2047_length = false
5853 .endd
5854
5855 If you need to be strictly RFC compliant you may wish to disable the
5856 8BITMIME advertisement. Use this, if you exchange mails with systems
5857 that are not 8-bit clean.
5858 .code
5859 # accept_8bitmime = false
5860 .endd
5861
5862 Libraries you use may depend on specific environment settings.  This
5863 imposes a security risk (e.g. PATH). There are two lists:
5864 &%keep_environment%& for the variables to import as they are, and
5865 &%add_environment%& for variables we want to set to a fixed value.
5866 Note that TZ is handled separately, by the $%timezone%$ runtime
5867 option and by the TIMEZONE_DEFAULT buildtime option.
5868 .code
5869 # keep_environment = ^LDAP
5870 # add_environment = PATH=/usr/bin::/bin
5871 .endd
5872
5873
5874 .section "ACL configuration" "SECID54"
5875 .cindex "default" "ACLs"
5876 .cindex "&ACL;" "default configuration"
5877 In the default configuration, the ACL section follows the main configuration.
5878 It starts with the line
5879 .code
5880 begin acl
5881 .endd
5882 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5883 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5884 and &%acl_smtp_data%& above.
5885
5886 .cindex "RCPT" "ACL for"
5887 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5888 RCPT command specifies one of the message's recipients. The ACL statements
5889 are considered in order, until the recipient address is either accepted or
5890 rejected. The RCPT command is then accepted or rejected, according to the
5891 result of the ACL processing.
5892 .code
5893 acl_check_rcpt:
5894 .endd
5895 This line, consisting of a name terminated by a colon, marks the start of the
5896 ACL, and names it.
5897 .code
5898 accept  hosts = :
5899 .endd
5900 This ACL statement accepts the recipient if the sending host matches the list.
5901 But what does that strange list mean? It doesn't actually contain any host
5902 names or IP addresses. The presence of the colon puts an empty item in the
5903 list; Exim matches this only if the incoming message did not come from a remote
5904 host, because in that case, the remote hostname is empty. The colon is
5905 important. Without it, the list itself is empty, and can never match anything.
5906
5907 What this statement is doing is to accept unconditionally all recipients in
5908 messages that are submitted by SMTP from local processes using the standard
5909 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5910 manner.
5911 .code
5912 deny    domains       = +local_domains
5913         local_parts   = ^[.] : ^.*[@%!/|]
5914         message       = Restricted characters in address
5915
5916 deny    domains       = !+local_domains
5917         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5918         message       = Restricted characters in address
5919 .endd
5920 These statements are concerned with local parts that contain any of the
5921 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5922 Although these characters are entirely legal in local parts (in the case of
5923 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5924 in Internet mail addresses.
5925
5926 The first three have in the past been associated with explicitly routed
5927 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5928 option). Addresses containing these characters are regularly tried by spammers
5929 in an attempt to bypass relaying restrictions, and also by open relay testing
5930 programs. Unless you really need them it is safest to reject these characters
5931 at this early stage. This configuration is heavy-handed in rejecting these
5932 characters for all messages it accepts from remote hosts. This is a deliberate
5933 policy of being as safe as possible.
5934
5935 The first rule above is stricter, and is applied to messages that are addressed
5936 to one of the local domains handled by this host. This is implemented by the
5937 first condition, which restricts it to domains that are listed in the
5938 &'local_domains'& domain list. The &"+"& character is used to indicate a
5939 reference to a named list. In this configuration, there is just one domain in
5940 &'local_domains'&, but in general there may be many.
5941
5942 The second condition on the first statement uses two regular expressions to
5943 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5944 or &"|"&. If you have local accounts that include these characters, you will
5945 have to modify this rule.
5946
5947 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5948 allows them because they have been encountered in practice. (Consider the
5949 common convention of local parts constructed as
5950 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5951 the author of Exim, who has no second initial.) However, a local part starting
5952 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5953 filename (for example, for a mailing list). This is also true for local parts
5954 that contain slashes. A pipe symbol can also be troublesome if the local part
5955 is incorporated unthinkingly into a shell command line.
5956
5957 The second rule above applies to all other domains, and is less strict. This
5958 allows your own users to send outgoing messages to sites that use slashes
5959 and vertical bars in their local parts. It blocks local parts that begin
5960 with a dot, slash, or vertical bar, but allows these characters within the
5961 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5962 and &"!"& is blocked, as before. The motivation here is to prevent your users
5963 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5964 .code
5965 accept  local_parts   = postmaster
5966         domains       = +local_domains
5967 .endd
5968 This statement, which has two conditions, accepts an incoming address if the
5969 local part is &'postmaster'& and the domain is one of those listed in the
5970 &'local_domains'& domain list. The &"+"& character is used to indicate a
5971 reference to a named list. In this configuration, there is just one domain in
5972 &'local_domains'&, but in general there may be many.
5973
5974 The presence of this statement means that mail to postmaster is never blocked
5975 by any of the subsequent tests. This can be helpful while sorting out problems
5976 in cases where the subsequent tests are incorrectly denying access.
5977 .code
5978 require verify        = sender
5979 .endd
5980 This statement requires the sender address to be verified before any subsequent
5981 ACL statement can be used. If verification fails, the incoming recipient
5982 address is refused. Verification consists of trying to route the address, to
5983 see if a bounce message could be delivered to it. In the case of remote
5984 addresses, basic verification checks only the domain, but &'callouts'& can be
5985 used for more verification if required. Section &<<SECTaddressverification>>&
5986 discusses the details of address verification.
5987 .code
5988 accept  hosts         = +relay_from_hosts
5989         control       = submission
5990 .endd
5991 This statement accepts the address if the message is coming from one of the
5992 hosts that are defined as being allowed to relay through this host. Recipient
5993 verification is omitted here, because in many cases the clients are dumb MUAs
5994 that do not cope well with SMTP error responses. For the same reason, the
5995 second line specifies &"submission mode"& for messages that are accepted. This
5996 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5997 messages that are deficient in some way, for example, because they lack a
5998 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5999 probably add recipient verification here, and disable submission mode.
6000 .code
6001 accept  authenticated = *
6002         control       = submission
6003 .endd
6004 This statement accepts the address if the client host has authenticated itself.
6005 Submission mode is again specified, on the grounds that such messages are most
6006 likely to come from MUAs. The default configuration does not define any
6007 authenticators, though it does include some nearly complete commented-out
6008 examples described in &<<SECTdefconfauth>>&. This means that no client can in
6009 fact authenticate until you complete the authenticator definitions.
6010 .code
6011 require message = relay not permitted
6012         domains = +local_domains : +relay_to_domains
6013 .endd
6014 This statement rejects the address if its domain is neither a local domain nor
6015 one of the domains for which this host is a relay.
6016 .code
6017 require verify = recipient
6018 .endd
6019 This statement requires the recipient address to be verified; if verification
6020 fails, the address is rejected.
6021 .code
6022 # deny    dnslists    = black.list.example
6023 #         message     = rejected because $sender_host_address \
6024 #                       is in a black list at $dnslist_domain\n\
6025 #                       $dnslist_text
6026 #
6027 # warn    dnslists    = black.list.example
6028 #         add_header  = X-Warning: $sender_host_address is in \
6029 #                       a black list at $dnslist_domain
6030 #         log_message = found in $dnslist_domain
6031 .endd
6032 These commented-out lines are examples of how you could configure Exim to check
6033 sending hosts against a DNS black list. The first statement rejects messages
6034 from blacklisted hosts, whereas the second just inserts a warning header
6035 line.
6036 .code
6037 # require verify = csa
6038 .endd
6039 This commented-out line is an example of how you could turn on client SMTP
6040 authorization (CSA) checking. Such checks do DNS lookups for special SRV
6041 records.
6042 .code
6043 accept
6044 .endd
6045 The final statement in the first ACL unconditionally accepts any recipient
6046 address that has successfully passed all the previous tests.
6047 .code
6048 acl_check_data:
6049 .endd
6050 This line marks the start of the second ACL, and names it. Most of the contents
6051 of this ACL are commented out:
6052 .code
6053 # deny    malware   = *
6054 #         message   = This message contains a virus \
6055 #                     ($malware_name).
6056 .endd
6057 These lines are examples of how to arrange for messages to be scanned for
6058 viruses when Exim has been compiled with the content-scanning extension, and a
6059 suitable virus scanner is installed. If the message is found to contain a
6060 virus, it is rejected with the given custom error message.
6061 .code
6062 # warn    spam      = nobody
6063 #         message   = X-Spam_score: $spam_score\n\
6064 #                     X-Spam_score_int: $spam_score_int\n\
6065 #                     X-Spam_bar: $spam_bar\n\
6066 #                     X-Spam_report: $spam_report
6067 .endd
6068 These lines are an example of how to arrange for messages to be scanned by
6069 SpamAssassin when Exim has been compiled with the content-scanning extension,
6070 and SpamAssassin has been installed. The SpamAssassin check is run with
6071 &`nobody`& as its user parameter, and the results are added to the message as a
6072 series of extra header line. In this case, the message is not rejected,
6073 whatever the spam score.
6074 .code
6075 accept
6076 .endd
6077 This final line in the DATA ACL accepts the message unconditionally.
6078
6079
6080 .section "Router configuration" "SECID55"
6081 .cindex "default" "routers"
6082 .cindex "routers" "default"
6083 The router configuration comes next in the default configuration, introduced
6084 by the line
6085 .code
6086 begin routers
6087 .endd
6088 Routers are the modules in Exim that make decisions about where to send
6089 messages. An address is passed to each router, in turn, until it is either
6090 accepted, or failed. This means that the order in which you define the routers
6091 matters. Each router is fully described in its own chapter later in this
6092 manual. Here we give only brief overviews.
6093 .code
6094 # domain_literal:
6095 #   driver = ipliteral
6096 #   domains = !+local_domains
6097 #   transport = remote_smtp
6098 .endd
6099 .cindex "domain literal" "default router"
6100 This router is commented out because the majority of sites do not want to
6101 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6102 you uncomment this router, you also need to uncomment the setting of
6103 &%allow_domain_literals%& in the main part of the configuration.
6104
6105 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6106 macro has been defined, per
6107 .code
6108 .ifdef ROUTER_SMARTHOST
6109 smarthost:
6110 #...
6111 .else
6112 dnslookup:
6113 #...
6114 .endif
6115 .endd
6116
6117 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6118 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6119 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6120 skip these routers because of the &%domains%& option.
6121
6122 .code
6123 smarthost:
6124   driver = manualroute
6125   domains = ! +local_domains
6126   transport = smarthost_smtp
6127   route_data = ROUTER_SMARTHOST
6128   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6129   no_more
6130 .endd
6131 This router only handles mail which is not to any local domains; this is
6132 specified by the line
6133 .code
6134 domains = ! +local_domains
6135 .endd
6136 The &%domains%& option lists the domains to which this router applies, but the
6137 exclamation mark is a negation sign, so the router is used only for domains
6138 that are not in the domain list called &'local_domains'& (which was defined at
6139 the start of the configuration). The plus sign before &'local_domains'&
6140 indicates that it is referring to a named list. Addresses in other domains are
6141 passed on to the following routers.
6142
6143 The name of the router driver is &(manualroute)& because we are manually
6144 specifying how mail should be routed onwards, instead of using DNS MX.
6145 While the name of this router instance is arbitrary, the &%driver%& option must
6146 be one of the driver modules that is in the Exim binary.
6147
6148 With no pre-conditions other than &%domains%&, all mail for non-local domains
6149 will be handled by this router, and the &%no_more%& setting will ensure that no
6150 other routers will be used for messages matching the pre-conditions.  See
6151 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6152 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6153 and the macro supplies the value; the address is then queued for the
6154 &(smarthost_smtp)& transport.
6155
6156 .code
6157 dnslookup:
6158   driver = dnslookup
6159   domains = ! +local_domains
6160   transport = remote_smtp
6161   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6162   no_more
6163 .endd
6164 The &%domains%& option behaves as per smarthost, above.
6165
6166 The name of the router driver is &(dnslookup)&,
6167 and is specified by the &%driver%& option. Do not be confused by the fact that
6168 the name of this router instance is the same as the name of the driver. The
6169 instance name is arbitrary, but the name set in the &%driver%& option must be
6170 one of the driver modules that is in the Exim binary.
6171
6172 The &(dnslookup)& router routes addresses by looking up their domains in the
6173 DNS in order to obtain a list of hosts to which the address is routed. If the
6174 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6175 specified by the &%transport%& option. If the router does not find the domain
6176 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6177 the address fails and is bounced.
6178
6179 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6180 be entirely ignored. This option is present because a number of cases have been
6181 encountered where MX records in the DNS point to host names
6182 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6183 Completely ignoring these IP addresses causes Exim to fail to route the
6184 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6185 continue to try to deliver the message periodically until the address timed
6186 out.
6187 .code
6188 system_aliases:
6189   driver = redirect
6190   allow_fail
6191   allow_defer
6192   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6193 # user = exim
6194   file_transport = address_file
6195   pipe_transport = address_pipe
6196 .endd
6197 Control reaches this and subsequent routers only for addresses in the local
6198 domains. This router checks to see whether the local part is defined as an
6199 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6200 data that it looks up from that file. If no data is found for the local part,
6201 the value of the &%data%& option is empty, causing the address to be passed to
6202 the next router.
6203
6204 &_/etc/aliases_& is a conventional name for the system aliases file that is
6205 often used. That is why it is referenced by from the default configuration
6206 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6207 &_Local/Makefile_& before building Exim.
6208 .code
6209 userforward:
6210   driver = redirect
6211   check_local_user
6212 # local_part_suffix = +* : -*
6213 # local_part_suffix_optional
6214   file = $home/.forward
6215 # allow_filter
6216   no_verify
6217   no_expn
6218   check_ancestor
6219   file_transport = address_file
6220   pipe_transport = address_pipe
6221   reply_transport = address_reply
6222 .endd
6223 This is the most complicated router in the default configuration. It is another
6224 redirection router, but this time it is looking for forwarding data set up by
6225 individual users. The &%check_local_user%& setting specifies a check that the
6226 local part of the address is the login name of a local user. If it is not, the
6227 router is skipped. The two commented options that follow &%check_local_user%&,
6228 namely:
6229 .code
6230 # local_part_suffix = +* : -*
6231 # local_part_suffix_optional
6232 .endd
6233 .vindex "&$local_part_suffix$&"
6234 show how you can specify the recognition of local part suffixes. If the first
6235 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6236 by any sequence of characters, is removed from the local part and placed in the
6237 variable &$local_part_suffix$&. The second suffix option specifies that the
6238 presence of a suffix in the local part is optional. When a suffix is present,
6239 the check for a local login uses the local part with the suffix removed.
6240
6241 When a local user account is found, the file called &_.forward_& in the user's
6242 home directory is consulted. If it does not exist, or is empty, the router
6243 declines. Otherwise, the contents of &_.forward_& are interpreted as
6244 redirection data (see chapter &<<CHAPredirect>>& for more details).
6245
6246 .cindex "Sieve filter" "enabling in default router"
6247 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6248 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6249 is commented out by default), the contents of the file are interpreted as a set
6250 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6251 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6252 separate document entitled &'Exim's interfaces to mail filtering'&.
6253
6254 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6255 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6256 There are two reasons for doing this:
6257
6258 .olist
6259 Whether or not a local user has a &_.forward_& file is not really relevant when
6260 checking an address for validity; it makes sense not to waste resources doing
6261 unnecessary work.
6262 .next
6263 More importantly, when Exim is verifying addresses or handling an EXPN
6264 command during an SMTP session, it is running as the Exim user, not as root.
6265 The group is the Exim group, and no additional groups are set up.
6266 It may therefore not be possible for Exim to read users' &_.forward_& files at
6267 this time.
6268 .endlist
6269
6270 The setting of &%check_ancestor%& prevents the router from generating a new
6271 address that is the same as any previous address that was redirected. (This
6272 works round a problem concerning a bad interaction between aliasing and
6273 forwarding &-- see section &<<SECTredlocmai>>&).
6274
6275 The final three option settings specify the transports that are to be used when
6276 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6277 auto-reply, respectively. For example, if a &_.forward_& file contains
6278 .code
6279 a.nother@elsewhere.example, /home/spqr/archive
6280 .endd
6281 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6282 transport.
6283 .code
6284 localuser:
6285   driver = accept
6286   check_local_user
6287 # local_part_suffix = +* : -*
6288 # local_part_suffix_optional
6289   transport = local_delivery
6290 .endd
6291 The final router sets up delivery into local mailboxes, provided that the local
6292 part is the name of a local login, by accepting the address and assigning it to
6293 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6294 routers, so the address is bounced. The commented suffix settings fulfil the
6295 same purpose as they do for the &(userforward)& router.
6296
6297
6298 .section "Transport configuration" "SECID56"
6299 .cindex "default" "transports"
6300 .cindex "transports" "default"
6301 Transports define mechanisms for actually delivering messages. They operate
6302 only when referenced from routers, so the order in which they are defined does
6303 not matter. The transports section of the configuration starts with
6304 .code
6305 begin transports
6306 .endd
6307 Two remote transports and four local transports are defined.
6308 .code
6309 remote_smtp:
6310   driver = smtp
6311   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6312 .ifdef _HAVE_PRDR
6313   hosts_try_prdr = *
6314 .endif
6315 .endd
6316 This transport is used for delivering messages over SMTP connections.
6317 The list of remote hosts comes from the router.
6318 The &%message_size_limit%& usage is a hack to avoid sending on messages
6319 with over-long lines.
6320
6321 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6322 negotiated between client and server and not expected to cause problems
6323 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6324 use of the &%hosts_try_prdr%& configuration option.
6325
6326 The other remote transport is used when delivering to a specific smarthost
6327 with whom there must be some kind of existing relationship, instead of the
6328 usual federated system.
6329
6330 .code
6331 smarthost_smtp:
6332   driver = smtp
6333   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6334   multi_domain
6335   #
6336 .ifdef _HAVE_TLS
6337   # Comment out any of these which you have to, then file a Support
6338   # request with your smarthost provider to get things fixed:
6339   hosts_require_tls = *
6340   tls_verify_hosts = *
6341   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6342   # have to comment it out then this will at least log whether you succeed
6343   # or not:
6344   tls_try_verify_hosts = *
6345   #
6346   # The SNI name should match the name which we'll expect to verify;
6347   # many mail systems don't use SNI and this doesn't matter, but if it does,
6348   # we need to send a name which the remote site will recognize.
6349   # This _should_ be the name which the smarthost operators specified as
6350   # the hostname for sending your mail to.
6351   tls_sni = ROUTER_SMARTHOST
6352   #
6353 .ifdef _HAVE_OPENSSL
6354   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6355 .endif
6356 .ifdef _HAVE_GNUTLS
6357   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6358 .endif
6359 .endif
6360 .ifdef _HAVE_PRDR
6361   hosts_try_prdr = *
6362 .endif
6363 .endd
6364 After the same &%message_size_limit%& hack, we then specify that this Transport
6365 can handle messages to multiple domains in one run.  The assumption here is
6366 that you're routing all non-local mail to the same place and that place is
6367 happy to take all messages from you as quickly as possible.
6368 All other options depend upon built-in macros; if Exim was built without TLS support
6369 then no other options are defined.
6370 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6371 and versions using the &%tls_require_ciphers%& option, where the value to be
6372 used depends upon the library providing TLS.
6373 Beyond that, the options adopt the stance that you should have TLS support available
6374 from your smarthost on today's Internet, so we turn on requiring TLS for the
6375 mail to be delivered, and requiring that the certificate be valid, and match
6376 the expected hostname.  The &%tls_sni%& option can be used by service providers
6377 to select an appropriate certificate to present to you and here we re-use the
6378 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6379 You want to specify the hostname which you'll expect to validate for, and that
6380 should not be subject to insecure tampering via DNS results.
6381
6382 For the &%hosts_try_prdr%& option see the previous transport.
6383
6384 All other options are defaulted.
6385 .code
6386 local_delivery:
6387   driver = appendfile
6388   file = /var/mail/$local_part_data
6389   delivery_date_add
6390   envelope_to_add
6391   return_path_add
6392 # group = mail
6393 # mode = 0660
6394 .endd
6395 This &(appendfile)& transport is used for local delivery to user mailboxes in
6396 traditional BSD mailbox format.
6397
6398 We prefer to avoid using &$local_part$& directly to define the mailbox filename,
6399 as it is provided by a potential bad actor.
6400 Instead we use &$local_part_data$&,
6401 the result of looking up &$local_part$& in the user database
6402 (done by using &%check_local_user%& in the the router).
6403
6404 By default &(appendfile)& runs under the uid and gid of the
6405 local user, which requires the sticky bit to be set on the &_/var/mail_&
6406 directory. Some systems use the alternative approach of running mail deliveries
6407 under a particular group instead of using the sticky bit. The commented options
6408 show how this can be done.
6409
6410 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6411 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6412 similarly-named options above.
6413 .code
6414 address_pipe:
6415   driver = pipe
6416   return_output
6417 .endd
6418 This transport is used for handling deliveries to pipes that are generated by
6419 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6420 option specifies that any output on stdout or stderr generated by the pipe is to
6421 be returned to the sender.
6422 .code
6423 address_file:
6424   driver = appendfile
6425   delivery_date_add
6426   envelope_to_add
6427   return_path_add
6428 .endd
6429 This transport is used for handling deliveries to files that are generated by
6430 redirection. The name of the file is not specified in this instance of
6431 &(appendfile)&, because it comes from the &(redirect)& router.
6432 .code
6433 address_reply:
6434   driver = autoreply
6435 .endd
6436 This transport is used for handling automatic replies generated by users'
6437 filter files.
6438
6439
6440
6441 .section "Default retry rule" "SECID57"
6442 .cindex "retry" "default rule"
6443 .cindex "default" "retry rule"
6444 The retry section of the configuration file contains rules which affect the way
6445 Exim retries deliveries that cannot be completed at the first attempt. It is
6446 introduced by the line
6447 .code
6448 begin retry
6449 .endd
6450 In the default configuration, there is just one rule, which applies to all
6451 errors:
6452 .code
6453 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6454 .endd
6455 This causes any temporarily failing address to be retried every 15 minutes for
6456 2 hours, then at intervals starting at one hour and increasing by a factor of
6457 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6458 is not delivered after 4 days of temporary failure, it is bounced. The time is
6459 measured from first failure, not from the time the message was received.
6460
6461 If the retry section is removed from the configuration, or is empty (that is,
6462 if no retry rules are defined), Exim will not retry deliveries. This turns
6463 temporary errors into permanent errors.
6464
6465
6466 .section "Rewriting configuration" "SECID58"
6467 The rewriting section of the configuration, introduced by
6468 .code
6469 begin rewrite
6470 .endd
6471 contains rules for rewriting addresses in messages as they arrive. There are no
6472 rewriting rules in the default configuration file.
6473
6474
6475
6476 .section "Authenticators configuration" "SECTdefconfauth"
6477 .cindex "AUTH" "configuration"
6478 The authenticators section of the configuration, introduced by
6479 .code
6480 begin authenticators
6481 .endd
6482 defines mechanisms for the use of the SMTP AUTH command. The default
6483 configuration file contains two commented-out example authenticators
6484 which support plaintext username/password authentication using the
6485 standard PLAIN mechanism and the traditional but non-standard LOGIN
6486 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6487 to support most MUA software.
6488
6489 The example PLAIN authenticator looks like this:
6490 .code
6491 #PLAIN:
6492 #  driver                  = plaintext
6493 #  server_set_id           = $auth2
6494 #  server_prompts          = :
6495 #  server_condition        = Authentication is not yet configured
6496 #  server_advertise_condition = ${if def:tls_in_cipher }
6497 .endd
6498 And the example LOGIN authenticator looks like this:
6499 .code
6500 #LOGIN:
6501 #  driver                  = plaintext
6502 #  server_set_id           = $auth1
6503 #  server_prompts          = <| Username: | Password:
6504 #  server_condition        = Authentication is not yet configured
6505 #  server_advertise_condition = ${if def:tls_in_cipher }
6506 .endd
6507
6508 The &%server_set_id%& option makes Exim remember the authenticated username
6509 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6510 &%server_prompts%& option configures the &(plaintext)& authenticator so
6511 that it implements the details of the specific authentication mechanism,
6512 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6513 when Exim offers authentication to clients; in the examples, this is only
6514 when TLS or SSL has been started, so to enable the authenticators you also
6515 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6516
6517 The &%server_condition%& setting defines how to verify that the username and
6518 password are correct. In the examples it just produces an error message.
6519 To make the authenticators work, you can use a string expansion
6520 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6521
6522 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6523 usercode and password are in different positions.
6524 Chapter &<<CHAPplaintext>>& covers both.
6525
6526 .ecindex IIDconfiwal
6527
6528
6529
6530 . ////////////////////////////////////////////////////////////////////////////
6531 . ////////////////////////////////////////////////////////////////////////////
6532
6533 .chapter "Regular expressions" "CHAPregexp"
6534
6535 .cindex "regular expressions" "library"
6536 .cindex "PCRE"
6537 Exim supports the use of regular expressions in many of its options. It
6538 uses the PCRE regular expression library; this provides regular expression
6539 matching that is compatible with Perl 5. The syntax and semantics of
6540 regular expressions is discussed in
6541 online Perl manpages, in
6542 many Perl reference books, and also in
6543 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6544 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6545 . --- the http: URL here redirects to another page with the ISBN in the URL
6546 . --- where trying to use https: just redirects back to http:, so sticking
6547 . --- to the old URL for now.  2018-09-07.
6548
6549 The documentation for the syntax and semantics of the regular expressions that
6550 are supported by PCRE is included in the PCRE distribution, and no further
6551 description is included here. The PCRE functions are called from Exim using
6552 the default option settings (that is, with no PCRE options set), except that
6553 the PCRE_CASELESS option is set when the matching is required to be
6554 case-insensitive.
6555
6556 In most cases, when a regular expression is required in an Exim configuration,
6557 it has to start with a circumflex, in order to distinguish it from plain text
6558 or an &"ends with"& wildcard. In this example of a configuration setting, the
6559 second item in the colon-separated list is a regular expression.
6560 .code
6561 domains = a.b.c : ^\\d{3} : *.y.z : ...
6562 .endd
6563 The doubling of the backslash is required because of string expansion that
6564 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6565 of this issue, and a way of avoiding the need for doubling backslashes. The
6566 regular expression that is eventually used in this example contains just one
6567 backslash. The circumflex is included in the regular expression, and has the
6568 normal effect of &"anchoring"& it to the start of the string that is being
6569 matched.
6570
6571 There are, however, two cases where a circumflex is not required for the
6572 recognition of a regular expression: these are the &%match%& condition in a
6573 string expansion, and the &%matches%& condition in an Exim filter file. In
6574 these cases, the relevant string is always treated as a regular expression; if
6575 it does not start with a circumflex, the expression is not anchored, and can
6576 match anywhere in the subject string.
6577
6578 In all cases, if you want a regular expression to match at the end of a string,
6579 you must code the $ metacharacter to indicate this. For example:
6580 .code
6581 domains = ^\\d{3}\\.example
6582 .endd
6583 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6584 You need to use:
6585 .code
6586 domains = ^\\d{3}\\.example\$
6587 .endd
6588 if you want &'example'& to be the top-level domain. The backslash before the
6589 $ is needed because string expansion also interprets dollar characters.
6590
6591
6592
6593 . ////////////////////////////////////////////////////////////////////////////
6594 . ////////////////////////////////////////////////////////////////////////////
6595
6596 .chapter "File and database lookups" "CHAPfdlookup"
6597 .scindex IIDfidalo1 "file" "lookups"
6598 .scindex IIDfidalo2 "database" "lookups"
6599 .cindex "lookup" "description of"
6600 Exim can be configured to look up data in files or databases as it processes
6601 messages. Two different kinds of syntax are used:
6602
6603 .olist
6604 A string that is to be expanded may contain explicit lookup requests. These
6605 cause parts of the string to be replaced by data that is obtained from the
6606 lookup. Lookups of this type are conditional expansion items. Different results
6607 can be defined for the cases of lookup success and failure. See chapter
6608 &<<CHAPexpand>>&, where string expansions are described in detail.
6609 The key for the lookup is specified as part of the string expansion.
6610 .next
6611 Lists of domains, hosts, and email addresses can contain lookup requests as a
6612 way of avoiding excessively long linear lists. In this case, the data that is
6613 returned by the lookup is often (but not always) discarded; whether the lookup
6614 succeeds or fails is what really counts. These kinds of list are described in
6615 chapter &<<CHAPdomhosaddlists>>&.
6616 The key for the lookup is given by the context in which the list is expanded.
6617 .endlist
6618
6619 String expansions, lists, and lookups interact with each other in such a way
6620 that there is no order in which to describe any one of them that does not
6621 involve references to the others. Each of these three chapters makes more sense
6622 if you have read the other two first. If you are reading this for the first
6623 time, be aware that some of it will make a lot more sense after you have read
6624 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6625
6626 .section "Examples of different lookup syntax" "SECID60"
6627 It is easy to confuse the two different kinds of lookup, especially as the
6628 lists that may contain the second kind are always expanded before being
6629 processed as lists. Therefore, they may also contain lookups of the first kind.
6630 Be careful to distinguish between the following two examples:
6631 .code
6632 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6633 domains = lsearch;/some/file
6634 .endd
6635 The first uses a string expansion, the result of which must be a domain list.
6636 No strings have been specified for a successful or a failing lookup; the
6637 defaults in this case are the looked-up data and an empty string, respectively.
6638 The expansion takes place before the string is processed as a list, and the
6639 file that is searched could contain lines like this:
6640 .code
6641 192.168.3.4: domain1:domain2:...
6642 192.168.1.9: domain3:domain4:...
6643 .endd
6644 When the lookup succeeds, the result of the expansion is a list of domains (and
6645 possibly other types of item that are allowed in domain lists).
6646 .cindex "tainted data" "de-tainting"
6647 The result of the expansion is not tainted.
6648
6649 In the second example, the lookup is a single item in a domain list. It causes
6650 Exim to use a lookup to see if the domain that is being processed can be found
6651 in the file. The file could contains lines like this:
6652 .code
6653 domain1:
6654 domain2:
6655 .endd
6656 Any data that follows the keys is not relevant when checking that the domain
6657 matches the list item.
6658
6659 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6660 Consider a file containing lines like this:
6661 .code
6662 192.168.5.6: lsearch;/another/file
6663 .endd
6664 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6665 first &%domains%& setting above generates the second setting, which therefore
6666 causes a second lookup to occur.
6667
6668 .new
6669 The lookup type may optionally be followed by a comma
6670 and a comma-separated list of options.
6671 Each option is a &"name=value"& pair.
6672 Whether an option is meaningful depands on the lookup type.
6673
6674 All lookups support the option &"cache=no_rd"&.
6675 If this is given then the cache that Exim manages for lookup results
6676 is not checked before diong the lookup.
6677 The result of the lookup is still written to the cache.
6678 .wen
6679
6680 The rest of this chapter describes the different lookup types that are
6681 available. Any of them can be used in any part of the configuration where a
6682 lookup is permitted.
6683
6684
6685 .section "Lookup types" "SECID61"
6686 .cindex "lookup" "types of"
6687 .cindex "single-key lookup" "definition of"
6688 Two different types of data lookup are implemented:
6689
6690 .ilist
6691 The &'single-key'& type requires the specification of a file in which to look,
6692 and a single key to search for. The key must be a non-empty string for the
6693 lookup to succeed. The lookup type determines how the file is searched.
6694 .cindex "tainted data" "single-key lookups"
6695 The file string may not be tainted
6696
6697 .cindex "tainted data" "de-tainting"
6698 All single-key lookups support the option &"ret=key"&.
6699 If this is given and the lookup
6700 (either underlying implementation or cached value)
6701 returns data, the result is replaced with a non-tainted
6702 version of the lookup key.
6703 .cindex "tainted data" "de-tainting"
6704 .next
6705 .cindex "query-style lookup" "definition of"
6706 The &'query-style'& type accepts a generalized database query. No particular
6707 key value is assumed by Exim for query-style lookups. You can use whichever
6708 Exim variables you need to construct the database query.
6709 .endlist
6710
6711 The code for each lookup type is in a separate source file that is included in
6712 the binary of Exim only if the corresponding compile-time option is set. The
6713 default settings in &_src/EDITME_& are:
6714 .code
6715 LOOKUP_DBM=yes
6716 LOOKUP_LSEARCH=yes
6717 .endd
6718 which means that only linear searching and DBM lookups are included by default.
6719 For some types of lookup (e.g. SQL databases), you need to install appropriate
6720 libraries and header files before building Exim.
6721
6722
6723
6724
6725 .section "Single-key lookup types" "SECTsinglekeylookups"
6726 .cindex "lookup" "single-key types"
6727 .cindex "single-key lookup" "list of types"
6728 The following single-key lookup types are implemented:
6729
6730 .ilist
6731 .cindex "cdb" "description of"
6732 .cindex "lookup" "cdb"
6733 .cindex "binary zero" "in lookup key"
6734 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6735 string without a terminating binary zero. The cdb format is designed for
6736 indexed files that are read frequently and never updated, except by total
6737 re-creation. As such, it is particularly suitable for large files containing
6738 aliases or other indexed data referenced by an MTA. Information about cdb and
6739 tools for building the files can be found in several places:
6740 .display
6741 &url(https://cr.yp.to/cdb.html)
6742 &url(https://www.corpit.ru/mjt/tinycdb.html)
6743 &url(https://packages.debian.org/stable/utils/freecdb)
6744 &url(https://github.com/philpennock/cdbtools) (in Go)
6745 .endd
6746 A cdb distribution is not needed in order to build Exim with cdb support,
6747 because the code for reading cdb files is included directly in Exim itself.
6748 However, no means of building or testing cdb files is provided with Exim, so
6749 you need to obtain a cdb distribution in order to do this.
6750 .next
6751 .cindex "DBM" "lookup type"
6752 .cindex "lookup" "dbm"
6753 .cindex "binary zero" "in lookup key"
6754 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6755 DBM file by looking up the record with the given key. A terminating binary
6756 zero is included in the key that is passed to the DBM library. See section
6757 &<<SECTdb>>& for a discussion of DBM libraries.
6758
6759 .cindex "Berkeley DB library" "file format"
6760 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6761 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6762 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6763 the DB_UNKNOWN option. This enables it to handle any of the types of database
6764 that the library supports, and can be useful for accessing DBM files created by
6765 other applications. (For earlier DB versions, DB_HASH is always used.)
6766 .next
6767 .cindex "lookup" "dbmjz"
6768 .cindex "lookup" "dbm &-- embedded NULs"
6769 .cindex "sasldb2"
6770 .cindex "dbmjz lookup type"
6771 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6772 interpreted as an Exim list; the elements of the list are joined together with
6773 ASCII NUL characters to form the lookup key.  An example usage would be to
6774 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6775 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6776 &(cram_md5)& authenticator.
6777 .next
6778 .cindex "lookup" "dbmnz"
6779 .cindex "lookup" "dbm &-- terminating zero"
6780 .cindex "binary zero" "in lookup key"
6781 .cindex "Courier"
6782 .cindex "&_/etc/userdbshadow.dat_&"
6783 .cindex "dbmnz lookup type"
6784 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6785 is not included in the key that is passed to the DBM library. You may need this
6786 if you want to look up data in files that are created by or shared with some
6787 other application that does not use terminating zeros. For example, you need to
6788 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6789 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6790 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6791 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6792 .next
6793 .cindex "lookup" "dsearch"
6794 .cindex "dsearch lookup type"
6795 &(dsearch)&: The given file must be an
6796 absolute
6797 directory path; this is searched for an entry
6798 whose name is the key by calling the &[lstat()]& function.
6799 The key may not
6800 contain any forward slash characters.
6801 If &[lstat()]& succeeds then so does the lookup.
6802 .cindex "tainted data" "dsearch result"
6803 The result is regarded as untainted.
6804
6805 Options for the lookup can be given by appending them after the word "dsearch",
6806 separated by a comma.  Options, if present, are a comma-separated list having
6807 each element starting with a tag name and an equals.
6808
6809 Two options are supported, for the return value and for filtering match
6810 candidates.
6811 The "ret" option requests an alternate result value of
6812 the entire path for the entry. Example:
6813 .code
6814 ${lookup {passwd} dsearch,ret=full {/etc}}
6815 .endd
6816 The default result is just the requested entry.
6817 The "filter" option requests that only directory entries of a given type
6818 are matched. The match value is one of "file", "dir" or "subdir" (the latter
6819 not matching "." or ".."). Example:
6820 .code
6821 ${lookup {passwd} dsearch,filter=file {/etc}}
6822 .endd
6823 The default matching is for any entry type, including directories
6824 and symlinks.
6825
6826 An example of how this
6827 lookup can be used to support virtual domains is given in section
6828 &<<SECTvirtualdomains>>&.
6829 .next
6830 .cindex "lookup" "iplsearch"
6831 .cindex "iplsearch lookup type"
6832 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6833 terminated by a colon or white space or the end of the line. The keys in the
6834 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6835 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6836 being interpreted as a key terminator. For example:
6837 .code
6838 1.2.3.4:           data for 1.2.3.4
6839 192.168.0.0/16:    data for 192.168.0.0/16
6840 "abcd::cdab":      data for abcd::cdab
6841 "abcd:abcd::/32"   data for abcd:abcd::/32
6842 .endd
6843 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6844 file is searched linearly, using the CIDR masks where present, until a matching
6845 key is found. The first key that matches is used; there is no attempt to find a
6846 &"best"& match. Apart from the way the keys are matched, the processing for
6847 &(iplsearch)& is the same as for &(lsearch)&.
6848
6849 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6850 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6851 lookup types support only literal keys.
6852
6853 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6854 the implicit key is the host's IP address rather than its name (see section
6855 &<<SECThoslispatsikey>>&).
6856
6857 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6858 IPv4, in dotted-quad form. (Exim converts IPv4-mapped IPv6 addresses to this
6859 notation before executing the lookup.)
6860 .next
6861 .cindex lookup json
6862 .cindex json "lookup type"
6863 .cindex JSON expansions
6864 &(json)&: The given file is a text file with a JSON structure.
6865 An element of the structure is extracted, defined by the search key.
6866 The key is a list of subelement selectors
6867 (colon-separated by default but changeable in the usual way)
6868 which are applied in turn to select smaller and smaller portions
6869 of the JSON structure.
6870 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6871 nunbered array element is selected.
6872 Otherwise it must apply to a JSON object; the named element is selected.
6873 The final resulting element can be a simple JSON type or a JSON object
6874 or array; for the latter two a string-representation of the JSON
6875 is returned.
6876 For elements of type string, the returned value is de-quoted.
6877
6878
6879 .new
6880 .next
6881 .cindex LMDB
6882 .cindex lookup lmdb
6883 .cindex database lmdb
6884 &(lmdb)&: The given file is an LMDB database.
6885 LMDB is a memory-mapped key-value store,
6886 with API modeled loosely on that of BerkeleyDB.
6887 See &url(https://symas.com/products/lightning-memory-mapped-database/)
6888 for the feature set and operation modes.
6889
6890 Exim provides read-only access via the LMDB C library.
6891 The library can be obtained from &url(https://github.com/LMDB/lmdb)
6892 or your operating system package repository.
6893 To enable LMDB support in Exim set LOOKUP_LMDB=yes in &_Local/Makefile_&.
6894
6895 You will need to separately create the LMDB database file,
6896 possibly using the &"mdb_load"& utility.
6897 .wen
6898
6899
6900 .next
6901 .cindex "linear search"
6902 .cindex "lookup" "lsearch"
6903 .cindex "lsearch lookup type"
6904 .cindex "case sensitivity" "in lsearch lookup"
6905 &(lsearch)&: The given file is a text file that is searched linearly for a
6906 line beginning with the search key, terminated by a colon or white space or the
6907 end of the line. The search is case-insensitive; that is, upper and lower case
6908 letters are treated as the same. The first occurrence of the key that is found
6909 in the file is used.
6910
6911 White space between the key and the colon is permitted. The remainder of the
6912 line, with leading and trailing white space removed, is the data. This can be
6913 continued onto subsequent lines by starting them with any amount of white
6914 space, but only a single space character is included in the data at such a
6915 junction. If the data begins with a colon, the key must be terminated by a
6916 colon, for example:
6917 .code
6918 baduser:  :fail:
6919 .endd
6920 Empty lines and lines beginning with # are ignored, even if they occur in the
6921 middle of an item. This is the traditional textual format of alias files. Note
6922 that the keys in an &(lsearch)& file are literal strings. There is no
6923 wildcarding of any kind.
6924
6925 .cindex "lookup" "lsearch &-- colons in keys"
6926 .cindex "white space" "in lsearch key"
6927 In most &(lsearch)& files, keys are not required to contain colons or #
6928 characters, or white space. However, if you need this feature, it is available.
6929 If a key begins with a doublequote character, it is terminated only by a
6930 matching quote (or end of line), and the normal escaping rules apply to its
6931 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6932 quoted keys (exactly as for unquoted keys). There is no special handling of
6933 quotes for the data part of an &(lsearch)& line.
6934
6935 .next
6936 .cindex "NIS lookup type"
6937 .cindex "lookup" "NIS"
6938 .cindex "binary zero" "in lookup key"
6939 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6940 the given key, without a terminating binary zero. There is a variant called
6941 &(nis0)& which does include the terminating binary zero in the key. This is
6942 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6943 aliases; the full map names must be used.
6944
6945 .next
6946 .cindex "wildlsearch lookup type"
6947 .cindex "lookup" "wildlsearch"
6948 .cindex "nwildlsearch lookup type"
6949 .cindex "lookup" "nwildlsearch"
6950 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6951 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6952 the file may be wildcarded. The difference between these two lookup types is
6953 that for &(wildlsearch)&, each key in the file is string-expanded before being
6954 used, whereas for &(nwildlsearch)&, no expansion takes place.
6955
6956 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6957 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6958 file that are regular expressions can be made case-sensitive by the use of
6959 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6960
6961 . ==== As this is a nested list, any displays it contains must be indented
6962 . ==== as otherwise they are too far to the left.
6963
6964 .olist
6965 The string may begin with an asterisk to mean &"ends with"&. For example:
6966 .code
6967     *.a.b.c       data for anything.a.b.c
6968     *fish         data for anythingfish
6969 .endd
6970 .next
6971 The string may begin with a circumflex to indicate a regular expression. For
6972 example, for &(wildlsearch)&:
6973 .code
6974     ^\N\d+\.a\.b\N    data for <digits>.a.b
6975 .endd
6976 Note the use of &`\N`& to disable expansion of the contents of the regular
6977 expression. If you are using &(nwildlsearch)&, where the keys are not
6978 string-expanded, the equivalent entry is:
6979 .code
6980     ^\d+\.a\.b        data for <digits>.a.b
6981 .endd
6982 The case-insensitive flag is set at the start of compiling the regular
6983 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6984 For example, to make the entire pattern case-sensitive:
6985 .code
6986     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6987 .endd
6988
6989 If the regular expression contains white space or colon characters, you must
6990 either quote it (see &(lsearch)& above), or represent these characters in other
6991 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6992 colon. This may be easier than quoting, because if you quote, you have to
6993 escape all the backslashes inside the quotes.
6994
6995 &*Note*&: It is not possible to capture substrings in a regular expression
6996 match for later use, because the results of all lookups are cached. If a lookup
6997 is repeated, the result is taken from the cache, and no actual pattern matching
6998 takes place. The values of all the numeric variables are unset after a
6999 &((n)wildlsearch)& match.
7000
7001 .next
7002 Although I cannot see it being of much use, the general matching function that
7003 is used to implement &((n)wildlsearch)& means that the string may begin with a
7004 lookup name terminated by a semicolon, and followed by lookup data. For
7005 example:
7006 .code
7007     cdb;/some/file  data for keys that match the file
7008 .endd
7009 The data that is obtained from the nested lookup is discarded.
7010 .endlist olist
7011
7012 Keys that do not match any of these patterns are interpreted literally. The
7013 continuation rules for the data are the same as for &(lsearch)&, and keys may
7014 be followed by optional colons.
7015
7016 &*Warning*&: Unlike most other single-key lookup types, a file of data for
7017 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
7018 lookup types support only literal keys.
7019
7020 .next
7021 .cindex "spf lookup type"
7022 .cindex "lookup" "spf"
7023 &(spf)&: If Exim is built with SPF support, manual lookups can be done
7024 (as opposed to the standard ACL condition method).
7025 For details see section &<<SECSPF>>&.
7026 .endlist ilist
7027
7028
7029 .section "Query-style lookup types" "SECTquerystylelookups"
7030 .cindex "lookup" "query-style types"
7031 .cindex "query-style lookup" "list of types"
7032 The supported query-style lookup types are listed below. Further details about
7033 many of them are given in later sections.
7034
7035 .ilist
7036 .cindex "DNS" "as a lookup type"
7037 .cindex "lookup" "DNS"
7038 &(dnsdb)&: This does a DNS search for one or more records whose domain names
7039 are given in the supplied query. The resulting data is the contents of the
7040 records. See section &<<SECTdnsdb>>&.
7041 .next
7042 .cindex "InterBase lookup type"
7043 .cindex "lookup" "InterBase"
7044 &(ibase)&: This does a lookup in an InterBase database.
7045 .next
7046 .cindex "LDAP" "lookup type"
7047 .cindex "lookup" "LDAP"
7048 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
7049 returns attributes from a single entry. There is a variant called &(ldapm)&
7050 that permits values from multiple entries to be returned. A third variant
7051 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
7052 any attribute values. See section &<<SECTldap>>&.
7053 .next
7054 .cindex "MySQL" "lookup type"
7055 .cindex "lookup" "MySQL"
7056 &(mysql)&: The format of the query is an SQL statement that is passed to a
7057 MySQL database. See section &<<SECTsql>>&.
7058 .next
7059 .cindex "NIS+ lookup type"
7060 .cindex "lookup" "NIS+"
7061 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
7062 the field to be returned. See section &<<SECTnisplus>>&.
7063 .next
7064 .cindex "Oracle" "lookup type"
7065 .cindex "lookup" "Oracle"
7066 &(oracle)&: The format of the query is an SQL statement that is passed to an
7067 Oracle database. See section &<<SECTsql>>&.
7068 .next
7069 .cindex "lookup" "passwd"
7070 .cindex "passwd lookup type"
7071 .cindex "&_/etc/passwd_&"
7072 &(passwd)& is a query-style lookup with queries that are just user names. The
7073 lookup calls &[getpwnam()]& to interrogate the system password data, and on
7074 success, the result string is the same as you would get from an &(lsearch)&
7075 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
7076 password value. For example:
7077 .code
7078 *:42:42:King Rat:/home/kr:/bin/bash
7079 .endd
7080 .next
7081 .cindex "PostgreSQL lookup type"
7082 .cindex "lookup" "PostgreSQL"
7083 &(pgsql)&: The format of the query is an SQL statement that is passed to a
7084 PostgreSQL database. See section &<<SECTsql>>&.
7085
7086 .next
7087 .cindex "Redis lookup type"
7088 .cindex lookup Redis
7089 &(redis)&: The format of the query is either a simple get or simple set,
7090 passed to a Redis database. See section &<<SECTsql>>&.
7091
7092 .next
7093 .cindex "sqlite lookup type"
7094 .cindex "lookup" "sqlite"
7095 &(sqlite)&: The format of the query is
7096 new
7097 an optional filename
7098 followed by an SQL statement
7099 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
7100
7101 .next
7102 &(testdb)&: This is a lookup type that is used for testing Exim. It is
7103 not likely to be useful in normal operation.
7104 .next
7105 .cindex "whoson lookup type"
7106 .cindex "lookup" "whoson"
7107 . --- still http:-only, 2018-09-07
7108 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
7109 allows a server to check whether a particular (dynamically allocated) IP
7110 address is currently allocated to a known (trusted) user and, optionally, to
7111 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
7112 at one time for &"POP before SMTP"& authentication, but that approach has been
7113 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
7114 &"POP before SMTP"& checking using ACL statements such as
7115 .code
7116 require condition = \
7117   ${lookup whoson {$sender_host_address}{yes}{no}}
7118 .endd
7119 The query consists of a single IP address. The value returned is the name of
7120 the authenticated user, which is stored in the variable &$value$&. However, in
7121 this example, the data in &$value$& is not used; the result of the lookup is
7122 one of the fixed strings &"yes"& or &"no"&.
7123 .endlist
7124
7125
7126
7127 .section "Temporary errors in lookups" "SECID63"
7128 .cindex "lookup" "temporary error in"
7129 Lookup functions can return temporary error codes if the lookup cannot be
7130 completed. For example, an SQL or LDAP database might be unavailable. For this
7131 reason, it is not advisable to use a lookup that might do this for critical
7132 options such as a list of local domains.
7133
7134 When a lookup cannot be completed in a router or transport, delivery
7135 of the message (to the relevant address) is deferred, as for any other
7136 temporary error. In other circumstances Exim may assume the lookup has failed,
7137 or may give up altogether.
7138
7139
7140
7141 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7142 .cindex "wildcard lookups"
7143 .cindex "lookup" "default values"
7144 .cindex "lookup" "wildcard"
7145 .cindex "lookup" "* added to type"
7146 .cindex "default" "in single-key lookups"
7147 In this context, a &"default value"& is a value specified by the administrator
7148 that is to be used if a lookup fails.
7149
7150 &*Note:*& This section applies only to single-key lookups. For query-style
7151 lookups, the facilities of the query language must be used. An attempt to
7152 specify a default for a query-style lookup provokes an error.
7153
7154 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7155 and the initial lookup fails, the key &"*"& is looked up in the file to
7156 provide a default value. See also the section on partial matching below.
7157
7158 .cindex "*@ with single-key lookup"
7159 .cindex "lookup" "*@ added to type"
7160 .cindex "alias file" "per-domain default"
7161 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7162 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7163 character, a second lookup is done with everything before the last @ replaced
7164 by *. This makes it possible to provide per-domain defaults in alias files
7165 that include the domains in the keys. If the second lookup fails (or doesn't
7166 take place because there is no @ in the key), &"*"& is looked up.
7167 For example, a &(redirect)& router might contain:
7168 .code
7169 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7170 .endd
7171 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7172 looks up these keys, in this order:
7173 .code
7174 jane@eyre.example
7175 *@eyre.example
7176 *
7177 .endd
7178 The data is taken from whichever key it finds first. &*Note*&: In an
7179 &(lsearch)& file, this does not mean the first of these keys in the file. A
7180 complete scan is done for each key, and only if it is not found at all does
7181 Exim move on to try the next key.
7182
7183
7184
7185 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7186 .cindex "partial matching"
7187 .cindex "wildcard lookups"
7188 .cindex "lookup" "partial matching"
7189 .cindex "lookup" "wildcard"
7190 .cindex "asterisk" "in search type"
7191 The normal operation of a single-key lookup is to search the file for an exact
7192 match with the given key. However, in a number of situations where domains are
7193 being looked up, it is useful to be able to do partial matching. In this case,
7194 information in the file that has a key starting with &"*."& is matched by any
7195 domain that ends with the components that follow the full stop. For example, if
7196 a key in a DBM file is
7197 .code
7198 *.dates.fict.example
7199 .endd
7200 then when partial matching is enabled this is matched by (amongst others)
7201 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7202 by &'dates.fict.example'&, if that does not appear as a separate key in the
7203 file.
7204
7205 &*Note*&: Partial matching is not available for query-style lookups. It is
7206 also not available for any lookup items in address lists (see section
7207 &<<SECTaddresslist>>&).
7208
7209 Partial matching is implemented by doing a series of separate lookups using
7210 keys constructed by modifying the original subject key. This means that it can
7211 be used with any of the single-key lookup types, provided that
7212 partial matching keys
7213 beginning with a special prefix (default &"*."&) are included in the data file.
7214 Keys in the file that do not begin with the prefix are matched only by
7215 unmodified subject keys when partial matching is in use.
7216
7217 Partial matching is requested by adding the string &"partial-"& to the front of
7218 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7219 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7220 is added at the start of the subject key, and it is looked up again. If that
7221 fails, further lookups are tried with dot-separated components removed from the
7222 start of the subject key, one-by-one, and &"*."& added on the front of what
7223 remains.
7224
7225 A minimum number of two non-* components are required. This can be adjusted
7226 by including a number before the hyphen in the search type. For example,
7227 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7228 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7229 subject key is &'2250.dates.fict.example'& then the following keys are looked
7230 up when the minimum number of non-* components is two:
7231 .code
7232 2250.dates.fict.example
7233 *.2250.dates.fict.example
7234 *.dates.fict.example
7235 *.fict.example
7236 .endd
7237 As soon as one key in the sequence is successfully looked up, the lookup
7238 finishes.
7239
7240 .cindex "lookup" "partial matching &-- changing prefix"
7241 .cindex "prefix" "for partial matching"
7242 The use of &"*."& as the partial matching prefix is a default that can be
7243 changed. The motivation for this feature is to allow Exim to operate with file
7244 formats that are used by other MTAs. A different prefix can be supplied in
7245 parentheses instead of the hyphen after &"partial"&. For example:
7246 .code
7247 domains = partial(.)lsearch;/some/file
7248 .endd
7249 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7250 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7251 components is unchanged). The prefix may consist of any punctuation characters
7252 other than a closing parenthesis. It may be empty, for example:
7253 .code
7254 domains = partial1()cdb;/some/file
7255 .endd
7256 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7257 &`a.b.c`&, &`b.c`&, and &`c`&.
7258
7259 If &"partial0"& is specified, what happens at the end (when the lookup with
7260 just one non-wild component has failed, and the original key is shortened right
7261 down to the null string) depends on the prefix:
7262
7263 .ilist
7264 If the prefix has zero length, the whole lookup fails.
7265 .next
7266 If the prefix has length 1, a lookup for just the prefix is done. For
7267 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7268 .next
7269 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7270 remainder is looked up. With the default prefix, therefore, the final lookup is
7271 for &"*"& on its own.
7272 .next
7273 Otherwise, the whole prefix is looked up.
7274 .endlist
7275
7276
7277 If the search type ends in &"*"& or &"*@"& (see section
7278 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7279 this implies happens after all partial lookups have failed. If &"partial0"& is
7280 specified, adding &"*"& to the search type has no effect with the default
7281 prefix, because the &"*"& key is already included in the sequence of partial
7282 lookups. However, there might be a use for lookup types such as
7283 &"partial0(.)lsearch*"&.
7284
7285 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7286 in domain lists and the like. Partial matching works only in terms of
7287 dot-separated components; a key such as &`*fict.example`&
7288 in a database file is useless, because the asterisk in a partial matching
7289 subject key is always followed by a dot.
7290
7291
7292
7293
7294 .section "Lookup caching" "SECID64"
7295 .cindex "lookup" "caching"
7296 .cindex "caching" "lookup data"
7297 Exim caches all lookup results in order to avoid needless repetition of
7298 lookups. However, because (apart from the daemon) Exim operates as a collection
7299 of independent, short-lived processes, this caching applies only within a
7300 single Exim process. There is no inter-process lookup caching facility.
7301
7302 For single-key lookups, Exim keeps the relevant files open in case there is
7303 another lookup that needs them. In some types of configuration this can lead to
7304 many files being kept open for messages with many recipients. To avoid hitting
7305 the operating system limit on the number of simultaneously open files, Exim
7306 closes the least recently used file when it needs to open more files than its
7307 own internal limit, which can be changed via the &%lookup_open_max%& option.
7308
7309 The single-key lookup files are closed and the lookup caches are flushed at
7310 strategic points during delivery &-- for example, after all routing is
7311 complete.
7312
7313
7314
7315
7316 .section "Quoting lookup data" "SECID65"
7317 .cindex "lookup" "quoting"
7318 .cindex "quoting" "in lookups"
7319 When data from an incoming message is included in a query-style lookup, there
7320 is the possibility of special characters in the data messing up the syntax of
7321 the query. For example, a NIS+ query that contains
7322 .code
7323 [name=$local_part]
7324 .endd
7325 will be broken if the local part happens to contain a closing square bracket.
7326 For NIS+, data can be enclosed in double quotes like this:
7327 .code
7328 [name="$local_part"]
7329 .endd
7330 but this still leaves the problem of a double quote in the data. The rule for
7331 NIS+ is that double quotes must be doubled. Other lookup types have different
7332 rules, and to cope with the differing requirements, an expansion operator
7333 of the following form is provided:
7334 .code
7335 ${quote_<lookup-type>:<string>}
7336 .endd
7337 For example, the safest way to write the NIS+ query is
7338 .code
7339 [name="${quote_nisplus:$local_part}"]
7340 .endd
7341 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7342 operator can be used for all lookup types, but has no effect for single-key
7343 lookups, since no quoting is ever needed in their key strings.
7344
7345
7346
7347
7348 .section "More about dnsdb" "SECTdnsdb"
7349 .cindex "dnsdb lookup"
7350 .cindex "lookup" "dnsdb"
7351 .cindex "DNS" "as a lookup type"
7352 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7353 of a record type and a domain name, separated by an equals sign. For example,
7354 an expansion string could contain:
7355 .code
7356 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7357 .endd
7358 If the lookup succeeds, the result is placed in &$value$&, which in this case
7359 is used on its own as the result. If the lookup does not succeed, the
7360 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7361 &<<SECTforexpfai>>& for an explanation of what this means.
7362
7363 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7364 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7365 If no type is given, TXT is assumed.
7366
7367 For any record type, if multiple records are found, the data is returned as a
7368 concatenation, with newline as the default separator. The order, of course,
7369 depends on the DNS resolver. You can specify a different separator character
7370 between multiple records by putting a right angle-bracket followed immediately
7371 by the new separator at the start of the query. For example:
7372 .code
7373 ${lookup dnsdb{>: a=host1.example}}
7374 .endd
7375 It is permitted to specify a space as the separator character. Further
7376 white space is ignored.
7377 For lookup types that return multiple fields per record,
7378 an alternate field separator can be specified using a comma after the main
7379 separator character, followed immediately by the field separator.
7380
7381 .cindex "PTR record" "in &(dnsdb)& lookup"
7382 When the type is PTR,
7383 the data can be an IP address, written as normal; inversion and the addition of
7384 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7385 .code
7386 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7387 .endd
7388 If the data for a PTR record is not a syntactically valid IP address, it is not
7389 altered and nothing is added.
7390
7391 .cindex "MX record" "in &(dnsdb)& lookup"
7392 .cindex "SRV record" "in &(dnsdb)& lookup"
7393 For an MX lookup, both the preference value and the host name are returned for
7394 each record, separated by a space. For an SRV lookup, the priority, weight,
7395 port, and host name are returned for each record, separated by spaces.
7396 The field separator can be modified as above.
7397
7398 .cindex "TXT record" "in &(dnsdb)& lookup"
7399 .cindex "SPF record" "in &(dnsdb)& lookup"
7400 For TXT records with multiple items of data, only the first item is returned,
7401 unless a field separator is specified.
7402 To concatenate items without a separator, use a semicolon instead.
7403 For SPF records the
7404 default behaviour is to concatenate multiple items without using a separator.
7405 .code
7406 ${lookup dnsdb{>\n,: txt=a.b.example}}
7407 ${lookup dnsdb{>\n; txt=a.b.example}}
7408 ${lookup dnsdb{spf=example.org}}
7409 .endd
7410 It is permitted to specify a space as the separator character. Further
7411 white space is ignored.
7412
7413 .cindex "SOA record" "in &(dnsdb)& lookup"
7414 For an SOA lookup, while no result is obtained the lookup is redone with
7415 successively more leading components dropped from the given domain.
7416 Only the primary-nameserver field is returned unless a field separator is
7417 specified.
7418 .code
7419 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7420 .endd
7421
7422 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7423 .cindex "dnsdb modifiers"
7424 .cindex "modifiers" "dnsdb"
7425 .cindex "options" "dnsdb"
7426 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7427 each followed by a comma,
7428 that may appear before the record type.
7429
7430 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7431 temporary DNS error for any of them, the behaviour is controlled by
7432 a defer-option modifier.
7433 The possible keywords are
7434 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7435 With &"strict"& behaviour, any temporary DNS error causes the
7436 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7437 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7438 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7439 error causes the whole lookup to defer only if none of the other lookups
7440 succeed. The default is &"lax"&, so the following lookups are equivalent:
7441 .code
7442 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7443 ${lookup dnsdb{a=one.host.com:two.host.com}}
7444 .endd
7445 Thus, in the default case, as long as at least one of the DNS lookups
7446 yields some data, the lookup succeeds.
7447
7448 .cindex "DNSSEC" "dns lookup"
7449 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7450 The possible keywords are
7451 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7452 With &"strict"& or &"lax"& DNSSEC information is requested
7453 with the lookup.
7454 With &"strict"& a response from the DNS resolver that
7455 is not labelled as authenticated data
7456 is treated as equivalent to a temporary DNS error.
7457 The default is &"lax"&.
7458
7459 See also the &$lookup_dnssec_authenticated$& variable.
7460
7461 .cindex timeout "dns lookup"
7462 .cindex "DNS" timeout
7463 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7464 The form is &"retrans_VAL"& where VAL is an Exim time specification
7465 (e.g. &"5s"&).
7466 The default value is set by the main configuration option &%dns_retrans%&.
7467
7468 Retries for the dnsdb lookup can be controlled by a retry modifier.
7469 The form if &"retry_VAL"& where VAL is an integer.
7470 The default count is set by the main configuration option &%dns_retry%&.
7471
7472 .cindex caching "of dns lookup"
7473 .cindex TTL "of dns lookup"
7474 .cindex DNS TTL
7475 Dnsdb lookup results are cached within a single process (and its children).
7476 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7477 value of the set of returned DNS records.
7478
7479
7480 .section "Pseudo dnsdb record types" "SECID66"
7481 .cindex "MX record" "in &(dnsdb)& lookup"
7482 By default, both the preference value and the host name are returned for
7483 each MX record, separated by a space. If you want only host names, you can use
7484 the pseudo-type MXH:
7485 .code
7486 ${lookup dnsdb{mxh=a.b.example}}
7487 .endd
7488 In this case, the preference values are omitted, and just the host names are
7489 returned.
7490
7491 .cindex "name server for enclosing domain"
7492 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7493 records on the given domain, but if none are found, it removes the first
7494 component of the domain name, and tries again. This process continues until NS
7495 records are found or there are no more components left (or there is a DNS
7496 error). In other words, it may return the name servers for a top-level domain,
7497 but it never returns the root name servers. If there are no NS records for the
7498 top-level domain, the lookup fails. Consider these examples:
7499 .code
7500 ${lookup dnsdb{zns=xxx.quercite.com}}
7501 ${lookup dnsdb{zns=xxx.edu}}
7502 .endd
7503 Assuming that in each case there are no NS records for the full domain name,
7504 the first returns the name servers for &%quercite.com%&, and the second returns
7505 the name servers for &%edu%&.
7506
7507 You should be careful about how you use this lookup because, unless the
7508 top-level domain does not exist, the lookup always returns some host names. The
7509 sort of use to which this might be put is for seeing if the name servers for a
7510 given domain are on a blacklist. You can probably assume that the name servers
7511 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7512 such a list.
7513
7514 .cindex "CSA" "in &(dnsdb)& lookup"
7515 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7516 records according to the CSA rules, which are described in section
7517 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7518 not sufficient because of the extra parent domain search behaviour of CSA. The
7519 result of a successful lookup such as:
7520 .code
7521 ${lookup dnsdb {csa=$sender_helo_name}}
7522 .endd
7523 has two space-separated fields: an authorization code and a target host name.
7524 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7525 authorization required but absent, or &"?"& for unknown.
7526
7527 .cindex "A+" "in &(dnsdb)& lookup"
7528 The pseudo-type A+ performs an AAAA
7529 and then an A lookup.  All results are returned; defer processing
7530 (see below) is handled separately for each lookup.  Example:
7531 .code
7532 ${lookup dnsdb {>; a+=$sender_helo_name}}
7533 .endd
7534
7535
7536 .section "Multiple dnsdb lookups" "SECID67"
7537 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7538 However, you can specify a list of domains or IP addresses in a single
7539 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7540 the default separator, but with the ability to change this. For example:
7541 .code
7542 ${lookup dnsdb{one.domain.com:two.domain.com}}
7543 ${lookup dnsdb{a=one.host.com:two.host.com}}
7544 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7545 .endd
7546 In order to retain backwards compatibility, there is one special case: if
7547 the lookup type is PTR and no change of separator is specified, Exim looks
7548 to see if the rest of the string is precisely one IPv6 address. In this
7549 case, it does not treat it as a list.
7550
7551 The data from each lookup is concatenated, with newline separators by default,
7552 in the same way that multiple DNS records for a single item are handled. A
7553 different separator can be specified, as described above.
7554
7555
7556
7557
7558 .section "More about LDAP" "SECTldap"
7559 .cindex "LDAP" "lookup, more about"
7560 .cindex "lookup" "LDAP"
7561 .cindex "Solaris" "LDAP"
7562 The original LDAP implementation came from the University of Michigan; this has
7563 become &"Open LDAP"&, and there are now two different releases. Another
7564 implementation comes from Netscape, and Solaris 7 and subsequent releases
7565 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7566 the lookup function level, their error handling is different. For this reason
7567 it is necessary to set a compile-time variable when building Exim with LDAP, to
7568 indicate which LDAP library is in use. One of the following should appear in
7569 your &_Local/Makefile_&:
7570 .code
7571 LDAP_LIB_TYPE=UMICHIGAN
7572 LDAP_LIB_TYPE=OPENLDAP1
7573 LDAP_LIB_TYPE=OPENLDAP2
7574 LDAP_LIB_TYPE=NETSCAPE
7575 LDAP_LIB_TYPE=SOLARIS
7576 .endd
7577 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7578 same interface as the University of Michigan version.
7579
7580 There are three LDAP lookup types in Exim. These behave slightly differently in
7581 the way they handle the results of a query:
7582
7583 .ilist
7584 &(ldap)& requires the result to contain just one entry; if there are more, it
7585 gives an error.
7586 .next
7587 &(ldapdn)& also requires the result to contain just one entry, but it is the
7588 Distinguished Name that is returned rather than any attribute values.
7589 .next
7590 &(ldapm)& permits the result to contain more than one entry; the attributes
7591 from all of them are returned.
7592 .endlist
7593
7594
7595 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7596 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7597 the data returned by a successful lookup is described in the next section.
7598 First we explain how LDAP queries are coded.
7599
7600
7601 .section "Format of LDAP queries" "SECTforldaque"
7602 .cindex "LDAP" "query format"
7603 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7604 the configuration of a &(redirect)& router one might have this setting:
7605 .code
7606 data = ${lookup ldap \
7607   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7608   c=UK?mailbox?base?}}
7609 .endd
7610 .cindex "LDAP" "with TLS"
7611 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7612 secure (encrypted) LDAP connections. The second of these ensures that an
7613 encrypted TLS connection is used.
7614
7615 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7616 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7617 See the &%ldap_start_tls%& option.
7618
7619 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7620 controlled. Every part of the TLS configuration can be configured by settings in
7621 &_exim.conf_&. Depending on the version of the client libraries installed on
7622 your system, some of the initialization may have required setting options in
7623 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7624 certificates. This revealed a nuance where the current UID that exim was
7625 running as could affect which config files it read. With Exim 4.83, these
7626 methods become optional, only taking effect if not specifically set in
7627 &_exim.conf_&.
7628
7629
7630 .section "LDAP quoting" "SECID68"
7631 .cindex "LDAP" "quoting"
7632 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7633 and the second because the LDAP query is represented as a URL. Furthermore,
7634 within an LDAP query, two different kinds of quoting are required. For this
7635 reason, there are two different LDAP-specific quoting operators.
7636
7637 The &%quote_ldap%& operator is designed for use on strings that are part of
7638 filter specifications. Conceptually, it first does the following conversions on
7639 the string:
7640 .code
7641 *   =>   \2A
7642 (   =>   \28
7643 )   =>   \29
7644 \   =>   \5C
7645 .endd
7646 in accordance with RFC 2254. The resulting string is then quoted according
7647 to the rules for URLs, that is, all non-alphanumeric characters except
7648 .code
7649 ! $ ' - . _ ( ) * +
7650 .endd
7651 are converted to their hex values, preceded by a percent sign. For example:
7652 .code
7653 ${quote_ldap: a(bc)*, a<yz>; }
7654 .endd
7655 yields
7656 .code
7657 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7658 .endd
7659 Removing the URL quoting, this is (with a leading and a trailing space):
7660 .code
7661 a\28bc\29\2A, a<yz>;
7662 .endd
7663 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7664 base DN specifications in queries. Conceptually, it first converts the string
7665 by inserting a backslash in front of any of the following characters:
7666 .code
7667 , + " \ < > ;
7668 .endd
7669 It also inserts a backslash before any leading spaces or # characters, and
7670 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7671 is then quoted according to the rules for URLs. For example:
7672 .code
7673 ${quote_ldap_dn: a(bc)*, a<yz>; }
7674 .endd
7675 yields
7676 .code
7677 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7678 .endd
7679 Removing the URL quoting, this is (with a trailing space):
7680 .code
7681 \ a(bc)*\, a\<yz\>\;\
7682 .endd
7683 There are some further comments about quoting in the section on LDAP
7684 authentication below.
7685
7686
7687 .section "LDAP connections" "SECID69"
7688 .cindex "LDAP" "connections"
7689 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7690 is in use, via a Unix domain socket. The example given above does not specify
7691 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7692 by starting it with
7693 .code
7694 ldap://<hostname>:<port>/...
7695 .endd
7696 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7697 used. When no server is specified in a query, a list of default servers is
7698 taken from the &%ldap_default_servers%& configuration option. This supplies a
7699 colon-separated list of servers which are tried in turn until one successfully
7700 handles a query, or there is a serious error. Successful handling either
7701 returns the requested data, or indicates that it does not exist. Serious errors
7702 are syntactical, or multiple values when only a single value is expected.
7703 Errors which cause the next server to be tried are connection failures, bind
7704 failures, and timeouts.
7705
7706 For each server name in the list, a port number can be given. The standard way
7707 of specifying a host and port is to use a colon separator (RFC 1738). Because
7708 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7709 doubled. For example
7710 .code
7711 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7712 .endd
7713 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7714 to the LDAP library with no server name, and the library's default (normally
7715 the local host) is used.
7716
7717 If you are using the OpenLDAP library, you can connect to an LDAP server using
7718 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7719 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7720 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7721 not available.
7722
7723 For this type of connection, instead of a host name for the server, a pathname
7724 for the socket is required, and the port number is not relevant. The pathname
7725 can be specified either as an item in &%ldap_default_servers%&, or inline in
7726 the query. In the former case, you can have settings such as
7727 .code
7728 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7729 .endd
7730 When the pathname is given in the query, you have to escape the slashes as
7731 &`%2F`& to fit in with the LDAP URL syntax. For example:
7732 .code
7733 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7734 .endd
7735 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7736 a pathname, it uses the Unix domain socket code, even if the query actually
7737 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7738 socket connection. This behaviour means that you can use a setting of
7739 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7740 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7741 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7742 backup host.
7743
7744 If an explicit &`ldapi`& type is given in a query when a host name is
7745 specified, an error is diagnosed. However, if there are more items in
7746 &%ldap_default_servers%&, they are tried. In other words:
7747
7748 .ilist
7749 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7750 interface.
7751 .next
7752 Using &`ldapi`& with a host name causes an error.
7753 .endlist
7754
7755
7756 Using &`ldapi`& with no host or path in the query, and no setting of
7757 &%ldap_default_servers%&, does whatever the library does by default.
7758
7759
7760
7761 .section "LDAP authentication and control information" "SECID70"
7762 .cindex "LDAP" "authentication"
7763 The LDAP URL syntax provides no way of passing authentication and other control
7764 information to the server. To make this possible, the URL in an LDAP query may
7765 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7766 spaces. If a value contains spaces it must be enclosed in double quotes, and
7767 when double quotes are used, backslash is interpreted in the usual way inside
7768 them. The following names are recognized:
7769 .display
7770 &`DEREFERENCE`&  set the dereferencing parameter
7771 &`NETTIME    `&  set a timeout for a network operation
7772 &`USER       `&  set the DN, for authenticating the LDAP bind
7773 &`PASS       `&  set the password, likewise
7774 &`REFERRALS  `&  set the referrals parameter
7775 &`SERVERS    `&  set alternate server list for this query only
7776 &`SIZE       `&  set the limit for the number of entries returned
7777 &`TIME       `&  set the maximum waiting time for a query
7778 .endd
7779 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7780 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7781 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7782 library from trying to follow referrals issued by the LDAP server.
7783
7784 .cindex LDAP timeout
7785 .cindex timeout "LDAP lookup"
7786 The name CONNECT is an obsolete name for NETTIME, retained for
7787 backwards compatibility. This timeout (specified as a number of seconds) is
7788 enforced from the client end for operations that can be carried out over a
7789 network. Specifically, it applies to network connections and calls to the
7790 &'ldap_result()'& function. If the value is greater than zero, it is used if
7791 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7792 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7793 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7794 Netscape SDK; for OpenLDAP no action is taken.
7795
7796 The TIME parameter (also a number of seconds) is passed to the server to
7797 set a server-side limit on the time taken to complete a search.
7798
7799 The SERVERS parameter allows you to specify an alternate list of ldap servers
7800 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7801 default list of ldap servers, and a single lookup can specify a single ldap
7802 server to use.  But when you need to do a lookup with a list of servers that is
7803 different than the default list (maybe different order, maybe a completely
7804 different set of servers), the SERVERS parameter allows you to specify this
7805 alternate list (colon-separated).
7806
7807 Here is an example of an LDAP query in an Exim lookup that uses some of these
7808 values. This is a single line, folded to fit on the page:
7809 .code
7810 ${lookup ldap
7811   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7812   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7813   {$value}fail}
7814 .endd
7815 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7816 any of the auxiliary data. Exim configuration settings that include lookups
7817 which contain password information should be preceded by &"hide"& to prevent
7818 non-admin users from using the &%-bP%& option to see their values.
7819
7820 The auxiliary data items may be given in any order. The default is no
7821 connection timeout (the system timeout is used), no user or password, no limit
7822 on the number of entries returned, and no time limit on queries.
7823
7824 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7825 removes any URL quoting that it may contain before passing it LDAP. Apparently
7826 some libraries do this for themselves, but some do not. Removing the URL
7827 quoting has two advantages:
7828
7829 .ilist
7830 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7831 DNs as with DNs inside actual queries.
7832 .next
7833 It permits spaces inside USER= DNs.
7834 .endlist
7835
7836 For example, a setting such as
7837 .code
7838 USER=cn=${quote_ldap_dn:$1}
7839 .endd
7840 should work even if &$1$& contains spaces.
7841
7842 Expanded data for the PASS= value should be quoted using the &%quote%&
7843 expansion operator, rather than the LDAP quote operators. The only reason this
7844 field needs quoting is to ensure that it conforms to the Exim syntax, which
7845 does not allow unquoted spaces. For example:
7846 .code
7847 PASS=${quote:$3}
7848 .endd
7849 The LDAP authentication mechanism can be used to check passwords as part of
7850 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7851 &<<CHAPexpand>>&.
7852
7853
7854
7855 .section "Format of data returned by LDAP" "SECID71"
7856 .cindex "LDAP" "returned data formats"
7857 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7858 as a sequence of values, for example
7859 .code
7860 cn=manager,o=University of Cambridge,c=UK
7861 .endd
7862 The &(ldap)& lookup type generates an error if more than one entry matches the
7863 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7864 the result between the data from different entries. It is possible for multiple
7865 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7866 you know that whatever values are returned all came from a single entry in the
7867 directory.
7868
7869 In the common case where you specify a single attribute in your LDAP query, the
7870 result is not quoted, and does not contain the attribute name. If the attribute
7871 has multiple values, they are separated by commas. Any comma that is
7872 part of an attribute's value is doubled.
7873
7874 If you specify multiple attributes, the result contains space-separated, quoted
7875 strings, each preceded by the attribute name and an equals sign. Within the
7876 quotes, the quote character, backslash, and newline are escaped with
7877 backslashes, and commas are used to separate multiple values for the attribute.
7878 Any commas in attribute values are doubled
7879 (permitting treatment of the values as a comma-separated list).
7880 Apart from the escaping, the string within quotes takes the same form as the
7881 output when a single attribute is requested. Specifying no attributes is the
7882 same as specifying all of an entry's attributes.
7883
7884 Here are some examples of the output format. The first line of each pair is an
7885 LDAP query, and the second is the data that is returned. The attribute called
7886 &%attr1%& has two values, one of them with an embedded comma, whereas
7887 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7888 (they have SUP &%attr%& in their schema definitions).
7889
7890 .code
7891 ldap:///o=base?attr1?sub?(uid=fred)
7892 value1.1,value1,,2
7893
7894 ldap:///o=base?attr2?sub?(uid=fred)
7895 value two
7896
7897 ldap:///o=base?attr?sub?(uid=fred)
7898 value1.1,value1,,2,value two
7899
7900 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7901 attr1="value1.1,value1,,2" attr2="value two"
7902
7903 ldap:///o=base??sub?(uid=fred)
7904 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7905 .endd
7906 You can
7907 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7908 results of LDAP lookups.
7909 The &%extract%& operator in string expansions can be used to pick out
7910 individual fields from data that consists of &'key'&=&'value'& pairs.
7911 The &%listextract%& operator should be used to pick out individual values
7912 of attributes, even when only a single value is expected.
7913 The doubling of embedded commas allows you to use the returned data as a
7914 comma separated list (using the "<," syntax for changing the input list separator).
7915
7916
7917
7918
7919 .section "More about NIS+" "SECTnisplus"
7920 .cindex "NIS+ lookup type"
7921 .cindex "lookup" "NIS+"
7922 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7923 and field name. If this is given, the result of a successful query is the
7924 contents of the named field; otherwise the result consists of a concatenation
7925 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7926 values containing spaces are quoted. For example, the query
7927 .code
7928 [name=mg1456],passwd.org_dir
7929 .endd
7930 might return the string
7931 .code
7932 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7933 home=/home/mg1456 shell=/bin/bash shadow=""
7934 .endd
7935 (split over two lines here to fit on the page), whereas
7936 .code
7937 [name=mg1456],passwd.org_dir:gcos
7938 .endd
7939 would just return
7940 .code
7941 Martin Guerre
7942 .endd
7943 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7944 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7945 operator is to double any quote characters within the text.
7946
7947
7948
7949 .section "SQL lookups" "SECTsql"
7950 .cindex "SQL lookup types"
7951 .cindex "MySQL" "lookup type"
7952 .cindex "PostgreSQL lookup type"
7953 .cindex "lookup" "MySQL"
7954 .cindex "lookup" "PostgreSQL"
7955 .cindex "Oracle" "lookup type"
7956 .cindex "lookup" "Oracle"
7957 .cindex "InterBase lookup type"
7958 .cindex "lookup" "InterBase"
7959 .cindex "Redis lookup type"
7960 .cindex lookup Redis
7961 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7962 and SQLite
7963 databases. Queries for these databases contain SQL statements, so an example
7964 might be
7965 .code
7966 ${lookup mysql{select mailbox from users where id='userx'}\
7967   {$value}fail}
7968 .endd
7969 If the result of the query contains more than one field, the data for each
7970 field in the row is returned, preceded by its name, so the result of
7971 .code
7972 ${lookup pgsql{select home,name from users where id='userx'}\
7973   {$value}}
7974 .endd
7975 might be
7976 .code
7977 home=/home/userx name="Mister X"
7978 .endd
7979 Empty values and values containing spaces are double quoted, with embedded
7980 quotes escaped by a backslash. If the result of the query contains just one
7981 field, the value is passed back verbatim, without a field name, for example:
7982 .code
7983 Mister X
7984 .endd
7985 If the result of the query yields more than one row, it is all concatenated,
7986 with a newline between the data for each row.
7987
7988
7989 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7990 .cindex "MySQL" "lookup type"
7991 .cindex "PostgreSQL lookup type"
7992 .cindex "lookup" "MySQL"
7993 .cindex "lookup" "PostgreSQL"
7994 .cindex "Oracle" "lookup type"
7995 .cindex "lookup" "Oracle"
7996 .cindex "InterBase lookup type"
7997 .cindex "lookup" "InterBase"
7998 .cindex "Redis lookup type"
7999 .cindex lookup Redis
8000 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
8001 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
8002 or &%redis_servers%&
8003 option (as appropriate) must be set to a colon-separated list of server
8004 information.
8005 .oindex &%mysql_servers%&
8006 .oindex &%pgsql_servers%&
8007 .oindex &%oracle_servers%&
8008 .oindex &%ibase_servers%&
8009 .oindex &%redis_servers%&
8010 (For MySQL and PostgreSQL, the global option need not be set if all
8011 queries contain their own server information &-- see section
8012 &<<SECTspeserque>>&.)
8013 For all but Redis
8014 each item in the list is a slash-separated list of four
8015 items: host name, database name, user name, and password. In the case of
8016 Oracle, the host name field is used for the &"service name"&, and the database
8017 name field is not used and should be empty. For example:
8018 .code
8019 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
8020 .endd
8021 Because password data is sensitive, you should always precede the setting with
8022 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
8023 option. Here is an example where two MySQL servers are listed:
8024 .code
8025 hide mysql_servers = localhost/users/root/secret:\
8026                      otherhost/users/root/othersecret
8027 .endd
8028 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
8029 because this is a colon-separated list, the colon has to be doubled. For each
8030 query, these parameter groups are tried in order until a connection is made and
8031 a query is successfully processed. The result of a query may be that no data is
8032 found, but that is still a successful query. In other words, the list of
8033 servers provides a backup facility, not a list of different places to look.
8034
8035 For Redis the global option need not be specified if all queries contain their
8036 own server information &-- see section &<<SECTspeserque>>&.
8037 If specified, the option must be set to a colon-separated list of server
8038 information.
8039 Each item in the list is a slash-separated list of three items:
8040 host, database number, and password.
8041 .olist
8042 The host is required and may be either an IPv4 address and optional
8043 port number (separated by a colon, which needs doubling due to the
8044 higher-level list), or a Unix socket pathname enclosed in parentheses
8045 .next
8046 The database number is optional; if present that number is selected in the backend
8047 .next
8048 The password is optional; if present it is used to authenticate to the backend
8049 .endlist
8050
8051 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
8052 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
8053 respectively, and the characters single-quote, double-quote, and backslash
8054 itself are escaped with backslashes.
8055
8056 The &%quote_redis%& expansion operator
8057 escapes whitespace and backslash characters with a backslash.
8058
8059 .section "Specifying the server in the query" "SECTspeserque"
8060 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
8061 it is possible to specify a list of servers with an individual query. This is
8062 done by appending a comma-separated option to the query type:
8063 .display
8064 &`,servers=`&&'server1:server2:server3:...'&
8065 .endd
8066 Each item in the list may take one of two forms:
8067 .olist
8068 If it contains no slashes it is assumed to be just a host name. The appropriate
8069 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
8070 of the same name, and the remaining parameters (database, user, password) are
8071 taken from there.
8072 .next
8073 If it contains any slashes, it is taken as a complete parameter set.
8074 .endlist
8075 The list of servers is used in exactly the same way as the global list.
8076 Once a connection to a server has happened and a query has been
8077 successfully executed, processing of the lookup ceases.
8078
8079 This feature is intended for use in master/slave situations where updates
8080 are occurring and you want to update the master rather than a slave. If the
8081 master is in the list as a backup for reading, you might have a global setting
8082 like this:
8083 .code
8084 mysql_servers = slave1/db/name/pw:\
8085                 slave2/db/name/pw:\
8086                 master/db/name/pw
8087 .endd
8088 In an updating lookup, you could then write:
8089 .code
8090 ${lookup mysql,servers=master {UPDATE ...} }
8091 .endd
8092 That query would then be sent only to the master server. If, on the other hand,
8093 the master is not to be used for reading, and so is not present in the global
8094 option, you can still update it by a query of this form:
8095 .code
8096 ${lookup pgsql,servers=master/db/name/pw {UPDATE ...} }
8097 .endd
8098
8099 An older syntax places the servers specification before the query,
8100 semicolon separated:
8101 .code
8102 ${lookup mysql{servers=master; UPDATE ...} }
8103 .endd
8104 The new version avoids potential issues with tainted
8105 arguments in the query, for explicit expansion.
8106 &*Note*&: server specifications in list-style lookups are still problematic.
8107
8108
8109 .section "Special MySQL features" "SECID73"
8110 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
8111 causes a connection to the server on the local host by means of a Unix domain
8112 socket. An alternate socket can be specified in parentheses.
8113 An option group name for MySQL option files can be specified in square brackets;
8114 the default value is &"exim"&.
8115 The full syntax of each item in &%mysql_servers%& is:
8116 .display
8117 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
8118   <&'database'&>/<&'user'&>/<&'password'&>
8119 .endd
8120 Any of the four sub-parts of the first field can be omitted. For normal use on
8121 the local host it can be left blank or set to just &"localhost"&.
8122
8123 No database need be supplied &-- but if it is absent here, it must be given in
8124 the queries.
8125
8126 If a MySQL query is issued that does not request any data (an insert, update,
8127 or delete command), the result of the lookup is the number of rows affected.
8128
8129 &*Warning*&: This can be misleading. If an update does not actually change
8130 anything (for example, setting a field to the value it already has), the result
8131 is zero because no rows are affected.
8132
8133
8134 .section "Special PostgreSQL features" "SECID74"
8135 PostgreSQL lookups can also use Unix domain socket connections to the database.
8136 This is usually faster and costs less CPU time than a TCP/IP connection.
8137 However it can be used only if the mail server runs on the same machine as the
8138 database server. A configuration line for PostgreSQL via Unix domain sockets
8139 looks like this:
8140 .code
8141 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
8142 .endd
8143 In other words, instead of supplying a host name, a path to the socket is
8144 given. The path name is enclosed in parentheses so that its slashes aren't
8145 visually confused with the delimiters for the other server parameters.
8146
8147 If a PostgreSQL query is issued that does not request any data (an insert,
8148 update, or delete command), the result of the lookup is the number of rows
8149 affected.
8150
8151 .section "More about SQLite" "SECTsqlite"
8152 .cindex "lookup" "SQLite"
8153 .cindex "sqlite lookup type"
8154 SQLite is different to the other SQL lookups because a filename is required in
8155 addition to the SQL query. An SQLite database is a single file, and there is no
8156 daemon as in the other SQL databases.
8157
8158 .oindex &%sqlite_dbfile%&
8159 The preferred way of specifying the file is by using the
8160 &%sqlite_dbfile%& option, set to
8161 an absolute path.
8162 A deprecated method is available, prefixing the query with the filename
8163 separated by white space.
8164 This means that the path name cannot contain white space.
8165 .cindex "tainted data" "sqlite file"
8166 It also means that the query cannot use any tainted values, as that taints
8167 the entire query including the filename - resulting in a refusal to open
8168 the file.
8169
8170 Here is a lookup expansion example:
8171 .code
8172 sqlite_dbfile = /some/thing/sqlitedb
8173 ...
8174 ${lookup sqlite {select name from aliases where id='userx';}}
8175 .endd
8176 In a list, the syntax is similar. For example:
8177 .code
8178 domainlist relay_to_domains = sqlite;\
8179    select * from relays where ip='$sender_host_address';
8180 .endd
8181 The only character affected by the &%quote_sqlite%& operator is a single
8182 quote, which it doubles.
8183
8184 .cindex timeout SQLite
8185 .cindex sqlite "lookup timeout"
8186 The SQLite library handles multiple simultaneous accesses to the database
8187 internally. Multiple readers are permitted, but only one process can
8188 update at once. Attempts to access the database while it is being updated
8189 are rejected after a timeout period, during which the SQLite library
8190 waits for the lock to be released. In Exim, the default timeout is set
8191 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8192 option.
8193
8194 .section "More about Redis" "SECTredis"
8195 .cindex "lookup" "Redis"
8196 .cindex "redis lookup type"
8197 Redis is a non-SQL database. Commands are simple get and set.
8198 Examples:
8199 .code
8200 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8201 ${lookup redis{get keyname}}
8202 .endd
8203
8204 As of release 4.91, "lightweight" support for Redis Cluster is available.
8205 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8206 of which must be reachable from the running exim instance. If the cluster has
8207 master/slave replication, the list must contain all the master and slave
8208 servers.
8209
8210 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8211 immediately follow the redirection but treats the response as a DEFER, moving on
8212 to the next server in the &%redis_servers%& list until the correct server is
8213 reached.
8214
8215 .ecindex IIDfidalo1
8216 .ecindex IIDfidalo2
8217
8218
8219 . ////////////////////////////////////////////////////////////////////////////
8220 . ////////////////////////////////////////////////////////////////////////////
8221
8222 .chapter "Domain, host, address, and local part lists" &&&
8223          "CHAPdomhosaddlists" &&&
8224          "Domain, host, and address lists"
8225 .scindex IIDdohoadli "lists of domains; hosts; etc."
8226 A number of Exim configuration options contain lists of domains, hosts,
8227 email addresses, or local parts. For example, the &%hold_domains%& option
8228 contains a list of domains whose delivery is currently suspended. These lists
8229 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8230 arguments to expansion conditions such as &%match_domain%&.
8231
8232 Each item in one of these lists is a pattern to be matched against a domain,
8233 host, email address, or local part, respectively. In the sections below, the
8234 different types of pattern for each case are described, but first we cover some
8235 general facilities that apply to all four kinds of list.
8236
8237 Note that other parts of Exim use a &'string list'& which does not
8238 support all the complexity available in
8239 domain, host, address and local part lists.
8240
8241
8242
8243 .section "Expansion of lists" "SECTlistexpand"
8244 .cindex "expansion" "of lists"
8245 Each list is expanded as a single string before it is used.
8246
8247 &'Exception: the router headers_remove option, where list-item
8248 splitting is done before string-expansion.'&
8249
8250 The result of
8251 expansion must be a list, possibly containing empty items, which is split up
8252 into separate items for matching. By default, colon is the separator character,
8253 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8254 &<<SECTempitelis>>& for details of the list syntax; the second of these
8255 discusses the way to specify empty list items.
8256
8257
8258 If the string expansion is forced to fail, Exim behaves as if the item it is
8259 testing (domain, host, address, or local part) is not in the list. Other
8260 expansion failures cause temporary errors.
8261
8262 If an item in a list is a regular expression, backslashes, dollars and possibly
8263 other special characters in the expression must be protected against
8264 misinterpretation by the string expander. The easiest way to do this is to use
8265 the &`\N`& expansion feature to indicate that the contents of the regular
8266 expression should not be expanded. For example, in an ACL you might have:
8267 .code
8268 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8269                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8270 .endd
8271 The first item is a regular expression that is protected from expansion by
8272 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8273 senders based on the receiving domain.
8274
8275
8276
8277
8278 .section "Negated items in lists" "SECID76"
8279 .cindex "list" "negation"
8280 .cindex "negation" "in lists"
8281 Items in a list may be positive or negative. Negative items are indicated by a
8282 leading exclamation mark, which may be followed by optional white space. A list
8283 defines a set of items (domains, etc). When Exim processes one of these lists,
8284 it is trying to find out whether a domain, host, address, or local part
8285 (respectively) is in the set that is defined by the list. It works like this:
8286
8287 The list is scanned from left to right. If a positive item is matched, the
8288 subject that is being checked is in the set; if a negative item is matched, the
8289 subject is not in the set. If the end of the list is reached without the
8290 subject having matched any of the patterns, it is in the set if the last item
8291 was a negative one, but not if it was a positive one. For example, the list in
8292 .code
8293 domainlist relay_to_domains = !a.b.c : *.b.c
8294 .endd
8295 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8296 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8297 list is positive. However, if the setting were
8298 .code
8299 domainlist relay_to_domains = !a.b.c
8300 .endd
8301 then all domains other than &'a.b.c'& would match because the last item in the
8302 list is negative. In other words, a list that ends with a negative item behaves
8303 as if it had an extra item &`:*`& on the end.
8304
8305 Another way of thinking about positive and negative items in lists is to read
8306 the connector as &"or"& after a positive item and as &"and"& after a negative
8307 item.
8308
8309
8310
8311 .section "File names in lists" "SECTfilnamlis"
8312 .cindex "list" "filename in"
8313 If an item in a domain, host, address, or local part list is an absolute
8314 filename (beginning with a slash character), each line of the file is read and
8315 processed as if it were an independent item in the list, except that further
8316 filenames are not allowed,
8317 and no expansion of the data from the file takes place.
8318 Empty lines in the file are ignored, and the file may also contain comment
8319 lines:
8320
8321 .ilist
8322 For domain and host lists, if a # character appears anywhere in a line of the
8323 file, it and all following characters are ignored.
8324 .next
8325 Because local parts may legitimately contain # characters, a comment in an
8326 address list or local part list file is recognized only if # is preceded by
8327 white space or the start of the line. For example:
8328 .code
8329 not#comment@x.y.z   # but this is a comment
8330 .endd
8331 .endlist
8332
8333 Putting a filename in a list has the same effect as inserting each line of the
8334 file as an item in the list (blank lines and comments excepted). However, there
8335 is one important difference: the file is read each time the list is processed,
8336 so if its contents vary over time, Exim's behaviour changes.
8337
8338 If a filename is preceded by an exclamation mark, the sense of any match
8339 within the file is inverted. For example, if
8340 .code
8341 hold_domains = !/etc/nohold-domains
8342 .endd
8343 and the file contains the lines
8344 .code
8345 !a.b.c
8346 *.b.c
8347 .endd
8348 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8349 any domain matching &`*.b.c`& is not.
8350
8351
8352
8353 .section "An lsearch file is not an out-of-line list" "SECID77"
8354 As will be described in the sections that follow, lookups can be used in lists
8355 to provide indexed methods of checking list membership. There has been some
8356 confusion about the way &(lsearch)& lookups work in lists. Because
8357 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8358 sometimes thought that it is allowed to contain wild cards and other kinds of
8359 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8360 always fixed strings, just as for any other single-key lookup type.
8361
8362 If you want to use a file to contain wild-card patterns that form part of a
8363 list, just give the filename on its own, without a search type, as described
8364 in the previous section. You could also use the &(wildlsearch)& or
8365 &(nwildlsearch)&, but there is no advantage in doing this.
8366
8367
8368
8369
8370 .section "Results of list checking" SECTlistresults
8371 The primary result of doing a list check is a truth value.
8372 In some contexts additional information is stored
8373 about the list element that matched:
8374 .vlist
8375 .vitem hosts
8376 A &%hosts%& ACL condition
8377 will store a result in the &$host_data$& variable.
8378 .vitem local_parts
8379 A &%local_parts%& router option or &%local_parts%& ACL condition
8380 will store a result in the &$local_part_data$& variable.
8381 .vitem domains
8382 A &%domains%& router option or &%domains%& ACL condition
8383 .vitem senders
8384 A &%senders%& router option or &%senders%& ACL condition
8385 will store a result in the &$sender_data$& variable.
8386 .vitem recipients
8387 A &%recipients%& ACL condition
8388 will store a result in the &$recipient_data$& variable.
8389 .endlist
8390
8391 The detail of the additional information depends on the
8392 type of match and is given below as the &*value*& information.
8393
8394
8395
8396
8397 .section "Named lists" "SECTnamedlists"
8398 .cindex "named lists"
8399 .cindex "list" "named"
8400 A list of domains, hosts, email addresses, or local parts can be given a name
8401 which is then used to refer to the list elsewhere in the configuration. This is
8402 particularly convenient if the same list is required in several different
8403 places. It also allows lists to be given meaningful names, which can improve
8404 the readability of the configuration. For example, it is conventional to define
8405 a domain list called &'local_domains'& for all the domains that are handled
8406 locally on a host, using a configuration line such as
8407 .code
8408 domainlist local_domains = localhost:my.dom.example
8409 .endd
8410 Named lists are referenced by giving their name preceded by a plus sign, so,
8411 for example, a router that is intended to handle local domains would be
8412 configured with the line
8413 .code
8414 domains = +local_domains
8415 .endd
8416 The first router in a configuration is often one that handles all domains
8417 except the local ones, using a configuration with a negated item like this:
8418 .code
8419 dnslookup:
8420   driver = dnslookup
8421   domains = ! +local_domains
8422   transport = remote_smtp
8423   no_more
8424 .endd
8425 The four kinds of named list are created by configuration lines starting with
8426 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8427 respectively. Then there follows the name that you are defining, followed by an
8428 equals sign and the list itself. For example:
8429 .code
8430 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8431 addresslist bad_senders = cdb;/etc/badsenders
8432 .endd
8433 A named list may refer to other named lists:
8434 .code
8435 domainlist  dom1 = first.example : second.example
8436 domainlist  dom2 = +dom1 : third.example
8437 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8438 .endd
8439 &*Warning*&: If the last item in a referenced list is a negative one, the
8440 effect may not be what you intended, because the negation does not propagate
8441 out to the higher level. For example, consider:
8442 .code
8443 domainlist  dom1 = !a.b
8444 domainlist  dom2 = +dom1 : *.b
8445 .endd
8446 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8447 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8448 means it matches the second list as well. The effect is not the same as
8449 .code
8450 domainlist  dom2 = !a.b : *.b
8451 .endd
8452 where &'x.y'& does not match. It's best to avoid negation altogether in
8453 referenced lists if you can.
8454
8455 .cindex "hiding named list values"
8456 .cindex "named lists" "hiding value of"
8457 Some named list definitions may contain sensitive data, for example, passwords for
8458 accessing databases. To stop non-admin users from using the &%-bP%& command
8459 line option to read these values, you can precede the definition with the
8460 word &"hide"&. For example:
8461 .code
8462 hide domainlist filter_for_domains = ldap;PASS=secret ldap::/// ...
8463 .endd
8464
8465
8466 Named lists may have a performance advantage. When Exim is routing an
8467 address or checking an incoming message, it caches the result of tests on named
8468 lists. So, if you have a setting such as
8469 .code
8470 domains = +local_domains
8471 .endd
8472 on several of your routers
8473 or in several ACL statements,
8474 the actual test is done only for the first one. However, the caching works only
8475 if there are no expansions within the list itself or any sublists that it
8476 references. In other words, caching happens only for lists that are known to be
8477 the same each time they are referenced.
8478
8479 By default, there may be up to 16 named lists of each type. This limit can be
8480 extended by changing a compile-time variable. The use of domain and host lists
8481 is recommended for concepts such as local domains, relay domains, and relay
8482 hosts. The default configuration is set up like this.
8483
8484
8485
8486 .section "Named lists compared with macros" "SECID78"
8487 .cindex "list" "named compared with macro"
8488 .cindex "macro" "compared with named list"
8489 At first sight, named lists might seem to be no different from macros in the
8490 configuration file. However, macros are just textual substitutions. If you
8491 write
8492 .code
8493 ALIST = host1 : host2
8494 auth_advertise_hosts = !ALIST
8495 .endd
8496 it probably won't do what you want, because that is exactly the same as
8497 .code
8498 auth_advertise_hosts = !host1 : host2
8499 .endd
8500 Notice that the second host name is not negated. However, if you use a host
8501 list, and write
8502 .code
8503 hostlist alist = host1 : host2
8504 auth_advertise_hosts = ! +alist
8505 .endd
8506 the negation applies to the whole list, and so that is equivalent to
8507 .code
8508 auth_advertise_hosts = !host1 : !host2
8509 .endd
8510
8511
8512 .section "Named list caching" "SECID79"
8513 .cindex "list" "caching of named"
8514 .cindex "caching" "named lists"
8515 While processing a message, Exim caches the result of checking a named list if
8516 it is sure that the list is the same each time. In practice, this means that
8517 the cache operates only if the list contains no $ characters, which guarantees
8518 that it will not change when it is expanded. Sometimes, however, you may have
8519 an expanded list that you know will be the same each time within a given
8520 message. For example:
8521 .code
8522 domainlist special_domains = \
8523            ${lookup{$sender_host_address}cdb{/some/file}}
8524 .endd
8525 This provides a list of domains that depends only on the sending host's IP
8526 address. If this domain list is referenced a number of times (for example,
8527 in several ACL lines, or in several routers) the result of the check is not
8528 cached by default, because Exim does not know that it is going to be the
8529 same list each time.
8530
8531 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8532 cache the result anyway. For example:
8533 .code
8534 domainlist_cache special_domains = ${lookup{...
8535 .endd
8536 If you do this, you should be absolutely sure that caching is going to do
8537 the right thing in all cases. When in doubt, leave it out.
8538
8539
8540
8541 .section "Domain lists" "SECTdomainlist"
8542 .cindex "domain list" "patterns for"
8543 .cindex "list" "domain list"
8544 Domain lists contain patterns that are to be matched against a mail domain.
8545 The following types of item may appear in domain lists:
8546
8547 .ilist
8548 .cindex "primary host name"
8549 .cindex "host name" "matched in domain list"
8550 .oindex "&%primary_hostname%&"
8551 .cindex "domain list" "matching primary host name"
8552 .cindex "@ in a domain list"
8553 If a pattern consists of a single @ character, it matches the local host name,
8554 as set by the &%primary_hostname%& option (or defaulted). This makes it
8555 possible to use the same configuration file on several different hosts that
8556 differ only in their names.
8557
8558 The value for a match will be the primary host name.
8559
8560
8561 .next
8562 .cindex "@[] in a domain list"
8563 .cindex "domain list" "matching local IP interfaces"
8564 .cindex "domain literal"
8565 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8566 in square brackets (as in an email address that contains a domain literal), but
8567 only if that IP address is recognized as local for email routing purposes. The
8568 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8569 control which of a host's several IP addresses are treated as local.
8570 In today's Internet, the use of domain literals is controversial;
8571 see the &%allow_domain_literals%& main option.
8572
8573 The value for a match will be the string &`@[]`&.
8574
8575
8576 .next
8577 .cindex "@mx_any"
8578 .cindex "@mx_primary"
8579 .cindex "@mx_secondary"
8580 .cindex "domain list" "matching MX pointers to local host"
8581 If a pattern consists of the string &`@mx_any`& it matches any domain that
8582 has an MX record pointing to the local host or to any host that is listed in
8583 .oindex "&%hosts_treat_as_local%&"
8584 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8585 are similar, except that the first matches only when a primary MX target is the
8586 local host, and the second only when no primary MX target is the local host,
8587 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8588 preference value &-- there may of course be more than one of them.
8589
8590 The MX lookup that takes place when matching a pattern of this type is
8591 performed with the resolver options for widening names turned off. Thus, for
8592 example, a single-component domain will &'not'& be expanded by adding the
8593 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8594 options of the &(dnslookup)& router for a discussion of domain widening.
8595
8596 Sometimes you may want to ignore certain IP addresses when using one of these
8597 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8598 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8599 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8600 on a router). For example:
8601 .code
8602 domains = @mx_any/ignore=127.0.0.1
8603 .endd
8604 This example matches any domain that has an MX record pointing to one of
8605 the local host's IP addresses other than 127.0.0.1.
8606
8607 The list of IP addresses is in fact processed by the same code that processes
8608 host lists, so it may contain CIDR-coded network specifications and it may also
8609 contain negative items.
8610
8611 Because the list of IP addresses is a sublist within a domain list, you have to
8612 be careful about delimiters if there is more than one address. Like any other
8613 list, the default delimiter can be changed. Thus, you might have:
8614 .code
8615 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8616           an.other.domain : ...
8617 .endd
8618 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8619 involved, it is easiest to change the delimiter for the main list as well:
8620 .code
8621 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8622           an.other.domain ? ...
8623 .endd
8624 The value for a match will be the list element string (starting &`@mx_`&).
8625
8626
8627 .next
8628 .cindex "asterisk" "in domain list"
8629 .cindex "domain list" "asterisk in"
8630 .cindex "domain list" "matching &""ends with""&"
8631 If a pattern starts with an asterisk, the remaining characters of the pattern
8632 are compared with the terminating characters of the domain. The use of &"*"& in
8633 domain lists differs from its use in partial matching lookups. In a domain
8634 list, the character following the asterisk need not be a dot, whereas partial
8635 matching works only in terms of dot-separated components. For example, a domain
8636 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8637 &'cipher.key.ex'&.
8638
8639 The value for a match will be the list element string (starting with the asterisk).
8640 Additionally, &$0$& will be set to the matched string
8641 and &$1$& to the variable portion which the asterisk matched.
8642
8643 .next
8644 .cindex "regular expressions" "in domain list"
8645 .cindex "domain list" "matching regular expression"
8646 If a pattern starts with a circumflex character, it is treated as a regular
8647 expression, and matched against the domain using a regular expression matching
8648 function. The circumflex is treated as part of the regular expression.
8649 Email domains are case-independent, so this regular expression match is by
8650 default case-independent, but you can make it case-dependent by starting it
8651 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8652 are given in chapter &<<CHAPregexp>>&.
8653
8654 &*Warning*&: Because domain lists are expanded before being processed, you
8655 must escape any backslash and dollar characters in the regular expression, or
8656 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8657 it is not to be expanded (unless you really do want to build a regular
8658 expression by expansion, of course).
8659
8660 The value for a match will be the list element string (starting with the circumflex).
8661 Additionally, &$0$& will be set to the string matching the regular expression,
8662 and &$1$& (onwards) to any submatches identified by parentheses.
8663
8664
8665
8666 .next
8667 .cindex "lookup" "in domain list"
8668 .cindex "domain list" "matching by lookup"
8669 If a pattern starts with the name of a single-key lookup type followed by a
8670 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8671 must be a filename in a suitable format for the lookup type. For example, for
8672 &"cdb;"& it must be an absolute path:
8673 .code
8674 domains = cdb;/etc/mail/local_domains.cdb
8675 .endd
8676 The appropriate type of lookup is done on the file using the domain name as the
8677 key. In most cases, the value resulting from the lookup is not used; Exim is interested
8678 only in whether or not the key is present in the file. However, when a lookup
8679 is used for the &%domains%& option on a router
8680 or a &%domains%& condition in an ACL statement, the value is preserved in the
8681 &$domain_data$& variable and can be referred to in other router options or
8682 other statements in the same ACL.
8683 .cindex "tainted data" "de-tainting"
8684 The value will be untainted.
8685
8686
8687 .next
8688 Any of the single-key lookup type names may be preceded by
8689 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8690 .code
8691 domains = partial-dbm;/partial/domains
8692 .endd
8693 This causes partial matching logic to be invoked; a description of how this
8694 works is given in section &<<SECTpartiallookup>>&.
8695
8696 .next
8697 .cindex "asterisk" "in lookup type"
8698 Any of the single-key lookup types may be followed by an asterisk. This causes
8699 a default lookup for a key consisting of a single asterisk to be done if the
8700 original lookup fails. This is not a useful feature when using a domain list to
8701 select particular domains (because any domain would match), but it might have
8702 value if the result of the lookup is being used via the &$domain_data$&
8703 expansion variable.
8704
8705 .next
8706 If the pattern starts with the name of a query-style lookup type followed by a
8707 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8708 pattern must be an appropriate query for the lookup type, as described in
8709 chapter &<<CHAPfdlookup>>&. For example:
8710 .code
8711 hold_domains = mysql;select domain from holdlist \
8712   where domain = '${quote_mysql:$domain}';
8713 .endd
8714 In most cases, the value resulting from the lookup is not used (so for an SQL query, for
8715 example, it doesn't matter what field you select). Exim is interested only in
8716 whether or not the query succeeds. However, when a lookup is used for the
8717 &%domains%& option on a router, the value is preserved in the &$domain_data$&
8718 variable and can be referred to in other options.
8719 .cindex "tainted data" "de-tainting"
8720 The value will be untainted.
8721
8722 .next
8723 If the pattern starts with the name of a lookup type
8724 of either kind (single-key or query-style) it may be
8725 followed by a comma and options,
8726 The options are lookup-type specific and consist of a comma-separated list.
8727 Each item starts with a tag and and equals "=".
8728
8729 .next
8730 .cindex "domain list" "matching literal domain name"
8731 If none of the above cases apply, a caseless textual comparison is made
8732 between the pattern and the domain.
8733
8734 The value for a match will be the list element string.
8735 .cindex "tainted data" "de-tainting"
8736 Note that this is commonly untainted
8737 (depending on the way the list was created).
8738 This is a useful way of obtaining an untainted equivalent to
8739 the domain, for later operations.
8740 .endlist
8741
8742
8743 Here is an example that uses several different kinds of pattern:
8744 .code
8745 domainlist funny_domains = \
8746   @ : \
8747   lib.unseen.edu : \
8748   *.foundation.fict.example : \
8749   \N^[1-2]\d{3}\.fict\.example$\N : \
8750   partial-dbm;/opt/data/penguin/book : \
8751   nis;domains.byname : \
8752   nisplus;[name=$domain,status=local],domains.org_dir
8753 .endd
8754 There are obvious processing trade-offs among the various matching modes. Using
8755 an asterisk is faster than a regular expression, and listing a few names
8756 explicitly probably is too. The use of a file or database lookup is expensive,
8757 but may be the only option if hundreds of names are required. Because the
8758 patterns are tested in order, it makes sense to put the most commonly matched
8759 patterns earlier.
8760
8761
8762
8763 .section "Host lists" "SECThostlist"
8764 .cindex "host list" "patterns in"
8765 .cindex "list" "host list"
8766 Host lists are used to control what remote hosts are allowed to do. For
8767 example, some hosts may be allowed to use the local host as a relay, and some
8768 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8769 two different ways, by name or by IP address. In a host list, some types of
8770 pattern are matched to a host name, and some are matched to an IP address.
8771 You need to be particularly careful with this when single-key lookups are
8772 involved, to ensure that the right value is being used as the key.
8773
8774
8775 .section "Special host list patterns" "SECID80"
8776 .cindex "empty item in hosts list"
8777 .cindex "host list" "empty string in"
8778 If a host list item is the empty string, it matches only when no remote host is
8779 involved. This is the case when a message is being received from a local
8780 process using SMTP on the standard input, that is, when a TCP/IP connection is
8781 not used.
8782
8783 .cindex "asterisk" "in host list"
8784 The special pattern &"*"& in a host list matches any host or no host. Neither
8785 the IP address nor the name is actually inspected.
8786
8787
8788
8789 .section "Host list patterns that match by IP address" "SECThoslispatip"
8790 .cindex "host list" "matching IP addresses"
8791 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8792 the incoming address actually appears in the IPv6 host as
8793 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8794 list, it is converted into a traditional IPv4 address first. (Not all operating
8795 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8796 concerns.)
8797
8798 The following types of pattern in a host list check the remote host by
8799 inspecting its IP address:
8800
8801 .ilist
8802 If the pattern is a plain domain name (not a regular expression, not starting
8803 with *, not a lookup of any kind), Exim calls the operating system function
8804 to find the associated IP address(es). Exim uses the newer
8805 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8806 This typically causes a forward DNS lookup of the name. The result is compared
8807 with the IP address of the subject host.
8808
8809 If there is a temporary problem (such as a DNS timeout) with the host name
8810 lookup, a temporary error occurs. For example, if the list is being used in an
8811 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8812 temporary SMTP error code. If no IP address can be found for the host name,
8813 what happens is described in section &<<SECTbehipnot>>& below.
8814
8815 .next
8816 .cindex "@ in a host list"
8817 If the pattern is &"@"&, the primary host name is substituted and used as a
8818 domain name, as just described.
8819
8820 .next
8821 If the pattern is an IP address, it is matched against the IP address of the
8822 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8823 IPv6 addresses can be given in colon-separated format, but the colons have to
8824 be doubled so as not to be taken as item separators when the default list
8825 separator is used. IPv6 addresses are recognized even when Exim is compiled
8826 without IPv6 support. This means that if they appear in a host list on an
8827 IPv4-only host, Exim will not treat them as host names. They are just addresses
8828 that can never match a client host.
8829
8830 .next
8831 .cindex "@[] in a host list"
8832 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8833 the local host. For example, if the local host is an IPv4 host with one
8834 interface address 10.45.23.56, these two ACL statements have the same effect:
8835 .code
8836 accept hosts = 127.0.0.1 : 10.45.23.56
8837 accept hosts = @[]
8838 .endd
8839 .next
8840 .cindex "CIDR notation"
8841 If the pattern is an IP address followed by a slash and a mask length (for
8842 example 10.11.42.0/24), it is matched against the IP address of the subject
8843 host under the given mask. This allows, an entire network of hosts to be
8844 included (or excluded) by a single item. The mask uses CIDR notation; it
8845 specifies the number of address bits that must match, starting from the most
8846 significant end of the address.
8847
8848 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8849 of a range of addresses. It is the number of bits in the network portion of the
8850 address. The above example specifies a 24-bit netmask, so it matches all 256
8851 addresses in the 10.11.42.0 network. An item such as
8852 .code
8853 192.168.23.236/31
8854 .endd
8855 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8856 32 for an IPv4 address is the same as no mask at all; just a single address
8857 matches.
8858
8859 Here is another example which shows an IPv4 and an IPv6 network:
8860 .code
8861 recipient_unqualified_hosts = 192.168.0.0/16: \
8862                               3ffe::ffff::836f::::/48
8863 .endd
8864 The doubling of list separator characters applies only when these items
8865 appear inline in a host list. It is not required when indirecting via a file.
8866 For example:
8867 .code
8868 recipient_unqualified_hosts = /opt/exim/unqualnets
8869 .endd
8870 could make use of a file containing
8871 .code
8872 172.16.0.0/12
8873 3ffe:ffff:836f::/48
8874 .endd
8875 to have exactly the same effect as the previous example. When listing IPv6
8876 addresses inline, it is usually more convenient to use the facility for
8877 changing separator characters. This list contains the same two networks:
8878 .code
8879 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8880                                  3ffe:ffff:836f::/48
8881 .endd
8882 The separator is changed to semicolon by the leading &"<;"& at the start of the
8883 list.
8884 .endlist
8885
8886
8887
8888 .section "Host list patterns for single-key lookups by host address" &&&
8889          "SECThoslispatsikey"
8890 .cindex "host list" "lookup of IP address"
8891 When a host is to be identified by a single-key lookup of its complete IP
8892 address, the pattern takes this form:
8893 .display
8894 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8895 .endd
8896 For example:
8897 .code
8898 hosts_lookup = net-cdb;/hosts-by-ip.db
8899 .endd
8900 The text form of the IP address of the subject host is used as the lookup key.
8901 IPv6 addresses are converted to an unabbreviated form, using lower case
8902 letters, with dots as separators because colon is the key terminator in
8903 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8904 quoting the keys, but this is a facility that was added later.] The data
8905 returned by the lookup is not used.
8906
8907 .cindex "IP address" "masking"
8908 .cindex "host list" "masked IP address"
8909 Single-key lookups can also be performed using masked IP addresses, using
8910 patterns of this form:
8911 .display
8912 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8913 .endd
8914 For example:
8915 .code
8916 net24-dbm;/networks.db
8917 .endd
8918 The IP address of the subject host is masked using <&'number'&> as the mask
8919 length. A textual string is constructed from the masked value, followed by the
8920 mask, and this is used as the lookup key. For example, if the host's IP address
8921 is 192.168.34.6, the key that is looked up for the above example is
8922 &"192.168.34.0/24"&.
8923
8924 When an IPv6 address is converted to a string, dots are normally used instead
8925 of colons, so that keys in &(lsearch)& files need not contain colons (which
8926 terminate &(lsearch)& keys). This was implemented some time before the ability
8927 to quote keys was made available in &(lsearch)& files. However, the more
8928 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8929 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8930 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8931 converted using colons and not dots.
8932 In all cases except IPv4-mapped IPv6, full, unabbreviated IPv6
8933 addresses are always used.
8934 The latter are converted to IPv4 addresses, in dotted-quad form.
8935
8936 Ideally, it would be nice to tidy up this anomalous situation by changing to
8937 colons in all cases, given that quoting is now available for &(lsearch)&.
8938 However, this would be an incompatible change that might break some existing
8939 configurations.
8940
8941 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8942 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8943 the former case the key strings include the mask value, whereas in the latter
8944 case the IP address is used on its own.
8945
8946
8947
8948 .section "Host list patterns that match by host name" "SECThoslispatnam"
8949 .cindex "host" "lookup failures"
8950 .cindex "unknown host name"
8951 .cindex "host list" "matching host name"
8952 There are several types of pattern that require Exim to know the name of the
8953 remote host. These are either wildcard patterns or lookups by name. (If a
8954 complete hostname is given without any wildcarding, it is used to find an IP
8955 address to match against, as described in section &<<SECThoslispatip>>&
8956 above.)
8957
8958 If the remote host name is not already known when Exim encounters one of these
8959 patterns, it has to be found from the IP address.
8960 Although many sites on the Internet are conscientious about maintaining reverse
8961 DNS data for their hosts, there are also many that do not do this.
8962 Consequently, a name cannot always be found, and this may lead to unwanted
8963 effects. Take care when configuring host lists with wildcarded name patterns.
8964 Consider what will happen if a name cannot be found.
8965
8966 Because of the problems of determining host names from IP addresses, matching
8967 against host names is not as common as matching against IP addresses.
8968
8969 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8970 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8971 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8972 are done can be changed by setting the &%host_lookup_order%& option. For
8973 security, once Exim has found one or more names, it looks up the IP addresses
8974 for these names and compares them with the IP address that it started with.
8975 Only those names whose IP addresses match are accepted. Any other names are
8976 discarded. If no names are left, Exim behaves as if the host name cannot be
8977 found. In the most common case there is only one name and one IP address.
8978
8979 There are some options that control what happens if a host name cannot be
8980 found. These are described in section &<<SECTbehipnot>>& below.
8981
8982 .cindex "host" "alias for"
8983 .cindex "alias for host"
8984 As a result of aliasing, hosts may have more than one name. When processing any
8985 of the following types of pattern, all the host's names are checked:
8986
8987 .ilist
8988 .cindex "asterisk" "in host list"
8989 If a pattern starts with &"*"& the remainder of the item must match the end of
8990 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8991 &'.b.c'&. This special simple form is provided because this is a very common
8992 requirement. Other kinds of wildcarding require the use of a regular
8993 expression.
8994 .next
8995 .cindex "regular expressions" "in host list"
8996 .cindex "host list" "regular expression in"
8997 If the item starts with &"^"& it is taken to be a regular expression which is
8998 matched against the host name. Host names are case-independent, so this regular
8999 expression match is by default case-independent, but you can make it
9000 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
9001 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
9002 example,
9003 .code
9004 ^(a|b)\.c\.d$
9005 .endd
9006 is a regular expression that matches either of the two hosts &'a.c.d'& or
9007 &'b.c.d'&. When a regular expression is used in a host list, you must take care
9008 that backslash and dollar characters are not misinterpreted as part of the
9009 string expansion. The simplest way to do this is to use &`\N`& to mark that
9010 part of the string as non-expandable. For example:
9011 .code
9012 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
9013 .endd
9014 &*Warning*&: If you want to match a complete host name, you must include the
9015 &`$`& terminating metacharacter in the regular expression, as in the above
9016 example. Without it, a match at the start of the host name is all that is
9017 required.
9018 .endlist
9019
9020
9021
9022
9023 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
9024 .cindex "host" "lookup failures, permanent"
9025 While processing a host list, Exim may need to look up an IP address from a
9026 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
9027 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
9028 behaviour when it fails to find the information it is seeking is the same.
9029
9030 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
9031 apply to temporary DNS errors, whose handling is described in the next section.
9032
9033 .cindex "&`+include_unknown`&"
9034 .cindex "&`+ignore_unknown`&"
9035 Exim parses a host list from left to right. If it encounters a permanent
9036 lookup failure in any item in the host list before it has found a match,
9037 Exim treats it as a failure and the default behavior is as if the host
9038 does not match the list. This may not always be what you want to happen.
9039 To change Exim's behaviour, the special items &`+include_unknown`& or
9040 &`+ignore_unknown`& may appear in the list (at top level &-- they are
9041 not recognized in an indirected file).
9042
9043 .ilist
9044 If any item that follows &`+include_unknown`& requires information that
9045 cannot found, Exim behaves as if the host does match the list. For example,
9046 .code
9047 host_reject_connection = +include_unknown:*.enemy.ex
9048 .endd
9049 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
9050 any hosts whose name it cannot find.
9051
9052 .next
9053 If any item that follows &`+ignore_unknown`& requires information that cannot
9054 be found, Exim ignores that item and proceeds to the rest of the list. For
9055 example:
9056 .code
9057 accept hosts = +ignore_unknown : friend.example : \
9058                192.168.4.5
9059 .endd
9060 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
9061 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
9062 name can be found for 192.168.4.5, it is rejected.
9063 .endlist
9064
9065 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
9066 list. The effect of each one lasts until the next, or until the end of the
9067 list.
9068
9069 .section "Mixing wildcarded host names and addresses in host lists" &&&
9070          "SECTmixwilhos"
9071 .cindex "host list" "mixing names and addresses in"
9072
9073 This section explains the host/ip processing logic with the same concepts
9074 as the previous section, but specifically addresses what happens when a
9075 wildcarded hostname is one of the items in the hostlist.
9076
9077 .ilist
9078 If you have name lookups or wildcarded host names and
9079 IP addresses in the same host list, you should normally put the IP
9080 addresses first. For example, in an ACL you could have:
9081 .code
9082 accept hosts = 10.9.8.7 : *.friend.example
9083 .endd
9084 The reason you normally would order it this way lies in the
9085 left-to-right way that Exim processes lists.  It can test IP addresses
9086 without doing any DNS lookups, but when it reaches an item that requires
9087 a host name, it fails if it cannot find a host name to compare with the
9088 pattern. If the above list is given in the opposite order, the
9089 &%accept%& statement fails for a host whose name cannot be found, even
9090 if its IP address is 10.9.8.7.
9091
9092 .next
9093 If you really do want to do the name check first, and still recognize the IP
9094 address, you can rewrite the ACL like this:
9095 .code
9096 accept hosts = *.friend.example
9097 accept hosts = 10.9.8.7
9098 .endd
9099 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
9100 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
9101 &`+ignore_unknown`&, which was discussed in depth in the first example in
9102 this section.
9103 .endlist
9104
9105
9106 .section "Temporary DNS errors when looking up host information" &&&
9107          "SECTtemdnserr"
9108 .cindex "host" "lookup failures, temporary"
9109 .cindex "&`+include_defer`&"
9110 .cindex "&`+ignore_defer`&"
9111 A temporary DNS lookup failure normally causes a defer action (except when
9112 &%dns_again_means_nonexist%& converts it into a permanent error). However,
9113 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
9114 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
9115 section. These options should be used with care, probably only in non-critical
9116 host lists such as whitelists.
9117
9118
9119
9120 .section "Host list patterns for single-key lookups by host name" &&&
9121          "SECThoslispatnamsk"
9122 .cindex "unknown host name"
9123 .cindex "host list" "matching host name"
9124 If a pattern is of the form
9125 .display
9126 <&'single-key-search-type'&>;<&'search-data'&>
9127 .endd
9128 for example
9129 .code
9130 dbm;/host/accept/list
9131 .endd
9132 a single-key lookup is performed, using the host name as its key. If the
9133 lookup succeeds, the host matches the item. The actual data that is looked up
9134 is not used.
9135
9136 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
9137 keys in the file, not IP addresses. If you want to do lookups based on IP
9138 addresses, you must precede the search type with &"net-"& (see section
9139 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
9140 two items in the same list, one doing an address lookup and one doing a name
9141 lookup, both using the same file.
9142
9143
9144
9145 .section "Host list patterns for query-style lookups" "SECID81"
9146 If a pattern is of the form
9147 .display
9148 <&'query-style-search-type'&>;<&'query'&>
9149 .endd
9150 the query is obeyed, and if it succeeds, the host matches the item. The actual
9151 data that is looked up is not used. The variables &$sender_host_address$& and
9152 &$sender_host_name$& can be used in the query. For example:
9153 .code
9154 hosts_lookup = pgsql;\
9155   select ip from hostlist where ip='$sender_host_address'
9156 .endd
9157 The value of &$sender_host_address$& for an IPv6 address contains colons. You
9158 can use the &%sg%& expansion item to change this if you need to. If you want to
9159 use masked IP addresses in database queries, you can use the &%mask%& expansion
9160 operator.
9161
9162 If the query contains a reference to &$sender_host_name$&, Exim automatically
9163 looks up the host name if it has not already done so. (See section
9164 &<<SECThoslispatnam>>& for comments on finding host names.)
9165
9166 Historical note: prior to release 4.30, Exim would always attempt to find a
9167 host name before running the query, unless the search type was preceded by
9168 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
9169 still recognized for query-style lookups, but its presence or absence has no
9170 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
9171 See section &<<SECThoslispatsikey>>&.)
9172
9173
9174
9175
9176
9177 .section "Address lists" "SECTaddresslist"
9178 .cindex "list" "address list"
9179 .cindex "address list" "empty item"
9180 .cindex "address list" "patterns"
9181 Address lists contain patterns that are matched against mail addresses. There
9182 is one special case to be considered: the sender address of a bounce message is
9183 always empty. You can test for this by providing an empty item in an address
9184 list. For example, you can set up a router to process bounce messages by
9185 using this option setting:
9186 .code
9187 senders = :
9188 .endd
9189 The presence of the colon creates an empty item. If you do not provide any
9190 data, the list is empty and matches nothing. The empty sender can also be
9191 detected by a regular expression that matches an empty string,
9192 and by a query-style lookup that succeeds when &$sender_address$& is empty.
9193
9194 Non-empty items in an address list can be straightforward email addresses. For
9195 example:
9196 .code
9197 senders = jbc@askone.example : hs@anacreon.example
9198 .endd
9199 A certain amount of wildcarding is permitted. If a pattern contains an @
9200 character, but is not a regular expression and does not begin with a
9201 semicolon-terminated lookup type (described below), the local part of the
9202 subject address is compared with the local part of the pattern, which may start
9203 with an asterisk. If the local parts match, the domain is checked in exactly
9204 the same way as for a pattern in a domain list. For example, the domain can be
9205 wildcarded, refer to a named list, or be a lookup:
9206 .code
9207 deny senders = *@*.spamming.site:\
9208                *@+hostile_domains:\
9209                bozo@partial-lsearch;/list/of/dodgy/sites:\
9210                *@dbm;/bad/domains.db
9211 .endd
9212 .cindex "local part" "starting with !"
9213 .cindex "address list" "local part starting with !"
9214 If a local part that begins with an exclamation mark is required, it has to be
9215 specified using a regular expression, because otherwise the exclamation mark is
9216 treated as a sign of negation, as is standard in lists.
9217
9218 If a non-empty pattern that is not a regular expression or a lookup does not
9219 contain an @ character, it is matched against the domain part of the subject
9220 address. The only two formats that are recognized this way are a literal
9221 domain, or a domain pattern that starts with *. In both these cases, the effect
9222 is the same as if &`*@`& preceded the pattern. For example:
9223 .code
9224 deny senders = enemy.domain : *.enemy.domain
9225 .endd
9226
9227 The following kinds of more complicated address list pattern can match any
9228 address, including the empty address that is characteristic of bounce message
9229 senders:
9230
9231 .ilist
9232 .cindex "regular expressions" "in address list"
9233 .cindex "address list" "regular expression in"
9234 If (after expansion) a pattern starts with &"^"&, a regular expression match is
9235 done against the complete address, with the pattern as the regular expression.
9236 You must take care that backslash and dollar characters are not misinterpreted
9237 as part of the string expansion. The simplest way to do this is to use &`\N`&
9238 to mark that part of the string as non-expandable. For example:
9239 .code
9240 deny senders = \N^.*this.*@example\.com$\N : \
9241                \N^\d{8}.+@spamhaus.example$\N : ...
9242 .endd
9243 The &`\N`& sequences are removed by the expansion, so these items do indeed
9244 start with &"^"& by the time they are being interpreted as address patterns.
9245
9246 .next
9247 .cindex "address list" "lookup for complete address"
9248 Complete addresses can be looked up by using a pattern that starts with a
9249 lookup type terminated by a semicolon, followed by the data for the lookup. For
9250 example:
9251 .code
9252 deny senders = cdb;/etc/blocked.senders : \
9253   mysql;select address from blocked where \
9254   address='${quote_mysql:$sender_address}'
9255 .endd
9256 Both query-style and single-key lookup types can be used. For a single-key
9257 lookup type, Exim uses the complete address as the key. However, empty keys are
9258 not supported for single-key lookups, so a match against the empty address
9259 always fails. This restriction does not apply to query-style lookups.
9260
9261 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9262 cannot be used, and is ignored if specified, with an entry being written to the
9263 panic log.
9264 .cindex "*@ with single-key lookup"
9265 However, you can configure lookup defaults, as described in section
9266 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9267 default. For example, with this lookup:
9268 .code
9269 accept senders = lsearch*@;/some/file
9270 .endd
9271 the file could contains lines like this:
9272 .code
9273 user1@domain1.example
9274 *@domain2.example
9275 .endd
9276 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9277 that are tried is:
9278 .code
9279 nimrod@jaeger.example
9280 *@jaeger.example
9281 *
9282 .endd
9283 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9284 would mean that every address matches, thus rendering the test useless.
9285
9286 &*Warning 2*&: Do not confuse these two kinds of item:
9287 .code
9288 deny recipients = dbm*@;/some/file
9289 deny recipients = *@dbm;/some/file
9290 .endd
9291 The first does a whole address lookup, with defaulting, as just described,
9292 because it starts with a lookup type. The second matches the local part and
9293 domain independently, as described in a bullet point below.
9294 .endlist
9295
9296
9297 The following kinds of address list pattern can match only non-empty addresses.
9298 If the subject address is empty, a match against any of these pattern types
9299 always fails.
9300
9301
9302 .ilist
9303 .cindex "@@ with single-key lookup"
9304 .cindex "address list" "@@ lookup type"
9305 .cindex "address list" "split local part and domain"
9306 If a pattern starts with &"@@"& followed by a single-key lookup item
9307 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9308 split into a local part and a domain. The domain is looked up in the file. If
9309 it is not found, there is no match. If it is found, the data that is looked up
9310 from the file is treated as a colon-separated list of local part patterns, each
9311 of which is matched against the subject local part in turn.
9312
9313 .cindex "asterisk" "in address list"
9314 The lookup may be a partial one, and/or one involving a search for a default
9315 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9316 patterns that are looked up can be regular expressions or begin with &"*"&, or
9317 even be further lookups. They may also be independently negated. For example,
9318 with
9319 .code
9320 deny senders = @@dbm;/etc/reject-by-domain
9321 .endd
9322 the data from which the DBM file is built could contain lines like
9323 .code
9324 baddomain.com:  !postmaster : *
9325 .endd
9326 to reject all senders except &%postmaster%& from that domain.
9327
9328 .cindex "local part" "starting with !"
9329 If a local part that actually begins with an exclamation mark is required, it
9330 has to be specified using a regular expression. In &(lsearch)& files, an entry
9331 may be split over several lines by indenting the second and subsequent lines,
9332 but the separating colon must still be included at line breaks. White space
9333 surrounding the colons is ignored. For example:
9334 .code
9335 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9336   spammer3 : spammer4
9337 .endd
9338 As in all colon-separated lists in Exim, a colon can be included in an item by
9339 doubling.
9340
9341 If the last item in the list starts with a right angle-bracket, the remainder
9342 of the item is taken as a new key to look up in order to obtain a continuation
9343 list of local parts. The new key can be any sequence of characters. Thus one
9344 might have entries like
9345 .code
9346 aol.com: spammer1 : spammer 2 : >*
9347 xyz.com: spammer3 : >*
9348 *:       ^\d{8}$
9349 .endd
9350 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9351 local parts for all domains, in addition to the specific local parts listed for
9352 each domain. Of course, using this feature costs another lookup each time a
9353 chain is followed, but the effort needed to maintain the data is reduced.
9354
9355 .cindex "loop" "in lookups"
9356 It is possible to construct loops using this facility, and in order to catch
9357 them, the chains may be no more than fifty items long.
9358
9359 .next
9360 The @@<&'lookup'&> style of item can also be used with a query-style
9361 lookup, but in this case, the chaining facility is not available. The lookup
9362 can only return a single list of local parts.
9363 .endlist
9364
9365 &*Warning*&: There is an important difference between the address list items
9366 in these two examples:
9367 .code
9368 senders = +my_list
9369 senders = *@+my_list
9370 .endd
9371 In the first one, &`my_list`& is a named address list, whereas in the second
9372 example it is a named domain list.
9373
9374
9375
9376
9377 .section "Case of letters in address lists" "SECTcasletadd"
9378 .cindex "case of local parts"
9379 .cindex "address list" "case forcing"
9380 .cindex "case forcing in address lists"
9381 Domains in email addresses are always handled caselessly, but for local parts
9382 case may be significant on some systems (see &%caseful_local_part%& for how
9383 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9384 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9385 blocking lists should be done in a case-independent manner. Since most address
9386 lists in Exim are used for this kind of control, Exim attempts to do this by
9387 default.
9388
9389 The domain portion of an address is always lowercased before matching it to an
9390 address list. The local part is lowercased by default, and any string
9391 comparisons that take place are done caselessly. This means that the data in
9392 the address list itself, in files included as plain filenames, and in any file
9393 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9394 keys in files that are looked up by a search type other than &(lsearch)& (which
9395 works caselessly) must be in lower case, because these lookups are not
9396 case-independent.
9397
9398 .cindex "&`+caseful`&"
9399 To allow for the possibility of caseful address list matching, if an item in
9400 an address list is the string &"+caseful"&, the original case of the local
9401 part is restored for any comparisons that follow, and string comparisons are no
9402 longer case-independent. This does not affect the domain, which remains in
9403 lower case. However, although independent matches on the domain alone are still
9404 performed caselessly, regular expressions that match against an entire address
9405 become case-sensitive after &"+caseful"& has been seen.
9406
9407
9408
9409 .section "Local part lists" "SECTlocparlis"
9410 .cindex "list" "local part list"
9411 .cindex "local part" "list"
9412 Case-sensitivity in local part lists is handled in the same way as for address
9413 lists, as just described. The &"+caseful"& item can be used if required. In a
9414 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9415 set false, the subject is lowercased and the matching is initially
9416 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9417 matching in the local part list, but not elsewhere in the router. If
9418 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9419 option is case-sensitive from the start.
9420
9421 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9422 comments are handled in the same way as address lists &-- they are recognized
9423 only if the # is preceded by white space or the start of the line.
9424 Otherwise, local part lists are matched in the same way as domain lists, except
9425 that the special items that refer to the local host (&`@`&, &`@[]`&,
9426 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9427 Refer to section &<<SECTdomainlist>>& for details of the other available item
9428 types.
9429 .ecindex IIDdohoadli
9430
9431
9432
9433
9434 . ////////////////////////////////////////////////////////////////////////////
9435 . ////////////////////////////////////////////////////////////////////////////
9436
9437 .chapter "String expansions" "CHAPexpand"
9438 .scindex IIDstrexp "expansion" "of strings"
9439 Many strings in Exim's runtime configuration are expanded before use. Some of
9440 them are expanded every time they are used; others are expanded only once.
9441
9442 When a string is being expanded it is copied verbatim from left to right except
9443 .cindex expansion "string concatenation"
9444 when a dollar or backslash character is encountered. A dollar specifies the
9445 start of a portion of the string that is interpreted and replaced as described
9446 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9447 escape character, as described in the following section.
9448
9449 Whether a string is expanded depends upon the context.  Usually this is solely
9450 dependent upon the option for which a value is sought; in this documentation,
9451 options for which string expansion is performed are marked with &dagger; after
9452 the data type.  ACL rules always expand strings.  A couple of expansion
9453 conditions do not expand some of the brace-delimited branches, for security
9454 reasons,
9455 .cindex "tainted data" expansion
9456 .cindex expansion "tainted data"
9457 and expansion of data deriving from the sender (&"tainted data"&)
9458 is not permitted.
9459
9460
9461
9462 .section "Literal text in expanded strings" "SECTlittext"
9463 .cindex "expansion" "including literal text"
9464 An uninterpreted dollar can be included in an expanded string by putting a
9465 backslash in front of it. A backslash can be used to prevent any special
9466 character being treated specially in an expansion, including backslash itself.
9467 If the string appears in quotes in the configuration file, two backslashes are
9468 required because the quotes themselves cause interpretation of backslashes when
9469 the string is read in (see section &<<SECTstrings>>&).
9470
9471 .cindex "expansion" "non-expandable substrings"
9472 A portion of the string can specified as non-expandable by placing it between
9473 two occurrences of &`\N`&. This is particularly useful for protecting regular
9474 expressions, which often contain backslashes and dollar signs. For example:
9475 .code
9476 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9477 .endd
9478 On encountering the first &`\N`&, the expander copies subsequent characters
9479 without interpretation until it reaches the next &`\N`& or the end of the
9480 string.
9481
9482
9483
9484 .section "Character escape sequences in expanded strings" "SECID82"
9485 .cindex "expansion" "escape sequences"
9486 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9487 expanded string is recognized as an escape sequence for the character newline,
9488 carriage return, or tab, respectively. A backslash followed by up to three
9489 octal digits is recognized as an octal encoding for a single character, and a
9490 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9491 encoding.
9492
9493 These escape sequences are also recognized in quoted strings when they are read
9494 in. Their interpretation in expansions as well is useful for unquoted strings,
9495 and for other cases such as looked-up strings that are then expanded.
9496
9497
9498 .section "Testing string expansions" "SECID83"
9499 .cindex "expansion" "testing"
9500 .cindex "testing" "string expansion"
9501 .oindex "&%-be%&"
9502 Many expansions can be tested by calling Exim with the &%-be%& option. This
9503 takes the command arguments, or lines from the standard input if there are no
9504 arguments, runs them through the string expansion code, and writes the results
9505 to the standard output. Variables based on configuration values are set up, but
9506 since no message is being processed, variables such as &$local_part$& have no
9507 value. Nevertheless the &%-be%& option can be useful for checking out file and
9508 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9509 and &%nhash%&.
9510
9511 Exim gives up its root privilege when it is called with the &%-be%& option, and
9512 instead runs under the uid and gid it was called with, to prevent users from
9513 using &%-be%& for reading files to which they do not have access.
9514
9515 .oindex "&%-bem%&"
9516 If you want to test expansions that include variables whose values are taken
9517 from a message, there are two other options that can be used. The &%-bem%&
9518 option is like &%-be%& except that it is followed by a filename. The file is
9519 read as a message before doing the test expansions. For example:
9520 .code
9521 exim -bem /tmp/test.message '$h_subject:'
9522 .endd
9523 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9524 Exim message identifier. For example:
9525 .code
9526 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9527 .endd
9528 This loads the message from Exim's spool before doing the test expansions, and
9529 is therefore restricted to admin users.
9530
9531
9532 .section "Forced expansion failure" "SECTforexpfai"
9533 .cindex "expansion" "forced failure"
9534 A number of expansions that are described in the following section have
9535 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9536 (which are sometimes called &"curly brackets"&). Which of the two strings is
9537 used depends on some condition that is evaluated as part of the expansion. If,
9538 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9539 the entire string expansion fails in a way that can be detected by the code
9540 that requested the expansion. This is called &"forced expansion failure"&, and
9541 its consequences depend on the circumstances. In some cases it is no different
9542 from any other expansion failure, but in others a different action may be
9543 taken. Such variations are mentioned in the documentation of the option that is
9544 being expanded.
9545
9546
9547
9548
9549 .section "Expansion items" "SECTexpansionitems"
9550 The following items are recognized in expanded strings. White space may be used
9551 between sub-items that are keywords or substrings enclosed in braces inside an
9552 outer set of braces, to improve readability. &*Warning*&: Within braces,
9553 white space is significant.
9554
9555 .vlist
9556 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9557 .cindex "expansion" "variables"
9558 Substitute the contents of the named variable, for example:
9559 .code
9560 $local_part
9561 ${domain}
9562 .endd
9563 The second form can be used to separate the name from subsequent alphanumeric
9564 characters. This form (using braces) is available only for variables; it does
9565 &'not'& apply to message headers. The names of the variables are given in
9566 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9567 given, the expansion fails.
9568
9569 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9570 .cindex "expansion" "operators"
9571 The string is first itself expanded, and then the operation specified by
9572 <&'op'&> is applied to it. For example:
9573 .code
9574 ${lc:$local_part}
9575 .endd
9576 The string starts with the first character after the colon, which may be
9577 leading white space. A list of operators is given in section &<<SECTexpop>>&
9578 below. The operator notation is used for simple expansion items that have just
9579 one argument, because it reduces the number of braces and therefore makes the
9580 string easier to understand.
9581
9582 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9583 This item inserts &"basic"& header lines. It is described with the &%header%&
9584 expansion item below.
9585
9586
9587 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9588 .cindex "expansion" "calling an acl"
9589 .cindex "&%acl%&" "call from expansion"
9590 The name and zero to nine argument strings are first expanded separately.  The expanded
9591 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9592 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9593 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9594 and may use the variables; if another acl expansion is used the values
9595 are restored after it returns.  If the ACL sets
9596 a value using a "message =" modifier and returns accept or deny, the value becomes
9597 the result of the expansion.
9598 If no message is set and the ACL returns accept or deny
9599 the expansion result is an empty string.
9600 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9601
9602
9603 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9604 .cindex authentication "results header"
9605 .cindex headers "authentication-results:"
9606 .cindex authentication "expansion item"
9607 This item returns a string suitable for insertion as an
9608 &'Authentication-Results:'&
9609 header line.
9610 The given <&'authserv-id'&> is included in the result; typically this
9611 will be a domain name identifying the system performing the authentications.
9612 Methods that might be present in the result include:
9613 .code
9614 none
9615 iprev
9616 auth
9617 spf
9618 dkim
9619 .endd
9620
9621 Example use (as an ACL modifier):
9622 .code
9623       add_header = :at_start:${authresults {$primary_hostname}}
9624 .endd
9625 This is safe even if no authentication results are available.
9626
9627
9628 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9629        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9630 .cindex "expansion" "extracting certificate fields"
9631 .cindex "&%certextract%&" "certificate fields"
9632 .cindex "certificate" "extracting fields"
9633 The <&'certificate'&> must be a variable of type certificate.
9634 The field name is expanded and used to retrieve the relevant field from
9635 the certificate.  Supported fields are:
9636 .display
9637 &`version        `&
9638 &`serial_number  `&
9639 &`subject        `& RFC4514 DN
9640 &`issuer         `& RFC4514 DN
9641 &`notbefore      `& time
9642 &`notafter       `& time
9643 &`sig_algorithm  `&
9644 &`signature      `&
9645 &`subj_altname   `& tagged list
9646 &`ocsp_uri       `& list
9647 &`crl_uri        `& list
9648 .endd
9649 If the field is found,
9650 <&'string2'&> is expanded, and replaces the whole item;
9651 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9652 variable &$value$& contains the value that has been extracted. Afterwards, it
9653 is restored to any previous value it might have had.
9654
9655 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9656 key is not found. If {<&'string2'&>} is also omitted, the value that was
9657 extracted is used.
9658
9659 Some field names take optional modifiers, appended and separated by commas.
9660
9661 The field selectors marked as "RFC4514" above
9662 output a Distinguished Name string which is
9663 not quite
9664 parseable by Exim as a comma-separated tagged list
9665 (the exceptions being elements containing commas).
9666 RDN elements of a single type may be selected by
9667 a modifier of the type label; if so the expansion
9668 result is a list (newline-separated by default).
9669 The separator may be changed by another modifier of
9670 a right angle-bracket followed immediately by the new separator.
9671 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9672
9673 The field selectors marked as "time" above
9674 take an optional modifier of "int"
9675 for which the result is the number of seconds since epoch.
9676 Otherwise the result is a human-readable string
9677 in the timezone selected by the main "timezone" option.
9678
9679 The field selectors marked as "list" above return a list,
9680 newline-separated by default,
9681 (embedded separator characters in elements are doubled).
9682 The separator may be changed by a modifier of
9683 a right angle-bracket followed immediately by the new separator.
9684
9685 The field selectors marked as "tagged" above
9686 prefix each list element with a type string and an equals sign.
9687 Elements of only one type may be selected by a modifier
9688 which is one of "dns", "uri" or "mail";
9689 if so the element tags are omitted.
9690
9691 If not otherwise noted field values are presented in human-readable form.
9692
9693 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9694        {*&<&'arg'&>&*}...}*&"
9695 .cindex &%dlfunc%&
9696 This expansion dynamically loads and then calls a locally-written C function.
9697 This functionality is available only if Exim is compiled with
9698 .code
9699 EXPAND_DLFUNC=yes
9700 .endd
9701 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9702 object so that it doesn't reload the same object file in the same Exim process
9703 (but of course Exim does start new processes frequently).
9704
9705 There may be from zero to eight arguments to the function.
9706
9707 When compiling
9708 a local function that is to be called in this way,
9709 first &_DLFUNC_IMPL_& should be defined,
9710 and second &_local_scan.h_& should be included.
9711 The Exim variables and functions that are defined by that API
9712 are also available for dynamically loaded functions. The function itself
9713 must have the following type:
9714 .code
9715 int dlfunction(uschar **yield, int argc, uschar *argv[])
9716 .endd
9717 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9718 function should return one of the following values:
9719
9720 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9721 into the expanded string that is being built.
9722
9723 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9724 from &'yield'&, if it is set.
9725
9726 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9727 taken from &'yield'& if it is set.
9728
9729 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9730
9731 When compiling a function that is to be used in this way with gcc,
9732 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9733 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9734
9735
9736 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9737 .cindex "expansion" "extracting value from environment"
9738 .cindex "environment" "values from"
9739 The key is first expanded separately, and leading and trailing white space
9740 removed.
9741 This is then searched for as a name in the environment.
9742 If a variable is found then its value is placed in &$value$&
9743 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9744
9745 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9746 appear, for example:
9747 .code
9748 ${env{USER}{$value} fail }
9749 .endd
9750 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9751 {<&'string1'&>} must be present for &"fail"& to be recognized.
9752
9753 If {<&'string2'&>} is omitted an empty string is substituted on
9754 search failure.
9755 If {<&'string1'&>} is omitted the search result is substituted on
9756 search success.
9757
9758 The environment is adjusted by the &%keep_environment%& and
9759 &%add_environment%& main section options.
9760
9761
9762 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9763        {*&<&'string3'&>&*}}*&"
9764 .cindex "expansion" "extracting substrings by key"
9765 .cindex "&%extract%&" "substrings by key"
9766 The key and <&'string1'&> are first expanded separately. Leading and trailing
9767 white space is removed from the key (but not from any of the strings). The key
9768 must not be empty and must not consist entirely of digits.
9769 The expanded <&'string1'&> must be of the form:
9770 .display
9771 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9772 .endd
9773 .vindex "&$value$&"
9774 where the equals signs and spaces (but not both) are optional. If any of the
9775 values contain white space, they must be enclosed in double quotes, and any
9776 values that are enclosed in double quotes are subject to escape processing as
9777 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9778 for the value that corresponds to the key. The search is case-insensitive. If
9779 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9780 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9781 variable &$value$& contains the value that has been extracted. Afterwards, it
9782 is restored to any previous value it might have had.
9783
9784 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9785 key is not found. If {<&'string2'&>} is also omitted, the value that was
9786 extracted is used. Thus, for example, these two expansions are identical, and
9787 yield &"2001"&:
9788 .code
9789 ${extract{gid}{uid=1984 gid=2001}}
9790 ${extract{gid}{uid=1984 gid=2001}{$value}}
9791 .endd
9792 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9793 appear, for example:
9794 .code
9795 ${extract{Z}{A=... B=...}{$value} fail }
9796 .endd
9797 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9798 {<&'string2'&>} must be present for &"fail"& to be recognized.
9799
9800 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9801        {*&<&'string3'&>&*}}*&" &&&
9802        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9803        {*&<&'string3'&>&*}}*&"
9804 .cindex "expansion" "extracting from JSON object"
9805 .cindex JSON expansions
9806 The key and <&'string1'&> are first expanded separately. Leading and trailing
9807 white space is removed from the key (but not from any of the strings). The key
9808 must not be empty and must not consist entirely of digits.
9809 The expanded <&'string1'&> must be of the form:
9810 .display
9811 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9812 .endd
9813 .vindex "&$value$&"
9814 The braces, commas and colons, and the quoting of the member name are required;
9815 the spaces are optional.
9816 Matching of the key against the member names is done case-sensitively.
9817 For the &"json"& variant,
9818 if a returned value is a JSON string, it retains its leading and
9819 trailing quotes.
9820 For the &"jsons"& variant, which is intended for use with JSON strings, the
9821 leading and trailing quotes are removed from the returned value.
9822 . XXX should be a UTF-8 compare
9823
9824 The results of matching are handled as above.
9825
9826
9827 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9828         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9829 .cindex "expansion" "extracting substrings by number"
9830 .cindex "&%extract%&" "substrings by number"
9831 The <&'number'&> argument must consist entirely of decimal digits,
9832 apart from leading and trailing white space, which is ignored.
9833 This is what distinguishes this form of &%extract%& from the previous kind. It
9834 behaves in the same way, except that, instead of extracting a named field, it
9835 extracts from <&'string1'&> the field whose number is given as the first
9836 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9837 <&'string3'&> as before.
9838
9839 The fields in the string are separated by any one of the characters in the
9840 separator string. These may include space or tab characters.
9841 The first field is numbered one. If the number is negative, the fields are
9842 counted from the end of the string, with the rightmost one numbered -1. If the
9843 number given is zero, the entire string is returned. If the modulus of the
9844 number is greater than the number of fields in the string, the result is the
9845 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9846 provided. For example:
9847 .code
9848 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9849 .endd
9850 yields &"42"&, and
9851 .code
9852 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9853 .endd
9854 yields &"99"&. Two successive separators mean that the field between them is
9855 empty (for example, the fifth field above).
9856
9857
9858 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9859         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9860        "&*${extract jsons{*&<&'number'&>&*}}&&&
9861         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9862 .cindex "expansion" "extracting from JSON array"
9863 .cindex JSON expansions
9864 The <&'number'&> argument must consist entirely of decimal digits,
9865 apart from leading and trailing white space, which is ignored.
9866
9867 Field selection and result handling is as above;
9868 there is no choice of field separator.
9869 For the &"json"& variant,
9870 if a returned value is a JSON string, it retains its leading and
9871 trailing quotes.
9872 For the &"jsons"& variant, which is intended for use with JSON strings, the
9873 leading and trailing quotes are removed from the returned value.
9874
9875
9876 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9877 .cindex "list" "selecting by condition"
9878 .cindex "expansion" "selecting from list by condition"
9879 .vindex "&$item$&"
9880 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9881 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9882 For each item
9883 in this list, its value is place in &$item$&, and then the condition is
9884 evaluated. If the condition is true, &$item$& is added to the output as an
9885 item in a new list; if the condition is false, the item is discarded. The
9886 separator used for the output list is the same as the one used for the
9887 input, but a separator setting is not included in the output. For example:
9888 .code
9889 ${filter{a:b:c}{!eq{$item}{b}}}
9890 .endd
9891 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9892 to what it was before. See also the &%map%& and &%reduce%& expansion items.
9893
9894
9895 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9896 .cindex "hash function" "textual"
9897 .cindex "expansion" "textual hash"
9898 This is a textual hashing function, and was the first to be implemented in
9899 early versions of Exim. In current releases, there are other hashing functions
9900 (numeric, MD5, and SHA-1), which are described below.
9901
9902 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9903 <&'n'&>. If you are using fixed values for these numbers, that is, if
9904 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9905 use the simpler operator notation that avoids some of the braces:
9906 .code
9907 ${hash_<n>_<m>:<string>}
9908 .endd
9909 The second number is optional (in both notations). If <&'n'&> is greater than
9910 or equal to the length of the string, the expansion item returns the string.
9911 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9912 function to the string. The new string consists of characters taken from the
9913 first <&'m'&> characters of the string
9914 .code
9915 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9916 .endd
9917 If <&'m'&> is not present the value 26 is used, so that only lower case
9918 letters appear. For example:
9919 .display
9920 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9921 &`$hash{5}{monty}}           `&   yields  &`monty`&
9922 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9923 .endd
9924
9925 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9926         &*$h_*&<&'header&~name'&>&*:*&" &&&
9927        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9928         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9929        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9930         &*$lh_*&<&'header&~name'&>&*:*&" &&&
9931        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9932         &*$rh_*&<&'header&~name'&>&*:*&"
9933 .cindex "expansion" "header insertion"
9934 .vindex "&$header_$&"
9935 .vindex "&$bheader_$&"
9936 .vindex "&$lheader_$&"
9937 .vindex "&$rheader_$&"
9938 .cindex "header lines" "in expansion strings"
9939 .cindex "header lines" "character sets"
9940 .cindex "header lines" "decoding"
9941 Substitute the contents of the named message header line, for example
9942 .code
9943 $header_reply-to:
9944 .endd
9945 The newline that terminates a header line is not included in the expansion, but
9946 internal newlines (caused by splitting the header line over several physical
9947 lines) may be present.
9948
9949 The difference between the four pairs of expansions is in the way
9950 the data in the header line is interpreted.
9951
9952 .ilist
9953 .cindex "white space" "in header lines"
9954 &%rheader%& gives the original &"raw"& content of the header line, with no
9955 processing at all, and without the removal of leading and trailing white space.
9956
9957 .next
9958 .cindex "list" "of header lines"
9959 &%lheader%& gives a colon-separated list, one element per header when there
9960 are multiple headers with a given name.
9961 Any embedded colon characters within an element are doubled, so normal Exim
9962 list-processing facilities can be used.
9963 The terminating newline of each element is removed; in other respects
9964 the content is &"raw"&.
9965
9966 .next
9967 .cindex "base64 encoding" "in header lines"
9968 &%bheader%& removes leading and trailing white space, and then decodes base64
9969 or quoted-printable MIME &"words"& within the header text, but does no
9970 character set translation. If decoding of what looks superficially like a MIME
9971 &"word"& fails, the raw string is returned. If decoding
9972 .cindex "binary zero" "in header line"
9973 produces a binary zero character, it is replaced by a question mark &-- this is
9974 what Exim does for binary zeros that are actually received in header lines.
9975
9976 .next
9977 &%header%& tries to translate the string as decoded by &%bheader%& to a
9978 standard character set. This is an attempt to produce the same string as would
9979 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9980 returned. Translation is attempted only on operating systems that support the
9981 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9982 a system Makefile or in &_Local/Makefile_&.
9983 .endlist ilist
9984
9985 In a filter file, the target character set for &%header%& can be specified by a
9986 command of the following form:
9987 .code
9988 headers charset "UTF-8"
9989 .endd
9990 This command affects all references to &$h_$& (or &$header_$&) expansions in
9991 subsequently obeyed filter commands. In the absence of this command, the target
9992 character set in a filter is taken from the setting of the &%headers_charset%&
9993 option in the runtime configuration. The value of this option defaults to the
9994 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9995 ISO-8859-1.
9996
9997 Header names follow the syntax of RFC 2822, which states that they may contain
9998 any printing characters except space and colon. Consequently, curly brackets
9999 &'do not'& terminate header names, and should not be used to enclose them as
10000 if they were variables. Attempting to do so causes a syntax error.
10001
10002 Only header lines that are common to all copies of a message are visible to
10003 this mechanism. These are the original header lines that are received with the
10004 message, and any that are added by an ACL statement or by a system
10005 filter. Header lines that are added to a particular copy of a message by a
10006 router or transport are not accessible.
10007
10008 For incoming SMTP messages, no header lines are visible in
10009 ACLs that are obeyed before the data phase completes,
10010 because the header structure is not set up until the message is received.
10011 They are visible in DKIM, PRDR and DATA ACLs.
10012 Header lines that are added in a RCPT ACL (for example)
10013 are saved until the message's incoming header lines are available, at which
10014 point they are added.
10015 When any of the above ACLs ar
10016 running, however, header lines added by earlier ACLs are visible.
10017
10018 Upper case and lower case letters are synonymous in header names. If the
10019 following character is white space, the terminating colon may be omitted, but
10020 this is not recommended, because you may then forget it when it is needed. When
10021 white space terminates the header name, this white space is included in the
10022 expanded string.  If the message does not contain the given header, the
10023 expansion item is replaced by an empty string. (See the &%def%& condition in
10024 section &<<SECTexpcond>>& for a means of testing for the existence of a
10025 header.)
10026
10027 If there is more than one header with the same name, they are all concatenated
10028 to form the substitution string, up to a maximum length of 64K. Unless
10029 &%rheader%& is being used, leading and trailing white space is removed from
10030 each header before concatenation, and a completely empty header is ignored. A
10031 newline character is then inserted between non-empty headers, but there is no
10032 newline at the very end. For the &%header%& and &%bheader%& expansion, for
10033 those headers that contain lists of addresses, a comma is also inserted at the
10034 junctions between headers. This does not happen for the &%rheader%& expansion.
10035
10036 .cindex "tainted data"
10037 When the headers are from an incoming message,
10038 the result of expanding any of these variables is tainted.
10039
10040
10041 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
10042 .cindex "expansion" "hmac hashing"
10043 .cindex &%hmac%&
10044 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
10045 shared secret and some text into a message authentication code, as specified in
10046 RFC 2104. This differs from &`${md5:secret_text...}`& or
10047 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
10048 cryptographic hash, allowing for authentication that is not possible with MD5
10049 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
10050 present. For example:
10051 .code
10052 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
10053 .endd
10054 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
10055 produces:
10056 .code
10057 dd97e3ba5d1a61b5006108f8c8252953
10058 .endd
10059 As an example of how this might be used, you might put in the main part of
10060 an Exim configuration:
10061 .code
10062 SPAMSCAN_SECRET=cohgheeLei2thahw
10063 .endd
10064 In a router or a transport you could then have:
10065 .code
10066 headers_add = \
10067   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
10068   ${hmac{md5}{SPAMSCAN_SECRET}\
10069   {${primary_hostname},${message_exim_id},$h_message-id:}}
10070 .endd
10071 Then given a message, you can check where it was scanned by looking at the
10072 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
10073 this header line is authentic by recomputing the authentication code from the
10074 host name, message ID and the &'Message-id:'& header line. This can be done
10075 using Exim's &%-be%& option, or by other means, for example, by using the
10076 &'hmac_md5_hex()'& function in Perl.
10077
10078
10079 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10080 .cindex "expansion" "conditional"
10081 .cindex "&%if%&, expansion item"
10082 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
10083 item; otherwise <&'string2'&> is used. The available conditions are described
10084 in section &<<SECTexpcond>>& below. For example:
10085 .code
10086 ${if eq {$local_part}{postmaster} {yes}{no} }
10087 .endd
10088 The second string need not be present; if it is not and the condition is not
10089 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
10090 be present instead of the second string (without any curly brackets). In this
10091 case, the expansion is forced to fail if the condition is not true (see section
10092 &<<SECTforexpfai>>&).
10093
10094 If both strings are omitted, the result is the string &`true`& if the condition
10095 is true, and the empty string if the condition is false. This makes it less
10096 cumbersome to write custom ACL and router conditions. For example, instead of
10097 .code
10098 condition = ${if >{$acl_m4}{3}{true}{false}}
10099 .endd
10100 you can use
10101 .code
10102 condition = ${if >{$acl_m4}{3}}
10103 .endd
10104
10105
10106
10107 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
10108 .cindex expansion "imap folder"
10109 .cindex "&%imapfolder%& expansion item"
10110 This item converts a (possibly multilevel, or with non-ASCII characters)
10111 folder specification to a Maildir name for filesystem use.
10112 For information on internationalisation support see &<<SECTi18nMDA>>&.
10113
10114
10115
10116 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10117 .cindex "expansion" "string truncation"
10118 .cindex "&%length%& expansion item"
10119 The &%length%& item is used to extract the initial portion of a string. Both
10120 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
10121 you are using a fixed value for the number, that is, if <&'string1'&> does not
10122 change when expanded, you can use the simpler operator notation that avoids
10123 some of the braces:
10124 .code
10125 ${length_<n>:<string>}
10126 .endd
10127 The result of this item is either the first <&'n'&> bytes or the whole
10128 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
10129 &%strlen%&, which gives the length of a string.
10130 All measurement is done in bytes and is not UTF-8 aware.
10131
10132
10133 .vitem "&*${listextract{*&<&'number'&>&*}&&&
10134         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
10135 .cindex "expansion" "extracting list elements by number"
10136 .cindex "&%listextract%&" "extract list elements by number"
10137 .cindex "list" "extracting elements by number"
10138 The <&'number'&> argument must consist entirely of decimal digits,
10139 apart from an optional leading minus,
10140 and leading and trailing white space (which is ignored).
10141
10142 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10143 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10144
10145 The first field of the list is numbered one.
10146 If the number is negative, the fields are
10147 counted from the end of the list, with the rightmost one numbered -1.
10148 The numbered element of the list is extracted and placed in &$value$&,
10149 then <&'string2'&> is expanded as the result.
10150
10151 If the modulus of the
10152 number is zero or greater than the number of fields in the string,
10153 the result is the expansion of <&'string3'&>.
10154
10155 For example:
10156 .code
10157 ${listextract{2}{x:42:99}}
10158 .endd
10159 yields &"42"&, and
10160 .code
10161 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
10162 .endd
10163 yields &"result: 42"&.
10164
10165 If {<&'string3'&>} is omitted, an empty string is used for string3.
10166 If {<&'string2'&>} is also omitted, the value that was
10167 extracted is used.
10168 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
10169
10170
10171 .new
10172 .vitem &*${listquote{*&<&'separator'&>&*}{*&<&'string'&>&*}}*&
10173 .cindex quoting "for list"
10174 .cindex list quoting
10175 This item doubles any occurrence of the separator character
10176 in the given string.
10177 An empty string is replaced with a single space.
10178 This converts the string into a safe form for use as a list element,
10179 in a list using the given separator.
10180 .wen
10181
10182
10183 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
10184         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10185 This is the first of one of two different types of lookup item, which are both
10186 described in the next item.
10187
10188 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
10189         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
10190 .cindex "expansion" "lookup in"
10191 .cindex "file" "lookups"
10192 .cindex "lookup" "in expanded string"
10193 The two forms of lookup item specify data lookups in files and databases, as
10194 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
10195 lookups, and the second is used for query-style lookups. The <&'key'&>,
10196 <&'file'&>, and <&'query'&> strings are expanded before use.
10197
10198 If there is any white space in a lookup item which is part of a filter command,
10199 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
10200 other place where white space is significant, the lookup item must be enclosed
10201 in double quotes. The use of data lookups in users' filter files may be locked
10202 out by the system administrator.
10203
10204 .vindex "&$value$&"
10205 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
10206 During its expansion, the variable &$value$& contains the data returned by the
10207 lookup. Afterwards it reverts to the value it had previously (at the outer
10208 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
10209 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
10210 string on failure. If <&'string2'&> is provided, it can itself be a nested
10211 lookup, thus providing a mechanism for looking up a default value when the
10212 original lookup fails.
10213
10214 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
10215 data for the outer lookup while the parameters of the second lookup are
10216 expanded, and also while <&'string2'&> of the second lookup is expanded, should
10217 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
10218 appear, and in this case, if the lookup fails, the entire expansion is forced
10219 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
10220 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
10221 successful lookup, and nothing in the case of failure.
10222
10223 For single-key lookups, the string &"partial"& is permitted to precede the
10224 search type in order to do partial matching, and * or *@ may follow a search
10225 type to request default lookups if the key does not match (see sections
10226 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
10227
10228 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
10229 If a partial search is used, the variables &$1$& and &$2$& contain the wild
10230 and non-wild parts of the key during the expansion of the replacement text.
10231 They return to their previous values at the end of the lookup item.
10232
10233 This example looks up the postmaster alias in the conventional alias file:
10234 .code
10235 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
10236 .endd
10237 This example uses NIS+ to look up the full name of the user corresponding to
10238 the local part of an address, forcing the expansion to fail if it is not found:
10239 .code
10240 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
10241   {$value}fail}
10242 .endd
10243
10244
10245 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
10246 .cindex "expansion" "list creation"
10247 .vindex "&$item$&"
10248 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
10249 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10250 For each item
10251 in this list, its value is place in &$item$&, and then <&'string2'&> is
10252 expanded and added to the output as an item in a new list. The separator used
10253 for the output list is the same as the one used for the input, but a separator
10254 setting is not included in the output. For example:
10255 .code
10256 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
10257 .endd
10258 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
10259 value of &$item$& is restored to what it was before. See also the &%filter%&
10260 and &%reduce%& expansion items.
10261
10262 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10263 .cindex "expansion" "numeric hash"
10264 .cindex "hash function" "numeric"
10265 The three strings are expanded; the first two must yield numbers. Call them
10266 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10267 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10268 can use the simpler operator notation that avoids some of the braces:
10269 .code
10270 ${nhash_<n>_<m>:<string>}
10271 .endd
10272 The second number is optional (in both notations). If there is only one number,
10273 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10274 processed by a div/mod hash function that returns two numbers, separated by a
10275 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10276 example,
10277 .code
10278 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10279 .endd
10280 returns the string &"6/33"&.
10281
10282
10283
10284 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10285 .cindex "Perl" "use in expanded string"
10286 .cindex "expansion" "calling Perl from"
10287 This item is available only if Exim has been built to include an embedded Perl
10288 interpreter. The subroutine name and the arguments are first separately
10289 expanded, and then the Perl subroutine is called with those arguments. No
10290 additional arguments need be given; the maximum number permitted, including the
10291 name of the subroutine, is nine.
10292
10293 The return value of the subroutine is inserted into the expanded string, unless
10294 the return value is &%undef%&. In that case, the expansion fails in the same
10295 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10296 Whatever you return is evaluated in a scalar context. For example, if you
10297 return the name of a Perl vector, the return value is the size of the vector,
10298 not its contents.
10299
10300 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10301 with the error message that was passed to &%die%&. More details of the embedded
10302 Perl facility are given in chapter &<<CHAPperl>>&.
10303
10304 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10305 out the use of this expansion item in filter files.
10306
10307
10308 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10309 .cindex "&%prvs%& expansion item"
10310 The first argument is a complete email address and the second is secret
10311 keystring. The third argument, specifying a key number, is optional. If absent,
10312 it defaults to 0. The result of the expansion is a prvs-signed email address,
10313 to be typically used with the &%return_path%& option on an &(smtp)& transport
10314 as part of a bounce address tag validation (BATV) scheme. For more discussion
10315 and an example, see section &<<SECTverifyPRVS>>&.
10316
10317 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10318         {*&<&'string'&>&*}}*&"
10319 .cindex "&%prvscheck%& expansion item"
10320 This expansion item is the complement of the &%prvs%& item. It is used for
10321 checking prvs-signed addresses. If the expansion of the first argument does not
10322 yield a syntactically valid prvs-signed address, the whole item expands to the
10323 empty string. When the first argument does expand to a syntactically valid
10324 prvs-signed address, the second argument is expanded, with the prvs-decoded
10325 version of the address and the key number extracted from the address in the
10326 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10327
10328 These two variables can be used in the expansion of the second argument to
10329 retrieve the secret. The validity of the prvs-signed address is then checked
10330 against the secret. The result is stored in the variable &$prvscheck_result$&,
10331 which is empty for failure or &"1"& for success.
10332
10333 The third argument is optional; if it is missing, it defaults to an empty
10334 string. This argument is now expanded. If the result is an empty string, the
10335 result of the expansion is the decoded version of the address. This is the case
10336 whether or not the signature was valid. Otherwise, the result of the expansion
10337 is the expansion of the third argument.
10338
10339 All three variables can be used in the expansion of the third argument.
10340 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10341 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10342
10343 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10344 .cindex "expansion" "inserting an entire file"
10345 .cindex "file" "inserting into expansion"
10346 .cindex "&%readfile%& expansion item"
10347 The filename and end-of-line string are first expanded separately. The file is
10348 then read, and its contents replace the entire item. All newline characters in
10349 the file are replaced by the end-of-line string if it is present. Otherwise,
10350 newlines are left in the string.
10351 String expansion is not applied to the contents of the file. If you want this,
10352 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10353 the string expansion fails.
10354
10355 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10356 locks out the use of this expansion item in filter files.
10357
10358
10359
10360 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10361         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10362 .cindex "expansion" "inserting from a socket"
10363 .cindex "socket, use of in expansion"
10364 .cindex "&%readsocket%& expansion item"
10365 This item inserts data from a Unix domain or TCP socket into the expanded
10366 string. The minimal way of using it uses just two arguments, as in these
10367 examples:
10368 .code
10369 ${readsocket{/socket/name}{request string}}
10370 ${readsocket{inet:some.host:1234}{request string}}
10371 .endd
10372 For a Unix domain socket, the first substring must be the path to the socket.
10373 For an Internet socket, the first substring must contain &`inet:`& followed by
10374 a host name or IP address, followed by a colon and a port, which can be a
10375 number or the name of a TCP port in &_/etc/services_&. An IP address may
10376 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10377 example:
10378 .code
10379 ${readsocket{inet:[::1]:1234}{request string}}
10380 .endd
10381 Only a single host name may be given, but if looking it up yields more than
10382 one IP address, they are each tried in turn until a connection is made. For
10383 both kinds of socket, Exim makes a connection, writes the request string
10384 unless it is an empty string; and no terminating NUL is ever sent)
10385 and reads from the socket until an end-of-file
10386 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10387 extend what can be done. Firstly, you can vary the timeout. For example:
10388 .code
10389 ${readsocket{/socket/name}{request string}{3s}}
10390 .endd
10391
10392 The third argument is a list of options, of which the first element is the timeout
10393 and must be present if any options are given.
10394 Further elements are options of form &'name=value'&.
10395 Example:
10396 .code
10397 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10398 .endd
10399
10400 The following option names are recognised:
10401 .ilist
10402 &*cache*&
10403 Defines if the result data can be cached for use by a later identical
10404 request in the same process.
10405 Values are &"yes"& or &"no"& (the default).
10406 If not, all cached results for this connection specification
10407 will be invalidated.
10408
10409 .next
10410 &*shutdown*&
10411 Defines whether or not a write-shutdown is done on the connection after
10412 sending the request. Values are &"yes"& (the default) or &"no"&
10413 (preferred, eg. by some webservers).
10414
10415 .next
10416 &*tls*&
10417 Controls the use of TLS on the connection.
10418 Values are &"yes"& or &"no"& (the default).
10419 If it is enabled, a shutdown as descripbed above is never done.
10420 .endlist
10421
10422
10423 A fourth argument allows you to change any newlines that are in the data
10424 that is read, in the same way as for &%readfile%& (see above). This example
10425 turns them into spaces:
10426 .code
10427 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10428 .endd
10429 As with all expansions, the substrings are expanded before the processing
10430 happens. Errors in these sub-expansions cause the expansion to fail. In
10431 addition, the following errors can occur:
10432
10433 .ilist
10434 Failure to create a socket file descriptor;
10435 .next
10436 Failure to connect the socket;
10437 .next
10438 Failure to write the request string;
10439 .next
10440 Timeout on reading from the socket.
10441 .endlist
10442
10443 By default, any of these errors causes the expansion to fail. However, if
10444 you supply a fifth substring, it is expanded and used when any of the above
10445 errors occurs. For example:
10446 .code
10447 ${readsocket{/socket/name}{request string}{3s}{\n}\
10448   {socket failure}}
10449 .endd
10450 You can test for the existence of a Unix domain socket by wrapping this
10451 expansion in &`${if exists`&, but there is a race condition between that test
10452 and the actual opening of the socket, so it is safer to use the fifth argument
10453 if you want to be absolutely sure of avoiding an expansion error for a
10454 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10455
10456 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10457 locks out the use of this expansion item in filter files.
10458
10459
10460 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10461 .cindex "expansion" "reducing a list to a scalar"
10462 .cindex "list" "reducing to a scalar"
10463 .vindex "&$value$&"
10464 .vindex "&$item$&"
10465 This operation reduces a list to a single, scalar string. After expansion,
10466 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10467 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10468 Then <&'string2'&> is expanded and
10469 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10470 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10471 them. The result of that expansion is assigned to &$value$& before the next
10472 iteration. When the end of the list is reached, the final value of &$value$& is
10473 added to the expansion output. The &%reduce%& expansion item can be used in a
10474 number of ways. For example, to add up a list of numbers:
10475 .code
10476 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10477 .endd
10478 The result of that expansion would be &`6`&. The maximum of a list of numbers
10479 can be found:
10480 .code
10481 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10482 .endd
10483 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10484 restored to what they were before. See also the &%filter%& and &%map%&
10485 expansion items.
10486
10487 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10488 This item inserts &"raw"& header lines. It is described with the &%header%&
10489 expansion item in section &<<SECTexpansionitems>>& above.
10490
10491 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10492         {*&<&'string2'&>&*}}*&"
10493 .cindex "expansion" "running a command"
10494 .cindex "&%run%& expansion item"
10495 The command and its arguments are first expanded as one string. The string is
10496 split apart into individual arguments by spaces, and then the command is run
10497 in a separate process, but under the same uid and gid.  As in other command
10498 executions from Exim, a shell is not used by default. If the command requires
10499 a shell, you must explicitly code it.
10500
10501 Since the arguments are split by spaces, when there is a variable expansion
10502 which has an empty result, it will cause the situation that the argument will
10503 simply be omitted when the program is actually executed by Exim. If the
10504 script/program requires a specific number of arguments and the expanded
10505 variable could possibly result in this empty expansion, the variable must be
10506 quoted. This is more difficult if the expanded variable itself could result
10507 in a string containing quotes, because it would interfere with the quotes
10508 around the command arguments. A possible guard against this is to wrap the
10509 variable in the &%sg%& operator to change any quote marks to some other
10510 character.
10511
10512 The standard input for the command exists, but is empty. The standard output
10513 and standard error are set to the same file descriptor.
10514 .cindex "return code" "from &%run%& expansion"
10515 .vindex "&$value$&"
10516 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10517 and replaces the entire item; during this expansion, the standard output/error
10518 from the command is in the variable &$value$&. If the command fails,
10519 <&'string2'&>, if present, is expanded and used. Once again, during the
10520 expansion, the standard output/error from the command is in the variable
10521 &$value$&.
10522
10523 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10524 can be the word &"fail"& (not in braces) to force expansion failure if the
10525 command does not succeed. If both strings are omitted, the result is contents
10526 of the standard output/error on success, and nothing on failure.
10527
10528 .vindex "&$run_in_acl$&"
10529 The standard output/error of the command is put in the variable &$value$&.
10530 In this ACL example, the output of a command is logged for the admin to
10531 troubleshoot:
10532 .code
10533 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10534       log_message  = Output of id: $value
10535 .endd
10536 If the command requires shell idioms, such as the > redirect operator, the
10537 shell must be invoked directly, such as with:
10538 .code
10539 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10540 .endd
10541
10542 .vindex "&$runrc$&"
10543 The return code from the command is put in the variable &$runrc$&, and this
10544 remains set afterwards, so in a filter file you can do things like this:
10545 .code
10546 if "${run{x y z}{}}$runrc" is 1 then ...
10547   elif $runrc is 2 then ...
10548   ...
10549 endif
10550 .endd
10551 If execution of the command fails (for example, the command does not exist),
10552 the return code is 127 &-- the same code that shells use for non-existent
10553 commands.
10554
10555 &*Warning*&: In a router or transport, you cannot assume the order in which
10556 option values are expanded, except for those preconditions whose order of
10557 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10558 by the expansion of one option, and use it in another.
10559
10560 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10561 out the use of this expansion item in filter files.
10562
10563
10564 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10565 .cindex "expansion" "string substitution"
10566 .cindex "&%sg%& expansion item"
10567 This item works like Perl's substitution operator (s) with the global (/g)
10568 option; hence its name. However, unlike the Perl equivalent, Exim does not
10569 modify the subject string; instead it returns the modified string for insertion
10570 into the overall expansion. The item takes three arguments: the subject string,
10571 a regular expression, and a substitution string. For example:
10572 .code
10573 ${sg{abcdefabcdef}{abc}{xyz}}
10574 .endd
10575 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10576 if any $, } or \ characters are required in the regular expression or in the
10577 substitution string, they have to be escaped. For example:
10578 .code
10579 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10580 .endd
10581 yields &"defabc"&, and
10582 .code
10583 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10584 .endd
10585 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10586 the regular expression from string expansion.
10587
10588 The regular expression is compiled in 8-bit mode, working against bytes
10589 rather than any Unicode-aware character handling.
10590
10591
10592 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10593 .cindex sorting "a list"
10594 .cindex list sorting
10595 .cindex expansion "list sorting"
10596 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10597 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10598 The <&'comparator'&> argument is interpreted as the operator
10599 of a two-argument expansion condition.
10600 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10601 The comparison should return true when applied to two values
10602 if the first value should sort before the second value.
10603 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10604 the element being placed in &$item$&,
10605 to give values for comparison.
10606
10607 The item result is a sorted list,
10608 with the original list separator,
10609 of the list elements (in full) of the original.
10610
10611 Examples:
10612 .code
10613 ${sort{3:2:1:4}{<}{$item}}
10614 .endd
10615 sorts a list of numbers, and
10616 .code
10617 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10618 .endd
10619 will sort an MX lookup into priority order.
10620
10621
10622
10623 .new
10624 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
10625 SRS encoding.  See SECT &<<SECTSRS>>& for details.
10626 .wen
10627
10628
10629
10630 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10631 .cindex "&%substr%& expansion item"
10632 .cindex "substring extraction"
10633 .cindex "expansion" "substring extraction"
10634 The three strings are expanded; the first two must yield numbers. Call them
10635 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10636 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10637 can use the simpler operator notation that avoids some of the braces:
10638 .code
10639 ${substr_<n>_<m>:<string>}
10640 .endd
10641 The second number is optional (in both notations).
10642 If it is absent in the simpler format, the preceding underscore must also be
10643 omitted.
10644
10645 The &%substr%& item can be used to extract more general substrings than
10646 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10647 length required. For example
10648 .code
10649 ${substr{3}{2}{$local_part}}
10650 .endd
10651 If the starting offset is greater than the string length the result is the
10652 null string; if the length plus starting offset is greater than the string
10653 length, the result is the right-hand part of the string, starting from the
10654 given offset. The first byte (character) in the string has offset zero.
10655
10656 The &%substr%& expansion item can take negative offset values to count
10657 from the right-hand end of its operand. The last byte (character) is offset -1,
10658 the second-last is offset -2, and so on. Thus, for example,
10659 .code
10660 ${substr{-5}{2}{1234567}}
10661 .endd
10662 yields &"34"&. If the absolute value of a negative offset is greater than the
10663 length of the string, the substring starts at the beginning of the string, and
10664 the length is reduced by the amount of overshoot. Thus, for example,
10665 .code
10666 ${substr{-5}{2}{12}}
10667 .endd
10668 yields an empty string, but
10669 .code
10670 ${substr{-3}{2}{12}}
10671 .endd
10672 yields &"1"&.
10673
10674 When the second number is omitted from &%substr%&, the remainder of the string
10675 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10676 string preceding the offset point are taken. For example, an offset of -1 and
10677 no length, as in these semantically identical examples:
10678 .code
10679 ${substr_-1:abcde}
10680 ${substr{-1}{abcde}}
10681 .endd
10682 yields all but the last character of the string, that is, &"abcd"&.
10683
10684 All measurement is done in bytes and is not UTF-8 aware.
10685
10686
10687
10688 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10689         {*&<&'replacements'&>&*}}*&"
10690 .cindex "expansion" "character translation"
10691 .cindex "&%tr%& expansion item"
10692 This item does single-character (in bytes) translation on its subject string. The second
10693 argument is a list of characters to be translated in the subject string. Each
10694 matching character is replaced by the corresponding character from the
10695 replacement list. For example
10696 .code
10697 ${tr{abcdea}{ac}{13}}
10698 .endd
10699 yields &`1b3de1`&. If there are duplicates in the second character string, the
10700 last occurrence is used. If the third string is shorter than the second, its
10701 last character is replicated. However, if it is empty, no translation takes
10702 place.
10703
10704 All character handling is done in bytes and is not UTF-8 aware.
10705
10706 .endlist
10707
10708
10709
10710 .section "Expansion operators" "SECTexpop"
10711 .cindex "expansion" "operators"
10712 For expansion items that perform transformations on a single argument string,
10713 the &"operator"& notation is used because it is simpler and uses fewer braces.
10714 The substring is first expanded before the operation is applied to it. The
10715 following operations can be performed:
10716
10717 .vlist
10718 .vitem &*${address:*&<&'string'&>&*}*&
10719 .cindex "expansion" "RFC 2822 address handling"
10720 .cindex "&%address%& expansion item"
10721 The string is interpreted as an RFC 2822 address, as it might appear in a
10722 header line, and the effective address is extracted from it. If the string does
10723 not parse successfully, the result is empty.
10724
10725 The parsing correctly handles SMTPUTF8 Unicode in the string.
10726
10727
10728 .vitem &*${addresses:*&<&'string'&>&*}*&
10729 .cindex "expansion" "RFC 2822 address handling"
10730 .cindex "&%addresses%& expansion item"
10731 The string (after expansion) is interpreted as a list of addresses in RFC
10732 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10733 operative address (&'local-part@domain'&) is extracted from each item, and the
10734 result of the expansion is a colon-separated list, with appropriate
10735 doubling of colons should any happen to be present in the email addresses.
10736 Syntactically invalid RFC2822 address items are omitted from the output.
10737
10738 It is possible to specify a character other than colon for the output
10739 separator by starting the string with > followed by the new separator
10740 character. For example:
10741 .code
10742 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10743 .endd
10744 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10745 first, so if the expanded string starts with >, it may change the output
10746 separator unintentionally. This can be avoided by setting the output
10747 separator explicitly:
10748 .code
10749 ${addresses:>:$h_from:}
10750 .endd
10751
10752 Compare the &%address%& (singular)
10753 expansion item, which extracts the working address from a single RFC2822
10754 address. See the &%filter%&, &%map%&, and &%reduce%& items for ways of
10755 processing lists.
10756
10757 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10758 a strict interpretation of header line formatting.  Exim parses the bare,
10759 unquoted portion of an email address and if it finds a comma, treats it as an
10760 email address separator. For the example header line:
10761 .code
10762 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10763 .endd
10764 The first example below demonstrates that Q-encoded email addresses are parsed
10765 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10766 It does not see the comma because it's still encoded as "=2C".  The second
10767 example below is passed the contents of &`$header_from:`&, meaning it gets
10768 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10769 The third example shows that the presence of a comma is skipped when it is
10770 quoted.  The fourth example shows SMTPUTF8 handling.
10771 .code
10772 # exim -be '${addresses:From: \
10773 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10774 user@example.com
10775 # exim -be '${addresses:From: Last, First <user@example.com>}'
10776 Last:user@example.com
10777 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10778 user@example.com
10779 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10780 フィリップ@example.jp
10781 .endd
10782
10783 .vitem &*${base32:*&<&'digits'&>&*}*&
10784 .cindex "&%base32%& expansion item"
10785 .cindex "expansion" "conversion to base 32"
10786 The string must consist entirely of decimal digits. The number is converted to
10787 base 32 and output as a (empty, for zero) string of characters.
10788 Only lowercase letters are used.
10789
10790 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10791 .cindex "&%base32d%& expansion item"
10792 .cindex "expansion" "conversion to base 32"
10793 The string must consist entirely of base-32 digits.
10794 The number is converted to decimal and output as a string.
10795
10796 .vitem &*${base62:*&<&'digits'&>&*}*&
10797 .cindex "&%base62%& expansion item"
10798 .cindex "expansion" "conversion to base 62"
10799 The string must consist entirely of decimal digits. The number is converted to
10800 base 62 and output as a string of six characters, including leading zeros. In
10801 the few operating environments where Exim uses base 36 instead of base 62 for
10802 its message identifiers (because those systems do not have case-sensitive
10803 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10804 to be absolutely clear: this is &'not'& base64 encoding.
10805
10806 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10807 .cindex "&%base62d%& expansion item"
10808 .cindex "expansion" "conversion to base 62"
10809 The string must consist entirely of base-62 digits, or, in operating
10810 environments where Exim uses base 36 instead of base 62 for its message
10811 identifiers, base-36 digits. The number is converted to decimal and output as a
10812 string.
10813
10814 .vitem &*${base64:*&<&'string'&>&*}*&
10815 .cindex "expansion" "base64 encoding"
10816 .cindex "base64 encoding" "in string expansion"
10817 .cindex "&%base64%& expansion item"
10818 .cindex certificate "base64 of DER"
10819 This operator converts a string into one that is base64 encoded.
10820
10821 If the string is a single variable of type certificate,
10822 returns the base64 encoding of the DER form of the certificate.
10823
10824
10825 .vitem &*${base64d:*&<&'string'&>&*}*&
10826 .cindex "expansion" "base64 decoding"
10827 .cindex "base64 decoding" "in string expansion"
10828 .cindex "&%base64d%& expansion item"
10829 This operator converts a base64-encoded string into the un-coded form.
10830
10831
10832 .vitem &*${domain:*&<&'string'&>&*}*&
10833 .cindex "domain" "extraction"
10834 .cindex "expansion" "domain extraction"
10835 The string is interpreted as an RFC 2822 address and the domain is extracted
10836 from it. If the string does not parse successfully, the result is empty.
10837
10838
10839 .vitem &*${escape:*&<&'string'&>&*}*&
10840 .cindex "expansion" "escaping non-printing characters"
10841 .cindex "&%escape%& expansion item"
10842 If the string contains any non-printing characters, they are converted to
10843 escape sequences starting with a backslash. Whether characters with the most
10844 significant bit set (so-called &"8-bit characters"&) count as printing or not
10845 is controlled by the &%print_topbitchars%& option.
10846
10847 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10848 .cindex "expansion" "escaping 8-bit characters"
10849 .cindex "&%escape8bit%& expansion item"
10850 If the string contains and characters with the most significant bit set,
10851 they are converted to escape sequences starting with a backslash.
10852 Backslashes and DEL characters are also converted.
10853
10854
10855 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10856 .cindex "expansion" "expression evaluation"
10857 .cindex "expansion" "arithmetic expression"
10858 .cindex "&%eval%& expansion item"
10859 These items supports simple arithmetic and bitwise logical operations in
10860 expansion strings. The string (after expansion) must be a conventional
10861 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10862 logical operators, and parentheses. All operations are carried out using
10863 integer arithmetic. The operator priorities are as follows (the same as in the
10864 C programming language):
10865 .table2 70pt 300pt
10866 .irow &'highest:'& "not (~), negate (-)"
10867 .irow ""   "multiply (*), divide (/), remainder (%)"
10868 .irow ""   "plus (+), minus (-)"
10869 .irow ""   "shift-left (<<), shift-right (>>)"
10870 .irow ""   "and (&&)"
10871 .irow ""   "xor (^)"
10872 .irow &'lowest:'&  "or (|)"
10873 .endtable
10874 Binary operators with the same priority are evaluated from left to right. White
10875 space is permitted before or after operators.
10876
10877 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10878 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10879 decimal, even if they start with a leading zero; hexadecimal numbers are not
10880 permitted. This can be useful when processing numbers extracted from dates or
10881 times, which often do have leading zeros.
10882
10883 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10884 or 1024*1024*1024,
10885 respectively. Negative numbers are supported. The result of the computation is
10886 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10887
10888 .display
10889 &`${eval:1+1}            `&  yields 2
10890 &`${eval:1+2*3}          `&  yields 7
10891 &`${eval:(1+2)*3}        `&  yields 9
10892 &`${eval:2+42%5}         `&  yields 4
10893 &`${eval:0xc&amp;5}          `&  yields 4
10894 &`${eval:0xc|5}          `&  yields 13
10895 &`${eval:0xc^5}          `&  yields 9
10896 &`${eval:0xc>>1}         `&  yields 6
10897 &`${eval:0xc<<1}         `&  yields 24
10898 &`${eval:~255&amp;0x1234}    `&  yields 4608
10899 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10900 .endd
10901
10902 As a more realistic example, in an ACL you might have
10903 .code
10904 deny   condition =                    \
10905          ${if and {                   \
10906            {>{$rcpt_count}{10}}       \
10907            {                          \
10908            <                          \
10909              {$recipients_count}      \
10910              {${eval:$rcpt_count/2}}  \
10911            }                          \
10912          }{yes}{no}}
10913        message = Too many bad recipients
10914 .endd
10915 The condition is true if there have been more than 10 RCPT commands and
10916 fewer than half of them have resulted in a valid recipient.
10917
10918
10919 .vitem &*${expand:*&<&'string'&>&*}*&
10920 .cindex "expansion" "re-expansion of substring"
10921 The &%expand%& operator causes a string to be expanded for a second time. For
10922 example,
10923 .code
10924 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10925 .endd
10926 first looks up a string in a file while expanding the operand for &%expand%&,
10927 and then re-expands what it has found.
10928
10929
10930 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10931 .cindex "Unicode"
10932 .cindex "UTF-8" "conversion from"
10933 .cindex "expansion" "UTF-8 conversion"
10934 .cindex "&%from_utf8%& expansion item"
10935 The world is slowly moving towards Unicode, although there are no standards for
10936 email yet. However, other applications (including some databases) are starting
10937 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10938 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10939 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10940 the result is an undefined sequence of bytes.
10941
10942 Unicode code points with values less than 256 are compatible with ASCII and
10943 ISO-8859-1 (also known as Latin-1).
10944 For example, character 169 is the copyright symbol in both cases, though the
10945 way it is encoded is different. In UTF-8, more than one byte is needed for
10946 characters with code values greater than 127, whereas ISO-8859-1 is a
10947 single-byte encoding (but thereby limited to 256 characters). This makes
10948 translation from UTF-8 to ISO-8859-1 straightforward.
10949
10950
10951 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10952 .cindex "hash function" "textual"
10953 .cindex "expansion" "textual hash"
10954 The &%hash%& operator is a simpler interface to the hashing function that can
10955 be used when the two parameters are fixed numbers (as opposed to strings that
10956 change when expanded). The effect is the same as
10957 .code
10958 ${hash{<n>}{<m>}{<string>}}
10959 .endd
10960 See the description of the general &%hash%& item above for details. The
10961 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10962
10963
10964
10965 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10966 .cindex "base64 encoding" "conversion from hex"
10967 .cindex "expansion" "hex to base64"
10968 .cindex "&%hex2b64%& expansion item"
10969 This operator converts a hex string into one that is base64 encoded. This can
10970 be useful for processing the output of the various hashing functions.
10971
10972
10973
10974 .vitem &*${hexquote:*&<&'string'&>&*}*&
10975 .cindex "quoting" "hex-encoded unprintable characters"
10976 .cindex "&%hexquote%& expansion item"
10977 This operator converts non-printable characters in a string into a hex
10978 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10979 as is, and other byte values are converted to &`\xNN`&, for example, a
10980 byte value 127 is converted to &`\x7f`&.
10981
10982
10983 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10984 .cindex "&%ipv6denorm%& expansion item"
10985 .cindex "IP address" normalisation
10986 This expands an IPv6 address to a full eight-element colon-separated set
10987 of hex digits including leading zeroes.
10988 A trailing ipv4-style dotted-decimal set is converted to hex.
10989 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10990
10991 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10992 .cindex "&%ipv6norm%& expansion item"
10993 .cindex "IP address" normalisation
10994 .cindex "IP address" "canonical form"
10995 This converts an IPv6 address to canonical form.
10996 Leading zeroes of groups are omitted, and the longest
10997 set of zero-valued groups is replaced with a double colon.
10998 A trailing ipv4-style dotted-decimal set is converted to hex.
10999 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
11000
11001
11002 .vitem &*${lc:*&<&'string'&>&*}*&
11003 .cindex "case forcing in strings"
11004 .cindex "string" "case forcing"
11005 .cindex "lower casing"
11006 .cindex "expansion" "case forcing"
11007 .cindex "&%lc%& expansion item"
11008 This forces the letters in the string into lower-case, for example:
11009 .code
11010 ${lc:$local_part}
11011 .endd
11012 Case is defined per the system C locale.
11013
11014 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
11015 .cindex "expansion" "string truncation"
11016 .cindex "&%length%& expansion item"
11017 The &%length%& operator is a simpler interface to the &%length%& function that
11018 can be used when the parameter is a fixed number (as opposed to a string that
11019 changes when expanded). The effect is the same as
11020 .code
11021 ${length{<number>}{<string>}}
11022 .endd
11023 See the description of the general &%length%& item above for details. Note that
11024 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
11025 when &%length%& is used as an operator.
11026 All measurement is done in bytes and is not UTF-8 aware.
11027
11028
11029 .vitem &*${listcount:*&<&'string'&>&*}*&
11030 .cindex "expansion" "list item count"
11031 .cindex "list" "item count"
11032 .cindex "list" "count of items"
11033 .cindex "&%listcount%& expansion item"
11034 The string is interpreted as a list and the number of items is returned.
11035
11036
11037 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
11038 .cindex "expansion" "named list"
11039 .cindex "&%listnamed%& expansion item"
11040 The name is interpreted as a named list and the content of the list is returned,
11041 expanding any referenced lists, re-quoting as needed for colon-separation.
11042 If the optional type is given it must be one of "a", "d", "h" or "l"
11043 and selects address-, domain-, host- or localpart- lists to search among respectively.
11044 Otherwise all types are searched in an undefined order and the first
11045 matching list is returned.
11046
11047
11048 .vitem &*${local_part:*&<&'string'&>&*}*&
11049 .cindex "expansion" "local part extraction"
11050 .cindex "&%local_part%& expansion item"
11051 The string is interpreted as an RFC 2822 address and the local part is
11052 extracted from it. If the string does not parse successfully, the result is
11053 empty.
11054 The parsing correctly handles SMTPUTF8 Unicode in the string.
11055
11056
11057 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
11058 .cindex "masked IP address"
11059 .cindex "IP address" "masking"
11060 .cindex "CIDR notation"
11061 .cindex "expansion" "IP address masking"
11062 .cindex "&%mask%& expansion item"
11063 If the form of the string to be operated on is not an IP address followed by a
11064 slash and an integer (that is, a network address in CIDR notation), the
11065 expansion fails. Otherwise, this operator converts the IP address to binary,
11066 masks off the least significant bits according to the bit count, and converts
11067 the result back to text, with mask appended. For example,
11068 .code
11069 ${mask:10.111.131.206/28}
11070 .endd
11071 returns the string &"10.111.131.192/28"&. Since this operation is expected to
11072 be mostly used for looking up masked addresses in files, the result for an IPv6
11073 address uses dots to separate components instead of colons, because colon
11074 terminates a key string in lsearch files. So, for example,
11075 .code
11076 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
11077 .endd
11078 returns the string
11079 .code
11080 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
11081 .endd
11082 Letters in IPv6 addresses are always output in lower case.
11083
11084
11085 .vitem &*${md5:*&<&'string'&>&*}*&
11086 .cindex "MD5 hash"
11087 .cindex "expansion" "MD5 hash"
11088 .cindex certificate fingerprint
11089 .cindex "&%md5%& expansion item"
11090 The &%md5%& operator computes the MD5 hash value of the string, and returns it
11091 as a 32-digit hexadecimal number, in which any letters are in lower case.
11092
11093 If the string is a single variable of type certificate,
11094 returns the MD5 hash fingerprint of the certificate.
11095
11096
11097 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
11098 .cindex "expansion" "numeric hash"
11099 .cindex "hash function" "numeric"
11100 The &%nhash%& operator is a simpler interface to the numeric hashing function
11101 that can be used when the two parameters are fixed numbers (as opposed to
11102 strings that change when expanded). The effect is the same as
11103 .code
11104 ${nhash{<n>}{<m>}{<string>}}
11105 .endd
11106 See the description of the general &%nhash%& item above for details.
11107
11108
11109 .vitem &*${quote:*&<&'string'&>&*}*&
11110 .cindex "quoting" "in string expansions"
11111 .cindex "expansion" "quoting"
11112 .cindex "&%quote%& expansion item"
11113 The &%quote%& operator puts its argument into double quotes if it
11114 is an empty string or
11115 contains anything other than letters, digits, underscores, dots, and hyphens.
11116 Any occurrences of double quotes and backslashes are escaped with a backslash.
11117 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
11118 respectively For example,
11119 .code
11120 ${quote:ab"*"cd}
11121 .endd
11122 becomes
11123 .code
11124 "ab\"*\"cd"
11125 .endd
11126 The place where this is useful is when the argument is a substitution from a
11127 variable or a message header.
11128
11129 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
11130 .cindex "&%quote_local_part%& expansion item"
11131 This operator is like &%quote%&, except that it quotes the string only if
11132 required to do so by the rules of RFC 2822 for quoting local parts. For
11133 example, a plus sign would not cause quoting (but it would for &%quote%&).
11134 If you are creating a new email address from the contents of &$local_part$&
11135 (or any other unknown data), you should always use this operator.
11136
11137 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
11138 will likely use the quoting form.
11139 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
11140
11141
11142 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
11143 .cindex "quoting" "lookup-specific"
11144 This operator applies lookup-specific quoting rules to the string. Each
11145 query-style lookup type has its own quoting rules which are described with
11146 the lookups in chapter &<<CHAPfdlookup>>&. For example,
11147 .code
11148 ${quote_ldap:two * two}
11149 .endd
11150 returns
11151 .code
11152 two%20%5C2A%20two
11153 .endd
11154 For single-key lookup types, no quoting is ever necessary and this operator
11155 yields an unchanged string.
11156
11157
11158 .vitem &*${randint:*&<&'n'&>&*}*&
11159 .cindex "random number"
11160 This operator returns a somewhat random number which is less than the
11161 supplied number and is at least 0.  The quality of this randomness depends
11162 on how Exim was built; the values are not suitable for keying material.
11163 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
11164 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
11165 for versions of GnuTLS with that function.
11166 Otherwise, the implementation may be arc4random(), random() seeded by
11167 srandomdev() or srandom(), or a custom implementation even weaker than
11168 random().
11169
11170
11171 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
11172 .cindex "expansion" "IP address"
11173 This operator reverses an IP address; for IPv4 addresses, the result is in
11174 dotted-quad decimal form, while for IPv6 addresses the result is in
11175 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
11176 for DNS.  For example,
11177 .code
11178 ${reverse_ip:192.0.2.4}
11179 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
11180 .endd
11181 returns
11182 .code
11183 4.2.0.192
11184 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
11185 .endd
11186
11187
11188 .vitem &*${rfc2047:*&<&'string'&>&*}*&
11189 .cindex "expansion" "RFC 2047"
11190 .cindex "RFC 2047" "expansion operator"
11191 .cindex "&%rfc2047%& expansion item"
11192 This operator encodes text according to the rules of RFC 2047. This is an
11193 encoding that is used in header lines to encode non-ASCII characters. It is
11194 assumed that the input string is in the encoding specified by the
11195 &%headers_charset%& option, which gets its default at build time. If the string
11196 contains only characters in the range 33&--126, and no instances of the
11197 characters
11198 .code
11199 ? = ( ) < > @ , ; : \ " . [ ] _
11200 .endd
11201 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
11202 string, using as many &"encoded words"& as necessary to encode all the
11203 characters.
11204
11205
11206 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
11207 .cindex "expansion" "RFC 2047"
11208 .cindex "RFC 2047" "decoding"
11209 .cindex "&%rfc2047d%& expansion item"
11210 This operator decodes strings that are encoded as per RFC 2047. Binary zero
11211 bytes are replaced by question marks. Characters are converted into the
11212 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
11213 not recognized unless &%check_rfc2047_length%& is set false.
11214
11215 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
11216 access a header line, RFC 2047 decoding is done automatically. You do not need
11217 to use this operator as well.
11218
11219
11220
11221 .vitem &*${rxquote:*&<&'string'&>&*}*&
11222 .cindex "quoting" "in regular expressions"
11223 .cindex "regular expressions" "quoting"
11224 .cindex "&%rxquote%& expansion item"
11225 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
11226 characters in its argument. This is useful when substituting the values of
11227 variables or headers inside regular expressions.
11228
11229
11230 .vitem &*${sha1:*&<&'string'&>&*}*&
11231 .cindex "SHA-1 hash"
11232 .cindex "expansion" "SHA-1 hashing"
11233 .cindex certificate fingerprint
11234 .cindex "&%sha1%& expansion item"
11235 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
11236 it as a 40-digit hexadecimal number, in which any letters are in upper case.
11237
11238 If the string is a single variable of type certificate,
11239 returns the SHA-1 hash fingerprint of the certificate.
11240
11241
11242 .vitem &*${sha256:*&<&'string'&>&*}*& &&&
11243        &*${sha2:*&<&'string'&>&*}*& &&&
11244        &*${sha2_<n>:*&<&'string'&>&*}*&
11245 .cindex "SHA-256 hash"
11246 .cindex "SHA-2 hash"
11247 .cindex certificate fingerprint
11248 .cindex "expansion" "SHA-256 hashing"
11249 .cindex "&%sha256%& expansion item"
11250 .cindex "&%sha2%& expansion item"
11251 The &%sha256%& operator computes the SHA-256 hash value of the string
11252 and returns
11253 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11254
11255 If the string is a single variable of type certificate,
11256 returns the SHA-256 hash fingerprint of the certificate.
11257
11258 The operator can also be spelled &%sha2%& and does the same as &%sha256%&
11259 (except for certificates, which are not supported).
11260 Finally, if an underbar
11261 and a number is appended it specifies the output length, selecting a
11262 member of the SHA-2 family of hash functions.
11263 Values of 256, 384 and 512 are accepted, with 256 being the default.
11264
11265
11266 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
11267        &*${sha3_<n>:*&<&'string'&>&*}*&
11268 .cindex "SHA3 hash"
11269 .cindex "expansion" "SHA3 hashing"
11270 .cindex "&%sha3%& expansion item"
11271 The &%sha3%& operator computes the SHA3-256 hash value of the string
11272 and returns
11273 it as a 64-digit hexadecimal number, in which any letters are in upper case.
11274
11275 If a number is appended, separated by an underbar, it specifies
11276 the output length.  Values of 224, 256, 384 and 512 are accepted;
11277 with 256 being the default.
11278
11279 The &%sha3%& expansion item is only supported if Exim has been
11280 compiled with GnuTLS 3.5.0 or later,
11281 or OpenSSL 1.1.1 or later.
11282 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
11283
11284
11285 .vitem &*${stat:*&<&'string'&>&*}*&
11286 .cindex "expansion" "statting a file"
11287 .cindex "file" "extracting characteristics"
11288 .cindex "&%stat%& expansion item"
11289 The string, after expansion, must be a file path. A call to the &[stat()]&
11290 function is made for this path. If &[stat()]& fails, an error occurs and the
11291 expansion fails. If it succeeds, the data from the stat replaces the item, as a
11292 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
11293 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
11294 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
11295 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
11296 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
11297 can extract individual fields using the &%extract%& expansion item.
11298
11299 The use of the &%stat%& expansion in users' filter files can be locked out by
11300 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11301 systems for files larger than 2GB.
11302
11303 .vitem &*${str2b64:*&<&'string'&>&*}*&
11304 .cindex "&%str2b64%& expansion item"
11305 Now deprecated, a synonym for the &%base64%& expansion operator.
11306
11307
11308
11309 .vitem &*${strlen:*&<&'string'&>&*}*&
11310 .cindex "expansion" "string length"
11311 .cindex "string" "length in expansion"
11312 .cindex "&%strlen%& expansion item"
11313 The item is replace by the length of the expanded string, expressed as a
11314 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11315 All measurement is done in bytes and is not UTF-8 aware.
11316
11317
11318 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11319 .cindex "&%substr%& expansion item"
11320 .cindex "substring extraction"
11321 .cindex "expansion" "substring expansion"
11322 The &%substr%& operator is a simpler interface to the &%substr%& function that
11323 can be used when the two parameters are fixed numbers (as opposed to strings
11324 that change when expanded). The effect is the same as
11325 .code
11326 ${substr{<start>}{<length>}{<string>}}
11327 .endd
11328 See the description of the general &%substr%& item above for details. The
11329 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11330 All measurement is done in bytes and is not UTF-8 aware.
11331
11332 .vitem &*${time_eval:*&<&'string'&>&*}*&
11333 .cindex "&%time_eval%& expansion item"
11334 .cindex "time interval" "decoding"
11335 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11336 seconds.
11337
11338 .vitem &*${time_interval:*&<&'string'&>&*}*&
11339 .cindex "&%time_interval%& expansion item"
11340 .cindex "time interval" "formatting"
11341 The argument (after sub-expansion) must be a sequence of decimal digits that
11342 represents an interval of time as a number of seconds. It is converted into a
11343 number of larger units and output in Exim's normal time format, for example,
11344 &`1w3d4h2m6s`&.
11345
11346 .vitem &*${uc:*&<&'string'&>&*}*&
11347 .cindex "case forcing in strings"
11348 .cindex "string" "case forcing"
11349 .cindex "upper casing"
11350 .cindex "expansion" "case forcing"
11351 .cindex "&%uc%& expansion item"
11352 This forces the letters in the string into upper-case.
11353 Case is defined per the system C locale.
11354
11355 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11356 .cindex "correction of invalid utf-8 sequences in strings"
11357 .cindex "utf-8" "utf-8 sequences"
11358 .cindex "incorrect utf-8"
11359 .cindex "expansion" "utf-8 forcing"
11360 .cindex "&%utf8clean%& expansion item"
11361 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11362 In versions of Exim before 4.92, this did not correctly do so for a truncated
11363 final codepoint's encoding, and the character would be silently dropped.
11364 If you must handle detection of this scenario across both sets of Exim behavior,
11365 the complexity will depend upon the task.
11366 For instance, to detect if the first character is multibyte and a 1-byte
11367 extraction can be successfully used as a path component (as is common for
11368 dividing up delivery folders), you might use:
11369 .code
11370 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11371 .endd
11372 (which will false-positive if the first character of the local part is a
11373 literal question mark).
11374
11375 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11376        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11377        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11378        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11379 .cindex expansion UTF-8
11380 .cindex UTF-8 expansion
11381 .cindex EAI
11382 .cindex internationalisation
11383 .cindex "&%utf8_domain_to_alabel%& expansion item"
11384 .cindex "&%utf8_domain_from_alabel%& expansion item"
11385 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11386 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11387 These convert EAI mail name components between UTF-8 and a-label forms.
11388 For information on internationalisation support see &<<SECTi18nMTA>>&.
11389 .endlist
11390
11391
11392
11393
11394
11395
11396 .section "Expansion conditions" "SECTexpcond"
11397 .scindex IIDexpcond "expansion" "conditions"
11398 The following conditions are available for testing by the &%${if%& construct
11399 while expanding strings:
11400
11401 .vlist
11402 .vitem &*!*&<&'condition'&>
11403 .cindex "expansion" "negating a condition"
11404 .cindex "negation" "in expansion condition"
11405 Preceding any condition with an exclamation mark negates the result of the
11406 condition.
11407
11408 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11409 .cindex "numeric comparison"
11410 .cindex "expansion" "numeric comparison"
11411 There are a number of symbolic operators for doing numeric comparisons. They
11412 are:
11413 .display
11414 &`=   `&   equal
11415 &`==  `&   equal
11416 &`>   `&   greater
11417 &`>=  `&   greater or equal
11418 &`<   `&   less
11419 &`<=  `&   less or equal
11420 .endd
11421 For example:
11422 .code
11423 ${if >{$message_size}{10M} ...
11424 .endd
11425 Note that the general negation operator provides for inequality testing. The
11426 two strings must take the form of optionally signed decimal integers,
11427 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11428 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11429 As a special case, the numerical value of an empty string is taken as
11430 zero.
11431
11432 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11433 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11434 10M, not if 10M is larger than &$message_size$&.
11435
11436
11437 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11438         {*&<&'arg2'&>&*}...}*&
11439 .cindex "expansion" "calling an acl"
11440 .cindex "&%acl%&" "expansion condition"
11441 The name and zero to nine argument strings are first expanded separately.  The expanded
11442 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11443 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11444 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11445 and may use the variables; if another acl expansion is used the values
11446 are restored after it returns.  If the ACL sets
11447 a value using a "message =" modifier the variable $value becomes
11448 the result of the expansion, otherwise it is empty.
11449 If the ACL returns accept the condition is true; if deny, false.
11450 If the ACL returns defer the result is a forced-fail.
11451
11452 .vitem &*bool&~{*&<&'string'&>&*}*&
11453 .cindex "expansion" "boolean parsing"
11454 .cindex "&%bool%& expansion condition"
11455 This condition turns a string holding a true or false representation into
11456 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11457 (case-insensitively); also integer numbers map to true if non-zero,
11458 false if zero.
11459 An empty string is treated as false.
11460 Leading and trailing whitespace is ignored;
11461 thus a string consisting only of whitespace is false.
11462 All other string values will result in expansion failure.
11463
11464 When combined with ACL variables, this expansion condition will let you
11465 make decisions in one place and act on those decisions in another place.
11466 For example:
11467 .code
11468 ${if bool{$acl_m_privileged_sender} ...
11469 .endd
11470
11471
11472 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11473 .cindex "expansion" "boolean parsing"
11474 .cindex "&%bool_lax%& expansion condition"
11475 Like &%bool%&, this condition turns a string into a boolean state.  But
11476 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11477 loose definition that the Router &%condition%& option uses.  The empty string
11478 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11479 true.  Leading and trailing whitespace is ignored.
11480
11481 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11482
11483 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11484 .cindex "expansion" "encrypted comparison"
11485 .cindex "encrypted strings, comparing"
11486 .cindex "&%crypteq%& expansion condition"
11487 This condition is included in the Exim binary if it is built to support any
11488 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11489 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11490 included in the binary.
11491
11492 The &%crypteq%& condition has two arguments. The first is encrypted and
11493 compared against the second, which is already encrypted. The second string may
11494 be in the LDAP form for storing encrypted strings, which starts with the
11495 encryption type in curly brackets, followed by the data. If the second string
11496 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11497 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11498 Typically this will be a field from a password file. An example of an encrypted
11499 string in LDAP form is:
11500 .code
11501 {md5}CY9rzUYh03PK3k6DJie09g==
11502 .endd
11503 If such a string appears directly in an expansion, the curly brackets have to
11504 be quoted, because they are part of the expansion syntax. For example:
11505 .code
11506 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11507 .endd
11508 The following encryption types (whose names are matched case-independently) are
11509 supported:
11510
11511 .ilist
11512 .cindex "MD5 hash"
11513 .cindex "base64 encoding" "in encrypted password"
11514 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11515 printable characters to compare with the remainder of the second string. If the
11516 length of the comparison string is 24, Exim assumes that it is base64 encoded
11517 (as in the above example). If the length is 32, Exim assumes that it is a
11518 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11519 comparison fails.
11520
11521 .next
11522 .cindex "SHA-1 hash"
11523 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11524 printable characters to compare with the remainder of the second string. If the
11525 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11526 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11527 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11528
11529 .next
11530 .cindex "&[crypt()]&"
11531 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11532 only the first eight characters of the password. However, in modern operating
11533 systems this is no longer true, and in many cases the entire password is used,
11534 whatever its length.
11535
11536 .next
11537 .cindex "&[crypt16()]&"
11538 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11539 use up to 16 characters of the password in some operating systems. Again, in
11540 modern operating systems, more characters may be used.
11541 .endlist
11542 Exim has its own version of &[crypt16()]&, which is just a double call to
11543 &[crypt()]&. For operating systems that have their own version, setting
11544 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11545 operating system version instead of its own. This option is set by default in
11546 the OS-dependent &_Makefile_& for those operating systems that are known to
11547 support &[crypt16()]&.
11548
11549 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11550 it was not using the same algorithm as some operating systems' versions. It
11551 turns out that as well as &[crypt16()]& there is a function called
11552 &[bigcrypt()]& in some operating systems. This may or may not use the same
11553 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11554
11555 However, since there is now a move away from the traditional &[crypt()]&
11556 functions towards using SHA1 and other algorithms, tidying up this area of
11557 Exim is seen as very low priority.
11558
11559 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11560 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11561 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11562 default is &`{crypt}`&. Whatever the default, you can always use either
11563 function by specifying it explicitly in curly brackets.
11564
11565 .vitem &*def:*&<&'variable&~name'&>
11566 .cindex "expansion" "checking for empty variable"
11567 .cindex "&%def%& expansion condition"
11568 The &%def%& condition must be followed by the name of one of the expansion
11569 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11570 variable does not contain the empty string. For example:
11571 .code
11572 ${if def:sender_ident {from $sender_ident}}
11573 .endd
11574 Note that the variable name is given without a leading &%$%& character. If the
11575 variable does not exist, the expansion fails.
11576
11577 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11578         &~&*def:h_*&<&'header&~name'&>&*:*&"
11579 .cindex "expansion" "checking header line existence"
11580 This condition is true if a message is being processed and the named header
11581 exists in the message. For example,
11582 .code
11583 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11584 .endd
11585 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11586 the header name must be terminated by a colon if white space does not follow.
11587
11588 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11589        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11590 .cindex "string" "comparison"
11591 .cindex "expansion" "string comparison"
11592 .cindex "&%eq%& expansion condition"
11593 .cindex "&%eqi%& expansion condition"
11594 The two substrings are first expanded. The condition is true if the two
11595 resulting strings are identical. For &%eq%& the comparison includes the case of
11596 letters, whereas for &%eqi%& the comparison is case-independent, where
11597 case is defined per the system C locale.
11598
11599 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11600 .cindex "expansion" "file existence test"
11601 .cindex "file" "existence test"
11602 .cindex "&%exists%&, expansion condition"
11603 The substring is first expanded and then interpreted as an absolute path. The
11604 condition is true if the named file (or directory) exists. The existence test
11605 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11606 users' filter files may be locked out by the system administrator.
11607
11608 .vitem &*first_delivery*&
11609 .cindex "delivery" "first"
11610 .cindex "first delivery"
11611 .cindex "expansion" "first delivery test"
11612 .cindex "&%first_delivery%& expansion condition"
11613 This condition, which has no data, is true during a message's first delivery
11614 attempt. It is false during any subsequent delivery attempts.
11615
11616
11617 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11618        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11619 .cindex "list" "iterative conditions"
11620 .cindex "expansion" "&*forall*& condition"
11621 .cindex "expansion" "&*forany*& condition"
11622 .vindex "&$item$&"
11623 These conditions iterate over a list. The first argument is expanded to form
11624 the list. By default, the list separator is a colon, but it can be changed by
11625 the normal method (&<<SECTlistsepchange>>&).
11626 The second argument is interpreted as a condition that is to
11627 be applied to each item in the list in turn. During the interpretation of the
11628 condition, the current list item is placed in a variable called &$item$&.
11629 .ilist
11630 For &*forany*&, interpretation stops if the condition is true for any item, and
11631 the result of the whole condition is true. If the condition is false for all
11632 items in the list, the overall condition is false.
11633 .next
11634 For &*forall*&, interpretation stops if the condition is false for any item,
11635 and the result of the whole condition is false. If the condition is true for
11636 all items in the list, the overall condition is true.
11637 .endlist
11638 Note that negation of &*forany*& means that the condition must be false for all
11639 items for the overall condition to succeed, and negation of &*forall*& means
11640 that the condition must be false for at least one item. In this example, the
11641 list separator is changed to a comma:
11642 .code
11643 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11644 .endd
11645 The value of &$item$& is saved and restored while &%forany%& or &%forall%& is
11646 being processed, to enable these expansion items to be nested.
11647
11648 To scan a named list, expand it with the &*listnamed*& operator.
11649
11650 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11651        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11652        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11653        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11654 .cindex JSON "iterative conditions"
11655 .cindex JSON expansions
11656 .cindex expansion "&*forall_json*& condition"
11657 .cindex expansion "&*forany_json*& condition"
11658 .cindex expansion "&*forall_jsons*& condition"
11659 .cindex expansion "&*forany_jsons*& condition"
11660 As for the above, except that the first argument must, after expansion,
11661 be a JSON array.
11662 The array separator is not changeable.
11663 For the &"jsons"& variants the elements are expected to be JSON strings
11664 and have their quotes removed before the evaluation of the condition.
11665
11666
11667
11668 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11669        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11670 .cindex "string" "comparison"
11671 .cindex "expansion" "string comparison"
11672 .cindex "&%ge%& expansion condition"
11673 .cindex "&%gei%& expansion condition"
11674 The two substrings are first expanded. The condition is true if the first
11675 string is lexically greater than or equal to the second string. For &%ge%& the
11676 comparison includes the case of letters, whereas for &%gei%& the comparison is
11677 case-independent.
11678 Case and collation order are defined per the system C locale.
11679
11680 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11681        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11682 .cindex "string" "comparison"
11683 .cindex "expansion" "string comparison"
11684 .cindex "&%gt%& expansion condition"
11685 .cindex "&%gti%& expansion condition"
11686 The two substrings are first expanded. The condition is true if the first
11687 string is lexically greater than the second string. For &%gt%& the comparison
11688 includes the case of letters, whereas for &%gti%& the comparison is
11689 case-independent.
11690 Case and collation order are defined per the system C locale.
11691
11692
11693 .new
11694 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
11695 SRS decode.  See SECT &<<SECTSRS>>& for details.
11696 .wen
11697
11698
11699 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11700        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11701 .cindex "string" "comparison"
11702 .cindex "list" "iterative conditions"
11703 Both strings are expanded; the second string is treated as a list of simple
11704 strings; if the first string is a member of the second, then the condition
11705 is true.
11706 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11707
11708 These are simpler to use versions of the more powerful &*forany*& condition.
11709 Examples, and the &*forany*& equivalents:
11710 .code
11711 ${if inlist{needle}{foo:needle:bar}}
11712   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11713 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11714   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11715 .endd
11716
11717 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11718        &*isip4&~{*&<&'string'&>&*}*& &&&
11719        &*isip6&~{*&<&'string'&>&*}*&
11720 .cindex "IP address" "testing string format"
11721 .cindex "string" "testing for IP address"
11722 .cindex "&%isip%& expansion condition"
11723 .cindex "&%isip4%& expansion condition"
11724 .cindex "&%isip6%& expansion condition"
11725 The substring is first expanded, and then tested to see if it has the form of
11726 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11727 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11728
11729 For an IPv4 address, the test is for four dot-separated components, each of
11730 which consists of from one to three digits. For an IPv6 address, up to eight
11731 colon-separated components are permitted, each containing from one to four
11732 hexadecimal digits. There may be fewer than eight components if an empty
11733 component (adjacent colons) is present. Only one empty component is permitted.
11734
11735 &*Note*&: The checks used to be just on the form of the address; actual numerical
11736 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11737 check.
11738 This is no longer the case.
11739
11740 The main use of these tests is to distinguish between IP addresses and
11741 host names, or between IPv4 and IPv6 addresses. For example, you could use
11742 .code
11743 ${if isip4{$sender_host_address}...
11744 .endd
11745 to test which IP version an incoming SMTP connection is using.
11746
11747 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11748 .cindex "LDAP" "use for authentication"
11749 .cindex "expansion" "LDAP authentication test"
11750 .cindex "&%ldapauth%& expansion condition"
11751 This condition supports user authentication using LDAP. See section
11752 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11753 queries. For this use, the query must contain a user name and password. The
11754 query itself is not used, and can be empty. The condition is true if the
11755 password is not empty, and the user name and password are accepted by the LDAP
11756 server. An empty password is rejected without calling LDAP because LDAP binds
11757 with an empty password are considered anonymous regardless of the username, and
11758 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11759 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11760 this can be used.
11761
11762
11763 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11764        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11765 .cindex "string" "comparison"
11766 .cindex "expansion" "string comparison"
11767 .cindex "&%le%& expansion condition"
11768 .cindex "&%lei%& expansion condition"
11769 The two substrings are first expanded. The condition is true if the first
11770 string is lexically less than or equal to the second string. For &%le%& the
11771 comparison includes the case of letters, whereas for &%lei%& the comparison is
11772 case-independent.
11773 Case and collation order are defined per the system C locale.
11774
11775 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11776        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11777 .cindex "string" "comparison"
11778 .cindex "expansion" "string comparison"
11779 .cindex "&%lt%& expansion condition"
11780 .cindex "&%lti%& expansion condition"
11781 The two substrings are first expanded. The condition is true if the first
11782 string is lexically less than the second string. For &%lt%& the comparison
11783 includes the case of letters, whereas for &%lti%& the comparison is
11784 case-independent.
11785 Case and collation order are defined per the system C locale.
11786
11787
11788 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11789 .cindex "expansion" "regular expression comparison"
11790 .cindex "regular expressions" "match in expanded string"
11791 .cindex "&%match%& expansion condition"
11792 The two substrings are first expanded. The second is then treated as a regular
11793 expression and applied to the first. Because of the pre-expansion, if the
11794 regular expression contains dollar, or backslash characters, they must be
11795 escaped. Care must also be taken if the regular expression contains braces
11796 (curly brackets). A closing brace must be escaped so that it is not taken as a
11797 premature termination of <&'string2'&>. The easiest approach is to use the
11798 &`\N`& feature to disable expansion of the regular expression.
11799 For example,
11800 .code
11801 ${if match {$local_part}{\N^\d{3}\N} ...
11802 .endd
11803 If the whole expansion string is in double quotes, further escaping of
11804 backslashes is also required.
11805
11806 The condition is true if the regular expression match succeeds.
11807 The regular expression is not required to begin with a circumflex
11808 metacharacter, but if there is no circumflex, the expression is not anchored,
11809 and it may match anywhere in the subject, not just at the start. If you want
11810 the pattern to match at the end of the subject, you must include the &`$`&
11811 metacharacter at an appropriate point.
11812 All character handling is done in bytes and is not UTF-8 aware,
11813 but we might change this in a future Exim release.
11814
11815 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11816 At the start of an &%if%& expansion the values of the numeric variable
11817 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11818 succeeds causes them to be reset to the substrings of that condition and they
11819 will have these values during the expansion of the success string. At the end
11820 of the &%if%& expansion, the previous values are restored. After testing a
11821 combination of conditions using &%or%&, the subsequent values of the numeric
11822 variables are those of the condition that succeeded.
11823
11824 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11825 .cindex "&%match_address%& expansion condition"
11826 See &*match_local_part*&.
11827
11828 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11829 .cindex "&%match_domain%& expansion condition"
11830 See &*match_local_part*&.
11831
11832 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11833 .cindex "&%match_ip%& expansion condition"
11834 This condition matches an IP address to a list of IP address patterns. It must
11835 be followed by two argument strings. The first (after expansion) must be an IP
11836 address or an empty string. The second (not expanded) is a restricted host
11837 list that can match only an IP address, not a host name. For example:
11838 .code
11839 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11840 .endd
11841 The specific types of host list item that are permitted in the list are:
11842
11843 .ilist
11844 An IP address, optionally with a CIDR mask.
11845 .next
11846 A single asterisk, which matches any IP address.
11847 .next
11848 An empty item, which matches only if the IP address is empty. This could be
11849 useful for testing for a locally submitted message or one from specific hosts
11850 in a single test such as
11851 . ==== As this is a nested list, any displays it contains must be indented
11852 . ==== as otherwise they are too far to the left. This comment applies to
11853 . ==== the use of xmlto plus fop. There's no problem when formatting with
11854 . ==== sdop, with or without the extra indent.
11855 .code
11856   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11857 .endd
11858 where the first item in the list is the empty string.
11859 .next
11860 The item @[] matches any of the local host's interface addresses.
11861 .next
11862 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11863 even if &`net-`& is not specified. There is never any attempt to turn the IP
11864 address into a host name. The most common type of linear search for
11865 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11866 masks. For example:
11867 .code
11868   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11869 .endd
11870 It is of course possible to use other kinds of lookup, and in such a case, you
11871 do need to specify the &`net-`& prefix if you want to specify a specific
11872 address mask, for example:
11873 .code
11874   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11875 .endd
11876 However, unless you are combining a &%match_ip%& condition with others, it is
11877 just as easy to use the fact that a lookup is itself a condition, and write:
11878 .code
11879   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11880 .endd
11881 .endlist ilist
11882
11883 Note that <&'string2'&> is not itself subject to string expansion, unless
11884 Exim was built with the EXPAND_LISTMATCH_RHS option.
11885
11886 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11887
11888 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11889 .cindex "domain list" "in expansion condition"
11890 .cindex "address list" "in expansion condition"
11891 .cindex "local part" "list, in expansion condition"
11892 .cindex "&%match_local_part%& expansion condition"
11893 This condition, together with &%match_address%& and &%match_domain%&, make it
11894 possible to test domain, address, and local part lists within expansions. Each
11895 condition requires two arguments: an item and a list to match. A trivial
11896 example is:
11897 .code
11898 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11899 .endd
11900 In each case, the second argument may contain any of the allowable items for a
11901 list of the appropriate type. Also, because the second argument
11902 is a standard form of list, it is possible to refer to a named list.
11903 Thus, you can use conditions like this:
11904 .code
11905 ${if match_domain{$domain}{+local_domains}{...
11906 .endd
11907 .cindex "&`+caseful`&"
11908 For address lists, the matching starts off caselessly, but the &`+caseful`&
11909 item can be used, as in all address lists, to cause subsequent items to
11910 have their local parts matched casefully. Domains are always matched
11911 caselessly.
11912
11913 Note that <&'string2'&> is not itself subject to string expansion, unless
11914 Exim was built with the EXPAND_LISTMATCH_RHS option.
11915
11916 &*Note*&: Host lists are &'not'& supported in this way. This is because
11917 hosts have two identities: a name and an IP address, and it is not clear
11918 how to specify cleanly how such a test would work. However, IP addresses can be
11919 matched using &%match_ip%&.
11920
11921 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11922 .cindex "PAM authentication"
11923 .cindex "AUTH" "with PAM"
11924 .cindex "Solaris" "PAM support"
11925 .cindex "expansion" "PAM authentication test"
11926 .cindex "&%pam%& expansion condition"
11927 &'Pluggable Authentication Modules'&
11928 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11929 available in the latest releases of Solaris and in some GNU/Linux
11930 distributions. The Exim support, which is intended for use in conjunction with
11931 the SMTP AUTH command, is available only if Exim is compiled with
11932 .code
11933 SUPPORT_PAM=yes
11934 .endd
11935 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11936 in some releases of GNU/Linux &%-ldl%& is also needed.
11937
11938 The argument string is first expanded, and the result must be a
11939 colon-separated list of strings. Leading and trailing white space is ignored.
11940 The PAM module is initialized with the service name &"exim"& and the user name
11941 taken from the first item in the colon-separated data string (<&'string1'&>).
11942 The remaining items in the data string are passed over in response to requests
11943 from the authentication function. In the simple case there will only be one
11944 request, for a password, so the data consists of just two strings.
11945
11946 There can be problems if any of the strings are permitted to contain colon
11947 characters. In the usual way, these have to be doubled to avoid being taken as
11948 separators.
11949 The &%listquote%& expansion item can be used for this.
11950 For example, the configuration
11951 of a LOGIN authenticator might contain this setting:
11952 .code
11953 server_condition = ${if pam{$auth1:${listquote{:}{$auth2}}}}
11954 .endd
11955 In some operating systems, PAM authentication can be done only from a process
11956 running as root. Since Exim is running as the Exim user when receiving
11957 messages, this means that PAM cannot be used directly in those systems.
11958 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11959
11960
11961 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11962 .cindex "&'pwcheck'& daemon"
11963 .cindex "Cyrus"
11964 .cindex "expansion" "&'pwcheck'& authentication test"
11965 .cindex "&%pwcheck%& expansion condition"
11966 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11967 This is one way of making it possible for passwords to be checked by a process
11968 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11969 deprecated. Its replacement is &'saslauthd'& (see below).
11970
11971 The pwcheck support is not included in Exim by default. You need to specify
11972 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11973 building Exim. For example:
11974 .code
11975 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11976 .endd
11977 You do not need to install the full Cyrus software suite in order to use
11978 the pwcheck daemon. You can compile and install just the daemon alone
11979 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11980 access to the &_/var/pwcheck_& directory.
11981
11982 The &%pwcheck%& condition takes one argument, which must be the user name and
11983 password, separated by a colon. For example, in a LOGIN authenticator
11984 configuration, you might have this:
11985 .code
11986 server_condition = ${if pwcheck{$auth1:$auth2}}
11987 .endd
11988 Again, for a PLAIN authenticator configuration, this would be:
11989 .code
11990 server_condition = ${if pwcheck{$auth2:$auth3}}
11991 .endd
11992 .vitem &*queue_running*&
11993 .cindex "queue runner" "detecting when delivering from"
11994 .cindex "expansion" "queue runner test"
11995 .cindex "&%queue_running%& expansion condition"
11996 This condition, which has no data, is true during delivery attempts that are
11997 initiated by queue runner processes, and false otherwise.
11998
11999
12000 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
12001 .cindex "Radius"
12002 .cindex "expansion" "Radius authentication"
12003 .cindex "&%radius%& expansion condition"
12004 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
12005 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
12006 the Radius client configuration file in order to build Exim with Radius
12007 support.
12008
12009 With just that one setting, Exim expects to be linked with the &%radiusclient%&
12010 library, using the original API. If you are using release 0.4.0 or later of
12011 this library, you need to set
12012 .code
12013 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
12014 .endd
12015 in &_Local/Makefile_& when building Exim. You can also link Exim with the
12016 &%libradius%& library that comes with FreeBSD. To do this, set
12017 .code
12018 RADIUS_LIB_TYPE=RADLIB
12019 .endd
12020 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
12021 You may also have to supply a suitable setting in EXTRALIBS so that the
12022 Radius library can be found when Exim is linked.
12023
12024 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
12025 Radius client library, which calls the Radius server. The condition is true if
12026 the authentication is successful. For example:
12027 .code
12028 server_condition = ${if radius{<arguments>}}
12029 .endd
12030
12031
12032 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
12033         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
12034 .cindex "&'saslauthd'& daemon"
12035 .cindex "Cyrus"
12036 .cindex "expansion" "&'saslauthd'& authentication test"
12037 .cindex "&%saslauthd%& expansion condition"
12038 This condition supports user authentication using the Cyrus &'saslauthd'&
12039 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
12040 Using this daemon is one way of making it possible for passwords to be checked
12041 by a process that is not running as root.
12042
12043 The saslauthd support is not included in Exim by default. You need to specify
12044 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
12045 building Exim. For example:
12046 .code
12047 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
12048 .endd
12049 You do not need to install the full Cyrus software suite in order to use
12050 the saslauthd daemon. You can compile and install just the daemon alone
12051 from the Cyrus SASL library.
12052
12053 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
12054 two are mandatory. For example:
12055 .code
12056 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
12057 .endd
12058 The service and the realm are optional (which is why the arguments are enclosed
12059 in their own set of braces). For details of the meaning of the service and
12060 realm, and how to run the daemon, consult the Cyrus documentation.
12061 .endlist vlist
12062
12063
12064
12065 .section "Combining expansion conditions" "SECID84"
12066 .cindex "expansion" "combining conditions"
12067 Several conditions can be tested at once by combining them using the &%and%&
12068 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
12069 conditions on their own, and precede their lists of sub-conditions. Each
12070 sub-condition must be enclosed in braces within the overall braces that contain
12071 the list. No repetition of &%if%& is used.
12072
12073
12074 .vlist
12075 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12076 .cindex "&""or""& expansion condition"
12077 .cindex "expansion" "&""or""& of conditions"
12078 The sub-conditions are evaluated from left to right. The condition is true if
12079 any one of the sub-conditions is true.
12080 For example,
12081 .code
12082 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
12083 .endd
12084 When a true sub-condition is found, the following ones are parsed but not
12085 evaluated. If there are several &"match"& sub-conditions the values of the
12086 numeric variables afterwards are taken from the first one that succeeds.
12087
12088 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
12089 .cindex "&""and""& expansion condition"
12090 .cindex "expansion" "&""and""& of conditions"
12091 The sub-conditions are evaluated from left to right. The condition is true if
12092 all of the sub-conditions are true. If there are several &"match"&
12093 sub-conditions, the values of the numeric variables afterwards are taken from
12094 the last one. When a false sub-condition is found, the following ones are
12095 parsed but not evaluated.
12096 .endlist
12097 .ecindex IIDexpcond
12098
12099
12100
12101
12102 .section "Expansion variables" "SECTexpvar"
12103 .cindex "expansion" "variables, list of"
12104 This section contains an alphabetical list of all the expansion variables. Some
12105 of them are available only when Exim is compiled with specific options such as
12106 support for TLS or the content scanning extension.
12107
12108 .vlist
12109 .vitem "&$0$&, &$1$&, etc"
12110 .cindex "numerical variables (&$1$& &$2$& etc)"
12111 When a &%match%& expansion condition succeeds, these variables contain the
12112 captured substrings identified by the regular expression during subsequent
12113 processing of the success string of the containing &%if%& expansion item.
12114 In the expansion condition case
12115 they do not retain their values afterwards; in fact, their previous
12116 values are restored at the end of processing an &%if%& item. The numerical
12117 variables may also be set externally by some other matching process which
12118 precedes the expansion of the string. For example, the commands available in
12119 Exim filter files include an &%if%& command with its own regular expression
12120 matching condition.
12121
12122 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
12123 Within an acl condition, expansion condition or expansion item
12124 any arguments are copied to these variables,
12125 any unused variables being made empty.
12126
12127 .vitem "&$acl_c...$&"
12128 Values can be placed in these variables by the &%set%& modifier in an ACL. They
12129 can be given any name that starts with &$acl_c$& and is at least six characters
12130 long, but the sixth character must be either a digit or an underscore. For
12131 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
12132 variables persist throughout the lifetime of an SMTP connection. They can be
12133 used to pass information between ACLs and between different invocations of the
12134 same ACL. When a message is received, the values of these variables are saved
12135 with the message, and can be accessed by filters, routers, and transports
12136 during subsequent delivery.
12137
12138 .vitem "&$acl_m...$&"
12139 These variables are like the &$acl_c...$& variables, except that their values
12140 are reset after a message has been received. Thus, if several messages are
12141 received in one SMTP connection, &$acl_m...$& values are not passed on from one
12142 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
12143 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
12144 message is received, the values of these variables are saved with the message,
12145 and can be accessed by filters, routers, and transports during subsequent
12146 delivery.
12147
12148 .vitem &$acl_narg$&
12149 Within an acl condition, expansion condition or expansion item
12150 this variable has the number of arguments.
12151
12152 .vitem &$acl_verify_message$&
12153 .vindex "&$acl_verify_message$&"
12154 After an address verification has failed, this variable contains the failure
12155 message. It retains its value for use in subsequent modifiers. The message can
12156 be preserved by coding like this:
12157 .code
12158 warn !verify = sender
12159      set acl_m0 = $acl_verify_message
12160 .endd
12161 You can use &$acl_verify_message$& during the expansion of the &%message%& or
12162 &%log_message%& modifiers, to include information about the verification
12163 failure.
12164
12165 .vitem &$address_data$&
12166 .vindex "&$address_data$&"
12167 This variable is set by means of the &%address_data%& option in routers. The
12168 value then remains with the address while it is processed by subsequent routers
12169 and eventually a transport. If the transport is handling multiple addresses,
12170 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
12171 for more details. &*Note*&: The contents of &$address_data$& are visible in
12172 user filter files.
12173
12174 If &$address_data$& is set when the routers are called from an ACL to verify
12175 a recipient address, the final value is still in the variable for subsequent
12176 conditions and modifiers of the ACL statement. If routing the address caused it
12177 to be redirected to just one address, the child address is also routed as part
12178 of the verification, and in this case the final value of &$address_data$& is
12179 from the child's routing.
12180
12181 If &$address_data$& is set when the routers are called from an ACL to verify a
12182 sender address, the final value is also preserved, but this time in
12183 &$sender_address_data$&, to distinguish it from data from a recipient
12184 address.
12185
12186 In both cases (recipient and sender verification), the value does not persist
12187 after the end of the current ACL statement. If you want to preserve
12188 these values for longer, you can save them in ACL variables.
12189
12190 .vitem &$address_file$&
12191 .vindex "&$address_file$&"
12192 When, as a result of aliasing, forwarding, or filtering, a message is directed
12193 to a specific file, this variable holds the name of the file when the transport
12194 is running. At other times, the variable is empty. For example, using the
12195 default configuration, if user &%r2d2%& has a &_.forward_& file containing
12196 .code
12197 /home/r2d2/savemail
12198 .endd
12199 then when the &(address_file)& transport is running, &$address_file$&
12200 contains the text string &`/home/r2d2/savemail`&.
12201 .cindex "Sieve filter" "value of &$address_file$&"
12202 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
12203 then up to the transport configuration to generate an appropriate absolute path
12204 to the relevant file.
12205
12206 .vitem &$address_pipe$&
12207 .vindex "&$address_pipe$&"
12208 When, as a result of aliasing or forwarding, a message is directed to a pipe,
12209 this variable holds the pipe command when the transport is running.
12210
12211 .vitem "&$auth1$& &-- &$auth3$&"
12212 .vindex "&$auth1$&, &$auth2$&, etc"
12213 These variables are used in SMTP authenticators (see chapters
12214 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
12215
12216 .vitem &$authenticated_id$&
12217 .cindex "authentication" "id"
12218 .vindex "&$authenticated_id$&"
12219 When a server successfully authenticates a client it may be configured to
12220 preserve some of the authentication information in the variable
12221 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
12222 user/password authenticator configuration might preserve the user name for use
12223 in the routers. Note that this is not the same information that is saved in
12224 &$sender_host_authenticated$&.
12225
12226 When a message is submitted locally (that is, not over a TCP connection)
12227 the value of &$authenticated_id$& is normally the login name of the calling
12228 process. However, a trusted user can override this by means of the &%-oMai%&
12229 command line option.
12230 This second case also sets up information used by the
12231 &$authresults$& expansion item.
12232
12233 .vitem &$authenticated_fail_id$&
12234 .cindex "authentication" "fail" "id"
12235 .vindex "&$authenticated_fail_id$&"
12236 When an authentication attempt fails, the variable &$authenticated_fail_id$&
12237 will contain the failed authentication id. If more than one authentication
12238 id is attempted, it will contain only the last one. The variable is
12239 available for processing in the ACL's, generally the quit or notquit ACL.
12240 A message to a local recipient could still be accepted without requiring
12241 authentication, which means this variable could also be visible in all of
12242 the ACL's as well.
12243
12244
12245 .vitem &$authenticated_sender$&
12246 .cindex "sender" "authenticated"
12247 .cindex "authentication" "sender"
12248 .cindex "AUTH" "on MAIL command"
12249 .vindex "&$authenticated_sender$&"
12250 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
12251 SMTP MAIL command if it believes the sender is sufficiently trusted, as
12252 described in section &<<SECTauthparamail>>&. Unless the data is the string
12253 &"<>"&, it is set as the authenticated sender of the message, and the value is
12254 available during delivery in the &$authenticated_sender$& variable. If the
12255 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
12256
12257 .vindex "&$qualify_domain$&"
12258 When a message is submitted locally (that is, not over a TCP connection), the
12259 value of &$authenticated_sender$& is an address constructed from the login
12260 name of the calling process and &$qualify_domain$&, except that a trusted user
12261 can override this by means of the &%-oMas%& command line option.
12262
12263
12264 .vitem &$authentication_failed$&
12265 .cindex "authentication" "failure"
12266 .vindex "&$authentication_failed$&"
12267 This variable is set to &"1"& in an Exim server if a client issues an AUTH
12268 command that does not succeed. Otherwise it is set to &"0"&. This makes it
12269 possible to distinguish between &"did not try to authenticate"&
12270 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
12271 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
12272 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
12273 negative response to an AUTH command, including (for example) an attempt to use
12274 an undefined mechanism.
12275
12276 .vitem &$av_failed$&
12277 .cindex "content scanning" "AV scanner failure"
12278 This variable is available when Exim is compiled with the content-scanning
12279 extension. It is set to &"0"& by default, but will be set to &"1"& if any
12280 problem occurs with the virus scanner (specified by &%av_scanner%&) during
12281 the ACL malware condition.
12282
12283 .vitem &$body_linecount$&
12284 .cindex "message body" "line count"
12285 .cindex "body of message" "line count"
12286 .vindex "&$body_linecount$&"
12287 When a message is being received or delivered, this variable contains the
12288 number of lines in the message's body. See also &$message_linecount$&.
12289
12290 .vitem &$body_zerocount$&
12291 .cindex "message body" "binary zero count"
12292 .cindex "body of message" "binary zero count"
12293 .cindex "binary zero" "in message body"
12294 .vindex "&$body_zerocount$&"
12295 When a message is being received or delivered, this variable contains the
12296 number of binary zero bytes (ASCII NULs) in the message's body.
12297
12298 .vitem &$bounce_recipient$&
12299 .vindex "&$bounce_recipient$&"
12300 This is set to the recipient address of a bounce message while Exim is creating
12301 it. It is useful if a customized bounce message text file is in use (see
12302 chapter &<<CHAPemsgcust>>&).
12303
12304 .vitem &$bounce_return_size_limit$&
12305 .vindex "&$bounce_return_size_limit$&"
12306 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12307 up to a multiple of 1000. It is useful when a customized error message text
12308 file is in use (see chapter &<<CHAPemsgcust>>&).
12309
12310 .vitem &$caller_gid$&
12311 .cindex "gid (group id)" "caller"
12312 .vindex "&$caller_gid$&"
12313 The real group id under which the process that called Exim was running. This is
12314 not the same as the group id of the originator of a message (see
12315 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12316 incarnation normally contains the Exim gid.
12317
12318 .vitem &$caller_uid$&
12319 .cindex "uid (user id)" "caller"
12320 .vindex "&$caller_uid$&"
12321 The real user id under which the process that called Exim was running. This is
12322 not the same as the user id of the originator of a message (see
12323 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12324 incarnation normally contains the Exim uid.
12325
12326 .vitem &$callout_address$&
12327 .vindex "&$callout_address$&"
12328 After a callout for verification, spamd or malware daemon service, the
12329 address that was connected to.
12330
12331 .vitem &$compile_number$&
12332 .vindex "&$compile_number$&"
12333 The building process for Exim keeps a count of the number
12334 of times it has been compiled. This serves to distinguish different
12335 compilations of the same version of Exim.
12336
12337 .vitem &$config_dir$&
12338 .vindex "&$config_dir$&"
12339 The directory name of the main configuration file. That is, the content of
12340 &$config_file$& with the last component stripped. The value does not
12341 contain the trailing slash. If &$config_file$& does not contain a slash,
12342 &$config_dir$& is ".".
12343
12344 .vitem &$config_file$&
12345 .vindex "&$config_file$&"
12346 The name of the main configuration file Exim is using.
12347
12348 .vitem &$dkim_verify_status$&
12349 Results of DKIM verification.
12350 For details see section &<<SECDKIMVFY>>&.
12351
12352 .vitem &$dkim_cur_signer$& &&&
12353        &$dkim_verify_reason$& &&&
12354        &$dkim_domain$& &&&
12355        &$dkim_identity$& &&&
12356        &$dkim_selector$& &&&
12357        &$dkim_algo$& &&&
12358        &$dkim_canon_body$& &&&
12359        &$dkim_canon_headers$& &&&
12360        &$dkim_copiedheaders$& &&&
12361        &$dkim_bodylength$& &&&
12362        &$dkim_created$& &&&
12363        &$dkim_expires$& &&&
12364        &$dkim_headernames$& &&&
12365        &$dkim_key_testing$& &&&
12366        &$dkim_key_nosubdomains$& &&&
12367        &$dkim_key_srvtype$& &&&
12368        &$dkim_key_granularity$& &&&
12369        &$dkim_key_notes$& &&&
12370        &$dkim_key_length$&
12371 These variables are only available within the DKIM ACL.
12372 For details see section &<<SECDKIMVFY>>&.
12373
12374 .vitem &$dkim_signers$&
12375 .vindex &$dkim_signers$&
12376 When a message has been received this variable contains
12377 a colon-separated list of signer domains and identities for the message.
12378 For details see section &<<SECDKIMVFY>>&.
12379
12380 .vitem &$dmarc_domain_policy$& &&&
12381        &$dmarc_status$& &&&
12382        &$dmarc_status_text$& &&&
12383        &$dmarc_used_domains$&
12384 Results of DMARC verification.
12385 For details see section &<<SECDMARC>>&.
12386
12387 .vitem &$dnslist_domain$& &&&
12388        &$dnslist_matched$& &&&
12389        &$dnslist_text$& &&&
12390        &$dnslist_value$&
12391 .vindex "&$dnslist_domain$&"
12392 .vindex "&$dnslist_matched$&"
12393 .vindex "&$dnslist_text$&"
12394 .vindex "&$dnslist_value$&"
12395 .cindex "black list (DNS)"
12396 When a DNS (black) list lookup succeeds, these variables are set to contain
12397 the following data from the lookup: the list's domain name, the key that was
12398 looked up, the contents of any associated TXT record, and the value from the
12399 main A record. See section &<<SECID204>>& for more details.
12400
12401 .vitem &$domain$&
12402 .vindex "&$domain$&"
12403 When an address is being routed, or delivered on its own, this variable
12404 contains the domain. Uppercase letters in the domain are converted into lower
12405 case for &$domain$&.
12406
12407 Global address rewriting happens when a message is received, so the value of
12408 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12409 is set during user filtering, but not during system filtering, because a
12410 message may have many recipients and the system filter is called just once.
12411
12412 When more than one address is being delivered at once (for example, several
12413 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12414 have the same domain. Transports can be restricted to handling only one domain
12415 at a time if the value of &$domain$& is required at transport time &-- this is
12416 the default for local transports. For further details of the environment in
12417 which local transports are run, see chapter &<<CHAPenvironment>>&.
12418
12419 .oindex "&%delay_warning_condition%&"
12420 At the end of a delivery, if all deferred addresses have the same domain, it is
12421 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12422
12423 The &$domain$& variable is also used in some other circumstances:
12424
12425 .ilist
12426 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12427 the recipient address. The domain of the &'sender'& address is in
12428 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12429 normally set during the running of the MAIL ACL. However, if the sender address
12430 is verified with a callout during the MAIL ACL, the sender domain is placed in
12431 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12432 the &(smtp)& transport.
12433
12434 .next
12435 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12436 &$domain$& contains the domain portion of the address that is being rewritten;
12437 it can be used in the expansion of the replacement address, for example, to
12438 rewrite domains by file lookup.
12439
12440 .next
12441 With one important exception, whenever a domain list is being scanned,
12442 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12443 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12444 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12445 that, in a RCPT ACL, the sender domain list can be dependent on the
12446 recipient domain (which is what is in &$domain$& at this time).
12447
12448 .next
12449 .cindex "ETRN" "value of &$domain$&"
12450 .oindex "&%smtp_etrn_command%&"
12451 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12452 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12453 .endlist
12454
12455 .cindex "tainted data"
12456 If the origin of the data is an incoming message,
12457 the result of expanding this variable is tainted.
12458 When un untainted version is needed, one should be obtained from
12459 looking up the value in a local (therefore trusted) database.
12460 Often &$domain_data$& is usable in this role.
12461
12462
12463 .vitem &$domain_data$&
12464 .vindex "&$domain_data$&"
12465 When the &%domains%& option on a router matches a domain by
12466 means of a lookup, the data read by the lookup is available during the running
12467 of the router as &$domain_data$&. In addition, if the driver routes the
12468 address to a transport, the value is available in that transport. If the
12469 transport is handling multiple addresses, the value from the first address is
12470 used.
12471
12472 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12473 domain by means of a lookup. The data read by the lookup is available during
12474 the rest of the ACL statement. In all other situations, this variable expands
12475 to nothing.
12476
12477 .vitem &$exim_gid$&
12478 .vindex "&$exim_gid$&"
12479 This variable contains the numerical value of the Exim group id.
12480
12481 .vitem &$exim_path$&
12482 .vindex "&$exim_path$&"
12483 This variable contains the path to the Exim binary.
12484
12485 .vitem &$exim_uid$&
12486 .vindex "&$exim_uid$&"
12487 This variable contains the numerical value of the Exim user id.
12488
12489 .vitem &$exim_version$&
12490 .vindex "&$exim_version$&"
12491 This variable contains the version string of the Exim build.
12492 The first character is a major version number, currently 4.
12493 Then after a dot, the next group of digits is a minor version number.
12494 There may be other characters following the minor version.
12495 This value may be overridden by the &%exim_version%& main config option.
12496
12497 .vitem &$header_$&<&'name'&>
12498 This is not strictly an expansion variable. It is expansion syntax for
12499 inserting the message header line with the given name. Note that the name must
12500 be terminated by colon or white space, because it may contain a wide variety of
12501 characters. Note also that braces must &'not'& be used.
12502 See the full description in section &<<SECTexpansionitems>>& above.
12503
12504 .vitem &$headers_added$&
12505 .vindex "&$headers_added$&"
12506 Within an ACL this variable contains the headers added so far by
12507 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12508 The headers are a newline-separated list.
12509
12510 .vitem &$home$&
12511 .vindex "&$home$&"
12512 When the &%check_local_user%& option is set for a router, the user's home
12513 directory is placed in &$home$& when the check succeeds. In particular, this
12514 means it is set during the running of users' filter files. A router may also
12515 explicitly set a home directory for use by a transport; this can be overridden
12516 by a setting on the transport itself.
12517
12518 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12519 of the environment variable HOME, which is subject to the
12520 &%keep_environment%& and &%add_environment%& main config options.
12521
12522 .vitem &$host$&
12523 .vindex "&$host$&"
12524 If a router assigns an address to a transport (any transport), and passes a
12525 list of hosts with the address, the value of &$host$& when the transport starts
12526 to run is the name of the first host on the list. Note that this applies both
12527 to local and remote transports.
12528
12529 .cindex "transport" "filter"
12530 .cindex "filter" "transport filter"
12531 For the &(smtp)& transport, if there is more than one host, the value of
12532 &$host$& changes as the transport works its way through the list. In
12533 particular, when the &(smtp)& transport is expanding its options for encryption
12534 using TLS, or for specifying a transport filter (see chapter
12535 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12536 is connected.
12537
12538 When used in the client part of an authenticator configuration (see chapter
12539 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12540 client is connected.
12541
12542
12543 .vitem &$host_address$&
12544 .vindex "&$host_address$&"
12545 This variable is set to the remote host's IP address whenever &$host$& is set
12546 for a remote connection. It is also set to the IP address that is being checked
12547 when the &%ignore_target_hosts%& option is being processed.
12548
12549 .vitem &$host_data$&
12550 .vindex "&$host_data$&"
12551 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12552 result of the lookup is made available in the &$host_data$& variable. This
12553 allows you, for example, to do things like this:
12554 .code
12555 deny  hosts = net-lsearch;/some/file
12556       message = $host_data
12557 .endd
12558 .vitem &$host_lookup_deferred$&
12559 .cindex "host name" "lookup, failure of"
12560 .vindex "&$host_lookup_deferred$&"
12561 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12562 message comes from a remote host and there is an attempt to look up the host's
12563 name from its IP address, and the attempt is not successful, one of these
12564 variables is set to &"1"&.
12565
12566 .ilist
12567 If the lookup receives a definite negative response (for example, a DNS lookup
12568 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12569
12570 .next
12571 If there is any kind of problem during the lookup, such that Exim cannot
12572 tell whether or not the host name is defined (for example, a timeout for a DNS
12573 lookup), &$host_lookup_deferred$& is set to &"1"&.
12574 .endlist ilist
12575
12576 Looking up a host's name from its IP address consists of more than just a
12577 single reverse lookup. Exim checks that a forward lookup of at least one of the
12578 names it receives from a reverse lookup yields the original IP address. If this
12579 is not the case, Exim does not accept the looked up name(s), and
12580 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12581 IP address (for example, the existence of a PTR record in the DNS) is not
12582 sufficient on its own for the success of a host name lookup. If the reverse
12583 lookup succeeds, but there is a lookup problem such as a timeout when checking
12584 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12585 &"1"&. See also &$sender_host_name$&.
12586
12587 .cindex authentication "expansion item"
12588 Performing these checks sets up information used by the
12589 &%authresults%& expansion item.
12590
12591
12592 .vitem &$host_lookup_failed$&
12593 .vindex "&$host_lookup_failed$&"
12594 See &$host_lookup_deferred$&.
12595
12596 .vitem &$host_port$&
12597 .vindex "&$host_port$&"
12598 This variable is set to the remote host's TCP port whenever &$host$& is set
12599 for an outbound connection.
12600
12601 .vitem &$initial_cwd$&
12602 .vindex "&$initial_cwd$&
12603 This variable contains the full path name of the initial working
12604 directory of the current Exim process. This may differ from the current
12605 working directory, as Exim changes this to "/" during early startup, and
12606 to &$spool_directory$& later.
12607
12608 .vitem &$inode$&
12609 .vindex "&$inode$&"
12610 The only time this variable is set is while expanding the &%directory_file%&
12611 option in the &(appendfile)& transport. The variable contains the inode number
12612 of the temporary file which is about to be renamed. It can be used to construct
12613 a unique name for the file.
12614
12615 .vitem &$interface_address$&
12616 .vindex "&$interface_address$&"
12617 This is an obsolete name for &$received_ip_address$&.
12618
12619 .vitem &$interface_port$&
12620 .vindex "&$interface_port$&"
12621 This is an obsolete name for &$received_port$&.
12622
12623 .vitem &$item$&
12624 .vindex "&$item$&"
12625 This variable is used during the expansion of &*forall*& and &*forany*&
12626 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12627 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12628 empty.
12629
12630 .vitem &$ldap_dn$&
12631 .vindex "&$ldap_dn$&"
12632 This variable, which is available only when Exim is compiled with LDAP support,
12633 contains the DN from the last entry in the most recently successful LDAP
12634 lookup.
12635
12636 .vitem &$load_average$&
12637 .vindex "&$load_average$&"
12638 This variable contains the system load average, multiplied by 1000 so that it
12639 is an integer. For example, if the load average is 0.21, the value of the
12640 variable is 210. The value is recomputed every time the variable is referenced.
12641
12642 .vitem &$local_part$&
12643 .vindex "&$local_part$&"
12644 When an address is being routed, or delivered on its own, this
12645 variable contains the local part. When a number of addresses are being
12646 delivered together (for example, multiple RCPT commands in an SMTP
12647 session), &$local_part$& is not set.
12648
12649 Global address rewriting happens when a message is received, so the value of
12650 &$local_part$& during routing and delivery is the value after rewriting.
12651 &$local_part$& is set during user filtering, but not during system filtering,
12652 because a message may have many recipients and the system filter is called just
12653 once.
12654
12655 .cindex "tainted data"
12656 If the origin of the data is an incoming message,
12657 the result of expanding this variable is tainted.
12658
12659 &*Warning*&: the content of this variable is usually provided by a potential
12660 attacker.
12661 Consider carefully the implications of using it unvalidated as a name
12662 for file access.
12663 This presents issues for users' &_.forward_& and filter files.
12664 For traditional full user accounts, use &%check_local_users%& and the
12665 &$local_part_data$& variable rather than this one.
12666 For virtual users, store a suitable pathname component in the database
12667 which is used for account name validation, and use that retrieved value
12668 rather than this variable.
12669 Often &$local_part_data$& is usable in this role.
12670 If needed, use a router &%address_data%& or &%set%& option for
12671 the retrieved data.
12672
12673 When a message is being delivered to a file, pipe, or autoreply transport as a
12674 result of aliasing or forwarding, &$local_part$& is set to the local part of
12675 the parent address, not to the filename or command (see &$address_file$& and
12676 &$address_pipe$&).
12677
12678 When an ACL is running for a RCPT command, &$local_part$& contains the
12679 local part of the recipient address.
12680
12681 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12682 &$local_part$& contains the local part of the address that is being rewritten;
12683 it can be used in the expansion of the replacement address, for example.
12684
12685 In all cases, all quoting is removed from the local part. For example, for both
12686 the addresses
12687 .code
12688 "abc:xyz"@test.example
12689 abc\:xyz@test.example
12690 .endd
12691 the value of &$local_part$& is
12692 .code
12693 abc:xyz
12694 .endd
12695 If you use &$local_part$& to create another address, you should always wrap it
12696 inside a quoting operator. For example, in a &(redirect)& router you could
12697 have:
12698 .code
12699 data = ${quote_local_part:$local_part}@new.domain.example
12700 .endd
12701 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12702 to process local parts in a case-dependent manner in a router, you can set the
12703 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12704
12705 .vitem &$local_part_data$&
12706 .vindex "&$local_part_data$&"
12707 When the &%local_parts%& option on a router matches a local part by means of a
12708 lookup, the data read by the lookup is available during the running of the
12709 router as &$local_part_data$&. In addition, if the driver routes the address
12710 to a transport, the value is available in that transport. If the transport is
12711 handling multiple addresses, the value from the first address is used.
12712
12713 The &%check_local_user%& router option also sets this variable.
12714
12715 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12716 matches a local part by means of a lookup. The data read by the lookup is
12717 available during the rest of the ACL statement. In all other situations, this
12718 variable expands to nothing.
12719
12720 .vindex &$local_part_prefix$& &&&
12721         &$local_part_prefix_v$& &&&
12722         &$local_part_suffix$& &&&
12723         &$local_part_suffix_v$&
12724 .cindex affix variables
12725 If a local part prefix or suffix has been recognized, it is not included in the
12726 value of &$local_part$& during routing and subsequent delivery. The values of
12727 any prefix or suffix are in &$local_part_prefix$& and
12728 &$local_part_suffix$&, respectively.
12729 .cindex "tainted data"
12730 If the specification did not include a wildcard then
12731 the affix variable value is not tainted.
12732
12733 If the affix specification included a wildcard then the portion of
12734 the affix matched by the wildcard is in
12735 &$local_part_prefix_v$& or &$local_part_suffix_v$& as appropriate,
12736 and both the whole and varying values are tainted.
12737
12738 .vitem &$local_scan_data$&
12739 .vindex "&$local_scan_data$&"
12740 This variable contains the text returned by the &[local_scan()]& function when
12741 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12742
12743 .vitem &$local_user_gid$&
12744 .vindex "&$local_user_gid$&"
12745 See &$local_user_uid$&.
12746
12747 .vitem &$local_user_uid$&
12748 .vindex "&$local_user_uid$&"
12749 This variable and &$local_user_gid$& are set to the uid and gid after the
12750 &%check_local_user%& router precondition succeeds. This means that their values
12751 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12752 and &%condition%&), for the &%address_data%& expansion, and for any
12753 router-specific expansions. At all other times, the values in these variables
12754 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12755
12756 .vitem &$localhost_number$&
12757 .vindex "&$localhost_number$&"
12758 This contains the expanded value of the
12759 &%localhost_number%& option. The expansion happens after the main options have
12760 been read.
12761
12762 .vitem &$log_inodes$&
12763 .vindex "&$log_inodes$&"
12764 The number of free inodes in the disk partition where Exim's
12765 log files are being written. The value is recalculated whenever the variable is
12766 referenced. If the relevant file system does not have the concept of inodes,
12767 the value of is -1. See also the &%check_log_inodes%& option.
12768
12769 .vitem &$log_space$&
12770 .vindex "&$log_space$&"
12771 The amount of free space (as a number of kilobytes) in the disk
12772 partition where Exim's log files are being written. The value is recalculated
12773 whenever the variable is referenced. If the operating system does not have the
12774 ability to find the amount of free space (only true for experimental systems),
12775 the space value is -1. See also the &%check_log_space%& option.
12776
12777
12778 .vitem &$lookup_dnssec_authenticated$&
12779 .vindex "&$lookup_dnssec_authenticated$&"
12780 This variable is set after a DNS lookup done by
12781 a dnsdb lookup expansion, dnslookup router or smtp transport.
12782 .cindex "DNS" "DNSSEC"
12783 It will be empty if &(DNSSEC)& was not requested,
12784 &"no"& if the result was not labelled as authenticated data
12785 and &"yes"& if it was.
12786 Results that are labelled as authoritative answer that match
12787 the &%dns_trust_aa%& configuration variable count also
12788 as authenticated data.
12789
12790 .vitem &$mailstore_basename$&
12791 .vindex "&$mailstore_basename$&"
12792 This variable is set only when doing deliveries in &"mailstore"& format in the
12793 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12794 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12795 contains the basename of the files that are being written, that is, the name
12796 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12797 variable is empty.
12798
12799 .vitem &$malware_name$&
12800 .vindex "&$malware_name$&"
12801 This variable is available when Exim is compiled with the
12802 content-scanning extension. It is set to the name of the virus that was found
12803 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12804
12805 .vitem &$max_received_linelength$&
12806 .vindex "&$max_received_linelength$&"
12807 .cindex "maximum" "line length"
12808 .cindex "line length" "maximum"
12809 This variable contains the number of bytes in the longest line that was
12810 received as part of the message, not counting the line termination
12811 character(s).
12812 It is not valid if the &%spool_files_wireformat%& option is used.
12813
12814 .vitem &$message_age$&
12815 .cindex "message" "age of"
12816 .vindex "&$message_age$&"
12817 This variable is set at the start of a delivery attempt to contain the number
12818 of seconds since the message was received. It does not change during a single
12819 delivery attempt.
12820
12821 .vitem &$message_body$&
12822 .cindex "body of message" "expansion variable"
12823 .cindex "message body" "in expansion"
12824 .cindex "binary zero" "in message body"
12825 .vindex "&$message_body$&"
12826 .oindex "&%message_body_visible%&"
12827 This variable contains the initial portion of a message's body while it is
12828 being delivered, and is intended mainly for use in filter files. The maximum
12829 number of characters of the body that are put into the variable is set by the
12830 &%message_body_visible%& configuration option; the default is 500.
12831
12832 .oindex "&%message_body_newlines%&"
12833 By default, newlines are converted into spaces in &$message_body$&, to make it
12834 easier to search for phrases that might be split over a line break. However,
12835 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12836 zeros are always converted into spaces.
12837
12838 .vitem &$message_body_end$&
12839 .cindex "body of message" "expansion variable"
12840 .cindex "message body" "in expansion"
12841 .vindex "&$message_body_end$&"
12842 This variable contains the final portion of a message's
12843 body while it is being delivered. The format and maximum size are as for
12844 &$message_body$&.
12845
12846 .vitem &$message_body_size$&
12847 .cindex "body of message" "size"
12848 .cindex "message body" "size"
12849 .vindex "&$message_body_size$&"
12850 When a message is being delivered, this variable contains the size of the body
12851 in bytes. The count starts from the character after the blank line that
12852 separates the body from the header. Newlines are included in the count. See
12853 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12854
12855 If the spool file is wireformat
12856 (see the &%spool_files_wireformat%& main option)
12857 the CRLF line-terminators are included in the count.
12858
12859 .vitem &$message_exim_id$&
12860 .vindex "&$message_exim_id$&"
12861 When a message is being received or delivered, this variable contains the
12862 unique message id that is generated and used by Exim to identify the message.
12863 An id is not created for a message until after its header has been successfully
12864 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12865 line; it is the local id that Exim assigns to the message, for example:
12866 &`1BXTIK-0001yO-VA`&.
12867
12868 .vitem &$message_headers$&
12869 .vindex &$message_headers$&
12870 This variable contains a concatenation of all the header lines when a message
12871 is being processed, except for lines added by routers or transports. The header
12872 lines are separated by newline characters. Their contents are decoded in the
12873 same way as a header line that is inserted by &%bheader%&.
12874
12875 .vitem &$message_headers_raw$&
12876 .vindex &$message_headers_raw$&
12877 This variable is like &$message_headers$& except that no processing of the
12878 contents of header lines is done.
12879
12880 .vitem &$message_id$&
12881 This is an old name for &$message_exim_id$&. It is now deprecated.
12882
12883 .vitem &$message_linecount$&
12884 .vindex "&$message_linecount$&"
12885 This variable contains the total number of lines in the header and body of the
12886 message. Compare &$body_linecount$&, which is the count for the body only.
12887 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12888 number of lines received. Before delivery happens (that is, before filters,
12889 routers, and transports run) the count is increased to include the
12890 &'Received:'& header line that Exim standardly adds, and also any other header
12891 lines that are added by ACLs. The blank line that separates the message header
12892 from the body is not counted.
12893
12894 As with the special case of &$message_size$&, during the expansion of the
12895 appendfile transport's maildir_tag option in maildir format, the value of
12896 &$message_linecount$& is the precise size of the number of newlines in the
12897 file that has been written (minus one for the blank line between the
12898 header and the body).
12899
12900 Here is an example of the use of this variable in a DATA ACL:
12901 .code
12902 deny condition = \
12903       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12904      message   = Too many lines in message header
12905 .endd
12906 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12907 message has not yet been received.
12908
12909 This variable is not valid if the &%spool_files_wireformat%& option is used.
12910
12911 .vitem &$message_size$&
12912 .cindex "size" "of message"
12913 .cindex "message" "size"
12914 .vindex "&$message_size$&"
12915 When a message is being processed, this variable contains its size in bytes. In
12916 most cases, the size includes those headers that were received with the
12917 message, but not those (such as &'Envelope-to:'&) that are added to individual
12918 deliveries as they are written. However, there is one special case: during the
12919 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12920 doing a delivery in maildir format, the value of &$message_size$& is the
12921 precise size of the file that has been written. See also
12922 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12923
12924 .cindex "RCPT" "value of &$message_size$&"
12925 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12926 contains the size supplied on the MAIL command, or -1 if no size was given. The
12927 value may not, of course, be truthful.
12928
12929 .vitem &$mime_$&&'xxx'&
12930 A number of variables whose names start with &$mime$& are
12931 available when Exim is compiled with the content-scanning extension. For
12932 details, see section &<<SECTscanmimepart>>&.
12933
12934 .vitem "&$n0$& &-- &$n9$&"
12935 These variables are counters that can be incremented by means
12936 of the &%add%& command in filter files.
12937
12938 .vitem &$original_domain$&
12939 .vindex "&$domain$&"
12940 .vindex "&$original_domain$&"
12941 When a top-level address is being processed for delivery, this contains the
12942 same value as &$domain$&. However, if a &"child"& address (for example,
12943 generated by an alias, forward, or filter file) is being processed, this
12944 variable contains the domain of the original address (lower cased). This
12945 differs from &$parent_domain$& only when there is more than one level of
12946 aliasing or forwarding. When more than one address is being delivered in a
12947 single transport run, &$original_domain$& is not set.
12948
12949 If a new address is created by means of a &%deliver%& command in a system
12950 filter, it is set up with an artificial &"parent"& address. This has the local
12951 part &'system-filter'& and the default qualify domain.
12952
12953 .vitem &$original_local_part$&
12954 .vindex "&$local_part$&"
12955 .vindex "&$original_local_part$&"
12956 When a top-level address is being processed for delivery, this contains the
12957 same value as &$local_part$&, unless a prefix or suffix was removed from the
12958 local part, because &$original_local_part$& always contains the full local
12959 part. When a &"child"& address (for example, generated by an alias, forward, or
12960 filter file) is being processed, this variable contains the full local part of
12961 the original address.
12962
12963 If the router that did the redirection processed the local part
12964 case-insensitively, the value in &$original_local_part$& is in lower case.
12965 This variable differs from &$parent_local_part$& only when there is more than
12966 one level of aliasing or forwarding. When more than one address is being
12967 delivered in a single transport run, &$original_local_part$& is not set.
12968
12969 If a new address is created by means of a &%deliver%& command in a system
12970 filter, it is set up with an artificial &"parent"& address. This has the local
12971 part &'system-filter'& and the default qualify domain.
12972
12973 .vitem &$originator_gid$&
12974 .cindex "gid (group id)" "of originating user"
12975 .cindex "sender" "gid"
12976 .vindex "&$caller_gid$&"
12977 .vindex "&$originator_gid$&"
12978 This variable contains the value of &$caller_gid$& that was set when the
12979 message was received. For messages received via the command line, this is the
12980 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12981 normally the gid of the Exim user.
12982
12983 .vitem &$originator_uid$&
12984 .cindex "uid (user id)" "of originating user"
12985 .cindex "sender" "uid"
12986 .vindex "&$caller_uid$&"
12987 .vindex "&$originator_uid$&"
12988 The value of &$caller_uid$& that was set when the message was received. For
12989 messages received via the command line, this is the uid of the sending user.
12990 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12991 user.
12992
12993 .vitem &$parent_domain$&
12994 .vindex "&$parent_domain$&"
12995 This variable is similar to &$original_domain$& (see
12996 above), except that it refers to the immediately preceding parent address.
12997
12998 .vitem &$parent_local_part$&
12999 .vindex "&$parent_local_part$&"
13000 This variable is similar to &$original_local_part$&
13001 (see above), except that it refers to the immediately preceding parent address.
13002
13003 .vitem &$pid$&
13004 .cindex "pid (process id)" "of current process"
13005 .vindex "&$pid$&"
13006 This variable contains the current process id.
13007
13008 .vitem &$pipe_addresses$&
13009 .cindex "filter" "transport filter"
13010 .cindex "transport" "filter"
13011 .vindex "&$pipe_addresses$&"
13012 This is not an expansion variable, but is mentioned here because the string
13013 &`$pipe_addresses`& is handled specially in the command specification for the
13014 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
13015 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
13016 It cannot be used in general expansion strings, and provokes an &"unknown
13017 variable"& error if encountered.
13018
13019 .vitem &$primary_hostname$&
13020 .vindex "&$primary_hostname$&"
13021 This variable contains the value set by &%primary_hostname%& in the
13022 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
13023 a single-component name, Exim calls &[gethostbyname()]& (or
13024 &[getipnodebyname()]& where available) in an attempt to acquire a fully
13025 qualified host name. See also &$smtp_active_hostname$&.
13026
13027
13028 .vitem &$proxy_external_address$& &&&
13029        &$proxy_external_port$& &&&
13030        &$proxy_local_address$& &&&
13031        &$proxy_local_port$& &&&
13032        &$proxy_session$&
13033 These variables are only available when built with Proxy Protocol
13034 or SOCKS5 support.
13035 For details see chapter &<<SECTproxyInbound>>&.
13036
13037 .vitem &$prdr_requested$&
13038 .cindex "PRDR" "variable for"
13039 This variable is set to &"yes"& if PRDR was requested by the client for the
13040 current message, otherwise &"no"&.
13041
13042 .vitem &$prvscheck_address$&
13043 This variable is used in conjunction with the &%prvscheck%& expansion item,
13044 which is described in sections &<<SECTexpansionitems>>& and
13045 &<<SECTverifyPRVS>>&.
13046
13047 .vitem &$prvscheck_keynum$&
13048 This variable is used in conjunction with the &%prvscheck%& expansion item,
13049 which is described in sections &<<SECTexpansionitems>>& and
13050 &<<SECTverifyPRVS>>&.
13051
13052 .vitem &$prvscheck_result$&
13053 This variable is used in conjunction with the &%prvscheck%& expansion item,
13054 which is described in sections &<<SECTexpansionitems>>& and
13055 &<<SECTverifyPRVS>>&.
13056
13057 .vitem &$qualify_domain$&
13058 .vindex "&$qualify_domain$&"
13059 The value set for the &%qualify_domain%& option in the configuration file.
13060
13061 .vitem &$qualify_recipient$&
13062 .vindex "&$qualify_recipient$&"
13063 The value set for the &%qualify_recipient%& option in the configuration file,
13064 or if not set, the value of &$qualify_domain$&.
13065
13066 .vitem &$queue_name$&
13067 .vindex &$queue_name$&
13068 .cindex "named queues" variable
13069 .cindex queues named
13070 The name of the spool queue in use; empty for the default queue.
13071
13072 .vitem &$queue_size$&
13073 .vindex "&$queue_size$&"
13074 .cindex "queue" "size of"
13075 .cindex "spool" "number of messages"
13076 This variable contains the number of messages queued.
13077 It is evaluated on demand, but no more often than once every minute.
13078
13079 .vitem &$r_...$&
13080 .vindex &$r_...$&
13081 .cindex router variables
13082 Values can be placed in these variables by the &%set%& option of a router.
13083 They can be given any name that starts with &$r_$&.
13084 The values persist for the address being handled through subsequent routers
13085 and the eventual transport.
13086
13087 .vitem &$rcpt_count$&
13088 .vindex "&$rcpt_count$&"
13089 When a message is being received by SMTP, this variable contains the number of
13090 RCPT commands received for the current message. If this variable is used in a
13091 RCPT ACL, its value includes the current command.
13092
13093 .vitem &$rcpt_defer_count$&
13094 .vindex "&$rcpt_defer_count$&"
13095 .cindex "4&'xx'& responses" "count of"
13096 When a message is being received by SMTP, this variable contains the number of
13097 RCPT commands in the current message that have previously been rejected with a
13098 temporary (4&'xx'&) response.
13099
13100 .vitem &$rcpt_fail_count$&
13101 .vindex "&$rcpt_fail_count$&"
13102 When a message is being received by SMTP, this variable contains the number of
13103 RCPT commands in the current message that have previously been rejected with a
13104 permanent (5&'xx'&) response.
13105
13106 .vitem &$received_count$&
13107 .vindex "&$received_count$&"
13108 This variable contains the number of &'Received:'& header lines in the message,
13109 including the one added by Exim (so its value is always greater than zero). It
13110 is available in the DATA ACL, the non-SMTP ACL, and while routing and
13111 delivering.
13112
13113 .vitem &$received_for$&
13114 .vindex "&$received_for$&"
13115 If there is only a single recipient address in an incoming message, this
13116 variable contains that address when the &'Received:'& header line is being
13117 built. The value is copied after recipient rewriting has happened, but before
13118 the &[local_scan()]& function is run.
13119
13120 .vitem &$received_ip_address$&
13121 .vindex "&$received_ip_address$&"
13122 As soon as an Exim server starts processing an incoming TCP/IP connection, this
13123 variable is set to the address of the local IP interface, and &$received_port$&
13124 is set to the local port number. (The remote IP address and port are in
13125 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
13126 the port value is -1 unless it has been set using the &%-oMi%& command line
13127 option.
13128
13129 As well as being useful in ACLs (including the &"connect"& ACL), these variable
13130 could be used, for example, to make the filename for a TLS certificate depend
13131 on which interface and/or port is being used for the incoming connection. The
13132 values of &$received_ip_address$& and &$received_port$& are saved with any
13133 messages that are received, thus making these variables available at delivery
13134 time.
13135 For outbound connections see &$sending_ip_address$&.
13136
13137 .vitem &$received_port$&
13138 .vindex "&$received_port$&"
13139 See &$received_ip_address$&.
13140
13141 .vitem &$received_protocol$&
13142 .vindex "&$received_protocol$&"
13143 When a message is being processed, this variable contains the name of the
13144 protocol by which it was received. Most of the names used by Exim are defined
13145 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
13146 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
13147 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
13148 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
13149 connection and the client was successfully authenticated.
13150
13151 Exim uses the protocol name &"smtps"& for the case when encryption is
13152 automatically set up on connection without the use of STARTTLS (see
13153 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
13154 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
13155 where the client initially uses EHLO, sets up an encrypted connection using
13156 STARTTLS, and then uses HELO afterwards.
13157
13158 The &%-oMr%& option provides a way of specifying a custom protocol name for
13159 messages that are injected locally by trusted callers. This is commonly used to
13160 identify messages that are being re-injected after some kind of scanning.
13161
13162 .vitem &$received_time$&
13163 .vindex "&$received_time$&"
13164 This variable contains the date and time when the current message was received,
13165 as a number of seconds since the start of the Unix epoch.
13166
13167 .vitem &$recipient_data$&
13168 .vindex "&$recipient_data$&"
13169 This variable is set after an indexing lookup success in an ACL &%recipients%&
13170 condition. It contains the data from the lookup, and the value remains set
13171 until the next &%recipients%& test. Thus, you can do things like this:
13172 .display
13173 &`require recipients  = cdb*@;/some/file`&
13174 &`deny    `&&'some further test involving'& &`$recipient_data`&
13175 .endd
13176 &*Warning*&: This variable is set only when a lookup is used as an indexing
13177 method in the address list, using the semicolon syntax as in the example above.
13178 The variable is not set for a lookup that is used as part of the string
13179 expansion that all such lists undergo before being interpreted.
13180
13181 .vitem &$recipient_verify_failure$&
13182 .vindex "&$recipient_verify_failure$&"
13183 In an ACL, when a recipient verification fails, this variable contains
13184 information about the failure. It is set to one of the following words:
13185
13186 .ilist
13187 &"qualify"&: The address was unqualified (no domain), and the message
13188 was neither local nor came from an exempted host.
13189
13190 .next
13191 &"route"&: Routing failed.
13192
13193 .next
13194 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
13195 or before the MAIL command (that is, on initial connection, HELO, or
13196 MAIL).
13197
13198 .next
13199 &"recipient"&: The RCPT command in a callout was rejected.
13200 .next
13201
13202 &"postmaster"&: The postmaster check in a callout was rejected.
13203 .endlist
13204
13205 The main use of this variable is expected to be to distinguish between
13206 rejections of MAIL and rejections of RCPT.
13207
13208 .vitem &$recipients$&
13209 .vindex "&$recipients$&"
13210 This variable contains a list of envelope recipients for a message. A comma and
13211 a space separate the addresses in the replacement text. However, the variable
13212 is not generally available, to prevent exposure of Bcc recipients in
13213 unprivileged users' filter files. You can use &$recipients$& only in these
13214 cases:
13215
13216 .olist
13217 In a system filter file.
13218 .next
13219 In the ACLs associated with the DATA command and with non-SMTP messages, that
13220 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
13221 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
13222 &%acl_not_smtp_mime%&.
13223 .next
13224 From within a &[local_scan()]& function.
13225 .endlist
13226
13227
13228 .vitem &$recipients_count$&
13229 .vindex "&$recipients_count$&"
13230 When a message is being processed, this variable contains the number of
13231 envelope recipients that came with the message. Duplicates are not excluded
13232 from the count. While a message is being received over SMTP, the number
13233 increases for each accepted recipient. It can be referenced in an ACL.
13234
13235
13236 .vitem &$regex_match_string$&
13237 .vindex "&$regex_match_string$&"
13238 This variable is set to contain the matching regular expression after a
13239 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
13240
13241 .vitem "&$regex1$&, &$regex2$&, etc"
13242 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
13243 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
13244 these variables contain the
13245 captured substrings identified by the regular expression.
13246
13247
13248 .vitem &$reply_address$&
13249 .vindex "&$reply_address$&"
13250 When a message is being processed, this variable contains the contents of the
13251 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
13252 contents of the &'From:'& header line. Apart from the removal of leading
13253 white space, the value is not processed in any way. In particular, no RFC 2047
13254 decoding or character code translation takes place.
13255
13256 .vitem &$return_path$&
13257 .vindex "&$return_path$&"
13258 When a message is being delivered, this variable contains the return path &--
13259 the sender field that will be sent as part of the envelope. It is not enclosed
13260 in <> characters. At the start of routing an address, &$return_path$& has the
13261 same value as &$sender_address$&, but if, for example, an incoming message to a
13262 mailing list has been expanded by a router which specifies a different address
13263 for bounce messages, &$return_path$& subsequently contains the new bounce
13264 address, whereas &$sender_address$& always contains the original sender address
13265 that was received with the message. In other words, &$sender_address$& contains
13266 the incoming envelope sender, and &$return_path$& contains the outgoing
13267 envelope sender.
13268
13269 .vitem &$return_size_limit$&
13270 .vindex "&$return_size_limit$&"
13271 This is an obsolete name for &$bounce_return_size_limit$&.
13272
13273 .vitem &$router_name$&
13274 .cindex "router" "name"
13275 .cindex "name" "of router"
13276 .vindex "&$router_name$&"
13277 During the running of a router this variable contains its name.
13278
13279 .vitem &$runrc$&
13280 .cindex "return code" "from &%run%& expansion"
13281 .vindex "&$runrc$&"
13282 This variable contains the return code from a command that is run by the
13283 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
13284 assume the order in which option values are expanded, except for those
13285 preconditions whose order of testing is documented. Therefore, you cannot
13286 reliably expect to set &$runrc$& by the expansion of one option, and use it in
13287 another.
13288
13289 .vitem &$self_hostname$&
13290 .oindex "&%self%&" "value of host name"
13291 .vindex "&$self_hostname$&"
13292 When an address is routed to a supposedly remote host that turns out to be the
13293 local host, what happens is controlled by the &%self%& generic router option.
13294 One of its values causes the address to be passed to another router. When this
13295 happens, &$self_hostname$& is set to the name of the local host that the
13296 original router encountered. In other circumstances its contents are null.
13297
13298 .vitem &$sender_address$&
13299 .vindex "&$sender_address$&"
13300 When a message is being processed, this variable contains the sender's address
13301 that was received in the message's envelope. The case of letters in the address
13302 is retained, in both the local part and the domain. For bounce messages, the
13303 value of this variable is the empty string. See also &$return_path$&.
13304
13305 .vitem &$sender_address_data$&
13306 .vindex "&$address_data$&"
13307 .vindex "&$sender_address_data$&"
13308 If &$address_data$& is set when the routers are called from an ACL to verify a
13309 sender address, the final value is preserved in &$sender_address_data$&, to
13310 distinguish it from data from a recipient address. The value does not persist
13311 after the end of the current ACL statement. If you want to preserve it for
13312 longer, you can save it in an ACL variable.
13313
13314 .vitem &$sender_address_domain$&
13315 .vindex "&$sender_address_domain$&"
13316 The domain portion of &$sender_address$&.
13317
13318 .vitem &$sender_address_local_part$&
13319 .vindex "&$sender_address_local_part$&"
13320 The local part portion of &$sender_address$&.
13321
13322 .vitem &$sender_data$&
13323 .vindex "&$sender_data$&"
13324 This variable is set after a lookup success in an ACL &%senders%& condition or
13325 in a router &%senders%& option. It contains the data from the lookup, and the
13326 value remains set until the next &%senders%& test. Thus, you can do things like
13327 this:
13328 .display
13329 &`require senders      = cdb*@;/some/file`&
13330 &`deny    `&&'some further test involving'& &`$sender_data`&
13331 .endd
13332 &*Warning*&: This variable is set only when a lookup is used as an indexing
13333 method in the address list, using the semicolon syntax as in the example above.
13334 The variable is not set for a lookup that is used as part of the string
13335 expansion that all such lists undergo before being interpreted.
13336
13337 .vitem &$sender_fullhost$&
13338 .vindex "&$sender_fullhost$&"
13339 When a message is received from a remote host, this variable contains the host
13340 name and IP address in a single string. It ends with the IP address in square
13341 brackets, followed by a colon and a port number if the logging of ports is
13342 enabled. The format of the rest of the string depends on whether the host
13343 issued a HELO or EHLO SMTP command, and whether the host name was verified by
13344 looking up its IP address. (Looking up the IP address can be forced by the
13345 &%host_lookup%& option, independent of verification.) A plain host name at the
13346 start of the string is a verified host name; if this is not present,
13347 verification either failed or was not requested. A host name in parentheses is
13348 the argument of a HELO or EHLO command. This is omitted if it is identical to
13349 the verified host name or to the host's IP address in square brackets.
13350
13351 .vitem &$sender_helo_dnssec$&
13352 .vindex "&$sender_helo_dnssec$&"
13353 This boolean variable is true if a successful HELO verification was
13354 .cindex "DNS" "DNSSEC"
13355 done using DNS information the resolver library stated was authenticated data.
13356
13357 .vitem &$sender_helo_name$&
13358 .vindex "&$sender_helo_name$&"
13359 When a message is received from a remote host that has issued a HELO or EHLO
13360 command, the argument of that command is placed in this variable. It is also
13361 set if HELO or EHLO is used when a message is received using SMTP locally via
13362 the &%-bs%& or &%-bS%& options.
13363
13364 .vitem &$sender_host_address$&
13365 .vindex "&$sender_host_address$&"
13366 When a message is received from a remote host using SMTP,
13367 this variable contains that
13368 host's IP address. For locally non-SMTP submitted messages, it is empty.
13369
13370 .vitem &$sender_host_authenticated$&
13371 .vindex "&$sender_host_authenticated$&"
13372 This variable contains the name (not the public name) of the authenticator
13373 driver that successfully authenticated the client from which the message was
13374 received. It is empty if there was no successful authentication. See also
13375 &$authenticated_id$&.
13376
13377 .vitem &$sender_host_dnssec$&
13378 .vindex "&$sender_host_dnssec$&"
13379 If an attempt to populate &$sender_host_name$& has been made
13380 (by reference, &%hosts_lookup%& or
13381 otherwise) then this boolean will have been set true if, and only if, the
13382 resolver library states that both
13383 the reverse and forward DNS were authenticated data.  At all
13384 other times, this variable is false.
13385
13386 .cindex "DNS" "DNSSEC"
13387 It is likely that you will need to coerce DNSSEC support on in the resolver
13388 library, by setting:
13389 .code
13390 dns_dnssec_ok = 1
13391 .endd
13392
13393 In addition, on Linux with glibc 2.31 or newer the resolver library will
13394 default to stripping out a successful validation status.
13395 This will break a previously working Exim installation.
13396 Provided that you do trust the resolver (ie, is on localhost) you can tell
13397 glibc to pass through any successful validation with a new option in
13398 &_/etc/resolv.conf_&:
13399 .code
13400 options trust-ad
13401 .endd
13402
13403 Exim does not perform DNSSEC validation itself, instead leaving that to a
13404 validating resolver (e.g. unbound, or bind with suitable configuration).
13405
13406 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13407 mechanism in the list, then this variable will be false.
13408
13409 This requires that your system resolver library support EDNS0 (and that
13410 DNSSEC flags exist in the system headers).  If the resolver silently drops
13411 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13412 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13413
13414
13415 .vitem &$sender_host_name$&
13416 .vindex "&$sender_host_name$&"
13417 When a message is received from a remote host, this variable contains the
13418 host's name as obtained by looking up its IP address. For messages received by
13419 other means, this variable is empty.
13420
13421 .vindex "&$host_lookup_failed$&"
13422 If the host name has not previously been looked up, a reference to
13423 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13424 A looked up name is accepted only if it leads back to the original IP address
13425 via a forward lookup. If either the reverse or the forward lookup fails to find
13426 any data, or if the forward lookup does not yield the original IP address,
13427 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13428
13429 .vindex "&$host_lookup_deferred$&"
13430 However, if either of the lookups cannot be completed (for example, there is a
13431 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13432 &$host_lookup_failed$& remains set to &"0"&.
13433
13434 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13435 host name again if there is a subsequent reference to &$sender_host_name$&
13436 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13437 is set to &"1"&.
13438
13439 Exim does not automatically look up every calling host's name. If you want
13440 maximum efficiency, you should arrange your configuration so that it avoids
13441 these lookups altogether. The lookup happens only if one or more of the
13442 following are true:
13443
13444 .ilist
13445 A string containing &$sender_host_name$& is expanded.
13446 .next
13447 The calling host matches the list in &%host_lookup%&. In the default
13448 configuration, this option is set to *, so it must be changed if lookups are
13449 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13450 .next
13451 Exim needs the host name in order to test an item in a host list. The items
13452 that require this are described in sections &<<SECThoslispatnam>>& and
13453 &<<SECThoslispatnamsk>>&.
13454 .next
13455 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13456 In this case, the host name is required to compare with the name quoted in any
13457 EHLO or HELO commands that the client issues.
13458 .next
13459 The remote host issues a EHLO or HELO command that quotes one of the
13460 domains in &%helo_lookup_domains%&. The default value of this option is
13461 . ==== As this is a nested list, any displays it contains must be indented
13462 . ==== as otherwise they are too far to the left.
13463 .code
13464   helo_lookup_domains = @ : @[]
13465 .endd
13466 which causes a lookup if a remote host (incorrectly) gives the server's name or
13467 IP address in an EHLO or HELO command.
13468 .endlist
13469
13470
13471 .vitem &$sender_host_port$&
13472 .vindex "&$sender_host_port$&"
13473 When a message is received from a remote host, this variable contains the port
13474 number that was used on the remote host.
13475
13476 .vitem &$sender_ident$&
13477 .vindex "&$sender_ident$&"
13478 When a message is received from a remote host, this variable contains the
13479 identification received in response to an RFC 1413 request. When a message has
13480 been received locally, this variable contains the login name of the user that
13481 called Exim.
13482
13483 .vitem &$sender_rate_$&&'xxx'&
13484 A number of variables whose names begin &$sender_rate_$& are set as part of the
13485 &%ratelimit%& ACL condition. Details are given in section
13486 &<<SECTratelimiting>>&.
13487
13488 .vitem &$sender_rcvhost$&
13489 .cindex "DNS" "reverse lookup"
13490 .cindex "reverse DNS lookup"
13491 .vindex "&$sender_rcvhost$&"
13492 This is provided specifically for use in &'Received:'& headers. It starts with
13493 either the verified host name (as obtained from a reverse DNS lookup) or, if
13494 there is no verified host name, the IP address in square brackets. After that
13495 there may be text in parentheses. When the first item is a verified host name,
13496 the first thing in the parentheses is the IP address in square brackets,
13497 followed by a colon and a port number if port logging is enabled. When the
13498 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13499 the parentheses.
13500
13501 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13502 was used and its argument was not identical to the real host name or IP
13503 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13504 all three items are present in the parentheses, a newline and tab are inserted
13505 into the string, to improve the formatting of the &'Received:'& header.
13506
13507 .vitem &$sender_verify_failure$&
13508 .vindex "&$sender_verify_failure$&"
13509 In an ACL, when a sender verification fails, this variable contains information
13510 about the failure. The details are the same as for
13511 &$recipient_verify_failure$&.
13512
13513 .vitem &$sending_ip_address$&
13514 .vindex "&$sending_ip_address$&"
13515 This variable is set whenever an outgoing SMTP connection to another host has
13516 been set up. It contains the IP address of the local interface that is being
13517 used. This is useful if a host that has more than one IP address wants to take
13518 on different personalities depending on which one is being used. For incoming
13519 connections, see &$received_ip_address$&.
13520
13521 .vitem &$sending_port$&
13522 .vindex "&$sending_port$&"
13523 This variable is set whenever an outgoing SMTP connection to another host has
13524 been set up. It contains the local port that is being used. For incoming
13525 connections, see &$received_port$&.
13526
13527 .vitem &$smtp_active_hostname$&
13528 .vindex "&$smtp_active_hostname$&"
13529 During an incoming SMTP session, this variable contains the value of the active
13530 host name, as specified by the &%smtp_active_hostname%& option. The value of
13531 &$smtp_active_hostname$& is saved with any message that is received, so its
13532 value can be consulted during routing and delivery.
13533
13534 .vitem &$smtp_command$&
13535 .vindex "&$smtp_command$&"
13536 During the processing of an incoming SMTP command, this variable contains the
13537 entire command. This makes it possible to distinguish between HELO and EHLO in
13538 the HELO ACL, and also to distinguish between commands such as these:
13539 .code
13540 MAIL FROM:<>
13541 MAIL FROM: <>
13542 .endd
13543 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13544 command, the address in &$smtp_command$& is the original address before any
13545 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13546 the address after SMTP-time rewriting.
13547
13548 .vitem &$smtp_command_argument$&
13549 .cindex "SMTP" "command, argument for"
13550 .vindex "&$smtp_command_argument$&"
13551 While an ACL is running to check an SMTP command, this variable contains the
13552 argument, that is, the text that follows the command name, with leading white
13553 space removed. Following the introduction of &$smtp_command$&, this variable is
13554 somewhat redundant, but is retained for backwards compatibility.
13555
13556 .vitem &$smtp_command_history$&
13557 .cindex SMTP "command history"
13558 .vindex "&$smtp_command_history$&"
13559 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13560 received, in time-order left to right.  Only a limited number of commands
13561 are remembered.
13562
13563 .vitem &$smtp_count_at_connection_start$&
13564 .vindex "&$smtp_count_at_connection_start$&"
13565 This variable is set greater than zero only in processes spawned by the Exim
13566 daemon for handling incoming SMTP connections. The name is deliberately long,
13567 in order to emphasize what the contents are. When the daemon accepts a new
13568 connection, it increments this variable. A copy of the variable is passed to
13569 the child process that handles the connection, but its value is fixed, and
13570 never changes. It is only an approximation of how many incoming connections
13571 there actually are, because many other connections may come and go while a
13572 single connection is being processed. When a child process terminates, the
13573 daemon decrements its copy of the variable.
13574
13575 .vitem "&$sn0$& &-- &$sn9$&"
13576 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13577 that were current at the end of the system filter file. This allows a system
13578 filter file to set values that can be tested in users' filter files. For
13579 example, a system filter could set a value indicating how likely it is that a
13580 message is junk mail.
13581
13582 .vitem &$spam_$&&'xxx'&
13583 A number of variables whose names start with &$spam$& are available when Exim
13584 is compiled with the content-scanning extension. For details, see section
13585 &<<SECTscanspamass>>&.
13586
13587 .vitem &$spf_header_comment$& &&&
13588        &$spf_received$& &&&
13589        &$spf_result$& &&&
13590        &$spf_result_guessed$& &&&
13591        &$spf_smtp_comment$&
13592 These variables are only available if Exim is built with SPF support.
13593 For details see section &<<SECSPF>>&.
13594
13595 .vitem &$spool_directory$&
13596 .vindex "&$spool_directory$&"
13597 The name of Exim's spool directory.
13598
13599 .vitem &$spool_inodes$&
13600 .vindex "&$spool_inodes$&"
13601 The number of free inodes in the disk partition where Exim's spool files are
13602 being written. The value is recalculated whenever the variable is referenced.
13603 If the relevant file system does not have the concept of inodes, the value of
13604 is -1. See also the &%check_spool_inodes%& option.
13605
13606 .vitem &$spool_space$&
13607 .vindex "&$spool_space$&"
13608 The amount of free space (as a number of kilobytes) in the disk partition where
13609 Exim's spool files are being written. The value is recalculated whenever the
13610 variable is referenced. If the operating system does not have the ability to
13611 find the amount of free space (only true for experimental systems), the space
13612 value is -1. For example, to check in an ACL that there is at least 50
13613 megabytes free on the spool, you could write:
13614 .code
13615 condition = ${if > {$spool_space}{50000}}
13616 .endd
13617 See also the &%check_spool_space%& option.
13618
13619
13620 .vitem &$thisaddress$&
13621 .vindex "&$thisaddress$&"
13622 This variable is set only during the processing of the &%foranyaddress%&
13623 command in a filter file. Its use is explained in the description of that
13624 command, which can be found in the separate document entitled &'Exim's
13625 interfaces to mail filtering'&.
13626
13627 .vitem &$tls_in_bits$&
13628 .vindex "&$tls_in_bits$&"
13629 Contains an approximation of the TLS cipher's bit-strength
13630 on the inbound connection; the meaning of
13631 this depends upon the TLS implementation used.
13632 If TLS has not been negotiated, the value will be 0.
13633 The value of this is automatically fed into the Cyrus SASL authenticator
13634 when acting as a server, to specify the "external SSF" (a SASL term).
13635
13636 The deprecated &$tls_bits$& variable refers to the inbound side
13637 except when used in the context of an outbound SMTP delivery, when it refers to
13638 the outbound.
13639
13640 .vitem &$tls_out_bits$&
13641 .vindex "&$tls_out_bits$&"
13642 Contains an approximation of the TLS cipher's bit-strength
13643 on an outbound SMTP connection; the meaning of
13644 this depends upon the TLS implementation used.
13645 If TLS has not been negotiated, the value will be 0.
13646
13647 .vitem &$tls_in_ourcert$&
13648 .vindex "&$tls_in_ourcert$&"
13649 .cindex certificate variables
13650 This variable refers to the certificate presented to the peer of an
13651 inbound connection when the message was received.
13652 It is only useful as the argument of a
13653 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13654 or a &%def%& condition.
13655
13656 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13657 when a list of more than one
13658 file is used for &%tls_certificate%&, this variable is not reliable.
13659 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
13660
13661 .vitem &$tls_in_peercert$&
13662 .vindex "&$tls_in_peercert$&"
13663 This variable refers to the certificate presented by the peer of an
13664 inbound connection when the message was received.
13665 It is only useful as the argument of a
13666 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13667 or a &%def%& condition.
13668 If certificate verification fails it may refer to a failing chain element
13669 which is not the leaf.
13670
13671 .vitem &$tls_out_ourcert$&
13672 .vindex "&$tls_out_ourcert$&"
13673 This variable refers to the certificate presented to the peer of an
13674 outbound connection.  It is only useful as the argument of a
13675 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13676 or a &%def%& condition.
13677
13678 .vitem &$tls_out_peercert$&
13679 .vindex "&$tls_out_peercert$&"
13680 This variable refers to the certificate presented by the peer of an
13681 outbound connection.  It is only useful as the argument of a
13682 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13683 or a &%def%& condition.
13684 If certificate verification fails it may refer to a failing chain element
13685 which is not the leaf.
13686
13687 .vitem &$tls_in_certificate_verified$&
13688 .vindex "&$tls_in_certificate_verified$&"
13689 This variable is set to &"1"& if a TLS certificate was verified when the
13690 message was received, and &"0"& otherwise.
13691
13692 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13693 except when used in the context of an outbound SMTP delivery, when it refers to
13694 the outbound.
13695
13696 .vitem &$tls_out_certificate_verified$&
13697 .vindex "&$tls_out_certificate_verified$&"
13698 This variable is set to &"1"& if a TLS certificate was verified when an
13699 outbound SMTP connection was made,
13700 and &"0"& otherwise.
13701
13702 .vitem &$tls_in_cipher$&
13703 .vindex "&$tls_in_cipher$&"
13704 .vindex "&$tls_cipher$&"
13705 When a message is received from a remote host over an encrypted SMTP
13706 connection, this variable is set to the cipher suite that was negotiated, for
13707 example DES-CBC3-SHA. In other circumstances, in particular, for message
13708 received over unencrypted connections, the variable is empty. Testing
13709 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13710 non-encrypted connections during ACL processing.
13711
13712 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13713 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13714 becomes the same as &$tls_out_cipher$&.
13715
13716 .vitem &$tls_in_cipher_std$&
13717 .vindex "&$tls_in_cipher_std$&"
13718 As above, but returning the RFC standard name for the cipher suite.
13719
13720 .vitem &$tls_out_cipher$&
13721 .vindex "&$tls_out_cipher$&"
13722 This variable is
13723 cleared before any outgoing SMTP connection is made,
13724 and then set to the outgoing cipher suite if one is negotiated. See chapter
13725 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13726 details of the &(smtp)& transport.
13727
13728 .vitem &$tls_out_cipher_std$&
13729 .vindex "&$tls_out_cipher_std$&"
13730 As above, but returning the RFC standard name for the cipher suite.
13731
13732 .vitem &$tls_out_dane$&
13733 .vindex &$tls_out_dane$&
13734 DANE active status.  See section &<<SECDANE>>&.
13735
13736 .vitem &$tls_in_ocsp$&
13737 .vindex "&$tls_in_ocsp$&"
13738 When a message is received from a remote client connection
13739 the result of any OCSP request from the client is encoded in this variable:
13740 .code
13741 0 OCSP proof was not requested (default value)
13742 1 No response to request
13743 2 Response not verified
13744 3 Verification failed
13745 4 Verification succeeded
13746 .endd
13747
13748 .vitem &$tls_out_ocsp$&
13749 .vindex "&$tls_out_ocsp$&"
13750 When a message is sent to a remote host connection
13751 the result of any OCSP request made is encoded in this variable.
13752 See &$tls_in_ocsp$& for values.
13753
13754 .vitem &$tls_in_peerdn$&
13755 .vindex "&$tls_in_peerdn$&"
13756 .vindex "&$tls_peerdn$&"
13757 .cindex certificate "extracting fields"
13758 When a message is received from a remote host over an encrypted SMTP
13759 connection, and Exim is configured to request a certificate from the client,
13760 the value of the Distinguished Name of the certificate is made available in the
13761 &$tls_in_peerdn$& during subsequent processing.
13762 If certificate verification fails it may refer to a failing chain element
13763 which is not the leaf.
13764
13765 The deprecated &$tls_peerdn$& variable refers to the inbound side
13766 except when used in the context of an outbound SMTP delivery, when it refers to
13767 the outbound.
13768
13769 .vitem &$tls_out_peerdn$&
13770 .vindex "&$tls_out_peerdn$&"
13771 When a message is being delivered to a remote host over an encrypted SMTP
13772 connection, and Exim is configured to request a certificate from the server,
13773 the value of the Distinguished Name of the certificate is made available in the
13774 &$tls_out_peerdn$& during subsequent processing.
13775 If certificate verification fails it may refer to a failing chain element
13776 which is not the leaf.
13777
13778
13779 .new
13780 .vitem &$tls_in_resumption$& &&&
13781        &$tls_out_resumption$&
13782 .vindex &$tls_in_resumption$&
13783 .vindex &$tls_out_resumption$&
13784 .cindex TLS resumption
13785 Observability for TLS session resumption.  See &<<SECTresumption>>& for details.
13786 .wen
13787
13788
13789 .vitem &$tls_in_sni$&
13790 .vindex "&$tls_in_sni$&"
13791 .vindex "&$tls_sni$&"
13792 .cindex "TLS" "Server Name Indication"
13793 When a TLS session is being established, if the client sends the Server
13794 Name Indication extension, the value will be placed in this variable.
13795 If the variable appears in &%tls_certificate%& then this option and
13796 some others, described in &<<SECTtlssni>>&,
13797 will be re-expanded early in the TLS session, to permit
13798 a different certificate to be presented (and optionally a different key to be
13799 used) to the client, based upon the value of the SNI extension.
13800
13801 The deprecated &$tls_sni$& variable refers to the inbound side
13802 except when used in the context of an outbound SMTP delivery, when it refers to
13803 the outbound.
13804
13805 .vitem &$tls_out_sni$&
13806 .vindex "&$tls_out_sni$&"
13807 .cindex "TLS" "Server Name Indication"
13808 During outbound
13809 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13810 the transport.
13811
13812 .vitem &$tls_out_tlsa_usage$&
13813 .vindex &$tls_out_tlsa_usage$&
13814 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13815
13816 .vitem &$tls_in_ver$&
13817 .vindex "&$tls_in_ver$&"
13818 When a message is received from a remote host over an encrypted SMTP connection
13819 this variable is set to the protocol version, eg &'TLS1.2'&.
13820
13821 .vitem &$tls_out_ver$&
13822 .vindex "&$tls_out_ver$&"
13823 When a message is being delivered to a remote host over an encrypted SMTP connection
13824 this variable is set to the protocol version.
13825
13826
13827 .vitem &$tod_bsdinbox$&
13828 .vindex "&$tod_bsdinbox$&"
13829 The time of day and the date, in the format required for BSD-style mailbox
13830 files, for example: Thu Oct 17 17:14:09 1995.
13831
13832 .vitem &$tod_epoch$&
13833 .vindex "&$tod_epoch$&"
13834 The time and date as a number of seconds since the start of the Unix epoch.
13835
13836 .vitem &$tod_epoch_l$&
13837 .vindex "&$tod_epoch_l$&"
13838 The time and date as a number of microseconds since the start of the Unix epoch.
13839
13840 .vitem &$tod_full$&
13841 .vindex "&$tod_full$&"
13842 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13843 +0100. The timezone is always given as a numerical offset from UTC, with
13844 positive values used for timezones that are ahead (east) of UTC, and negative
13845 values for those that are behind (west).
13846
13847 .vitem &$tod_log$&
13848 .vindex "&$tod_log$&"
13849 The time and date in the format used for writing Exim's log files, for example:
13850 1995-10-12 15:32:29, but without a timezone.
13851
13852 .vitem &$tod_logfile$&
13853 .vindex "&$tod_logfile$&"
13854 This variable contains the date in the format yyyymmdd. This is the format that
13855 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13856 flag.
13857
13858 .vitem &$tod_zone$&
13859 .vindex "&$tod_zone$&"
13860 This variable contains the numerical value of the local timezone, for example:
13861 -0500.
13862
13863 .vitem &$tod_zulu$&
13864 .vindex "&$tod_zulu$&"
13865 This variable contains the UTC date and time in &"Zulu"& format, as specified
13866 by ISO 8601, for example: 20030221154023Z.
13867
13868 .vitem &$transport_name$&
13869 .cindex "transport" "name"
13870 .cindex "name" "of transport"
13871 .vindex "&$transport_name$&"
13872 During the running of a transport, this variable contains its name.
13873
13874 .vitem &$value$&
13875 .vindex "&$value$&"
13876 This variable contains the result of an expansion lookup, extraction operation,
13877 or external command, as described above. It is also used during a
13878 &*reduce*& expansion.
13879
13880 .vitem &$verify_mode$&
13881 .vindex "&$verify_mode$&"
13882 While a router or transport is being run in verify mode or for cutthrough delivery,
13883 contains "S" for sender-verification or "R" for recipient-verification.
13884 Otherwise, empty.
13885
13886 .vitem &$version_number$&
13887 .vindex "&$version_number$&"
13888 The version number of Exim. Same as &$exim_version$&, may be overridden
13889 by the &%exim_version%& main config option.
13890
13891 .vitem &$warn_message_delay$&
13892 .vindex "&$warn_message_delay$&"
13893 This variable is set only during the creation of a message warning about a
13894 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13895
13896 .vitem &$warn_message_recipients$&
13897 .vindex "&$warn_message_recipients$&"
13898 This variable is set only during the creation of a message warning about a
13899 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13900 .endlist
13901 .ecindex IIDstrexp
13902
13903
13904
13905 . ////////////////////////////////////////////////////////////////////////////
13906 . ////////////////////////////////////////////////////////////////////////////
13907
13908 .chapter "Embedded Perl" "CHAPperl"
13909 .scindex IIDperl "Perl" "calling from Exim"
13910 Exim can be built to include an embedded Perl interpreter. When this is done,
13911 Perl subroutines can be called as part of the string expansion process. To make
13912 use of the Perl support, you need version 5.004 or later of Perl installed on
13913 your system. To include the embedded interpreter in the Exim binary, include
13914 the line
13915 .code
13916 EXIM_PERL = perl.o
13917 .endd
13918 in your &_Local/Makefile_& and then build Exim in the normal way.
13919
13920
13921 .section "Setting up so Perl can be used" "SECID85"
13922 .oindex "&%perl_startup%&"
13923 Access to Perl subroutines is via a global configuration option called
13924 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13925 no &%perl_startup%& option in the Exim configuration file then no Perl
13926 interpreter is started and there is almost no overhead for Exim (since none of
13927 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13928 option then the associated value is taken to be Perl code which is executed in
13929 a newly created Perl interpreter.
13930
13931 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13932 need backslashes before any characters to escape special meanings. The option
13933 should usually be something like
13934 .code
13935 perl_startup = do '/etc/exim.pl'
13936 .endd
13937 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13938 use from Exim. Exim can be configured either to start up a Perl interpreter as
13939 soon as it is entered, or to wait until the first time it is needed. Starting
13940 the interpreter at the beginning ensures that it is done while Exim still has
13941 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13942 fact used in a particular run. Also, note that this does not mean that Exim is
13943 necessarily running as root when Perl is called at a later time. By default,
13944 the interpreter is started only when it is needed, but this can be changed in
13945 two ways:
13946
13947 .ilist
13948 .oindex "&%perl_at_start%&"
13949 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13950 a startup when Exim is entered.
13951 .next
13952 The command line option &%-ps%& also requests a startup when Exim is entered,
13953 overriding the setting of &%perl_at_start%&.
13954 .endlist
13955
13956 There is also a command line option &%-pd%& (for delay) which suppresses the
13957 initial startup, even if &%perl_at_start%& is set.
13958
13959 .ilist
13960 .oindex "&%perl_taintmode%&"
13961 .cindex "Perl" "taintmode"
13962 To provide more security executing Perl code via the embedded Perl
13963 interpreter, the &%perl_taintmode%& option can be set. This enables the
13964 taint mode of the Perl interpreter. You are encouraged to set this
13965 option to a true value. To avoid breaking existing installations, it
13966 defaults to false.
13967
13968
13969 .section "Calling Perl subroutines" "SECID86"
13970 When the configuration file includes a &%perl_startup%& option you can make use
13971 of the string expansion item to call the Perl subroutines that are defined
13972 by the &%perl_startup%& code. The operator is used in any of the following
13973 forms:
13974 .code
13975 ${perl{foo}}
13976 ${perl{foo}{argument}}
13977 ${perl{foo}{argument1}{argument2} ... }
13978 .endd
13979 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13980 arguments may be passed. Passing more than this results in an expansion failure
13981 with an error message of the form
13982 .code
13983 Too many arguments passed to Perl subroutine "foo" (max is 8)
13984 .endd
13985 The return value of the Perl subroutine is evaluated in a scalar context before
13986 it is passed back to Exim to be inserted into the expanded string. If the
13987 return value is &'undef'&, the expansion is forced to fail in the same way as
13988 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13989 by obeying Perl's &%die%& function, the expansion fails with the error message
13990 that was passed to &%die%&.
13991
13992
13993 .section "Calling Exim functions from Perl" "SECID87"
13994 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13995 is available to call back into Exim's string expansion function. For example,
13996 the Perl code
13997 .code
13998 my $lp = Exim::expand_string('$local_part');
13999 .endd
14000 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
14001 Note those are single quotes and not double quotes to protect against
14002 &$local_part$& being interpolated as a Perl variable.
14003
14004 If the string expansion is forced to fail by a &"fail"& item, the result of
14005 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
14006 expansion string, the Perl call from the original expansion string fails with
14007 an appropriate error message, in the same way as if &%die%& were used.
14008
14009 .cindex "debugging" "from embedded Perl"
14010 .cindex "log" "writing from embedded Perl"
14011 Two other Exim functions are available for use from within Perl code.
14012 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
14013 debugging is enabled. If you want a newline at the end, you must supply it.
14014 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
14015 timestamp. In this case, you should not supply a terminating newline.
14016
14017
14018 .section "Use of standard output and error by Perl" "SECID88"
14019 .cindex "Perl" "standard output and error"
14020 You should not write to the standard error or output streams from within your
14021 Perl code, as it is not defined how these are set up. In versions of Exim
14022 before 4.50, it is possible for the standard output or error to refer to the
14023 SMTP connection during message reception via the daemon. Writing to this stream
14024 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
14025 error streams are connected to &_/dev/null_& in the daemon. The chaos is
14026 avoided, but the output is lost.
14027
14028 .cindex "Perl" "use of &%warn%&"
14029 The Perl &%warn%& statement writes to the standard error stream by default.
14030 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
14031 you have no control. When Exim starts up the Perl interpreter, it arranges for
14032 output from the &%warn%& statement to be written to the Exim main log. You can
14033 change this by including appropriate Perl magic somewhere in your Perl code.
14034 For example, to discard &%warn%& output completely, you need this:
14035 .code
14036 $SIG{__WARN__} = sub { };
14037 .endd
14038 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
14039 example, the code for the subroutine is empty, so it does nothing, but you can
14040 include any Perl code that you like. The text of the &%warn%& message is passed
14041 as the first subroutine argument.
14042 .ecindex IIDperl
14043
14044
14045 . ////////////////////////////////////////////////////////////////////////////
14046 . ////////////////////////////////////////////////////////////////////////////
14047
14048 .chapter "Starting the daemon and the use of network interfaces" &&&
14049          "CHAPinterfaces" &&&
14050          "Starting the daemon"
14051 .cindex "daemon" "starting"
14052 .cindex "interface" "listening"
14053 .cindex "network interface"
14054 .cindex "interface" "network"
14055 .cindex "IP address" "for listening"
14056 .cindex "daemon" "listening IP addresses"
14057 .cindex "TCP/IP" "setting listening interfaces"
14058 .cindex "TCP/IP" "setting listening ports"
14059 A host that is connected to a TCP/IP network may have one or more physical
14060 hardware network interfaces. Each of these interfaces may be configured as one
14061 or more &"logical"& interfaces, which are the entities that a program actually
14062 works with. Each of these logical interfaces is associated with an IP address.
14063 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
14064 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
14065 knowledge about the host's interfaces for use in three different circumstances:
14066
14067 .olist
14068 When a listening daemon is started, Exim needs to know which interfaces
14069 and ports to listen on.
14070 .next
14071 When Exim is routing an address, it needs to know which IP addresses
14072 are associated with local interfaces. This is required for the correct
14073 processing of MX lists by removing the local host and others with the
14074 same or higher priority values. Also, Exim needs to detect cases
14075 when an address is routed to an IP address that in fact belongs to the
14076 local host. Unless the &%self%& router option or the &%allow_localhost%&
14077 option of the smtp transport is set (as appropriate), this is treated
14078 as an error situation.
14079 .next
14080 When Exim connects to a remote host, it may need to know which interface to use
14081 for the outgoing connection.
14082 .endlist
14083
14084
14085 Exim's default behaviour is likely to be appropriate in the vast majority
14086 of cases. If your host has only one interface, and you want all its IP
14087 addresses to be treated in the same way, and you are using only the
14088 standard SMTP port, you should not need to take any special action. The
14089 rest of this chapter does not apply to you.
14090
14091 In a more complicated situation you may want to listen only on certain
14092 interfaces, or on different ports, and for this reason there are a number of
14093 options that can be used to influence Exim's behaviour. The rest of this
14094 chapter describes how they operate.
14095
14096 When a message is received over TCP/IP, the interface and port that were
14097 actually used are set in &$received_ip_address$& and &$received_port$&.
14098
14099
14100
14101 .section "Starting a listening daemon" "SECID89"
14102 When a listening daemon is started (by means of the &%-bd%& command line
14103 option), the interfaces and ports on which it listens are controlled by the
14104 following options:
14105
14106 .ilist
14107 &%daemon_smtp_ports%& contains a list of default ports
14108 or service names.
14109 (For backward compatibility, this option can also be specified in the singular.)
14110 .next
14111 &%local_interfaces%& contains list of interface IP addresses on which to
14112 listen. Each item may optionally also specify a port.
14113 .endlist
14114
14115 The default list separator in both cases is a colon, but this can be changed as
14116 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
14117 it is usually best to change the separator to avoid having to double all the
14118 colons. For example:
14119 .code
14120 local_interfaces = <; 127.0.0.1 ; \
14121                       192.168.23.65 ; \
14122                       ::1 ; \
14123                       3ffe:ffff:836f::fe86:a061
14124 .endd
14125 There are two different formats for specifying a port along with an IP address
14126 in &%local_interfaces%&:
14127
14128 .olist
14129 The port is added onto the address with a dot separator. For example, to listen
14130 on port 1234 on two different IP addresses:
14131 .code
14132 local_interfaces = <; 192.168.23.65.1234 ; \
14133                       3ffe:ffff:836f::fe86:a061.1234
14134 .endd
14135 .next
14136 The IP address is enclosed in square brackets, and the port is added
14137 with a colon separator, for example:
14138 .code
14139 local_interfaces = <; [192.168.23.65]:1234 ; \
14140                       [3ffe:ffff:836f::fe86:a061]:1234
14141 .endd
14142 .endlist
14143
14144 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
14145 default setting contains just one port:
14146 .code
14147 daemon_smtp_ports = smtp
14148 .endd
14149 If more than one port is listed, each interface that does not have its own port
14150 specified listens on all of them. Ports that are listed in
14151 &%daemon_smtp_ports%& can be identified either by name (defined in
14152 &_/etc/services_&) or by number. However, when ports are given with individual
14153 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
14154
14155
14156
14157 .section "Special IP listening addresses" "SECID90"
14158 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
14159 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
14160 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
14161 instead of setting up separate listening sockets for each interface. The
14162 default value of &%local_interfaces%& is
14163 .code
14164 local_interfaces = 0.0.0.0
14165 .endd
14166 when Exim is built without IPv6 support; otherwise it is:
14167 .code
14168 local_interfaces = <; ::0 ; 0.0.0.0
14169 .endd
14170 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
14171
14172
14173
14174 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
14175 The &%-oX%& command line option can be used to override the values of
14176 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
14177 instance. Another way of doing this would be to use macros and the &%-D%&
14178 option. However, &%-oX%& can be used by any admin user, whereas modification of
14179 the runtime configuration by &%-D%& is allowed only when the caller is root or
14180 exim.
14181
14182 The value of &%-oX%& is a list of items. The default colon separator can be
14183 changed in the usual way (&<<SECTlistsepchange>>&) if required.
14184 If there are any items that do not
14185 contain dots or colons (that is, are not IP addresses), the value of
14186 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
14187 items that do contain dots or colons, the value of &%local_interfaces%& is
14188 replaced by those items. Thus, for example,
14189 .code
14190 -oX 1225
14191 .endd
14192 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
14193 whereas
14194 .code
14195 -oX 192.168.34.5.1125
14196 .endd
14197 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
14198 (However, since &%local_interfaces%& now contains no items without ports, the
14199 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
14200
14201
14202
14203 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
14204 .cindex "submissions protocol"
14205 .cindex "ssmtp protocol"
14206 .cindex "smtps protocol"
14207 .cindex "SMTP" "ssmtp protocol"
14208 .cindex "SMTP" "smtps protocol"
14209 Exim supports the use of TLS-on-connect, used by mail clients in the
14210 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
14211 For some years, IETF Standards Track documents only blessed the
14212 STARTTLS-based Submission service (port 587) while common practice was to support
14213 the same feature set on port 465, but using TLS-on-connect.
14214 If your installation needs to provide service to mail clients
14215 (Mail User Agents, MUAs) then you should provide service on both the 587 and
14216 the 465 TCP ports.
14217
14218 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
14219 service names, connections to those ports must first establish TLS, before
14220 proceeding to the application layer use of the SMTP protocol.
14221
14222 The common use of this option is expected to be
14223 .code
14224 tls_on_connect_ports = 465
14225 .endd
14226 per RFC 8314.
14227 There is also a command line option &%-tls-on-connect%&, which forces all ports
14228 to behave in this way when a daemon is started.
14229
14230 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
14231 daemon to listen on those ports. You must still specify them in
14232 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
14233 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
14234 connections via the daemon.)
14235
14236
14237
14238
14239 .section "IPv6 address scopes" "SECID92"
14240 .cindex "IPv6" "address scopes"
14241 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
14242 can, in principle, have the same link-local IPv6 address on different
14243 interfaces. Thus, additional information is needed, over and above the IP
14244 address, to distinguish individual interfaces. A convention of using a
14245 percent sign followed by something (often the interface name) has been
14246 adopted in some cases, leading to addresses like this:
14247 .code
14248 fe80::202:b3ff:fe03:45c1%eth0
14249 .endd
14250 To accommodate this usage, a percent sign followed by an arbitrary string is
14251 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
14252 to convert a textual IPv6 address for actual use. This function recognizes the
14253 percent convention in operating systems that support it, and it processes the
14254 address appropriately. Unfortunately, some older libraries have problems with
14255 &[getaddrinfo()]&. If
14256 .code
14257 IPV6_USE_INET_PTON=yes
14258 .endd
14259 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
14260 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
14261 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
14262 function.) Of course, this means that the additional functionality of
14263 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
14264
14265 .section "Disabling IPv6" "SECID93"
14266 .cindex "IPv6" "disabling"
14267 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
14268 run on a host whose kernel does not support IPv6. The binary will fall back to
14269 using IPv4, but it may waste resources looking up AAAA records, and trying to
14270 connect to IPv6 addresses, causing delays to mail delivery. If you set the
14271 .oindex "&%disable_ipv6%&"
14272 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
14273 activities take place. AAAA records are never looked up, and any IPv6 addresses
14274 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
14275 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
14276 to handle IPv6 literal addresses.
14277
14278 On the other hand, when IPv6 is in use, there may be times when you want to
14279 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
14280 option to globally suppress the lookup of AAAA records for specified domains,
14281 and you can use the &%ignore_target_hosts%& generic router option to ignore
14282 IPv6 addresses in an individual router.
14283
14284
14285
14286 .section "Examples of starting a listening daemon" "SECID94"
14287 The default case in an IPv6 environment is
14288 .code
14289 daemon_smtp_ports = smtp
14290 local_interfaces = <; ::0 ; 0.0.0.0
14291 .endd
14292 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
14293 Either one or two sockets may be used, depending on the characteristics of
14294 the TCP/IP stack. (This is complicated and messy; for more information,
14295 read the comments in the &_daemon.c_& source file.)
14296
14297 To specify listening on ports 25 and 26 on all interfaces:
14298 .code
14299 daemon_smtp_ports = 25 : 26
14300 .endd
14301 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
14302 .code
14303 local_interfaces = <; ::0.25     ; ::0.26 \
14304                       0.0.0.0.25 ; 0.0.0.0.26
14305 .endd
14306 To listen on the default port on all IPv4 interfaces, and on port 26 on the
14307 IPv4 loopback address only:
14308 .code
14309 local_interfaces = 0.0.0.0 : 127.0.0.1.26
14310 .endd
14311 To specify listening on the default port on specific interfaces only:
14312 .code
14313 local_interfaces = 10.0.0.67 : 192.168.34.67
14314 .endd
14315 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
14316
14317
14318
14319 .section "Recognizing the local host" "SECTreclocipadd"
14320 The &%local_interfaces%& option is also used when Exim needs to determine
14321 whether or not an IP address refers to the local host. That is, the IP
14322 addresses of all the interfaces on which a daemon is listening are always
14323 treated as local.
14324
14325 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
14326 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
14327 available interfaces from the operating system, and extracts the relevant
14328 (that is, IPv4 or IPv6) addresses to use for checking.
14329
14330 Some systems set up large numbers of virtual interfaces in order to provide
14331 many virtual web servers. In this situation, you may want to listen for
14332 email on only a few of the available interfaces, but nevertheless treat all
14333 interfaces as local when routing. You can do this by setting
14334 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
14335 &"all"& wildcard values. These addresses are recognized as local, but are not
14336 used for listening. Consider this example:
14337 .code
14338 local_interfaces = <; 127.0.0.1 ; ::1 ; \
14339                       192.168.53.235 ; \
14340                       3ffe:2101:12:1:a00:20ff:fe86:a061
14341
14342 extra_local_interfaces = <; ::0 ; 0.0.0.0
14343 .endd
14344 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
14345 address, but all available interface addresses are treated as local when
14346 Exim is routing.
14347
14348 In some environments the local host name may be in an MX list, but with an IP
14349 address that is not assigned to any local interface. In other cases it may be
14350 desirable to treat other host names as if they referred to the local host. Both
14351 these cases can be handled by setting the &%hosts_treat_as_local%& option.
14352 This contains host names rather than IP addresses. When a host is referenced
14353 during routing, either via an MX record or directly, it is treated as the local
14354 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
14355 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
14356
14357
14358
14359 .section "Delivering to a remote host" "SECID95"
14360 Delivery to a remote host is handled by the smtp transport. By default, it
14361 allows the system's TCP/IP functions to choose which interface to use (if
14362 there is more than one) when connecting to a remote host. However, the
14363 &%interface%& option can be set to specify which interface is used. See the
14364 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
14365 details.
14366
14367
14368
14369
14370 . ////////////////////////////////////////////////////////////////////////////
14371 . ////////////////////////////////////////////////////////////////////////////
14372
14373 .chapter "Main configuration" "CHAPmainconfig"
14374 .scindex IIDconfima "configuration file" "main section"
14375 .scindex IIDmaiconf "main configuration"
14376 The first part of the runtime configuration file contains three types of item:
14377
14378 .ilist
14379 Macro definitions: These lines start with an upper case letter. See section
14380 &<<SECTmacrodefs>>& for details of macro processing.
14381 .next
14382 Named list definitions: These lines start with one of the words &"domainlist"&,
14383 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14384 section &<<SECTnamedlists>>&.
14385 .next
14386 Main configuration settings: Each setting occupies one line of the file
14387 (with possible continuations). If any setting is preceded by the word
14388 &"hide"&, the &%-bP%& command line option displays its value to admin users
14389 only. See section &<<SECTcos>>& for a description of the syntax of these option
14390 settings.
14391 .endlist
14392
14393 This chapter specifies all the main configuration options, along with their
14394 types and default values. For ease of finding a particular option, they appear
14395 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14396 are now so many options, they are first listed briefly in functional groups, as
14397 an aid to finding the name of the option you are looking for. Some options are
14398 listed in more than one group.
14399
14400 .section "Miscellaneous" "SECID96"
14401 .table2
14402 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14403 .row &%debug_store%&                 "do extra internal checks"
14404 .row &%disable_ipv6%&                "do no IPv6 processing"
14405 .row &%keep_malformed%&              "for broken files &-- should not happen"
14406 .row &%localhost_number%&            "for unique message ids in clusters"
14407 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14408 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14409 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14410 .row &%print_topbitchars%&           "top-bit characters are printing"
14411 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14412 .row &%timezone%&                    "force time zone"
14413 .endtable
14414
14415
14416 .section "Exim parameters" "SECID97"
14417 .table2
14418 .row &%exim_group%&                  "override compiled-in value"
14419 .row &%exim_path%&                   "override compiled-in value"
14420 .row &%exim_user%&                   "override compiled-in value"
14421 .row &%primary_hostname%&            "default from &[uname()]&"
14422 .row &%split_spool_directory%&       "use multiple directories"
14423 .row &%spool_directory%&             "override compiled-in value"
14424 .endtable
14425
14426
14427
14428 .section "Privilege controls" "SECID98"
14429 .table2
14430 .row &%admin_groups%&                "groups that are Exim admin users"
14431 .row &%commandline_checks_require_admin%& "require admin for various checks"
14432 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14433 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14434 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14435 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14436 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14437 .row &%never_users%&                 "do not run deliveries as these"
14438 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14439 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14440 .row &%trusted_groups%&              "groups that are trusted"
14441 .row &%trusted_users%&               "users that are trusted"
14442 .endtable
14443
14444
14445
14446 .section "Logging" "SECID99"
14447 .table2
14448 .row &%event_action%&                "custom logging"
14449 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14450 .row &%log_file_path%&               "override compiled-in value"
14451 .row &%log_selector%&                "set/unset optional logging"
14452 .row &%log_timezone%&                "add timezone to log lines"
14453 .row &%message_logs%&                "create per-message logs"
14454 .row &%preserve_message_logs%&       "after message completion"
14455 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14456 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14457 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14458 .row &%syslog_facility%&             "set syslog &""facility""& field"
14459 .row &%syslog_pid%&                  "pid in syslog lines"
14460 .row &%syslog_processname%&          "set syslog &""ident""& field"
14461 .row &%syslog_timestamp%&            "timestamp syslog lines"
14462 .row &%write_rejectlog%&             "control use of message log"
14463 .endtable
14464
14465
14466
14467 .section "Frozen messages" "SECID100"
14468 .table2
14469 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14470 .row &%freeze_tell%&                 "send message when freezing"
14471 .row &%move_frozen_messages%&        "to another directory"
14472 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14473 .endtable
14474
14475
14476
14477 .section "Data lookups" "SECID101"
14478 .table2
14479 .row &%ibase_servers%&               "InterBase servers"
14480 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14481 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14482 .row &%ldap_cert_file%&              "client cert file for LDAP"
14483 .row &%ldap_cert_key%&               "client key file for LDAP"
14484 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14485 .row &%ldap_default_servers%&        "used if no server in query"
14486 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14487 .row &%ldap_start_tls%&              "require TLS within LDAP"
14488 .row &%ldap_version%&                "set protocol version"
14489 .row &%lookup_open_max%&             "lookup files held open"
14490 .row &%mysql_servers%&               "default MySQL servers"
14491 .row &%oracle_servers%&              "Oracle servers"
14492 .row &%pgsql_servers%&               "default PostgreSQL servers"
14493 .row &%sqlite_lock_timeout%&         "as it says"
14494 .endtable
14495
14496
14497
14498 .section "Message ids" "SECID102"
14499 .table2
14500 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14501 .row &%message_id_header_text%&      "ditto"
14502 .endtable
14503
14504
14505
14506 .section "Embedded Perl Startup" "SECID103"
14507 .table2
14508 .row &%perl_at_start%&               "always start the interpreter"
14509 .row &%perl_startup%&                "code to obey when starting Perl"
14510 .row &%perl_taintmode%&              "enable taint mode in Perl"
14511 .endtable
14512
14513
14514
14515 .section "Daemon" "SECID104"
14516 .table2
14517 .row &%daemon_smtp_ports%&           "default ports"
14518 .row &%daemon_startup_retries%&      "number of times to retry"
14519 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14520 .row &%extra_local_interfaces%&      "not necessarily listened on"
14521 .row &%local_interfaces%&            "on which to listen, with optional ports"
14522 .row &%notifier_socket%&             "override compiled-in value"
14523 .row &%pid_file_path%&               "override compiled-in value"
14524 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14525 .endtable
14526
14527
14528
14529 .section "Resource control" "SECID105"
14530 .table2
14531 .row &%check_log_inodes%&            "before accepting a message"
14532 .row &%check_log_space%&             "before accepting a message"
14533 .row &%check_spool_inodes%&          "before accepting a message"
14534 .row &%check_spool_space%&           "before accepting a message"
14535 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14536 .row &%queue_only_load%&             "queue incoming if load high"
14537 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14538 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14539 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14540 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14541 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14542 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14543 .row &%smtp_accept_max_per_connection%& "messages per connection"
14544 .row &%smtp_accept_max_per_host%&    "connections from one host"
14545 .row &%smtp_accept_queue%&           "queue mail if more connections"
14546 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14547                                            connection"
14548 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14549 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14550 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14551 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14552 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14553 .endtable
14554
14555
14556
14557 .section "Policy controls" "SECID106"
14558 .table2
14559 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14560 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14561 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14562 .row &%acl_smtp_auth%&               "ACL for AUTH"
14563 .row &%acl_smtp_connect%&            "ACL for connection"
14564 .row &%acl_smtp_data%&               "ACL for DATA"
14565 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14566 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14567 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14568 .row &%acl_smtp_expn%&               "ACL for EXPN"
14569 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14570 .row &%acl_smtp_mail%&               "ACL for MAIL"
14571 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14572 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14573 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14574 .row &%acl_smtp_predata%&            "ACL for start of data"
14575 .row &%acl_smtp_quit%&               "ACL for QUIT"
14576 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14577 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14578 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14579 .row &%av_scanner%&                  "specify virus scanner"
14580 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14581                                       words""&"
14582 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14583 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14584 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14585 .row &%header_maxsize%&              "total size of message header"
14586 .row &%header_line_maxsize%&         "individual header line limit"
14587 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14588 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14589 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14590 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14591 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14592 .row &%host_lookup%&                 "host name looked up for these hosts"
14593 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14594 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14595 .row &%host_reject_connection%&      "reject connection from these hosts"
14596 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14597 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14598 .row &%message_size_limit%&          "for all messages"
14599 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14600 .row &%spamd_address%&               "set interface to SpamAssassin"
14601 .row &%strict_acl_vars%&             "object to unset ACL variables"
14602 .row &%spf_smtp_comment_template%&   "template for &$spf_smtp_comment$&"
14603 .endtable
14604
14605
14606
14607 .section "Callout cache" "SECID107"
14608 .table2
14609 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14610                                          item"
14611 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14612                                          item"
14613 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14614 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14615 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14616 .endtable
14617
14618
14619
14620 .section "TLS" "SECID108"
14621 .table2
14622 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14623 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14624 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14625 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14626 .row &%tls_certificate%&             "location of server certificate"
14627 .row &%tls_crl%&                     "certificate revocation list"
14628 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14629 .row &%tls_dhparam%&                 "DH parameters for server"
14630 .row &%tls_eccurve%&                 "EC curve selection for server"
14631 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14632 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14633 .row &%tls_privatekey%&              "location of server private key"
14634 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14635 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14636 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14637 .row &%tls_verify_certificates%&     "expected client certificates"
14638 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14639 .endtable
14640
14641
14642
14643 .section "Local user handling" "SECID109"
14644 .table2
14645 .row &%finduser_retries%&            "useful in NIS environments"
14646 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14647 .row &%gecos_pattern%&               "ditto"
14648 .row &%max_username_length%&         "for systems that truncate"
14649 .row &%unknown_login%&               "used when no login name found"
14650 .row &%unknown_username%&            "ditto"
14651 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14652 .row &%uucp_from_sender%&            "ditto"
14653 .endtable
14654
14655
14656
14657 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14658 .table2
14659 .row &%header_maxsize%&              "total size of message header"
14660 .row &%header_line_maxsize%&         "individual header line limit"
14661 .row &%message_size_limit%&          "applies to all messages"
14662 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14663 .row &%received_header_text%&        "expanded to make &'Received:'&"
14664 .row &%received_headers_max%&        "for mail loop detection"
14665 .row &%recipients_max%&              "limit per message"
14666 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14667 .endtable
14668
14669
14670
14671
14672 .section "Non-SMTP incoming messages" "SECID111"
14673 .table2
14674 .row &%receive_timeout%&             "for non-SMTP messages"
14675 .endtable
14676
14677
14678
14679
14680
14681 .section "Incoming SMTP messages" "SECID112"
14682 See also the &'Policy controls'& section above.
14683
14684 .table2
14685 .row &%dkim_verify_hashes%&          "DKIM hash methods accepted for signatures"
14686 .row &%dkim_verify_keytypes%&        "DKIM key types accepted for signatures"
14687 .row &%dkim_verify_min_keysizes%&    "DKIM key sizes accepted for signatures"
14688 .row &%dkim_verify_signers%&         "DKIM domains for which DKIM ACL is run"
14689 .row &%dmarc_forensic_sender%&       "DMARC sender for report messages"
14690 .row &%dmarc_history_file%&          "DMARC results log"
14691 .row &%dmarc_tld_file%&              "DMARC toplevel domains file"
14692 .row &%host_lookup%&                 "host name looked up for these hosts"
14693 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14694 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14695 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14696 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14697 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14698 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14699 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14700 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14701 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14702 .row &%smtp_accept_max_per_connection%& "messages per connection"
14703 .row &%smtp_accept_max_per_host%&    "connections from one host"
14704 .row &%smtp_accept_queue%&           "queue mail if more connections"
14705 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14706                                            connection"
14707 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14708 .row &%smtp_active_hostname%&        "host name to use in messages"
14709 .row &%smtp_banner%&                 "text for welcome banner"
14710 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14711 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14712 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14713 .row &%smtp_etrn_command%&           "what to run for ETRN"
14714 .row &%smtp_etrn_serialize%&         "only one at once"
14715 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14716 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14717 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14718 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14719 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14720 .row &%smtp_receive_timeout%&        "per command or data line"
14721 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14722 .row &%smtp_return_error_details%&   "give detail on rejections"
14723 .endtable
14724
14725
14726
14727 .section "SMTP extensions" "SECID113"
14728 .table2
14729 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14730 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14731 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14732 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14733 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14734 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14735 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14736 .row &%pipelining_connect_advertise_hosts%& "advertise pipelining to these hosts"
14737 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14738 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14739 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14740 .endtable
14741
14742
14743
14744 .section "Processing messages" "SECID114"
14745 .table2
14746 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14747 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14748 .row &%allow_utf8_domains%&          "in addresses"
14749 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14750                                       words""&"
14751 .row &%delivery_date_remove%&        "from incoming messages"
14752 .row &%envelope_to_remove%&          "from incoming messages"
14753 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14754 .row &%headers_charset%&             "default for translations"
14755 .row &%qualify_domain%&              "default for senders"
14756 .row &%qualify_recipient%&           "default for recipients"
14757 .row &%return_path_remove%&          "from incoming messages"
14758 .row &%strip_excess_angle_brackets%& "in addresses"
14759 .row &%strip_trailing_dot%&          "at end of addresses"
14760 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14761 .endtable
14762
14763
14764
14765 .section "System filter" "SECID115"
14766 .table2
14767 .row &%system_filter%&               "locate system filter"
14768 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14769                                             directory"
14770 .row &%system_filter_file_transport%& "transport for delivery to a file"
14771 .row &%system_filter_group%&         "group for filter running"
14772 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14773 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14774 .row &%system_filter_user%&          "user for filter running"
14775 .endtable
14776
14777
14778
14779 .section "Routing and delivery" "SECID116"
14780 .table2
14781 .row &%disable_ipv6%&                "do no IPv6 processing"
14782 .row &%dns_again_means_nonexist%&    "for broken domains"
14783 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14784 .row &%dns_dnssec_ok%&               "parameter for resolver"
14785 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14786 .row &%dns_retrans%&                 "parameter for resolver"
14787 .row &%dns_retry%&                   "parameter for resolver"
14788 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14789 .row &%dns_use_edns0%&               "parameter for resolver"
14790 .row &%hold_domains%&                "hold delivery for these domains"
14791 .row &%local_interfaces%&            "for routing checks"
14792 .row &%queue_domains%&               "no immediate delivery for these"
14793 .row &%queue_fast_ramp%&             "parallel delivery with 2-phase queue run"
14794 .row &%queue_only%&                  "no immediate delivery at all"
14795 .row &%queue_only_file%&             "no immediate delivery if file exists"
14796 .row &%queue_only_load%&             "no immediate delivery if load is high"
14797 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14798 .row &%queue_only_override%&         "allow command line to override"
14799 .row &%queue_run_in_order%&          "order of arrival"
14800 .row &%queue_run_max%&               "of simultaneous queue runners"
14801 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14802 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14803 .row &%remote_sort_domains%&         "order of remote deliveries"
14804 .row &%retry_data_expire%&           "timeout for retry data"
14805 .row &%retry_interval_max%&          "safety net for retry rules"
14806 .endtable
14807
14808
14809
14810 .section "Bounce and warning messages" "SECID117"
14811 .table2
14812 .row &%bounce_message_file%&         "content of bounce"
14813 .row &%bounce_message_text%&         "content of bounce"
14814 .row &%bounce_return_body%&          "include body if returning message"
14815 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14816 .row &%bounce_return_message%&       "include original message in bounce"
14817 .row &%bounce_return_size_limit%&    "limit on returned message"
14818 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14819 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14820 .row &%errors_copy%&                 "copy bounce messages"
14821 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14822 .row &%delay_warning%&               "time schedule"
14823 .row &%delay_warning_condition%&     "condition for warning messages"
14824 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14825 .row &%smtp_return_error_details%&   "give detail on rejections"
14826 .row &%warn_message_file%&           "content of warning message"
14827 .endtable
14828
14829
14830
14831 .section "Alphabetical list of main options" "SECTalomo"
14832 Those options that undergo string expansion before use are marked with
14833 &dagger;.
14834
14835 .option accept_8bitmime main boolean true
14836 .cindex "8BITMIME"
14837 .cindex "8-bit characters"
14838 .cindex "log" "selectors"
14839 .cindex "log" "8BITMIME"
14840 .cindex "ESMTP extensions" 8BITMIME
14841 This option causes Exim to send 8BITMIME in its response to an SMTP
14842 EHLO command, and to accept the BODY= parameter on MAIL commands.
14843 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14844 takes no steps to do anything special with messages received by this route.
14845
14846 Historically Exim kept this option off by default, but the maintainers
14847 feel that in today's Internet, this causes more problems than it solves.
14848 It now defaults to true.
14849 A more detailed analysis of the issues is provided by Dan Bernstein:
14850 .display
14851 &url(https://cr.yp.to/smtp/8bitmime.html)
14852 .endd
14853
14854 To log received 8BITMIME status use
14855 .code
14856 log_selector = +8bitmime
14857 .endd
14858
14859 .option acl_not_smtp main string&!! unset
14860 .cindex "&ACL;" "for non-SMTP messages"
14861 .cindex "non-SMTP messages" "ACLs for"
14862 This option defines the ACL that is run when a non-SMTP message has been
14863 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14864 further details.
14865
14866 .option acl_not_smtp_mime main string&!! unset
14867 This option defines the ACL that is run for individual MIME parts of non-SMTP
14868 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14869 SMTP messages.
14870
14871 .option acl_not_smtp_start main string&!! unset
14872 .cindex "&ACL;" "at start of non-SMTP message"
14873 .cindex "non-SMTP messages" "ACLs for"
14874 This option defines the ACL that is run before Exim starts reading a
14875 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14876
14877 .option acl_smtp_auth main string&!! unset
14878 .cindex "&ACL;" "setting up for SMTP commands"
14879 .cindex "AUTH" "ACL for"
14880 This option defines the ACL that is run when an SMTP AUTH command is
14881 received. See chapter &<<CHAPACL>>& for further details.
14882
14883 .option acl_smtp_connect main string&!! unset
14884 .cindex "&ACL;" "on SMTP connection"
14885 This option defines the ACL that is run when an SMTP connection is received.
14886 See chapter &<<CHAPACL>>& for further details.
14887
14888 .option acl_smtp_data main string&!! unset
14889 .cindex "DATA" "ACL for"
14890 This option defines the ACL that is run after an SMTP DATA command has been
14891 processed and the message itself has been received, but before the final
14892 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14893
14894 .option acl_smtp_data_prdr main string&!! accept
14895 .cindex "PRDR" "ACL for"
14896 .cindex "DATA" "PRDR ACL for"
14897 .cindex "&ACL;" "PRDR-related"
14898 .cindex "&ACL;" "per-user data processing"
14899 This option defines the ACL that,
14900 if the PRDR feature has been negotiated,
14901 is run for each recipient after an SMTP DATA command has been
14902 processed and the message itself has been received, but before the
14903 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14904
14905 .option acl_smtp_dkim main string&!! unset
14906 .cindex DKIM "ACL for"
14907 This option defines the ACL that is run for each DKIM signature
14908 (by default, or as specified in the dkim_verify_signers option)
14909 of a received message.
14910 See section &<<SECDKIMVFY>>& for further details.
14911
14912 .option acl_smtp_etrn main string&!! unset
14913 .cindex "ETRN" "ACL for"
14914 This option defines the ACL that is run when an SMTP ETRN command is
14915 received. See chapter &<<CHAPACL>>& for further details.
14916
14917 .option acl_smtp_expn main string&!! unset
14918 .cindex "EXPN" "ACL for"
14919 This option defines the ACL that is run when an SMTP EXPN command is
14920 received. See chapter &<<CHAPACL>>& for further details.
14921
14922 .option acl_smtp_helo main string&!! unset
14923 .cindex "EHLO" "ACL for"
14924 .cindex "HELO" "ACL for"
14925 This option defines the ACL that is run when an SMTP EHLO or HELO
14926 command is received. See chapter &<<CHAPACL>>& for further details.
14927
14928
14929 .option acl_smtp_mail main string&!! unset
14930 .cindex "MAIL" "ACL for"
14931 This option defines the ACL that is run when an SMTP MAIL command is
14932 received. See chapter &<<CHAPACL>>& for further details.
14933
14934 .option acl_smtp_mailauth main string&!! unset
14935 .cindex "AUTH" "on MAIL command"
14936 This option defines the ACL that is run when there is an AUTH parameter on
14937 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14938 &<<CHAPSMTPAUTH>>& for details of authentication.
14939
14940 .option acl_smtp_mime main string&!! unset
14941 .cindex "MIME content scanning" "ACL for"
14942 This option is available when Exim is built with the content-scanning
14943 extension. It defines the ACL that is run for each MIME part in a message. See
14944 section &<<SECTscanmimepart>>& for details.
14945
14946 .option acl_smtp_notquit main string&!! unset
14947 .cindex "not-QUIT, ACL for"
14948 This option defines the ACL that is run when an SMTP session
14949 ends without a QUIT command being received.
14950 See chapter &<<CHAPACL>>& for further details.
14951
14952 .option acl_smtp_predata main string&!! unset
14953 This option defines the ACL that is run when an SMTP DATA command is
14954 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14955 further details.
14956
14957 .option acl_smtp_quit main string&!! unset
14958 .cindex "QUIT, ACL for"
14959 This option defines the ACL that is run when an SMTP QUIT command is
14960 received. See chapter &<<CHAPACL>>& for further details.
14961
14962 .option acl_smtp_rcpt main string&!! unset
14963 .cindex "RCPT" "ACL for"
14964 This option defines the ACL that is run when an SMTP RCPT command is
14965 received. See chapter &<<CHAPACL>>& for further details.
14966
14967 .option acl_smtp_starttls main string&!! unset
14968 .cindex "STARTTLS, ACL for"
14969 This option defines the ACL that is run when an SMTP STARTTLS command is
14970 received. See chapter &<<CHAPACL>>& for further details.
14971
14972 .option acl_smtp_vrfy main string&!! unset
14973 .cindex "VRFY" "ACL for"
14974 This option defines the ACL that is run when an SMTP VRFY command is
14975 received. See chapter &<<CHAPACL>>& for further details.
14976
14977 .option add_environment main "string list" empty
14978 .cindex "environment" "set values"
14979 This option adds individual environment variables that the
14980 currently linked libraries and programs in child processes may use.
14981 Each list element should be of the form &"name=value"&.
14982
14983 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14984
14985 .option admin_groups main "string list&!!" unset
14986 .cindex "admin user"
14987 This option is expanded just once, at the start of Exim's processing. If the
14988 current group or any of the supplementary groups of an Exim caller is in this
14989 colon-separated list, the caller has admin privileges. If all your system
14990 programmers are in a specific group, for example, you can give them all Exim
14991 admin privileges by putting that group in &%admin_groups%&. However, this does
14992 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14993 To permit this, you have to add individuals to the Exim group.
14994
14995 .option allow_domain_literals main boolean false
14996 .cindex "domain literal"
14997 If this option is set, the RFC 2822 domain literal format is permitted in
14998 email addresses. The option is not set by default, because the domain literal
14999 format is not normally required these days, and few people know about it. It
15000 has, however, been exploited by mail abusers.
15001
15002 Unfortunately, it seems that some DNS black list maintainers are using this
15003 format to report black listing to postmasters. If you want to accept messages
15004 addressed to your hosts by IP address, you need to set
15005 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
15006 domains (defined in the named domain list &%local_domains%& in the default
15007 configuration). This &"magic string"& matches the domain literal form of all
15008 the local host's IP addresses.
15009
15010
15011 .option allow_mx_to_ip main boolean false
15012 .cindex "MX record" "pointing to IP address"
15013 It appears that more and more DNS zone administrators are breaking the rules
15014 and putting domain names that look like IP addresses on the right hand side of
15015 MX records. Exim follows the rules and rejects this, giving an error message
15016 that explains the misconfiguration. However, some other MTAs support this
15017 practice, so to avoid &"Why can't Exim do this?"& complaints,
15018 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
15019 recommended, except when you have no other choice.
15020
15021 .option allow_utf8_domains main boolean false
15022 .cindex "domain" "UTF-8 characters in"
15023 .cindex "UTF-8" "in domain name"
15024 Lots of discussion is going on about internationalized domain names. One
15025 camp is strongly in favour of just using UTF-8 characters, and it seems
15026 that at least two other MTAs permit this.
15027 This option allows Exim users to experiment if they wish.
15028
15029 If it is set true, Exim's domain parsing function allows valid
15030 UTF-8 multicharacters to appear in domain name components, in addition to
15031 letters, digits, and hyphens.
15032
15033 If Exim is built with internationalization support
15034 and the SMTPUTF8 ESMTP option is in use (see chapter &<<CHAPi18n>>&)
15035 this option can be left as default.
15036 Without that,
15037 if you want to look up such domain names in the DNS, you must also
15038 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
15039 suitable setting is:
15040 .code
15041 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
15042   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
15043 .endd
15044 Alternatively, you can just disable this feature by setting
15045 .code
15046 dns_check_names_pattern =
15047 .endd
15048 That is, set the option to an empty string so that no check is done.
15049
15050
15051 .option auth_advertise_hosts main "host list&!!" *
15052 .cindex "authentication" "advertising"
15053 .cindex "AUTH" "advertising"
15054 .cindex "ESMTP extensions" AUTH
15055 If any server authentication mechanisms are configured, Exim advertises them in
15056 response to an EHLO command only if the calling host matches this list.
15057 Otherwise, Exim does not advertise AUTH.
15058 Exim does not accept AUTH commands from clients to which it has not
15059 advertised the availability of AUTH. The advertising of individual
15060 authentication mechanisms can be controlled by the use of the
15061 &%server_advertise_condition%& generic authenticator option on the individual
15062 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
15063
15064 Certain mail clients (for example, Netscape) require the user to provide a name
15065 and password for authentication if AUTH is advertised, even though it may
15066 not be needed (the host may accept messages from hosts on its local LAN without
15067 authentication, for example). The &%auth_advertise_hosts%& option can be used
15068 to make these clients more friendly by excluding them from the set of hosts to
15069 which Exim advertises AUTH.
15070
15071 .cindex "AUTH" "advertising when encrypted"
15072 If you want to advertise the availability of AUTH only when the connection
15073 is encrypted using TLS, you can make use of the fact that the value of this
15074 option is expanded, with a setting like this:
15075 .code
15076 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
15077 .endd
15078 .vindex "&$tls_in_cipher$&"
15079 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
15080 the expansion is empty, thus matching no hosts. Otherwise, the result of the
15081 expansion is *, which matches all hosts.
15082
15083
15084 .option auto_thaw main time 0s
15085 .cindex "thawing messages"
15086 .cindex "unfreezing messages"
15087 If this option is set to a time greater than zero, a queue runner will try a
15088 new delivery attempt on any frozen message, other than a bounce message, if
15089 this much time has passed since it was frozen. This may result in the message
15090 being re-frozen if nothing has changed since the last attempt. It is a way of
15091 saying &"keep on trying, even though there are big problems"&.
15092
15093 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
15094 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
15095 thought to be very useful any more, and its use should probably be avoided.
15096
15097
15098 .option av_scanner main string "see below"
15099 This option is available if Exim is built with the content-scanning extension.
15100 It specifies which anti-virus scanner to use. The default value is:
15101 .code
15102 sophie:/var/run/sophie
15103 .endd
15104 If the value of &%av_scanner%& starts with a dollar character, it is expanded
15105 before use. See section &<<SECTscanvirus>>& for further details.
15106
15107
15108 .option bi_command main string unset
15109 .oindex "&%-bi%&"
15110 This option supplies the name of a command that is run when Exim is called with
15111 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
15112 just the command name, it is not a complete command line. If an argument is
15113 required, it must come from the &%-oA%& command line option.
15114
15115
15116 .option bounce_message_file main string&!! unset
15117 .cindex "bounce message" "customizing"
15118 .cindex "customizing" "bounce message"
15119 This option defines a template file containing paragraphs of text to be used
15120 for constructing bounce messages.  Details of the file's contents are given in
15121 chapter &<<CHAPemsgcust>>&.
15122 .cindex bounce_message_file "tainted data"
15123 The option is expanded to give the file path, which must be
15124 absolute and untainted.
15125 See also &%warn_message_file%&.
15126
15127
15128 .option bounce_message_text main string unset
15129 When this option is set, its contents are included in the default bounce
15130 message immediately after &"This message was created automatically by mail
15131 delivery software."& It is not used if &%bounce_message_file%& is set.
15132
15133 .option bounce_return_body main boolean true
15134 .cindex "bounce message" "including body"
15135 This option controls whether the body of an incoming message is included in a
15136 bounce message when &%bounce_return_message%& is true. The default setting
15137 causes the entire message, both header and body, to be returned (subject to the
15138 value of &%bounce_return_size_limit%&). If this option is false, only the
15139 message header is included. In the case of a non-SMTP message containing an
15140 error that is detected during reception, only those header lines preceding the
15141 point at which the error was detected are returned.
15142 .cindex "bounce message" "including original"
15143
15144 .option bounce_return_linesize_limit main integer 998
15145 .cindex "size" "of bounce lines, limit"
15146 .cindex "bounce message" "line length limit"
15147 .cindex "limit" "bounce message line length"
15148 This option sets a limit in bytes on the line length of messages
15149 that are returned to senders due to delivery problems,
15150 when &%bounce_return_message%& is true.
15151 The default value corresponds to RFC limits.
15152 If the message being returned has lines longer than this value it is
15153 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
15154
15155 The option also applies to bounces returned when an error is detected
15156 during reception of a message.
15157 In this case lines from the original are truncated.
15158
15159 The option does not apply to messages generated by an &(autoreply)& transport.
15160
15161
15162 .option bounce_return_message main boolean true
15163 If this option is set false, none of the original message is included in
15164 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
15165 &%bounce_return_body%&.
15166
15167
15168 .option bounce_return_size_limit main integer 100K
15169 .cindex "size" "of bounce, limit"
15170 .cindex "bounce message" "size limit"
15171 .cindex "limit" "bounce message size"
15172 This option sets a limit in bytes on the size of messages that are returned to
15173 senders as part of bounce messages when &%bounce_return_message%& is true. The
15174 limit should be less than the value of the global &%message_size_limit%& and of
15175 any &%message_size_limit%& settings on transports, to allow for the bounce text
15176 that Exim generates. If this option is set to zero there is no limit.
15177
15178 When the body of any message that is to be included in a bounce message is
15179 greater than the limit, it is truncated, and a comment pointing this out is
15180 added at the top. The actual cutoff may be greater than the value given, owing
15181 to the use of buffering for transferring the message in chunks (typically 8K in
15182 size). The idea is to save bandwidth on those undeliverable 15-megabyte
15183 messages.
15184
15185 .option bounce_sender_authentication main string unset
15186 .cindex "bounce message" "sender authentication"
15187 .cindex "authentication" "bounce message"
15188 .cindex "AUTH" "on bounce message"
15189 This option provides an authenticated sender address that is sent with any
15190 bounce messages generated by Exim that are sent over an authenticated SMTP
15191 connection. A typical setting might be:
15192 .code
15193 bounce_sender_authentication = mailer-daemon@my.domain.example
15194 .endd
15195 which would cause bounce messages to be sent using the SMTP command:
15196 .code
15197 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
15198 .endd
15199 The value of &%bounce_sender_authentication%& must always be a complete email
15200 address.
15201
15202 .option callout_domain_negative_expire main time 3h
15203 .cindex "caching" "callout timeouts"
15204 .cindex "callout" "caching timeouts"
15205 This option specifies the expiry time for negative callout cache data for a
15206 domain. See section &<<SECTcallver>>& for details of callout verification, and
15207 section &<<SECTcallvercache>>& for details of the caching.
15208
15209
15210 .option callout_domain_positive_expire main time 7d
15211 This option specifies the expiry time for positive callout cache data for a
15212 domain. See section &<<SECTcallver>>& for details of callout verification, and
15213 section &<<SECTcallvercache>>& for details of the caching.
15214
15215
15216 .option callout_negative_expire main time 2h
15217 This option specifies the expiry time for negative callout cache data for an
15218 address. See section &<<SECTcallver>>& for details of callout verification, and
15219 section &<<SECTcallvercache>>& for details of the caching.
15220
15221
15222 .option callout_positive_expire main time 24h
15223 This option specifies the expiry time for positive callout cache data for an
15224 address. See section &<<SECTcallver>>& for details of callout verification, and
15225 section &<<SECTcallvercache>>& for details of the caching.
15226
15227
15228 .option callout_random_local_part main string&!! "see below"
15229 This option defines the &"random"& local part that can be used as part of
15230 callout verification. The default value is
15231 .code
15232 $primary_hostname-$tod_epoch-testing
15233 .endd
15234 See section &<<CALLaddparcall>>& for details of how this value is used.
15235
15236
15237 .option check_log_inodes main integer 100
15238 See &%check_spool_space%& below.
15239
15240
15241 .option check_log_space main integer 10M
15242 See &%check_spool_space%& below.
15243
15244 .oindex "&%check_rfc2047_length%&"
15245 .cindex "RFC 2047" "disabling length check"
15246 .option check_rfc2047_length main boolean true
15247 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
15248 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
15249 word; strings to be encoded that exceed this length are supposed to use
15250 multiple encoded words. By default, Exim does not recognize encoded words that
15251 exceed the maximum length. However, it seems that some software, in violation
15252 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
15253 set false, Exim recognizes encoded words of any length.
15254
15255
15256 .option check_spool_inodes main integer 100
15257 See &%check_spool_space%& below.
15258
15259
15260 .option check_spool_space main integer 10M
15261 .cindex "checking disk space"
15262 .cindex "disk space, checking"
15263 .cindex "spool directory" "checking space"
15264 The four &%check_...%& options allow for checking of disk resources before a
15265 message is accepted.
15266
15267 .vindex "&$log_inodes$&"
15268 .vindex "&$log_space$&"
15269 .vindex "&$spool_inodes$&"
15270 .vindex "&$spool_space$&"
15271 When any of these options are nonzero, they apply to all incoming messages. If you
15272 want to apply different checks to different kinds of message, you can do so by
15273 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
15274 &$spool_space$& in an ACL with appropriate additional conditions.
15275
15276
15277 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
15278 either value is greater than zero, for example:
15279 .code
15280 check_spool_space = 100M
15281 check_spool_inodes = 100
15282 .endd
15283 The spool partition is the one that contains the directory defined by
15284 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
15285 transit.
15286
15287 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
15288 files are written if either is greater than zero. These should be set only if
15289 &%log_file_path%& and &%spool_directory%& refer to different partitions.
15290
15291 If there is less space or fewer inodes than requested, Exim refuses to accept
15292 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
15293 error response to the MAIL command. If ESMTP is in use and there was a
15294 SIZE parameter on the MAIL command, its value is added to the
15295 &%check_spool_space%& value, and the check is performed even if
15296 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
15297
15298 The values for &%check_spool_space%& and &%check_log_space%& are held as a
15299 number of kilobytes (though specified in bytes).
15300 If a non-multiple of 1024 is specified, it is rounded up.
15301
15302 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
15303 failure a message is written to stderr and Exim exits with a non-zero code, as
15304 it obviously cannot send an error message of any kind.
15305
15306 There is a slight performance penalty for these checks.
15307 Versions of Exim preceding 4.88 had these disabled by default;
15308 high-rate installations confident they will never run out of resources
15309 may wish to deliberately disable them.
15310
15311 .option chunking_advertise_hosts main "host list&!!" *
15312 .cindex CHUNKING advertisement
15313 .cindex "RFC 3030" "CHUNKING"
15314 .cindex "ESMTP extensions" CHUNKING
15315 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
15316 these hosts.
15317 Hosts may use the BDAT command as an alternate to DATA.
15318
15319 .option commandline_checks_require_admin main boolean &`false`&
15320 .cindex "restricting access to features"
15321 This option restricts various basic checking features to require an
15322 administrative user.
15323 This affects most of the &%-b*%& options, such as &%-be%&.
15324
15325 .option debug_store main boolean &`false`&
15326 .cindex debugging "memory corruption"
15327 .cindex memory debugging
15328 This option, when true, enables extra checking in Exim's internal memory
15329 management.  For use when a memory corruption issue is being investigated,
15330 it should normally be left as default.
15331
15332 .option daemon_smtp_ports main string &`smtp`&
15333 .cindex "port" "for daemon"
15334 .cindex "TCP/IP" "setting listening ports"
15335 This option specifies one or more default SMTP ports on which the Exim daemon
15336 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
15337 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
15338
15339 .option daemon_startup_retries main integer 9
15340 .cindex "daemon startup, retrying"
15341 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
15342 the daemon at startup when it cannot immediately bind a listening socket
15343 (typically because the socket is already in use): &%daemon_startup_retries%&
15344 defines the number of retries after the first failure, and
15345 &%daemon_startup_sleep%& defines the length of time to wait between retries.
15346
15347 .option daemon_startup_sleep main time 30s
15348 See &%daemon_startup_retries%&.
15349
15350 .option delay_warning main "time list" 24h
15351 .cindex "warning of delay"
15352 .cindex "delay warning, specifying"
15353 .cindex "queue" "delay warning"
15354 When a message is delayed, Exim sends a warning message to the sender at
15355 intervals specified by this option. The data is a colon-separated list of times
15356 after which to send warning messages. If the value of the option is an empty
15357 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
15358 message has been in the queue for longer than the last time, the last interval
15359 between the times is used to compute subsequent warning times. For example,
15360 with
15361 .code
15362 delay_warning = 4h:8h:24h
15363 .endd
15364 the first message is sent after 4 hours, the second after 8 hours, and
15365 the third one after 24 hours. After that, messages are sent every 16 hours,
15366 because that is the interval between the last two times on the list. If you set
15367 just one time, it specifies the repeat interval. For example, with:
15368 .code
15369 delay_warning = 6h
15370 .endd
15371 messages are repeated every six hours. To stop warnings after a given time, set
15372 a very large time at the end of the list. For example:
15373 .code
15374 delay_warning = 2h:12h:99d
15375 .endd
15376 Note that the option is only evaluated at the time a delivery attempt fails,
15377 which depends on retry and queue-runner configuration.
15378 Typically retries will be configured more frequently than warning messages.
15379
15380 .option delay_warning_condition main string&!! "see below"
15381 .vindex "&$domain$&"
15382 The string is expanded at the time a warning message might be sent. If all the
15383 deferred addresses have the same domain, it is set in &$domain$& during the
15384 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
15385 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
15386 &"false"& (the comparison being done caselessly) then the warning message is
15387 not sent. The default is:
15388 .code
15389 delay_warning_condition = ${if or {\
15390   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
15391   { match{$h_precedence:}{(?i)bulk|list|junk} }\
15392   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
15393   } {no}{yes}}
15394 .endd
15395 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
15396 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
15397 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
15398 &"auto-replied"& in an &'Auto-Submitted:'& header.
15399
15400 .option deliver_drop_privilege main boolean false
15401 .cindex "unprivileged delivery"
15402 .cindex "delivery" "unprivileged"
15403 If this option is set true, Exim drops its root privilege at the start of a
15404 delivery process, and runs as the Exim user throughout. This severely restricts
15405 the kinds of local delivery that are possible, but is viable in certain types
15406 of configuration. There is a discussion about the use of root privilege in
15407 chapter &<<CHAPsecurity>>&.
15408
15409 .option deliver_queue_load_max main fixed-point unset
15410 .cindex "load average"
15411 .cindex "queue runner" "abandoning"
15412 When this option is set, a queue run is abandoned if the system load average
15413 becomes greater than the value of the option. The option has no effect on
15414 ancient operating systems on which Exim cannot determine the load average.
15415 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15416
15417
15418 .option delivery_date_remove main boolean true
15419 .cindex "&'Delivery-date:'& header line"
15420 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15421 message when it is delivered, in exactly the same way as &'Return-path:'& is
15422 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15423 should not be present in incoming messages, and this option causes them to be
15424 removed at the time the message is received, to avoid any problems that might
15425 occur when a delivered message is subsequently sent on to some other recipient.
15426
15427 .option disable_fsync main boolean false
15428 .cindex "&[fsync()]&, disabling"
15429 This option is available only if Exim was built with the compile-time option
15430 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15431 a runtime configuration generates an &"unknown option"& error. You should not
15432 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15433 really, really, really understand what you are doing. &'No pre-compiled
15434 distributions of Exim should ever make this option available.'&
15435
15436 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15437 updated files' data to be written to disc before continuing. Unexpected events
15438 such as crashes and power outages may cause data to be lost or scrambled.
15439 Here be Dragons. &*Beware.*&
15440
15441
15442 .option disable_ipv6 main boolean false
15443 .cindex "IPv6" "disabling"
15444 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15445 activities take place. AAAA records are never looked up, and any IPv6 addresses
15446 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15447 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15448 to handle IPv6 literal addresses.
15449
15450
15451 .option dkim_verify_hashes main "string list" "sha256 : sha512"
15452 .cindex DKIM "selecting signature algorithms"
15453 This option gives a list of hash types which are acceptable in signatures,
15454 and an order of processing.
15455 Signatures with algorithms not in the list will be ignored.
15456
15457 Acceptable values include:
15458 .code
15459 sha1
15460 sha256
15461 sha512
15462 .endd
15463
15464 Note that the acceptance of sha1 violates RFC 8301.
15465
15466 .option dkim_verify_keytypes main "string list" "ed25519 : rsa"
15467 This option gives a list of key types which are acceptable in signatures,
15468 and an order of processing.
15469 Signatures with algorithms not in the list will be ignored.
15470
15471
15472 .option dkim_verify_min_keysizes main "string list" "rsa=1024 ed25519=250"
15473 This option gives a list of key sizes which are acceptable in signatures.
15474 The list is keyed by the algorithm type for the key; the values are in bits.
15475 Signatures with keys smaller than given by this option will fail verification.
15476
15477 The default enforces the RFC 8301 minimum key size for RSA signatures.
15478
15479 .option dkim_verify_minimal main boolean false
15480 If set to true, verification of signatures will terminate after the
15481 first success.
15482
15483 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15484 .cindex DKIM "controlling calls to the ACL"
15485 This option gives a list of DKIM domains for which the DKIM ACL is run.
15486 It is expanded after the message is received; by default it runs
15487 the ACL once for each signature in the message.
15488 See section &<<SECDKIMVFY>>&.
15489
15490
15491 .option dmarc_forensic_sender main string&!! unset
15492 .option dmarc_history_file main string unset
15493 .option dmarc_tld_file main string unset
15494 .cindex DMARC "main section options"
15495 These options control DMARC processing.
15496 See section &<<SECDMARC>>& for details.
15497
15498
15499 .option dns_again_means_nonexist main "domain list&!!" unset
15500 .cindex "DNS" "&""try again""& response; overriding"
15501 DNS lookups give a &"try again"& response for the DNS errors
15502 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15503 keep trying to deliver a message, or to give repeated temporary errors to
15504 incoming mail. Sometimes the effect is caused by a badly set up name server and
15505 may persist for a long time. If a domain which exhibits this problem matches
15506 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15507 This option should be used with care. You can make it apply to reverse lookups
15508 by a setting such as this:
15509 .code
15510 dns_again_means_nonexist = *.in-addr.arpa
15511 .endd
15512 This option applies to all DNS lookups that Exim does. It also applies when the
15513 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15514 since these are most likely to be caused by DNS lookup problems. The
15515 &(dnslookup)& router has some options of its own for controlling what happens
15516 when lookups for MX or SRV records give temporary errors. These more specific
15517 options are applied after this global option.
15518
15519 .option dns_check_names_pattern main string "see below"
15520 .cindex "DNS" "pre-check of name syntax"
15521 When this option is set to a non-empty string, it causes Exim to check domain
15522 names for characters that are not allowed in host names before handing them to
15523 the DNS resolver, because some resolvers give temporary errors for names that
15524 contain unusual characters. If a domain name contains any unwanted characters,
15525 a &"not found"& result is forced, and the resolver is not called. The check is
15526 done by matching the domain name against a regular expression, which is the
15527 value of this option. The default pattern is
15528 .code
15529 dns_check_names_pattern = \
15530   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15531 .endd
15532 which permits only letters, digits, slashes, and hyphens in components, but
15533 they must start and end with a letter or digit. Slashes are not, in fact,
15534 permitted in host names, but they are found in certain NS records (which can be
15535 accessed in Exim by using a &%dnsdb%& lookup). If you set
15536 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15537 empty string.
15538
15539 .option dns_csa_search_limit main integer 5
15540 This option controls the depth of parental searching for CSA SRV records in the
15541 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15542
15543 .option dns_csa_use_reverse main boolean true
15544 This option controls whether or not an IP address, given as a CSA domain, is
15545 reversed and looked up in the reverse DNS, as described in more detail in
15546 section &<<SECTverifyCSA>>&.
15547
15548 .option dns_cname_loops main integer 1
15549 .cindex DNS "CNAME following"
15550 This option controls the following of CNAME chains, needed if the resolver does
15551 not do it internally.
15552 As of 2018 most should, and the default can be left.
15553 If you have an ancient one, a value of 10 is likely needed.
15554
15555 The default value of one CNAME-follow is needed
15556 thanks to the observed return for an MX request,
15557 given no MX presence but a CNAME to an A, of the CNAME.
15558
15559
15560 .option dns_dnssec_ok main integer -1
15561 .cindex "DNS" "resolver options"
15562 .cindex "DNS" "DNSSEC"
15563 If this option is set to a non-negative number then Exim will initialise the
15564 DNS resolver library to either use or not use DNSSEC, overriding the system
15565 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15566
15567 If the resolver library does not support DNSSEC then this option has no effect.
15568
15569 On Linux with glibc 2.31 or newer this is insufficient, the resolver library
15570 will default to stripping out a successful validation status.
15571 This will break a previously working Exim installation.
15572 Provided that you do trust the resolver (ie, is on localhost) you can tell
15573 glibc to pass through any successful validation with a new option in
15574 &_/etc/resolv.conf_&:
15575 .code
15576 options trust-ad
15577 .endd
15578
15579
15580 .option dns_ipv4_lookup main "domain list&!!" unset
15581 .cindex "IPv6" "DNS lookup for AAAA records"
15582 .cindex "DNS" "IPv6 lookup for AAAA records"
15583 .cindex DNS "IPv6 disabling"
15584 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15585 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15586 (A records) when trying to find IP addresses for hosts, unless the host's
15587 domain matches this list.
15588
15589 This is a fudge to help with name servers that give big delays or otherwise do
15590 not work for the AAAA record type. In due course, when the world's name
15591 servers have all been upgraded, there should be no need for this option.
15592 Note that all lookups, including those done for verification, are affected;
15593 this will result in verify failure for IPv6 connections or ones using names
15594 only valid for IPv6 addresses.
15595
15596
15597 .option dns_retrans main time 0s
15598 .cindex "DNS" "resolver options"
15599 .cindex timeout "dns lookup"
15600 .cindex "DNS" timeout
15601 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15602 retransmission and retry parameters for DNS lookups. Values of zero (the
15603 defaults) leave the system default settings unchanged. The first value is the
15604 time between retries, and the second is the number of retries. It isn't
15605 totally clear exactly how these settings affect the total time a DNS lookup may
15606 take. I haven't found any documentation about timeouts on DNS lookups; these
15607 parameter values are available in the external resolver interface structure,
15608 but nowhere does it seem to describe how they are used or what you might want
15609 to set in them.
15610 See also the &%slow_lookup_log%& option.
15611
15612
15613 .option dns_retry main integer 0
15614 See &%dns_retrans%& above.
15615
15616
15617 .option dns_trust_aa main "domain list&!!" unset
15618 .cindex "DNS" "resolver options"
15619 .cindex "DNS" "DNSSEC"
15620 If this option is set then lookup results marked with the AA bit
15621 (Authoritative Answer) are trusted the same way as if they were
15622 DNSSEC-verified. The authority section's name of the answer must
15623 match with this expanded domain list.
15624
15625 Use this option only if you talk directly to a resolver that is
15626 authoritative for some zones and does not set the AD (Authentic Data)
15627 bit in the answer. Some DNS servers may have an configuration option to
15628 mark the answers from their own zones as verified (they set the AD bit).
15629 Others do not have this option. It is considered as poor practice using
15630 a resolver that is an authoritative server for some zones.
15631
15632 Use this option only if you really have to (e.g. if you want
15633 to use DANE for remote delivery to a server that is listed in the DNS
15634 zones that your resolver is authoritative for).
15635
15636 If the DNS answer packet has the AA bit set and contains resource record
15637 in the answer section, the name of the first NS record appearing in the
15638 authority section is compared against the list. If the answer packet is
15639 authoritative but the answer section is empty, the name of the first SOA
15640 record in the authoritative section is used instead.
15641
15642 .cindex "DNS" "resolver options"
15643 .option dns_use_edns0 main integer -1
15644 .cindex "DNS" "resolver options"
15645 .cindex "DNS" "EDNS0"
15646 .cindex "DNS" "OpenBSD
15647 If this option is set to a non-negative number then Exim will initialise the
15648 DNS resolver library to either use or not use EDNS0 extensions, overriding
15649 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15650 on.
15651
15652 If the resolver library does not support EDNS0 then this option has no effect.
15653
15654 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15655 means that DNSSEC will not work with Exim on that platform either, unless Exim
15656 is linked against an alternative DNS client library.
15657
15658
15659 .option drop_cr main boolean false
15660 This is an obsolete option that is now a no-op. It used to affect the way Exim
15661 handled CR and LF characters in incoming messages. What happens now is
15662 described in section &<<SECTlineendings>>&.
15663
15664 .option dsn_advertise_hosts main "host list&!!" unset
15665 .cindex "bounce messages" "success"
15666 .cindex "DSN" "success"
15667 .cindex "Delivery Status Notification" "success"
15668 .cindex "ESMTP extensions" DSN
15669 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15670 and accepted from, these hosts.
15671 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15672 and RET and ORCPT options on MAIL FROM commands.
15673 A NOTIFY=SUCCESS option requests success-DSN messages.
15674 A NOTIFY= option with no argument requests that no delay or failure DSNs
15675 are sent.
15676 &*Note*&: Supplying success-DSN messages has been criticised
15677 on privacy grounds; it can leak details of internal forwarding.
15678
15679 .option dsn_from main "string&!!" "see below"
15680 .cindex "&'From:'& header line" "in bounces"
15681 .cindex "bounce messages" "&'From:'& line, specifying"
15682 This option can be used to vary the contents of &'From:'& header lines in
15683 bounces and other automatically generated messages (&"Delivery Status
15684 Notifications"& &-- hence the name of the option). The default setting is:
15685 .code
15686 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15687 .endd
15688 The value is expanded every time it is needed. If the expansion fails, a
15689 panic is logged, and the default value is used.
15690
15691 .option envelope_to_remove main boolean true
15692 .cindex "&'Envelope-to:'& header line"
15693 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15694 message when it is delivered, in exactly the same way as &'Return-path:'& is
15695 handled. &'Envelope-to:'& records the original recipient address from the
15696 message's envelope that caused the delivery to happen. Such headers should not
15697 be present in incoming messages, and this option causes them to be removed at
15698 the time the message is received, to avoid any problems that might occur when a
15699 delivered message is subsequently sent on to some other recipient.
15700
15701
15702 .option errors_copy main "string list&!!" unset
15703 .cindex "bounce message" "copy to other address"
15704 .cindex "copy of bounce message"
15705 Setting this option causes Exim to send bcc copies of bounce messages that it
15706 generates to other addresses. &*Note*&: This does not apply to bounce messages
15707 coming from elsewhere. The value of the option is a colon-separated list of
15708 items. Each item consists of a pattern, terminated by white space, followed by
15709 a comma-separated list of email addresses. If a pattern contains spaces, it
15710 must be enclosed in double quotes.
15711
15712 Each pattern is processed in the same way as a single item in an address list
15713 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15714 the bounce message, the message is copied to the addresses on the list. The
15715 items are scanned in order, and once a matching one is found, no further items
15716 are examined. For example:
15717 .code
15718 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15719               rqps@mydomain   hostmaster@mydomain.example,\
15720                               postmaster@mydomain.example
15721 .endd
15722 .vindex "&$domain$&"
15723 .vindex "&$local_part$&"
15724 The address list is expanded before use. The expansion variables &$local_part$&
15725 and &$domain$& are set from the original recipient of the error message, and if
15726 there was any wildcard matching in the pattern, the expansion
15727 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15728 variables &$0$&, &$1$&, etc. are set in the normal way.
15729
15730
15731 .option errors_reply_to main string unset
15732 .cindex "bounce message" "&'Reply-to:'& in"
15733 By default, Exim's bounce and delivery warning messages contain the header line
15734 .display
15735 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15736 .endd
15737 .oindex &%quota_warn_message%&
15738 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15739 A warning message that is generated by the &%quota_warn_message%& option in an
15740 &(appendfile)& transport may contain its own &'From:'& header line that
15741 overrides the default.
15742
15743 Experience shows that people reply to bounce messages. If the
15744 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15745 and warning messages. For example:
15746 .code
15747 errors_reply_to = postmaster@my.domain.example
15748 .endd
15749 The value of the option is not expanded. It must specify a valid RFC 2822
15750 address. However, if a warning message that is generated by the
15751 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15752 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15753 not used.
15754
15755
15756 .option event_action main string&!! unset
15757 .cindex events
15758 This option declares a string to be expanded for Exim's events mechanism.
15759 For details see chapter &<<CHAPevents>>&.
15760
15761
15762 .option exim_group main string "compile-time configured"
15763 .cindex "gid (group id)" "Exim's own"
15764 .cindex "Exim group"
15765 This option changes the gid under which Exim runs when it gives up root
15766 privilege. The default value is compiled into the binary. The value of this
15767 option is used only when &%exim_user%& is also set. Unless it consists entirely
15768 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15769 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15770 security issues.
15771
15772
15773 .option exim_path main string "see below"
15774 .cindex "Exim binary, path name"
15775 This option specifies the path name of the Exim binary, which is used when Exim
15776 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15777 the directory configured at compile time by the BIN_DIRECTORY setting. It
15778 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15779 other place.
15780 &*Warning*&: Do not use a macro to define the value of this option, because
15781 you will break those Exim utilities that scan the configuration file to find
15782 where the binary is. (They then use the &%-bP%& option to extract option
15783 settings such as the value of &%spool_directory%&.)
15784
15785
15786 .option exim_user main string "compile-time configured"
15787 .cindex "uid (user id)" "Exim's own"
15788 .cindex "Exim user"
15789 This option changes the uid under which Exim runs when it gives up root
15790 privilege. The default value is compiled into the binary. Ownership of the run
15791 time configuration file and the use of the &%-C%& and &%-D%& command line
15792 options is checked against the values in the binary, not what is set here.
15793
15794 Unless it consists entirely of digits, the string is looked up using
15795 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15796 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15797 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15798
15799
15800 .option exim_version main string "current version"
15801 .cindex "Exim version"
15802 .cindex customizing "version number"
15803 .cindex "version number of Exim" override
15804 This option overrides the &$version_number$&/&$exim_version$& that Exim reports in
15805 various places.  Use with care; this may fool stupid security scanners.
15806
15807
15808 .option extra_local_interfaces main "string list" unset
15809 This option defines network interfaces that are to be considered local when
15810 routing, but which are not used for listening by the daemon. See section
15811 &<<SECTreclocipadd>>& for details.
15812
15813
15814 . Allow this long option name to split; give it unsplit as a fifth argument
15815 . for the automatic .oindex that is generated by .option.
15816
15817 .option "extract_addresses_remove_arguments" main boolean true &&&
15818          extract_addresses_remove_arguments
15819 .oindex "&%-t%&"
15820 .cindex "command line" "addresses with &%-t%&"
15821 .cindex "Sendmail compatibility" "&%-t%& option"
15822 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15823 are present on the command line when the &%-t%& option is used to build an
15824 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15825 line addresses are removed from the recipients list. This is also how Smail
15826 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15827 command line addresses are added to those obtained from the header lines. When
15828 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15829 argument headers. If it is set false, Exim adds rather than removes argument
15830 addresses.
15831
15832
15833 .option finduser_retries main integer 0
15834 .cindex "NIS, retrying user lookups"
15835 On systems running NIS or other schemes in which user and group information is
15836 distributed from a remote system, there can be times when &[getpwnam()]& and
15837 related functions fail, even when given valid data, because things time out.
15838 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15839 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15840 many extra times to find a user or a group, waiting for one second between
15841 retries.
15842
15843 .cindex "&_/etc/passwd_&" "multiple reading of"
15844 You should not set this option greater than zero if your user information is in
15845 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15846 search the file multiple times for non-existent users, and also cause delay.
15847
15848
15849
15850 .option freeze_tell main "string list, comma separated" unset
15851 .cindex "freezing messages" "sending a message when freezing"
15852 On encountering certain errors, or when configured to do so in a system filter,
15853 ACL, or special router, Exim freezes a message. This means that no further
15854 delivery attempts take place until an administrator thaws the message, or the
15855 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15856 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15857 warning message whenever it freezes something, unless the message it is
15858 freezing is a locally-generated bounce message. (Without this exception there
15859 is the possibility of looping.) The warning message is sent to the addresses
15860 supplied as the comma-separated value of this option. If several of the
15861 message's addresses cause freezing, only a single message is sent. If the
15862 freezing was automatic, the reason(s) for freezing can be found in the message
15863 log. If you configure freezing in a filter or ACL, you must arrange for any
15864 logging that you require.
15865
15866
15867 .option gecos_name main string&!! unset
15868 .cindex "HP-UX"
15869 .cindex "&""gecos""& field, parsing"
15870 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15871 password file to hold other information in addition to users' real names. Exim
15872 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15873 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15874 of the field are used unchanged, except that, if an ampersand is encountered,
15875 it is replaced by the user's login name with the first character forced to
15876 upper case, since this is a convention that is observed on many systems.
15877
15878 When these options are set, &%gecos_pattern%& is treated as a regular
15879 expression that is to be applied to the field (again with && replaced by the
15880 login name), and if it matches, &%gecos_name%& is expanded and used as the
15881 user's name.
15882
15883 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15884 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15885 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15886 name terminates at the first comma, the following can be used:
15887 .code
15888 gecos_pattern = ([^,]*)
15889 gecos_name = $1
15890 .endd
15891
15892 .option gecos_pattern main string unset
15893 See &%gecos_name%& above.
15894
15895
15896 .option gnutls_compat_mode main boolean unset
15897 This option controls whether GnuTLS is used in compatibility mode in an Exim
15898 server. This reduces security slightly, but improves interworking with older
15899 implementations of TLS.
15900
15901
15902 .option gnutls_allow_auto_pkcs11 main boolean unset
15903 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15904 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15905
15906 See
15907 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15908 for documentation.
15909
15910
15911
15912 .option headers_charset main string "see below"
15913 This option sets a default character set for translating from encoded MIME
15914 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15915 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15916 ultimate default is ISO-8859-1. For more details see the description of header
15917 insertions in section &<<SECTexpansionitems>>&.
15918
15919
15920
15921 .option header_maxsize main integer "see below"
15922 .cindex "header section" "maximum size of"
15923 .cindex "limit" "size of message header section"
15924 This option controls the overall maximum size of a message's header
15925 section. The default is the value of HEADER_MAXSIZE in
15926 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15927 sections are rejected.
15928
15929
15930 .option header_line_maxsize main integer 0
15931 .cindex "header lines" "maximum size of"
15932 .cindex "limit" "size of one header line"
15933 This option limits the length of any individual header line in a message, after
15934 all the continuations have been joined together. Messages with individual
15935 header lines that are longer than the limit are rejected. The default value of
15936 zero means &"no limit"&.
15937
15938
15939
15940
15941 .option helo_accept_junk_hosts main "host list&!!" unset
15942 .cindex "HELO" "accepting junk data"
15943 .cindex "EHLO" "accepting junk data"
15944 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15945 mail, and gives an error response for invalid data. Unfortunately, there are
15946 some SMTP clients that send syntactic junk. They can be accommodated by setting
15947 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15948 if you want to do semantic checking.
15949 See also &%helo_allow_chars%& for a way of extending the permitted character
15950 set.
15951
15952
15953 .option helo_allow_chars main string unset
15954 .cindex "HELO" "underscores in"
15955 .cindex "EHLO" "underscores in"
15956 .cindex "underscore in EHLO/HELO"
15957 This option can be set to a string of rogue characters that are permitted in
15958 all EHLO and HELO names in addition to the standard letters, digits,
15959 hyphens, and dots. If you really must allow underscores, you can set
15960 .code
15961 helo_allow_chars = _
15962 .endd
15963 Note that the value is one string, not a list.
15964
15965
15966 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15967 .cindex "HELO" "forcing reverse lookup"
15968 .cindex "EHLO" "forcing reverse lookup"
15969 If the domain given by a client in a HELO or EHLO command matches this
15970 list, a reverse lookup is done in order to establish the host's true name. The
15971 default forces a lookup if the client host gives the server's name or any of
15972 its IP addresses (in brackets), something that broken clients have been seen to
15973 do.
15974
15975
15976 .option helo_try_verify_hosts main "host list&!!" unset
15977 .cindex "HELO verifying" "optional"
15978 .cindex "EHLO" "verifying, optional"
15979 By default, Exim just checks the syntax of HELO and EHLO commands (see
15980 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15981 to do more extensive checking of the data supplied by these commands. The ACL
15982 condition &`verify = helo`& is provided to make this possible.
15983 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15984 to force the check to occur. From release 4.53 onwards, this is no longer
15985 necessary. If the check has not been done before &`verify = helo`& is
15986 encountered, it is done at that time. Consequently, this option is obsolete.
15987 Its specification is retained here for backwards compatibility.
15988
15989 When an EHLO or HELO command is received, if the calling host matches
15990 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15991 EHLO command either:
15992
15993 .ilist
15994 is an IP literal matching the calling address of the host, or
15995 .next
15996 .cindex "DNS" "reverse lookup"
15997 .cindex "reverse DNS lookup"
15998 matches the host name that Exim obtains by doing a reverse lookup of the
15999 calling host address, or
16000 .next
16001 when looked up in DNS yields the calling host address.
16002 .endlist
16003
16004 However, the EHLO or HELO command is not rejected if any of the checks
16005 fail. Processing continues, but the result of the check is remembered, and can
16006 be detected later in an ACL by the &`verify = helo`& condition.
16007
16008 If DNS was used for successful verification, the variable
16009 .cindex "DNS" "DNSSEC"
16010 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
16011
16012 .option helo_verify_hosts main "host list&!!" unset
16013 .cindex "HELO verifying" "mandatory"
16014 .cindex "EHLO" "verifying, mandatory"
16015 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
16016 backwards compatibility. For hosts that match this option, Exim checks the host
16017 name given in the HELO or EHLO in the same way as for
16018 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
16019 rejected with a 550 error, and entries are written to the main and reject logs.
16020 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
16021 error.
16022
16023 .option hold_domains main "domain list&!!" unset
16024 .cindex "domain" "delaying delivery"
16025 .cindex "delivery" "delaying certain domains"
16026 This option allows mail for particular domains to be held in the queue
16027 manually. The option is overridden if a message delivery is forced with the
16028 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
16029 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
16030 item in &%hold_domains%&, no routing or delivery for that address is done, and
16031 it is deferred every time the message is looked at.
16032
16033 This option is intended as a temporary operational measure for delaying the
16034 delivery of mail while some problem is being sorted out, or some new
16035 configuration tested. If you just want to delay the processing of some
16036 domains until a queue run occurs, you should use &%queue_domains%& or
16037 &%queue_smtp_domains%&, not &%hold_domains%&.
16038
16039 A setting of &%hold_domains%& does not override Exim's code for removing
16040 messages from the queue if they have been there longer than the longest retry
16041 time in any retry rule. If you want to hold messages for longer than the normal
16042 retry times, insert a dummy retry rule with a long retry time.
16043
16044
16045 .option host_lookup main "host list&!!" unset
16046 .cindex "host name" "lookup, forcing"
16047 Exim does not look up the name of a calling host from its IP address unless it
16048 is required to compare against some host list, or the host matches
16049 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
16050 option (which normally contains IP addresses rather than host names). The
16051 default configuration file contains
16052 .code
16053 host_lookup = *
16054 .endd
16055 which causes a lookup to happen for all hosts. If the expense of these lookups
16056 is felt to be too great, the setting can be changed or removed.
16057
16058 After a successful reverse lookup, Exim does a forward lookup on the name it
16059 has obtained, to verify that it yields the IP address that it started with. If
16060 this check fails, Exim behaves as if the name lookup failed.
16061
16062 .vindex "&$host_lookup_failed$&"
16063 .vindex "&$sender_host_name$&"
16064 After any kind of failure, the host name (in &$sender_host_name$&) remains
16065 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
16066 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
16067 &`verify = reverse_host_lookup`& in ACLs.
16068
16069
16070 .option host_lookup_order main "string list" &`bydns:byaddr`&
16071 This option specifies the order of different lookup methods when Exim is trying
16072 to find a host name from an IP address. The default is to do a DNS lookup
16073 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
16074 if that fails. You can change the order of these lookups, or omit one entirely,
16075 if you want.
16076
16077 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
16078 multiple PTR records in the DNS and the IP address is not listed in
16079 &_/etc/hosts_&. Different operating systems give different results in this
16080 case. That is why the default tries a DNS lookup first.
16081
16082
16083
16084 .option host_reject_connection main "host list&!!" unset
16085 .cindex "host" "rejecting connections from"
16086 If this option is set, incoming SMTP calls from the hosts listed are rejected
16087 as soon as the connection is made.
16088 This option is obsolete, and retained only for backward compatibility, because
16089 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
16090 connections immediately.
16091
16092 The ability to give an immediate rejection (either by this option or using an
16093 ACL) is provided for use in unusual cases. Many hosts will just try again,
16094 sometimes without much delay. Normally, it is better to use an ACL to reject
16095 incoming messages at a later stage, such as after RCPT commands. See
16096 chapter &<<CHAPACL>>&.
16097
16098
16099 .option hosts_connection_nolog main "host list&!!" unset
16100 .cindex "host" "not logging connections from"
16101 This option defines a list of hosts for which connection logging does not
16102 happen, even though the &%smtp_connection%& log selector is set. For example,
16103 you might want not to log SMTP connections from local processes, or from
16104 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
16105 the daemon; you should therefore strive to restrict its value to a short inline
16106 list of IP addresses and networks. To disable logging SMTP connections from
16107 local processes, you must create a host list with an empty item. For example:
16108 .code
16109 hosts_connection_nolog = :
16110 .endd
16111 If the &%smtp_connection%& log selector is not set, this option has no effect.
16112
16113
16114
16115 .option hosts_proxy main "host list&!!" unset
16116 .cindex proxy "proxy protocol"
16117 This option enables use of Proxy Protocol proxies for incoming
16118 connections.  For details see section &<<SECTproxyInbound>>&.
16119
16120
16121 .option hosts_treat_as_local main "domain list&!!" unset
16122 .cindex "local host" "domains treated as"
16123 .cindex "host" "treated as local"
16124 If this option is set, any host names that match the domain list are treated as
16125 if they were the local host when Exim is scanning host lists obtained from MX
16126 records
16127 or other sources. Note that the value of this option is a domain list, not a
16128 host list, because it is always used to check host names, not IP addresses.
16129
16130 This option also applies when Exim is matching the special items
16131 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
16132 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
16133 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
16134 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
16135 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
16136 interfaces and recognizing the local host.
16137
16138
16139 .option ibase_servers main "string list" unset
16140 .cindex "InterBase" "server list"
16141 This option provides a list of InterBase servers and associated connection data,
16142 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
16143 The option is available only if Exim has been built with InterBase support.
16144
16145
16146
16147 .option ignore_bounce_errors_after main time 10w
16148 .cindex "bounce message" "discarding"
16149 .cindex "discarding bounce message"
16150 This option affects the processing of bounce messages that cannot be delivered,
16151 that is, those that suffer a permanent delivery failure. (Bounce messages that
16152 suffer temporary delivery failures are of course retried in the usual way.)
16153
16154 After a permanent delivery failure, bounce messages are frozen,
16155 because there is no sender to whom they can be returned. When a frozen bounce
16156 message has been in the queue for more than the given time, it is unfrozen at
16157 the next queue run, and a further delivery is attempted. If delivery fails
16158 again, the bounce message is discarded. This makes it possible to keep failed
16159 bounce messages around for a shorter time than the normal maximum retry time
16160 for frozen messages. For example,
16161 .code
16162 ignore_bounce_errors_after = 12h
16163 .endd
16164 retries failed bounce message deliveries after 12 hours, discarding any further
16165 failures. If the value of this option is set to a zero time period, bounce
16166 failures are discarded immediately. Setting a very long time (as in the default
16167 value) has the effect of disabling this option. For ways of automatically
16168 dealing with other kinds of frozen message, see &%auto_thaw%& and
16169 &%timeout_frozen_after%&.
16170
16171
16172 .option ignore_fromline_hosts main "host list&!!" unset
16173 .cindex "&""From""& line"
16174 .cindex "UUCP" "&""From""& line"
16175 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
16176 the headers of a message. By default this is treated as the start of the
16177 message's body, which means that any following headers are not recognized as
16178 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
16179 match those hosts that insist on sending it. If the sender is actually a local
16180 process rather than a remote host, and is using &%-bs%& to inject the messages,
16181 &%ignore_fromline_local%& must be set to achieve this effect.
16182
16183
16184 .option ignore_fromline_local main boolean false
16185 See &%ignore_fromline_hosts%& above.
16186
16187 .option keep_environment main "string list" unset
16188 .cindex "environment" "values from"
16189 This option contains a string list of environment variables to keep.
16190 You have to trust these variables or you have to be sure that
16191 these variables do not impose any security risk. Keep in mind that
16192 during the startup phase Exim is running with an effective UID 0 in most
16193 installations. As the default value is an empty list, the default
16194 environment for using libraries, running embedded Perl code, or running
16195 external binaries is empty, and does not not even contain PATH or HOME.
16196
16197 Actually the list is interpreted as a list of patterns
16198 (&<<SECTlistexpand>>&), except that it is not expanded first.
16199
16200 WARNING: Macro substitution is still done first, so having a macro
16201 FOO and having FOO_HOME in your &%keep_environment%& option may have
16202 unexpected results. You may work around this using a regular expression
16203 that does not match the macro name: ^[F]OO_HOME$.
16204
16205 Current versions of Exim issue a warning during startup if you do not mention
16206 &%keep_environment%& in your runtime configuration file and if your
16207 current environment is not empty. Future versions may not issue that warning
16208 anymore.
16209
16210 See the &%add_environment%& main config option for a way to set
16211 environment variables to a fixed value.  The environment for &(pipe)&
16212 transports is handled separately, see section &<<SECTpipeenv>>& for
16213 details.
16214
16215
16216 .option keep_malformed main time 4d
16217 This option specifies the length of time to keep messages whose spool files
16218 have been corrupted in some way. This should, of course, never happen. At the
16219 next attempt to deliver such a message, it gets removed. The incident is
16220 logged.
16221
16222
16223 .option ldap_ca_cert_dir main string unset
16224 .cindex "LDAP", "TLS CA certificate directory"
16225 .cindex certificate "directory for LDAP"
16226 This option indicates which directory contains CA certificates for verifying
16227 a TLS certificate presented by an LDAP server.
16228 While Exim does not provide a default value, your SSL library may.
16229 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16230 and constrained to be a directory.
16231
16232
16233 .option ldap_ca_cert_file main string unset
16234 .cindex "LDAP", "TLS CA certificate file"
16235 .cindex certificate "file for LDAP"
16236 This option indicates which file contains CA certificates for verifying
16237 a TLS certificate presented by an LDAP server.
16238 While Exim does not provide a default value, your SSL library may.
16239 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
16240 and constrained to be a file.
16241
16242
16243 .option ldap_cert_file main string unset
16244 .cindex "LDAP" "TLS client certificate file"
16245 .cindex certificate "file for LDAP"
16246 This option indicates which file contains an TLS client certificate which
16247 Exim should present to the LDAP server during TLS negotiation.
16248 Should be used together with &%ldap_cert_key%&.
16249
16250
16251 .option ldap_cert_key main string unset
16252 .cindex "LDAP" "TLS client key file"
16253 .cindex certificate "key for LDAP"
16254 This option indicates which file contains the secret/private key to use
16255 to prove identity to the LDAP server during TLS negotiation.
16256 Should be used together with &%ldap_cert_file%&, which contains the
16257 identity to be proven.
16258
16259
16260 .option ldap_cipher_suite main string unset
16261 .cindex "LDAP" "TLS cipher suite"
16262 This controls the TLS cipher-suite negotiation during TLS negotiation with
16263 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
16264 cipher-suite options with OpenSSL (as used by LDAP client libraries).
16265
16266
16267 .option ldap_default_servers main "string list" unset
16268 .cindex "LDAP" "default servers"
16269 This option provides a list of LDAP servers which are tried in turn when an
16270 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
16271 details of LDAP queries. This option is available only when Exim has been built
16272 with LDAP support.
16273
16274
16275 .option ldap_require_cert main string unset.
16276 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
16277 This should be one of the values "hard", "demand", "allow", "try" or "never".
16278 A value other than one of these is interpreted as "never".
16279 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
16280 Although Exim does not set a default, the LDAP library probably defaults
16281 to hard/demand.
16282
16283
16284 .option ldap_start_tls main boolean false
16285 .cindex "LDAP" "whether or not to negotiate TLS"
16286 If set, Exim will attempt to negotiate TLS with the LDAP server when
16287 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
16288 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
16289 of SSL-on-connect.
16290 In the event of failure to negotiate TLS, the action taken is controlled
16291 by &%ldap_require_cert%&.
16292 This option is ignored for &`ldapi`& connections.
16293
16294
16295 .option ldap_version main integer unset
16296 .cindex "LDAP" "protocol version, forcing"
16297 This option can be used to force Exim to set a specific protocol version for
16298 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
16299 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
16300 the LDAP headers; otherwise it is 2. This option is available only when Exim
16301 has been built with LDAP support.
16302
16303
16304
16305 .option local_from_check main boolean true
16306 .cindex "&'Sender:'& header line" "disabling addition of"
16307 .cindex "&'From:'& header line" "disabling checking of"
16308 When a message is submitted locally (that is, not over a TCP/IP connection) by
16309 an untrusted user, Exim removes any existing &'Sender:'& header line, and
16310 checks that the &'From:'& header line matches the login of the calling user and
16311 the domain specified by &%qualify_domain%&.
16312
16313 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
16314 locally submitted message is automatically qualified by Exim, unless the
16315 &%-bnq%& command line option is used.
16316
16317 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
16318 on the local part. If the &'From:'& header line does not match, Exim adds a
16319 &'Sender:'& header with an address constructed from the calling user's login
16320 and the default qualify domain.
16321
16322 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
16323 and no &'Sender:'& header is ever added. If, in addition, you want to retain
16324 &'Sender:'& header lines supplied by untrusted users, you must also set
16325 &%local_sender_retain%& to be true.
16326
16327 .cindex "envelope from"
16328 .cindex "envelope sender"
16329 These options affect only the header lines in the message. The envelope sender
16330 is still forced to be the login id at the qualify domain unless
16331 &%untrusted_set_sender%& permits the user to supply an envelope sender.
16332
16333 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
16334 request similar header line checking. See section &<<SECTthesenhea>>&, which
16335 has more details about &'Sender:'& processing.
16336
16337
16338
16339
16340 .option local_from_prefix main string unset
16341 When Exim checks the &'From:'& header line of locally submitted messages for
16342 matching the login id (see &%local_from_check%& above), it can be configured to
16343 ignore certain prefixes and suffixes in the local part of the address. This is
16344 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
16345 appropriate lists, in the same form as the &%local_part_prefix%& and
16346 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
16347 example, if
16348 .code
16349 local_from_prefix = *-
16350 .endd
16351 is set, a &'From:'& line containing
16352 .code
16353 From: anything-user@your.domain.example
16354 .endd
16355 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
16356 matches the actual sender address that is constructed from the login name and
16357 qualify domain.
16358
16359
16360 .option local_from_suffix main string unset
16361 See &%local_from_prefix%& above.
16362
16363
16364 .option local_interfaces main "string list" "see below"
16365 This option controls which network interfaces are used by the daemon for
16366 listening; they are also used to identify the local host when routing. Chapter
16367 &<<CHAPinterfaces>>& contains a full description of this option and the related
16368 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
16369 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
16370 &%local_interfaces%& is
16371 .code
16372 local_interfaces = 0.0.0.0
16373 .endd
16374 when Exim is built without IPv6 support; otherwise it is
16375 .code
16376 local_interfaces = <; ::0 ; 0.0.0.0
16377 .endd
16378
16379 .option local_scan_timeout main time 5m
16380 .cindex "timeout" "for &[local_scan()]& function"
16381 .cindex "&[local_scan()]& function" "timeout"
16382 This timeout applies to the &[local_scan()]& function (see chapter
16383 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
16384 the incoming message is rejected with a temporary error if it is an SMTP
16385 message. For a non-SMTP message, the message is dropped and Exim ends with a
16386 non-zero code. The incident is logged on the main and reject logs.
16387
16388
16389
16390 .option local_sender_retain main boolean false
16391 .cindex "&'Sender:'& header line" "retaining from local submission"
16392 When a message is submitted locally (that is, not over a TCP/IP connection) by
16393 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
16394 do not want this to happen, you must set &%local_sender_retain%&, and you must
16395 also set &%local_from_check%& to be false (Exim will complain if you do not).
16396 See also the ACL modifier &`control = suppress_local_fixups`&. Section
16397 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
16398
16399
16400
16401
16402 .option localhost_number main string&!! unset
16403 .cindex "host" "locally unique number for"
16404 .cindex "message ids" "with multiple hosts"
16405 .vindex "&$localhost_number$&"
16406 Exim's message ids are normally unique only within the local host. If
16407 uniqueness among a set of hosts is required, each host must set a different
16408 value for the &%localhost_number%& option. The string is expanded immediately
16409 after reading the configuration file (so that a number can be computed from the
16410 host name, for example) and the result of the expansion must be a number in the
16411 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
16412 systems). This is available in subsequent string expansions via the variable
16413 &$localhost_number$&. When &%localhost_number is set%&, the final two
16414 characters of the message id, instead of just being a fractional part of the
16415 time, are computed from the time and the local host number as described in
16416 section &<<SECTmessiden>>&.
16417
16418
16419
16420 .option log_file_path main "string list&!!" "set at compile time"
16421 .cindex "log" "file path for"
16422 This option sets the path which is used to determine the names of Exim's log
16423 files, or indicates that logging is to be to syslog, or both. It is expanded
16424 when Exim is entered, so it can, for example, contain a reference to the host
16425 name. If no specific path is set for the log files at compile or runtime,
16426 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
16427 they are written in a sub-directory called &_log_& in Exim's spool directory.
16428 A path must start with a slash.
16429 To send to syslog, use the word &"syslog"&.
16430 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
16431 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
16432 used. If this string is fixed at your installation (contains no expansion
16433 variables) it is recommended that you do not set this option in the
16434 configuration file, but instead supply the path using LOG_FILE_PATH in
16435 &_Local/Makefile_& so that it is available to Exim for logging errors detected
16436 early on &-- in particular, failure to read the configuration file.
16437
16438
16439 .option log_selector main string unset
16440 .cindex "log" "selectors"
16441 This option can be used to reduce or increase the number of things that Exim
16442 writes to its log files. Its argument is made up of names preceded by plus or
16443 minus characters. For example:
16444 .code
16445 log_selector = +arguments -retry_defer
16446 .endd
16447 A list of possible names and what they control is given in the chapter on
16448 logging, in section &<<SECTlogselector>>&.
16449
16450
16451 .option log_timezone main boolean false
16452 .cindex "log" "timezone for entries"
16453 .vindex "&$tod_log$&"
16454 .vindex "&$tod_zone$&"
16455 By default, the timestamps on log lines are in local time without the
16456 timezone. This means that if your timezone changes twice a year, the timestamps
16457 in log lines are ambiguous for an hour when the clocks go back. One way of
16458 avoiding this problem is to set the timezone to UTC. An alternative is to set
16459 &%log_timezone%& true. This turns on the addition of the timezone offset to
16460 timestamps in log lines. Turning on this option can add quite a lot to the size
16461 of log files because each line is extended by 6 characters. Note that the
16462 &$tod_log$& variable contains the log timestamp without the zone, but there is
16463 another variable called &$tod_zone$& that contains just the timezone offset.
16464
16465
16466 .option lookup_open_max main integer 25
16467 .cindex "too many open files"
16468 .cindex "open files, too many"
16469 .cindex "file" "too many open"
16470 .cindex "lookup" "maximum open files"
16471 .cindex "limit" "open files for lookups"
16472 This option limits the number of simultaneously open files for single-key
16473 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16474 Exim normally keeps these files open during routing, because often the same
16475 file is required several times. If the limit is reached, Exim closes the least
16476 recently used file. Note that if you are using the &'ndbm'& library, it
16477 actually opens two files for each logical DBM database, though it still counts
16478 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16479 open files"& errors with NDBM, you need to reduce the value of
16480 &%lookup_open_max%&.
16481
16482
16483 .option max_username_length main integer 0
16484 .cindex "length of login name"
16485 .cindex "user name" "maximum length"
16486 .cindex "limit" "user name length"
16487 Some operating systems are broken in that they truncate long arguments to
16488 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16489 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16490 an argument that is longer behaves as if &[getpwnam()]& failed.
16491
16492
16493 .option message_body_newlines main bool false
16494 .cindex "message body" "newlines in variables"
16495 .cindex "newline" "in message body variables"
16496 .vindex "&$message_body$&"
16497 .vindex "&$message_body_end$&"
16498 By default, newlines in the message body are replaced by spaces when setting
16499 the &$message_body$& and &$message_body_end$& expansion variables. If this
16500 option is set true, this no longer happens.
16501
16502
16503 .option message_body_visible main integer 500
16504 .cindex "body of message" "visible size"
16505 .cindex "message body" "visible size"
16506 .vindex "&$message_body$&"
16507 .vindex "&$message_body_end$&"
16508 This option specifies how much of a message's body is to be included in the
16509 &$message_body$& and &$message_body_end$& expansion variables.
16510
16511
16512 .option message_id_header_domain main string&!! unset
16513 .cindex "&'Message-ID:'& header line"
16514 If this option is set, the string is expanded and used as the right hand side
16515 (domain) of the &'Message-ID:'& header that Exim creates if a
16516 locally-originated incoming message does not have one. &"Locally-originated"&
16517 means &"not received over TCP/IP."&
16518 Otherwise, the primary host name is used.
16519 Only letters, digits, dot and hyphen are accepted; any other characters are
16520 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16521 empty string, the option is ignored.
16522
16523
16524 .option message_id_header_text main string&!! unset
16525 If this variable is set, the string is expanded and used to augment the text of
16526 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16527 message does not have one. The text of this header is required by RFC 2822 to
16528 take the form of an address. By default, Exim uses its internal message id as
16529 the local part, and the primary host name as the domain. If this option is set,
16530 it is expanded, and provided the expansion is not forced to fail, and does not
16531 yield an empty string, the result is inserted into the header immediately
16532 before the @, separated from the internal message id by a dot. Any characters
16533 that are illegal in an address are automatically converted into hyphens. This
16534 means that variables such as &$tod_log$& can be used, because the spaces and
16535 colons will become hyphens.
16536
16537
16538 .option message_logs main boolean true
16539 .cindex "message logs" "disabling"
16540 .cindex "log" "message log; disabling"
16541 If this option is turned off, per-message log files are not created in the
16542 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16543 Exim, by reducing the number of files involved in handling a message from a
16544 minimum of four (header spool file, body spool file, delivery journal, and
16545 per-message log) to three. The other major I/O activity is Exim's main log,
16546 which is not affected by this option.
16547
16548
16549 .option message_size_limit main string&!! 50M
16550 .cindex "message" "size limit"
16551 .cindex "limit" "message size"
16552 .cindex "size" "of message, limit"
16553 This option limits the maximum size of message that Exim will process. The
16554 value is expanded for each incoming connection so, for example, it can be made
16555 to depend on the IP address of the remote host for messages arriving via
16556 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16557 optionally followed by K or M.
16558
16559 .cindex "SIZE" "ESMTP extension, advertising"
16560 .cindex "ESMTP extensions" SIZE
16561 If nonzero the value will be advertised as a parameter to the ESMTP SIZE
16562 service extension keyword.
16563
16564 &*Note*&: This limit cannot be made to depend on a message's sender or any
16565 other properties of an individual message, because it has to be advertised in
16566 the server's response to EHLO. String expansion failure causes a temporary
16567 error. A value of zero means no limit, but its use is not recommended. See also
16568 &%bounce_return_size_limit%&.
16569
16570 Incoming SMTP messages are failed with a 552 error if the limit is
16571 exceeded; locally-generated messages either get a stderr message or a delivery
16572 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16573 an oversized message is logged in both the main and the reject logs. See also
16574 the generic transport option &%message_size_limit%&, which limits the size of
16575 message that an individual transport can process.
16576
16577 If you use a virus-scanner and set this option to to a value larger than the
16578 maximum size that your virus-scanner is configured to support, you may get
16579 failures triggered by large mails.  The right size to configure for the
16580 virus-scanner depends upon what data is passed and the options in use but it's
16581 probably safest to just set it to a little larger than this value.  E.g., with a
16582 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16583 some problems may result.
16584
16585 A value of 0 will disable size limit checking; Exim will still advertise the
16586 SIZE extension in an EHLO response, but without a limit, so as to permit
16587 SMTP clients to still indicate the message size along with the MAIL verb.
16588
16589
16590 .option move_frozen_messages main boolean false
16591 .cindex "frozen messages" "moving"
16592 This option, which is available only if Exim has been built with the setting
16593 .code
16594 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16595 .endd
16596 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16597 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16598 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16599 standard utilities for handling such moved messages, and they do not show up in
16600 lists generated by &%-bp%& or by the Exim monitor.
16601
16602
16603 .option mua_wrapper main boolean false
16604 Setting this option true causes Exim to run in a very restrictive mode in which
16605 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16606 contains a full description of this facility.
16607
16608
16609
16610 .option mysql_servers main "string list" unset
16611 .cindex "MySQL" "server list"
16612 This option provides a list of MySQL servers and associated connection data, to
16613 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16614 option is available only if Exim has been built with MySQL support.
16615
16616
16617 .option never_users main "string list&!!" unset
16618 This option is expanded just once, at the start of Exim's processing. Local
16619 message deliveries are normally run in processes that are setuid to the
16620 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16621 It is usually desirable to prevent any deliveries from running as root, as a
16622 safety precaution.
16623
16624 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16625 list of users that must not be used for local deliveries. This list is fixed in
16626 the binary and cannot be overridden by the configuration file. By default, it
16627 contains just the single user name &"root"&. The &%never_users%& runtime option
16628 can be used to add more users to the fixed list.
16629
16630 If a message is to be delivered as one of the users on the fixed list or the
16631 &%never_users%& list, an error occurs, and delivery is deferred. A common
16632 example is
16633 .code
16634 never_users = root:daemon:bin
16635 .endd
16636 Including root is redundant if it is also on the fixed list, but it does no
16637 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16638 transport driver.
16639
16640
16641 .option notifier_socket main string "$spool_directory/exim_daemon_notify"
16642 This option gives the name for a unix-domain socket on which the daemon
16643 listens for work and information-requests.
16644 Only installations running multiple daemons sharing a spool directory
16645 should need to modify the default.
16646
16647 The option is expanded before use.
16648 If the platform supports Linux-style abstract socket names, the result
16649 is used with a nul byte prefixed.
16650 Otherwise, it should be a full path name and use a directory accessible
16651 to Exim.
16652
16653 If the Exim command line uses a &%-oX%& option and does not use &%-oP%&
16654 then a notifier socket is not created.
16655
16656
16657 .option openssl_options main "string list" "+no_sslv2 +no_sslv3 +single_dh_use +no_ticket +no_renegotiation"
16658 .cindex "OpenSSL "compatibility options"
16659 This option allows an administrator to adjust the SSL options applied
16660 by OpenSSL to connections.  It is given as a space-separated list of items,
16661 each one to be +added or -subtracted from the current value.
16662
16663 This option is only available if Exim is built against OpenSSL.  The values
16664 available for this option vary according to the age of your OpenSSL install.
16665 The &"all"& value controls a subset of flags which are available, typically
16666 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16667 list the values known on your system and Exim should support all the
16668 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16669 names lose the leading &"SSL_OP_"& and are lower-cased.
16670
16671 Note that adjusting the options can have severe impact upon the security of
16672 SSL as used by Exim.  It is possible to disable safety checks and shoot
16673 yourself in the foot in various unpleasant ways.  This option should not be
16674 adjusted lightly.  An unrecognised item will be detected at startup, by
16675 invoking Exim with the &%-bV%& flag.
16676
16677 The option affects Exim operating both as a server and as a client.
16678
16679 Historical note: prior to release 4.80, Exim defaulted this value to
16680 "+dont_insert_empty_fragments", which may still be needed for compatibility
16681 with some clients, but which lowers security by increasing exposure to
16682 some now infamous attacks.
16683
16684 Examples:
16685 .code
16686 # Make both old MS and old Eudora happy:
16687 openssl_options = -all +microsoft_big_sslv3_buffer \
16688                        +dont_insert_empty_fragments
16689
16690 # Disable older protocol versions:
16691 openssl_options = +no_sslv2 +no_sslv3
16692 .endd
16693
16694 Possible options may include:
16695 .ilist
16696 &`all`&
16697 .next
16698 &`allow_unsafe_legacy_renegotiation`&
16699 .next
16700 &`cipher_server_preference`&
16701 .next
16702 &`dont_insert_empty_fragments`&
16703 .next
16704 &`ephemeral_rsa`&
16705 .next
16706 &`legacy_server_connect`&
16707 .next
16708 &`microsoft_big_sslv3_buffer`&
16709 .next
16710 &`microsoft_sess_id_bug`&
16711 .next
16712 &`msie_sslv2_rsa_padding`&
16713 .next
16714 &`netscape_challenge_bug`&
16715 .next
16716 &`netscape_reuse_cipher_change_bug`&
16717 .next
16718 &`no_compression`&
16719 .next
16720 &`no_session_resumption_on_renegotiation`&
16721 .next
16722 &`no_sslv2`&
16723 .next
16724 &`no_sslv3`&
16725 .next
16726 &`no_ticket`&
16727 .next
16728 &`no_tlsv1`&
16729 .next
16730 &`no_tlsv1_1`&
16731 .next
16732 &`no_tlsv1_2`&
16733 .next
16734 &`safari_ecdhe_ecdsa_bug`&
16735 .next
16736 &`single_dh_use`&
16737 .next
16738 &`single_ecdh_use`&
16739 .next
16740 &`ssleay_080_client_dh_bug`&
16741 .next
16742 &`sslref2_reuse_cert_type_bug`&
16743 .next
16744 &`tls_block_padding_bug`&
16745 .next
16746 &`tls_d5_bug`&
16747 .next
16748 &`tls_rollback_bug`&
16749 .endlist
16750
16751 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16752 all clients connecting using the MacOS SecureTransport TLS facility prior
16753 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16754 to negotiate TLS then this option value might help, provided that your OpenSSL
16755 release is new enough to contain this work-around.  This may be a situation
16756 where you have to upgrade OpenSSL to get buggy clients working.
16757
16758
16759 .option oracle_servers main "string list" unset
16760 .cindex "Oracle" "server list"
16761 This option provides a list of Oracle servers and associated connection data,
16762 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16763 The option is available only if Exim has been built with Oracle support.
16764
16765
16766 .option percent_hack_domains main "domain list&!!" unset
16767 .cindex "&""percent hack""&"
16768 .cindex "source routing" "in email address"
16769 .cindex "address" "source-routed"
16770 The &"percent hack"& is the convention whereby a local part containing a
16771 percent sign is re-interpreted as a new email address, with the percent
16772 replaced by @. This is sometimes called &"source routing"&, though that term is
16773 also applied to RFC 2822 addresses that begin with an @ character. If this
16774 option is set, Exim implements the percent facility for those domains listed,
16775 but no others. This happens before an incoming SMTP address is tested against
16776 an ACL.
16777
16778 &*Warning*&: The &"percent hack"& has often been abused by people who are
16779 trying to get round relaying restrictions. For this reason, it is best avoided
16780 if at all possible. Unfortunately, a number of less security-conscious MTAs
16781 implement it unconditionally. If you are running Exim on a gateway host, and
16782 routing mail through to internal MTAs without processing the local parts, it is
16783 a good idea to reject recipient addresses with percent characters in their
16784 local parts. Exim's default configuration does this.
16785
16786
16787 .option perl_at_start main boolean false
16788 .cindex "Perl"
16789 This option is available only when Exim is built with an embedded Perl
16790 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16791
16792
16793 .option perl_startup main string unset
16794 .cindex "Perl"
16795 This option is available only when Exim is built with an embedded Perl
16796 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16797
16798 .option perl_taintmode main boolean false
16799 .cindex "Perl"
16800 This option enables the taint mode of the embedded Perl interpreter.
16801
16802
16803 .option pgsql_servers main "string list" unset
16804 .cindex "PostgreSQL lookup type" "server list"
16805 This option provides a list of PostgreSQL servers and associated connection
16806 data, to be used in conjunction with &(pgsql)& lookups (see section
16807 &<<SECID72>>&). The option is available only if Exim has been built with
16808 PostgreSQL support.
16809
16810
16811 .option pid_file_path main string&!! "set at compile time"
16812 .cindex "daemon" "pid file path"
16813 .cindex "pid file, path for"
16814 This option sets the name of the file to which the Exim daemon writes its
16815 process id. The string is expanded, so it can contain, for example, references
16816 to the host name:
16817 .code
16818 pid_file_path = /var/log/$primary_hostname/exim.pid
16819 .endd
16820 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16821 spool directory.
16822 The value set by the option can be overridden by the &%-oP%& command line
16823 option. A pid file is not written if a &"non-standard"& daemon is run by means
16824 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16825
16826
16827 .option pipelining_advertise_hosts main "host list&!!" *
16828 .cindex "PIPELINING" "suppressing advertising"
16829 .cindex "ESMTP extensions" PIPELINING
16830 This option can be used to suppress the advertisement of the SMTP
16831 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16832 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16833 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16834 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16835 that clients will use it; &"out of order"& commands that are &"expected"& do
16836 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16837
16838 .option pipelining_connect_advertise_hosts main "host list&!!" *
16839 .cindex "pipelining" "early connection"
16840 .cindex "pipelining" PIPE_CONNECT
16841 .cindex "ESMTP extensions" X_PIPE_CONNECT
16842 If Exim is built with the SUPPORT_PIPE_CONNECT build option
16843 this option controls which hosts the facility is advertised to
16844 and from which pipeline early-connection (before MAIL) SMTP
16845 commands are acceptable.
16846 When used, the pipelining saves on roundtrip times.
16847
16848 See also the &%hosts_pipe_connect%& smtp transport option.
16849
16850 Currently the option name &"X_PIPE_CONNECT"& is used.
16851
16852
16853 .option prdr_enable main boolean false
16854 .cindex "PRDR" "enabling on server"
16855 .cindex "ESMTP extensions" PRDR
16856 This option can be used to enable the Per-Recipient Data Response extension
16857 to SMTP, defined by Eric Hall.
16858 If the option is set, PRDR is advertised by Exim when operating as a server.
16859 If the client requests PRDR, and more than one recipient, for a message
16860 an additional ACL is called for each recipient after the message content
16861 is received.  See section &<<SECTPRDRACL>>&.
16862
16863 .option preserve_message_logs main boolean false
16864 .cindex "message logs" "preserving"
16865 If this option is set, message log files are not deleted when messages are
16866 completed. Instead, they are moved to a sub-directory of the spool directory
16867 called &_msglog.OLD_&, where they remain available for statistical or debugging
16868 purposes. This is a dangerous option to set on systems with any appreciable
16869 volume of mail. Use with care!
16870
16871
16872 .option primary_hostname main string "see below"
16873 .cindex "name" "of local host"
16874 .cindex "host" "name of local"
16875 .cindex "local host" "name of"
16876 .vindex "&$primary_hostname$&"
16877 This specifies the name of the current host. It is used in the default EHLO or
16878 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16879 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16880 The value is also used by default in some SMTP response messages from an Exim
16881 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16882
16883 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16884 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16885 contains only one component, Exim passes it to &[gethostbyname()]& (or
16886 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16887 version. The variable &$primary_hostname$& contains the host name, whether set
16888 explicitly by this option, or defaulted.
16889
16890
16891 .option print_topbitchars main boolean false
16892 .cindex "printing characters"
16893 .cindex "8-bit characters"
16894 By default, Exim considers only those characters whose codes lie in the range
16895 32&--126 to be printing characters. In a number of circumstances (for example,
16896 when writing log entries) non-printing characters are converted into escape
16897 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16898 is set, code values of 128 and above are also considered to be printing
16899 characters.
16900
16901 This option also affects the header syntax checks performed by the
16902 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16903 the user's full name when constructing From: and Sender: addresses (as
16904 described in section &<<SECTconstr>>&). Setting this option can cause
16905 Exim to generate eight bit message headers that do not conform to the
16906 standards.
16907
16908
16909 .option process_log_path main string unset
16910 .cindex "process log path"
16911 .cindex "log" "process log"
16912 .cindex "&'exiwhat'&"
16913 This option sets the name of the file to which an Exim process writes its
16914 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16915 utility script. If this option is unset, the file called &_exim-process.info_&
16916 in Exim's spool directory is used. The ability to specify the name explicitly
16917 can be useful in environments where two different Exims are running, using
16918 different spool directories.
16919
16920
16921 .option prod_requires_admin main boolean true
16922 .cindex "restricting access to features"
16923 .oindex "&%-M%&"
16924 .oindex "&%-R%&"
16925 .oindex "&%-q%&"
16926 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16927 admin user unless &%prod_requires_admin%& is set false. See also
16928 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16929
16930
16931 .option qualify_domain main string "see below"
16932 .cindex "domain" "for qualifying addresses"
16933 .cindex "address" "qualification"
16934 This option specifies the domain name that is added to any envelope sender
16935 addresses that do not have a domain qualification. It also applies to
16936 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16937 are accepted by default only for locally-generated messages. Qualification is
16938 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16939 locally-generated messages, unless the &%-bnq%& command line option is used.
16940
16941 Messages from external sources must always contain fully qualified addresses,
16942 unless the sending host matches &%sender_unqualified_hosts%& or
16943 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16944 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16945 necessary. Internally, Exim always works with fully qualified envelope
16946 addresses. If &%qualify_domain%& is not set, it defaults to the
16947 &%primary_hostname%& value.
16948
16949
16950 .option qualify_recipient main string "see below"
16951 This option allows you to specify a different domain for qualifying recipient
16952 addresses to the one that is used for senders. See &%qualify_domain%& above.
16953
16954
16955
16956 .option queue_domains main "domain list&!!" unset
16957 .cindex "domain" "specifying non-immediate delivery"
16958 .cindex "queueing incoming messages"
16959 .cindex "message" "queueing certain domains"
16960 This option lists domains for which immediate delivery is not required.
16961 A delivery process is started whenever a message is received, but only those
16962 domains that do not match are processed. All other deliveries wait until the
16963 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16964
16965
16966 .new
16967 .option queue_fast_ramp main boolean false
16968 .cindex "queue runner" "two phase"
16969 .cindex "queue" "double scanning"
16970 If set to true, two-phase queue runs, initiated using &%-qq%& on the
16971 command line, may start parallel delivery processes during their first
16972 phase.  This will be done when a threshold number of messages have been
16973 routed for a single host.
16974 .wen
16975
16976
16977 .option queue_list_requires_admin main boolean true
16978 .cindex "restricting access to features"
16979 .oindex "&%-bp%&"
16980 The &%-bp%& command-line option, which lists the messages that are on the
16981 queue, requires the caller to be an admin user unless
16982 &%queue_list_requires_admin%& is set false.
16983 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16984
16985
16986 .option queue_only main boolean false
16987 .cindex "queueing incoming messages"
16988 .cindex "message" "queueing unconditionally"
16989 If &%queue_only%& is set, a delivery process is not automatically started
16990 whenever a message is received. Instead, the message waits in the queue for the
16991 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16992 delivered immediately when certain conditions (such as heavy load) occur.
16993
16994 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16995 and &%-odi%& command line options override &%queue_only%& unless
16996 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16997 &%queue_only_load%&, and &%smtp_accept_queue%&.
16998
16999
17000 .option queue_only_file main string unset
17001 .cindex "queueing incoming messages"
17002 .cindex "message" "queueing by file existence"
17003 This option can be set to a colon-separated list of absolute path names, each
17004 one optionally preceded by &"smtp"&. When Exim is receiving a message,
17005 it tests for the existence of each listed path using a call to &[stat()]&. For
17006 each path that exists, the corresponding queueing option is set.
17007 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
17008 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
17009 .code
17010 queue_only_file = smtp/some/file
17011 .endd
17012 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
17013 &_/some/file_& exists.
17014
17015
17016 .option queue_only_load main fixed-point unset
17017 .cindex "load average"
17018 .cindex "queueing incoming messages"
17019 .cindex "message" "queueing by load"
17020 If the system load average is higher than this value, incoming messages from
17021 all sources are queued, and no automatic deliveries are started. If this
17022 happens during local or remote SMTP input, all subsequent messages received on
17023 the same SMTP connection are queued by default, whatever happens to the load in
17024 the meantime, but this can be changed by setting &%queue_only_load_latch%&
17025 false.
17026
17027 Deliveries will subsequently be performed by queue runner processes. This
17028 option has no effect on ancient operating systems on which Exim cannot
17029 determine the load average. See also &%deliver_queue_load_max%& and
17030 &%smtp_load_reserve%&.
17031
17032
17033 .option queue_only_load_latch main boolean true
17034 .cindex "load average" "re-evaluating per message"
17035 When this option is true (the default), once one message has been queued
17036 because the load average is higher than the value set by &%queue_only_load%&,
17037 all subsequent messages received on the same SMTP connection are also queued.
17038 This is a deliberate choice; even though the load average may fall below the
17039 threshold, it doesn't seem right to deliver later messages on the same
17040 connection when not delivering earlier ones. However, there are special
17041 circumstances such as very long-lived connections from scanning appliances
17042 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
17043 should be set false. This causes the value of the load average to be
17044 re-evaluated for each message.
17045
17046
17047 .option queue_only_override main boolean true
17048 .cindex "queueing incoming messages"
17049 When this option is true, the &%-od%&&'x'& command line options override the
17050 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
17051 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
17052 to override; they are accepted, but ignored.
17053
17054
17055 .option queue_run_in_order main boolean false
17056 .cindex "queue runner" "processing messages in order"
17057 If this option is set, queue runs happen in order of message arrival instead of
17058 in an arbitrary order. For this to happen, a complete list of the entire queue
17059 must be set up before the deliveries start. When the queue is all held in a
17060 single directory (the default), a single list is created for both the ordered
17061 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
17062 single list is not created when &%queue_run_in_order%& is false. In this case,
17063 the sub-directories are processed one at a time (in a random order), and this
17064 avoids setting up one huge list for the whole queue. Thus, setting
17065 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
17066 when the queue is large, because of the extra work in setting up the single,
17067 large list. In most situations, &%queue_run_in_order%& should not be set.
17068
17069
17070
17071 .option queue_run_max main integer&!! 5
17072 .cindex "queue runner" "maximum number of"
17073 This controls the maximum number of queue runner processes that an Exim daemon
17074 can run simultaneously. This does not mean that it starts them all at once,
17075 but rather that if the maximum number are still running when the time comes to
17076 start another one, it refrains from starting another one. This can happen with
17077 very large queues and/or very sluggish deliveries. This option does not,
17078 however, interlock with other processes, so additional queue runners can be
17079 started by other means, or by killing and restarting the daemon.
17080
17081 Setting this option to zero does not suppress queue runs; rather, it disables
17082 the limit, allowing any number of simultaneous queue runner processes to be
17083 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
17084 the daemon's command line.
17085
17086 .cindex queues named
17087 .cindex "named queues" "resource limit"
17088 To set limits for different named queues use
17089 an expansion depending on the &$queue_name$& variable.
17090
17091 .option queue_smtp_domains main "domain list&!!" unset
17092 .cindex "queueing incoming messages"
17093 .cindex "message" "queueing remote deliveries"
17094 .cindex "first pass routing"
17095 When this option is set, a delivery process is started whenever a message is
17096 received, routing is performed, and local deliveries take place.
17097 However, if any SMTP deliveries are required for domains that match
17098 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
17099 message waits in the queue for the next queue run. Since routing of the message
17100 has taken place, Exim knows to which remote hosts it must be delivered, and so
17101 when the queue run happens, multiple messages for the same host are delivered
17102 over a single SMTP connection. The &%-odqs%& command line option causes all
17103 SMTP deliveries to be queued in this way, and is equivalent to setting
17104 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
17105 &%queue_domains%&.
17106
17107
17108 .option receive_timeout main time 0s
17109 .cindex "timeout" "for non-SMTP input"
17110 This option sets the timeout for accepting a non-SMTP message, that is, the
17111 maximum time that Exim waits when reading a message on the standard input. If
17112 the value is zero, it will wait forever. This setting is overridden by the
17113 &%-or%& command line option. The timeout for incoming SMTP messages is
17114 controlled by &%smtp_receive_timeout%&.
17115
17116 .option received_header_text main string&!! "see below"
17117 .cindex "customizing" "&'Received:'& header"
17118 .cindex "&'Received:'& header line" "customizing"
17119 This string defines the contents of the &'Received:'& message header that is
17120 added to each message, except for the timestamp, which is automatically added
17121 on at the end (preceded by a semicolon). The string is expanded each time it is
17122 used. If the expansion yields an empty string, no &'Received:'& header line is
17123 added to the message. Otherwise, the string should start with the text
17124 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
17125 header lines.
17126 The default setting is:
17127
17128 .code
17129 received_header_text = Received: \
17130   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
17131     {${if def:sender_ident \
17132       {from ${quote_local_part:$sender_ident} }}\
17133         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
17134   by $primary_hostname \
17135   ${if def:received_protocol {with $received_protocol }}\
17136   ${if def:tls_in_ver        { ($tls_in_ver)}}\
17137   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
17138   (Exim $version_number)\n\t\
17139   ${if def:sender_address \
17140   {(envelope-from <$sender_address>)\n\t}}\
17141   id $message_exim_id\
17142   ${if def:received_for {\n\tfor $received_for}}
17143 .endd
17144
17145 The references to the TLS version and cipher are
17146 omitted when Exim is built without TLS
17147 support. The use of conditional expansions ensures that this works for both
17148 locally generated messages and messages received from remote hosts, giving
17149 header lines such as the following:
17150 .code
17151 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
17152 by marley.carol.example with esmtp (Exim 4.00)
17153 (envelope-from <bob@carol.example>)
17154 id 16IOWa-00019l-00
17155 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
17156 Received: by scrooge.carol.example with local (Exim 4.00)
17157 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
17158 .endd
17159 Until the body of the message has been received, the timestamp is the time when
17160 the message started to be received. Once the body has arrived, and all policy
17161 checks have taken place, the timestamp is updated to the time at which the
17162 message was accepted.
17163
17164
17165 .option received_headers_max main integer 30
17166 .cindex "loop" "prevention"
17167 .cindex "mail loop prevention"
17168 .cindex "&'Received:'& header line" "counting"
17169 When a message is to be delivered, the number of &'Received:'& headers is
17170 counted, and if it is greater than this parameter, a mail loop is assumed to
17171 have occurred, the delivery is abandoned, and an error message is generated.
17172 This applies to both local and remote deliveries.
17173
17174
17175 .option recipient_unqualified_hosts main "host list&!!" unset
17176 .cindex "unqualified addresses"
17177 .cindex "host" "unqualified addresses from"
17178 This option lists those hosts from which Exim is prepared to accept unqualified
17179 recipient addresses in message envelopes. The addresses are made fully
17180 qualified by the addition of the &%qualify_recipient%& value. This option also
17181 affects message header lines. Exim does not reject unqualified recipient
17182 addresses in headers, but it qualifies them only if the message came from a
17183 host that matches &%recipient_unqualified_hosts%&,
17184 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
17185 option was not set.
17186
17187
17188 .option recipients_max main integer 0
17189 .cindex "limit" "number of recipients"
17190 .cindex "recipient" "maximum number"
17191 If this option is set greater than zero, it specifies the maximum number of
17192 original recipients for any message. Additional recipients that are generated
17193 by aliasing or forwarding do not count. SMTP messages get a 452 response for
17194 all recipients over the limit; earlier recipients are delivered as normal.
17195 Non-SMTP messages with too many recipients are failed, and no deliveries are
17196 done.
17197
17198 .cindex "RCPT" "maximum number of incoming"
17199 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
17200 RCPT commands in a single message.
17201
17202
17203 .option recipients_max_reject main boolean false
17204 If this option is set true, Exim rejects SMTP messages containing too many
17205 recipients by giving 552 errors to the surplus RCPT commands, and a 554
17206 error to the eventual DATA command. Otherwise (the default) it gives a 452
17207 error to the surplus RCPT commands and accepts the message on behalf of the
17208 initial set of recipients. The remote server should then re-send the message
17209 for the remaining recipients at a later time.
17210
17211
17212 .option remote_max_parallel main integer 2
17213 .cindex "delivery" "parallelism for remote"
17214 This option controls parallel delivery of one message to a number of remote
17215 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
17216 does all the remote deliveries for a message one by one. Otherwise, if a single
17217 message has to be delivered to more than one remote host, or if several copies
17218 have to be sent to the same remote host, up to &%remote_max_parallel%&
17219 deliveries are done simultaneously. If more than &%remote_max_parallel%&
17220 deliveries are required, the maximum number of processes are started, and as
17221 each one finishes, another is begun. The order of starting processes is the
17222 same as if sequential delivery were being done, and can be controlled by the
17223 &%remote_sort_domains%& option. If parallel delivery takes place while running
17224 with debugging turned on, the debugging output from each delivery process is
17225 tagged with its process id.
17226
17227 This option controls only the maximum number of parallel deliveries for one
17228 message in one Exim delivery process. Because Exim has no central queue
17229 manager, there is no way of controlling the total number of simultaneous
17230 deliveries if the configuration allows a delivery attempt as soon as a message
17231 is received.
17232
17233 .cindex "number of deliveries"
17234 .cindex "delivery" "maximum number of"
17235 If you want to control the total number of deliveries on the system, you
17236 need to set the &%queue_only%& option. This ensures that all incoming messages
17237 are added to the queue without starting a delivery process. Then set up an Exim
17238 daemon to start queue runner processes at appropriate intervals (probably
17239 fairly often, for example, every minute), and limit the total number of queue
17240 runners by setting the &%queue_run_max%& parameter. Because each queue runner
17241 delivers only one message at a time, the maximum number of deliveries that can
17242 then take place at once is &%queue_run_max%& multiplied by
17243 &%remote_max_parallel%&.
17244
17245 If it is purely remote deliveries you want to control, use
17246 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
17247 doing the SMTP routing before queueing, so that several messages for the same
17248 host will eventually get delivered down the same connection.
17249
17250
17251 .option remote_sort_domains main "domain list&!!" unset
17252 .cindex "sorting remote deliveries"
17253 .cindex "delivery" "sorting remote"
17254 When there are a number of remote deliveries for a message, they are sorted by
17255 domain into the order given by this list. For example,
17256 .code
17257 remote_sort_domains = *.cam.ac.uk:*.uk
17258 .endd
17259 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
17260 then to those in the &%uk%& domain, then to any others.
17261
17262
17263 .option retry_data_expire main time 7d
17264 .cindex "hints database" "data expiry"
17265 This option sets a &"use before"& time on retry information in Exim's hints
17266 database. Any older retry data is ignored. This means that, for example, once a
17267 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
17268 past failures.
17269
17270
17271 .option retry_interval_max main time 24h
17272 .cindex "retry" "limit on interval"
17273 .cindex "limit" "on retry interval"
17274 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
17275 intervals between delivery attempts for messages that cannot be delivered
17276 straight away. This option sets an overall limit to the length of time between
17277 retries. It cannot be set greater than 24 hours; any attempt to do so forces
17278 the default value.
17279
17280
17281 .option return_path_remove main boolean true
17282 .cindex "&'Return-path:'& header line" "removing"
17283 RFC 2821, section 4.4, states that an SMTP server must insert a
17284 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
17285 The &'Return-path:'& header preserves the sender address as received in the
17286 MAIL command. This description implies that this header should not be present
17287 in an incoming message. If &%return_path_remove%& is true, any existing
17288 &'Return-path:'& headers are removed from messages at the time they are
17289 received. Exim's transports have options for adding &'Return-path:'& headers at
17290 the time of delivery. They are normally used only for final local deliveries.
17291
17292
17293 .option return_size_limit main integer 100K
17294 This option is an obsolete synonym for &%bounce_return_size_limit%&.
17295
17296
17297 .option rfc1413_hosts main "host list&!!" @[]
17298 .cindex "RFC 1413"
17299 .cindex "host" "for RFC 1413 calls"
17300 RFC 1413 identification calls are made to any client host which matches
17301 an item in the list.
17302 The default value specifies just this host, being any local interface
17303 for the system.
17304
17305 .option rfc1413_query_timeout main time 0s
17306 .cindex "RFC 1413" "query timeout"
17307 .cindex "timeout" "for RFC 1413 call"
17308 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
17309 no RFC 1413 calls are ever made.
17310
17311
17312 .option sender_unqualified_hosts main "host list&!!" unset
17313 .cindex "unqualified addresses"
17314 .cindex "host" "unqualified addresses from"
17315 This option lists those hosts from which Exim is prepared to accept unqualified
17316 sender addresses. The addresses are made fully qualified by the addition of
17317 &%qualify_domain%&. This option also affects message header lines. Exim does
17318 not reject unqualified addresses in headers that contain sender addresses, but
17319 it qualifies them only if the message came from a host that matches
17320 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
17321 using TCP/IP), and the &%-bnq%& option was not set.
17322
17323
17324 .option slow_lookup_log main integer 0
17325 .cindex "logging" "slow lookups"
17326 .cindex "dns" "logging slow lookups"
17327 This option controls logging of slow lookups.
17328 If the value is nonzero it is taken as a number of milliseconds
17329 and lookups taking longer than this are logged.
17330 Currently this applies only to DNS lookups.
17331
17332
17333
17334 .option smtp_accept_keepalive main boolean true
17335 .cindex "keepalive" "on incoming connection"
17336 This option controls the setting of the SO_KEEPALIVE option on incoming
17337 TCP/IP socket connections. When set, it causes the kernel to probe idle
17338 connections periodically, by sending packets with &"old"& sequence numbers. The
17339 other end of the connection should send an acknowledgment if the connection is
17340 still okay or a reset if the connection has been aborted. The reason for doing
17341 this is that it has the beneficial effect of freeing up certain types of
17342 connection that can get stuck when the remote host is disconnected without
17343 tidying up the TCP/IP call properly. The keepalive mechanism takes several
17344 hours to detect unreachable hosts.
17345
17346
17347
17348 .option smtp_accept_max main integer 20
17349 .cindex "limit" "incoming SMTP connections"
17350 .cindex "SMTP" "incoming connection count"
17351 .cindex "inetd"
17352 This option specifies the maximum number of simultaneous incoming SMTP calls
17353 that Exim will accept. It applies only to the listening daemon; there is no
17354 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
17355 value is set to zero, no limit is applied. However, it is required to be
17356 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
17357 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
17358
17359 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
17360 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
17361 that limit has not been reached for the client host, &%smtp_accept_reserve%&
17362 and &%smtp_load_reserve%& are then checked before accepting the connection.
17363
17364
17365 .option smtp_accept_max_nonmail main integer 10
17366 .cindex "limit" "non-mail SMTP commands"
17367 .cindex "SMTP" "limiting non-mail commands"
17368 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
17369 the connection if there are too many. This option defines &"too many"&. The
17370 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
17371 client looping sending EHLO, for example. The check is applied only if the
17372 client host matches &%smtp_accept_max_nonmail_hosts%&.
17373
17374 When a new message is expected, one occurrence of RSET is not counted. This
17375 allows a client to send one RSET between messages (this is not necessary,
17376 but some clients do it). Exim also allows one uncounted occurrence of HELO
17377 or EHLO, and one occurrence of STARTTLS between messages. After
17378 starting up a TLS session, another EHLO is expected, and so it too is not
17379 counted. The first occurrence of AUTH in a connection, or immediately
17380 following STARTTLS is not counted. Otherwise, all commands other than
17381 MAIL, RCPT, DATA, and QUIT are counted.
17382
17383
17384 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
17385 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
17386 check by setting this option. The default value makes it apply to all hosts. By
17387 changing the value, you can exclude any badly-behaved hosts that you have to
17388 live with.
17389
17390
17391 . Allow this long option name to split; give it unsplit as a fifth argument
17392 . for the automatic .oindex that is generated by .option.
17393 . We insert " &~&~" which is both pretty nasty visually and results in
17394 . non-searchable text.  HowItWorks.txt mentions an option for inserting
17395 . zero-width-space, which would be nicer visually and results in (at least)
17396 . html that Firefox will split on when it's forced to reflow (rather than
17397 . inserting a horizontal scrollbar).  However, the text is still not
17398 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
17399 . the option name to split.
17400
17401 .option "smtp_accept_max_per_connection" main integer 1000 &&&
17402          smtp_accept_max_per_connection
17403 .cindex "SMTP" "limiting incoming message count"
17404 .cindex "limit" "messages per SMTP connection"
17405 The value of this option limits the number of MAIL commands that Exim is
17406 prepared to accept over a single SMTP connection, whether or not each command
17407 results in the transfer of a message. After the limit is reached, a 421
17408 response is given to subsequent MAIL commands. This limit is a safety
17409 precaution against a client that goes mad (incidents of this type have been
17410 seen).
17411
17412
17413 .option smtp_accept_max_per_host main string&!! unset
17414 .cindex "limit" "SMTP connections from one host"
17415 .cindex "host" "limiting SMTP connections from"
17416 This option restricts the number of simultaneous IP connections from a single
17417 host (strictly, from a single IP address) to the Exim daemon. The option is
17418 expanded, to enable different limits to be applied to different hosts by
17419 reference to &$sender_host_address$&. Once the limit is reached, additional
17420 connection attempts from the same host are rejected with error code 421. This
17421 is entirely independent of &%smtp_accept_reserve%&. The option's default value
17422 of zero imposes no limit. If this option is set greater than zero, it is
17423 required that &%smtp_accept_max%& be non-zero.
17424
17425 &*Warning*&: When setting this option you should not use any expansion
17426 constructions that take an appreciable amount of time. The expansion and test
17427 happen in the main daemon loop, in order to reject additional connections
17428 without forking additional processes (otherwise a denial-of-service attack
17429 could cause a vast number or processes to be created). While the daemon is
17430 doing this processing, it cannot accept any other incoming connections.
17431
17432
17433
17434 .option smtp_accept_queue main integer 0
17435 .cindex "SMTP" "incoming connection count"
17436 .cindex "queueing incoming messages"
17437 .cindex "message" "queueing by SMTP connection count"
17438 If the number of simultaneous incoming SMTP connections being handled via the
17439 listening daemon exceeds this value, messages received by SMTP are just placed
17440 in the queue; no delivery processes are started automatically. The count is
17441 fixed at the start of an SMTP connection. It cannot be updated in the
17442 subprocess that receives messages, and so the queueing or not queueing applies
17443 to all messages received in the same connection.
17444
17445 A value of zero implies no limit, and clearly any non-zero value is useful only
17446 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
17447 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
17448 various &%-od%&&'x'& command line options.
17449
17450
17451 . See the comment on smtp_accept_max_per_connection
17452
17453 .option "smtp_accept_queue_per_connection" main integer 10 &&&
17454          smtp_accept_queue_per_connection
17455 .cindex "queueing incoming messages"
17456 .cindex "message" "queueing by message count"
17457 This option limits the number of delivery processes that Exim starts
17458 automatically when receiving messages via SMTP, whether via the daemon or by
17459 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
17460 and the number of messages received in a single SMTP session exceeds this
17461 number, subsequent messages are placed in the queue, but no delivery processes
17462 are started. This helps to limit the number of Exim processes when a server
17463 restarts after downtime and there is a lot of mail waiting for it on other
17464 systems. On large systems, the default should probably be increased, and on
17465 dial-in client systems it should probably be set to zero (that is, disabled).
17466
17467
17468 .option smtp_accept_reserve main integer 0
17469 .cindex "SMTP" "incoming call count"
17470 .cindex "host" "reserved"
17471 When &%smtp_accept_max%& is set greater than zero, this option specifies a
17472 number of SMTP connections that are reserved for connections from the hosts
17473 that are specified in &%smtp_reserve_hosts%&. The value set in
17474 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
17475 restricted to this number of connections; the option specifies a minimum number
17476 of connection slots for them, not a maximum. It is a guarantee that this group
17477 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
17478 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
17479 individual host.
17480
17481 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
17482 set to 5, once there are 45 active connections (from any hosts), new
17483 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
17484 provided the other criteria for acceptance are met.
17485
17486
17487 .option smtp_active_hostname main string&!! unset
17488 .cindex "host" "name in SMTP responses"
17489 .cindex "SMTP" "host name in responses"
17490 .vindex "&$primary_hostname$&"
17491 This option is provided for multi-homed servers that want to masquerade as
17492 several different hosts. At the start of an incoming SMTP connection, its value
17493 is expanded and used instead of the value of &$primary_hostname$& in SMTP
17494 responses. For example, it is used as domain name in the response to an
17495 incoming HELO or EHLO command.
17496
17497 .vindex "&$smtp_active_hostname$&"
17498 The active hostname is placed in the &$smtp_active_hostname$& variable, which
17499 is saved with any messages that are received. It is therefore available for use
17500 in routers and transports when the message is later delivered.
17501
17502 If this option is unset, or if its expansion is forced to fail, or if the
17503 expansion results in an empty string, the value of &$primary_hostname$& is
17504 used. Other expansion failures cause a message to be written to the main and
17505 panic logs, and the SMTP command receives a temporary error. Typically, the
17506 value of &%smtp_active_hostname%& depends on the incoming interface address.
17507 For example:
17508 .code
17509 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
17510   {cox.mydomain}{box.mydomain}}
17511 .endd
17512
17513 Although &$smtp_active_hostname$& is primarily concerned with incoming
17514 messages, it is also used as the default for HELO commands in callout
17515 verification if there is no remote transport from which to obtain a
17516 &%helo_data%& value.
17517
17518 .option smtp_banner main string&!! "see below"
17519 .cindex "SMTP" "welcome banner"
17520 .cindex "banner for SMTP"
17521 .cindex "welcome banner for SMTP"
17522 .cindex "customizing" "SMTP banner"
17523 This string, which is expanded every time it is used, is output as the initial
17524 positive response to an SMTP connection. The default setting is:
17525 .code
17526 smtp_banner = $smtp_active_hostname ESMTP Exim \
17527   $version_number $tod_full
17528 .endd
17529 Failure to expand the string causes a panic error. If you want to create a
17530 multiline response to the initial SMTP connection, use &"\n"& in the string at
17531 appropriate points, but not at the end. Note that the 220 code is not included
17532 in this string. Exim adds it automatically (several times in the case of a
17533 multiline response).
17534
17535
17536 .option smtp_check_spool_space main boolean true
17537 .cindex "checking disk space"
17538 .cindex "disk space, checking"
17539 .cindex "spool directory" "checking space"
17540 When this option is set, if an incoming SMTP session encounters the SIZE
17541 option on a MAIL command, it checks that there is enough space in the
17542 spool directory's partition to accept a message of that size, while still
17543 leaving free the amount specified by &%check_spool_space%& (even if that value
17544 is zero). If there isn't enough space, a temporary error code is returned.
17545
17546
17547 .option smtp_connect_backlog main integer 20
17548 .cindex "connection backlog"
17549 .cindex "SMTP" "connection backlog"
17550 .cindex "backlog of connections"
17551 This option specifies a maximum number of waiting SMTP connections. Exim passes
17552 this value to the TCP/IP system when it sets up its listener. Once this number
17553 of connections are waiting for the daemon's attention, subsequent connection
17554 attempts are refused at the TCP/IP level. At least, that is what the manuals
17555 say; in some circumstances such connection attempts have been observed to time
17556 out instead. For large systems it is probably a good idea to increase the
17557 value (to 50, say). It also gives some protection against denial-of-service
17558 attacks by SYN flooding.
17559
17560
17561 .option smtp_enforce_sync main boolean true
17562 .cindex "SMTP" "synchronization checking"
17563 .cindex "synchronization checking in SMTP"
17564 The SMTP protocol specification requires the client to wait for a response from
17565 the server at certain points in the dialogue. Without PIPELINING these
17566 synchronization points are after every command; with PIPELINING they are
17567 fewer, but they still exist.
17568
17569 Some spamming sites send out a complete set of SMTP commands without waiting
17570 for any response. Exim protects against this by rejecting a message if the
17571 client has sent further input when it should not have. The error response &"554
17572 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17573 for this error cannot be perfect because of transmission delays (unexpected
17574 input may be on its way but not yet received when Exim checks). However, it
17575 does detect many instances.
17576
17577 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17578 If you want to disable the check selectively (for example, only for certain
17579 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17580 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17581
17582
17583
17584 .option smtp_etrn_command main string&!! unset
17585 .cindex "ETRN" "command to be run"
17586 .cindex "ESMTP extensions" ETRN
17587 .vindex "&$domain$&"
17588 If this option is set, the given command is run whenever an SMTP ETRN
17589 command is received from a host that is permitted to issue such commands (see
17590 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17591 are independently expanded. The expansion variable &$domain$& is set to the
17592 argument of the ETRN command, and no syntax checking is done on it. For
17593 example:
17594 .code
17595 smtp_etrn_command = /etc/etrn_command $domain \
17596                     $sender_host_address
17597 .endd
17598 If the option is not set, the argument for the ETRN command must
17599 be a &'#'& followed by an address string.
17600 In this case an &'exim -R <string>'& command is used;
17601 if the ETRN ACL has set up a named-queue then &'-MCG <queue>'& is appended.
17602
17603 A new process is created to run the command, but Exim does not wait for it to
17604 complete. Consequently, its status cannot be checked. If the command cannot be
17605 run, a line is written to the panic log, but the ETRN caller still receives
17606 a 250 success response. Exim is normally running under its own uid when
17607 receiving SMTP, so it is not possible for it to change the uid before running
17608 the command.
17609
17610
17611 .option smtp_etrn_serialize main boolean true
17612 .cindex "ETRN" "serializing"
17613 When this option is set, it prevents the simultaneous execution of more than
17614 one identical command as a result of ETRN in an SMTP connection. See
17615 section &<<SECTETRN>>& for details.
17616
17617
17618 .option smtp_load_reserve main fixed-point unset
17619 .cindex "load average"
17620 If the system load average ever gets higher than this, incoming SMTP calls are
17621 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17622 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17623 the load is over the limit. The option has no effect on ancient operating
17624 systems on which Exim cannot determine the load average. See also
17625 &%deliver_queue_load_max%& and &%queue_only_load%&.
17626
17627
17628
17629 .option smtp_max_synprot_errors main integer 3
17630 .cindex "SMTP" "limiting syntax and protocol errors"
17631 .cindex "limit" "SMTP syntax and protocol errors"
17632 Exim rejects SMTP commands that contain syntax or protocol errors. In
17633 particular, a syntactically invalid email address, as in this command:
17634 .code
17635 RCPT TO:<abc xyz@a.b.c>
17636 .endd
17637 causes immediate rejection of the command, before any other tests are done.
17638 (The ACL cannot be run if there is no valid address to set up for it.) An
17639 example of a protocol error is receiving RCPT before MAIL. If there are
17640 too many syntax or protocol errors in one SMTP session, the connection is
17641 dropped. The limit is set by this option.
17642
17643 .cindex "PIPELINING" "expected errors"
17644 When the PIPELINING extension to SMTP is in use, some protocol errors are
17645 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17646 Exim assumes that PIPELINING will be used if it advertises it (see
17647 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17648 not count towards the limit.
17649
17650
17651
17652 .option smtp_max_unknown_commands main integer 3
17653 .cindex "SMTP" "limiting unknown commands"
17654 .cindex "limit" "unknown SMTP commands"
17655 If there are too many unrecognized commands in an incoming SMTP session, an
17656 Exim server drops the connection. This is a defence against some kinds of abuse
17657 that subvert web
17658 clients
17659 into making connections to SMTP ports; in these circumstances, a number of
17660 non-SMTP command lines are sent first.
17661
17662
17663
17664 .option smtp_ratelimit_hosts main "host list&!!" unset
17665 .cindex "SMTP" "rate limiting"
17666 .cindex "limit" "rate of message arrival"
17667 .cindex "RCPT" "rate limiting"
17668 Some sites find it helpful to be able to limit the rate at which certain hosts
17669 can send them messages, and the rate at which an individual message can specify
17670 recipients.
17671
17672 Exim has two rate-limiting facilities. This section describes the older
17673 facility, which can limit rates within a single connection. The newer
17674 &%ratelimit%& ACL condition can limit rates across all connections. See section
17675 &<<SECTratelimiting>>& for details of the newer facility.
17676
17677 When a host matches &%smtp_ratelimit_hosts%&, the values of
17678 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17679 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17680 respectively. Each option, if set, must contain a set of four comma-separated
17681 values:
17682
17683 .ilist
17684 A threshold, before which there is no rate limiting.
17685 .next
17686 An initial time delay. Unlike other times in Exim, numbers with decimal
17687 fractional parts are allowed here.
17688 .next
17689 A factor by which to increase the delay each time.
17690 .next
17691 A maximum value for the delay. This should normally be less than 5 minutes,
17692 because after that time, the client is liable to timeout the SMTP command.
17693 .endlist
17694
17695 For example, these settings have been used successfully at the site which
17696 first suggested this feature, for controlling mail from their customers:
17697 .code
17698 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17699 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17700 .endd
17701 The first setting specifies delays that are applied to MAIL commands after
17702 two have been received over a single connection. The initial delay is 0.5
17703 seconds, increasing by a factor of 1.05 each time. The second setting applies
17704 delays to RCPT commands when more than four occur in a single message.
17705
17706
17707 .option smtp_ratelimit_mail main string unset
17708 See &%smtp_ratelimit_hosts%& above.
17709
17710
17711 .option smtp_ratelimit_rcpt main string unset
17712 See &%smtp_ratelimit_hosts%& above.
17713
17714
17715 .option smtp_receive_timeout main time&!! 5m
17716 .cindex "timeout" "for SMTP input"
17717 .cindex "SMTP" "input timeout"
17718 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17719 input, including batch SMTP. If a line of input (either an SMTP command or a
17720 data line) is not received within this time, the SMTP connection is dropped and
17721 the message is abandoned.
17722 A line is written to the log containing one of the following messages:
17723 .code
17724 SMTP command timeout on connection from...
17725 SMTP data timeout on connection from...
17726 .endd
17727 The former means that Exim was expecting to read an SMTP command; the latter
17728 means that it was in the DATA phase, reading the contents of a message.
17729
17730 If the first character of the option is a &"$"& the option is
17731 expanded before use and may depend on
17732 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17733
17734
17735 .oindex "&%-os%&"
17736 The value set by this option can be overridden by the
17737 &%-os%& command-line option. A setting of zero time disables the timeout, but
17738 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17739 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17740 timeout is controlled by &%receive_timeout%& and &%-or%&.
17741
17742
17743 .option smtp_reserve_hosts main "host list&!!" unset
17744 This option defines hosts for which SMTP connections are reserved; see
17745 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17746
17747
17748 .option smtp_return_error_details main boolean false
17749 .cindex "SMTP" "details policy failures"
17750 .cindex "policy control" "rejection, returning details"
17751 In the default state, Exim uses bland messages such as
17752 &"Administrative prohibition"& when it rejects SMTP commands for policy
17753 reasons. Many sysadmins like this because it gives away little information
17754 to spammers. However, some other sysadmins who are applying strict checking
17755 policies want to give out much fuller information about failures. Setting
17756 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17757 example, instead of &"Administrative prohibition"&, it might give:
17758 .code
17759 550-Rejected after DATA: '>' missing at end of address:
17760 550 failing address in "From" header is: <user@dom.ain
17761 .endd
17762
17763
17764 .option smtputf8_advertise_hosts main "host list&!!" *
17765 .cindex "SMTPUTF8" "ESMTP extension, advertising"
17766 .cindex "ESMTP extensions" SMTPUTF8
17767 When Exim is built with support for internationalised mail names,
17768 the availability thereof is advertised in
17769 response to EHLO only to those client hosts that match this option. See
17770 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17771
17772
17773 .option spamd_address main string "127.0.0.1 783"
17774 This option is available when Exim is compiled with the content-scanning
17775 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17776 See section &<<SECTscanspamass>>& for more details.
17777
17778
17779
17780 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17781 This option is available when Exim is compiled with SPF support.
17782 See section &<<SECSPF>>& for more details.
17783
17784 .option spf_smtp_comment_template main string&!! "Please%_see%_http://www.open-spf.org/Why"
17785 This option is available when Exim is compiled with SPF support.  It
17786 allows the customisation of the SMTP comment that the SPF library
17787 generates.  You are strongly encouraged to link to your own explanative
17788 site. The template must not contain spaces. If you need spaces in the
17789 output, use the proper placeholder. If libspf2 can not parse the
17790 template, it uses a built-in default broken link. The following placeholders
17791 (along with Exim variables (but see below)) are allowed in the template:
17792 .ilist
17793 &*%_*&: A space.
17794 .next
17795 &*%{L}*&: Envelope sender's local part.
17796 .next
17797 &*%{S}*&: Envelope sender.
17798 .next
17799 &*%{O}*&: Envelope sender's domain.
17800 .next
17801 &*%{D}*&: Current(?) domain.
17802 .next
17803 &*%{I}*&: SMTP client Ip.
17804 .next
17805 &*%{C}*&: SMTP client pretty IP.
17806 .next
17807 &*%{T}*&: Epoch time (UTC).
17808 .next
17809 &*%{P}*&: SMTP client domain name.
17810 .next
17811 &*%{V}*&: IP version.
17812 .next
17813 &*%{H}*&: EHLO/HELO domain.
17814 .next
17815 &*%{R}*&: Receiving domain.
17816 .endlist
17817 The capitalized placeholders do proper URL encoding, if you use them
17818 lowercased, no encoding takes place.  This list was compiled from the
17819 libspf2 sources.
17820
17821 A note on using Exim variables: As
17822 currently the SPF library is initialized before the SMTP EHLO phase,
17823 the variables useful for expansion are quite limited.
17824
17825
17826 .option split_spool_directory main boolean false
17827 .cindex "multiple spool directories"
17828 .cindex "spool directory" "split"
17829 .cindex "directories, multiple"
17830 If this option is set, it causes Exim to split its input directory into 62
17831 subdirectories, each with a single alphanumeric character as its name. The
17832 sixth character of the message id is used to allocate messages to
17833 subdirectories; this is the least significant base-62 digit of the time of
17834 arrival of the message.
17835
17836 Splitting up the spool in this way may provide better performance on systems
17837 where there are long mail queues, by reducing the number of files in any one
17838 directory. The msglog directory is also split up in a similar way to the input
17839 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17840 are still placed in the single directory &_msglog.OLD_&.
17841
17842 It is not necessary to take any special action for existing messages when
17843 changing &%split_spool_directory%&. Exim notices messages that are in the
17844 &"wrong"& place, and continues to process them. If the option is turned off
17845 after a period of being on, the subdirectories will eventually empty and be
17846 automatically deleted.
17847
17848 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17849 changes. Instead of creating a list of all messages in the queue, and then
17850 trying to deliver each one, in turn, it constructs a list of those in one
17851 sub-directory and tries to deliver them, before moving on to the next
17852 sub-directory. The sub-directories are processed in a random order. This
17853 spreads out the scanning of the input directories, and uses less memory. It is
17854 particularly beneficial when there are lots of messages in the queue. However,
17855 if &%queue_run_in_order%& is set, none of this new processing happens. The
17856 entire queue has to be scanned and sorted before any deliveries can start.
17857
17858
17859 .option spool_directory main string&!! "set at compile time"
17860 .cindex "spool directory" "path to"
17861 This defines the directory in which Exim keeps its spool, that is, the messages
17862 it is waiting to deliver. The default value is taken from the compile-time
17863 configuration setting, if there is one. If not, this option must be set. The
17864 string is expanded, so it can contain, for example, a reference to
17865 &$primary_hostname$&.
17866
17867 If the spool directory name is fixed on your installation, it is recommended
17868 that you set it at build time rather than from this option, particularly if the
17869 log files are being written to the spool directory (see &%log_file_path%&).
17870 Otherwise log files cannot be used for errors that are detected early on, such
17871 as failures in the configuration file.
17872
17873 By using this option to override the compiled-in path, it is possible to run
17874 tests of Exim without using the standard spool.
17875
17876 .option spool_wireformat main boolean false
17877 .cindex "spool directory" "file formats"
17878 If this option is set, Exim may for some messages use an alternative format
17879 for data-files in the spool which matches the wire format.
17880 Doing this permits more efficient message reception and transmission.
17881 Currently it is only done for messages received using the ESMTP CHUNKING
17882 option.
17883
17884 The following variables will not have useful values:
17885 .code
17886 $max_received_linelength
17887 $body_linecount
17888 $body_zerocount
17889 .endd
17890
17891 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17892 and any external programs which are passed a reference to a message data file
17893 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17894 will need to be aware of the different formats potentially available.
17895
17896 Using any of the ACL conditions noted will negate the reception benefit
17897 (as a Unix-mbox-format file is constructed for them).
17898 The transmission benefit is maintained.
17899
17900 .option sqlite_lock_timeout main time 5s
17901 .cindex "sqlite lookup type" "lock timeout"
17902 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17903 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17904
17905 .option strict_acl_vars main boolean false
17906 .cindex "&ACL;" "variables, handling unset"
17907 This option controls what happens if a syntactically valid but undefined ACL
17908 variable is referenced. If it is false (the default), an empty string
17909 is substituted; if it is true, an error is generated. See section
17910 &<<SECTaclvariables>>& for details of ACL variables.
17911
17912 .option strip_excess_angle_brackets main boolean false
17913 .cindex "angle brackets, excess"
17914 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17915 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17916 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17917 passed on to another MTA, the excess angle brackets are not passed on. If this
17918 option is not set, multiple pairs of angle brackets cause a syntax error.
17919
17920
17921 .option strip_trailing_dot main boolean false
17922 .cindex "trailing dot on domain"
17923 .cindex "dot" "trailing on domain"
17924 If this option is set, a trailing dot at the end of a domain in an address is
17925 ignored. If this is in the envelope and the message is passed on to another
17926 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17927 domain causes a syntax error.
17928 However, addresses in header lines are checked only when an ACL requests header
17929 syntax checking.
17930
17931
17932 .option syslog_duplication main boolean true
17933 .cindex "syslog" "duplicate log lines; suppressing"
17934 When Exim is logging to syslog, it writes the log lines for its three
17935 separate logs at different syslog priorities so that they can in principle
17936 be separated on the logging hosts. Some installations do not require this
17937 separation, and in those cases, the duplication of certain log lines is a
17938 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17939 particular log line is written to syslog. For lines that normally go to
17940 both the main log and the reject log, the reject log version (possibly
17941 containing message header lines) is written, at LOG_NOTICE priority.
17942 Lines that normally go to both the main and the panic log are written at
17943 the LOG_ALERT priority.
17944
17945
17946 .option syslog_facility main string unset
17947 .cindex "syslog" "facility; setting"
17948 This option sets the syslog &"facility"& name, used when Exim is logging to
17949 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17950 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17951 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17952 details of Exim's logging.
17953
17954
17955 .option syslog_pid main boolean true
17956 .cindex "syslog" "pid"
17957 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17958 omitted when these lines are sent to syslog. (Syslog normally prefixes
17959 the log lines with the PID of the logging process automatically.) You need
17960 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17961 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17962
17963
17964
17965 .option syslog_processname main string &`exim`&
17966 .cindex "syslog" "process name; setting"
17967 This option sets the syslog &"ident"& name, used when Exim is logging to
17968 syslog. The value must be no longer than 32 characters. See chapter
17969 &<<CHAPlog>>& for details of Exim's logging.
17970
17971
17972
17973 .option syslog_timestamp main boolean true
17974 .cindex "syslog" "timestamps"
17975 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17976 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17977 details of Exim's logging.
17978
17979
17980 .option system_filter main string&!! unset
17981 .cindex "filter" "system filter"
17982 .cindex "system filter" "specifying"
17983 .cindex "Sieve filter" "not available for system filter"
17984 This option specifies an Exim filter file that is applied to all messages at
17985 the start of each delivery attempt, before any routing is done. System filters
17986 must be Exim filters; they cannot be Sieve filters. If the system filter
17987 generates any deliveries to files or pipes, or any new mail messages, the
17988 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17989 which transports are to be used. Details of this facility are given in chapter
17990 &<<CHAPsystemfilter>>&.
17991 A forced expansion failure results in no filter operation.
17992
17993
17994 .option system_filter_directory_transport main string&!! unset
17995 .vindex "&$address_file$&"
17996 This sets the name of the transport driver that is to be used when the
17997 &%save%& command in a system message filter specifies a path ending in &"/"&,
17998 implying delivery of each message into a separate file in some directory.
17999 During the delivery, the variable &$address_file$& contains the path name.
18000
18001
18002 .option system_filter_file_transport main string&!! unset
18003 .cindex "file" "transport for system filter"
18004 This sets the name of the transport driver that is to be used when the &%save%&
18005 command in a system message filter specifies a path not ending in &"/"&. During
18006 the delivery, the variable &$address_file$& contains the path name.
18007
18008 .option system_filter_group main string unset
18009 .cindex "gid (group id)" "system filter"
18010 This option is used only when &%system_filter_user%& is also set. It sets the
18011 gid under which the system filter is run, overriding any gid that is associated
18012 with the user. The value may be numerical or symbolic.
18013
18014 .option system_filter_pipe_transport main string&!! unset
18015 .cindex "&(pipe)& transport" "for system filter"
18016 .vindex "&$address_pipe$&"
18017 This specifies the transport driver that is to be used when a &%pipe%& command
18018 is used in a system filter. During the delivery, the variable &$address_pipe$&
18019 contains the pipe command.
18020
18021
18022 .option system_filter_reply_transport main string&!! unset
18023 .cindex "&(autoreply)& transport" "for system filter"
18024 This specifies the transport driver that is to be used when a &%mail%& command
18025 is used in a system filter.
18026
18027
18028 .option system_filter_user main string unset
18029 .cindex "uid (user id)" "system filter"
18030 If this option is set to root, the system filter is run in the main Exim
18031 delivery process, as root.  Otherwise, the system filter runs in a separate
18032 process, as the given user, defaulting to the Exim run-time user.
18033 Unless the string consists entirely of digits, it
18034 is looked up in the password data. Failure to find the named user causes a
18035 configuration error. The gid is either taken from the password data, or
18036 specified by &%system_filter_group%&. When the uid is specified numerically,
18037 &%system_filter_group%& is required to be set.
18038
18039 If the system filter generates any pipe, file, or reply deliveries, the uid
18040 under which the filter is run is used when transporting them, unless a
18041 transport option overrides.
18042
18043
18044 .option tcp_nodelay main boolean true
18045 .cindex "daemon" "TCP_NODELAY on sockets"
18046 .cindex "Nagle algorithm"
18047 .cindex "TCP_NODELAY on listening sockets"
18048 If this option is set false, it stops the Exim daemon setting the
18049 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
18050 turns off the &"Nagle algorithm"&, which is a way of improving network
18051 performance in interactive (character-by-character) situations. Turning it off
18052 should improve Exim's performance a bit, so that is what happens by default.
18053 However, it appears that some broken clients cannot cope, and time out. Hence
18054 this option. It affects only those sockets that are set up for listening by the
18055 daemon. Sockets created by the smtp transport for delivering mail always set
18056 TCP_NODELAY.
18057
18058
18059 .option timeout_frozen_after main time 0s
18060 .cindex "frozen messages" "timing out"
18061 .cindex "timeout" "frozen messages"
18062 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
18063 message of any kind that has been in the queue for longer than the given time
18064 is automatically cancelled at the next queue run. If the frozen message is a
18065 bounce message, it is just discarded; otherwise, a bounce is sent to the
18066 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
18067 If you want to timeout frozen bounce messages earlier than other kinds of
18068 frozen message, see &%ignore_bounce_errors_after%&.
18069
18070 &*Note:*& the default value of zero means no timeouts; with this setting,
18071 frozen messages remain in the queue forever (except for any frozen bounce
18072 messages that are released by &%ignore_bounce_errors_after%&).
18073
18074
18075 .option timezone main string unset
18076 .cindex "timezone, setting"
18077 .cindex "environment" "values from"
18078 The value of &%timezone%& is used to set the environment variable TZ while
18079 running Exim (if it is different on entry). This ensures that all timestamps
18080 created by Exim are in the required timezone. If you want all your timestamps
18081 to be in UTC (aka GMT) you should set
18082 .code
18083 timezone = UTC
18084 .endd
18085 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
18086 or, if that is not set, from the value of the TZ environment variable when Exim
18087 is built. If &%timezone%& is set to the empty string, either at build or run
18088 time, any existing TZ variable is removed from the environment when Exim
18089 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
18090 unfortunately not all, operating systems.
18091
18092
18093 .option tls_advertise_hosts main "host list&!!" *
18094 .cindex "TLS" "advertising"
18095 .cindex "encryption" "on SMTP connection"
18096 .cindex "SMTP" "encrypted connection"
18097 .cindex "ESMTP extensions" STARTTLS
18098 When Exim is built with support for TLS encrypted connections, the availability
18099 of the STARTTLS command to set up an encrypted session is advertised in
18100 response to EHLO only to those client hosts that match this option. See
18101 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
18102 Note that the default value requires that a certificate be supplied
18103 using the &%tls_certificate%& option.  If TLS support for incoming connections
18104 is not required the &%tls_advertise_hosts%& option should be set empty.
18105
18106
18107 .option tls_certificate main string list&!! unset
18108 .cindex "TLS" "server certificate; location of"
18109 .cindex "certificate" "server, location of"
18110 The value of this option is expanded, and must then be a list of absolute paths to
18111 files which contain the server's certificates (in PEM format).
18112 Commonly only one file is needed.
18113 The server's private key is also
18114 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
18115 &<<CHAPTLS>>& for further details.
18116
18117 &*Note*&: The certificates defined by this option are used only when Exim is
18118 receiving incoming messages as a server. If you want to supply certificates for
18119 use when sending messages as a client, you must set the &%tls_certificate%&
18120 option in the relevant &(smtp)& transport.
18121
18122 &*Note*&: If you use filenames based on IP addresses, change the list
18123 separator in the usual way (&<<SECTlistsepchange>>&) to avoid confusion under IPv6.
18124
18125 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
18126 when a list of more than one
18127 file is used, the &$tls_in_ourcert$& variable is unreliable.
18128 The macro "_TLS_BAD_MULTICERT_IN_OURCERT" will be defined for those versions.
18129
18130 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
18131 if the OpenSSL build supports TLS extensions and the TLS client sends the
18132 Server Name Indication extension, then this option and others documented in
18133 &<<SECTtlssni>>& will be re-expanded.
18134
18135 If this option is unset or empty a fresh self-signed certificate will be
18136 generated for every connection.
18137
18138 .option tls_crl main string&!! unset
18139 .cindex "TLS" "server certificate revocation list"
18140 .cindex "certificate" "revocation list for server"
18141 This option specifies a certificate revocation list. The expanded value must
18142 be the name of a file that contains CRLs in PEM format.
18143
18144 Under OpenSSL the option can specify a directory with CRL files.
18145
18146 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
18147 for each signing element of the certificate chain (i.e. all but the leaf).
18148 For the file variant this can be multiple PEM blocks in the one file.
18149
18150 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18151
18152
18153 .option tls_dh_max_bits main integer 2236
18154 .cindex "TLS" "D-H bit count"
18155 The number of bits used for Diffie-Hellman key-exchange may be suggested by
18156 the chosen TLS library.  That value might prove to be too high for
18157 interoperability.  This option provides a maximum clamp on the value
18158 suggested, trading off security for interoperability.
18159
18160 The value must be at least 1024.
18161
18162 The value 2236 was chosen because, at time of adding the option, it was the
18163 hard-coded maximum value supported by the NSS cryptographic library, as used
18164 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
18165
18166 If you prefer more security and are willing to break some clients, raise this
18167 number.
18168
18169 Note that the value passed to GnuTLS for *generating* a new prime may be a
18170 little less than this figure, because GnuTLS is inexact and may produce a
18171 larger prime than requested.
18172
18173
18174 .option tls_dhparam main string&!! unset
18175 .cindex "TLS" "D-H parameters for server"
18176 The value of this option is expanded and indicates the source of DH parameters
18177 to be used by Exim.
18178
18179 This option is ignored for GnuTLS version 3.6.0 and later.
18180 The library manages parameter negotiation internally.
18181
18182 &*Note: The Exim Maintainers strongly recommend,
18183 for other TLS library versions,
18184 using a filename with site-generated
18185 local DH parameters*&, which has been supported across all versions of Exim.  The
18186 other specific constants available are a fallback so that even when
18187 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
18188
18189 If &%tls_dhparam%& is a filename starting with a &`/`&,
18190 then it names a file from which DH
18191 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
18192 PKCS#3 representation of the DH prime.  If the file does not exist, for
18193 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
18194 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
18195 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
18196 and treated as though the &%tls_dhparam%& were set to "none".
18197
18198 If this option expands to the string "none", then no DH parameters will be
18199 loaded by Exim.
18200
18201 If this option expands to the string "historic" and Exim is using GnuTLS, then
18202 Exim will attempt to load a file from inside the spool directory.  If the file
18203 does not exist, Exim will attempt to create it.
18204 See section &<<SECTgnutlsparam>>& for further details.
18205
18206 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
18207 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
18208
18209 In older versions of Exim the default was the 2048 bit prime described in section
18210 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
18211 in IKE is assigned number 23.
18212
18213 Otherwise, the option must expand to the name used by Exim for any of a number
18214 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
18215 sources.  As names, Exim uses a standard specified name, else "ike" followed by
18216 the number used by IKE, or "default" which corresponds to
18217 &`exim.dev.20160529.3`&.
18218
18219 The available standard primes are:
18220 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
18221 &`ike1`&, &`ike2`&, &`ike5`&,
18222 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
18223 &`ike22`&, &`ike23`& and &`ike24`&.
18224
18225 The available additional primes are:
18226 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
18227
18228 Some of these will be too small to be accepted by clients.
18229 Some may be too large to be accepted by clients.
18230 The open cryptographic community has suspicions about the integrity of some
18231 of the later IKE values, which led into RFC7919 providing new fixed constants
18232 (the "ffdhe" identifiers).
18233
18234 At this point, all of the "ike" values should be considered obsolete;
18235 they're still in Exim to avoid breaking unusual configurations, but are
18236 candidates for removal the next time we have backwards-incompatible changes.
18237
18238 The TLS protocol does not negotiate an acceptable size for this; clients tend
18239 to hard-drop connections if what is offered by the server is unacceptable,
18240 whether too large or too small, and there's no provision for the client to
18241 tell the server what these constraints are.  Thus, as a server operator, you
18242 need to make an educated guess as to what is most likely to work for your
18243 userbase.
18244
18245 Some known size constraints suggest that a bit-size in the range 2048 to 2236
18246 is most likely to maximise interoperability.  The upper bound comes from
18247 applications using the Mozilla Network Security Services (NSS) library, which
18248 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
18249 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
18250 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
18251 acceptable bound from 1024 to 2048.
18252
18253
18254 .option tls_eccurve main string&!! &`auto`&
18255 .cindex TLS "EC cryptography"
18256 This option selects a EC curve for use by Exim when used with OpenSSL.
18257 It has no effect when Exim is used with GnuTLS.
18258
18259 After expansion it must contain a valid EC curve parameter, such as
18260 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
18261 for valid selections.
18262
18263 For OpenSSL versions before (and not including) 1.0.2, the string
18264 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
18265 &`auto`& tells the library to choose.
18266
18267 If the option expands to an empty string, no EC curves will be enabled.
18268
18269
18270 .option tls_ocsp_file main string&!! unset
18271 .cindex TLS "certificate status"
18272 .cindex TLS "OCSP proof file"
18273 This option
18274 must if set expand to the absolute path to a file which contains a current
18275 status proof for the server's certificate, as obtained from the
18276 Certificate Authority.
18277
18278 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
18279 The macro "_HAVE_TLS_OCSP" will be defined for those versions.
18280
18281 For OpenSSL 1.1.0 or later, and
18282 for GnuTLS 3.5.6 or later the expanded value of this option can be a list
18283 of files, to match a list given for the &%tls_certificate%& option.
18284 The ordering of the two lists must match.
18285 The macro "_HAVE_TLS_OCSP_LIST" will be defined for those versions.
18286
18287 The file(s) should be in DER format,
18288 except for GnuTLS 3.6.3 or later
18289 or for OpenSSL,
18290 when an optional filetype prefix can be used.
18291 The prefix must be one of "DER" or "PEM", followed by
18292 a single space.  If one is used it sets the format for subsequent
18293 files in the list; the initial format is DER.
18294 If multiple proofs are wanted, for multiple chain elements
18295 (this only works under TLS1.3)
18296 they must be coded as a combined OCSP response.
18297
18298 Although GnuTLS will accept PEM files with multiple separate
18299 PEM blobs (ie. separate OCSP responses), it sends them in the
18300 TLS Certificate record interleaved with the certificates of the chain;
18301 although a GnuTLS client is happy with that, an OpenSSL client is not.
18302
18303 .option tls_on_connect_ports main "string list" unset
18304 .cindex SSMTP
18305 .cindex SMTPS
18306 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
18307 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
18308 set up without waiting for the client to issue a STARTTLS command. For
18309 further details, see section &<<SECTsupobssmt>>&.
18310
18311
18312
18313 .option tls_privatekey main string list&!! unset
18314 .cindex "TLS" "server private key; location of"
18315 The value of this option is expanded, and must then be a list of absolute paths to
18316 files which contains the server's private keys.
18317 If this option is unset, or if
18318 the expansion is forced to fail, or the result is an empty string, the private
18319 key is assumed to be in the same file as the server's certificates. See chapter
18320 &<<CHAPTLS>>& for further details.
18321
18322 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18323
18324
18325 .option tls_remember_esmtp main boolean false
18326 .cindex "TLS" "esmtp state; remembering"
18327 .cindex "TLS" "broken clients"
18328 If this option is set true, Exim violates the RFCs by remembering that it is in
18329 &"esmtp"& state after successfully negotiating a TLS session. This provides
18330 support for broken clients that fail to send a new EHLO after starting a
18331 TLS session.
18332
18333
18334 .option tls_require_ciphers main string&!! unset
18335 .cindex "TLS" "requiring specific ciphers"
18336 .cindex "cipher" "requiring specific"
18337 This option controls which ciphers can be used for incoming TLS connections.
18338 The &(smtp)& transport has an option of the same name for controlling outgoing
18339 connections. This option is expanded for each connection, so can be varied for
18340 different clients if required. The value of this option must be a list of
18341 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
18342 in somewhat different ways. If GnuTLS is being used, the client controls the
18343 preference order of the available ciphers. Details are given in sections
18344 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
18345
18346
18347 .new
18348 .option tls_resumption_hosts main "host list&!!" unset
18349 .cindex TLS resumption
18350 This option controls which connections to offer the TLS resumption feature.
18351 See &<<SECTresumption>>& for details.
18352 .wen
18353
18354
18355 .option tls_try_verify_hosts main "host list&!!" unset
18356 .cindex "TLS" "client certificate verification"
18357 .cindex "certificate" "verification of client"
18358 See &%tls_verify_hosts%& below.
18359
18360
18361 .option tls_verify_certificates main string&!! system
18362 .cindex "TLS" "client certificate verification"
18363 .cindex "certificate" "verification of client"
18364 The value of this option is expanded, and must then be either the
18365 word "system"
18366 or the absolute path to
18367 a file or directory containing permitted certificates for clients that
18368 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
18369
18370 The "system" value for the option will use a
18371 system default location compiled into the SSL library.
18372 This is not available for GnuTLS versions preceding 3.0.20,
18373 and will be taken as empty; an explicit location
18374 must be specified.
18375
18376 The use of a directory for the option value is not available for GnuTLS versions
18377 preceding 3.3.6 and a single file must be used.
18378
18379 With OpenSSL the certificates specified
18380 explicitly
18381 either by file or directory
18382 are added to those given by the system default location.
18383
18384 These certificates should be for the certificate authorities trusted, rather
18385 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
18386 the value is a file then the certificates are sent by Exim as a server to
18387 connecting clients, defining the list of accepted certificate authorities.
18388 Thus the values defined should be considered public data.  To avoid this,
18389 use the explicit directory version.
18390
18391 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
18392
18393 A forced expansion failure or setting to an empty string is equivalent to
18394 being unset.
18395
18396
18397 .option tls_verify_hosts main "host list&!!" unset
18398 .cindex "TLS" "client certificate verification"
18399 .cindex "certificate" "verification of client"
18400 This option, along with &%tls_try_verify_hosts%&, controls the checking of
18401 certificates from clients. The expected certificates are defined by
18402 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
18403 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
18404 &%tls_verify_certificates%& is not set.
18405
18406 Any client that matches &%tls_verify_hosts%& is constrained by
18407 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
18408 present one of the listed certificates. If it does not, the connection is
18409 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
18410 the host to use TLS. It can still send SMTP commands through unencrypted
18411 connections. Forcing a client to use TLS has to be done separately using an
18412 ACL to reject inappropriate commands when the connection is not encrypted.
18413
18414 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
18415 matches this option (but not &%tls_verify_hosts%&), Exim requests a
18416 certificate and checks it against &%tls_verify_certificates%&, but does not
18417 abort the connection if there is no certificate or if it does not match. This
18418 state can be detected in an ACL, which makes it possible to implement policies
18419 such as &"accept for relay only if a verified certificate has been received,
18420 but accept for local delivery if encrypted, even without a verified
18421 certificate"&.
18422
18423 Client hosts that match neither of these lists are not asked to present
18424 certificates.
18425
18426
18427 .option trusted_groups main "string list&!!" unset
18428 .cindex "trusted groups"
18429 .cindex "groups" "trusted"
18430 This option is expanded just once, at the start of Exim's processing. If this
18431 option is set, any process that is running in one of the listed groups, or
18432 which has one of them as a supplementary group, is trusted. The groups can be
18433 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
18434 details of what trusted callers are permitted to do. If neither
18435 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
18436 are trusted.
18437
18438 .option trusted_users main "string list&!!" unset
18439 .cindex "trusted users"
18440 .cindex "user" "trusted"
18441 This option is expanded just once, at the start of Exim's processing. If this
18442 option is set, any process that is running as one of the listed users is
18443 trusted. The users can be specified numerically or by name. See section
18444 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
18445 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
18446 Exim user are trusted.
18447
18448 .option unknown_login main string&!! unset
18449 .cindex "uid (user id)" "unknown caller"
18450 .vindex "&$caller_uid$&"
18451 This is a specialized feature for use in unusual configurations. By default, if
18452 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
18453 gives up. The &%unknown_login%& option can be used to set a login name to be
18454 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
18455 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
18456 is used for the user's real name (gecos field), unless this has been set by the
18457 &%-F%& option.
18458
18459 .option unknown_username main string unset
18460 See &%unknown_login%&.
18461
18462 .option untrusted_set_sender main "address list&!!" unset
18463 .cindex "trusted users"
18464 .cindex "sender" "setting by untrusted user"
18465 .cindex "untrusted user setting sender"
18466 .cindex "user" "untrusted setting sender"
18467 .cindex "envelope from"
18468 .cindex "envelope sender"
18469 When an untrusted user submits a message to Exim using the standard input, Exim
18470 normally creates an envelope sender address from the user's login and the
18471 default qualification domain. Data from the &%-f%& option (for setting envelope
18472 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
18473 is used) is ignored.
18474
18475 However, untrusted users are permitted to set an empty envelope sender address,
18476 to declare that a message should never generate any bounces. For example:
18477 .code
18478 exim -f '<>' user@domain.example
18479 .endd
18480 .vindex "&$sender_ident$&"
18481 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
18482 other envelope sender addresses in a controlled way. When it is set, untrusted
18483 users are allowed to set envelope sender addresses that match any of the
18484 patterns in the list. Like all address lists, the string is expanded. The
18485 identity of the user is in &$sender_ident$&, so you can, for example, restrict
18486 users to setting senders that start with their login ids
18487 followed by a hyphen
18488 by a setting like this:
18489 .code
18490 untrusted_set_sender = ^$sender_ident-
18491 .endd
18492 If you want to allow untrusted users to set envelope sender addresses without
18493 restriction, you can use
18494 .code
18495 untrusted_set_sender = *
18496 .endd
18497 The &%untrusted_set_sender%& option applies to all forms of local input, but
18498 only to the setting of the envelope sender. It does not permit untrusted users
18499 to use the other options which trusted user can use to override message
18500 parameters. Furthermore, it does not stop Exim from removing an existing
18501 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
18502 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
18503 overriding these actions. The handling of the &'Sender:'& header is also
18504 described in section &<<SECTthesenhea>>&.
18505
18506 The log line for a message's arrival shows the envelope sender following
18507 &"<="&. For local messages, the user's login always follows, after &"U="&. In
18508 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
18509 envelope sender address, the user's login is shown in parentheses after the
18510 sender address.
18511
18512
18513 .option uucp_from_pattern main string "see below"
18514 .cindex "&""From""& line"
18515 .cindex "UUCP" "&""From""& line"
18516 Some applications that pass messages to an MTA via a command line interface use
18517 an initial line starting with &"From&~"& to pass the envelope sender. In
18518 particular, this is used by UUCP software. Exim recognizes such a line by means
18519 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
18520 matches, the sender address is constructed by expanding the contents of
18521 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
18522 default pattern recognizes lines in the following two forms:
18523 .code
18524 From ph10 Fri Jan  5 12:35 GMT 1996
18525 From ph10 Fri, 7 Jan 97 14:00:00 GMT
18526 .endd
18527 The pattern can be seen by running
18528 .code
18529 exim -bP uucp_from_pattern
18530 .endd
18531 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
18532 year in the second case. The first word after &"From&~"& is matched in the
18533 regular expression by a parenthesized subpattern. The default value for
18534 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
18535 (&"ph10"& in the example above) as the message's sender. See also
18536 &%ignore_fromline_hosts%&.
18537
18538
18539 .option uucp_from_sender main string&!! &`$1`&
18540 See &%uucp_from_pattern%& above.
18541
18542
18543 .option warn_message_file main string&!! unset
18544 .cindex "warning of delay" "customizing the message"
18545 .cindex "customizing" "warning message"
18546 This option defines a template file containing paragraphs of text to be used
18547 for constructing the warning message which is sent by Exim when a message has
18548 been in the queue for a specified amount of time, as specified by
18549 &%delay_warning%&. Details of the file's contents are given in chapter
18550 &<<CHAPemsgcust>>&.
18551 .cindex warn_message_file "tainted data"
18552 The option is expanded to give the file path, which must be
18553 absolute and untainted.
18554 See also &%bounce_message_file%&.
18555
18556
18557 .option write_rejectlog main boolean true
18558 .cindex "reject log" "disabling"
18559 If this option is set false, Exim no longer writes anything to the reject log.
18560 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
18561 .ecindex IIDconfima
18562 .ecindex IIDmaiconf
18563
18564
18565
18566
18567 . ////////////////////////////////////////////////////////////////////////////
18568 . ////////////////////////////////////////////////////////////////////////////
18569
18570 .chapter "Generic options for routers" "CHAProutergeneric"
18571 .scindex IIDgenoprou1 "options" "generic; for routers"
18572 .scindex IIDgenoprou2 "generic options" "router"
18573 This chapter describes the generic options that apply to all routers.
18574 Those that are preconditions are marked with &Dagger; in the &"use"& field.
18575
18576 For a general description of how a router operates, see sections
18577 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
18578 which the preconditions are tested. The order of expansion of the options that
18579 provide data for a transport is: &%errors_to%&, &%headers_add%&,
18580 &%headers_remove%&, &%transport%&.
18581
18582
18583
18584 .option address_data routers string&!! unset
18585 .cindex "router" "data attached to address"
18586 The string is expanded just before the router is run, that is, after all the
18587 precondition tests have succeeded. If the expansion is forced to fail, the
18588 router declines, the value of &%address_data%& remains unchanged, and the
18589 &%more%& option controls what happens next. Other expansion failures cause
18590 delivery of the address to be deferred.
18591
18592 .vindex "&$address_data$&"
18593 When the expansion succeeds, the value is retained with the address, and can be
18594 accessed using the variable &$address_data$& in the current router, subsequent
18595 routers, and the eventual transport.
18596
18597 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18598 that runs a user's filter file, the contents of &$address_data$& are accessible
18599 in the filter. This is not normally a problem, because such data is usually
18600 either not confidential or it &"belongs"& to the current user, but if you do
18601 put confidential data into &$address_data$& you need to remember this point.
18602
18603 Even if the router declines or passes, the value of &$address_data$& remains
18604 with the address, though it can be changed by another &%address_data%& setting
18605 on a subsequent router. If a router generates child addresses, the value of
18606 &$address_data$& propagates to them. This also applies to the special kind of
18607 &"child"& that is generated by a router with the &%unseen%& option.
18608
18609 The idea of &%address_data%& is that you can use it to look up a lot of data
18610 for the address once, and then pick out parts of the data later. For example,
18611 you could use a single LDAP lookup to return a string of the form
18612 .code
18613 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18614 .endd
18615 In the transport you could pick out the mailbox by a setting such as
18616 .code
18617 file = ${extract{mailbox}{$address_data}}
18618 .endd
18619 This makes the configuration file less messy, and also reduces the number of
18620 lookups (though Exim does cache lookups).
18621
18622 See also the &%set%& option below.
18623
18624 .vindex "&$sender_address_data$&"
18625 .vindex "&$address_data$&"
18626 The &%address_data%& facility is also useful as a means of passing information
18627 from one router to another, and from a router to a transport. In addition, if
18628 &$address_data$& is set by a router when verifying a recipient address from an
18629 ACL, it remains available for use in the rest of the ACL statement. After
18630 verifying a sender, the value is transferred to &$sender_address_data$&.
18631
18632
18633
18634 .option address_test routers&!? boolean true
18635 .oindex "&%-bt%&"
18636 .cindex "router" "skipping when address testing"
18637 If this option is set false, the router is skipped when routing is being tested
18638 by means of the &%-bt%& command line option. This can be a convenience when
18639 your first router sends messages to an external scanner, because it saves you
18640 having to set the &"already scanned"& indicator when testing real address
18641 routing.
18642
18643
18644
18645 .option cannot_route_message routers string&!! unset
18646 .cindex "router" "customizing &""cannot route""& message"
18647 .cindex "customizing" "&""cannot route""& message"
18648 This option specifies a text message that is used when an address cannot be
18649 routed because Exim has run out of routers. The default message is
18650 &"Unrouteable address"&. This option is useful only on routers that have
18651 &%more%& set false, or on the very last router in a configuration, because the
18652 value that is used is taken from the last router that is considered. This
18653 includes a router that is skipped because its preconditions are not met, as
18654 well as a router that declines. For example, using the default configuration,
18655 you could put:
18656 .code
18657 cannot_route_message = Remote domain not found in DNS
18658 .endd
18659 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18660 and
18661 .code
18662 cannot_route_message = Unknown local user
18663 .endd
18664 on the final router that checks for local users. If string expansion fails for
18665 this option, the default message is used. Unless the expansion failure was
18666 explicitly forced, a message about the failure is written to the main and panic
18667 logs, in addition to the normal message about the routing failure.
18668
18669
18670 .option caseful_local_part routers boolean false
18671 .cindex "case of local parts"
18672 .cindex "router" "case of local parts"
18673 By default, routers handle the local parts of addresses in a case-insensitive
18674 manner, though the actual case is preserved for transmission with the message.
18675 If you want the case of letters to be significant in a router, you must set
18676 this option true. For individual router options that contain address or local
18677 part lists (for example, &%local_parts%&), case-sensitive matching can be
18678 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18679 more details.
18680
18681 .vindex "&$local_part$&"
18682 .vindex "&$original_local_part$&"
18683 .vindex "&$parent_local_part$&"
18684 The value of the &$local_part$& variable is forced to lower case while a
18685 router is running unless &%caseful_local_part%& is set. When a router assigns
18686 an address to a transport, the value of &$local_part$& when the transport runs
18687 is the same as it was in the router. Similarly, when a router generates child
18688 addresses by aliasing or forwarding, the values of &$original_local_part$&
18689 and &$parent_local_part$& are those that were used by the redirecting router.
18690
18691 This option applies to the processing of an address by a router. When a
18692 recipient address is being processed in an ACL, there is a separate &%control%&
18693 modifier that can be used to specify case-sensitive processing within the ACL
18694 (see section &<<SECTcontrols>>&).
18695
18696
18697
18698 .option check_local_user routers&!? boolean false
18699 .cindex "local user, checking in router"
18700 .cindex "router" "checking for local user"
18701 .cindex "&_/etc/passwd_&"
18702 .vindex "&$home$&"
18703 When this option is true, Exim checks that the local part of the recipient
18704 address (with affixes removed if relevant) is the name of an account on the
18705 local system. The check is done by calling the &[getpwnam()]& function rather
18706 than trying to read &_/etc/passwd_& directly. This means that other methods of
18707 holding password data (such as NIS) are supported. If the local part is a local
18708 user, &$home$& is set from the password data, and can be tested in other
18709 preconditions that are evaluated after this one (the order of evaluation is
18710 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18711 overridden by &%router_home_directory%&. If the local part is not a local user,
18712 the router is skipped.
18713
18714 If you want to check that the local part is either the name of a local user
18715 or matches something else, you cannot combine &%check_local_user%& with a
18716 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18717 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18718 setting to achieve this. For example:
18719 .code
18720 local_parts = passwd;$local_part : lsearch;/etc/other/users
18721 .endd
18722 Note, however, that the side effects of &%check_local_user%& (such as setting
18723 up a home directory) do not occur when a &(passwd)& lookup is used in a
18724 &%local_parts%& (or any other) precondition.
18725
18726
18727
18728 .option condition routers&!? string&!! unset
18729 .cindex "router" "customized precondition"
18730 This option specifies a general precondition test that has to succeed for the
18731 router to be called. The &%condition%& option is the last precondition to be
18732 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18733 result is a forced failure, or an empty string, or one of the strings &"0"& or
18734 &"no"& or &"false"& (checked without regard to the case of the letters), the
18735 router is skipped, and the address is offered to the next one.
18736
18737 If the result is any other value, the router is run (as this is the last
18738 precondition to be evaluated, all the other preconditions must be true).
18739
18740 This option is unusual in that multiple &%condition%& options may be present.
18741 All &%condition%& options must succeed.
18742
18743 The &%condition%& option provides a means of applying custom conditions to the
18744 running of routers. Note that in the case of a simple conditional expansion,
18745 the default expansion values are exactly what is wanted. For example:
18746 .code
18747 condition = ${if >{$message_age}{600}}
18748 .endd
18749 Because of the default behaviour of the string expansion, this is equivalent to
18750 .code
18751 condition = ${if >{$message_age}{600}{true}{}}
18752 .endd
18753
18754 A multiple condition example, which succeeds:
18755 .code
18756 condition = ${if >{$message_age}{600}}
18757 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18758 condition = foobar
18759 .endd
18760
18761 If the expansion fails (other than forced failure) delivery is deferred. Some
18762 of the other precondition options are common special cases that could in fact
18763 be specified using &%condition%&.
18764
18765 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18766 are far older, and use one set of semantics.  ACLs are newer and when
18767 they were created, the ACL &%condition%& process was given far stricter
18768 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18769 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18770 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18771 Router rules processing behavior.
18772
18773 This is best illustrated in an example:
18774 .code
18775 # If used in an ACL condition will fail with a syntax error, but
18776 # in a router condition any extra characters are treated as a string
18777
18778 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18779 true {yes} {no}}
18780
18781 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18782  {yes} {no}}
18783 .endd
18784 In each example above, the &%if%& statement actually ends after
18785 &"{google.com}}"&.  Since no true or false braces were defined, the
18786 default &%if%& behavior is to return a boolean true or a null answer
18787 (which evaluates to false). The rest of the line is then treated as a
18788 string. So the first example resulted in the boolean answer &"true"&
18789 with the string &" {yes} {no}}"& appended to it. The second example
18790 resulted in the null output (indicating false) with the string
18791 &" {yes} {no}}"& appended to it.
18792
18793 In fact you can put excess forward braces in too.  In the router
18794 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18795 mean something, like after a &"$"& or when required as part of a
18796 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18797 string characters.
18798
18799 Thus, in a Router, the above expansion strings will both always evaluate
18800 true, as the result of expansion is a non-empty string which doesn't
18801 match an explicit false value.  This can be tricky to debug.  By
18802 contrast, in an ACL either of those strings will always result in an
18803 expansion error because the result doesn't look sufficiently boolean.
18804
18805
18806 .option debug_print routers string&!! unset
18807 .cindex "testing" "variables in drivers"
18808 If this option is set and debugging is enabled (see the &%-d%& command line
18809 option) or in address-testing mode (see the &%-bt%& command line option),
18810 the string is expanded and included in the debugging output.
18811 If expansion of the string fails, the error message is written to the debugging
18812 output, and Exim carries on processing.
18813 This option is provided to help with checking out the values of variables and
18814 so on when debugging router configurations. For example, if a &%condition%&
18815 option appears not to be working, &%debug_print%& can be used to output the
18816 variables it references. The output happens after checks for &%domains%&,
18817 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18818 are tested. A newline is added to the text if it does not end with one.
18819 The variable &$router_name$& contains the name of the router.
18820
18821
18822
18823 .option disable_logging routers boolean false
18824 If this option is set true, nothing is logged for any routing errors
18825 or for any deliveries caused by this router. You should not set this option
18826 unless you really, really know what you are doing. See also the generic
18827 transport option of the same name.
18828
18829 .option dnssec_request_domains routers "domain list&!!" *
18830 .cindex "MX record" "security"
18831 .cindex "DNSSEC" "MX lookup"
18832 .cindex "security" "MX lookup"
18833 .cindex "DNS" "DNSSEC"
18834 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18835 the dnssec request bit set.
18836 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18837
18838 .option dnssec_require_domains routers "domain list&!!" unset
18839 .cindex "MX record" "security"
18840 .cindex "DNSSEC" "MX lookup"
18841 .cindex "security" "MX lookup"
18842 .cindex "DNS" "DNSSEC"
18843 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18844 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18845 (AD bit) set will be ignored and logged as a host-lookup failure.
18846 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18847
18848
18849 .option domains routers&!? "domain list&!!" unset
18850 .cindex "router" "restricting to specific domains"
18851 .vindex "&$domain_data$&"
18852 If this option is set, the router is skipped unless the current domain matches
18853 the list. If the match is achieved by means of a file lookup, the data that the
18854 lookup returned for the domain is placed in &$domain_data$& for use in string
18855 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18856 a list of the order in which preconditions are evaluated.
18857
18858
18859
18860 .option driver routers string unset
18861 This option must always be set. It specifies which of the available routers is
18862 to be used.
18863
18864
18865 .option dsn_lasthop routers boolean false
18866 .cindex "DSN" "success"
18867 .cindex "Delivery Status Notification" "success"
18868 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18869 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18870 instead send a success DSN as if the next hop does not support DSN.
18871 Not effective on redirect routers.
18872
18873
18874
18875 .option errors_to routers string&!! unset
18876 .cindex "envelope from"
18877 .cindex "envelope sender"
18878 .cindex "router" "changing address for errors"
18879 If a router successfully handles an address, it may assign the address to a
18880 transport for delivery or it may generate child addresses. In both cases, if
18881 there is a delivery problem during later processing, the resulting bounce
18882 message is sent to the address that results from expanding this string,
18883 provided that the address verifies successfully. The &%errors_to%& option is
18884 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18885
18886 The &%errors_to%& setting associated with an address can be overridden if it
18887 subsequently passes through other routers that have their own &%errors_to%&
18888 settings, or if the message is delivered by a transport with a &%return_path%&
18889 setting.
18890
18891 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18892 the expansion fails to verify, the errors address associated with the incoming
18893 address is used. At top level, this is the envelope sender. A non-forced
18894 expansion failure causes delivery to be deferred.
18895
18896 If an address for which &%errors_to%& has been set ends up being delivered over
18897 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18898 any bounces that are generated by other MTAs on the delivery route are also
18899 sent there. You can set &%errors_to%& to the empty string by either of these
18900 settings:
18901 .code
18902 errors_to =
18903 errors_to = ""
18904 .endd
18905 An expansion item that yields an empty string has the same effect. If you do
18906 this, a locally detected delivery error for addresses processed by this router
18907 no longer gives rise to a bounce message; the error is discarded. If the
18908 address is delivered to a remote host, the return path is set to &`<>`&, unless
18909 overridden by the &%return_path%& option on the transport.
18910
18911 .vindex "&$address_data$&"
18912 If for some reason you want to discard local errors, but use a non-empty
18913 MAIL command for remote delivery, you can preserve the original return
18914 path in &$address_data$& in the router, and reinstate it in the transport by
18915 setting &%return_path%&.
18916
18917 The most common use of &%errors_to%& is to direct mailing list bounces to the
18918 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18919 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18920
18921
18922
18923 .option expn routers&!? boolean true
18924 .cindex "address" "testing"
18925 .cindex "testing" "addresses"
18926 .cindex "EXPN" "router skipping"
18927 .cindex "router" "skipping for EXPN"
18928 If this option is turned off, the router is skipped when testing an address
18929 as a result of processing an SMTP EXPN command. You might, for example,
18930 want to turn it off on a router for users' &_.forward_& files, while leaving it
18931 on for the system alias file.
18932 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18933 are evaluated.
18934
18935 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18936 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18937 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18938
18939
18940
18941 .option fail_verify routers boolean false
18942 .cindex "router" "forcing verification failure"
18943 Setting this option has the effect of setting both &%fail_verify_sender%& and
18944 &%fail_verify_recipient%& to the same value.
18945
18946
18947
18948 .option fail_verify_recipient routers boolean false
18949 If this option is true and an address is accepted by this router when
18950 verifying a recipient, verification fails.
18951
18952
18953
18954 .option fail_verify_sender routers boolean false
18955 If this option is true and an address is accepted by this router when
18956 verifying a sender, verification fails.
18957
18958
18959
18960 .option fallback_hosts routers "string list" unset
18961 .cindex "router" "fallback hosts"
18962 .cindex "fallback" "hosts specified on router"
18963 String expansion is not applied to this option. The argument must be a
18964 colon-separated list of host names or IP addresses. The list separator can be
18965 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18966 each name or address. In fact, the format of each item is exactly the same as
18967 defined for the list of hosts in a &(manualroute)& router (see section
18968 &<<SECTformatonehostitem>>&).
18969
18970 If a router queues an address for a remote transport, this host list is
18971 associated with the address, and used instead of the transport's fallback host
18972 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18973 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18974 transport for further details.
18975
18976
18977 .option group routers string&!! "see below"
18978 .cindex "gid (group id)" "local delivery"
18979 .cindex "local transports" "uid and gid"
18980 .cindex "transport" "local"
18981 .cindex "router" "setting group"
18982 When a router queues an address for a transport, and the transport does not
18983 specify a group, the group given here is used when running the delivery
18984 process.
18985 The group may be specified numerically or by name. If expansion fails, the
18986 error is logged and delivery is deferred.
18987 The default is unset, unless &%check_local_user%& is set, when the default
18988 is taken from the password information. See also &%initgroups%& and &%user%&
18989 and the discussion in chapter &<<CHAPenvironment>>&.
18990
18991
18992
18993 .option headers_add routers list&!! unset
18994 .cindex "header lines" "adding"
18995 .cindex "router" "adding header lines"
18996 This option specifies a list of text headers,
18997 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18998 that is associated with any addresses that are accepted by the router.
18999 Each item is separately expanded, at routing time.  However, this
19000 option has no effect when an address is just being verified. The way in which
19001 the text is used to add header lines at transport time is described in section
19002 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
19003 message is in the process of being transported. This means that references to
19004 header lines in string expansions in the transport's configuration do not
19005 &"see"& the added header lines.
19006
19007 The &%headers_add%& option is expanded after &%errors_to%&, but before
19008 &%headers_remove%& and &%transport%&. If an item is empty, or if
19009 an item expansion is forced to fail, the item has no effect. Other expansion
19010 failures are treated as configuration errors.
19011
19012 Unlike most options, &%headers_add%& can be specified multiple times
19013 for a router; all listed headers are added.
19014
19015 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
19016 router that has the &%one_time%& option set.
19017
19018 .cindex "duplicate addresses"
19019 .oindex "&%unseen%&"
19020 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19021 additions are deleted when the address is passed on to subsequent routers.
19022 For a &%redirect%& router, if a generated address is the same as the incoming
19023 address, this can lead to duplicate addresses with different header
19024 modifications. Exim does not do duplicate deliveries (except, in certain
19025 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
19026 which of the duplicates is discarded, so this ambiguous situation should be
19027 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
19028
19029
19030
19031 .option headers_remove routers list&!! unset
19032 .cindex "header lines" "removing"
19033 .cindex "router" "removing header lines"
19034 This option specifies a list of text headers,
19035 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
19036 that is associated with any addresses that are accepted by the router.
19037 However, the option has no effect when an address is just being verified.
19038 Each list item is separately expanded, at transport time.
19039 If an item ends in *, it will match any header with the given prefix.
19040 The way in which
19041 the text is used to remove header lines at transport time is described in
19042 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
19043 the message is in the process of being transported. This means that references
19044 to header lines in string expansions in the transport's configuration still
19045 &"see"& the original header lines.
19046
19047 The &%headers_remove%& option is handled after &%errors_to%& and
19048 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
19049 the item has no effect. Other expansion failures are treated as configuration
19050 errors.
19051
19052 Unlike most options, &%headers_remove%& can be specified multiple times
19053 for a router; all listed headers are removed.
19054
19055 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
19056 router that has the &%one_time%& option set.
19057
19058 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
19059 removal requests are deleted when the address is passed on to subsequent
19060 routers, and this can lead to problems with duplicates -- see the similar
19061 warning for &%headers_add%& above.
19062
19063 &*Warning 3*&: Because of the separate expansion of the list items,
19064 items that contain a list separator must have it doubled.
19065 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
19066
19067
19068
19069 .option ignore_target_hosts routers "host list&!!" unset
19070 .cindex "IP address" "discarding"
19071 .cindex "router" "discarding IP addresses"
19072 Although this option is a host list, it should normally contain IP address
19073 entries rather than names. If any host that is looked up by the router has an
19074 IP address that matches an item in this list, Exim behaves as if that IP
19075 address did not exist. This option allows you to cope with rogue DNS entries
19076 like
19077 .code
19078 remote.domain.example.  A  127.0.0.1
19079 .endd
19080 by setting
19081 .code
19082 ignore_target_hosts = 127.0.0.1
19083 .endd
19084 on the relevant router. If all the hosts found by a &(dnslookup)& router are
19085 discarded in this way, the router declines. In a conventional configuration, an
19086 attempt to mail to such a domain would normally provoke the &"unrouteable
19087 domain"& error, and an attempt to verify an address in the domain would fail.
19088 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
19089 router declines if presented with one of the listed addresses.
19090
19091 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
19092 means of the first or the second of the following settings, respectively:
19093 .code
19094 ignore_target_hosts = 0.0.0.0/0
19095 ignore_target_hosts = <; 0::0/0
19096 .endd
19097 The pattern in the first line matches all IPv4 addresses, whereas the pattern
19098 in the second line matches all IPv6 addresses.
19099
19100 This option may also be useful for ignoring link-local and site-local IPv6
19101 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
19102 is expanded before use as a list, it is possible to make it dependent on the
19103 domain that is being routed.
19104
19105 .vindex "&$host_address$&"
19106 During its expansion, &$host_address$& is set to the IP address that is being
19107 checked.
19108
19109 .option initgroups routers boolean false
19110 .cindex "additional groups"
19111 .cindex "groups" "additional"
19112 .cindex "local transports" "uid and gid"
19113 .cindex "transport" "local"
19114 If the router queues an address for a transport, and this option is true, and
19115 the uid supplied by the router is not overridden by the transport, the
19116 &[initgroups()]& function is called when running the transport to ensure that
19117 any additional groups associated with the uid are set up. See also &%group%&
19118 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
19119
19120
19121
19122 .option local_part_prefix routers&!? "string list" unset
19123 .cindex affix "router precondition"
19124 .cindex "router" "prefix for local part"
19125 .cindex "prefix" "for local part, used in router"
19126 If this option is set, the router is skipped unless the local part starts with
19127 one of the given strings, or &%local_part_prefix_optional%& is true. See
19128 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
19129 evaluated.
19130
19131 The list is scanned from left to right, and the first prefix that matches is
19132 used. A limited form of wildcard is available; if the prefix begins with an
19133 asterisk, it matches the longest possible sequence of arbitrary characters at
19134 the start of the local part. An asterisk should therefore always be followed by
19135 some character that does not occur in normal local parts.
19136 .cindex "multiple mailboxes"
19137 .cindex "mailbox" "multiple"
19138 Wildcarding can be used to set up multiple user mailboxes, as described in
19139 section &<<SECTmulbox>>&.
19140
19141 .vindex "&$local_part$&"
19142 .vindex "&$local_part_prefix$&"
19143 During the testing of the &%local_parts%& option, and while the router is
19144 running, the prefix is removed from the local part, and is available in the
19145 expansion variable &$local_part_prefix$&. When a message is being delivered, if
19146 the router accepts the address, this remains true during subsequent delivery by
19147 a transport. In particular, the local part that is transmitted in the RCPT
19148 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
19149 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
19150 the relevant transport.
19151
19152 .vindex &$local_part_prefix_v$&
19153 If wildcarding (above) was used then the part of the prefix matching the
19154 wildcard is available in &$local_part_prefix_v$&.
19155
19156 When an address is being verified, &%local_part_prefix%& affects only the
19157 behaviour of the router. If the callout feature of verification is in use, this
19158 means that the full address, including the prefix, will be used during the
19159 callout.
19160
19161 The prefix facility is commonly used to handle local parts of the form
19162 &%owner-something%&. Another common use is to support local parts of the form
19163 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
19164 to tell a user their forwarding is broken &-- by placing a router like this one
19165 immediately before the router that handles &_.forward_& files:
19166 .code
19167 real_localuser:
19168   driver = accept
19169   local_part_prefix = real-
19170   check_local_user
19171   transport = local_delivery
19172 .endd
19173 For security, it would probably be a good idea to restrict the use of this
19174 router to locally-generated messages, using a condition such as this:
19175 .code
19176   condition = ${if match {$sender_host_address}\
19177                          {\N^(|127\.0\.0\.1)$\N}}
19178 .endd
19179
19180 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
19181 both conditions must be met if not optional. Care must be taken if wildcards
19182 are used in both a prefix and a suffix on the same router. Different
19183 separator characters must be used to avoid ambiguity.
19184
19185
19186 .option local_part_prefix_optional routers boolean false
19187 See &%local_part_prefix%& above.
19188
19189
19190
19191 .option local_part_suffix routers&!? "string list" unset
19192 .cindex "router" "suffix for local part"
19193 .cindex "suffix for local part" "used in router"
19194 This option operates in the same way as &%local_part_prefix%&, except that the
19195 local part must end (rather than start) with the given string, the
19196 &%local_part_suffix_optional%& option determines whether the suffix is
19197 mandatory, and the wildcard * character, if present, must be the last
19198 character of the suffix. This option facility is commonly used to handle local
19199 parts of the form &%something-request%& and multiple user mailboxes of the form
19200 &%username-foo%&.
19201
19202
19203 .option local_part_suffix_optional routers boolean false
19204 See &%local_part_suffix%& above.
19205
19206
19207
19208 .option local_parts routers&!? "local part list&!!" unset
19209 .cindex "router" "restricting to specific local parts"
19210 .cindex "local part" "checking in router"
19211 The router is run only if the local part of the address matches the list.
19212 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19213 are evaluated, and
19214 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
19215 string is expanded, it is possible to make it depend on the domain, for
19216 example:
19217 .code
19218 local_parts = dbm;/usr/local/specials/$domain
19219 .endd
19220 .vindex "&$local_part_data$&"
19221 If the match is achieved by a lookup, the data that the lookup returned
19222 for the local part is placed in the variable &$local_part_data$& for use in
19223 expansions of the router's private options. You might use this option, for
19224 example, if you have a large number of local virtual domains, and you want to
19225 send all postmaster mail to the same place without having to set up an alias in
19226 each virtual domain:
19227 .code
19228 postmaster:
19229   driver = redirect
19230   local_parts = postmaster
19231   data = postmaster@real.domain.example
19232 .endd
19233
19234
19235 .option log_as_local routers boolean "see below"
19236 .cindex "log" "delivery line"
19237 .cindex "delivery" "log line format"
19238 Exim has two logging styles for delivery, the idea being to make local
19239 deliveries stand out more visibly from remote ones. In the &"local"& style, the
19240 recipient address is given just as the local part, without a domain. The use of
19241 this style is controlled by this option. It defaults to true for the &(accept)&
19242 router, and false for all the others. This option applies only when a
19243 router assigns an address to a transport. It has no effect on routers that
19244 redirect addresses.
19245
19246
19247
19248 .option more routers boolean&!! true
19249 The result of string expansion for this option must be a valid boolean value,
19250 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19251 result causes an error, and delivery is deferred. If the expansion is forced to
19252 fail, the default value for the option (true) is used. Other failures cause
19253 delivery to be deferred.
19254
19255 If this option is set false, and the router declines to handle the address, no
19256 further routers are tried, routing fails, and the address is bounced.
19257 .oindex "&%self%&"
19258 However, if the router explicitly passes an address to the following router by
19259 means of the setting
19260 .code
19261 self = pass
19262 .endd
19263 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
19264 does not affect the behaviour if one of the precondition tests fails. In that
19265 case, the address is always passed to the next router.
19266
19267 Note that &%address_data%& is not considered to be a precondition. If its
19268 expansion is forced to fail, the router declines, and the value of &%more%&
19269 controls what happens next.
19270
19271
19272 .option pass_on_timeout routers boolean false
19273 .cindex "timeout" "of router"
19274 .cindex "router" "timeout"
19275 If a router times out during a host lookup, it normally causes deferral of the
19276 address. If &%pass_on_timeout%& is set, the address is passed on to the next
19277 router, overriding &%no_more%&. This may be helpful for systems that are
19278 intermittently connected to the Internet, or those that want to pass to a smart
19279 host any messages that cannot immediately be delivered.
19280
19281 There are occasional other temporary errors that can occur while doing DNS
19282 lookups. They are treated in the same way as a timeout, and this option
19283 applies to all of them.
19284
19285
19286
19287 .option pass_router routers string unset
19288 .cindex "router" "go to after &""pass""&"
19289 Routers that recognize the generic &%self%& option (&(dnslookup)&,
19290 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
19291 routing to continue, and overriding a false setting of &%more%&. When one of
19292 these routers returns &"pass"&, the address is normally handed on to the next
19293 router in sequence. This can be changed by setting &%pass_router%& to the name
19294 of another router. However (unlike &%redirect_router%&) the named router must
19295 be below the current router, to avoid loops. Note that this option applies only
19296 to the special case of &"pass"&. It does not apply when a router returns
19297 &"decline"& because it cannot handle an address.
19298
19299
19300
19301 .option redirect_router routers string unset
19302 .cindex "router" "start at after redirection"
19303 Sometimes an administrator knows that it is pointless to reprocess addresses
19304 generated from alias or forward files with the same router again. For
19305 example, if an alias file translates real names into login ids there is no
19306 point searching the alias file a second time, especially if it is a large file.
19307
19308 The &%redirect_router%& option can be set to the name of any router instance.
19309 It causes the routing of any generated addresses to start at the named router
19310 instead of at the first router. This option has no effect if the router in
19311 which it is set does not generate new addresses.
19312
19313
19314
19315 .option require_files routers&!? "string list&!!" unset
19316 .cindex "file" "requiring for router"
19317 .cindex "router" "requiring file existence"
19318 This option provides a general mechanism for predicating the running of a
19319 router on the existence or non-existence of certain files or directories.
19320 Before running a router, as one of its precondition tests, Exim works its way
19321 through the &%require_files%& list, expanding each item separately.
19322
19323 Because the list is split before expansion, any colons in expansion items must
19324 be doubled, or the facility for using a different list separator must be used
19325 (&<<SECTlistsepchange>>&).
19326 If any expansion is forced to fail, the item is ignored. Other expansion
19327 failures cause routing of the address to be deferred.
19328
19329 If any expanded string is empty, it is ignored. Otherwise, except as described
19330 below, each string must be a fully qualified file path, optionally preceded by
19331 &"!"&. The paths are passed to the &[stat()]& function to test for the
19332 existence of the files or directories. The router is skipped if any paths not
19333 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
19334
19335 .cindex "NFS"
19336 If &[stat()]& cannot determine whether a file exists or not, delivery of
19337 the message is deferred. This can happen when NFS-mounted filesystems are
19338 unavailable.
19339
19340 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
19341 options, so you cannot use it to check for the existence of a file in which to
19342 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
19343 full list of the order in which preconditions are evaluated.) However, as
19344 these options are all expanded, you can use the &%exists%& expansion condition
19345 to make such tests. The &%require_files%& option is intended for checking files
19346 that the router may be going to use internally, or which are needed by a
19347 transport (e.g., &_.procmailrc_&).
19348
19349 During delivery, the &[stat()]& function is run as root, but there is a
19350 facility for some checking of the accessibility of a file by another user.
19351 This is not a proper permissions check, but just a &"rough"& check that
19352 operates as follows:
19353
19354 If an item in a &%require_files%& list does not contain any forward slash
19355 characters, it is taken to be the user (and optional group, separated by a
19356 comma) to be checked for subsequent files in the list. If no group is specified
19357 but the user is specified symbolically, the gid associated with the uid is
19358 used. For example:
19359 .code
19360 require_files = mail:/some/file
19361 require_files = $local_part_data:$home/.procmailrc
19362 .endd
19363 If a user or group name in a &%require_files%& list does not exist, the
19364 &%require_files%& condition fails.
19365
19366 Exim performs the check by scanning along the components of the file path, and
19367 checking the access for the given uid and gid. It checks for &"x"& access on
19368 directories, and &"r"& access on the final file. Note that this means that file
19369 access control lists, if the operating system has them, are ignored.
19370
19371 &*Warning 1*&: When the router is being run to verify addresses for an
19372 incoming SMTP message, Exim is not running as root, but under its own uid. This
19373 may affect the result of a &%require_files%& check. In particular, &[stat()]&
19374 may yield the error EACCES (&"Permission denied"&). This means that the Exim
19375 user is not permitted to read one of the directories on the file's path.
19376
19377 &*Warning 2*&: Even when Exim is running as root while delivering a message,
19378 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
19379 without root access. In this case, if a check for access by a particular user
19380 is requested, Exim creates a subprocess that runs as that user, and tries the
19381 check again in that process.
19382
19383 The default action for handling an unresolved EACCES is to consider it to
19384 be caused by a configuration error, and routing is deferred because the
19385 existence or non-existence of the file cannot be determined. However, in some
19386 circumstances it may be desirable to treat this condition as if the file did
19387 not exist. If the filename (or the exclamation mark that precedes the filename
19388 for non-existence) is preceded by a plus sign, the EACCES error is treated
19389 as if the file did not exist. For example:
19390 .code
19391 require_files = +/some/file
19392 .endd
19393 If the router is not an essential part of verification (for example, it
19394 handles users' &_.forward_& files), another solution is to set the &%verify%&
19395 option false so that the router is skipped when verifying.
19396
19397
19398
19399 .option retry_use_local_part routers boolean "see below"
19400 .cindex "hints database" "retry keys"
19401 .cindex "local part" "in retry keys"
19402 When a delivery suffers a temporary routing failure, a retry record is created
19403 in Exim's hints database. For addresses whose routing depends only on the
19404 domain, the key for the retry record should not involve the local part, but for
19405 other addresses, both the domain and the local part should be included.
19406 Usually, remote routing is of the former kind, and local routing is of the
19407 latter kind.
19408
19409 This option controls whether the local part is used to form the key for retry
19410 hints for addresses that suffer temporary errors while being handled by this
19411 router. The default value is true for any router that has any of
19412 &%check_local_user%&,
19413 &%local_parts%&,
19414 &%condition%&,
19415 &%local_part_prefix%&,
19416 &%local_part_suffix%&,
19417 &%senders%& or
19418 &%require_files%&
19419 set, and false otherwise. Note that this option does not apply to hints keys
19420 for transport delays; they are controlled by a generic transport option of the
19421 same name.
19422
19423 Failing to set this option when it is needed
19424 (because a remote router handles only some of the local-parts for a domain)
19425 can result in incorrect error messages being generated.
19426
19427 The setting of &%retry_use_local_part%& applies only to the router on which it
19428 appears. If the router generates child addresses, they are routed
19429 independently; this setting does not become attached to them.
19430
19431
19432
19433 .option router_home_directory routers string&!! unset
19434 .cindex "router" "home directory for"
19435 .cindex "home directory" "for router"
19436 .vindex "&$home$&"
19437 This option sets a home directory for use while the router is running. (Compare
19438 &%transport_home_directory%&, which sets a home directory for later
19439 transporting.) In particular, if used on a &(redirect)& router, this option
19440 sets a value for &$home$& while a filter is running. The value is expanded;
19441 forced expansion failure causes the option to be ignored &-- other failures
19442 cause the router to defer.
19443
19444 Expansion of &%router_home_directory%& happens immediately after the
19445 &%check_local_user%& test (if configured), before any further expansions take
19446 place.
19447 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19448 are evaluated.)
19449 While the router is running, &%router_home_directory%& overrides the value of
19450 &$home$& that came from &%check_local_user%&.
19451
19452 When a router accepts an address and assigns it to a local transport (including
19453 the cases when a &(redirect)& router generates a pipe, file, or autoreply
19454 delivery), the home directory setting for the transport is taken from the first
19455 of these values that is set:
19456
19457 .ilist
19458 The &%home_directory%& option on the transport;
19459 .next
19460 The &%transport_home_directory%& option on the router;
19461 .next
19462 The password data if &%check_local_user%& is set on the router;
19463 .next
19464 The &%router_home_directory%& option on the router.
19465 .endlist
19466
19467 In other words, &%router_home_directory%& overrides the password data for the
19468 router, but not for the transport.
19469
19470
19471
19472 .option self routers string freeze
19473 .cindex "MX record" "pointing to local host"
19474 .cindex "local host" "MX pointing to"
19475 This option applies to those routers that use a recipient address to find a
19476 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
19477 and &(manualroute)& routers.
19478 Certain configurations of the &(queryprogram)& router can also specify a list
19479 of remote hosts.
19480 Usually such routers are configured to send the message to a remote host via an
19481 &(smtp)& transport. The &%self%& option specifies what happens when the first
19482 host on the list turns out to be the local host.
19483 The way in which Exim checks for the local host is described in section
19484 &<<SECTreclocipadd>>&.
19485
19486 Normally this situation indicates either an error in Exim's configuration (for
19487 example, the router should be configured not to process this domain), or an
19488 error in the DNS (for example, the MX should not point to this host). For this
19489 reason, the default action is to log the incident, defer the address, and
19490 freeze the message. The following alternatives are provided for use in special
19491 cases:
19492
19493 .vlist
19494 .vitem &%defer%&
19495 Delivery of the message is tried again later, but the message is not frozen.
19496
19497 .vitem "&%reroute%&: <&'domain'&>"
19498 The domain is changed to the given domain, and the address is passed back to
19499 be reprocessed by the routers. No rewriting of headers takes place. This
19500 behaviour is essentially a redirection.
19501
19502 .vitem "&%reroute: rewrite:%& <&'domain'&>"
19503 The domain is changed to the given domain, and the address is passed back to be
19504 reprocessed by the routers. Any headers that contain the original domain are
19505 rewritten.
19506
19507 .vitem &%pass%&
19508 .oindex "&%more%&"
19509 .vindex "&$self_hostname$&"
19510 The router passes the address to the next router, or to the router named in the
19511 &%pass_router%& option if it is set. This overrides &%no_more%&. During
19512 subsequent routing and delivery, the variable &$self_hostname$& contains the
19513 name of the local host that the router encountered. This can be used to
19514 distinguish between different cases for hosts with multiple names. The
19515 combination
19516 .code
19517 self = pass
19518 no_more
19519 .endd
19520 ensures that only those addresses that routed to the local host are passed on.
19521 Without &%no_more%&, addresses that were declined for other reasons would also
19522 be passed to the next router.
19523
19524 .vitem &%fail%&
19525 Delivery fails and an error report is generated.
19526
19527 .vitem &%send%&
19528 .cindex "local host" "sending to"
19529 The anomaly is ignored and the address is queued for the transport. This
19530 setting should be used with extreme caution. For an &(smtp)& transport, it
19531 makes sense only in cases where the program that is listening on the SMTP port
19532 is not this version of Exim. That is, it must be some other MTA, or Exim with a
19533 different configuration file that handles the domain in another way.
19534 .endlist
19535
19536
19537
19538 .option senders routers&!? "address list&!!" unset
19539 .cindex "router" "checking senders"
19540 If this option is set, the router is skipped unless the message's sender
19541 address matches something on the list.
19542 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19543 are evaluated.
19544
19545 There are issues concerning verification when the running of routers is
19546 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
19547 setting, it sets the sender to the null string. When using the &%-bt%& option
19548 to check a configuration file, it is necessary also to use the &%-f%& option to
19549 set an appropriate sender. For incoming mail, the sender is unset when
19550 verifying the sender, but is available when verifying any recipients. If the
19551 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
19552 matters.
19553
19554
19555 .option set routers "string list" unset
19556 .cindex router variables
19557 This option may be used multiple times on a router;
19558 because of this the list aspect is mostly irrelevant.
19559 The list separator is a semicolon but can be changed in the
19560 usual way.
19561
19562 Each list-element given must be of the form &"name = value"&
19563 and the names used must start with the string &"r_"&.
19564 Values containing a list-separator should have them doubled.
19565 When a router runs, the strings are evaluated in order,
19566 to create variables which are added to the set associated with
19567 the address.
19568 The variable is set with the expansion of the value.
19569 The variables can be used by the router options
19570 (not including any preconditions)
19571 and by the transport.
19572 Later definitions of a given named variable will override former ones.
19573 Variable use is via the usual &$r_...$& syntax.
19574
19575 This is similar to the &%address_data%& option, except that
19576 many independent variables can be used, with choice of naming.
19577
19578
19579 .option translate_ip_address routers string&!! unset
19580 .cindex "IP address" "translating"
19581 .cindex "packet radio"
19582 .cindex "router" "IP address translation"
19583 There exist some rare networking situations (for example, packet radio) where
19584 it is helpful to be able to translate IP addresses generated by normal routing
19585 mechanisms into other IP addresses, thus performing a kind of manual IP
19586 routing. This should be done only if the normal IP routing of the TCP/IP stack
19587 is inadequate or broken. Because this is an extremely uncommon requirement, the
19588 code to support this option is not included in the Exim binary unless
19589 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
19590
19591 .vindex "&$host_address$&"
19592 The &%translate_ip_address%& string is expanded for every IP address generated
19593 by the router, with the generated address set in &$host_address$&. If the
19594 expansion is forced to fail, no action is taken.
19595 For any other expansion error, delivery of the message is deferred.
19596 If the result of the expansion is an IP address, that replaces the original
19597 address; otherwise the result is assumed to be a host name &-- this is looked
19598 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
19599 produce one or more replacement IP addresses. For example, to subvert all IP
19600 addresses in some specific networks, this could be added to a router:
19601 .code
19602 translate_ip_address = \
19603   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
19604     {$value}fail}}
19605 .endd
19606 The file would contain lines like
19607 .code
19608 10.2.3.128/26    some.host
19609 10.8.4.34/26     10.44.8.15
19610 .endd
19611 You should not make use of this facility unless you really understand what you
19612 are doing.
19613
19614
19615
19616 .option transport routers string&!! unset
19617 This option specifies the transport to be used when a router accepts an address
19618 and sets it up for delivery. A transport is never needed if a router is used
19619 only for verification. The value of the option is expanded at routing time,
19620 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
19621 and result must be the name of one of the configured transports. If it is not,
19622 delivery is deferred.
19623
19624 The &%transport%& option is not used by the &(redirect)& router, but it does
19625 have some private options that set up transports for pipe and file deliveries
19626 (see chapter &<<CHAPredirect>>&).
19627
19628
19629
19630 .option transport_current_directory routers string&!! unset
19631 .cindex "current directory for local transport"
19632 This option associates a current directory with any address that is routed
19633 to a local transport. This can happen either because a transport is
19634 explicitly configured for the router, or because it generates a delivery to a
19635 file or a pipe. During the delivery process (that is, at transport time), this
19636 option string is expanded and is set as the current directory, unless
19637 overridden by a setting on the transport.
19638 If the expansion fails for any reason, including forced failure, an error is
19639 logged, and delivery is deferred.
19640 See chapter &<<CHAPenvironment>>& for details of the local delivery
19641 environment.
19642
19643
19644
19645
19646 .option transport_home_directory routers string&!! "see below"
19647 .cindex "home directory" "for local transport"
19648 This option associates a home directory with any address that is routed to a
19649 local transport. This can happen either because a transport is explicitly
19650 configured for the router, or because it generates a delivery to a file or a
19651 pipe. During the delivery process (that is, at transport time), the option
19652 string is expanded and is set as the home directory, unless overridden by a
19653 setting of &%home_directory%& on the transport.
19654 If the expansion fails for any reason, including forced failure, an error is
19655 logged, and delivery is deferred.
19656
19657 If the transport does not specify a home directory, and
19658 &%transport_home_directory%& is not set for the router, the home directory for
19659 the transport is taken from the password data if &%check_local_user%& is set for
19660 the router. Otherwise it is taken from &%router_home_directory%& if that option
19661 is set; if not, no home directory is set for the transport.
19662
19663 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19664 environment.
19665
19666
19667
19668
19669 .option unseen routers boolean&!! false
19670 .cindex "router" "carrying on after success"
19671 The result of string expansion for this option must be a valid boolean value,
19672 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19673 result causes an error, and delivery is deferred. If the expansion is forced to
19674 fail, the default value for the option (false) is used. Other failures cause
19675 delivery to be deferred.
19676
19677 When this option is set true, routing does not cease if the router accepts the
19678 address. Instead, a copy of the incoming address is passed to the next router,
19679 overriding a false setting of &%more%&. There is little point in setting
19680 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19681 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19682 sometimes true and sometimes false).
19683
19684 .cindex "copy of message (&%unseen%& option)"
19685 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19686 qualifier in filter files. It can be used to cause copies of messages to be
19687 delivered to some other destination, while also carrying out a normal delivery.
19688 In effect, the current address is made into a &"parent"& that has two children
19689 &-- one that is delivered as specified by this router, and a clone that goes on
19690 to be routed further. For this reason, &%unseen%& may not be combined with the
19691 &%one_time%& option in a &(redirect)& router.
19692
19693 &*Warning*&: Header lines added to the address (or specified for removal) by
19694 this router or by previous routers affect the &"unseen"& copy of the message
19695 only. The clone that continues to be processed by further routers starts with
19696 no added headers and none specified for removal. For a &%redirect%& router, if
19697 a generated address is the same as the incoming address, this can lead to
19698 duplicate addresses with different header modifications. Exim does not do
19699 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19700 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19701 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19702 &%redirect%& router may be of help.
19703
19704 Unlike the handling of header modifications, any data that was set by the
19705 &%address_data%& option in the current or previous routers &'is'& passed on to
19706 subsequent routers.
19707
19708
19709 .option user routers string&!! "see below"
19710 .cindex "uid (user id)" "local delivery"
19711 .cindex "local transports" "uid and gid"
19712 .cindex "transport" "local"
19713 .cindex "router" "user for filter processing"
19714 .cindex "filter" "user for processing"
19715 When a router queues an address for a transport, and the transport does not
19716 specify a user, the user given here is used when running the delivery process.
19717 The user may be specified numerically or by name. If expansion fails, the
19718 error is logged and delivery is deferred.
19719 This user is also used by the &(redirect)& router when running a filter file.
19720 The default is unset, except when &%check_local_user%& is set. In this case,
19721 the default is taken from the password information. If the user is specified as
19722 a name, and &%group%& is not set, the group associated with the user is used.
19723 See also &%initgroups%& and &%group%& and the discussion in chapter
19724 &<<CHAPenvironment>>&.
19725
19726
19727
19728 .option verify routers&!? boolean true
19729 Setting this option has the effect of setting &%verify_sender%& and
19730 &%verify_recipient%& to the same value.
19731
19732
19733 .option verify_only routers&!? boolean false
19734 .cindex "EXPN" "with &%verify_only%&"
19735 .oindex "&%-bv%&"
19736 .cindex "router" "used only when verifying"
19737 If this option is set, the router is used only when verifying an address,
19738 delivering in cutthrough mode or
19739 testing with the &%-bv%& option, not when actually doing a delivery, testing
19740 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19741 restricted to verifying only senders or recipients by means of
19742 &%verify_sender%& and &%verify_recipient%&.
19743
19744 &*Warning*&: When the router is being run to verify addresses for an incoming
19745 SMTP message, Exim is not running as root, but under its own uid. If the router
19746 accesses any files, you need to make sure that they are accessible to the Exim
19747 user or group.
19748
19749
19750 .option verify_recipient routers&!? boolean true
19751 If this option is false, the router is skipped when verifying recipient
19752 addresses,
19753 delivering in cutthrough mode
19754 or testing recipient verification using &%-bv%&.
19755 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19756 are evaluated.
19757 See also the &$verify_mode$& variable.
19758
19759
19760 .option verify_sender routers&!? boolean true
19761 If this option is false, the router is skipped when verifying sender addresses
19762 or testing sender verification using &%-bvs%&.
19763 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19764 are evaluated.
19765 See also the &$verify_mode$& variable.
19766 .ecindex IIDgenoprou1
19767 .ecindex IIDgenoprou2
19768
19769
19770
19771
19772
19773
19774 . ////////////////////////////////////////////////////////////////////////////
19775 . ////////////////////////////////////////////////////////////////////////////
19776
19777 .chapter "The accept router" "CHID4"
19778 .cindex "&(accept)& router"
19779 .cindex "routers" "&(accept)&"
19780 The &(accept)& router has no private options of its own. Unless it is being
19781 used purely for verification (see &%verify_only%&) a transport is required to
19782 be defined by the generic &%transport%& option. If the preconditions that are
19783 specified by generic options are met, the router accepts the address and queues
19784 it for the given transport. The most common use of this router is for setting
19785 up deliveries to local mailboxes. For example:
19786 .code
19787 localusers:
19788   driver = accept
19789   domains = mydomain.example
19790   check_local_user
19791   transport = local_delivery
19792 .endd
19793 The &%domains%& condition in this example checks the domain of the address, and
19794 &%check_local_user%& checks that the local part is the login of a local user.
19795 When both preconditions are met, the &(accept)& router runs, and queues the
19796 address for the &(local_delivery)& transport.
19797
19798
19799
19800
19801
19802
19803 . ////////////////////////////////////////////////////////////////////////////
19804 . ////////////////////////////////////////////////////////////////////////////
19805
19806 .chapter "The dnslookup router" "CHAPdnslookup"
19807 .scindex IIDdnsrou1 "&(dnslookup)& router"
19808 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19809 The &(dnslookup)& router looks up the hosts that handle mail for the
19810 recipient's domain in the DNS. A transport must always be set for this router,
19811 unless &%verify_only%& is set.
19812
19813 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19814 SRV records. If none are found, or if SRV support is not configured,
19815 MX records are looked up. If no MX records exist, address records are sought.
19816 However, &%mx_domains%& can be set to disable the direct use of address
19817 records.
19818
19819 MX records of equal priority are sorted by Exim into a random order. Exim then
19820 looks for address records for the host names obtained from MX or SRV records.
19821 When a host has more than one IP address, they are sorted into a random order,
19822 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19823 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19824 generic option, the router declines.
19825
19826 Unless they have the highest priority (lowest MX value), MX records that point
19827 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19828 are discarded, together with any other MX records of equal or lower priority.
19829
19830 .cindex "MX record" "pointing to local host"
19831 .cindex "local host" "MX pointing to"
19832 .oindex "&%self%&" "in &(dnslookup)& router"
19833 If the host pointed to by the highest priority MX record, or looked up as an
19834 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19835 happens is controlled by the generic &%self%& option.
19836
19837
19838 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19839 There have been problems with DNS servers when SRV records are looked up.
19840 Some misbehaving servers return a DNS error or timeout when a non-existent
19841 SRV record is sought. Similar problems have in the past been reported for
19842 MX records. The global &%dns_again_means_nonexist%& option can help with this
19843 problem, but it is heavy-handed because it is a global option.
19844
19845 For this reason, there are two options, &%srv_fail_domains%& and
19846 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19847 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19848 an attempt to look up an SRV or MX record causes one of these results, and the
19849 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19850 such record"&. In the case of an SRV lookup, this means that the router
19851 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19852 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19853 case routing fails.
19854
19855
19856 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19857 .cindex "&(dnslookup)& router" "declines"
19858 There are a few cases where a &(dnslookup)& router will decline to accept
19859 an address; if such a router is expected to handle "all remaining non-local
19860 domains", then it is important to set &%no_more%&.
19861
19862 The router will defer rather than decline if the domain
19863 is found in the &%fail_defer_domains%& router option.
19864
19865 Reasons for a &(dnslookup)& router to decline currently include:
19866 .ilist
19867 The domain does not exist in DNS
19868 .next
19869 The domain exists but the MX record's host part is just "."; this is a common
19870 convention (borrowed from SRV) used to indicate that there is no such service
19871 for this domain and to not fall back to trying A/AAAA records.
19872 .next
19873 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19874 .next
19875 MX record points to a non-existent host.
19876 .next
19877 MX record points to an IP address and the main section option
19878 &%allow_mx_to_ip%& is not set.
19879 .next
19880 MX records exist and point to valid hosts, but all hosts resolve only to
19881 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19882 .next
19883 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19884 &%dns_check_names_pattern%& for handling one variant of this)
19885 .next
19886 &%check_secondary_mx%& is set on this router but the local host can
19887 not be found in the MX records (see below)
19888 .endlist
19889
19890
19891
19892
19893 .section "Private options for dnslookup" "SECID118"
19894 .cindex "options" "&(dnslookup)& router"
19895 The private options for the &(dnslookup)& router are as follows:
19896
19897 .option check_secondary_mx dnslookup boolean false
19898 .cindex "MX record" "checking for secondary"
19899 If this option is set, the router declines unless the local host is found in
19900 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19901 process domains for which the local host is a secondary mail exchanger
19902 differently to other domains. The way in which Exim decides whether a host is
19903 the local host is described in section &<<SECTreclocipadd>>&.
19904
19905
19906 .option check_srv dnslookup string&!! unset
19907 .cindex "SRV record" "enabling use of"
19908 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19909 addition to MX and address records. The support is disabled by default. To
19910 enable SRV support, set the &%check_srv%& option to the name of the service
19911 required. For example,
19912 .code
19913 check_srv = smtp
19914 .endd
19915 looks for SRV records that refer to the normal smtp service. The option is
19916 expanded, so the service name can vary from message to message or address
19917 to address. This might be helpful if SRV records are being used for a
19918 submission service. If the expansion is forced to fail, the &%check_srv%&
19919 option is ignored, and the router proceeds to look for MX records in the
19920 normal way.
19921
19922 When the expansion succeeds, the router searches first for SRV records for
19923 the given service (it assumes TCP protocol). A single SRV record with a
19924 host name that consists of just a single dot indicates &"no such service for
19925 this domain"&; if this is encountered, the router declines. If other kinds of
19926 SRV record are found, they are used to construct a host list for delivery
19927 according to the rules of RFC 2782. MX records are not sought in this case.
19928
19929 When no SRV records are found, MX records (and address records) are sought in
19930 the traditional way. In other words, SRV records take precedence over MX
19931 records, just as MX records take precedence over address records. Note that
19932 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19933 defined it. It is apparently believed that MX records are sufficient for email
19934 and that SRV records should not be used for this purpose. However, SRV records
19935 have an additional &"weight"& feature which some people might find useful when
19936 trying to split an SMTP load between hosts of different power.
19937
19938 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19939 when there is a DNS lookup error.
19940
19941
19942
19943
19944 .option fail_defer_domains dnslookup "domain list&!!" unset
19945 .cindex "MX record" "not found"
19946 DNS lookups for domains matching &%fail_defer_domains%&
19947 which find no matching record will cause the router to defer
19948 rather than the default behaviour of decline.
19949 This maybe be useful for queueing messages for a newly created
19950 domain while the DNS configuration is not ready.
19951 However, it will result in any message with mistyped domains
19952 also being queued.
19953
19954
19955 .option ipv4_only "string&!!" unset
19956 .cindex IPv6 disabling
19957 .cindex DNS "IPv6 disabling"
19958 The string is expanded, and if the result is anything but a forced failure,
19959 or an empty string, or one of the strings “0” or “no” or “false”
19960 (checked without regard to the case of the letters),
19961 only A records are used.
19962
19963 .option ipv4_prefer "string&!!" unset
19964 .cindex IPv4 preference
19965 .cindex DNS "IPv4 preference"
19966 The string is expanded, and if the result is anything but a forced failure,
19967 or an empty string, or one of the strings “0” or “no” or “false”
19968 (checked without regard to the case of the letters),
19969 A records are sorted before AAAA records (inverting the default).
19970
19971 .option mx_domains dnslookup "domain list&!!" unset
19972 .cindex "MX record" "required to exist"
19973 .cindex "SRV record" "required to exist"
19974 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19975 record in order to be recognized. (The name of this option could be improved.)
19976 For example, if all the mail hosts in &'fict.example'& are known to have MX
19977 records, except for those in &'discworld.fict.example'&, you could use this
19978 setting:
19979 .code
19980 mx_domains = ! *.discworld.fict.example : *.fict.example
19981 .endd
19982 This specifies that messages addressed to a domain that matches the list but
19983 has no MX record should be bounced immediately instead of being routed using
19984 the address record.
19985
19986
19987 .option mx_fail_domains dnslookup "domain list&!!" unset
19988 If the DNS lookup for MX records for one of the domains in this list causes a
19989 DNS lookup error, Exim behaves as if no MX records were found. See section
19990 &<<SECTprowitdnsloo>>& for more discussion.
19991
19992
19993
19994
19995 .option qualify_single dnslookup boolean true
19996 .cindex "DNS" "resolver options"
19997 .cindex "DNS" "qualifying single-component names"
19998 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19999 lookups. Typically, but not standardly, this causes the resolver to qualify
20000 single-component names with the default domain. For example, on a machine
20001 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
20002 &'thesaurus.ref.example'& inside the resolver. For details of what your
20003 resolver actually does, consult your man pages for &'resolver'& and
20004 &'resolv.conf'&.
20005
20006
20007
20008 .option rewrite_headers dnslookup boolean true
20009 .cindex "rewriting" "header lines"
20010 .cindex "header lines" "rewriting"
20011 If the domain name in the address that is being processed is not fully
20012 qualified, it may be expanded to its full form by a DNS lookup. For example, if
20013 an address is specified as &'dormouse@teaparty'&, the domain might be
20014 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
20015 occur as a result of setting the &%widen_domains%& option. If
20016 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
20017 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
20018 header lines of the message are rewritten with the full domain name.
20019
20020 This option should be turned off only when it is known that no message is
20021 ever going to be sent outside an environment where the abbreviation makes
20022 sense.
20023
20024 When an MX record is looked up in the DNS and matches a wildcard record, name
20025 servers normally return a record containing the name that has been looked up,
20026 making it impossible to detect whether a wildcard was present or not. However,
20027 some name servers have recently been seen to return the wildcard entry. If the
20028 name returned by a DNS lookup begins with an asterisk, it is not used for
20029 header rewriting.
20030
20031
20032 .option same_domain_copy_routing dnslookup boolean false
20033 .cindex "address" "copying routing"
20034 Addresses with the same domain are normally routed by the &(dnslookup)& router
20035 to the same list of hosts. However, this cannot be presumed, because the router
20036 options and preconditions may refer to the local part of the address. By
20037 default, therefore, Exim routes each address in a message independently. DNS
20038 servers run caches, so repeated DNS lookups are not normally expensive, and in
20039 any case, personal messages rarely have more than a few recipients.
20040
20041 If you are running mailing lists with large numbers of subscribers at the same
20042 domain, and you are using a &(dnslookup)& router which is independent of the
20043 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20044 lookups for identical domains in one message. In this case, when &(dnslookup)&
20045 routes an address to a remote transport, any other unrouted addresses in the
20046 message that have the same domain are automatically given the same routing
20047 without processing them independently,
20048 provided the following conditions are met:
20049
20050 .ilist
20051 No router that processed the address specified &%headers_add%& or
20052 &%headers_remove%&.
20053 .next
20054 The router did not change the address in any way, for example, by &"widening"&
20055 the domain.
20056 .endlist
20057
20058
20059
20060
20061 .option search_parents dnslookup boolean false
20062 .cindex "DNS" "resolver options"
20063 When this option is true, the resolver option RES_DNSRCH is set for DNS
20064 lookups. This is different from the &%qualify_single%& option in that it
20065 applies to domains containing dots. Typically, but not standardly, it causes
20066 the resolver to search for the name in the current domain and in parent
20067 domains. For example, on a machine in the &'fict.example'& domain, if looking
20068 up &'teaparty.wonderland'& failed, the resolver would try
20069 &'teaparty.wonderland.fict.example'&. For details of what your resolver
20070 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
20071
20072 Setting this option true can cause problems in domains that have a wildcard MX
20073 record, because any domain that does not have its own MX record matches the
20074 local wildcard.
20075
20076
20077
20078 .option srv_fail_domains dnslookup "domain list&!!" unset
20079 If the DNS lookup for SRV records for one of the domains in this list causes a
20080 DNS lookup error, Exim behaves as if no SRV records were found. See section
20081 &<<SECTprowitdnsloo>>& for more discussion.
20082
20083
20084
20085
20086 .option widen_domains dnslookup "string list" unset
20087 .cindex "domain" "partial; widening"
20088 If a DNS lookup fails and this option is set, each of its strings in turn is
20089 added onto the end of the domain, and the lookup is tried again. For example,
20090 if
20091 .code
20092 widen_domains = fict.example:ref.example
20093 .endd
20094 is set and a lookup of &'klingon.dictionary'& fails,
20095 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
20096 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
20097 and &%search_parents%& options can cause some widening to be undertaken inside
20098 the DNS resolver. &%widen_domains%& is not applied to sender addresses
20099 when verifying, unless &%rewrite_headers%& is false (not the default).
20100
20101
20102 .section "Effect of qualify_single and search_parents" "SECID119"
20103 When a domain from an envelope recipient is changed by the resolver as a result
20104 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
20105 corresponding address in the message's header lines unless &%rewrite_headers%&
20106 is set false. Exim then re-routes the address, using the full domain.
20107
20108 These two options affect only the DNS lookup that takes place inside the router
20109 for the domain of the address that is being routed. They do not affect lookups
20110 such as that implied by
20111 .code
20112 domains = @mx_any
20113 .endd
20114 that may happen while processing a router precondition before the router is
20115 entered. No widening ever takes place for these lookups.
20116 .ecindex IIDdnsrou1
20117 .ecindex IIDdnsrou2
20118
20119
20120
20121
20122
20123
20124
20125
20126
20127 . ////////////////////////////////////////////////////////////////////////////
20128 . ////////////////////////////////////////////////////////////////////////////
20129
20130 .chapter "The ipliteral router" "CHID5"
20131 .cindex "&(ipliteral)& router"
20132 .cindex "domain literal" "routing"
20133 .cindex "routers" "&(ipliteral)&"
20134 This router has no private options. Unless it is being used purely for
20135 verification (see &%verify_only%&) a transport is required to be defined by the
20136 generic &%transport%& option. The router accepts the address if its domain part
20137 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
20138 router handles the address
20139 .code
20140 root@[192.168.1.1]
20141 .endd
20142 by setting up delivery to the host with that IP address. IPv4 domain literals
20143 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
20144 are similar, but the address is preceded by &`ipv6:`&. For example:
20145 .code
20146 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
20147 .endd
20148 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
20149 grounds that sooner or later somebody will try it.
20150
20151 .oindex "&%self%&" "in &(ipliteral)& router"
20152 If the IP address matches something in &%ignore_target_hosts%&, the router
20153 declines. If an IP literal turns out to refer to the local host, the generic
20154 &%self%& option determines what happens.
20155
20156 The RFCs require support for domain literals; however, their use is
20157 controversial in today's Internet. If you want to use this router, you must
20158 also set the main configuration option &%allow_domain_literals%&. Otherwise,
20159 Exim will not recognize the domain literal syntax in addresses.
20160
20161
20162
20163 . ////////////////////////////////////////////////////////////////////////////
20164 . ////////////////////////////////////////////////////////////////////////////
20165
20166 .chapter "The iplookup router" "CHID6"
20167 .cindex "&(iplookup)& router"
20168 .cindex "routers" "&(iplookup)&"
20169 The &(iplookup)& router was written to fulfil a specific requirement in
20170 Cambridge University (which in fact no longer exists). For this reason, it is
20171 not included in the binary of Exim by default. If you want to include it, you
20172 must set
20173 .code
20174 ROUTER_IPLOOKUP=yes
20175 .endd
20176 in your &_Local/Makefile_& configuration file.
20177
20178 The &(iplookup)& router routes an address by sending it over a TCP or UDP
20179 connection to one or more specific hosts. The host can then return the same or
20180 a different address &-- in effect rewriting the recipient address in the
20181 message's envelope. The new address is then passed on to subsequent routers. If
20182 this process fails, the address can be passed on to other routers, or delivery
20183 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
20184 must not be specified for it.
20185
20186 .cindex "options" "&(iplookup)& router"
20187 .option hosts iplookup string unset
20188 This option must be supplied. Its value is a colon-separated list of host
20189 names. The hosts are looked up using &[gethostbyname()]&
20190 (or &[getipnodebyname()]& when available)
20191 and are tried in order until one responds to the query. If none respond, what
20192 happens is controlled by &%optional%&.
20193
20194
20195 .option optional iplookup boolean false
20196 If &%optional%& is true, if no response is obtained from any host, the address
20197 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
20198 delivery to the address is deferred.
20199
20200
20201 .option port iplookup integer 0
20202 .cindex "port" "&(iplookup)& router"
20203 This option must be supplied. It specifies the port number for the TCP or UDP
20204 call.
20205
20206
20207 .option protocol iplookup string udp
20208 This option can be set to &"udp"& or &"tcp"& to specify which of the two
20209 protocols is to be used.
20210
20211
20212 .option query iplookup string&!! "see below"
20213 This defines the content of the query that is sent to the remote hosts. The
20214 default value is:
20215 .code
20216 $local_part@$domain $local_part@$domain
20217 .endd
20218 The repetition serves as a way of checking that a response is to the correct
20219 query in the default case (see &%response_pattern%& below).
20220
20221
20222 .option reroute iplookup string&!! unset
20223 If this option is not set, the rerouted address is precisely the byte string
20224 returned by the remote host, up to the first white space, if any. If set, the
20225 string is expanded to form the rerouted address. It can include parts matched
20226 in the response by &%response_pattern%& by means of numeric variables such as
20227 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
20228 whether or not a pattern is in use. In all cases, the rerouted address must end
20229 up in the form &'local_part@domain'&.
20230
20231
20232 .option response_pattern iplookup string unset
20233 This option can be set to a regular expression that is applied to the string
20234 returned from the remote host. If the pattern does not match the response, the
20235 router declines. If &%response_pattern%& is not set, no checking of the
20236 response is done, unless the query was defaulted, in which case there is a
20237 check that the text returned after the first white space is the original
20238 address. This checks that the answer that has been received is in response to
20239 the correct question. For example, if the response is just a new domain, the
20240 following could be used:
20241 .code
20242 response_pattern = ^([^@]+)$
20243 reroute = $local_part@$1
20244 .endd
20245
20246 .option timeout iplookup time 5s
20247 This specifies the amount of time to wait for a response from the remote
20248 machine. The same timeout is used for the &[connect()]& function for a TCP
20249 call. It does not apply to UDP.
20250
20251
20252
20253
20254 . ////////////////////////////////////////////////////////////////////////////
20255 . ////////////////////////////////////////////////////////////////////////////
20256
20257 .chapter "The manualroute router" "CHID7"
20258 .scindex IIDmanrou1 "&(manualroute)& router"
20259 .scindex IIDmanrou2 "routers" "&(manualroute)&"
20260 .cindex "domain" "manually routing"
20261 The &(manualroute)& router is so-called because it provides a way of manually
20262 routing an address according to its domain. It is mainly used when you want to
20263 route addresses to remote hosts according to your own rules, bypassing the
20264 normal DNS routing that looks up MX records. However, &(manualroute)& can also
20265 route to local transports, a facility that may be useful if you want to save
20266 messages for dial-in hosts in local files.
20267
20268 The &(manualroute)& router compares a list of domain patterns with the domain
20269 it is trying to route. If there is no match, the router declines. Each pattern
20270 has associated with it a list of hosts and some other optional data, which may
20271 include a transport. The combination of a pattern and its data is called a
20272 &"routing rule"&. For patterns that do not have an associated transport, the
20273 generic &%transport%& option must specify a transport, unless the router is
20274 being used purely for verification (see &%verify_only%&).
20275
20276 .vindex "&$host$&"
20277 In the case of verification, matching the domain pattern is sufficient for the
20278 router to accept the address. When actually routing an address for delivery,
20279 an address that matches a domain pattern is queued for the associated
20280 transport. If the transport is not a local one, a host list must be associated
20281 with the pattern; IP addresses are looked up for the hosts, and these are
20282 passed to the transport along with the mail address. For local transports, a
20283 host list is optional. If it is present, it is passed in &$host$& as a single
20284 text string.
20285
20286 The list of routing rules can be provided as an inline string in
20287 &%route_list%&, or the data can be obtained by looking up the domain in a file
20288 or database by setting &%route_data%&. Only one of these settings may appear in
20289 any one instance of &(manualroute)&. The format of routing rules is described
20290 below, following the list of private options.
20291
20292
20293 .section "Private options for manualroute" "SECTprioptman"
20294
20295 .cindex "options" "&(manualroute)& router"
20296 The private options for the &(manualroute)& router are as follows:
20297
20298 .option host_all_ignored manualroute string defer
20299 See &%host_find_failed%&.
20300
20301 .option host_find_failed manualroute string freeze
20302 This option controls what happens when &(manualroute)& tries to find an IP
20303 address for a host, and the host does not exist. The option can be set to one
20304 of the following values:
20305 .code
20306 decline
20307 defer
20308 fail
20309 freeze
20310 ignore
20311 pass
20312 .endd
20313 The default (&"freeze"&) assumes that this state is a serious configuration
20314 error. The difference between &"pass"& and &"decline"& is that the former
20315 forces the address to be passed to the next router (or the router defined by
20316 &%pass_router%&),
20317 .oindex "&%more%&"
20318 overriding &%no_more%&, whereas the latter passes the address to the next
20319 router only if &%more%& is true.
20320
20321 The value &"ignore"& causes Exim to completely ignore a host whose IP address
20322 cannot be found. If all the hosts in the list are ignored, the behaviour is
20323 controlled by the &%host_all_ignored%& option. This takes the same values
20324 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
20325
20326 The &%host_find_failed%& option applies only to a definite &"does not exist"&
20327 state; if a host lookup gets a temporary error, delivery is deferred unless the
20328 generic &%pass_on_timeout%& option is set.
20329
20330
20331 .option hosts_randomize manualroute boolean false
20332 .cindex "randomized host list"
20333 .cindex "host" "list of; randomized"
20334 If this option is set, the order of the items in a host list in a routing rule
20335 is randomized each time the list is used, unless an option in the routing rule
20336 overrides (see below). Randomizing the order of a host list can be used to do
20337 crude load sharing. However, if more than one mail address is routed by the
20338 same router to the same host list, the host lists are considered to be the same
20339 (even though they may be randomized into different orders) for the purpose of
20340 deciding whether to batch the deliveries into a single SMTP transaction.
20341
20342 When &%hosts_randomize%& is true, a host list may be split
20343 into groups whose order is separately randomized. This makes it possible to
20344 set up MX-like behaviour. The boundaries between groups are indicated by an
20345 item that is just &`+`& in the host list. For example:
20346 .code
20347 route_list = * host1:host2:host3:+:host4:host5
20348 .endd
20349 The order of the first three hosts and the order of the last two hosts is
20350 randomized for each use, but the first three always end up before the last two.
20351 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
20352 randomized host list is passed to an &(smtp)& transport that also has
20353 &%hosts_randomize set%&, the list is not re-randomized.
20354
20355
20356 .option route_data manualroute string&!! unset
20357 If this option is set, it must expand to yield the data part of a routing rule.
20358 Typically, the expansion string includes a lookup based on the domain. For
20359 example:
20360 .code
20361 route_data = ${lookup{$domain}dbm{/etc/routes}}
20362 .endd
20363 If the expansion is forced to fail, or the result is an empty string, the
20364 router declines. Other kinds of expansion failure cause delivery to be
20365 deferred.
20366
20367
20368 .option route_list manualroute "string list" unset
20369 This string is a list of routing rules, in the form defined below. Note that,
20370 unlike most string lists, the items are separated by semicolons. This is so
20371 that they may contain colon-separated host lists.
20372
20373
20374 .option same_domain_copy_routing manualroute boolean false
20375 .cindex "address" "copying routing"
20376 Addresses with the same domain are normally routed by the &(manualroute)&
20377 router to the same list of hosts. However, this cannot be presumed, because the
20378 router options and preconditions may refer to the local part of the address. By
20379 default, therefore, Exim routes each address in a message independently. DNS
20380 servers run caches, so repeated DNS lookups are not normally expensive, and in
20381 any case, personal messages rarely have more than a few recipients.
20382
20383 If you are running mailing lists with large numbers of subscribers at the same
20384 domain, and you are using a &(manualroute)& router which is independent of the
20385 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
20386 lookups for identical domains in one message. In this case, when
20387 &(manualroute)& routes an address to a remote transport, any other unrouted
20388 addresses in the message that have the same domain are automatically given the
20389 same routing without processing them independently. However, this is only done
20390 if &%headers_add%& and &%headers_remove%& are unset.
20391
20392
20393
20394
20395 .section "Routing rules in route_list" "SECID120"
20396 The value of &%route_list%& is a string consisting of a sequence of routing
20397 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
20398 entered as two semicolons. Alternatively, the list separator can be changed as
20399 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
20400 Empty rules are ignored. The format of each rule is
20401 .display
20402 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
20403 .endd
20404 The following example contains two rules, each with a simple domain pattern and
20405 no options:
20406 .code
20407 route_list = \
20408   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
20409   thes.ref.example  mail-3.ref.example:mail-4.ref.example
20410 .endd
20411 The three parts of a rule are separated by white space. The pattern and the
20412 list of hosts can be enclosed in quotes if necessary, and if they are, the
20413 usual quoting rules apply. Each rule in a &%route_list%& must start with a
20414 single domain pattern, which is the only mandatory item in the rule. The
20415 pattern is in the same format as one item in a domain list (see section
20416 &<<SECTdomainlist>>&),
20417 except that it may not be the name of an interpolated file.
20418 That is, it may be wildcarded, or a regular expression, or a file or database
20419 lookup (with semicolons doubled, because of the use of semicolon as a separator
20420 in a &%route_list%&).
20421
20422 The rules in &%route_list%& are searched in order until one of the patterns
20423 matches the domain that is being routed. The list of hosts and then options are
20424 then used as described below. If there is no match, the router declines. When
20425 &%route_list%& is set, &%route_data%& must not be set.
20426
20427
20428
20429 .section "Routing rules in route_data" "SECID121"
20430 The use of &%route_list%& is convenient when there are only a small number of
20431 routing rules. For larger numbers, it is easier to use a file or database to
20432 hold the routing information, and use the &%route_data%& option instead.
20433 The value of &%route_data%& is a list of hosts, followed by (optional) options.
20434 Most commonly, &%route_data%& is set as a string that contains an
20435 expansion lookup. For example, suppose we place two routing rules in a file
20436 like this:
20437 .code
20438 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
20439 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
20440 .endd
20441 This data can be accessed by setting
20442 .code
20443 route_data = ${lookup{$domain}lsearch{/the/file/name}}
20444 .endd
20445 Failure of the lookup results in an empty string, causing the router to
20446 decline. However, you do not have to use a lookup in &%route_data%&. The only
20447 requirement is that the result of expanding the string is a list of hosts,
20448 possibly followed by options, separated by white space. The list of hosts must
20449 be enclosed in quotes if it contains white space.
20450
20451
20452
20453
20454 .section "Format of the list of hosts" "SECID122"
20455 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
20456 always separately expanded before use. If the expansion fails, the router
20457 declines. The result of the expansion must be a colon-separated list of names
20458 and/or IP addresses, optionally also including ports.
20459 If the list is written with spaces, it must be protected with quotes.
20460 The format of each item
20461 in the list is described in the next section. The list separator can be changed
20462 as described in section &<<SECTlistsepchange>>&.
20463
20464 If the list of hosts was obtained from a &%route_list%& item, the following
20465 variables are set during its expansion:
20466
20467 .ilist
20468 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
20469 If the domain was matched against a regular expression, the numeric variables
20470 &$1$&, &$2$&, etc. may be set. For example:
20471 .code
20472 route_list = ^domain(\d+)   host-$1.text.example
20473 .endd
20474 .next
20475 &$0$& is always set to the entire domain.
20476 .next
20477 &$1$& is also set when partial matching is done in a file lookup.
20478
20479 .next
20480 .vindex "&$value$&"
20481 If the pattern that matched the domain was a lookup item, the data that was
20482 looked up is available in the expansion variable &$value$&. For example:
20483 .code
20484 route_list = lsearch;;/some/file.routes  $value
20485 .endd
20486 .endlist
20487
20488 Note the doubling of the semicolon in the pattern that is necessary because
20489 semicolon is the default route list separator.
20490
20491
20492
20493 .section "Format of one host item" "SECTformatonehostitem"
20494 Each item in the list of hosts can be either a host name or an IP address,
20495 optionally with an attached port number, or it can be a single "+"
20496 (see &%hosts_randomize%&).
20497 When no port is given, an IP address
20498 is not enclosed in brackets. When a port is specified, it overrides the port
20499 specification on the transport. The port is separated from the name or address
20500 by a colon. This leads to some complications:
20501
20502 .ilist
20503 Because colon is the default separator for the list of hosts, either
20504 the colon that specifies a port must be doubled, or the list separator must
20505 be changed. The following two examples have the same effect:
20506 .code
20507 route_list = * "host1.tld::1225 : host2.tld::1226"
20508 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
20509 .endd
20510 .next
20511 When IPv6 addresses are involved, it gets worse, because they contain
20512 colons of their own. To make this case easier, it is permitted to
20513 enclose an IP address (either v4 or v6) in square brackets if a port
20514 number follows. For example:
20515 .code
20516 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
20517 .endd
20518 .endlist
20519
20520 .section "How the list of hosts is used" "SECThostshowused"
20521 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
20522 the hosts is tried, in the order specified, when carrying out the SMTP
20523 delivery. However, the order can be changed by setting the &%hosts_randomize%&
20524 option, either on the router (see section &<<SECTprioptman>>& above), or on the
20525 transport.
20526
20527 Hosts may be listed by name or by IP address. An unadorned name in the list of
20528 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
20529 interpreted as an indirection to a sublist of hosts obtained by looking up MX
20530 records in the DNS. For example:
20531 .code
20532 route_list = *  x.y.z:p.q.r/MX:e.f.g
20533 .endd
20534 If this feature is used with a port specifier, the port must come last. For
20535 example:
20536 .code
20537 route_list = *  dom1.tld/mx::1225
20538 .endd
20539 If the &%hosts_randomize%& option is set, the order of the items in the list is
20540 randomized before any lookups are done. Exim then scans the list; for any name
20541 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
20542 be an interface on the local host and the item is not the first in the list,
20543 Exim discards it and any subsequent items. If it is the first item, what
20544 happens is controlled by the
20545 .oindex "&%self%&" "in &(manualroute)& router"
20546 &%self%& option of the router.
20547
20548 A name on the list that is followed by &`/MX`& is replaced with the list of
20549 hosts obtained by looking up MX records for the name. This is always a DNS
20550 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
20551 below) are not relevant here. The order of these hosts is determined by the
20552 preference values in the MX records, according to the usual rules. Because
20553 randomizing happens before the MX lookup, it does not affect the order that is
20554 defined by MX preferences.
20555
20556 If the local host is present in the sublist obtained from MX records, but is
20557 not the most preferred host in that list, it and any equally or less
20558 preferred hosts are removed before the sublist is inserted into the main list.
20559
20560 If the local host is the most preferred host in the MX list, what happens
20561 depends on where in the original list of hosts the &`/MX`& item appears. If it
20562 is not the first item (that is, there are previous hosts in the main list),
20563 Exim discards this name and any subsequent items in the main list.
20564
20565 If the MX item is first in the list of hosts, and the local host is the
20566 most preferred host, what happens is controlled by the &%self%& option of the
20567 router.
20568
20569 DNS failures when lookup up the MX records are treated in the same way as DNS
20570 failures when looking up IP addresses: &%pass_on_timeout%& and
20571 &%host_find_failed%& are used when relevant.
20572
20573 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
20574 whether obtained from an MX lookup or not.
20575
20576
20577
20578 .section "How the options are used" "SECThowoptused"
20579 The options are a sequence of words, space-separated.
20580 One of the words can be the name of a transport; this overrides the
20581 &%transport%& option on the router for this particular routing rule only. The
20582 other words (if present) control randomization of the list of hosts on a
20583 per-rule basis, and how the IP addresses of the hosts are to be found when
20584 routing to a remote transport. These options are as follows:
20585
20586 .ilist
20587 &%randomize%&: randomize the order of the hosts in this list, overriding the
20588 setting of &%hosts_randomize%& for this routing rule only.
20589 .next
20590 &%no_randomize%&: do not randomize the order of the hosts in this list,
20591 overriding the setting of &%hosts_randomize%& for this routing rule only.
20592 .next
20593 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
20594 find IP addresses. This function may ultimately cause a DNS lookup, but it may
20595 also look in &_/etc/hosts_& or other sources of information.
20596 .next
20597 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
20598 no address records are found. If there is a temporary DNS error (such as a
20599 timeout), delivery is deferred.
20600 .next
20601 &%ipv4_only%&: in direct DNS lookups, look up only A records.
20602 .next
20603 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
20604 .endlist
20605
20606 For example:
20607 .code
20608 route_list = domain1  host1:host2:host3  randomize bydns;\
20609              domain2  host4:host5
20610 .endd
20611 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
20612 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
20613 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
20614 or &[gethostbyname()]&, and the result of the lookup is the result of that
20615 call.
20616
20617 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
20618 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
20619 instead of TRY_AGAIN. That is why the default action is to try a DNS
20620 lookup first. Only if that gives a definite &"no such host"& is the local
20621 function called.
20622
20623 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
20624 inadvertent constraint that a transport name as an option had to be the last
20625 option specified.
20626
20627
20628
20629 If no IP address for a host can be found, what happens is controlled by the
20630 &%host_find_failed%& option.
20631
20632 .vindex "&$host$&"
20633 When an address is routed to a local transport, IP addresses are not looked up.
20634 The host list is passed to the transport in the &$host$& variable.
20635
20636
20637
20638 .section "Manualroute examples" "SECID123"
20639 In some of the examples that follow, the presence of the &%remote_smtp%&
20640 transport, as defined in the default configuration file, is assumed:
20641
20642 .ilist
20643 .cindex "smart host" "example router"
20644 The &(manualroute)& router can be used to forward all external mail to a
20645 &'smart host'&. If you have set up, in the main part of the configuration, a
20646 named domain list that contains your local domains, for example:
20647 .code
20648 domainlist local_domains = my.domain.example
20649 .endd
20650 You can arrange for all other domains to be routed to a smart host by making
20651 your first router something like this:
20652 .code
20653 smart_route:
20654   driver = manualroute
20655   domains = !+local_domains
20656   transport = remote_smtp
20657   route_list = * smarthost.ref.example
20658 .endd
20659 This causes all non-local addresses to be sent to the single host
20660 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20661 they are tried in order
20662 (but you can use &%hosts_randomize%& to vary the order each time).
20663 Another way of configuring the same thing is this:
20664 .code
20665 smart_route:
20666   driver = manualroute
20667   transport = remote_smtp
20668   route_list = !+local_domains  smarthost.ref.example
20669 .endd
20670 There is no difference in behaviour between these two routers as they stand.
20671 However, they behave differently if &%no_more%& is added to them. In the first
20672 example, the router is skipped if the domain does not match the &%domains%&
20673 precondition; the following router is always tried. If the router runs, it
20674 always matches the domain and so can never decline. Therefore, &%no_more%&
20675 would have no effect. In the second case, the router is never skipped; it
20676 always runs. However, if it doesn't match the domain, it declines. In this case
20677 &%no_more%& would prevent subsequent routers from running.
20678
20679 .next
20680 .cindex "mail hub example"
20681 A &'mail hub'& is a host which receives mail for a number of domains via MX
20682 records in the DNS and delivers it via its own private routing mechanism. Often
20683 the final destinations are behind a firewall, with the mail hub being the one
20684 machine that can connect to machines both inside and outside the firewall. The
20685 &(manualroute)& router is usually used on a mail hub to route incoming messages
20686 to the correct hosts. For a small number of domains, the routing can be inline,
20687 using the &%route_list%& option, but for a larger number a file or database
20688 lookup is easier to manage.
20689
20690 If the domain names are in fact the names of the machines to which the mail is
20691 to be sent by the mail hub, the configuration can be quite simple. For
20692 example:
20693 .code
20694 hub_route:
20695   driver = manualroute
20696   transport = remote_smtp
20697   route_list = *.rhodes.tvs.example  $domain
20698 .endd
20699 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20700 whose names are the same as the mail domains. A similar approach can be taken
20701 if the host name can be obtained from the domain name by a string manipulation
20702 that the expansion facilities can handle. Otherwise, a lookup based on the
20703 domain can be used to find the host:
20704 .code
20705 through_firewall:
20706   driver = manualroute
20707   transport = remote_smtp
20708   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20709 .endd
20710 The result of the lookup must be the name or IP address of the host (or
20711 hosts) to which the address is to be routed. If the lookup fails, the route
20712 data is empty, causing the router to decline. The address then passes to the
20713 next router.
20714
20715 .next
20716 .cindex "batched SMTP output example"
20717 .cindex "SMTP" "batched outgoing; example"
20718 You can use &(manualroute)& to deliver messages to pipes or files in batched
20719 SMTP format for onward transportation by some other means. This is one way of
20720 storing mail for a dial-up host when it is not connected. The route list entry
20721 can be as simple as a single domain name in a configuration like this:
20722 .code
20723 save_in_file:
20724   driver = manualroute
20725   transport = batchsmtp_appendfile
20726   route_list = saved.domain.example
20727 .endd
20728 though often a pattern is used to pick up more than one domain. If there are
20729 several domains or groups of domains with different transport requirements,
20730 different transports can be listed in the routing information:
20731 .code
20732 save_in_file:
20733   driver = manualroute
20734   route_list = \
20735     *.saved.domain1.example  $domain  batch_appendfile; \
20736     *.saved.domain2.example  \
20737       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20738       batch_pipe
20739 .endd
20740 .vindex "&$domain$&"
20741 .vindex "&$host$&"
20742 The first of these just passes the domain in the &$host$& variable, which
20743 doesn't achieve much (since it is also in &$domain$&), but the second does a
20744 file lookup to find a value to pass, causing the router to decline to handle
20745 the address if the lookup fails.
20746
20747 .next
20748 .cindex "UUCP" "example of router for"
20749 Routing mail directly to UUCP software is a specific case of the use of
20750 &(manualroute)& in a gateway to another mail environment. This is an example of
20751 one way it can be done:
20752 .code
20753 # Transport
20754 uucp:
20755   driver = pipe
20756   user = nobody
20757   command = /usr/local/bin/uux -r - \
20758     ${substr_-5:$host}!rmail ${local_part}
20759   return_fail_output = true
20760
20761 # Router
20762 uucphost:
20763   transport = uucp
20764   driver = manualroute
20765   route_data = \
20766     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20767 .endd
20768 The file &_/usr/local/exim/uucphosts_& contains entries like
20769 .code
20770 darksite.ethereal.example:           darksite.UUCP
20771 .endd
20772 It can be set up more simply without adding and removing &".UUCP"& but this way
20773 makes clear the distinction between the domain name
20774 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20775 .endlist
20776 .ecindex IIDmanrou1
20777 .ecindex IIDmanrou2
20778
20779
20780
20781
20782
20783
20784
20785
20786 . ////////////////////////////////////////////////////////////////////////////
20787 . ////////////////////////////////////////////////////////////////////////////
20788
20789 .chapter "The queryprogram router" "CHAPdriverlast"
20790 .scindex IIDquerou1 "&(queryprogram)& router"
20791 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20792 .cindex "routing" "by external program"
20793 The &(queryprogram)& router routes an address by running an external command
20794 and acting on its output. This is an expensive way to route, and is intended
20795 mainly for use in lightly-loaded systems, or for performing experiments.
20796 However, if it is possible to use the precondition options (&%domains%&,
20797 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20798 be used in special cases, even on a busy host. There are the following private
20799 options:
20800 .cindex "options" "&(queryprogram)& router"
20801
20802 .option command queryprogram string&!! unset
20803 This option must be set. It specifies the command that is to be run. The
20804 command is split up into a command name and arguments, and then each is
20805 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20806 &<<CHAPpipetransport>>&).
20807
20808
20809 .option command_group queryprogram string unset
20810 .cindex "gid (group id)" "in &(queryprogram)& router"
20811 This option specifies a gid to be set when running the command while routing an
20812 address for deliver. It must be set if &%command_user%& specifies a numerical
20813 uid. If it begins with a digit, it is interpreted as the numerical value of the
20814 gid. Otherwise it is looked up using &[getgrnam()]&.
20815
20816
20817 .option command_user queryprogram string unset
20818 .cindex "uid (user id)" "for &(queryprogram)&"
20819 This option must be set. It specifies the uid which is set when running the
20820 command while routing an address for delivery. If the value begins with a digit,
20821 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20822 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20823 not set, a value for the gid also.
20824
20825 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20826 root, which it does during a normal delivery in a conventional configuration.
20827 However, when an address is being verified during message reception, Exim is
20828 usually running as the Exim user, not as root. If the &(queryprogram)& router
20829 is called from a non-root process, Exim cannot change uid or gid before running
20830 the command. In this circumstance the command runs under the current uid and
20831 gid.
20832
20833
20834 .option current_directory queryprogram string /
20835 This option specifies an absolute path which is made the current directory
20836 before running the command.
20837
20838
20839 .option timeout queryprogram time 1h
20840 If the command does not complete within the timeout period, its process group
20841 is killed and the message is frozen. A value of zero time specifies no
20842 timeout.
20843
20844
20845 The standard output of the command is connected to a pipe, which is read when
20846 the command terminates. It should consist of a single line of output,
20847 containing up to five fields, separated by white space. The maximum length of
20848 the line is 1023 characters. Longer lines are silently truncated. The first
20849 field is one of the following words (case-insensitive):
20850
20851 .ilist
20852 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20853 below).
20854 .next
20855 &'Decline'&: the router declines; pass the address to the next router, unless
20856 &%no_more%& is set.
20857 .next
20858 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20859 subsequent text on the line is an error message. If the router is run as part
20860 of address verification during an incoming SMTP message, the message is
20861 included in the SMTP response.
20862 .next
20863 &'Defer'&: routing could not be completed at this time; try again later. Any
20864 subsequent text on the line is an error message which is logged. It is not
20865 included in any SMTP response.
20866 .next
20867 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20868 .next
20869 &'Pass'&: pass the address to the next router (or the router specified by
20870 &%pass_router%&), overriding &%no_more%&.
20871 .next
20872 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20873 new addresses, which are routed independently, starting with the first router,
20874 or the router specified by &%redirect_router%&, if set.
20875 .endlist
20876
20877 When the first word is &'accept'&, the remainder of the line consists of a
20878 number of keyed data values, as follows (split into two lines here, to fit on
20879 the page):
20880 .code
20881 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20882 LOOKUP=byname|bydns DATA=<text>
20883 .endd
20884 The data items can be given in any order, and all are optional. If no transport
20885 is included, the transport specified by the generic &%transport%& option is
20886 used. The list of hosts and the lookup type are needed only if the transport is
20887 an &(smtp)& transport that does not itself supply a list of hosts.
20888
20889 The format of the list of hosts is the same as for the &(manualroute)& router.
20890 As well as host names and IP addresses with optional port numbers, as described
20891 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20892 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20893 (see section &<<SECThostshowused>>&).
20894
20895 If the lookup type is not specified, Exim behaves as follows when trying to
20896 find an IP address for each host: First, a DNS lookup is done. If this yields
20897 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20898 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20899 result of the lookup is the result of that call.
20900
20901 .vindex "&$address_data$&"
20902 If the DATA field is set, its value is placed in the &$address_data$&
20903 variable. For example, this return line
20904 .code
20905 accept hosts=x1.y.example:x2.y.example data="rule1"
20906 .endd
20907 routes the address to the default transport, passing a list of two hosts. When
20908 the transport runs, the string &"rule1"& is in &$address_data$&.
20909 .ecindex IIDquerou1
20910 .ecindex IIDquerou2
20911
20912
20913
20914
20915 . ////////////////////////////////////////////////////////////////////////////
20916 . ////////////////////////////////////////////////////////////////////////////
20917
20918 .chapter "The redirect router" "CHAPredirect"
20919 .scindex IIDredrou1 "&(redirect)& router"
20920 .scindex IIDredrou2 "routers" "&(redirect)&"
20921 .cindex "alias file" "in a &(redirect)& router"
20922 .cindex "address redirection" "&(redirect)& router"
20923 The &(redirect)& router handles several kinds of address redirection. Its most
20924 common uses are for resolving local part aliases from a central alias file
20925 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20926 files, but it has many other potential uses. The incoming address can be
20927 redirected in several different ways:
20928
20929 .ilist
20930 It can be replaced by one or more new addresses which are themselves routed
20931 independently.
20932 .next
20933 It can be routed to be delivered to a given file or directory.
20934 .next
20935 It can be routed to be delivered to a specified pipe command.
20936 .next
20937 It can cause an automatic reply to be generated.
20938 .next
20939 It can be forced to fail, optionally with a custom error message.
20940 .next
20941 It can be temporarily deferred, optionally with a custom message.
20942 .next
20943 It can be discarded.
20944 .endlist
20945
20946 The generic &%transport%& option must not be set for &(redirect)& routers.
20947 However, there are some private options which define transports for delivery to
20948 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20949 &%pipe_transport%& and &%reply_transport%& descriptions below.
20950
20951 If success DSNs have been requested
20952 .cindex "DSN" "success"
20953 .cindex "Delivery Status Notification" "success"
20954 redirection triggers one and the DSN options are not passed any further.
20955
20956
20957
20958 .section "Redirection data" "SECID124"
20959 The router operates by interpreting a text string which it obtains either by
20960 expanding the contents of the &%data%& option, or by reading the entire
20961 contents of a file whose name is given in the &%file%& option. These two
20962 options are mutually exclusive. The first is commonly used for handling system
20963 aliases, in a configuration like this:
20964 .code
20965 system_aliases:
20966   driver = redirect
20967   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20968 .endd
20969 If the lookup fails, the expanded string in this example is empty. When the
20970 expansion of &%data%& results in an empty string, the router declines. A forced
20971 expansion failure also causes the router to decline; other expansion failures
20972 cause delivery to be deferred.
20973
20974 A configuration using &%file%& is commonly used for handling users'
20975 &_.forward_& files, like this:
20976 .code
20977 userforward:
20978   driver = redirect
20979   check_local_user
20980   file = $home/.forward
20981   no_verify
20982 .endd
20983 If the file does not exist, or causes no action to be taken (for example, it is
20984 empty or consists only of comments), the router declines. &*Warning*&: This
20985 is not the case when the file contains syntactically valid items that happen to
20986 yield empty addresses, for example, items containing only RFC 2822 address
20987 comments.
20988
20989 .cindex "tainted data" "in filenames"
20990 .cindex redirect "tainted data"
20991 Tainted data may not be used for a filename.
20992
20993 &*Warning*&: It is unwise to use &$local_part$& or &$domain$&
20994 directly for redirection,
20995 as they are provided by a potential attacker.
20996 In the examples above, &$local_part$& is used for looking up data held locally
20997 on the system, and not used directly (the second example derives &$home$& via
20998 the passsword file or database, using &$local_part$&).
20999
21000
21001
21002 .section "Forward files and address verification" "SECID125"
21003 .cindex "address redirection" "while verifying"
21004 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
21005 &_.forward_& files, as in the example above. There are two reasons for this:
21006
21007 .ilist
21008 When Exim is receiving an incoming SMTP message from a remote host, it is
21009 running under the Exim uid, not as root. Exim is unable to change uid to read
21010 the file as the user, and it may not be able to read it as the Exim user. So in
21011 practice the router may not be able to operate.
21012 .next
21013 However, even when the router can operate, the existence of a &_.forward_& file
21014 is unimportant when verifying an address. What should be checked is whether the
21015 local part is a valid user name or not. Cutting out the redirection processing
21016 saves some resources.
21017 .endlist
21018
21019
21020
21021
21022
21023
21024 .section "Interpreting redirection data" "SECID126"
21025 .cindex "Sieve filter" "specifying in redirection data"
21026 .cindex "filter" "specifying in redirection data"
21027 The contents of the data string, whether obtained from &%data%& or &%file%&,
21028 can be interpreted in two different ways:
21029
21030 .ilist
21031 If the &%allow_filter%& option is set true, and the data begins with the text
21032 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
21033 &'filtering'& instructions in the form of an Exim or Sieve filter file,
21034 respectively. Details of the syntax and semantics of filter files are described
21035 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
21036 document is intended for use by end users.
21037 .next
21038 Otherwise, the data must be a comma-separated list of redirection items, as
21039 described in the next section.
21040 .endlist
21041
21042 When a message is redirected to a file (a &"mail folder"&), the filename given
21043 in a non-filter redirection list must always be an absolute path. A filter may
21044 generate a relative path &-- how this is handled depends on the transport's
21045 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
21046 for the &(appendfile)& transport.
21047
21048
21049
21050 .section "Items in a non-filter redirection list" "SECTitenonfilred"
21051 .cindex "address redirection" "non-filter list items"
21052 When the redirection data is not an Exim or Sieve filter, for example, if it
21053 comes from a conventional alias or forward file, it consists of a list of
21054 addresses, filenames, pipe commands, or certain special items (see section
21055 &<<SECTspecitredli>>& below). The special items can be individually enabled or
21056 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
21057 depending on their default values. The items in the list are separated by
21058 commas or newlines.
21059 If a comma is required in an item, the entire item must be enclosed in double
21060 quotes.
21061
21062 Lines starting with a # character are comments, and are ignored, and # may
21063 also appear following a comma, in which case everything between the # and the
21064 next newline character is ignored.
21065
21066 If an item is entirely enclosed in double quotes, these are removed. Otherwise
21067 double quotes are retained because some forms of mail address require their use
21068 (but never to enclose the entire address). In the following description,
21069 &"item"& refers to what remains after any surrounding double quotes have been
21070 removed.
21071
21072 .vindex "&$local_part$&"
21073 &*Warning*&: If you use an Exim expansion to construct a redirection address,
21074 and the expansion contains a reference to &$local_part$&, you should make use
21075 of the &%quote_local_part%& expansion operator, in case the local part contains
21076 special characters. For example, to redirect all mail for the domain
21077 &'obsolete.example'&, retaining the existing local part, you could use this
21078 setting:
21079 .code
21080 data = ${quote_local_part:$local_part}@newdomain.example
21081 .endd
21082
21083
21084 .section "Redirecting to a local mailbox" "SECTredlocmai"
21085 .cindex "routing" "loops in"
21086 .cindex "loop" "while routing, avoidance of"
21087 .cindex "address redirection" "to local mailbox"
21088 A redirection item may safely be the same as the address currently under
21089 consideration. This does not cause a routing loop, because a router is
21090 automatically skipped if any ancestor of the address that is being processed
21091 is the same as the current address and was processed by the current router.
21092 Such an address is therefore passed to the following routers, so it is handled
21093 as if there were no redirection. When making this loop-avoidance test, the
21094 complete local part, including any prefix or suffix, is used.
21095
21096 .cindex "address redirection" "local part without domain"
21097 Specifying the same local part without a domain is a common usage in personal
21098 filter files when the user wants to have messages delivered to the local
21099 mailbox and also forwarded elsewhere. For example, the user whose login is
21100 &'cleo'& might have a &_.forward_& file containing this:
21101 .code
21102 cleo, cleopatra@egypt.example
21103 .endd
21104 .cindex "backslash in alias file"
21105 .cindex "alias file" "backslash in"
21106 For compatibility with other MTAs, such unqualified local parts may be
21107 preceded by &"\"&, but this is not a requirement for loop prevention. However,
21108 it does make a difference if more than one domain is being handled
21109 synonymously.
21110
21111 If an item begins with &"\"& and the rest of the item parses as a valid RFC
21112 2822 address that does not include a domain, the item is qualified using the
21113 domain of the incoming address. In the absence of a leading &"\"&, unqualified
21114 addresses are qualified using the value in &%qualify_recipient%&, but you can
21115 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
21116
21117 Care must be taken if there are alias names for local users.
21118 Consider an MTA handling a single local domain where the system alias file
21119 contains:
21120 .code
21121 Sam.Reman: spqr
21122 .endd
21123 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
21124 messages in the local mailbox, and also forward copies elsewhere. He creates
21125 this forward file:
21126 .code
21127 Sam.Reman, spqr@reme.elsewhere.example
21128 .endd
21129 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
21130 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
21131 second time round, because it has previously routed it,
21132 and the following routers presumably cannot handle the alias. The forward file
21133 should really contain
21134 .code
21135 spqr, spqr@reme.elsewhere.example
21136 .endd
21137 but because this is such a common error, the &%check_ancestor%& option (see
21138 below) exists to provide a way to get round it. This is normally set on a
21139 &(redirect)& router that is handling users' &_.forward_& files.
21140
21141
21142
21143 .section "Special items in redirection lists" "SECTspecitredli"
21144 In addition to addresses, the following types of item may appear in redirection
21145 lists (that is, in non-filter redirection data):
21146
21147 .ilist
21148 .cindex "pipe" "in redirection list"
21149 .cindex "address redirection" "to pipe"
21150 An item is treated as a pipe command if it begins with &"|"& and does not parse
21151 as a valid RFC 2822 address that includes a domain. A transport for running the
21152 command must be specified by the &%pipe_transport%& option.
21153 Normally, either the router or the transport specifies a user and a group under
21154 which to run the delivery. The default is to use the Exim user and group.
21155
21156 Single or double quotes can be used for enclosing the individual arguments of
21157 the pipe command; no interpretation of escapes is done for single quotes. If
21158 the command contains a comma character, it is necessary to put the whole item
21159 in double quotes, for example:
21160 .code
21161 "|/some/command ready,steady,go"
21162 .endd
21163 since items in redirection lists are terminated by commas. Do not, however,
21164 quote just the command. An item such as
21165 .code
21166 |"/some/command ready,steady,go"
21167 .endd
21168 is interpreted as a pipe with a rather strange command name, and no arguments.
21169
21170 Note that the above example assumes that the text comes from a lookup source
21171 of some sort, so that the quotes are part of the data.  If composing a
21172 redirect router with a &%data%& option directly specifying this command, the
21173 quotes will be used by the configuration parser to define the extent of one
21174 string, but will not be passed down into the redirect router itself.  There
21175 are two main approaches to get around this: escape quotes to be part of the
21176 data itself, or avoid using this mechanism and instead create a custom
21177 transport with the &%command%& option set and reference that transport from
21178 an &%accept%& router.
21179
21180 .next
21181 .cindex "file" "in redirection list"
21182 .cindex "address redirection" "to file"
21183 An item is interpreted as a path name if it begins with &"/"& and does not
21184 parse as a valid RFC 2822 address that includes a domain. For example,
21185 .code
21186 /home/world/minbari
21187 .endd
21188 is treated as a filename, but
21189 .code
21190 /s=molari/o=babylon/@x400gate.way
21191 .endd
21192 is treated as an address. For a filename, a transport must be specified using
21193 the &%file_transport%& option. However, if the generated path name ends with a
21194 forward slash character, it is interpreted as a directory name rather than a
21195 filename, and &%directory_transport%& is used instead.
21196
21197 Normally, either the router or the transport specifies a user and a group under
21198 which to run the delivery. The default is to use the Exim user and group.
21199
21200 .cindex "&_/dev/null_&"
21201 However, if a redirection item is the path &_/dev/null_&, delivery to it is
21202 bypassed at a high level, and the log entry shows &"**bypassed**"&
21203 instead of a transport name. In this case the user and group are not used.
21204
21205 .next
21206 .cindex "included address list"
21207 .cindex "address redirection" "included external list"
21208 If an item is of the form
21209 .code
21210 :include:<path name>
21211 .endd
21212 a list of further items is taken from the given file and included at that
21213 point. &*Note*&: Such a file can not be a filter file; it is just an
21214 out-of-line addition to the list. The items in the included list are separated
21215 by commas or newlines and are not subject to expansion. If this is the first
21216 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
21217 the alias name. This example is incorrect:
21218 .code
21219 list1    :include:/opt/lists/list1
21220 .endd
21221 It must be given as
21222 .code
21223 list1:   :include:/opt/lists/list1
21224 .endd
21225 .cindex "tainted data" "in filenames"
21226 .cindex redirect "tainted data"
21227 Tainted data may not be used for a filename.
21228 .next
21229 .cindex "address redirection" "to black hole"
21230 .cindex "delivery" "discard"
21231 .cindex "delivery" "blackhole"
21232 .cindex "black hole"
21233 .cindex "abandoning mail"
21234 Sometimes you want to throw away mail to a particular local part.  Making the
21235 &%data%& option expand to an empty string does not work, because that causes
21236 the router to decline. Instead, the alias item
21237 .code
21238 :blackhole:
21239 .endd
21240 can be used. It does what its name implies. No delivery is
21241 done, and no error message is generated. This has the same effect as specifying
21242 &_/dev/null_& as a destination, but it can be independently disabled.
21243
21244 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
21245 delivery is done for the original local part, even if other redirection items
21246 are present. If you are generating a multi-item list (for example, by reading a
21247 database) and need the ability to provide a no-op item, you must use
21248 &_/dev/null_&.
21249
21250 .next
21251 .cindex "delivery" "forcing failure"
21252 .cindex "delivery" "forcing deferral"
21253 .cindex "failing delivery" "forcing"
21254 .cindex "deferred delivery, forcing"
21255 .cindex "customizing" "failure message"
21256 An attempt to deliver a particular address can be deferred or forced to fail by
21257 redirection items of the form
21258 .code
21259 :defer:
21260 :fail:
21261 .endd
21262 respectively. When a redirection list contains such an item, it applies
21263 to the entire redirection; any other items in the list are ignored. Any
21264 text following &':fail:'& or &':defer:'& is placed in the error text
21265 associated with the failure. For example, an alias file might contain:
21266 .code
21267 X.Employee:  :fail: Gone away, no forwarding address
21268 .endd
21269 In the case of an address that is being verified from an ACL or as the subject
21270 of a
21271 .cindex "VRFY" "error text, display of"
21272 VRFY command, the text is included in the SMTP error response by
21273 default.
21274 .cindex "EXPN" "error text, display of"
21275 The text is not included in the response to an EXPN command. In non-SMTP cases
21276 the text is included in the error message that Exim generates.
21277
21278 .cindex "SMTP" "error codes"
21279 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
21280 &':fail:'&. However, if the message starts with three digits followed by a
21281 space, optionally followed by an extended code of the form &'n.n.n'&, also
21282 followed by a space, and the very first digit is the same as the default error
21283 code, the code from the message is used instead. If the very first digit is
21284 incorrect, a panic error is logged, and the default code is used. You can
21285 suppress the use of the supplied code in a redirect router by setting the
21286 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
21287 ignored.
21288
21289 .vindex "&$acl_verify_message$&"
21290 In an ACL, an explicitly provided message overrides the default, but the
21291 default message is available in the variable &$acl_verify_message$& and can
21292 therefore be included in a custom message if this is desired.
21293
21294 Normally the error text is the rest of the redirection list &-- a comma does
21295 not terminate it &-- but a newline does act as a terminator. Newlines are not
21296 normally present in alias expansions. In &(lsearch)& lookups they are removed
21297 as part of the continuation process, but they may exist in other kinds of
21298 lookup and in &':include:'& files.
21299
21300 During routing for message delivery (as opposed to verification), a redirection
21301 containing &':fail:'& causes an immediate failure of the incoming address,
21302 whereas &':defer:'& causes the message to remain in the queue so that a
21303 subsequent delivery attempt can happen at a later time. If an address is
21304 deferred for too long, it will ultimately fail, because the normal retry
21305 rules still apply.
21306
21307 .next
21308 .cindex "alias file" "exception to default"
21309 Sometimes it is useful to use a single-key search type with a default (see
21310 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
21311 for exceptions to the default. These can be handled by aliasing them to
21312 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
21313 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
21314 results in an empty redirection list has the same effect.
21315 .endlist
21316
21317
21318 .section "Duplicate addresses" "SECTdupaddr"
21319 .cindex "duplicate addresses"
21320 .cindex "address duplicate, discarding"
21321 .cindex "pipe" "duplicated"
21322 Exim removes duplicate addresses from the list to which it is delivering, so as
21323 to deliver just one copy to each address. This does not apply to deliveries
21324 routed to pipes by different immediate parent addresses, but an indirect
21325 aliasing scheme of the type
21326 .code
21327 pipe:       |/some/command $local_part
21328 localpart1: pipe
21329 localpart2: pipe
21330 .endd
21331 does not work with a message that is addressed to both local parts, because
21332 when the second is aliased to the intermediate local part &"pipe"& it gets
21333 discarded as being the same as a previously handled address. However, a scheme
21334 such as
21335 .code
21336 localpart1: |/some/command $local_part
21337 localpart2: |/some/command $local_part
21338 .endd
21339 does result in two different pipe deliveries, because the immediate parents of
21340 the pipes are distinct.
21341
21342
21343
21344 .section "Repeated redirection expansion" "SECID128"
21345 .cindex "repeated redirection expansion"
21346 .cindex "address redirection" "repeated for each delivery attempt"
21347 When a message cannot be delivered to all of its recipients immediately,
21348 leading to two or more delivery attempts, redirection expansion is carried out
21349 afresh each time for those addresses whose children were not all previously
21350 delivered. If redirection is being used as a mailing list, this can lead to new
21351 members of the list receiving copies of old messages. The &%one_time%& option
21352 can be used to avoid this.
21353
21354
21355 .section "Errors in redirection lists" "SECID129"
21356 .cindex "address redirection" "errors"
21357 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
21358 error is skipped, and an entry is written to the main log. This may be useful
21359 for mailing lists that are automatically managed. Otherwise, if an error is
21360 detected while generating the list of new addresses, the original address is
21361 deferred. See also &%syntax_errors_to%&.
21362
21363
21364
21365 .section "Private options for the redirect router" "SECID130"
21366
21367 .cindex "options" "&(redirect)& router"
21368 The private options for the &(redirect)& router are as follows:
21369
21370
21371 .option allow_defer redirect boolean false
21372 Setting this option allows the use of &':defer:'& in non-filter redirection
21373 data, or the &%defer%& command in an Exim filter file.
21374
21375
21376 .option allow_fail redirect boolean false
21377 .cindex "failing delivery" "from filter"
21378 If this option is true, the &':fail:'& item can be used in a redirection list,
21379 and the &%fail%& command may be used in an Exim filter file.
21380
21381
21382 .option allow_filter redirect boolean false
21383 .cindex "filter" "enabling use of"
21384 .cindex "Sieve filter" "enabling use of"
21385 Setting this option allows Exim to interpret redirection data that starts with
21386 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
21387 are some features of Exim filter files that some administrators may wish to
21388 lock out; see the &%forbid_filter_%&&'xxx'& options below.
21389
21390 It is also possible to lock out Exim filters or Sieve filters while allowing
21391 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
21392
21393
21394 The filter is run using the uid and gid set by the generic &%user%& and
21395 &%group%& options. These take their defaults from the password data if
21396 &%check_local_user%& is set, so in the normal case of users' personal filter
21397 files, the filter is run as the relevant user. When &%allow_filter%& is set
21398 true, Exim insists that either &%check_local_user%& or &%user%& is set.
21399
21400
21401
21402 .option allow_freeze redirect boolean false
21403 .cindex "freezing messages" "allowing in filter"
21404 Setting this option allows the use of the &%freeze%& command in an Exim filter.
21405 This command is more normally encountered in system filters, and is disabled by
21406 default for redirection filters because it isn't something you usually want to
21407 let ordinary users do.
21408
21409
21410
21411 .option check_ancestor redirect boolean false
21412 This option is concerned with handling generated addresses that are the same
21413 as some address in the list of redirection ancestors of the current address.
21414 Although it is turned off by default in the code, it is set in the default
21415 configuration file for handling users' &_.forward_& files. It is recommended
21416 for this use of the &(redirect)& router.
21417
21418 When &%check_ancestor%& is set, if a generated address (including the domain)
21419 is the same as any ancestor of the current address, it is replaced by a copy of
21420 the current address. This helps in the case where local part A is aliased to B,
21421 and B has a &_.forward_& file pointing back to A. For example, within a single
21422 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
21423 &_&~jb/.forward_& contains:
21424 .code
21425 \Joe.Bloggs, <other item(s)>
21426 .endd
21427 Without the &%check_ancestor%& setting, either local part (&"jb"& or
21428 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
21429 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
21430 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
21431 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
21432 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
21433 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
21434 original address. See also the &%repeat_use%& option below.
21435
21436
21437 .option check_group redirect boolean "see below"
21438 When the &%file%& option is used, the group owner of the file is checked only
21439 when this option is set. The permitted groups are those listed in the
21440 &%owngroups%& option, together with the user's default group if
21441 &%check_local_user%& is set. If the file has the wrong group, routing is
21442 deferred. The default setting for this option is true if &%check_local_user%&
21443 is set and the &%modemask%& option permits the group write bit, or if the
21444 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
21445
21446
21447
21448 .option check_owner redirect boolean "see below"
21449 When the &%file%& option is used, the owner of the file is checked only when
21450 this option is set. If &%check_local_user%& is set, the local user is
21451 permitted; otherwise the owner must be one of those listed in the &%owners%&
21452 option. The default value for this option is true if &%check_local_user%& or
21453 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
21454
21455
21456 .option data redirect string&!! unset
21457 This option is mutually exclusive with &%file%&. One or other of them must be
21458 set, but not both. The contents of &%data%& are expanded, and then used as the
21459 list of forwarding items, or as a set of filtering instructions. If the
21460 expansion is forced to fail, or the result is an empty string or a string that
21461 has no effect (consists entirely of comments), the router declines.
21462
21463 When filtering instructions are used, the string must begin with &"#Exim
21464 filter"&, and all comments in the string, including this initial one, must be
21465 terminated with newline characters. For example:
21466 .code
21467 data = #Exim filter\n\
21468        if $h_to: contains Exim then save $home/mail/exim endif
21469 .endd
21470 If you are reading the data from a database where newlines cannot be included,
21471 you can use the &${sg}$& expansion item to turn the escape string of your
21472 choice into a newline.
21473
21474
21475 .option directory_transport redirect string&!! unset
21476 A &(redirect)& router sets up a direct delivery to a directory when a path name
21477 ending with a slash is specified as a new &"address"&. The transport used is
21478 specified by this option, which, after expansion, must be the name of a
21479 configured transport. This should normally be an &(appendfile)& transport.
21480
21481
21482 .option file redirect string&!! unset
21483 This option specifies the name of a file that contains the redirection data. It
21484 is mutually exclusive with the &%data%& option. The string is expanded before
21485 use; if the expansion is forced to fail, the router declines. Other expansion
21486 failures cause delivery to be deferred. The result of a successful expansion
21487 must be an absolute path. The entire file is read and used as the redirection
21488 data. If the data is an empty string or a string that has no effect (consists
21489 entirely of comments), the router declines.
21490
21491 .cindex "NFS" "checking for file existence"
21492 If the attempt to open the file fails with a &"does not exist"& error, Exim
21493 runs a check on the containing directory,
21494 unless &%ignore_enotdir%& is true (see below).
21495 If the directory does not appear to exist, delivery is deferred. This can
21496 happen when users' &_.forward_& files are in NFS-mounted directories, and there
21497 is a mount problem. If the containing directory does exist, but the file does
21498 not, the router declines.
21499
21500
21501 .option file_transport redirect string&!! unset
21502 .vindex "&$address_file$&"
21503 A &(redirect)& router sets up a direct delivery to a file when a path name not
21504 ending in a slash is specified as a new &"address"&. The transport used is
21505 specified by this option, which, after expansion, must be the name of a
21506 configured transport. This should normally be an &(appendfile)& transport. When
21507 it is running, the filename is in &$address_file$&.
21508
21509
21510 .option filter_prepend_home redirect boolean true
21511 When this option is true, if a &(save)& command in an Exim filter specifies a
21512 relative path, and &$home$& is defined, it is automatically prepended to the
21513 relative path. If this option is set false, this action does not happen. The
21514 relative path is then passed to the transport unmodified.
21515
21516
21517 .option forbid_blackhole redirect boolean false
21518 .cindex "restricting access to features"
21519 .cindex "filter" "locking out certain features"
21520 If this option is true, the &':blackhole:'& item may not appear in a
21521 redirection list.
21522
21523
21524 .option forbid_exim_filter redirect boolean false
21525 .cindex "restricting access to features"
21526 .cindex "filter" "locking out certain features"
21527 If this option is set true, only Sieve filters are permitted when
21528 &%allow_filter%& is true.
21529
21530
21531
21532
21533 .option forbid_file redirect boolean false
21534 .cindex "restricting access to features"
21535 .cindex "delivery" "to file; forbidding"
21536 .cindex "filter" "locking out certain features"
21537 .cindex "Sieve filter" "forbidding delivery to a file"
21538 .cindex "Sieve filter" "&""keep""& facility; disabling"
21539 If this option is true, this router may not generate a new address that
21540 specifies delivery to a local file or directory, either from a filter or from a
21541 conventional forward file. This option is forced to be true if &%one_time%& is
21542 set. It applies to Sieve filters as well as to Exim filters, but if true, it
21543 locks out the Sieve's &"keep"& facility.
21544
21545
21546 .option forbid_filter_dlfunc redirect boolean false
21547 .cindex "restricting access to features"
21548 .cindex "filter" "locking out certain features"
21549 If this option is true, string expansions in Exim filters are not allowed to
21550 make use of the &%dlfunc%& expansion facility to run dynamically loaded
21551 functions.
21552
21553 .option forbid_filter_existstest redirect boolean false
21554 .cindex "restricting access to features"
21555 .cindex "filter" "locking out certain features"
21556 .cindex "expansion" "statting a file"
21557 If this option is true, string expansions in Exim filters are not allowed to
21558 make use of the &%exists%& condition or the &%stat%& expansion item.
21559
21560 .option forbid_filter_logwrite redirect boolean false
21561 .cindex "restricting access to features"
21562 .cindex "filter" "locking out certain features"
21563 If this option is true, use of the logging facility in Exim filters is not
21564 permitted. Logging is in any case available only if the filter is being run
21565 under some unprivileged uid (which is normally the case for ordinary users'
21566 &_.forward_& files).
21567
21568
21569 .option forbid_filter_lookup redirect boolean false
21570 .cindex "restricting access to features"
21571 .cindex "filter" "locking out certain features"
21572 If this option is true, string expansions in Exim filter files are not allowed
21573 to make use of &%lookup%& items.
21574
21575
21576 .option forbid_filter_perl redirect boolean false
21577 .cindex "restricting access to features"
21578 .cindex "filter" "locking out certain features"
21579 This option has an effect only if Exim is built with embedded Perl support. If
21580 it is true, string expansions in Exim filter files are not allowed to make use
21581 of the embedded Perl support.
21582
21583
21584 .option forbid_filter_readfile redirect boolean false
21585 .cindex "restricting access to features"
21586 .cindex "filter" "locking out certain features"
21587 If this option is true, string expansions in Exim filter files are not allowed
21588 to make use of &%readfile%& items.
21589
21590
21591 .option forbid_filter_readsocket redirect boolean false
21592 .cindex "restricting access to features"
21593 .cindex "filter" "locking out certain features"
21594 If this option is true, string expansions in Exim filter files are not allowed
21595 to make use of &%readsocket%& items.
21596
21597
21598 .option forbid_filter_reply redirect boolean false
21599 .cindex "restricting access to features"
21600 .cindex "filter" "locking out certain features"
21601 If this option is true, this router may not generate an automatic reply
21602 message. Automatic replies can be generated only from Exim or Sieve filter
21603 files, not from traditional forward files. This option is forced to be true if
21604 &%one_time%& is set.
21605
21606
21607 .option forbid_filter_run redirect boolean false
21608 .cindex "restricting access to features"
21609 .cindex "filter" "locking out certain features"
21610 If this option is true, string expansions in Exim filter files are not allowed
21611 to make use of &%run%& items.
21612
21613
21614 .option forbid_include redirect boolean false
21615 .cindex "restricting access to features"
21616 .cindex "filter" "locking out certain features"
21617 If this option is true, items of the form
21618 .code
21619 :include:<path name>
21620 .endd
21621 are not permitted in non-filter redirection lists.
21622
21623
21624 .option forbid_pipe redirect boolean false
21625 .cindex "restricting access to features"
21626 .cindex "filter" "locking out certain features"
21627 .cindex "delivery" "to pipe; forbidding"
21628 If this option is true, this router may not generate a new address which
21629 specifies delivery to a pipe, either from an Exim filter or from a conventional
21630 forward file. This option is forced to be true if &%one_time%& is set.
21631
21632
21633 .option forbid_sieve_filter redirect boolean false
21634 .cindex "restricting access to features"
21635 .cindex "filter" "locking out certain features"
21636 If this option is set true, only Exim filters are permitted when
21637 &%allow_filter%& is true.
21638
21639
21640 .cindex "SMTP" "error codes"
21641 .option forbid_smtp_code redirect boolean false
21642 If this option is set true, any SMTP error codes that are present at the start
21643 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
21644 the default codes (451 and 550, respectively) are always used.
21645
21646
21647
21648
21649 .option hide_child_in_errmsg redirect boolean false
21650 .cindex "bounce message" "redirection details; suppressing"
21651 If this option is true, it prevents Exim from quoting a child address if it
21652 generates a bounce or delay message for it. Instead it says &"an address
21653 generated from <&'the top level address'&>"&. Of course, this applies only to
21654 bounces generated locally. If a message is forwarded to another host, &'its'&
21655 bounce may well quote the generated address.
21656
21657
21658 .option ignore_eacces redirect boolean false
21659 .cindex "EACCES"
21660 If this option is set and an attempt to open a redirection file yields the
21661 EACCES error (permission denied), the &(redirect)& router behaves as if the
21662 file did not exist.
21663
21664
21665 .option ignore_enotdir redirect boolean false
21666 .cindex "ENOTDIR"
21667 If this option is set and an attempt to open a redirection file yields the
21668 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21669 router behaves as if the file did not exist.
21670
21671 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21672 router that has the &%file%& option set discovers that the file does not exist
21673 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21674 against unmounted NFS directories. If the parent can not be statted, delivery
21675 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21676 is set, because that option tells Exim to ignore &"something on the path is not
21677 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21678 that some operating systems give ENOENT where others give ENOTDIR.
21679
21680
21681
21682 .option include_directory redirect string unset
21683 If this option is set, the path names of any &':include:'& items in a
21684 redirection list must start with this directory.
21685
21686
21687 .option modemask redirect "octal integer" 022
21688 This specifies mode bits which must not be set for a file specified by the
21689 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21690
21691
21692 .option one_time redirect boolean false
21693 .cindex "one-time aliasing/forwarding expansion"
21694 .cindex "alias file" "one-time expansion"
21695 .cindex "forward file" "one-time expansion"
21696 .cindex "mailing lists" "one-time expansion"
21697 .cindex "address redirection" "one-time expansion"
21698 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21699 files each time it tries to deliver a message causes a problem when one or more
21700 of the generated addresses fails be delivered at the first attempt. The problem
21701 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21702 but of what happens when the redirection list changes during the time that the
21703 message is on Exim's queue. This is particularly true in the case of mailing
21704 lists, where new subscribers might receive copies of messages that were posted
21705 before they subscribed.
21706
21707 If &%one_time%& is set and any addresses generated by the router fail to
21708 deliver at the first attempt, the failing addresses are added to the message as
21709 &"top level"& addresses, and the parent address that generated them is marked
21710 &"delivered"&. Thus, redirection does not happen again at the next delivery
21711 attempt.
21712
21713 &*Warning 1*&: Any header line addition or removal that is specified by this
21714 router would be lost if delivery did not succeed at the first attempt. For this
21715 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21716 permitted when &%one_time%& is set.
21717
21718 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21719 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21720 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21721
21722 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21723 &%one_time%&.
21724
21725 The original top-level address is remembered with each of the generated
21726 addresses, and is output in any log messages. However, any intermediate parent
21727 addresses are not recorded. This makes a difference to the log only if
21728 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21729 typically be used for mailing lists, where there is normally just one level of
21730 expansion.
21731
21732
21733 .option owners redirect "string list" unset
21734 .cindex "ownership" "alias file"
21735 .cindex "ownership" "forward file"
21736 .cindex "alias file" "ownership"
21737 .cindex "forward file" "ownership"
21738 This specifies a list of permitted owners for the file specified by &%file%&.
21739 This list is in addition to the local user when &%check_local_user%& is set.
21740 See &%check_owner%& above.
21741
21742
21743 .option owngroups redirect "string list" unset
21744 This specifies a list of permitted groups for the file specified by &%file%&.
21745 The list is in addition to the local user's primary group when
21746 &%check_local_user%& is set. See &%check_group%& above.
21747
21748
21749 .option pipe_transport redirect string&!! unset
21750 .vindex "&$address_pipe$&"
21751 A &(redirect)& router sets up a direct delivery to a pipe when a string
21752 starting with a vertical bar character is specified as a new &"address"&. The
21753 transport used is specified by this option, which, after expansion, must be the
21754 name of a configured transport. This should normally be a &(pipe)& transport.
21755 When the transport is run, the pipe command is in &$address_pipe$&.
21756
21757
21758 .option qualify_domain redirect string&!! unset
21759 .vindex "&$qualify_recipient$&"
21760 If this option is set, and an unqualified address (one without a domain) is
21761 generated, and that address would normally be qualified by the global setting
21762 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21763 expanding this string. If the expansion fails, the router declines. If you want
21764 to revert to the default, you can have the expansion generate
21765 &$qualify_recipient$&.
21766
21767 This option applies to all unqualified addresses generated by Exim filters,
21768 but for traditional &_.forward_& files, it applies only to addresses that are
21769 not preceded by a backslash. Sieve filters cannot generate unqualified
21770 addresses.
21771
21772 .option qualify_preserve_domain redirect boolean false
21773 .cindex "domain" "in redirection; preserving"
21774 .cindex "preserving domain in redirection"
21775 .cindex "address redirection" "domain; preserving"
21776 If this option is set, the router's local &%qualify_domain%& option must not be
21777 set (a configuration error occurs if it is). If an unqualified address (one
21778 without a domain) is generated, it is qualified with the domain of the parent
21779 address (the immediately preceding ancestor) instead of the global
21780 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21781 this applies whether or not the address is preceded by a backslash.
21782
21783
21784 .option repeat_use redirect boolean true
21785 If this option is set false, the router is skipped for a child address that has
21786 any ancestor that was routed by this router. This test happens before any of
21787 the other preconditions are tested. Exim's default anti-looping rules skip
21788 only when the ancestor is the same as the current address. See also
21789 &%check_ancestor%& above and the generic &%redirect_router%& option.
21790
21791
21792 .option reply_transport redirect string&!! unset
21793 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21794 &%vacation%& command is used in a filter file. The transport used is specified
21795 by this option, which, after expansion, must be the name of a configured
21796 transport. This should normally be an &(autoreply)& transport. Other transports
21797 are unlikely to do anything sensible or useful.
21798
21799
21800 .option rewrite redirect boolean true
21801 .cindex "address redirection" "disabling rewriting"
21802 If this option is set false, addresses generated by the router are not
21803 subject to address rewriting. Otherwise, they are treated like new addresses
21804 and are rewritten according to the global rewriting rules.
21805
21806
21807 .option sieve_subaddress redirect string&!! unset
21808 The value of this option is passed to a Sieve filter to specify the
21809 :subaddress part of an address.
21810
21811 .option sieve_useraddress redirect string&!! unset
21812 The value of this option is passed to a Sieve filter to specify the :user part
21813 of an address. However, if it is unset, the entire original local part
21814 (including any prefix or suffix) is used for :user.
21815
21816
21817 .option sieve_vacation_directory redirect string&!! unset
21818 .cindex "Sieve filter" "vacation directory"
21819 To enable the &"vacation"& extension for Sieve filters, you must set
21820 &%sieve_vacation_directory%& to the directory where vacation databases are held
21821 (do not put anything else in that directory), and ensure that the
21822 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21823 needs their own directory; Exim will create it if necessary.
21824
21825
21826
21827 .option skip_syntax_errors redirect boolean false
21828 .cindex "forward file" "broken"
21829 .cindex "address redirection" "broken files"
21830 .cindex "alias file" "broken"
21831 .cindex "broken alias or forward files"
21832 .cindex "ignoring faulty addresses"
21833 .cindex "skipping faulty addresses"
21834 .cindex "error" "skipping bad syntax"
21835 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21836 non-filter redirection data are skipped, and each failing address is logged. If
21837 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21838 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21839 are expanded and placed at the head of the error message generated by
21840 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21841 be the same address as the generic &%errors_to%& option. The
21842 &%skip_syntax_errors%& option is often used when handling mailing lists.
21843
21844 If all the addresses in a redirection list are skipped because of syntax
21845 errors, the router declines to handle the original address, and it is passed to
21846 the following routers.
21847
21848 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21849 error in the filter causes filtering to be abandoned without any action being
21850 taken. The incident is logged, and the router declines to handle the address,
21851 so it is passed to the following routers.
21852
21853 .cindex "Sieve filter" "syntax errors in"
21854 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21855 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21856 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21857
21858 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21859 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21860 option, used with an address that does not get redirected, can be used to
21861 notify users of these errors, by means of a router like this:
21862 .code
21863 userforward:
21864   driver = redirect
21865   allow_filter
21866   check_local_user
21867   file = $home/.forward
21868   file_transport = address_file
21869   pipe_transport = address_pipe
21870   reply_transport = address_reply
21871   no_verify
21872   skip_syntax_errors
21873   syntax_errors_to = real-$local_part@$domain
21874   syntax_errors_text = \
21875    This is an automatically generated message. An error has\n\
21876    been found in your .forward file. Details of the error are\n\
21877    reported below. While this error persists, you will receive\n\
21878    a copy of this message for every message that is addressed\n\
21879    to you. If your .forward file is a filter file, or if it is\n\
21880    a non-filter file containing no valid forwarding addresses,\n\
21881    a copy of each incoming message will be put in your normal\n\
21882    mailbox. If a non-filter file contains at least one valid\n\
21883    forwarding address, forwarding to the valid addresses will\n\
21884    happen, and those will be the only deliveries that occur.
21885 .endd
21886 You also need a router to ensure that local addresses that are prefixed by
21887 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21888 put this immediately before the &(userforward)& router:
21889 .code
21890 real_localuser:
21891   driver = accept
21892   check_local_user
21893   local_part_prefix = real-
21894   transport = local_delivery
21895 .endd
21896 For security, it would probably be a good idea to restrict the use of this
21897 router to locally-generated messages, using a condition such as this:
21898 .code
21899   condition = ${if match {$sender_host_address}\
21900                          {\N^(|127\.0\.0\.1)$\N}}
21901 .endd
21902
21903
21904 .option syntax_errors_text redirect string&!! unset
21905 See &%skip_syntax_errors%& above.
21906
21907
21908 .option syntax_errors_to redirect string unset
21909 See &%skip_syntax_errors%& above.
21910 .ecindex IIDredrou1
21911 .ecindex IIDredrou2
21912
21913
21914
21915
21916
21917
21918 . ////////////////////////////////////////////////////////////////////////////
21919 . ////////////////////////////////////////////////////////////////////////////
21920
21921 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21922          "Environment for local transports"
21923 .scindex IIDenvlotra1 "local transports" "environment for"
21924 .scindex IIDenvlotra2 "environment" "local transports"
21925 .scindex IIDenvlotra3 "transport" "local; environment for"
21926 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21927 transport can be thought of as similar to a pipe.) Exim always runs transports
21928 in subprocesses, under specified uids and gids. Typical deliveries to local
21929 mailboxes run under the uid and gid of the local user.
21930
21931 Exim also sets a specific current directory while running the transport; for
21932 some transports a home directory setting is also relevant. The &(pipe)&
21933 transport is the only one that sets up environment variables; see section
21934 &<<SECTpipeenv>>& for details.
21935
21936 The values used for the uid, gid, and the directories may come from several
21937 different places. In many cases, the router that handles the address associates
21938 settings with that address as a result of its &%check_local_user%&, &%group%&,
21939 or &%user%& options. However, values may also be given in the transport's own
21940 configuration, and these override anything that comes from the router.
21941
21942
21943
21944 .section "Concurrent deliveries" "SECID131"
21945 .cindex "concurrent deliveries"
21946 .cindex "simultaneous deliveries"
21947 If two different messages for the same local recipient arrive more or less
21948 simultaneously, the two delivery processes are likely to run concurrently. When
21949 the &(appendfile)& transport is used to write to a file, Exim applies locking
21950 rules to stop concurrent processes from writing to the same file at the same
21951 time.
21952
21953 However, when you use a &(pipe)& transport, it is up to you to arrange any
21954 locking that is needed. Here is a silly example:
21955 .code
21956 my_transport:
21957   driver = pipe
21958   command = /bin/sh -c 'cat >>/some/file'
21959 .endd
21960 This is supposed to write the message at the end of the file. However, if two
21961 messages arrive at the same time, the file will be scrambled. You can use the
21962 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21963 file using the same algorithm that Exim itself uses.
21964
21965
21966
21967
21968 .section "Uids and gids" "SECTenvuidgid"
21969 .cindex "local transports" "uid and gid"
21970 .cindex "transport" "local; uid and gid"
21971 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21972 overrides any group that the router set in the address, even if &%user%& is not
21973 set for the transport. This makes it possible, for example, to run local mail
21974 delivery under the uid of the recipient (set by the router), but in a special
21975 group (set by the transport). For example:
21976 .code
21977 # Routers ...
21978 # User/group are set by check_local_user in this router
21979 local_users:
21980   driver = accept
21981   check_local_user
21982   transport = group_delivery
21983
21984 # Transports ...
21985 # This transport overrides the group
21986 group_delivery:
21987   driver = appendfile
21988   file = /var/spool/mail/$local_part_data
21989   group = mail
21990 .endd
21991 If &%user%& is set for a transport, its value overrides what is set in the
21992 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21993 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21994 set.
21995
21996 .oindex "&%initgroups%&"
21997 When the uid is taken from the transport's configuration, the &[initgroups()]&
21998 function is called for the groups associated with that uid if the
21999 &%initgroups%& option is set for the transport. When the uid is not specified
22000 by the transport, but is associated with the address by a router, the option
22001 for calling &[initgroups()]& is taken from the router configuration.
22002
22003 .cindex "&(pipe)& transport" "uid for"
22004 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
22005 is set and &%user%& is not set, the uid of the process that called Exim to
22006 receive the message is used, and if &%group%& is not set, the corresponding
22007 original gid is also used.
22008
22009 This is the detailed preference order for obtaining a gid; the first of the
22010 following that is set is used:
22011
22012 .ilist
22013 A &%group%& setting of the transport;
22014 .next
22015 A &%group%& setting of the router;
22016 .next
22017 A gid associated with a user setting of the router, either as a result of
22018 &%check_local_user%& or an explicit non-numeric &%user%& setting;
22019 .next
22020 The group associated with a non-numeric &%user%& setting of the transport;
22021 .next
22022 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
22023 the uid is the creator's uid;
22024 .next
22025 The Exim gid if the Exim uid is being used as a default.
22026 .endlist
22027
22028 If, for example, the user is specified numerically on the router and there are
22029 no group settings, no gid is available. In this situation, an error occurs.
22030 This is different for the uid, for which there always is an ultimate default.
22031 The first of the following that is set is used:
22032
22033 .ilist
22034 A &%user%& setting of the transport;
22035 .next
22036 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
22037 .next
22038 A &%user%& setting of the router;
22039 .next
22040 A &%check_local_user%& setting of the router;
22041 .next
22042 The Exim uid.
22043 .endlist
22044
22045 Of course, an error will still occur if the uid that is chosen is on the
22046 &%never_users%& list.
22047
22048
22049
22050
22051
22052 .section "Current and home directories" "SECID132"
22053 .cindex "current directory for local transport"
22054 .cindex "home directory" "for local transport"
22055 .cindex "transport" "local; home directory for"
22056 .cindex "transport" "local; current directory for"
22057 Routers may set current and home directories for local transports by means of
22058 the &%transport_current_directory%& and &%transport_home_directory%& options.
22059 However, if the transport's &%current_directory%& or &%home_directory%& options
22060 are set, they override the router's values. In detail, the home directory
22061 for a local transport is taken from the first of these values that is set:
22062
22063 .ilist
22064 The &%home_directory%& option on the transport;
22065 .next
22066 The &%transport_home_directory%& option on the router;
22067 .next
22068 The password data if &%check_local_user%& is set on the router;
22069 .next
22070 The &%router_home_directory%& option on the router.
22071 .endlist
22072
22073 The current directory is taken from the first of these values that is set:
22074
22075 .ilist
22076 The &%current_directory%& option on the transport;
22077 .next
22078 The &%transport_current_directory%& option on the router.
22079 .endlist
22080
22081
22082 If neither the router nor the transport sets a current directory, Exim uses the
22083 value of the home directory, if it is set. Otherwise it sets the current
22084 directory to &_/_& before running a local transport.
22085
22086
22087
22088 .section "Expansion variables derived from the address" "SECID133"
22089 .vindex "&$domain$&"
22090 .vindex "&$local_part$&"
22091 .vindex "&$original_domain$&"
22092 Normally a local delivery is handling a single address, and in that case the
22093 variables such as &$domain$& and &$local_part$& are set during local
22094 deliveries. However, in some circumstances more than one address may be handled
22095 at once (for example, while writing batch SMTP for onward transmission by some
22096 other means). In this case, the variables associated with the local part are
22097 never set, &$domain$& is set only if all the addresses have the same domain,
22098 and &$original_domain$& is never set.
22099 .ecindex IIDenvlotra1
22100 .ecindex IIDenvlotra2
22101 .ecindex IIDenvlotra3
22102
22103
22104
22105
22106
22107
22108
22109 . ////////////////////////////////////////////////////////////////////////////
22110 . ////////////////////////////////////////////////////////////////////////////
22111
22112 .chapter "Generic options for transports" "CHAPtransportgeneric"
22113 .scindex IIDgenoptra1 "generic options" "transport"
22114 .scindex IIDgenoptra2 "options" "generic; for transports"
22115 .scindex IIDgenoptra3 "transport" "generic options for"
22116 The following generic options apply to all transports:
22117
22118
22119 .option body_only transports boolean false
22120 .cindex "transport" "body only"
22121 .cindex "message" "transporting body only"
22122 .cindex "body of message" "transporting"
22123 If this option is set, the message's headers are not transported. It is
22124 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
22125 or &(pipe)& transports, the settings of &%message_prefix%& and
22126 &%message_suffix%& should be checked, because this option does not
22127 automatically suppress them.
22128
22129
22130 .option current_directory transports string&!! unset
22131 .cindex "transport" "current directory for"
22132 This specifies the current directory that is to be set while running the
22133 transport, overriding any value that may have been set by the router.
22134 If the expansion fails for any reason, including forced failure, an error is
22135 logged, and delivery is deferred.
22136
22137
22138 .option disable_logging transports boolean false
22139 If this option is set true, nothing is logged for any
22140 deliveries by the transport or for any
22141 transport errors. You should not set this option unless you really, really know
22142 what you are doing.
22143
22144
22145 .option debug_print transports string&!! unset
22146 .cindex "testing" "variables in drivers"
22147 If this option is set and debugging is enabled (see the &%-d%& command line
22148 option), the string is expanded and included in the debugging output when the
22149 transport is run.
22150 If expansion of the string fails, the error message is written to the debugging
22151 output, and Exim carries on processing.
22152 This facility is provided to help with checking out the values of variables and
22153 so on when debugging driver configurations. For example, if a &%headers_add%&
22154 option is not working properly, &%debug_print%& could be used to output the
22155 variables it references. A newline is added to the text if it does not end with
22156 one.
22157 The variables &$transport_name$& and &$router_name$& contain the name of the
22158 transport and the router that called it.
22159
22160 .option delivery_date_add transports boolean false
22161 .cindex "&'Delivery-date:'& header line"
22162 If this option is true, a &'Delivery-date:'& header is added to the message.
22163 This gives the actual time the delivery was made. As this is not a standard
22164 header, Exim has a configuration option (&%delivery_date_remove%&) which
22165 requests its removal from incoming messages, so that delivered messages can
22166 safely be resent to other recipients.
22167
22168
22169 .option driver transports string unset
22170 This specifies which of the available transport drivers is to be used.
22171 There is no default, and this option must be set for every transport.
22172
22173
22174 .option envelope_to_add transports boolean false
22175 .cindex "&'Envelope-to:'& header line"
22176 If this option is true, an &'Envelope-to:'& header is added to the message.
22177 This gives the original address(es) in the incoming envelope that caused this
22178 delivery to happen. More than one address may be present if the transport is
22179 configured to handle several addresses at once, or if more than one original
22180 address was redirected to the same final address. As this is not a standard
22181 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
22182 its removal from incoming messages, so that delivered messages can safely be
22183 resent to other recipients.
22184
22185
22186 .option event_action transports string&!! unset
22187 .cindex events
22188 This option declares a string to be expanded for Exim's events mechanism.
22189 For details see chapter &<<CHAPevents>>&.
22190
22191
22192 .option group transports string&!! "Exim group"
22193 .cindex "transport" "group; specifying"
22194 This option specifies a gid for running the transport process, overriding any
22195 value that the router supplies, and also overriding any value associated with
22196 &%user%& (see below).
22197
22198
22199 .option headers_add transports list&!! unset
22200 .cindex "header lines" "adding in transport"
22201 .cindex "transport" "header lines; adding"
22202 This option specifies a list of text headers,
22203 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22204 which are (separately) expanded and added to the header
22205 portion of a message as it is transported, as described in section
22206 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
22207 routers. If the result of the expansion is an empty string, or if the expansion
22208 is forced to fail, no action is taken. Other expansion failures are treated as
22209 errors and cause the delivery to be deferred.
22210
22211 Unlike most options, &%headers_add%& can be specified multiple times
22212 for a transport; all listed headers are added.
22213
22214
22215 .option headers_only transports boolean false
22216 .cindex "transport" "header lines only"
22217 .cindex "message" "transporting headers only"
22218 .cindex "header lines" "transporting"
22219 If this option is set, the message's body is not transported. It is mutually
22220 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
22221 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
22222 checked, since this option does not automatically suppress them.
22223
22224
22225 .option headers_remove transports list&!! unset
22226 .cindex "header lines" "removing"
22227 .cindex "transport" "header lines; removing"
22228 This option specifies a list of text headers,
22229 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
22230 to be removed from the message.
22231 However, the option has no effect when an address is just being verified.
22232 Each list item is separately expanded.
22233 If the result of the expansion is an empty string, or if the expansion
22234 is forced to fail, no action is taken. Other expansion failures are treated as
22235 errors and cause the delivery to be deferred.
22236 If an item ends in *, it will match any header with the given prefix.
22237
22238 Matching headers are omitted from the message as it is transported, as described
22239 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
22240 routers.
22241
22242 Unlike most options, &%headers_remove%& can be specified multiple times
22243 for a transport; all listed headers are removed.
22244
22245 &*Warning*&: Because of the separate expansion of the list items,
22246 items that contain a list separator must have it doubled.
22247 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
22248
22249
22250
22251 .option headers_rewrite transports string unset
22252 .cindex "transport" "header lines; rewriting"
22253 .cindex "rewriting" "at transport time"
22254 This option allows addresses in header lines to be rewritten at transport time,
22255 that is, as the message is being copied to its destination. The contents of the
22256 option are a colon-separated list of rewriting rules. Each rule is in exactly
22257 the same form as one of the general rewriting rules that are applied when a
22258 message is received. These are described in chapter &<<CHAPrewrite>>&. For
22259 example,
22260 .code
22261 headers_rewrite = a@b c@d f : \
22262                   x@y w@z
22263 .endd
22264 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
22265 &'w@z'& in all address-bearing header lines. The rules are applied to the
22266 header lines just before they are written out at transport time, so they affect
22267 only those copies of the message that pass through the transport. However, only
22268 the message's original header lines, and any that were added by a system
22269 filter, are rewritten. If a router or transport adds header lines, they are not
22270 affected by this option. These rewriting rules are &'not'& applied to the
22271 envelope. You can change the return path using &%return_path%&, but you cannot
22272 change envelope recipients at this time.
22273
22274
22275 .option home_directory transports string&!! unset
22276 .cindex "transport" "home directory for"
22277 .vindex "&$home$&"
22278 This option specifies a home directory setting for a local transport,
22279 overriding any value that may be set by the router. The home directory is
22280 placed in &$home$& while expanding the transport's private options. It is also
22281 used as the current directory if no current directory is set by the
22282 &%current_directory%& option on the transport or the
22283 &%transport_current_directory%& option on the router. If the expansion fails
22284 for any reason, including forced failure, an error is logged, and delivery is
22285 deferred.
22286
22287
22288 .option initgroups transports boolean false
22289 .cindex "additional groups"
22290 .cindex "groups" "additional"
22291 .cindex "transport" "group; additional"
22292 If this option is true and the uid for the delivery process is provided by the
22293 transport, the &[initgroups()]& function is called when running the transport
22294 to ensure that any additional groups associated with the uid are set up.
22295
22296
22297 .option max_parallel transports integer&!! unset
22298 .cindex limit "transport parallelism"
22299 .cindex transport "parallel processes"
22300 .cindex transport "concurrency limit"
22301 .cindex "delivery" "parallelism for transport"
22302 If this option is set and expands to an integer greater than zero
22303 it limits the number of concurrent runs of the transport.
22304 The control does not apply to shadow transports.
22305
22306 .cindex "hints database" "transport concurrency control"
22307 Exim implements this control by means of a hints database in which a record is
22308 incremented whenever a transport process is being created. The record
22309 is decremented and possibly removed when the process terminates.
22310 Obviously there is scope for
22311 records to get left lying around if there is a system or program crash. To
22312 guard against this, Exim ignores any records that are more than six hours old.
22313
22314 If you use this option, you should also arrange to delete the
22315 relevant hints database whenever your system reboots. The names of the files
22316 start with &_misc_& and they are kept in the &_spool/db_& directory. There
22317 may be one or two files, depending on the type of DBM in use. The same files
22318 are used for ETRN and smtp transport serialization.
22319
22320
22321 .option message_size_limit transports string&!! 0
22322 .cindex "limit" "message size per transport"
22323 .cindex "size" "of message, limit"
22324 .cindex "transport" "message size; limiting"
22325 This option controls the size of messages passed through the transport. It is
22326 expanded before use; the result of the expansion must be a sequence of decimal
22327 digits, optionally followed by K or M. If the expansion fails for any reason,
22328 including forced failure, or if the result is not of the required form,
22329 delivery is deferred. If the value is greater than zero and the size of a
22330 message exceeds this limit, the address is failed. If there is any chance that
22331 the resulting bounce message could be routed to the same transport, you should
22332 ensure that &%return_size_limit%& is less than the transport's
22333 &%message_size_limit%&, as otherwise the bounce message will fail to get
22334 delivered.
22335
22336
22337
22338 .option rcpt_include_affixes transports boolean false
22339 .cindex "prefix" "for local part, including in envelope"
22340 .cindex "suffix for local part" "including in envelope"
22341 .cindex "local part" "prefix"
22342 .cindex "local part" "suffix"
22343 When this option is false (the default), and an address that has had any
22344 affixes (prefixes or suffixes) removed from the local part is delivered by any
22345 form of SMTP or LMTP, the affixes are not included. For example, if a router
22346 that contains
22347 .code
22348 local_part_prefix = *-
22349 .endd
22350 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
22351 is delivered with
22352 .code
22353 RCPT TO:<xyz@some.domain>
22354 .endd
22355 This is also the case when an ACL-time callout is being used to verify a
22356 recipient address. However, if &%rcpt_include_affixes%& is set true, the
22357 whole local part is included in the RCPT command. This option applies to BSMTP
22358 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
22359 &(lmtp)& and &(smtp)& transports.
22360
22361
22362 .option retry_use_local_part transports boolean "see below"
22363 .cindex "hints database" "retry keys"
22364 When a delivery suffers a temporary failure, a retry record is created
22365 in Exim's hints database. For remote deliveries, the key for the retry record
22366 is based on the name and/or IP address of the failing remote host. For local
22367 deliveries, the key is normally the entire address, including both the local
22368 part and the domain. This is suitable for most common cases of local delivery
22369 temporary failure &-- for example, exceeding a mailbox quota should delay only
22370 deliveries to that mailbox, not to the whole domain.
22371
22372 However, in some special cases you may want to treat a temporary local delivery
22373 as a failure associated with the domain, and not with a particular local part.
22374 (For example, if you are storing all mail for some domain in files.) You can do
22375 this by setting &%retry_use_local_part%& false.
22376
22377 For all the local transports, its default value is true. For remote transports,
22378 the default value is false for tidiness, but changing the value has no effect
22379 on a remote transport in the current implementation.
22380
22381
22382 .option return_path transports string&!! unset
22383 .cindex "envelope sender"
22384 .cindex "envelope from"
22385 .cindex "transport" "return path; changing"
22386 .cindex "return path" "changing in transport"
22387 If this option is set, the string is expanded at transport time and replaces
22388 the existing return path (envelope sender) value in the copy of the message
22389 that is being delivered. An empty return path is permitted. This feature is
22390 designed for remote deliveries, where the value of this option is used in the
22391 SMTP MAIL command. If you set &%return_path%& for a local transport, the
22392 only effect is to change the address that is placed in the &'Return-path:'&
22393 header line, if one is added to the message (see the next option).
22394
22395 &*Note:*& A changed return path is not logged unless you add
22396 &%return_path_on_delivery%& to the log selector.
22397
22398 .vindex "&$return_path$&"
22399 The expansion can refer to the existing value via &$return_path$&. This is
22400 either the message's envelope sender, or an address set by the
22401 &%errors_to%& option on a router. If the expansion is forced to fail, no
22402 replacement occurs; if it fails for another reason, delivery is deferred. This
22403 option can be used to support VERP (Variable Envelope Return Paths) &-- see
22404 section &<<SECTverp>>&.
22405
22406 &*Note*&: If a delivery error is detected locally, including the case when a
22407 remote server rejects a message at SMTP time, the bounce message is not sent to
22408 the value of this option. It is sent to the previously set errors address.
22409 This defaults to the incoming sender address, but can be changed by setting
22410 &%errors_to%& in a router.
22411
22412
22413
22414 .option return_path_add transports boolean false
22415 .cindex "&'Return-path:'& header line"
22416 If this option is true, a &'Return-path:'& header is added to the message.
22417 Although the return path is normally available in the prefix line of BSD
22418 mailboxes, this is commonly not displayed by MUAs, and so the user does not
22419 have easy access to it.
22420
22421 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
22422 the delivery SMTP server makes the final delivery"&. This implies that this
22423 header should not be present in incoming messages. Exim has a configuration
22424 option, &%return_path_remove%&, which requests removal of this header from
22425 incoming messages, so that delivered messages can safely be resent to other
22426 recipients.
22427
22428
22429 .option shadow_condition transports string&!! unset
22430 See &%shadow_transport%& below.
22431
22432
22433 .option shadow_transport transports string unset
22434 .cindex "shadow transport"
22435 .cindex "transport" "shadow"
22436 A local transport may set the &%shadow_transport%& option to the name of
22437 another local transport. Shadow remote transports are not supported.
22438
22439 Whenever a delivery to the main transport succeeds, and either
22440 &%shadow_condition%& is unset, or its expansion does not result in the empty
22441 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
22442 passed to the shadow transport, with the same delivery address or addresses. If
22443 expansion fails, no action is taken except that non-forced expansion failures
22444 cause a log line to be written.
22445
22446 The result of the shadow transport is discarded and does not affect the
22447 subsequent processing of the message. Only a single level of shadowing is
22448 provided; the &%shadow_transport%& option is ignored on any transport when it
22449 is running as a shadow. Options concerned with output from pipes are also
22450 ignored. The log line for the successful delivery has an item added on the end,
22451 of the form
22452 .code
22453 ST=<shadow transport name>
22454 .endd
22455 If the shadow transport did not succeed, the error message is put in
22456 parentheses afterwards. Shadow transports can be used for a number of different
22457 purposes, including keeping more detailed log information than Exim normally
22458 provides, and implementing automatic acknowledgment policies based on message
22459 headers that some sites insist on.
22460
22461
22462 .option transport_filter transports string&!! unset
22463 .cindex "transport" "filter"
22464 .cindex "filter" "transport filter"
22465 This option sets up a filtering (in the Unix shell sense) process for messages
22466 at transport time. It should not be confused with mail filtering as set up by
22467 individual users or via a system filter.
22468 If unset, or expanding to an empty string, no filtering is done.
22469
22470 When the message is about to be written out, the command specified by
22471 &%transport_filter%& is started up in a separate, parallel process, and
22472 the entire message, including the header lines, is passed to it on its standard
22473 input (this in fact is done from a third process, to avoid deadlock). The
22474 command must be specified as an absolute path.
22475
22476 The lines of the message that are written to the transport filter are
22477 terminated by newline (&"\n"&). The message is passed to the filter before any
22478 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
22479 lines beginning with a dot, and also before any processing implied by the
22480 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
22481 &(pipe)& transports.
22482
22483 The standard error for the filter process is set to the same destination as its
22484 standard output; this is read and written to the message's ultimate
22485 destination. The process that writes the message to the filter, the
22486 filter itself, and the original process that reads the result and delivers it
22487 are all run in parallel, like a shell pipeline.
22488
22489 The filter can perform any transformations it likes, but of course should take
22490 care not to break RFC 2822 syntax. Exim does not check the result, except to
22491 test for a final newline when SMTP is in use. All messages transmitted over
22492 SMTP must end with a newline, so Exim supplies one if it is missing.
22493
22494 .cindex "content scanning" "per user"
22495 A transport filter can be used to provide content-scanning on a per-user basis
22496 at delivery time if the only required effect of the scan is to modify the
22497 message. For example, a content scan could insert a new header line containing
22498 a spam score. This could be interpreted by a filter in the user's MUA. It is
22499 not possible to discard a message at this stage.
22500
22501 .cindex "SIZE" "ESMTP extension"
22502 A problem might arise if the filter increases the size of a message that is
22503 being sent down an SMTP connection. If the receiving SMTP server has indicated
22504 support for the SIZE parameter, Exim will have sent the size of the message
22505 at the start of the SMTP session. If what is actually sent is substantially
22506 more, the server might reject the message. This can be worked round by setting
22507 the &%size_addition%& option on the &(smtp)& transport, either to allow for
22508 additions to the message, or to disable the use of SIZE altogether.
22509
22510 .vindex "&$pipe_addresses$&"
22511 The value of the &%transport_filter%& option is the command string for starting
22512 the filter, which is run directly from Exim, not under a shell. The string is
22513 parsed by Exim in the same way as a command string for the &(pipe)& transport:
22514 Exim breaks it up into arguments and then expands each argument separately (see
22515 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
22516 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
22517 of arguments, one for each address that applies to this delivery. (This isn't
22518 an ideal name for this feature here, but as it was already implemented for the
22519 &(pipe)& transport, it seemed sensible not to change it.)
22520
22521 .vindex "&$host$&"
22522 .vindex "&$host_address$&"
22523 The expansion variables &$host$& and &$host_address$& are available when the
22524 transport is a remote one. They contain the name and IP address of the host to
22525 which the message is being sent. For example:
22526 .code
22527 transport_filter = /some/directory/transport-filter.pl \
22528   $host $host_address $sender_address $pipe_addresses
22529 .endd
22530
22531 Two problems arise if you want to use more complicated expansion items to
22532 generate transport filter commands, both of which due to the fact that the
22533 command is split up &'before'& expansion.
22534 .ilist
22535 If an expansion item contains white space, you must quote it, so that it is all
22536 part of the same command item. If the entire option setting is one such
22537 expansion item, you have to take care what kind of quoting you use. For
22538 example:
22539 .code
22540 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
22541 .endd
22542 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
22543 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
22544 stripped by Exim when it read the option's value. When the value is used, if
22545 the single quotes were missing, the line would be split into two items,
22546 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
22547 Exim tried to expand the first one.
22548 .next
22549 Except for the special case of &$pipe_addresses$& that is mentioned above, an
22550 expansion cannot generate multiple arguments, or a command name followed by
22551 arguments. Consider this example:
22552 .code
22553 transport_filter = ${lookup{$host}lsearch{/a/file}\
22554                     {$value}{/bin/cat}}
22555 .endd
22556 The result of the lookup is interpreted as the name of the command, even
22557 if it contains white space. The simplest way round this is to use a shell:
22558 .code
22559 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
22560                                {$value}{/bin/cat}}
22561 .endd
22562 .endlist
22563
22564 The filter process is run under the same uid and gid as the normal delivery.
22565 For remote deliveries this is the Exim uid/gid by default. The command should
22566 normally yield a zero return code. Transport filters are not supposed to fail.
22567 A non-zero code is taken to mean that the transport filter encountered some
22568 serious problem. Delivery of the message is deferred; the message remains on
22569 the queue and is tried again later. It is not possible to cause a message to be
22570 bounced from a transport filter.
22571
22572 If a transport filter is set on an autoreply transport, the original message is
22573 passed through the filter as it is being copied into the newly generated
22574 message, which happens if the &%return_message%& option is set.
22575
22576
22577 .option transport_filter_timeout transports time 5m
22578 .cindex "transport" "filter, timeout"
22579 When Exim is reading the output of a transport filter, it applies a timeout
22580 that can be set by this option. Exceeding the timeout is normally treated as a
22581 temporary delivery failure. However, if a transport filter is used with a
22582 &(pipe)& transport, a timeout in the transport filter is treated in the same
22583 way as a timeout in the pipe command itself. By default, a timeout is a hard
22584 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
22585 becomes a temporary error.
22586
22587
22588 .option user transports string&!! "Exim user"
22589 .cindex "uid (user id)" "local delivery"
22590 .cindex "transport" "user, specifying"
22591 This option specifies the user under whose uid the delivery process is to be
22592 run, overriding any uid that may have been set by the router. If the user is
22593 given as a name, the uid is looked up from the password data, and the
22594 associated group is taken as the value of the gid to be used if the &%group%&
22595 option is not set.
22596
22597 For deliveries that use local transports, a user and group are normally
22598 specified explicitly or implicitly (for example, as a result of
22599 &%check_local_user%&) by the router or transport.
22600
22601 .cindex "hints database" "access by remote transport"
22602 For remote transports, you should leave this option unset unless you really are
22603 sure you know what you are doing. When a remote transport is running, it needs
22604 to be able to access Exim's hints databases, because each host may have its own
22605 retry data.
22606 .ecindex IIDgenoptra1
22607 .ecindex IIDgenoptra2
22608 .ecindex IIDgenoptra3
22609
22610
22611
22612
22613
22614
22615 . ////////////////////////////////////////////////////////////////////////////
22616 . ////////////////////////////////////////////////////////////////////////////
22617
22618 .chapter "Address batching in local transports" "CHAPbatching" &&&
22619          "Address batching"
22620 .cindex "transport" "local; address batching in"
22621 The only remote transport (&(smtp)&) is normally configured to handle more than
22622 one address at a time, so that when several addresses are routed to the same
22623 remote host, just one copy of the message is sent. Local transports, however,
22624 normally handle one address at a time. That is, a separate instance of the
22625 transport is run for each address that is routed to the transport. A separate
22626 copy of the message is delivered each time.
22627
22628 .cindex "batched local delivery"
22629 .oindex "&%batch_max%&"
22630 .oindex "&%batch_id%&"
22631 In special cases, it may be desirable to handle several addresses at once in a
22632 local transport, for example:
22633
22634 .ilist
22635 In an &(appendfile)& transport, when storing messages in files for later
22636 delivery by some other means, a single copy of the message with multiple
22637 recipients saves space.
22638 .next
22639 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
22640 a single copy saves time, and is the normal way LMTP is expected to work.
22641 .next
22642 In a &(pipe)& transport, when passing the message
22643 to a scanner program or
22644 to some other delivery mechanism such as UUCP, multiple recipients may be
22645 acceptable.
22646 .endlist
22647
22648 These three local transports all have the same options for controlling multiple
22649 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
22650 repeating the information for each transport, these options are described here.
22651
22652 The &%batch_max%& option specifies the maximum number of addresses that can be
22653 delivered together in a single run of the transport. Its default value is one
22654 (no batching). When more than one address is routed to a transport that has a
22655 &%batch_max%& value greater than one, the addresses are delivered in a batch
22656 (that is, in a single run of the transport with multiple recipients), subject
22657 to certain conditions:
22658
22659 .ilist
22660 .vindex "&$local_part$&"
22661 If any of the transport's options contain a reference to &$local_part$&, no
22662 batching is possible.
22663 .next
22664 .vindex "&$domain$&"
22665 If any of the transport's options contain a reference to &$domain$&, only
22666 addresses with the same domain are batched.
22667 .next
22668 .cindex "customizing" "batching condition"
22669 If &%batch_id%& is set, it is expanded for each address, and only those
22670 addresses with the same expanded value are batched. This allows you to specify
22671 customized batching conditions. Failure of the expansion for any reason,
22672 including forced failure, disables batching, but it does not stop the delivery
22673 from taking place.
22674 .next
22675 Batched addresses must also have the same errors address (where to send
22676 delivery errors), the same header additions and removals, the same user and
22677 group for the transport, and if a host list is present, the first host must
22678 be the same.
22679 .endlist
22680
22681 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22682 both when the file or pipe command is specified in the transport, and when it
22683 is specified by a &(redirect)& router, but all the batched addresses must of
22684 course be routed to the same file or pipe command. These two transports have an
22685 option called &%use_bsmtp%&, which causes them to deliver the message in
22686 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22687 &%check_string%& and &%escape_string%& options are forced to the values
22688 .code
22689 check_string = "."
22690 escape_string = ".."
22691 .endd
22692 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22693 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22694 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22695
22696 .cindex "&'Envelope-to:'& header line"
22697 If the generic &%envelope_to_add%& option is set for a batching transport, the
22698 &'Envelope-to:'& header that is added to the message contains all the addresses
22699 that are being processed together. If you are using a batching &(appendfile)&
22700 transport without &%use_bsmtp%&, the only way to preserve the recipient
22701 addresses is to set the &%envelope_to_add%& option.
22702
22703 .cindex "&(pipe)& transport" "with multiple addresses"
22704 .vindex "&$pipe_addresses$&"
22705 If you are using a &(pipe)& transport without BSMTP, and setting the
22706 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22707 the command. This is not a true variable; it is a bit of magic that causes each
22708 of the recipient addresses to be inserted into the command as a separate
22709 argument. This provides a way of accessing all the addresses that are being
22710 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22711 are specified by a &(redirect)& router.
22712
22713
22714
22715
22716 . ////////////////////////////////////////////////////////////////////////////
22717 . ////////////////////////////////////////////////////////////////////////////
22718
22719 .chapter "The appendfile transport" "CHAPappendfile"
22720 .scindex IIDapptra1 "&(appendfile)& transport"
22721 .scindex IIDapptra2 "transports" "&(appendfile)&"
22722 .cindex "directory creation"
22723 .cindex "creating directories"
22724 The &(appendfile)& transport delivers a message by appending it to an existing
22725 file, or by creating an entirely new file in a specified directory. Single
22726 files to which messages are appended can be in the traditional Unix mailbox
22727 format, or optionally in the MBX format supported by the Pine MUA and
22728 University of Washington IMAP daemon, &'inter alia'&. When each message is
22729 being delivered as a separate file, &"maildir"& format can optionally be used
22730 to give added protection against failures that happen part-way through the
22731 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22732 supported. For all file formats, Exim attempts to create as many levels of
22733 directory as necessary, provided that &%create_directory%& is set.
22734
22735 The code for the optional formats is not included in the Exim binary by
22736 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22737 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22738 included.
22739
22740 .cindex "quota" "system"
22741 Exim recognizes system quota errors, and generates an appropriate message. Exim
22742 also supports its own quota control within the transport, for use when the
22743 system facility is unavailable or cannot be used for some reason.
22744
22745 If there is an error while appending to a file (for example, quota exceeded or
22746 partition filled), Exim attempts to reset the file's length and last
22747 modification time back to what they were before. If there is an error while
22748 creating an entirely new file, the new file is removed.
22749
22750 Before appending to a file, a number of security checks are made, and the
22751 file is locked. A detailed description is given below, after the list of
22752 private options.
22753
22754 The &(appendfile)& transport is most commonly used for local deliveries to
22755 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22756 putting messages into files for remote delivery by some means other than Exim.
22757 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22758 option).
22759
22760
22761
22762 .section "The file and directory options" "SECTfildiropt"
22763 The &%file%& option specifies a single file, to which the message is appended;
22764 the &%directory%& option specifies a directory, in which a new file containing
22765 the message is created. Only one of these two options can be set, and for
22766 normal deliveries to mailboxes, one of them &'must'& be set.
22767
22768 .vindex "&$address_file$&"
22769 .vindex "&$local_part$&"
22770 However, &(appendfile)& is also used for delivering messages to files or
22771 directories whose names (or parts of names) are obtained from alias,
22772 forwarding, or filtering operations (for example, a &%save%& command in a
22773 user's Exim filter). When such a transport is running, &$local_part$& contains
22774 the local part that was aliased or forwarded, and &$address_file$& contains the
22775 name (or partial name) of the file or directory generated by the redirection
22776 operation. There are two cases:
22777
22778 .ilist
22779 If neither &%file%& nor &%directory%& is set, the redirection operation
22780 must specify an absolute path (one that begins with &`/`&). This is the most
22781 common case when users with local accounts use filtering to sort mail into
22782 different folders. See for example, the &(address_file)& transport in the
22783 default configuration. If the path ends with a slash, it is assumed to be the
22784 name of a directory. A delivery to a directory can also be forced by setting
22785 &%maildir_format%& or &%mailstore_format%&.
22786 .next
22787 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22788 used to determine the file or directory name for the delivery. Normally, the
22789 contents of &$address_file$& are used in some way in the string expansion.
22790 .endlist
22791 .cindex "tainted data" "in filenames"
22792 .cindex appendfile "tainted data"
22793 Tainted data may not be used for a file or directory name.
22794 This means that, for instance, &$local_part$& cannot be used directly
22795 as a component of a path.  It can however be used as the key for a lookup
22796 which returns a path (or component).
22797
22798
22799 .cindex "Sieve filter" "configuring &(appendfile)&"
22800 .cindex "Sieve filter" "relative mailbox path handling"
22801 As an example of the second case, consider an environment where users do not
22802 have home directories. They may be permitted to use Exim filter commands of the
22803 form:
22804 .code
22805 save folder23
22806 .endd
22807 or Sieve filter commands of the form:
22808 .code
22809 require "fileinto";
22810 fileinto "folder23";
22811 .endd
22812 In this situation, the expansion of &%file%& or &%directory%& in the transport
22813 must transform the relative path into an appropriate absolute filename. In the
22814 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22815 is used as a result of a &"keep"& action in the filter. This example shows one
22816 way of handling this requirement:
22817 .code
22818 file = ${if eq{$address_file}{inbox} \
22819             {/var/mail/$local_part_data} \
22820             {${if eq{${substr_0_1:$address_file}}{/} \
22821                   {$address_file} \
22822                   {$home/mail/$address_file} \
22823             }} \
22824        }
22825 .endd
22826 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22827 location, absolute paths are used without change, and other folders are in the
22828 &_mail_& directory within the home directory.
22829
22830 &*Note 1*&: While processing an Exim filter, a relative path such as
22831 &_folder23_& is turned into an absolute path if a home directory is known to
22832 the router. In particular, this is the case if &%check_local_user%& is set. If
22833 you want to prevent this happening at routing time, you can set
22834 &%router_home_directory%& empty. This forces the router to pass the relative
22835 path to the transport.
22836
22837 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22838 the &%file%& or &%directory%& option is still used if it is set.
22839
22840
22841
22842
22843 .section "Private options for appendfile" "SECID134"
22844 .cindex "options" "&(appendfile)& transport"
22845
22846
22847
22848 .option allow_fifo appendfile boolean false
22849 .cindex "fifo (named pipe)"
22850 .cindex "named pipe (fifo)"
22851 .cindex "pipe" "named (fifo)"
22852 Setting this option permits delivery to named pipes (FIFOs) as well as to
22853 regular files. If no process is reading the named pipe at delivery time, the
22854 delivery is deferred.
22855
22856
22857 .option allow_symlink appendfile boolean false
22858 .cindex "symbolic link" "to mailbox"
22859 .cindex "mailbox" "symbolic link"
22860 By default, &(appendfile)& will not deliver if the path name for the file is
22861 that of a symbolic link. Setting this option relaxes that constraint, but there
22862 are security issues involved in the use of symbolic links. Be sure you know
22863 what you are doing if you set this. Details of exactly what this option affects
22864 are included in the discussion which follows this list of options.
22865
22866
22867 .option batch_id appendfile string&!! unset
22868 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22869 However, batching is automatically disabled for &(appendfile)& deliveries that
22870 happen as a result of forwarding or aliasing or other redirection directly to a
22871 file.
22872
22873
22874 .option batch_max appendfile integer 1
22875 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22876
22877
22878 .option check_group appendfile boolean false
22879 When this option is set, the group owner of the file defined by the &%file%&
22880 option is checked to see that it is the same as the group under which the
22881 delivery process is running. The default setting is false because the default
22882 file mode is 0600, which means that the group is irrelevant.
22883
22884
22885 .option check_owner appendfile boolean true
22886 When this option is set, the owner of the file defined by the &%file%& option
22887 is checked to ensure that it is the same as the user under which the delivery
22888 process is running.
22889
22890
22891 .option check_string appendfile string "see below"
22892 .cindex "&""From""& line"
22893 As &(appendfile)& writes the message, the start of each line is tested for
22894 matching &%check_string%&, and if it does, the initial matching characters are
22895 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22896 a literal string, not a regular expression, and the case of any letters it
22897 contains is significant.
22898
22899 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22900 are forced to &"."& and &".."& respectively, and any settings in the
22901 configuration are ignored. Otherwise, they default to &"From&~"& and
22902 &">From&~"& when the &%file%& option is set, and unset when any of the
22903 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22904
22905 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22906 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22907 &"From&~"& indicates the start of a new message. All four options need changing
22908 if another format is used. For example, to deliver to mailboxes in MMDF format:
22909 .cindex "MMDF format mailbox"
22910 .cindex "mailbox" "MMDF format"
22911 .code
22912 check_string = "\1\1\1\1\n"
22913 escape_string = "\1\1\1\1 \n"
22914 message_prefix = "\1\1\1\1\n"
22915 message_suffix = "\1\1\1\1\n"
22916 .endd
22917 .option create_directory appendfile boolean true
22918 .cindex "directory creation"
22919 When this option is true, Exim attempts to create any missing superior
22920 directories for the file that it is about to write. A created directory's mode
22921 is given by the &%directory_mode%& option.
22922
22923 The group ownership of a newly created directory is highly dependent on the
22924 operating system (and possibly the file system) that is being used. For
22925 example, in Solaris, if the parent directory has the setgid bit set, its group
22926 is propagated to the child; if not, the currently set group is used. However,
22927 in FreeBSD, the parent's group is always used.
22928
22929
22930
22931 .option create_file appendfile string anywhere
22932 This option constrains the location of files and directories that are created
22933 by this transport. It applies to files defined by the &%file%& option and
22934 directories defined by the &%directory%& option. In the case of maildir
22935 delivery, it applies to the top level directory, not the maildir directories
22936 beneath.
22937
22938 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22939 &"belowhome"&. In the second and third cases, a home directory must have been
22940 set for the transport. This option is not useful when an explicit filename is
22941 given for normal mailbox deliveries. It is intended for the case when filenames
22942 are generated from users' &_.forward_& files. These are usually handled
22943 by an &(appendfile)& transport called &%address_file%&. See also
22944 &%file_must_exist%&.
22945
22946
22947 .option directory appendfile string&!! unset
22948 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22949 or &%directory%& must be set, unless the delivery is the direct result of a
22950 redirection (see section &<<SECTfildiropt>>&).
22951
22952 When &%directory%& is set, the string is expanded, and the message is delivered
22953 into a new file or files in or below the given directory, instead of being
22954 appended to a single mailbox file. A number of different formats are provided
22955 (see &%maildir_format%& and &%mailstore_format%&), and see section
22956 &<<SECTopdir>>& for further details of this form of delivery.
22957
22958
22959 .option directory_file appendfile string&!! "see below"
22960 .cindex "base62"
22961 .vindex "&$inode$&"
22962 When &%directory%& is set, but neither &%maildir_format%& nor
22963 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22964 whose name is obtained by expanding this string. The default value is:
22965 .code
22966 q${base62:$tod_epoch}-$inode
22967 .endd
22968 This generates a unique name from the current time, in base 62 form, and the
22969 inode of the file. The variable &$inode$& is available only when expanding this
22970 option.
22971
22972
22973 .option directory_mode appendfile "octal integer" 0700
22974 If &(appendfile)& creates any directories as a result of the
22975 &%create_directory%& option, their mode is specified by this option.
22976
22977
22978 .option escape_string appendfile string "see description"
22979 See &%check_string%& above.
22980
22981
22982 .option file appendfile string&!! unset
22983 This option is mutually exclusive with the &%directory%& option, but one of
22984 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22985 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22986 specifies a single file, to which the message is appended. One or more of
22987 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22988 &%file%&.
22989
22990 .cindex "NFS" "lock file"
22991 .cindex "locking files"
22992 .cindex "lock files"
22993 If you are using more than one host to deliver over NFS into the same
22994 mailboxes, you should always use lock files.
22995
22996 The string value is expanded for each delivery, and must yield an absolute
22997 path. The most common settings of this option are variations on one of these
22998 examples:
22999 .code
23000 file = /var/spool/mail/$local_part_data
23001 file = /home/$local_part_data/inbox
23002 file = $home/inbox
23003 .endd
23004 .cindex "&""sticky""& bit"
23005 In the first example, all deliveries are done into the same directory. If Exim
23006 is configured to use lock files (see &%use_lockfile%& below) it must be able to
23007 create a file in the directory, so the &"sticky"& bit must be turned on for
23008 deliveries to be possible, or alternatively the &%group%& option can be used to
23009 run the delivery under a group id which has write access to the directory.
23010
23011
23012
23013 .option file_format appendfile string unset
23014 .cindex "file" "mailbox; checking existing format"
23015 This option requests the transport to check the format of an existing file
23016 before adding to it. The check consists of matching a specific string at the
23017 start of the file. The value of the option consists of an even number of
23018 colon-separated strings. The first of each pair is the test string, and the
23019 second is the name of a transport. If the transport associated with a matched
23020 string is not the current transport, control is passed over to the other
23021 transport. For example, suppose the standard &(local_delivery)& transport has
23022 this added to it:
23023 .code
23024 file_format = "From       : local_delivery :\
23025                \1\1\1\1\n : local_mmdf_delivery"
23026 .endd
23027 Mailboxes that begin with &"From"& are still handled by this transport, but if
23028 a mailbox begins with four binary ones followed by a newline, control is passed
23029 to a transport called &%local_mmdf_delivery%&, which presumably is configured
23030 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
23031 is assumed to match the current transport. If the start of a mailbox doesn't
23032 match any string, or if the transport named for a given string is not defined,
23033 delivery is deferred.
23034
23035
23036 .option file_must_exist appendfile boolean false
23037 If this option is true, the file specified by the &%file%& option must exist.
23038 A temporary error occurs if it does not, causing delivery to be deferred.
23039 If this option is false, the file is created if it does not exist.
23040
23041
23042 .option lock_fcntl_timeout appendfile time 0s
23043 .cindex "timeout" "mailbox locking"
23044 .cindex "mailbox" "locking, blocking and non-blocking"
23045 .cindex "locking files"
23046 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
23047 when locking an open mailbox file. If the call fails, the delivery process
23048 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
23049 Non-blocking calls are used so that the file is not kept open during the wait
23050 for the lock; the reason for this is to make it as safe as possible for
23051 deliveries over NFS in the case when processes might be accessing an NFS
23052 mailbox without using a lock file. This should not be done, but
23053 misunderstandings and hence misconfigurations are not unknown.
23054
23055 On a busy system, however, the performance of a non-blocking lock approach is
23056 not as good as using a blocking lock with a timeout. In this case, the waiting
23057 is done inside the system call, and Exim's delivery process acquires the lock
23058 and can proceed as soon as the previous lock holder releases it.
23059
23060 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
23061 timeout, are used. There may still be some retrying: the maximum number of
23062 retries is
23063 .code
23064 (lock_retries * lock_interval) / lock_fcntl_timeout
23065 .endd
23066 rounded up to the next whole number. In other words, the total time during
23067 which &(appendfile)& is trying to get a lock is roughly the same, unless
23068 &%lock_fcntl_timeout%& is set very large.
23069
23070 You should consider setting this option if you are getting a lot of delayed
23071 local deliveries because of errors of the form
23072 .code
23073 failed to lock mailbox /some/file (fcntl)
23074 .endd
23075
23076 .option lock_flock_timeout appendfile time 0s
23077 This timeout applies to file locking when using &[flock()]& (see
23078 &%use_flock%&); the timeout operates in a similar manner to
23079 &%lock_fcntl_timeout%&.
23080
23081
23082 .option lock_interval appendfile time 3s
23083 This specifies the time to wait between attempts to lock the file. See below
23084 for details of locking.
23085
23086
23087 .option lock_retries appendfile integer 10
23088 This specifies the maximum number of attempts to lock the file. A value of zero
23089 is treated as 1. See below for details of locking.
23090
23091
23092 .option lockfile_mode appendfile "octal integer" 0600
23093 This specifies the mode of the created lock file, when a lock file is being
23094 used (see &%use_lockfile%& and &%use_mbx_lock%&).
23095
23096
23097 .option lockfile_timeout appendfile time 30m
23098 .cindex "timeout" "mailbox locking"
23099 When a lock file is being used (see &%use_lockfile%&), if a lock file already
23100 exists and is older than this value, it is assumed to have been left behind by
23101 accident, and Exim attempts to remove it.
23102
23103
23104 .option mailbox_filecount appendfile string&!! unset
23105 .cindex "mailbox" "specifying size of"
23106 .cindex "size" "of mailbox"
23107 If this option is set, it is expanded, and the result is taken as the current
23108 number of files in the mailbox. It must be a decimal number, optionally
23109 followed by K or M. This provides a way of obtaining this information from an
23110 external source that maintains the data.
23111
23112
23113 .option mailbox_size appendfile string&!! unset
23114 .cindex "mailbox" "specifying size of"
23115 .cindex "size" "of mailbox"
23116 If this option is set, it is expanded, and the result is taken as the current
23117 size the mailbox. It must be a decimal number, optionally followed by K or M.
23118 This provides a way of obtaining this information from an external source that
23119 maintains the data. This is likely to be helpful for maildir deliveries where
23120 it is computationally expensive to compute the size of a mailbox.
23121
23122
23123
23124 .option maildir_format appendfile boolean false
23125 .cindex "maildir format" "specifying"
23126 If this option is set with the &%directory%& option, the delivery is into a new
23127 file, in the &"maildir"& format that is used by other mail software. When the
23128 transport is activated directly from a &(redirect)& router (for example, the
23129 &(address_file)& transport in the default configuration), setting
23130 &%maildir_format%& causes the path received from the router to be treated as a
23131 directory, whether or not it ends with &`/`&. This option is available only if
23132 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
23133 &<<SECTmaildirdelivery>>& below for further details.
23134
23135
23136 .option maildir_quota_directory_regex appendfile string "See below"
23137 .cindex "maildir format" "quota; directories included in"
23138 .cindex "quota" "maildir; directories included in"
23139 This option is relevant only when &%maildir_use_size_file%& is set. It defines
23140 a regular expression for specifying directories, relative to the quota
23141 directory (see &%quota_directory%&), that should be included in the quota
23142 calculation. The default value is:
23143 .code
23144 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
23145 .endd
23146 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
23147 (directories whose names begin with a dot). If you want to exclude the
23148 &_Trash_&
23149 folder from the count (as some sites do), you need to change this setting to
23150 .code
23151 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
23152 .endd
23153 This uses a negative lookahead in the regular expression to exclude the
23154 directory whose name is &_.Trash_&. When a directory is excluded from quota
23155 calculations, quota processing is bypassed for any messages that are delivered
23156 directly into that directory.
23157
23158
23159 .option maildir_retries appendfile integer 10
23160 This option specifies the number of times to retry when writing a file in
23161 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
23162
23163
23164 .option maildir_tag appendfile string&!! unset
23165 This option applies only to deliveries in maildir format, and is described in
23166 section &<<SECTmaildirdelivery>>& below.
23167
23168
23169 .option maildir_use_size_file appendfile&!! boolean false
23170 .cindex "maildir format" "&_maildirsize_& file"
23171 The result of string expansion for this option must be a valid boolean value.
23172 If it is true, it enables support for &_maildirsize_& files. Exim
23173 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
23174 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
23175 value is zero. See &%maildir_quota_directory_regex%& above and section
23176 &<<SECTmaildirdelivery>>& below for further details.
23177
23178 .option maildirfolder_create_regex appendfile string unset
23179 .cindex "maildir format" "&_maildirfolder_& file"
23180 .cindex "&_maildirfolder_&, creating"
23181 The value of this option is a regular expression. If it is unset, it has no
23182 effect. Otherwise, before a maildir delivery takes place, the pattern is
23183 matched against the name of the maildir directory, that is, the directory
23184 containing the &_new_& and &_tmp_& subdirectories that will be used for the
23185 delivery. If there is a match, Exim checks for the existence of a file called
23186 &_maildirfolder_& in the directory, and creates it if it does not exist.
23187 See section &<<SECTmaildirdelivery>>& for more details.
23188
23189
23190 .option mailstore_format appendfile boolean false
23191 .cindex "mailstore format" "specifying"
23192 If this option is set with the &%directory%& option, the delivery is into two
23193 new files in  &"mailstore"& format. The option is available only if
23194 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
23195 below for further details.
23196
23197
23198 .option mailstore_prefix appendfile string&!! unset
23199 This option applies only to deliveries in mailstore format, and is described in
23200 section &<<SECTopdir>>& below.
23201
23202
23203 .option mailstore_suffix appendfile string&!! unset
23204 This option applies only to deliveries in mailstore format, and is described in
23205 section &<<SECTopdir>>& below.
23206
23207
23208 .option mbx_format appendfile boolean false
23209 .cindex "locking files"
23210 .cindex "file" "locking"
23211 .cindex "file" "MBX format"
23212 .cindex "MBX format, specifying"
23213 This option is available only if Exim has been compiled with SUPPORT_MBX
23214 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
23215 the message is appended to the mailbox file in MBX format instead of
23216 traditional Unix format. This format is supported by Pine4 and its associated
23217 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
23218
23219 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
23220 automatically changed by the use of &%mbx_format%&. They should normally be set
23221 empty when using MBX format, so this option almost always appears in this
23222 combination:
23223 .code
23224 mbx_format = true
23225 message_prefix =
23226 message_suffix =
23227 .endd
23228 If none of the locking options are mentioned in the configuration,
23229 &%use_mbx_lock%& is assumed and the other locking options default to false. It
23230 is possible to specify the other kinds of locking with &%mbx_format%&, but
23231 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
23232 interworks with &'c-client'&, providing for shared access to the mailbox. It
23233 should not be used if any program that does not use this form of locking is
23234 going to access the mailbox, nor should it be used if the mailbox file is NFS
23235 mounted, because it works only when the mailbox is accessed from a single host.
23236
23237 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
23238 the standard version of &'c-client'&, because as long as it has a mailbox open
23239 (this means for the whole of a Pine or IMAP session), Exim will not be able to
23240 append messages to it.
23241
23242
23243 .option message_prefix appendfile string&!! "see below"
23244 .cindex "&""From""& line"
23245 The string specified here is expanded and output at the start of every message.
23246 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23247 in which case it is:
23248 .code
23249 message_prefix = "From ${if def:return_path{$return_path}\
23250   {MAILER-DAEMON}} $tod_bsdinbox\n"
23251 .endd
23252 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23253 &`\n`& to &`\r\n`& in &%message_prefix%&.
23254
23255 .option message_suffix appendfile string&!! "see below"
23256 The string specified here is expanded and output at the end of every message.
23257 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
23258 in which case it is a single newline character. The suffix can be suppressed by
23259 setting
23260 .code
23261 message_suffix =
23262 .endd
23263 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23264 &`\n`& to &`\r\n`& in &%message_suffix%&.
23265
23266 .option mode appendfile "octal integer" 0600
23267 If the output file is created, it is given this mode. If it already exists and
23268 has wider permissions, they are reduced to this mode. If it has narrower
23269 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
23270 if the delivery is the result of a &%save%& command in a filter file specifying
23271 a particular mode, the mode of the output file is always forced to take that
23272 value, and this option is ignored.
23273
23274
23275 .option mode_fail_narrower appendfile boolean true
23276 This option applies in the case when an existing mailbox file has a narrower
23277 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
23278 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
23279 continues with the delivery attempt, using the existing mode of the file.
23280
23281
23282 .option notify_comsat appendfile boolean false
23283 If this option is true, the &'comsat'& daemon is notified after every
23284 successful delivery to a user mailbox. This is the daemon that notifies logged
23285 on users about incoming mail.
23286
23287
23288 .option quota appendfile string&!! unset
23289 .cindex "quota" "imposed by Exim"
23290 This option imposes a limit on the size of the file to which Exim is appending,
23291 or to the total space used in the directory tree when the &%directory%& option
23292 is set. In the latter case, computation of the space used is expensive, because
23293 all the files in the directory (and any sub-directories) have to be
23294 individually inspected and their sizes summed. (See &%quota_size_regex%& and
23295 &%maildir_use_size_file%& for ways to avoid this in environments where users
23296 have no shell access to their mailboxes).
23297
23298 As there is no interlock against two simultaneous deliveries into a
23299 multi-file mailbox, it is possible for the quota to be overrun in this case.
23300 For single-file mailboxes, of course, an interlock is a necessity.
23301
23302 A file's size is taken as its &'used'& value. Because of blocking effects, this
23303 may be a lot less than the actual amount of disk space allocated to the file.
23304 If the sizes of a number of files are being added up, the rounding effect can
23305 become quite noticeable, especially on systems that have large block sizes.
23306 Nevertheless, it seems best to stick to the &'used'& figure, because this is
23307 the obvious value which users understand most easily.
23308
23309 The value of the option is expanded, and must then be a numerical value
23310 (decimal point allowed), optionally followed by one of the letters K, M, or G,
23311 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
23312 and further option modifiers. If Exim is running on a system with
23313 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
23314 be handled.
23315
23316 The option modifier &%no_check%& can be used to force delivery even if the over
23317 quota condition is met. The quota gets updated as usual.
23318
23319 &*Note*&: A value of zero is interpreted as &"no quota"&.
23320
23321 The expansion happens while Exim is running as root, before it changes uid for
23322 the delivery. This means that files that are inaccessible to the end user can
23323 be used to hold quota values that are looked up in the expansion. When delivery
23324 fails because this quota is exceeded, the handling of the error is as for
23325 system quota failures.
23326
23327 By default, Exim's quota checking mimics system quotas, and restricts the
23328 mailbox to the specified maximum size, though the value is not accurate to the
23329 last byte, owing to separator lines and additional headers that may get added
23330 during message delivery. When a mailbox is nearly full, large messages may get
23331 refused even though small ones are accepted, because the size of the current
23332 message is added to the quota when the check is made. This behaviour can be
23333 changed by setting &%quota_is_inclusive%& false. When this is done, the check
23334 for exceeding the quota does not include the current message. Thus, deliveries
23335 continue until the quota has been exceeded; thereafter, no further messages are
23336 delivered. See also &%quota_warn_threshold%&.
23337
23338
23339 .option quota_directory appendfile string&!! unset
23340 This option defines the directory to check for quota purposes when delivering
23341 into individual files. The default is the delivery directory, or, if a file
23342 called &_maildirfolder_& exists in a maildir directory, the parent of the
23343 delivery directory.
23344
23345
23346 .option quota_filecount appendfile string&!! 0
23347 This option applies when the &%directory%& option is set. It limits the total
23348 number of files in the directory (compare the inode limit in system quotas). It
23349 can only be used if &%quota%& is also set. The value is expanded; an expansion
23350 failure causes delivery to be deferred. A value of zero is interpreted as
23351 &"no quota"&.
23352
23353 The option modifier &%no_check%& can be used to force delivery even if the over
23354 quota condition is met. The quota gets updated as usual.
23355
23356 .option quota_is_inclusive appendfile boolean true
23357 See &%quota%& above.
23358
23359
23360 .option quota_size_regex appendfile string unset
23361 This option applies when one of the delivery modes that writes a separate file
23362 for each message is being used. When Exim wants to find the size of one of
23363 these files in order to test the quota, it first checks &%quota_size_regex%&.
23364 If this is set to a regular expression that matches the filename, and it
23365 captures one string, that string is interpreted as a representation of the
23366 file's size. The value of &%quota_size_regex%& is not expanded.
23367
23368 This feature is useful only when users have no shell access to their mailboxes
23369 &-- otherwise they could defeat the quota simply by renaming the files. This
23370 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
23371 the file length to the filename. For example:
23372 .code
23373 maildir_tag = ,S=$message_size
23374 quota_size_regex = ,S=(\d+)
23375 .endd
23376 An alternative to &$message_size$& is &$message_linecount$&, which contains the
23377 number of lines in the message.
23378
23379 The regular expression should not assume that the length is at the end of the
23380 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
23381 sometimes add other information onto the ends of message filenames.
23382
23383 Section &<<SECID136>>& contains further information.
23384
23385 This option should not be used when other message-handling software
23386 may duplicate messages by making hardlinks to the files.  When that is done Exim
23387 will count the message size once for each filename, in contrast with the actual
23388 disk usage.  When the option is not set, calculating total usage requires
23389 a system-call per file to get the size; the number of links is then available also
23390 as is used to adjust the effective size.
23391
23392
23393 .option quota_warn_message appendfile string&!! "see below"
23394 See below for the use of this option. If it is not set when
23395 &%quota_warn_threshold%& is set, it defaults to
23396 .code
23397 quota_warn_message = "\
23398   To: $local_part@$domain\n\
23399   Subject: Your mailbox\n\n\
23400   This message is automatically created \
23401   by mail delivery software.\n\n\
23402   The size of your mailbox has exceeded \
23403   a warning threshold that is\n\
23404   set by the system administrator.\n"
23405 .endd
23406
23407
23408 .option quota_warn_threshold appendfile string&!! 0
23409 .cindex "quota" "warning threshold"
23410 .cindex "mailbox" "size warning"
23411 .cindex "size" "of mailbox"
23412 This option is expanded in the same way as &%quota%& (see above). If the
23413 resulting value is greater than zero, and delivery of the message causes the
23414 size of the file or total space in the directory tree to cross the given
23415 threshold, a warning message is sent. If &%quota%& is also set, the threshold
23416 may be specified as a percentage of it by following the value with a percent
23417 sign. For example:
23418 .code
23419 quota = 10M
23420 quota_warn_threshold = 75%
23421 .endd
23422 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
23423 percent sign is ignored.
23424
23425 The warning message itself is specified by the &%quota_warn_message%& option,
23426 and it must start with a &'To:'& header line containing the recipient(s) of the
23427 warning message. These do not necessarily have to include the recipient(s) of
23428 the original message. A &'Subject:'& line should also normally be supplied. You
23429 can include any other header lines that you want. If you do not include a
23430 &'From:'& line, the default is:
23431 .code
23432 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
23433 .endd
23434 .oindex &%errors_reply_to%&
23435 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
23436 option.
23437
23438 The &%quota%& option does not have to be set in order to use this option; they
23439 are independent of one another except when the threshold is specified as a
23440 percentage.
23441
23442
23443 .option use_bsmtp appendfile boolean false
23444 .cindex "envelope from"
23445 .cindex "envelope sender"
23446 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
23447 format, with the envelope sender and recipient(s) included as SMTP commands. If
23448 you want to include a leading HELO command with such messages, you can do
23449 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
23450 for details of batch SMTP.
23451
23452
23453 .option use_crlf appendfile boolean false
23454 .cindex "carriage return"
23455 .cindex "linefeed"
23456 This option causes lines to be terminated with the two-character CRLF sequence
23457 (carriage return, linefeed) instead of just a linefeed character. In the case
23458 of batched SMTP, the byte sequence written to the file is then an exact image
23459 of what would be sent down a real SMTP connection.
23460
23461 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
23462 (which are used to supply the traditional &"From&~"& and blank line separators
23463 in Berkeley-style mailboxes) are written verbatim, so must contain their own
23464 carriage return characters if these are needed. In cases where these options
23465 have non-empty defaults, the values end with a single linefeed, so they must be
23466 changed to end with &`\r\n`& if &%use_crlf%& is set.
23467
23468
23469 .option use_fcntl_lock appendfile boolean "see below"
23470 This option controls the use of the &[fcntl()]& function to lock a file for
23471 exclusive use when a message is being appended. It is set by default unless
23472 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
23473 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
23474 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
23475
23476
23477 .option use_flock_lock appendfile boolean false
23478 This option is provided to support the use of &[flock()]& for file locking, for
23479 the few situations where it is needed. Most modern operating systems support
23480 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
23481 each other. Exim uses &[fcntl()]& locking by default.
23482
23483 This option is required only if you are using an operating system where
23484 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
23485 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
23486 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
23487
23488 .cindex "Solaris" "&[flock()]& support"
23489 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
23490 have it (and some, I think, provide a not quite right version built on top of
23491 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
23492 the ability to use it, and any attempt to do so will cause a configuration
23493 error.
23494
23495 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
23496 is just being mapped onto &[fcntl()]& by the OS).
23497
23498
23499 .option use_lockfile appendfile boolean "see below"
23500 If this option is turned off, Exim does not attempt to create a lock file when
23501 appending to a mailbox file. In this situation, the only locking is by
23502 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
23503 sure that every MUA that is ever going to look at your users' mailboxes uses
23504 &[fcntl()]& rather than a lock file, and even then only when you are not
23505 delivering over NFS from more than one host.
23506
23507 .cindex "NFS" "lock file"
23508 In order to append to an NFS file safely from more than one host, it is
23509 necessary to take out a lock &'before'& opening the file, and the lock file
23510 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
23511 file corruption.
23512
23513 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
23514 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
23515 except when &%mbx_format%& is set.
23516
23517
23518 .option use_mbx_lock appendfile boolean "see below"
23519 This option is available only if Exim has been compiled with SUPPORT_MBX
23520 set in &_Local/Makefile_&. Setting the option specifies that special MBX
23521 locking rules be used. It is set by default if &%mbx_format%& is set and none
23522 of the locking options are mentioned in the configuration. The locking rules
23523 are the same as are used by the &'c-client'& library that underlies Pine and
23524 the IMAP4 and POP daemons that come with it (see the discussion below). The
23525 rules allow for shared access to the mailbox. However, this kind of locking
23526 does not work when the mailbox is NFS mounted.
23527
23528 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
23529 &%use_flock_lock%& to control what kind of locking is used in implementing the
23530 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
23531 without &%use_fcntl_lock%& or &%use_flock_lock%&.
23532
23533
23534
23535
23536 .section "Operational details for appending" "SECTopappend"
23537 .cindex "appending to a file"
23538 .cindex "file" "appending"
23539 Before appending to a file, the following preparations are made:
23540
23541 .ilist
23542 If the name of the file is &_/dev/null_&, no action is taken, and a success
23543 return is given.
23544
23545 .next
23546 .cindex "directory creation"
23547 If any directories on the file's path are missing, Exim creates them if the
23548 &%create_directory%& option is set. A created directory's mode is given by the
23549 &%directory_mode%& option.
23550
23551 .next
23552 If &%file_format%& is set, the format of an existing file is checked. If this
23553 indicates that a different transport should be used, control is passed to that
23554 transport.
23555
23556 .next
23557 .cindex "file" "locking"
23558 .cindex "locking files"
23559 .cindex "NFS" "lock file"
23560 If &%use_lockfile%& is set, a lock file is built in a way that will work
23561 reliably over NFS, as follows:
23562
23563 .olist
23564 Create a &"hitching post"& file whose name is that of the lock file with the
23565 current time, primary host name, and process id added, by opening for writing
23566 as a new file. If this fails with an access error, delivery is deferred.
23567 .next
23568 Close the hitching post file, and hard link it to the lock filename.
23569 .next
23570 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
23571 Unlink the hitching post name.
23572 .next
23573 Otherwise, use &[stat()]& to get information about the hitching post file, and
23574 then unlink hitching post name. If the number of links is exactly two, creation
23575 of the lock file succeeded but something (for example, an NFS server crash and
23576 restart) caused this fact not to be communicated to the &[link()]& call.
23577 .next
23578 If creation of the lock file failed, wait for &%lock_interval%& and try again,
23579 up to &%lock_retries%& times. However, since any program that writes to a
23580 mailbox should complete its task very quickly, it is reasonable to time out old
23581 lock files that are normally the result of user agent and system crashes. If an
23582 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
23583 it before trying again.
23584 .endlist olist
23585
23586 .next
23587 A call is made to &[lstat()]& to discover whether the main file exists, and if
23588 so, what its characteristics are. If &[lstat()]& fails for any reason other
23589 than non-existence, delivery is deferred.
23590
23591 .next
23592 .cindex "symbolic link" "to mailbox"
23593 .cindex "mailbox" "symbolic link"
23594 If the file does exist and is a symbolic link, delivery is deferred, unless the
23595 &%allow_symlink%& option is set, in which case the ownership of the link is
23596 checked, and then &[stat()]& is called to find out about the real file, which
23597 is then subjected to the checks below. The check on the top-level link
23598 ownership prevents one user creating a link for another's mailbox in a sticky
23599 directory, though allowing symbolic links in this case is definitely not a good
23600 idea. If there is a chain of symbolic links, the intermediate ones are not
23601 checked.
23602
23603 .next
23604 If the file already exists but is not a regular file, or if the file's owner
23605 and group (if the group is being checked &-- see &%check_group%& above) are
23606 different from the user and group under which the delivery is running,
23607 delivery is deferred.
23608
23609 .next
23610 If the file's permissions are more generous than specified, they are reduced.
23611 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
23612 is set false, in which case the delivery is tried using the existing
23613 permissions.
23614
23615 .next
23616 The file's inode number is saved, and the file is then opened for appending.
23617 If this fails because the file has vanished, &(appendfile)& behaves as if it
23618 hadn't existed (see below). For any other failures, delivery is deferred.
23619
23620 .next
23621 If the file is opened successfully, check that the inode number hasn't
23622 changed, that it is still a regular file, and that the owner and permissions
23623 have not changed. If anything is wrong, defer delivery and freeze the message.
23624
23625 .next
23626 If the file did not exist originally, defer delivery if the &%file_must_exist%&
23627 option is set. Otherwise, check that the file is being created in a permitted
23628 directory if the &%create_file%& option is set (deferring on failure), and then
23629 open for writing as a new file, with the O_EXCL and O_CREAT options,
23630 except when dealing with a symbolic link (the &%allow_symlink%& option must be
23631 set). In this case, which can happen if the link points to a non-existent file,
23632 the file is opened for writing using O_CREAT but not O_EXCL, because
23633 that prevents link following.
23634
23635 .next
23636 .cindex "loop" "while file testing"
23637 If opening fails because the file exists, obey the tests given above for
23638 existing files. However, to avoid looping in a situation where the file is
23639 being continuously created and destroyed, the exists/not-exists loop is broken
23640 after 10 repetitions, and the message is then frozen.
23641
23642 .next
23643 If opening fails with any other error, defer delivery.
23644
23645 .next
23646 .cindex "file" "locking"
23647 .cindex "locking files"
23648 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
23649 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
23650 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
23651 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
23652 file, and an exclusive lock on the file whose name is
23653 .code
23654 /tmp/.<device-number>.<inode-number>
23655 .endd
23656 using the device and inode numbers of the open mailbox file, in accordance with
23657 the MBX locking rules. This file is created with a mode that is specified by
23658 the &%lockfile_mode%& option.
23659
23660 If Exim fails to lock the file, there are two possible courses of action,
23661 depending on the value of the locking timeout. This is obtained from
23662 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
23663
23664 If the timeout value is zero, the file is closed, Exim waits for
23665 &%lock_interval%&, and then goes back and re-opens the file as above and tries
23666 to lock it again. This happens up to &%lock_retries%& times, after which the
23667 delivery is deferred.
23668
23669 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
23670 &[flock()]& are used (with the given timeout), so there has already been some
23671 waiting involved by the time locking fails. Nevertheless, Exim does not give up
23672 immediately. It retries up to
23673 .code
23674 (lock_retries * lock_interval) / <timeout>
23675 .endd
23676 times (rounded up).
23677 .endlist
23678
23679 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23680 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23681
23682
23683 .section "Operational details for delivery to a new file" "SECTopdir"
23684 .cindex "delivery" "to single file"
23685 .cindex "&""From""& line"
23686 When the &%directory%& option is set instead of &%file%&, each message is
23687 delivered into a newly-created file or set of files. When &(appendfile)& is
23688 activated directly from a &(redirect)& router, neither &%file%& nor
23689 &%directory%& is normally set, because the path for delivery is supplied by the
23690 router. (See for example, the &(address_file)& transport in the default
23691 configuration.) In this case, delivery is to a new file if either the path name
23692 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23693
23694 No locking is required while writing the message to a new file, so the various
23695 locking options of the transport are ignored. The &"From"& line that by default
23696 separates messages in a single file is not normally needed, nor is the escaping
23697 of message lines that start with &"From"&, and there is no need to ensure a
23698 newline at the end of each message. Consequently, the default values for
23699 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23700 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23701
23702 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23703 the files in the delivery directory by default. However, you can specify a
23704 different directory by setting &%quota_directory%&. Also, for maildir
23705 deliveries (see below) the &_maildirfolder_& convention is honoured.
23706
23707
23708 .cindex "maildir format"
23709 .cindex "mailstore format"
23710 There are three different ways in which delivery to individual files can be
23711 done, controlled by the settings of the &%maildir_format%& and
23712 &%mailstore_format%& options. Note that code to support maildir or mailstore
23713 formats is not included in the binary unless SUPPORT_MAILDIR or
23714 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23715
23716 .cindex "directory creation"
23717 In all three cases an attempt is made to create the directory and any necessary
23718 sub-directories if they do not exist, provided that the &%create_directory%&
23719 option is set (the default). The location of a created directory can be
23720 constrained by setting &%create_file%&. A created directory's mode is given by
23721 the &%directory_mode%& option. If creation fails, or if the
23722 &%create_directory%& option is not set when creation is required, delivery is
23723 deferred.
23724
23725
23726
23727 .section "Maildir delivery" "SECTmaildirdelivery"
23728 .cindex "maildir format" "description of"
23729 If the &%maildir_format%& option is true, Exim delivers each message by writing
23730 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23731 directory that is defined by the &%directory%& option (the &"delivery
23732 directory"&). If the delivery is successful, the file is renamed into the
23733 &_new_& subdirectory.
23734
23735 In the filename, <&'stime'&> is the current time of day in seconds, and
23736 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23737 Exim checks that the time-of-day clock has moved on by at least one microsecond
23738 before terminating the delivery process. This guarantees uniqueness for the
23739 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23740 opening it. If any response other than ENOENT (does not exist) is given,
23741 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23742
23743 Before Exim carries out a maildir delivery, it ensures that subdirectories
23744 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23745 do not exist, Exim tries to create them and any superior directories in their
23746 path, subject to the &%create_directory%& and &%create_file%& options. If the
23747 &%maildirfolder_create_regex%& option is set, and the regular expression it
23748 contains matches the delivery directory, Exim also ensures that a file called
23749 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23750 &_maildirfolder_& file cannot be created, delivery is deferred.
23751
23752 These features make it possible to use Exim to create all the necessary files
23753 and directories in a maildir mailbox, including subdirectories for maildir++
23754 folders. Consider this example:
23755 .code
23756 maildir_format = true
23757 directory = /var/mail/$local_part_data\
23758            ${if eq{$local_part_suffix}{}{}\
23759            {/.${substr_1:$local_part_suffix}}}
23760 maildirfolder_create_regex = /\.[^/]+$
23761 .endd
23762 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23763 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23764 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23765 not match this name, so Exim will not look for or create the file
23766 &_/var/mail/pimbo/maildirfolder_&, though it will create
23767 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23768
23769 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23770 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23771 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23772 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23773 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23774
23775 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23776 not inadvertently match the toplevel maildir directory, because a
23777 &_maildirfolder_& file at top level would completely break quota calculations.
23778
23779 .cindex "quota" "in maildir delivery"
23780 .cindex "maildir++"
23781 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23782 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23783 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23784 Exim assumes the directory is a maildir++ folder directory, which is one level
23785 down from the user's top level mailbox directory. This causes it to start at
23786 the parent directory instead of the current directory when calculating the
23787 amount of space used.
23788
23789 One problem with delivering into a multi-file mailbox is that it is
23790 computationally expensive to compute the size of the mailbox for quota
23791 checking. Various approaches have been taken to reduce the amount of work
23792 needed. The next two sections describe two of them. A third alternative is to
23793 use some external process for maintaining the size data, and use the expansion
23794 of the &%mailbox_size%& option as a way of importing it into Exim.
23795
23796
23797
23798
23799 .section "Using tags to record message sizes" "SECID135"
23800 If &%maildir_tag%& is set, the string is expanded for each delivery.
23801 When the maildir file is renamed into the &_new_& sub-directory, the
23802 tag is added to its name. However, if adding the tag takes the length of the
23803 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23804 the tag is dropped and the maildir file is created with no tag.
23805
23806
23807 .vindex "&$message_size$&"
23808 Tags can be used to encode the size of files in their names; see
23809 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23810 happens after the message has been written. The value of the &$message_size$&
23811 variable is set to the number of bytes actually written. If the expansion is
23812 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23813 be deferred. The expanded tag may contain any printing characters except &"/"&.
23814 Non-printing characters in the string are ignored; if the resulting string is
23815 empty, it is ignored. If it starts with an alphanumeric character, a leading
23816 colon is inserted; this default has not proven to be the path that popular
23817 maildir implementations have chosen (but changing it in Exim would break
23818 backwards compatibility).
23819
23820 For one common implementation, you might set:
23821 .code
23822 maildir_tag = ,S=${message_size}
23823 .endd
23824 but you should check the documentation of the other software to be sure.
23825
23826 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23827 as this allows Exim to extract the size from your tag, instead of having to
23828 &[stat()]& each message file.
23829
23830
23831 .section "Using a maildirsize file" "SECID136"
23832 .cindex "quota" "in maildir delivery"
23833 .cindex "maildir format" "&_maildirsize_& file"
23834 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23835 storing quota and message size information in a file called &_maildirsize_&
23836 within the toplevel maildir directory. If this file does not exist, Exim
23837 creates it, setting the quota from the &%quota%& option of the transport. If
23838 the maildir directory itself does not exist, it is created before any attempt
23839 to write a &_maildirsize_& file.
23840
23841 The &_maildirsize_& file is used to hold information about the sizes of
23842 messages in the maildir, thus speeding up quota calculations. The quota value
23843 in the file is just a cache; if the quota is changed in the transport, the new
23844 value overrides the cached value when the next message is delivered. The cache
23845 is maintained for the benefit of other programs that access the maildir and
23846 need to know the quota.
23847
23848 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23849 file is maintained (with a zero quota setting), but no quota is imposed.
23850
23851 A regular expression is available for controlling which directories in the
23852 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23853 See the description of the &%maildir_quota_directory_regex%& option above for
23854 details.
23855
23856
23857 .section "Mailstore delivery" "SECID137"
23858 .cindex "mailstore format" "description of"
23859 If the &%mailstore_format%& option is true, each message is written as two
23860 files in the given directory. A unique base name is constructed from the
23861 message id and the current delivery process, and the files that are written use
23862 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23863 contains the message's envelope, and the &_.msg_& file contains the message
23864 itself. The base name is placed in the variable &$mailstore_basename$&.
23865
23866 During delivery, the envelope is first written to a file with the suffix
23867 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23868 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23869 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23870 file before accessing either of them. An alternative approach is to wait for
23871 the absence of a &_.tmp_& file.
23872
23873 The envelope file starts with any text defined by the &%mailstore_prefix%&
23874 option, expanded and terminated by a newline if there isn't one. Then follows
23875 the sender address on one line, then all the recipient addresses, one per line.
23876 There can be more than one recipient only if the &%batch_max%& option is set
23877 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23878 appended to the file, followed by a newline if it does not end with one.
23879
23880 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23881 failure, it is ignored. Other expansion errors are treated as serious
23882 configuration errors, and delivery is deferred. The variable
23883 &$mailstore_basename$& is available for use during these expansions.
23884
23885
23886 .section "Non-special new file delivery" "SECID138"
23887 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23888 file is created directly in the named directory. For example, when delivering
23889 messages into files in batched SMTP format for later delivery to some host (see
23890 section &<<SECTbatchSMTP>>&), a setting such as
23891 .code
23892 directory = /var/bsmtp/$host
23893 .endd
23894 might be used. A message is written to a file with a temporary name, which is
23895 then renamed when the delivery is complete. The final name is obtained by
23896 expanding the contents of the &%directory_file%& option.
23897 .ecindex IIDapptra1
23898 .ecindex IIDapptra2
23899
23900
23901
23902
23903
23904
23905 . ////////////////////////////////////////////////////////////////////////////
23906 . ////////////////////////////////////////////////////////////////////////////
23907
23908 .chapter "The autoreply transport" "CHID8"
23909 .scindex IIDauttra1 "transports" "&(autoreply)&"
23910 .scindex IIDauttra2 "&(autoreply)& transport"
23911 The &(autoreply)& transport is not a true transport in that it does not cause
23912 the message to be transmitted. Instead, it generates a new mail message as an
23913 automatic reply to the incoming message. &'References:'& and
23914 &'Auto-Submitted:'& header lines are included. These are constructed according
23915 to the rules in RFCs 2822 and 3834, respectively.
23916
23917 If the router that passes the message to this transport does not have the
23918 &%unseen%& option set, the original message (for the current recipient) is not
23919 delivered anywhere. However, when the &%unseen%& option is set on the router
23920 that passes the message to this transport, routing of the address continues, so
23921 another router can set up a normal message delivery.
23922
23923
23924 The &(autoreply)& transport is usually run as the result of mail filtering, a
23925 &"vacation"& message being the standard example. However, it can also be run
23926 directly from a router like any other transport. To reduce the possibility of
23927 message cascades, messages created by the &(autoreply)& transport always have
23928 empty envelope sender addresses, like bounce messages.
23929
23930 The parameters of the message to be sent can be specified in the configuration
23931 by options described below. However, these are used only when the address
23932 passed to the transport does not contain its own reply information. When the
23933 transport is run as a consequence of a
23934 &%mail%&
23935 or &%vacation%& command in a filter file, the parameters of the message are
23936 supplied by the filter, and passed with the address. The transport's options
23937 that define the message are then ignored (so they are not usually set in this
23938 case). The message is specified entirely by the filter or by the transport; it
23939 is never built from a mixture of options. However, the &%file_optional%&,
23940 &%mode%&, and &%return_message%& options apply in all cases.
23941
23942 &(Autoreply)& is implemented as a local transport. When used as a result of a
23943 command in a user's filter file, &(autoreply)& normally runs under the uid and
23944 gid of the user, and with appropriate current and home directories (see chapter
23945 &<<CHAPenvironment>>&).
23946
23947 There is a subtle difference between routing a message to a &(pipe)& transport
23948 that generates some text to be returned to the sender, and routing it to an
23949 &(autoreply)& transport. This difference is noticeable only if more than one
23950 address from the same message is so handled. In the case of a pipe, the
23951 separate outputs from the different addresses are gathered up and returned to
23952 the sender in a single message, whereas if &(autoreply)& is used, a separate
23953 message is generated for each address that is passed to it.
23954
23955 Non-printing characters are not permitted in the header lines generated for the
23956 message that &(autoreply)& creates, with the exception of newlines that are
23957 immediately followed by white space. If any non-printing characters are found,
23958 the transport defers.
23959 Whether characters with the top bit set count as printing characters or not is
23960 controlled by the &%print_topbitchars%& global option.
23961
23962 If any of the generic options for manipulating headers (for example,
23963 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23964 of the original message that is included in the generated message when
23965 &%return_message%& is set. They do not apply to the generated message itself.
23966
23967 .vindex "&$sender_address$&"
23968 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23969 the message, indicating that there were no recipients, it does not treat this
23970 as an error. This means that autoreplies sent to &$sender_address$& when this
23971 is empty (because the incoming message is a bounce message) do not cause
23972 problems. They are just discarded.
23973
23974
23975
23976 .section "Private options for autoreply" "SECID139"
23977 .cindex "options" "&(autoreply)& transport"
23978
23979 .option bcc autoreply string&!! unset
23980 This specifies the addresses that are to receive &"blind carbon copies"& of the
23981 message when the message is specified by the transport.
23982
23983
23984 .option cc autoreply string&!! unset
23985 This specifies recipients of the message and the contents of the &'Cc:'& header
23986 when the message is specified by the transport.
23987
23988
23989 .option file autoreply string&!! unset
23990 The contents of the file are sent as the body of the message when the message
23991 is specified by the transport. If both &%file%& and &%text%& are set, the text
23992 string comes first.
23993
23994
23995 .option file_expand autoreply boolean false
23996 If this is set, the contents of the file named by the &%file%& option are
23997 subjected to string expansion as they are added to the message.
23998
23999
24000 .option file_optional autoreply boolean false
24001 If this option is true, no error is generated if the file named by the &%file%&
24002 option or passed with the address does not exist or cannot be read.
24003
24004
24005 .option from autoreply string&!! unset
24006 This specifies the contents of the &'From:'& header when the message is
24007 specified by the transport.
24008
24009
24010 .option headers autoreply string&!! unset
24011 This specifies additional RFC 2822 headers that are to be added to the message
24012 when the message is specified by the transport. Several can be given by using
24013 &"\n"& to separate them. There is no check on the format.
24014
24015
24016 .option log autoreply string&!! unset
24017 This option names a file in which a record of every message sent is logged when
24018 the message is specified by the transport.
24019
24020
24021 .option mode autoreply "octal integer" 0600
24022 If either the log file or the &"once"& file has to be created, this mode is
24023 used.
24024
24025
24026 .option never_mail autoreply "address list&!!" unset
24027 If any run of the transport creates a message with a recipient that matches any
24028 item in the list, that recipient is quietly discarded. If all recipients are
24029 discarded, no message is created. This applies both when the recipients are
24030 generated by a filter and when they are specified in the transport.
24031
24032
24033
24034 .option once autoreply string&!! unset
24035 This option names a file or DBM database in which a record of each &'To:'&
24036 recipient is kept when the message is specified by the transport. &*Note*&:
24037 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
24038
24039 If &%once%& is unset, or is set to an empty string, the message is always sent.
24040 By default, if &%once%& is set to a non-empty filename, the message
24041 is not sent if a potential recipient is already listed in the database.
24042 However, if the &%once_repeat%& option specifies a time greater than zero, the
24043 message is sent if that much time has elapsed since a message was last sent to
24044 this recipient. A setting of zero time for &%once_repeat%& (the default)
24045 prevents a message from being sent a second time &-- in this case, zero means
24046 infinity.
24047
24048 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
24049 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
24050 greater than zero, it changes the way Exim implements the &%once%& option.
24051 Instead of using a DBM file to record every recipient it sends to, it uses a
24052 regular file, whose size will never get larger than the given value.
24053
24054 In the file, Exim keeps a linear list of recipient addresses and the times at
24055 which they were sent messages. If the file is full when a new address needs to
24056 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
24057 means that a given recipient may receive multiple messages, but at
24058 unpredictable intervals that depend on the rate of turnover of addresses in the
24059 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
24060
24061
24062 .option once_file_size autoreply integer 0
24063 See &%once%& above.
24064
24065
24066 .option once_repeat autoreply time&!! 0s
24067 See &%once%& above.
24068 After expansion, the value of this option must be a valid time value.
24069
24070
24071 .option reply_to autoreply string&!! unset
24072 This specifies the contents of the &'Reply-To:'& header when the message is
24073 specified by the transport.
24074
24075
24076 .option return_message autoreply boolean false
24077 If this is set, a copy of the original message is returned with the new
24078 message, subject to the maximum size set in the &%return_size_limit%& global
24079 configuration option.
24080
24081
24082 .option subject autoreply string&!! unset
24083 This specifies the contents of the &'Subject:'& header when the message is
24084 specified by the transport. It is tempting to quote the original subject in
24085 automatic responses. For example:
24086 .code
24087 subject = Re: $h_subject:
24088 .endd
24089 There is a danger in doing this, however. It may allow a third party to
24090 subscribe your users to an opt-in mailing list, provided that the list accepts
24091 bounce messages as subscription confirmations. Well-managed lists require a
24092 non-bounce message to confirm a subscription, so the danger is relatively
24093 small.
24094
24095
24096
24097 .option text autoreply string&!! unset
24098 This specifies a single string to be used as the body of the message when the
24099 message is specified by the transport. If both &%text%& and &%file%& are set,
24100 the text comes first.
24101
24102
24103 .option to autoreply string&!! unset
24104 This specifies recipients of the message and the contents of the &'To:'& header
24105 when the message is specified by the transport.
24106 .ecindex IIDauttra1
24107 .ecindex IIDauttra2
24108
24109
24110
24111
24112 . ////////////////////////////////////////////////////////////////////////////
24113 . ////////////////////////////////////////////////////////////////////////////
24114
24115 .chapter "The lmtp transport" "CHAPLMTP"
24116 .cindex "transports" "&(lmtp)&"
24117 .cindex "&(lmtp)& transport"
24118 .cindex "LMTP" "over a pipe"
24119 .cindex "LMTP" "over a socket"
24120 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
24121 specified command
24122 or by interacting with a Unix domain socket.
24123 This transport is something of a cross between the &(pipe)& and &(smtp)&
24124 transports. Exim also has support for using LMTP over TCP/IP; this is
24125 implemented as an option for the &(smtp)& transport. Because LMTP is expected
24126 to be of minority interest, the default build-time configure in &_src/EDITME_&
24127 has it commented out. You need to ensure that
24128 .code
24129 TRANSPORT_LMTP=yes
24130 .endd
24131 .cindex "options" "&(lmtp)& transport"
24132 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
24133 included in the Exim binary. The private options of the &(lmtp)& transport are
24134 as follows:
24135
24136 .option batch_id lmtp string&!! unset
24137 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24138
24139
24140 .option batch_max lmtp integer 1
24141 This limits the number of addresses that can be handled in a single delivery.
24142 Most LMTP servers can handle several addresses at once, so it is normally a
24143 good idea to increase this value. See the description of local delivery
24144 batching in chapter &<<CHAPbatching>>&.
24145
24146
24147 .option command lmtp string&!! unset
24148 This option must be set if &%socket%& is not set. The string is a command which
24149 is run in a separate process. It is split up into a command name and list of
24150 arguments, each of which is separately expanded (so expansion cannot change the
24151 number of arguments). The command is run directly, not via a shell. The message
24152 is passed to the new process using the standard input and output to operate the
24153 LMTP protocol.
24154
24155 .option ignore_quota lmtp boolean false
24156 .cindex "LMTP" "ignoring quota errors"
24157 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
24158 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
24159 in its response to the LHLO command.
24160
24161 .option socket lmtp string&!! unset
24162 This option must be set if &%command%& is not set. The result of expansion must
24163 be the name of a Unix domain socket. The transport connects to the socket and
24164 delivers the message to it using the LMTP protocol.
24165
24166
24167 .option timeout lmtp time 5m
24168 The transport is aborted if the created process or Unix domain socket does not
24169 respond to LMTP commands or message input within this timeout. Delivery
24170 is deferred, and will be tried again later. Here is an example of a typical
24171 LMTP transport:
24172 .code
24173 lmtp:
24174   driver = lmtp
24175   command = /some/local/lmtp/delivery/program
24176   batch_max = 20
24177   user = exim
24178 .endd
24179 This delivers up to 20 addresses at a time, in a mixture of domains if
24180 necessary, running as the user &'exim'&.
24181
24182
24183
24184 . ////////////////////////////////////////////////////////////////////////////
24185 . ////////////////////////////////////////////////////////////////////////////
24186
24187 .chapter "The pipe transport" "CHAPpipetransport"
24188 .scindex IIDpiptra1 "transports" "&(pipe)&"
24189 .scindex IIDpiptra2 "&(pipe)& transport"
24190 The &(pipe)& transport is used to deliver messages via a pipe to a command
24191 running in another process. One example is the use of &(pipe)& as a
24192 pseudo-remote transport for passing messages to some other delivery mechanism
24193 (such as UUCP). Another is the use by individual users to automatically process
24194 their incoming messages. The &(pipe)& transport can be used in one of the
24195 following ways:
24196
24197 .ilist
24198 .vindex "&$local_part$&"
24199 A router routes one address to a transport in the normal way, and the
24200 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
24201 contains the local part of the address (as usual), and the command that is run
24202 is specified by the &%command%& option on the transport.
24203 .next
24204 .vindex "&$pipe_addresses$&"
24205 If the &%batch_max%& option is set greater than 1 (the default is 1), the
24206 transport can handle more than one address in a single run. In this case, when
24207 more than one address is routed to the transport, &$local_part$& is not set
24208 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
24209 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
24210 that are routed to the transport.
24211 .next
24212 .vindex "&$address_pipe$&"
24213 A router redirects an address directly to a pipe command (for example, from an
24214 alias or forward file). In this case, &$address_pipe$& contains the text of the
24215 pipe command, and the &%command%& option on the transport is ignored unless
24216 &%force_command%& is set. If only one address is being transported
24217 (&%batch_max%& is not greater than one, or only one address was redirected to
24218 this pipe command), &$local_part$& contains the local part that was redirected.
24219 .endlist
24220
24221
24222 The &(pipe)& transport is a non-interactive delivery method. Exim can also
24223 deliver messages over pipes using the LMTP interactive protocol. This is
24224 implemented by the &(lmtp)& transport.
24225
24226 In the case when &(pipe)& is run as a consequence of an entry in a local user's
24227 &_.forward_& file, the command runs under the uid and gid of that user. In
24228 other cases, the uid and gid have to be specified explicitly, either on the
24229 transport or on the router that handles the address. Current and &"home"&
24230 directories are also controllable. See chapter &<<CHAPenvironment>>& for
24231 details of the local delivery environment and chapter &<<CHAPbatching>>&
24232 for a discussion of local delivery batching.
24233
24234 .cindex "tainted data" "in pipe command"
24235 .cindex pipe "tainted data"
24236 Tainted data may not be used for the command name.
24237
24238
24239 .section "Concurrent delivery" "SECID140"
24240 If two messages arrive at almost the same time, and both are routed to a pipe
24241 delivery, the two pipe transports may be run concurrently. You must ensure that
24242 any pipe commands you set up are robust against this happening. If the commands
24243 write to a file, the &%exim_lock%& utility might be of use.
24244 Alternatively the &%max_parallel%& option could be used with a value
24245 of "1" to enforce serialization.
24246
24247
24248
24249
24250 .section "Returned status and data" "SECID141"
24251 .cindex "&(pipe)& transport" "returned data"
24252 If the command exits with a non-zero return code, the delivery is deemed to
24253 have failed, unless either the &%ignore_status%& option is set (in which case
24254 the return code is treated as zero), or the return code is one of those listed
24255 in the &%temp_errors%& option, which are interpreted as meaning &"try again
24256 later"&. In this case, delivery is deferred. Details of a permanent failure are
24257 logged, but are not included in the bounce message, which merely contains
24258 &"local delivery failed"&.
24259
24260 If the command exits on a signal and the &%freeze_signal%& option is set then
24261 the message will be frozen in the queue. If that option is not set, a bounce
24262 will be sent as normal.
24263
24264 If the return code is greater than 128 and the command being run is a shell
24265 script, it normally means that the script was terminated by a signal whose
24266 value is the return code minus 128. The &%freeze_signal%& option does not
24267 apply in this case.
24268
24269 If Exim is unable to run the command (that is, if &[execve()]& fails), the
24270 return code is set to 127. This is the value that a shell returns if it is
24271 asked to run a non-existent command. The wording for the log line suggests that
24272 a non-existent command may be the problem.
24273
24274 The &%return_output%& option can affect the result of a pipe delivery. If it is
24275 set and the command produces any output on its standard output or standard
24276 error streams, the command is considered to have failed, even if it gave a zero
24277 return code or if &%ignore_status%& is set. The output from the command is
24278 included as part of the bounce message. The &%return_fail_output%& option is
24279 similar, except that output is returned only when the command exits with a
24280 failure return code, that is, a value other than zero or a code that matches
24281 &%temp_errors%&.
24282
24283
24284
24285 .section "How the command is run" "SECThowcommandrun"
24286 .cindex "&(pipe)& transport" "path for command"
24287 The command line is (by default) broken down into a command name and arguments
24288 by the &(pipe)& transport itself. The &%allow_commands%& and
24289 &%restrict_to_path%& options can be used to restrict the commands that may be
24290 run.
24291
24292 .cindex "quoting" "in pipe command"
24293 Unquoted arguments are delimited by white space. If an argument appears in
24294 double quotes, backslash is interpreted as an escape character in the usual
24295 way. If an argument appears in single quotes, no escaping is done.
24296
24297 String expansion is applied to the command line except when it comes from a
24298 traditional &_.forward_& file (commands from a filter file are expanded). The
24299 expansion is applied to each argument in turn rather than to the whole line.
24300 For this reason, any string expansion item that contains white space must be
24301 quoted so as to be contained within a single argument. A setting such as
24302 .code
24303 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
24304 .endd
24305 will not work, because the expansion item gets split between several
24306 arguments. You have to write
24307 .code
24308 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
24309 .endd
24310 to ensure that it is all in one argument. The expansion is done in this way,
24311 argument by argument, so that the number of arguments cannot be changed as a
24312 result of expansion, and quotes or backslashes in inserted variables do not
24313 interact with external quoting. However, this leads to problems if you want to
24314 generate multiple arguments (or the command name plus arguments) from a single
24315 expansion. In this situation, the simplest solution is to use a shell. For
24316 example:
24317 .code
24318 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
24319 .endd
24320
24321 .cindex "transport" "filter"
24322 .cindex "filter" "transport filter"
24323 .vindex "&$pipe_addresses$&"
24324 Special handling takes place when an argument consists of precisely the text
24325 &`$pipe_addresses`& (no quotes).
24326 This is not a general expansion variable; the only
24327 place this string is recognized is when it appears as an argument for a pipe or
24328 transport filter command. It causes each address that is being handled to be
24329 inserted in the argument list at that point &'as a separate argument'&. This
24330 avoids any problems with spaces or shell metacharacters, and is of use when a
24331 &(pipe)& transport is handling groups of addresses in a batch.
24332
24333 If &%force_command%& is enabled on the transport, special handling takes place
24334 for an argument that consists of precisely the text &`$address_pipe`&.  It
24335 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
24336 argument is inserted in the argument list at that point
24337 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
24338 the only item in the argument; in fact, if it were then &%force_command%&
24339 should behave as a no-op.  Rather, it should be used to adjust the command
24340 run while preserving the argument vector separation.
24341
24342 After splitting up into arguments and expansion, the resulting command is run
24343 in a subprocess directly from the transport, &'not'& under a shell. The
24344 message that is being delivered is supplied on the standard input, and the
24345 standard output and standard error are both connected to a single pipe that is
24346 read by Exim. The &%max_output%& option controls how much output the command
24347 may produce, and the &%return_output%& and &%return_fail_output%& options
24348 control what is done with it.
24349
24350 Not running the command under a shell (by default) lessens the security risks
24351 in cases when a command from a user's filter file is built out of data that was
24352 taken from an incoming message. If a shell is required, it can of course be
24353 explicitly specified as the command to be run. However, there are circumstances
24354 where existing commands (for example, in &_.forward_& files) expect to be run
24355 under a shell and cannot easily be modified. To allow for these cases, there is
24356 an option called &%use_shell%&, which changes the way the &(pipe)& transport
24357 works. Instead of breaking up the command line as just described, it expands it
24358 as a single string and passes the result to &_/bin/sh_&. The
24359 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
24360 with &%use_shell%&, and the whole mechanism is inherently less secure.
24361
24362
24363
24364 .section "Environment variables" "SECTpipeenv"
24365 .cindex "&(pipe)& transport" "environment for command"
24366 .cindex "environment" "&(pipe)& transport"
24367 The environment variables listed below are set up when the command is invoked.
24368 This list is a compromise for maximum compatibility with other MTAs. Note that
24369 the &%environment%& option can be used to add additional variables to this
24370 environment. The environment for the &(pipe)& transport is not subject
24371 to the &%add_environment%& and &%keep_environment%& main config options.
24372 .display
24373 &`DOMAIN            `&   the domain of the address
24374 &`HOME              `&   the home directory, if set
24375 &`HOST              `&   the host name when called from a router (see below)
24376 &`LOCAL_PART        `&   see below
24377 &`LOCAL_PART_PREFIX `&   see below
24378 &`LOCAL_PART_SUFFIX `&   see below
24379 &`LOGNAME           `&   see below
24380 &`MESSAGE_ID        `&   Exim's local ID for the message
24381 &`PATH              `&   as specified by the &%path%& option below
24382 &`QUALIFY_DOMAIN    `&   the sender qualification domain
24383 &`RECIPIENT         `&   the complete recipient address
24384 &`SENDER            `&   the sender of the message (empty if a bounce)
24385 &`SHELL             `&   &`/bin/sh`&
24386 &`TZ                `&   the value of the &%timezone%& option, if set
24387 &`USER              `&   see below
24388 .endd
24389 When a &(pipe)& transport is called directly from (for example) an &(accept)&
24390 router, LOCAL_PART is set to the local part of the address. When it is
24391 called as a result of a forward or alias expansion, LOCAL_PART is set to
24392 the local part of the address that was expanded. In both cases, any affixes are
24393 removed from the local part, and made available in LOCAL_PART_PREFIX and
24394 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
24395 same value as LOCAL_PART for compatibility with other MTAs.
24396
24397 .cindex "HOST"
24398 HOST is set only when a &(pipe)& transport is called from a router that
24399 associates hosts with an address, typically when using &(pipe)& as a
24400 pseudo-remote transport. HOST is set to the first host name specified by
24401 the router.
24402
24403 .cindex "HOME"
24404 If the transport's generic &%home_directory%& option is set, its value is used
24405 for the HOME environment variable. Otherwise, a home directory may be set
24406 by the router's &%transport_home_directory%& option, which defaults to the
24407 user's home directory if &%check_local_user%& is set.
24408
24409
24410 .section "Private options for pipe" "SECID142"
24411 .cindex "options" "&(pipe)& transport"
24412
24413
24414
24415 .option allow_commands pipe "string list&!!" unset
24416 .cindex "&(pipe)& transport" "permitted commands"
24417 The string is expanded, and is then interpreted as a colon-separated list of
24418 permitted commands. If &%restrict_to_path%& is not set, the only commands
24419 permitted are those in the &%allow_commands%& list. They need not be absolute
24420 paths; the &%path%& option is still used for relative paths. If
24421 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
24422 in the &%allow_commands%& list, or a name without any slashes that is found on
24423 the path. In other words, if neither &%allow_commands%& nor
24424 &%restrict_to_path%& is set, there is no restriction on the command, but
24425 otherwise only commands that are permitted by one or the other are allowed. For
24426 example, if
24427 .code
24428 allow_commands = /usr/bin/vacation
24429 .endd
24430 and &%restrict_to_path%& is not set, the only permitted command is
24431 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
24432 &%use_shell%& is set.
24433
24434
24435 .option batch_id pipe string&!! unset
24436 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24437
24438
24439 .option batch_max pipe integer 1
24440 This limits the number of addresses that can be handled in a single delivery.
24441 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
24442
24443
24444 .option check_string pipe string unset
24445 As &(pipe)& writes the message, the start of each line is tested for matching
24446 &%check_string%&, and if it does, the initial matching characters are replaced
24447 by the contents of &%escape_string%&, provided both are set. The value of
24448 &%check_string%& is a literal string, not a regular expression, and the case of
24449 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
24450 of &%check_string%& and &%escape_string%& are forced to values that implement
24451 the SMTP escaping protocol. Any settings made in the configuration file are
24452 ignored.
24453
24454
24455 .option command pipe string&!! unset
24456 This option need not be set when &(pipe)& is being used to deliver to pipes
24457 obtained directly from address redirections. In other cases, the option must be
24458 set, to provide a command to be run. It need not yield an absolute path (see
24459 the &%path%& option below). The command is split up into separate arguments by
24460 Exim, and each argument is separately expanded, as described in section
24461 &<<SECThowcommandrun>>& above.
24462
24463
24464 .option environment pipe string&!! unset
24465 .cindex "&(pipe)& transport" "environment for command"
24466 .cindex "environment" "&(pipe)& transport"
24467 This option is used to add additional variables to the environment in which the
24468 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
24469 a string which is expanded, and then interpreted as a colon-separated list of
24470 environment settings of the form <&'name'&>=<&'value'&>.
24471
24472
24473 .option escape_string pipe string unset
24474 See &%check_string%& above.
24475
24476
24477 .option freeze_exec_fail pipe boolean false
24478 .cindex "exec failure"
24479 .cindex "failure of exec"
24480 .cindex "&(pipe)& transport" "failure of exec"
24481 Failure to exec the command in a pipe transport is by default treated like
24482 any other failure while running the command. However, if &%freeze_exec_fail%&
24483 is set, failure to exec is treated specially, and causes the message to be
24484 frozen, whatever the setting of &%ignore_status%&.
24485
24486
24487 .option freeze_signal pipe boolean false
24488 .cindex "signal exit"
24489 .cindex "&(pipe)& transport", "signal exit"
24490 Normally if the process run by a command in a pipe transport exits on a signal,
24491 a bounce message is sent. If &%freeze_signal%& is set, the message will be
24492 frozen in Exim's queue instead.
24493
24494
24495 .option force_command pipe boolean false
24496 .cindex "force command"
24497 .cindex "&(pipe)& transport", "force command"
24498 Normally when a router redirects an address directly to a pipe command
24499 the &%command%& option on the transport is ignored.  If &%force_command%&
24500 is set, the &%command%& option will used. This is especially
24501 useful for forcing a wrapper or additional argument to be added to the
24502 command. For example:
24503 .code
24504 command = /usr/bin/remote_exec myhost -- $address_pipe
24505 force_command
24506 .endd
24507
24508 Note that &$address_pipe$& is handled specially in &%command%& when
24509 &%force_command%& is set, expanding out to the original argument vector as
24510 separate items, similarly to a Unix shell &`"$@"`& construct.
24511
24512
24513 .option ignore_status pipe boolean false
24514 If this option is true, the status returned by the subprocess that is set up to
24515 run the command is ignored, and Exim behaves as if zero had been returned.
24516 Otherwise, a non-zero status or termination by signal causes an error return
24517 from the transport unless the status value is one of those listed in
24518 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
24519
24520 &*Note*&: This option does not apply to timeouts, which do not return a status.
24521 See the &%timeout_defer%& option for how timeouts are handled.
24522
24523
24524 .option log_defer_output pipe boolean false
24525 .cindex "&(pipe)& transport" "logging output"
24526 If this option is set, and the status returned by the command is
24527 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
24528 and any output was produced on stdout or stderr, the first line of it is
24529 written to the main log.
24530
24531
24532 .option log_fail_output pipe boolean false
24533 If this option is set, and the command returns any output on stdout or
24534 stderr, and also ends with a return code that is neither zero nor one of
24535 the return codes listed in &%temp_errors%& (that is, the delivery
24536 failed), the first line of output is written to the main log. This
24537 option and &%log_output%& are mutually exclusive.  Only one of them may
24538 be set.
24539
24540
24541 .option log_output pipe boolean false
24542 If this option is set and the command returns any output on stdout or
24543 stderr, the first line of output is written to the main log, whatever
24544 the return code. This option and &%log_fail_output%& are mutually
24545 exclusive. Only one of them may be set.
24546
24547
24548 .option max_output pipe integer 20K
24549 This specifies the maximum amount of output that the command may produce on its
24550 standard output and standard error file combined. If the limit is exceeded, the
24551 process running the command is killed. This is intended as a safety measure to
24552 catch runaway processes. The limit is applied independently of the settings of
24553 the options that control what is done with such output (for example,
24554 &%return_output%&). Because of buffering effects, the amount of output may
24555 exceed the limit by a small amount before Exim notices.
24556
24557
24558 .option message_prefix pipe string&!! "see below"
24559 The string specified here is expanded and output at the start of every message.
24560 The default is unset if &%use_bsmtp%& is set. Otherwise it is
24561 .code
24562 message_prefix = \
24563   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
24564   ${tod_bsdinbox}\n
24565 .endd
24566 .cindex "Cyrus"
24567 .cindex "&%tmail%&"
24568 .cindex "&""From""& line"
24569 This is required by the commonly used &_/usr/bin/vacation_& program.
24570 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
24571 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
24572 setting
24573 .code
24574 message_prefix =
24575 .endd
24576 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24577 &`\n`& to &`\r\n`& in &%message_prefix%&.
24578
24579
24580 .option message_suffix pipe string&!! "see below"
24581 The string specified here is expanded and output at the end of every message.
24582 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
24583 The suffix can be suppressed by setting
24584 .code
24585 message_suffix =
24586 .endd
24587 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
24588 &`\n`& to &`\r\n`& in &%message_suffix%&.
24589
24590
24591 .option path pipe string&!! "/bin:/usr/bin"
24592 This option is expanded and
24593 specifies the string that is set up in the PATH environment
24594 variable of the subprocess.
24595 If the &%command%& option does not yield an absolute path name, the command is
24596 sought in the PATH directories, in the usual way. &*Warning*&: This does not
24597 apply to a command specified as a transport filter.
24598
24599
24600 .option permit_coredump pipe boolean false
24601 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
24602 a core-dump of a pipe command, enable this command.  This enables core-dumps
24603 during delivery and affects both the Exim binary and the pipe command run.
24604 It is recommended that this option remain off unless and until you have a need
24605 for it and that this only be enabled when needed, as the risk of excessive
24606 resource consumption can be quite high.  Note also that Exim is typically
24607 installed as a setuid binary and most operating systems will inhibit coredumps
24608 of these by default, so further OS-specific action may be required.
24609
24610
24611 .option pipe_as_creator pipe boolean false
24612 .cindex "uid (user id)" "local delivery"
24613 If the generic &%user%& option is not set and this option is true, the delivery
24614 process is run under the uid that was in force when Exim was originally called
24615 to accept the message. If the group id is not otherwise set (via the generic
24616 &%group%& option), the gid that was in force when Exim was originally called to
24617 accept the message is used.
24618
24619
24620 .option restrict_to_path pipe boolean false
24621 When this option is set, any command name not listed in &%allow_commands%& must
24622 contain no slashes. The command is searched for only in the directories listed
24623 in the &%path%& option. This option is intended for use in the case when a pipe
24624 command has been generated from a user's &_.forward_& file. This is usually
24625 handled by a &(pipe)& transport called &%address_pipe%&.
24626
24627
24628 .option return_fail_output pipe boolean false
24629 If this option is true, and the command produced any output and ended with a
24630 return code other than zero or one of the codes listed in &%temp_errors%& (that
24631 is, the delivery failed), the output is returned in the bounce message.
24632 However, if the message has a null sender (that is, it is itself a bounce
24633 message), output from the command is discarded. This option and
24634 &%return_output%& are mutually exclusive. Only one of them may be set.
24635
24636
24637
24638 .option return_output pipe boolean false
24639 If this option is true, and the command produced any output, the delivery is
24640 deemed to have failed whatever the return code from the command, and the output
24641 is returned in the bounce message. Otherwise, the output is just discarded.
24642 However, if the message has a null sender (that is, it is a bounce message),
24643 output from the command is always discarded, whatever the setting of this
24644 option. This option and &%return_fail_output%& are mutually exclusive. Only one
24645 of them may be set.
24646
24647
24648
24649 .option temp_errors pipe "string list" "see below"
24650 .cindex "&(pipe)& transport" "temporary failure"
24651 This option contains either a colon-separated list of numbers, or a single
24652 asterisk. If &%ignore_status%& is false
24653 and &%return_output%& is not set,
24654 and the command exits with a non-zero return code, the failure is treated as
24655 temporary and the delivery is deferred if the return code matches one of the
24656 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
24657 codes are treated as permanent errors. The default setting contains the codes
24658 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
24659 compiled on a system that does not define these macros, it assumes values of 75
24660 and 73, respectively.
24661
24662
24663 .option timeout pipe time 1h
24664 If the command fails to complete within this time, it is killed. This normally
24665 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
24666 specifies no timeout. In order to ensure that any subprocesses created by the
24667 command are also killed, Exim makes the initial process a process group leader,
24668 and kills the whole process group on a timeout. However, this can be defeated
24669 if one of the processes starts a new process group.
24670
24671 .option timeout_defer pipe boolean false
24672 A timeout in a &(pipe)& transport, either in the command that the transport
24673 runs, or in a transport filter that is associated with it, is by default
24674 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
24675 is set true, both kinds of timeout become temporary errors, causing the
24676 delivery to be deferred.
24677
24678 .option umask pipe "octal integer" 022
24679 This specifies the umask setting for the subprocess that runs the command.
24680
24681
24682 .option use_bsmtp pipe boolean false
24683 .cindex "envelope sender"
24684 If this option is set true, the &(pipe)& transport writes messages in &"batch
24685 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24686 commands. If you want to include a leading HELO command with such messages,
24687 you can do so by setting the &%message_prefix%& option. See section
24688 &<<SECTbatchSMTP>>& for details of batch SMTP.
24689
24690 .option use_classresources pipe boolean false
24691 .cindex "class resources (BSD)"
24692 This option is available only when Exim is running on FreeBSD, NetBSD, or
24693 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24694 resource limits when a &(pipe)& transport is run to perform a delivery. The
24695 limits for the uid under which the pipe is to run are obtained from the login
24696 class database.
24697
24698
24699 .option use_crlf pipe boolean false
24700 .cindex "carriage return"
24701 .cindex "linefeed"
24702 This option causes lines to be terminated with the two-character CRLF sequence
24703 (carriage return, linefeed) instead of just a linefeed character. In the case
24704 of batched SMTP, the byte sequence written to the pipe is then an exact image
24705 of what would be sent down a real SMTP connection.
24706
24707 The contents of the &%message_prefix%& and &%message_suffix%& options are
24708 written verbatim, so must contain their own carriage return characters if these
24709 are needed. When &%use_bsmtp%& is not set, the default values for both
24710 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24711 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24712
24713
24714 .option use_shell pipe boolean false
24715 .vindex "&$pipe_addresses$&"
24716 If this option is set, it causes the command to be passed to &_/bin/sh_&
24717 instead of being run directly from the transport, as described in section
24718 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24719 where the command is expected to be run under a shell and cannot easily be
24720 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24721 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24722 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24723 its &%-c%& option.
24724
24725
24726
24727 .section "Using an external local delivery agent" "SECID143"
24728 .cindex "local delivery" "using an external agent"
24729 .cindex "&'procmail'&"
24730 .cindex "external local delivery"
24731 .cindex "delivery" "&'procmail'&"
24732 .cindex "delivery" "by external agent"
24733 The &(pipe)& transport can be used to pass all messages that require local
24734 delivery to a separate local delivery agent such as &%procmail%&. When doing
24735 this, care must be taken to ensure that the pipe is run under an appropriate
24736 uid and gid. In some configurations one wants this to be a uid that is trusted
24737 by the delivery agent to supply the correct sender of the message. It may be
24738 necessary to recompile or reconfigure the delivery agent so that it trusts an
24739 appropriate user. The following is an example transport and router
24740 configuration for &%procmail%&:
24741 .code
24742 # transport
24743 procmail_pipe:
24744   driver = pipe
24745   command = /usr/local/bin/procmail -d $local_part_data
24746   return_path_add
24747   delivery_date_add
24748   envelope_to_add
24749   check_string = "From "
24750   escape_string = ">From "
24751   umask = 077
24752   user = $local_part_data
24753   group = mail
24754
24755 # router
24756 procmail:
24757   driver = accept
24758   check_local_user
24759   transport = procmail_pipe
24760 .endd
24761 In this example, the pipe is run as the local user, but with the group set to
24762 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24763 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24764 user to supply a correct sender address. If you do not specify either a
24765 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24766 home directory is the user's home directory by default.
24767
24768 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24769 .code
24770 IFS=" "
24771 .endd
24772 as shown in some &%procmail%& documentation, because Exim does not by default
24773 use a shell to run pipe commands.
24774
24775 .cindex "Cyrus"
24776 The next example shows a transport and a router for a system where local
24777 deliveries are handled by the Cyrus IMAP server.
24778 .code
24779 # transport
24780 local_delivery_cyrus:
24781   driver = pipe
24782   command = /usr/cyrus/bin/deliver \
24783             -m ${substr_1:$local_part_suffix} -- $local_part
24784   user = cyrus
24785   group = mail
24786   return_output
24787   log_output
24788   message_prefix =
24789   message_suffix =
24790
24791 # router
24792 local_user_cyrus:
24793   driver = accept
24794   check_local_user
24795   local_part_suffix = .*
24796   transport = local_delivery_cyrus
24797 .endd
24798 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24799 &%return_output%& to cause any text written by Cyrus to be returned to the
24800 sender.
24801 .ecindex IIDpiptra1
24802 .ecindex IIDpiptra2
24803
24804
24805 . ////////////////////////////////////////////////////////////////////////////
24806 . ////////////////////////////////////////////////////////////////////////////
24807
24808 .chapter "The smtp transport" "CHAPsmtptrans"
24809 .scindex IIDsmttra1 "transports" "&(smtp)&"
24810 .scindex IIDsmttra2 "&(smtp)& transport"
24811 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24812 or LMTP protocol. The list of hosts to try can either be taken from the address
24813 that is being processed (having been set up by the router), or specified
24814 explicitly for the transport. Timeout and retry processing (see chapter
24815 &<<CHAPretry>>&) is applied to each IP address independently.
24816
24817
24818 .section "Multiple messages on a single connection" "SECID144"
24819 The sending of multiple messages over a single TCP/IP connection can arise in
24820 two ways:
24821
24822 .ilist
24823 If a message contains more than &%max_rcpt%& (see below) addresses that are
24824 routed to the same host, more than one copy of the message has to be sent to
24825 that host. In this situation, multiple copies may be sent in a single run of
24826 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24827 does when it has too many addresses to send in one message also depends on the
24828 value of the global &%remote_max_parallel%& option. Details are given in
24829 section &<<SECToutSMTPTCP>>&.)
24830 .next
24831 .cindex "hints database" "remembering routing"
24832 When a message has been successfully delivered over a TCP/IP connection, Exim
24833 looks in its hints database to see if there are any other messages awaiting a
24834 connection to the same host. If there are, a new delivery process is started
24835 for one of them, and the current TCP/IP connection is passed on to it. The new
24836 process may in turn send multiple copies and possibly create yet another
24837 process.
24838 .endlist
24839
24840
24841 For each copy sent over the same TCP/IP connection, a sequence counter is
24842 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24843 no further messages are sent over that connection.
24844
24845
24846
24847 .section "Use of the $host and $host_address variables" "SECID145"
24848 .vindex "&$host$&"
24849 .vindex "&$host_address$&"
24850 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24851 &$host_address$& are the name and IP address of the first host on the host list
24852 passed by the router. However, when the transport is about to connect to a
24853 specific host, and while it is connected to that host, &$host$& and
24854 &$host_address$& are set to the values for that host. These are the values
24855 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24856 &%serialize_hosts%&, and the various TLS options are expanded.
24857
24858
24859 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24860 .vindex &$tls_bits$&
24861 .vindex &$tls_cipher$&
24862 .vindex &$tls_peerdn$&
24863 .vindex &$tls_sni$&
24864 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24865 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24866 are the values that were set when the message was received.
24867 These are the values that are used for options that are expanded before any
24868 SMTP connections are made. Just before each connection is made, these four
24869 variables are emptied. If TLS is subsequently started, they are set to the
24870 appropriate values for the outgoing connection, and these are the values that
24871 are in force when any authenticators are run and when the
24872 &%authenticated_sender%& option is expanded.
24873
24874 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24875 and will be removed in a future release.
24876
24877
24878 .section "Private options for smtp" "SECID146"
24879 .cindex "options" "&(smtp)& transport"
24880 The private options of the &(smtp)& transport are as follows:
24881
24882
24883 .option address_retry_include_sender smtp boolean true
24884 .cindex "4&'xx'& responses" "retrying after"
24885 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24886 is the combination of sender and recipient that is delayed in subsequent queue
24887 runs until the retry time is reached. You can delay the recipient without
24888 reference to the sender (which is what earlier versions of Exim did), by
24889 setting &%address_retry_include_sender%& false. However, this can lead to
24890 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24891
24892 .option allow_localhost smtp boolean false
24893 .cindex "local host" "sending to"
24894 .cindex "fallback" "hosts specified on transport"
24895 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24896 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24897 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24898 the delivery anyway. This should be used only in special cases when the
24899 configuration ensures that no looping will result (for example, a differently
24900 configured Exim is listening on the port to which the message is sent).
24901
24902
24903 .option authenticated_sender smtp string&!! unset
24904 .cindex "Cyrus"
24905 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24906 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24907 overriding any existing authenticated sender value. If the string expansion is
24908 forced to fail, the option is ignored. Other expansion failures cause delivery
24909 to be deferred. If the result of expansion is an empty string, that is also
24910 ignored.
24911
24912 The expansion happens after the outgoing connection has been made and TLS
24913 started, if required. This means that the &$host$&, &$host_address$&,
24914 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24915 particular connection.
24916
24917 If the SMTP session is not authenticated, the expansion of
24918 &%authenticated_sender%& still happens (and can cause the delivery to be
24919 deferred if it fails), but no AUTH= item is added to MAIL commands
24920 unless &%authenticated_sender_force%& is true.
24921
24922 This option allows you to use the &(smtp)& transport in LMTP mode to
24923 deliver mail to Cyrus IMAP and provide the proper local part as the
24924 &"authenticated sender"&, via a setting such as:
24925 .code
24926 authenticated_sender = $local_part
24927 .endd
24928 This removes the need for IMAP subfolders to be assigned special ACLs to
24929 allow direct delivery to those subfolders.
24930
24931 Because of expected uses such as that just described for Cyrus (when no
24932 domain is involved), there is no checking on the syntax of the provided
24933 value.
24934
24935
24936 .option authenticated_sender_force smtp boolean false
24937 If this option is set true, the &%authenticated_sender%& option's value
24938 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24939 authenticated as a client.
24940
24941
24942 .option command_timeout smtp time 5m
24943 This sets a timeout for receiving a response to an SMTP command that has been
24944 sent out. It is also used when waiting for the initial banner line from the
24945 remote host. Its value must not be zero.
24946
24947
24948 .option connect_timeout smtp time 5m
24949 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24950 to a remote host. A setting of zero allows the system timeout (typically
24951 several minutes) to act. To have any effect, the value of this option must be
24952 less than the system timeout. However, it has been observed that on some
24953 systems there is no system timeout, which is why the default value for this
24954 option is 5 minutes, a value recommended by RFC 1123.
24955
24956
24957 .option connection_max_messages smtp integer 500
24958 .cindex "SMTP" "passed connection"
24959 .cindex "SMTP" "multiple deliveries"
24960 .cindex "multiple SMTP deliveries"
24961 This controls the maximum number of separate message deliveries that are sent
24962 over a single TCP/IP connection. If the value is zero, there is no limit.
24963 For testing purposes, this value can be overridden by the &%-oB%& command line
24964 option.
24965
24966
24967 .option dane_require_tls_ciphers smtp string&!! unset
24968 .cindex "TLS" "requiring specific ciphers for DANE"
24969 .cindex "cipher" "requiring specific"
24970 .cindex DANE "TLS ciphers"
24971 This option may be used to override &%tls_require_ciphers%& for connections
24972 where DANE has been determined to be in effect.
24973 If not set, then &%tls_require_ciphers%& will be used.
24974 Normal SMTP delivery is not able to make strong demands of TLS cipher
24975 configuration, because delivery will fall back to plaintext.  Once DANE has
24976 been determined to be in effect, there is no plaintext fallback and making the
24977 TLS cipherlist configuration stronger will increase security, rather than
24978 counter-intuitively decreasing it.
24979 If the option expands to be empty or is forced to fail, then it will
24980 be treated as unset and &%tls_require_ciphers%& will be used instead.
24981
24982
24983 .option data_timeout smtp time 5m
24984 This sets a timeout for the transmission of each block in the data portion of
24985 the message. As a result, the overall timeout for a message depends on the size
24986 of the message. Its value must not be zero. See also &%final_timeout%&.
24987
24988
24989 .option dkim_canon smtp string&!! unset
24990 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24991 .option dkim_domain smtp string list&!! unset
24992 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24993 .option dkim_hash smtp string&!! sha256
24994 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24995 .option dkim_identity smtp string&!! unset
24996 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24997 .option dkim_private_key smtp string&!! unset
24998 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
24999 .option dkim_selector smtp string&!! unset
25000 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25001 .option dkim_strict smtp string&!! unset
25002 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25003 .option dkim_sign_headers smtp string&!! "per RFC"
25004 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25005 .option dkim_timestamps smtp string&!! unset
25006 DKIM signing option.  For details see section &<<SECDKIMSIGN>>&.
25007
25008
25009 .option delay_after_cutoff smtp boolean true
25010 .cindex "final cutoff" "retries, controlling"
25011 .cindex retry "final cutoff"
25012 This option controls what happens when all remote IP addresses for a given
25013 domain have been inaccessible for so long that they have passed their retry
25014 cutoff times.
25015
25016 In the default state, if the next retry time has not been reached for any of
25017 them, the address is bounced without trying any deliveries. In other words,
25018 Exim delays retrying an IP address after the final cutoff time until a new
25019 retry time is reached, and can therefore bounce an address without ever trying
25020 a delivery, when machines have been down for a long time. Some people are
25021 unhappy at this prospect, so...
25022
25023 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
25024 addresses are past their final cutoff time, Exim tries to deliver to those
25025 IP addresses that have not been tried since the message arrived. If there are
25026 none, of if they all fail, the address is bounced. In other words, it does not
25027 delay when a new message arrives, but immediately tries those expired IP
25028 addresses that haven't been tried since the message arrived. If there is a
25029 continuous stream of messages for the dead hosts, unsetting
25030 &%delay_after_cutoff%& means that there will be many more attempts to deliver
25031 to them.
25032
25033
25034 .option dns_qualify_single smtp boolean true
25035 If the &%hosts%& or &%fallback_hosts%& option is being used,
25036 and the &%gethostbyname%& option is false,
25037 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
25038 in chapter &<<CHAPdnslookup>>& for more details.
25039
25040
25041 .option dns_search_parents smtp boolean false
25042 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
25043 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
25044 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
25045 details.
25046
25047
25048 .option dnssec_request_domains smtp "domain list&!!" *
25049 .cindex "MX record" "security"
25050 .cindex "DNSSEC" "MX lookup"
25051 .cindex "security" "MX lookup"
25052 .cindex "DNS" "DNSSEC"
25053 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
25054 the dnssec request bit set. Setting this transport option is only useful if the
25055 transport overrides or sets the host names. See the &%dnssec_request_domains%&
25056 router option.
25057
25058
25059
25060 .option dnssec_require_domains smtp "domain list&!!" unset
25061 .cindex "MX record" "security"
25062 .cindex "DNSSEC" "MX lookup"
25063 .cindex "security" "MX lookup"
25064 .cindex "DNS" "DNSSEC"
25065 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
25066 the dnssec request bit set.  Setting this transport option is only
25067 useful if the transport overrides or sets the host names. See the
25068 &%dnssec_require_domains%& router option.
25069
25070
25071
25072 .option dscp smtp string&!! unset
25073 .cindex "DCSP" "outbound"
25074 This option causes the DSCP value associated with a socket to be set to one
25075 of a number of fixed strings or to numeric value.
25076 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
25077 Common values include &`throughput`&, &`mincost`&, and on newer systems
25078 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
25079
25080 The outbound packets from Exim will be marked with this value in the header
25081 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
25082 that these values will have any effect, not be stripped by networking
25083 equipment, or do much of anything without cooperation with your Network
25084 Engineer and those of all network operators between the source and destination.
25085
25086
25087 .option fallback_hosts smtp "string list" unset
25088 .cindex "fallback" "hosts specified on transport"
25089 String expansion is not applied to this option. The argument must be a
25090 colon-separated list of host names or IP addresses, optionally also including
25091 port numbers, though the separator can be changed, as described in section
25092 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25093 item in a &%route_list%& setting for the &(manualroute)& router, as described
25094 in section &<<SECTformatonehostitem>>&.
25095
25096 Fallback hosts can also be specified on routers, which associate them with the
25097 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
25098 &%fallback_hosts%& specified on the transport is used only if the address does
25099 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
25100 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
25101 However, &%hosts_randomize%& does apply to fallback host lists.
25102
25103 If Exim is unable to deliver to any of the hosts for a particular address, and
25104 the errors are not permanent rejections, the address is put on a separate
25105 transport queue with its host list replaced by the fallback hosts, unless the
25106 address was routed via MX records and the current host was in the original MX
25107 list. In that situation, the fallback host list is not used.
25108
25109 Once normal deliveries are complete, the fallback queue is delivered by
25110 re-running the same transports with the new host lists. If several failing
25111 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
25112 copy of the message is sent.
25113
25114 The resolution of the host names on the fallback list is controlled by the
25115 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
25116 both to cases when the host list comes with the address and when it is taken
25117 from &%hosts%&. This option provides a &"use a smart host only if delivery
25118 fails"& facility.
25119
25120
25121 .option final_timeout smtp time 10m
25122 This is the timeout that applies while waiting for the response to the final
25123 line containing just &"."& that terminates a message. Its value must not be
25124 zero.
25125
25126 .option gethostbyname smtp boolean false
25127 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
25128 being used, names are looked up using &[gethostbyname()]&
25129 (or &[getipnodebyname()]& when available)
25130 instead of using the DNS. Of course, that function may in fact use the DNS, but
25131 it may also consult other sources of information such as &_/etc/hosts_&.
25132
25133 .option gnutls_compat_mode smtp boolean unset
25134 This option controls whether GnuTLS is used in compatibility mode in an Exim
25135 server. This reduces security slightly, but improves interworking with older
25136 implementations of TLS.
25137
25138 .option helo_data smtp string&!! "see below"
25139 .cindex "HELO" "argument, setting"
25140 .cindex "EHLO" "argument, setting"
25141 .cindex "LHLO argument setting"
25142 The value of this option is expanded after a connection to a another host has
25143 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
25144 command that starts the outgoing SMTP or LMTP session. The default value of the
25145 option is:
25146 .code
25147 $primary_hostname
25148 .endd
25149 During the expansion, the variables &$host$& and &$host_address$& are set to
25150 the identity of the remote host, and the variables &$sending_ip_address$& and
25151 &$sending_port$& are set to the local IP address and port number that are being
25152 used. These variables can be used to generate different values for different
25153 servers or different local IP addresses. For example, if you want the string
25154 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
25155 interface address, you could use this:
25156 .code
25157 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
25158   {$primary_hostname}}
25159 .endd
25160 The use of &%helo_data%& applies both to sending messages and when doing
25161 callouts.
25162
25163 .option hosts smtp "string list&!!" unset
25164 Hosts are associated with an address by a router such as &(dnslookup)&, which
25165 finds the hosts by looking up the address domain in the DNS, or by
25166 &(manualroute)&, which has lists of hosts in its configuration. However,
25167 email addresses can be passed to the &(smtp)& transport by any router, and not
25168 all of them can provide an associated list of hosts.
25169
25170 The &%hosts%& option specifies a list of hosts to be used if the address being
25171 processed does not have any hosts associated with it. The hosts specified by
25172 &%hosts%& are also used, whether or not the address has its own hosts, if
25173 &%hosts_override%& is set.
25174
25175 The string is first expanded, before being interpreted as a colon-separated
25176 list of host names or IP addresses, possibly including port numbers. The
25177 separator may be changed to something other than colon, as described in section
25178 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
25179 item in a &%route_list%& setting for the &(manualroute)& router, as described
25180 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
25181 of the &(manualroute)& router is not available here.
25182
25183 If the expansion fails, delivery is deferred. Unless the failure was caused by
25184 the inability to complete a lookup, the error is logged to the panic log as
25185 well as the main log. Host names are looked up either by searching directly for
25186 address records in the DNS or by calling &[gethostbyname()]& (or
25187 &[getipnodebyname()]& when available), depending on the setting of the
25188 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
25189 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
25190 address are used.
25191
25192 During delivery, the hosts are tried in order, subject to their retry status,
25193 unless &%hosts_randomize%& is set.
25194
25195
25196 .option hosts_avoid_esmtp smtp "host list&!!" unset
25197 .cindex "ESMTP, avoiding use of"
25198 .cindex "HELO" "forcing use of"
25199 .cindex "EHLO" "avoiding use of"
25200 .cindex "PIPELINING" "avoiding the use of"
25201 This option is for use with broken hosts that announce ESMTP facilities (for
25202 example, PIPELINING) and then fail to implement them properly. When a host
25203 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
25204 start of the SMTP session. This means that it cannot use any of the ESMTP
25205 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
25206
25207
25208 .option hosts_avoid_pipelining smtp "host list&!!" unset
25209 .cindex "PIPELINING" "avoiding the use of"
25210 .cindex "ESMTP extensions" PIPELINING
25211 Exim will not use the ESMTP PIPELINING extension when delivering to any host
25212 that matches this list, even if the server host advertises PIPELINING support.
25213
25214 .option hosts_pipe_connect smtp "host list&!!" unset
25215 .cindex "pipelining" "early connection"
25216 .cindex "pipelining" PIPE_CONNECT
25217 If Exim is built with the SUPPORT_PIPE_CONNECT build option
25218 this option controls which to hosts the facility watched for
25219 and recorded, and used for subsequent connections.
25220
25221 The retry hints database is used for the record,
25222 and records are subject to the &%retry_data_expire%& option.
25223 When used, the pipelining saves on roundtrip times.
25224 It also turns SMTP into a client-first protocol
25225 so combines well with TCP Fast Open.
25226
25227 See also the &%pipelining_connect_advertise_hosts%& main option.
25228
25229 Note:
25230 When the facility is used, the transport &%helo_data%& option
25231 will be expanded before the &$sending_ip_address$& variable
25232 is filled in.
25233 A check is made for the use of that variable, without the
25234 presence of a &"def:"& test on it, but suitably complex coding
25235 can avoid the check and produce unexpected results.
25236 You have been warned.
25237
25238
25239 .option hosts_avoid_tls smtp "host list&!!" unset
25240 .cindex "TLS" "avoiding for certain hosts"
25241 Exim will not try to start a TLS session when delivering to any host that
25242 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25243
25244 .option hosts_verify_avoid_tls smtp "host list&!!" unset
25245 .cindex "TLS" "avoiding for certain hosts"
25246 Exim will not try to start a TLS session for a verify callout,
25247 or when delivering in cutthrough mode,
25248 to any host that matches this list.
25249
25250
25251 .option hosts_max_try smtp integer 5
25252 .cindex "host" "maximum number to try"
25253 .cindex "limit" "number of hosts tried"
25254 .cindex "limit" "number of MX tried"
25255 .cindex "MX record" "maximum tried"
25256 This option limits the number of IP addresses that are tried for any one
25257 delivery in cases where there are temporary delivery errors. Section
25258 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
25259
25260
25261 .option hosts_max_try_hardlimit smtp integer 50
25262 This is an additional check on the maximum number of IP addresses that Exim
25263 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
25264 why it exists.
25265
25266
25267
25268 .option hosts_nopass_tls smtp "host list&!!" unset
25269 .cindex "TLS" "passing connection"
25270 .cindex "multiple SMTP deliveries"
25271 .cindex "TLS" "multiple message deliveries"
25272 For any host that matches this list, a connection on which a TLS session has
25273 been started will not be passed to a new delivery process for sending another
25274 message on the same connection. See section &<<SECTmulmessam>>& for an
25275 explanation of when this might be needed.
25276
25277 .option hosts_noproxy_tls smtp "host list&!!" unset
25278 .cindex "TLS" "passing connection"
25279 .cindex "multiple SMTP deliveries"
25280 .cindex "TLS" "multiple message deliveries"
25281 For any host that matches this list, a TLS session which has
25282 been started will not be passed to a new delivery process for sending another
25283 message on the same session.
25284
25285 The traditional implementation closes down TLS and re-starts it in the new
25286 process, on the same open TCP connection, for each successive message
25287 sent.  If permitted by this option a pipe to to the new process is set up
25288 instead, and the original process maintains the TLS connection and proxies
25289 the SMTP connection from and to the new process and any subsequents.
25290 The new process has no access to TLS information, so cannot include it in
25291 logging.
25292
25293
25294
25295 .option hosts_override smtp boolean false
25296 If this option is set and the &%hosts%& option is also set, any hosts that are
25297 attached to the address are ignored, and instead the hosts specified by the
25298 &%hosts%& option are always used. This option does not apply to
25299 &%fallback_hosts%&.
25300
25301
25302 .option hosts_randomize smtp boolean false
25303 .cindex "randomized host list"
25304 .cindex "host" "list of; randomized"
25305 .cindex "fallback" "randomized hosts"
25306 If this option is set, and either the list of hosts is taken from the
25307 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
25308 were not obtained from MX records (this includes fallback hosts from the
25309 router), and were not randomized by the router, the order of trying the hosts
25310 is randomized each time the transport runs. Randomizing the order of a host
25311 list can be used to do crude load sharing.
25312
25313 When &%hosts_randomize%& is true, a host list may be split into groups whose
25314 order is separately randomized. This makes it possible to set up MX-like
25315 behaviour. The boundaries between groups are indicated by an item that is just
25316 &`+`& in the host list. For example:
25317 .code
25318 hosts = host1:host2:host3:+:host4:host5
25319 .endd
25320 The order of the first three hosts and the order of the last two hosts is
25321 randomized for each use, but the first three always end up before the last two.
25322 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
25323
25324 .option hosts_require_auth smtp "host list&!!" unset
25325 .cindex "authentication" "required by client"
25326 This option provides a list of servers for which authentication must succeed
25327 before Exim will try to transfer a message. If authentication fails for
25328 servers which are not in this list, Exim tries to send unauthenticated. If
25329 authentication fails for one of these servers, delivery is deferred. This
25330 temporary error is detectable in the retry rules, so it can be turned into a
25331 hard failure if required. See also &%hosts_try_auth%&, and chapter
25332 &<<CHAPSMTPAUTH>>& for details of authentication.
25333
25334
25335 .option hosts_request_ocsp smtp "host list&!!" *
25336 .cindex "TLS" "requiring for certain servers"
25337 Exim will request a Certificate Status on a
25338 TLS session for any host that matches this list.
25339 &%tls_verify_certificates%& should also be set for the transport.
25340
25341 .option hosts_require_dane smtp "host list&!!" unset
25342 .cindex DANE "transport options"
25343 .cindex DANE "requiring for certain servers"
25344 If built with DANE support, Exim  will require that a DNSSEC-validated
25345 TLSA record is present for any host matching the list,
25346 and that a DANE-verified TLS connection is made. See
25347 the &%dnssec_request_domains%& router and transport options.
25348 There will be no fallback to in-clear communication.
25349 See section &<<SECDANE>>&.
25350
25351 .option hosts_require_ocsp smtp "host list&!!" unset
25352 .cindex "TLS" "requiring for certain servers"
25353 Exim will request, and check for a valid Certificate Status being given, on a
25354 TLS session for any host that matches this list.
25355 &%tls_verify_certificates%& should also be set for the transport.
25356
25357 .option hosts_require_tls smtp "host list&!!" unset
25358 .cindex "TLS" "requiring for certain servers"
25359 Exim will insist on using a TLS session when delivering to any host that
25360 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
25361 &*Note*&: This option affects outgoing mail only. To insist on TLS for
25362 incoming messages, use an appropriate ACL.
25363
25364 .option hosts_try_auth smtp "host list&!!" unset
25365 .cindex "authentication" "optional in client"
25366 This option provides a list of servers to which, provided they announce
25367 authentication support, Exim will attempt to authenticate as a client when it
25368 connects. If authentication fails, Exim will try to transfer the message
25369 unauthenticated. See also &%hosts_require_auth%&, and chapter
25370 &<<CHAPSMTPAUTH>>& for details of authentication.
25371
25372 .option hosts_try_chunking smtp "host list&!!" *
25373 .cindex CHUNKING "enabling, in client"
25374 .cindex BDAT "SMTP command"
25375 .cindex "RFC 3030" "CHUNKING"
25376 This option provides a list of servers to which, provided they announce
25377 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
25378 Unless DKIM signing is being done,
25379 BDAT will not be used in conjunction with a transport filter.
25380
25381 .option hosts_try_dane smtp "host list&!!" *
25382 .cindex DANE "transport options"
25383 .cindex DANE "attempting for certain servers"
25384 If built with DANE support, Exim  will require that a DNSSEC-validated
25385 TLSA record is present for any host matching the list,
25386 and that a DANE-verified TLS connection is made. See
25387 the &%dnssec_request_domains%& router and transport options.
25388 There will be no fallback to in-clear communication.
25389 See section &<<SECDANE>>&.
25390
25391 .option hosts_try_fastopen smtp "host list&!!" *
25392 .cindex "fast open, TCP" "enabling, in client"
25393 .cindex "TCP Fast Open" "enabling, in client"
25394 .cindex "RFC 7413" "TCP Fast Open"
25395 This option provides a list of servers to which, provided
25396 the facility is supported by this system, Exim will attempt to
25397 perform a TCP Fast Open.
25398 No data is sent on the SYN segment but, if the remote server also
25399 supports the facility, it can send its SMTP banner immediately after
25400 the SYN,ACK segment.  This can save up to one round-trip time.
25401
25402 The facility is only active for previously-contacted servers,
25403 as the initiator must present a cookie in the SYN segment.
25404
25405 On (at least some) current Linux distributions the facility must be enabled
25406 in the kernel by the sysadmin before the support is usable.
25407 There is no option for control of the server side; if the system supports
25408 it it is always enabled.  Note that lengthy operations in the connect ACL,
25409 such as DNSBL lookups, will still delay the emission of the SMTP banner.
25410
25411 .option hosts_try_prdr smtp "host list&!!" *
25412 .cindex "PRDR" "enabling, optional in client"
25413 .cindex "ESMTP extensions" PRDR
25414 This option provides a list of servers to which, provided they announce
25415 PRDR support, Exim will attempt to negotiate PRDR
25416 for multi-recipient messages.
25417 The option can usually be left as default.
25418
25419 .option interface smtp "string list&!!" unset
25420 .cindex "bind IP address"
25421 .cindex "IP address" "binding"
25422 .vindex "&$host$&"
25423 .vindex "&$host_address$&"
25424 This option specifies which interface to bind to when making an outgoing SMTP
25425 call. The value is an IP address, not an interface name such as
25426 &`eth0`&. Do not confuse this with the interface address that was used when a
25427 message was received, which is in &$received_ip_address$&, formerly known as
25428 &$interface_address$&. The name was changed to minimize confusion with the
25429 outgoing interface address. There is no variable that contains an outgoing
25430 interface address because, unless it is set by this option, its value is
25431 unknown.
25432
25433 During the expansion of the &%interface%& option the variables &$host$& and
25434 &$host_address$& refer to the host to which a connection is about to be made
25435 during the expansion of the string. Forced expansion failure, or an empty
25436 string result causes the option to be ignored. Otherwise, after expansion, the
25437 string must be a list of IP addresses, colon-separated by default, but the
25438 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
25439 For example:
25440 .code
25441 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
25442 .endd
25443 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
25444 connection. If none of them are the correct type, the option is ignored. If
25445 &%interface%& is not set, or is ignored, the system's IP functions choose which
25446 interface to use if the host has more than one.
25447
25448
25449 .option keepalive smtp boolean true
25450 .cindex "keepalive" "on outgoing connection"
25451 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
25452 connections. When set, it causes the kernel to probe idle connections
25453 periodically, by sending packets with &"old"& sequence numbers. The other end
25454 of the connection should send a acknowledgment if the connection is still okay
25455 or a reset if the connection has been aborted. The reason for doing this is
25456 that it has the beneficial effect of freeing up certain types of connection
25457 that can get stuck when the remote host is disconnected without tidying up the
25458 TCP/IP call properly. The keepalive mechanism takes several hours to detect
25459 unreachable hosts.
25460
25461
25462 .option lmtp_ignore_quota smtp boolean false
25463 .cindex "LMTP" "ignoring quota errors"
25464 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
25465 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
25466 has advertised support for IGNOREQUOTA in its response to the LHLO command.
25467
25468 .option max_rcpt smtp integer 100
25469 .cindex "RCPT" "maximum number of outgoing"
25470 This option limits the number of RCPT commands that are sent in a single
25471 SMTP message transaction. Each set of addresses is treated independently, and
25472 so can cause parallel connections to the same host if &%remote_max_parallel%&
25473 permits this.
25474
25475
25476 .new
25477 .option message_linelength_limit smtp integer 998
25478 .cindex "line length" limit
25479 This option sets the maximum line length, in bytes, that the transport
25480 will send.  Any messages with lines exceeding the given value
25481 will fail and a failure-DSN ("bounce") message will if possible be returned
25482 to the sender.
25483 The default value is that defined by the SMTP standards.
25484
25485 It is generally wise to also check in the data ACL so that messages
25486 received via SMTP can be refused without producing a bounce.
25487 .wen
25488
25489
25490 .option multi_domain smtp boolean&!! true
25491 .vindex "&$domain$&"
25492 When this option is set, the &(smtp)& transport can handle a number of
25493 addresses containing a mixture of different domains provided they all resolve
25494 to the same list of hosts. Turning the option off restricts the transport to
25495 handling only one domain at a time. This is useful if you want to use
25496 &$domain$& in an expansion for the transport, because it is set only when there
25497 is a single domain involved in a remote delivery.
25498
25499 It is expanded per-address and can depend on any of
25500 &$address_data$&, &$domain_data$&, &$local_part_data$&,
25501 &$host$&, &$host_address$& and &$host_port$&.
25502
25503 .option port smtp string&!! "see below"
25504 .cindex "port" "sending TCP/IP"
25505 .cindex "TCP/IP" "setting outgoing port"
25506 This option specifies the TCP/IP port on the server to which Exim connects.
25507 &*Note:*& Do not confuse this with the port that was used when a message was
25508 received, which is in &$received_port$&, formerly known as &$interface_port$&.
25509 The name was changed to minimize confusion with the outgoing port. There is no
25510 variable that contains an outgoing port.
25511
25512 If the value of this option begins with a digit it is taken as a port number;
25513 otherwise it is looked up using &[getservbyname()]&. The default value is
25514 normally &"smtp"&,
25515 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
25516 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
25517 If the expansion fails, or if a port number cannot be found, delivery
25518 is deferred.
25519
25520 Note that at least one Linux distribution has been seen failing
25521 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
25522
25523
25524
25525 .option protocol smtp string smtp
25526 .cindex "LMTP" "over TCP/IP"
25527 .cindex "ssmtp protocol" "outbound"
25528 .cindex "TLS" "SSL-on-connect outbound"
25529 .vindex "&$port$&"
25530 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
25531 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
25532 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
25533 deliveries into closed message stores. Exim also has support for running LMTP
25534 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
25535
25536 If this option is set to &"smtps"&, the default value for the &%port%& option
25537 changes to &"smtps"&, and the transport initiates TLS immediately after
25538 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
25539 The Internet standards bodies used to strongly discourage use of this mode,
25540 but as of RFC 8314 it is perferred over STARTTLS for message submission
25541 (as distinct from MTA-MTA communication).
25542
25543
25544 .option retry_include_ip_address smtp boolean&!! true
25545 Exim normally includes both the host name and the IP address in the key it
25546 constructs for indexing retry data after a temporary delivery failure. This
25547 means that when one of several IP addresses for a host is failing, it gets
25548 tried periodically (controlled by the retry rules), but use of the other IP
25549 addresses is not affected.
25550
25551 However, in some dialup environments hosts are assigned a different IP address
25552 each time they connect. In this situation the use of the IP address as part of
25553 the retry key leads to undesirable behaviour. Setting this option false causes
25554 Exim to use only the host name.
25555 Since it is expanded it can be made to depend on the host or domain.
25556
25557
25558 .option serialize_hosts smtp "host list&!!" unset
25559 .cindex "serializing connections"
25560 .cindex "host" "serializing connections"
25561 Because Exim operates in a distributed manner, if several messages for the same
25562 host arrive at around the same time, more than one simultaneous connection to
25563 the remote host can occur. This is not usually a problem except when there is a
25564 slow link between the hosts. In that situation it may be helpful to restrict
25565 Exim to one connection at a time. This can be done by setting
25566 &%serialize_hosts%& to match the relevant hosts.
25567
25568 .cindex "hints database" "serializing deliveries to a host"
25569 Exim implements serialization by means of a hints database in which a record is
25570 written whenever a process connects to one of the restricted hosts. The record
25571 is deleted when the connection is completed. Obviously there is scope for
25572 records to get left lying around if there is a system or program crash. To
25573 guard against this, Exim ignores any records that are more than six hours old.
25574
25575 If you set up this kind of serialization, you should also arrange to delete the
25576 relevant hints database whenever your system reboots. The names of the files
25577 start with &_misc_& and they are kept in the &_spool/db_& directory. There
25578 may be one or two files, depending on the type of DBM in use. The same files
25579 are used for ETRN serialization.
25580
25581 See also the &%max_parallel%& generic transport option.
25582
25583
25584 .option size_addition smtp integer 1024
25585 .cindex "SIZE" "ESMTP extension"
25586 .cindex "message" "size issue for transport filter"
25587 .cindex "size" "of message"
25588 .cindex "transport" "filter"
25589 .cindex "filter" "transport filter"
25590 If a remote SMTP server indicates that it supports the SIZE option of the
25591 MAIL command, Exim uses this to pass over the message size at the start of
25592 an SMTP transaction. It adds the value of &%size_addition%& to the value it
25593 sends, to allow for headers and other text that may be added during delivery by
25594 configuration options or in a transport filter. It may be necessary to increase
25595 this if a lot of text is added to messages.
25596
25597 Alternatively, if the value of &%size_addition%& is set negative, it disables
25598 the use of the SIZE option altogether.
25599
25600
25601 .option socks_proxy smtp string&!! unset
25602 .cindex proxy SOCKS
25603 This option enables use of SOCKS proxies for connections made by the
25604 transport.  For details see section &<<SECTproxySOCKS>>&.
25605
25606
25607 .option tls_certificate smtp string&!! unset
25608 .cindex "TLS" "client certificate, location of"
25609 .cindex "certificate" "client, location of"
25610 .vindex "&$host$&"
25611 .vindex "&$host_address$&"
25612 The value of this option must be the absolute path to a file which contains the
25613 client's certificate, for possible use when sending a message over an encrypted
25614 connection. The values of &$host$& and &$host_address$& are set to the name and
25615 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
25616 details of TLS.
25617
25618 &*Note*&: This option must be set if you want Exim to be able to use a TLS
25619 certificate when sending messages as a client. The global option of the same
25620 name specifies the certificate for Exim as a server; it is not automatically
25621 assumed that the same certificate should be used when Exim is operating as a
25622 client.
25623
25624
25625 .option tls_crl smtp string&!! unset
25626 .cindex "TLS" "client certificate revocation list"
25627 .cindex "certificate" "revocation list for client"
25628 This option specifies a certificate revocation list. The expanded value must
25629 be the name of a file that contains a CRL in PEM format.
25630
25631
25632 .option tls_dh_min_bits smtp integer 1024
25633 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
25634 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
25635 key agreement is negotiated, the server will provide a large prime number
25636 for use.  This option establishes the minimum acceptable size of that number.
25637 If the parameter offered by the server is too small, then the TLS handshake
25638 will fail.
25639
25640 Only supported when using GnuTLS.
25641
25642
25643 .option tls_privatekey smtp string&!! unset
25644 .cindex "TLS" "client private key, location of"
25645 .vindex "&$host$&"
25646 .vindex "&$host_address$&"
25647 The value of this option must be the absolute path to a file which contains the
25648 client's private key. This is used when sending a message over an encrypted
25649 connection using a client certificate. The values of &$host$& and
25650 &$host_address$& are set to the name and address of the server during the
25651 expansion. If this option is unset, or the expansion is forced to fail, or the
25652 result is an empty string, the private key is assumed to be in the same file as
25653 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
25654
25655
25656 .option tls_require_ciphers smtp string&!! unset
25657 .cindex "TLS" "requiring specific ciphers"
25658 .cindex "cipher" "requiring specific"
25659 .vindex "&$host$&"
25660 .vindex "&$host_address$&"
25661 The value of this option must be a list of permitted cipher suites, for use
25662 when setting up an outgoing encrypted connection. (There is a global option of
25663 the same name for controlling incoming connections.) The values of &$host$& and
25664 &$host_address$& are set to the name and address of the server during the
25665 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
25666 is used in different ways by OpenSSL and GnuTLS (see sections
25667 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
25668 ciphers is a preference order.
25669
25670
25671 .new
25672 .option tls_resumption_hosts smtp "host list&!!" unset
25673 .cindex TLS resumption
25674 This option controls which connections to use the TLS resumption feature.
25675 See &<<SECTresumption>>& for details.
25676 .wen
25677
25678
25679
25680 .option tls_sni smtp string&!! unset
25681 .cindex "TLS" "Server Name Indication"
25682 .vindex "&$tls_sni$&"
25683 If this option is set then it sets the $tls_out_sni variable and causes any
25684 TLS session to pass this value as the Server Name Indication extension to
25685 the remote side, which can be used by the remote side to select an appropriate
25686 certificate and private key for the session.
25687
25688 See &<<SECTtlssni>>& for more information.
25689
25690 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
25691 TLS extensions.
25692
25693
25694
25695
25696 .option tls_tempfail_tryclear smtp boolean true
25697 .cindex "4&'xx'& responses" "to STARTTLS"
25698 When the server host is not in &%hosts_require_tls%&, and there is a problem in
25699 setting up a TLS session, this option determines whether or not Exim should try
25700 to deliver the message unencrypted. If it is set false, delivery to the
25701 current host is deferred; if there are other hosts, they are tried. If this
25702 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
25703 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
25704 TLS negotiation fails, Exim closes the current connection (because it is in an
25705 unknown state), opens a new one to the same host, and then tries the delivery
25706 in clear.
25707
25708
25709 .option tls_try_verify_hosts smtp "host list&!!" *
25710 .cindex "TLS" "server certificate verification"
25711 .cindex "certificate" "verification of server"
25712 This option gives a list of hosts for which, on encrypted connections,
25713 certificate verification will be tried but need not succeed.
25714 The &%tls_verify_certificates%& option must also be set.
25715 Note that unless the host is in this list
25716 TLS connections will be denied to hosts using self-signed certificates
25717 when &%tls_verify_certificates%& is matched.
25718 The &$tls_out_certificate_verified$& variable is set when
25719 certificate verification succeeds.
25720
25721
25722 .option tls_verify_cert_hostnames smtp "host list&!!" *
25723 .cindex "TLS" "server certificate hostname verification"
25724 .cindex "certificate" "verification of server"
25725 This option give a list of hosts for which,
25726 while verifying the server certificate,
25727 checks will be included on the host name
25728 (note that this will generally be the result of a DNS MX lookup)
25729 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
25730 limited to being the initial component of a 3-or-more component FQDN.
25731
25732 There is no equivalent checking on client certificates.
25733
25734
25735 .option tls_verify_certificates smtp string&!! system
25736 .cindex "TLS" "server certificate verification"
25737 .cindex "certificate" "verification of server"
25738 .vindex "&$host$&"
25739 .vindex "&$host_address$&"
25740 The value of this option must be either the
25741 word "system"
25742 or the absolute path to
25743 a file or directory containing permitted certificates for servers,
25744 for use when setting up an encrypted connection.
25745
25746 The "system" value for the option will use a location compiled into the SSL library.
25747 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25748 is taken as empty and an explicit location
25749 must be specified.
25750
25751 The use of a directory for the option value is not available for GnuTLS versions
25752 preceding 3.3.6 and a single file must be used.
25753
25754 With OpenSSL the certificates specified
25755 explicitly
25756 either by file or directory
25757 are added to those given by the system default location.
25758
25759 The values of &$host$& and
25760 &$host_address$& are set to the name and address of the server during the
25761 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25762
25763 For back-compatibility,
25764 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25765 (a single-colon empty list counts as being set)
25766 and certificate verification fails the TLS connection is closed.
25767
25768
25769 .option tls_verify_hosts smtp "host list&!!" unset
25770 .cindex "TLS" "server certificate verification"
25771 .cindex "certificate" "verification of server"
25772 This option gives a list of hosts for which, on encrypted connections,
25773 certificate verification must succeed.
25774 The &%tls_verify_certificates%& option must also be set.
25775 If both this option and &%tls_try_verify_hosts%& are unset
25776 operation is as if this option selected all hosts.
25777
25778 .option utf8_downconvert smtp integer&!! -1
25779 .cindex utf8 "address downconversion"
25780 .cindex i18n "utf8 address downconversion"
25781 If built with internationalization support,
25782 this option controls conversion of UTF-8 in message envelope addresses
25783 to a-label form.
25784 If, after expansion, the value is 1, 0, or -1 then this value overrides
25785 any value previously set for the message.  Otherwise, any previously
25786 set value is used.  To permit use of a previous value,
25787 set this option to an empty string.
25788 For details on the values see section &<<SECTi18nMTA>>&.
25789
25790
25791
25792
25793 .section "How the limits for the number of hosts to try are used" &&&
25794          "SECTvalhosmax"
25795 .cindex "host" "maximum number to try"
25796 .cindex "limit" "hosts; maximum number tried"
25797 There are two options that are concerned with the number of hosts that are
25798 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25799 &%hosts_max_try_hardlimit%&.
25800
25801
25802 The &%hosts_max_try%& option limits the number of hosts that are tried
25803 for a single delivery. However, despite the term &"host"& in its name, the
25804 option actually applies to each IP address independently. In other words, a
25805 multihomed host is treated as several independent hosts, just as it is for
25806 retrying.
25807
25808 Many of the larger ISPs have multiple MX records which often point to
25809 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25810 created as a result of routing one of these domains.
25811
25812 Trying every single IP address on such a long list does not seem sensible; if
25813 several at the top of the list fail, it is reasonable to assume there is some
25814 problem that is likely to affect all of them. Roughly speaking, the value of
25815 &%hosts_max_try%& is the maximum number that are tried before deferring the
25816 delivery. However, the logic cannot be quite that simple.
25817
25818 Firstly, IP addresses that are skipped because their retry times have not
25819 arrived do not count, and in addition, addresses that are past their retry
25820 limits are also not counted, even when they are tried. This means that when
25821 some IP addresses are past their retry limits, more than the value of
25822 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25823 that all IP addresses are considered before timing out an email address (but
25824 see below for an exception).
25825
25826 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25827 list to see if there is a subsequent host with a different (higher valued) MX.
25828 If there is, that host is considered next, and the current IP address is used
25829 but not counted. This behaviour helps in the case of a domain with a retry rule
25830 that hardly ever delays any hosts, as is now explained:
25831
25832 Consider the case of a long list of hosts with one MX value, and a few with a
25833 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25834 hosts at the top of the list are tried at first. With the default retry rule,
25835 which specifies increasing retry times, the higher MX hosts are eventually
25836 tried when those at the top of the list are skipped because they have not
25837 reached their retry times.
25838
25839 However, it is common practice to put a fixed short retry time on domains for
25840 large ISPs, on the grounds that their servers are rarely down for very long.
25841 Unfortunately, these are exactly the domains that tend to resolve to long lists
25842 of hosts. The short retry time means that the lowest MX hosts are tried every
25843 time. The attempts may be in a different order because of random sorting, but
25844 without the special MX check, the higher MX hosts would never be tried until
25845 all the lower MX hosts had timed out (which might be several days), because
25846 there are always some lower MX hosts that have reached their retry times. With
25847 the special check, Exim considers at least one IP address from each MX value at
25848 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25849 reached.
25850
25851 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25852 particular, Exim normally eventually tries all the IP addresses before timing
25853 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25854 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25855 been set up with hundreds of IP addresses for some domains. It can
25856 take a very long time indeed for an address to time out in these cases.
25857
25858 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25859 Exim never tries more than this number of IP addresses; if it hits this limit
25860 and they are all timed out, the email address is bounced, even though not all
25861 possible IP addresses have been tried.
25862 .ecindex IIDsmttra1
25863 .ecindex IIDsmttra2
25864
25865
25866
25867
25868
25869 . ////////////////////////////////////////////////////////////////////////////
25870 . ////////////////////////////////////////////////////////////////////////////
25871
25872 .chapter "Address rewriting" "CHAPrewrite"
25873 .scindex IIDaddrew "rewriting" "addresses"
25874 There are some circumstances in which Exim automatically rewrites domains in
25875 addresses. The two most common are when an address is given without a domain
25876 (referred to as an &"unqualified address"&) or when an address contains an
25877 abbreviated domain that is expanded by DNS lookup.
25878
25879 Unqualified envelope addresses are accepted only for locally submitted
25880 messages, or for messages that are received from hosts matching
25881 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25882 appropriate. Unqualified addresses in header lines are qualified if they are in
25883 locally submitted messages, or messages from hosts that are permitted to send
25884 unqualified envelope addresses. Otherwise, unqualified addresses in header
25885 lines are neither qualified nor rewritten.
25886
25887 One situation in which Exim does &'not'& automatically rewrite a domain is
25888 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25889 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25890 do this. The new RFCs do not contain this suggestion.
25891
25892
25893 .section "Explicitly configured address rewriting" "SECID147"
25894 This chapter describes the rewriting rules that can be used in the
25895 main rewrite section of the configuration file, and also in the generic
25896 &%headers_rewrite%& option that can be set on any transport.
25897
25898 Some people believe that configured address rewriting is a Mortal Sin.
25899 Others believe that life is not possible without it. Exim provides the
25900 facility; you do not have to use it.
25901
25902 The main rewriting rules that appear in the &"rewrite"& section of the
25903 configuration file are applied to addresses in incoming messages, both envelope
25904 addresses and addresses in header lines. Each rule specifies the types of
25905 address to which it applies.
25906
25907 Whether or not addresses in header lines are rewritten depends on the origin of
25908 the headers and the type of rewriting. Global rewriting, that is, rewriting
25909 rules from the rewrite section of the configuration file, is applied only to
25910 those headers that were received with the message. Header lines that are added
25911 by ACLs or by a system filter or by individual routers or transports (which
25912 are specific to individual recipient addresses) are not rewritten by the global
25913 rules.
25914
25915 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25916 applies all headers except those added by routers and transports. That is, as
25917 well as the headers that were received with the message, it also applies to
25918 headers that were added by an ACL or a system filter.
25919
25920
25921 In general, rewriting addresses from your own system or domain has some
25922 legitimacy. Rewriting other addresses should be done only with great care and
25923 in special circumstances. The author of Exim believes that rewriting should be
25924 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25925 Although it can sometimes be used as a routing tool, this is very strongly
25926 discouraged.
25927
25928 There are two commonly encountered circumstances where rewriting is used, as
25929 illustrated by these examples:
25930
25931 .ilist
25932 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25933 exchange mail with each other behind a firewall, but there is only a single
25934 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25935 &'hitch.fict.example'& when sending mail off-site.
25936 .next
25937 A host rewrites the local parts of its own users so that, for example,
25938 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25939 .endlist
25940
25941
25942
25943 .section "When does rewriting happen?" "SECID148"
25944 .cindex "rewriting" "timing of"
25945 .cindex "&ACL;" "rewriting addresses in"
25946 Configured address rewriting can take place at several different stages of a
25947 message's processing.
25948
25949 .vindex "&$sender_address$&"
25950 At the start of an ACL for MAIL, the sender address may have been rewritten
25951 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25952 ordinary rewrite rules have yet been applied. If, however, the sender address
25953 is verified in the ACL, it is rewritten before verification, and remains
25954 rewritten thereafter. The subsequent value of &$sender_address$& is the
25955 rewritten address. This also applies if sender verification happens in a
25956 RCPT ACL. Otherwise, when the sender address is not verified, it is
25957 rewritten as soon as a message's header lines have been received.
25958
25959 .vindex "&$domain$&"
25960 .vindex "&$local_part$&"
25961 Similarly, at the start of an ACL for RCPT, the current recipient's address
25962 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25963 rewrite rules have yet been applied to it. However, the behaviour is different
25964 from the sender address when a recipient is verified. The address is rewritten
25965 for the verification, but the rewriting is not remembered at this stage. The
25966 value of &$local_part$& and &$domain$& after verification are always the same
25967 as they were before (that is, they contain the unrewritten &-- except for
25968 SMTP-time rewriting &-- address).
25969
25970 As soon as a message's header lines have been received, all the envelope
25971 recipient addresses are permanently rewritten, and rewriting is also applied to
25972 the addresses in the header lines (if configured). This happens before adding
25973 any header lines that were specified in MAIL or RCPT ACLs, and
25974 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25975 before the DATA ACL and &[local_scan()]& functions are run.
25976
25977 When an address is being routed, either for delivery or for verification,
25978 rewriting is applied immediately to child addresses that are generated by
25979 redirection, unless &%no_rewrite%& is set on the router.
25980
25981 .cindex "envelope from"
25982 .cindex "envelope sender" "rewriting at transport time"
25983 .cindex "rewriting" "at transport time"
25984 .cindex "header lines" "rewriting at transport time"
25985 At transport time, additional rewriting of addresses in header lines can be
25986 specified by setting the generic &%headers_rewrite%& option on a transport.
25987 This option contains rules that are identical in form to those in the rewrite
25988 section of the configuration file. They are applied to the original message
25989 header lines and any that were added by ACLs or a system filter. They are not
25990 applied to header lines that are added by routers or the transport.
25991
25992 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25993 transport option. However, it is not possible to rewrite envelope recipients at
25994 transport time.
25995
25996
25997
25998
25999 .section "Testing the rewriting rules that apply on input" "SECID149"
26000 .cindex "rewriting" "testing"
26001 .cindex "testing" "rewriting"
26002 Exim's input rewriting configuration appears in a part of the runtime
26003 configuration file headed by &"begin rewrite"&. It can be tested by the
26004 &%-brw%& command line option. This takes an address (which can be a full RFC
26005 2822 address) as its argument. The output is a list of how the address would be
26006 transformed by the rewriting rules for each of the different places it might
26007 appear in an incoming message, that is, for each different header and for the
26008 envelope sender and recipient fields. For example,
26009 .code
26010 exim -brw ph10@exim.workshop.example
26011 .endd
26012 might produce the output
26013 .code
26014 sender: Philip.Hazel@exim.workshop.example
26015 from: Philip.Hazel@exim.workshop.example
26016 to: ph10@exim.workshop.example
26017 cc: ph10@exim.workshop.example
26018 bcc: ph10@exim.workshop.example
26019 reply-to: Philip.Hazel@exim.workshop.example
26020 env-from: Philip.Hazel@exim.workshop.example
26021 env-to: ph10@exim.workshop.example
26022 .endd
26023 which shows that rewriting has been set up for that address when used in any of
26024 the source fields, but not when it appears as a recipient address. At the
26025 present time, there is no equivalent way of testing rewriting rules that are
26026 set for a particular transport.
26027
26028
26029 .section "Rewriting rules" "SECID150"
26030 .cindex "rewriting" "rules"
26031 The rewrite section of the configuration file consists of lines of rewriting
26032 rules in the form
26033 .display
26034 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
26035 .endd
26036 Rewriting rules that are specified for the &%headers_rewrite%& generic
26037 transport option are given as a colon-separated list. Each item in the list
26038 takes the same form as a line in the main rewriting configuration (except that
26039 any colons must be doubled, of course).
26040
26041 The formats of source patterns and replacement strings are described below.
26042 Each is terminated by white space, unless enclosed in double quotes, in which
26043 case normal quoting conventions apply inside the quotes. The flags are single
26044 characters which may appear in any order. Spaces and tabs between them are
26045 ignored.
26046
26047 For each address that could potentially be rewritten, the rules are scanned in
26048 order, and replacements for the address from earlier rules can themselves be
26049 replaced by later rules (but see the &"q"& and &"R"& flags).
26050
26051 The order in which addresses are rewritten is undefined, may change between
26052 releases, and must not be relied on, with one exception: when a message is
26053 received, the envelope sender is always rewritten first, before any header
26054 lines are rewritten. For example, the replacement string for a rewrite of an
26055 address in &'To:'& must not assume that the message's address in &'From:'& has
26056 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
26057 that the envelope sender has already been rewritten.
26058
26059 .vindex "&$domain$&"
26060 .vindex "&$local_part$&"
26061 The variables &$local_part$& and &$domain$& can be used in the replacement
26062 string to refer to the address that is being rewritten. Note that lookup-driven
26063 rewriting can be done by a rule of the form
26064 .code
26065 *@*   ${lookup ...
26066 .endd
26067 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
26068 refer to the address that is being rewritten.
26069
26070
26071 .section "Rewriting patterns" "SECID151"
26072 .cindex "rewriting" "patterns"
26073 .cindex "address list" "in a rewriting pattern"
26074 The source pattern in a rewriting rule is any item which may appear in an
26075 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
26076 single-item address list, which means that it is expanded before being tested
26077 against the address. As always, if you use a regular expression as a pattern,
26078 you must take care to escape dollar and backslash characters, or use the &`\N`&
26079 facility to suppress string expansion within the regular expression.
26080
26081 Domains in patterns should be given in lower case. Local parts in patterns are
26082 case-sensitive. If you want to do case-insensitive matching of local parts, you
26083 can use a regular expression that starts with &`^(?i)`&.
26084
26085 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
26086 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
26087 depending on the type of match which occurred. These can be used in the
26088 replacement string to insert portions of the incoming address. &$0$& always
26089 refers to the complete incoming address. When a regular expression is used, the
26090 numerical variables are set from its capturing subexpressions. For other types
26091 of pattern they are set as follows:
26092
26093 .ilist
26094 If a local part or domain starts with an asterisk, the numerical variables
26095 refer to the character strings matched by asterisks, with &$1$& associated with
26096 the first asterisk, and &$2$& with the second, if present. For example, if the
26097 pattern
26098 .code
26099 *queen@*.fict.example
26100 .endd
26101 is matched against the address &'hearts-queen@wonderland.fict.example'& then
26102 .code
26103 $0 = hearts-queen@wonderland.fict.example
26104 $1 = hearts-
26105 $2 = wonderland
26106 .endd
26107 Note that if the local part does not start with an asterisk, but the domain
26108 does, it is &$1$& that contains the wild part of the domain.
26109
26110 .next
26111 If the domain part of the pattern is a partial lookup, the wild and fixed parts
26112 of the domain are placed in the next available numerical variables. Suppose,
26113 for example, that the address &'foo@bar.baz.example'& is processed by a
26114 rewriting rule of the form
26115 .display
26116 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
26117 .endd
26118 and the key in the file that matches the domain is &`*.baz.example`&. Then
26119 .code
26120 $1 = foo
26121 $2 = bar
26122 $3 = baz.example
26123 .endd
26124 If the address &'foo@baz.example'& is looked up, this matches the same
26125 wildcard file entry, and in this case &$2$& is set to the empty string, but
26126 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
26127 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
26128 whole domain. For non-partial domain lookups, no numerical variables are set.
26129 .endlist
26130
26131
26132 .section "Rewriting replacements" "SECID152"
26133 .cindex "rewriting" "replacements"
26134 If the replacement string for a rule is a single asterisk, addresses that
26135 match the pattern and the flags are &'not'& rewritten, and no subsequent
26136 rewriting rules are scanned. For example,
26137 .code
26138 hatta@lookingglass.fict.example  *  f
26139 .endd
26140 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
26141 &'From:'& headers.
26142
26143 .vindex "&$domain$&"
26144 .vindex "&$local_part$&"
26145 If the replacement string is not a single asterisk, it is expanded, and must
26146 yield a fully qualified address. Within the expansion, the variables
26147 &$local_part$& and &$domain$& refer to the address that is being rewritten.
26148 Any letters they contain retain their original case &-- they are not lower
26149 cased. The numerical variables are set up according to the type of pattern that
26150 matched the address, as described above. If the expansion is forced to fail by
26151 the presence of &"fail"& in a conditional or lookup item, rewriting by the
26152 current rule is abandoned, but subsequent rules may take effect. Any other
26153 expansion failure causes the entire rewriting operation to be abandoned, and an
26154 entry written to the panic log.
26155
26156
26157
26158 .section "Rewriting flags" "SECID153"
26159 There are three different kinds of flag that may appear on rewriting rules:
26160
26161 .ilist
26162 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
26163 c, f, h, r, s, t.
26164 .next
26165 A flag that specifies rewriting at SMTP time: S.
26166 .next
26167 Flags that control the rewriting process: Q, q, R, w.
26168 .endlist
26169
26170 For rules that are part of the &%headers_rewrite%& generic transport option,
26171 E, F, T, and S are not permitted.
26172
26173
26174
26175 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
26176          "SECID154"
26177 .cindex "rewriting" "flags"
26178 If none of the following flag letters, nor the &"S"& flag (see section
26179 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
26180 and to both the sender and recipient fields of the envelope, whereas a
26181 transport-time rewriting rule just applies to all headers. Otherwise, the
26182 rewriting rule is skipped unless the relevant addresses are being processed.
26183 .display
26184 &`E`&       rewrite all envelope fields
26185 &`F`&       rewrite the envelope From field
26186 &`T`&       rewrite the envelope To field
26187 &`b`&       rewrite the &'Bcc:'& header
26188 &`c`&       rewrite the &'Cc:'& header
26189 &`f`&       rewrite the &'From:'& header
26190 &`h`&       rewrite all headers
26191 &`r`&       rewrite the &'Reply-To:'& header
26192 &`s`&       rewrite the &'Sender:'& header
26193 &`t`&       rewrite the &'To:'& header
26194 .endd
26195 "All headers" means all of the headers listed above that can be selected
26196 individually, plus their &'Resent-'& versions. It does not include
26197 other headers such as &'Subject:'& etc.
26198
26199 You should be particularly careful about rewriting &'Sender:'& headers, and
26200 restrict this to special known cases in your own domains.
26201
26202
26203 .section "The SMTP-time rewriting flag" "SECTrewriteS"
26204 .cindex "SMTP" "rewriting malformed addresses"
26205 .cindex "RCPT" "rewriting argument of"
26206 .cindex "MAIL" "rewriting argument of"
26207 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
26208 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
26209 before any other processing; even before syntax checking. The pattern is
26210 required to be a regular expression, and it is matched against the whole of the
26211 data for the command, including any surrounding angle brackets.
26212
26213 .vindex "&$domain$&"
26214 .vindex "&$local_part$&"
26215 This form of rewrite rule allows for the handling of addresses that are not
26216 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
26217 input). Because the input is not required to be a syntactically valid address,
26218 the variables &$local_part$& and &$domain$& are not available during the
26219 expansion of the replacement string. The result of rewriting replaces the
26220 original address in the MAIL or RCPT command.
26221
26222
26223 .section "Flags controlling the rewriting process" "SECID155"
26224 There are four flags which control the way the rewriting process works. These
26225 take effect only when a rule is invoked, that is, when the address is of the
26226 correct type (matches the flags) and matches the pattern:
26227
26228 .ilist
26229 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
26230 unqualified local part. It is qualified with &%qualify_recipient%&. In the
26231 absence of &"Q"& the rewritten address must always include a domain.
26232 .next
26233 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
26234 even if no rewriting actually takes place because of a &"fail"& in the
26235 expansion. The &"q"& flag is not effective if the address is of the wrong type
26236 (does not match the flags) or does not match the pattern.
26237 .next
26238 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
26239 address, up to ten times. It can be combined with the &"q"& flag, to stop
26240 rewriting once it fails to match (after at least one successful rewrite).
26241 .next
26242 .cindex "rewriting" "whole addresses"
26243 When an address in a header is rewritten, the rewriting normally applies only
26244 to the working part of the address, with any comments and RFC 2822 &"phrase"&
26245 left unchanged. For example, rewriting might change
26246 .code
26247 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
26248 .endd
26249 into
26250 .code
26251 From: Ford Prefect <prefectf@hitch.fict.example>
26252 .endd
26253 .cindex "RFC 2047"
26254 Sometimes there is a need to replace the whole address item, and this can be
26255 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
26256 causes an address in a header line to be rewritten, the entire address is
26257 replaced, not just the working part. The replacement must be a complete RFC
26258 2822 address, including the angle brackets if necessary. If text outside angle
26259 brackets contains a character whose value is greater than 126 or less than 32
26260 (except for tab), the text is encoded according to RFC 2047. The character set
26261 is taken from &%headers_charset%&, which gets its default at build time.
26262
26263 When the &"w"& flag is set on a rule that causes an envelope address to be
26264 rewritten, all but the working part of the replacement address is discarded.
26265 .endlist
26266
26267
26268 .section "Rewriting examples" "SECID156"
26269 Here is an example of the two common rewriting paradigms:
26270 .code
26271 *@*.hitch.fict.example  $1@hitch.fict.example
26272 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
26273                      {$value}fail}@hitch.fict.example bctfrF
26274 .endd
26275 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
26276 the string expansion to fail if the lookup does not succeed. In this context it
26277 has the effect of leaving the original address unchanged, but Exim goes on to
26278 consider subsequent rewriting rules, if any, because the &"q"& flag is not
26279 present in that rule. An alternative to &"fail"& would be to supply &$1$&
26280 explicitly, which would cause the rewritten address to be the same as before,
26281 at the cost of a small bit of processing. Not supplying either of these is an
26282 error, since the rewritten address would then contain no local part.
26283
26284 The first example above replaces the domain with a superior, more general
26285 domain. This may not be desirable for certain local parts. If the rule
26286 .code
26287 root@*.hitch.fict.example  *
26288 .endd
26289 were inserted before the first rule, rewriting would be suppressed for the
26290 local part &'root'& at any domain ending in &'hitch.fict.example'&.
26291
26292 Rewriting can be made conditional on a number of tests, by making use of
26293 &${if$& in the expansion item. For example, to apply a rewriting rule only to
26294 messages that originate outside the local host:
26295 .code
26296 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
26297                          {$1@hitch.fict.example}fail}"
26298 .endd
26299 The replacement string is quoted in this example because it contains white
26300 space.
26301
26302 .cindex "rewriting" "bang paths"
26303 .cindex "bang paths" "rewriting"
26304 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
26305 an address it treats it as an unqualified local part which it qualifies with
26306 the local qualification domain (if the source of the message is local or if the
26307 remote host is permitted to send unqualified addresses). Rewriting can
26308 sometimes be used to handle simple bang paths with a fixed number of
26309 components. For example, the rule
26310 .code
26311 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
26312 .endd
26313 rewrites a two-component bang path &'host.name!user'& as the domain address
26314 &'user@host.name'&. However, there is a security implication in using this as
26315 a global rewriting rule for envelope addresses. It can provide a backdoor
26316 method for using your system as a relay, because the incoming addresses appear
26317 to be local. If the bang path addresses are received via SMTP, it is safer to
26318 use the &"S"& flag to rewrite them as they are received, so that relay checking
26319 can be done on the rewritten addresses.
26320 .ecindex IIDaddrew
26321
26322
26323
26324
26325
26326 . ////////////////////////////////////////////////////////////////////////////
26327 . ////////////////////////////////////////////////////////////////////////////
26328
26329 .chapter "Retry configuration" "CHAPretry"
26330 .scindex IIDretconf1 "retry" "configuration, description of"
26331 .scindex IIDregconf2 "configuration file" "retry section"
26332 The &"retry"& section of the runtime configuration file contains a list of
26333 retry rules that control how often Exim tries to deliver messages that cannot
26334 be delivered at the first attempt. If there are no retry rules (the section is
26335 empty or not present), there are no retries. In this situation, temporary
26336 errors are treated as permanent. The default configuration contains a single,
26337 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
26338 line option can be used to test which retry rule will be used for a given
26339 address, domain and error.
26340
26341 The most common cause of retries is temporary failure to deliver to a remote
26342 host because the host is down, or inaccessible because of a network problem.
26343 Exim's retry processing in this case is applied on a per-host (strictly, per IP
26344 address) basis, not on a per-message basis. Thus, if one message has recently
26345 been delayed, delivery of a new message to the same host is not immediately
26346 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
26347 log selector is set, the message
26348 .cindex "retry" "time not reached"
26349 &"retry time not reached"& is written to the main log whenever a delivery is
26350 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
26351 the handling of errors during remote deliveries.
26352
26353 Retry processing applies to routing as well as to delivering, except as covered
26354 in the next paragraph. The retry rules do not distinguish between these
26355 actions. It is not possible, for example, to specify different behaviour for
26356 failures to route the domain &'snark.fict.example'& and failures to deliver to
26357 the host &'snark.fict.example'&. I didn't think anyone would ever need this
26358 added complication, so did not implement it. However, although they share the
26359 same retry rule, the actual retry times for routing and transporting a given
26360 domain are maintained independently.
26361
26362 When a delivery is not part of a queue run (typically an immediate delivery on
26363 receipt of a message), the routers are always run, and local deliveries are
26364 always attempted, even if retry times are set for them. This makes for better
26365 behaviour if one particular message is causing problems (for example, causing
26366 quota overflow, or provoking an error in a filter file). If such a delivery
26367 suffers a temporary failure, the retry data is updated as normal, and
26368 subsequent delivery attempts from queue runs occur only when the retry time for
26369 the local address is reached.
26370
26371 .section "Changing retry rules" "SECID157"
26372 If you change the retry rules in your configuration, you should consider
26373 whether or not to delete the retry data that is stored in Exim's spool area in
26374 files with names like &_db/retry_&. Deleting any of Exim's hints files is
26375 always safe; that is why they are called &"hints"&.
26376
26377 The hints retry data contains suggested retry times based on the previous
26378 rules. In the case of a long-running problem with a remote host, it might
26379 record the fact that the host has timed out. If your new rules increase the
26380 timeout time for such a host, you should definitely remove the old retry data
26381 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
26382 messages that it should now be retaining.
26383
26384
26385
26386 .section "Format of retry rules" "SECID158"
26387 .cindex "retry" "rules"
26388 Each retry rule occupies one line and consists of three or four parts,
26389 separated by white space: a pattern, an error name, an optional list of sender
26390 addresses, and a list of retry parameters. The pattern and sender lists must be
26391 enclosed in double quotes if they contain white space. The rules are searched
26392 in order until one is found where the pattern, error name, and sender list (if
26393 present) match the failing host or address, the error that occurred, and the
26394 message's sender, respectively.
26395
26396
26397 The pattern is any single item that may appear in an address list (see section
26398 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
26399 which means that it is expanded before being tested against the address that
26400 has been delayed. A negated address list item is permitted. Address
26401 list processing treats a plain domain name as if it were preceded by &"*@"&,
26402 which makes it possible for many retry rules to start with just a domain. For
26403 example,
26404 .code
26405 lookingglass.fict.example        *  F,24h,30m;
26406 .endd
26407 provides a rule for any address in the &'lookingglass.fict.example'& domain,
26408 whereas
26409 .code
26410 alice@lookingglass.fict.example  *  F,24h,30m;
26411 .endd
26412 applies only to temporary failures involving the local part &%alice%&.
26413 In practice, almost all rules start with a domain name pattern without a local
26414 part.
26415
26416 .cindex "regular expressions" "in retry rules"
26417 &*Warning*&: If you use a regular expression in a retry rule pattern, it
26418 must match a complete address, not just a domain, because that is how regular
26419 expressions work in address lists.
26420 .display
26421 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
26422 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
26423 .endd
26424
26425
26426 .section "Choosing which retry rule to use for address errors" "SECID159"
26427 When Exim is looking for a retry rule after a routing attempt has failed (for
26428 example, after a DNS timeout), each line in the retry configuration is tested
26429 against the complete address only if &%retry_use_local_part%& is set for the
26430 router. Otherwise, only the domain is used, except when matching against a
26431 regular expression, when the local part of the address is replaced with &"*"&.
26432 A domain on its own can match a domain pattern, or a pattern that starts with
26433 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
26434 &%check_local_user%& is true, and false for other routers.
26435
26436 Similarly, when Exim is looking for a retry rule after a local delivery has
26437 failed (for example, after a mailbox full error), each line in the retry
26438 configuration is tested against the complete address only if
26439 &%retry_use_local_part%& is set for the transport (it defaults true for all
26440 local transports).
26441
26442 .cindex "4&'xx'& responses" "retry rules for"
26443 However, when Exim is looking for a retry rule after a remote delivery attempt
26444 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
26445 whole address is always used as the key when searching the retry rules. The
26446 rule that is found is used to create a retry time for the combination of the
26447 failing address and the message's sender. It is the combination of sender and
26448 recipient that is delayed in subsequent queue runs until its retry time is
26449 reached. You can delay the recipient without regard to the sender by setting
26450 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
26451 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
26452 commands.
26453
26454
26455
26456 .section "Choosing which retry rule to use for host and message errors" &&&
26457          "SECID160"
26458 For a temporary error that is not related to an individual address (for
26459 example, a connection timeout), each line in the retry configuration is checked
26460 twice. First, the name of the remote host is used as a domain name (preceded by
26461 &"*@"& when matching a regular expression). If this does not match the line,
26462 the domain from the email address is tried in a similar fashion. For example,
26463 suppose the MX records for &'a.b.c.example'& are
26464 .code
26465 a.b.c.example  MX  5  x.y.z.example
26466                MX  6  p.q.r.example
26467                MX  7  m.n.o.example
26468 .endd
26469 and the retry rules are
26470 .code
26471 p.q.r.example    *      F,24h,30m;
26472 a.b.c.example    *      F,4d,45m;
26473 .endd
26474 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
26475 first rule matches neither the host nor the domain, so Exim looks at the second
26476 rule. This does not match the host, but it does match the domain, so it is used
26477 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
26478 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
26479 first retry rule is used, because it matches the host.
26480
26481 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
26482 first rule to determine retry times, but for all the other hosts for the domain
26483 &'a.b.c.example'&, the second rule is used. The second rule is also used if
26484 routing to &'a.b.c.example'& suffers a temporary failure.
26485
26486 &*Note*&: The host name is used when matching the patterns, not its IP address.
26487 However, if a message is routed directly to an IP address without the use of a
26488 host name, for example, if a &(manualroute)& router contains a setting such as:
26489 .code
26490 route_list = *.a.example  192.168.34.23
26491 .endd
26492 then the &"host name"& that is used when searching for a retry rule is the
26493 textual form of the IP address.
26494
26495 .section "Retry rules for specific errors" "SECID161"
26496 .cindex "retry" "specific errors; specifying"
26497 The second field in a retry rule is the name of a particular error, or an
26498 asterisk, which matches any error. The errors that can be tested for are:
26499
26500 .vlist
26501 .vitem &%auth_failed%&
26502 Authentication failed when trying to send to a host in the
26503 &%hosts_require_auth%& list in an &(smtp)& transport.
26504
26505 .vitem &%data_4xx%&
26506 A 4&'xx'& error was received for an outgoing DATA command, either immediately
26507 after the command, or after sending the message's data.
26508
26509 .vitem &%mail_4xx%&
26510 A 4&'xx'& error was received for an outgoing MAIL command.
26511
26512 .vitem &%rcpt_4xx%&
26513 A 4&'xx'& error was received for an outgoing RCPT command.
26514 .endlist
26515
26516 For the three 4&'xx'& errors, either the first or both of the x's can be given
26517 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
26518 recognize 452 errors given to RCPT commands for addresses in a certain domain,
26519 and have retries every ten minutes with a one-hour timeout, you could set up a
26520 retry rule of this form:
26521 .code
26522 the.domain.name  rcpt_452   F,1h,10m
26523 .endd
26524 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
26525 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
26526
26527 .vlist
26528 .vitem &%lost_connection%&
26529 A server unexpectedly closed the SMTP connection. There may, of course,
26530 legitimate reasons for this (host died, network died), but if it repeats a lot
26531 for the same host, it indicates something odd.
26532
26533 .vitem &%lookup%&
26534 A DNS lookup for a host failed.
26535 Note that a &%dnslookup%& router will need to have matched
26536 its &%fail_defer_domains%& option for this retry type to be usable.
26537 Also note that a &%manualroute%& router will probably need
26538 its &%host_find_failed%& option set to &%defer%&.
26539
26540 .vitem &%refused_MX%&
26541 A connection to a host obtained from an MX record was refused.
26542
26543 .vitem &%refused_A%&
26544 A connection to a host not obtained from an MX record was refused.
26545
26546 .vitem &%refused%&
26547 A connection was refused.
26548
26549 .vitem &%timeout_connect_MX%&
26550 A connection attempt to a host obtained from an MX record timed out.
26551
26552 .vitem &%timeout_connect_A%&
26553 A connection attempt to a host not obtained from an MX record timed out.
26554
26555 .vitem &%timeout_connect%&
26556 A connection attempt timed out.
26557
26558 .vitem &%timeout_MX%&
26559 There was a timeout while connecting or during an SMTP session with a host
26560 obtained from an MX record.
26561
26562 .vitem &%timeout_A%&
26563 There was a timeout while connecting or during an SMTP session with a host not
26564 obtained from an MX record.
26565
26566 .vitem &%timeout%&
26567 There was a timeout while connecting or during an SMTP session.
26568
26569 .vitem &%tls_required%&
26570 The server was required to use TLS (it matched &%hosts_require_tls%& in the
26571 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
26572 to STARTTLS, or there was a problem setting up the TLS connection.
26573
26574 .vitem &%quota%&
26575 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26576 transport.
26577
26578 .vitem &%quota_%&<&'time'&>
26579 .cindex "quota" "error testing in retry rule"
26580 .cindex "retry" "quota error testing"
26581 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
26582 transport, and the mailbox has not been accessed for <&'time'&>. For example,
26583 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
26584 for four days.
26585 .endlist
26586
26587 .cindex "mailbox" "time of last read"
26588 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
26589 timeouts when the mailbox is full and is not being read by its owner. Ideally,
26590 it should be based on the last time that the user accessed the mailbox.
26591 However, it is not always possible to determine this. Exim uses the following
26592 heuristic rules:
26593
26594 .ilist
26595 If the mailbox is a single file, the time of last access (the &"atime"&) is
26596 used. As no new messages are being delivered (because the mailbox is over
26597 quota), Exim does not access the file, so this is the time of last user access.
26598 .next
26599 .cindex "maildir format" "time of last read"
26600 For a maildir delivery, the time of last modification of the &_new_&
26601 subdirectory is used. As the mailbox is over quota, no new files are created in
26602 the &_new_& subdirectory, because no new messages are being delivered. Any
26603 change to the &_new_& subdirectory is therefore assumed to be the result of an
26604 MUA moving a new message to the &_cur_& directory when it is first read. The
26605 time that is used is therefore the last time that the user read a new message.
26606 .next
26607 For other kinds of multi-file mailbox, the time of last access cannot be
26608 obtained, so a retry rule that uses this type of error field is never matched.
26609 .endlist
26610
26611 The quota errors apply both to system-enforced quotas and to Exim's own quota
26612 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
26613 when a local delivery is deferred because a partition is full (the ENOSPC
26614 error).
26615
26616
26617
26618 .section "Retry rules for specified senders" "SECID162"
26619 .cindex "retry" "rules; sender-specific"
26620 You can specify retry rules that apply only when the failing message has a
26621 specific sender. In particular, this can be used to define retry rules that
26622 apply only to bounce messages. The third item in a retry rule can be of this
26623 form:
26624 .display
26625 &`senders=`&<&'address list'&>
26626 .endd
26627 The retry timings themselves are then the fourth item. For example:
26628 .code
26629 *   rcpt_4xx   senders=:   F,1h,30m
26630 .endd
26631 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
26632 host. If the address list contains white space, it must be enclosed in quotes.
26633 For example:
26634 .code
26635 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
26636 .endd
26637 &*Warning*&: This facility can be unhelpful if it is used for host errors
26638 (which do not depend on the recipient). The reason is that the sender is used
26639 only to match the retry rule. Once the rule has been found for a host error,
26640 its contents are used to set a retry time for the host, and this will apply to
26641 all messages, not just those with specific senders.
26642
26643 When testing retry rules using &%-brt%&, you can supply a sender using the
26644 &%-f%& command line option, like this:
26645 .code
26646 exim -f "" -brt user@dom.ain
26647 .endd
26648 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
26649 list is never matched.
26650
26651
26652
26653
26654
26655 .section "Retry parameters" "SECID163"
26656 .cindex "retry" "parameters in rules"
26657 The third (or fourth, if a senders list is present) field in a retry rule is a
26658 sequence of retry parameter sets, separated by semicolons. Each set consists of
26659 .display
26660 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
26661 .endd
26662 The letter identifies the algorithm for computing a new retry time; the cutoff
26663 time is the time beyond which this algorithm no longer applies, and the
26664 arguments vary the algorithm's action. The cutoff time is measured from the
26665 time that the first failure for the domain (combined with the local part if
26666 relevant) was detected, not from the time the message was received.
26667
26668 .cindex "retry" "algorithms"
26669 .cindex "retry" "fixed intervals"
26670 .cindex "retry" "increasing intervals"
26671 .cindex "retry" "random intervals"
26672 The available algorithms are:
26673
26674 .ilist
26675 &'F'&: retry at fixed intervals. There is a single time parameter specifying
26676 the interval.
26677 .next
26678 &'G'&: retry at geometrically increasing intervals. The first argument
26679 specifies a starting value for the interval, and the second a multiplier, which
26680 is used to increase the size of the interval at each retry.
26681 .next
26682 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
26683 retry, the previous interval is multiplied by the factor in order to get a
26684 maximum for the next interval. The minimum interval is the first argument of
26685 the parameter, and an actual interval is chosen randomly between them. Such a
26686 rule has been found to be helpful in cluster configurations when all the
26687 members of the cluster restart at once, and may therefore synchronize their
26688 queue processing times.
26689 .endlist
26690
26691 When computing the next retry time, the algorithm definitions are scanned in
26692 order until one whose cutoff time has not yet passed is reached. This is then
26693 used to compute a new retry time that is later than the current time. In the
26694 case of fixed interval retries, this simply means adding the interval to the
26695 current time. For geometrically increasing intervals, retry intervals are
26696 computed from the rule's parameters until one that is greater than the previous
26697 interval is found. The main configuration variable
26698 .cindex "limit" "retry interval"
26699 .cindex "retry" "interval, maximum"
26700 .oindex "&%retry_interval_max%&"
26701 &%retry_interval_max%& limits the maximum interval between retries. It
26702 cannot be set greater than &`24h`&, which is its default value.
26703
26704 A single remote domain may have a number of hosts associated with it, and each
26705 host may have more than one IP address. Retry algorithms are selected on the
26706 basis of the domain name, but are applied to each IP address independently. If,
26707 for example, a host has two IP addresses and one is unusable, Exim will
26708 generate retry times for it and will not try to use it until its next retry
26709 time comes. Thus the good IP address is likely to be tried first most of the
26710 time.
26711
26712 .cindex "hints database" "use for retrying"
26713 Retry times are hints rather than promises. Exim does not make any attempt to
26714 run deliveries exactly at the computed times. Instead, a queue runner process
26715 starts delivery processes for delayed messages periodically, and these attempt
26716 new deliveries only for those addresses that have passed their next retry time.
26717 If a new message arrives for a deferred address, an immediate delivery attempt
26718 occurs only if the address has passed its retry time. In the absence of new
26719 messages, the minimum time between retries is the interval between queue runner
26720 processes. There is not much point in setting retry times of five minutes if
26721 your queue runners happen only once an hour, unless there are a significant
26722 number of incoming messages (which might be the case on a system that is
26723 sending everything to a smart host, for example).
26724
26725 The data in the retry hints database can be inspected by using the
26726 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
26727 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
26728 &'exinext'& utility script can be used to find out what the next retry times
26729 are for the hosts associated with a particular mail domain, and also for local
26730 deliveries that have been deferred.
26731
26732
26733 .section "Retry rule examples" "SECID164"
26734 Here are some example retry rules:
26735 .code
26736 alice@wonderland.fict.example quota_5d  F,7d,3h
26737 wonderland.fict.example       quota_5d
26738 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
26739 lookingglass.fict.example     *         F,24h,30m;
26740 *                 refused_A   F,2h,20m;
26741 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
26742 .endd
26743 The first rule sets up special handling for mail to
26744 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26745 mailbox has not been read for at least 5 days. Retries continue every three
26746 hours for 7 days. The second rule handles over-quota errors for all other local
26747 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26748 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26749 fail are bounced immediately if the mailbox has not been read for at least 5
26750 days.
26751
26752 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26753 happen every 15 minutes for an hour, then with geometrically increasing
26754 intervals until two days have passed since a delivery first failed. After the
26755 first hour there is a delay of one hour, then two hours, then four hours, and
26756 so on (this is a rather extreme example).
26757
26758 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26759 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26760 all other domains, with special action for connection refusal from hosts that
26761 were not obtained from an MX record.
26762
26763 The final rule in a retry configuration should always have asterisks in the
26764 first two fields so as to provide a general catch-all for any addresses that do
26765 not have their own special handling. This example tries every 15 minutes for 2
26766 hours, then with intervals starting at one hour and increasing by a factor of
26767 1.5 up to 16 hours, then every 8 hours up to 5 days.
26768
26769
26770
26771 .section "Timeout of retry data" "SECID165"
26772 .cindex "timeout" "of retry data"
26773 .oindex "&%retry_data_expire%&"
26774 .cindex "hints database" "data expiry"
26775 .cindex "retry" "timeout of data"
26776 Exim timestamps the data that it writes to its retry hints database. When it
26777 consults the data during a delivery it ignores any that is older than the value
26778 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26779 been tried for 7 days, Exim will try to deliver to it immediately a message
26780 arrives, and if that fails, it will calculate a retry time as if it were
26781 failing for the first time.
26782
26783 This improves the behaviour for messages routed to rarely-used hosts such as MX
26784 backups. If such a host was down at one time, and happens to be down again when
26785 Exim tries a month later, using the old retry data would imply that it had been
26786 down all the time, which is not a justified assumption.
26787
26788 If a host really is permanently dead, this behaviour causes a burst of retries
26789 every now and again, but only if messages routed to it are rare. If there is a
26790 message at least once every 7 days the retry data never expires.
26791
26792
26793
26794
26795 .section "Long-term failures" "SECID166"
26796 .cindex "delivery failure, long-term"
26797 .cindex "retry" "after long-term failure"
26798 Special processing happens when an email address has been failing for so long
26799 that the cutoff time for the last algorithm is reached. For example, using the
26800 default retry rule:
26801 .code
26802 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26803 .endd
26804 the cutoff time is four days. Reaching the retry cutoff is independent of how
26805 long any specific message has been failing; it is the length of continuous
26806 failure for the recipient address that counts.
26807
26808 When the cutoff time is reached for a local delivery, or for all the IP
26809 addresses associated with a remote delivery, a subsequent delivery failure
26810 causes Exim to give up on the address, and a bounce message is generated.
26811 In order to cater for new messages that use the failing address, a next retry
26812 time is still computed from the final algorithm, and is used as follows:
26813
26814 For local deliveries, one delivery attempt is always made for any subsequent
26815 messages. If this delivery fails, the address fails immediately. The
26816 post-cutoff retry time is not used.
26817
26818 .cindex "final cutoff" "retries, controlling"
26819 .cindex retry "final cutoff"
26820 If the delivery is remote, there are two possibilities, controlled by the
26821 .oindex "&%delay_after_cutoff%&"
26822 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26823 default. Until the post-cutoff retry time for one of the IP addresses,
26824 as set by the &%retry_data_expire%& option, is
26825 reached, the failing email address is bounced immediately, without a delivery
26826 attempt taking place. After that time, one new delivery attempt is made to
26827 those IP addresses that are past their retry times, and if that still fails,
26828 the address is bounced and new retry times are computed.
26829
26830 In other words, when all the hosts for a given email address have been failing
26831 for a long time, Exim bounces rather then defers until one of the hosts' retry
26832 times is reached. Then it tries once, and bounces if that attempt fails. This
26833 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26834 to a broken destination, but if the host does recover, Exim will eventually
26835 notice.
26836
26837 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26838 addresses are past their final cutoff time, Exim tries to deliver to those IP
26839 addresses that have not been tried since the message arrived. If there are
26840 no suitable IP addresses, or if they all fail, the address is bounced. In other
26841 words, it does not delay when a new message arrives, but tries the expired
26842 addresses immediately, unless they have been tried since the message arrived.
26843 If there is a continuous stream of messages for the failing domains, setting
26844 &%delay_after_cutoff%& false means that there will be many more attempts to
26845 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26846 true.
26847
26848 .section "Deliveries that work intermittently" "SECID167"
26849 .cindex "retry" "intermittently working deliveries"
26850 Some additional logic is needed to cope with cases where a host is
26851 intermittently available, or when a message has some attribute that prevents
26852 its delivery when others to the same address get through. In this situation,
26853 because some messages are successfully delivered, the &"retry clock"& for the
26854 host or address keeps getting reset by the successful deliveries, and so
26855 failing messages remain in the queue for ever because the cutoff time is never
26856 reached.
26857
26858 Two exceptional actions are applied to prevent this happening. The first
26859 applies to errors that are related to a message rather than a remote host.
26860 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26861 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26862 commands, and quota failures. For this type of error, if a message's arrival
26863 time is earlier than the &"first failed"& time for the error, the earlier time
26864 is used when scanning the retry rules to decide when to try next and when to
26865 time out the address.
26866
26867 The exceptional second action applies in all cases. If a message has been on
26868 the queue for longer than the cutoff time of any applicable retry rule for a
26869 given address, a delivery is attempted for that address, even if it is not yet
26870 time, and if this delivery fails, the address is timed out. A new retry time is
26871 not computed in this case, so that other messages for the same address are
26872 considered immediately.
26873 .ecindex IIDretconf1
26874 .ecindex IIDregconf2
26875
26876
26877
26878
26879
26880
26881 . ////////////////////////////////////////////////////////////////////////////
26882 . ////////////////////////////////////////////////////////////////////////////
26883
26884 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26885 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26886 .scindex IIDauthconf2 "authentication"
26887 The &"authenticators"& section of Exim's runtime configuration is concerned
26888 with SMTP authentication. This facility is an extension to the SMTP protocol,
26889 described in RFC 2554, which allows a client SMTP host to authenticate itself
26890 to a server. This is a common way for a server to recognize clients that are
26891 permitted to use it as a relay. SMTP authentication is not of relevance to the
26892 transfer of mail between servers that have no managerial connection with each
26893 other.
26894
26895 .cindex "AUTH" "description of"
26896 .cindex "ESMTP extensions" AUTH
26897 Very briefly, the way SMTP authentication works is as follows:
26898
26899 .ilist
26900 The server advertises a number of authentication &'mechanisms'& in response to
26901 the client's EHLO command.
26902 .next
26903 The client issues an AUTH command, naming a specific mechanism. The command
26904 may, optionally, contain some authentication data.
26905 .next
26906 The server may issue one or more &'challenges'&, to which the client must send
26907 appropriate responses. In simple authentication mechanisms, the challenges are
26908 just prompts for user names and passwords. The server does not have to issue
26909 any challenges &-- in some mechanisms the relevant data may all be transmitted
26910 with the AUTH command.
26911 .next
26912 The server either accepts or denies authentication.
26913 .next
26914 If authentication succeeds, the client may optionally make use of the AUTH
26915 option on the MAIL command to pass an authenticated sender in subsequent
26916 mail transactions. Authentication lasts for the remainder of the SMTP
26917 connection.
26918 .next
26919 If authentication fails, the client may give up, or it may try a different
26920 authentication mechanism, or it may try transferring mail over the
26921 unauthenticated connection.
26922 .endlist
26923
26924 If you are setting up a client, and want to know which authentication
26925 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26926 SMTP port) on the server, and issue an EHLO command. The response to this
26927 includes the list of supported mechanisms. For example:
26928 .display
26929 &`$ `&&*&`telnet server.example 25`&*&
26930 &`Trying 192.168.34.25...`&
26931 &`Connected to server.example.`&
26932 &`Escape character is &#x0027;^]&#x0027;.`&
26933 &`220 server.example ESMTP Exim 4.20 ...`&
26934 &*&`ehlo client.example`&*&
26935 &`250-server.example Hello client.example [10.8.4.5]`&
26936 &`250-SIZE 52428800`&
26937 &`250-PIPELINING`&
26938 &`250-AUTH PLAIN`&
26939 &`250 HELP`&
26940 .endd
26941 The second-last line of this example output shows that the server supports
26942 authentication using the PLAIN mechanism. In Exim, the different authentication
26943 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26944 routers and transports, which authenticators are included in the binary is
26945 controlled by build-time definitions. The following are currently available,
26946 included by setting
26947 .code
26948 AUTH_CRAM_MD5=yes
26949 AUTH_CYRUS_SASL=yes
26950 AUTH_DOVECOT=yes
26951 AUTH_EXTERNAL=yes
26952 AUTH_GSASL=yes
26953 AUTH_HEIMDAL_GSSAPI=yes
26954 AUTH_PLAINTEXT=yes
26955 AUTH_SPA=yes
26956 AUTH_TLS=yes
26957 .endd
26958 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26959 authentication mechanism (RFC 2195), and the second provides an interface to
26960 the Cyrus SASL authentication library.
26961 The third is an interface to Dovecot's authentication system, delegating the
26962 work via a socket interface.
26963 The fourth provides for negotiation of authentication done via non-SMTP means,
26964 as defined by RFC 4422 Appendix A.
26965 The fifth provides an interface to the GNU SASL authentication library, which
26966 provides mechanisms but typically not data sources.
26967 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26968 supporting setting a server keytab.
26969 The seventh can be configured to support
26970 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26971 not formally documented, but used by several MUAs.
26972 The eighth authenticator
26973 supports Microsoft's &'Secure Password Authentication'& mechanism.
26974 The last is an Exim authenticator but not an SMTP one;
26975 instead it can use information from a TLS negotiation.
26976
26977 The authenticators are configured using the same syntax as other drivers (see
26978 section &<<SECTfordricon>>&). If no authenticators are required, no
26979 authentication section need be present in the configuration file. Each
26980 authenticator can in principle have both server and client functions. When Exim
26981 is receiving SMTP mail, it is acting as a server; when it is sending out
26982 messages over SMTP, it is acting as a client. Authenticator configuration
26983 options are provided for use in both these circumstances.
26984
26985 To make it clear which options apply to which situation, the prefixes
26986 &%server_%& and &%client_%& are used on option names that are specific to
26987 either the server or the client function, respectively. Server and client
26988 functions are disabled if none of their options are set. If an authenticator is
26989 to be used for both server and client functions, a single definition, using
26990 both sets of options, is required. For example:
26991 .code
26992 cram:
26993   driver = cram_md5
26994   public_name = CRAM-MD5
26995   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26996   client_name = ph10
26997   client_secret = secret2
26998 .endd
26999 The &%server_%& option is used when Exim is acting as a server, and the
27000 &%client_%& options when it is acting as a client.
27001
27002 Descriptions of the individual authenticators are given in subsequent chapters.
27003 The remainder of this chapter covers the generic options for the
27004 authenticators, followed by general discussion of the way authentication works
27005 in Exim.
27006
27007 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
27008 per-mechanism basis.  Please read carefully to determine which variables hold
27009 account labels such as usercodes and which hold passwords or other
27010 authenticating data.
27011
27012 Note that some mechanisms support two different identifiers for accounts: the
27013 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
27014 and &'authz'& are commonly encountered.  The American spelling is standard here.
27015 Conceptually, authentication data such as passwords are tied to the identifier
27016 used to authenticate; servers may have rules to permit one user to act as a
27017 second user, so that after login the session is treated as though that second
27018 user had logged in.  That second user is the &'authorization id'&.  A robust
27019 configuration might confirm that the &'authz'& field is empty or matches the
27020 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
27021 as verified data, the &'authz'& as an unverified request which the server might
27022 choose to honour.
27023
27024 A &'realm'& is a text string, typically a domain name, presented by a server
27025 to a client to help it select an account and credentials to use.  In some
27026 mechanisms, the client and server provably agree on the realm, but clients
27027 typically can not treat the realm as secure data to be blindly trusted.
27028
27029
27030
27031 .section "Generic options for authenticators" "SECID168"
27032 .cindex "authentication" "generic options"
27033 .cindex "options" "generic; for authenticators"
27034
27035 .option client_condition authenticators string&!! unset
27036 When Exim is authenticating as a client, it skips any authenticator whose
27037 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
27038 used, for example, to skip plain text authenticators when the connection is not
27039 encrypted by a setting such as:
27040 .code
27041 client_condition = ${if !eq{$tls_out_cipher}{}}
27042 .endd
27043
27044
27045 .option client_set_id authenticators string&!! unset
27046 When client authentication succeeds, this condition is expanded; the
27047 result is used in the log lines for outbound messages.
27048 Typically it will be the user name used for authentication.
27049
27050
27051 .option driver authenticators string unset
27052 This option must always be set. It specifies which of the available
27053 authenticators is to be used.
27054
27055
27056 .option public_name authenticators string unset
27057 This option specifies the name of the authentication mechanism that the driver
27058 implements, and by which it is known to the outside world. These names should
27059 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
27060 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
27061 defaults to the driver's instance name.
27062
27063
27064 .option server_advertise_condition authenticators string&!! unset
27065 When a server is about to advertise an authentication mechanism, the condition
27066 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
27067 mechanism is not advertised.
27068 If the expansion fails, the mechanism is not advertised. If the failure was not
27069 forced, and was not caused by a lookup defer, the incident is logged.
27070 See section &<<SECTauthexiser>>& below for further discussion.
27071
27072
27073 .option server_condition authenticators string&!! unset
27074 This option must be set for a &%plaintext%& server authenticator, where it
27075 is used directly to control authentication. See section &<<SECTplainserver>>&
27076 for details.
27077
27078 For the &(gsasl)& authenticator, this option is required for various
27079 mechanisms; see chapter &<<CHAPgsasl>>& for details.
27080
27081 For the other authenticators, &%server_condition%& can be used as an additional
27082 authentication or authorization mechanism that is applied after the other
27083 authenticator conditions succeed. If it is set, it is expanded when the
27084 authenticator would otherwise return a success code. If the expansion is forced
27085 to fail, authentication fails. Any other expansion failure causes a temporary
27086 error code to be returned. If the result of a successful expansion is an empty
27087 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27088 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
27089 other result, a temporary error code is returned, with the expanded string as
27090 the error text.
27091
27092
27093 .option server_debug_print authenticators string&!! unset
27094 If this option is set and authentication debugging is enabled (see the &%-d%&
27095 command line option), the string is expanded and included in the debugging
27096 output when the authenticator is run as a server. This can help with checking
27097 out the values of variables.
27098 If expansion of the string fails, the error message is written to the debugging
27099 output, and Exim carries on processing.
27100
27101
27102 .option server_set_id authenticators string&!! unset
27103 .vindex "&$authenticated_id$&"
27104 .vindex "&$authenticated_fail_id$&"
27105 When an Exim server successfully authenticates a client, this string is
27106 expanded using data from the authentication, and preserved for any incoming
27107 messages in the variable &$authenticated_id$&. It is also included in the log
27108 lines for incoming messages. For example, a user/password authenticator
27109 configuration might preserve the user name that was used to authenticate, and
27110 refer to it subsequently during delivery of the message.
27111 On a failing authentication the expansion result is instead saved in
27112 the &$authenticated_fail_id$& variable.
27113 If expansion fails, the option is ignored.
27114
27115
27116 .option server_mail_auth_condition authenticators string&!! unset
27117 This option allows a server to discard authenticated sender addresses supplied
27118 as part of MAIL commands in SMTP connections that are authenticated by the
27119 driver on which &%server_mail_auth_condition%& is set. The option is not used
27120 as part of the authentication process; instead its (unexpanded) value is
27121 remembered for later use.
27122 How it is used is described in the following section.
27123
27124
27125
27126
27127
27128 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
27129 .cindex "authentication" "sender; authenticated"
27130 .cindex "AUTH" "on MAIL command"
27131 When a client supplied an AUTH= item on a MAIL command, Exim applies
27132 the following checks before accepting it as the authenticated sender of the
27133 message:
27134
27135 .ilist
27136 If the connection is not using extended SMTP (that is, HELO was used rather
27137 than EHLO), the use of AUTH= is a syntax error.
27138 .next
27139 If the value of the AUTH= parameter is &"<>"&, it is ignored.
27140 .next
27141 .vindex "&$authenticated_sender$&"
27142 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
27143 running, the value of &$authenticated_sender$& is set to the value obtained
27144 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
27145 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
27146 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
27147 given for the MAIL command.
27148 .next
27149 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
27150 is accepted and placed in &$authenticated_sender$& only if the client has
27151 authenticated.
27152 .next
27153 If the AUTH= value was accepted by either of the two previous rules, and
27154 the client has authenticated, and the authenticator has a setting for the
27155 &%server_mail_auth_condition%&, the condition is checked at this point. The
27156 valued that was saved from the authenticator is expanded. If the expansion
27157 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
27158 &$authenticated_sender$& is deleted. If the expansion yields any other value,
27159 the value of &$authenticated_sender$& is retained and passed on with the
27160 message.
27161 .endlist
27162
27163
27164 When &$authenticated_sender$& is set for a message, it is passed on to other
27165 hosts to which Exim authenticates as a client. Do not confuse this value with
27166 &$authenticated_id$&, which is a string obtained from the authentication
27167 process, and which is not usually a complete email address.
27168
27169 .vindex "&$sender_address$&"
27170 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
27171 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
27172 therefore make use of &$authenticated_sender$&. The converse is not true: the
27173 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
27174 ACL is run.
27175
27176
27177
27178 .section "Authentication on an Exim server" "SECTauthexiser"
27179 .cindex "authentication" "on an Exim server"
27180 When Exim receives an EHLO command, it advertises the public names of those
27181 authenticators that are configured as servers, subject to the following
27182 conditions:
27183
27184 .ilist
27185 The client host must match &%auth_advertise_hosts%& (default *).
27186 .next
27187 It the &%server_advertise_condition%& option is set, its expansion must not
27188 yield the empty string, &"0"&, &"no"&, or &"false"&.
27189 .endlist
27190
27191 The order in which the authenticators are defined controls the order in which
27192 the mechanisms are advertised.
27193
27194 Some mail clients (for example, some versions of Netscape) require the user to
27195 provide a name and password for authentication whenever AUTH is advertised,
27196 even though authentication may not in fact be needed (for example, Exim may be
27197 set up to allow unconditional relaying from the client by an IP address check).
27198 You can make such clients more friendly by not advertising AUTH to them.
27199 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
27200 that runs for RCPT) to relay without authentication, you should set
27201 .code
27202 auth_advertise_hosts = ! 10.9.8.0/24
27203 .endd
27204 so that no authentication mechanisms are advertised to them.
27205
27206 The &%server_advertise_condition%& controls the advertisement of individual
27207 authentication mechanisms. For example, it can be used to restrict the
27208 advertisement of a particular mechanism to encrypted connections, by a setting
27209 such as:
27210 .code
27211 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
27212 .endd
27213 .vindex "&$tls_in_cipher$&"
27214 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
27215 yields &"yes"&, which allows the advertisement to happen.
27216
27217 When an Exim server receives an AUTH command from a client, it rejects it
27218 immediately if AUTH was not advertised in response to an earlier EHLO
27219 command. This is the case if
27220
27221 .ilist
27222 The client host does not match &%auth_advertise_hosts%&; or
27223 .next
27224 No authenticators are configured with server options; or
27225 .next
27226 Expansion of &%server_advertise_condition%& blocked the advertising of all the
27227 server authenticators.
27228 .endlist
27229
27230
27231 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
27232 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
27233 AUTH is accepted from any client host.
27234
27235 If AUTH is not rejected by the ACL, Exim searches its configuration for a
27236 server authentication mechanism that was advertised in response to EHLO and
27237 that matches the one named in the AUTH command. If it finds one, it runs
27238 the appropriate authentication protocol, and authentication either succeeds or
27239 fails. If there is no matching advertised mechanism, the AUTH command is
27240 rejected with a 504 error.
27241
27242 .vindex "&$received_protocol$&"
27243 .vindex "&$sender_host_authenticated$&"
27244 When a message is received from an authenticated host, the value of
27245 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
27246 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
27247 public name) of the authenticator driver that successfully authenticated the
27248 client from which the message was received. This variable is empty if there was
27249 no successful authentication.
27250
27251 .cindex authentication "expansion item"
27252 Successful authentication sets up information used by the
27253 &%authresults%& expansion item.
27254
27255
27256
27257
27258 .section "Testing server authentication" "SECID169"
27259 .cindex "authentication" "testing a server"
27260 .cindex "AUTH" "testing a server"
27261 .cindex "base64 encoding" "creating authentication test data"
27262 Exim's &%-bh%& option can be useful for testing server authentication
27263 configurations. The data for the AUTH command has to be sent using base64
27264 encoding. A quick way to produce such data for testing is the following Perl
27265 script:
27266 .code
27267 use MIME::Base64;
27268 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
27269 .endd
27270 .cindex "binary zero" "in authentication data"
27271 This interprets its argument as a Perl string, and then encodes it. The
27272 interpretation as a Perl string allows binary zeros, which are required for
27273 some kinds of authentication, to be included in the data. For example, a
27274 command line to run this script on such data might be
27275 .code
27276 encode '\0user\0password'
27277 .endd
27278 Note the use of single quotes to prevent the shell interpreting the
27279 backslashes, so that they can be interpreted by Perl to specify characters
27280 whose code value is zero.
27281
27282 &*Warning 1*&: If either of the user or password strings starts with an octal
27283 digit, you must use three zeros instead of one after the leading backslash. If
27284 you do not, the octal digit that starts your string will be incorrectly
27285 interpreted as part of the code for the first character.
27286
27287 &*Warning 2*&: If there are characters in the strings that Perl interprets
27288 specially, you must use a Perl escape to prevent them being misinterpreted. For
27289 example, a command such as
27290 .code
27291 encode '\0user@domain.com\0pas$$word'
27292 .endd
27293 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
27294
27295 If you have the &%mimencode%& command installed, another way to do produce
27296 base64-encoded strings is to run the command
27297 .code
27298 echo -e -n `\0user\0password' | mimencode
27299 .endd
27300 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
27301 in the argument, and the &%-n%& option specifies no newline at the end of its
27302 output. However, not all versions of &%echo%& recognize these options, so you
27303 should check your version before relying on this suggestion.
27304
27305
27306
27307 .section "Authentication by an Exim client" "SECID170"
27308 .cindex "authentication" "on an Exim client"
27309 The &(smtp)& transport has two options called &%hosts_require_auth%& and
27310 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
27311 announces support for authentication, and the host matches an entry in either
27312 of these options, Exim (as a client) tries to authenticate as follows:
27313
27314 .ilist
27315 For each authenticator that is configured as a client, in the order in which
27316 they are defined in the configuration, it searches the authentication
27317 mechanisms announced by the server for one whose name matches the public name
27318 of the authenticator.
27319 .next
27320 .vindex "&$host$&"
27321 .vindex "&$host_address$&"
27322 When it finds one that matches, it runs the authenticator's client code. The
27323 variables &$host$& and &$host_address$& are available for any string expansions
27324 that the client might do. They are set to the server's name and IP address. If
27325 any expansion is forced to fail, the authentication attempt is abandoned, and
27326 Exim moves on to the next authenticator. Otherwise an expansion failure causes
27327 delivery to be deferred.
27328 .next
27329 If the result of the authentication attempt is a temporary error or a timeout,
27330 Exim abandons trying to send the message to the host for the moment. It will
27331 try again later. If there are any backup hosts available, they are tried in the
27332 usual way.
27333 .next
27334 If the response to authentication is a permanent error (5&'xx'& code), Exim
27335 carries on searching the list of authenticators and tries another one if
27336 possible. If all authentication attempts give permanent errors, or if there are
27337 no attempts because no mechanisms match (or option expansions force failure),
27338 what happens depends on whether the host matches &%hosts_require_auth%& or
27339 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
27340 delivery is deferred. The error can be detected in the retry rules, and thereby
27341 turned into a permanent error if you wish. In the second case, Exim tries to
27342 deliver the message unauthenticated.
27343 .endlist
27344
27345 Note that the hostlist test for whether to do authentication can be
27346 confused if name-IP lookups change between the time the peer is decided
27347 upon and the time that the transport runs.  For example, with a manualroute
27348 router given a host name, and with DNS "round-robin" used by that name: if
27349 the local resolver cache times out between the router and the transport
27350 running, the transport may get an IP for the name for its authentication
27351 check which does not match the connection peer IP.
27352 No authentication will then be done, despite the names being identical.
27353
27354 For such cases use a separate transport which always authenticates.
27355
27356 .cindex "AUTH" "on MAIL command"
27357 When Exim has authenticated itself to a remote server, it adds the AUTH
27358 parameter to the MAIL commands it sends, if it has an authenticated sender for
27359 the message. If the message came from a remote host, the authenticated sender
27360 is the one that was receiving on an incoming MAIL command, provided that the
27361 incoming connection was authenticated and the &%server_mail_auth%& condition
27362 allowed the authenticated sender to be retained. If a local process calls Exim
27363 to send a message, the sender address that is built from the login name and
27364 &%qualify_domain%& is treated as authenticated. However, if the
27365 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
27366 the authenticated sender that was received with the message.
27367 .ecindex IIDauthconf1
27368 .ecindex IIDauthconf2
27369
27370
27371
27372
27373
27374
27375 . ////////////////////////////////////////////////////////////////////////////
27376 . ////////////////////////////////////////////////////////////////////////////
27377
27378 .chapter "The plaintext authenticator" "CHAPplaintext"
27379 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
27380 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
27381 The &(plaintext)& authenticator can be configured to support the PLAIN and
27382 LOGIN authentication mechanisms, both of which transfer authentication data as
27383 plain (unencrypted) text (though base64 encoded). The use of plain text is a
27384 security risk; you are strongly advised to insist on the use of SMTP encryption
27385 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
27386 use unencrypted plain text, you should not use the same passwords for SMTP
27387 connections as you do for login accounts.
27388
27389 .section "Avoiding cleartext use" "SECTplain_TLS"
27390 The following generic option settings will disable &(plaintext)& authenticators when
27391 TLS is not being used:
27392 .code
27393   server_advertise_condition = ${if def:tls_in_cipher }
27394   client_condition =           ${if def:tls_out_cipher}
27395 .endd
27396
27397 &*Note*&: a plaintext SMTP AUTH done inside TLS is not vulnerable to casual snooping,
27398 but is still vulnerable to a Man In The Middle attack unless certificates
27399 (including their names) have been properly verified.
27400
27401 .section "Plaintext server options" "SECID171"
27402 .cindex "options" "&(plaintext)& authenticator (server)"
27403 When configured as a server, &(plaintext)& uses the following options:
27404
27405 .option server_condition authenticators string&!! unset
27406 This is actually a global authentication option, but it must be set in order to
27407 configure the &(plaintext)& driver as a server. Its use is described below.
27408
27409 .option server_prompts plaintext "string list&!!" unset
27410 The contents of this option, after expansion, must be a colon-separated list of
27411 prompt strings. If expansion fails, a temporary authentication rejection is
27412 given.
27413
27414 .section "Using plaintext in a server" "SECTplainserver"
27415 .cindex "AUTH" "in &(plaintext)& authenticator"
27416 .cindex "binary zero" "in &(plaintext)& authenticator"
27417 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27418         "in &(plaintext)& authenticator"
27419 .vindex "&$auth1$&, &$auth2$&, etc"
27420 .cindex "base64 encoding" "in &(plaintext)& authenticator"
27421
27422 When running as a server, &(plaintext)& performs the authentication test by
27423 expanding a string. The data sent by the client with the AUTH command, or in
27424 response to subsequent prompts, is base64 encoded, and so may contain any byte
27425 values when decoded. If any data is supplied with the command, it is treated as
27426 a list of strings, separated by NULs (binary zeros), the first three of which
27427 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
27428 (neither LOGIN nor PLAIN uses more than three strings).
27429
27430 For compatibility with previous releases of Exim, the values are also placed in
27431 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
27432 variables for this purpose is now deprecated, as it can lead to confusion in
27433 string expansions that also use them for other things.
27434
27435 If there are more strings in &%server_prompts%& than the number of strings
27436 supplied with the AUTH command, the remaining prompts are used to obtain more
27437 data. Each response from the client may be a list of NUL-separated strings.
27438
27439 .vindex "&$authenticated_id$&"
27440 Once a sufficient number of data strings have been received,
27441 &%server_condition%& is expanded. If the expansion is forced to fail,
27442 authentication fails. Any other expansion failure causes a temporary error code
27443 to be returned. If the result of a successful expansion is an empty string,
27444 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27445 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27446 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27447 For any other result, a temporary error code is returned, with the expanded
27448 string as the error text.
27449
27450 &*Warning*&: If you use a lookup in the expansion to find the user's
27451 password, be sure to make the authentication fail if the user is unknown.
27452 There are good and bad examples at the end of the next section.
27453
27454
27455
27456 .section "The PLAIN authentication mechanism" "SECID172"
27457 .cindex "PLAIN authentication mechanism"
27458 .cindex authentication PLAIN
27459 .cindex "binary zero" "in &(plaintext)& authenticator"
27460 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
27461 sent as one item of data (that is, one combined string containing two NUL
27462 separators). The data is sent either as part of the AUTH command, or
27463 subsequently in response to an empty prompt from the server.
27464
27465 The second and third strings are a user name and a corresponding password.
27466 Using a single fixed user name and password as an example, this could be
27467 configured as follows:
27468 .code
27469 fixed_plain:
27470   driver = plaintext
27471   public_name = PLAIN
27472   server_prompts = :
27473   server_condition = \
27474     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
27475   server_set_id = $auth2
27476 .endd
27477 Note that the default result strings from &%if%& (&"true"& or an empty string)
27478 are exactly what we want here, so they need not be specified. Obviously, if the
27479 password contains expansion-significant characters such as dollar, backslash,
27480 or closing brace, they have to be escaped.
27481
27482 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
27483 the end of a string list are ignored). If all the data comes as part of the
27484 AUTH command, as is commonly the case, the prompt is not used. This
27485 authenticator is advertised in the response to EHLO as
27486 .code
27487 250-AUTH PLAIN
27488 .endd
27489 and a client host can authenticate itself by sending the command
27490 .code
27491 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
27492 .endd
27493 As this contains three strings (more than the number of prompts), no further
27494 data is required from the client. Alternatively, the client may just send
27495 .code
27496 AUTH PLAIN
27497 .endd
27498 to initiate authentication, in which case the server replies with an empty
27499 prompt. The client must respond with the combined data string.
27500
27501 The data string is base64 encoded, as required by the RFC. This example,
27502 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
27503 represents a zero byte. This is split up into three strings, the first of which
27504 is empty. The &%server_condition%& option in the authenticator checks that the
27505 second two are &`username`& and &`mysecret`& respectively.
27506
27507 Having just one fixed user name and password, as in this example, is not very
27508 realistic, though for a small organization with only a handful of
27509 authenticating clients it could make sense.
27510
27511 A more sophisticated instance of this authenticator could use the user name in
27512 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
27513 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
27514 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
27515 This is an incorrect example:
27516 .code
27517 server_condition = \
27518   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
27519 .endd
27520 The expansion uses the user name (&$auth2$&) as the key to look up a password,
27521 which it then compares to the supplied password (&$auth3$&). Why is this example
27522 incorrect? It works fine for existing users, but consider what happens if a
27523 non-existent user name is given. The lookup fails, but as no success/failure
27524 strings are given for the lookup, it yields an empty string. Thus, to defeat
27525 the authentication, all a client has to do is to supply a non-existent user
27526 name and an empty password. The correct way of writing this test is:
27527 .code
27528 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
27529   {${if eq{$value}{$auth3}}} {false}}
27530 .endd
27531 In this case, if the lookup succeeds, the result is checked; if the lookup
27532 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
27533 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
27534 always fails if its second argument is empty. However, the second way of
27535 writing the test makes the logic clearer.
27536
27537
27538 .section "The LOGIN authentication mechanism" "SECID173"
27539 .cindex "LOGIN authentication mechanism"
27540 .cindex authentication LOGIN
27541 The LOGIN authentication mechanism is not documented in any RFC, but is in use
27542 in a number of programs. No data is sent with the AUTH command. Instead, a
27543 user name and password are supplied separately, in response to prompts. The
27544 plaintext authenticator can be configured to support this as in this example:
27545 .code
27546 fixed_login:
27547   driver = plaintext
27548   public_name = LOGIN
27549   server_prompts = User Name : Password
27550   server_condition = \
27551     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
27552   server_set_id = $auth1
27553 .endd
27554 Because of the way plaintext operates, this authenticator accepts data supplied
27555 with the AUTH command (in contravention of the specification of LOGIN), but
27556 if the client does not supply it (as is the case for LOGIN clients), the prompt
27557 strings are used to obtain two data items.
27558
27559 Some clients are very particular about the precise text of the prompts. For
27560 example, Outlook Express is reported to recognize only &"Username:"& and
27561 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
27562 strings. It uses the &%ldapauth%& expansion condition to check the user
27563 name and password by binding to an LDAP server:
27564 .code
27565 login:
27566   driver = plaintext
27567   public_name = LOGIN
27568   server_prompts = Username:: : Password::
27569   server_condition = ${if and{{ \
27570     !eq{}{$auth1} }{ \
27571     ldapauth{\
27572       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
27573       pass=${quote:$auth2} \
27574       ldap://ldap.example.org/} }} }
27575   server_set_id = uid=$auth1,ou=people,o=example.org
27576 .endd
27577 We have to check that the username is not empty before using it, because LDAP
27578 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
27579 operator to correctly quote the DN for authentication. However, the basic
27580 &%quote%& operator, rather than any of the LDAP quoting operators, is the
27581 correct one to use for the password, because quoting is needed only to make
27582 the password conform to the Exim syntax. At the LDAP level, the password is an
27583 uninterpreted string.
27584
27585
27586 .section "Support for different kinds of authentication" "SECID174"
27587 A number of string expansion features are provided for the purpose of
27588 interfacing to different ways of user authentication. These include checking
27589 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
27590 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
27591 &<<SECTexpcond>>&.
27592
27593
27594
27595
27596 .section "Using plaintext in a client" "SECID175"
27597 .cindex "options" "&(plaintext)& authenticator (client)"
27598 The &(plaintext)& authenticator has two client options:
27599
27600 .option client_ignore_invalid_base64 plaintext boolean false
27601 If the client receives a server prompt that is not a valid base64 string,
27602 authentication is abandoned by default. However, if this option is set true,
27603 the error in the challenge is ignored and the client sends the response as
27604 usual.
27605
27606 .option client_send plaintext string&!! unset
27607 The string is a colon-separated list of authentication data strings. Each
27608 string is independently expanded before being sent to the server. The first
27609 string is sent with the AUTH command; any more strings are sent in response
27610 to prompts from the server. Before each string is expanded, the value of the
27611 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
27612 with &$auth1$& for the first prompt. Up to three prompts are stored in this
27613 way. Thus, the prompt that is received in response to sending the first string
27614 (with the AUTH command) can be used in the expansion of the second string, and
27615 so on. If an invalid base64 string is received when
27616 &%client_ignore_invalid_base64%& is set, an empty string is put in the
27617 &$auth$&<&'n'&> variable.
27618
27619 &*Note*&: You cannot use expansion to create multiple strings, because
27620 splitting takes priority and happens first.
27621
27622 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
27623 the data, further processing is applied to each string before it is sent. If
27624 there are any single circumflex characters in the string, they are converted to
27625 NULs. Should an actual circumflex be required as data, it must be doubled in
27626 the string.
27627
27628 This is an example of a client configuration that implements the PLAIN
27629 authentication mechanism with a fixed user name and password:
27630 .code
27631 fixed_plain:
27632   driver = plaintext
27633   public_name = PLAIN
27634   client_send = ^username^mysecret
27635 .endd
27636 The lack of colons means that the entire text is sent with the AUTH
27637 command, with the circumflex characters converted to NULs. A similar example
27638 that uses the LOGIN mechanism is:
27639 .code
27640 fixed_login:
27641   driver = plaintext
27642   public_name = LOGIN
27643   client_send = : username : mysecret
27644 .endd
27645 The initial colon means that the first string is empty, so no data is sent with
27646 the AUTH command itself. The remaining strings are sent in response to
27647 prompts.
27648 .ecindex IIDplaiauth1
27649 .ecindex IIDplaiauth2
27650
27651
27652
27653
27654 . ////////////////////////////////////////////////////////////////////////////
27655 . ////////////////////////////////////////////////////////////////////////////
27656
27657 .chapter "The cram_md5 authenticator" "CHID9"
27658 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
27659 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
27660 .cindex "CRAM-MD5 authentication mechanism"
27661 .cindex authentication CRAM-MD5
27662 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
27663 sends a challenge string to the client, and the response consists of a user
27664 name and the CRAM-MD5 digest of the challenge string combined with a secret
27665 string (password) which is known to both server and client. Thus, the secret
27666 is not sent over the network as plain text, which makes this authenticator more
27667 secure than &(plaintext)&. However, the downside is that the secret has to be
27668 available in plain text at either end.
27669
27670
27671 .section "Using cram_md5 as a server" "SECID176"
27672 .cindex "options" "&(cram_md5)& authenticator (server)"
27673 This authenticator has one server option, which must be set to configure the
27674 authenticator as a server:
27675
27676 .option server_secret cram_md5 string&!! unset
27677 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
27678 When the server receives the client's response, the user name is placed in
27679 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
27680 obtain the password for that user. The server then computes the CRAM-MD5 digest
27681 that the client should have sent, and checks that it received the correct
27682 string. If the expansion of &%server_secret%& is forced to fail, authentication
27683 fails. If the expansion fails for some other reason, a temporary error code is
27684 returned to the client.
27685
27686 For compatibility with previous releases of Exim, the user name is also placed
27687 in &$1$&. However, the use of this variables for this purpose is now
27688 deprecated, as it can lead to confusion in string expansions that also use
27689 numeric variables for other things.
27690
27691 For example, the following authenticator checks that the user name given by the
27692 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
27693 user name, authentication fails.
27694 .code
27695 fixed_cram:
27696   driver = cram_md5
27697   public_name = CRAM-MD5
27698   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
27699   server_set_id = $auth1
27700 .endd
27701 .vindex "&$authenticated_id$&"
27702 If authentication succeeds, the setting of &%server_set_id%& preserves the user
27703 name in &$authenticated_id$&. A more typical configuration might look up the
27704 secret string in a file, using the user name as the key. For example:
27705 .code
27706 lookup_cram:
27707   driver = cram_md5
27708   public_name = CRAM-MD5
27709   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
27710                   {$value}fail}
27711   server_set_id = $auth1
27712 .endd
27713 Note that this expansion explicitly forces failure if the lookup fails
27714 because &$auth1$& contains an unknown user name.
27715
27716 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
27717 using the relevant libraries, you need to know the realm to specify in the
27718 lookup and then ask for the &"userPassword"& attribute for that user in that
27719 realm, with:
27720 .code
27721 cyrusless_crammd5:
27722   driver = cram_md5
27723   public_name = CRAM-MD5
27724   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
27725                   dbmjz{/etc/sasldb2}{$value}fail}
27726   server_set_id = $auth1
27727 .endd
27728
27729 .section "Using cram_md5 as a client" "SECID177"
27730 .cindex "options" "&(cram_md5)& authenticator (client)"
27731 When used as a client, the &(cram_md5)& authenticator has two options:
27732
27733
27734
27735 .option client_name cram_md5 string&!! "the primary host name"
27736 This string is expanded, and the result used as the user name data when
27737 computing the response to the server's challenge.
27738
27739
27740 .option client_secret cram_md5 string&!! unset
27741 This option must be set for the authenticator to work as a client. Its value is
27742 expanded and the result used as the secret string when computing the response.
27743
27744
27745 .vindex "&$host$&"
27746 .vindex "&$host_address$&"
27747 Different user names and secrets can be used for different servers by referring
27748 to &$host$& or &$host_address$& in the options. Forced failure of either
27749 expansion string is treated as an indication that this authenticator is not
27750 prepared to handle this case. Exim moves on to the next configured client
27751 authenticator. Any other expansion failure causes Exim to give up trying to
27752 send the message to the current server.
27753
27754 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27755 strings, is:
27756 .code
27757 fixed_cram:
27758   driver = cram_md5
27759   public_name = CRAM-MD5
27760   client_name = ph10
27761   client_secret = secret
27762 .endd
27763 .ecindex IIDcramauth1
27764 .ecindex IIDcramauth2
27765
27766
27767
27768 . ////////////////////////////////////////////////////////////////////////////
27769 . ////////////////////////////////////////////////////////////////////////////
27770
27771 .chapter "The cyrus_sasl authenticator" "CHID10"
27772 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27773 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27774 .cindex "Cyrus" "SASL library"
27775 .cindex "Kerberos"
27776 The code for this authenticator was provided by Matthew Byng-Maddick while
27777 at A L Digital Ltd.
27778
27779 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27780 library implementation of the RFC 2222 (&"Simple Authentication and Security
27781 Layer"&). This library supports a number of authentication mechanisms,
27782 including PLAIN and LOGIN, but also several others that Exim does not support
27783 directly. In particular, there is support for Kerberos authentication.
27784
27785 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27786 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27787 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27788 name of the driver to determine which mechanism to support.
27789
27790 Where access to some kind of secret file is required, for example, in GSSAPI
27791 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27792 user, and that the Cyrus SASL library has no way of escalating privileges
27793 by default. You may also find you need to set environment variables,
27794 depending on the driver you are using.
27795
27796 The application name provided by Exim is &"exim"&, so various SASL options may
27797 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27798 Kerberos, note that because of limitations in the GSSAPI interface,
27799 changing the server keytab might need to be communicated down to the Kerberos
27800 layer independently. The mechanism for doing so is dependent upon the Kerberos
27801 implementation.
27802
27803 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27804 may be set to point to an alternative keytab file. Exim will pass this
27805 variable through from its own inherited environment when started as root or the
27806 Exim user. The keytab file needs to be readable by the Exim user.
27807 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27808 environment variable.  In practice, for those releases, the Cyrus authenticator
27809 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27810 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27811
27812
27813 .section "Using cyrus_sasl as a server" "SECID178"
27814 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27815 (on a successful authentication) into &$auth1$&. For compatibility with
27816 previous releases of Exim, the username is also placed in &$1$&. However, the
27817 use of this variable for this purpose is now deprecated, as it can lead to
27818 confusion in string expansions that also use numeric variables for other
27819 things.
27820
27821
27822 .option server_hostname cyrus_sasl string&!! "see below"
27823 This option selects the hostname that is used when communicating with the
27824 library. The default value is &`$primary_hostname`&. It is up to the underlying
27825 SASL plug-in what it does with this data.
27826
27827
27828 .option server_mech cyrus_sasl string "see below"
27829 This option selects the authentication mechanism this driver should use. The
27830 default is the value of the generic &%public_name%& option. This option allows
27831 you to use a different underlying mechanism from the advertised name. For
27832 example:
27833 .code
27834 sasl:
27835   driver = cyrus_sasl
27836   public_name = X-ANYTHING
27837   server_mech = CRAM-MD5
27838   server_set_id = $auth1
27839 .endd
27840
27841 .option server_realm cyrus_sasl string&!! unset
27842 This specifies the SASL realm that the server claims to be in.
27843
27844
27845 .option server_service cyrus_sasl string &`smtp`&
27846 This is the SASL service that the server claims to implement.
27847
27848
27849 For straightforward cases, you do not need to set any of the authenticator's
27850 private options. All you need to do is to specify an appropriate mechanism as
27851 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27852 PLAIN, you could have two authenticators as follows:
27853 .code
27854 sasl_cram_md5:
27855   driver = cyrus_sasl
27856   public_name = CRAM-MD5
27857   server_set_id = $auth1
27858
27859 sasl_plain:
27860   driver = cyrus_sasl
27861   public_name = PLAIN
27862   server_set_id = $auth2
27863 .endd
27864 Cyrus SASL does implement the LOGIN authentication method, even though it is
27865 not a standard method. It is disabled by default in the source distribution,
27866 but it is present in many binary distributions.
27867 .ecindex IIDcyrauth1
27868 .ecindex IIDcyrauth2
27869
27870
27871
27872
27873 . ////////////////////////////////////////////////////////////////////////////
27874 . ////////////////////////////////////////////////////////////////////////////
27875 .chapter "The dovecot authenticator" "CHAPdovecot"
27876 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27877 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27878 This authenticator is an interface to the authentication facility of the
27879 Dovecot 2 POP/IMAP server, which can support a number of authentication methods.
27880 Note that Dovecot must be configured to use auth-client not auth-userdb.
27881 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27882 to use the same mechanisms for SMTP authentication. This is a server
27883 authenticator only. There is only one option:
27884
27885 .option server_socket dovecot string unset
27886
27887 This option must specify the UNIX socket that is the interface to Dovecot
27888 authentication. The &%public_name%& option must specify an authentication
27889 mechanism that Dovecot is configured to support. You can have several
27890 authenticators for different mechanisms. For example:
27891 .code
27892 dovecot_plain:
27893   driver = dovecot
27894   public_name = PLAIN
27895   server_socket = /var/run/dovecot/auth-client
27896   server_set_id = $auth1
27897
27898 dovecot_ntlm:
27899   driver = dovecot
27900   public_name = NTLM
27901   server_socket = /var/run/dovecot/auth-client
27902   server_set_id = $auth1
27903 .endd
27904 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27905 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27906 option is passed in the Dovecot authentication command. If, for a TLS
27907 connection, a client certificate has been verified, the &"valid-client-cert"&
27908 option is passed. When authentication succeeds, the identity of the user
27909 who authenticated is placed in &$auth1$&.
27910
27911 The Dovecot configuration to match the above wil look
27912 something like:
27913 .code
27914 conf.d/10-master.conf :-
27915
27916 service auth {
27917 ...
27918 #SASL
27919   unix_listener auth-client {
27920     mode = 0660
27921     user = mail
27922   }
27923 ...
27924 }
27925
27926 conf.d/10-auth.conf :-
27927
27928 auth_mechanisms = plain login ntlm
27929 .endd
27930
27931 .ecindex IIDdcotauth1
27932 .ecindex IIDdcotauth2
27933
27934
27935 . ////////////////////////////////////////////////////////////////////////////
27936 . ////////////////////////////////////////////////////////////////////////////
27937 .chapter "The gsasl authenticator" "CHAPgsasl"
27938 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27939 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27940 .cindex "authentication" "GNU SASL"
27941 .cindex "authentication" "SASL"
27942 .cindex "authentication" "EXTERNAL"
27943 .cindex "authentication" "ANONYMOUS"
27944 .cindex "authentication" "PLAIN"
27945 .cindex "authentication" "LOGIN"
27946 .cindex "authentication" "DIGEST-MD5"
27947 .cindex "authentication" "CRAM-MD5"
27948 .cindex "authentication" "SCRAM family"
27949 The &(gsasl)& authenticator provides integration for the GNU SASL
27950 library and the mechanisms it provides.  This is new as of the 4.80 release
27951 and there are a few areas where the library does not let Exim smoothly
27952 scale to handle future authentication mechanisms, so no guarantee can be
27953 made that any particular new authentication mechanism will be supported
27954 without code changes in Exim.
27955
27956 The library is expected to add support in an upcoming
27957 realease for the SCRAM-SHA-256 method.
27958 The macro _HAVE_AUTH_GSASL_SCRAM_SHA_256 will be defined
27959 when this happens.
27960
27961
27962 .option client_authz gsasl string&!! unset
27963 This option can be used to supply an &'authorization id'&
27964 which is different to the &'authentication_id'& provided
27965 by &%client_username%& option.
27966 If unset or (after expansion) empty it is not used,
27967 which is the common case.
27968
27969 .option client_channelbinding gsasl boolean false
27970 See &%server_channelbinding%& below.
27971
27972 .option client_password gsasl string&!! unset
27973 This option is exapanded before use, and should result in
27974 the password to be used, in clear.
27975
27976 .option client_username gsasl string&!! unset
27977 This option is exapanded before use, and should result in
27978 the account name to be used.
27979
27980 .option client_spassword gsasl string&!! unset
27981 If a SCRAM mechanism is being used and this option is set
27982 it is used in preference to &%client_password%&.
27983 The value after expansion should be
27984 a 40 (for SHA-1) or 64 (for SHA-256) character string
27985 with the PBKDF2-prepared password, hex-encoded.
27986 Note that this value will depend on the salt and iteration-count
27987 supplied by the server.
27988
27989
27990
27991 .option server_channelbinding gsasl boolean false
27992 Do not set this true and rely on the properties
27993 without consulting a cryptographic engineer.
27994
27995 Some authentication mechanisms are able to use external context at both ends
27996 of the session to bind the authentication to that context, and fail the
27997 authentication process if that context differs.  Specifically, some TLS
27998 ciphersuites can provide identifying information about the cryptographic
27999 context.
28000
28001 This should have meant that certificate identity and verification becomes a
28002 non-issue, as a man-in-the-middle attack will cause the correct client and
28003 server to see different identifiers and authentication will fail.
28004
28005 This is
28006 only usable by mechanisms which support "channel binding"; at time of
28007 writing, that's the SCRAM family.
28008 When using this feature the "-PLUS" variants of the method names need to be used.
28009
28010 This defaults off to ensure smooth upgrade across Exim releases, in case
28011 this option causes some clients to start failing.  Some future release
28012 of Exim might have switched the default to be true.
28013
28014 However, Channel Binding in TLS has proven to be vulnerable in current versions.
28015 Do not plan to rely upon this feature for security, ever, without consulting
28016 with a subject matter expert (a cryptographic engineer).
28017
28018
28019 .option server_hostname gsasl string&!! "see below"
28020 This option selects the hostname that is used when communicating with the
28021 library. The default value is &`$primary_hostname`&.
28022 Some mechanisms will use this data.
28023
28024
28025 .option server_mech gsasl string "see below"
28026 This option selects the authentication mechanism this driver should use. The
28027 default is the value of the generic &%public_name%& option. This option allows
28028 you to use a different underlying mechanism from the advertised name. For
28029 example:
28030 .code
28031 sasl:
28032   driver = gsasl
28033   public_name = X-ANYTHING
28034   server_mech = CRAM-MD5
28035   server_set_id = $auth1
28036 .endd
28037
28038
28039 .option server_password gsasl string&!! unset
28040 Various mechanisms need access to the cleartext password on the server, so
28041 that proof-of-possession can be demonstrated on the wire, without sending
28042 the password itself.
28043
28044 The data available for lookup varies per mechanism.
28045 In all cases, &$auth1$& is set to the &'authentication id'&.
28046 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
28047 if available, else the empty string.
28048 The &$auth3$& variable will always be the &'realm'& if available,
28049 else the empty string.
28050
28051 A forced failure will cause authentication to defer.
28052
28053 If using this option, it may make sense to set the &%server_condition%&
28054 option to be simply "true".
28055
28056
28057 .option server_realm gsasl string&!! unset
28058 This specifies the SASL realm that the server claims to be in.
28059 Some mechanisms will use this data.
28060
28061
28062 .option server_scram_iter gsasl string&!! 4096
28063 This option provides data for the SCRAM family of mechanisms.
28064 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28065 when this option is expanded.
28066
28067 The result of expansion should be a decimal number,
28068 and represents both a lower-bound on the security, and
28069 a compute cost factor imposed on the client
28070 (if it does not cache results, or the server changes
28071 either the iteration count or the salt).
28072 A minimum value of 4096 is required by the standards
28073 for all current SCRAM mechanism variants.
28074
28075 .option server_scram_salt gsasl string&!! unset
28076 This option provides data for the SCRAM family of mechanisms.
28077 The &$auth1$&, &$auth2$& and &$auth3$& variables are available
28078 when this option is expanded.
28079 The value should be a base64-encoded string,
28080 of random data typically 4-to-16 bytes long.
28081 If unset or empty after expansion the library will provides a value for the
28082 protocol conversation.
28083
28084
28085 .option server_key gsasl string&!! unset
28086 .option server_skey gsasl string&!! unset
28087 These options can be used for the SCRAM family of mechanisms
28088 to provide stored information related to a password,
28089 the storage of which is preferable to plaintext.
28090
28091 &%server_key%& is the value defined in the SCRAM standards as ServerKey;
28092 &%server_skey%& is StoredKey.
28093
28094 They are only available for version 1.9.0 (or later) of the gsasl library.
28095 When this is so, the macros
28096 _OPT_AUTHENTICATOR_GSASL_SERVER_KEY
28097 and _HAVE_AUTH_GSASL_SCRAM_S_KEY
28098 will be defined.
28099
28100 The &$authN$& variables are available when these options are expanded.
28101
28102 If set, the results of expansion should for each
28103 should be a 28 (for SHA-1) or 44 (for SHA-256) character string
28104 of base64-coded data, and will be used in preference to the
28105 &%server_password%& option.
28106 If unset or not of the right length, &%server_password%& will be used.
28107
28108 The libgsasl library release includes a utility &'gsasl'& which can be used
28109 to generate these values.
28110
28111
28112 .option server_service gsasl string &`smtp`&
28113 This is the SASL service that the server claims to implement.
28114 Some mechanisms will use this data.
28115
28116
28117 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
28118 .vindex "&$auth1$&, &$auth2$&, etc"
28119 These may be set when evaluating specific options, as detailed above.
28120 They will also be set when evaluating &%server_condition%&.
28121
28122 Unless otherwise stated below, the &(gsasl)& integration will use the following
28123 meanings for these variables:
28124
28125 .ilist
28126 .vindex "&$auth1$&"
28127 &$auth1$&: the &'authentication id'&
28128 .next
28129 .vindex "&$auth2$&"
28130 &$auth2$&: the &'authorization id'&
28131 .next
28132 .vindex "&$auth3$&"
28133 &$auth3$&: the &'realm'&
28134 .endlist
28135
28136 On a per-mechanism basis:
28137
28138 .ilist
28139 .cindex "authentication" "EXTERNAL"
28140 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
28141 the &%server_condition%& option must be present.
28142 .next
28143 .cindex "authentication" "ANONYMOUS"
28144 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
28145 the &%server_condition%& option must be present.
28146 .next
28147 .cindex "authentication" "GSSAPI"
28148 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
28149 &$auth2$& will be set to the &'authorization id'&,
28150 the &%server_condition%& option must be present.
28151 .endlist
28152
28153 An &'anonymous token'& is something passed along as an unauthenticated
28154 identifier; this is analogous to FTP anonymous authentication passing an
28155 email address, or software-identifier@, as the "password".
28156
28157
28158 An example showing the password having the realm specified in the callback
28159 and demonstrating a Cyrus SASL to GSASL migration approach is:
28160 .code
28161 gsasl_cyrusless_crammd5:
28162   driver = gsasl
28163   public_name = CRAM-MD5
28164   server_realm = imap.example.org
28165   server_password = ${lookup{$auth1:$auth3:userPassword}\
28166                     dbmjz{/etc/sasldb2}{$value}fail}
28167   server_set_id = ${quote:$auth1}
28168   server_condition = yes
28169 .endd
28170
28171
28172 . ////////////////////////////////////////////////////////////////////////////
28173 . ////////////////////////////////////////////////////////////////////////////
28174
28175 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
28176 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
28177 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
28178 .cindex "authentication" "GSSAPI"
28179 .cindex "authentication" "Kerberos"
28180 The &(heimdal_gssapi)& authenticator provides server integration for the
28181 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
28182 reliably.
28183
28184 .option server_hostname heimdal_gssapi string&!! "see below"
28185 This option selects the hostname that is used, with &%server_service%&,
28186 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
28187 identifier.  The default value is &`$primary_hostname`&.
28188
28189 .option server_keytab heimdal_gssapi string&!! unset
28190 If set, then Heimdal will not use the system default keytab (typically
28191 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
28192 The value should be a pathname, with no &"file:"& prefix.
28193
28194 .option server_service heimdal_gssapi string&!! "smtp"
28195 This option specifies the service identifier used, in conjunction with
28196 &%server_hostname%&, for building the identifier for finding credentials
28197 from the keytab.
28198
28199
28200 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
28201 Beware that these variables will typically include a realm, thus will appear
28202 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
28203 not verified, so a malicious client can set it to anything.
28204
28205 The &$auth1$& field should be safely trustable as a value from the Key
28206 Distribution Center.  Note that these are not quite email addresses.
28207 Each identifier is for a role, and so the left-hand-side may include a
28208 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
28209
28210 .vindex "&$auth1$&, &$auth2$&, etc"
28211 .ilist
28212 .vindex "&$auth1$&"
28213 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
28214 .next
28215 .vindex "&$auth2$&"
28216 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
28217 authentication.  If that was empty, this will also be set to the
28218 GSS Display Name.
28219 .endlist
28220
28221
28222 . ////////////////////////////////////////////////////////////////////////////
28223 . ////////////////////////////////////////////////////////////////////////////
28224
28225 .chapter "The spa authenticator" "CHAPspa"
28226 .scindex IIDspaauth1 "&(spa)& authenticator"
28227 .scindex IIDspaauth2 "authenticators" "&(spa)&"
28228 .cindex "authentication" "Microsoft Secure Password"
28229 .cindex "authentication" "NTLM"
28230 .cindex "Microsoft Secure Password Authentication"
28231 .cindex "NTLM authentication"
28232 The &(spa)& authenticator provides client support for Microsoft's &'Secure
28233 Password Authentication'& mechanism,
28234 which is also sometimes known as NTLM (NT LanMan). The code for client side of
28235 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
28236 taken from the Samba project (&url(https://www.samba.org/)). The code for the
28237 server side was subsequently contributed by Tom Kistner. The mechanism works as
28238 follows:
28239
28240 .ilist
28241 After the AUTH command has been accepted, the client sends an SPA
28242 authentication request based on the user name and optional domain.
28243 .next
28244 The server sends back a challenge.
28245 .next
28246 The client builds a challenge response which makes use of the user's password
28247 and sends it to the server, which then accepts or rejects it.
28248 .endlist
28249
28250 Encryption is used to protect the password in transit.
28251
28252
28253
28254 .section "Using spa as a server" "SECID179"
28255 .cindex "options" "&(spa)& authenticator (server)"
28256 The &(spa)& authenticator has just one server option:
28257
28258 .option server_password spa string&!! unset
28259 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
28260 This option is expanded, and the result must be the cleartext password for the
28261 authenticating user, whose name is at this point in &$auth1$&. For
28262 compatibility with previous releases of Exim, the user name is also placed in
28263 &$1$&. However, the use of this variable for this purpose is now deprecated, as
28264 it can lead to confusion in string expansions that also use numeric variables
28265 for other things. For example:
28266 .code
28267 spa:
28268   driver = spa
28269   public_name = NTLM
28270   server_password = \
28271     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
28272 .endd
28273 If the expansion is forced to fail, authentication fails. Any other expansion
28274 failure causes a temporary error code to be returned.
28275
28276
28277
28278
28279
28280 .section "Using spa as a client" "SECID180"
28281 .cindex "options" "&(spa)& authenticator (client)"
28282 The &(spa)& authenticator has the following client options:
28283
28284
28285
28286 .option client_domain spa string&!! unset
28287 This option specifies an optional domain for the authentication.
28288
28289
28290 .option client_password spa string&!! unset
28291 This option specifies the user's password, and must be set.
28292
28293
28294 .option client_username spa string&!! unset
28295 This option specifies the user name, and must be set. Here is an example of a
28296 configuration of this authenticator for use with the mail servers at
28297 &'msn.com'&:
28298 .code
28299 msn:
28300   driver = spa
28301   public_name = MSN
28302   client_username = msn/msn_username
28303   client_password = msn_plaintext_password
28304   client_domain = DOMAIN_OR_UNSET
28305 .endd
28306 .ecindex IIDspaauth1
28307 .ecindex IIDspaauth2
28308
28309
28310
28311
28312
28313 . ////////////////////////////////////////////////////////////////////////////
28314 . ////////////////////////////////////////////////////////////////////////////
28315
28316 .chapter "The external authenticator" "CHAPexternauth"
28317 .scindex IIDexternauth1 "&(external)& authenticator"
28318 .scindex IIDexternauth2 "authenticators" "&(external)&"
28319 .cindex "authentication" "Client Certificate"
28320 .cindex "authentication" "X509"
28321 .cindex "Certificate-based authentication"
28322 The &(external)& authenticator provides support for
28323 authentication based on non-SMTP information.
28324 The specification is in RFC 4422 Appendix A
28325 (&url(https://tools.ietf.org/html/rfc4422)).
28326 It is only a transport and negotiation mechanism;
28327 the process of authentication is entirely controlled
28328 by the server configuration.
28329
28330 The client presents an identity in-clear.
28331 It is probably wise for a server to only advertise,
28332 and for clients to only attempt,
28333 this authentication method on a secure (eg. under TLS) connection.
28334
28335 One possible use, compatible with the
28336 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
28337 is for using X509 client certificates.
28338
28339 It thus overlaps in function with the TLS authenticator
28340 (see &<<CHAPtlsauth>>&)
28341 but is a full SMTP SASL authenticator
28342 rather than being implicit for TLS-connection carried
28343 client certificates only.
28344
28345 The examples and discussion in this chapter assume that
28346 client-certificate authentication is being done.
28347
28348 The client must present a certificate,
28349 for which it must have been requested via the
28350 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28351 (see &<<CHAPTLS>>&).
28352 For authentication to be effective the certificate should be
28353 verifiable against a trust-anchor certificate known to the server.
28354
28355 .section "External options" "SECTexternsoptions"
28356 .cindex "options" "&(external)& authenticator (server)"
28357 The &(external)& authenticator has two server options:
28358
28359 .option server_param2 external string&!! unset
28360 .option server_param3 external string&!! unset
28361 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
28362 These options are expanded before the &%server_condition%& option
28363 and the result are placed in &$auth2$& and &$auth3$& resectively.
28364 If the expansion is forced to fail, authentication fails. Any other expansion
28365 failure causes a temporary error code to be returned.
28366
28367 They can be used to clarify the coding of a complex &%server_condition%&.
28368
28369 .section "Using external in a server" "SECTexternserver"
28370 .cindex "AUTH" "in &(external)& authenticator"
28371 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
28372         "in &(external)& authenticator"
28373 .vindex "&$auth1$&, &$auth2$&, etc"
28374 .cindex "base64 encoding" "in &(external)& authenticator"
28375
28376 When running as a server, &(external)& performs the authentication test by
28377 expanding a string. The data sent by the client with the AUTH command, or in
28378 response to subsequent prompts, is base64 encoded, and so may contain any byte
28379 values when decoded. The decoded value is treated as
28380 an identity for authentication and
28381 placed in the expansion variable &$auth1$&.
28382
28383 For compatibility with previous releases of Exim, the value is also placed in
28384 the expansion variable &$1$&. However, the use of this
28385 variable for this purpose is now deprecated, as it can lead to confusion in
28386 string expansions that also use them for other things.
28387
28388 .vindex "&$authenticated_id$&"
28389 Once an identity has been received,
28390 &%server_condition%& is expanded. If the expansion is forced to fail,
28391 authentication fails. Any other expansion failure causes a temporary error code
28392 to be returned. If the result of a successful expansion is an empty string,
28393 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
28394 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
28395 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
28396 For any other result, a temporary error code is returned, with the expanded
28397 string as the error text.
28398
28399 Example:
28400 .code
28401 ext_ccert_san_mail:
28402   driver =            external
28403   public_name =       EXTERNAL
28404
28405   server_advertise_condition = $tls_in_certificate_verified
28406   server_param2 =     ${certextract {subj_altname,mail,>:} \
28407                                     {$tls_in_peercert}}
28408   server_condition =  ${if forany {$auth2} \
28409                             {eq {$item}{$auth1}}}
28410   server_set_id =     $auth1
28411 .endd
28412 This accepts a client certificate that is verifiable against any
28413 of your configured trust-anchors
28414 (which usually means the full set of public CAs)
28415 and which has a mail-SAN matching the claimed identity sent by the client.
28416
28417 &*Note*&: up to TLS1.2, the client cert is on the wire in-clear, including the SAN.
28418 The account name is therefore guessable by an opponent.
28419 TLS 1.3 protects both server and client certificates, and is not vulnerable
28420 in this way.
28421
28422
28423 .section "Using external in a client" "SECTexternclient"
28424 .cindex "options" "&(external)& authenticator (client)"
28425 The &(external)& authenticator has one client option:
28426
28427 .option client_send external string&!! unset
28428 This option is expanded and sent with the AUTH command as the
28429 identity being asserted.
28430
28431 Example:
28432 .code
28433 ext_ccert:
28434   driver =      external
28435   public_name = EXTERNAL
28436
28437   client_condition = ${if !eq{$tls_out_cipher}{}}
28438   client_send = myaccount@smarthost.example.net
28439 .endd
28440
28441
28442 .ecindex IIDexternauth1
28443 .ecindex IIDexternauth2
28444
28445
28446
28447
28448
28449 . ////////////////////////////////////////////////////////////////////////////
28450 . ////////////////////////////////////////////////////////////////////////////
28451
28452 .chapter "The tls authenticator" "CHAPtlsauth"
28453 .scindex IIDtlsauth1 "&(tls)& authenticator"
28454 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
28455 .cindex "authentication" "Client Certificate"
28456 .cindex "authentication" "X509"
28457 .cindex "Certificate-based authentication"
28458 The &(tls)& authenticator provides server support for
28459 authentication based on client certificates.
28460
28461 It is not an SMTP authentication mechanism and is not
28462 advertised by the server as part of the SMTP EHLO response.
28463 It is an Exim authenticator in the sense that it affects
28464 the protocol element of the log line, can be tested for
28465 by the &%authenticated%& ACL condition, and can set
28466 the &$authenticated_id$& variable.
28467
28468 The client must present a verifiable certificate,
28469 for which it must have been requested via the
28470 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
28471 (see &<<CHAPTLS>>&).
28472
28473 If an authenticator of this type is configured it is
28474 run before any SMTP-level communication is done,
28475 and can authenticate the connection.
28476 If it does, SMTP authentication is not offered.
28477
28478 A maximum of one authenticator of this type may be present.
28479
28480
28481 .cindex "options" "&(tls)& authenticator (server)"
28482 The &(tls)& authenticator has three server options:
28483
28484 .option server_param1 tls string&!! unset
28485 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
28486 This option is expanded after the TLS negotiation and
28487 the result is placed in &$auth1$&.
28488 If the expansion is forced to fail, authentication fails. Any other expansion
28489 failure causes a temporary error code to be returned.
28490
28491 .option server_param2 tls string&!! unset
28492 .option server_param3 tls string&!! unset
28493 As above, for &$auth2$& and &$auth3$&.
28494
28495 &%server_param1%& may also be spelled &%server_param%&.
28496
28497
28498 Example:
28499 .code
28500 tls:
28501   driver = tls
28502   server_param1 =     ${certextract {subj_altname,mail,>:} \
28503                                     {$tls_in_peercert}}
28504   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
28505                                  {forany {$auth1} \
28506                             {!= {0} \
28507                                 {${lookup ldap{ldap:///\
28508                          mailname=${quote_ldap_dn:${lc:$item}},\
28509                          ou=users,LDAP_DC?mailid} {$value}{0} \
28510                        }    }  } }}}
28511   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
28512 .endd
28513 This accepts a client certificate that is verifiable against any
28514 of your configured trust-anchors
28515 (which usually means the full set of public CAs)
28516 and which has a SAN with a good account name.
28517
28518 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
28519 The account name is therefore guessable by an opponent.
28520 TLS 1.3 protects both server and client certificates, and is not vulnerable
28521 in this way.
28522 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
28523
28524 . An alternative might use
28525 . .code
28526 .   server_param1 = ${sha256:$tls_in_peercert}
28527 . .endd
28528 . to require one of a set of specific certs that define a given account
28529 . (the verification is still required, but mostly irrelevant).
28530 . This would help for per-device use.
28531 .
28532 . However, for the future we really need support for checking a
28533 . user cert in LDAP - which probably wants a base-64 DER.
28534
28535 .ecindex IIDtlsauth1
28536 .ecindex IIDtlsauth2
28537
28538
28539 Note that because authentication is traditionally an SMTP operation,
28540 the &%authenticated%& ACL condition cannot be used in
28541 a connect- or helo-ACL.
28542
28543
28544
28545 . ////////////////////////////////////////////////////////////////////////////
28546 . ////////////////////////////////////////////////////////////////////////////
28547
28548 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
28549          "Encrypted SMTP connections"
28550 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
28551 .scindex IIDencsmtp2 "SMTP" "encryption"
28552 .cindex "TLS" "on SMTP connection"
28553 .cindex "OpenSSL"
28554 .cindex "GnuTLS"
28555 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
28556 Sockets Layer), is implemented by making use of the OpenSSL library or the
28557 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
28558 cryptographic code in the Exim distribution itself for implementing TLS. In
28559 order to use this feature you must install OpenSSL or GnuTLS, and then build a
28560 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
28561 You also need to understand the basic concepts of encryption at a managerial
28562 level, and in particular, the way that public keys, private keys, and
28563 certificates are used.
28564
28565 RFC 3207 defines how SMTP connections can make use of encryption. Once a
28566 connection is established, the client issues a STARTTLS command. If the
28567 server accepts this, the client and the server negotiate an encryption
28568 mechanism. If the negotiation succeeds, the data that subsequently passes
28569 between them is encrypted.
28570
28571 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
28572 and if so, what cipher suite is in use, whether the client supplied a
28573 certificate, and whether or not that certificate was verified. This makes it
28574 possible for an Exim server to deny or accept certain commands based on the
28575 encryption state.
28576
28577 &*Warning*&: Certain types of firewall and certain anti-virus products can
28578 disrupt TLS connections. You need to turn off SMTP scanning for these products
28579 in order to get TLS to work.
28580
28581
28582
28583 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
28584          "SECID284"
28585 .cindex "submissions protocol"
28586 .cindex "ssmtp protocol"
28587 .cindex "smtps protocol"
28588 .cindex "SMTP" "submissions protocol"
28589 .cindex "SMTP" "ssmtp protocol"
28590 .cindex "SMTP" "smtps protocol"
28591 The history of port numbers for TLS in SMTP is a little messy and has been
28592 contentious.  As of RFC 8314, the common practice of using the historically
28593 allocated port 465 for "email submission but with TLS immediately upon connect
28594 instead of using STARTTLS" is officially blessed by the IETF, and recommended
28595 by them in preference to STARTTLS.
28596
28597 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
28598 clarity emerged over the dual roles of SMTP, for MX delivery and Email
28599 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
28600
28601 This approach was, for a while, officially abandoned when encrypted SMTP was
28602 standardized, but many clients kept using it, even as the TCP port number was
28603 reassigned for other use.
28604 Thus you may encounter guidance claiming that you shouldn't enable use of
28605 this port.
28606 In practice, a number of mail-clients have only ever supported submissions,
28607 not submission with STARTTLS upgrade.
28608 Ideally, offer both submission (587) and submissions (465) service.
28609
28610 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
28611 global option. Its value must be a list of port numbers;
28612 the most common use is expected to be:
28613 .code
28614 tls_on_connect_ports = 465
28615 .endd
28616 The port numbers specified by this option apply to all SMTP connections, both
28617 via the daemon and via &'inetd'&. You still need to specify all the ports that
28618 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
28619 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
28620 an extra port &-- rather, it specifies different behaviour on a port that is
28621 defined elsewhere.
28622
28623 There is also a &%-tls-on-connect%& command line option. This overrides
28624 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
28625
28626
28627
28628
28629
28630
28631 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
28632 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
28633 TLS is supported in Exim using either the OpenSSL or GnuTLS library.
28634 To build Exim to use OpenSSL you need to set
28635 .code
28636 USE_OPENSSL=yes
28637 .endd
28638 in Local/Makefile.
28639
28640 To build Exim to use GnuTLS, you need to set
28641 .code
28642 USE_GNUTLS=yes
28643 .endd
28644 in Local/Makefile.
28645
28646 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
28647 include files and libraries for GnuTLS can be found.
28648
28649 There are some differences in usage when using GnuTLS instead of OpenSSL:
28650
28651 .ilist
28652 The &%tls_verify_certificates%& option
28653 cannot be the path of a directory
28654 for GnuTLS versions before 3.3.6
28655 (for later versions, or OpenSSL, it can be either).
28656 .next
28657 The default value for &%tls_dhparam%& differs for historical reasons.
28658 .next
28659 .vindex "&$tls_in_peerdn$&"
28660 .vindex "&$tls_out_peerdn$&"
28661 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
28662 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
28663 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
28664 .next
28665 OpenSSL identifies cipher suites using hyphens as separators, for example:
28666 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
28667 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
28668 in a cipher list. To make life simpler, Exim changes underscores to hyphens
28669 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
28670 to handle its own older variants) when processing lists of cipher suites in the
28671 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
28672 option).
28673 .next
28674 The &%tls_require_ciphers%& options operate differently, as described in the
28675 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
28676 .next
28677 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
28678 When using OpenSSL, this option is ignored.
28679 (If an API is found to let OpenSSL be configured in this way,
28680 let the Exim Maintainers know and we'll likely use it).
28681 .next
28682 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
28683 main option, it must be ordered to match the &%tls_certificate%& list.
28684 .next
28685 Some other recently added features may only be available in one or the other.
28686 This should be documented with the feature.  If the documentation does not
28687 explicitly state that the feature is infeasible in the other TLS
28688 implementation, then patches are welcome.
28689 .endlist
28690
28691
28692 .section "GnuTLS parameter computation" "SECTgnutlsparam"
28693 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
28694 an explicit path; if the latter, then the text about generation still applies,
28695 but not the chosen filename.
28696 By default, as of Exim 4.80 a hard-coded D-H prime is used.
28697 See the documentation of &%tls_dhparam%& for more information.
28698
28699 GnuTLS uses D-H parameters that may take a substantial amount of time
28700 to compute. It is unreasonable to re-compute them for every TLS session.
28701 Therefore, Exim keeps this data in a file in its spool directory, called
28702 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
28703 of bits requested.
28704 The file is owned by the Exim user and is readable only by
28705 its owner. Every Exim process that start up GnuTLS reads the D-H
28706 parameters from this file. If the file does not exist, the first Exim process
28707 that needs it computes the data and writes it to a temporary file which is
28708 renamed once it is complete. It does not matter if several Exim processes do
28709 this simultaneously (apart from wasting a few resources). Once a file is in
28710 place, new Exim processes immediately start using it.
28711
28712 For maximum security, the parameters that are stored in this file should be
28713 recalculated periodically, the frequency depending on your paranoia level.
28714 If you are avoiding using the fixed D-H primes published in RFCs, then you
28715 are concerned about some advanced attacks and will wish to do this; if you do
28716 not regenerate then you might as well stick to the standard primes.
28717
28718 Arranging this is easy in principle; just delete the file when you want new
28719 values to be computed. However, there may be a problem. The calculation of new
28720 parameters needs random numbers, and these are obtained from &_/dev/random_&.
28721 If the system is not very active, &_/dev/random_& may delay returning data
28722 until enough randomness (entropy) is available. This may cause Exim to hang for
28723 a substantial amount of time, causing timeouts on incoming connections.
28724
28725 The solution is to generate the parameters externally to Exim. They are stored
28726 in &_gnutls-params-N_& in PEM format, which means that they can be
28727 generated externally using the &(certtool)& command that is part of GnuTLS.
28728
28729 To replace the parameters with new ones, instead of deleting the file
28730 and letting Exim re-create it, you can generate new parameters using
28731 &(certtool)& and, when this has been done, replace Exim's cache file by
28732 renaming. The relevant commands are something like this:
28733 .code
28734 # ls
28735 [ look for file; assume gnutls-params-2236 is the most recent ]
28736 # rm -f new-params
28737 # touch new-params
28738 # chown exim:exim new-params
28739 # chmod 0600 new-params
28740 # certtool --generate-dh-params --bits 2236 >>new-params
28741 # openssl dhparam -noout -text -in new-params | head
28742 [ check the first line, make sure it's not more than 2236;
28743   if it is, then go back to the start ("rm") and repeat
28744   until the size generated is at most the size requested ]
28745 # chmod 0400 new-params
28746 # mv new-params gnutls-params-2236
28747 .endd
28748 If Exim never has to generate the parameters itself, the possibility of
28749 stalling is removed.
28750
28751 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
28752 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
28753 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
28754 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
28755 and Exim does so.  This attempt to remove Exim from TLS policy decisions
28756 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
28757 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
28758 which applies to all D-H usage, client or server.  If the value returned by
28759 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
28760 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
28761 limit, which is still much higher than Exim historically used.
28762
28763 The filename and bits used will change as the GnuTLS maintainers change the
28764 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
28765 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
28766 2432 bits, while NSS is limited to 2236 bits.
28767
28768 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
28769 increase the chance of the generated prime actually being within acceptable
28770 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
28771 procedure above.  There is no sane procedure available to Exim to double-check
28772 the size of the generated prime, so it might still be too large.
28773
28774
28775 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
28776 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
28777 .oindex "&%tls_require_ciphers%&" "OpenSSL"
28778 There is a function in the OpenSSL library that can be passed a list of cipher
28779 suites before the cipher negotiation takes place. This specifies which ciphers
28780 are acceptable for TLS versions prior to 1.3.
28781 The list is colon separated and may contain names like
28782 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
28783 directly to this function call.
28784 Many systems will install the OpenSSL manual-pages, so you may have
28785 &'ciphers(1)'& available to you.
28786 The following quotation from the OpenSSL
28787 documentation specifies what forms of item are allowed in the cipher string:
28788
28789 .ilist
28790 It can consist of a single cipher suite such as RC4-SHA.
28791 .next
28792 It can represent a list of cipher suites containing a certain algorithm,
28793 or cipher suites of a certain type. For example SHA1 represents all
28794 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
28795 SSL v3 algorithms.
28796 .next
28797 Lists of cipher suites can be combined in a single cipher string using
28798 the + character. This is used as a logical and operation. For example
28799 SHA1+DES represents all cipher suites containing the SHA1 and the DES
28800 algorithms.
28801 .endlist
28802
28803 Each cipher string can be optionally preceded by one of the characters &`!`&,
28804 &`-`& or &`+`&.
28805 .ilist
28806 If &`!`& is used, the ciphers are permanently deleted from the list. The
28807 ciphers deleted can never reappear in the list even if they are explicitly
28808 stated.
28809 .next
28810 If &`-`& is used, the ciphers are deleted from the list, but some or all
28811 of the ciphers can be added again by later options.
28812 .next
28813 If &`+`& is used, the ciphers are moved to the end of the list. This
28814 option does not add any new ciphers; it just moves matching existing ones.
28815 .endlist
28816
28817 If none of these characters is present, the string is interpreted as
28818 a list of ciphers to be appended to the current preference list. If the list
28819 includes any ciphers already present they will be ignored: that is, they will
28820 not be moved to the end of the list.
28821 .endlist
28822
28823 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
28824 string:
28825 .code
28826 # note single-quotes to get ! past any shell history expansion
28827 $ openssl ciphers 'HIGH:!MD5:!SHA1'
28828 .endd
28829
28830 This example will let the library defaults be permitted on the MX port, where
28831 there's probably no identity verification anyway, but ups the ante on the
28832 submission ports where the administrator might have some influence on the
28833 choice of clients used:
28834 .code
28835 # OpenSSL variant; see man ciphers(1)
28836 tls_require_ciphers = ${if =={$received_port}{25}\
28837                            {DEFAULT}\
28838                            {HIGH:!MD5:!SHA1}}
28839 .endd
28840
28841 This example will prefer ECDSA-authenticated ciphers over RSA ones:
28842 .code
28843 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
28844 .endd
28845
28846 For TLS version 1.3 the control available is less fine-grained
28847 and Exim does not provide access to it at present.
28848 The value of the &%tls_require_ciphers%& option is ignored when
28849 TLS version 1.3 is negotiated.
28850
28851 As of writing the library default cipher suite list for TLSv1.3 is
28852 .code
28853 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28854 .endd
28855
28856
28857 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28858          "SECTreqciphgnu"
28859 .cindex "GnuTLS" "specifying parameters for"
28860 .cindex "TLS" "specifying ciphers (GnuTLS)"
28861 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28862 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28863 .cindex "TLS" "specifying protocols (GnuTLS)"
28864 .cindex "TLS" "specifying priority string (GnuTLS)"
28865 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28866 The GnuTLS library allows the caller to provide a "priority string", documented
28867 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28868 ciphersuite specification in OpenSSL.
28869
28870 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28871 and controls both protocols and ciphers.
28872
28873 The &%tls_require_ciphers%& option is available both as an global option,
28874 controlling how Exim behaves as a server, and also as an option of the
28875 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28876 the value is string expanded.  The resulting string is not an Exim list and
28877 the string is given to the GnuTLS library, so that Exim does not need to be
28878 aware of future feature enhancements of GnuTLS.
28879
28880 Documentation of the strings accepted may be found in the GnuTLS manual, under
28881 "Priority strings".  This is online as
28882 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28883 but beware that this relates to GnuTLS 3, which may be newer than the version
28884 installed on your system.  If you are using GnuTLS 3,
28885 then the example code
28886 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28887 on that site can be used to test a given string.
28888
28889 For example:
28890 .code
28891 # Disable older versions of protocols
28892 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28893 .endd
28894
28895 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28896 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28897 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28898
28899 This example will let the library defaults be permitted on the MX port, where
28900 there's probably no identity verification anyway, and lowers security further
28901 by increasing compatibility; but this ups the ante on the submission ports
28902 where the administrator might have some influence on the choice of clients
28903 used:
28904 .code
28905 # GnuTLS variant
28906 tls_require_ciphers = ${if =={$received_port}{25}\
28907                            {NORMAL:%COMPAT}\
28908                            {SECURE128}}
28909 .endd
28910
28911
28912 .section "Configuring an Exim server to use TLS" "SECID182"
28913 .cindex "TLS" "configuring an Exim server"
28914 .cindex "ESMTP extensions" STARTTLS
28915 When Exim has been built with TLS support, it advertises the availability of
28916 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28917 but not to any others. The default value of this option is *, which means
28918 that STARTTLS is always advertised.  Set it to blank to never advertise;
28919 this is reasonable for systems that want to use TLS only as a client.
28920
28921 If STARTTLS is to be used you
28922 need to set some other options in order to make TLS available.
28923
28924 If a client issues a STARTTLS command and there is some configuration
28925 problem in the server, the command is rejected with a 454 error. If the client
28926 persists in trying to issue SMTP commands, all except QUIT are rejected
28927 with the error
28928 .code
28929 554 Security failure
28930 .endd
28931 If a STARTTLS command is issued within an existing TLS session, it is
28932 rejected with a 554 error code.
28933
28934 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28935 must be set to match some hosts. The default is * which matches all hosts.
28936
28937 If this is all you do, TLS encryption will be enabled but not authentication -
28938 meaning that the peer has no assurance it is actually you he is talking to.
28939 You gain protection from a passive sniffer listening on the wire but not
28940 from someone able to intercept the communication.
28941
28942 Further protection requires some further configuration at the server end.
28943
28944 To make TLS work you need to set, in the server,
28945 .code
28946 tls_certificate = /some/file/name
28947 tls_privatekey = /some/file/name
28948 .endd
28949 These options are, in fact, expanded strings, so you can make them depend on
28950 the identity of the client that is connected if you wish. The first file
28951 contains the server's X509 certificate, and the second contains the private key
28952 that goes with it. These files need to be
28953 PEM format and readable by the Exim user, and must
28954 always be given as full path names.
28955 The key must not be password-protected.
28956 They can be the same file if both the
28957 certificate and the key are contained within it. If &%tls_privatekey%& is not
28958 set, or if its expansion is forced to fail or results in an empty string, this
28959 is assumed to be the case. The certificate file may also contain intermediate
28960 certificates that need to be sent to the client to enable it to authenticate
28961 the server's certificate.
28962
28963 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28964 colon-separated lists of file paths.  Ciphers using given authentication
28965 algorithms require the presence of a suitable certificate to supply the
28966 public-key.  The server selects among the certificates to present to the
28967 client depending on the selected cipher, hence the priority ordering for
28968 ciphers will affect which certificate is used.
28969
28970 If you do not understand about certificates and keys, please try to find a
28971 source of this background information, which is not Exim-specific. (There are a
28972 few comments below in section &<<SECTcerandall>>&.)
28973
28974 &*Note*&: These options do not apply when Exim is operating as a client &--
28975 they apply only in the case of a server. If you need to use a certificate in an
28976 Exim client, you must set the options of the same names in an &(smtp)&
28977 transport.
28978
28979 With just these options, an Exim server will be able to use TLS. It does not
28980 require the client to have a certificate (but see below for how to insist on
28981 this). There is one other option that may be needed in other situations. If
28982 .code
28983 tls_dhparam = /some/file/name
28984 .endd
28985 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28986 with the parameters contained in the file.
28987 Set this to &`none`& to disable use of DH entirely, by making no prime
28988 available:
28989 .code
28990 tls_dhparam = none
28991 .endd
28992 This may also be set to a string identifying a standard prime to be used for
28993 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28994 used is &`ike23`&.  There are a few standard primes available, see the
28995 documentation for &%tls_dhparam%& for the complete list.
28996
28997 See the command
28998 .code
28999 openssl dhparam
29000 .endd
29001 for a way of generating file data.
29002
29003 The strings supplied for these three options are expanded every time a client
29004 host connects. It is therefore possible to use different certificates and keys
29005 for different hosts, if you so wish, by making use of the client's IP address
29006 in &$sender_host_address$& to control the expansion. If a string expansion is
29007 forced to fail, Exim behaves as if the option is not set.
29008
29009 .cindex "cipher" "logging"
29010 .cindex "log" "TLS cipher"
29011 .vindex "&$tls_in_cipher$&"
29012 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
29013 an incoming TLS connection. It is included in the &'Received:'& header of an
29014 incoming message (by default &-- you can, of course, change this), and it is
29015 also included in the log line that records a message's arrival, keyed by
29016 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
29017 condition can be used to test for specific cipher suites in ACLs.
29018
29019 Once TLS has been established, the ACLs that run for subsequent SMTP commands
29020 can check the name of the cipher suite and vary their actions accordingly. The
29021 cipher suite names vary, depending on which TLS library is being used. For
29022 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
29023 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
29024 documentation for more details.
29025
29026 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
29027 (again depending on the &%tls_cipher%& log selector).
29028
29029
29030 .section "Requesting and verifying client certificates" "SECID183"
29031 .cindex "certificate" "verification of client"
29032 .cindex "TLS" "client certificate verification"
29033 If you want an Exim server to request a certificate when negotiating a TLS
29034 session with a client, you must set either &%tls_verify_hosts%& or
29035 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
29036 apply to all TLS connections. For any host that matches one of these options,
29037 Exim requests a certificate as part of the setup of the TLS session. The
29038 contents of the certificate are verified by comparing it with a list of
29039 expected trust-anchors or certificates.
29040 These may be the system default set (depending on library version),
29041 an explicit file or,
29042 depending on library version, a directory, identified by
29043 &%tls_verify_certificates%&.
29044
29045 A file can contain multiple certificates, concatenated end to end. If a
29046 directory is used
29047 (OpenSSL only),
29048 each certificate must be in a separate file, with a name (or a symbolic link)
29049 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
29050 certificate. You can compute the relevant hash by running the command
29051 .code
29052 openssl x509 -hash -noout -in /cert/file
29053 .endd
29054 where &_/cert/file_& contains a single certificate.
29055
29056 There is no checking of names of the client against the certificate
29057 Subject Name or Subject Alternate Names.
29058
29059 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
29060 what happens if the client does not supply a certificate, or if the certificate
29061 does not match any of the certificates in the collection named by
29062 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
29063 attempt to set up a TLS session is aborted, and the incoming connection is
29064 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
29065 session continues. ACLs that run for subsequent SMTP commands can detect the
29066 fact that no certificate was verified, and vary their actions accordingly. For
29067 example, you can insist on a certificate before accepting a message for
29068 relaying, but not when the message is destined for local delivery.
29069
29070 .vindex "&$tls_in_peerdn$&"
29071 When a client supplies a certificate (whether it verifies or not), the value of
29072 the Distinguished Name of the certificate is made available in the variable
29073 &$tls_in_peerdn$& during subsequent processing of the message.
29074
29075 .cindex "log" "distinguished name"
29076 Because it is often a long text string, it is not included in the log line or
29077 &'Received:'& header by default. You can arrange for it to be logged, keyed by
29078 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
29079 &%received_header_text%& to change the &'Received:'& header. When no
29080 certificate is supplied, &$tls_in_peerdn$& is empty.
29081
29082
29083 .section "Revoked certificates" "SECID184"
29084 .cindex "TLS" "revoked certificates"
29085 .cindex "revocation list"
29086 .cindex "certificate" "revocation list"
29087 .cindex "OCSP" "stapling"
29088 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
29089 certificates are revoked. If you have such a list, you can pass it to an Exim
29090 server using the global option called &%tls_crl%& and to an Exim client using
29091 an identically named option for the &(smtp)& transport. In each case, the value
29092 of the option is expanded and must then be the name of a file that contains a
29093 CRL in PEM format.
29094 The downside is that clients have to periodically re-download a potentially huge
29095 file from every certificate authority they know of.
29096
29097 The way with most moving parts at query time is Online Certificate
29098 Status Protocol (OCSP), where the client verifies the certificate
29099 against an OCSP server run by the CA.  This lets the CA track all
29100 usage of the certs.  It requires running software with access to the
29101 private key of the CA, to sign the responses to the OCSP queries.  OCSP
29102 is based on HTTP and can be proxied accordingly.
29103
29104 The only widespread OCSP server implementation (known to this writer)
29105 comes as part of OpenSSL and aborts on an invalid request, such as
29106 connecting to the port and then disconnecting.  This requires
29107 re-entering the passphrase each time some random client does this.
29108
29109 The third way is OCSP Stapling; in this, the server using a certificate
29110 issued by the CA periodically requests an OCSP proof of validity from
29111 the OCSP server, then serves it up inline as part of the TLS
29112 negotiation.   This approach adds no extra round trips, does not let the
29113 CA track users, scales well with number of certs issued by the CA and is
29114 resilient to temporary OCSP server failures, as long as the server
29115 starts retrying to fetch an OCSP proof some time before its current
29116 proof expires.  The downside is that it requires server support.
29117
29118 Unless Exim is built with the support disabled,
29119 or with GnuTLS earlier than version 3.3.16 / 3.4.8
29120 support for OCSP stapling is included.
29121
29122 There is a global option called &%tls_ocsp_file%&.
29123 The file specified therein is expected to be in DER format, and contain
29124 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
29125 option will be re-expanded for SNI, if the &%tls_certificate%& option
29126 contains &`tls_in_sni`&, as per other TLS options.
29127
29128 Exim does not at this time implement any support for fetching a new OCSP
29129 proof.  The burden is on the administrator to handle this, outside of
29130 Exim.  The file specified should be replaced atomically, so that the
29131 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
29132 on each connection, so a new file will be handled transparently on the
29133 next connection.
29134
29135 When built with OpenSSL Exim will check for a valid next update timestamp
29136 in the OCSP proof; if not present, or if the proof has expired, it will be
29137 ignored.
29138
29139 For the client to be able to verify the stapled OCSP the server must
29140 also supply, in its stapled information, any intermediate
29141 certificates for the chain leading to the OCSP proof from the signer
29142 of the server certificate.  There may be zero or one such. These
29143 intermediate certificates should be added to the server OCSP stapling
29144 file named by &%tls_ocsp_file%&.
29145
29146 Note that the proof only covers the terminal server certificate,
29147 not any of the chain from CA to it.
29148
29149 There is no current way to staple a proof for a client certificate.
29150
29151 .code
29152   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
29153   OCSP server is supplied.  The server URL may be included in the
29154   server certificate, if the CA is helpful.
29155
29156   One failure mode seen was the OCSP Signer cert expiring before the end
29157   of validity of the OCSP proof. The checking done by Exim/OpenSSL
29158   noted this as invalid overall, but the re-fetch script did not.
29159 .endd
29160
29161
29162
29163
29164 .section "Configuring an Exim client to use TLS" "SECTclientTLS"
29165 .cindex "cipher" "logging"
29166 .cindex "log" "TLS cipher"
29167 .cindex "log" "distinguished name"
29168 .cindex "TLS" "configuring an Exim client"
29169 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
29170 deliveries as well as to incoming, the latter one causing logging of the
29171 server certificate's DN. The remaining client configuration for TLS is all
29172 within the &(smtp)& transport.
29173
29174 .cindex "ESMTP extensions" STARTTLS
29175 It is not necessary to set any options to have TLS work in the &(smtp)&
29176 transport. If Exim is built with TLS support, and TLS is advertised by a
29177 server, the &(smtp)& transport always tries to start a TLS session. However,
29178 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
29179 transport) to a list of server hosts for which TLS should not be used.
29180
29181 If you do not want Exim to attempt to send messages unencrypted when an attempt
29182 to set up an encrypted connection fails in any way, you can set
29183 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
29184 those hosts, delivery is always deferred if an encrypted connection cannot be
29185 set up. If there are any other hosts for the address, they are tried in the
29186 usual way.
29187
29188 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
29189 the message unencrypted. It always does this if the response to STARTTLS is
29190 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
29191 session after a success response code, what happens is controlled by the
29192 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
29193 delivery to this host is deferred, and other hosts (if available) are tried. If
29194 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
29195 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
29196 negotiation fails, Exim closes the current connection (because it is in an
29197 unknown state), opens a new one to the same host, and then tries the delivery
29198 unencrypted.
29199
29200 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
29201 transport provide the client with a certificate, which is passed to the server
29202 if it requests it. If the server is Exim, it will request a certificate only if
29203 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
29204
29205 &*Note*&: Do not use a certificate which has the OCSP-must-staple extension,
29206 for client use (they are usable for server use).
29207 As the TLS protocol has no means for the client to staple before TLS 1.3 it will result
29208 in failed connections.
29209
29210 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
29211 specifies a collection of expected server certificates.
29212 These may be
29213 the system default set (depending on library version),
29214 a file,
29215 or (depending on library version) a directory.
29216 The client verifies the server's certificate
29217 against this collection, taking into account any revoked certificates that are
29218 in the list defined by &%tls_crl%&.
29219 Failure to verify fails the TLS connection unless either of the
29220 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
29221
29222 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
29223 certificate verification to the listed servers.  Verification either must
29224 or need not succeed respectively.
29225
29226 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
29227 checks are made: that the host name (the one in the DNS A record)
29228 is valid for the certificate.
29229 The option defaults to always checking.
29230
29231 The &(smtp)& transport has two OCSP-related options:
29232 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
29233 is requested and required for the connection to proceed.  The default
29234 value is empty.
29235 &%hosts_request_ocsp%&; a host-list for which (additionally)
29236 a Certificate Status is requested (but not necessarily verified).  The default
29237 value is "*" meaning that requests are made unless configured
29238 otherwise.
29239
29240 The host(s) should also be in &%hosts_require_tls%&, and
29241 &%tls_verify_certificates%& configured for the transport,
29242 for OCSP to be relevant.
29243
29244 If
29245 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
29246 list of permitted cipher suites. If either of these checks fails, delivery to
29247 the current host is abandoned, and the &(smtp)& transport tries to deliver to
29248 alternative hosts, if any.
29249
29250  &*Note*&:
29251 These options must be set in the &(smtp)& transport for Exim to use TLS when it
29252 is operating as a client. Exim does not assume that a server certificate (set
29253 by the global options of the same name) should also be used when operating as a
29254 client.
29255
29256 .vindex "&$host$&"
29257 .vindex "&$host_address$&"
29258 All the TLS options in the &(smtp)& transport are expanded before use, with
29259 &$host$& and &$host_address$& containing the name and address of the server to
29260 which the client is connected. Forced failure of an expansion causes Exim to
29261 behave as if the relevant option were unset.
29262
29263 .vindex &$tls_out_bits$&
29264 .vindex &$tls_out_cipher$&
29265 .vindex &$tls_out_peerdn$&
29266 .vindex &$tls_out_sni$&
29267 Before an SMTP connection is established, the
29268 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
29269 variables are emptied. (Until the first connection, they contain the values
29270 that were set when the message was received.) If STARTTLS is subsequently
29271 successfully obeyed, these variables are set to the relevant values for the
29272 outgoing connection.
29273
29274
29275
29276 .section "Use of TLS Server Name Indication" "SECTtlssni"
29277 .cindex "TLS" "Server Name Indication"
29278 .vindex "&$tls_in_sni$&"
29279 .oindex "&%tls_in_sni%&"
29280 With TLS1.0 or above, there is an extension mechanism by which extra
29281 information can be included at various points in the protocol.  One of these
29282 extensions, documented in RFC 6066 (and before that RFC 4366) is
29283 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
29284 client in the initial handshake, so that the server can examine the servername
29285 within and possibly choose to use different certificates and keys (and more)
29286 for this session.
29287
29288 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
29289 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
29290 address.
29291
29292 With SMTP to MX, there are the same problems here as in choosing the identity
29293 against which to validate a certificate: you can't rely on insecure DNS to
29294 provide the identity which you then cryptographically verify.  So this will
29295 be of limited use in that environment.
29296
29297 With SMTP to Submission, there is a well-defined hostname which clients are
29298 connecting to and can validate certificates against.  Thus clients &*can*&
29299 choose to include this information in the TLS negotiation.  If this becomes
29300 wide-spread, then hosters can choose to present different certificates to
29301 different clients.  Or even negotiate different cipher suites.
29302
29303 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
29304 if not empty, will be sent on a TLS session as part of the handshake.  There's
29305 nothing more to it.  Choosing a sensible value not derived insecurely is the
29306 only point of caution.  The &$tls_out_sni$& variable will be set to this string
29307 for the lifetime of the client connection (including during authentication).
29308
29309 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
29310 received from a client.
29311 It can be logged with the &%log_selector%& item &`+tls_sni`&.
29312
29313 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
29314 option (prior to expansion) then the following options will be re-expanded
29315 during TLS session handshake, to permit alternative values to be chosen:
29316
29317 .ilist
29318 &%tls_certificate%&
29319 .next
29320 &%tls_crl%&
29321 .next
29322 &%tls_privatekey%&
29323 .next
29324 &%tls_verify_certificates%&
29325 .next
29326 &%tls_ocsp_file%&
29327 .endlist
29328
29329 Great care should be taken to deal with matters of case, various injection
29330 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
29331 can always be referenced; it is important to remember that &$tls_in_sni$& is
29332 arbitrary unverified data provided prior to authentication.
29333 Further, the initial certificate is loaded before SNI has arrived, so
29334 an expansion for &%tls_certificate%& must have a default which is used
29335 when &$tls_in_sni$& is empty.
29336
29337 The Exim developers are proceeding cautiously and so far no other TLS options
29338 are re-expanded.
29339
29340 When Exim is built against OpenSSL, OpenSSL must have been built with support
29341 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
29342 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
29343 see &`-servername`& in the output, then OpenSSL has support.
29344
29345 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
29346 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
29347 built, then you have SNI support).
29348
29349
29350
29351 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
29352          "SECTmulmessam"
29353 .cindex "multiple SMTP deliveries with TLS"
29354 .cindex "TLS" "multiple message deliveries"
29355 Exim sends multiple messages down the same TCP/IP connection by starting up
29356 an entirely new delivery process for each message, passing the socket from
29357 one process to the next. This implementation does not fit well with the use
29358 of TLS, because there is quite a lot of state information associated with a TLS
29359 connection, not just a socket identification. Passing all the state information
29360 to a new process is not feasible. Consequently, for sending using TLS Exim
29361 starts an additional proxy process for handling the encryption, piping the
29362 unencrypted data stream from and to the delivery processes.
29363
29364 An older mode of operation can be enabled on a per-host basis by the
29365 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
29366 this list the proxy process described above is not used; instead Exim
29367 shuts down an existing TLS session being run by the delivery process
29368 before passing the socket to a new process. The new process may then
29369 try to start a new TLS session, and if successful, may try to re-authenticate
29370 if AUTH is in use, before sending the next message.
29371
29372 The RFC is not clear as to whether or not an SMTP session continues in clear
29373 after TLS has been shut down, or whether TLS may be restarted again later, as
29374 just described. However, if the server is Exim, this shutdown and
29375 reinitialization works. It is not known which (if any) other servers operate
29376 successfully if the client closes a TLS session and continues with unencrypted
29377 SMTP, but there are certainly some that do not work. For such servers, Exim
29378 should not pass the socket to another process, because the failure of the
29379 subsequent attempt to use it would cause Exim to record a temporary host error,
29380 and delay other deliveries to that host.
29381
29382 To test for this case, Exim sends an EHLO command to the server after
29383 closing down the TLS session. If this fails in any way, the connection is
29384 closed instead of being passed to a new delivery process, but no retry
29385 information is recorded.
29386
29387 There is also a manual override; you can set &%hosts_nopass_tls%& on the
29388 &(smtp)& transport to match those hosts for which Exim should not pass
29389 connections to new processes if TLS has been used.
29390
29391
29392
29393
29394 .section "Certificates and all that" "SECTcerandall"
29395 .cindex "certificate" "references to discussion"
29396 In order to understand fully how TLS works, you need to know about
29397 certificates, certificate signing, and certificate authorities.
29398 This is a large topic and an introductory guide is unsuitable for the Exim
29399 reference manual, so instead we provide pointers to existing documentation.
29400
29401 The Apache web-server was for a long time the canonical guide, so their
29402 documentation is a good place to start; their SSL module's Introduction
29403 document is currently at
29404 .display
29405 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
29406 .endd
29407 and their FAQ is at
29408 .display
29409 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
29410 .endd
29411
29412 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
29413 0-201-61598-3) in 2001, contains both introductory and more in-depth
29414 descriptions.
29415 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
29416 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
29417 Ivan is the author of the popular TLS testing tools at
29418 &url(https://www.ssllabs.com/).
29419
29420
29421 .section "Certificate chains" "SECID186"
29422 The file named by &%tls_certificate%& may contain more than one
29423 certificate. This is useful in the case where the certificate that is being
29424 sent is validated by an intermediate certificate which the other end does
29425 not have. Multiple certificates must be in the correct order in the file.
29426 First the host's certificate itself, then the first intermediate
29427 certificate to validate the issuer of the host certificate, then the next
29428 intermediate certificate to validate the issuer of the first intermediate
29429 certificate, and so on, until finally (optionally) the root certificate.
29430 The root certificate must already be trusted by the recipient for
29431 validation to succeed, of course, but if it's not preinstalled, sending the
29432 root certificate along with the rest makes it available for the user to
29433 install if the receiving end is a client MUA that can interact with a user.
29434
29435 Note that certificates using MD5 are unlikely to work on today's Internet;
29436 even if your libraries allow loading them for use in Exim when acting as a
29437 server, increasingly clients will not accept such certificates.  The error
29438 diagnostics in such a case can be frustratingly vague.
29439
29440
29441
29442 .section "Self-signed certificates" "SECID187"
29443 .cindex "certificate" "self-signed"
29444 You can create a self-signed certificate using the &'req'& command provided
29445 with OpenSSL, like this:
29446 . ==== Do not shorten the duration here without reading and considering
29447 . ==== the text below.  Please leave it at 9999 days.
29448 .code
29449 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
29450             -days 9999 -nodes
29451 .endd
29452 &_file1_& and &_file2_& can be the same file; the key and the certificate are
29453 delimited and so can be identified independently. The &%-days%& option
29454 specifies a period for which the certificate is valid. The &%-nodes%& option is
29455 important: if you do not set it, the key is encrypted with a passphrase
29456 that you are prompted for, and any use that is made of the key causes more
29457 prompting for the passphrase. This is not helpful if you are going to use
29458 this certificate and key in an MTA, where prompting is not possible.
29459
29460 . ==== I expect to still be working 26 years from now.  The less technical
29461 . ==== debt I create, in terms of storing up trouble for my later years, the
29462 . ==== happier I will be then.  We really have reached the point where we
29463 . ==== should start, at the very least, provoking thought and making folks
29464 . ==== pause before proceeding, instead of leaving all the fixes until two
29465 . ==== years before 2^31 seconds after the 1970 Unix epoch.
29466 . ==== -pdp, 2012
29467 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
29468 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
29469 the above command might produce a date in the past.  Think carefully about
29470 the lifetime of the systems you're deploying, and either reduce the duration
29471 of the certificate or reconsider your platform deployment.  (At time of
29472 writing, reducing the duration is the most likely choice, but the inexorable
29473 progression of time takes us steadily towards an era where this will not
29474 be a sensible resolution).
29475
29476 A self-signed certificate made in this way is sufficient for testing, and
29477 may be adequate for all your requirements if you are mainly interested in
29478 encrypting transfers, and not in secure identification.
29479
29480 However, many clients require that the certificate presented by the server be a
29481 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
29482 certificate. In this situation, the self-signed certificate described above
29483 must be installed on the client host as a trusted root &'certification
29484 authority'& (CA), and the certificate used by Exim must be a user certificate
29485 signed with that self-signed certificate.
29486
29487 For information on creating self-signed CA certificates and using them to sign
29488 user certificates, see the &'General implementation overview'& chapter of the
29489 Open-source PKI book, available online at
29490 &url(https://sourceforge.net/projects/ospkibook/).
29491 .ecindex IIDencsmtp1
29492 .ecindex IIDencsmtp2
29493
29494
29495 .new
29496 .section "TLS Resumption" "SECTresumption"
29497 .cindex TLS resumption
29498 TLS Session Resumption for TLS 1.2 and TLS 1.3 connections can be used (defined
29499 in RFC 5077 for 1.2).  The support for this requires GnuTLS 3.6.3 or OpenSSL 1.1.1
29500 (or later).
29501
29502 Session resumption (this is the "stateless" variant) involves the server sending
29503 a "session ticket" to the client on one connection, which can be stored by the
29504 client and used for a later session.  The ticket contains sufficient state for
29505 the server to reconstruct the TLS session, avoiding some expensive crypto
29506 calculation and (on TLS1.2) one full packet roundtrip time.
29507
29508 .ilist
29509 Operational cost/benefit:
29510
29511  The extra data being transmitted costs a minor amount, and the client has
29512  extra costs in storing and retrieving the data.
29513
29514  In the Exim/Gnutls implementation the extra cost on an initial connection
29515  which is TLS1.2 over a loopback path is about 6ms on 2017-laptop class hardware.
29516  The saved cost on a subsequent connection is about 4ms; three or more
29517  connections become a net win.  On longer network paths, two or more
29518  connections will have an average lower startup time thanks to the one
29519  saved packet roundtrip.  TLS1.3 will save the crypto cpu costs but not any
29520  packet roundtrips.
29521
29522 .cindex "hints database" tls
29523  Since a new hints DB is used on the TLS client,
29524  the hints DB maintenance should be updated to additionally handle "tls".
29525
29526 .next
29527 Security aspects:
29528
29529  The session ticket is encrypted, but is obviously an additional security
29530  vulnarability surface.  An attacker able to decrypt it would have access
29531  all connections using the resumed session.
29532  The session ticket encryption key is not committed to storage by the server
29533  and is rotated regularly (OpenSSL: 1hr, and one previous key is used for
29534  overlap; GnuTLS 6hr but does not specify any overlap).
29535  Tickets have limited lifetime (2hr, and new ones issued after 1hr under
29536  OpenSSL.  GnuTLS 2hr, appears to not do overlap).
29537
29538  There is a question-mark over the security of the Diffie-Helman parameters
29539  used for session negotiation.
29540
29541 .next
29542 Observability:
29543
29544  The &%log_selector%& "tls_resumption" appends an asterisk to the tls_cipher "X="
29545  element.
29546
29547  The variables &$tls_in_resumption$& and &$tls_out_resumption$&
29548  have bits 0-4 indicating respectively
29549  support built, client requested ticket, client offered session,
29550  server issued ticket, resume used.  A suitable decode list is provided
29551  in the builtin macro _RESUME_DECODE for in &%listextract%& expansions.
29552
29553 .next
29554 Control:
29555
29556 The &%tls_resumption_hosts%& main option specifies a hostlist for which
29557 exim, operating as a server, will offer resumption to clients.
29558 Current best practice is to not offer the feature to MUA connection.
29559 Commonly this can be done like this:
29560 .code
29561 tls_resumption_hosts = ${if inlist {$received_port}{587:465} {:}{*}}
29562 .endd
29563 If the peer host matches the list after expansion then resumption
29564 is offered and/or accepted.
29565
29566 The &%tls_resumption_hosts%& smtp transport option performs the
29567 equivalent function for operation as a client.
29568 If the peer host matches the list after expansion then resumption
29569 is attempted (if a stored session is available) or the information
29570 stored (if supplied by the peer).
29571
29572
29573 .next
29574 Issues:
29575
29576  In a resumed session:
29577 .ilist
29578   The variables &$tls_{in,out}_cipher$& will have values different
29579  to the original (under GnuTLS).
29580 .next
29581   The variables &$tls_{in,out}_ocsp$& will be "not requested" or "no response",
29582  and the &%hosts_require_ocsp%& smtp trasnport option will fail.
29583 . XXX need to do something with that hosts_require_ocsp
29584 .endlist
29585
29586 .endlist
29587 .wen
29588
29589
29590 .section DANE "SECDANE"
29591 .cindex DANE
29592 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
29593 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
29594 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
29595 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
29596 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
29597 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
29598
29599 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
29600 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
29601 by (a) is thought to be smaller than that of the set of root CAs.
29602
29603 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
29604 fail to pass on a server's STARTTLS.
29605
29606 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
29607 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
29608 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
29609
29610 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
29611 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
29612 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
29613 DNSSEC.
29614 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
29615 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
29616
29617 There are no changes to Exim specific to server-side operation of DANE.
29618 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
29619 in &_Local/Makefile_&.
29620 If it has been included, the macro "_HAVE_DANE" will be defined.
29621
29622 A TLSA record consist of 4 fields, the "Certificate Usage", the
29623 "Selector", the "Matching type", and the "Certificate Association Data".
29624 For a detailed description of the TLSA record see
29625 &url(https://tools.ietf.org/html/rfc7671#page-5,RFC 7671).
29626
29627 The TLSA record for the server may have "Certificate Usage" (1st) field of DANE-TA(2) or DANE-EE(3).
29628 These are the "Trust Anchor" and "End Entity" variants.
29629 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
29630 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
29631 this is appropriate for a single system, using a self-signed certificate.
29632 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
29633 well-known one.
29634 A private CA at simplest is just a self-signed certificate (with certain
29635 attributes) which is used to sign server certificates, but running one securely
29636 does require careful arrangement.
29637 With DANE-TA, as implemented in Exim and commonly in other MTAs,
29638 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
29639 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
29640 all of which point to a single TLSA record.
29641 DANE-TA and DANE-EE can both be used together.
29642
29643 Our recommendation is to use DANE with a certificate from a public CA,
29644 because this enables a variety of strategies for remote clients to verify
29645 your certificate.
29646 You can then publish information both via DANE and another technology,
29647 "MTA-STS", described below.
29648
29649 When you use DANE-TA to publish trust anchor information, you ask entities
29650 outside your administrative control to trust the Certificate Authority for
29651 connections to you.
29652 If using a private CA then you should expect others to still apply the
29653 technical criteria they'd use for a public CA to your certificates.
29654 In particular, you should probably try to follow current best practices for CA
29655 operation around hash algorithms and key sizes.
29656 Do not expect other organizations to lower their security expectations just
29657 because a particular profile might be reasonable for your own internal use.
29658
29659 When this text was last updated, this in practice means to avoid use of SHA-1
29660 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
29661 than 4096, for interoperability); to use keyUsage fields correctly; to use
29662 random serial numbers.
29663 The list of requirements is subject to change as best practices evolve.
29664 If you're not already using a private CA, or it doesn't meet these
29665 requirements, then we encourage you to avoid all these issues and use a public
29666 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
29667
29668 The TLSA record should have a "Selector" (2nd) field of SPKI(1) and
29669 a "Matching Type" (3rd) field of SHA2-512(2).
29670
29671 For the "Certificate Authority Data" (4th) field, commands like
29672
29673 .code
29674   openssl x509 -pubkey -noout <certificate.pem \
29675   | openssl rsa -outform der -pubin 2>/dev/null \
29676   | openssl sha512 \
29677   | awk '{print $2}'
29678 .endd
29679
29680 are workable to create a hash of the certificate's public key.
29681
29682 An example TLSA record for DANE-EE(3), SPKI(1), and SHA-512 (2) looks like
29683
29684 .code
29685   _25._tcp.mail.example.com. TLSA 3 1 2 8BA8A336E...
29686 .endd
29687
29688 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
29689 is useful for quickly generating TLSA records.
29690
29691
29692 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
29693
29694 The Certificate issued by the CA published in the DANE-TA model should be
29695 issued using a strong hash algorithm.
29696 Exim, and importantly various other MTAs sending to you, will not
29697 re-enable hash algorithms which have been disabled by default in TLS
29698 libraries.
29699 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
29700 interoperability (and probably the maximum too, in 2018).
29701
29702 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
29703 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
29704 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
29705
29706 .code
29707   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
29708                                  {= {4}{$tls_out_tlsa_usage}} } \
29709                          {*}{}}
29710 .endd
29711
29712 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
29713 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
29714 found. If the definition of &%hosts_request_ocsp%& includes the
29715 string "tls_out_tlsa_usage", they are re-expanded in time to
29716 control the OCSP request.
29717
29718 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
29719 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
29720
29721
29722 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
29723 and &%dane_require_tls_ciphers%&.
29724 The &"require"& variant will result in failure if the target host is not
29725 DNSSEC-secured. To get DNSSEC-secured hostname resolution, use
29726 the &%dnssec_request_domains%& router or transport option.
29727
29728 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
29729
29730 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
29731 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
29732 will be required for the host.  If it does not, the host will not
29733 be used; there is no fallback to non-DANE or non-TLS.
29734
29735 If DANE is requested and usable, then the TLS cipher list configuration
29736 prefers to use the option &%dane_require_tls_ciphers%& and falls
29737 back to &%tls_require_ciphers%& only if that is unset.
29738 This lets you configure "decent crypto" for DANE and "better than nothing
29739 crypto" as the default.  Note though that while GnuTLS lets the string control
29740 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
29741 limited to ciphersuite constraints.
29742
29743 If DANE is requested and useable (see above) the following transport options are ignored:
29744 .code
29745   hosts_require_tls
29746   tls_verify_hosts
29747   tls_try_verify_hosts
29748   tls_verify_certificates
29749   tls_crl
29750   tls_verify_cert_hostnames
29751 .endd
29752
29753 If DANE is not usable, whether requested or not, and CA-anchored
29754 verification evaluation is wanted, the above variables should be set appropriately.
29755
29756 The router and transport option &%dnssec_request_domains%& must not be
29757 set to &"never"&, and &%dnssec_require_domains%& is ignored.
29758
29759 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
29760
29761 There is a new variable &$tls_out_dane$& which will have "yes" if
29762 verification succeeded using DANE and "no" otherwise (only useful
29763 in combination with events; see &<<CHAPevents>>&),
29764 and a new variable &$tls_out_tlsa_usage$& (detailed above).
29765
29766 .cindex DANE reporting
29767 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
29768 to achieve DANE-verified connection, if one was either requested and offered, or
29769 required.  This is intended to support TLS-reporting as defined in
29770 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
29771 The &$event_data$& will be one of the Result Types defined in
29772 Section 4.3 of that document.
29773
29774 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
29775
29776 DANE is specified in published RFCs and decouples certificate authority trust
29777 selection from a "race to the bottom" of "you must trust everything for mail
29778 to get through".  There is an alternative technology called MTA-STS, which
29779 instead publishes MX trust anchor information on an HTTPS website.  At the
29780 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
29781 Exim has no support for MTA-STS as a client, but Exim mail server operators
29782 can choose to publish information describing their TLS configuration using
29783 MTA-STS to let those clients who do use that protocol derive trust
29784 information.
29785
29786 The MTA-STS design requires a certificate from a public Certificate Authority
29787 which is recognized by clients sending to you.
29788 That selection of which CAs are trusted by others is outside your control.
29789
29790 The most interoperable course of action is probably to use
29791 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
29792 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
29793 records for DANE clients (such as Exim and Postfix) and to publish anchor
29794 information for MTA-STS as well.  This is what is done for the &'exim.org'&
29795 domain itself (with caveats around occasionally broken MTA-STS because of
29796 incompatible specification changes prior to reaching RFC status).
29797
29798
29799
29800 . ////////////////////////////////////////////////////////////////////////////
29801 . ////////////////////////////////////////////////////////////////////////////
29802
29803 .chapter "Access control lists" "CHAPACL"
29804 .scindex IIDacl "&ACL;" "description"
29805 .cindex "control of incoming mail"
29806 .cindex "message" "controlling incoming"
29807 .cindex "policy control" "access control lists"
29808 Access Control Lists (ACLs) are defined in a separate section of the runtime
29809 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
29810 name, terminated by a colon. Here is a complete ACL section that contains just
29811 one very small ACL:
29812 .code
29813 begin acl
29814 small_acl:
29815   accept   hosts = one.host.only
29816 .endd
29817 You can have as many lists as you like in the ACL section, and the order in
29818 which they appear does not matter. The lists are self-terminating.
29819
29820 The majority of ACLs are used to control Exim's behaviour when it receives
29821 certain SMTP commands. This applies both to incoming TCP/IP connections, and
29822 when a local process submits a message using SMTP by specifying the &%-bs%&
29823 option. The most common use is for controlling which recipients are accepted
29824 in incoming messages. In addition, you can define an ACL that is used to check
29825 local non-SMTP messages. The default configuration file contains an example of
29826 a realistic ACL for checking RCPT commands. This is discussed in chapter
29827 &<<CHAPdefconfil>>&.
29828
29829
29830 .section "Testing ACLs" "SECID188"
29831 The &%-bh%& command line option provides a way of testing your ACL
29832 configuration locally by running a fake SMTP session with which you interact.
29833
29834
29835 .section "Specifying when ACLs are used" "SECID189"
29836 .cindex "&ACL;" "options for specifying"
29837 In order to cause an ACL to be used, you have to name it in one of the relevant
29838 options in the main part of the configuration. These options are:
29839 .cindex "AUTH" "ACL for"
29840 .cindex "DATA" "ACLs for"
29841 .cindex "ETRN" "ACL for"
29842 .cindex "EXPN" "ACL for"
29843 .cindex "HELO" "ACL for"
29844 .cindex "EHLO" "ACL for"
29845 .cindex "DKIM" "ACL for"
29846 .cindex "MAIL" "ACL for"
29847 .cindex "QUIT, ACL for"
29848 .cindex "RCPT" "ACL for"
29849 .cindex "STARTTLS, ACL for"
29850 .cindex "VRFY" "ACL for"
29851 .cindex "SMTP" "connection, ACL for"
29852 .cindex "non-SMTP messages" "ACLs for"
29853 .cindex "MIME content scanning" "ACL for"
29854 .cindex "PRDR" "ACL for"
29855
29856 .table2 140pt
29857 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
29858 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
29859 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
29860 .irow &%acl_smtp_auth%&        "ACL for AUTH"
29861 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
29862 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
29863 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
29864 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
29865 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
29866 .irow &%acl_smtp_expn%&        "ACL for EXPN"
29867 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
29868 .irow &%acl_smtp_mail%&        "ACL for MAIL"
29869 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
29870 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
29871 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
29872 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
29873 .irow &%acl_smtp_quit%&        "ACL for QUIT"
29874 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
29875 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
29876 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
29877 .endtable
29878
29879 For example, if you set
29880 .code
29881 acl_smtp_rcpt = small_acl
29882 .endd
29883 the little ACL defined above is used whenever Exim receives a RCPT command
29884 in an SMTP dialogue. The majority of policy tests on incoming messages can be
29885 done when RCPT commands arrive. A rejection of RCPT should cause the
29886 sending MTA to give up on the recipient address contained in the RCPT
29887 command, whereas rejection at other times may cause the client MTA to keep on
29888 trying to deliver the message. It is therefore recommended that you do as much
29889 testing as possible at RCPT time.
29890
29891
29892 .section "The non-SMTP ACLs" "SECID190"
29893 .cindex "non-SMTP messages" "ACLs for"
29894 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
29895 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
29896 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
29897 the state of the SMTP connection such as encryption and authentication) are not
29898 relevant and are forbidden in these ACLs. However, the sender and recipients
29899 are known, so the &%senders%& and &%sender_domains%& conditions and the
29900 &$sender_address$& and &$recipients$& variables can be used. Variables such as
29901 &$authenticated_sender$& are also available. You can specify added header lines
29902 in any of these ACLs.
29903
29904 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
29905 non-SMTP message, before any of the message has been read. (This is the
29906 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
29907 batched SMTP input, it runs after the DATA command has been reached. The
29908 result of this ACL is ignored; it cannot be used to reject a message. If you
29909 really need to, you could set a value in an ACL variable here and reject based
29910 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
29911 controls, and in particular, it can be used to set
29912 .code
29913 control = suppress_local_fixups
29914 .endd
29915 This cannot be used in the other non-SMTP ACLs because by the time they are
29916 run, it is too late.
29917
29918 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
29919 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29920
29921 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
29922 kind of rejection is treated as permanent, because there is no way of sending a
29923 temporary error for these kinds of message.
29924
29925
29926 .section "The SMTP connect ACL" "SECID191"
29927 .cindex "SMTP" "connection, ACL for"
29928 .oindex &%smtp_banner%&
29929 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
29930 session, after the test specified by &%host_reject_connection%& (which is now
29931 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
29932 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
29933 the message override the banner message that is otherwise specified by the
29934 &%smtp_banner%& option.
29935
29936
29937 .section "The EHLO/HELO ACL" "SECID192"
29938 .cindex "EHLO" "ACL for"
29939 .cindex "HELO" "ACL for"
29940 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
29941 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
29942 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
29943 Note that a client may issue more than one EHLO or HELO command in an SMTP
29944 session, and indeed is required to issue a new EHLO or HELO after successfully
29945 setting up encryption following a STARTTLS command.
29946
29947 Note also that a deny neither forces the client to go away nor means that
29948 mail will be refused on the connection.  Consider checking for
29949 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
29950
29951 If the command is accepted by an &%accept%& verb that has a &%message%&
29952 modifier, the message may not contain more than one line (it will be truncated
29953 at the first newline and a panic logged if it does). Such a message cannot
29954 affect the EHLO options that are listed on the second and subsequent lines of
29955 an EHLO response.
29956
29957
29958 .section "The DATA ACLs" "SECID193"
29959 .cindex "DATA" "ACLs for"
29960 Two ACLs are associated with the DATA command, because it is two-stage
29961 command, with two responses being sent to the client.
29962 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
29963 is obeyed. This gives you control after all the RCPT commands, but before
29964 the message itself is received. It offers the opportunity to give a negative
29965 response to the DATA command before the data is transmitted. Header lines
29966 added by MAIL or RCPT ACLs are not visible at this time, but any that
29967 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29968
29969 You cannot test the contents of the message, for example, to verify addresses
29970 in the headers, at RCPT time or when the DATA command is received. Such
29971 tests have to appear in the ACL that is run after the message itself has been
29972 received, before the final response to the DATA command is sent. This is
29973 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29974 associated with the DATA command.
29975
29976 .cindex CHUNKING "BDAT command"
29977 .cindex BDAT "SMTP command"
29978 .cindex "RFC 3030" CHUNKING
29979 If CHUNKING was advertised and a BDAT command sequence is received,
29980 the &%acl_smtp_predata%& ACL is not run.
29981 . XXX why not?  It should be possible, for the first BDAT.
29982 The &%acl_smtp_data%& is run after the last BDAT command and all of
29983 the data specified is received.
29984
29985 For both of these ACLs, it is not possible to reject individual recipients. An
29986 error response rejects the entire message. Unfortunately, it is known that some
29987 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29988 before or after the data) correctly &-- they keep the message on their queues
29989 and try again later, but that is their problem, though it does waste some of
29990 your resources.
29991
29992 The &%acl_smtp_data%& ACL is run after
29993 the &%acl_smtp_data_prdr%&,
29994 the &%acl_smtp_dkim%&
29995 and the &%acl_smtp_mime%& ACLs.
29996
29997 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29998 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29999 enabled (which is the default).
30000
30001 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
30002 received, and is executed for each DKIM signature found in a message.  If not
30003 otherwise specified, the default action is to accept.
30004
30005 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
30006
30007 For details on the operation of DKIM, see section &<<SECDKIM>>&.
30008
30009
30010 .section "The SMTP MIME ACL" "SECID194"
30011 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
30012 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
30013
30014 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30015
30016
30017 .section "The SMTP PRDR ACL" "SECTPRDRACL"
30018 .cindex "PRDR" "ACL for"
30019 .oindex "&%prdr_enable%&"
30020 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
30021 with PRDR support enabled (which is the default).
30022 It becomes active only when the PRDR feature is negotiated between
30023 client and server for a message, and more than one recipient
30024 has been accepted.
30025
30026 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
30027 has been received, and is executed once for each recipient of the message
30028 with &$local_part$& and &$domain$& valid.
30029 The test may accept, defer or deny for individual recipients.
30030 The &%acl_smtp_data%& will still be called after this ACL and
30031 can reject the message overall, even if this ACL has accepted it
30032 for some or all recipients.
30033
30034 PRDR may be used to support per-user content filtering.  Without it
30035 one must defer any recipient after the first that has a different
30036 content-filter configuration.  With PRDR, the RCPT-time check
30037 .cindex "PRDR" "variable for"
30038 for this can be disabled when the variable &$prdr_requested$&
30039 is &"yes"&.
30040 Any required difference in behaviour of the main DATA-time
30041 ACL should however depend on the PRDR-time ACL having run, as Exim
30042 will avoid doing so in some situations (e.g. single-recipient mails).
30043
30044 See also the &%prdr_enable%& global option
30045 and the &%hosts_try_prdr%& smtp transport option.
30046
30047 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
30048 If the ACL is not defined, processing completes as if
30049 the feature was not requested by the client.
30050
30051 .section "The QUIT ACL" "SECTQUITACL"
30052 .cindex "QUIT, ACL for"
30053 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
30054 does not affect the response code to QUIT, which is always 221. Thus, the ACL
30055 does not in fact control any access.
30056 For this reason, it may only accept
30057 or warn as its final result.
30058
30059 This ACL can be used for tasks such as custom logging at the end of an SMTP
30060 session. For example, you can use ACL variables in other ACLs to count
30061 messages, recipients, etc., and log the totals at QUIT time using one or
30062 more &%logwrite%& modifiers on a &%warn%& verb.
30063
30064 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
30065 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
30066
30067 You do not need to have a final &%accept%&, but if you do, you can use a
30068 &%message%& modifier to specify custom text that is sent as part of the 221
30069 response to QUIT.
30070
30071 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
30072 failure (for example, failure to open a log file, or when Exim is bombing out
30073 because it has detected an unrecoverable error), all SMTP commands from the
30074 client are given temporary error responses until QUIT is received or the
30075 connection is closed. In these special cases, the QUIT ACL does not run.
30076
30077
30078 .section "The not-QUIT ACL" "SECTNOTQUITACL"
30079 .vindex &$acl_smtp_notquit$&
30080 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
30081 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
30082 trouble, such as being unable to write to its log files, this ACL is not run,
30083 because it might try to do things (such as write to log files) that make the
30084 situation even worse.
30085
30086 Like the QUIT ACL, this ACL is provided to make it possible to do customized
30087 logging or to gather statistics, and its outcome is ignored. The &%delay%&
30088 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
30089 and &%warn%&.
30090
30091 .vindex &$smtp_notquit_reason$&
30092 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
30093 to a string that indicates the reason for the termination of the SMTP
30094 connection. The possible values are:
30095 .table2
30096 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
30097 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
30098 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
30099 .irow &`connection-lost`&          "The SMTP connection has been lost"
30100 .irow &`data-timeout`&             "Timeout while reading message data"
30101 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
30102 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
30103 .irow &`signal-exit`&              "SIGTERM or SIGINT"
30104 .irow &`synchronization-error`&    "SMTP synchronization error"
30105 .irow &`tls-failed`&               "TLS failed to start"
30106 .endtable
30107 In most cases when an SMTP connection is closed without having received QUIT,
30108 Exim sends an SMTP response message before actually closing the connection.
30109 With the exception of the &`acl-drop`& case, the default message can be
30110 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
30111 &%drop%& verb in another ACL, it is the message from the other ACL that is
30112 used.
30113
30114
30115 .section "Finding an ACL to use" "SECID195"
30116 .cindex "&ACL;" "finding which to use"
30117 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
30118 you can use different ACLs in different circumstances. For example,
30119 .code
30120 acl_smtp_rcpt = ${if ={25}{$interface_port} \
30121                      {acl_check_rcpt} {acl_check_rcpt_submit} }
30122 .endd
30123 In the default configuration file there are some example settings for
30124 providing an RFC 4409 message &"submission"& service on port 587 and
30125 an RFC 8314 &"submissions"& service on port 465. You can use a string
30126 expansion like this to choose an ACL for MUAs on these ports which is
30127 more appropriate for this purpose than the default ACL on port 25.
30128
30129 The expanded string does not have to be the name of an ACL in the
30130 configuration file; there are other possibilities. Having expanded the
30131 string, Exim searches for an ACL as follows:
30132
30133 .ilist
30134 If the string begins with a slash, Exim uses it as a filename, and reads its
30135 contents as an ACL. The lines are processed in the same way as lines in the
30136 Exim configuration file. In particular, continuation lines are supported, blank
30137 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
30138 If the file does not exist or cannot be read, an error occurs (typically
30139 causing a temporary failure of whatever caused the ACL to be run). For example:
30140 .code
30141 acl_smtp_data = /etc/acls/\
30142   ${lookup{$sender_host_address}lsearch\
30143   {/etc/acllist}{$value}{default}}
30144 .endd
30145 This looks up an ACL file to use on the basis of the host's IP address, falling
30146 back to a default if the lookup fails. If an ACL is successfully read from a
30147 file, it is retained in memory for the duration of the Exim process, so that it
30148 can be re-used without having to re-read the file.
30149 .next
30150 If the string does not start with a slash, and does not contain any spaces,
30151 Exim searches the ACL section of the configuration for an ACL whose name
30152 matches the string.
30153 .next
30154 If no named ACL is found, or if the string contains spaces, Exim parses
30155 the string as an inline ACL. This can save typing in cases where you just
30156 want to have something like
30157 .code
30158 acl_smtp_vrfy = accept
30159 .endd
30160 in order to allow free use of the VRFY command. Such a string may contain
30161 newlines; it is processed in the same way as an ACL that is read from a file.
30162 .endlist
30163
30164
30165
30166
30167 .section "ACL return codes" "SECID196"
30168 .cindex "&ACL;" "return codes"
30169 Except for the QUIT ACL, which does not affect the SMTP return code (see
30170 section &<<SECTQUITACL>>& above), the result of running an ACL is either
30171 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
30172 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
30173 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
30174 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
30175 This also causes a 4&'xx'& return code.
30176
30177 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
30178 &"deny"&, because there is no mechanism for passing temporary errors to the
30179 submitters of non-SMTP messages.
30180
30181
30182 ACLs that are relevant to message reception may also return &"discard"&. This
30183 has the effect of &"accept"&, but causes either the entire message or an
30184 individual recipient address to be discarded. In other words, it is a
30185 blackholing facility. Use it with care.
30186
30187 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
30188 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
30189 RCPT ACL is to discard just the one recipient address. If there are no
30190 recipients left when the message's data is received, the DATA ACL is not
30191 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
30192 remaining recipients. The &"discard"& return is not permitted for the
30193 &%acl_smtp_predata%& ACL.
30194
30195 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
30196 is done on the address and the result determines the SMTP response.
30197
30198
30199 .cindex "&[local_scan()]& function" "when all recipients discarded"
30200 The &[local_scan()]& function is always run, even if there are no remaining
30201 recipients; it may create new recipients.
30202
30203
30204
30205 .section "Unset ACL options" "SECID197"
30206 .cindex "&ACL;" "unset options"
30207 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
30208 all the same. &*Note*&: These defaults apply only when the relevant ACL is
30209 not defined at all. For any defined ACL, the default action when control
30210 reaches the end of the ACL statements is &"deny"&.
30211
30212 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
30213 these two are ACLs that are used only for their side effects. They cannot be
30214 used to accept or reject anything.
30215
30216 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
30217 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
30218 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
30219 when the ACL is not defined is &"accept"&.
30220
30221 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
30222 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
30223 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
30224 messages over an SMTP connection. For an example, see the ACL in the default
30225 configuration file.
30226
30227
30228
30229
30230 .section "Data for message ACLs" "SECID198"
30231 .cindex "&ACL;" "data for message ACL"
30232 .vindex &$domain$&
30233 .vindex &$local_part$&
30234 .vindex &$sender_address$&
30235 .vindex &$sender_host_address$&
30236 .vindex &$smtp_command$&
30237 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
30238 that contain information about the host and the message's sender (for example,
30239 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
30240 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
30241 &$local_part$& are set from the argument address. The entire SMTP command
30242 is available in &$smtp_command$&.
30243
30244 When an ACL for the AUTH parameter of MAIL is running, the variables that
30245 contain information about the host are set, but &$sender_address$& is not yet
30246 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
30247 how it is used.
30248
30249 .vindex "&$message_size$&"
30250 The &$message_size$& variable is set to the value of the SIZE parameter on
30251 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
30252 that parameter is not given. The value is updated to the true message size by
30253 the time the final DATA ACL is run (after the message data has been
30254 received).
30255
30256 .vindex "&$rcpt_count$&"
30257 .vindex "&$recipients_count$&"
30258 The &$rcpt_count$& variable increases by one for each RCPT command received.
30259 The &$recipients_count$& variable increases by one each time a RCPT command is
30260 accepted, so while an ACL for RCPT is being processed, it contains the number
30261 of previously accepted recipients. At DATA time (for both the DATA ACLs),
30262 &$rcpt_count$& contains the total number of RCPT commands, and
30263 &$recipients_count$& contains the total number of accepted recipients.
30264
30265
30266
30267
30268
30269 .section "Data for non-message ACLs" "SECTdatfornon"
30270 .cindex "&ACL;" "data for non-message ACL"
30271 .vindex &$smtp_command_argument$&
30272 .vindex &$smtp_command$&
30273 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
30274 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
30275 and the entire SMTP command is available in &$smtp_command$&.
30276 These variables can be tested using a &%condition%& condition. For example,
30277 here is an ACL for use with AUTH, which insists that either the session is
30278 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
30279 does not permit authentication methods that use cleartext passwords on
30280 unencrypted connections.
30281 .code
30282 acl_check_auth:
30283   accept encrypted = *
30284   accept condition = ${if eq{${uc:$smtp_command_argument}}\
30285                      {CRAM-MD5}}
30286   deny   message   = TLS encryption or CRAM-MD5 required
30287 .endd
30288 (Another way of applying this restriction is to arrange for the authenticators
30289 that use cleartext passwords not to be advertised when the connection is not
30290 encrypted. You can use the generic &%server_advertise_condition%& authenticator
30291 option to do this.)
30292
30293
30294
30295 .section "Format of an ACL" "SECID199"
30296 .cindex "&ACL;" "format of"
30297 .cindex "&ACL;" "verbs, definition of"
30298 An individual ACL consists of a number of statements. Each statement starts
30299 with a verb, optionally followed by a number of conditions and &"modifiers"&.
30300 Modifiers can change the way the verb operates, define error and log messages,
30301 set variables, insert delays, and vary the processing of accepted messages.
30302
30303 If all the conditions are met, the verb is obeyed. The same condition may be
30304 used (with different arguments) more than once in the same statement. This
30305 provides a means of specifying an &"and"& conjunction between conditions. For
30306 example:
30307 .code
30308 deny  dnslists = list1.example
30309       dnslists = list2.example
30310 .endd
30311 If there are no conditions, the verb is always obeyed. Exim stops evaluating
30312 the conditions and modifiers when it reaches a condition that fails. What
30313 happens then depends on the verb (and in one case, on a special modifier). Not
30314 all the conditions make sense at every testing point. For example, you cannot
30315 test a sender address in the ACL that is run for a VRFY command.
30316
30317
30318 .section "ACL verbs" "SECID200"
30319 The ACL verbs are as follows:
30320
30321 .ilist
30322 .cindex "&%accept%& ACL verb"
30323 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
30324 of the conditions are not met, what happens depends on whether &%endpass%&
30325 appears among the conditions (for syntax see below). If the failing condition
30326 is before &%endpass%&, control is passed to the next ACL statement; if it is
30327 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
30328 check a RCPT command:
30329 .code
30330 accept domains = +local_domains
30331        endpass
30332        verify = recipient
30333 .endd
30334 If the recipient domain does not match the &%domains%& condition, control
30335 passes to the next statement. If it does match, the recipient is verified, and
30336 the command is accepted if verification succeeds. However, if verification
30337 fails, the ACL yields &"deny"&, because the failing condition is after
30338 &%endpass%&.
30339
30340 The &%endpass%& feature has turned out to be confusing to many people, so its
30341 use is not recommended nowadays. It is always possible to rewrite an ACL so
30342 that &%endpass%& is not needed, and it is no longer used in the default
30343 configuration.
30344
30345 .cindex "&%message%& ACL modifier" "with &%accept%&"
30346 If a &%message%& modifier appears on an &%accept%& statement, its action
30347 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
30348 (when an &%accept%& verb either accepts or passes control to the next
30349 statement), &%message%& can be used to vary the message that is sent when an
30350 SMTP command is accepted. For example, in a RCPT ACL you could have:
30351 .display
30352 &`accept  `&<&'some conditions'&>
30353 &`        message = OK, I will allow you through today`&
30354 .endd
30355 You can specify an SMTP response code, optionally followed by an &"extended
30356 response code"& at the start of the message, but the first digit must be the
30357 same as would be sent by default, which is 2 for an &%accept%& verb.
30358
30359 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
30360 an error message that is used when access is denied. This behaviour is retained
30361 for backward compatibility, but current &"best practice"& is to avoid the use
30362 of &%endpass%&.
30363
30364
30365 .next
30366 .cindex "&%defer%& ACL verb"
30367 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
30368 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
30369 &%defer%& is the same as &%deny%&, because there is no way of sending a
30370 temporary error. For a RCPT command, &%defer%& is much the same as using a
30371 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
30372 be used in any ACL, and even for a recipient it might be a simpler approach.
30373
30374
30375 .next
30376 .cindex "&%deny%& ACL verb"
30377 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
30378 the conditions are not met, control is passed to the next ACL statement. For
30379 example,
30380 .code
30381 deny dnslists = blackholes.mail-abuse.org
30382 .endd
30383 rejects commands from hosts that are on a DNS black list.
30384
30385
30386 .next
30387 .cindex "&%discard%& ACL verb"
30388 &%discard%&: This verb behaves like &%accept%&, except that it returns
30389 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
30390 that are concerned with receiving messages. When all the conditions are true,
30391 the sending entity receives a &"success"& response. However, &%discard%& causes
30392 recipients to be discarded. If it is used in an ACL for RCPT, just the one
30393 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
30394 message's recipients are discarded. Recipients that are discarded before DATA
30395 do not appear in the log line when the &%received_recipients%& log selector is set.
30396
30397 If the &%log_message%& modifier is set when &%discard%& operates,
30398 its contents are added to the line that is automatically written to the log.
30399 The &%message%& modifier operates exactly as it does for &%accept%&.
30400
30401
30402 .next
30403 .cindex "&%drop%& ACL verb"
30404 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
30405 forcibly closed after the 5&'xx'& error message has been sent. For example:
30406 .code
30407 drop   condition = ${if > {$rcpt_count}{20}}
30408        message   = I don't take more than 20 RCPTs
30409 .endd
30410 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
30411 The connection is always dropped after sending a 550 response.
30412
30413 .next
30414 .cindex "&%require%& ACL verb"
30415 &%require%&: If all the conditions are met, control is passed to the next ACL
30416 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
30417 example, when checking a RCPT command,
30418 .code
30419 require message = Sender did not verify
30420         verify  = sender
30421 .endd
30422 passes control to subsequent statements only if the message's sender can be
30423 verified. Otherwise, it rejects the command. Note the positioning of the
30424 &%message%& modifier, before the &%verify%& condition. The reason for this is
30425 discussed in section &<<SECTcondmodproc>>&.
30426
30427 .next
30428 .cindex "&%warn%& ACL verb"
30429 &%warn%&: If all the conditions are true, a line specified by the
30430 &%log_message%& modifier is written to Exim's main log. Control always passes
30431 to the next ACL statement. If any condition is false, the log line is not
30432 written. If an identical log line is requested several times in the same
30433 message, only one copy is actually written to the log. If you want to force
30434 duplicates to be written, use the &%logwrite%& modifier instead.
30435
30436 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
30437 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
30438 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
30439 first failing condition. There is more about adding header lines in section
30440 &<<SECTaddheadacl>>&.
30441
30442 If any condition on a &%warn%& statement cannot be completed (that is, there is
30443 some sort of defer), the log line specified by &%log_message%& is not written.
30444 This does not include the case of a forced failure from a lookup, which
30445 is considered to be a successful completion. After a defer, no further
30446 conditions or modifiers in the &%warn%& statement are processed. The incident
30447 is logged, and the ACL continues to be processed, from the next statement
30448 onwards.
30449
30450
30451 .vindex "&$acl_verify_message$&"
30452 When one of the &%warn%& conditions is an address verification that fails, the
30453 text of the verification failure message is in &$acl_verify_message$&. If you
30454 want this logged, you must set it up explicitly. For example:
30455 .code
30456 warn   !verify = sender
30457        log_message = sender verify failed: $acl_verify_message
30458 .endd
30459 .endlist
30460
30461 At the end of each ACL there is an implicit unconditional &%deny%&.
30462
30463 As you can see from the examples above, the conditions and modifiers are
30464 written one to a line, with the first one on the same line as the verb, and
30465 subsequent ones on following lines. If you have a very long condition, you can
30466 continue it onto several physical lines by the usual backslash continuation
30467 mechanism. It is conventional to align the conditions vertically.
30468
30469
30470
30471 .section "ACL variables" "SECTaclvariables"
30472 .cindex "&ACL;" "variables"
30473 There are some special variables that can be set during ACL processing. They
30474 can be used to pass information between different ACLs, different invocations
30475 of the same ACL in the same SMTP connection, and between ACLs and the routers,
30476 transports, and filters that are used to deliver a message. The names of these
30477 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
30478 an underscore, but the remainder of the name can be any sequence of
30479 alphanumeric characters and underscores that you choose. There is no limit on
30480 the number of ACL variables. The two sets act as follows:
30481 .ilist
30482 The values of those variables whose names begin with &$acl_c$& persist
30483 throughout an SMTP connection. They are never reset. Thus, a value that is set
30484 while receiving one message is still available when receiving the next message
30485 on the same SMTP connection.
30486 .next
30487 The values of those variables whose names begin with &$acl_m$& persist only
30488 while a message is being received. They are reset afterwards. They are also
30489 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
30490 .endlist
30491
30492 When a message is accepted, the current values of all the ACL variables are
30493 preserved with the message and are subsequently made available at delivery
30494 time. The ACL variables are set by a modifier called &%set%&. For example:
30495 .code
30496 accept hosts = whatever
30497        set acl_m4 = some value
30498 accept authenticated = *
30499        set acl_c_auth = yes
30500 .endd
30501 &*Note*&: A leading dollar sign is not used when naming a variable that is to
30502 be set. If you want to set a variable without taking any action, you can use a
30503 &%warn%& verb without any other modifiers or conditions.
30504
30505 .oindex &%strict_acl_vars%&
30506 What happens if a syntactically valid but undefined ACL variable is
30507 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
30508 false (the default), an empty string is substituted; if it is true, an
30509 error is generated.
30510
30511 Versions of Exim before 4.64 have a limited set of numbered variables, but
30512 their names are compatible, so there is no problem with upgrading.
30513
30514
30515 .section "Condition and modifier processing" "SECTcondmodproc"
30516 .cindex "&ACL;" "conditions; processing"
30517 .cindex "&ACL;" "modifiers; processing"
30518 An exclamation mark preceding a condition negates its result. For example:
30519 .code
30520 deny   domains = *.dom.example
30521       !verify  = recipient
30522 .endd
30523 causes the ACL to return &"deny"& if the recipient domain ends in
30524 &'dom.example'& and the recipient address cannot be verified. Sometimes
30525 negation can be used on the right-hand side of a condition. For example, these
30526 two statements are equivalent:
30527 .code
30528 deny  hosts = !192.168.3.4
30529 deny !hosts =  192.168.3.4
30530 .endd
30531 However, for many conditions (&%verify%& being a good example), only left-hand
30532 side negation of the whole condition is possible.
30533
30534 The arguments of conditions and modifiers are expanded. A forced failure
30535 of an expansion causes a condition to be ignored, that is, it behaves as if the
30536 condition is true. Consider these two statements:
30537 .code
30538 accept  senders = ${lookup{$host_name}lsearch\
30539                   {/some/file}{$value}fail}
30540 accept  senders = ${lookup{$host_name}lsearch\
30541                   {/some/file}{$value}{}}
30542 .endd
30543 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
30544 the returned list is searched, but if the lookup fails the behaviour is
30545 different in the two cases. The &%fail%& in the first statement causes the
30546 condition to be ignored, leaving no further conditions. The &%accept%& verb
30547 therefore succeeds. The second statement, however, generates an empty list when
30548 the lookup fails. No sender can match an empty list, so the condition fails,
30549 and therefore the &%accept%& also fails.
30550
30551 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
30552 specify actions that are taken as the conditions for a statement are checked;
30553 others specify text for messages that are used when access is denied or a
30554 warning is generated. The &%control%& modifier affects the way an incoming
30555 message is handled.
30556
30557 The positioning of the modifiers in an ACL statement is important, because the
30558 processing of a verb ceases as soon as its outcome is known. Only those
30559 modifiers that have already been encountered will take effect. For example,
30560 consider this use of the &%message%& modifier:
30561 .code
30562 require message = Can't verify sender
30563         verify  = sender
30564         message = Can't verify recipient
30565         verify  = recipient
30566         message = This message cannot be used
30567 .endd
30568 If sender verification fails, Exim knows that the result of the statement is
30569 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
30570 so its text is used as the error message. If sender verification succeeds, but
30571 recipient verification fails, the second message is used. If recipient
30572 verification succeeds, the third message becomes &"current"&, but is never used
30573 because there are no more conditions to cause failure.
30574
30575 For the &%deny%& verb, on the other hand, it is always the last &%message%&
30576 modifier that is used, because all the conditions must be true for rejection to
30577 happen. Specifying more than one &%message%& modifier does not make sense, and
30578 the message can even be specified after all the conditions. For example:
30579 .code
30580 deny   hosts = ...
30581       !senders = *@my.domain.example
30582        message = Invalid sender from client host
30583 .endd
30584 The &"deny"& result does not happen until the end of the statement is reached,
30585 by which time Exim has set up the message.
30586
30587
30588
30589 .section "ACL modifiers" "SECTACLmodi"
30590 .cindex "&ACL;" "modifiers; list of"
30591 The ACL modifiers are as follows:
30592
30593 .vlist
30594 .vitem &*add_header*&&~=&~<&'text'&>
30595 This modifier specifies one or more header lines that are to be added to an
30596 incoming message, assuming, of course, that the message is ultimately
30597 accepted. For details, see section &<<SECTaddheadacl>>&.
30598
30599 .vitem &*continue*&&~=&~<&'text'&>
30600 .cindex "&%continue%& ACL modifier"
30601 .cindex "database" "updating in ACL"
30602 This modifier does nothing of itself, and processing of the ACL always
30603 continues with the next condition or modifier. The value of &%continue%& is in
30604 the side effects of expanding its argument. Typically this could be used to
30605 update a database. It is really just a syntactic tidiness, to avoid having to
30606 write rather ugly lines like this:
30607 .display
30608 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
30609 .endd
30610 Instead, all you need is
30611 .display
30612 &`continue = `&<&'some expansion'&>
30613 .endd
30614
30615 .vitem &*control*&&~=&~<&'text'&>
30616 .cindex "&%control%& ACL modifier"
30617 This modifier affects the subsequent processing of the SMTP connection or of an
30618 incoming message that is accepted. The effect of the first type of control
30619 lasts for the duration of the connection, whereas the effect of the second type
30620 lasts only until the current message has been received. The message-specific
30621 controls always apply to the whole message, not to individual recipients,
30622 even if the &%control%& modifier appears in a RCPT ACL.
30623
30624 As there are now quite a few controls that can be applied, they are described
30625 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
30626 in several different ways. For example:
30627
30628 . ==== As this is a nested list, any displays it contains must be indented
30629 . ==== as otherwise they are too far to the left. That comment applies only
30630 . ==== when xmlto and fop are used; formatting with sdop gets it right either
30631 . ==== way.
30632
30633 .ilist
30634 It can be at the end of an &%accept%& statement:
30635 .code
30636     accept  ...some conditions
30637             control = queue
30638 .endd
30639 In this case, the control is applied when this statement yields &"accept"&, in
30640 other words, when the conditions are all true.
30641
30642 .next
30643 It can be in the middle of an &%accept%& statement:
30644 .code
30645     accept  ...some conditions...
30646             control = queue
30647             ...some more conditions...
30648 .endd
30649 If the first set of conditions are true, the control is applied, even if the
30650 statement does not accept because one of the second set of conditions is false.
30651 In this case, some subsequent statement must yield &"accept"& for the control
30652 to be relevant.
30653
30654 .next
30655 It can be used with &%warn%& to apply the control, leaving the
30656 decision about accepting or denying to a subsequent verb. For
30657 example:
30658 .code
30659     warn    ...some conditions...
30660             control = freeze
30661     accept  ...
30662 .endd
30663 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
30664 &%logwrite%&, so it does not add anything to the message and does not write a
30665 log entry.
30666
30667 .next
30668 If you want to apply a control unconditionally, you can use it with a
30669 &%require%& verb. For example:
30670 .code
30671     require  control = no_multiline_responses
30672 .endd
30673 .endlist
30674
30675 .vitem &*delay*&&~=&~<&'time'&>
30676 .cindex "&%delay%& ACL modifier"
30677 .oindex "&%-bh%&"
30678 This modifier may appear in any ACL except notquit. It causes Exim to wait for
30679 the time interval before proceeding. However, when testing Exim using the
30680 &%-bh%& option, the delay is not actually imposed (an appropriate message is
30681 output instead). The time is given in the usual Exim notation, and the delay
30682 happens as soon as the modifier is processed. In an SMTP session, pending
30683 output is flushed before the delay is imposed.
30684
30685 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
30686 example:
30687 .code
30688 deny    ...some conditions...
30689         delay = 30s
30690 .endd
30691 The delay happens if all the conditions are true, before the statement returns
30692 &"deny"&. Compare this with:
30693 .code
30694 deny    delay = 30s
30695         ...some conditions...
30696 .endd
30697 which waits for 30s before processing the conditions. The &%delay%& modifier
30698 can also be used with &%warn%& and together with &%control%&:
30699 .code
30700 warn    ...some conditions...
30701         delay = 2m
30702         control = freeze
30703 accept  ...
30704 .endd
30705
30706 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
30707 responses to several commands are no longer buffered and sent in one packet (as
30708 they would normally be) because all output is flushed before imposing the
30709 delay. This optimization is disabled so that a number of small delays do not
30710 appear to the client as one large aggregated delay that might provoke an
30711 unwanted timeout. You can, however, disable output flushing for &%delay%& by
30712 using a &%control%& modifier to set &%no_delay_flush%&.
30713
30714
30715 .vitem &*endpass*&
30716 .cindex "&%endpass%& ACL modifier"
30717 This modifier, which has no argument, is recognized only in &%accept%& and
30718 &%discard%& statements. It marks the boundary between the conditions whose
30719 failure causes control to pass to the next statement, and the conditions whose
30720 failure causes the ACL to return &"deny"&. This concept has proved to be
30721 confusing to some people, so the use of &%endpass%& is no longer recommended as
30722 &"best practice"&. See the description of &%accept%& above for more details.
30723
30724
30725 .vitem &*log_message*&&~=&~<&'text'&>
30726 .cindex "&%log_message%& ACL modifier"
30727 This modifier sets up a message that is used as part of the log message if the
30728 ACL denies access or a &%warn%& statement's conditions are true. For example:
30729 .code
30730 require log_message = wrong cipher suite $tls_in_cipher
30731         encrypted   = DES-CBC3-SHA
30732 .endd
30733 &%log_message%& is also used when recipients are discarded by &%discard%&. For
30734 example:
30735 .display
30736 &`discard `&<&'some conditions'&>
30737 &`        log_message = Discarded $local_part@$domain because...`&
30738 .endd
30739 When access is denied, &%log_message%& adds to any underlying error message
30740 that may exist because of a condition failure. For example, while verifying a
30741 recipient address, a &':fail:'& redirection might have already set up a
30742 message.
30743
30744 The message may be defined before the conditions to which it applies, because
30745 the string expansion does not happen until Exim decides that access is to be
30746 denied. This means that any variables that are set by the condition are
30747 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
30748 variables are set after a DNS black list lookup succeeds. If the expansion of
30749 &%log_message%& fails, or if the result is an empty string, the modifier is
30750 ignored.
30751
30752 .vindex "&$acl_verify_message$&"
30753 If you want to use a &%warn%& statement to log the result of an address
30754 verification, you can use &$acl_verify_message$& to include the verification
30755 error message.
30756
30757 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
30758 the start of the logged message. If the same warning log message is requested
30759 more than once while receiving  a single email message, only one copy is
30760 actually logged. If you want to log multiple copies, use &%logwrite%& instead
30761 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
30762 is logged for a successful &%warn%& statement.
30763
30764 If &%log_message%& is not present and there is no underlying error message (for
30765 example, from the failure of address verification), but &%message%& is present,
30766 the &%message%& text is used for logging rejections. However, if any text for
30767 logging contains newlines, only the first line is logged. In the absence of
30768 both &%log_message%& and &%message%&, a default built-in message is used for
30769 logging rejections.
30770
30771
30772 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
30773 .cindex "&%log_reject_target%& ACL modifier"
30774 .cindex "logging in ACL" "specifying which log"
30775 This modifier makes it possible to specify which logs are used for messages
30776 about ACL rejections. Its argument is a colon-separated list of words that can
30777 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
30778 may be empty, in which case a rejection is not logged at all. For example, this
30779 ACL fragment writes no logging information when access is denied:
30780 .display
30781 &`deny `&<&'some conditions'&>
30782 &`     log_reject_target =`&
30783 .endd
30784 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
30785 permanent and temporary rejections. Its effect lasts for the rest of the
30786 current ACL.
30787
30788
30789 .vitem &*logwrite*&&~=&~<&'text'&>
30790 .cindex "&%logwrite%& ACL modifier"
30791 .cindex "logging in ACL" "immediate"
30792 This modifier writes a message to a log file as soon as it is encountered when
30793 processing an ACL. (Compare &%log_message%&, which, except in the case of
30794 &%warn%& and &%discard%&, is used only if the ACL statement denies
30795 access.) The &%logwrite%& modifier can be used to log special incidents in
30796 ACLs. For example:
30797 .display
30798 &`accept `&<&'some special conditions'&>
30799 &`       control  = freeze`&
30800 &`       logwrite = froze message because ...`&
30801 .endd
30802 By default, the message is written to the main log. However, it may begin
30803 with a colon, followed by a comma-separated list of log names, and then
30804 another colon, to specify exactly which logs are to be written. For
30805 example:
30806 .code
30807 logwrite = :main,reject: text for main and reject logs
30808 logwrite = :panic: text for panic log only
30809 .endd
30810
30811
30812 .vitem &*message*&&~=&~<&'text'&>
30813 .cindex "&%message%& ACL modifier"
30814 This modifier sets up a text string that is expanded and used as a response
30815 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
30816 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
30817 there is some complication if &%endpass%& is involved; see the description of
30818 &%accept%& for details.)
30819
30820 The expansion of the message happens at the time Exim decides that the ACL is
30821 to end, not at the time it processes &%message%&. If the expansion fails, or
30822 generates an empty string, the modifier is ignored. Here is an example where
30823 &%message%& must be specified first, because the ACL ends with a rejection if
30824 the &%hosts%& condition fails:
30825 .code
30826 require  message = Host not recognized
30827          hosts = 10.0.0.0/8
30828 .endd
30829 (Once a condition has failed, no further conditions or modifiers are
30830 processed.)
30831
30832 .cindex "SMTP" "error codes"
30833 .oindex "&%smtp_banner%&
30834 For ACLs that are triggered by SMTP commands, the message is returned as part
30835 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
30836 is meaningful only for SMTP, as no message is returned when a non-SMTP message
30837 is accepted. In the case of the connect ACL, accepting with a message modifier
30838 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
30839 accept message may not contain more than one line (otherwise it will be
30840 truncated at the first newline and a panic logged), and it cannot affect the
30841 EHLO options.
30842
30843 When SMTP is involved, the message may begin with an overriding response code,
30844 consisting of three digits optionally followed by an &"extended response code"&
30845 of the form &'n.n.n'&, each code being followed by a space. For example:
30846 .code
30847 deny  message = 599 1.2.3 Host not welcome
30848       hosts = 192.168.34.0/24
30849 .endd
30850 The first digit of the supplied response code must be the same as would be sent
30851 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
30852 access, but for the predata ACL, note that the default success code is 354, not
30853 2&'xx'&.
30854
30855 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
30856 the message modifier cannot override the 221 response code.
30857
30858 The text in a &%message%& modifier is literal; any quotes are taken as
30859 literals, but because the string is expanded, backslash escapes are processed
30860 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
30861 response.
30862
30863 .vindex "&$acl_verify_message$&"
30864 For ACLs that are called by an &%acl =%& ACL condition, the message is
30865 stored in &$acl_verify_message$&, from which the calling ACL may use it.
30866
30867 If &%message%& is used on a statement that verifies an address, the message
30868 specified overrides any message that is generated by the verification process.
30869 However, the original message is available in the variable
30870 &$acl_verify_message$&, so you can incorporate it into your message if you
30871 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
30872 routers to be passed back as part of the SMTP response, you should either not
30873 use a &%message%& modifier, or make use of &$acl_verify_message$&.
30874
30875 For compatibility with previous releases of Exim, a &%message%& modifier that
30876 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
30877 modifier, but this usage is now deprecated. However, &%message%& acts only when
30878 all the conditions are true, wherever it appears in an ACL command, whereas
30879 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
30880 &%warn%& in an ACL that is not concerned with receiving a message, it has no
30881 effect.
30882
30883
30884 .vitem &*queue*&&~=&~<&'text'&>
30885 .cindex "&%queue%& ACL modifier"
30886 .cindex "named queues" "selecting in ACL"
30887 This modifier specifies the use of a named queue for spool files
30888 for the message.
30889 It can only be used before the message is received (i.e. not in
30890 the DATA ACL).
30891 This could be used, for example, for known high-volume burst sources
30892 of traffic, or for quarantine of messages.
30893 Separate queue-runner processes will be needed for named queues.
30894 If the text after expansion is empty, the default queue is used.
30895
30896
30897 .vitem &*remove_header*&&~=&~<&'text'&>
30898 This modifier specifies one or more header names in a colon-separated list
30899  that are to be removed from an incoming message, assuming, of course, that
30900 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
30901
30902
30903 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
30904 .cindex "&%set%& ACL modifier"
30905 This modifier puts a value into one of the ACL variables (see section
30906 &<<SECTaclvariables>>&).
30907
30908
30909 .vitem &*udpsend*&&~=&~<&'parameters'&>
30910 .cindex "UDP communications"
30911 This modifier sends a UDP packet, for purposes such as statistics
30912 collection or behaviour monitoring. The parameters are expanded, and
30913 the result of the expansion must be a colon-separated list consisting
30914 of a destination server, port number, and the packet contents. The
30915 server can be specified as a host name or IPv4 or IPv6 address. The
30916 separator can be changed with the usual angle bracket syntax. For
30917 example, you might want to collect information on which hosts connect
30918 when:
30919 .code
30920 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
30921              $tod_zulu $sender_host_address
30922 .endd
30923 .endlist
30924
30925
30926
30927
30928 .section "Use of the control modifier" "SECTcontrols"
30929 .cindex "&%control%& ACL modifier"
30930 The &%control%& modifier supports the following settings:
30931
30932 .vlist
30933 .vitem &*control&~=&~allow_auth_unadvertised*&
30934 This modifier allows a client host to use the SMTP AUTH command even when it
30935 has not been advertised in response to EHLO. Furthermore, because there are
30936 apparently some really broken clients that do this, Exim will accept AUTH after
30937 HELO (rather than EHLO) when this control is set. It should be used only if you
30938 really need it, and you should limit its use to those broken clients that do
30939 not work without it. For example:
30940 .code
30941 warn hosts   = 192.168.34.25
30942      control = allow_auth_unadvertised
30943 .endd
30944 Normally, when an Exim server receives an AUTH command, it checks the name of
30945 the authentication mechanism that is given in the command to ensure that it
30946 matches an advertised mechanism. When this control is set, the check that a
30947 mechanism has been advertised is bypassed. Any configured mechanism can be used
30948 by the client. This control is permitted only in the connection and HELO ACLs.
30949
30950
30951 .vitem &*control&~=&~caseful_local_part*& &&&
30952        &*control&~=&~caselower_local_part*&
30953 .cindex "&ACL;" "case of local part in"
30954 .cindex "case of local parts"
30955 .vindex "&$local_part$&"
30956 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
30957 (that is, during RCPT processing). By default, the contents of &$local_part$&
30958 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
30959 any uppercase letters in the original local part are restored in &$local_part$&
30960 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
30961 is encountered.
30962
30963 These controls affect only the current recipient. Moreover, they apply only to
30964 local part handling that takes place directly in the ACL (for example, as a key
30965 in lookups). If a test to verify the recipient is obeyed, the case-related
30966 handling of the local part during the verification is controlled by the router
30967 configuration (see the &%caseful_local_part%& generic router option).
30968
30969 This facility could be used, for example, to add a spam score to local parts
30970 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30971 spam score:
30972 .code
30973 warn  control = caseful_local_part
30974       set acl_m4 = ${eval:\
30975                      $acl_m4 + \
30976                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30977                     }
30978       control = caselower_local_part
30979 .endd
30980 Notice that we put back the lower cased version afterwards, assuming that
30981 is what is wanted for subsequent tests.
30982
30983
30984 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30985 .cindex "&ACL;" "cutthrough routing"
30986 .cindex "cutthrough" "requesting"
30987 This option requests delivery be attempted while the item is being received.
30988
30989 The option is usable in the RCPT ACL.
30990 If enabled for a message received via smtp and routed to an smtp transport,
30991 and only one transport, interface, destination host and port combination
30992 is used for all recipients of the message,
30993 then the delivery connection is made while the receiving connection is open
30994 and data is copied from one to the other.
30995
30996 An attempt to set this option for any recipient but the first
30997 for a mail will be quietly ignored.
30998 If a recipient-verify callout
30999 (with use_sender)
31000 connection is subsequently
31001 requested in the same ACL it is held open and used for
31002 any subsequent recipients and the data,
31003 otherwise one is made after the initial RCPT ACL completes.
31004
31005 Note that routers are used in verify mode,
31006 and cannot depend on content of received headers.
31007 Note also that headers cannot be
31008 modified by any of the post-data ACLs (DATA, MIME and DKIM).
31009 Headers may be modified by routers (subject to the above) and transports.
31010 The &'Received-By:'& header is generated as soon as the body reception starts,
31011 rather than the traditional time after the full message is received;
31012 this will affect the timestamp.
31013
31014 All the usual ACLs are called; if one results in the message being
31015 rejected, all effort spent in delivery (including the costs on
31016 the ultimate destination) will be wasted.
31017 Note that in the case of data-time ACLs this includes the entire
31018 message body.
31019
31020 Cutthrough delivery is not supported via transport-filters or when DKIM signing
31021 of outgoing messages is done, because it sends data to the ultimate destination
31022 before the entire message has been received from the source.
31023 It is not supported for messages received with the SMTP PRDR
31024 or CHUNKING
31025 options in use.
31026
31027 Should the ultimate destination system positively accept or reject the mail,
31028 a corresponding indication is given to the source system and nothing is queued.
31029 If the item is successfully delivered in cutthrough mode
31030 the delivery log lines are tagged with ">>" rather than "=>" and appear
31031 before the acceptance "<=" line.
31032
31033 If there is a temporary error the item is queued for later delivery in the
31034 usual fashion.
31035 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
31036 to the control; the default value is &"spool"& and the alternate value
31037 &"pass"& copies an SMTP defer response from the target back to the initiator
31038 and does not queue the message.
31039 Note that this is independent of any recipient verify conditions in the ACL.
31040
31041 Delivery in this mode avoids the generation of a bounce mail to a
31042 (possibly faked)
31043 sender when the destination system is doing content-scan based rejection.
31044
31045
31046 .vitem &*control&~=&~debug/*&<&'options'&>
31047 .cindex "&ACL;" "enabling debug logging"
31048 .cindex "debugging" "enabling from an ACL"
31049 This control turns on debug logging, almost as though Exim had been invoked
31050 with &`-d`&, with the output going to a new logfile in the usual logs directory,
31051 by default called &'debuglog'&.
31052 The filename can be adjusted with the &'tag'& option, which
31053 may access any variables already defined.  The logging may be adjusted with
31054 the &'opts'& option, which takes the same values as the &`-d`& command-line
31055 option.
31056 Logging started this way may be stopped, and the file removed,
31057 with the &'kill'& option.
31058 Some examples (which depend on variables that don't exist in all
31059 contexts):
31060 .code
31061       control = debug
31062       control = debug/tag=.$sender_host_address
31063       control = debug/opts=+expand+acl
31064       control = debug/tag=.$message_exim_id/opts=+expand
31065       control = debug/kill
31066 .endd
31067
31068
31069 .vitem &*control&~=&~dkim_disable_verify*&
31070 .cindex "disable DKIM verify"
31071 .cindex "DKIM" "disable verify"
31072 This control turns off DKIM verification processing entirely.  For details on
31073 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
31074
31075
31076 .vitem &*control&~=&~dmarc_disable_verify*&
31077 .cindex "disable DMARC verify"
31078 .cindex "DMARC" "disable verify"
31079 This control turns off DMARC verification processing entirely.  For details on
31080 the operation and configuration of DMARC, see section &<<SECDMARC>>&.
31081
31082
31083 .vitem &*control&~=&~dscp/*&<&'value'&>
31084 .cindex "&ACL;" "setting DSCP value"
31085 .cindex "DSCP" "inbound"
31086 This option causes the DSCP value associated with the socket for the inbound
31087 connection to be adjusted to a given value, given as one of a number of fixed
31088 strings or to numeric value.
31089 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
31090 Common values include &`throughput`&, &`mincost`&, and on newer systems
31091 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
31092
31093 The outbound packets from Exim will be marked with this value in the header
31094 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
31095 that these values will have any effect, not be stripped by networking
31096 equipment, or do much of anything without cooperation with your Network
31097 Engineer and those of all network operators between the source and destination.
31098
31099
31100 .vitem &*control&~=&~enforce_sync*& &&&
31101        &*control&~=&~no_enforce_sync*&
31102 .cindex "SMTP" "synchronization checking"
31103 .cindex "synchronization checking in SMTP"
31104 These controls make it possible to be selective about when SMTP synchronization
31105 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
31106 state of the switch (it is true by default). See the description of this option
31107 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
31108
31109 The effect of these two controls lasts for the remainder of the SMTP
31110 connection. They can appear in any ACL except the one for the non-SMTP
31111 messages. The most straightforward place to put them is in the ACL defined by
31112 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
31113 before the first synchronization check. The expected use is to turn off the
31114 synchronization checks for badly-behaved hosts that you nevertheless need to
31115 work with.
31116
31117
31118 .vitem &*control&~=&~fakedefer/*&<&'message'&>
31119 .cindex "fake defer"
31120 .cindex "defer, fake"
31121 This control works in exactly the same way as &%fakereject%& (described below)
31122 except that it causes an SMTP 450 response after the message data instead of a
31123 550 response. You must take care when using &%fakedefer%& because it causes the
31124 messages to be duplicated when the sender retries. Therefore, you should not
31125 use &%fakedefer%& if the message is to be delivered normally.
31126
31127 .vitem &*control&~=&~fakereject/*&<&'message'&>
31128 .cindex "fake rejection"
31129 .cindex "rejection, fake"
31130 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
31131 words, only when an SMTP message is being received. If Exim accepts the
31132 message, instead the final 250 response, a 550 rejection message is sent.
31133 However, Exim proceeds to deliver the message as normal. The control applies
31134 only to the current message, not to any subsequent ones that may be received in
31135 the same SMTP connection.
31136
31137 The text for the 550 response is taken from the &%control%& modifier. If no
31138 message is supplied, the following is used:
31139 .code
31140 550-Your message has been rejected but is being
31141 550-kept for evaluation.
31142 550-If it was a legitimate message, it may still be
31143 550 delivered to the target recipient(s).
31144 .endd
31145 This facility should be used with extreme caution.
31146
31147 .vitem &*control&~=&~freeze*&
31148 .cindex "frozen messages" "forcing in ACL"
31149 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31150 other words, only when a message is being received. If the message is accepted,
31151 it is placed on Exim's queue and frozen. The control applies only to the
31152 current message, not to any subsequent ones that may be received in the same
31153 SMTP connection.
31154
31155 This modifier can optionally be followed by &`/no_tell`&. If the global option
31156 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
31157 is told about the freezing), provided all the &*control=freeze*& modifiers that
31158 are obeyed for the current message have the &`/no_tell`& option.
31159
31160 .vitem &*control&~=&~no_delay_flush*&
31161 .cindex "SMTP" "output flushing, disabling for delay"
31162 Exim normally flushes SMTP output before implementing a delay in an ACL, to
31163 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31164 use. This control, as long as it is encountered before the &%delay%& modifier,
31165 disables such output flushing.
31166
31167 .vitem &*control&~=&~no_callout_flush*&
31168 .cindex "SMTP" "output flushing, disabling for callout"
31169 Exim normally flushes SMTP output before performing a callout in an ACL, to
31170 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
31171 use. This control, as long as it is encountered before the &%verify%& condition
31172 that causes the callout, disables such output flushing.
31173
31174 .vitem &*control&~=&~no_mbox_unspool*&
31175 This control is available when Exim is compiled with the content scanning
31176 extension. Content scanning may require a copy of the current message, or parts
31177 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
31178 or spam scanner. Normally, such copies are deleted when they are no longer
31179 needed. If this control is set, the copies are not deleted. The control applies
31180 only to the current message, not to any subsequent ones that may be received in
31181 the same SMTP connection. It is provided for debugging purposes and is unlikely
31182 to be useful in production.
31183
31184 .vitem &*control&~=&~no_multiline_responses*&
31185 .cindex "multiline responses, suppressing"
31186 This control is permitted for any ACL except the one for non-SMTP messages.
31187 It seems that there are broken clients in use that cannot handle multiline
31188 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
31189
31190 If this control is set, multiline SMTP responses from ACL rejections are
31191 suppressed. One way of doing this would have been to put out these responses as
31192 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
31193 (&"use multiline responses for more"& it says &-- ha!), and some of the
31194 responses might get close to that. So this facility, which is after all only a
31195 sop to broken clients, is implemented by doing two very easy things:
31196
31197 .ilist
31198 Extra information that is normally output as part of a rejection caused by
31199 sender verification failure is omitted. Only the final line (typically &"sender
31200 verification failed"&) is sent.
31201 .next
31202 If a &%message%& modifier supplies a multiline response, only the first
31203 line is output.
31204 .endlist
31205
31206 The setting of the switch can, of course, be made conditional on the
31207 calling host. Its effect lasts until the end of the SMTP connection.
31208
31209 .vitem &*control&~=&~no_pipelining*&
31210 .cindex "PIPELINING" "suppressing advertising"
31211 .cindex "ESMTP extensions" PIPELINING
31212 This control turns off the advertising of the PIPELINING extension to SMTP in
31213 the current session. To be useful, it must be obeyed before Exim sends its
31214 response to an EHLO command. Therefore, it should normally appear in an ACL
31215 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
31216 &%pipelining_advertise_hosts%&.
31217
31218 .vitem &*control&~=&~queue/*&<&'options'&>* &&&
31219        &*control&~=&~queue_only*&
31220 .oindex "&%queue%&"
31221 .oindex "&%queue_only%&"
31222 .cindex "queueing incoming messages"
31223 .cindex queueing "forcing in ACL"
31224 .cindex "first pass routing"
31225 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
31226 other words, only when a message is being received. If the message is accepted,
31227 it is placed on Exim's queue and left there for delivery by a subsequent queue
31228 runner.
31229 If used with no options set,
31230 no immediate delivery process is started. In other words, it has the
31231 effect as the &%queue_only%& global option or &'-odq'& command-line option.
31232
31233 If the &'first_pass_route'& option is given then
31234 the behaviour is like the command-line &'-oqds'& option;
31235 a delivery process is started which stops short of making
31236 any SMTP delivery.  The benefit is that the hints database will be updated for
31237 the message being waiting for a specific host, and a later queue run will be
31238 able to send all such messages on a single connection.
31239
31240 The control only applies to the current message, not to any subsequent ones that
31241  may be received in the same SMTP connection.
31242
31243 .vitem &*control&~=&~submission/*&<&'options'&>
31244 .cindex "message" "submission"
31245 .cindex "submission mode"
31246 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
31247 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
31248 the current message is a submission from a local MUA. In this case, Exim
31249 operates in &"submission mode"&, and applies certain fixups to the message if
31250 necessary. For example, it adds a &'Date:'& header line if one is not present.
31251 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
31252 late (the message has already been created).
31253
31254 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
31255 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
31256 submission mode; the available options for this control are described there.
31257 The control applies only to the current message, not to any subsequent ones
31258 that may be received in the same SMTP connection.
31259
31260 .vitem &*control&~=&~suppress_local_fixups*&
31261 .cindex "submission fixups, suppressing"
31262 This control applies to locally submitted (non TCP/IP) messages, and is the
31263 complement of &`control = submission`&. It disables the fixups that are
31264 normally applied to locally-submitted messages. Specifically:
31265
31266 .ilist
31267 Any &'Sender:'& header line is left alone (in this respect, it is a
31268 dynamic version of &%local_sender_retain%&).
31269 .next
31270 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
31271 .next
31272 There is no check that &'From:'& corresponds to the actual sender.
31273 .endlist ilist
31274
31275 This control may be useful when a remotely-originated message is accepted,
31276 passed to some scanning program, and then re-submitted for delivery. It can be
31277 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31278 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
31279 data is read.
31280
31281 &*Note:*& This control applies only to the current message, not to any others
31282 that are being submitted at the same time using &%-bs%& or &%-bS%&.
31283
31284 .vitem &*control&~=&~utf8_downconvert*&
31285 This control enables conversion of UTF-8 in message envelope addresses
31286 to a-label form.
31287 For details see section &<<SECTi18nMTA>>&.
31288 .endlist vlist
31289
31290
31291 .section "Summary of message fixup control" "SECTsummesfix"
31292 All four possibilities for message fixups can be specified:
31293
31294 .ilist
31295 Locally submitted, fixups applied: the default.
31296 .next
31297 Locally submitted, no fixups applied: use
31298 &`control = suppress_local_fixups`&.
31299 .next
31300 Remotely submitted, no fixups applied: the default.
31301 .next
31302 Remotely submitted, fixups applied: use &`control = submission`&.
31303 .endlist
31304
31305
31306
31307 .section "Adding header lines in ACLs" "SECTaddheadacl"
31308 .cindex "header lines" "adding in an ACL"
31309 .cindex "header lines" "position of added lines"
31310 .cindex "&%add_header%& ACL modifier"
31311 The &%add_header%& modifier can be used to add one or more extra header lines
31312 to an incoming message, as in this example:
31313 .code
31314 warn dnslists = sbl.spamhaus.org : \
31315                 dialup.mail-abuse.org
31316      add_header = X-blacklisted-at: $dnslist_domain
31317 .endd
31318 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31319 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31320 receiving a message). The message must ultimately be accepted for
31321 &%add_header%& to have any significant effect. You can use &%add_header%& with
31322 any ACL verb, including &%deny%& (though this is potentially useful only in a
31323 RCPT ACL).
31324
31325 Headers will not be added to the message if the modifier is used in
31326 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31327
31328 Leading and trailing newlines are removed from
31329 the data for the &%add_header%& modifier; if it then
31330 contains one or more newlines that
31331 are not followed by a space or a tab, it is assumed to contain multiple header
31332 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
31333 front of any line that is not a valid header line.
31334
31335 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
31336 They are added to the message before processing the DATA and MIME ACLs.
31337 However, if an identical header line is requested more than once, only one copy
31338 is actually added to the message. Further header lines may be accumulated
31339 during the DATA and MIME ACLs, after which they are added to the message, again
31340 with duplicates suppressed. Thus, it is possible to add two identical header
31341 lines to an SMTP message, but only if one is added before DATA and one after.
31342 In the case of non-SMTP messages, new headers are accumulated during the
31343 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
31344 message is rejected after DATA or by the non-SMTP ACL, all added header lines
31345 are included in the entry that is written to the reject log.
31346
31347 .cindex "header lines" "added; visibility of"
31348 Header lines are not visible in string expansions
31349 of message headers
31350 until they are added to the
31351 message. It follows that header lines defined in the MAIL, RCPT, and predata
31352 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
31353 header lines that are added by the DATA or MIME ACLs are not visible in those
31354 ACLs. Because of this restriction, you cannot use header lines as a way of
31355 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
31356 this, you can use ACL variables, as described in section
31357 &<<SECTaclvariables>>&.
31358
31359 The list of headers yet to be added is given by the &%$headers_added%& variable.
31360
31361 The &%add_header%& modifier acts immediately as it is encountered during the
31362 processing of an ACL. Notice the difference between these two cases:
31363 .display
31364 &`accept add_header = ADDED: some text`&
31365 &`       `&<&'some condition'&>
31366
31367 &`accept `&<&'some condition'&>
31368 &`       add_header = ADDED: some text`&
31369 .endd
31370 In the first case, the header line is always added, whether or not the
31371 condition is true. In the second case, the header line is added only if the
31372 condition is true. Multiple occurrences of &%add_header%& may occur in the same
31373 ACL statement. All those that are encountered before a condition fails are
31374 honoured.
31375
31376 .cindex "&%warn%& ACL verb"
31377 For compatibility with previous versions of Exim, a &%message%& modifier for a
31378 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
31379 effect only if all the conditions are true, even if it appears before some of
31380 them. Furthermore, only the last occurrence of &%message%& is honoured. This
31381 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
31382 are present on a &%warn%& verb, both are processed according to their
31383 specifications.
31384
31385 By default, new header lines are added to a message at the end of the existing
31386 header lines. However, you can specify that any particular header line should
31387 be added right at the start (before all the &'Received:'& lines), immediately
31388 after the first block of &'Received:'& lines, or immediately before any line
31389 that is not a &'Received:'& or &'Resent-something:'& header.
31390
31391 This is done by specifying &":at_start:"&, &":after_received:"&, or
31392 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
31393 header line, respectively. (Header text cannot start with a colon, as there has
31394 to be a header name first.) For example:
31395 .code
31396 warn add_header = \
31397        :after_received:X-My-Header: something or other...
31398 .endd
31399 If more than one header line is supplied in a single &%add_header%& modifier,
31400 each one is treated independently and can therefore be placed differently. If
31401 you add more than one line at the start, or after the Received: block, they end
31402 up in reverse order.
31403
31404 &*Warning*&: This facility currently applies only to header lines that are
31405 added in an ACL. It does NOT work for header lines that are added in a
31406 system filter or in a router or transport.
31407
31408
31409
31410 .section "Removing header lines in ACLs" "SECTremoveheadacl"
31411 .cindex "header lines" "removing in an ACL"
31412 .cindex "header lines" "position of removed lines"
31413 .cindex "&%remove_header%& ACL modifier"
31414 The &%remove_header%& modifier can be used to remove one or more header lines
31415 from an incoming message, as in this example:
31416 .code
31417 warn   message        = Remove internal headers
31418        remove_header  = x-route-mail1 : x-route-mail2
31419 .endd
31420 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
31421 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
31422 receiving a message). The message must ultimately be accepted for
31423 &%remove_header%& to have any significant effect. You can use &%remove_header%&
31424 with any ACL verb, including &%deny%&, though this is really not useful for
31425 any verb that doesn't result in a delivered message.
31426
31427 Headers will not be removed from the message if the modifier is used in
31428 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
31429
31430 More than one header can be removed at the same time by using a colon separated
31431 list of header names. The header matching is case insensitive. Wildcards are
31432 not permitted, nor is list expansion performed, so you cannot use hostlists to
31433 create a list of headers, however both connection and message variable expansion
31434 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
31435 .code
31436 warn   hosts           = +internal_hosts
31437        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
31438 warn   message         = Remove internal headers
31439        remove_header   = $acl_c_ihdrs
31440 .endd
31441 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
31442 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
31443 If multiple header lines match, all are removed.
31444 There is no harm in attempting to remove the same header twice nor in removing
31445 a non-existent header. Further header lines to be removed may be accumulated
31446 during the DATA and MIME ACLs, after which they are removed from the message,
31447 if present. In the case of non-SMTP messages, headers to be removed are
31448 accumulated during the non-SMTP ACLs, and are removed from the message after
31449 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
31450 ACL, there really is no effect because there is no logging of what headers
31451 would have been removed.
31452
31453 .cindex "header lines" "removed; visibility of"
31454 Header lines are not visible in string expansions until the DATA phase when it
31455 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
31456 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
31457 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
31458 this restriction, you cannot use header lines as a way of controlling data
31459 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
31460 you should instead use ACL variables, as described in section
31461 &<<SECTaclvariables>>&.
31462
31463 The &%remove_header%& modifier acts immediately as it is encountered during the
31464 processing of an ACL. Notice the difference between these two cases:
31465 .display
31466 &`accept remove_header = X-Internal`&
31467 &`       `&<&'some condition'&>
31468
31469 &`accept `&<&'some condition'&>
31470 &`       remove_header = X-Internal`&
31471 .endd
31472 In the first case, the header line is always removed, whether or not the
31473 condition is true. In the second case, the header line is removed only if the
31474 condition is true. Multiple occurrences of &%remove_header%& may occur in the
31475 same ACL statement. All those that are encountered before a condition fails
31476 are honoured.
31477
31478 &*Warning*&: This facility currently applies only to header lines that are
31479 present during ACL processing. It does NOT remove header lines that are added
31480 in a system filter or in a router or transport.
31481
31482
31483
31484
31485 .section "ACL conditions" "SECTaclconditions"
31486 .cindex "&ACL;" "conditions; list of"
31487 Some of the conditions listed in this section are available only when Exim is
31488 compiled with the content-scanning extension. They are included here briefly
31489 for completeness. More detailed descriptions can be found in the discussion on
31490 content scanning in chapter &<<CHAPexiscan>>&.
31491
31492 Not all conditions are relevant in all circumstances. For example, testing
31493 senders and recipients does not make sense in an ACL that is being run as the
31494 result of the arrival of an ETRN command, and checks on message headers can be
31495 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
31496 can use the same condition (with different parameters) more than once in the
31497 same ACL statement. This provides a way of specifying an &"and"& conjunction.
31498 The conditions are as follows:
31499
31500
31501 .vlist
31502 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
31503 .cindex "&ACL;" "nested"
31504 .cindex "&ACL;" "indirect"
31505 .cindex "&ACL;" "arguments"
31506 .cindex "&%acl%& ACL condition"
31507 The possible values of the argument are the same as for the
31508 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
31509 &"accept"& the condition is true; if it returns &"deny"& the condition is
31510 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
31511 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
31512 condition false. This means that further processing of the &%warn%& verb
31513 ceases, but processing of the ACL continues.
31514
31515 If the argument is a named ACL, up to nine space-separated optional values
31516 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
31517 and $acl_narg is set to the count of values.
31518 Previous values of these variables are restored after the call returns.
31519 The name and values are expanded separately.
31520 Note that spaces in complex expansions which are used as arguments
31521 will act as argument separators.
31522
31523 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
31524 the connection is dropped. If it returns &"discard"&, the verb must be
31525 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
31526 conditions are tested.
31527
31528 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
31529 loops. This condition allows you to use different ACLs in different
31530 circumstances. For example, different ACLs can be used to handle RCPT commands
31531 for different local users or different local domains.
31532
31533 .vitem &*authenticated&~=&~*&<&'string&~list'&>
31534 .cindex "&%authenticated%& ACL condition"
31535 .cindex "authentication" "ACL checking"
31536 .cindex "&ACL;" "testing for authentication"
31537 If the SMTP connection is not authenticated, the condition is false. Otherwise,
31538 the name of the authenticator is tested against the list. To test for
31539 authentication by any authenticator, you can set
31540 .code
31541 authenticated = *
31542 .endd
31543
31544 .vitem &*condition&~=&~*&<&'string'&>
31545 .cindex "&%condition%& ACL condition"
31546 .cindex "customizing" "ACL condition"
31547 .cindex "&ACL;" "customized test"
31548 .cindex "&ACL;" "testing, customized"
31549 This feature allows you to make up custom conditions. If the result of
31550 expanding the string is an empty string, the number zero, or one of the strings
31551 &"no"& or &"false"&, the condition is false. If the result is any non-zero
31552 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
31553 any other value, some error is assumed to have occurred, and the ACL returns
31554 &"defer"&. However, if the expansion is forced to fail, the condition is
31555 ignored. The effect is to treat it as true, whether it is positive or
31556 negative.
31557
31558 .vitem &*decode&~=&~*&<&'location'&>
31559 .cindex "&%decode%& ACL condition"
31560 This condition is available only when Exim is compiled with the
31561 content-scanning extension, and it is allowed only in the ACL defined by
31562 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
31563 If all goes well, the condition is true. It is false only if there are
31564 problems such as a syntax error or a memory shortage. For more details, see
31565 chapter &<<CHAPexiscan>>&.
31566
31567 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
31568 .cindex "&%dnslists%& ACL condition"
31569 .cindex "DNS list" "in ACL"
31570 .cindex "black list (DNS)"
31571 .cindex "&ACL;" "testing a DNS list"
31572 This condition checks for entries in DNS black lists. These are also known as
31573 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
31574 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
31575 different variants of this condition to describe briefly here. See sections
31576 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
31577
31578 .vitem &*domains&~=&~*&<&'domain&~list'&>
31579 .cindex "&%domains%& ACL condition"
31580 .cindex "domain" "ACL checking"
31581 .cindex "&ACL;" "testing a recipient domain"
31582 .vindex "&$domain_data$&"
31583 This condition is relevant only after a RCPT command. It checks that the domain
31584 of the recipient address is in the domain list. If percent-hack processing is
31585 enabled, it is done before this test is done. If the check succeeds with a
31586 lookup, the result of the lookup is placed in &$domain_data$& until the next
31587 &%domains%& test.
31588
31589 &*Note carefully*& (because many people seem to fall foul of this): you cannot
31590 use &%domains%& in a DATA ACL.
31591
31592
31593 .vitem &*encrypted&~=&~*&<&'string&~list'&>
31594 .cindex "&%encrypted%& ACL condition"
31595 .cindex "encryption" "checking in an ACL"
31596 .cindex "&ACL;" "testing for encryption"
31597 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
31598 name of the cipher suite in use is tested against the list. To test for
31599 encryption without testing for any specific cipher suite(s), set
31600 .code
31601 encrypted = *
31602 .endd
31603
31604
31605 .vitem &*hosts&~=&~*&<&'host&~list'&>
31606 .cindex "&%hosts%& ACL condition"
31607 .cindex "host" "ACL checking"
31608 .cindex "&ACL;" "testing the client host"
31609 This condition tests that the calling host matches the host list. If you have
31610 name lookups or wildcarded host names and IP addresses in the same host list,
31611 you should normally put the IP addresses first. For example, you could have:
31612 .code
31613 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
31614 .endd
31615 The lookup in this example uses the host name for its key. This is implied by
31616 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
31617 and it wouldn't matter which way round you had these two items.)
31618
31619 The reason for the problem with host names lies in the left-to-right way that
31620 Exim processes lists. It can test IP addresses without doing any DNS lookups,
31621 but when it reaches an item that requires a host name, it fails if it cannot
31622 find a host name to compare with the pattern. If the above list is given in the
31623 opposite order, the &%accept%& statement fails for a host whose name cannot be
31624 found, even if its IP address is 10.9.8.7.
31625
31626 If you really do want to do the name check first, and still recognize the IP
31627 address even if the name lookup fails, you can rewrite the ACL like this:
31628 .code
31629 accept hosts = dbm;/etc/friendly/hosts
31630 accept hosts = 10.9.8.7
31631 .endd
31632 The default action on failing to find the host name is to assume that the host
31633 is not in the list, so the first &%accept%& statement fails. The second
31634 statement can then check the IP address.
31635
31636 .vindex "&$host_data$&"
31637 If a &%hosts%& condition is satisfied by means of a lookup, the result
31638 of the lookup is made available in the &$host_data$& variable. This
31639 allows you, for example, to set up a statement like this:
31640 .code
31641 deny  hosts = net-lsearch;/some/file
31642       message = $host_data
31643 .endd
31644 which gives a custom error message for each denied host.
31645
31646 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
31647 .cindex "&%local_parts%& ACL condition"
31648 .cindex "local part" "ACL checking"
31649 .cindex "&ACL;" "testing a local part"
31650 .vindex "&$local_part_data$&"
31651 This condition is relevant only after a RCPT command. It checks that the local
31652 part of the recipient address is in the list. If percent-hack processing is
31653 enabled, it is done before this test. If the check succeeds with a lookup, the
31654 result of the lookup is placed in &$local_part_data$&, which remains set until
31655 the next &%local_parts%& test.
31656
31657 .vitem &*malware&~=&~*&<&'option'&>
31658 .cindex "&%malware%& ACL condition"
31659 .cindex "&ACL;" "virus scanning"
31660 .cindex "&ACL;" "scanning for viruses"
31661 This condition is available only when Exim is compiled with the
31662 content-scanning extension
31663 and only after a DATA command.
31664 It causes the incoming message to be scanned for
31665 viruses. For details, see chapter &<<CHAPexiscan>>&.
31666
31667 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31668 .cindex "&%mime_regex%& ACL condition"
31669 .cindex "&ACL;" "testing by regex matching"
31670 This condition is available only when Exim is compiled with the
31671 content-scanning extension, and it is allowed only in the ACL defined by
31672 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
31673 with any of the regular expressions. For details, see chapter
31674 &<<CHAPexiscan>>&.
31675
31676 .vitem &*ratelimit&~=&~*&<&'parameters'&>
31677 .cindex "rate limiting"
31678 This condition can be used to limit the rate at which a user or host submits
31679 messages. Details are given in section &<<SECTratelimiting>>&.
31680
31681 .vitem &*recipients&~=&~*&<&'address&~list'&>
31682 .cindex "&%recipients%& ACL condition"
31683 .cindex "recipient" "ACL checking"
31684 .cindex "&ACL;" "testing a recipient"
31685 This condition is relevant only after a RCPT command. It checks the entire
31686 recipient address against a list of recipients.
31687
31688 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
31689 .cindex "&%regex%& ACL condition"
31690 .cindex "&ACL;" "testing by regex matching"
31691 This condition is available only when Exim is compiled with the
31692 content-scanning extension, and is available only in the DATA, MIME, and
31693 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
31694 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
31695
31696 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
31697 .cindex "&%sender_domains%& ACL condition"
31698 .cindex "sender" "ACL checking"
31699 .cindex "&ACL;" "testing a sender domain"
31700 .vindex "&$domain$&"
31701 .vindex "&$sender_address_domain$&"
31702 This condition tests the domain of the sender of the message against the given
31703 domain list. &*Note*&: The domain of the sender address is in
31704 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
31705 of this condition. This is an exception to the general rule for testing domain
31706 lists. It is done this way so that, if this condition is used in an ACL for a
31707 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
31708 influence the sender checking.
31709
31710 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31711 relaying, because sender addresses are easily, and commonly, forged.
31712
31713 .vitem &*senders&~=&~*&<&'address&~list'&>
31714 .cindex "&%senders%& ACL condition"
31715 .cindex "sender" "ACL checking"
31716 .cindex "&ACL;" "testing a sender"
31717 This condition tests the sender of the message against the given list. To test
31718 for a bounce message, which has an empty sender, set
31719 .code
31720 senders = :
31721 .endd
31722 &*Warning*&: It is a bad idea to use this condition on its own as a control on
31723 relaying, because sender addresses are easily, and commonly, forged.
31724
31725 .vitem &*spam&~=&~*&<&'username'&>
31726 .cindex "&%spam%& ACL condition"
31727 .cindex "&ACL;" "scanning for spam"
31728 This condition is available only when Exim is compiled with the
31729 content-scanning extension. It causes the incoming message to be scanned by
31730 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
31731
31732 .vitem &*verify&~=&~certificate*&
31733 .cindex "&%verify%& ACL condition"
31734 .cindex "TLS" "client certificate verification"
31735 .cindex "certificate" "verification of client"
31736 .cindex "&ACL;" "certificate verification"
31737 .cindex "&ACL;" "testing a TLS certificate"
31738 This condition is true in an SMTP session if the session is encrypted, and a
31739 certificate was received from the client, and the certificate was verified. The
31740 server requests a certificate only if the client matches &%tls_verify_hosts%&
31741 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
31742
31743 .vitem &*verify&~=&~csa*&
31744 .cindex "CSA verification"
31745 This condition checks whether the sending host (the client) is authorized to
31746 send email. Details of how this works are given in section
31747 &<<SECTverifyCSA>>&.
31748
31749 .vitem &*verify&~=&~header_names_ascii*&
31750 .cindex "&%verify%& ACL condition"
31751 .cindex "&ACL;" "verifying header names only ASCII"
31752 .cindex "header lines" "verifying header names only ASCII"
31753 .cindex "verifying" "header names only ASCII"
31754 This condition is relevant only in an ACL that is run after a message has been
31755 received, that is, in an ACL specified by &%acl_smtp_data%& or
31756 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
31757 there are no non-ASCII characters, also excluding control characters.  The
31758 allowable characters are decimal ASCII values 33 through 126.
31759
31760 Exim itself will handle headers with non-ASCII characters, but it can cause
31761 problems for downstream applications, so this option will allow their
31762 detection and rejection in the DATA ACL's.
31763
31764 .vitem &*verify&~=&~header_sender/*&<&'options'&>
31765 .cindex "&%verify%& ACL condition"
31766 .cindex "&ACL;" "verifying sender in the header"
31767 .cindex "header lines" "verifying the sender in"
31768 .cindex "sender" "verifying in header"
31769 .cindex "verifying" "sender in header"
31770 This condition is relevant only in an ACL that is run after a message has been
31771 received, that is, in an ACL specified by &%acl_smtp_data%& or
31772 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
31773 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
31774 is loosely thought of as a &"sender"& address (hence the name of the test).
31775 However, an address that appears in one of these headers need not be an address
31776 that accepts bounce messages; only sender addresses in envelopes are required
31777 to accept bounces. Therefore, if you use the callout option on this check, you
31778 might want to arrange for a non-empty address in the MAIL command.
31779
31780 Details of address verification and the options are given later, starting at
31781 section &<<SECTaddressverification>>& (callouts are described in section
31782 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
31783 condition to restrict it to bounce messages only:
31784 .code
31785 deny    senders = :
31786        !verify  = header_sender
31787         message = A valid sender header is required for bounces
31788 .endd
31789
31790 .vitem &*verify&~=&~header_syntax*&
31791 .cindex "&%verify%& ACL condition"
31792 .cindex "&ACL;" "verifying header syntax"
31793 .cindex "header lines" "verifying syntax"
31794 .cindex "verifying" "header syntax"
31795 This condition is relevant only in an ACL that is run after a message has been
31796 received, that is, in an ACL specified by &%acl_smtp_data%& or
31797 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
31798 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
31799 and &'Bcc:'&), returning true if there are no problems.
31800 Unqualified addresses (local parts without domains) are
31801 permitted only in locally generated messages and from hosts that match
31802 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
31803 appropriate.
31804
31805 Note that this condition is a syntax check only. However, a common spamming
31806 ploy used to be to send syntactically invalid headers such as
31807 .code
31808 To: @
31809 .endd
31810 and this condition can be used to reject such messages, though they are not as
31811 common as they used to be.
31812
31813 .vitem &*verify&~=&~helo*&
31814 .cindex "&%verify%& ACL condition"
31815 .cindex "&ACL;" "verifying HELO/EHLO"
31816 .cindex "HELO" "verifying"
31817 .cindex "EHLO" "verifying"
31818 .cindex "verifying" "EHLO"
31819 .cindex "verifying" "HELO"
31820 This condition is true if a HELO or EHLO command has been received from the
31821 client host, and its contents have been verified. If there has been no previous
31822 attempt to verify the HELO/EHLO contents, it is carried out when this
31823 condition is encountered. See the description of the &%helo_verify_hosts%& and
31824 &%helo_try_verify_hosts%& options for details of how to request verification
31825 independently of this condition, and for detail of the verification.
31826
31827 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
31828 option), this condition is always true.
31829
31830
31831 .vitem &*verify&~=&~not_blind/*&<&'options'&>
31832 .cindex "verifying" "not blind"
31833 .cindex "bcc recipients, verifying none"
31834 This condition checks that there are no blind (bcc) recipients in the message.
31835 Every envelope recipient must appear either in a &'To:'& header line or in a
31836 &'Cc:'& header line for this condition to be true. Local parts are checked
31837 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
31838 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
31839 used only in a DATA or non-SMTP ACL.
31840
31841 There is one possible option, &`case_insensitive`&.  If this is present then
31842 local parts are checked case-insensitively.
31843
31844 There are, of course, many legitimate messages that make use of blind (bcc)
31845 recipients. This check should not be used on its own for blocking messages.
31846
31847
31848 .vitem &*verify&~=&~recipient/*&<&'options'&>
31849 .cindex "&%verify%& ACL condition"
31850 .cindex "&ACL;" "verifying recipient"
31851 .cindex "recipient" "verifying"
31852 .cindex "verifying" "recipient"
31853 .vindex "&$address_data$&"
31854 This condition is relevant only after a RCPT command. It verifies the current
31855 recipient. Details of address verification are given later, starting at section
31856 &<<SECTaddressverification>>&. After a recipient has been verified, the value
31857 of &$address_data$& is the last value that was set while routing the address.
31858 This applies even if the verification fails. When an address that is being
31859 verified is redirected to a single address, verification continues with the new
31860 address, and in that case, the subsequent value of &$address_data$& is the
31861 value for the child address.
31862
31863 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
31864 .cindex "&%verify%& ACL condition"
31865 .cindex "&ACL;" "verifying host reverse lookup"
31866 .cindex "host" "verifying reverse lookup"
31867 This condition ensures that a verified host name has been looked up from the IP
31868 address of the client host. (This may have happened already if the host name
31869 was needed for checking a host list, or if the host matched &%host_lookup%&.)
31870 Verification ensures that the host name obtained from a reverse DNS lookup, or
31871 one of its aliases, does, when it is itself looked up in the DNS, yield the
31872 original IP address.
31873
31874 There is one possible option, &`defer_ok`&.  If this is present and a
31875 DNS operation returns a temporary error, the verify condition succeeds.
31876
31877 If this condition is used for a locally generated message (that is, when there
31878 is no client host involved), it always succeeds.
31879
31880 .vitem &*verify&~=&~sender/*&<&'options'&>
31881 .cindex "&%verify%& ACL condition"
31882 .cindex "&ACL;" "verifying sender"
31883 .cindex "sender" "verifying"
31884 .cindex "verifying" "sender"
31885 This condition is relevant only after a MAIL or RCPT command, or after a
31886 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
31887 the message's sender is empty (that is, this is a bounce message), the
31888 condition is true. Otherwise, the sender address is verified.
31889
31890 .vindex "&$address_data$&"
31891 .vindex "&$sender_address_data$&"
31892 If there is data in the &$address_data$& variable at the end of routing, its
31893 value is placed in &$sender_address_data$& at the end of verification. This
31894 value can be used in subsequent conditions and modifiers in the same ACL
31895 statement. It does not persist after the end of the current statement. If you
31896 want to preserve the value for longer, you can save it in an ACL variable.
31897
31898 Details of verification are given later, starting at section
31899 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
31900 to avoid doing it more than once per message.
31901
31902 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
31903 .cindex "&%verify%& ACL condition"
31904 This is a variation of the previous option, in which a modified address is
31905 verified as a sender.
31906
31907 Note that '/' is legal in local-parts; if the address may have such
31908 (eg. is generated from the received message)
31909 they must be protected from the options parsing by doubling:
31910 .code
31911 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
31912 .endd
31913 .endlist
31914
31915
31916
31917 .section "Using DNS lists" "SECTmorednslists"
31918 .cindex "DNS list" "in ACL"
31919 .cindex "black list (DNS)"
31920 .cindex "&ACL;" "testing a DNS list"
31921 In its simplest form, the &%dnslists%& condition tests whether the calling host
31922 is on at least one of a number of DNS lists by looking up the inverted IP
31923 address in one or more DNS domains. (Note that DNS list domains are not mail
31924 domains, so the &`+`& syntax for named lists doesn't work - it is used for
31925 special options instead.) For example, if the calling host's IP
31926 address is 192.168.62.43, and the ACL statement is
31927 .code
31928 deny dnslists = blackholes.mail-abuse.org : \
31929                 dialups.mail-abuse.org
31930 .endd
31931 the following records are looked up:
31932 .code
31933 43.62.168.192.blackholes.mail-abuse.org
31934 43.62.168.192.dialups.mail-abuse.org
31935 .endd
31936 As soon as Exim finds an existing DNS record, processing of the list stops.
31937 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
31938 to test that a host is on more than one list (an &"and"& conjunction), you can
31939 use two separate conditions:
31940 .code
31941 deny dnslists = blackholes.mail-abuse.org
31942      dnslists = dialups.mail-abuse.org
31943 .endd
31944 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
31945 behaves as if the host does not match the list item, that is, as if the DNS
31946 record does not exist. If there are further items in the DNS list, they are
31947 processed.
31948
31949 This is usually the required action when &%dnslists%& is used with &%deny%&
31950 (which is the most common usage), because it prevents a DNS failure from
31951 blocking mail. However, you can change this behaviour by putting one of the
31952 following special items in the list:
31953 .display
31954 &`+include_unknown `&   behave as if the item is on the list
31955 &`+exclude_unknown `&   behave as if the item is not on the list (default)
31956 &`+defer_unknown   `&   give a temporary error
31957 .endd
31958 .cindex "&`+include_unknown`&"
31959 .cindex "&`+exclude_unknown`&"
31960 .cindex "&`+defer_unknown`&"
31961 Each of these applies to any subsequent items on the list. For example:
31962 .code
31963 deny dnslists = +defer_unknown : foo.bar.example
31964 .endd
31965 Testing the list of domains stops as soon as a match is found. If you want to
31966 warn for one list and block for another, you can use two different statements:
31967 .code
31968 deny  dnslists = blackholes.mail-abuse.org
31969 warn  dnslists = dialups.mail-abuse.org
31970       message  = X-Warn: sending host is on dialups list
31971 .endd
31972 .cindex caching "of dns lookup"
31973 .cindex DNS TTL
31974 DNS list lookups are cached by Exim for the duration of the SMTP session
31975 (but limited by the DNS return TTL value),
31976 so a lookup based on the IP address is done at most once for any incoming
31977 connection (assuming long-enough TTL).
31978 Exim does not share information between multiple incoming
31979 connections (but your local name server cache should be active).
31980
31981 There are a number of DNS lists to choose from, some commercial, some free,
31982 or free for small deployments.  An overview can be found at
31983 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
31984
31985
31986
31987 .section "Specifying the IP address for a DNS list lookup" "SECID201"
31988 .cindex "DNS list" "keyed by explicit IP address"
31989 By default, the IP address that is used in a DNS list lookup is the IP address
31990 of the calling host. However, you can specify another IP address by listing it
31991 after the domain name, introduced by a slash. For example:
31992 .code
31993 deny dnslists = black.list.tld/192.168.1.2
31994 .endd
31995 This feature is not very helpful with explicit IP addresses; it is intended for
31996 use with IP addresses that are looked up, for example, the IP addresses of the
31997 MX hosts or nameservers of an email sender address. For an example, see section
31998 &<<SECTmulkeyfor>>& below.
31999
32000
32001
32002
32003 .section "DNS lists keyed on domain names" "SECID202"
32004 .cindex "DNS list" "keyed by domain name"
32005 There are some lists that are keyed on domain names rather than inverted IP
32006 addresses (see, e.g., the &'domain based zones'& link at
32007 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
32008 with these lists. You can change the name that is looked up in a DNS list by
32009 listing it after the domain name, introduced by a slash. For example,
32010 .code
32011 deny  dnslists = dsn.rfc-ignorant.org/$sender_address_domain
32012       message  = Sender's domain is listed at $dnslist_domain
32013 .endd
32014 This particular example is useful only in ACLs that are obeyed after the
32015 RCPT or DATA commands, when a sender address is available. If (for
32016 example) the message's sender is &'user@tld.example'& the name that is looked
32017 up by this example is
32018 .code
32019 tld.example.dsn.rfc-ignorant.org
32020 .endd
32021 A single &%dnslists%& condition can contain entries for both names and IP
32022 addresses. For example:
32023 .code
32024 deny dnslists = sbl.spamhaus.org : \
32025                 dsn.rfc-ignorant.org/$sender_address_domain
32026 .endd
32027 The first item checks the sending host's IP address; the second checks a domain
32028 name. The whole condition is true if either of the DNS lookups succeeds.
32029
32030
32031
32032
32033 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
32034 .cindex "DNS list" "multiple keys for"
32035 The syntax described above for looking up explicitly-defined values (either
32036 names or IP addresses) in a DNS blacklist is a simplification. After the domain
32037 name for the DNS list, what follows the slash can in fact be a list of items.
32038 As with all lists in Exim, the default separator is a colon. However, because
32039 this is a sublist within the list of DNS blacklist domains, it is necessary
32040 either to double the separators like this:
32041 .code
32042 dnslists = black.list.tld/name.1::name.2
32043 .endd
32044 or to change the separator character, like this:
32045 .code
32046 dnslists = black.list.tld/<;name.1;name.2
32047 .endd
32048 If an item in the list is an IP address, it is inverted before the DNS
32049 blacklist domain is appended. If it is not an IP address, no inversion
32050 occurs. Consider this condition:
32051 .code
32052 dnslists = black.list.tld/<;192.168.1.2;a.domain
32053 .endd
32054 The DNS lookups that occur are:
32055 .code
32056 2.1.168.192.black.list.tld
32057 a.domain.black.list.tld
32058 .endd
32059 Once a DNS record has been found (that matches a specific IP return
32060 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
32061 are done. If there is a temporary DNS error, the rest of the sublist of domains
32062 or IP addresses is tried. A temporary error for the whole dnslists item occurs
32063 only if no other DNS lookup in this sublist succeeds. In other words, a
32064 successful lookup for any of the items in the sublist overrides a temporary
32065 error for a previous item.
32066
32067 The ability to supply a list of items after the slash is in some sense just a
32068 syntactic convenience. These two examples have the same effect:
32069 .code
32070 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
32071 dnslists = black.list.tld/a.domain::b.domain
32072 .endd
32073 However, when the data for the list is obtained from a lookup, the second form
32074 is usually much more convenient. Consider this example:
32075 .code
32076 deny dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
32077                                    ${lookup dnsdb {>|mxh=\
32078                                    $sender_address_domain} }} }
32079      message  = The mail servers for the domain \
32080                 $sender_address_domain \
32081                 are listed at $dnslist_domain ($dnslist_value); \
32082                 see $dnslist_text.
32083 .endd
32084 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
32085 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
32086 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
32087 of expanding the condition might be something like this:
32088 .code
32089 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
32090 .endd
32091 Thus, this example checks whether or not the IP addresses of the sender
32092 domain's mail servers are on the Spamhaus black list.
32093
32094 The key that was used for a successful DNS list lookup is put into the variable
32095 &$dnslist_matched$& (see section &<<SECID204>>&).
32096
32097
32098
32099
32100 .section "Data returned by DNS lists" "SECID203"
32101 .cindex "DNS list" "data returned from"
32102 DNS lists are constructed using address records in the DNS. The original RBL
32103 just used the address 127.0.0.1 on the right hand side of each record, but the
32104 RBL+ list and some other lists use a number of values with different meanings.
32105 The values used on the RBL+ list are:
32106 .display
32107 127.1.0.1  RBL
32108 127.1.0.2  DUL
32109 127.1.0.3  DUL and RBL
32110 127.1.0.4  RSS
32111 127.1.0.5  RSS and RBL
32112 127.1.0.6  RSS and DUL
32113 127.1.0.7  RSS and DUL and RBL
32114 .endd
32115 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
32116 different values. Some DNS lists may return more than one address record;
32117 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
32118
32119
32120 .section "Variables set from DNS lists" "SECID204"
32121 .cindex "expansion" "variables, set from DNS list"
32122 .cindex "DNS list" "variables set from"
32123 .vindex "&$dnslist_domain$&"
32124 .vindex "&$dnslist_matched$&"
32125 .vindex "&$dnslist_text$&"
32126 .vindex "&$dnslist_value$&"
32127 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
32128 the name of the overall domain that matched (for example,
32129 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
32130 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
32131 the DNS record. When the key is an IP address, it is not reversed in
32132 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
32133 cases, for example:
32134 .code
32135 deny dnslists = spamhaus.example
32136 .endd
32137 the key is also available in another variable (in this case,
32138 &$sender_host_address$&). In more complicated cases, however, this is not true.
32139 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
32140 might generate a dnslists lookup like this:
32141 .code
32142 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
32143 .endd
32144 If this condition succeeds, the value in &$dnslist_matched$& might be
32145 &`192.168.6.7`& (for example).
32146
32147 If more than one address record is returned by the DNS lookup, all the IP
32148 addresses are included in &$dnslist_value$&, separated by commas and spaces.
32149 The variable &$dnslist_text$& contains the contents of any associated TXT
32150 record. For lists such as RBL+ the TXT record for a merged entry is often not
32151 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
32152 information.
32153
32154 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
32155 &-- even if these appear before the condition in the ACL, they are not
32156 expanded until after it has failed. For example:
32157 .code
32158 deny    hosts = !+local_networks
32159         message = $sender_host_address is listed \
32160                   at $dnslist_domain
32161         dnslists = rbl-plus.mail-abuse.example
32162 .endd
32163
32164
32165
32166 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
32167 .cindex "DNS list" "matching specific returned data"
32168 You can add an equals sign and an IP address after a &%dnslists%& domain name
32169 in order to restrict its action to DNS records with a matching right hand side.
32170 For example,
32171 .code
32172 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
32173 .endd
32174 rejects only those hosts that yield 127.0.0.2. Without this additional data,
32175 any address record is considered to be a match. For the moment, we assume
32176 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
32177 describes how multiple records are handled.
32178
32179 More than one IP address may be given for checking, using a comma as a
32180 separator. These are alternatives &-- if any one of them matches, the
32181 &%dnslists%& condition is true. For example:
32182 .code
32183 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32184 .endd
32185 If you want to specify a constraining address list and also specify names or IP
32186 addresses to be looked up, the constraining address list must be specified
32187 first. For example:
32188 .code
32189 deny dnslists = dsn.rfc-ignorant.org\
32190                 =127.0.0.2/$sender_address_domain
32191 .endd
32192
32193 If the character &`&&`& is used instead of &`=`&, the comparison for each
32194 listed IP address is done by a bitwise &"and"& instead of by an equality test.
32195 In other words, the listed addresses are used as bit masks. The comparison is
32196 true if all the bits in the mask are present in the address that is being
32197 tested. For example:
32198 .code
32199 dnslists = a.b.c&0.0.0.3
32200 .endd
32201 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
32202 want to test whether one bit or another bit is present (as opposed to both
32203 being present), you must use multiple values. For example:
32204 .code
32205 dnslists = a.b.c&0.0.0.1,0.0.0.2
32206 .endd
32207 matches if the final component of the address is an odd number or two times
32208 an odd number.
32209
32210
32211
32212 .section "Negated DNS matching conditions" "SECID205"
32213 You can supply a negative list of IP addresses as part of a &%dnslists%&
32214 condition. Whereas
32215 .code
32216 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
32217 .endd
32218 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32219 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
32220 .code
32221 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
32222 .endd
32223 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
32224 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
32225 words, the result of the test is inverted if an exclamation mark appears before
32226 the &`=`& (or the &`&&`&) sign.
32227
32228 &*Note*&: This kind of negation is not the same as negation in a domain,
32229 host, or address list (which is why the syntax is different).
32230
32231 If you are using just one list, the negation syntax does not gain you much. The
32232 previous example is precisely equivalent to
32233 .code
32234 deny  dnslists = a.b.c
32235      !dnslists = a.b.c=127.0.0.2,127.0.0.3
32236 .endd
32237 However, if you are using multiple lists, the negation syntax is clearer.
32238 Consider this example:
32239 .code
32240 deny  dnslists = sbl.spamhaus.org : \
32241                  list.dsbl.org : \
32242                  dnsbl.njabl.org!=127.0.0.3 : \
32243                  relays.ordb.org
32244 .endd
32245 Using only positive lists, this would have to be:
32246 .code
32247 deny  dnslists = sbl.spamhaus.org : \
32248                  list.dsbl.org
32249 deny  dnslists = dnsbl.njabl.org
32250      !dnslists = dnsbl.njabl.org=127.0.0.3
32251 deny  dnslists = relays.ordb.org
32252 .endd
32253 which is less clear, and harder to maintain.
32254
32255
32256
32257
32258 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
32259 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
32260 thereby providing more than one IP address. When an item in a &%dnslists%& list
32261 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
32262 the match to specific results from the DNS lookup, there are two ways in which
32263 the checking can be handled. For example, consider the condition:
32264 .code
32265 dnslists = a.b.c=127.0.0.1
32266 .endd
32267 What happens if the DNS lookup for the incoming IP address yields both
32268 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
32269 condition true because at least one given value was found, or is it false
32270 because at least one of the found values was not listed? And how does this
32271 affect negated conditions? Both possibilities are provided for with the help of
32272 additional separators &`==`& and &`=&&`&.
32273
32274 .ilist
32275 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
32276 IP addresses matches one of the listed addresses. For the example above, the
32277 condition is true because 127.0.0.1 matches.
32278 .next
32279 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
32280 looked up IP addresses matches one of the listed addresses. If the condition is
32281 changed to:
32282 .code
32283 dnslists = a.b.c==127.0.0.1
32284 .endd
32285 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32286 false because 127.0.0.2 is not listed. You would need to have:
32287 .code
32288 dnslists = a.b.c==127.0.0.1,127.0.0.2
32289 .endd
32290 for the condition to be true.
32291 .endlist
32292
32293 When &`!`& is used to negate IP address matching, it inverts the result, giving
32294 the precise opposite of the behaviour above. Thus:
32295 .ilist
32296 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
32297 addresses matches one of the listed addresses. Consider:
32298 .code
32299 dnslists = a.b.c!&0.0.0.1
32300 .endd
32301 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32302 false because 127.0.0.1 matches.
32303 .next
32304 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
32305 looked up IP address that does not match. Consider:
32306 .code
32307 dnslists = a.b.c!=&0.0.0.1
32308 .endd
32309 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
32310 true, because 127.0.0.2 does not match. You would need to have:
32311 .code
32312 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
32313 .endd
32314 for the condition to be false.
32315 .endlist
32316 When the DNS lookup yields only a single IP address, there is no difference
32317 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
32318
32319
32320
32321
32322 .section "Detailed information from merged DNS lists" "SECTmordetinf"
32323 .cindex "DNS list" "information from merged"
32324 When the facility for restricting the matching IP values in a DNS list is used,
32325 the text from the TXT record that is set in &$dnslist_text$& may not reflect
32326 the true reason for rejection. This happens when lists are merged and the IP
32327 address in the A record is used to distinguish them; unfortunately there is
32328 only one TXT record. One way round this is not to use merged lists, but that
32329 can be inefficient because it requires multiple DNS lookups where one would do
32330 in the vast majority of cases when the host of interest is not on any of the
32331 lists.
32332
32333 A less inefficient way of solving this problem is available. If
32334 two domain names, comma-separated, are given, the second is used first to
32335 do an initial check, making use of any IP value restrictions that are set.
32336 If there is a match, the first domain is used, without any IP value
32337 restrictions, to get the TXT record. As a byproduct of this, there is also
32338 a check that the IP being tested is indeed on the first list. The first
32339 domain is the one that is put in &$dnslist_domain$&. For example:
32340 .code
32341 deny   dnslists = \
32342          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
32343          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32344        message  = \
32345          rejected because $sender_host_address is blacklisted \
32346          at $dnslist_domain\n$dnslist_text
32347 .endd
32348 For the first blacklist item, this starts by doing a lookup in
32349 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
32350 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
32351 value, and as long as something is found, it looks for the corresponding TXT
32352 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
32353 The second blacklist item is processed similarly.
32354
32355 If you are interested in more than one merged list, the same list must be
32356 given several times, but because the results of the DNS lookups are cached,
32357 the DNS calls themselves are not repeated. For example:
32358 .code
32359 deny dnslists = \
32360          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
32361          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
32362          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
32363          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
32364 .endd
32365 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
32366 values matches (or if no record is found), this is the only lookup that is
32367 done. Only if there is a match is one of the more specific lists consulted.
32368
32369
32370
32371 .section "DNS lists and IPv6" "SECTmorednslistslast"
32372 .cindex "IPv6" "DNS black lists"
32373 .cindex "DNS list" "IPv6 usage"
32374 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
32375 nibble by nibble. For example, if the calling host's IP address is
32376 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
32377 .code
32378 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
32379   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
32380 .endd
32381 (split over two lines here to fit on the page). Unfortunately, some of the DNS
32382 lists contain wildcard records, intended for IPv4, that interact badly with
32383 IPv6. For example, the DNS entry
32384 .code
32385 *.3.some.list.example.    A    127.0.0.1
32386 .endd
32387 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
32388 Unfortunately, it also matches the entire 3::/4 IPv6 network.
32389
32390 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
32391 &%condition%& condition, as in this example:
32392 .code
32393 deny   condition = ${if isip4{$sender_host_address}}
32394        dnslists  = some.list.example
32395 .endd
32396
32397 If an explicit key is being used for a DNS lookup and it may be an IPv6
32398 address you should specify alternate list separators for both the outer
32399 (DNS list name) list and inner (lookup keys) list:
32400 .code
32401        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
32402 .endd
32403
32404 .section "Rate limiting incoming messages" "SECTratelimiting"
32405 .cindex "rate limiting" "client sending"
32406 .cindex "limiting client sending rates"
32407 .oindex "&%smtp_ratelimit_*%&"
32408 The &%ratelimit%& ACL condition can be used to measure and control the rate at
32409 which clients can send email. This is more powerful than the
32410 &%smtp_ratelimit_*%& options, because those options control the rate of
32411 commands in a single SMTP session only, whereas the &%ratelimit%& condition
32412 works across all connections (concurrent and sequential) from the same client
32413 host. The syntax of the &%ratelimit%& condition is:
32414 .display
32415 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
32416 .endd
32417 If the average client sending rate is less than &'m'& messages per time
32418 period &'p'& then the condition is false; otherwise it is true.
32419
32420 As a side-effect, the &%ratelimit%& condition sets the expansion variable
32421 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
32422 configured value of &'m'&, and &$sender_rate_period$& to the configured value
32423 of &'p'&.
32424
32425 The parameter &'p'& is the smoothing time constant, in the form of an Exim
32426 time interval, for example, &`8h`& for eight hours. A larger time constant
32427 means that it takes Exim longer to forget a client's past behaviour. The
32428 parameter &'m'& is the maximum number of messages that a client is permitted to
32429 send in each time interval. It also specifies the number of messages permitted
32430 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
32431 constant, you can allow a client to send more messages in a burst without
32432 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
32433 both small, messages must be sent at an even rate.
32434
32435 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
32436 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
32437 when deploying the &%ratelimit%& ACL condition. The script prints usage
32438 instructions when it is run with no arguments.
32439
32440 The key is used to look up the data for calculating the client's average
32441 sending rate. This data is stored in Exim's spool directory, alongside the
32442 retry and other hints databases. The default key is &$sender_host_address$&,
32443 which means Exim computes the sending rate of each client host IP address.
32444 By changing the key you can change how Exim identifies clients for the purpose
32445 of ratelimiting. For example, to limit the sending rate of each authenticated
32446 user, independent of the computer they are sending from, set the key to
32447 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
32448 example, &$authenticated_id$& is only meaningful if the client has
32449 authenticated (which you can check with the &%authenticated%& ACL condition).
32450
32451 The lookup key does not have to identify clients: If you want to limit the
32452 rate at which a recipient receives messages, you can use the key
32453 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
32454 ACL.
32455
32456 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
32457 specifies what Exim measures the rate of, for example, messages or recipients
32458 or bytes. You can adjust the measurement using the &%unique=%& and/or
32459 &%count=%& options. You can also control when Exim updates the recorded rate
32460 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
32461 separated by a slash, like the other parameters. They may appear in any order.
32462
32463 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
32464 any options that alter the meaning of the stored data. The limit &'m'& is not
32465 stored, so you can alter the configured maximum rate and Exim will still
32466 remember clients' past behaviour. If you change the &%per_*%& mode or add or
32467 remove the &%unique=%& option, the lookup key changes so Exim will forget past
32468 behaviour. The lookup key is not affected by changes to the update mode and
32469 the &%count=%& option.
32470
32471
32472 .section "Ratelimit options for what is being measured" "ratoptmea"
32473 .cindex "rate limiting" "per_* options"
32474 The &%per_conn%& option limits the client's connection rate. It is not
32475 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
32476 &%acl_not_smtp_start%& ACLs.
32477
32478 The &%per_mail%& option limits the client's rate of sending messages. This is
32479 the default if none of the &%per_*%& options is specified. It can be used in
32480 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
32481 &%acl_smtp_data%&, or &%acl_not_smtp%&.
32482
32483 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
32484 the same ACLs as the &%per_mail%& option, though it is best to use this option
32485 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
32486 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
32487 in its MAIL command, which may be inaccurate or completely missing. You can
32488 follow the limit &'m'& in the configuration with K, M, or G to specify limits
32489 in kilobytes, megabytes, or gigabytes, respectively.
32490
32491 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
32492 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
32493 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
32494 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
32495 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
32496 in either case the rate limiting engine will see a message with many
32497 recipients as a large high-speed burst.
32498
32499 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
32500 number of different recipients that the client has sent messages to in the
32501 last time period. That is, if the client repeatedly sends messages to the same
32502 recipient, its measured rate is not increased. This option can only be used in
32503 &%acl_smtp_rcpt%&.
32504
32505 The &%per_cmd%& option causes Exim to recompute the rate every time the
32506 condition is processed. This can be used to limit the rate of any SMTP
32507 command. If it is used in multiple ACLs it can limit the aggregate rate of
32508 multiple different commands.
32509
32510 The &%count=%& option can be used to alter how much Exim adds to the client's
32511 measured rate. For example, the &%per_byte%& option is equivalent to
32512 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
32513 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
32514 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
32515
32516 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
32517
32518
32519 .section "Ratelimit update modes" "ratoptupd"
32520 .cindex "rate limiting" "reading data without updating"
32521 You can specify one of three options with the &%ratelimit%& condition to
32522 control when its database is updated. This section describes the &%readonly%&
32523 mode, and the next section describes the &%strict%& and &%leaky%& modes.
32524
32525 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
32526 previously-computed rate to check against the limit.
32527
32528 For example, you can test the client's sending rate and deny it access (when
32529 it is too fast) in the connect ACL. If the client passes this check then it
32530 can go on to send a message, in which case its recorded rate will be updated
32531 in the MAIL ACL. Subsequent connections from the same client will check this
32532 new rate.
32533 .code
32534 acl_check_connect:
32535  deny ratelimit = 100 / 5m / readonly
32536       log_message = RATE CHECK: $sender_rate/$sender_rate_period \
32537                   (max $sender_rate_limit)
32538 # ...
32539 acl_check_mail:
32540  warn ratelimit = 100 / 5m / strict
32541       log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
32542                   (max $sender_rate_limit)
32543 .endd
32544
32545 If Exim encounters multiple &%ratelimit%& conditions with the same key when
32546 processing a message then it may increase the client's measured rate more than
32547 it should. For example, this will happen if you check the &%per_rcpt%& option
32548 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
32549 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
32550 multiple update problems by using the &%readonly%& option on later ratelimit
32551 checks.
32552
32553 The &%per_*%& options described above do not make sense in some ACLs. If you
32554 use a &%per_*%& option in an ACL where it is not normally permitted then the
32555 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
32556 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
32557 next section) so you must specify the &%readonly%& option explicitly.
32558
32559
32560 .section "Ratelimit options for handling fast clients" "ratoptfast"
32561 .cindex "rate limiting" "strict and leaky modes"
32562 If a client's average rate is greater than the maximum, the rate limiting
32563 engine can react in two possible ways, depending on the presence of the
32564 &%strict%& or &%leaky%& update modes. This is independent of the other
32565 counter-measures (such as rejecting the message) that may be specified by the
32566 rest of the ACL.
32567
32568 The &%leaky%& (default) option means that the client's recorded rate is not
32569 updated if it is above the limit. The effect of this is that Exim measures the
32570 client's average rate of successfully sent email,
32571 up to the given limit.
32572 This is appropriate if the countermeasure when the condition is true
32573 consists of refusing the message, and
32574 is generally the better choice if you have clients that retry automatically.
32575 If the action when true is anything more complex then this option is
32576 likely not what is wanted.
32577
32578 The &%strict%& option means that the client's recorded rate is always
32579 updated. The effect of this is that Exim measures the client's average rate
32580 of attempts to send email, which can be much higher than the maximum it is
32581 actually allowed. If the client is over the limit it may be subjected to
32582 counter-measures by the ACL. It must slow down and allow sufficient time to
32583 pass that its computed rate falls below the maximum before it can send email
32584 again. The time (the number of smoothing periods) it must wait and not
32585 attempt to send mail can be calculated with this formula:
32586 .code
32587         ln(peakrate/maxrate)
32588 .endd
32589
32590
32591 .section "Limiting the rate of different events" "ratoptuniq"
32592 .cindex "rate limiting" "counting unique events"
32593 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
32594 rate of different events. For example, the &%per_addr%& option uses this
32595 mechanism to count the number of different recipients that the client has
32596 sent messages to in the last time period; it is equivalent to
32597 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
32598 measure the rate that a client uses different sender addresses with the
32599 options &`per_mail/unique=$sender_address`&.
32600
32601 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
32602 has seen for that key. The whole set is thrown away when it is older than the
32603 rate smoothing period &'p'&, so each different event is counted at most once
32604 per period. In the &%leaky%& update mode, an event that causes the client to
32605 go over the limit is not added to the set, in the same way that the client's
32606 recorded rate is not updated in the same situation.
32607
32608 When you combine the &%unique=%& and &%readonly%& options, the specific
32609 &%unique=%& value is ignored, and Exim just retrieves the client's stored
32610 rate.
32611
32612 The &%unique=%& mechanism needs more space in the ratelimit database than the
32613 other &%ratelimit%& options in order to store the event set. The number of
32614 unique values is potentially as large as the rate limit, so the extra space
32615 required increases with larger limits.
32616
32617 The uniqueification is not perfect: there is a small probability that Exim
32618 will think a new event has happened before. If the sender's rate is less than
32619 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
32620 the measured rate can go above the limit, in which case Exim may under-count
32621 events by a significant margin. Fortunately, if the rate is high enough (2.7
32622 times the limit) that the false positive rate goes above 9%, then Exim will
32623 throw away the over-full event set before the measured rate falls below the
32624 limit. Therefore the only harm should be that exceptionally high sending rates
32625 are logged incorrectly; any countermeasures you configure will be as effective
32626 as intended.
32627
32628
32629 .section "Using rate limiting" "useratlim"
32630 Exim's other ACL facilities are used to define what counter-measures are taken
32631 when the rate limit is exceeded. This might be anything from logging a warning
32632 (for example, while measuring existing sending rates in order to define
32633 policy), through time delays to slow down fast senders, up to rejecting the
32634 message. For example:
32635 .code
32636 # Log all senders' rates
32637 warn ratelimit = 0 / 1h / strict
32638      log_message = Sender rate $sender_rate / $sender_rate_period
32639
32640 # Slow down fast senders; note the need to truncate $sender_rate
32641 # at the decimal point.
32642 warn ratelimit = 100 / 1h / per_rcpt / strict
32643      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
32644                    $sender_rate_limit }s
32645
32646 # Keep authenticated users under control
32647 deny authenticated = *
32648      ratelimit = 100 / 1d / strict / $authenticated_id
32649
32650 # System-wide rate limit
32651 defer ratelimit = 10 / 1s / $primary_hostname
32652       message = Sorry, too busy. Try again later.
32653
32654 # Restrict incoming rate from each host, with a default
32655 # set using a macro and special cases looked up in a table.
32656 defer ratelimit = ${lookup {$sender_host_address} \
32657                    cdb {DB/ratelimits.cdb} \
32658                    {$value} {RATELIMIT} }
32659       message = Sender rate exceeds $sender_rate_limit \
32660                messages per $sender_rate_period
32661 .endd
32662 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
32663 especially with the &%per_rcpt%& option, you may suffer from a performance
32664 bottleneck caused by locking on the ratelimit hints database. Apart from
32665 making your ACLs less complicated, you can reduce the problem by using a
32666 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
32667 this means that Exim will lose its hints data after a reboot (including retry
32668 hints, the callout cache, and ratelimit data).
32669
32670
32671
32672 .section "Address verification" "SECTaddressverification"
32673 .cindex "verifying address" "options for"
32674 .cindex "policy control" "address verification"
32675 Several of the &%verify%& conditions described in section
32676 &<<SECTaclconditions>>& cause addresses to be verified. Section
32677 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
32678 The verification conditions can be followed by options that modify the
32679 verification process. The options are separated from the keyword and from each
32680 other by slashes, and some of them contain parameters. For example:
32681 .code
32682 verify = sender/callout
32683 verify = recipient/defer_ok/callout=10s,defer_ok
32684 .endd
32685 The first stage of address verification, which always happens, is to run the
32686 address through the routers, in &"verify mode"&. Routers can detect the
32687 difference between verification and routing for delivery, and their actions can
32688 be varied by a number of generic options such as &%verify%& and &%verify_only%&
32689 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
32690 The available options are as follows:
32691
32692 .ilist
32693 If the &%callout%& option is specified, successful routing to one or more
32694 remote hosts is followed by a &"callout"& to those hosts as an additional
32695 check. Callouts and their sub-options are discussed in the next section.
32696 .next
32697 If there is a defer error while doing verification routing, the ACL
32698 normally returns &"defer"&. However, if you include &%defer_ok%& in the
32699 options, the condition is forced to be true instead. Note that this is a main
32700 verification option as well as a suboption for callouts.
32701 .next
32702 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
32703 discusses the reporting of sender address verification failures.
32704 .next
32705 The &%success_on_redirect%& option causes verification always to succeed
32706 immediately after a successful redirection. By default, if a redirection
32707 generates just one address, that address is also verified. See further
32708 discussion in section &<<SECTredirwhilveri>>&.
32709 .new
32710 .next
32711 If the &%quota%& option is specified for recipient verify,
32712 successful routing to an appendfile transport is followed by a call into
32713 the transport to evaluate the quota status for the recipient.
32714 No actual delivery is done, but verification will succeed if the quota
32715 is sufficient for the message (if the sender gave a message size) or
32716 not already exceeded (otherwise).
32717 .wen
32718 .endlist
32719
32720 .cindex "verifying address" "differentiating failures"
32721 .vindex "&$recipient_verify_failure$&"
32722 .vindex "&$sender_verify_failure$&"
32723 .vindex "&$acl_verify_message$&"
32724 After an address verification failure, &$acl_verify_message$& contains the
32725 error message that is associated with the failure. It can be preserved by
32726 coding like this:
32727 .code
32728 warn  !verify = sender
32729        set acl_m0 = $acl_verify_message
32730 .endd
32731 If you are writing your own custom rejection message or log message when
32732 denying access, you can use this variable to include information about the
32733 verification failure.
32734
32735 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
32736 appropriate) contains one of the following words:
32737
32738 .ilist
32739 &%qualify%&: The address was unqualified (no domain), and the message
32740 was neither local nor came from an exempted host.
32741 .next
32742 &%route%&: Routing failed.
32743 .next
32744 &%mail%&: Routing succeeded, and a callout was attempted; rejection
32745 occurred at or before the MAIL command (that is, on initial
32746 connection, HELO, or MAIL).
32747 .next
32748 &%recipient%&: The RCPT command in a callout was rejected.
32749 .next
32750 &%postmaster%&: The postmaster check in a callout was rejected.
32751 .new
32752 .next
32753 &%quota%&: The quota check for a local recipient did non pass.
32754 .endlist
32755
32756 The main use of these variables is expected to be to distinguish between
32757 rejections of MAIL and rejections of RCPT in callouts.
32758
32759 The above variables may also be set after a &*successful*&
32760 address verification to:
32761
32762 .ilist
32763 &%random%&: A random local-part callout succeeded
32764 .endlist
32765
32766
32767
32768
32769 .section "Callout verification" "SECTcallver"
32770 .cindex "verifying address" "by callout"
32771 .cindex "callout" "verification"
32772 .cindex "SMTP" "callout verification"
32773 For non-local addresses, routing verifies the domain, but is unable to do any
32774 checking of the local part. There are situations where some means of verifying
32775 the local part is desirable. One way this can be done is to make an SMTP
32776 &'callback'& to a delivery host for the sender address or a &'callforward'& to
32777 a subsequent host for a recipient address, to see if the host accepts the
32778 address. We use the term &'callout'& to cover both cases. Note that for a
32779 sender address, the callback is not to the client host that is trying to
32780 deliver the message, but to one of the hosts that accepts incoming mail for the
32781 sender's domain.
32782
32783 Exim does not do callouts by default. If you want them to happen, you must
32784 request them by setting appropriate options on the &%verify%& condition, as
32785 described below. This facility should be used with care, because it can add a
32786 lot of resource usage to the cost of verifying an address. However, Exim does
32787 cache the results of callouts, which helps to reduce the cost. Details of
32788 caching are in section &<<SECTcallvercache>>&.
32789
32790 Recipient callouts are usually used only between hosts that are controlled by
32791 the same administration. For example, a corporate gateway host could use
32792 callouts to check for valid recipients on an internal mailserver. A successful
32793 callout does not guarantee that a real delivery to the address would succeed;
32794 on the other hand, a failing callout does guarantee that a delivery would fail.
32795
32796 If the &%callout%& option is present on a condition that verifies an address, a
32797 second stage of verification occurs if the address is successfully routed to
32798 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
32799 &(manualroute)& router, where the router specifies the hosts. However, if a
32800 router that does not set up hosts routes to an &(smtp)& transport with a
32801 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
32802 &%hosts_override%& set, its hosts are always used, whether or not the router
32803 supplies a host list.
32804 Callouts are only supported on &(smtp)& transports.
32805
32806 The port that is used is taken from the transport, if it is specified and is a
32807 remote transport. (For routers that do verification only, no transport need be
32808 specified.) Otherwise, the default SMTP port is used. If a remote transport
32809 specifies an outgoing interface, this is used; otherwise the interface is not
32810 specified. Likewise, the text that is used for the HELO command is taken from
32811 the transport's &%helo_data%& option; if there is no transport, the value of
32812 &$smtp_active_hostname$& is used.
32813
32814 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
32815 test whether a bounce message could be delivered to the sender address. The
32816 following SMTP commands are sent:
32817 .display
32818 &`HELO `&<&'local host name'&>
32819 &`MAIL FROM:<>`&
32820 &`RCPT TO:`&<&'the address to be tested'&>
32821 &`QUIT`&
32822 .endd
32823 LHLO is used instead of HELO if the transport's &%protocol%& option is
32824 set to &"lmtp"&.
32825
32826 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
32827 settings.
32828
32829 A recipient callout check is similar. By default, it also uses an empty address
32830 for the sender. This default is chosen because most hosts do not make use of
32831 the sender address when verifying a recipient. Using the same address means
32832 that a single cache entry can be used for each recipient. Some sites, however,
32833 do make use of the sender address when verifying. These are catered for by the
32834 &%use_sender%& and &%use_postmaster%& options, described in the next section.
32835
32836 If the response to the RCPT command is a 2&'xx'& code, the verification
32837 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
32838 Exim tries the next host, if any. If there is a problem with all the remote
32839 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
32840 &%callout%& option is given, in which case the condition is forced to succeed.
32841
32842 .cindex "SMTP" "output flushing, disabling for callout"
32843 A callout may take a little time. For this reason, Exim normally flushes SMTP
32844 output before performing a callout in an ACL, to avoid unexpected timeouts in
32845 clients when the SMTP PIPELINING extension is in use. The flushing can be
32846 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
32847
32848
32849
32850
32851 .section "Additional parameters for callouts" "CALLaddparcall"
32852 .cindex "callout" "additional parameters for"
32853 The &%callout%& option can be followed by an equals sign and a number of
32854 optional parameters, separated by commas. For example:
32855 .code
32856 verify = recipient/callout=10s,defer_ok
32857 .endd
32858 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
32859 separate verify options, is retained for backwards compatibility, but is now
32860 deprecated. The additional parameters for &%callout%& are as follows:
32861
32862
32863 .vlist
32864 .vitem <&'a&~time&~interval'&>
32865 .cindex "callout" "timeout, specifying"
32866 This specifies the timeout that applies for the callout attempt to each host.
32867 For example:
32868 .code
32869 verify = sender/callout=5s
32870 .endd
32871 The default is 30 seconds. The timeout is used for each response from the
32872 remote host. It is also used for the initial connection, unless overridden by
32873 the &%connect%& parameter.
32874
32875
32876 .vitem &*connect&~=&~*&<&'time&~interval'&>
32877 .cindex "callout" "connection timeout, specifying"
32878 This parameter makes it possible to set a different (usually smaller) timeout
32879 for making the SMTP connection. For example:
32880 .code
32881 verify = sender/callout=5s,connect=1s
32882 .endd
32883 If not specified, this timeout defaults to the general timeout value.
32884
32885 .vitem &*defer_ok*&
32886 .cindex "callout" "defer, action on"
32887 When this parameter is present, failure to contact any host, or any other kind
32888 of temporary error, is treated as success by the ACL. However, the cache is not
32889 updated in this circumstance.
32890
32891 .vitem &*fullpostmaster*&
32892 .cindex "callout" "full postmaster check"
32893 This operates like the &%postmaster%& option (see below), but if the check for
32894 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
32895 accordance with the specification in RFC 2821. The RFC states that the
32896 unqualified address &'postmaster'& should be accepted.
32897
32898
32899 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
32900 .cindex "callout" "sender when verifying header"
32901 When verifying addresses in header lines using the &%header_sender%&
32902 verification option, Exim behaves by default as if the addresses are envelope
32903 sender addresses from a message. Callout verification therefore tests to see
32904 whether a bounce message could be delivered, by using an empty address in the
32905 MAIL command. However, it is arguable that these addresses might never be used
32906 as envelope senders, and could therefore justifiably reject bounce messages
32907 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
32908 address to use in the MAIL command. For example:
32909 .code
32910 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
32911 .endd
32912 This parameter is available only for the &%header_sender%& verification option.
32913
32914
32915 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
32916 .cindex "callout" "overall timeout, specifying"
32917 This parameter sets an overall timeout for performing a callout verification.
32918 For example:
32919 .code
32920 verify = sender/callout=5s,maxwait=30s
32921 .endd
32922 This timeout defaults to four times the callout timeout for individual SMTP
32923 commands. The overall timeout applies when there is more than one host that can
32924 be tried. The timeout is checked before trying the next host. This prevents
32925 very long delays if there are a large number of hosts and all are timing out
32926 (for example, when network connections are timing out).
32927
32928
32929 .vitem &*no_cache*&
32930 .cindex "callout" "cache, suppressing"
32931 .cindex "caching callout, suppressing"
32932 When this parameter is given, the callout cache is neither read nor updated.
32933
32934 .vitem &*postmaster*&
32935 .cindex "callout" "postmaster; checking"
32936 When this parameter is set, a successful callout check is followed by a similar
32937 check for the local part &'postmaster'& at the same domain. If this address is
32938 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
32939 the postmaster check is recorded in a cache record; if it is a failure, this is
32940 used to fail subsequent callouts for the domain without a connection being
32941 made, until the cache record expires.
32942
32943 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
32944 The postmaster check uses an empty sender in the MAIL command by default.
32945 You can use this parameter to do a postmaster check using a different address.
32946 For example:
32947 .code
32948 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
32949 .endd
32950 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
32951 one overrides. The &%postmaster%& parameter is equivalent to this example:
32952 .code
32953 require  verify = sender/callout=postmaster_mailfrom=
32954 .endd
32955 &*Warning*&: The caching arrangements for postmaster checking do not take
32956 account of the sender address. It is assumed that either the empty address or
32957 a fixed non-empty address will be used. All that Exim remembers is that the
32958 postmaster check for the domain succeeded or failed.
32959
32960
32961 .vitem &*random*&
32962 .cindex "callout" "&""random""& check"
32963 When this parameter is set, before doing the normal callout check, Exim does a
32964 check for a &"random"& local part at the same domain. The local part is not
32965 really random &-- it is defined by the expansion of the option
32966 &%callout_random_local_part%&, which defaults to
32967 .code
32968 $primary_hostname-$tod_epoch-testing
32969 .endd
32970 The idea here is to try to determine whether the remote host accepts all local
32971 parts without checking. If it does, there is no point in doing callouts for
32972 specific local parts. If the &"random"& check succeeds, the result is saved in
32973 a cache record, and used to force the current and subsequent callout checks to
32974 succeed without a connection being made, until the cache record expires.
32975
32976 .vitem &*use_postmaster*&
32977 .cindex "callout" "sender for recipient check"
32978 This parameter applies to recipient callouts only. For example:
32979 .code
32980 deny  !verify = recipient/callout=use_postmaster
32981 .endd
32982 .vindex "&$qualify_domain$&"
32983 It causes a non-empty postmaster address to be used in the MAIL command when
32984 performing the callout for the recipient, and also for a &"random"& check if
32985 that is configured. The local part of the address is &`postmaster`& and the
32986 domain is the contents of &$qualify_domain$&.
32987
32988 .vitem &*use_sender*&
32989 This option applies to recipient callouts only. For example:
32990 .code
32991 require  verify = recipient/callout=use_sender
32992 .endd
32993 It causes the message's actual sender address to be used in the MAIL
32994 command when performing the callout, instead of an empty address. There is no
32995 need to use this option unless you know that the called hosts make use of the
32996 sender when checking recipients. If used indiscriminately, it reduces the
32997 usefulness of callout caching.
32998
32999 .vitem &*hold*&
33000 This option applies to recipient callouts only. For example:
33001 .code
33002 require  verify = recipient/callout=use_sender,hold
33003 .endd
33004 It causes the connection to be held open and used for any further recipients
33005 and for eventual delivery (should that be done quickly).
33006 Doing this saves on TCP and SMTP startup costs, and TLS costs also
33007 when that is used for the connections.
33008 The advantage is only gained if there are no callout cache hits
33009 (which could be enforced by the no_cache option),
33010 if the use_sender option is used,
33011 if neither the random nor the use_postmaster option is used,
33012 and if no other callouts intervene.
33013 .endlist
33014
33015 If you use any of the parameters that set a non-empty sender for the MAIL
33016 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
33017 &%use_sender%&), you should think about possible loops. Recipient checking is
33018 usually done between two hosts that are under the same management, and the host
33019 that receives the callouts is not normally configured to do callouts itself.
33020 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
33021 these circumstances.
33022
33023 However, if you use a non-empty sender address for a callout to an arbitrary
33024 host, there is the likelihood that the remote host will itself initiate a
33025 callout check back to your host. As it is checking what appears to be a message
33026 sender, it is likely to use an empty address in MAIL, thus avoiding a
33027 callout loop. However, to be on the safe side it would be best to set up your
33028 own ACLs so that they do not do sender verification checks when the recipient
33029 is the address you use for header sender or postmaster callout checking.
33030
33031 Another issue to think about when using non-empty senders for callouts is
33032 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
33033 by the sender/recipient combination; thus, for any given recipient, many more
33034 actual callouts are performed than when an empty sender or postmaster is used.
33035
33036
33037
33038
33039 .section "Callout caching" "SECTcallvercache"
33040 .cindex "hints database" "callout cache"
33041 .cindex "callout" "cache, description of"
33042 .cindex "caching" "callout"
33043 Exim caches the results of callouts in order to reduce the amount of resources
33044 used, unless you specify the &%no_cache%& parameter with the &%callout%&
33045 option. A hints database called &"callout"& is used for the cache. Two
33046 different record types are used: one records the result of a callout check for
33047 a specific address, and the other records information that applies to the
33048 entire domain (for example, that it accepts the local part &'postmaster'&).
33049
33050 When an original callout fails, a detailed SMTP error message is given about
33051 the failure. However, for subsequent failures use the cache data, this message
33052 is not available.
33053
33054 The expiry times for negative and positive address cache records are
33055 independent, and can be set by the global options &%callout_negative_expire%&
33056 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
33057
33058 If a host gives a negative response to an SMTP connection, or rejects any
33059 commands up to and including
33060 .code
33061 MAIL FROM:<>
33062 .endd
33063 (but not including the MAIL command with a non-empty address),
33064 any callout attempt is bound to fail. Exim remembers such failures in a
33065 domain cache record, which it uses to fail callouts for the domain without
33066 making new connections, until the domain record times out. There are two
33067 separate expiry times for domain cache records:
33068 &%callout_domain_negative_expire%& (default 3h) and
33069 &%callout_domain_positive_expire%& (default 7d).
33070
33071 Domain records expire when the negative expiry time is reached if callouts
33072 cannot be made for the domain, or if the postmaster check failed.
33073 Otherwise, they expire when the positive expiry time is reached. This
33074 ensures that, for example, a host that stops accepting &"random"& local parts
33075 will eventually be noticed.
33076
33077 The callout caching mechanism is based on the domain of the address that is
33078 being tested. If the domain routes to several hosts, it is assumed that their
33079 behaviour will be the same.
33080
33081
33082
33083 .new
33084 .section "Quota caching" "SECTquotacache"
33085 .cindex "hints database" "quota cache"
33086 .cindex "quota" "cache, description of"
33087 .cindex "caching" "quota"
33088 Exim caches the results of quota verification
33089 in order to reduce the amount of resources used.
33090 The &"callout"& hints database is used.
33091
33092 The default cache periods are five minutes for a positive (good) result
33093 and one hour for a negative result.
33094 To change the periods the &%quota%& option can be followed by an equals sign
33095 and a number of optional paramemters, separated by commas.
33096 For example:
33097 .code
33098 verify = recipient/quota=cachepos=1h,cacheneg=1d
33099 .endd
33100 Possible parameters are:
33101 .vlist
33102 .vitem &*cachepos&~=&~*&<&'time&~interval'&>
33103 .cindex "quota cache" "positive entry expiry, specifying"
33104 Set the lifetime for a positive cache entry.
33105 A value of zero seconds is legitimate.
33106
33107 .vitem &*cacheneg&~=&~*&<&'time&~interval'&>
33108 .cindex "quota cache" "negative entry expiry, specifying"
33109 As above, for a negative entry.
33110
33111 .vitem &*no_cache*&
33112 Set both positive and negative lifetimes to zero.
33113 .wen
33114
33115 .section "Sender address verification reporting" "SECTsenaddver"
33116 .cindex "verifying" "suppressing error details"
33117 See section &<<SECTaddressverification>>& for a general discussion of
33118 verification. When sender verification fails in an ACL, the details of the
33119 failure are given as additional output lines before the 550 response to the
33120 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
33121 you might see:
33122 .code
33123 MAIL FROM:<xyz@abc.example>
33124 250 OK
33125 RCPT TO:<pqr@def.example>
33126 550-Verification failed for <xyz@abc.example>
33127 550-Called:   192.168.34.43
33128 550-Sent:     RCPT TO:<xyz@abc.example>
33129 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
33130 550 Sender verification failed
33131 .endd
33132 If more than one RCPT command fails in the same way, the details are given
33133 only for the first of them. However, some administrators do not want to send
33134 out this much information. You can suppress the details by adding
33135 &`/no_details`& to the ACL statement that requests sender verification. For
33136 example:
33137 .code
33138 verify = sender/no_details
33139 .endd
33140
33141 .section "Redirection while verifying" "SECTredirwhilveri"
33142 .cindex "verifying" "redirection while"
33143 .cindex "address redirection" "while verifying"
33144 A dilemma arises when a local address is redirected by aliasing or forwarding
33145 during verification: should the generated addresses themselves be verified,
33146 or should the successful expansion of the original address be enough to verify
33147 it? By default, Exim takes the following pragmatic approach:
33148
33149 .ilist
33150 When an incoming address is redirected to just one child address, verification
33151 continues with the child address, and if that fails to verify, the original
33152 verification also fails.
33153 .next
33154 When an incoming address is redirected to more than one child address,
33155 verification does not continue. A success result is returned.
33156 .endlist
33157
33158 This seems the most reasonable behaviour for the common use of aliasing as a
33159 way of redirecting different local parts to the same mailbox. It means, for
33160 example, that a pair of alias entries of the form
33161 .code
33162 A.Wol:   aw123
33163 aw123:   :fail: Gone away, no forwarding address
33164 .endd
33165 work as expected, with both local parts causing verification failure. When a
33166 redirection generates more than one address, the behaviour is more like a
33167 mailing list, where the existence of the alias itself is sufficient for
33168 verification to succeed.
33169
33170 It is possible, however, to change the default behaviour so that all successful
33171 redirections count as successful verifications, however many new addresses are
33172 generated. This is specified by the &%success_on_redirect%& verification
33173 option. For example:
33174 .code
33175 require verify = recipient/success_on_redirect/callout=10s
33176 .endd
33177 In this example, verification succeeds if a router generates a new address, and
33178 the callout does not occur, because no address was routed to a remote host.
33179
33180 When verification is being tested via the &%-bv%& option, the treatment of
33181 redirections is as just described, unless the &%-v%& or any debugging option is
33182 also specified. In that case, full verification is done for every generated
33183 address and a report is output for each of them.
33184
33185
33186
33187 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
33188 .cindex "CSA" "verifying"
33189 Client SMTP Authorization is a system that allows a site to advertise
33190 which machines are and are not permitted to send email. This is done by placing
33191 special SRV records in the DNS; these are looked up using the client's HELO
33192 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
33193 Authorization checks in Exim are performed by the ACL condition:
33194 .code
33195 verify = csa
33196 .endd
33197 This fails if the client is not authorized. If there is a DNS problem, or if no
33198 valid CSA SRV record is found, or if the client is authorized, the condition
33199 succeeds. These three cases can be distinguished using the expansion variable
33200 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
33201 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
33202 be likely to cause problems for legitimate email.
33203
33204 The error messages produced by the CSA code include slightly more
33205 detail. If &$csa_status$& is &"defer"&, this may be because of problems
33206 looking up the CSA SRV record, or problems looking up the CSA target
33207 address record. There are four reasons for &$csa_status$& being &"fail"&:
33208
33209 .ilist
33210 The client's host name is explicitly not authorized.
33211 .next
33212 The client's IP address does not match any of the CSA target IP addresses.
33213 .next
33214 The client's host name is authorized but it has no valid target IP addresses
33215 (for example, the target's addresses are IPv6 and the client is using IPv4).
33216 .next
33217 The client's host name has no CSA SRV record but a parent domain has asserted
33218 that all subdomains must be explicitly authorized.
33219 .endlist
33220
33221 The &%csa%& verification condition can take an argument which is the domain to
33222 use for the DNS query. The default is:
33223 .code
33224 verify = csa/$sender_helo_name
33225 .endd
33226 This implementation includes an extension to CSA. If the query domain
33227 is an address literal such as [192.0.2.95], or if it is a bare IP
33228 address, Exim searches for CSA SRV records in the reverse DNS as if
33229 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
33230 meaningful to say:
33231 .code
33232 verify = csa/$sender_host_address
33233 .endd
33234 In fact, this is the check that Exim performs if the client does not say HELO.
33235 This extension can be turned off by setting the main configuration option
33236 &%dns_csa_use_reverse%& to be false.
33237
33238 If a CSA SRV record is not found for the domain itself, a search
33239 is performed through its parent domains for a record which might be
33240 making assertions about subdomains. The maximum depth of this search is limited
33241 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
33242 default. Exim does not look for CSA SRV records in a top level domain, so the
33243 default settings handle HELO domains as long as seven
33244 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
33245 of legitimate HELO domains.
33246
33247 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
33248 direct SRV lookups, this is not sufficient because of the extra parent domain
33249 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
33250 addresses into lookups in the reverse DNS space. The result of a successful
33251 lookup such as:
33252 .code
33253 ${lookup dnsdb {csa=$sender_helo_name}}
33254 .endd
33255 has two space-separated fields: an authorization code and a target host name.
33256 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
33257 authorization required but absent, or &"?"& for unknown.
33258
33259
33260
33261
33262 .section "Bounce address tag validation" "SECTverifyPRVS"
33263 .cindex "BATV, verifying"
33264 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
33265 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
33266 Genuine incoming bounce messages should therefore always be addressed to
33267 recipients that have a valid tag. This scheme is a way of detecting unwanted
33268 bounce messages caused by sender address forgeries (often called &"collateral
33269 spam"&), because the recipients of such messages do not include valid tags.
33270
33271 There are two expansion items to help with the implementation of the BATV
33272 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
33273 the original envelope sender address by using a simple key to add a hash of the
33274 address and some time-based randomizing information. The &%prvs%& expansion
33275 item creates a signed address, and the &%prvscheck%& expansion item checks one.
33276 The syntax of these expansion items is described in section
33277 &<<SECTexpansionitems>>&.
33278 The validity period on signed addresses is seven days.
33279
33280 As an example, suppose the secret per-address keys are stored in an MySQL
33281 database. A query to look up the key for an address could be defined as a macro
33282 like this:
33283 .code
33284 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
33285                 WHERE sender='${quote_mysql:$prvscheck_address}'\
33286                 }{$value}}
33287 .endd
33288 Suppose also that the senders who make use of BATV are defined by an address
33289 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
33290 use this:
33291 .code
33292 # Bounces: drop unsigned addresses for BATV senders
33293 deny senders = :
33294      recipients = +batv_senders
33295      message = This address does not send an unsigned reverse path
33296
33297 # Bounces: In case of prvs-signed address, check signature.
33298 deny senders = :
33299      condition  = ${prvscheck {$local_part@$domain}\
33300                   {PRVSCHECK_SQL}{1}}
33301      !condition = $prvscheck_result
33302      message = Invalid reverse path signature.
33303 .endd
33304 The first statement rejects recipients for bounce messages that are addressed
33305 to plain BATV sender addresses, because it is known that BATV senders do not
33306 send out messages with plain sender addresses. The second statement rejects
33307 recipients that are prvs-signed, but with invalid signatures (either because
33308 the key is wrong, or the signature has timed out).
33309
33310 A non-prvs-signed address is not rejected by the second statement, because the
33311 &%prvscheck%& expansion yields an empty string if its first argument is not a
33312 prvs-signed address, thus causing the &%condition%& condition to be false. If
33313 the first argument is a syntactically valid prvs-signed address, the yield is
33314 the third string (in this case &"1"&), whether or not the cryptographic and
33315 timeout checks succeed. The &$prvscheck_result$& variable contains the result
33316 of the checks (empty for failure, &"1"& for success).
33317
33318 There is one more issue you must consider when implementing prvs-signing:
33319 you have to ensure that the routers accept prvs-signed addresses and
33320 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
33321 router to remove the signature with a configuration along these lines:
33322 .code
33323 batv_redirect:
33324   driver = redirect
33325   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
33326 .endd
33327 This works because, if the third argument of &%prvscheck%& is empty, the result
33328 of the expansion of a prvs-signed address is the decoded value of the original
33329 address. This router should probably be the first of your routers that handles
33330 local addresses.
33331
33332 To create BATV-signed addresses in the first place, a transport of this form
33333 can be used:
33334 .code
33335 external_smtp_batv:
33336   driver = smtp
33337   return_path = ${prvs {$return_path} \
33338                        {${lookup mysql{SELECT \
33339                        secret FROM batv_prvs WHERE \
33340                        sender='${quote_mysql:$sender_address}'} \
33341                        {$value}fail}}}
33342 .endd
33343 If no key can be found for the existing return path, no signing takes place.
33344
33345
33346
33347 .section "Using an ACL to control relaying" "SECTrelaycontrol"
33348 .cindex "&ACL;" "relay control"
33349 .cindex "relaying" "control by ACL"
33350 .cindex "policy control" "relay control"
33351 An MTA is said to &'relay'& a message if it receives it from some host and
33352 delivers it directly to another host as a result of a remote address contained
33353 within it. Redirecting a local address via an alias or forward file and then
33354 passing the message on to another host is not relaying,
33355 .cindex "&""percent hack""&"
33356 but a redirection as a result of the &"percent hack"& is.
33357
33358 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
33359 A host which is acting as a gateway or an MX backup is concerned with incoming
33360 relaying from arbitrary hosts to a specific set of domains. On the other hand,
33361 a host which is acting as a smart host for a number of clients is concerned
33362 with outgoing relaying from those clients to the Internet at large. Often the
33363 same host is fulfilling both functions,
33364 . ///
33365 . as illustrated in the diagram below,
33366 . ///
33367 but in principle these two kinds of relaying are entirely independent. What is
33368 not wanted is the transmission of mail from arbitrary remote hosts through your
33369 system to arbitrary domains.
33370
33371
33372 You can implement relay control by means of suitable statements in the ACL that
33373 runs for each RCPT command. For convenience, it is often easiest to use
33374 Exim's named list facility to define the domains and hosts involved. For
33375 example, suppose you want to do the following:
33376
33377 .ilist
33378 Deliver a number of domains to mailboxes on the local host (or process them
33379 locally in some other way). Let's say these are &'my.dom1.example'& and
33380 &'my.dom2.example'&.
33381 .next
33382 Relay mail for a number of other domains for which you are the secondary MX.
33383 These might be &'friend1.example'& and &'friend2.example'&.
33384 .next
33385 Relay mail from the hosts on your local LAN, to whatever domains are involved.
33386 Suppose your LAN is 192.168.45.0/24.
33387 .endlist
33388
33389
33390 In the main part of the configuration, you put the following definitions:
33391 .code
33392 domainlist local_domains    = my.dom1.example : my.dom2.example
33393 domainlist relay_to_domains = friend1.example : friend2.example
33394 hostlist   relay_from_hosts = 192.168.45.0/24
33395 .endd
33396 Now you can use these definitions in the ACL that is run for every RCPT
33397 command:
33398 .code
33399 acl_check_rcpt:
33400   accept domains = +local_domains : +relay_to_domains
33401   accept hosts   = +relay_from_hosts
33402 .endd
33403 The first statement accepts any RCPT command that contains an address in
33404 the local or relay domains. For any other domain, control passes to the second
33405 statement, which accepts the command only if it comes from one of the relay
33406 hosts. In practice, you will probably want to make your ACL more sophisticated
33407 than this, for example, by including sender and recipient verification. The
33408 default configuration includes a more comprehensive example, which is described
33409 in chapter &<<CHAPdefconfil>>&.
33410
33411
33412
33413 .section "Checking a relay configuration" "SECTcheralcon"
33414 .cindex "relaying" "checking control of"
33415 You can check the relay characteristics of your configuration in the same way
33416 that you can test any ACL behaviour for an incoming SMTP connection, by using
33417 the &%-bh%& option to run a fake SMTP session with which you interact.
33418 .ecindex IIDacl
33419
33420
33421
33422 . ////////////////////////////////////////////////////////////////////////////
33423 . ////////////////////////////////////////////////////////////////////////////
33424
33425 .chapter "Content scanning at ACL time" "CHAPexiscan"
33426 .scindex IIDcosca "content scanning" "at ACL time"
33427 The extension of Exim to include content scanning at ACL time, formerly known
33428 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
33429 was integrated into the main source for Exim release 4.50, and Tom continues to
33430 maintain it. Most of the wording of this chapter is taken from Tom's
33431 specification.
33432
33433 It is also possible to scan the content of messages at other times. The
33434 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
33435 scanning after all the ACLs have run. A transport filter can be used to scan
33436 messages at delivery time (see the &%transport_filter%& option, described in
33437 chapter &<<CHAPtransportgeneric>>&).
33438
33439 If you want to include the ACL-time content-scanning features when you compile
33440 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
33441 &_Local/Makefile_&. When you do that, the Exim binary is built with:
33442
33443 .ilist
33444 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
33445 for all MIME parts for SMTP and non-SMTP messages, respectively.
33446 .next
33447 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
33448 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
33449 run at the end of message reception (the &%acl_smtp_data%& ACL).
33450 .next
33451 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
33452 of messages, or parts of messages, for debugging purposes.
33453 .next
33454 Additional expansion variables that are set in the new ACL and by the new
33455 conditions.
33456 .next
33457 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
33458 .endlist
33459
33460 Content-scanning is continually evolving, and new features are still being
33461 added. While such features are still unstable and liable to incompatible
33462 changes, they are made available in Exim by setting options whose names begin
33463 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
33464 this manual. You can find out about them by reading the file called
33465 &_doc/experimental.txt_&.
33466
33467 All the content-scanning facilities work on a MBOX copy of the message that is
33468 temporarily created in a file called:
33469 .display
33470 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
33471 .endd
33472 The &_.eml_& extension is a friendly hint to virus scanners that they can
33473 expect an MBOX-like structure inside that file. The file is created when the
33474 first content scanning facility is called. Subsequent calls to content
33475 scanning conditions open the same file again. The directory is recursively
33476 removed when the &%acl_smtp_data%& ACL has finished running, unless
33477 .code
33478 control = no_mbox_unspool
33479 .endd
33480 has been encountered. When the MIME ACL decodes files, they are put into the
33481 same directory by default.
33482
33483
33484
33485 .section "Scanning for viruses" "SECTscanvirus"
33486 .cindex "virus scanning"
33487 .cindex "content scanning" "for viruses"
33488 .cindex "content scanning" "the &%malware%& condition"
33489 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
33490 It supports a &"generic"& interface to scanners called via the shell, and
33491 specialized interfaces for &"daemon"& type virus scanners, which are resident
33492 in memory and thus are much faster.
33493
33494 Since message data needs to have arrived,
33495 the condition may be only called in ACL defined by
33496 &%acl_smtp_data%&,
33497 &%acl_smtp_data_prdr%&,
33498 &%acl_smtp_mime%& or
33499 &%acl_smtp_dkim%&
33500
33501 A timeout of 2 minutes is applied to a scanner call (by default);
33502 if it expires then a defer action is taken.
33503
33504 .oindex "&%av_scanner%&"
33505 You can set the &%av_scanner%& option in the main part of the configuration
33506 to specify which scanner to use, together with any additional options that
33507 are needed. The basic syntax is as follows:
33508 .display
33509 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
33510 .endd
33511 If you do not set &%av_scanner%&, it defaults to
33512 .code
33513 av_scanner = sophie:/var/run/sophie
33514 .endd
33515 If the value of &%av_scanner%& starts with a dollar character, it is expanded
33516 before use.
33517 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
33518 The following scanner types are supported in this release,
33519 though individual ones can be included or not at build time:
33520
33521 .vlist
33522 .vitem &%avast%&
33523 .cindex "virus scanners" "avast"
33524 This is the scanner daemon of Avast. It has been tested with Avast Core
33525 Security (currently at version 2.2.0).
33526 You can get a trial version at &url(https://www.avast.com) or for Linux
33527 at &url(https://www.avast.com/linux-server-antivirus).
33528 This scanner type takes one option,
33529 which can be either a full path to a UNIX socket,
33530 or host and port specifiers separated by white space.
33531 The host may be a name or an IP address; the port is either a
33532 single number or a pair of numbers with a dash between.
33533 A list of options may follow. These options are interpreted on the
33534 Exim's side of the malware scanner, or are given on separate lines to
33535 the daemon as options before the main scan command.
33536
33537 .cindex &`pass_unscanned`& "avast"
33538 If &`pass_unscanned`&
33539 is set, any files the Avast scanner can't scan (e.g.
33540 decompression bombs, or invalid archives) are considered clean. Use with
33541 care.
33542
33543 For example:
33544 .code
33545 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
33546 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
33547 av_scanner = avast:192.168.2.22 5036
33548 .endd
33549 If you omit the argument, the default path
33550 &_/var/run/avast/scan.sock_&
33551 is used.
33552 If you use a remote host,
33553 you need to make Exim's spool directory available to it,
33554 as the scanner is passed a file path, not file contents.
33555 For information about available commands and their options you may use
33556 .code
33557 $ socat UNIX:/var/run/avast/scan.sock STDIO:
33558     FLAGS
33559     SENSITIVITY
33560     PACK
33561 .endd
33562
33563 If the scanner returns a temporary failure (e.g. license issues, or
33564 permission problems), the message is deferred and a paniclog entry is
33565 written.  The usual &`defer_ok`& option is available.
33566
33567 .vitem &%aveserver%&
33568 .cindex "virus scanners" "Kaspersky"
33569 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
33570 at &url(https://www.kaspersky.com/). This scanner type takes one option,
33571 which is the path to the daemon's UNIX socket. The default is shown in this
33572 example:
33573 .code
33574 av_scanner = aveserver:/var/run/aveserver
33575 .endd
33576
33577
33578 .vitem &%clamd%&
33579 .cindex "virus scanners" "clamd"
33580 This daemon-type scanner is GPL and free. You can get it at
33581 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
33582 unpack MIME containers, so it used to be recommended to unpack MIME attachments
33583 in the MIME ACL. This is no longer believed to be necessary.
33584
33585 The options are a list of server specifiers, which may be
33586 a UNIX socket specification,
33587 a TCP socket specification,
33588 or a (global) option.
33589
33590 A socket specification consists of a space-separated list.
33591 For a Unix socket the first element is a full path for the socket,
33592 for a TCP socket the first element is the IP address
33593 and the second a port number,
33594 Any further elements are per-server (non-global) options.
33595 These per-server options are supported:
33596 .code
33597 retry=<timespec>        Retry on connect fail
33598 .endd
33599
33600 The &`retry`& option specifies a time after which a single retry for
33601 a failed connect is made.  The default is to not retry.
33602
33603 If a Unix socket file is specified, only one server is supported.
33604
33605 Examples:
33606 .code
33607 av_scanner = clamd:/opt/clamd/socket
33608 av_scanner = clamd:192.0.2.3 1234
33609 av_scanner = clamd:192.0.2.3 1234:local
33610 av_scanner = clamd:192.0.2.3 1234 retry=10s
33611 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
33612 .endd
33613 If the value of av_scanner points to a UNIX socket file or contains the
33614 &`local`&
33615 option, then the ClamAV interface will pass a filename containing the data
33616 to be scanned, which should normally result in less I/O happening and be
33617 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
33618 Exim does not assume that there is a common filesystem with the remote host.
33619
33620 The final example shows that multiple TCP targets can be specified.  Exim will
33621 randomly use one for each incoming email (i.e. it load balances them).  Note
33622 that only TCP targets may be used if specifying a list of scanners; a UNIX
33623 socket cannot be mixed in with TCP targets.  If one of the servers becomes
33624 unavailable, Exim will try the remaining one(s) until it finds one that works.
33625 When a clamd server becomes unreachable, Exim will log a message.  Exim does
33626 not keep track of scanner state between multiple messages, and the scanner
33627 selection is random, so the message will get logged in the mainlog for each
33628 email that the down scanner gets chosen first (message wrapped to be readable):
33629 .code
33630 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
33631    clamd: connection to localhost, port 3310 failed
33632    (Connection refused)
33633 .endd
33634
33635 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
33636 contributing the code for this scanner.
33637
33638 .vitem &%cmdline%&
33639 .cindex "virus scanners" "command line interface"
33640 This is the keyword for the generic command line scanner interface. It can be
33641 used to attach virus scanners that are invoked from the shell. This scanner
33642 type takes 3 mandatory options:
33643
33644 .olist
33645 The full path and name of the scanner binary, with all command line options,
33646 and a placeholder (&`%s`&) for the directory to scan.
33647
33648 .next
33649 A regular expression to match against the STDOUT and STDERR output of the
33650 virus scanner. If the expression matches, a virus was found. You must make
33651 absolutely sure that this expression matches on &"virus found"&. This is called
33652 the &"trigger"& expression.
33653
33654 .next
33655 Another regular expression, containing exactly one pair of parentheses, to
33656 match the name of the virus found in the scanners output. This is called the
33657 &"name"& expression.
33658 .endlist olist
33659
33660 For example, Sophos Sweep reports a virus on a line like this:
33661 .code
33662 Virus 'W32/Magistr-B' found in file ./those.bat
33663 .endd
33664 For the trigger expression, we can match the phrase &"found in file"&. For the
33665 name expression, we want to extract the W32/Magistr-B string, so we can match
33666 for the single quotes left and right of it. Altogether, this makes the
33667 configuration setting:
33668 .code
33669 av_scanner = cmdline:\
33670              /path/to/sweep -ss -all -rec -archive %s:\
33671              found in file:'(.+)'
33672 .endd
33673 .vitem &%drweb%&
33674 .cindex "virus scanners" "DrWeb"
33675 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
33676 takes one option,
33677 either a full path to a UNIX socket,
33678 or host and port specifiers separated by white space.
33679 The host may be a name or an IP address; the port is either a
33680 single number or a pair of numbers with a dash between.
33681 For example:
33682 .code
33683 av_scanner = drweb:/var/run/drwebd.sock
33684 av_scanner = drweb:192.168.2.20 31337
33685 .endd
33686 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
33687 is used. Thanks to Alex Miller for contributing the code for this scanner.
33688
33689 .vitem &%f-protd%&
33690 .cindex "virus scanners" "f-protd"
33691 The f-protd scanner is accessed via HTTP over TCP.
33692 One argument is taken, being a space-separated hostname and port number
33693 (or port-range).
33694 For example:
33695 .code
33696 av_scanner = f-protd:localhost 10200-10204
33697 .endd
33698 If you omit the argument, the default values shown above are used.
33699
33700 .vitem &%f-prot6d%&
33701 .cindex "virus scanners" "f-prot6d"
33702 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
33703 One argument is taken, being a space-separated hostname and port number.
33704 For example:
33705 .code
33706 av_scanner = f-prot6d:localhost 10200
33707 .endd
33708 If you omit the argument, the default values show above are used.
33709
33710 .vitem &%fsecure%&
33711 .cindex "virus scanners" "F-Secure"
33712 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
33713 argument which is the path to a UNIX socket. For example:
33714 .code
33715 av_scanner = fsecure:/path/to/.fsav
33716 .endd
33717 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
33718 Thelmen for contributing the code for this scanner.
33719
33720 .vitem &%kavdaemon%&
33721 .cindex "virus scanners" "Kaspersky"
33722 This is the scanner daemon of Kaspersky Version 4. This version of the
33723 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
33724 scanner type takes one option, which is the path to the daemon's UNIX socket.
33725 For example:
33726 .code
33727 av_scanner = kavdaemon:/opt/AVP/AvpCtl
33728 .endd
33729 The default path is &_/var/run/AvpCtl_&.
33730
33731 .vitem &%mksd%&
33732 .cindex "virus scanners" "mksd"
33733 This was a daemon type scanner that is aimed mainly at Polish users,
33734 though some documentation was available in English.
33735 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
33736 and this appears to be a candidate for removal from Exim, unless
33737 we are informed of other virus scanners which use the same protocol
33738 to integrate.
33739 The only option for this scanner type is
33740 the maximum number of processes used simultaneously to scan the attachments,
33741 provided that mksd has
33742 been run with at least the same number of child processes. For example:
33743 .code
33744 av_scanner = mksd:2
33745 .endd
33746 You can safely omit this option (the default value is 1).
33747
33748 .vitem &%sock%&
33749 .cindex "virus scanners" "simple socket-connected"
33750 This is a general-purpose way of talking to simple scanner daemons
33751 running on the local machine.
33752 There are four options:
33753 an address (which may be an IP address and port, or the path of a Unix socket),
33754 a commandline to send (may include a single %s which will be replaced with
33755 the path to the mail file to be scanned),
33756 an RE to trigger on from the returned data,
33757 and an RE to extract malware_name from the returned data.
33758 For example:
33759 .code
33760 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
33761 .endd
33762 Note that surrounding whitespace is stripped from each option, meaning
33763 there is no way to specify a trailing newline.
33764 The socket specifier and both regular-expressions are required.
33765 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
33766 specify an empty element to get this.
33767
33768 .vitem &%sophie%&
33769 .cindex "virus scanners" "Sophos and Sophie"
33770 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
33771 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
33772 for this scanner type is the path to the UNIX socket that Sophie uses for
33773 client communication. For example:
33774 .code
33775 av_scanner = sophie:/tmp/sophie
33776 .endd
33777 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
33778 the option.
33779 .endlist
33780
33781 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
33782 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
33783 ACL.
33784
33785 The &%av_scanner%& option is expanded each time &%malware%& is called. This
33786 makes it possible to use different scanners. See further below for an example.
33787 The &%malware%& condition caches its results, so when you use it multiple times
33788 for the same message, the actual scanning process is only carried out once.
33789 However, using expandable items in &%av_scanner%& disables this caching, in
33790 which case each use of the &%malware%& condition causes a new scan of the
33791 message.
33792
33793 The &%malware%& condition takes a right-hand argument that is expanded before
33794 use and taken as a list, slash-separated by default.
33795 The first element can then be one of
33796
33797 .ilist
33798 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
33799 The condition succeeds if a virus was found, and fail otherwise. This is the
33800 recommended usage.
33801 .next
33802 &"false"& or &"0"& or an empty string, in which case no scanning is done and
33803 the condition fails immediately.
33804 .next
33805 A regular expression, in which case the message is scanned for viruses. The
33806 condition succeeds if a virus is found and its name matches the regular
33807 expression. This allows you to take special actions on certain types of virus.
33808 Note that &"/"& characters in the RE must be doubled due to the list-processing,
33809 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
33810 .endlist
33811
33812 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
33813 messages even if there is a problem with the virus scanner.
33814 Otherwise, such a problem causes the ACL to defer.
33815
33816 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
33817 specify a non-default timeout.  The default is two minutes.
33818 For example:
33819 .code
33820 malware = * / defer_ok / tmo=10s
33821 .endd
33822 A timeout causes the ACL to defer.
33823
33824 .vindex "&$callout_address$&"
33825 When a connection is made to the scanner the expansion variable &$callout_address$&
33826 is set to record the actual address used.
33827
33828 .vindex "&$malware_name$&"
33829 When a virus is found, the condition sets up an expansion variable called
33830 &$malware_name$& that contains the name of the virus. You can use it in a
33831 &%message%& modifier that specifies the error returned to the sender, and/or in
33832 logging data.
33833
33834 Beware the interaction of Exim's &%message_size_limit%& with any size limits
33835 imposed by your anti-virus scanner.
33836
33837 Here is a very simple scanning example:
33838 .code
33839 deny malware = *
33840      message = This message contains malware ($malware_name)
33841 .endd
33842 The next example accepts messages when there is a problem with the scanner:
33843 .code
33844 deny malware = */defer_ok
33845      message = This message contains malware ($malware_name)
33846 .endd
33847 The next example shows how to use an ACL variable to scan with both sophie and
33848 aveserver. It assumes you have set:
33849 .code
33850 av_scanner = $acl_m0
33851 .endd
33852 in the main Exim configuration.
33853 .code
33854 deny set acl_m0 = sophie
33855      malware = *
33856      message = This message contains malware ($malware_name)
33857
33858 deny set acl_m0 = aveserver
33859      malware = *
33860      message = This message contains malware ($malware_name)
33861 .endd
33862
33863
33864 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
33865 .cindex "content scanning" "for spam"
33866 .cindex "spam scanning"
33867 .cindex "SpamAssassin"
33868 .cindex "Rspamd"
33869 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
33870 score and a report for the message.
33871 Support is also provided for Rspamd.
33872
33873 For more information about installation and configuration of SpamAssassin or
33874 Rspamd refer to their respective websites at
33875 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
33876
33877 SpamAssassin can be installed with CPAN by running:
33878 .code
33879 perl -MCPAN -e 'install Mail::SpamAssassin'
33880 .endd
33881 SpamAssassin has its own set of configuration files. Please review its
33882 documentation to see how you can tweak it. The default installation should work
33883 nicely, however.
33884
33885 .oindex "&%spamd_address%&"
33886 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
33887 intend to use an instance running on the local host you do not need to set
33888 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
33889 you must set the &%spamd_address%& option in the global part of the Exim
33890 configuration as follows (example):
33891 .code
33892 spamd_address = 192.168.99.45 783
33893 .endd
33894 The SpamAssassin protocol relies on a TCP half-close from the client.
33895 If your SpamAssassin client side is running a Linux system with an
33896 iptables firewall, consider setting
33897 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
33898 timeout, Exim uses when waiting for a response from the SpamAssassin
33899 server (currently defaulting to 120s).  With a lower value the Linux
33900 connection tracking may consider your half-closed connection as dead too
33901 soon.
33902
33903
33904 To use Rspamd (which by default listens on all local addresses
33905 on TCP port 11333)
33906 you should add &%variant=rspamd%& after the address/port pair, for example:
33907 .code
33908 spamd_address = 127.0.0.1 11333 variant=rspamd
33909 .endd
33910
33911 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
33912 sockets. If you want to us these, supply &%spamd_address%& with an absolute
33913 filename instead of an address/port pair:
33914 .code
33915 spamd_address = /var/run/spamd_socket
33916 .endd
33917 You can have multiple &%spamd%& servers to improve scalability. These can
33918 reside on other hardware reachable over the network. To specify multiple
33919 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
33920 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
33921 .code
33922 spamd_address = 192.168.2.10 783 : \
33923                 192.168.2.11 783 : \
33924                 192.168.2.12 783
33925 .endd
33926 Up to 32 &%spamd%& servers are supported.
33927 When a server fails to respond to the connection attempt, all other
33928 servers are tried until one succeeds. If no server responds, the &%spam%&
33929 condition defers.
33930
33931 Unix and TCP socket specifications may be mixed in any order.
33932 Each element of the list is a list itself, space-separated by default
33933 and changeable in the usual way (&<<SECTlistsepchange>>&);
33934 take care to not double the separator.
33935
33936 For TCP socket specifications a host name or IP (v4 or v6, but
33937 subject to list-separator quoting rules) address can be used,
33938 and the port can be one or a dash-separated pair.
33939 In the latter case, the range is tried in strict order.
33940
33941 Elements after the first for Unix sockets, or second for TCP socket,
33942 are options.
33943 The supported options are:
33944 .code
33945 pri=<priority>      Selection priority
33946 weight=<value>      Selection bias
33947 time=<start>-<end>  Use only between these times of day
33948 retry=<timespec>    Retry on connect fail
33949 tmo=<timespec>      Connection time limit
33950 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
33951 .endd
33952
33953 The &`pri`& option specifies a priority for the server within the list,
33954 higher values being tried first.
33955 The default priority is 1.
33956
33957 The &`weight`& option specifies a selection bias.
33958 Within a priority set
33959 servers are queried in a random fashion, weighted by this value.
33960 The default value for selection bias is 1.
33961
33962 Time specifications for the &`time`& option are <hour>.<minute>.<second>
33963 in the local time zone; each element being one or more digits.
33964 Either the seconds or both minutes and seconds, plus the leading &`.`&
33965 characters, may be omitted and will be taken as zero.
33966
33967 Timeout specifications for the &`retry`& and &`tmo`& options
33968 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
33969
33970 The &`tmo`& option specifies an overall timeout for communication.
33971 The default value is two minutes.
33972
33973 The &`retry`& option specifies a time after which a single retry for
33974 a failed connect is made.
33975 The default is to not retry.
33976
33977 The &%spamd_address%& variable is expanded before use if it starts with
33978 a dollar sign. In this case, the expansion may return a string that is
33979 used as the list so that multiple spamd servers can be the result of an
33980 expansion.
33981
33982 .vindex "&$callout_address$&"
33983 When a connection is made to the server the expansion variable &$callout_address$&
33984 is set to record the actual address used.
33985
33986 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
33987 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
33988 .code
33989 deny spam = joe
33990      message = This message was classified as SPAM
33991 .endd
33992 The right-hand side of the &%spam%& condition specifies a name. This is
33993 relevant if you have set up multiple SpamAssassin profiles. If you do not want
33994 to scan using a specific profile, but rather use the SpamAssassin system-wide
33995 default profile, you can scan for an unknown name, or simply use &"nobody"&.
33996 Rspamd does not use this setting. However, you must put something on the
33997 right-hand side.
33998
33999 The name allows you to use per-domain or per-user antispam profiles in
34000 principle, but this is not straightforward in practice, because a message may
34001 have multiple recipients, not necessarily all in the same domain. Because the
34002 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
34003 read the contents of the message, the variables &$local_part$& and &$domain$&
34004 are not set.
34005 Careful enforcement of single-recipient messages
34006 (e.g. by responding with defer in the recipient ACL for all recipients
34007 after the first),
34008 or the use of PRDR,
34009 .cindex "PRDR" "use for per-user SpamAssassin profiles"
34010 are needed to use this feature.
34011
34012 The right-hand side of the &%spam%& condition is expanded before being used, so
34013 you can put lookups or conditions there. When the right-hand side evaluates to
34014 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
34015
34016
34017 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
34018 large ones may cause significant performance degradation. As most spam messages
34019 are quite small, it is recommended that you do not scan the big ones. For
34020 example:
34021 .code
34022 deny condition = ${if < {$message_size}{10K}}
34023      spam = nobody
34024      message = This message was classified as SPAM
34025 .endd
34026
34027 The &%spam%& condition returns true if the threshold specified in the user's
34028 SpamAssassin profile has been matched or exceeded. If you want to use the
34029 &%spam%& condition for its side effects (see the variables below), you can make
34030 it always return &"true"& by appending &`:true`& to the username.
34031
34032 .cindex "spam scanning" "returned variables"
34033 When the &%spam%& condition is run, it sets up a number of expansion
34034 variables.
34035 Except for &$spam_report$&,
34036 these variables are saved with the received message so are
34037 available for use at delivery time.
34038
34039 .vlist
34040 .vitem &$spam_score$&
34041 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
34042 for inclusion in log or reject messages.
34043
34044 .vitem &$spam_score_int$&
34045 The spam score of the message, multiplied by ten, as an integer value. For
34046 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
34047 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
34048 The integer value is useful for numeric comparisons in conditions.
34049
34050 .vitem &$spam_bar$&
34051 A string consisting of a number of &"+"& or &"-"& characters, representing the
34052 integer part of the spam score value. A spam score of 4.4 would have a
34053 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
34054 headers, since MUAs can match on such strings. The maximum length of the
34055 spam bar is 50 characters.
34056
34057 .vitem &$spam_report$&
34058 A multiline text table, containing the full SpamAssassin report for the
34059 message. Useful for inclusion in headers or reject messages.
34060 This variable is only usable in a DATA-time ACL.
34061 Beware that SpamAssassin may return non-ASCII characters, especially
34062 when running in country-specific locales, which are not legal
34063 unencoded in headers.
34064
34065 .vitem &$spam_action$&
34066 For SpamAssassin either 'reject' or 'no action' depending on the
34067 spam score versus threshold.
34068 For Rspamd, the recommended action.
34069
34070 .endlist
34071
34072 The &%spam%& condition caches its results unless expansion in
34073 spamd_address was used. If you call it again with the same user name, it
34074 does not scan again, but rather returns the same values as before.
34075
34076 The &%spam%& condition returns DEFER if there is any error while running
34077 the message through SpamAssassin or if the expansion of spamd_address
34078 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
34079 statement block), append &`/defer_ok`& to the right-hand side of the
34080 spam condition, like this:
34081 .code
34082 deny spam    = joe/defer_ok
34083      message = This message was classified as SPAM
34084 .endd
34085 This causes messages to be accepted even if there is a problem with &%spamd%&.
34086
34087 Here is a longer, commented example of the use of the &%spam%&
34088 condition:
34089 .code
34090 # put headers in all messages (no matter if spam or not)
34091 warn  spam = nobody:true
34092       add_header = X-Spam-Score: $spam_score ($spam_bar)
34093       add_header = X-Spam-Report: $spam_report
34094
34095 # add second subject line with *SPAM* marker when message
34096 # is over threshold
34097 warn  spam = nobody
34098       add_header = Subject: *SPAM* $h_Subject:
34099
34100 # reject spam at high scores (> 12)
34101 deny  spam = nobody:true
34102       condition = ${if >{$spam_score_int}{120}{1}{0}}
34103       message = This message scored $spam_score spam points.
34104 .endd
34105
34106
34107
34108 .section "Scanning MIME parts" "SECTscanmimepart"
34109 .cindex "content scanning" "MIME parts"
34110 .cindex "MIME content scanning"
34111 .oindex "&%acl_smtp_mime%&"
34112 .oindex "&%acl_not_smtp_mime%&"
34113 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
34114 each MIME part of an SMTP message, including multipart types, in the sequence
34115 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
34116 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
34117 options may both refer to the same ACL if you want the same processing in both
34118 cases.
34119
34120 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
34121 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
34122 the case of a non-SMTP message. However, a MIME ACL is called only if the
34123 message contains a &'Content-Type:'& header line. When a call to a MIME
34124 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
34125 result code is sent to the client. In the case of an SMTP message, the
34126 &%acl_smtp_data%& ACL is not called when this happens.
34127
34128 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
34129 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
34130 condition to match against the raw MIME part. You can also use the
34131 &%mime_regex%& condition to match against the decoded MIME part (see section
34132 &<<SECTscanregex>>&).
34133
34134 At the start of a MIME ACL, a number of variables are set from the header
34135 information for the relevant MIME part. These are described below. The contents
34136 of the MIME part are not by default decoded into a disk file except for MIME
34137 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
34138 part into a disk file, you can use the &%decode%& condition. The general
34139 syntax is:
34140 .display
34141 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
34142 .endd
34143 The right hand side is expanded before use. After expansion,
34144 the value can be:
34145
34146 .olist
34147 &"0"& or &"false"&, in which case no decoding is done.
34148 .next
34149 The string &"default"&. In that case, the file is put in the temporary
34150 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
34151 a sequential filename consisting of the message id and a sequence number. The
34152 full path and name is available in &$mime_decoded_filename$& after decoding.
34153 .next
34154 A full path name starting with a slash. If the full name is an existing
34155 directory, it is used as a replacement for the default directory. The filename
34156 is then sequentially assigned. If the path does not exist, it is used as
34157 the full path and filename.
34158 .next
34159 If the string does not start with a slash, it is used as the
34160 filename, and the default path is then used.
34161 .endlist
34162 The &%decode%& condition normally succeeds. It is only false for syntax
34163 errors or unusual circumstances such as memory shortages. You can easily decode
34164 a file with its original, proposed filename using
34165 .code
34166 decode = $mime_filename
34167 .endd
34168 However, you should keep in mind that &$mime_filename$& might contain
34169 anything. If you place files outside of the default path, they are not
34170 automatically unlinked.
34171
34172 For RFC822 attachments (these are messages attached to messages, with a
34173 content-type of &"message/rfc822"&), the ACL is called again in the same manner
34174 as for the primary message, only that the &$mime_is_rfc822$& expansion
34175 variable is set (see below). Attached messages are always decoded to disk
34176 before being checked, and the files are unlinked once the check is done.
34177
34178 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
34179 used to match regular expressions against raw and decoded MIME parts,
34180 respectively. They are described in section &<<SECTscanregex>>&.
34181
34182 .cindex "MIME content scanning" "returned variables"
34183 The following list describes all expansion variables that are
34184 available in the MIME ACL:
34185
34186 .vlist
34187 .vitem &$mime_anomaly_level$& &&&
34188        &$mime_anomaly_text$&
34189 .vindex &$mime_anomaly_level$&
34190 .vindex &$mime_anomaly_text$&
34191 If there are problems decoding, these variables contain information on
34192 the detected issue.
34193
34194 .vitem &$mime_boundary$&
34195 .vindex &$mime_boundary$&
34196 If the current part is a multipart (see &$mime_is_multipart$& below), it should
34197 have a boundary string, which is stored in this variable. If the current part
34198 has no boundary parameter in the &'Content-Type:'& header, this variable
34199 contains the empty string.
34200
34201 .vitem &$mime_charset$&
34202 .vindex &$mime_charset$&
34203 This variable contains the character set identifier, if one was found in the
34204 &'Content-Type:'& header. Examples for charset identifiers are:
34205 .code
34206 us-ascii
34207 gb2312 (Chinese)
34208 iso-8859-1
34209 .endd
34210 Please note that this value is not normalized, so you should do matches
34211 case-insensitively.
34212
34213 .vitem &$mime_content_description$&
34214 .vindex &$mime_content_description$&
34215 This variable contains the normalized content of the &'Content-Description:'&
34216 header. It can contain a human-readable description of the parts content. Some
34217 implementations repeat the filename for attachments here, but they are usually
34218 only used for display purposes.
34219
34220 .vitem &$mime_content_disposition$&
34221 .vindex &$mime_content_disposition$&
34222 This variable contains the normalized content of the &'Content-Disposition:'&
34223 header. You can expect strings like &"attachment"& or &"inline"& here.
34224
34225 .vitem &$mime_content_id$&
34226 .vindex &$mime_content_id$&
34227 This variable contains the normalized content of the &'Content-ID:'& header.
34228 This is a unique ID that can be used to reference a part from another part.
34229
34230 .vitem &$mime_content_size$&
34231 .vindex &$mime_content_size$&
34232 This variable is set only after the &%decode%& modifier (see above) has been
34233 successfully run. It contains the size of the decoded part in kilobytes. The
34234 size is always rounded up to full kilobytes, so only a completely empty part
34235 has a &$mime_content_size$& of zero.
34236
34237 .vitem &$mime_content_transfer_encoding$&
34238 .vindex &$mime_content_transfer_encoding$&
34239 This variable contains the normalized content of the
34240 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
34241 type. Typical values are &"base64"& and &"quoted-printable"&.
34242
34243 .vitem &$mime_content_type$&
34244 .vindex &$mime_content_type$&
34245 If the MIME part has a &'Content-Type:'& header, this variable contains its
34246 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
34247 are some examples of popular MIME types, as they may appear in this variable:
34248 .code
34249 text/plain
34250 text/html
34251 application/octet-stream
34252 image/jpeg
34253 audio/midi
34254 .endd
34255 If the MIME part has no &'Content-Type:'& header, this variable contains the
34256 empty string.
34257
34258 .vitem &$mime_decoded_filename$&
34259 .vindex &$mime_decoded_filename$&
34260 This variable is set only after the &%decode%& modifier (see above) has been
34261 successfully run. It contains the full path and filename of the file
34262 containing the decoded data.
34263 .endlist
34264
34265 .cindex "RFC 2047"
34266 .vlist
34267 .vitem &$mime_filename$&
34268 .vindex &$mime_filename$&
34269 This is perhaps the most important of the MIME variables. It contains a
34270 proposed filename for an attachment, if one was found in either the
34271 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
34272 RFC2047
34273 or RFC2231
34274 decoded, but no additional sanity checks are done.
34275  If no filename was
34276 found, this variable contains the empty string.
34277
34278 .vitem &$mime_is_coverletter$&
34279 .vindex &$mime_is_coverletter$&
34280 This variable attempts to differentiate the &"cover letter"& of an e-mail from
34281 attached data. It can be used to clamp down on flashy or unnecessarily encoded
34282 content in the cover letter, while not restricting attachments at all.
34283
34284 The variable contains 1 (true) for a MIME part believed to be part of the
34285 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
34286 follows:
34287
34288 .olist
34289 The outermost MIME part of a message is always a cover letter.
34290
34291 .next
34292 If a multipart/alternative or multipart/related MIME part is a cover letter,
34293 so are all MIME subparts within that multipart.
34294
34295 .next
34296 If any other multipart is a cover letter, the first subpart is a cover letter,
34297 and the rest are attachments.
34298
34299 .next
34300 All parts contained within an attachment multipart are attachments.
34301 .endlist olist
34302
34303 As an example, the following will ban &"HTML mail"& (including that sent with
34304 alternative plain text), while allowing HTML files to be attached. HTML
34305 coverletter mail attached to non-HTML coverletter mail will also be allowed:
34306 .code
34307 deny !condition = $mime_is_rfc822
34308      condition = $mime_is_coverletter
34309      condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
34310      message = HTML mail is not accepted here
34311 .endd
34312
34313 .vitem &$mime_is_multipart$&
34314 .vindex &$mime_is_multipart$&
34315 This variable has the value 1 (true) when the current part has the main type
34316 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
34317 Since multipart entities only serve as containers for other parts, you may not
34318 want to carry out specific actions on them.
34319
34320 .vitem &$mime_is_rfc822$&
34321 .vindex &$mime_is_rfc822$&
34322 This variable has the value 1 (true) if the current part is not a part of the
34323 checked message itself, but part of an attached message. Attached message
34324 decoding is fully recursive.
34325
34326 .vitem &$mime_part_count$&
34327 .vindex &$mime_part_count$&
34328 This variable is a counter that is raised for each processed MIME part. It
34329 starts at zero for the very first part (which is usually a multipart). The
34330 counter is per-message, so it is reset when processing RFC822 attachments (see
34331 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
34332 complete, so you can use it in the DATA ACL to determine the number of MIME
34333 parts of a message. For non-MIME messages, this variable contains the value -1.
34334 .endlist
34335
34336
34337
34338 .section "Scanning with regular expressions" "SECTscanregex"
34339 .cindex "content scanning" "with regular expressions"
34340 .cindex "regular expressions" "content scanning with"
34341 You can specify your own custom regular expression matches on the full body of
34342 the message, or on individual MIME parts.
34343
34344 The &%regex%& condition takes one or more regular expressions as arguments and
34345 matches them against the full message (when called in the DATA ACL) or a raw
34346 MIME part (when called in the MIME ACL). The &%regex%& condition matches
34347 linewise, with a maximum line length of 32K characters. That means you cannot
34348 have multiline matches with the &%regex%& condition.
34349
34350 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
34351 to 32K of decoded content (the whole content at once, not linewise). If the
34352 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
34353 is decoded automatically when &%mime_regex%& is executed (using default path
34354 and filename values). If the decoded data is larger than  32K, only the first
34355 32K characters are checked.
34356
34357 The regular expressions are passed as a colon-separated list. To include a
34358 literal colon, you must double it. Since the whole right-hand side string is
34359 expanded before being used, you must also escape dollar signs and backslashes
34360 with more backslashes, or use the &`\N`& facility to disable expansion.
34361 Here is a simple example that contains two regular expressions:
34362 .code
34363 deny regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
34364      message = contains blacklisted regex ($regex_match_string)
34365 .endd
34366 The conditions returns true if any one of the regular expressions matches. The
34367 &$regex_match_string$& expansion variable is then set up and contains the
34368 matching regular expression.
34369 The expansion variables &$regex1$& &$regex2$& etc
34370 are set to any substrings captured by the regular expression.
34371
34372 &*Warning*&: With large messages, these conditions can be fairly
34373 CPU-intensive.
34374
34375 .ecindex IIDcosca
34376
34377
34378
34379
34380 . ////////////////////////////////////////////////////////////////////////////
34381 . ////////////////////////////////////////////////////////////////////////////
34382
34383 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
34384          "Local scan function"
34385 .scindex IIDlosca "&[local_scan()]& function" "description of"
34386 .cindex "customizing" "input scan using C function"
34387 .cindex "policy control" "by local scan function"
34388 In these days of email worms, viruses, and ever-increasing spam, some sites
34389 want to apply a lot of checking to messages before accepting them.
34390
34391 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
34392 passing messages to external virus and spam scanning software. You can also do
34393 a certain amount in Exim itself through string expansions and the &%condition%&
34394 condition in the ACL that runs after the SMTP DATA command or the ACL for
34395 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
34396
34397 To allow for further customization to a site's own requirements, there is the
34398 possibility of linking Exim with a private message scanning function, written
34399 in C. If you want to run code that is written in something other than C, you
34400 can of course use a little C stub to call it.
34401
34402 The local scan function is run once for every incoming message, at the point
34403 when Exim is just about to accept the message.
34404 It can therefore be used to control non-SMTP messages from local processes as
34405 well as messages arriving via SMTP.
34406
34407 Exim applies a timeout to calls of the local scan function, and there is an
34408 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
34409 Zero means &"no timeout"&.
34410 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
34411 before calling the local scan function, so that the most common types of crash
34412 are caught. If the timeout is exceeded or one of those signals is caught, the
34413 incoming message is rejected with a temporary error if it is an SMTP message.
34414 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
34415 code. The incident is logged on the main and reject logs.
34416
34417
34418
34419 .section "Building Exim to use a local scan function" "SECID207"
34420 .cindex "&[local_scan()]& function" "building Exim to use"
34421 To make use of the local scan function feature, you must tell Exim where your
34422 function is before building Exim, by setting
34423 both HAVE_LOCAL_SCAN and
34424 LOCAL_SCAN_SOURCE in your
34425 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
34426 directory, so you might set
34427 .code
34428 HAVE_LOCAL_SCAN=yes
34429 LOCAL_SCAN_SOURCE=Local/local_scan.c
34430 .endd
34431 for example. The function must be called &[local_scan()]&;
34432 the source file(s) for it should first #define LOCAL_SCAN
34433 and then #include "local_scan.h".
34434 It is called by
34435 Exim after it has received a message, when the success return code is about to
34436 be sent. This is after all the ACLs have been run. The return code from your
34437 function controls whether the message is actually accepted or not. There is a
34438 commented template function (that just accepts the message) in the file
34439 _src/local_scan.c_.
34440
34441 If you want to make use of Exim's runtime configuration file to set options
34442 for your &[local_scan()]& function, you must also set
34443 .code
34444 LOCAL_SCAN_HAS_OPTIONS=yes
34445 .endd
34446 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
34447
34448
34449
34450
34451 .section "API for local_scan()" "SECTapiforloc"
34452 .cindex "&[local_scan()]& function" "API description"
34453 .cindex &%dlfunc%& "API description"
34454 You must include this line near the start of your code:
34455 .code
34456 #define LOCAL_SCAN
34457 #include "local_scan.h"
34458 .endd
34459 This header file defines a number of variables and other values, and the
34460 prototype for the function itself. Exim is coded to use unsigned char values
34461 almost exclusively, and one of the things this header defines is a shorthand
34462 for &`unsigned char`& called &`uschar`&.
34463 It also makes available the following macro definitions, to simplify casting character
34464 strings and pointers to character strings:
34465 .code
34466 #define CS   (char *)
34467 #define CCS  (const char *)
34468 #define CSS  (char **)
34469 #define US   (unsigned char *)
34470 #define CUS  (const unsigned char *)
34471 #define USS  (unsigned char **)
34472 .endd
34473 The function prototype for &[local_scan()]& is:
34474 .code
34475 extern int local_scan(int fd, uschar **return_text);
34476 .endd
34477 The arguments are as follows:
34478
34479 .ilist
34480 &%fd%& is a file descriptor for the file that contains the body of the message
34481 (the -D file). The file is open for reading and writing, but updating it is not
34482 recommended. &*Warning*&: You must &'not'& close this file descriptor.
34483
34484 The descriptor is positioned at character 19 of the file, which is the first
34485 character of the body itself, because the first 19 characters are the message
34486 id followed by &`-D`& and a newline. If you rewind the file, you should use the
34487 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
34488 case this changes in some future version.
34489 .next
34490 &%return_text%& is an address which you can use to return a pointer to a text
34491 string at the end of the function. The value it points to on entry is NULL.
34492 .endlist
34493
34494 The function must return an &%int%& value which is one of the following macros:
34495
34496 .vlist
34497 .vitem &`LOCAL_SCAN_ACCEPT`&
34498 .vindex "&$local_scan_data$&"
34499 The message is accepted. If you pass back a string of text, it is saved with
34500 the message, and made available in the variable &$local_scan_data$&. No
34501 newlines are permitted (if there are any, they are turned into spaces) and the
34502 maximum length of text is 1000 characters.
34503
34504 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
34505 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34506 queued without immediate delivery, and is frozen.
34507
34508 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
34509 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
34510 queued without immediate delivery.
34511
34512 .vitem &`LOCAL_SCAN_REJECT`&
34513 The message is rejected; the returned text is used as an error message which is
34514 passed back to the sender and which is also logged. Newlines are permitted &--
34515 they cause a multiline response for SMTP rejections, but are converted to
34516 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
34517 used.
34518
34519 .vitem &`LOCAL_SCAN_TEMPREJECT`&
34520 The message is temporarily rejected; the returned text is used as an error
34521 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
34522 problem"& is used.
34523
34524 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
34525 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
34526 message is not written to the reject log. It has the effect of unsetting the
34527 &%rejected_header%& log selector for just this rejection. If
34528 &%rejected_header%& is already unset (see the discussion of the
34529 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
34530 same as LOCAL_SCAN_REJECT.
34531
34532 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
34533 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
34534 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
34535 .endlist
34536
34537 If the message is not being received by interactive SMTP, rejections are
34538 reported by writing to &%stderr%& or by sending an email, as configured by the
34539 &%-oe%& command line options.
34540
34541
34542
34543 .section "Configuration options for local_scan()" "SECTconoptloc"
34544 .cindex "&[local_scan()]& function" "configuration options"
34545 It is possible to have option settings in the main configuration file
34546 that set values in static variables in the &[local_scan()]& module. If you
34547 want to do this, you must have the line
34548 .code
34549 LOCAL_SCAN_HAS_OPTIONS=yes
34550 .endd
34551 in your &_Local/Makefile_& when you build Exim. (This line is in
34552 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
34553 file, you must define static variables to hold the option values, and a table
34554 to define them.
34555
34556 The table must be a vector called &%local_scan_options%&, of type
34557 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
34558 and a pointer to the variable that holds the value. The entries must appear in
34559 alphabetical order. Following &%local_scan_options%& you must also define a
34560 variable called &%local_scan_options_count%& that contains the number of
34561 entries in the table. Here is a short example, showing two kinds of option:
34562 .code
34563 static int my_integer_option = 42;
34564 static uschar *my_string_option = US"a default string";
34565
34566 optionlist local_scan_options[] = {
34567   { "my_integer", opt_int,       &my_integer_option },
34568   { "my_string",  opt_stringptr, &my_string_option }
34569 };
34570
34571 int local_scan_options_count =
34572   sizeof(local_scan_options)/sizeof(optionlist);
34573 .endd
34574 The values of the variables can now be changed from Exim's runtime
34575 configuration file by including a local scan section as in this example:
34576 .code
34577 begin local_scan
34578 my_integer = 99
34579 my_string = some string of text...
34580 .endd
34581 The available types of option data are as follows:
34582
34583 .vlist
34584 .vitem &*opt_bool*&
34585 This specifies a boolean (true/false) option. The address should point to a
34586 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
34587 that are defined as &"1"& and &"0"&, respectively. If you want to detect
34588 whether such a variable has been set at all, you can initialize it to
34589 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
34590 values.)
34591
34592 .vitem &*opt_fixed*&
34593 This specifies a fixed point number, such as is used for load averages.
34594 The address should point to a variable of type &`int`&. The value is stored
34595 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
34596
34597 .vitem &*opt_int*&
34598 This specifies an integer; the address should point to a variable of type
34599 &`int`&. The value may be specified in any of the integer formats accepted by
34600 Exim.
34601
34602 .vitem &*opt_mkint*&
34603 This is the same as &%opt_int%&, except that when such a value is output in a
34604 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
34605 printed with the suffix K or M.
34606
34607 .vitem &*opt_octint*&
34608 This also specifies an integer, but the value is always interpreted as an
34609 octal integer, whether or not it starts with the digit zero, and it is
34610 always output in octal.
34611
34612 .vitem &*opt_stringptr*&
34613 This specifies a string value; the address must be a pointer to a
34614 variable that points to a string (for example, of type &`uschar *`&).
34615
34616 .vitem &*opt_time*&
34617 This specifies a time interval value. The address must point to a variable of
34618 type &`int`&. The value that is placed there is a number of seconds.
34619 .endlist
34620
34621 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
34622 out the values of all the &[local_scan()]& options.
34623
34624
34625
34626 .section "Available Exim variables" "SECID208"
34627 .cindex "&[local_scan()]& function" "available Exim variables"
34628 The header &_local_scan.h_& gives you access to a number of C variables. These
34629 are the only ones that are guaranteed to be maintained from release to release.
34630 Note, however, that you can obtain the value of any Exim expansion variable,
34631 including &$recipients$&, by calling &'expand_string()'&. The exported
34632 C variables are as follows:
34633
34634 .vlist
34635 .vitem &*int&~body_linecount*&
34636 This variable contains the number of lines in the message's body.
34637 It is not valid if the &%spool_files_wireformat%& option is used.
34638
34639 .vitem &*int&~body_zerocount*&
34640 This variable contains the number of binary zero bytes in the message's body.
34641 It is not valid if the &%spool_files_wireformat%& option is used.
34642
34643 .vitem &*unsigned&~int&~debug_selector*&
34644 This variable is set to zero when no debugging is taking place. Otherwise, it
34645 is a bitmap of debugging selectors. Two bits are identified for use in
34646 &[local_scan()]&; they are defined as macros:
34647
34648 .ilist
34649 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
34650 testing option that is not privileged &-- any caller may set it. All the
34651 other selector bits can be set only by admin users.
34652
34653 .next
34654 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
34655 by the &`+local_scan`& debug selector. It is not included in the default set
34656 of debugging bits.
34657 .endlist ilist
34658
34659 Thus, to write to the debugging output only when &`+local_scan`& has been
34660 selected, you should use code like this:
34661 .code
34662 if ((debug_selector & D_local_scan) != 0)
34663   debug_printf("xxx", ...);
34664 .endd
34665 .vitem &*uschar&~*expand_string_message*&
34666 After a failing call to &'expand_string()'& (returned value NULL), the
34667 variable &%expand_string_message%& contains the error message, zero-terminated.
34668
34669 .vitem &*header_line&~*header_list*&
34670 A pointer to a chain of header lines. The &%header_line%& structure is
34671 discussed below.
34672
34673 .vitem &*header_line&~*header_last*&
34674 A pointer to the last of the header lines.
34675
34676 .vitem &*uschar&~*headers_charset*&
34677 The value of the &%headers_charset%& configuration option.
34678
34679 .vitem &*BOOL&~host_checking*&
34680 This variable is TRUE during a host checking session that is initiated by the
34681 &%-bh%& command line option.
34682
34683 .vitem &*uschar&~*interface_address*&
34684 The IP address of the interface that received the message, as a string. This
34685 is NULL for locally submitted messages.
34686
34687 .vitem &*int&~interface_port*&
34688 The port on which this message was received. When testing with the &%-bh%&
34689 command line option, the value of this variable is -1 unless a port has been
34690 specified via the &%-oMi%& option.
34691
34692 .vitem &*uschar&~*message_id*&
34693 This variable contains Exim's message id for the incoming message (the value of
34694 &$message_exim_id$&) as a zero-terminated string.
34695
34696 .vitem &*uschar&~*received_protocol*&
34697 The name of the protocol by which the message was received.
34698
34699 .vitem &*int&~recipients_count*&
34700 The number of accepted recipients.
34701
34702 .vitem &*recipient_item&~*recipients_list*&
34703 .cindex "recipient" "adding in local scan"
34704 .cindex "recipient" "removing in local scan"
34705 The list of accepted recipients, held in a vector of length
34706 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
34707 can add additional recipients by calling &'receive_add_recipient()'& (see
34708 below). You can delete recipients by removing them from the vector and
34709 adjusting the value in &%recipients_count%&. In particular, by setting
34710 &%recipients_count%& to zero you remove all recipients. If you then return the
34711 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
34712 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
34713 and then call &'receive_add_recipient()'& as often as needed.
34714
34715 .vitem &*uschar&~*sender_address*&
34716 The envelope sender address. For bounce messages this is the empty string.
34717
34718 .vitem &*uschar&~*sender_host_address*&
34719 The IP address of the sending host, as a string. This is NULL for
34720 locally-submitted messages.
34721
34722 .vitem &*uschar&~*sender_host_authenticated*&
34723 The name of the authentication mechanism that was used, or NULL if the message
34724 was not received over an authenticated SMTP connection.
34725
34726 .vitem &*uschar&~*sender_host_name*&
34727 The name of the sending host, if known.
34728
34729 .vitem &*int&~sender_host_port*&
34730 The port on the sending host.
34731
34732 .vitem &*BOOL&~smtp_input*&
34733 This variable is TRUE for all SMTP input, including BSMTP.
34734
34735 .vitem &*BOOL&~smtp_batched_input*&
34736 This variable is TRUE for BSMTP input.
34737
34738 .vitem &*int&~store_pool*&
34739 The contents of this variable control which pool of memory is used for new
34740 requests. See section &<<SECTmemhanloc>>& for details.
34741 .endlist
34742
34743
34744 .section "Structure of header lines" "SECID209"
34745 The &%header_line%& structure contains the members listed below.
34746 You can add additional header lines by calling the &'header_add()'& function
34747 (see below). You can cause header lines to be ignored (deleted) by setting
34748 their type to *.
34749
34750
34751 .vlist
34752 .vitem &*struct&~header_line&~*next*&
34753 A pointer to the next header line, or NULL for the last line.
34754
34755 .vitem &*int&~type*&
34756 A code identifying certain headers that Exim recognizes. The codes are printing
34757 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
34758 Notice in particular that any header line whose type is * is not transmitted
34759 with the message. This flagging is used for header lines that have been
34760 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
34761 lines.) Effectively, * means &"deleted"&.
34762
34763 .vitem &*int&~slen*&
34764 The number of characters in the header line, including the terminating and any
34765 internal newlines.
34766
34767 .vitem &*uschar&~*text*&
34768 A pointer to the text of the header. It always ends with a newline, followed by
34769 a zero byte. Internal newlines are preserved.
34770 .endlist
34771
34772
34773
34774 .section "Structure of recipient items" "SECID210"
34775 The &%recipient_item%& structure contains these members:
34776
34777 .vlist
34778 .vitem &*uschar&~*address*&
34779 This is a pointer to the recipient address as it was received.
34780
34781 .vitem &*int&~pno*&
34782 This is used in later Exim processing when top level addresses are created by
34783 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
34784 and must always contain -1 at this stage.
34785
34786 .vitem &*uschar&~*errors_to*&
34787 If this value is not NULL, bounce messages caused by failing to deliver to the
34788 recipient are sent to the address it contains. In other words, it overrides the
34789 envelope sender for this one recipient. (Compare the &%errors_to%& generic
34790 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
34791 an unqualified address, Exim qualifies it using the domain from
34792 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
34793 is NULL for all recipients.
34794 .endlist
34795
34796
34797
34798 .section "Available Exim functions" "SECID211"
34799 .cindex "&[local_scan()]& function" "available Exim functions"
34800 The header &_local_scan.h_& gives you access to a number of Exim functions.
34801 These are the only ones that are guaranteed to be maintained from release to
34802 release:
34803
34804 .vlist
34805 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
34806        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
34807
34808 This function creates a child process that runs the command specified by
34809 &%argv%&. The environment for the process is specified by &%envp%&, which can
34810 be NULL if no environment variables are to be passed. A new umask is supplied
34811 for the process in &%newumask%&.
34812
34813 Pipes to the standard input and output of the new process are set up
34814 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
34815 standard error is cloned to the standard output. If there are any file
34816 descriptors &"in the way"& in the new process, they are closed. If the final
34817 argument is TRUE, the new process is made into a process group leader.
34818
34819 The function returns the pid of the new process, or -1 if things go wrong.
34820
34821 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
34822 This function waits for a child process to terminate, or for a timeout (in
34823 seconds) to expire. A timeout value of zero means wait as long as it takes. The
34824 return value is as follows:
34825
34826 .ilist
34827 >= 0
34828
34829 The process terminated by a normal exit and the value is the process
34830 ending status.
34831
34832 .next
34833 < 0 and > &--256
34834
34835 The process was terminated by a signal and the value is the negation of the
34836 signal number.
34837
34838 .next
34839 &--256
34840
34841 The process timed out.
34842 .next
34843 &--257
34844
34845 The was some other error in wait(); &%errno%& is still set.
34846 .endlist
34847
34848 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
34849 This function provide you with a means of submitting a new message to
34850 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
34851 want, but this packages it all up for you.) The function creates a pipe,
34852 forks a subprocess that is running
34853 .code
34854 exim -t -oem -oi -f <>
34855 .endd
34856 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
34857 that is connected to the standard input. The yield of the function is the PID
34858 of the subprocess. You can then write a message to the file descriptor, with
34859 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
34860
34861 When you have finished, call &'child_close()'& to wait for the process to
34862 finish and to collect its ending status. A timeout value of zero is usually
34863 fine in this circumstance. Unless you have made a mistake with the recipient
34864 addresses, you should get a return code of zero.
34865
34866
34867 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
34868        *sender_authentication)*&
34869 This function is a more sophisticated version of &'child_open()'&. The command
34870 that it runs is:
34871 .display
34872 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
34873 .endd
34874 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
34875
34876
34877 .vitem &*void&~debug_printf(char&~*,&~...)*&
34878 This is Exim's debugging function, with arguments as for &'(printf()'&. The
34879 output is written to the standard error stream. If no debugging is selected,
34880 calls to &'debug_printf()'& have no effect. Normally, you should make calls
34881 conditional on the &`local_scan`& debug selector by coding like this:
34882 .code
34883 if ((debug_selector & D_local_scan) != 0)
34884   debug_printf("xxx", ...);
34885 .endd
34886
34887 .vitem &*uschar&~*expand_string(uschar&~*string)*&
34888 This is an interface to Exim's string expansion code. The return value is the
34889 expanded string, or NULL if there was an expansion failure.
34890 The C variable &%expand_string_message%& contains an error message after an
34891 expansion failure. If expansion does not change the string, the return value is
34892 the pointer to the input string. Otherwise, the return value points to a new
34893 block of memory that was obtained by a call to &'store_get()'&. See section
34894 &<<SECTmemhanloc>>& below for a discussion of memory handling.
34895
34896 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
34897 This function allows you to an add additional header line at the end of the
34898 existing ones. The first argument is the type, and should normally be a space
34899 character. The second argument is a format string and any number of
34900 substitution arguments as for &[sprintf()]&. You may include internal newlines
34901 if you want, and you must ensure that the string ends with a newline.
34902
34903 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
34904         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
34905 This function adds a new header line at a specified point in the header
34906 chain. The header itself is specified as for &'header_add()'&.
34907
34908 If &%name%& is NULL, the new header is added at the end of the chain if
34909 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
34910 NULL, the header lines are searched for the first non-deleted header that
34911 matches the name. If one is found, the new header is added before it if
34912 &%after%& is false. If &%after%& is true, the new header is added after the
34913 found header and any adjacent subsequent ones with the same name (even if
34914 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
34915 option controls where the header is added. If it is true, addition is at the
34916 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
34917 headers, or at the top if there are no &'Received:'& headers, you could use
34918 .code
34919 header_add_at_position(TRUE, US"Received", TRUE,
34920   ' ', "X-xxx: ...");
34921 .endd
34922 Normally, there is always at least one non-deleted &'Received:'& header, but
34923 there may not be if &%received_header_text%& expands to an empty string.
34924
34925
34926 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
34927 This function removes header lines. If &%occurrence%& is zero or negative, all
34928 occurrences of the header are removed. If occurrence is greater than zero, that
34929 particular instance of the header is removed. If no header(s) can be found that
34930 match the specification, the function does nothing.
34931
34932
34933 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
34934         int&~length,&~BOOL&~notdel)*&"
34935 This function tests whether the given header has the given name. It is not just
34936 a string comparison, because white space is permitted between the name and the
34937 colon. If the &%notdel%& argument is true, a false return is forced for all
34938 &"deleted"& headers; otherwise they are not treated specially. For example:
34939 .code
34940 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
34941 .endd
34942 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
34943 .cindex "base64 encoding" "functions for &[local_scan()]& use"
34944 This function base64-encodes a string, which is passed by address and length.
34945 The text may contain bytes of any value, including zero. The result is passed
34946 back in dynamic memory that is obtained by calling &'store_get()'&. It is
34947 zero-terminated.
34948
34949 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
34950 This function decodes a base64-encoded string. Its arguments are a
34951 zero-terminated base64-encoded string and the address of a variable that is set
34952 to point to the result, which is in dynamic memory. The length of the decoded
34953 string is the yield of the function. If the input is invalid base64 data, the
34954 yield is -1. A zero byte is added to the end of the output string to make it
34955 easy to interpret as a C string (assuming it contains no zeros of its own). The
34956 added zero byte is not included in the returned count.
34957
34958 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
34959 This function checks for a match in a domain list. Domains are always
34960 matched caselessly. The return value is one of the following:
34961 .display
34962 &`OK     `& match succeeded
34963 &`FAIL   `& match failed
34964 &`DEFER  `& match deferred
34965 .endd
34966 DEFER is usually caused by some kind of lookup defer, such as the
34967 inability to contact a database.
34968
34969 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
34970         BOOL&~caseless)*&"
34971 This function checks for a match in a local part list. The third argument
34972 controls case-sensitivity. The return values are as for
34973 &'lss_match_domain()'&.
34974
34975 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
34976         BOOL&~caseless)*&"
34977 This function checks for a match in an address list. The third argument
34978 controls the case-sensitivity of the local part match. The domain is always
34979 matched caselessly. The return values are as for &'lss_match_domain()'&.
34980
34981 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
34982         uschar&~*list)*&"
34983 This function checks for a match in a host list. The most common usage is
34984 expected to be
34985 .code
34986 lss_match_host(sender_host_name, sender_host_address, ...)
34987 .endd
34988 .vindex "&$sender_host_address$&"
34989 An empty address field matches an empty item in the host list. If the host name
34990 is NULL, the name corresponding to &$sender_host_address$& is automatically
34991 looked up if a host name is required to match an item in the list. The return
34992 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
34993 returns ERROR in the case when it had to look up a host name, but the lookup
34994 failed.
34995
34996 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
34997         *format,&~...)*&"
34998 This function writes to Exim's log files. The first argument should be zero (it
34999 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
35000 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
35001 them. It specifies to which log or logs the message is written. The remaining
35002 arguments are a format and relevant insertion arguments. The string should not
35003 contain any newlines, not even at the end.
35004
35005
35006 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
35007 This function adds an additional recipient to the message. The first argument
35008 is the recipient address. If it is unqualified (has no domain), it is qualified
35009 with the &%qualify_recipient%& domain. The second argument must always be -1.
35010
35011 This function does not allow you to specify a private &%errors_to%& address (as
35012 described with the structure of &%recipient_item%& above), because it pre-dates
35013 the addition of that field to the structure. However, it is easy to add such a
35014 value afterwards. For example:
35015 .code
35016  receive_add_recipient(US"monitor@mydom.example", -1);
35017  recipients_list[recipients_count-1].errors_to =
35018    US"postmaster@mydom.example";
35019 .endd
35020
35021 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
35022 This is a convenience function to remove a named recipient from the list of
35023 recipients. It returns true if a recipient was removed, and false if no
35024 matching recipient could be found. The argument must be a complete email
35025 address.
35026 .endlist
35027
35028
35029 .cindex "RFC 2047"
35030 .vlist
35031 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
35032   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
35033 This function decodes strings that are encoded according to RFC 2047. Typically
35034 these are the contents of header lines. First, each &"encoded word"& is decoded
35035 from the Q or B encoding into a byte-string. Then, if provided with the name of
35036 a charset encoding, and if the &[iconv()]& function is available, an attempt is
35037 made  to translate the result to the named character set. If this fails, the
35038 binary string is returned with an error message.
35039
35040 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
35041 maximum MIME word length is enforced. The third argument is the target
35042 encoding, or NULL if no translation is wanted.
35043
35044 .cindex "binary zero" "in RFC 2047 decoding"
35045 .cindex "RFC 2047" "binary zero in"
35046 If a binary zero is encountered in the decoded string, it is replaced by the
35047 contents of the &%zeroval%& argument. For use with Exim headers, the value must
35048 not be 0 because header lines are handled as zero-terminated strings.
35049
35050 The function returns the result of processing the string, zero-terminated; if
35051 &%lenptr%& is not NULL, the length of the result is set in the variable to
35052 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
35053
35054 If an error is encountered, the function returns NULL and uses the &%error%&
35055 argument to return an error message. The variable pointed to by &%error%& is
35056 set to NULL if there is no error; it may be set non-NULL even when the function
35057 returns a non-NULL value if decoding was successful, but there was a problem
35058 with translation.
35059
35060
35061 .vitem &*int&~smtp_fflush(void)*&
35062 This function is used in conjunction with &'smtp_printf()'&, as described
35063 below.
35064
35065 .vitem &*void&~smtp_printf(char&~*,BOOL,&~...)*&
35066 The arguments of this function are almost like &[printf()]&; it writes to the SMTP
35067 output stream. You should use this function only when there is an SMTP output
35068 stream, that is, when the incoming message is being received via interactive
35069 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
35070 is FALSE. If you want to test for an incoming message from another host (as
35071 opposed to a local process that used the &%-bs%& command line option), you can
35072 test the value of &%sender_host_address%&, which is non-NULL when a remote host
35073 is involved.
35074
35075 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
35076 output function, so it can be used for all forms of SMTP connection.
35077
35078 The second argument is used to request that the data be buffered
35079 (when TRUE) or flushed (along with any previously buffered, when FALSE).
35080 This is advisory only, but likely to save on system-calls and packets
35081 sent when a sequence of calls to the function are made.
35082
35083 The argument was added in Exim version 4.90 - changing the API/ABI.
35084 Nobody noticed until 4.93 was imminent, at which point the
35085 ABI version number was incremented.
35086
35087 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
35088 must start with an appropriate response code: 550 if you are going to return
35089 LOCAL_SCAN_REJECT, 451 if you are going to return
35090 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
35091 initial lines of a multi-line response, the code must be followed by a hyphen
35092 to indicate that the line is not the final response line. You must also ensure
35093 that the lines you write terminate with CRLF. For example:
35094 .code
35095 smtp_printf("550-this is some extra info\r\n");
35096 return LOCAL_SCAN_REJECT;
35097 .endd
35098 Note that you can also create multi-line responses by including newlines in
35099 the data returned via the &%return_text%& argument. The added value of using
35100 &'smtp_printf()'& is that, for instance, you could introduce delays between
35101 multiple output lines.
35102
35103 The &'smtp_printf()'& function does not return any error indication, because it
35104 does not
35105 guarantee a flush of
35106 pending output, and therefore does not test
35107 the state of the stream. (In the main code of Exim, flushing and error
35108 detection is done when Exim is ready for the next SMTP input command.) If
35109 you want to flush the output and check for an error (for example, the
35110 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
35111 arguments. It flushes the output stream, and returns a non-zero value if there
35112 is an error.
35113
35114 .vitem &*void&~*store_get(int,BOOL)*&
35115 This function accesses Exim's internal store (memory) manager. It gets a new
35116 chunk of memory whose size is given by the first argument.
35117 The second argument should be given as TRUE if the memory will be used for
35118 data possibly coming from an attacker (eg. the message content),
35119 FALSE if it is locally-sourced.
35120 Exim bombs out if it ever
35121 runs out of memory. See the next section for a discussion of memory handling.
35122
35123 .vitem &*void&~*store_get_perm(int,BOOL)*&
35124 This function is like &'store_get()'&, but it always gets memory from the
35125 permanent pool. See the next section for a discussion of memory handling.
35126
35127 .vitem &*uschar&~*string_copy(uschar&~*string)*&
35128 See below.
35129
35130 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
35131 See below.
35132
35133 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
35134 These three functions create strings using Exim's dynamic memory facilities.
35135 The first makes a copy of an entire string. The second copies up to a maximum
35136 number of characters, indicated by the second argument. The third uses a format
35137 and insertion arguments to create a new string. In each case, the result is a
35138 pointer to a new string in the current memory pool. See the next section for
35139 more discussion.
35140 .endlist
35141
35142
35143
35144 .section "More about Exim's memory handling" "SECTmemhanloc"
35145 .cindex "&[local_scan()]& function" "memory handling"
35146 No function is provided for freeing memory, because that is never needed.
35147 The dynamic memory that Exim uses when receiving a message is automatically
35148 recycled if another message is received by the same process (this applies only
35149 to incoming SMTP connections &-- other input methods can supply only one
35150 message at a time). After receiving the last message, a reception process
35151 terminates.
35152
35153 Because it is recycled, the normal dynamic memory cannot be used for holding
35154 data that must be preserved over a number of incoming messages on the same SMTP
35155 connection. However, Exim in fact uses two pools of dynamic memory; the second
35156 one is not recycled, and can be used for this purpose.
35157
35158 If you want to allocate memory that remains available for subsequent messages
35159 in the same SMTP connection, you should set
35160 .code
35161 store_pool = POOL_PERM
35162 .endd
35163 before calling the function that does the allocation. There is no need to
35164 restore the value if you do not need to; however, if you do want to revert to
35165 the normal pool, you can either restore the previous value of &%store_pool%& or
35166 set it explicitly to POOL_MAIN.
35167
35168 The pool setting applies to all functions that get dynamic memory, including
35169 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
35170 There is also a convenience function called &'store_get_perm()'& that gets a
35171 block of memory from the permanent pool while preserving the value of
35172 &%store_pool%&.
35173 .ecindex IIDlosca
35174
35175
35176
35177
35178 . ////////////////////////////////////////////////////////////////////////////
35179 . ////////////////////////////////////////////////////////////////////////////
35180
35181 .chapter "System-wide message filtering" "CHAPsystemfilter"
35182 .scindex IIDsysfil1 "filter" "system filter"
35183 .scindex IIDsysfil2 "filtering all mail"
35184 .scindex IIDsysfil3 "system filter"
35185 The previous chapters (on ACLs and the local scan function) describe checks
35186 that can be applied to messages before they are accepted by a host. There is
35187 also a mechanism for checking messages once they have been received, but before
35188 they are delivered. This is called the &'system filter'&.
35189
35190 The system filter operates in a similar manner to users' filter files, but it
35191 is run just once per message (however many recipients the message has).
35192 It should not normally be used as a substitute for routing, because &%deliver%&
35193 commands in a system router provide new envelope recipient addresses.
35194 The system filter must be an Exim filter. It cannot be a Sieve filter.
35195
35196 The system filter is run at the start of a delivery attempt, before any routing
35197 is done. If a message fails to be completely delivered at the first attempt,
35198 the system filter is run again at the start of every retry.
35199 If you want your filter to do something only once per message, you can make use
35200 of the &%first_delivery%& condition in an &%if%& command in the filter to
35201 prevent it happening on retries.
35202
35203 .vindex "&$domain$&"
35204 .vindex "&$local_part$&"
35205 &*Warning*&: Because the system filter runs just once, variables that are
35206 specific to individual recipient addresses, such as &$local_part$& and
35207 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
35208 you want to run a centrally-specified filter for each recipient address
35209 independently, you can do so by setting up a suitable &(redirect)& router, as
35210 described in section &<<SECTperaddfil>>& below.
35211
35212
35213 .section "Specifying a system filter" "SECID212"
35214 .cindex "uid (user id)" "system filter"
35215 .cindex "gid (group id)" "system filter"
35216 The name of the file that contains the system filter must be specified by
35217 setting &%system_filter%&. If you want the filter to run under a uid and gid
35218 other than root, you must also set &%system_filter_user%& and
35219 &%system_filter_group%& as appropriate. For example:
35220 .code
35221 system_filter = /etc/mail/exim.filter
35222 system_filter_user = exim
35223 .endd
35224 If a system filter generates any deliveries directly to files or pipes (via the
35225 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
35226 specified by setting &%system_filter_file_transport%& and
35227 &%system_filter_pipe_transport%&, respectively. Similarly,
35228 &%system_filter_reply_transport%& must be set to handle any messages generated
35229 by the &%reply%& command.
35230
35231
35232 .section "Testing a system filter" "SECID213"
35233 You can run simple tests of a system filter in the same way as for a user
35234 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
35235 are permitted only in system filters are recognized.
35236
35237 If you want to test the combined effect of a system filter and a user filter,
35238 you can use both &%-bF%& and &%-bf%& on the same command line.
35239
35240
35241
35242 .section "Contents of a system filter" "SECID214"
35243 The language used to specify system filters is the same as for users' filter
35244 files. It is described in the separate end-user document &'Exim's interface to
35245 mail filtering'&. However, there are some additional features that are
35246 available only in system filters; these are described in subsequent sections.
35247 If they are encountered in a user's filter file or when testing with &%-bf%&,
35248 they cause errors.
35249
35250 .cindex "frozen messages" "manual thaw; testing in filter"
35251 There are two special conditions which, though available in users' filter
35252 files, are designed for use in system filters. The condition &%first_delivery%&
35253 is true only for the first attempt at delivering a message, and
35254 &%manually_thawed%& is true only if the message has been frozen, and
35255 subsequently thawed by an admin user. An explicit forced delivery counts as a
35256 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
35257
35258 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
35259 specify an &"unseen"& (non-significant) delivery, and that delivery does not
35260 succeed, it will not be tried again.
35261 If you want Exim to retry an unseen delivery until it succeeds, you should
35262 arrange to set it up every time the filter runs.
35263
35264 When a system filter finishes running, the values of the variables &$n0$& &--
35265 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
35266 users' filter files. Thus a system filter can, for example, set up &"scores"&
35267 to which users' filter files can refer.
35268
35269
35270
35271 .section "Additional variable for system filters" "SECID215"
35272 .vindex "&$recipients$&"
35273 The expansion variable &$recipients$&, containing a list of all the recipients
35274 of the message (separated by commas and white space), is available in system
35275 filters. It is not available in users' filters for privacy reasons.
35276
35277
35278
35279 .section "Defer, freeze, and fail commands for system filters" "SECID216"
35280 .cindex "freezing messages"
35281 .cindex "message" "freezing"
35282 .cindex "message" "forced failure"
35283 .cindex "&%fail%&" "in system filter"
35284 .cindex "&%freeze%& in system filter"
35285 .cindex "&%defer%& in system filter"
35286 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
35287 always available in system filters, but are not normally enabled in users'
35288 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
35289 for the &(redirect)& router.) These commands can optionally be followed by the
35290 word &%text%& and a string containing an error message, for example:
35291 .code
35292 fail text "this message looks like spam to me"
35293 .endd
35294 The keyword &%text%& is optional if the next character is a double quote.
35295
35296 The &%defer%& command defers delivery of the original recipients of the
35297 message. The &%fail%& command causes all the original recipients to be failed,
35298 and a bounce message to be created. The &%freeze%& command suspends all
35299 delivery attempts for the original recipients. In all cases, any new deliveries
35300 that are specified by the filter are attempted as normal after the filter has
35301 run.
35302
35303 The &%freeze%& command is ignored if the message has been manually unfrozen and
35304 not manually frozen since. This means that automatic freezing by a system
35305 filter can be used as a way of checking out suspicious messages. If a message
35306 is found to be all right, manually unfreezing it allows it to be delivered.
35307
35308 .cindex "log" "&%fail%& command log line"
35309 .cindex "&%fail%&" "log line; reducing"
35310 The text given with a fail command is used as part of the bounce message as
35311 well as being written to the log. If the message is quite long, this can fill
35312 up a lot of log space when such failures are common. To reduce the size of the
35313 log message, Exim interprets the text in a special way if it starts with the
35314 two characters &`<<`& and contains &`>>`& later. The text between these two
35315 strings is written to the log, and the rest of the text is used in the bounce
35316 message. For example:
35317 .code
35318 fail "<<filter test 1>>Your message is rejected \
35319      because it contains attachments that we are \
35320      not prepared to receive."
35321 .endd
35322
35323 .cindex "loop" "caused by &%fail%&"
35324 Take great care with the &%fail%& command when basing the decision to fail on
35325 the contents of the message, because the bounce message will of course include
35326 the contents of the original message and will therefore trigger the &%fail%&
35327 command again (causing a mail loop) unless steps are taken to prevent this.
35328 Testing the &%error_message%& condition is one way to prevent this. You could
35329 use, for example
35330 .code
35331 if $message_body contains "this is spam" and not error_message
35332 then fail text "spam is not wanted here" endif
35333 .endd
35334 though of course that might let through unwanted bounce messages. The
35335 alternative is clever checking of the body and/or headers to detect bounces
35336 generated by the filter.
35337
35338 The interpretation of a system filter file ceases after a
35339 &%defer%&,
35340 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
35341 set up earlier in the filter file are honoured, so you can use a sequence such
35342 as
35343 .code
35344 mail ...
35345 freeze
35346 .endd
35347 to send a specified message when the system filter is freezing (or deferring or
35348 failing) a message. The normal deliveries for the message do not, of course,
35349 take place.
35350
35351
35352
35353 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
35354 .cindex "header lines" "adding; in system filter"
35355 .cindex "header lines" "removing; in system filter"
35356 .cindex "filter" "header lines; adding/removing"
35357 Two filter commands that are available only in system filters are:
35358 .code
35359 headers add <string>
35360 headers remove <string>
35361 .endd
35362 The argument for the &%headers add%& is a string that is expanded and then
35363 added to the end of the message's headers. It is the responsibility of the
35364 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
35365 space is ignored, and if the string is otherwise empty, or if the expansion is
35366 forced to fail, the command has no effect.
35367
35368 You can use &"\n"& within the string, followed by white space, to specify
35369 continued header lines. More than one header may be added in one command by
35370 including &"\n"& within the string without any following white space. For
35371 example:
35372 .code
35373 headers add "X-header-1: ....\n  \
35374              continuation of X-header-1 ...\n\
35375              X-header-2: ...."
35376 .endd
35377 Note that the header line continuation white space after the first newline must
35378 be placed before the backslash that continues the input string, because white
35379 space after input continuations is ignored.
35380
35381 The argument for &%headers remove%& is a colon-separated list of header names.
35382 This command applies only to those headers that are stored with the message;
35383 those that are added at delivery time (such as &'Envelope-To:'& and
35384 &'Return-Path:'&) cannot be removed by this means. If there is more than one
35385 header with the same name, they are all removed.
35386
35387 The &%headers%& command in a system filter makes an immediate change to the set
35388 of header lines that was received with the message (with possible additions
35389 from ACL processing). Subsequent commands in the system filter operate on the
35390 modified set, which also forms the basis for subsequent message delivery.
35391 Unless further modified during routing or transporting, this set of headers is
35392 used for all recipients of the message.
35393
35394 During routing and transporting, the variables that refer to the contents of
35395 header lines refer only to those lines that are in this set. Thus, header lines
35396 that are added by a system filter are visible to users' filter files and to all
35397 routers and transports. This contrasts with the manipulation of header lines by
35398 routers and transports, which is not immediate, but which instead is saved up
35399 until the message is actually being written (see section
35400 &<<SECTheadersaddrem>>&).
35401
35402 If the message is not delivered at the first attempt, header lines that were
35403 added by the system filter are stored with the message, and so are still
35404 present at the next delivery attempt. Header lines that were removed are still
35405 present, but marked &"deleted"& so that they are not transported with the
35406 message. For this reason, it is usual to make the &%headers%& command
35407 conditional on &%first_delivery%& so that the set of header lines is not
35408 modified more than once.
35409
35410 Because header modification in a system filter acts immediately, you have to
35411 use an indirect approach if you want to modify the contents of a header line.
35412 For example:
35413 .code
35414 headers add "Old-Subject: $h_subject:"
35415 headers remove "Subject"
35416 headers add "Subject: new subject (was: $h_old-subject:)"
35417 headers remove "Old-Subject"
35418 .endd
35419
35420
35421
35422 .section "Setting an errors address in a system filter" "SECID217"
35423 .cindex "envelope from"
35424 .cindex "envelope sender"
35425 In a system filter, if a &%deliver%& command is followed by
35426 .code
35427 errors_to <some address>
35428 .endd
35429 in order to change the envelope sender (and hence the error reporting) for that
35430 delivery, any address may be specified. (In a user filter, only the current
35431 user's address can be set.) For example, if some mail is being monitored, you
35432 might use
35433 .code
35434 unseen deliver monitor@spying.example errors_to root@local.example
35435 .endd
35436 to take a copy which would not be sent back to the normal error reporting
35437 address if its delivery failed.
35438
35439
35440
35441 .section "Per-address filtering" "SECTperaddfil"
35442 .vindex "&$domain$&"
35443 .vindex "&$local_part$&"
35444 In contrast to the system filter, which is run just once per message for each
35445 delivery attempt, it is also possible to set up a system-wide filtering
35446 operation that runs once for each recipient address. In this case, variables
35447 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
35448 filter file could be made dependent on them. This is an example of a router
35449 which implements such a filter:
35450 .code
35451 central_filter:
35452   check_local_user
35453   driver = redirect
35454   domains = +local_domains
35455   file = /central/filters/$local_part_data
35456   no_verify
35457   allow_filter
35458   allow_freeze
35459 .endd
35460 The filter is run in a separate process under its own uid. Therefore, either
35461 &%check_local_user%& must be set (as above), in which case the filter is run as
35462 the local user, or the &%user%& option must be used to specify which user to
35463 use. If both are set, &%user%& overrides.
35464
35465 Care should be taken to ensure that none of the commands in the filter file
35466 specify a significant delivery if the message is to go on to be delivered to
35467 its intended recipient. The router will not then claim to have dealt with the
35468 address, so it will be passed on to subsequent routers to be delivered in the
35469 normal way.
35470 .ecindex IIDsysfil1
35471 .ecindex IIDsysfil2
35472 .ecindex IIDsysfil3
35473
35474
35475
35476
35477
35478
35479 . ////////////////////////////////////////////////////////////////////////////
35480 . ////////////////////////////////////////////////////////////////////////////
35481
35482 .chapter "Message processing" "CHAPmsgproc"
35483 .scindex IIDmesproc "message" "general processing"
35484 Exim performs various transformations on the sender and recipient addresses of
35485 all messages that it handles, and also on the messages' header lines. Some of
35486 these are optional and configurable, while others always take place. All of
35487 this processing, except rewriting as a result of routing, and the addition or
35488 removal of header lines while delivering, happens when a message is received,
35489 before it is placed on Exim's queue.
35490
35491 Some of the automatic processing takes place by default only for
35492 &"locally-originated"& messages. This adjective is used to describe messages
35493 that are not received over TCP/IP, but instead are passed to an Exim process on
35494 its standard input. This includes the interactive &"local SMTP"& case that is
35495 set up by the &%-bs%& command line option.
35496
35497 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
35498 or ::1) are not considered to be locally-originated. Exim does not treat the
35499 loopback interface specially in any way.
35500
35501 If you want the loopback interface to be treated specially, you must ensure
35502 that there are appropriate entries in your ACLs.
35503
35504
35505
35506
35507 .section "Submission mode for non-local messages" "SECTsubmodnon"
35508 .cindex "message" "submission"
35509 .cindex "submission mode"
35510 Processing that happens automatically for locally-originated messages (unless
35511 &%suppress_local_fixups%& is set) can also be requested for messages that are
35512 received over TCP/IP. The term &"submission mode"& is used to describe this
35513 state. Submission mode is set by the modifier
35514 .code
35515 control = submission
35516 .endd
35517 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
35518 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
35519 a local submission, and is normally used when the source of the message is
35520 known to be an MUA running on a client host (as opposed to an MTA). For
35521 example, to set submission mode for messages originating on the IPv4 loopback
35522 interface, you could include the following in the MAIL ACL:
35523 .code
35524 warn  hosts = 127.0.0.1
35525       control = submission
35526 .endd
35527 .cindex "&%sender_retain%& submission option"
35528 There are some options that can be used when setting submission mode. A slash
35529 is used to separate options. For example:
35530 .code
35531 control = submission/sender_retain
35532 .endd
35533 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
35534 true and &%local_from_check%& false for the current incoming message. The first
35535 of these allows an existing &'Sender:'& header in the message to remain, and
35536 the second suppresses the check to ensure that &'From:'& matches the
35537 authenticated sender. With this setting, Exim still fixes up messages by adding
35538 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
35539 attempt to check sender authenticity in header lines.
35540
35541 When &%sender_retain%& is not set, a submission mode setting may specify a
35542 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
35543 example:
35544 .code
35545 control = submission/domain=some.domain
35546 .endd
35547 The domain may be empty. How this value is used is described in sections
35548 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
35549 that allows you to specify the user's full name for inclusion in a created
35550 &'Sender:'& or &'From:'& header line. For example:
35551 .code
35552 accept authenticated = *
35553        control = submission/domain=wonderland.example/\
35554                             name=${lookup {$authenticated_id} \
35555                                    lsearch {/etc/exim/namelist}}
35556 .endd
35557 Because the name may contain any characters, including slashes, the &%name%&
35558 option must be given last. The remainder of the string is used as the name. For
35559 the example above, if &_/etc/exim/namelist_& contains:
35560 .code
35561 bigegg:  Humpty Dumpty
35562 .endd
35563 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
35564 line would be:
35565 .code
35566 Sender: Humpty Dumpty <bigegg@wonderland.example>
35567 .endd
35568 .cindex "return path" "in submission mode"
35569 By default, submission mode forces the return path to the same address as is
35570 used to create the &'Sender:'& header. However, if &%sender_retain%& is
35571 specified, the return path is also left unchanged.
35572
35573 &*Note*&: The changes caused by submission mode take effect after the predata
35574 ACL. This means that any sender checks performed before the fix-ups use the
35575 untrusted sender address specified by the user, not the trusted sender address
35576 specified by submission mode. Although this might be slightly unexpected, it
35577 does mean that you can configure ACL checks to spot that a user is trying to
35578 spoof another's address.
35579
35580 .section "Line endings" "SECTlineendings"
35581 .cindex "line endings"
35582 .cindex "carriage return"
35583 .cindex "linefeed"
35584 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
35585 linefeed) is the line ending for messages transmitted over the Internet using
35586 SMTP over TCP/IP. However, within individual operating systems, different
35587 conventions are used. For example, Unix-like systems use just LF, but others
35588 use CRLF or just CR.
35589
35590 Exim was designed for Unix-like systems, and internally, it stores messages
35591 using the system's convention of a single LF as a line terminator. When
35592 receiving a message, all line endings are translated to this standard format.
35593 Originally, it was thought that programs that passed messages directly to an
35594 MTA within an operating system would use that system's convention. Experience
35595 has shown that this is not the case; for example, there are Unix applications
35596 that use CRLF in this circumstance. For this reason, and for compatibility with
35597 other MTAs, the way Exim handles line endings for all messages is now as
35598 follows:
35599
35600 .ilist
35601 LF not preceded by CR is treated as a line ending.
35602 .next
35603 CR is treated as a line ending; if it is immediately followed by LF, the LF
35604 is ignored.
35605 .next
35606 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
35607 nor a local message in the state where a line containing only a dot is a
35608 terminator.
35609 .next
35610 If a bare CR is encountered within a header line, an extra space is added after
35611 the line terminator so as not to end the header line. The reasoning behind this
35612 is that bare CRs in header lines are most likely either to be mistakes, or
35613 people trying to play silly games.
35614 .next
35615 If the first header line received in a message ends with CRLF, a subsequent
35616 bare LF in a header line is treated in the same way as a bare CR in a header
35617 line.
35618 .endlist
35619
35620
35621
35622
35623
35624 .section "Unqualified addresses" "SECID218"
35625 .cindex "unqualified addresses"
35626 .cindex "address" "qualification"
35627 By default, Exim expects every envelope address it receives from an external
35628 host to be fully qualified. Unqualified addresses cause negative responses to
35629 SMTP commands. However, because SMTP is used as a means of transporting
35630 messages from MUAs running on personal workstations, there is sometimes a
35631 requirement to accept unqualified addresses from specific hosts or IP networks.
35632
35633 Exim has two options that separately control which hosts may send unqualified
35634 sender or recipient addresses in SMTP commands, namely
35635 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
35636 cases, if an unqualified address is accepted, it is qualified by adding the
35637 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
35638
35639 .oindex "&%qualify_domain%&"
35640 .oindex "&%qualify_recipient%&"
35641 Unqualified addresses in header lines are automatically qualified for messages
35642 that are locally originated, unless the &%-bnq%& option is given on the command
35643 line. For messages received over SMTP, unqualified addresses in header lines
35644 are qualified only if unqualified addresses are permitted in SMTP commands. In
35645 other words, such qualification is also controlled by
35646 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
35647
35648
35649
35650
35651 .section "The UUCP From line" "SECID219"
35652 .cindex "&""From""& line"
35653 .cindex "UUCP" "&""From""& line"
35654 .cindex "sender" "address"
35655 .oindex "&%uucp_from_pattern%&"
35656 .oindex "&%uucp_from_sender%&"
35657 .cindex "envelope from"
35658 .cindex "envelope sender"
35659 .cindex "Sendmail compatibility" "&""From""& line"
35660 Messages that have come from UUCP (and some other applications) often begin
35661 with a line containing the envelope sender and a timestamp, following the word
35662 &"From"&. Examples of two common formats are:
35663 .code
35664 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
35665 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
35666 .endd
35667 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
35668 Exim recognizes such lines at the start of messages that are submitted to it
35669 via the command line (that is, on the standard input). It does not recognize
35670 such lines in incoming SMTP messages, unless the sending host matches
35671 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
35672 and &%ignore_fromline_local%& is set. The recognition is controlled by a
35673 regular expression that is defined by the &%uucp_from_pattern%& option, whose
35674 default value matches the two common cases shown above and puts the address
35675 that follows &"From"& into &$1$&.
35676
35677 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
35678 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
35679 a trusted user, the message's sender address is constructed by expanding the
35680 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
35681 then parsed as an RFC 2822 address. If there is no domain, the local part is
35682 qualified with &%qualify_domain%& unless it is the empty string. However, if
35683 the command line &%-f%& option is used, it overrides the &"From"& line.
35684
35685 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
35686 sender address is not changed. This is also the case for incoming SMTP messages
35687 that are permitted to contain &"From"& lines.
35688
35689 Only one &"From"& line is recognized. If there is more than one, the second is
35690 treated as a data line that starts the body of the message, as it is not valid
35691 as a header line. This also happens if a &"From"& line is present in an
35692 incoming SMTP message from a source that is not permitted to send them.
35693
35694
35695
35696 .section "Resent- header lines" "SECID220"
35697 .cindex "&%Resent-%& header lines"
35698 .cindex "header lines" "Resent-"
35699 RFC 2822 makes provision for sets of header lines starting with the string
35700 &`Resent-`& to be added to a message when it is resent by the original
35701 recipient to somebody else. These headers are &'Resent-Date:'&,
35702 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
35703 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
35704
35705 .blockquote
35706 &'Resent fields are strictly informational. They MUST NOT be used in the normal
35707 processing of replies or other such automatic actions on messages.'&
35708 .endblockquote
35709
35710 This leaves things a bit vague as far as other processing actions such as
35711 address rewriting are concerned. Exim treats &%Resent-%& header lines as
35712 follows:
35713
35714 .ilist
35715 A &'Resent-From:'& line that just contains the login id of the submitting user
35716 is automatically rewritten in the same way as &'From:'& (see below).
35717 .next
35718 If there's a rewriting rule for a particular header line, it is also applied to
35719 &%Resent-%& header lines of the same type. For example, a rule that rewrites
35720 &'From:'& also rewrites &'Resent-From:'&.
35721 .next
35722 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
35723 also removed.
35724 .next
35725 For a locally-submitted message,
35726 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
35727 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
35728 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
35729 included in log lines in this case.
35730 .next
35731 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
35732 &%Resent-%& header lines are present.
35733 .endlist
35734
35735
35736
35737
35738 .section "The Auto-Submitted: header line" "SECID221"
35739 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
35740 includes the header line:
35741 .code
35742 Auto-Submitted: auto-replied
35743 .endd
35744
35745 .section "The Bcc: header line" "SECID222"
35746 .cindex "&'Bcc:'& header line"
35747 If Exim is called with the &%-t%& option, to take recipient addresses from a
35748 message's header, it removes any &'Bcc:'& header line that may exist (after
35749 extracting its addresses). If &%-t%& is not present on the command line, any
35750 existing &'Bcc:'& is not removed.
35751
35752
35753 .section "The Date: header line" "SECID223"
35754 .cindex "&'Date:'& header line"
35755 .cindex "header lines" "Date:"
35756 If a locally-generated or submission-mode message has no &'Date:'& header line,
35757 Exim adds one, using the current date and time, unless the
35758 &%suppress_local_fixups%& control has been specified.
35759
35760 .section "The Delivery-date: header line" "SECID224"
35761 .cindex "&'Delivery-date:'& header line"
35762 .oindex "&%delivery_date_remove%&"
35763 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
35764 set. Exim can be configured to add them to the final delivery of messages. (See
35765 the generic &%delivery_date_add%& transport option.) They should not be present
35766 in messages in transit. If the &%delivery_date_remove%& configuration option is
35767 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
35768 messages.
35769
35770
35771 .section "The Envelope-to: header line" "SECID225"
35772 .cindex "&'Envelope-to:'& header line"
35773 .cindex "header lines" "Envelope-to:"
35774 .oindex "&%envelope_to_remove%&"
35775 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
35776 Exim can be configured to add them to the final delivery of messages. (See the
35777 generic &%envelope_to_add%& transport option.) They should not be present in
35778 messages in transit. If the &%envelope_to_remove%& configuration option is set
35779 (the default), Exim removes &'Envelope-to:'& header lines from incoming
35780 messages.
35781
35782
35783 .section "The From: header line" "SECTthefrohea"
35784 .cindex "&'From:'& header line"
35785 .cindex "header lines" "From:"
35786 .cindex "Sendmail compatibility" "&""From""& line"
35787 .cindex "message" "submission"
35788 .cindex "submission mode"
35789 If a submission-mode message does not contain a &'From:'& header line, Exim
35790 adds one if either of the following conditions is true:
35791
35792 .ilist
35793 The envelope sender address is not empty (that is, this is not a bounce
35794 message). The added header line copies the envelope sender address.
35795 .next
35796 .vindex "&$authenticated_id$&"
35797 The SMTP session is authenticated and &$authenticated_id$& is not empty.
35798 .olist
35799 .vindex "&$qualify_domain$&"
35800 If no domain is specified by the submission control, the local part is
35801 &$authenticated_id$& and the domain is &$qualify_domain$&.
35802 .next
35803 If a non-empty domain is specified by the submission control, the local
35804 part is &$authenticated_id$&, and the domain is the specified domain.
35805 .next
35806 If an empty domain is specified by the submission control,
35807 &$authenticated_id$& is assumed to be the complete address.
35808 .endlist
35809 .endlist
35810
35811 A non-empty envelope sender takes precedence.
35812
35813 If a locally-generated incoming message does not contain a &'From:'& header
35814 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
35815 containing the sender's address. The calling user's login name and full name
35816 are used to construct the address, as described in section &<<SECTconstr>>&.
35817 They are obtained from the password data by calling &[getpwuid()]& (but see the
35818 &%unknown_login%& configuration option). The address is qualified with
35819 &%qualify_domain%&.
35820
35821 For compatibility with Sendmail, if an incoming, non-SMTP message has a
35822 &'From:'& header line containing just the unqualified login name of the calling
35823 user, this is replaced by an address containing the user's login name and full
35824 name as described in section &<<SECTconstr>>&.
35825
35826
35827 .section "The Message-ID: header line" "SECID226"
35828 .cindex "&'Message-ID:'& header line"
35829 .cindex "header lines" "Message-ID:"
35830 .cindex "message" "submission"
35831 .oindex "&%message_id_header_text%&"
35832 If a locally-generated or submission-mode incoming message does not contain a
35833 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
35834 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
35835 to the message. If there are any &'Resent-:'& headers in the message, it
35836 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
35837 message id, preceded by the letter E to ensure it starts with a letter, and
35838 followed by @ and the primary host name. Additional information can be included
35839 in this header line by setting the &%message_id_header_text%& and/or
35840 &%message_id_header_domain%& options.
35841
35842
35843 .section "The Received: header line" "SECID227"
35844 .cindex "&'Received:'& header line"
35845 .cindex "header lines" "Received:"
35846 A &'Received:'& header line is added at the start of every message. The
35847 contents are defined by the &%received_header_text%& configuration option, and
35848 Exim automatically adds a semicolon and a timestamp to the configured string.
35849
35850 The &'Received:'& header is generated as soon as the message's header lines
35851 have been received. At this stage, the timestamp in the &'Received:'& header
35852 line is the time that the message started to be received. This is the value
35853 that is seen by the DATA ACL and by the &[local_scan()]& function.
35854
35855 Once a message is accepted, the timestamp in the &'Received:'& header line is
35856 changed to the time of acceptance, which is (apart from a small delay while the
35857 -H spool file is written) the earliest time at which delivery could start.
35858
35859
35860 .section "The References: header line" "SECID228"
35861 .cindex "&'References:'& header line"
35862 .cindex "header lines" "References:"
35863 Messages created by the &(autoreply)& transport include a &'References:'&
35864 header line. This is constructed according to the rules that are described in
35865 section 3.64 of RFC 2822 (which states that replies should contain such a
35866 header line), and section 3.14 of RFC 3834 (which states that automatic
35867 responses are not different in this respect). However, because some mail
35868 processing software does not cope well with very long header lines, no more
35869 than 12 message IDs are copied from the &'References:'& header line in the
35870 incoming message. If there are more than 12, the first one and then the final
35871 11 are copied, before adding the message ID of the incoming message.
35872
35873
35874
35875 .section "The Return-path: header line" "SECID229"
35876 .cindex "&'Return-path:'& header line"
35877 .cindex "header lines" "Return-path:"
35878 .oindex "&%return_path_remove%&"
35879 &'Return-path:'& header lines are defined as something an MTA may insert when
35880 it does the final delivery of messages. (See the generic &%return_path_add%&
35881 transport option.) Therefore, they should not be present in messages in
35882 transit. If the &%return_path_remove%& configuration option is set (the
35883 default), Exim removes &'Return-path:'& header lines from incoming messages.
35884
35885
35886
35887 .section "The Sender: header line" "SECTthesenhea"
35888 .cindex "&'Sender:'& header line"
35889 .cindex "message" "submission"
35890 .cindex "header lines" "Sender:"
35891 For a locally-originated message from an untrusted user, Exim may remove an
35892 existing &'Sender:'& header line, and it may add a new one. You can modify
35893 these actions by setting the &%local_sender_retain%& option true, the
35894 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
35895 control setting.
35896
35897 When a local message is received from an untrusted user and
35898 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
35899 control has not been set, a check is made to see if the address given in the
35900 &'From:'& header line is the correct (local) sender of the message. The address
35901 that is expected has the login name as the local part and the value of
35902 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
35903 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
35904 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
35905 line is added to the message.
35906
35907 If you set &%local_from_check%& false, this checking does not occur. However,
35908 the removal of an existing &'Sender:'& line still happens, unless you also set
35909 &%local_sender_retain%& to be true. It is not possible to set both of these
35910 options true at the same time.
35911
35912 .cindex "submission mode"
35913 By default, no processing of &'Sender:'& header lines is done for messages
35914 received over TCP/IP or for messages submitted by trusted users. However, when
35915 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
35916 not specified on the submission control, the following processing takes place:
35917
35918 .vindex "&$authenticated_id$&"
35919 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
35920 authenticated, and &$authenticated_id$& is not empty, a sender address is
35921 created as follows:
35922
35923 .ilist
35924 .vindex "&$qualify_domain$&"
35925 If no domain is specified by the submission control, the local part is
35926 &$authenticated_id$& and the domain is &$qualify_domain$&.
35927 .next
35928 If a non-empty domain is specified by the submission control, the local part
35929 is &$authenticated_id$&, and the domain is the specified domain.
35930 .next
35931 If an empty domain is specified by the submission control,
35932 &$authenticated_id$& is assumed to be the complete address.
35933 .endlist
35934
35935 This address is compared with the address in the &'From:'& header line. If they
35936 are different, a &'Sender:'& header line containing the created address is
35937 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
35938 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
35939
35940 .cindex "return path" "created from &'Sender:'&"
35941 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
35942 the message (the envelope sender address) is changed to be the same address,
35943 except in the case of submission mode when &%sender_retain%& is specified.
35944
35945
35946
35947 .section "Adding and removing header lines in routers and transports" &&&
35948          "SECTheadersaddrem"
35949 .cindex "header lines" "adding; in router or transport"
35950 .cindex "header lines" "removing; in router or transport"
35951 When a message is delivered, the addition and removal of header lines can be
35952 specified in a system filter, or on any of the routers and transports that
35953 process the message. Section &<<SECTaddremheasys>>& contains details about
35954 modifying headers in a system filter. Header lines can also be added in an ACL
35955 as a message is received (see section &<<SECTaddheadacl>>&).
35956
35957 In contrast to what happens in a system filter, header modifications that are
35958 specified on routers and transports apply only to the particular recipient
35959 addresses that are being processed by those routers and transports. These
35960 changes do not actually take place until a copy of the message is being
35961 transported. Therefore, they do not affect the basic set of header lines, and
35962 they do not affect the values of the variables that refer to header lines.
35963
35964 &*Note*&: In particular, this means that any expansions in the configuration of
35965 the transport cannot refer to the modified header lines, because such
35966 expansions all occur before the message is actually transported.
35967
35968 For both routers and transports, the argument of a &%headers_add%&
35969 option must be in the form of one or more RFC 2822 header lines, separated by
35970 newlines (coded as &"\n"&). For example:
35971 .code
35972 headers_add = X-added-header: added by $primary_hostname\n\
35973               X-added-second: another added header line
35974 .endd
35975 Exim does not check the syntax of these added header lines.
35976
35977 Multiple &%headers_add%& options for a single router or transport can be
35978 specified; the values will append to a single list of header lines.
35979 Each header-line is separately expanded.
35980
35981 The argument of a &%headers_remove%& option must consist of a colon-separated
35982 list of header names. This is confusing, because header names themselves are
35983 often terminated by colons. In this case, the colons are the list separators,
35984 not part of the names. For example:
35985 .code
35986 headers_remove = return-receipt-to:acknowledge-to
35987 .endd
35988
35989 Multiple &%headers_remove%& options for a single router or transport can be
35990 specified; the arguments will append to a single header-names list.
35991 Each item is separately expanded.
35992 Note that colons in complex expansions which are used to
35993 form all or part of a &%headers_remove%& list
35994 will act as list separators.
35995
35996 When &%headers_add%& or &%headers_remove%& is specified on a router,
35997 items are expanded at routing time,
35998 and then associated with all addresses that are
35999 accepted by that router, and also with any new addresses that it generates. If
36000 an address passes through several routers as a result of aliasing or
36001 forwarding, the changes are cumulative.
36002
36003 .oindex "&%unseen%&"
36004 However, this does not apply to multiple routers that result from the use of
36005 the &%unseen%& option. Any header modifications that were specified by the
36006 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
36007
36008 Addresses that end up with different &%headers_add%& or &%headers_remove%&
36009 settings cannot be delivered together in a batch, so a transport is always
36010 dealing with a set of addresses that have the same header-processing
36011 requirements.
36012
36013 The transport starts by writing the original set of header lines that arrived
36014 with the message, possibly modified by the system filter. As it writes out
36015 these lines, it consults the list of header names that were attached to the
36016 recipient address(es) by &%headers_remove%& options in routers, and it also
36017 consults the transport's own &%headers_remove%& option. Header lines whose
36018 names are on either of these lists are not written out. If there are multiple
36019 instances of any listed header, they are all skipped.
36020
36021 After the remaining original header lines have been written, new header
36022 lines that were specified by routers' &%headers_add%& options are written, in
36023 the order in which they were attached to the address. These are followed by any
36024 header lines specified by the transport's &%headers_add%& option.
36025
36026 This way of handling header line modifications in routers and transports has
36027 the following consequences:
36028
36029 .ilist
36030 The original set of header lines, possibly modified by the system filter,
36031 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
36032 to it, at all times.
36033 .next
36034 Header lines that are added by a router's
36035 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
36036 expansion syntax in subsequent routers or the transport.
36037 .next
36038 Conversely, header lines that are specified for removal by &%headers_remove%&
36039 in a router remain visible to subsequent routers and the transport.
36040 .next
36041 Headers added to an address by &%headers_add%& in a router cannot be removed by
36042 a later router or by a transport.
36043 .next
36044 An added header can refer to the contents of an original header that is to be
36045 removed, even it has the same name as the added header. For example:
36046 .code
36047 headers_remove = subject
36048 headers_add = Subject: new subject (was: $h_subject:)
36049 .endd
36050 .endlist
36051
36052 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
36053 for a &(redirect)& router that has the &%one_time%& option set.
36054
36055
36056
36057
36058
36059 .section "Constructed addresses" "SECTconstr"
36060 .cindex "address" "constructed"
36061 .cindex "constructed address"
36062 When Exim constructs a sender address for a locally-generated message, it uses
36063 the form
36064 .display
36065 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
36066 .endd
36067 For example:
36068 .code
36069 Zaphod Beeblebrox <zaphod@end.univ.example>
36070 .endd
36071 The user name is obtained from the &%-F%& command line option if set, or
36072 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
36073 &"gecos"& field from the password entry. If the &"gecos"& field contains an
36074 ampersand character, this is replaced by the login name with the first letter
36075 upper cased, as is conventional in a number of operating systems. See the
36076 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
36077 The &%unknown_username%& option can be used to specify user names in cases when
36078 there is no password file entry.
36079
36080 .cindex "RFC 2047"
36081 In all cases, the user name is made to conform to RFC 2822 by quoting all or
36082 parts of it if necessary. In addition, if it contains any non-printing
36083 characters, it is encoded as described in RFC 2047, which defines a way of
36084 including non-ASCII characters in header lines. The value of the
36085 &%headers_charset%& option specifies the name of the encoding that is used (the
36086 characters are assumed to be in this encoding). The setting of
36087 &%print_topbitchars%& controls whether characters with the top bit set (that
36088 is, with codes greater than 127) count as printing characters or not.
36089
36090
36091
36092 .section "Case of local parts" "SECID230"
36093 .cindex "case of local parts"
36094 .cindex "local part" "case of"
36095 RFC 2822 states that the case of letters in the local parts of addresses cannot
36096 be assumed to be non-significant. Exim preserves the case of local parts of
36097 addresses, but by default it uses a lower-cased form when it is routing,
36098 because on most Unix systems, usernames are in lower case and case-insensitive
36099 routing is required. However, any particular router can be made to use the
36100 original case for local parts by setting the &%caseful_local_part%& generic
36101 router option.
36102
36103 .cindex "mixed-case login names"
36104 If you must have mixed-case user names on your system, the best way to proceed,
36105 assuming you want case-independent handling of incoming email, is to set up
36106 your first router to convert incoming local parts in your domains to the
36107 correct case by means of a file lookup. For example:
36108 .code
36109 correct_case:
36110   driver = redirect
36111   domains = +local_domains
36112   data = ${lookup{$local_part}cdb\
36113               {/etc/usercased.cdb}{$value}fail}\
36114               @$domain
36115 .endd
36116 For this router, the local part is forced to lower case by the default action
36117 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
36118 up a new local part in the correct case. If you then set &%caseful_local_part%&
36119 on any subsequent routers which process your domains, they will operate on
36120 local parts with the correct case in a case-sensitive manner.
36121
36122
36123
36124 .section "Dots in local parts" "SECID231"
36125 .cindex "dot" "in local part"
36126 .cindex "local part" "dots in"
36127 RFC 2822 forbids empty components in local parts. That is, an unquoted local
36128 part may not begin or end with a dot, nor have two consecutive dots in the
36129 middle. However, it seems that many MTAs do not enforce this, so Exim permits
36130 empty components for compatibility.
36131
36132
36133
36134 .section "Rewriting addresses" "SECID232"
36135 .cindex "rewriting" "addresses"
36136 Rewriting of sender and recipient addresses, and addresses in headers, can
36137 happen automatically, or as the result of configuration options, as described
36138 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
36139 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
36140
36141 Automatic rewriting includes qualification, as mentioned above. The other case
36142 in which it can happen is when an incomplete non-local domain is given. The
36143 routing process may cause this to be expanded into the full domain name. For
36144 example, a header such as
36145 .code
36146 To: hare@teaparty
36147 .endd
36148 might get rewritten as
36149 .code
36150 To: hare@teaparty.wonderland.fict.example
36151 .endd
36152 Rewriting as a result of routing is the one kind of message processing that
36153 does not happen at input time, as it cannot be done until the address has
36154 been routed.
36155
36156 Strictly, one should not do &'any'& deliveries of a message until all its
36157 addresses have been routed, in case any of the headers get changed as a
36158 result of routing. However, doing this in practice would hold up many
36159 deliveries for unreasonable amounts of time, just because one address could not
36160 immediately be routed. Exim therefore does not delay other deliveries when
36161 routing of one or more addresses is deferred.
36162 .ecindex IIDmesproc
36163
36164
36165
36166 . ////////////////////////////////////////////////////////////////////////////
36167 . ////////////////////////////////////////////////////////////////////////////
36168
36169 .chapter "SMTP processing" "CHAPSMTP"
36170 .scindex IIDsmtpproc1 "SMTP" "processing details"
36171 .scindex IIDsmtpproc2 "LMTP" "processing details"
36172 Exim supports a number of different ways of using the SMTP protocol, and its
36173 LMTP variant, which is an interactive protocol for transferring messages into a
36174 closed mail store application. This chapter contains details of how SMTP is
36175 processed. For incoming mail, the following are available:
36176
36177 .ilist
36178 SMTP over TCP/IP (Exim daemon or &'inetd'&);
36179 .next
36180 SMTP over the standard input and output (the &%-bs%& option);
36181 .next
36182 Batched SMTP on the standard input (the &%-bS%& option).
36183 .endlist
36184
36185 For mail delivery, the following are available:
36186
36187 .ilist
36188 SMTP over TCP/IP (the &(smtp)& transport);
36189 .next
36190 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
36191 &"lmtp"&);
36192 .next
36193 LMTP over a pipe to a process running in the local host (the &(lmtp)&
36194 transport);
36195 .next
36196 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
36197 the &%use_bsmtp%& option set).
36198 .endlist
36199
36200 &'Batched SMTP'& is the name for a process in which batches of messages are
36201 stored in or read from files (or pipes), in a format in which SMTP commands are
36202 used to contain the envelope information.
36203
36204
36205
36206 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
36207 .cindex "SMTP" "outgoing over TCP/IP"
36208 .cindex "outgoing SMTP over TCP/IP"
36209 .cindex "LMTP" "over TCP/IP"
36210 .cindex "outgoing LMTP over TCP/IP"
36211 .cindex "EHLO"
36212 .cindex "HELO"
36213 .cindex "SIZE" "option on MAIL command"
36214 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
36215 The &%protocol%& option selects which protocol is to be used, but the actual
36216 processing is the same in both cases.
36217
36218 .cindex "ESMTP extensions" SIZE
36219 If, in response to its EHLO command, Exim is told that the SIZE
36220 extension is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
36221 command. The value of <&'n'&> is the message size plus the value of the
36222 &%size_addition%& option (default 1024) to allow for additions to the message
36223 such as per-transport header lines, or changes made in a
36224 .cindex "transport" "filter"
36225 .cindex "filter" "transport filter"
36226 transport filter. If &%size_addition%& is set negative, the use of SIZE is
36227 suppressed.
36228
36229 If the remote server advertises support for PIPELINING, Exim uses the
36230 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
36231 required for the transaction.
36232
36233 If the remote server advertises support for the STARTTLS command, and Exim
36234 was built to support TLS encryption, it tries to start a TLS session unless the
36235 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
36236 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
36237 is called for verification.
36238
36239 If the remote server advertises support for the AUTH command, Exim scans
36240 the authenticators configuration for any suitable client settings, as described
36241 in chapter &<<CHAPSMTPAUTH>>&.
36242
36243 .cindex "carriage return"
36244 .cindex "linefeed"
36245 Responses from the remote host are supposed to be terminated by CR followed by
36246 LF. However, there are known to be hosts that do not send CR characters, so in
36247 order to be able to interwork with such hosts, Exim treats LF on its own as a
36248 line terminator.
36249
36250 If a message contains a number of different addresses, all those with the same
36251 characteristics (for example, the same envelope sender) that resolve to the
36252 same set of hosts, in the same order, are sent in a single SMTP transaction,
36253 even if they are for different domains, unless there are more than the setting
36254 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
36255 they are split into groups containing no more than &%max_rcpt%&s addresses
36256 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
36257 in parallel sessions. The order of hosts with identical MX values is not
36258 significant when checking whether addresses can be batched in this way.
36259
36260 When the &(smtp)& transport suffers a temporary failure that is not
36261 message-related, Exim updates its transport-specific database, which contains
36262 records indexed by host name that remember which messages are waiting for each
36263 particular host. It also updates the retry database with new retry times.
36264
36265 .cindex "hints database" "retry keys"
36266 Exim's retry hints are based on host name plus IP address, so if one address of
36267 a multi-homed host is broken, it will soon be skipped most of the time.
36268 See the next section for more detail about error handling.
36269
36270 .cindex "SMTP" "passed connection"
36271 .cindex "SMTP" "batching over TCP/IP"
36272 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
36273 looks in the hints database for the transport to see if there are any queued
36274 messages waiting for the host to which it is connected. If it finds one, it
36275 creates a new Exim process using the &%-MC%& option (which can only be used by
36276 a process running as root or the Exim user) and passes the TCP/IP socket to it
36277 so that it can deliver another message using the same socket. The new process
36278 does only those deliveries that are routed to the connected host, and may in
36279 turn pass the socket on to a third process, and so on.
36280
36281 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
36282 limit the number of messages sent down a single TCP/IP connection.
36283
36284 .cindex "asterisk" "after IP address"
36285 The second and subsequent messages delivered down an existing connection are
36286 identified in the main log by the addition of an asterisk after the closing
36287 square bracket of the IP address.
36288
36289
36290
36291
36292 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
36293 .cindex "error" "in outgoing SMTP"
36294 .cindex "SMTP" "errors in outgoing"
36295 .cindex "host" "error"
36296 Three different kinds of error are recognized for outgoing SMTP: host errors,
36297 message errors, and recipient errors.
36298
36299 .vlist
36300 .vitem "&*Host errors*&"
36301 A host error is not associated with a particular message or with a
36302 particular recipient of a message. The host errors are:
36303
36304 .ilist
36305 Connection refused or timed out,
36306 .next
36307 Any error response code on connection,
36308 .next
36309 Any error response code to EHLO or HELO,
36310 .next
36311 Loss of connection at any time, except after &"."&,
36312 .next
36313 I/O errors at any time,
36314 .next
36315 Timeouts during the session, other than in response to MAIL, RCPT or
36316 the &"."& at the end of the data.
36317 .endlist ilist
36318
36319 For a host error, a permanent error response on connection, or in response to
36320 EHLO, causes all addresses routed to the host to be failed. Any other host
36321 error causes all addresses to be deferred, and retry data to be created for the
36322 host. It is not tried again, for any message, until its retry time arrives. If
36323 the current set of addresses are not all delivered in this run (to some
36324 alternative host), the message is added to the list of those waiting for this
36325 host, so if it is still undelivered when a subsequent successful delivery is
36326 made to the host, it will be sent down the same SMTP connection.
36327
36328 .vitem "&*Message errors*&"
36329 .cindex "message" "error"
36330 A message error is associated with a particular message when sent to a
36331 particular host, but not with a particular recipient of the message. The
36332 message errors are:
36333
36334 .ilist
36335 Any error response code to MAIL, DATA, or the &"."& that terminates
36336 the data,
36337 .next
36338 Timeout after MAIL,
36339 .next
36340 Timeout or loss of connection after the &"."& that terminates the data. A
36341 timeout after the DATA command itself is treated as a host error, as is loss of
36342 connection at any other time.
36343 .endlist ilist
36344
36345 For a message error, a permanent error response (5&'xx'&) causes all addresses
36346 to be failed, and a delivery error report to be returned to the sender. A
36347 temporary error response (4&'xx'&), or one of the timeouts, causes all
36348 addresses to be deferred. Retry data is not created for the host, but instead,
36349 a retry record for the combination of host plus message id is created. The
36350 message is not added to the list of those waiting for this host. This ensures
36351 that the failing message will not be sent to this host again until the retry
36352 time arrives. However, other messages that are routed to the host are not
36353 affected, so if it is some property of the message that is causing the error,
36354 it will not stop the delivery of other mail.
36355
36356 If the remote host specified support for the SIZE parameter in its response
36357 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
36358 over-large message will cause a message error because the error arrives as a
36359 response to MAIL.
36360
36361 .vitem "&*Recipient errors*&"
36362 .cindex "recipient" "error"
36363 A recipient error is associated with a particular recipient of a message. The
36364 recipient errors are:
36365
36366 .ilist
36367 Any error response to RCPT,
36368 .next
36369 Timeout after RCPT.
36370 .endlist
36371
36372 For a recipient error, a permanent error response (5&'xx'&) causes the
36373 recipient address to be failed, and a bounce message to be returned to the
36374 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
36375 address to be deferred, and routing retry data to be created for it. This is
36376 used to delay processing of the address in subsequent queue runs, until its
36377 routing retry time arrives. This applies to all messages, but because it
36378 operates only in queue runs, one attempt will be made to deliver a new message
36379 to the failing address before the delay starts to operate. This ensures that,
36380 if the failure is really related to the message rather than the recipient
36381 (&"message too big for this recipient"& is a possible example), other messages
36382 have a chance of getting delivered. If a delivery to the address does succeed,
36383 the retry information gets cleared, so all stuck messages get tried again, and
36384 the retry clock is reset.
36385
36386 The message is not added to the list of those waiting for this host. Use of the
36387 host for other messages is unaffected, and except in the case of a timeout,
36388 other recipients are processed independently, and may be successfully delivered
36389 in the current SMTP session. After a timeout it is of course impossible to
36390 proceed with the session, so all addresses get deferred. However, those other
36391 than the one that failed do not suffer any subsequent retry delays. Therefore,
36392 if one recipient is causing trouble, the others have a chance of getting
36393 through when a subsequent delivery attempt occurs before the failing
36394 recipient's retry time.
36395 .endlist
36396
36397 In all cases, if there are other hosts (or IP addresses) available for the
36398 current set of addresses (for example, from multiple MX records), they are
36399 tried in this run for any undelivered addresses, subject of course to their
36400 own retry data. In other words, recipient error retry data does not take effect
36401 until the next delivery attempt.
36402
36403 Some hosts have been observed to give temporary error responses to every
36404 MAIL command at certain times (&"insufficient space"& has been seen). It
36405 would be nice if such circumstances could be recognized, and defer data for the
36406 host itself created, but this is not possible within the current Exim design.
36407 What actually happens is that retry data for every (host, message) combination
36408 is created.
36409
36410 The reason that timeouts after MAIL and RCPT are treated specially is that
36411 these can sometimes arise as a result of the remote host's verification
36412 procedures. Exim makes this assumption, and treats them as if a temporary error
36413 response had been received. A timeout after &"."& is treated specially because
36414 it is known that some broken implementations fail to recognize the end of the
36415 message if the last character of the last line is a binary zero. Thus, it is
36416 helpful to treat this case as a message error.
36417
36418 Timeouts at other times are treated as host errors, assuming a problem with the
36419 host, or the connection to it. If a timeout after MAIL, RCPT,
36420 or &"."& is really a connection problem, the assumption is that at the next try
36421 the timeout is likely to occur at some other point in the dialogue, causing it
36422 then to be treated as a host error.
36423
36424 There is experimental evidence that some MTAs drop the connection after the
36425 terminating &"."& if they do not like the contents of the message for some
36426 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
36427 should be given. That is why Exim treats this case as a message rather than a
36428 host error, in order not to delay other messages to the same host.
36429
36430
36431
36432
36433 .section "Incoming SMTP messages over TCP/IP" "SECID233"
36434 .cindex "SMTP" "incoming over TCP/IP"
36435 .cindex "incoming SMTP over TCP/IP"
36436 .cindex "inetd"
36437 .cindex "daemon"
36438 Incoming SMTP messages can be accepted in one of two ways: by running a
36439 listening daemon, or by using &'inetd'&. In the latter case, the entry in
36440 &_/etc/inetd.conf_& should be like this:
36441 .code
36442 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
36443 .endd
36444 Exim distinguishes between this case and the case of a locally running user
36445 agent using the &%-bs%& option by checking whether or not the standard input is
36446 a socket. When it is, either the port must be privileged (less than 1024), or
36447 the caller must be root or the Exim user. If any other user passes a socket
36448 with an unprivileged port number, Exim prints a message on the standard error
36449 stream and exits with an error code.
36450
36451 By default, Exim does not make a log entry when a remote host connects or
36452 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
36453 unexpected. It can be made to write such log entries by setting the
36454 &%smtp_connection%& log selector.
36455
36456 .cindex "carriage return"
36457 .cindex "linefeed"
36458 Commands from the remote host are supposed to be terminated by CR followed by
36459 LF. However, there are known to be hosts that do not send CR characters. In
36460 order to be able to interwork with such hosts, Exim treats LF on its own as a
36461 line terminator.
36462 Furthermore, because common code is used for receiving messages from all
36463 sources, a CR on its own is also interpreted as a line terminator. However, the
36464 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
36465
36466 .cindex "EHLO" "invalid data"
36467 .cindex "HELO" "invalid data"
36468 One area that sometimes gives rise to problems concerns the EHLO or
36469 HELO commands. Some clients send syntactically invalid versions of these
36470 commands, which Exim rejects by default. (This is nothing to do with verifying
36471 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
36472 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
36473 match the broken hosts that send invalid commands.
36474
36475 .cindex "SIZE option on MAIL command"
36476 .cindex "MAIL" "SIZE option"
36477 The amount of disk space available is checked whenever SIZE is received on
36478 a MAIL command, independently of whether &%message_size_limit%& or
36479 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
36480 false. A temporary error is given if there is not enough space. If
36481 &%check_spool_space%& is set, the check is for that amount of space plus the
36482 value given with SIZE, that is, it checks that the addition of the incoming
36483 message will not reduce the space below the threshold.
36484
36485 When a message is successfully received, Exim includes the local message id in
36486 its response to the final &"."& that terminates the data. If the remote host
36487 logs this text it can help with tracing what has happened to a message.
36488
36489 The Exim daemon can limit the number of simultaneous incoming connections it is
36490 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
36491 number of simultaneous incoming connections from a single remote host (see the
36492 &%smtp_accept_max_per_host%& option). Additional connection attempts are
36493 rejected using the SMTP temporary error code 421.
36494
36495 The Exim daemon does not rely on the SIGCHLD signal to detect when a
36496 subprocess has finished, as this can get lost at busy times. Instead, it looks
36497 for completed subprocesses every time it wakes up. Provided there are other
36498 things happening (new incoming calls, starts of queue runs), completed
36499 processes will be noticed and tidied away. On very quiet systems you may
36500 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
36501 it will be noticed when the daemon next wakes up.
36502
36503 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
36504 and can also be set up to reject SMTP calls from non-reserved hosts at times of
36505 high system load &-- for details see the &%smtp_accept_reserve%&,
36506 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
36507 applies in both the daemon and &'inetd'& cases.
36508
36509 Exim normally starts a delivery process for each message received, though this
36510 can be varied by means of the &%-odq%& command line option and the
36511 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
36512 number of simultaneously running delivery processes started in this way from
36513 SMTP input can be limited by the &%smtp_accept_queue%& and
36514 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
36515 subsequently received messages are just put on the input queue without starting
36516 a delivery process.
36517
36518 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
36519 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
36520 started up from the &'inetd'& daemon, because in that case each connection is
36521 handled by an entirely independent Exim process. Control by load average is,
36522 however, available with &'inetd'&.
36523
36524 Exim can be configured to verify addresses in incoming SMTP commands as they
36525 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
36526 to rewrite addresses at this time &-- before any syntax checking is done. See
36527 section &<<SECTrewriteS>>&.
36528
36529 Exim can also be configured to limit the rate at which a client host submits
36530 MAIL and RCPT commands in a single SMTP session. See the
36531 &%smtp_ratelimit_hosts%& option.
36532
36533
36534
36535 .section "Unrecognized SMTP commands" "SECID234"
36536 .cindex "SMTP" "unrecognized commands"
36537 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
36538 commands during a single SMTP connection, it drops the connection after sending
36539 the error response to the last command. The default value for
36540 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
36541 abuse that subvert web servers into making connections to SMTP ports; in these
36542 circumstances, a number of non-SMTP lines are sent first.
36543
36544
36545 .section "Syntax and protocol errors in SMTP commands" "SECID235"
36546 .cindex "SMTP" "syntax errors"
36547 .cindex "SMTP" "protocol errors"
36548 A syntax error is detected if an SMTP command is recognized, but there is
36549 something syntactically wrong with its data, for example, a malformed email
36550 address in a RCPT command. Protocol errors include invalid command
36551 sequencing such as RCPT before MAIL. If Exim receives more than
36552 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
36553 drops the connection after sending the error response to the last command. The
36554 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
36555 broken clients that loop sending bad commands (yes, it has been seen).
36556
36557
36558
36559 .section "Use of non-mail SMTP commands" "SECID236"
36560 .cindex "SMTP" "non-mail commands"
36561 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
36562 DATA. Exim counts such commands, and drops the connection if there are too
36563 many of them in a single SMTP session. This action catches some
36564 denial-of-service attempts and things like repeated failing AUTHs, or a mad
36565 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
36566 defines what &"too many"& means. Its default value is 10.
36567
36568 When a new message is expected, one occurrence of RSET is not counted. This
36569 allows a client to send one RSET between messages (this is not necessary,
36570 but some clients do it). Exim also allows one uncounted occurrence of HELO
36571 or EHLO, and one occurrence of STARTTLS between messages. After
36572 starting up a TLS session, another EHLO is expected, and so it too is not
36573 counted.
36574
36575 The first occurrence of AUTH in a connection, or immediately following
36576 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
36577 RCPT, DATA, and QUIT are counted.
36578
36579 You can control which hosts are subject to the limit set by
36580 &%smtp_accept_max_nonmail%& by setting
36581 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
36582 the limit apply to all hosts. This option means that you can exclude any
36583 specific badly-behaved hosts that you have to live with.
36584
36585
36586
36587
36588 .section "The VRFY and EXPN commands" "SECID237"
36589 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
36590 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
36591 appropriate) in order to decide whether the command should be accepted or not.
36592
36593 .cindex "VRFY" "processing"
36594 When no ACL is defined for VRFY, or if it rejects without
36595 setting an explicit response code, the command is accepted
36596 (with a 252 SMTP response code)
36597 in order to support awkward clients that do a VRFY before every RCPT.
36598 When VRFY is accepted, it runs exactly the same code as when Exim is
36599 called with the &%-bv%& option, and returns 250/451/550
36600 SMTP response codes.
36601
36602 .cindex "EXPN" "processing"
36603 If no ACL for EXPN is defined, the command is rejected.
36604 When EXPN is accepted, a single-level expansion of the address is done.
36605 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
36606 than a verification (the &%-bv%& option). If an unqualified local part is given
36607 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
36608 of VRFY and EXPN commands are logged on the main and reject logs, and
36609 VRFY verification failures are logged on the main log for consistency with
36610 RCPT failures.
36611
36612
36613
36614 .section "The ETRN command" "SECTETRN"
36615 .cindex "ETRN" "processing"
36616 .cindex "ESMTP extensions" ETRN
36617 RFC 1985 describes an ESMTP command called ETRN that is designed to
36618 overcome the security problems of the TURN command (which has fallen into
36619 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
36620 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
36621 should be accepted or not. If no ACL is defined, the command is rejected.
36622
36623 The ETRN command is concerned with &"releasing"& messages that are awaiting
36624 delivery to certain hosts. As Exim does not organize its message queue by host,
36625 the only form of ETRN that is supported by default is the one where the
36626 text starts with the &"#"& prefix, in which case the remainder of the text is
36627 specific to the SMTP server. A valid ETRN command causes a run of Exim with
36628 the &%-R%& option to happen, with the remainder of the ETRN text as its
36629 argument. For example,
36630 .code
36631 ETRN #brigadoon
36632 .endd
36633 runs the command
36634 .code
36635 exim -R brigadoon
36636 .endd
36637 which causes a delivery attempt on all messages with undelivered addresses
36638 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
36639 default), Exim prevents the simultaneous execution of more than one queue run
36640 for the same argument string as a result of an ETRN command. This stops
36641 a misbehaving client from starting more than one queue runner at once.
36642
36643 .cindex "hints database" "ETRN serialization"
36644 Exim implements the serialization by means of a hints database in which a
36645 record is written whenever a process is started by ETRN, and deleted when
36646 the process completes. However, Exim does not keep the SMTP session waiting for
36647 the ETRN process to complete. Once ETRN is accepted, the client is sent
36648 a &"success"& return code. Obviously there is scope for hints records to get
36649 left lying around if there is a system or program crash. To guard against this,
36650 Exim ignores any records that are more than six hours old.
36651
36652 .oindex "&%smtp_etrn_command%&"
36653 For more control over what ETRN does, the &%smtp_etrn_command%& option can
36654 used. This specifies a command that is run whenever ETRN is received,
36655 whatever the form of its argument. For
36656 example:
36657 .code
36658 smtp_etrn_command = /etc/etrn_command $domain \
36659                     $sender_host_address
36660 .endd
36661 .vindex "&$domain$&"
36662 The string is split up into arguments which are independently expanded. The
36663 expansion variable &$domain$& is set to the argument of the ETRN command,
36664 and no syntax checking is done on the contents of this argument. Exim does not
36665 wait for the command to complete, so its status code is not checked. Exim runs
36666 under its own uid and gid when receiving incoming SMTP, so it is not possible
36667 for it to change them before running the command.
36668
36669
36670
36671 .section "Incoming local SMTP" "SECID238"
36672 .cindex "SMTP" "local incoming"
36673 Some user agents use SMTP to pass messages to their local MTA using the
36674 standard input and output, as opposed to passing the envelope on the command
36675 line and writing the message to the standard input. This is supported by the
36676 &%-bs%& option. This form of SMTP is handled in the same way as incoming
36677 messages over TCP/IP (including the use of ACLs), except that the envelope
36678 sender given in a MAIL command is ignored unless the caller is trusted. In
36679 an ACL you can detect this form of SMTP input by testing for an empty host
36680 identification. It is common to have this as the first line in the ACL that
36681 runs for RCPT commands:
36682 .code
36683 accept hosts = :
36684 .endd
36685 This accepts SMTP messages from local processes without doing any other tests.
36686
36687
36688
36689 .section "Outgoing batched SMTP" "SECTbatchSMTP"
36690 .cindex "SMTP" "batched outgoing"
36691 .cindex "batched SMTP output"
36692 Both the &(appendfile)& and &(pipe)& transports can be used for handling
36693 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
36694 be output in BSMTP format. No SMTP responses are possible for this form of
36695 delivery. All it is doing is using SMTP commands as a way of transmitting the
36696 envelope along with the message.
36697
36698 The message is written to the file or pipe preceded by the SMTP commands
36699 MAIL and RCPT, and followed by a line containing a single dot. Lines in
36700 the message that start with a dot have an extra dot added. The SMTP command
36701 HELO is not normally used. If it is required, the &%message_prefix%& option
36702 can be used to specify it.
36703
36704 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
36705 one recipient address at a time by default. However, you can arrange for them
36706 to handle several addresses at once by setting the &%batch_max%& option. When
36707 this is done for BSMTP, messages may contain multiple RCPT commands. See
36708 chapter &<<CHAPbatching>>& for more details.
36709
36710 .vindex "&$host$&"
36711 When one or more addresses are routed to a BSMTP transport by a router that
36712 sets up a host list, the name of the first host on the list is available to the
36713 transport in the variable &$host$&. Here is an example of such a transport and
36714 router:
36715 .code
36716 begin routers
36717 route_append:
36718   driver = manualroute
36719   transport = smtp_appendfile
36720   route_list = domain.example  batch.host.example
36721
36722 begin transports
36723 smtp_appendfile:
36724   driver = appendfile
36725   directory = /var/bsmtp/$host
36726   batch_max = 1000
36727   use_bsmtp
36728   user = exim
36729 .endd
36730 This causes messages addressed to &'domain.example'& to be written in BSMTP
36731 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
36732 message (unless there are more than 1000 recipients).
36733
36734
36735
36736 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
36737 .cindex "SMTP" "batched incoming"
36738 .cindex "batched SMTP input"
36739 The &%-bS%& command line option causes Exim to accept one or more messages by
36740 reading SMTP on the standard input, but to generate no responses. If the caller
36741 is trusted, the senders in the MAIL commands are believed; otherwise the
36742 sender is always the caller of Exim. Unqualified senders and receivers are not
36743 rejected (there seems little point) but instead just get qualified. HELO
36744 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
36745 as NOOP; QUIT quits.
36746
36747 Minimal policy checking is done for BSMTP input. Only the non-SMTP
36748 ACL is run in the same way as for non-SMTP local input.
36749
36750 If an error is detected while reading a message, including a missing &"."& at
36751 the end, Exim gives up immediately. It writes details of the error to the
36752 standard output in a stylized way that the calling program should be able to
36753 make some use of automatically, for example:
36754 .code
36755 554 Unexpected end of file
36756 Transaction started in line 10
36757 Error detected in line 14
36758 .endd
36759 It writes a more verbose version, for human consumption, to the standard error
36760 file, for example:
36761 .code
36762 An error was detected while processing a file of BSMTP input.
36763 The error message was:
36764
36765 501 '>' missing at end of address
36766
36767 The SMTP transaction started in line 10.
36768 The error was detected in line 12.
36769 The SMTP command at fault was:
36770
36771 rcpt to:<malformed@in.com.plete
36772
36773 1 previous message was successfully processed.
36774 The rest of the batch was abandoned.
36775 .endd
36776 The return code from Exim is zero only if there were no errors. It is 1 if some
36777 messages were accepted before an error was detected, and 2 if no messages were
36778 accepted.
36779 .ecindex IIDsmtpproc1
36780 .ecindex IIDsmtpproc2
36781
36782
36783
36784 . ////////////////////////////////////////////////////////////////////////////
36785 . ////////////////////////////////////////////////////////////////////////////
36786
36787 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
36788          "Customizing messages"
36789 When a message fails to be delivered, or remains in the queue for more than a
36790 configured amount of time, Exim sends a message to the original sender, or
36791 to an alternative configured address. The text of these messages is built into
36792 the code of Exim, but it is possible to change it, either by adding a single
36793 string, or by replacing each of the paragraphs by text supplied in a file.
36794
36795 The &'From:'& and &'To:'& header lines are automatically generated; you can
36796 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
36797 option. Exim also adds the line
36798 .code
36799 Auto-Submitted: auto-generated
36800 .endd
36801 to all warning and bounce messages,
36802
36803
36804 .section "Customizing bounce messages" "SECID239"
36805 .cindex "customizing" "bounce message"
36806 .cindex "bounce message" "customizing"
36807 If &%bounce_message_text%& is set, its contents are included in the default
36808 message immediately after &"This message was created automatically by mail
36809 delivery software."& The string is not expanded. It is not used if
36810 &%bounce_message_file%& is set.
36811
36812 When &%bounce_message_file%& is set, it must point to a template file for
36813 constructing error messages. The file consists of a series of text items,
36814 separated by lines consisting of exactly four asterisks. If the file cannot be
36815 opened, default text is used and a message is written to the main and panic
36816 logs. If any text item in the file is empty, default text is used for that
36817 item.
36818
36819 .vindex "&$bounce_recipient$&"
36820 .vindex "&$bounce_return_size_limit$&"
36821 Each item of text that is read from the file is expanded, and there are two
36822 expansion variables which can be of use here: &$bounce_recipient$& is set to
36823 the recipient of an error message while it is being created, and
36824 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
36825 option, rounded to a whole number.
36826
36827 The items must appear in the file in the following order:
36828
36829 .ilist
36830 The first item is included in the headers, and should include at least a
36831 &'Subject:'& header. Exim does not check the syntax of these headers.
36832 .next
36833 The second item forms the start of the error message. After it, Exim lists the
36834 failing addresses with their error messages.
36835 .next
36836 The third item is used to introduce any text from pipe transports that is to be
36837 returned to the sender. It is omitted if there is no such text.
36838 .next
36839 The fourth, fifth and sixth items will be ignored and may be empty.
36840 The fields exist for back-compatibility
36841 .endlist
36842
36843 The default state (&%bounce_message_file%& unset) is equivalent to the
36844 following file, in which the sixth item is empty. The &'Subject:'& and some
36845 other lines have been split in order to fit them on the page:
36846 .code
36847 Subject: Mail delivery failed
36848   ${if eq{$sender_address}{$bounce_recipient}
36849   {: returning message to sender}}
36850 ****
36851 This message was created automatically by mail delivery software.
36852
36853 A message ${if eq{$sender_address}{$bounce_recipient}
36854   {that you sent }{sent by
36855
36856 <$sender_address>
36857
36858 }}could not be delivered to all of its recipients.
36859 This is a permanent error. The following address(es) failed:
36860 ****
36861 The following text was generated during the delivery attempt(s):
36862 ****
36863 ------ This is a copy of the message, including all the headers.
36864   ------
36865 ****
36866 ------ The body of the message is $message_size characters long;
36867   only the first
36868 ------ $bounce_return_size_limit or so are included here.
36869 ****
36870 .endd
36871 .section "Customizing warning messages" "SECTcustwarn"
36872 .cindex "customizing" "warning message"
36873 .cindex "warning of delay" "customizing the message"
36874 The option &%warn_message_file%& can be pointed at a template file for use when
36875 warnings about message delays are created. In this case there are only three
36876 text sections:
36877
36878 .ilist
36879 The first item is included in the headers, and should include at least a
36880 &'Subject:'& header. Exim does not check the syntax of these headers.
36881 .next
36882 The second item forms the start of the warning message. After it, Exim lists
36883 the delayed addresses.
36884 .next
36885 The third item then ends the message.
36886 .endlist
36887
36888 The default state is equivalent to the following file, except that some lines
36889 have been split here, in order to fit them on the page:
36890 .code
36891 Subject: Warning: message $message_exim_id delayed
36892   $warn_message_delay
36893 ****
36894 This message was created automatically by mail delivery software.
36895
36896 A message ${if eq{$sender_address}{$warn_message_recipients}
36897 {that you sent }{sent by
36898
36899 <$sender_address>
36900
36901 }}has not been delivered to all of its recipients after
36902 more than $warn_message_delay in the queue on $primary_hostname.
36903
36904 The message identifier is:     $message_exim_id
36905 The subject of the message is: $h_subject
36906 The date of the message is:    $h_date
36907
36908 The following address(es) have not yet been delivered:
36909 ****
36910 No action is required on your part. Delivery attempts will
36911 continue for some time, and this warning may be repeated at
36912 intervals if the message remains undelivered. Eventually the
36913 mail delivery software will give up, and when that happens,
36914 the message will be returned to you.
36915 .endd
36916 .vindex "&$warn_message_delay$&"
36917 .vindex "&$warn_message_recipients$&"
36918 However, in the default state the subject and date lines are omitted if no
36919 appropriate headers exist. During the expansion of this file,
36920 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
36921 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
36922 of recipients for the warning message. There may be more than one if there are
36923 multiple addresses with different &%errors_to%& settings on the routers that
36924 handled them.
36925
36926
36927
36928
36929 . ////////////////////////////////////////////////////////////////////////////
36930 . ////////////////////////////////////////////////////////////////////////////
36931
36932 .chapter "Some common configuration settings" "CHAPcomconreq"
36933 This chapter discusses some configuration settings that seem to be fairly
36934 common. More examples and discussion can be found in the Exim book.
36935
36936
36937
36938 .section "Sending mail to a smart host" "SECID240"
36939 .cindex "smart host" "example router"
36940 If you want to send all mail for non-local domains to a &"smart host"&, you
36941 should replace the default &(dnslookup)& router with a router which does the
36942 routing explicitly:
36943 .code
36944 send_to_smart_host:
36945   driver = manualroute
36946   route_list = !+local_domains smart.host.name
36947   transport = remote_smtp
36948 .endd
36949 You can use the smart host's IP address instead of the name if you wish.
36950 If you are using Exim only to submit messages to a smart host, and not for
36951 receiving incoming messages, you can arrange for it to do the submission
36952 synchronously by setting the &%mua_wrapper%& option (see chapter
36953 &<<CHAPnonqueueing>>&).
36954
36955
36956
36957
36958 .section "Using Exim to handle mailing lists" "SECTmailinglists"
36959 .cindex "mailing lists"
36960 Exim can be used to run simple mailing lists, but for large and/or complicated
36961 requirements, the use of additional specialized mailing list software such as
36962 Majordomo or Mailman is recommended.
36963
36964 The &(redirect)& router can be used to handle mailing lists where each list
36965 is maintained in a separate file, which can therefore be managed by an
36966 independent manager. The &%domains%& router option can be used to run these
36967 lists in a separate domain from normal mail. For example:
36968 .code
36969 lists:
36970   driver = redirect
36971   domains = lists.example
36972   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
36973   forbid_pipe
36974   forbid_file
36975   errors_to = ${quote_local_part:$local_part-request}@lists.example
36976   no_more
36977 .endd
36978 This router is skipped for domains other than &'lists.example'&. For addresses
36979 in that domain, it looks for a file that matches the local part. If there is no
36980 such file, the router declines, but because &%no_more%& is set, no subsequent
36981 routers are tried, and so the whole delivery fails.
36982
36983 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
36984 expanded into a filename or a pipe delivery, which is usually inappropriate in
36985 a mailing list.
36986
36987 .oindex "&%errors_to%&"
36988 The &%errors_to%& option specifies that any delivery errors caused by addresses
36989 taken from a mailing list are to be sent to the given address rather than the
36990 original sender of the message. However, before acting on this, Exim verifies
36991 the error address, and ignores it if verification fails.
36992
36993 For example, using the configuration above, mail sent to
36994 &'dicts@lists.example'& is passed on to those addresses contained in
36995 &_/usr/lists/dicts_&, with error reports directed to
36996 &'dicts-request@lists.example'&, provided that this address can be verified.
36997 There could be a file called &_/usr/lists/dicts-request_& containing
36998 the address(es) of this particular list's manager(s), but other approaches,
36999 such as setting up an earlier router (possibly using the &%local_part_prefix%&
37000 or &%local_part_suffix%& options) to handle addresses of the form
37001 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
37002
37003
37004
37005 .section "Syntax errors in mailing lists" "SECID241"
37006 .cindex "mailing lists" "syntax errors in"
37007 If an entry in redirection data contains a syntax error, Exim normally defers
37008 delivery of the original address. That means that a syntax error in a mailing
37009 list holds up all deliveries to the list. This may not be appropriate when a
37010 list is being maintained automatically from data supplied by users, and the
37011 addresses are not rigorously checked.
37012
37013 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
37014 entries that fail to parse, noting the incident in the log. If in addition
37015 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
37016 whenever a broken address is skipped. It is usually appropriate to set
37017 &%syntax_errors_to%& to the same address as &%errors_to%&.
37018
37019
37020
37021 .section "Re-expansion of mailing lists" "SECID242"
37022 .cindex "mailing lists" "re-expansion of"
37023 Exim remembers every individual address to which a message has been delivered,
37024 in order to avoid duplication, but it normally stores only the original
37025 recipient addresses with a message. If all the deliveries to a mailing list
37026 cannot be done at the first attempt, the mailing list is re-expanded when the
37027 delivery is next tried. This means that alterations to the list are taken into
37028 account at each delivery attempt, so addresses that have been added to
37029 the list since the message arrived will therefore receive a copy of the
37030 message, even though it pre-dates their subscription.
37031
37032 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
37033 on the &(redirect)& router. If this is done, any addresses generated by the
37034 router that fail to deliver at the first attempt are added to the message as
37035 &"top level"& addresses, and the parent address that generated them is marked
37036 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
37037 subsequent delivery attempts. The disadvantage of this is that if any of the
37038 failing addresses are incorrect, correcting them in the file has no effect on
37039 pre-existing messages.
37040
37041 The original top-level address is remembered with each of the generated
37042 addresses, and is output in any log messages. However, any intermediate parent
37043 addresses are not recorded. This makes a difference to the log only if the
37044 &%all_parents%& selector is set, but for mailing lists there is normally only
37045 one level of expansion anyway.
37046
37047
37048
37049 .section "Closed mailing lists" "SECID243"
37050 .cindex "mailing lists" "closed"
37051 The examples so far have assumed open mailing lists, to which anybody may
37052 send mail. It is also possible to set up closed lists, where mail is accepted
37053 from specified senders only. This is done by making use of the generic
37054 &%senders%& option to restrict the router that handles the list.
37055
37056 The following example uses the same file as a list of recipients and as a list
37057 of permitted senders. It requires three routers:
37058 .code
37059 lists_request:
37060   driver = redirect
37061   domains = lists.example
37062   local_part_suffix = -request
37063   local_parts = ${lookup {$local_part} dsearch,filter=file {/usr/lists}}
37064   file = /usr/lists/${local_part_data}-request
37065   no_more
37066
37067 lists_post:
37068   driver = redirect
37069   domains = lists.example
37070   senders = ${if exists {/usr/lists/$local_part}\
37071              {lsearch;/usr/lists/$local_part}{*}}
37072   file = ${lookup {$local_part} dsearch,ret=full {/usr/lists}}
37073   forbid_pipe
37074   forbid_file
37075   errors_to = ${quote_local_part:$local_part-request}@lists.example
37076   no_more
37077
37078 lists_closed:
37079   driver = redirect
37080   domains = lists.example
37081   allow_fail
37082   data = :fail: $local_part@lists.example is a closed mailing list
37083 .endd
37084 All three routers have the same &%domains%& setting, so for any other domains,
37085 they are all skipped. The first router runs only if the local part ends in
37086 &%-request%&. It handles messages to the list manager(s) by means of an open
37087 mailing list.
37088
37089 The second router runs only if the &%senders%& precondition is satisfied. It
37090 checks for the existence of a list that corresponds to the local part, and then
37091 checks that the sender is on the list by means of a linear search. It is
37092 necessary to check for the existence of the file before trying to search it,
37093 because otherwise Exim thinks there is a configuration error. If the file does
37094 not exist, the expansion of &%senders%& is *, which matches all senders. This
37095 means that the router runs, but because there is no list, declines, and
37096 &%no_more%& ensures that no further routers are run. The address fails with an
37097 &"unrouteable address"& error.
37098
37099 The third router runs only if the second router is skipped, which happens when
37100 a mailing list exists, but the sender is not on it. This router forcibly fails
37101 the address, giving a suitable error message.
37102
37103
37104
37105
37106 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
37107 .cindex "VERP"
37108 .cindex "Variable Envelope Return Paths"
37109 .cindex "envelope from"
37110 .cindex "envelope sender"
37111 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
37112 are a way of helping mailing list administrators discover which subscription
37113 address is the cause of a particular delivery failure. The idea is to encode
37114 the original recipient address in the outgoing envelope sender address, so that
37115 if the message is forwarded by another host and then subsequently bounces, the
37116 original recipient can be extracted from the recipient address of the bounce.
37117
37118 .oindex &%errors_to%&
37119 .oindex &%return_path%&
37120 Envelope sender addresses can be modified by Exim using two different
37121 facilities: the &%errors_to%& option on a router (as shown in previous mailing
37122 list examples), or the &%return_path%& option on a transport. The second of
37123 these is effective only if the message is successfully delivered to another
37124 host; it is not used for errors detected on the local host (see the description
37125 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
37126 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
37127 .code
37128 verp_smtp:
37129   driver = smtp
37130   max_rcpt = 1
37131   return_path = \
37132     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37133       {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37134 .endd
37135 This has the effect of rewriting the return path (envelope sender) on outgoing
37136 SMTP messages, if the local part of the original return path ends in
37137 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
37138 local part and domain of the recipient into the return path. Suppose, for
37139 example, that a message whose return path has been set to
37140 &'somelist-request@your.dom.example'& is sent to
37141 &'subscriber@other.dom.example'&. In the transport, the return path is
37142 rewritten as
37143 .code
37144 somelist-request+subscriber=other.dom.example@your.dom.example
37145 .endd
37146 .vindex "&$local_part$&"
37147 For this to work, you must tell Exim to send multiple copies of messages that
37148 have more than one recipient, so that each copy has just one recipient. This is
37149 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
37150 might be sent to several different recipients in the same domain, in which case
37151 &$local_part$& is not available in the transport, because it is not unique.
37152
37153 Unless your host is doing nothing but mailing list deliveries, you should
37154 probably use a separate transport for the VERP deliveries, so as not to use
37155 extra resources in making one-per-recipient copies for other deliveries. This
37156 can easily be done by expanding the &%transport%& option in the router:
37157 .code
37158 dnslookup:
37159   driver = dnslookup
37160   domains = ! +local_domains
37161   transport = \
37162     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
37163       {verp_smtp}{remote_smtp}}
37164   no_more
37165 .endd
37166 If you want to change the return path using &%errors_to%& in a router instead
37167 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
37168 routers that handle mailing list addresses. This will ensure that all delivery
37169 errors, including those detected on the local host, are sent to the VERP
37170 address.
37171
37172 On a host that does no local deliveries and has no manual routing, only the
37173 &(dnslookup)& router needs to be changed. A special transport is not needed for
37174 SMTP deliveries. Every mailing list recipient has its own return path value,
37175 and so Exim must hand them to the transport one at a time. Here is an example
37176 of a &(dnslookup)& router that implements VERP:
37177 .code
37178 verp_dnslookup:
37179   driver = dnslookup
37180   domains = ! +local_domains
37181   transport = remote_smtp
37182   errors_to = \
37183     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
37184      {${quote_local_part:$1-request+$local_part=$domain}@your.dom.example}fail}
37185   no_more
37186 .endd
37187 Before you start sending out messages with VERPed return paths, you must also
37188 configure Exim to accept the bounce messages that come back to those paths.
37189 Typically this is done by setting a &%local_part_suffix%& option for a
37190 router, and using this to route the messages to wherever you want to handle
37191 them.
37192
37193 The overhead incurred in using VERP depends very much on the size of the
37194 message, the number of recipient addresses that resolve to the same remote
37195 host, and the speed of the connection over which the message is being sent. If
37196 a lot of addresses resolve to the same host and the connection is slow, sending
37197 a separate copy of the message for each address may take substantially longer
37198 than sending a single copy with many recipients (for which VERP cannot be
37199 used).
37200
37201
37202
37203
37204
37205
37206 .section "Virtual domains" "SECTvirtualdomains"
37207 .cindex "virtual domains"
37208 .cindex "domain" "virtual"
37209 The phrase &'virtual domain'& is unfortunately used with two rather different
37210 meanings:
37211
37212 .ilist
37213 A domain for which there are no real mailboxes; all valid local parts are
37214 aliases for other email addresses. Common examples are organizational
37215 top-level domains and &"vanity"& domains.
37216 .next
37217 One of a number of independent domains that are all handled by the same host,
37218 with mailboxes on that host, but where the mailbox owners do not necessarily
37219 have login accounts on that host.
37220 .endlist
37221
37222 The first usage is probably more common, and does seem more &"virtual"& than
37223 the second. This kind of domain can be handled in Exim with a straightforward
37224 aliasing router. One approach is to create a separate alias file for each
37225 virtual domain. Exim can test for the existence of the alias file to determine
37226 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
37227 to a router of this form:
37228 .code
37229 virtual:
37230   driver = redirect
37231   domains = dsearch;/etc/mail/virtual
37232   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain_data}}
37233   no_more
37234 .endd
37235 The &%domains%& option specifies that the router is to be skipped, unless there
37236 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
37237 domain that is being processed.
37238 The &(dsearch)& lookup used results in an untainted version of &$domain$&
37239 being placed into the &$domain_data$& variable.
37240
37241 When the router runs, it looks up the local
37242 part in the file to find a new address (or list of addresses). The &%no_more%&
37243 setting ensures that if the lookup fails (leading to &%data%& being an empty
37244 string), Exim gives up on the address without trying any subsequent routers.
37245
37246 This one router can handle all the virtual domains because the alias filenames
37247 follow a fixed pattern. Permissions can be arranged so that appropriate people
37248 can edit the different alias files. A successful aliasing operation results in
37249 a new envelope recipient address, which is then routed from scratch.
37250
37251 The other kind of &"virtual"& domain can also be handled in a straightforward
37252 way. One approach is to create a file for each domain containing a list of
37253 valid local parts, and use it in a router like this:
37254 .code
37255 my_domains:
37256   driver = accept
37257   domains = dsearch;/etc/mail/domains
37258   local_parts = lsearch;/etc/mail/domains/$domain
37259   transport = my_mailboxes
37260 .endd
37261 The address is accepted if there is a file for the domain, and the local part
37262 can be found in the file. The &%domains%& option is used to check for the
37263 file's existence because &%domains%& is tested before the &%local_parts%&
37264 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
37265 because that option is tested after &%local_parts%&. The transport is as
37266 follows:
37267 .code
37268 my_mailboxes:
37269   driver = appendfile
37270   file = /var/mail/$domain/$local_part_data
37271   user = mail
37272 .endd
37273 This uses a directory of mailboxes for each domain. The &%user%& setting is
37274 required, to specify which uid is to be used for writing to the mailboxes.
37275
37276 The configuration shown here is just one example of how you might support this
37277 requirement. There are many other ways this kind of configuration can be set
37278 up, for example, by using a database instead of separate files to hold all the
37279 information about the domains.
37280
37281
37282
37283 .section "Multiple user mailboxes" "SECTmulbox"
37284 .cindex "multiple mailboxes"
37285 .cindex "mailbox" "multiple"
37286 .cindex "local part" "prefix"
37287 .cindex "local part" "suffix"
37288 Heavy email users often want to operate with multiple mailboxes, into which
37289 incoming mail is automatically sorted. A popular way of handling this is to
37290 allow users to use multiple sender addresses, so that replies can easily be
37291 identified. Users are permitted to add prefixes or suffixes to their local
37292 parts for this purpose. The wildcard facility of the generic router options
37293 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
37294 example, consider this router:
37295 .code
37296 userforward:
37297   driver = redirect
37298   check_local_user
37299   file = $home/.forward
37300   local_part_suffix = -*
37301   local_part_suffix_optional
37302   allow_filter
37303 .endd
37304 .vindex "&$local_part_suffix$&"
37305 It runs a user's &_.forward_& file for all local parts of the form
37306 &'username-*'&. Within the filter file the user can distinguish different
37307 cases by testing the variable &$local_part_suffix$&. For example:
37308 .code
37309 if $local_part_suffix contains -special then
37310 save /home/$local_part/Mail/special
37311 endif
37312 .endd
37313 If the filter file does not exist, or does not deal with such addresses, they
37314 fall through to subsequent routers, and, assuming no subsequent use of the
37315 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
37316 control over which suffixes are valid.
37317
37318 Alternatively, a suffix can be used to trigger the use of a different
37319 &_.forward_& file &-- which is the way a similar facility is implemented in
37320 another MTA:
37321 .code
37322 userforward:
37323   driver = redirect
37324   check_local_user
37325   local_part_suffix = -*
37326   local_part_suffix_optional
37327   file = ${lookup {.forward$local_part_suffix} dsearch,ret=full {$home} {$value}fail}
37328   allow_filter
37329 .endd
37330 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
37331 example, &_.forward-special_& is used. Once again, if the appropriate file
37332 does not exist, or does not deal with the address, it is passed on to
37333 subsequent routers, which could, if required, look for an unqualified
37334 &_.forward_& file to use as a default.
37335
37336
37337
37338 .section "Simplified vacation processing" "SECID244"
37339 .cindex "vacation processing"
37340 The traditional way of running the &'vacation'& program is for a user to set up
37341 a pipe command in a &_.forward_& file
37342 (see section &<<SECTspecitredli>>& for syntax details).
37343 This is prone to error by inexperienced users. There are two features of Exim
37344 that can be used to make this process simpler for users:
37345
37346 .ilist
37347 A local part prefix such as &"vacation-"& can be specified on a router which
37348 can cause the message to be delivered directly to the &'vacation'& program, or
37349 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
37350 &_.forward_& file are then much simpler. For example:
37351 .code
37352 spqr, vacation-spqr
37353 .endd
37354 .next
37355 The &%require_files%& generic router option can be used to trigger a
37356 vacation delivery by checking for the existence of a certain file in the
37357 user's home directory. The &%unseen%& generic option should also be used, to
37358 ensure that the original delivery also proceeds. In this case, all the user has
37359 to do is to create a file called, say, &_.vacation_&, containing a vacation
37360 message.
37361 .endlist
37362
37363 Another advantage of both these methods is that they both work even when the
37364 use of arbitrary pipes by users is locked out.
37365
37366
37367
37368 .section "Taking copies of mail" "SECID245"
37369 .cindex "message" "copying every"
37370 Some installations have policies that require archive copies of all messages to
37371 be made. A single copy of each message can easily be taken by an appropriate
37372 command in a system filter, which could, for example, use a different file for
37373 each day's messages.
37374
37375 There is also a shadow transport mechanism that can be used to take copies of
37376 messages that are successfully delivered by local transports, one copy per
37377 delivery. This could be used, &'inter alia'&, to implement automatic
37378 notification of delivery by sites that insist on doing such things.
37379
37380
37381
37382 .section "Intermittently connected hosts" "SECID246"
37383 .cindex "intermittently connected hosts"
37384 It has become quite common (because it is cheaper) for hosts to connect to the
37385 Internet periodically rather than remain connected all the time. The normal
37386 arrangement is that mail for such hosts accumulates on a system that is
37387 permanently connected.
37388
37389 Exim was designed for use on permanently connected hosts, and so it is not
37390 particularly well-suited to use in an intermittently connected environment.
37391 Nevertheless there are some features that can be used.
37392
37393
37394 .section "Exim on the upstream server host" "SECID247"
37395 It is tempting to arrange for incoming mail for the intermittently connected
37396 host to remain in Exim's queue until the client connects. However, this
37397 approach does not scale very well. Two different kinds of waiting message are
37398 being mixed up in the same queue &-- those that cannot be delivered because of
37399 some temporary problem, and those that are waiting for their destination host
37400 to connect. This makes it hard to manage the queue, as well as wasting
37401 resources, because each queue runner scans the entire queue.
37402
37403 A better approach is to separate off those messages that are waiting for an
37404 intermittently connected host. This can be done by delivering these messages
37405 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
37406 format, from where they are transmitted by other software when their
37407 destination connects. This makes it easy to collect all the mail for one host
37408 in a single directory, and to apply local timeout rules on a per-message basis
37409 if required.
37410
37411 On a very small scale, leaving the mail on Exim's queue can be made to work. If
37412 you are doing this, you should configure Exim with a long retry period for the
37413 intermittent host. For example:
37414 .code
37415 cheshire.wonderland.fict.example    *   F,5d,24h
37416 .endd
37417 This stops a lot of failed delivery attempts from occurring, but Exim remembers
37418 which messages it has queued up for that host. Once the intermittent host comes
37419 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
37420 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
37421 causes all the queued up messages to be delivered, often down a single SMTP
37422 connection. While the host remains connected, any new messages get delivered
37423 immediately.
37424
37425 If the connecting hosts do not have fixed IP addresses, that is, if a host is
37426 issued with a different IP address each time it connects, Exim's retry
37427 mechanisms on the holding host get confused, because the IP address is normally
37428 used as part of the key string for holding retry information. This can be
37429 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
37430 Since this has disadvantages for permanently connected hosts, it is best to
37431 arrange a separate transport for the intermittently connected ones.
37432
37433
37434
37435 .section "Exim on the intermittently connected client host" "SECID248"
37436 The value of &%smtp_accept_queue_per_connection%& should probably be
37437 increased, or even set to zero (that is, disabled) on the intermittently
37438 connected host, so that all incoming messages down a single connection get
37439 delivered immediately.
37440
37441 .cindex "SMTP" "passed connection"
37442 .cindex "SMTP" "multiple deliveries"
37443 .cindex "multiple SMTP deliveries"
37444 .cindex "first pass routing"
37445 Mail waiting to be sent from an intermittently connected host will probably
37446 not have been routed, because without a connection DNS lookups are not
37447 possible. This means that if a normal queue run is done at connection time,
37448 each message is likely to be sent in a separate SMTP session. This can be
37449 avoided by starting the queue run with a command line option beginning with
37450 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
37451 first pass, routing is done but no deliveries take place. The second pass is a
37452 normal queue run; since all the messages have been previously routed, those
37453 destined for the same host are likely to get sent as multiple deliveries in a
37454 single SMTP connection.
37455
37456
37457
37458 . ////////////////////////////////////////////////////////////////////////////
37459 . ////////////////////////////////////////////////////////////////////////////
37460
37461 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
37462          "Exim as a non-queueing client"
37463 .cindex "client, non-queueing"
37464 .cindex "smart host" "suppressing queueing"
37465 On a personal computer, it is a common requirement for all
37466 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
37467 configured to operate that way, for all the popular operating systems.
37468 However, there are some MUAs for Unix-like systems that cannot be so
37469 configured: they submit messages using the command line interface of
37470 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
37471 messages this way.
37472
37473 If the personal computer runs continuously, there is no problem, because it can
37474 run a conventional MTA that handles delivery to the smart host, and deal with
37475 any delays via its queueing mechanism. However, if the computer does not run
37476 continuously or runs different operating systems at different times, queueing
37477 email is not desirable.
37478
37479 There is therefore a requirement for something that can provide the
37480 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
37481 any queueing or retrying facilities. Furthermore, the delivery to the smart
37482 host should be synchronous, so that if it fails, the sending MUA is immediately
37483 informed. In other words, we want something that extends an MUA that submits
37484 to a local MTA via the command line so that it behaves like one that submits
37485 to a remote smart host using TCP/SMTP.
37486
37487 There are a number of applications (for example, there is one called &'ssmtp'&)
37488 that do this job. However, people have found them to be lacking in various
37489 ways. For instance, you might want to allow aliasing and forwarding to be done
37490 before sending a message to the smart host.
37491
37492 Exim already had the necessary infrastructure for doing this job. Just a few
37493 tweaks were needed to make it behave as required, though it is somewhat of an
37494 overkill to use a fully-featured MTA for this purpose.
37495
37496 .oindex "&%mua_wrapper%&"
37497 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
37498 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
37499 assumes that it is being used to &"wrap"& a command-line MUA in the manner
37500 just described. As well as setting &%mua_wrapper%&, you also need to provide a
37501 compatible router and transport configuration. Typically there will be just one
37502 router and one transport, sending everything to a smart host.
37503
37504 When run in MUA wrapping mode, the behaviour of Exim changes in the
37505 following ways:
37506
37507 .ilist
37508 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
37509 In other words, the only way to submit messages is via the command line.
37510 .next
37511 Each message is synchronously delivered as soon as it is received (&%-odi%& is
37512 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
37513 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
37514 does not finish until the delivery attempt is complete. If the delivery is
37515 successful, a zero return code is given.
37516 .next
37517 Address redirection is permitted, but the final routing for all addresses must
37518 be to the same remote transport, and to the same list of hosts. Furthermore,
37519 the return address (envelope sender) must be the same for all recipients, as
37520 must any added or deleted header lines. In other words, it must be possible to
37521 deliver the message in a single SMTP transaction, however many recipients there
37522 are.
37523 .next
37524 If these conditions are not met, or if routing any address results in a
37525 failure or defer status, or if Exim is unable to deliver all the recipients
37526 successfully to one of the smart hosts, delivery of the entire message fails.
37527 .next
37528 Because no queueing is allowed, all failures are treated as permanent; there
37529 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
37530 smart host. Furthermore, because only a single yes/no response can be given to
37531 the caller, it is not possible to deliver to some recipients and not others. If
37532 there is an error (temporary or permanent) for any recipient, all are failed.
37533 .next
37534 If more than one smart host is listed, Exim will try another host after a
37535 connection failure or a timeout, in the normal way. However, if this kind of
37536 failure happens for all the hosts, the delivery fails.
37537 .next
37538 When delivery fails, an error message is written to the standard error stream
37539 (as well as to Exim's log), and Exim exits to the caller with a return code
37540 value 1. The message is expunged from Exim's spool files. No bounce messages
37541 are ever generated.
37542 .next
37543 No retry data is maintained, and any retry rules are ignored.
37544 .next
37545 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
37546 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
37547 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
37548 .endlist
37549
37550 The overall effect is that Exim makes a single synchronous attempt to deliver
37551 the message, failing if there is any kind of problem. Because no local
37552 deliveries are done and no daemon can be run, Exim does not need root
37553 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
37554 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
37555 the advantages and disadvantages of running without root privilege.
37556
37557
37558
37559
37560 . ////////////////////////////////////////////////////////////////////////////
37561 . ////////////////////////////////////////////////////////////////////////////
37562
37563 .chapter "Log files" "CHAPlog"
37564 .scindex IIDloggen "log" "general description"
37565 .cindex "log" "types of"
37566 Exim writes three different logs, referred to as the main log, the reject log,
37567 and the panic log:
37568
37569 .ilist
37570 .cindex "main log"
37571 The main log records the arrival of each message and each delivery in a single
37572 line in each case. The format is as compact as possible, in an attempt to keep
37573 down the size of log files. Two-character flag sequences make it easy to pick
37574 out these lines. A number of other events are recorded in the main log. Some of
37575 them are optional, in which case the &%log_selector%& option controls whether
37576 they are included or not. A Perl script called &'eximstats'&, which does simple
37577 analysis of main log files, is provided in the Exim distribution (see section
37578 &<<SECTmailstat>>&).
37579 .next
37580 .cindex "reject log"
37581 The reject log records information from messages that are rejected as a result
37582 of a configuration option (that is, for policy reasons).
37583 The first line of each rejection is a copy of the line that is also written to
37584 the main log. Then, if the message's header has been read at the time the log
37585 is written, its contents are written to this log. Only the original header
37586 lines are available; header lines added by ACLs are not logged. You can use the
37587 reject log to check that your policy controls are working correctly; on a busy
37588 host this may be easier than scanning the main log for rejection messages. You
37589 can suppress the writing of the reject log by setting &%write_rejectlog%&
37590 false.
37591 .next
37592 .cindex "panic log"
37593 .cindex "system log"
37594 When certain serious errors occur, Exim writes entries to its panic log. If the
37595 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
37596 are usually written to the main log as well, but can get lost amid the mass of
37597 other entries. The panic log should be empty under normal circumstances. It is
37598 therefore a good idea to check it (or to have a &'cron'& script check it)
37599 regularly, in order to become aware of any problems. When Exim cannot open its
37600 panic log, it tries as a last resort to write to the system log (syslog). This
37601 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
37602 message itself is written at priority LOG_CRIT.
37603 .endlist
37604
37605 Every log line starts with a timestamp, in the format shown in the following
37606 example. Note that many of the examples shown in this chapter are line-wrapped.
37607 In the log file, this would be all on one line:
37608 .code
37609 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
37610   by QUIT
37611 .endd
37612 By default, the timestamps are in the local timezone. There are two
37613 ways of changing this:
37614
37615 .ilist
37616 You can set the &%timezone%& option to a different time zone; in particular, if
37617 you set
37618 .code
37619 timezone = UTC
37620 .endd
37621 the timestamps will be in UTC (aka GMT).
37622 .next
37623 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
37624 example:
37625 .code
37626 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
37627 .endd
37628 .endlist
37629
37630 .cindex "log" "process ids in"
37631 .cindex "pid (process id)" "in log lines"
37632 Exim does not include its process id in log lines by default, but you can
37633 request that it does so by specifying the &`pid`& log selector (see section
37634 &<<SECTlogselector>>&). When this is set, the process id is output, in square
37635 brackets, immediately after the time and date.
37636
37637
37638
37639
37640 .section "Where the logs are written" "SECTwhelogwri"
37641 .cindex "log" "destination"
37642 .cindex "log" "to file"
37643 .cindex "log" "to syslog"
37644 .cindex "syslog"
37645 The logs may be written to local files, or to syslog, or both. However, it
37646 should be noted that many syslog implementations use UDP as a transport, and
37647 are therefore unreliable in the sense that messages are not guaranteed to
37648 arrive at the loghost, nor is the ordering of messages necessarily maintained.
37649 It has also been reported that on large log files (tens of megabytes) you may
37650 need to tweak syslog to prevent it syncing the file with each write &-- on
37651 Linux this has been seen to make syslog take 90% plus of CPU time.
37652
37653 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
37654 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
37655 configuration. This latter string is expanded, so it can contain, for example,
37656 references to the host name:
37657 .code
37658 log_file_path = /var/log/$primary_hostname/exim_%slog
37659 .endd
37660 It is generally advisable, however, to set the string in &_Local/Makefile_&
37661 rather than at runtime, because then the setting is available right from the
37662 start of Exim's execution. Otherwise, if there's something it wants to log
37663 before it has read the configuration file (for example, an error in the
37664 configuration file) it will not use the path you want, and may not be able to
37665 log at all.
37666
37667 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
37668 list, currently limited to at most two items. This is one option where the
37669 facility for changing a list separator may not be used. The list must always be
37670 colon-separated. If an item in the list is &"syslog"& then syslog is used;
37671 otherwise the item must either be an absolute path, containing &`%s`& at the
37672 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
37673 implying the use of a default path.
37674
37675 When Exim encounters an empty item in the list, it searches the list defined by
37676 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
37677 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
37678 mean &"use the path specified at build time"&. It no such item exists, log
37679 files are written in the &_log_& subdirectory of the spool directory. This is
37680 equivalent to the setting:
37681 .code
37682 log_file_path = $spool_directory/log/%slog
37683 .endd
37684 If you do not specify anything at build time or runtime,
37685 or if you unset the option at runtime (i.e. &`log_file_path = `&),
37686 that is where the logs are written.
37687
37688 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
37689 are in use &-- see section &<<SECTdatlogfil>>& below.
37690
37691 Here are some examples of possible settings:
37692 .display
37693 &`LOG_FILE_PATH=syslog                    `& syslog only
37694 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
37695 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
37696 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
37697 .endd
37698 If there are more than two paths in the list, the first is used and a panic
37699 error is logged.
37700
37701
37702
37703 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
37704 .cindex "log" "cycling local files"
37705 .cindex "cycling logs"
37706 .cindex "&'exicyclog'&"
37707 .cindex "log" "local files; writing to"
37708 Some operating systems provide centralized and standardized methods for cycling
37709 log files. For those that do not, a utility script called &'exicyclog'& is
37710 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
37711 main and reject logs each time it is called. The maximum number of old logs to
37712 keep can be set. It is suggested this script is run as a daily &'cron'& job.
37713
37714 An Exim delivery process opens the main log when it first needs to write to it,
37715 and it keeps the file open in case subsequent entries are required &-- for
37716 example, if a number of different deliveries are being done for the same
37717 message. However, remote SMTP deliveries can take a long time, and this means
37718 that the file may be kept open long after it is renamed if &'exicyclog'& or
37719 something similar is being used to rename log files on a regular basis. To
37720 ensure that a switch of log files is noticed as soon as possible, Exim calls
37721 &[stat()]& on the main log's name before reusing an open file, and if the file
37722 does not exist, or its inode has changed, the old file is closed and Exim
37723 tries to open the main log from scratch. Thus, an old log file may remain open
37724 for quite some time, but no Exim processes should write to it once it has been
37725 renamed.
37726
37727
37728
37729 .section "Datestamped log files" "SECTdatlogfil"
37730 .cindex "log" "datestamped files"
37731 Instead of cycling the main and reject log files by renaming them
37732 periodically, some sites like to use files whose names contain a datestamp,
37733 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
37734 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
37735 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
37736 point where the datestamp is required. For example:
37737 .code
37738 log_file_path = /var/spool/exim/log/%slog-%D
37739 log_file_path = /var/log/exim-%s-%D.log
37740 log_file_path = /var/spool/exim/log/%D-%slog
37741 log_file_path = /var/log/exim/%s.%M
37742 .endd
37743 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
37744 examples of names generated by the above examples:
37745 .code
37746 /var/spool/exim/log/mainlog-20021225
37747 /var/log/exim-reject-20021225.log
37748 /var/spool/exim/log/20021225-mainlog
37749 /var/log/exim/main.200212
37750 .endd
37751 When this form of log file is specified, Exim automatically switches to new
37752 files at midnight. It does not make any attempt to compress old logs; you
37753 will need to write your own script if you require this. You should not
37754 run &'exicyclog'& with this form of logging.
37755
37756 The location of the panic log is also determined by &%log_file_path%&, but it
37757 is not datestamped, because rotation of the panic log does not make sense.
37758 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
37759 the string. In addition, if it immediately follows a slash, a following
37760 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
37761 character is removed. Thus, the four examples above would give these panic
37762 log names:
37763 .code
37764 /var/spool/exim/log/paniclog
37765 /var/log/exim-panic.log
37766 /var/spool/exim/log/paniclog
37767 /var/log/exim/panic
37768 .endd
37769
37770
37771 .section "Logging to syslog" "SECID249"
37772 .cindex "log" "syslog; writing to"
37773 The use of syslog does not change what Exim logs or the format of its messages,
37774 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
37775 Exim's log lines are omitted when these lines are sent to syslog. Apart from
37776 that, the same strings are written to syslog as to log files. The syslog
37777 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
37778 by default, but you can change these by setting the &%syslog_facility%& and
37779 &%syslog_processname%& options, respectively. If Exim was compiled with
37780 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
37781 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
37782 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
37783 the time and host name to each line.
37784 The three log streams are mapped onto syslog priorities as follows:
37785
37786 .ilist
37787 &'mainlog'& is mapped to LOG_INFO
37788 .next
37789 &'rejectlog'& is mapped to LOG_NOTICE
37790 .next
37791 &'paniclog'& is mapped to LOG_ALERT
37792 .endlist
37793
37794 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
37795 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
37796 these are routed by syslog to the same place. You can suppress this duplication
37797 by setting &%syslog_duplication%& false.
37798
37799 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
37800 entries contain multiple lines when headers are included. To cope with both
37801 these cases, entries written to syslog are split into separate &[syslog()]&
37802 calls at each internal newline, and also after a maximum of
37803 870 data characters. (This allows for a total syslog line length of 1024, when
37804 additions such as timestamps are added.) If you are running a syslog
37805 replacement that can handle lines longer than the 1024 characters allowed by
37806 RFC 3164, you should set
37807 .code
37808 SYSLOG_LONG_LINES=yes
37809 .endd
37810 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
37811 lines, but it still splits at internal newlines in &'reject'& log entries.
37812
37813 To make it easy to re-assemble split lines later, each component of a split
37814 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
37815 where <&'n'&> is the component number and <&'m'&> is the total number of
37816 components in the entry. The / delimiter is used when the line was split
37817 because it was too long; if it was split because of an internal newline, the \
37818 delimiter is used. For example, supposing the length limit to be 50 instead of
37819 870, the following would be the result of a typical rejection message to
37820 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
37821 name, and pid as added by syslog:
37822 .code
37823 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
37824 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
37825 [3/5]  when scanning for sender: missing or malformed lo
37826 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
37827 [5/5] mple>)
37828 .endd
37829 The same error might cause the following lines to be written to &"rejectlog"&
37830 (LOG_NOTICE):
37831 .code
37832 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
37833 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
37834 [3/18] er when scanning for sender: missing or malformed
37835 [4/18]  local part in "<>" (envelope sender is <ph10@cam
37836 [5\18] .example>)
37837 [6\18] Recipients: ph10@some.domain.cam.example
37838 [7\18] P Received: from [127.0.0.1] (ident=ph10)
37839 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
37840 [9\18]        id 16RdAL-0006pc-00
37841 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
37842 [11\18] 09:43 +0100
37843 [12\18] F From: <>
37844 [13\18]   Subject: this is a test header
37845 [18\18]   X-something: this is another header
37846 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
37847 [16\18] le>
37848 [17\18] B Bcc:
37849 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
37850 .endd
37851 Log lines that are neither too long nor contain newlines are written to syslog
37852 without modification.
37853
37854 If only syslog is being used, the Exim monitor is unable to provide a log tail
37855 display, unless syslog is routing &'mainlog'& to a file on the local host and
37856 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
37857 where it is.
37858
37859
37860
37861 .section "Log line flags" "SECID250"
37862 One line is written to the main log for each message received, and for each
37863 successful, unsuccessful, and delayed delivery. These lines can readily be
37864 picked out by the distinctive two-character flags that immediately follow the
37865 timestamp. The flags are:
37866 .display
37867 &`<=`&     message arrival
37868 &`(=`&     message fakereject
37869 &`=>`&     normal message delivery
37870 &`->`&     additional address in same delivery
37871 &`>>`&     cutthrough message delivery
37872 &`*>`&     delivery suppressed by &%-N%&
37873 &`**`&     delivery failed; address bounced
37874 &`==`&     delivery deferred; temporary problem
37875 .endd
37876
37877
37878 .section "Logging message reception" "SECID251"
37879 .cindex "log" "reception line"
37880 The format of the single-line entry in the main log that is written for every
37881 message received is shown in the basic example below, which is split over
37882 several lines in order to fit it on the page:
37883 .code
37884 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
37885   H=mailer.fict.example [192.168.123.123] U=exim
37886   P=smtp S=5678 id=<incoming message id>
37887 .endd
37888 The address immediately following &"<="& is the envelope sender address. A
37889 bounce message is shown with the sender address &"<>"&, and if it is locally
37890 generated, this is followed by an item of the form
37891 .code
37892 R=<message id>
37893 .endd
37894 which is a reference to the message that caused the bounce to be sent.
37895
37896 .cindex "HELO"
37897 .cindex "EHLO"
37898 For messages from other hosts, the H and U fields identify the remote host and
37899 record the RFC 1413 identity of the user that sent the message, if one was
37900 received. The number given in square brackets is the IP address of the sending
37901 host. If there is a single, unparenthesized  host name in the H field, as
37902 above, it has been verified to correspond to the IP address (see the
37903 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
37904 by the remote host in the SMTP HELO or EHLO command, and has not been
37905 verified. If verification yields a different name to that given for HELO or
37906 EHLO, the verified name appears first, followed by the HELO or EHLO
37907 name in parentheses.
37908
37909 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
37910 without brackets, in the HELO or EHLO command, leading to entries in
37911 the log containing text like these examples:
37912 .code
37913 H=(10.21.32.43) [192.168.8.34]
37914 H=([10.21.32.43]) [192.168.8.34]
37915 .endd
37916 This can be confusing. Only the final address in square brackets can be relied
37917 on.
37918
37919 For locally generated messages (that is, messages not received over TCP/IP),
37920 the H field is omitted, and the U field contains the login name of the caller
37921 of Exim.
37922
37923 .cindex "authentication" "logging"
37924 .cindex "AUTH" "logging"
37925 For all messages, the P field specifies the protocol used to receive the
37926 message. This is the value that is stored in &$received_protocol$&. In the case
37927 of incoming SMTP messages, the value indicates whether or not any SMTP
37928 extensions (ESMTP), encryption, or authentication were used. If the SMTP
37929 session was encrypted, there is an additional X field that records the cipher
37930 suite that was used.
37931
37932 .cindex log protocol
37933 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
37934 hosts that have authenticated themselves using the SMTP AUTH command. The first
37935 value is used when the SMTP connection was encrypted (&"secure"&). In this case
37936 there is an additional item A= followed by the name of the authenticator that
37937 was used. If an authenticated identification was set up by the authenticator's
37938 &%server_set_id%& option, this is logged too, separated by a colon from the
37939 authenticator name.
37940
37941 .cindex "size" "of message"
37942 The id field records the existing message id, if present. The size of the
37943 received message is given by the S field. When the message is delivered,
37944 headers may be removed or added, so that the size of delivered copies of the
37945 message may not correspond with this value (and indeed may be different to each
37946 other).
37947
37948 The &%log_selector%& option can be used to request the logging of additional
37949 data when a message is received. See section &<<SECTlogselector>>& below.
37950
37951
37952
37953 .section "Logging deliveries" "SECID252"
37954 .cindex "log" "delivery line"
37955 The format of the single-line entry in the main log that is written for every
37956 delivery is shown in one of the examples below, for local and remote
37957 deliveries, respectively. Each example has been split into multiple lines in order
37958 to fit it on the page:
37959 .code
37960 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
37961   <marv@hitch.fict.example> R=localuser T=local_delivery
37962 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
37963   monk@holistic.fict.example R=dnslookup T=remote_smtp
37964   H=holistic.fict.example [192.168.234.234]
37965 .endd
37966 For ordinary local deliveries, the original address is given in angle brackets
37967 after the final delivery address, which might be a pipe or a file. If
37968 intermediate address(es) exist between the original and the final address, the
37969 last of these is given in parentheses after the final address. The R and T
37970 fields record the router and transport that were used to process the address.
37971
37972 If SMTP AUTH was used for the delivery there is an additional item A=
37973 followed by the name of the authenticator that was used.
37974 If an authenticated identification was set up by the authenticator's &%client_set_id%&
37975 option, this is logged too, separated by a colon from the authenticator name.
37976
37977 If a shadow transport was run after a successful local delivery, the log line
37978 for the successful delivery has an item added on the end, of the form
37979 .display
37980 &`ST=<`&&'shadow transport name'&&`>`&
37981 .endd
37982 If the shadow transport did not succeed, the error message is put in
37983 parentheses afterwards.
37984
37985 .cindex "asterisk" "after IP address"
37986 When more than one address is included in a single delivery (for example, two
37987 SMTP RCPT commands in one transaction) the second and subsequent addresses are
37988 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
37989 down a single SMTP connection, an asterisk follows the IP address in the log
37990 lines for the second and subsequent messages.
37991 When two or more messages are delivered down a single TLS connection, the
37992 DNS and some TLS-related information logged for the first message delivered
37993 will not be present in the log lines for the second and subsequent messages.
37994 TLS cipher information is still available.
37995
37996 .cindex "delivery" "cutthrough; logging"
37997 .cindex "cutthrough" "logging"
37998 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
37999 line precedes the reception line, since cutthrough waits for a possible
38000 rejection from the destination in case it can reject the sourced item.
38001
38002 The generation of a reply message by a filter file gets logged as a
38003 &"delivery"& to the addressee, preceded by &">"&.
38004
38005 The &%log_selector%& option can be used to request the logging of additional
38006 data when a message is delivered. See section &<<SECTlogselector>>& below.
38007
38008
38009 .section "Discarded deliveries" "SECID253"
38010 .cindex "discarded messages"
38011 .cindex "message" "discarded"
38012 .cindex "delivery" "discarded; logging"
38013 When a message is discarded as a result of the command &"seen finish"& being
38014 obeyed in a filter file which generates no deliveries, a log entry of the form
38015 .code
38016 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
38017   <low.club@bridge.example> R=userforward
38018 .endd
38019 is written, to record why no deliveries are logged. When a message is discarded
38020 because it is aliased to &":blackhole:"& the log line is like this:
38021 .code
38022 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
38023   <hole@nowhere.example> R=blackhole_router
38024 .endd
38025
38026
38027 .section "Deferred deliveries" "SECID254"
38028 When a delivery is deferred, a line of the following form is logged:
38029 .code
38030 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
38031   R=dnslookup T=smtp defer (146): Connection refused
38032 .endd
38033 In the case of remote deliveries, the error is the one that was given for the
38034 last IP address that was tried. Details of individual SMTP failures are also
38035 written to the log, so the above line would be preceded by something like
38036 .code
38037 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
38038   mail1.endrest.example [192.168.239.239]: Connection refused
38039 .endd
38040 When a deferred address is skipped because its retry time has not been reached,
38041 a message is written to the log, but this can be suppressed by setting an
38042 appropriate value in &%log_selector%&.
38043
38044
38045
38046 .section "Delivery failures" "SECID255"
38047 .cindex "delivery" "failure; logging"
38048 If a delivery fails because an address cannot be routed, a line of the
38049 following form is logged:
38050 .code
38051 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
38052   <jim@trek99.example>: unknown mail domain
38053 .endd
38054 If a delivery fails at transport time, the router and transport are shown, and
38055 the response from the remote host is included, as in this example:
38056 .code
38057 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
38058   R=dnslookup T=remote_smtp: SMTP error from remote mailer
38059   after pipelined RCPT TO:<ace400@pb.example>: host
38060   pbmail3.py.example [192.168.63.111]: 553 5.3.0
38061   <ace400@pb.example>...Addressee unknown
38062 .endd
38063 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
38064 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
38065 disabling PIPELINING. The log lines for all forms of delivery failure are
38066 flagged with &`**`&.
38067
38068
38069
38070 .section "Fake deliveries" "SECID256"
38071 .cindex "delivery" "fake; logging"
38072 If a delivery does not actually take place because the &%-N%& option has been
38073 used to suppress it, a normal delivery line is written to the log, except that
38074 &"=>"& is replaced by &"*>"&.
38075
38076
38077
38078 .section "Completion" "SECID257"
38079 A line of the form
38080 .code
38081 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
38082 .endd
38083 is written to the main log when a message is about to be removed from the spool
38084 at the end of its processing.
38085
38086
38087
38088
38089 .section "Summary of Fields in Log Lines" "SECID258"
38090 .cindex "log" "summary of fields"
38091 A summary of the field identifiers that are used in log lines is shown in
38092 the following table:
38093 .display
38094 &`A   `&        authenticator name (and optional id and sender)
38095 &`C   `&        SMTP confirmation on delivery
38096 &`    `&        command list for &"no mail in SMTP session"&
38097 &`CV  `&        certificate verification status
38098 &`D   `&        duration of &"no mail in SMTP session"&
38099 &`DKIM`&        domain verified in incoming message
38100 &`DN  `&        distinguished name from peer certificate
38101 &`DS  `&        DNSSEC secured lookups
38102 &`DT  `&        on &`=>`&, &'=='& and &'**'& lines: time taken for, or to attempt, a delivery
38103 &`F   `&        sender address (on delivery lines)
38104 &`H   `&        host name and IP address
38105 &`I   `&        local interface used
38106 &`id  `&        message id (from header) for incoming message
38107 &`K   `&        CHUNKING extension used
38108 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
38109 &`M8S `&        8BITMIME status for incoming message
38110 &`P   `&        on &`<=`& lines: protocol used
38111 &`    `&        on &`=>`& and &`**`& lines: return path
38112 &`PRDR`&        PRDR extension used
38113 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
38114 &`Q   `&        alternate queue name
38115 &`QT  `&        on &`=>`& lines: time spent on queue so far
38116 &`    `&        on &"Completed"& lines: time spent on queue
38117 &`R   `&        on &`<=`& lines: reference for local bounce
38118 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
38119 &`RT  `&        on &`<=`& lines: time taken for reception
38120 &`S   `&        size of message in bytes
38121 &`SNI `&        server name indication from TLS client hello
38122 &`ST  `&        shadow transport name
38123 &`T   `&        on &`<=`& lines: message subject (topic)
38124 &`TFO `&        connection took advantage of TCP Fast Open
38125 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
38126 &`U   `&        local user or RFC 1413 identity
38127 &`X   `&        TLS cipher suite
38128 .endd
38129
38130
38131 .section "Other log entries" "SECID259"
38132 Various other types of log entry are written from time to time. Most should be
38133 self-explanatory. Among the more common are:
38134
38135 .ilist
38136 .cindex "retry" "time not reached"
38137 &'retry time not reached'&&~&~An address previously suffered a temporary error
38138 during routing or local delivery, and the time to retry has not yet arrived.
38139 This message is not written to an individual message log file unless it happens
38140 during the first delivery attempt.
38141 .next
38142 &'retry time not reached for any host'&&~&~An address previously suffered
38143 temporary errors during remote delivery, and the retry time has not yet arrived
38144 for any of the hosts to which it is routed.
38145 .next
38146 .cindex "spool directory" "file locked"
38147 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
38148 some other Exim process is already working on the message. This can be quite
38149 common if queue running processes are started at frequent intervals. The
38150 &'exiwhat'& utility script can be used to find out what Exim processes are
38151 doing.
38152 .next
38153 .cindex "error" "ignored"
38154 &'error ignored'&&~&~There are several circumstances that give rise to this
38155 message:
38156 .olist
38157 Exim failed to deliver a bounce message whose age was greater than
38158 &%ignore_bounce_errors_after%&. The bounce was discarded.
38159 .next
38160 A filter file set up a delivery using the &"noerror"& option, and the delivery
38161 failed. The delivery was discarded.
38162 .next
38163 A delivery set up by a router configured with
38164 . ==== As this is a nested list, any displays it contains must be indented
38165 . ==== as otherwise they are too far to the left.
38166 .code
38167     errors_to = <>
38168 .endd
38169 failed. The delivery was discarded.
38170 .endlist olist
38171 .next
38172 .cindex DKIM "log line"
38173 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
38174 logging and the message has a DKIM signature header.
38175 .endlist ilist
38176
38177
38178
38179
38180
38181 .section "Reducing or increasing what is logged" "SECTlogselector"
38182 .cindex "log" "selectors"
38183 By setting the &%log_selector%& global option, you can disable some of Exim's
38184 default logging, or you can request additional logging. The value of
38185 &%log_selector%& is made up of names preceded by plus or minus characters. For
38186 example:
38187 .code
38188 log_selector = +arguments -retry_defer
38189 .endd
38190 The list of optional log items is in the following table, with the default
38191 selection marked by asterisks:
38192 .display
38193 &` 8bitmime                   `&  received 8BITMIME status
38194 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
38195 &` address_rewrite            `&  address rewriting
38196 &` all_parents                `&  all parents in => lines
38197 &` arguments                  `&  command line arguments
38198 &`*connection_reject          `&  connection rejections
38199 &`*delay_delivery             `&  immediate delivery delayed
38200 &` deliver_time               `&  time taken to attempt delivery
38201 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
38202 &`*dkim                       `&  DKIM verified domain on <= lines
38203 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
38204 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
38205 &` dnssec                     `&  DNSSEC secured lookups
38206 &`*etrn                       `&  ETRN commands
38207 &`*host_lookup_failed         `&  as it says
38208 &` ident_timeout              `&  timeout for ident connection
38209 &` incoming_interface         `&  local interface on <= and => lines
38210 &` incoming_port              `&  remote port on <= lines
38211 &`*lost_incoming_connection   `&  as it says (includes timeouts)
38212 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
38213 &`*msg_id                     `&  on <= lines, Message-ID: header value
38214 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
38215 &` outgoing_interface         `&  local interface on => lines
38216 &` outgoing_port              `&  add remote port to => lines
38217 &`*queue_run                  `&  start and end queue runs
38218 &` queue_time                 `&  time on queue for one recipient
38219 &` queue_time_overall         `&  time on queue for whole message
38220 &` pid                        `&  Exim process id
38221 &` pipelining                 `&  PIPELINING use, on <= and => lines
38222 &` proxy                      `&  proxy address on <= and => lines
38223 &` receive_time               `&  time taken to receive message
38224 &` received_recipients        `&  recipients on <= lines
38225 &` received_sender            `&  sender on <= lines
38226 &`*rejected_header            `&  header contents on reject log
38227 &`*retry_defer                `&  &"retry time not reached"&
38228 &` return_path_on_delivery    `&  put return path on => and ** lines
38229 &` sender_on_delivery         `&  add sender to => lines
38230 &`*sender_verify_fail         `&  sender verification failures
38231 &`*size_reject                `&  rejection because too big
38232 &`*skip_delivery              `&  delivery skipped in a queue run
38233 &`*smtp_confirmation          `&  SMTP confirmation on => lines
38234 &` smtp_connection            `&  incoming SMTP connections
38235 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
38236 &` smtp_mailauth              `&  AUTH argument to MAIL commands
38237 &` smtp_no_mail               `&  session with no MAIL commands
38238 &` smtp_protocol_error        `&  SMTP protocol errors
38239 &` smtp_syntax_error          `&  SMTP syntax errors
38240 &` subject                    `&  contents of &'Subject:'& on <= lines
38241 &`*tls_certificate_verified   `&  certificate verification status
38242 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
38243 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
38244 &` tls_resumption             `&  append * to cipher field
38245 &` tls_sni                    `&  TLS SNI on <= lines
38246 &` unknown_in_list            `&  DNS lookup failed in list match
38247
38248 &` all                        `&  all of the above
38249 .endd
38250 See also the &%slow_lookup_log%& main configuration option,
38251 section &<<SECID99>>&
38252
38253 More details on each of these items follows:
38254
38255 .ilist
38256 .cindex "8BITMIME"
38257 .cindex "log" "8BITMIME"
38258 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
38259 which may help in tracking down interoperability issues with ancient MTAs
38260 that are not 8bit clean.  This is added to the &"<="& line, tagged with
38261 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
38262 &`7BIT`& and &`8BITMIME`& respectively.
38263 .next
38264 .cindex "&%warn%& ACL verb" "log when skipping"
38265 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
38266 its conditions cannot be evaluated, a log line to this effect is written if
38267 this log selector is set.
38268 .next
38269 .cindex "log" "rewriting"
38270 .cindex "rewriting" "logging"
38271 &%address_rewrite%&: This applies both to global rewrites and per-transport
38272 rewrites, but not to rewrites in filters run as an unprivileged user (because
38273 such users cannot access the log).
38274 .next
38275 .cindex "log" "full parentage"
38276 &%all_parents%&: Normally only the original and final addresses are logged on
38277 delivery lines; with this selector, intermediate parents are given in
38278 parentheses between them.
38279 .next
38280 .cindex "log" "Exim arguments"
38281 .cindex "Exim arguments, logging"
38282 &%arguments%&: This causes Exim to write the arguments with which it was called
38283 to the main log, preceded by the current working directory. This is a debugging
38284 feature, added to make it easier to find out how certain MUAs call
38285 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
38286 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
38287 that are empty or that contain white space are quoted. Non-printing characters
38288 are shown as escape sequences. This facility cannot log unrecognized arguments,
38289 because the arguments are checked before the configuration file is read. The
38290 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
38291 between the caller and Exim.
38292 .next
38293 .cindex "log" "connection rejections"
38294 &%connection_reject%&: A log entry is written whenever an incoming SMTP
38295 connection is rejected, for whatever reason.
38296 .next
38297 .cindex "log" "delayed delivery"
38298 .cindex "delayed delivery, logging"
38299 &%delay_delivery%&: A log entry is written whenever a delivery process is not
38300 started for an incoming message because the load is too high or too many
38301 messages were received on one connection. Logging does not occur if no delivery
38302 process is started because &%queue_only%& is set or &%-odq%& was used.
38303 .next
38304 .cindex "log" "delivery duration"
38305 &%deliver_time%&: For each delivery, the amount of real time it has taken to
38306 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
38307 If millisecond logging is enabled, short times will be shown with greater
38308 precision, eg. &`DT=0.304s`&.
38309 .next
38310 .cindex "log" "message size on delivery"
38311 .cindex "size" "of message"
38312 &%delivery_size%&: For each delivery, the size of message delivered is added to
38313 the &"=>"& line, tagged with S=.
38314 .next
38315 .cindex log "DKIM verification"
38316 .cindex DKIM "verification logging"
38317 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
38318 verifies successfully a tag of DKIM is added, with one of the verified domains.
38319 .next
38320 .cindex log "DKIM verification"
38321 .cindex DKIM "verification logging"
38322 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
38323 .next
38324 .cindex "log" "dnslist defer"
38325 .cindex "DNS list" "logging defer"
38326 .cindex "black list (DNS)"
38327 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
38328 DNS black list suffers a temporary error.
38329 .next
38330 .cindex log dnssec
38331 .cindex dnssec logging
38332 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
38333 dns lookups gave secure results a tag of DS is added.
38334 For acceptance this covers the reverse and forward lookups for host name verification.
38335 It does not cover helo-name verification.
38336 For delivery this covers the SRV, MX, A and/or AAAA lookups.
38337 .next
38338 .cindex "log" "ETRN commands"
38339 .cindex "ETRN" "logging"
38340 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
38341 is run to determine whether or not it is actually accepted. An invalid ETRN
38342 command, or one received within a message transaction is not logged by this
38343 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
38344 .next
38345 .cindex "log" "host lookup failure"
38346 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
38347 any addresses, or when a lookup of an IP address fails to find a host name, a
38348 log line is written. This logging does not apply to direct DNS lookups when
38349 routing email addresses, but it does apply to &"byname"& lookups.
38350 .next
38351 .cindex "log" "ident timeout"
38352 .cindex "RFC 1413" "logging timeout"
38353 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
38354 client's ident port times out.
38355 .next
38356 .cindex "log" "incoming interface"
38357 .cindex "log" "local interface"
38358 .cindex "log" "local address and port"
38359 .cindex "TCP/IP" "logging local address and port"
38360 .cindex "interface" "logging"
38361 &%incoming_interface%&: The interface on which a message was received is added
38362 to the &"<="& line as an IP address in square brackets, tagged by I= and
38363 followed by a colon and the port number. The local interface and port are also
38364 added to other SMTP log lines, for example, &"SMTP connection from"&, to
38365 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
38366 The latter can be disabled by turning off the &%outgoing_interface%& option.
38367 .next
38368 .cindex log "incoming proxy address"
38369 .cindex proxy "logging proxy address"
38370 .cindex "TCP/IP" "logging proxy address"
38371 &%proxy%&: The internal (closest to the system running Exim) IP address
38372 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
38373 on a proxied connection
38374 or the &"=>"& line for a message delivered on a proxied connection.
38375 See &<<SECTproxyInbound>>& for more information.
38376 .next
38377 .cindex "log" "incoming remote port"
38378 .cindex "port" "logging remote"
38379 .cindex "TCP/IP" "logging incoming remote port"
38380 .vindex "&$sender_fullhost$&"
38381 .vindex "&$sender_rcvhost$&"
38382 &%incoming_port%&: The remote port number from which a message was received is
38383 added to log entries and &'Received:'& header lines, following the IP address
38384 in square brackets, and separated from it by a colon. This is implemented by
38385 changing the value that is put in the &$sender_fullhost$& and
38386 &$sender_rcvhost$& variables. Recording the remote port number has become more
38387 important with the widening use of NAT (see RFC 2505).
38388 .next
38389 .cindex "log" "dropped connection"
38390 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
38391 connection is unexpectedly dropped.
38392 .next
38393 .cindex "log" "millisecond timestamps"
38394 .cindex millisecond logging
38395 .cindex timestamps "millisecond, in logs"
38396 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
38397 appended to the seconds value.
38398 .next
38399 .cindex "log" "message id"
38400 &%msg_id%&: The value of the Message-ID: header.
38401 .next
38402 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
38403 This will be either because the message is a bounce, or was submitted locally
38404 (submission mode) without one.
38405 The field identifier will have an asterix appended: &"id*="&.
38406 .next
38407 .cindex "log" "outgoing interface"
38408 .cindex "log" "local interface"
38409 .cindex "log" "local address and port"
38410 .cindex "TCP/IP" "logging local address and port"
38411 .cindex "interface" "logging"
38412 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
38413 interface on which a message was sent is added to delivery lines as an I= tag
38414 followed by IP address in square brackets. You can disable this by turning
38415 off the &%outgoing_interface%& option.
38416 .next
38417 .cindex "log" "outgoing remote port"
38418 .cindex "port" "logging outgoing remote"
38419 .cindex "TCP/IP" "logging outgoing remote port"
38420 &%outgoing_port%&: The remote port number is added to delivery log lines (those
38421 containing => tags) following the IP address.
38422 The local port is also added if &%incoming_interface%& and
38423 &%outgoing_interface%& are both enabled.
38424 This option is not included in the default setting, because for most ordinary
38425 configurations, the remote port number is always 25 (the SMTP port), and the
38426 local port is a random ephemeral port.
38427 .next
38428 .cindex "log" "process ids in"
38429 .cindex "pid (process id)" "in log lines"
38430 &%pid%&: The current process id is added to every log line, in square brackets,
38431 immediately after the time and date.
38432 .next
38433 .cindex log pipelining
38434 .cindex pipelining "logging outgoing"
38435 &%pipelining%&: A field is added to delivery and accept
38436 log lines when the ESMTP PIPELINING extension was used.
38437 The field is a single "L".
38438
38439 On accept lines, where PIPELINING was offered but not used by the client,
38440 the field has a minus appended.
38441
38442 .cindex "pipelining" "early connection"
38443 If Exim is built with the SUPPORT_PIPE_CONNECT build option
38444 accept "L" fields have a period appended if the feature was
38445 offered but not used, or an asterisk appended if used.
38446 Delivery "L" fields have an asterisk appended if used.
38447
38448 .next
38449 .cindex "log" "queue run"
38450 .cindex "queue runner" "logging"
38451 &%queue_run%&: The start and end of every queue run are logged.
38452 .next
38453 .cindex "log" "queue time"
38454 &%queue_time%&: The amount of time the message has been in the queue on the
38455 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
38456 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
38457 includes reception time as well as the delivery time for the current address.
38458 This means that it may be longer than the difference between the arrival and
38459 delivery log line times, because the arrival log line is not written until the
38460 message has been successfully received.
38461 If millisecond logging is enabled, short times will be shown with greater
38462 precision, eg. &`QT=1.578s`&.
38463 .next
38464 &%queue_time_overall%&: The amount of time the message has been in the queue on
38465 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
38466 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
38467 message, so it includes reception time as well as the total delivery time.
38468 .next
38469 .cindex "log" "receive duration"
38470 &%receive_time%&: For each message, the amount of real time it has taken to
38471 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
38472 If millisecond logging is enabled, short times will be shown with greater
38473 precision, eg. &`RT=0.204s`&.
38474 .next
38475 .cindex "log" "recipients"
38476 &%received_recipients%&: The recipients of a message are listed in the main log
38477 as soon as the message is received. The list appears at the end of the log line
38478 that is written when a message is received, preceded by the word &"for"&. The
38479 addresses are listed after they have been qualified, but before any rewriting
38480 has taken place.
38481 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
38482 in the list.
38483 .next
38484 .cindex "log" "sender reception"
38485 &%received_sender%&: The unrewritten original sender of a message is added to
38486 the end of the log line that records the message's arrival, after the word
38487 &"from"& (before the recipients if &%received_recipients%& is also set).
38488 .next
38489 .cindex "log" "header lines for rejection"
38490 &%rejected_header%&: If a message's header has been received at the time a
38491 rejection is written to the reject log, the complete header is added to the
38492 log. Header logging can be turned off individually for messages that are
38493 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
38494 .next
38495 .cindex "log" "retry defer"
38496 &%retry_defer%&: A log line is written if a delivery is deferred because a
38497 retry time has not yet been reached. However, this &"retry time not reached"&
38498 message is always omitted from individual message logs after the first delivery
38499 attempt.
38500 .next
38501 .cindex "log" "return path"
38502 &%return_path_on_delivery%&: The return path that is being transmitted with
38503 the message is included in delivery and bounce lines, using the tag P=.
38504 This is omitted if no delivery actually happens, for example, if routing fails,
38505 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
38506 .next
38507 .cindex "log" "sender on delivery"
38508 &%sender_on_delivery%&: The message's sender address is added to every delivery
38509 and bounce line, tagged by F= (for &"from"&).
38510 This is the original sender that was received with the message; it is not
38511 necessarily the same as the outgoing return path.
38512 .next
38513 .cindex "log" "sender verify failure"
38514 &%sender_verify_fail%&: If this selector is unset, the separate log line that
38515 gives details of a sender verification failure is not written. Log lines for
38516 the rejection of SMTP commands contain just &"sender verify failed"&, so some
38517 detail is lost.
38518 .next
38519 .cindex "log" "size rejection"
38520 &%size_reject%&: A log line is written whenever a message is rejected because
38521 it is too big.
38522 .next
38523 .cindex "log" "frozen messages; skipped"
38524 .cindex "frozen messages" "logging skipping"
38525 &%skip_delivery%&: A log line is written whenever a message is skipped during a
38526 queue run because it is frozen or because another process is already delivering
38527 it.
38528 .cindex "&""spool file is locked""&"
38529 The message that is written is &"spool file is locked"&.
38530 .next
38531 .cindex "log" "smtp confirmation"
38532 .cindex "SMTP" "logging confirmation"
38533 .cindex "LMTP" "logging confirmation"
38534 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
38535 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
38536 A number of MTAs (including Exim) return an identifying string in this
38537 response.
38538 .next
38539 .cindex "log" "SMTP connections"
38540 .cindex "SMTP" "logging connections"
38541 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
38542 established or closed, unless the connection is from a host that matches
38543 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
38544 only when the closure is unexpected.) This applies to connections from local
38545 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
38546 dropped in the middle of a message, a log line is always written, whether or
38547 not this selector is set, but otherwise nothing is written at the start and end
38548 of connections unless this selector is enabled.
38549
38550 For TCP/IP connections to an Exim daemon, the current number of connections is
38551 included in the log message for each new connection, but note that the count is
38552 reset if the daemon is restarted.
38553 Also, because connections are closed (and the closure is logged) in
38554 subprocesses, the count may not include connections that have been closed but
38555 whose termination the daemon has not yet noticed. Thus, while it is possible to
38556 match up the opening and closing of connections in the log, the value of the
38557 logged counts may not be entirely accurate.
38558 .next
38559 .cindex "log" "SMTP transaction; incomplete"
38560 .cindex "SMTP" "logging incomplete transactions"
38561 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
38562 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
38563 and the message sender plus any accepted recipients are included in the log
38564 line. This can provide evidence of dictionary attacks.
38565 .next
38566 .cindex "log" "non-MAIL SMTP sessions"
38567 .cindex "MAIL" "logging session without"
38568 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
38569 connection terminates without having issued a MAIL command. This includes both
38570 the case when the connection is dropped, and the case when QUIT is used. It
38571 does not include cases where the connection is rejected right at the start (by
38572 an ACL, or because there are too many connections, or whatever). These cases
38573 already have their own log lines.
38574
38575 The log line that is written contains the identity of the client in the usual
38576 way, followed by D= and a time, which records the duration of the connection.
38577 If the connection was authenticated, this fact is logged exactly as it is for
38578 an incoming message, with an A= item. If the connection was encrypted, CV=,
38579 DN=, and X= items may appear as they do for an incoming message, controlled by
38580 the same logging options.
38581
38582 Finally, if any SMTP commands were issued during the connection, a C= item
38583 is added to the line, listing the commands that were used. For example,
38584 .code
38585 C=EHLO,QUIT
38586 .endd
38587 shows that the client issued QUIT straight after EHLO. If there were fewer
38588 than 20 commands, they are all listed. If there were more than 20 commands,
38589 the last 20 are listed, preceded by &"..."&. However, with the default
38590 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
38591 have been aborted before 20 non-mail commands are processed.
38592 .next
38593 &%smtp_mailauth%&: A third subfield with the authenticated sender,
38594 colon-separated, is appended to the A= item for a message arrival or delivery
38595 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
38596 was accepted or used.
38597 .next
38598 .cindex "log" "SMTP protocol error"
38599 .cindex "SMTP" "logging protocol error"
38600 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
38601 encountered. Exim does not have perfect detection of all protocol errors
38602 because of transmission delays and the use of pipelining. If PIPELINING has
38603 been advertised to a client, an Exim server assumes that the client will use
38604 it, and therefore it does not count &"expected"& errors (for example, RCPT
38605 received after rejecting MAIL) as protocol errors.
38606 .next
38607 .cindex "SMTP" "logging syntax errors"
38608 .cindex "SMTP" "syntax errors; logging"
38609 .cindex "SMTP" "unknown command; logging"
38610 .cindex "log" "unknown SMTP command"
38611 .cindex "log" "SMTP syntax error"
38612 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
38613 encountered. An unrecognized command is treated as a syntax error. For an
38614 external connection, the host identity is given; for an internal connection
38615 using &%-bs%& the sender identification (normally the calling user) is given.
38616 .next
38617 .cindex "log" "subject"
38618 .cindex "subject, logging"
38619 &%subject%&: The subject of the message is added to the arrival log line,
38620 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
38621 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
38622 specifies whether characters with values greater than 127 should be logged
38623 unchanged, or whether they should be rendered as escape sequences.
38624 .next
38625 .cindex "log" "certificate verification"
38626 .cindex log DANE
38627 .cindex DANE logging
38628 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
38629 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
38630 verified
38631 using a CA trust anchor,
38632 &`CA=dane`& if using a DNS trust anchor,
38633 and &`CV=no`& if not.
38634 .next
38635 .cindex "log" "TLS cipher"
38636 .cindex "TLS" "logging cipher"
38637 &%tls_cipher%&: When a message is sent or received over an encrypted
38638 connection, the cipher suite used is added to the log line, preceded by X=.
38639 .next
38640 .cindex "log" "TLS peer DN"
38641 .cindex "TLS" "logging peer DN"
38642 &%tls_peerdn%&: When a message is sent or received over an encrypted
38643 connection, and a certificate is supplied by the remote host, the peer DN is
38644 added to the log line, preceded by DN=.
38645 .next
38646 .cindex "log" "TLS resumption"
38647 .cindex "TLS" "logging session resumption"
38648 .new
38649 &%tls_resumption%&: When a message is sent or received over an encrypted
38650 connection and the TLS session resumed one used on a previous TCP connection,
38651 an asterisk is appended to the X= cipher field in the log line.
38652 .wen
38653 .next
38654 .cindex "log" "TLS SNI"
38655 .cindex "TLS" "logging SNI"
38656 &%tls_sni%&: When a message is received over an encrypted connection, and
38657 the remote host provided the Server Name Indication extension, the SNI is
38658 added to the log line, preceded by SNI=.
38659 .next
38660 .cindex "log" "DNS failure in list"
38661 &%unknown_in_list%&: This setting causes a log entry to be written when the
38662 result of a list match is failure because a DNS lookup failed.
38663 .endlist
38664
38665
38666 .section "Message log" "SECID260"
38667 .cindex "message" "log file for"
38668 .cindex "log" "message log; description of"
38669 .cindex "&_msglog_& directory"
38670 .oindex "&%preserve_message_logs%&"
38671 In addition to the general log files, Exim writes a log file for each message
38672 that it handles. The names of these per-message logs are the message ids, and
38673 they are kept in the &_msglog_& sub-directory of the spool directory. Each
38674 message log contains copies of the log lines that apply to the message. This
38675 makes it easier to inspect the status of an individual message without having
38676 to search the main log. A message log is deleted when processing of the message
38677 is complete, unless &%preserve_message_logs%& is set, but this should be used
38678 only with great care because they can fill up your disk very quickly.
38679
38680 On a heavily loaded system, it may be desirable to disable the use of
38681 per-message logs, in order to reduce disk I/O. This can be done by setting the
38682 &%message_logs%& option false.
38683 .ecindex IIDloggen
38684
38685
38686
38687
38688 . ////////////////////////////////////////////////////////////////////////////
38689 . ////////////////////////////////////////////////////////////////////////////
38690
38691 .chapter "Exim utilities" "CHAPutils"
38692 .scindex IIDutils "utilities"
38693 A number of utility scripts and programs are supplied with Exim and are
38694 described in this chapter. There is also the Exim Monitor, which is covered in
38695 the next chapter. The utilities described here are:
38696
38697 .itable none 0 0 3  7* left  15* left  40* left
38698 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
38699   "list what Exim processes are doing"
38700 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
38701 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
38702 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
38703 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
38704                                                 various criteria"
38705 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
38706 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
38707   "extract statistics from the log"
38708 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
38709   "check address acceptance from given IP"
38710 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
38711 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
38712 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
38713 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
38714 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
38715 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
38716 .endtable
38717
38718 Another utility that might be of use to sites with many MTAs is Tom Kistner's
38719 &'exilog'&. It provides log visualizations across multiple Exim servers. See
38720 &url(https://duncanthrax.net/exilog/) for details.
38721
38722
38723
38724
38725 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
38726 .cindex "&'exiwhat'&"
38727 .cindex "process, querying"
38728 .cindex "SIGUSR1"
38729 On operating systems that can restart a system call after receiving a signal
38730 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
38731 a line describing what it is doing to the file &_exim-process.info_& in the
38732 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
38733 processes it can find, having first emptied the file. It then waits for one
38734 second to allow the Exim processes to react before displaying the results. In
38735 order to run &'exiwhat'& successfully you have to have sufficient privilege to
38736 send the signal to the Exim processes, so it is normally run as root.
38737
38738 &*Warning*&: This is not an efficient process. It is intended for occasional
38739 use by system administrators. It is not sensible, for example, to set up a
38740 script that sends SIGUSR1 signals to Exim processes at short intervals.
38741
38742
38743 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
38744 varies in different operating systems. Not only are different options used,
38745 but the format of the output is different. For this reason, there are some
38746 system configuration options that configure exactly how &'exiwhat'& works. If
38747 it doesn't seem to be working for you, check the following compile-time
38748 options:
38749 .display
38750 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
38751 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
38752 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
38753 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
38754 .endd
38755 An example of typical output from &'exiwhat'& is
38756 .code
38757 164 daemon: -q1h, listening on port 25
38758 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
38759 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
38760   [10.19.42.42] (editor@ref.example)
38761 10592 handling incoming call from [192.168.243.242]
38762 10628 accepting a local non-SMTP message
38763 .endd
38764 The first number in the output line is the process number. The third line has
38765 been split here, in order to fit it on the page.
38766
38767
38768
38769 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
38770 .cindex "&'exiqgrep'&"
38771 .cindex "queue" "grepping"
38772 This utility is a Perl script contributed by Matt Hubbard. It runs
38773 .code
38774 exim -bpu
38775 .endd
38776 or (in case &*-a*& switch is specified)
38777 .code
38778 exim -bp
38779 .endd
38780 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
38781 contain alternate exim configuration the queue management might be using.
38782
38783 to obtain a queue listing, and then greps the output to select messages
38784 that match given criteria. The following selection options are available:
38785
38786 .vlist
38787 .vitem &*-f*&&~<&'regex'&>
38788 Match the sender address using a case-insensitive search. The field that is
38789 tested is enclosed in angle brackets, so you can test for bounce messages with
38790 .code
38791 exiqgrep -f '^<>$'
38792 .endd
38793 .vitem &*-r*&&~<&'regex'&>
38794 Match a recipient address using a case-insensitive search. The field that is
38795 tested is not enclosed in angle brackets.
38796
38797 .vitem &*-s*&&~<&'regex'&>
38798 Match against the size field.
38799
38800 .vitem &*-y*&&~<&'seconds'&>
38801 Match messages that are younger than the given time.
38802
38803 .vitem &*-o*&&~<&'seconds'&>
38804 Match messages that are older than the given time.
38805
38806 .vitem &*-z*&
38807 Match only frozen messages.
38808
38809 .vitem &*-x*&
38810 Match only non-frozen messages.
38811
38812 .vitem &*-G*&&~<&'queuename'&>
38813 Match only messages in the given queue.  Without this, the default queue is searched.
38814 .endlist
38815
38816 The following options control the format of the output:
38817
38818 .vlist
38819 .vitem &*-c*&
38820 Display only the count of matching messages.
38821
38822 .vitem &*-l*&
38823 Long format &-- display the full message information as output by Exim. This is
38824 the default.
38825
38826 .vitem &*-i*&
38827 Display message ids only.
38828
38829 .vitem &*-b*&
38830 Brief format &-- one line per message.
38831
38832 .vitem &*-R*&
38833 Display messages in reverse order.
38834
38835 .vitem &*-a*&
38836 Include delivered recipients in queue listing.
38837 .endlist
38838
38839 There is one more option, &%-h%&, which outputs a list of options.
38840
38841
38842
38843 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
38844 .cindex "&'exiqsumm'&"
38845 .cindex "queue" "summary"
38846 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
38847 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
38848 running a command such as
38849 .code
38850 exim -bp | exiqsumm
38851 .endd
38852 The output consists of one line for each domain that has messages waiting for
38853 it, as in the following example:
38854 .code
38855 3   2322   74m   66m  msn.com.example
38856 .endd
38857 Each line lists the number of pending deliveries for a domain, their total
38858 volume, and the length of time that the oldest and the newest messages have
38859 been waiting. Note that the number of pending deliveries is greater than the
38860 number of messages when messages have more than one recipient.
38861
38862 A summary line is output at the end. By default the output is sorted on the
38863 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
38864 the output to be sorted by oldest message and by count of messages,
38865 respectively. There are also three options that split the messages for each
38866 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
38867 separates frozen messages, and &%-s%& separates messages according to their
38868 sender.
38869
38870 The output of &'exim -bp'& contains the original addresses in the message, so
38871 this also applies to the output from &'exiqsumm'&. No domains from addresses
38872 generated by aliasing or forwarding are included (unless the &%one_time%&
38873 option of the &(redirect)& router has been used to convert them into &"top
38874 level"& addresses).
38875
38876
38877
38878
38879 .section "Extracting specific information from the log (exigrep)" &&&
38880          "SECTextspeinf"
38881 .cindex "&'exigrep'&"
38882 .cindex "log" "extracts; grepping for"
38883 The &'exigrep'& utility is a Perl script that searches one or more main log
38884 files for entries that match a given pattern. When it finds a match, it
38885 extracts all the log entries for the relevant message, not just those that
38886 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
38887 given message, or all mail for a given user, or for a given host, for example.
38888 The input files can be in Exim log format or syslog format.
38889 If a matching log line is not associated with a specific message, it is
38890 included in &'exigrep'&'s output without any additional lines. The usage is:
38891 .display
38892 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
38893 .endd
38894 If no log filenames are given on the command line, the standard input is read.
38895
38896 The &%-t%& argument specifies a number of seconds. It adds an additional
38897 condition for message selection. Messages that are complete are shown only if
38898 they spent more than <&'n'&> seconds in the queue.
38899
38900 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
38901 makes it case-sensitive. This may give a performance improvement when searching
38902 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
38903 option; with &%-I%& they do not. In both cases it is possible to change the
38904 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
38905
38906 The &%-l%& option means &"literal"&, that is, treat all characters in the
38907 pattern as standing for themselves. Otherwise the pattern must be a Perl
38908 regular expression.
38909
38910 The &%-v%& option inverts the matching condition. That is, a line is selected
38911 if it does &'not'& match the pattern.
38912
38913 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
38914 that are generated as a result/response to a message that &'exigrep'& matched
38915 normally.
38916
38917 Example of &%-M%&:
38918 user_a sends a message to user_b, which generates a bounce back to user_b. If
38919 &'exigrep'& is used to search for &"user_a"&, only the first message will be
38920 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
38921 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
38922 when searching for &"user_a"& will show both messages since the bounce is
38923 &"related"& to or a &"result"& of the first message that was found by the
38924 search term.
38925
38926 If the location of a &'zcat'& command is known from the definition of
38927 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
38928 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
38929 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
38930 autodetection of some well known compression extensions.
38931
38932
38933 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
38934 .cindex "&'exipick'&"
38935 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
38936 lists messages from the queue according to a variety of criteria. For details
38937 of &'exipick'&'s facilities, run &'exipick'& with
38938 the &%--help%& option.
38939
38940
38941 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
38942 .cindex "log" "cycling local files"
38943 .cindex "cycling logs"
38944 .cindex "&'exicyclog'&"
38945 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
38946 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
38947 you are using log files with datestamps in their names (see section
38948 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
38949 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
38950 There are two command line options for &'exicyclog'&:
38951 .ilist
38952 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
38953 default that is set when Exim is built. The default default is 10.
38954 .next
38955 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
38956 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
38957 overriding the script's default, which is to find the setting from Exim's
38958 configuration.
38959 .endlist
38960
38961 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
38962 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
38963 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
38964 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
38965 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
38966 logs are handled similarly.
38967
38968 If the limit is greater than 99, the script uses 3-digit numbers such as
38969 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
38970 to one that is greater, or &'vice versa'&, you will have to fix the names of
38971 any existing log files.
38972
38973 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
38974 the end are deleted. All files with numbers greater than 01 are compressed,
38975 using a compression command which is configured by the COMPRESS_COMMAND
38976 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
38977 root &%crontab%& entry of the form
38978 .code
38979 1 0 * * * su exim -c /usr/exim/bin/exicyclog
38980 .endd
38981 assuming you have used the name &"exim"& for the Exim user. You can run
38982 &'exicyclog'& as root if you wish, but there is no need.
38983
38984
38985
38986 .section "Mail statistics (eximstats)" "SECTmailstat"
38987 .cindex "statistics"
38988 .cindex "&'eximstats'&"
38989 A Perl script called &'eximstats'& is provided for extracting statistical
38990 information from log files. The output is either plain text, or HTML.
38991 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
38992 . --- 404 error and everything else points to that.
38993
38994 The &'eximstats'& script has been hacked about quite a bit over time. The
38995 latest version is the result of some extensive revision by Steve Campbell. A
38996 lot of information is given by default, but there are options for suppressing
38997 various parts of it. Following any options, the arguments to the script are a
38998 list of files, which should be main log files. For example:
38999 .code
39000 eximstats -nr /var/spool/exim/log/mainlog.01
39001 .endd
39002 By default, &'eximstats'& extracts information about the number and volume of
39003 messages received from or delivered to various hosts. The information is sorted
39004 both by message count and by volume, and the top fifty hosts in each category
39005 are listed on the standard output. Similar information, based on email
39006 addresses or domains instead of hosts can be requested by means of various
39007 options. For messages delivered and received locally, similar statistics are
39008 also produced per user.
39009
39010 The output also includes total counts and statistics about delivery errors, and
39011 histograms showing the number of messages received and deliveries made in each
39012 hour of the day. A delivery with more than one address in its envelope (for
39013 example, an SMTP transaction with more than one RCPT command) is counted
39014 as a single delivery by &'eximstats'&.
39015
39016 Though normally more deliveries than receipts are reported (as messages may
39017 have multiple recipients), it is possible for &'eximstats'& to report more
39018 messages received than delivered, even though the queue is empty at the start
39019 and end of the period in question. If an incoming message contains no valid
39020 recipients, no deliveries are recorded for it. A bounce message is handled as
39021 an entirely separate message.
39022
39023 &'eximstats'& always outputs a grand total summary giving the volume and number
39024 of messages received and deliveries made, and the number of hosts involved in
39025 each case. It also outputs the number of messages that were delayed (that is,
39026 not completely delivered at the first attempt), and the number that had at
39027 least one address that failed.
39028
39029 The remainder of the output is in sections that can be independently disabled
39030 or modified by various options. It consists of a summary of deliveries by
39031 transport, histograms of messages received and delivered per time interval
39032 (default per hour), information about the time messages spent in the queue,
39033 a list of relayed messages, lists of the top fifty sending hosts, local
39034 senders, destination hosts, and destination local users by count and by volume,
39035 and a list of delivery errors that occurred.
39036
39037 The relay information lists messages that were actually relayed, that is, they
39038 came from a remote host and were directly delivered to some other remote host,
39039 without being processed (for example, for aliasing or forwarding) locally.
39040
39041 There are quite a few options for &'eximstats'& to control exactly what it
39042 outputs. These are documented in the Perl script itself, and can be extracted
39043 by running the command &(perldoc)& on the script. For example:
39044 .code
39045 perldoc /usr/exim/bin/eximstats
39046 .endd
39047
39048 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
39049 .cindex "&'exim_checkaccess'&"
39050 .cindex "policy control" "checking access"
39051 .cindex "checking access"
39052 The &%-bh%& command line argument allows you to run a fake SMTP session with
39053 debugging output, in order to check what Exim is doing when it is applying
39054 policy controls to incoming SMTP mail. However, not everybody is sufficiently
39055 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
39056 sometimes you just want to answer the question &"Does this address have
39057 access?"& without bothering with any further details.
39058
39059 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
39060 two arguments, an IP address and an email address:
39061 .code
39062 exim_checkaccess 10.9.8.7 A.User@a.domain.example
39063 .endd
39064 The utility runs a call to Exim with the &%-bh%& option, to test whether the
39065 given email address would be accepted in a RCPT command in a TCP/IP
39066 connection from the host with the given IP address. The output of the utility
39067 is either the word &"accepted"&, or the SMTP error response, for example:
39068 .code
39069 Rejected:
39070 550 Relay not permitted
39071 .endd
39072 When running this test, the utility uses &`<>`& as the envelope sender address
39073 for the MAIL command, but you can change this by providing additional
39074 options. These are passed directly to the Exim command. For example, to specify
39075 that the test is to be run with the sender address &'himself@there.example'&
39076 you can use:
39077 .code
39078 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
39079                  -f himself@there.example
39080 .endd
39081 Note that these additional Exim command line items must be given after the two
39082 mandatory arguments.
39083
39084 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
39085 while running its checks. You can run checks that include callouts by using
39086 &%-bhc%&, but this is not yet available in a &"packaged"& form.
39087
39088
39089
39090 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
39091 .cindex "DBM" "building dbm files"
39092 .cindex "building DBM files"
39093 .cindex "&'exim_dbmbuild'&"
39094 .cindex "lower casing"
39095 .cindex "binary zero" "in lookup key"
39096 The &'exim_dbmbuild'& program reads an input file containing keys and data in
39097 the format used by the &(lsearch)& lookup (see section
39098 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
39099 names as keys and the remainder of the information as data. The lower-casing
39100 can be prevented by calling the program with the &%-nolc%& option.
39101
39102 A terminating zero is included as part of the key string. This is expected by
39103 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
39104 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
39105 strings or the data strings. The &(dbmnz)& lookup type can be used with such
39106 files.
39107
39108 The program requires two arguments: the name of the input file (which can be a
39109 single hyphen to indicate the standard input), and the name of the output file.
39110 It creates the output under a temporary name, and then renames it if all went
39111 well.
39112
39113 .cindex "USE_DB"
39114 If the native DB interface is in use (USE_DB is set in a compile-time
39115 configuration file &-- this is common in free versions of Unix) the two
39116 filenames must be different, because in this mode the Berkeley DB functions
39117 create a single output file using exactly the name given. For example,
39118 .code
39119 exim_dbmbuild /etc/aliases /etc/aliases.db
39120 .endd
39121 reads the system alias file and creates a DBM version of it in
39122 &_/etc/aliases.db_&.
39123
39124 In systems that use the &'ndbm'& routines (mostly proprietary versions of
39125 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
39126 environment, the suffixes are added to the second argument of
39127 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
39128 when the Berkeley functions are used in compatibility mode (though this is not
39129 recommended), because in that case it adds a &_.db_& suffix to the filename.
39130
39131 If a duplicate key is encountered, the program outputs a warning, and when it
39132 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
39133 option is used. By default, only the first of a set of duplicates is used &--
39134 this makes it compatible with &(lsearch)& lookups. There is an option
39135 &%-lastdup%& which causes it to use the data for the last duplicate instead.
39136 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
39137 &%stderr%&. For other errors, where it doesn't actually make a new file, the
39138 return code is 2.
39139
39140
39141
39142
39143 .section "Finding individual retry times (exinext)" "SECTfinindret"
39144 .cindex "retry" "times"
39145 .cindex "&'exinext'&"
39146 A utility called &'exinext'& (mostly a Perl script) provides the ability to
39147 fish specific information out of the retry database. Given a mail domain (or a
39148 complete address), it looks up the hosts for that domain, and outputs any retry
39149 information for the hosts or for the domain. At present, the retry information
39150 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
39151 output. For example:
39152 .code
39153 $ exinext piglet@milne.fict.example
39154 kanga.milne.example:192.168.8.1 error 146: Connection refused
39155   first failed: 21-Feb-1996 14:57:34
39156   last tried:   21-Feb-1996 14:57:34
39157   next try at:  21-Feb-1996 15:02:34
39158 roo.milne.example:192.168.8.3 error 146: Connection refused
39159   first failed: 20-Jan-1996 13:12:08
39160   last tried:   21-Feb-1996 11:42:03
39161   next try at:  21-Feb-1996 19:42:03
39162   past final cutoff time
39163 .endd
39164 You can also give &'exinext'& a local part, without a domain, and it
39165 will give any retry information for that local part in your default domain.
39166 A message id can be used to obtain retry information pertaining to a specific
39167 message. This exists only when an attempt to deliver a message to a remote host
39168 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
39169 &'exinext'& is not particularly efficient, but then it is not expected to be
39170 run very often.
39171
39172 The &'exinext'& utility calls Exim to find out information such as the location
39173 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
39174 passed on to the &'exim'& commands. The first specifies an alternate Exim
39175 configuration file, and the second sets macros for use within the configuration
39176 file. These features are mainly to help in testing, but might also be useful in
39177 environments where more than one configuration file is in use.
39178
39179
39180
39181 .section "Hints database maintenance" "SECThindatmai"
39182 .cindex "hints database" "maintenance"
39183 .cindex "maintaining Exim's hints database"
39184 Three utility programs are provided for maintaining the DBM files that Exim
39185 uses to contain its delivery hint information. Each program requires two
39186 arguments. The first specifies the name of Exim's spool directory, and the
39187 second is the name of the database it is to operate on. These are as follows:
39188
39189 .ilist
39190 &'retry'&: the database of retry information
39191 .next
39192 &'wait-'&<&'transport name'&>: databases of information about messages waiting
39193 for remote hosts
39194 .next
39195 &'callout'&: the callout cache
39196 .next
39197 &'ratelimit'&: the data for implementing the ratelimit ACL condition
39198 .next
39199 .new
39200 &'tls'&: TLS session resumption data
39201 .wen
39202 .next
39203 &'misc'&: other hints data
39204 .endlist
39205
39206 The &'misc'& database is used for
39207
39208 .ilist
39209 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
39210 .next
39211 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
39212 &(smtp)& transport)
39213 .next
39214 Limiting the concurrency of specific transports (when &%max_parallel%& is set
39215 in a transport)
39216 .endlist
39217
39218
39219
39220 .section "exim_dumpdb" "SECID261"
39221 .cindex "&'exim_dumpdb'&"
39222 The entire contents of a database are written to the standard output by the
39223 &'exim_dumpdb'& program, which has no options or arguments other than the
39224 spool and database names. For example, to dump the retry database:
39225 .code
39226 exim_dumpdb /var/spool/exim retry
39227 .endd
39228 Two lines of output are produced for each entry:
39229 .code
39230 T:mail.ref.example:192.168.242.242 146 77 Connection refused
39231 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
39232 .endd
39233 The first item on the first line is the key of the record. It starts with one
39234 of the letters R, or T, depending on whether it refers to a routing or
39235 transport retry. For a local delivery, the next part is the local address; for
39236 a remote delivery it is the name of the remote host, followed by its failing IP
39237 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
39238 transport). If the remote port is not the standard one (port 25), it is added
39239 to the IP address. Then there follows an error code, an additional error code,
39240 and a textual description of the error.
39241
39242 The three times on the second line are the time of first failure, the time of
39243 the last delivery attempt, and the computed time for the next attempt. The line
39244 ends with an asterisk if the cutoff time for the last retry rule has been
39245 exceeded.
39246
39247 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
39248 consists of a host name followed by a list of ids for messages that are or were
39249 waiting to be delivered to that host. If there are a very large number for any
39250 one host, continuation records, with a sequence number added to the host name,
39251 may be seen. The data in these records is often out of date, because a message
39252 may be routed to several alternative hosts, and Exim makes no effort to keep
39253 cross-references.
39254
39255
39256
39257 .section "exim_tidydb" "SECID262"
39258 .cindex "&'exim_tidydb'&"
39259 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
39260 database. If run with no options, it removes all records that are more than 30
39261 days old. The age is calculated from the date and time that the record was last
39262 updated. Note that, in the case of the retry database, it is &'not'& the time
39263 since the first delivery failure. Information about a host that has been down
39264 for more than 30 days will remain in the database, provided that the record is
39265 updated sufficiently often.
39266
39267 The cutoff date can be altered by means of the &%-t%& option, which must be
39268 followed by a time. For example, to remove all records older than a week from
39269 the retry database:
39270 .code
39271 exim_tidydb -t 7d /var/spool/exim retry
39272 .endd
39273 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
39274 message ids. In the former these appear as data in records keyed by host &--
39275 they were messages that were waiting for that host &-- and in the latter they
39276 are the keys for retry information for messages that have suffered certain
39277 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
39278 message ids in database records are those of messages that are still on the
39279 queue. Message ids for messages that no longer exist are removed from
39280 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
39281 For the &'retry'& database, records whose keys are non-existent message ids are
39282 removed. The &'exim_tidydb'& utility outputs comments on the standard output
39283 whenever it removes information from the database.
39284
39285 Certain records are automatically removed by Exim when they are no longer
39286 needed, but others are not. For example, if all the MX hosts for a domain are
39287 down, a retry record is created for each one. If the primary MX host comes back
39288 first, its record is removed when Exim successfully delivers to it, but the
39289 records for the others remain because Exim has not tried to use those hosts.
39290
39291 It is important, therefore, to run &'exim_tidydb'& periodically on all the
39292 hints databases. You should do this at a quiet time of day, because it requires
39293 a database to be locked (and therefore inaccessible to Exim) while it does its
39294 work. Removing records from a DBM file does not normally make the file smaller,
39295 but all the common DBM libraries are able to re-use the space that is released.
39296 After an initial phase of increasing in size, the databases normally reach a
39297 point at which they no longer get any bigger, as long as they are regularly
39298 tidied.
39299
39300 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
39301 databases is likely to keep on increasing.
39302
39303
39304
39305
39306 .section "exim_fixdb" "SECID263"
39307 .cindex "&'exim_fixdb'&"
39308 The &'exim_fixdb'& program is a utility for interactively modifying databases.
39309 Its main use is for testing Exim, but it might also be occasionally useful for
39310 getting round problems in a live system. It has no options, and its interface
39311 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
39312 key of a database record can then be entered, and the data for that record is
39313 displayed.
39314
39315 If &"d"& is typed at the next prompt, the entire record is deleted. For all
39316 except the &'retry'& database, that is the only operation that can be carried
39317 out. For the &'retry'& database, each field is output preceded by a number, and
39318 data for individual fields can be changed by typing the field number followed
39319 by new data, for example:
39320 .code
39321 > 4 951102:1000
39322 .endd
39323 resets the time of the next delivery attempt. Time values are given as a
39324 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
39325 used as optional separators.
39326
39327
39328
39329
39330 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
39331 .cindex "mailbox" "maintenance"
39332 .cindex "&'exim_lock'&"
39333 .cindex "locking mailboxes"
39334 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
39335 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
39336 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
39337 a user agent while investigating a problem. The utility requires the name of
39338 the file as its first argument. If the locking is successful, the second
39339 argument is run as a command (using C's &[system()]& function); if there is no
39340 second argument, the value of the SHELL environment variable is used; if this
39341 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
39342 is unlocked and the utility ends. The following options are available:
39343
39344 .vlist
39345 .vitem &%-fcntl%&
39346 Use &[fcntl()]& locking on the open mailbox.
39347
39348 .vitem &%-flock%&
39349 Use &[flock()]& locking on the open mailbox, provided the operating system
39350 supports it.
39351
39352 .vitem &%-interval%&
39353 This must be followed by a number, which is a number of seconds; it sets the
39354 interval to sleep between retries (default 3).
39355
39356 .vitem &%-lockfile%&
39357 Create a lock file before opening the mailbox.
39358
39359 .vitem &%-mbx%&
39360 Lock the mailbox using MBX rules.
39361
39362 .vitem &%-q%&
39363 Suppress verification output.
39364
39365 .vitem &%-retries%&
39366 This must be followed by a number; it sets the number of times to try to get
39367 the lock (default 10).
39368
39369 .vitem &%-restore_time%&
39370 This option causes &%exim_lock%& to restore the modified and read times to the
39371 locked file before exiting. This allows you to access a locked mailbox (for
39372 example, to take a backup copy) without disturbing the times that the user
39373 subsequently sees.
39374
39375 .vitem &%-timeout%&
39376 This must be followed by a number, which is a number of seconds; it sets a
39377 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
39378 default), a non-blocking call is used.
39379
39380 .vitem &%-v%&
39381 Generate verbose output.
39382 .endlist
39383
39384 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
39385 default is to create a lock file and also to use &[fcntl()]& locking on the
39386 mailbox, which is the same as Exim's default. The use of &%-flock%& or
39387 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
39388 requires that the directory containing the file be writeable. Locking by lock
39389 file does not last forever; Exim assumes that a lock file is expired if it is
39390 more than 30 minutes old.
39391
39392 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
39393 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
39394 to be taken out on the open mailbox, and an exclusive lock on the file
39395 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
39396 number of the mailbox file. When the locking is released, if an exclusive lock
39397 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
39398
39399 The default output contains verification of the locking that takes place. The
39400 &%-v%& option causes some additional information to be given. The &%-q%& option
39401 suppresses all output except error messages.
39402
39403 A command such as
39404 .code
39405 exim_lock /var/spool/mail/spqr
39406 .endd
39407 runs an interactive shell while the file is locked, whereas
39408 .display
39409 &`exim_lock -q /var/spool/mail/spqr <<End`&
39410 <&'some commands'&>
39411 &`End`&
39412 .endd
39413 runs a specific non-interactive sequence of commands while the file is locked,
39414 suppressing all verification output. A single command can be run by a command
39415 such as
39416 .code
39417 exim_lock -q /var/spool/mail/spqr \
39418   "cp /var/spool/mail/spqr /some/where"
39419 .endd
39420 Note that if a command is supplied, it must be entirely contained within the
39421 second argument &-- hence the quotes.
39422 .ecindex IIDutils
39423
39424
39425 . ////////////////////////////////////////////////////////////////////////////
39426 . ////////////////////////////////////////////////////////////////////////////
39427
39428 .chapter "The Exim monitor" "CHAPeximon"
39429 .scindex IIDeximon "Exim monitor" "description"
39430 .cindex "X-windows"
39431 .cindex "&'eximon'&"
39432 .cindex "Local/eximon.conf"
39433 .cindex "&_exim_monitor/EDITME_&"
39434 The Exim monitor is an application which displays in an X window information
39435 about the state of Exim's queue and what Exim is doing. An admin user can
39436 perform certain operations on messages from this GUI interface; however all
39437 such facilities are also available from the command line, and indeed, the
39438 monitor itself makes use of the command line to perform any actions requested.
39439
39440
39441
39442 .section "Running the monitor" "SECID264"
39443 The monitor is started by running the script called &'eximon'&. This is a shell
39444 script that sets up a number of environment variables, and then runs the
39445 binary called &_eximon.bin_&. The default appearance of the monitor window can
39446 be changed by editing the &_Local/eximon.conf_& file created by editing
39447 &_exim_monitor/EDITME_&. Comments in that file describe what the various
39448 parameters are for.
39449
39450 The parameters that get built into the &'eximon'& script can be overridden for
39451 a particular invocation by setting up environment variables of the same names,
39452 preceded by &`EXIMON_`&. For example, a shell command such as
39453 .code
39454 EXIMON_LOG_DEPTH=400 eximon
39455 .endd
39456 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
39457 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
39458 overrides the Exim log file configuration. This makes it possible to have
39459 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
39460 syslog messages are routed to a file on the local host.
39461
39462 X resources can be used to change the appearance of the window in the normal
39463 way. For example, a resource setting of the form
39464 .code
39465 Eximon*background: gray94
39466 .endd
39467 changes the colour of the background to light grey rather than white. The
39468 stripcharts are drawn with both the data lines and the reference lines in
39469 black. This means that the reference lines are not visible when on top of the
39470 data. However, their colour can be changed by setting a resource called
39471 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
39472 For example, if your X server is running Unix, you could set up lighter
39473 reference lines in the stripcharts by obeying
39474 .code
39475 xrdb -merge <<End
39476 Eximon*highlight: gray
39477 End
39478 .endd
39479 .cindex "admin user"
39480 In order to see the contents of messages in the queue, and to operate on them,
39481 &'eximon'& must either be run as root or by an admin user.
39482
39483 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
39484 contain X11 resource parameters interpreted by the X11 library.  In addition,
39485 if the first parameter starts with the string "gdb" then it is removed and the
39486 binary is invoked under gdb (the parameter is used as the gdb command-name, so
39487 versioned variants of gdb can be invoked).
39488
39489 The monitor's window is divided into three parts. The first contains one or
39490 more stripcharts and two action buttons, the second contains a &"tail"& of the
39491 main log file, and the third is a display of the queue of messages awaiting
39492 delivery, with two more action buttons. The following sections describe these
39493 different parts of the display.
39494
39495
39496
39497
39498 .section "The stripcharts" "SECID265"
39499 .cindex "stripchart"
39500 The first stripchart is always a count of messages in the queue. Its name can
39501 be configured by setting QUEUE_STRIPCHART_NAME in the
39502 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
39503 configuration script by regular expression matches on log file entries, making
39504 it possible to display, for example, counts of messages delivered to certain
39505 hosts or using certain transports. The supplied defaults display counts of
39506 received and delivered messages, and of local and SMTP deliveries. The default
39507 period between stripchart updates is one minute; this can be adjusted by a
39508 parameter in the &_Local/eximon.conf_& file.
39509
39510 The stripchart displays rescale themselves automatically as the value they are
39511 displaying changes. There are always 10 horizontal lines in each chart; the
39512 title string indicates the value of each division when it is greater than one.
39513 For example, &"x2"& means that each division represents a value of 2.
39514
39515 It is also possible to have a stripchart which shows the percentage fullness of
39516 a particular disk partition, which is useful when local deliveries are confined
39517 to a single partition.
39518
39519 .cindex "&%statvfs%& function"
39520 This relies on the availability of the &[statvfs()]& function or equivalent in
39521 the operating system. Most, but not all versions of Unix that support Exim have
39522 this. For this particular stripchart, the top of the chart always represents
39523 100%, and the scale is given as &"x10%"&. This chart is configured by setting
39524 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
39525 &_Local/eximon.conf_& file.
39526
39527
39528
39529
39530 .section "Main action buttons" "SECID266"
39531 .cindex "size" "of monitor window"
39532 .cindex "Exim monitor" "window size"
39533 .cindex "window size"
39534 Below the stripcharts there is an action button for quitting the monitor. Next
39535 to this is another button marked &"Size"&. They are placed here so that
39536 shrinking the window to its default minimum size leaves just the queue count
39537 stripchart and these two buttons visible. Pressing the &"Size"& button causes
39538 the window to expand to its maximum size, unless it is already at the maximum,
39539 in which case it is reduced to its minimum.
39540
39541 When expanding to the maximum, if the window cannot be fully seen where it
39542 currently is, it is moved back to where it was the last time it was at full
39543 size. When it is expanding from its minimum size, the old position is
39544 remembered, and next time it is reduced to the minimum it is moved back there.
39545
39546 The idea is that you can keep a reduced window just showing one or two
39547 stripcharts at a convenient place on your screen, easily expand it to show
39548 the full window when required, and just as easily put it back to what it was.
39549 The idea is copied from what the &'twm'& window manager does for its
39550 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
39551 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
39552
39553 Normally, the monitor starts up with the window at its full size, but it can be
39554 built so that it starts up with the window at its smallest size, by setting
39555 START_SMALL=yes in &_Local/eximon.conf_&.
39556
39557
39558
39559 .section "The log display" "SECID267"
39560 .cindex "log" "tail of; in monitor"
39561 The second section of the window is an area in which a display of the tail of
39562 the main log is maintained.
39563 To save space on the screen, the timestamp on each log line is shortened by
39564 removing the date and, if &%log_timezone%& is set, the timezone.
39565 The log tail is not available when the only destination for logging data is
39566 syslog, unless the syslog lines are routed to a local file whose name is passed
39567 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
39568
39569 The log sub-window has a scroll bar at its lefthand side which can be used to
39570 move back to look at earlier text, and the up and down arrow keys also have a
39571 scrolling effect. The amount of log that is kept depends on the setting of
39572 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
39573 to use. When this is full, the earlier 50% of data is discarded &-- this is
39574 much more efficient than throwing it away line by line. The sub-window also has
39575 a horizontal scroll bar for accessing the ends of long log lines. This is the
39576 only means of horizontal scrolling; the right and left arrow keys are not
39577 available. Text can be cut from this part of the window using the mouse in the
39578 normal way. The size of this subwindow is controlled by parameters in the
39579 configuration file &_Local/eximon.conf_&.
39580
39581 Searches of the text in the log window can be carried out by means of the ^R
39582 and ^S keystrokes, which default to a reverse and a forward search,
39583 respectively. The search covers only the text that is displayed in the window.
39584 It cannot go further back up the log.
39585
39586 The point from which the search starts is indicated by a caret marker. This is
39587 normally at the end of the text in the window, but can be positioned explicitly
39588 by pointing and clicking with the left mouse button, and is moved automatically
39589 by a successful search. If new text arrives in the window when it is scrolled
39590 back, the caret remains where it is, but if the window is not scrolled back,
39591 the caret is moved to the end of the new text.
39592
39593 Pressing ^R or ^S pops up a window into which the search text can be typed.
39594 There are buttons for selecting forward or reverse searching, for carrying out
39595 the search, and for cancelling. If the &"Search"& button is pressed, the search
39596 happens and the window remains so that further searches can be done. If the
39597 &"Return"& key is pressed, a single search is done and the window is closed. If
39598 ^C is typed the search is cancelled.
39599
39600 The searching facility is implemented using the facilities of the Athena text
39601 widget. By default this pops up a window containing both &"search"& and
39602 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
39603 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
39604 However, the linkers in BSDI and HP-UX seem unable to handle an externally
39605 provided version of &%TextPop%& when the remaining parts of the text widget
39606 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
39607 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
39608 on these systems, at the expense of having unwanted items in the search popup
39609 window.
39610
39611
39612
39613 .section "The queue display" "SECID268"
39614 .cindex "queue" "display in monitor"
39615 The bottom section of the monitor window contains a list of all messages that
39616 are in the queue, which includes those currently being received or delivered,
39617 as well as those awaiting delivery. The size of this subwindow is controlled by
39618 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
39619 at which it is updated is controlled by another parameter in the same file &--
39620 the default is 5 minutes, since queue scans can be quite expensive. However,
39621 there is an &"Update"& action button just above the display which can be used
39622 to force an update of the queue display at any time.
39623
39624 When a host is down for some time, a lot of pending mail can build up for it,
39625 and this can make it hard to deal with other messages in the queue. To help
39626 with this situation there is a button next to &"Update"& called &"Hide"&. If
39627 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
39628 type anything in here and press &"Return"&, the text is added to a chain of
39629 such texts, and if every undelivered address in a message matches at least one
39630 of the texts, the message is not displayed.
39631
39632 If there is an address that does not match any of the texts, all the addresses
39633 are displayed as normal. The matching happens on the ends of addresses so, for
39634 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
39635 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
39636 has been set up, a button called &"Unhide"& is displayed. If pressed, it
39637 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
39638 a hide request is automatically cancelled after one hour.
39639
39640 While the dialogue box is displayed, you can't press any buttons or do anything
39641 else to the monitor window. For this reason, if you want to cut text from the
39642 queue display to use in the dialogue box, you have to do the cutting before
39643 pressing the &"Hide"& button.
39644
39645 The queue display contains, for each unhidden queued message, the length of
39646 time it has been in the queue, the size of the message, the message id, the
39647 message sender, and the first undelivered recipient, all on one line. If it is
39648 a bounce message, the sender is shown as &"<>"&. If there is more than one
39649 recipient to which the message has not yet been delivered, subsequent ones are
39650 listed on additional lines, up to a maximum configured number, following which
39651 an ellipsis is displayed. Recipients that have already received the message are
39652 not shown.
39653
39654 .cindex "frozen messages" "display"
39655 If a message is frozen, an asterisk is displayed at the left-hand side.
39656
39657 The queue display has a vertical scroll bar, and can also be scrolled by means
39658 of the arrow keys. Text can be cut from it using the mouse in the normal way.
39659 The text searching facilities, as described above for the log window, are also
39660 available, but the caret is always moved to the end of the text when the queue
39661 display is updated.
39662
39663
39664
39665 .section "The queue menu" "SECID269"
39666 .cindex "queue" "menu in monitor"
39667 If the &%shift%& key is held down and the left button is clicked when the mouse
39668 pointer is over the text for any message, an action menu pops up, and the first
39669 line of the queue display for the message is highlighted. This does not affect
39670 any selected text.
39671
39672 If you want to use some other event for popping up the menu, you can set the
39673 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
39674 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
39675 value set in this parameter is a standard X event description. For example, to
39676 run eximon using &%ctrl%& rather than &%shift%& you could use
39677 .code
39678 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
39679 .endd
39680 The title of the menu is the message id, and it contains entries which act as
39681 follows:
39682
39683 .ilist
39684 &'message log'&: The contents of the message log for the message are displayed
39685 in a new text window.
39686 .next
39687 &'headers'&: Information from the spool file that contains the envelope
39688 information and headers is displayed in a new text window. See chapter
39689 &<<CHAPspool>>& for a description of the format of spool files.
39690 .next
39691 &'body'&: The contents of the spool file containing the body of the message are
39692 displayed in a new text window. There is a default limit of 20,000 bytes to the
39693 amount of data displayed. This can be changed by setting the BODY_MAX
39694 option at compile time, or the EXIMON_BODY_MAX option at runtime.
39695 .next
39696 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
39697 delivery of the message. This causes an automatic thaw if the message is
39698 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
39699 a new text window. The delivery is run in a separate process, to avoid holding
39700 up the monitor while the delivery proceeds.
39701 .next
39702 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
39703 that the message be frozen.
39704 .next
39705 .cindex "thawing messages"
39706 .cindex "unfreezing messages"
39707 .cindex "frozen messages" "thawing"
39708 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
39709 that the message be thawed.
39710 .next
39711 .cindex "delivery" "forcing failure"
39712 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
39713 that Exim gives up trying to deliver the message. A bounce message is generated
39714 for any remaining undelivered addresses.
39715 .next
39716 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
39717 that the message be deleted from the system without generating a bounce
39718 message.
39719 .next
39720 &'add recipient'&: A dialog box is displayed into which a recipient address can
39721 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39722 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39723 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39724 causes a call to Exim to be made using the &%-Mar%& option to request that an
39725 additional recipient be added to the message, unless the entry box is empty, in
39726 which case no action is taken.
39727 .next
39728 &'mark delivered'&: A dialog box is displayed into which a recipient address
39729 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
39730 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
39731 Otherwise it must be entered as a fully qualified address. Pressing RETURN
39732 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
39733 recipient address as already delivered, unless the entry box is empty, in which
39734 case no action is taken.
39735 .next
39736 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
39737 mark all recipient addresses as already delivered.
39738 .next
39739 &'edit sender'&: A dialog box is displayed initialized with the current
39740 sender's address. Pressing RETURN causes a call to Exim to be made using the
39741 &%-Mes%& option to replace the sender address, unless the entry box is empty,
39742 in which case no action is taken. If you want to set an empty sender (as in
39743 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
39744 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
39745 the address is qualified with that domain.
39746 .endlist
39747
39748 When a delivery is forced, a window showing the &%-v%& output is displayed. In
39749 other cases when a call to Exim is made, if there is any output from Exim (in
39750 particular, if the command fails) a window containing the command and the
39751 output is displayed. Otherwise, the results of the action are normally apparent
39752 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
39753 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
39754 if no output is generated.
39755
39756 The queue display is automatically updated for actions such as freezing and
39757 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
39758 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
39759 force an update of the display after one of these actions.
39760
39761 In any text window that is displayed as result of a menu action, the normal
39762 cut-and-paste facility is available, and searching can be carried out using ^R
39763 and ^S, as described above for the log tail window.
39764 .ecindex IIDeximon
39765
39766
39767
39768
39769
39770 . ////////////////////////////////////////////////////////////////////////////
39771 . ////////////////////////////////////////////////////////////////////////////
39772
39773 .chapter "Security considerations" "CHAPsecurity"
39774 .scindex IIDsecurcon "security" "discussion of"
39775 This chapter discusses a number of issues concerned with security, some of
39776 which are also covered in other parts of this manual.
39777
39778 For reasons that this author does not understand, some people have promoted
39779 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
39780 existence of this chapter in the documentation. However, the intent of the
39781 chapter is simply to describe the way Exim works in relation to certain
39782 security concerns, not to make any specific claims about the effectiveness of
39783 its security as compared with other MTAs.
39784
39785 What follows is a description of the way Exim is supposed to be. Best efforts
39786 have been made to try to ensure that the code agrees with the theory, but an
39787 absence of bugs can never be guaranteed. Any that are reported will get fixed
39788 as soon as possible.
39789
39790
39791 .section "Building a more &""hardened""& Exim" "SECID286"
39792 .cindex "security" "build-time features"
39793 There are a number of build-time options that can be set in &_Local/Makefile_&
39794 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
39795 Exim administrator who does not have the root password, or by someone who has
39796 penetrated the Exim (but not the root) account. These options are as follows:
39797
39798 .ilist
39799 ALT_CONFIG_PREFIX can be set to a string that is required to match the
39800 start of any filenames used with the &%-C%& option. When it is set, these
39801 filenames are also not allowed to contain the sequence &"/../"&. (However, if
39802 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
39803 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
39804 default setting for &%ALT_CONFIG_PREFIX%&.
39805
39806 If the permitted configuration files are confined to a directory to
39807 which only root has access, this guards against someone who has broken
39808 into the Exim account from running a privileged Exim with an arbitrary
39809 configuration file, and using it to break into other accounts.
39810 .next
39811
39812 If a non-trusted configuration file (i.e. not the default configuration file
39813 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
39814 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
39815 the next item), then root privilege is retained only if the caller of Exim is
39816 root. This locks out the possibility of testing a configuration using &%-C%&
39817 right through message reception and delivery, even if the caller is root. The
39818 reception works, but by that time, Exim is running as the Exim user, so when
39819 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
39820 privilege to be lost. However, root can test reception and delivery using two
39821 separate commands.
39822
39823 .next
39824 The WHITELIST_D_MACROS build option declares some macros to be safe to override
39825 with &%-D%& if the real uid is one of root, the Exim run-time user or the
39826 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
39827 requiring the run-time value supplied to &%-D%& to match a regex that errs on
39828 the restrictive side.  Requiring build-time selection of safe macros is onerous
39829 but this option is intended solely as a transition mechanism to permit
39830 previously-working configurations to continue to work after release 4.73.
39831 .next
39832 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
39833 is disabled.
39834 .next
39835 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
39836 never to be used for any deliveries. This is like the &%never_users%& runtime
39837 option, but it cannot be overridden; the runtime option adds additional users
39838 to the list. The default setting is &"root"&; this prevents a non-root user who
39839 is permitted to modify the runtime file from using Exim as a way to get root.
39840 .endlist
39841
39842
39843
39844 .section "Root privilege" "SECID270"
39845 .cindex "setuid"
39846 .cindex "root privilege"
39847 The Exim binary is normally setuid to root, which means that it gains root
39848 privilege (runs as root) when it starts execution. In some special cases (for
39849 example, when the daemon is not in use and there are no local deliveries), it
39850 may be possible to run Exim setuid to some user other than root. This is
39851 discussed in the next section. However, in most installations, root privilege
39852 is required for two things:
39853
39854 .ilist
39855 To set up a socket connected to the standard SMTP port (25) when initialising
39856 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
39857 not required.
39858 .next
39859 To be able to change uid and gid in order to read users' &_.forward_& files and
39860 perform local deliveries as the receiving user or as specified in the
39861 configuration.
39862 .endlist
39863
39864 It is not necessary to be root to do any of the other things Exim does, such as
39865 receiving messages and delivering them externally over SMTP, and it is
39866 obviously more secure if Exim does not run as root except when necessary.
39867 For this reason, a user and group for Exim to use must be defined in
39868 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
39869 group"&. Their values can be changed by the runtime configuration, though this
39870 is not recommended. Often a user called &'exim'& is used, but some sites use
39871 &'mail'& or another user name altogether.
39872
39873 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
39874 abdication; the process cannot regain root afterwards. Prior to release 4.00,
39875 &[seteuid()]& was used in some circumstances, but this is no longer the case.
39876
39877 After a new Exim process has interpreted its command line options, it changes
39878 uid and gid in the following cases:
39879
39880 .ilist
39881 .oindex "&%-C%&"
39882 .oindex "&%-D%&"
39883 If the &%-C%& option is used to specify an alternate configuration file, or if
39884 the &%-D%& option is used to define macro values for the configuration, and the
39885 calling process is not running as root, the uid and gid are changed to those of
39886 the calling process.
39887 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
39888 option may not be used at all.
39889 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
39890 can be supplied if the calling process is running as root, the Exim run-time
39891 user or CONFIGURE_OWNER, if defined.
39892 .next
39893 .oindex "&%-be%&"
39894 .oindex "&%-bf%&"
39895 .oindex "&%-bF%&"
39896 If the expansion test option (&%-be%&) or one of the filter testing options
39897 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
39898 calling process.
39899 .next
39900 If the process is not a daemon process or a queue runner process or a delivery
39901 process or a process for testing address routing (started with &%-bt%&), the
39902 uid and gid are changed to the Exim user and group. This means that Exim always
39903 runs under its own uid and gid when receiving messages. This also applies when
39904 testing address verification
39905 .oindex "&%-bv%&"
39906 .oindex "&%-bh%&"
39907 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
39908 option).
39909 .next
39910 For a daemon, queue runner, delivery, or address testing process, the uid
39911 remains as root at this stage, but the gid is changed to the Exim group.
39912 .endlist
39913
39914 The processes that initially retain root privilege behave as follows:
39915
39916 .ilist
39917 A daemon process changes the gid to the Exim group and the uid to the Exim
39918 user after setting up one or more listening sockets. The &[initgroups()]&
39919 function is called, so that if the Exim user is in any additional groups, they
39920 will be used during message reception.
39921 .next
39922 A queue runner process retains root privilege throughout its execution. Its
39923 job is to fork a controlled sequence of delivery processes.
39924 .next
39925 A delivery process retains root privilege throughout most of its execution,
39926 but any actual deliveries (that is, the transports themselves) are run in
39927 subprocesses which always change to a non-root uid and gid. For local
39928 deliveries this is typically the uid and gid of the owner of the mailbox; for
39929 remote deliveries, the Exim uid and gid are used. Once all the delivery
39930 subprocesses have been run, a delivery process changes to the Exim uid and gid
39931 while doing post-delivery tidying up such as updating the retry database and
39932 generating bounce and warning messages.
39933
39934 While the recipient addresses in a message are being routed, the delivery
39935 process runs as root. However, if a user's filter file has to be processed,
39936 this is done in a subprocess that runs under the individual user's uid and
39937 gid. A system filter is run as root unless &%system_filter_user%& is set.
39938 .next
39939 A process that is testing addresses (the &%-bt%& option) runs as root so that
39940 the routing is done in the same environment as a message delivery.
39941 .endlist
39942
39943
39944
39945
39946 .section "Running Exim without privilege" "SECTrunexiwitpri"
39947 .cindex "privilege, running without"
39948 .cindex "unprivileged running"
39949 .cindex "root privilege" "running without"
39950 Some installations like to run Exim in an unprivileged state for more of its
39951 operation, for added security. Support for this mode of operation is provided
39952 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
39953 gid are changed to the Exim user and group at the start of a delivery process
39954 (and also queue runner and address testing processes). This means that address
39955 routing is no longer run as root, and the deliveries themselves cannot change
39956 to any other uid.
39957
39958 .cindex SIGHUP
39959 .cindex "daemon" "restarting"
39960 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
39961 that the daemon can still be started in the usual way, and it can respond
39962 correctly to SIGHUP because the re-invocation regains root privilege.
39963
39964 An alternative approach is to make Exim setuid to the Exim user and also setgid
39965 to the Exim group. If you do this, the daemon must be started from a root
39966 process. (Calling Exim from a root process makes it behave in the way it does
39967 when it is setuid root.) However, the daemon cannot restart itself after a
39968 SIGHUP signal because it cannot regain privilege.
39969
39970 It is still useful to set &%deliver_drop_privilege%& in this case, because it
39971 stops Exim from trying to re-invoke itself to do a delivery after a message has
39972 been received. Such a re-invocation is a waste of resources because it has no
39973 effect.
39974
39975 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
39976 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
39977 to the Exim user seems a clean approach, but there is one complication:
39978
39979 In this style of operation, Exim is running with the real uid and gid set to
39980 those of the calling process, and the effective uid/gid set to Exim's values.
39981 Ideally, any association with the calling process' uid/gid should be dropped,
39982 that is, the real uid/gid should be reset to the effective values so as to
39983 discard any privileges that the caller may have. While some operating systems
39984 have a function that permits this action for a non-root effective uid, quite a
39985 number of them do not. Because of this lack of standardization, Exim does not
39986 address this problem at this time.
39987
39988 For this reason, the recommended approach for &"mostly unprivileged"& running
39989 is to keep the Exim binary setuid to root, and to set
39990 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
39991 be used in the most straightforward way.
39992
39993 If you configure Exim not to run delivery processes as root, there are a
39994 number of restrictions on what you can do:
39995
39996 .ilist
39997 You can deliver only as the Exim user/group. You should  explicitly use the
39998 &%user%& and &%group%& options to override routers or local transports that
39999 normally deliver as the recipient. This makes sure that configurations that
40000 work in this mode function the same way in normal mode. Any implicit or
40001 explicit specification of another user causes an error.
40002 .next
40003 Use of &_.forward_& files is severely restricted, such that it is usually
40004 not worthwhile to include them in the configuration.
40005 .next
40006 Users who wish to use &_.forward_& would have to make their home directory and
40007 the file itself accessible to the Exim user. Pipe and append-to-file entries,
40008 and their equivalents in Exim filters, cannot be used. While they could be
40009 enabled in the Exim user's name, that would be insecure and not very useful.
40010 .next
40011 Unless the local user mailboxes are all owned by the Exim user (possible in
40012 some POP3 or IMAP-only environments):
40013
40014 .olist
40015 They must be owned by the Exim group and be writeable by that group. This
40016 implies you must set &%mode%& in the appendfile configuration, as well as the
40017 mode of the mailbox files themselves.
40018 .next
40019 You must set &%no_check_owner%&, since most or all of the files will not be
40020 owned by the Exim user.
40021 .next
40022 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
40023 on a newly created mailbox when unprivileged. This also implies that new
40024 mailboxes need to be created manually.
40025 .endlist olist
40026 .endlist ilist
40027
40028
40029 These restrictions severely restrict what can be done in local deliveries.
40030 However, there are no restrictions on remote deliveries. If you are running a
40031 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
40032 gives more security at essentially no cost.
40033
40034 If you are using the &%mua_wrapper%& facility (see chapter
40035 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
40036
40037
40038
40039
40040 .section "Delivering to local files" "SECID271"
40041 Full details of the checks applied by &(appendfile)& before it writes to a file
40042 are given in chapter &<<CHAPappendfile>>&.
40043
40044
40045
40046 .section "Running local commands" "SECTsecconslocalcmds"
40047 .cindex "security" "local commands"
40048 .cindex "security" "command injection attacks"
40049 There are a number of ways in which an administrator can configure Exim to run
40050 commands based upon received, untrustworthy, data. Further, in some
40051 configurations a user who can control a &_.forward_& file can also arrange to
40052 run commands. Configuration to check includes, but is not limited to:
40053
40054 .ilist
40055 Use of &%use_shell%& in the pipe transport: various forms of shell command
40056 injection may be possible with this option present. It is dangerous and should
40057 be used only with considerable caution. Consider constraints which whitelist
40058 allowed characters in a variable which is to be used in a pipe transport that
40059 has &%use_shell%& enabled.
40060 .next
40061 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
40062 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
40063 &_.forward_& files in a redirect router. If Exim is running on a central mail
40064 hub to which ordinary users do not have shell access, but home directories are
40065 NFS mounted (for instance) then administrators should review the list of these
40066 forbid options available, and should bear in mind that the options that may
40067 need forbidding can change as new features are added between releases.
40068 .next
40069 The &%${run...}%& expansion item does not use a shell by default, but
40070 administrators can configure use of &_/bin/sh_& as part of the command.
40071 Such invocations should be viewed with prejudicial suspicion.
40072 .next
40073 Administrators who use embedded Perl are advised to explore how Perl's
40074 taint checking might apply to their usage.
40075 .next
40076 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
40077 administrators are well advised to view its use with suspicion, in case (for
40078 instance) it allows a local-part to contain embedded Exim directives.
40079 .next
40080 Use of &%${match_local_part...}%& and friends becomes more dangerous if
40081 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
40082 each can reference arbitrary lists and files, rather than just being a list
40083 of opaque strings.
40084 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
40085 real-world security vulnerabilities caused by its use with untrustworthy data
40086 injected in, for SQL injection attacks.
40087 Consider the use of the &%inlisti%& expansion condition instead.
40088 .endlist
40089
40090
40091
40092
40093 .section "Trust in configuration data" "SECTsecconfdata"
40094 .cindex "security" "data sources"
40095 .cindex "security" "regular expressions"
40096 .cindex "regular expressions" "security"
40097 .cindex "PCRE" "security"
40098 If configuration data for Exim can come from untrustworthy sources, there
40099 are some issues to be aware of:
40100
40101 .ilist
40102 Use of &%${expand...}%& may provide a path for shell injection attacks.
40103 .next
40104 Letting untrusted data provide a regular expression is unwise.
40105 .next
40106 Using &%${match...}%& to apply a fixed regular expression against untrusted
40107 data may result in pathological behaviour within PCRE.  Be aware of what
40108 "backtracking" means and consider options for being more strict with a regular
40109 expression. Avenues to explore include limiting what can match (avoiding &`.`&
40110 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
40111 possessive quantifiers or just not using regular expressions against untrusted
40112 data.
40113 .next
40114 It can be important to correctly use &%${quote:...}%&,
40115 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
40116 items to ensure that data is correctly constructed.
40117 .next
40118 Some lookups might return multiple results, even though normal usage is only
40119 expected to yield one result.
40120 .endlist
40121
40122
40123
40124
40125 .section "IPv4 source routing" "SECID272"
40126 .cindex "source routing" "in IP packets"
40127 .cindex "IP source routing"
40128 Many operating systems suppress IP source-routed packets in the kernel, but
40129 some cannot be made to do this, so Exim does its own check. It logs incoming
40130 IPv4 source-routed TCP calls, and then drops them. Things are all different in
40131 IPv6. No special checking is currently done.
40132
40133
40134
40135 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
40136 Support for these SMTP commands is disabled by default. If required, they can
40137 be enabled by defining suitable ACLs.
40138
40139
40140
40141
40142 .section "Privileged users" "SECID274"
40143 .cindex "trusted users"
40144 .cindex "admin user"
40145 .cindex "privileged user"
40146 .cindex "user" "trusted"
40147 .cindex "user" "admin"
40148 Exim recognizes two sets of users with special privileges. Trusted users are
40149 able to submit new messages to Exim locally, but supply their own sender
40150 addresses and information about a sending host. For other users submitting
40151 local messages, Exim sets up the sender address from the uid, and doesn't
40152 permit a remote host to be specified.
40153
40154 .oindex "&%-f%&"
40155 However, an untrusted user is permitted to use the &%-f%& command line option
40156 in the special form &%-f <>%& to indicate that a delivery failure for the
40157 message should not cause an error report. This affects the message's envelope,
40158 but it does not affect the &'Sender:'& header. Untrusted users may also be
40159 permitted to use specific forms of address with the &%-f%& option by setting
40160 the &%untrusted_set_sender%& option.
40161
40162 Trusted users are used to run processes that receive mail messages from some
40163 other mail domain and pass them on to Exim for delivery either locally, or over
40164 the Internet. Exim trusts a caller that is running as root, as the Exim user,
40165 as any user listed in the &%trusted_users%& configuration option, or under any
40166 group listed in the &%trusted_groups%& option.
40167
40168 Admin users are permitted to do things to the messages on Exim's queue. They
40169 can freeze or thaw messages, cause them to be returned to their senders, remove
40170 them entirely, or modify them in various ways. In addition, admin users can run
40171 the Exim monitor and see all the information it is capable of providing, which
40172 includes the contents of files on the spool.
40173
40174 .oindex "&%-M%&"
40175 .oindex "&%-q%&"
40176 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
40177 delivery of messages on its queue is restricted to admin users. This
40178 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
40179 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
40180 queue is also restricted to admin users. This restriction can be relaxed by
40181 setting &%no_queue_list_requires_admin%&.
40182
40183 Exim recognizes an admin user if the calling process is running as root or as
40184 the Exim user or if any of the groups associated with the calling process is
40185 the Exim group. It is not necessary actually to be running under the Exim
40186 group. However, if admin users who are not root or the Exim user are to access
40187 the contents of files on the spool via the Exim monitor (which runs
40188 unprivileged), Exim must be built to allow group read access to its spool
40189 files.
40190
40191 By default, regular users are trusted to perform basic testing and
40192 introspection commands, as themselves.  This setting can be tightened by
40193 setting the &%commandline_checks_require_admin%& option.
40194 This affects most of the checking options,
40195 such as &%-be%& and anything else &%-b*%&.
40196
40197
40198 .section "Spool files" "SECID275"
40199 .cindex "spool directory" "files"
40200 Exim's spool directory and everything it contains is owned by the Exim user and
40201 set to the Exim group. The mode for spool files is defined in the
40202 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
40203 any user who is a member of the Exim group can access these files.
40204
40205
40206
40207 .section "Use of argv[0]" "SECID276"
40208 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
40209 of specific strings, Exim assumes certain options. For example, calling Exim
40210 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
40211 to calling it with the option &%-bS%&. There are no security implications in
40212 this.
40213
40214
40215
40216 .section "Use of %f formatting" "SECID277"
40217 The only use made of &"%f"& by Exim is in formatting load average values. These
40218 are actually stored in integer variables as 1000 times the load average.
40219 Consequently, their range is limited and so therefore is the length of the
40220 converted output.
40221
40222
40223
40224 .section "Embedded Exim path" "SECID278"
40225 Exim uses its own path name, which is embedded in the code, only when it needs
40226 to re-exec in order to regain root privilege. Therefore, it is not root when it
40227 does so. If some bug allowed the path to get overwritten, it would lead to an
40228 arbitrary program's being run as exim, not as root.
40229
40230
40231
40232 .section "Dynamic module directory" "SECTdynmoddir"
40233 Any dynamically loadable modules must be installed into the directory
40234 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
40235 loading it.
40236
40237
40238 .section "Use of sprintf()" "SECID279"
40239 .cindex "&[sprintf()]&"
40240 A large number of occurrences of &"sprintf"& in the code are actually calls to
40241 &'string_sprintf()'&, a function that returns the result in malloc'd store.
40242 The intermediate formatting is done into a large fixed buffer by a function
40243 that runs through the format string itself, and checks the length of each
40244 conversion before performing it, thus preventing buffer overruns.
40245
40246 The remaining uses of &[sprintf()]& happen in controlled circumstances where
40247 the output buffer is known to be sufficiently long to contain the converted
40248 string.
40249
40250
40251
40252 .section "Use of debug_printf() and log_write()" "SECID280"
40253 Arbitrary strings are passed to both these functions, but they do their
40254 formatting by calling the function &'string_vformat()'&, which runs through
40255 the format string itself, and checks the length of each conversion.
40256
40257
40258
40259 .section "Use of strcat() and strcpy()" "SECID281"
40260 These are used only in cases where the output buffer is known to be large
40261 enough to hold the result.
40262 .ecindex IIDsecurcon
40263
40264
40265
40266
40267 . ////////////////////////////////////////////////////////////////////////////
40268 . ////////////////////////////////////////////////////////////////////////////
40269
40270 .chapter "Format of spool files" "CHAPspool"
40271 .scindex IIDforspo1 "format" "spool files"
40272 .scindex IIDforspo2 "spool directory" "format of files"
40273 .scindex IIDforspo3 "spool files" "format of"
40274 .cindex "spool files" "editing"
40275 A message on Exim's queue consists of two files, whose names are the message id
40276 followed by -D and -H, respectively. The data portion of the message is kept in
40277 the -D file on its own. The message's envelope, status, and headers are all
40278 kept in the -H file, whose format is described in this chapter. Each of these
40279 two files contains the final component of its own name as its first line. This
40280 is insurance against disk crashes where the directory is lost but the files
40281 themselves are recoverable.
40282
40283 The file formats may be changed, or new formats added, at any release.
40284 Spool files are not intended as an interface to other programs
40285 and should not be used as such.
40286
40287 Some people are tempted into editing -D files in order to modify messages. You
40288 need to be extremely careful if you do this; it is not recommended and you are
40289 on your own if you do it. Here are some of the pitfalls:
40290
40291 .ilist
40292 You must ensure that Exim does not try to deliver the message while you are
40293 fiddling with it. The safest way is to take out a write lock on the -D file,
40294 which is what Exim itself does, using &[fcntl()]&. If you update the file in
40295 place, the lock will be retained. If you write a new file and rename it, the
40296 lock will be lost at the instant of rename.
40297 .next
40298 .vindex "&$body_linecount$&"
40299 If you change the number of lines in the file, the value of
40300 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
40301 cause incomplete transmission of messages or undeliverable messages.
40302 .next
40303 If the message is in MIME format, you must take care not to break it.
40304 .next
40305 If the message is cryptographically signed, any change will invalidate the
40306 signature.
40307 .endlist
40308 All in all, modifying -D files is fraught with danger.
40309
40310 Files whose names end with -J may also be seen in the &_input_& directory (or
40311 its subdirectories when &%split_spool_directory%& is set). These are journal
40312 files, used to record addresses to which the message has been delivered during
40313 the course of a delivery attempt. If there are still undelivered recipients at
40314 the end, the -H file is updated, and the -J file is deleted. If, however, there
40315 is some kind of crash (for example, a power outage) before this happens, the -J
40316 file remains in existence. When Exim next processes the message, it notices the
40317 -J file and uses it to update the -H file before starting the next delivery
40318 attempt.
40319
40320 Files whose names end with -K or .eml may also be seen in the spool.
40321 These are temporaries used for DKIM or malware processing, when that is used.
40322 They should be tidied up by normal operations; any old ones are probably
40323 relics of crashes and can be removed.
40324
40325 .section "Format of the -H file" "SECID282"
40326 .cindex "uid (user id)" "in spool file"
40327 .cindex "gid (group id)" "in spool file"
40328 The second line of the -H file contains the login name for the uid of the
40329 process that called Exim to read the message, followed by the numerical uid and
40330 gid. For a locally generated message, this is normally the user who sent the
40331 message. For a message received over TCP/IP via the daemon, it is
40332 normally the Exim user.
40333
40334 The third line of the file contains the address of the message's sender as
40335 transmitted in the envelope, contained in angle brackets. The sender address is
40336 empty for bounce messages. For incoming SMTP mail, the sender address is given
40337 in the MAIL command. For locally generated mail, the sender address is
40338 created by Exim from the login name of the current user and the configured
40339 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
40340 leading &"From&~"& line if the caller is trusted, or if the supplied address is
40341 &"<>"& or an address that matches &%untrusted_set_senders%&.
40342
40343 The fourth line contains two numbers. The first is the time that the message
40344 was received, in the conventional Unix form &-- the number of seconds since the
40345 start of the epoch. The second number is a count of the number of messages
40346 warning of delayed delivery that have been sent to the sender.
40347
40348 There follow a number of lines starting with a hyphen. These can appear in any
40349 order, and are omitted when not relevant:
40350
40351 .vlist
40352 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
40353 This item is obsolete, and is not generated from Exim release 4.61 onwards;
40354 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
40355 recognized, to provide backward compatibility. In the old format, a line of
40356 this form is present for every ACL variable that is not empty. The number
40357 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
40358 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
40359 the data string for the variable. The string itself starts at the beginning of
40360 the next line, and is followed by a newline character. It may contain internal
40361 newlines.
40362
40363 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
40364 A line of this form is present for every ACL connection variable that is
40365 defined. Note that there is a space between &%-aclc%& and the rest of the name.
40366 The length is the length of the data string for the variable. The string itself
40367 starts at the beginning of the next line, and is followed by a newline
40368 character. It may contain internal newlines.
40369
40370 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
40371 A line of this form is present for every ACL message variable that is defined.
40372 Note that there is a space between &%-aclm%& and the rest of the name. The
40373 length is the length of the data string for the variable. The string itself
40374 starts at the beginning of the next line, and is followed by a newline
40375 character. It may contain internal newlines.
40376
40377 .vitem "&%-active_hostname%&&~<&'hostname'&>"
40378 This is present if, when the message was received over SMTP, the value of
40379 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
40380
40381 .vitem &%-allow_unqualified_recipient%&
40382 This is present if unqualified recipient addresses are permitted in header
40383 lines (to stop such addresses from being qualified if rewriting occurs at
40384 transport time). Local messages that were input using &%-bnq%& and remote
40385 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
40386
40387 .vitem &%-allow_unqualified_sender%&
40388 This is present if unqualified sender addresses are permitted in header lines
40389 (to stop such addresses from being qualified if rewriting occurs at transport
40390 time). Local messages that were input using &%-bnq%& and remote messages from
40391 hosts that match &%sender_unqualified_hosts%& set this flag.
40392
40393 .vitem "&%-auth_id%&&~<&'text'&>"
40394 The id information for a message received on an authenticated SMTP connection
40395 &-- the value of the &$authenticated_id$& variable.
40396
40397 .vitem "&%-auth_sender%&&~<&'address'&>"
40398 The address of an authenticated sender &-- the value of the
40399 &$authenticated_sender$& variable.
40400
40401 .vitem "&%-body_linecount%&&~<&'number'&>"
40402 This records the number of lines in the body of the message, and is
40403 present unless &%-spool_file_wireformat%& is.
40404
40405 .vitem "&%-body_zerocount%&&~<&'number'&>"
40406 This records the number of binary zero bytes in the body of the message, and is
40407 present if the number is greater than zero.
40408
40409 .vitem &%-deliver_firsttime%&
40410 This is written when a new message is first added to the spool. When the spool
40411 file is updated after a deferral, it is omitted.
40412
40413 .vitem "&%-frozen%&&~<&'time'&>"
40414 .cindex "frozen messages" "spool data"
40415 The message is frozen, and the freezing happened at <&'time'&>.
40416
40417 .vitem "&%-helo_name%&&~<&'text'&>"
40418 This records the host name as specified by a remote host in a HELO or EHLO
40419 command.
40420
40421 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
40422 This records the IP address of the host from which the message was received and
40423 the remote port number that was used. It is omitted for locally generated
40424 messages.
40425
40426 .vitem "&%-host_auth%&&~<&'text'&>"
40427 If the message was received on an authenticated SMTP connection, this records
40428 the name of the authenticator &-- the value of the
40429 &$sender_host_authenticated$& variable.
40430
40431 .vitem &%-host_lookup_failed%&
40432 This is present if an attempt to look up the sending host's name from its IP
40433 address failed. It corresponds to the &$host_lookup_failed$& variable.
40434
40435 .vitem "&%-host_name%&&~<&'text'&>"
40436 .cindex "reverse DNS lookup"
40437 .cindex "DNS" "reverse lookup"
40438 This records the name of the remote host from which the message was received,
40439 if the host name was looked up from the IP address when the message was being
40440 received. It is not present if no reverse lookup was done.
40441
40442 .vitem "&%-ident%&&~<&'text'&>"
40443 For locally submitted messages, this records the login of the originating user,
40444 unless it was a trusted user and the &%-oMt%& option was used to specify an
40445 ident value. For messages received over TCP/IP, this records the ident string
40446 supplied by the remote host, if any.
40447
40448 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
40449 This records the IP address of the local interface and the port number through
40450 which a message was received from a remote host. It is omitted for locally
40451 generated messages.
40452
40453 .vitem &%-local%&
40454 The message is from a local sender.
40455
40456 .vitem &%-localerror%&
40457 The message is a locally-generated bounce message.
40458
40459 .vitem "&%-local_scan%&&~<&'string'&>"
40460 This records the data string that was returned by the &[local_scan()]& function
40461 when the message was received &-- the value of the &$local_scan_data$&
40462 variable. It is omitted if no data was returned.
40463
40464 .vitem &%-manual_thaw%&
40465 The message was frozen but has been thawed manually, that is, by an explicit
40466 Exim command rather than via the auto-thaw process.
40467
40468 .vitem &%-N%&
40469 A testing delivery process was started using the &%-N%& option to suppress any
40470 actual deliveries, but delivery was deferred. At any further delivery attempts,
40471 &%-N%& is assumed.
40472
40473 .vitem &%-received_protocol%&
40474 This records the value of the &$received_protocol$& variable, which contains
40475 the name of the protocol by which the message was received.
40476
40477 .vitem &%-sender_set_untrusted%&
40478 The envelope sender of this message was set by an untrusted local caller (used
40479 to ensure that the caller is displayed in queue listings).
40480
40481 .vitem "&%-spam_score_int%&&~<&'number'&>"
40482 If a message was scanned by SpamAssassin, this is present. It records the value
40483 of &$spam_score_int$&.
40484
40485 .vitem &%-spool_file_wireformat%&
40486 The -D file for this message is in wire-format (for ESMTP CHUNKING)
40487 rather than Unix-format.
40488 The line-ending is CRLF rather than newline.
40489 There is still, however, no leading-dot-stuffing.
40490
40491 .vitem &%-tls_certificate_verified%&
40492 A TLS certificate was received from the client that sent this message, and the
40493 certificate was verified by the server.
40494
40495 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
40496 When the message was received over an encrypted connection, this records the
40497 name of the cipher suite that was used.
40498
40499 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
40500 When the message was received over an encrypted connection, and a certificate
40501 was received from the client, this records the Distinguished Name from that
40502 certificate.
40503 .endlist
40504
40505 Any of the above may have an extra hyphen prepended, to indicate the the
40506 corresponding data is untrusted.
40507
40508 Following the options there is a list of those addresses to which the message
40509 is not to be delivered. This set of addresses is initialized from the command
40510 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
40511 is set; otherwise it starts out empty. Whenever a successful delivery is made,
40512 the address is added to this set. The addresses are kept internally as a
40513 balanced binary tree, and it is a representation of that tree which is written
40514 to the spool file. If an address is expanded via an alias or forward file, the
40515 original address is added to the tree when deliveries to all its child
40516 addresses are complete.
40517
40518 If the tree is empty, there is a single line in the spool file containing just
40519 the text &"XX"&. Otherwise, each line consists of two letters, which are either
40520 Y or N, followed by an address. The address is the value for the node of the
40521 tree, and the letters indicate whether the node has a left branch and/or a
40522 right branch attached to it, respectively. If branches exist, they immediately
40523 follow. Here is an example of a three-node tree:
40524 .code
40525 YY darcy@austen.fict.example
40526 NN alice@wonderland.fict.example
40527 NN editor@thesaurus.ref.example
40528 .endd
40529 After the non-recipients tree, there is a list of the message's recipients.
40530 This is a simple list, preceded by a count. It includes all the original
40531 recipients of the message, including those to whom the message has already been
40532 delivered. In the simplest case, the list contains one address per line. For
40533 example:
40534 .code
40535 4
40536 editor@thesaurus.ref.example
40537 darcy@austen.fict.example
40538 rdo@foundation
40539 alice@wonderland.fict.example
40540 .endd
40541 However, when a child address has been added to the top-level addresses as a
40542 result of the use of the &%one_time%& option on a &(redirect)& router, each
40543 line is of the following form:
40544 .display
40545 <&'top-level address'&> <&'errors_to address'&> &&&
40546   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
40547 .endd
40548 The 01 flag bit indicates the presence of the three other fields that follow
40549 the top-level address. Other bits may be used in future to support additional
40550 fields. The <&'parent number'&> is the offset in the recipients list of the
40551 original parent of the &"one time"& address. The first two fields are the
40552 envelope sender that is associated with this address and its length. If the
40553 length is zero, there is no special envelope sender (there are then two space
40554 characters in the line). A non-empty field can arise from a &(redirect)& router
40555 that has an &%errors_to%& setting.
40556
40557
40558 A blank line separates the envelope and status information from the headers
40559 which follow. A header may occupy several lines of the file, and to save effort
40560 when reading it in, each header is preceded by a number and an identifying
40561 character. The number is the number of characters in the header, including any
40562 embedded newlines and the terminating newline. The character is one of the
40563 following:
40564
40565 .table2 50pt
40566 .row <&'blank'&>         "header in which Exim has no special interest"
40567 .row &`B`&               "&'Bcc:'& header"
40568 .row &`C`&               "&'Cc:'& header"
40569 .row &`F`&               "&'From:'& header"
40570 .row &`I`&               "&'Message-id:'& header"
40571 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
40572 .row &`R`&               "&'Reply-To:'& header"
40573 .row &`S`&               "&'Sender:'& header"
40574 .row &`T`&               "&'To:'& header"
40575 .row &`*`&               "replaced or deleted header"
40576 .endtable
40577
40578 Deleted or replaced (rewritten) headers remain in the spool file for debugging
40579 purposes. They are not transmitted when the message is delivered. Here is a
40580 typical set of headers:
40581 .code
40582 111P Received: by hobbit.fict.example with local (Exim 4.00)
40583 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
40584 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
40585 038* X-rewrote-sender: bb@hobbit.fict.example
40586 042* From: Bilbo Baggins <bb@hobbit.fict.example>
40587 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
40588 099* To: alice@wonderland.fict.example, rdo@foundation,
40589 darcy@austen.fict.example, editor@thesaurus.ref.example
40590 104T To: alice@wonderland.fict.example, rdo@foundation.example,
40591 darcy@austen.fict.example, editor@thesaurus.ref.example
40592 038  Date: Fri, 11 May 2001 10:28:59 +0100
40593 .endd
40594 The asterisked headers indicate that the envelope sender, &'From:'& header, and
40595 &'To:'& header have been rewritten, the last one because routing expanded the
40596 unqualified domain &'foundation'&.
40597 .ecindex IIDforspo1
40598 .ecindex IIDforspo2
40599 .ecindex IIDforspo3
40600
40601 .section "Format of the -D file" "SECID282a"
40602 The data file is traditionally in Unix-standard format: lines are ended with
40603 an ASCII newline character.
40604 However, when the &%spool_wireformat%& main option is used some -D files
40605 can have an alternate format.
40606 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
40607 The -D file lines (not including the first name-component line) are
40608 suitable for direct copying to the wire when transmitting using the
40609 ESMTP CHUNKING option, meaning lower processing overhead.
40610 Lines are terminated with an ASCII CRLF pair.
40611 There is no dot-stuffing (and no dot-termination).
40612
40613 . ////////////////////////////////////////////////////////////////////////////
40614 . ////////////////////////////////////////////////////////////////////////////
40615
40616 .chapter "DKIM, SPF, SRS and DMARC" "CHAPdkim" &&&
40617          "DKIM, SPF, SRS and DMARC Support"
40618
40619 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
40620 .cindex "DKIM"
40621
40622 DKIM is a mechanism by which messages sent by some entity can be provably
40623 linked to a domain which that entity controls.  It permits reputation to
40624 be tracked on a per-domain basis, rather than merely upon source IP address.
40625 DKIM is documented in RFC 6376.
40626
40627 As DKIM relies on the message being unchanged in transit, messages handled
40628 by a mailing-list (which traditionally adds to the message) will not match
40629 any original DKIM signature.
40630
40631 DKIM support is compiled into Exim by default if TLS support is present.
40632 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
40633
40634 Exim's DKIM implementation allows for
40635 .olist
40636 Signing outgoing messages: This function is implemented in the SMTP transport.
40637 It can co-exist with all other Exim features
40638 (including transport filters)
40639 except cutthrough delivery.
40640 .next
40641 Verifying signatures in incoming messages: This is implemented by an additional
40642 ACL (acl_smtp_dkim), which can be called several times per message, with
40643 different signature contexts.
40644 .endlist
40645
40646 In typical Exim style, the verification implementation does not include any
40647 default "policy". Instead it enables you to build your own policy using
40648 Exim's standard controls.
40649
40650 Please note that verification of DKIM signatures in incoming mail is turned
40651 on by default for logging (in the <= line) purposes.
40652
40653 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
40654 When set, for each signature in incoming email,
40655 exim will log a line displaying the most important signature details, and the
40656 signature status. Here is an example (with line-breaks added for clarity):
40657 .code
40658 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
40659     d=facebookmail.com s=q1-2009b
40660     c=relaxed/relaxed a=rsa-sha1
40661     i=@facebookmail.com t=1252484542 [verification succeeded]
40662 .endd
40663
40664 You might want to turn off DKIM verification processing entirely for internal
40665 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
40666 control modifier. This should typically be done in the RCPT ACL, at points
40667 where you accept mail from relay sources (internal hosts or authenticated
40668 senders).
40669
40670
40671 .section "Signing outgoing messages" "SECDKIMSIGN"
40672 .cindex "DKIM" "signing"
40673
40674 For signing to be usable you must have published a DKIM record in DNS.
40675 Note that RFC 8301 (which does not cover EC keys) says:
40676 .code
40677 rsa-sha1 MUST NOT be used for signing or verifying.
40678
40679 Signers MUST use RSA keys of at least 1024 bits for all keys.
40680 Signers SHOULD use RSA keys of at least 2048 bits.
40681 .endd
40682
40683 Note also that the key content (the 'p=' field)
40684 in the DNS record is different between RSA and EC keys;
40685 for the former it is the base64 of the ASN.1 for the RSA public key
40686 (equivalent to the private-key .pem with the header/trailer stripped)
40687 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
40688
40689 Signing is enabled by setting private options on the SMTP transport.
40690 These options take (expandable) strings as arguments.
40691
40692 .option dkim_domain smtp string list&!! unset
40693 The domain(s) you want to sign with.
40694 After expansion, this can be a list.
40695 Each element in turn,
40696 lowercased,
40697 is put into the &%$dkim_domain%& expansion variable
40698 while expanding the remaining signing options.
40699 If it is empty after expansion, DKIM signing is not done,
40700 and no error will result even if &%dkim_strict%& is set.
40701
40702 .option dkim_selector smtp string list&!! unset
40703 This sets the key selector string.
40704 After expansion, which can use &$dkim_domain$&, this can be a list.
40705 Each element in turn is put in the expansion
40706 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
40707 option along with &%$dkim_domain%&.
40708 If the option is empty after expansion, DKIM signing is not done for this domain,
40709 and no error will result even if &%dkim_strict%& is set.
40710
40711 .option dkim_private_key smtp string&!! unset
40712 This sets the private key to use.
40713 You can use the &%$dkim_domain%& and
40714 &%$dkim_selector%& expansion variables to determine the private key to use.
40715 The result can either
40716 .ilist
40717 be a valid RSA private key in ASCII armor (.pem file), including line breaks
40718 .next
40719 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
40720 be a valid Ed25519 private key (same format as above)
40721 .next
40722 start with a slash, in which case it is treated as a file that contains
40723 the private key
40724 .next
40725 be "0", "false" or the empty string, in which case the message will not
40726 be signed. This case will not result in an error, even if &%dkim_strict%&
40727 is set.
40728 .endlist
40729
40730 To generate keys under OpenSSL:
40731 .code
40732 openssl genrsa -out dkim_rsa.private 2048
40733 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
40734 .endd
40735 The result file from the first command should be retained, and
40736 this option set to use it.
40737 Take the base-64 lines from the output of the second command, concatenated,
40738 for the DNS TXT record.
40739 See section 3.6 of RFC6376 for the record specification.
40740
40741 Under GnuTLS:
40742 .code
40743 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
40744 certtool --load-privkey=dkim_rsa.private --pubkey-info
40745 .endd
40746
40747 Note that RFC 8301 says:
40748 .code
40749 Signers MUST use RSA keys of at least 1024 bits for all keys.
40750 Signers SHOULD use RSA keys of at least 2048 bits.
40751 .endd
40752
40753 EC keys for DKIM are defined by RFC 8463.
40754 They are considerably smaller than RSA keys for equivalent protection.
40755 As they are a recent development, users should consider dual-signing
40756 (by setting a list of selectors, and an expansion for this option)
40757 for some transition period.
40758 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
40759 for EC keys.
40760
40761 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
40762 .code
40763 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
40764 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
40765 .endd
40766
40767 To produce the required public key value for a DNS record:
40768 .code
40769 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
40770 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
40771 .endd
40772
40773 Exim also supports an alternate format
40774 of Ed25519 keys in DNS which was a candidate during development
40775 of the standard, but not adopted.
40776 A future release will probably drop that support.
40777
40778 .option dkim_hash smtp string&!! sha256
40779 Can be set to any one of the supported hash methods, which are:
40780 .ilist
40781 &`sha1`& &-- should not be used, is old and insecure
40782 .next
40783 &`sha256`& &-- the default
40784 .next
40785 &`sha512`& &-- possibly more secure but less well supported
40786 .endlist
40787
40788 Note that RFC 8301 says:
40789 .code
40790 rsa-sha1 MUST NOT be used for signing or verifying.
40791 .endd
40792
40793 .option dkim_identity smtp string&!! unset
40794 If set after expansion, the value is used to set an "i=" tag in
40795 the signing header.  The DKIM standards restrict the permissible
40796 syntax of this optional tag to a mail address, with possibly-empty
40797 local part, an @, and a domain identical to or subdomain of the "d="
40798 tag value.  Note that Exim does not check the value.
40799
40800 .option dkim_canon smtp string&!! unset
40801 This option sets the canonicalization method used when signing a message.
40802 The DKIM RFC currently supports two methods: "simple" and "relaxed".
40803 The option defaults to "relaxed" when unset. Note: the current implementation
40804 only supports signing with the same canonicalization method for both headers and body.
40805
40806 .option dkim_strict smtp string&!! unset
40807 This  option  defines  how  Exim  behaves  when  signing a message that
40808 should be signed fails for some reason.  When the expansion evaluates to
40809 either &"1"& or &"true"&, Exim will defer. Otherwise Exim will send the message
40810 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
40811 variables here.
40812
40813 .option dkim_sign_headers smtp string&!! "see below"
40814 If set, this option must expand to a colon-separated
40815 list of header names.
40816 Headers with these names, or the absence or such a header, will be included
40817 in the message signature.
40818 When unspecified, the header names listed in RFC4871 will be used,
40819 whether or not each header is present in the message.
40820 The default list is available for the expansion in the macro
40821 &"_DKIM_SIGN_HEADERS"&
40822 and an oversigning variant is in &"_DKIM_OVERSIGN_HEADERS"&.
40823
40824 If a name is repeated, multiple headers by that name (or the absence thereof)
40825 will be signed.  The textually later headers in the headers part of the
40826 message are signed first, if there are multiples.
40827
40828 A name can be prefixed with either an &"="& or a &"+"& character.
40829 If an &"="& prefix is used, all headers that are present with this name
40830 will be signed.
40831 If a &"+"& prefix if used, all headers that are present with this name
40832 will be signed, and one signature added for a missing header with the
40833 name will be appended.
40834
40835 .option dkim_timestamps smtp integer&!! unset
40836 This option controls the inclusion of timestamp information in the signature.
40837 If not set, no such information will be included.
40838 Otherwise, must be an unsigned number giving an offset in seconds from the current time
40839 for the expiry tag
40840 (eg. 1209600 for two weeks);
40841 both creation (t=) and expiry (x=) tags will be included.
40842
40843 RFC 6376 lists these tags as RECOMMENDED.
40844
40845
40846 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
40847 .cindex "DKIM" "verification"
40848
40849 Verification of DKIM signatures in SMTP incoming email is done for all
40850 messages for which an ACL control &%dkim_disable_verify%& has not been set.
40851 .cindex DKIM "selecting signature algorithms"
40852 Individual classes of signature algorithm can be ignored by changing
40853 the main options &%dkim_verify_hashes%& or &%dkim_verify_keytypes%&.
40854 The &%dkim_verify_minimal%& option can be set to cease verification
40855 processing for a message once the first passing signature is found.
40856
40857 .cindex authentication "expansion item"
40858 Performing verification sets up information used by the
40859 &%authresults%& expansion item.
40860
40861 For most purposes the default option settings suffice and the remainder
40862 of this section can be ignored.
40863
40864 The results of verification are made available to the
40865 &%acl_smtp_dkim%& ACL, which can examine and modify them.
40866 A missing ACL definition defaults to accept.
40867 By default, the ACL is called once for each
40868 syntactically(!) correct signature in the incoming message.
40869 If any ACL call does not accept, the message is not accepted.
40870 If a cutthrough delivery was in progress for the message, that is
40871 summarily dropped (having wasted the transmission effort).
40872
40873 To evaluate the verification result in the ACL
40874 a large number of expansion variables
40875 containing the signature status and its details are set up during the
40876 runtime of the ACL.
40877
40878 Calling the ACL only for existing signatures is not sufficient to build
40879 more advanced policies. For that reason, the main option
40880 &%dkim_verify_signers%&, and an expansion variable
40881 &%$dkim_signers%& exist.
40882
40883 The main option &%dkim_verify_signers%& can be set to a colon-separated
40884 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
40885 called. It is expanded when the message has been received. At this point,
40886 the expansion variable &%$dkim_signers%& already contains a colon-separated
40887 list of signer domains and identities for the message. When
40888 &%dkim_verify_signers%& is not specified in the main configuration,
40889 it defaults as:
40890 .code
40891 dkim_verify_signers = $dkim_signers
40892 .endd
40893 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
40894 DKIM signature in the message. Current DKIM verifiers may want to explicitly
40895 call the ACL for known domains or identities. This would be achieved as follows:
40896 .code
40897 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
40898 .endd
40899 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
40900 and "ebay.com", plus all domains and identities that have signatures in the message.
40901 You can also be more creative in constructing your policy. For example:
40902 .code
40903 dkim_verify_signers = $sender_address_domain:$dkim_signers
40904 .endd
40905
40906 If a domain or identity is listed several times in the (expanded) value of
40907 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
40908
40909 Note that if the option is set using untrustworthy data
40910 (such as the From: header)
40911 care should be taken to force lowercase for domains
40912 and for the domain part if identities.
40913 The default setting can be regarded as trustworthy in this respect.
40914
40915 If multiple signatures match a domain (or identity), the ACL is called once
40916 for each matching signature.
40917
40918
40919 Inside the DKIM ACL, the following expansion variables are
40920 available (from most to least important):
40921
40922
40923 .vlist
40924 .vitem &%$dkim_cur_signer%&
40925 The signer that is being evaluated in this ACL run. This can be a domain or
40926 an identity. This is one of the list items from the expanded main option
40927 &%dkim_verify_signers%& (see above).
40928
40929 .vitem &%$dkim_verify_status%&
40930 Within the DKIM ACL,
40931 a string describing the general status of the signature. One of
40932 .ilist
40933 &%none%&: There is no signature in the message for the current domain or
40934 identity (as reflected by &%$dkim_cur_signer%&).
40935 .next
40936 &%invalid%&: The signature could not be verified due to a processing error.
40937 More detail is available in &%$dkim_verify_reason%&.
40938 .next
40939 &%fail%&: Verification of the signature failed.  More detail is
40940 available in &%$dkim_verify_reason%&.
40941 .next
40942 &%pass%&: The signature passed verification. It is valid.
40943 .endlist
40944
40945 This variable can be overwritten using an ACL 'set' modifier.
40946 This might, for instance, be done to enforce a policy restriction on
40947 hash-method or key-size:
40948 .code
40949   warn condition       = ${if eq {$dkim_verify_status}{pass}}
40950        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
40951        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
40952                                   {< {$dkim_key_length}{1024}}}}
40953        logwrite        = NOTE: forcing DKIM verify fail (was pass)
40954        set dkim_verify_status = fail
40955        set dkim_verify_reason = hash too weak or key too short
40956 .endd
40957
40958 So long as a DKIM ACL is defined (it need do no more than accept),
40959 after all the DKIM ACL runs have completed, the value becomes a
40960 colon-separated list of the values after each run.
40961 This is maintained for the mime, prdr and data ACLs.
40962
40963 .vitem &%$dkim_verify_reason%&
40964 A string giving a little bit more detail when &%$dkim_verify_status%& is either
40965 "fail" or "invalid". One of
40966 .ilist
40967 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
40968 key for the domain could not be retrieved. This may be a temporary problem.
40969 .next
40970 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
40971 record for the domain is syntactically invalid.
40972 .next
40973 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
40974 body hash does not match the one specified in the signature header. This
40975 means that the message body was modified in transit.
40976 .next
40977 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
40978 could not be verified. This may mean that headers were modified,
40979 re-written or otherwise changed in a way which is incompatible with
40980 DKIM verification. It may of course also mean that the signature is forged.
40981 .endlist
40982
40983 This variable can be overwritten, with any value, using an ACL 'set' modifier.
40984
40985 .vitem &%$dkim_domain%&
40986 The signing domain. IMPORTANT: This variable is only populated if there is
40987 an actual signature in the message for the current domain or identity (as
40988 reflected by &%$dkim_cur_signer%&).
40989
40990 .vitem &%$dkim_identity%&
40991 The signing identity, if present. IMPORTANT: This variable is only populated
40992 if there is an actual signature in the message for the current domain or
40993 identity (as reflected by &%$dkim_cur_signer%&).
40994
40995 .vitem &%$dkim_selector%&
40996 The key record selector string.
40997
40998 .vitem &%$dkim_algo%&
40999 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
41000 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
41001 may also be 'ed25519-sha256'.
41002 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
41003 for EC keys.
41004
41005 Note that RFC 8301 says:
41006 .code
41007 rsa-sha1 MUST NOT be used for signing or verifying.
41008
41009 DKIM signatures identified as having been signed with historic
41010 algorithms (currently, rsa-sha1) have permanently failed evaluation
41011 .endd
41012
41013 To enforce this you must either have a DKIM ACL which checks this variable
41014 and overwrites the &$dkim_verify_status$& variable as discussed above,
41015 or have set the main option &%dkim_verify_hashes%& to exclude
41016 processing of such signatures.
41017
41018 .vitem &%$dkim_canon_body%&
41019 The body canonicalization method. One of 'relaxed' or 'simple'.
41020
41021 .vitem &%$dkim_canon_headers%&
41022 The header canonicalization method. One of 'relaxed' or 'simple'.
41023
41024 .vitem &%$dkim_copiedheaders%&
41025 A transcript of headers and their values which are included in the signature
41026 (copied from the 'z=' tag of the signature).
41027 Note that RFC6376 requires that verification fail if the From: header is
41028 not included in the signature.  Exim does not enforce this; sites wishing
41029 strict enforcement should code the check explicitly.
41030
41031 .vitem &%$dkim_bodylength%&
41032 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
41033 limit was set by the signer, "9999999999999" is returned. This makes sure
41034 that this variable always expands to an integer value.
41035 &*Note:*& The presence of the signature tag specifying a signing body length
41036 is one possible route to spoofing of valid DKIM signatures.
41037 A paranoid implementation might wish to regard signature where this variable
41038 shows less than the "no limit" return as being invalid.
41039
41040 .vitem &%$dkim_created%&
41041 UNIX timestamp reflecting the date and time when the signature was created.
41042 When this was not specified by the signer, "0" is returned.
41043
41044 .vitem &%$dkim_expires%&
41045 UNIX timestamp reflecting the date and time when the signer wants the
41046 signature to be treated as "expired". When this was not specified by the
41047 signer, "9999999999999" is returned. This makes it possible to do useful
41048 integer size comparisons against this value.
41049 Note that Exim does not check this value.
41050
41051 .vitem &%$dkim_headernames%&
41052 A colon-separated list of names of headers included in the signature.
41053
41054 .vitem &%$dkim_key_testing%&
41055 "1" if the key record has the "testing" flag set, "0" if not.
41056
41057 .vitem &%$dkim_key_nosubdomains%&
41058 "1" if the key record forbids subdomaining, "0" otherwise.
41059
41060 .vitem &%$dkim_key_srvtype%&
41061 Service type (tag s=) from the key record. Defaults to "*" if not specified
41062 in the key record.
41063
41064 .vitem &%$dkim_key_granularity%&
41065 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
41066 in the key record.
41067
41068 .vitem &%$dkim_key_notes%&
41069 Notes from the key record (tag n=).
41070
41071 .vitem &%$dkim_key_length%&
41072 Number of bits in the key.
41073 Valid only once the key is loaded, which is at the time the header signature
41074 is verified, which is after the body hash is.
41075
41076 Note that RFC 8301 says:
41077 .code
41078 Verifiers MUST NOT consider signatures using RSA keys of
41079 less than 1024 bits as valid signatures.
41080 .endd
41081
41082 This is enforced by the default setting for the &%dkim_verify_min_keysizes%&
41083 option.
41084
41085 .endlist
41086
41087 In addition, two ACL conditions are provided:
41088
41089 .vlist
41090 .vitem &%dkim_signers%&
41091 ACL condition that checks a colon-separated list of domains or identities
41092 for a match against the domain or identity that the ACL is currently verifying
41093 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
41094 verb to a group of domains or identities. For example:
41095
41096 .code
41097 # Warn when Mail purportedly from GMail has no gmail signature
41098 warn sender_domains = gmail.com
41099      dkim_signers = gmail.com
41100      dkim_status = none
41101      log_message = GMail sender without gmail.com DKIM signature
41102 .endd
41103
41104 Note that the above does not check for a total lack of DKIM signing;
41105 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
41106
41107 .vitem &%dkim_status%&
41108 ACL condition that checks a colon-separated list of possible DKIM verification
41109 results against the actual result of verification. This is typically used
41110 to restrict an ACL verb to a list of verification outcomes, for example:
41111
41112 .code
41113 deny sender_domains = paypal.com:paypal.de
41114      dkim_signers = paypal.com:paypal.de
41115      dkim_status = none:invalid:fail
41116      message = Mail from Paypal with invalid/missing signature
41117 .endd
41118
41119 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
41120 see the documentation of the &%$dkim_verify_status%& expansion variable above
41121 for more information of what they mean.
41122 .endlist
41123
41124
41125
41126
41127 .section "SPF (Sender Policy Framework)" SECSPF
41128 .cindex SPF verification
41129
41130 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
41131 messages with its domain in the envelope from, documented by RFC 7208.
41132 For more information on SPF see &url(http://www.open-spf.org), a static copy of
41133 the &url(http://openspf.org).
41134 . --- 2019-10-28: still not https, open-spf.org is told to be a
41135 . --- web-archive copy of the now dead openspf.org site
41136 . --- See https://www.mail-archive.com/mailop@mailop.org/msg08019.html for a
41137 . --- discussion.
41138
41139 Messages sent by a system not authorised will fail checking of such assertions.
41140 This includes retransmissions done by traditional forwarders.
41141
41142 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
41143 &_Local/Makefile_&.  The support uses the &_libspf2_& library
41144 &url(https://www.libspf2.org/).
41145 There is no Exim involvement in the transmission of messages;
41146 publishing certain DNS records is all that is required.
41147
41148 For verification, an ACL condition and an expansion lookup are provided.
41149 .cindex authentication "expansion item"
41150 Performing verification sets up information used by the
41151 &%authresults%& expansion item.
41152
41153
41154 .cindex SPF "ACL condition"
41155 .cindex ACL "spf condition"
41156 The ACL condition "spf" can be used at or after the MAIL ACL.
41157 It takes as an argument a list of strings giving the outcome of the SPF check,
41158 and will succeed for any matching outcome.
41159 Valid strings are:
41160 .vlist
41161 .vitem &%pass%&
41162 The SPF check passed, the sending host is positively verified by SPF.
41163
41164 .vitem &%fail%&
41165 The SPF check failed, the sending host is NOT allowed to send mail for the
41166 domain in the envelope-from address.
41167
41168 .vitem &%softfail%&
41169 The SPF check failed, but the queried domain can't absolutely confirm that this
41170 is a forgery.
41171
41172 .vitem &%none%&
41173 The queried domain does not publish SPF records.
41174
41175 .vitem &%neutral%&
41176 The SPF check returned a "neutral" state.  This means the queried domain has
41177 published a SPF record, but wants to allow outside servers to send mail under
41178 its domain as well.  This should be treated like "none".
41179
41180 .vitem &%permerror%&
41181 This indicates a syntax error in the SPF record of the queried domain.
41182 You may deny messages when this occurs.
41183
41184 .vitem &%temperror%&
41185 This indicates a temporary error during all processing, including Exim's
41186 SPF processing.  You may defer messages when this occurs.
41187 .endlist
41188
41189 You can prefix each string with an exclamation mark to  invert
41190 its meaning,  for example  "!fail" will  match all  results but
41191 "fail".  The  string  list is  evaluated  left-to-right,  in a
41192 short-circuit fashion.
41193
41194 Example:
41195 .code
41196 deny spf = fail
41197      message = $sender_host_address is not allowed to send mail from \
41198                ${if def:sender_address_domain \
41199                     {$sender_address_domain}{$sender_helo_name}}.  \
41200                Please see http://www.open-spf.org/Why;\
41201                identity=${if def:sender_address_domain \
41202                              {$sender_address}{$sender_helo_name}};\
41203                ip=$sender_host_address
41204 .endd
41205
41206 Note: The above mentioned URL may not be as helpful as expected. You are
41207 encouraged to replace the link with a link to a site with more
41208 explanations.
41209
41210 When the spf condition has run, it sets up several expansion
41211 variables:
41212
41213 .cindex SPF "verification variables"
41214 .vlist
41215 .vitem &$spf_header_comment$&
41216 .vindex &$spf_header_comment$&
41217   This contains a human-readable string describing the outcome
41218   of the SPF check. You can add it to a custom header or use
41219   it for logging purposes.
41220
41221 .vitem &$spf_received$&
41222 .vindex &$spf_received$&
41223   This contains a complete Received-SPF: header that can be
41224   added to the message. Please note that according to the SPF
41225   draft, this header must be added at the top of the header
41226   list. Please see section 10 on how you can do this.
41227
41228   Note: in case of "Best-guess" (see below), the convention is
41229   to put this string in a header called X-SPF-Guess: instead.
41230
41231 .vitem &$spf_result$&
41232 .vindex &$spf_result$&
41233   This contains the outcome of the SPF check in string form,
41234   one of pass, fail, softfail, none, neutral, permerror or
41235   temperror.
41236
41237 .vitem &$spf_result_guessed$&
41238 .vindex &$spf_result_guessed$&
41239   This boolean is true only if a best-guess operation was used
41240   and required in order to obtain a result.
41241
41242 .vitem &$spf_smtp_comment$&
41243 .vindex &$spf_smtp_comment$&
41244 .vindex &%spf_smtp_comment_template%&
41245   This contains a string that can be used in a SMTP response
41246   to the calling party. Useful for "fail".
41247   The string is generated by the SPF library from the template configured in the main config
41248   option &%spf_smtp_comment_template%&.
41249 .endlist
41250
41251
41252 .cindex SPF "ACL condition"
41253 .cindex ACL "spf_guess condition"
41254 .cindex SPF "best guess"
41255 In addition to SPF, you can also perform checks for so-called
41256 "Best-guess".  Strictly speaking, "Best-guess" is not standard
41257 SPF, but it is supported by the same framework that enables SPF
41258 capability.
41259 Refer to &url(http://www.open-spf.org/FAQ/Best_guess_record)
41260 for a description of what it means.
41261 . --- 2019-10-28: still not https:
41262
41263 To access this feature, simply use the spf_guess condition in place
41264 of the spf one.  For example:
41265
41266 .code
41267 deny spf_guess = fail
41268      message = $sender_host_address doesn't look trustworthy to me
41269 .endd
41270
41271 In case you decide to reject messages based on this check, you
41272 should note that although it uses the same framework, "Best-guess"
41273 is not SPF, and therefore you should not mention SPF at all in your
41274 reject message.
41275
41276 When the spf_guess condition has run, it sets up the same expansion
41277 variables as when spf condition is run, described above.
41278
41279 Additionally, since Best-guess is not standardized, you may redefine
41280 what "Best-guess" means to you by redefining the main configuration
41281 &%spf_guess%& option.
41282 For example, the following:
41283
41284 .code
41285 spf_guess = v=spf1 a/16 mx/16 ptr ?all
41286 .endd
41287
41288 would relax host matching rules to a broader network range.
41289
41290
41291 .cindex SPF "lookup expansion"
41292 .cindex lookup spf
41293 A lookup expansion is also available. It takes an email
41294 address as the key and an IP address
41295 (v4 or v6)
41296 as the database:
41297
41298 .code
41299   ${lookup {username@domain} spf {ip.ip.ip.ip}}
41300 .endd
41301
41302 The lookup will return the same result strings as can appear in
41303 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
41304
41305
41306
41307
41308
41309 .section "SRS (Sender Rewriting Scheme)" SECTSRS
41310 .cindex SRS "sender rewriting scheme"
41311
41312 .new
41313 SRS can be used to modify sender addresses when forwarding so that
41314 SPF verification does not object to them.
41315 It operates by encoding the original envelope sender in a new
41316 sender local part and using a domain run by the forwarding site
41317 as the new domain for the sender.  Any DSN message should be returned
41318 to this new sender at the forwarding site, which can extract the
41319 original sender from the coded local part and forward the DSN to
41320 the originator.
41321
41322 This is a way of avoiding the breakage that SPF does to forwarding.
41323 The constructed local-part will be longer than the original,
41324 leading to possible problems with very long addresses.
41325 The changing of the sender address also hinders the tracing of mail
41326 problems.
41327
41328 Exim can be built to include native SRS support.  To do this
41329 SUPPORT_SRS=yes must be defined in &_Local/Makefile_&.
41330 If this has been done, the macros _HAVE_SRS and _HAVE_NATIVE_SRS
41331 will be defined.
41332 The support is limited to SRS0-encoding; SRS1 is not supported.
41333
41334 .cindex SRS excoding
41335 To encode an address use this expansion item:
41336 .vlist
41337 .vitem &*${srs_encode&~{*&<&'secret'&>&*}{*&<&'return&~path'&>&*}{*&<&'original&~domain'&>&*}}*&
41338 .cindex "&%srs_encode%& expansion item"
41339 .cindex SRS "expansion item"
41340 The first argument should be a secret known and used by all systems
41341 handling the recipient domain for the original message.
41342 There is no need to periodically change this key; a timestamp is also
41343 encoded.
41344 The second argument should be given as the envelope sender address before this
41345 encoding operation.
41346 The third argument should be the recipient domain of the message when
41347 it arrived at this system.
41348 .endlist
41349
41350 .cindex SRS decoding
41351 To decode an address use this expansion condition:
41352 .vlist
41353 .vitem &*inbound_srs&~{*&<&'local&~part'&>&*}{*&<&'secret'&>&*}*&
41354 The first argument should be the recipient local prt as is was received.
41355 The second argument is the site secret.
41356
41357 If the messages is not for an SRS-encoded recipient the condition will
41358 return false.  If it is, the condition will return true and the variable
41359 &$srs_recipient$& will be set to the decoded (original) value.
41360 .endlist
41361
41362 Example usage:
41363 .code
41364   #macro
41365   SRS_SECRET = <pick something unique for your site for this. Use on all MXs.>
41366   
41367   #routers
41368
41369   outbound:
41370     driver =    dnslookup
41371     # if outbound, and forwarding has been done, use an alternate transport
41372     domains =   ! +my_domains
41373     transport = ${if eq {$local_part@$domain} \
41374                         {$original_local_part@$original_domain} \
41375                      {remote_smtp} {remote_forwarded_smtp}}
41376   
41377   inbound_srs:
41378     driver =    redirect
41379     senders =   :
41380     domains =   +my_domains
41381     # detect inbound bounces which are SRS'd, and decode them
41382     condition = ${if inbound_srs {$local_part} {SRS_SECRET}}
41383     data =      $srs_recipient
41384   
41385   inbound_srs_failure:
41386     driver =    redirect
41387     senders =   :
41388     domains =   +my_domains
41389     # detect inbound bounces which look SRS'd but are invalid
41390     condition = ${if inbound_srs {$local_part} {}}
41391     allow_fail
41392     data =      :fail: Invalid SRS recipient address
41393
41394   #... further routers here
41395
41396   
41397   # transport; should look like the non-forward outbound
41398   # one, plus the max_rcpt and return_path options
41399   remote_forwarded_smtp:
41400     driver =              smtp
41401     # modify the envelope from, for mails that we forward
41402     max_rcpt =            1
41403     return_path =         ${srs_encode {SRS_SECRET} {$return_path} {$original_domain}}
41404 .endd
41405
41406
41407 .wen
41408
41409
41410
41411 .section DMARC SECDMARC
41412 .cindex DMARC verification
41413
41414 DMARC combines feedback from SPF, DKIM, and header From: in order
41415 to attempt to provide better indicators of the authenticity of an
41416 email.  This document does not explain the fundamentals; you
41417 should read and understand how it works by visiting the website at
41418 &url(http://www.dmarc.org/).
41419
41420 If Exim is built with DMARC support,
41421 the libopendmarc library is used.
41422
41423 For building Exim yourself, obtain the library from
41424 &url(http://sourceforge.net/projects/opendmarc/)
41425 to obtain a copy, or find it in your favorite package
41426 repository.  You will need to attend to the local/Makefile feature
41427 SUPPORT_DMARC and the associated LDFLAGS addition.
41428 This description assumes
41429 that headers will be in /usr/local/include, and that the libraries
41430 are in /usr/local/lib.
41431
41432 . subsection
41433
41434 There are three main-configuration options:
41435 .cindex DMARC "configuration options"
41436
41437 The &%dmarc_tld_file%& option
41438 .oindex &%dmarc_tld_file%&
41439 defines the location of a text file of valid
41440 top level domains the opendmarc library uses
41441 during domain parsing. Maintained by Mozilla,
41442 the most current version can be downloaded
41443 from a link at &url(https://publicsuffix.org/list/public_suffix_list.dat).
41444 See also the util/renew-opendmarc-tlds.sh script.
41445 The default for the option is unset.
41446 If not set, DMARC processing is disabled.
41447
41448
41449 The &%dmarc_history_file%& option, if set
41450 .oindex &%dmarc_history_file%&
41451 defines the location of a file to log results
41452 of dmarc verification on inbound emails. The
41453 contents are importable by the opendmarc tools
41454 which will manage the data, send out DMARC
41455 reports, and expire the data. Make sure the
41456 directory of this file is writable by the user
41457 exim runs as.
41458 The default is unset.
41459
41460 The &%dmarc_forensic_sender%& option
41461 .oindex &%dmarc_forensic_sender%&
41462 defines an alternate email address to use when sending a
41463 forensic report detailing alignment failures
41464 if a sender domain's dmarc record specifies it
41465 and you have configured Exim to send them.
41466 If set, this is expanded and used for the
41467 From: header line; the address is extracted
41468 from it and used for the envelope from.
41469 If not set (the default), the From: header is expanded from
41470 the dsn_from option, and <> is used for the
41471 envelope from.
41472
41473 . I wish we had subsections...
41474
41475 .cindex DMARC controls
41476 By default, the DMARC processing will run for any remote,
41477 non-authenticated user.  It makes sense to only verify DMARC
41478 status of messages coming from remote, untrusted sources.  You can
41479 use standard conditions such as hosts, senders, etc, to decide that
41480 DMARC verification should *not* be performed for them and disable
41481 DMARC with an ACL control modifier:
41482 .code
41483   control = dmarc_disable_verify
41484 .endd
41485 A DMARC record can also specify a "forensic address", which gives
41486 exim an email address to submit reports about failed alignment.
41487 Exim does not do this by default because in certain conditions it
41488 results in unintended information leakage (what lists a user might
41489 be subscribed to, etc).  You must configure exim to submit forensic
41490 reports to the owner of the domain.  If the DMARC record contains a
41491 forensic address and you specify the control statement below, then
41492 exim will send these forensic emails.  It is also advised that you
41493 configure a &%dmarc_forensic_sender%& because the default sender address
41494 construction might be inadequate.
41495 .code
41496   control = dmarc_enable_forensic
41497 .endd
41498 (AGAIN: You can choose not to send these forensic reports by simply
41499 not putting the dmarc_enable_forensic control line at any point in
41500 your exim config.  If you don't tell exim to send them, it will not
41501 send them.)
41502
41503 There are no options to either control.  Both must appear before
41504 the DATA acl.
41505
41506 . subsection
41507
41508 DMARC checks cam be run on incoming SMTP  messages by using the
41509 &"dmarc_status"& ACL condition in the DATA ACL.  You are required to
41510 call the &"spf"& condition first in the ACLs, then the &"dmarc_status"&
41511 condition.  Putting this condition in the ACLs is required in order
41512 for a DMARC check to actually occur.  All of the variables are set
41513 up before the DATA ACL, but there is no actual DMARC check that
41514 occurs until a &"dmarc_status"& condition is encountered in the ACLs.
41515
41516 The &"dmarc_status"& condition takes a list of strings on its
41517 right-hand side.  These strings describe recommended action based
41518 on the DMARC check.  To understand what the policy recommendations
41519 mean, refer to the DMARC website above.  Valid strings are:
41520 .display
41521 &'accept      '& The DMARC check passed and the library recommends accepting the email.
41522 &'reject      '& The DMARC check failed and the library recommends rejecting the email.
41523 &'quarantine  '& The DMARC check failed and the library recommends keeping it for further inspection.
41524 &'none        '& The DMARC check passed and the library recommends no specific action, neutral.
41525 &'norecord    '& No policy section in the DMARC record for this sender domain.
41526 &'nofrom      '& Unable to determine the domain of the sender.
41527 &'temperror   '& Library error or dns error.
41528 &'off         '& The DMARC check was disabled for this email.
41529 .endd
41530 You can prefix each string with an exclamation mark to invert its
41531 meaning, for example "!accept" will match all results but
41532 "accept".  The string list is evaluated left-to-right in a
41533 short-circuit fashion.  When a string matches the outcome of the
41534 DMARC check, the condition succeeds.  If none of the listed
41535 strings matches the outcome of the DMARC check, the condition
41536 fails.
41537
41538 Of course, you can also use any other lookup method that Exim
41539 supports, including LDAP, Postgres, MySQL, etc, as long as the
41540 result is a list of colon-separated strings.
41541
41542 Performing the check sets up information used by the
41543 &%authresults%& expansion item.
41544
41545 Several expansion variables are set before the DATA ACL is
41546 processed, and you can use them in this ACL.  The following
41547 expansion variables are available:
41548
41549 .vlist
41550 .vitem &$dmarc_status$&
41551 .vindex &$dmarc_status$&
41552 .cindex DMARC result
41553 A one word status indicating what the DMARC library
41554 thinks of the email.  It is a combination of the results of
41555 DMARC record lookup and the SPF/DKIM/DMARC processing results
41556 (if a DMARC record was found).  The actual policy declared
41557 in the DMARC record is in a separate expansion variable.
41558
41559 .vitem &$dmarc_status_text$&
41560 .vindex &$dmarc_status_text$&
41561 Slightly longer, human readable status.
41562
41563 .vitem &$dmarc_used_domain$&
41564 .vindex &$dmarc_used_domain$&
41565 The domain which DMARC used to look up the DMARC policy record.
41566
41567 .vitem &$dmarc_domain_policy$&
41568 .vindex &$dmarc_domain_policy$&
41569 The policy declared in the DMARC record.  Valid values
41570 are "none", "reject" and "quarantine".  It is blank when there
41571 is any error, including no DMARC record.
41572 .endlist
41573
41574 . subsection
41575
41576 By default, Exim's DMARC configuration is intended to be
41577 non-intrusive and conservative.  To facilitate this, Exim will not
41578 create any type of logging files without explicit configuration by
41579 you, the admin.  Nor will Exim send out any emails/reports about
41580 DMARC issues without explicit configuration by you, the admin (other
41581 than typical bounce messages that may come about due to ACL
41582 processing or failure delivery issues).
41583
41584 In order to log statistics suitable to be imported by the opendmarc
41585 tools, you need to:
41586 .ilist
41587 Configure the global option &%dmarc_history_file%&
41588 .next
41589 Configure cron jobs to call the appropriate opendmarc history
41590 import scripts and truncating the dmarc_history_file
41591 .endlist
41592
41593 In order to send forensic reports, you need to:
41594 .ilist
41595 Configure the global option &%dmarc_forensic_sender%&
41596 .next
41597 Configure, somewhere before the DATA ACL, the control option to
41598 enable sending DMARC forensic reports
41599 .endlist
41600
41601 . subsection
41602
41603 Example usage:
41604 .code
41605 (RCPT ACL)
41606   warn    domains        = +local_domains
41607           hosts          = +local_hosts
41608           control        = dmarc_disable_verify
41609
41610   warn    !domains       = +screwed_up_dmarc_records
41611           control        = dmarc_enable_forensic
41612
41613   warn    condition      = (lookup if destined to mailing list)
41614           set acl_m_mailing_list = 1
41615
41616 (DATA ACL)
41617   warn    dmarc_status   = accept : none : off
41618           !authenticated = *
41619           log_message    = DMARC DEBUG: $dmarc_status $dmarc_used_domain
41620
41621   warn    dmarc_status   = !accept
41622           !authenticated = *
41623           log_message    = DMARC DEBUG: '$dmarc_status' for $dmarc_used_domain
41624
41625   warn    dmarc_status   = quarantine
41626           !authenticated = *
41627           set $acl_m_quarantine = 1
41628           # Do something in a transport with this flag variable
41629
41630   deny    condition      = ${if eq{$dmarc_domain_policy}{reject}}
41631           condition      = ${if eq{$acl_m_mailing_list}{1}}
41632           message        = Messages from $dmarc_used_domain break mailing lists
41633
41634   deny    dmarc_status   = reject
41635           !authenticated = *
41636           message        = Message from $dmarc_used_domain failed sender's DMARC policy, REJECT
41637
41638   warn    add_header     = :at_start:${authresults {$primary_hostname}}
41639 .endd
41640
41641
41642
41643
41644
41645 . ////////////////////////////////////////////////////////////////////////////
41646 . ////////////////////////////////////////////////////////////////////////////
41647
41648 .chapter "Proxies" "CHAPproxies" &&&
41649          "Proxy support"
41650 .cindex "proxy support"
41651 .cindex "proxy" "access via"
41652
41653 A proxy is an intermediate system through which communication is passed.
41654 Proxies may provide a security, availability or load-distribution function.
41655
41656
41657 .section "Inbound proxies" SECTproxyInbound
41658 .cindex proxy inbound
41659 .cindex proxy "server side"
41660 .cindex proxy "Proxy protocol"
41661 .cindex "Proxy protocol" proxy
41662
41663 Exim has support for receiving inbound SMTP connections via a proxy
41664 that uses &"Proxy Protocol"& to speak to it.
41665 To include this support, include &"SUPPORT_PROXY=yes"&
41666 in Local/Makefile.
41667
41668 It was built on the HAProxy specification, found at
41669 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
41670
41671 The purpose of this facility is so that an application load balancer,
41672 such as HAProxy, can sit in front of several Exim servers
41673 to distribute load.
41674 Exim uses the local protocol communication with the proxy to obtain
41675 the remote SMTP system IP address and port information.
41676 There is no logging if a host passes or
41677 fails Proxy Protocol negotiation, but it can easily be determined and
41678 recorded in an ACL (example is below).
41679
41680 Use of a proxy is enabled by setting the &%hosts_proxy%&
41681 main configuration option to a hostlist; connections from these
41682 hosts will use Proxy Protocol.
41683 Exim supports both version 1 and version 2 of the Proxy Protocol and
41684 automatically determines which version is in use.
41685
41686 The Proxy Protocol header is the first data received on a TCP connection
41687 and is inserted before any TLS-on-connect handshake from the client; Exim
41688 negotiates TLS between Exim-as-server and the remote client, not between
41689 Exim and the proxy server.
41690
41691 The following expansion variables are usable
41692 (&"internal"& and &"external"& here refer to the interfaces
41693 of the proxy):
41694 .display
41695 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
41696 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
41697 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
41698 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
41699 &'proxy_session            '& boolean: SMTP connection via proxy
41700 .endd
41701 If &$proxy_session$& is set but &$proxy_external_address$& is empty
41702 there was a protocol error.
41703 The variables &$sender_host_address$& and &$sender_host_port$&
41704 will have values for the actual client system, not the proxy.
41705
41706 Since the real connections are all coming from the proxy, and the
41707 per host connection tracking is done before Proxy Protocol is
41708 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
41709 handle all of the parallel volume you expect per inbound proxy.
41710 With the option set so high, you lose the ability
41711 to protect your server from many connections from one IP.
41712 In order to prevent your server from overload, you
41713 need to add a per connection ratelimit to your connect ACL.
41714 A possible solution is:
41715 .display
41716   # Set max number of connections per host
41717   LIMIT   = 5
41718   # Or do some kind of IP lookup in a flat file or database
41719   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
41720
41721   defer   ratelimit      = LIMIT / 5s / per_conn / strict
41722           message        = Too many connections from this IP right now
41723 .endd
41724
41725
41726
41727 .section "Outbound proxies" SECTproxySOCKS
41728 .cindex proxy outbound
41729 .cindex proxy "client side"
41730 .cindex proxy SOCKS
41731 .cindex SOCKS proxy
41732 Exim has support for sending outbound SMTP via a proxy
41733 using a protocol called SOCKS5 (defined by RFC1928).
41734 The support can be optionally included by defining SUPPORT_SOCKS=yes in
41735 Local/Makefile.
41736
41737 Use of a proxy is enabled by setting the &%socks_proxy%& option
41738 on an smtp transport.
41739 The option value is expanded and should then be a list
41740 (colon-separated by default) of proxy specifiers.
41741 Each proxy specifier is a list
41742 (space-separated by default) where the initial element
41743 is an IP address and any subsequent elements are options.
41744
41745 Options are a string <name>=<value>.
41746 The list of options is in the following table:
41747 .display
41748 &'auth   '& authentication method
41749 &'name   '& authentication username
41750 &'pass   '& authentication password
41751 &'port   '& tcp port
41752 &'tmo    '& connection timeout
41753 &'pri    '& priority
41754 &'weight '& selection bias
41755 .endd
41756
41757 More details on each of these options follows:
41758
41759 .ilist
41760 .cindex authentication "to proxy"
41761 .cindex proxy authentication
41762 &%auth%&: Either &"none"& (default) or &"name"&.
41763 Using &"name"& selects username/password authentication per RFC 1929
41764 for access to the proxy.
41765 Default is &"none"&.
41766 .next
41767 &%name%&: sets the username for the &"name"& authentication method.
41768 Default is empty.
41769 .next
41770 &%pass%&: sets the password for the &"name"& authentication method.
41771 Default is empty.
41772 .next
41773 &%port%&: the TCP port number to use for the connection to the proxy.
41774 Default is 1080.
41775 .next
41776 &%tmo%&: sets a connection timeout in seconds for this proxy.
41777 Default is 5.
41778 .next
41779 &%pri%&: specifies a priority for the proxy within the list,
41780 higher values being tried first.
41781 The default priority is 1.
41782 .next
41783 &%weight%&: specifies a selection bias.
41784 Within a priority set servers are queried in a random fashion,
41785 weighted by this value.
41786 The default value for selection bias is 1.
41787 .endlist
41788
41789 Proxies from the list are tried according to their priority
41790 and weight settings until one responds.  The timeout for the
41791 overall connection applies to the set of proxied attempts.
41792
41793 .section Logging SECTproxyLog
41794 To log the (local) IP of a proxy in the incoming or delivery logline,
41795 add &"+proxy"& to the &%log_selector%& option.
41796 This will add a component tagged with &"PRX="& to the line.
41797
41798 . ////////////////////////////////////////////////////////////////////////////
41799 . ////////////////////////////////////////////////////////////////////////////
41800
41801 .chapter "Internationalisation" "CHAPi18n" &&&
41802          "Internationalisation""
41803 .cindex internationalisation "email address"
41804 .cindex EAI
41805 .cindex i18n
41806 .cindex utf8 "mail name handling"
41807
41808 Exim has support for Internationalised mail names.
41809 To include this it must be built with SUPPORT_I18N and the libidn library.
41810 Standards supported are RFCs 2060, 5890, 6530 and 6533.
41811
41812 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
41813 instead of it) then IDNA2008 is supported; this adds an extra library
41814 requirement, upon libidn2.
41815
41816 .section "MTA operations" SECTi18nMTA
41817 .cindex SMTPUTF8 "ESMTP option"
41818 .cindex "ESMTP extensions" SMTPUTF8
41819 The main configuration option &%smtputf8_advertise_hosts%& specifies
41820 a host list.  If this matches the sending host and
41821 accept_8bitmime is true (the default) then the ESMTP option
41822 SMTPUTF8 will be advertised.
41823
41824 If the sender specifies the SMTPUTF8 option on a MAIL command
41825 international handling for the message is enabled and
41826 the expansion variable &$message_smtputf8$& will have value TRUE.
41827
41828 The option &%allow_utf8_domains%& is set to true for this
41829 message. All DNS lookups are converted to a-label form
41830 whatever the setting of &%allow_utf8_domains%&
41831 when Exim is built with SUPPORT_I18N.
41832
41833 Both localparts and domain are maintained as the original
41834 UTF-8 form internally; any comparison or regular-expression use will
41835 require appropriate care.  Filenames created, eg. by
41836 the appendfile transport, will have UTF-8 names.
41837
41838 HELO names sent by the smtp transport will have any UTF-8
41839 components expanded to a-label form,
41840 and any certificate name checks will be done using the a-label
41841 form of the name.
41842
41843 .cindex log protocol
41844 .cindex SMTPUTF8 logging
41845 .cindex i18n logging
41846 Log lines and Received-by: header lines will acquire a "utf8"
41847 prefix on the protocol element, eg. utf8esmtp.
41848
41849 The following expansion operators can be used:
41850 .code
41851 ${utf8_domain_to_alabel:str}
41852 ${utf8_domain_from_alabel:str}
41853 ${utf8_localpart_to_alabel:str}
41854 ${utf8_localpart_from_alabel:str}
41855 .endd
41856
41857 .cindex utf8 "address downconversion"
41858 .cindex i18n "utf8 address downconversion"
41859 The RCPT ACL
41860 may use the following modifier:
41861 .display
41862 control = utf8_downconvert
41863 control = utf8_downconvert/<value>
41864 .endd
41865 This sets a flag requiring that envelope addresses are converted to
41866 a-label form before smtp delivery.
41867 This is usually for use in a Message Submission Agent context,
41868 but could be used for any message.
41869
41870 If a value is appended it may be:
41871 .display
41872 &`1  `& mandatory downconversion
41873 &`0  `& no downconversion
41874 &`-1 `& if SMTPUTF8 not supported by destination host
41875 .endd
41876 If no value is given, 1 is used.
41877
41878 If mua_wrapper is set, the utf8_downconvert control
41879 is initially set to -1.
41880
41881 The smtp transport has an option &%utf8_downconvert%&.
41882 If set it must expand to one of the three values described above,
41883 or an empty string.
41884 If non-empty it overrides value previously set
41885 (due to mua_wrapper or by an ACL control).
41886
41887
41888 There is no explicit support for VRFY and EXPN.
41889 Configurations supporting these should inspect
41890 &$smtp_command_argument$& for an SMTPUTF8 argument.
41891
41892 There is no support for LMTP on Unix sockets.
41893 Using the "lmtp" protocol option on an smtp transport,
41894 for LMTP over TCP, should work as expected.
41895
41896 There is no support for DSN unitext handling,
41897 and no provision for converting logging from or to UTF-8.
41898
41899
41900
41901 .section "MDA operations" SECTi18nMDA
41902 To aid in constructing names suitable for IMAP folders
41903 the following expansion operator can be used:
41904 .code
41905 ${imapfolder {<string>} {<sep>} {<specials>}}
41906 .endd
41907
41908 The string is converted from the charset specified by
41909 the "headers charset" command (in a filter file)
41910 or &%headers_charset%& main configuration option (otherwise),
41911 to the
41912 modified UTF-7 encoding specified by RFC 2060,
41913 with the following exception: All occurrences of <sep>
41914 (which has to be a single character)
41915 are replaced with periods ("."), and all periods and slashes that are not
41916 <sep> and are not in the <specials> string are BASE64 encoded.
41917
41918 The third argument can be omitted, defaulting to an empty string.
41919 The second argument can be omitted, defaulting to "/".
41920
41921 This is the encoding used by Courier for Maildir names on disk, and followed
41922 by many other IMAP servers.
41923
41924 Examples:
41925 .display
41926 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
41927 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
41928 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
41929 .endd
41930
41931 Note that the source charset setting is vital, and also that characters
41932 must be representable in UTF-16.
41933
41934
41935 . ////////////////////////////////////////////////////////////////////////////
41936 . ////////////////////////////////////////////////////////////////////////////
41937
41938 .chapter "Events" "CHAPevents" &&&
41939          "Events"
41940 .cindex events
41941
41942 The events mechanism in Exim can be used to intercept processing at a number
41943 of points.  It was originally invented to give a way to do customised logging
41944 actions (for example, to a database) but can also be used to modify some
41945 processing actions.
41946
41947 Most installations will never need to use Events.
41948 The support can be left out of a build by defining DISABLE_EVENT=yes
41949 in &_Local/Makefile_&.
41950
41951 There are two major classes of events: main and transport.
41952 The main configuration option &%event_action%& controls reception events;
41953 a transport option &%event_action%& controls delivery events.
41954
41955 Both options are a string which is expanded when the event fires.
41956 An example might look like:
41957 .cindex logging custom
41958 .code
41959 event_action = ${if eq {msg:delivery}{$event_name} \
41960 {${lookup pgsql {SELECT * FROM record_Delivery( \
41961     '${quote_pgsql:$sender_address_domain}',\
41962     '${quote_pgsql:${lc:$sender_address_local_part}}', \
41963     '${quote_pgsql:$domain}', \
41964     '${quote_pgsql:${lc:$local_part}}', \
41965     '${quote_pgsql:$host_address}', \
41966     '${quote_pgsql:${lc:$host}}', \
41967     '${quote_pgsql:$message_exim_id}')}} \
41968 } {}}
41969 .endd
41970
41971 Events have names which correspond to the point in process at which they fire.
41972 The name is placed in the variable &$event_name$& and the event action
41973 expansion must check this, as it will be called for every possible event type.
41974
41975 The current list of events is:
41976 .display
41977 &`dane:fail              after    transport  `& per connection
41978 &`msg:complete           after    main       `& per message
41979 &`msg:defer              after    transport  `& per message per delivery try
41980 &`msg:delivery           after    transport  `& per recipient
41981 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
41982 &`msg:rcpt:defer         after    transport  `& per recipient
41983 &`msg:host:defer         after    transport  `& per host per delivery try; host errors
41984 &`msg:fail:delivery      after    transport  `& per recipient
41985 &`msg:fail:internal      after    main       `& per recipient
41986 &`tcp:connect            before   transport  `& per connection
41987 &`tcp:close              after    transport  `& per connection
41988 &`tls:cert               before   both       `& per certificate in verification chain
41989 &`smtp:connect           after    transport  `& per connection
41990 &`smtp:ehlo              after    transport  `& per connection
41991 .endd
41992 New event types may be added in future.
41993
41994 The event name is a colon-separated list, defining the type of
41995 event in a tree of possibilities.  It may be used as a list
41996 or just matched on as a whole.  There will be no spaces in the name.
41997
41998 The second column in the table above describes whether the event fires
41999 before or after the action is associates with.  Those which fire before
42000 can be used to affect that action (more on this below).
42001
42002 The third column in the table above says what section of the configuration
42003 should define the event action.
42004
42005 An additional variable, &$event_data$&, is filled with information varying
42006 with the event type:
42007 .display
42008 &`dane:fail            `& failure reason
42009 &`msg:defer            `& error string
42010 &`msg:delivery         `& smtp confirmation message
42011 &`msg:fail:internal    `& failure reason
42012 &`msg:fail:delivery    `& smtp error message
42013 &`msg:host:defer       `& error string
42014 &`msg:rcpt:host:defer  `& error string
42015 &`msg:rcpt:defer       `& error string
42016 &`tls:cert             `& verification chain depth
42017 &`smtp:connect         `& smtp banner
42018 &`smtp:ehlo            `& smtp ehlo response
42019 .endd
42020
42021 The :defer events populate one extra variable: &$event_defer_errno$&.
42022
42023 For complex operations an ACL expansion can be used in &%event_action%&
42024 however due to the multiple contexts that Exim operates in during
42025 the course of its processing:
42026 .ilist
42027 variables set in transport events will not be visible outside that
42028 transport call
42029 .next
42030 acl_m variables in a server context are lost on a new connection,
42031 and after smtp helo/ehlo/mail/starttls/rset commands
42032 .endlist
42033 Using an ACL expansion with the logwrite modifier can be
42034 a useful way of writing to the main log.
42035
42036 The expansion of the event_action option should normally
42037 return an empty string.  Should it return anything else the
42038 following will be forced:
42039 .display
42040 &`tcp:connect      `&  do not connect
42041 &`tls:cert         `&  refuse verification
42042 &`smtp:connect     `&  close connection
42043 .endd
42044 All other message types ignore the result string, and
42045 no other use is made of it.
42046
42047 For a tcp:connect event, if the connection is being made to a proxy
42048 then the address and port variables will be that of the proxy and not
42049 the target system.
42050
42051 For tls:cert events, if GnuTLS is in use this will trigger only per
42052 chain element received on the connection.
42053 For OpenSSL it will trigger for every chain element including those
42054 loaded locally.
42055
42056 . ////////////////////////////////////////////////////////////////////////////
42057 . ////////////////////////////////////////////////////////////////////////////
42058
42059 .chapter "Adding new drivers or lookup types" "CHID13" &&&
42060          "Adding drivers or lookups"
42061 .cindex "adding drivers"
42062 .cindex "new drivers, adding"
42063 .cindex "drivers" "adding new"
42064 The following actions have to be taken in order to add a new router, transport,
42065 authenticator, or lookup type to Exim:
42066
42067 .olist
42068 Choose a name for the driver or lookup type that does not conflict with any
42069 existing name; I will use &"newdriver"& in what follows.
42070 .next
42071 Add to &_src/EDITME_& the line:
42072 .display
42073 <&'type'&>&`_NEWDRIVER=yes`&
42074 .endd
42075 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
42076 code is not to be included in the binary by default, comment this line out. You
42077 should also add any relevant comments about the driver or lookup type.
42078 .next
42079 Add to &_src/config.h.defaults_& the line:
42080 .code
42081 #define <type>_NEWDRIVER
42082 .endd
42083 .next
42084 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
42085 and create a table entry as is done for all the other drivers and lookup types.
42086 .next
42087 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
42088 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
42089 Add your &`NEWDRIVER`& to that list.
42090 As long as the dynamic module would be named &_newdriver.so_&, you can use the
42091 simple form that most lookups have.
42092 .next
42093 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
42094 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
42095 driver or lookup type and add it to the definition of OBJ.
42096 .next
42097 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
42098 definition of OBJ_MACRO.  Add a set of line to do the compile also.
42099 .next
42100 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
42101 &_src_&.
42102 .next
42103 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
42104 as for other drivers and lookups.
42105 .endlist
42106
42107 Then all you need to do is write the code! A good way to start is to make a
42108 proforma by copying an existing module of the same type, globally changing all
42109 occurrences of the name, and cutting out most of the code. Note that any
42110 options you create must be listed in alphabetical order, because the tables are
42111 searched using a binary chop procedure.
42112
42113 There is a &_README_& file in each of the sub-directories of &_src_& describing
42114 the interface that is expected.
42115
42116
42117
42118
42119 . ////////////////////////////////////////////////////////////////////////////
42120 . ////////////////////////////////////////////////////////////////////////////
42121
42122 . /////////////////////////////////////////////////////////////////////////////
42123 . These lines are processing instructions for the Simple DocBook Processor that
42124 . Philip Hazel has developed as a less cumbersome way of making PostScript and
42125 . PDFs than using xmlto and fop. They will be ignored by all other XML
42126 . processors.
42127 . /////////////////////////////////////////////////////////////////////////////
42128
42129 .literal xml
42130 <?sdop
42131   format="newpage"
42132   foot_right_recto="&chaptertitle;"
42133   foot_right_verso="&chaptertitle;"
42134 ?>
42135 .literal off
42136
42137 .makeindex "Options index"   "option"
42138 .makeindex "Variables index" "variable"
42139 .makeindex "Concept index"   "concept"
42140
42141
42142 . /////////////////////////////////////////////////////////////////////////////
42143 . /////////////////////////////////////////////////////////////////////////////