Docs: Add note on lsearch for IPv4-mapped IPv6 addresses
[users/heiko/exim.git] / doc / doc-docbook / spec.xfpt
1 . /////////////////////////////////////////////////////////////////////////////
2 . This is the primary source of the Exim Manual. It is an xfpt document that is
3 . converted into DocBook XML for subsequent conversion into printable and online
4 . formats. The markup used herein is "standard" xfpt markup, with some extras.
5 . The markup is summarized in a file called Markup.txt.
6 .
7 . WARNING: When you use the .new macro, make sure it appears *before* any
8 . adjacent index items; otherwise you get an empty "paragraph" which causes
9 . unwanted vertical space.
10 . /////////////////////////////////////////////////////////////////////////////
11
12 .include stdflags
13 .include stdmacs
14
15 . /////////////////////////////////////////////////////////////////////////////
16 . This outputs the standard DocBook boilerplate.
17 . /////////////////////////////////////////////////////////////////////////////
18
19 .docbook
20
21 . /////////////////////////////////////////////////////////////////////////////
22 . These lines are processing instructions for the Simple DocBook Processor that
23 . Philip Hazel has developed as a less cumbersome way of making PostScript and
24 . PDFs than using xmlto and fop. They will be ignored by all other XML
25 . processors.
26 . /////////////////////////////////////////////////////////////////////////////
27
28 .literal xml
29 <?sdop
30   foot_right_recto="&chaptertitle; (&chapternumber;)"
31   foot_right_verso="&chaptertitle; (&chapternumber;)"
32   toc_chapter_blanks="yes,yes"
33   table_warn_overflow="overprint"
34 ?>
35 .literal off
36
37 . /////////////////////////////////////////////////////////////////////////////
38 . This generates the outermost <book> element that wraps the entire document.
39 . /////////////////////////////////////////////////////////////////////////////
40
41 .book
42
43 . /////////////////////////////////////////////////////////////////////////////
44 . These definitions set some parameters and save some typing.
45 . Update the Copyright year (only) when changing content.
46 . /////////////////////////////////////////////////////////////////////////////
47
48 .set previousversion "4.92"
49 .include ./local_params
50
51 .set ACL "access control lists (ACLs)"
52 .set I   "&nbsp;&nbsp;&nbsp;&nbsp;"
53
54 .macro copyyear
55 2018
56 .endmacro
57
58 . /////////////////////////////////////////////////////////////////////////////
59 . Additional xfpt markup used by this document, over and above the default
60 . provided in the xfpt library.
61 . /////////////////////////////////////////////////////////////////////////////
62
63 . --- Override the &$ flag to automatically insert a $ with the variable name.
64
65 .flag &$  $&   "<varname>$"  "</varname>"
66
67 . --- Short flags for daggers in option headings. They will always be inside
68 . --- an italic string, but we want the daggers to be in Roman.
69
70 .flag &!!      "</emphasis>&dagger;<emphasis>"
71 .flag &!?      "</emphasis>&Dagger;<emphasis>"
72
73 . --- A macro for an Exim option definition heading, generating a one-line
74 . --- table with four columns. For cases when the option name is given with
75 . --- a space, so that it can be split, a fifth argument is used for the
76 . --- index entry.
77
78 .macro option
79 .arg 5
80 .oindex "&%$5%&"
81 .endarg
82 .arg -5
83 .oindex "&%$1%&"
84 .endarg
85 .itable all 0 0 4 8* left 6* center 6* center 6* right
86 .row "&%$1%&" "Use: &'$2'&" "Type: &'$3'&" "Default: &'$4'&"
87 .endtable
88 .endmacro
89
90 . --- A macro for the common 2-column tables. The width of the first column
91 . --- is suitable for the many tables at the start of the main options chapter;
92 . --- a small number of other 2-column tables override it.
93
94 .macro table2 196pt 254pt
95 .itable none 0 0 2 $1 left $2 left
96 .endmacro
97
98 . --- A macro that generates .row, but puts &I; at the start of the first
99 . --- argument, thus indenting it. Assume a minimum of two arguments, and
100 . --- allow up to four arguments, which is as many as we'll ever need.
101
102 .macro irow
103 .arg 4
104 .row "&I;$1" "$2" "$3" "$4"
105 .endarg
106 .arg -4
107 .arg 3
108 .row "&I;$1" "$2" "$3"
109 .endarg
110 .arg -3
111 .row "&I;$1" "$2"
112 .endarg
113 .endarg
114 .endmacro
115
116 . --- Macros for option, variable, and concept index entries. For a "range"
117 . --- style of entry, use .scindex for the start and .ecindex for the end. The
118 . --- first argument of .scindex and the only argument of .ecindex must be the
119 . --- ID that ties them together.
120
121 .macro cindex
122 &<indexterm role="concept">&
123 &<primary>&$1&</primary>&
124 .arg 2
125 &<secondary>&$2&</secondary>&
126 .endarg
127 &</indexterm>&
128 .endmacro
129
130 .macro scindex
131 &<indexterm role="concept" id="$1" class="startofrange">&
132 &<primary>&$2&</primary>&
133 .arg 3
134 &<secondary>&$3&</secondary>&
135 .endarg
136 &</indexterm>&
137 .endmacro
138
139 .macro ecindex
140 &<indexterm role="concept" startref="$1" class="endofrange"/>&
141 .endmacro
142
143 .macro oindex
144 &<indexterm role="option">&
145 &<primary>&$1&</primary>&
146 .arg 2
147 &<secondary>&$2&</secondary>&
148 .endarg
149 &</indexterm>&
150 .endmacro
151
152 .macro vindex
153 &<indexterm role="variable">&
154 &<primary>&$1&</primary>&
155 .arg 2
156 &<secondary>&$2&</secondary>&
157 .endarg
158 &</indexterm>&
159 .endmacro
160
161 .macro index
162 .echo "** Don't use .index; use .cindex or .oindex or .vindex"
163 .endmacro
164 . ////////////////////////////////////////////////////////////////////////////
165
166
167 . ////////////////////////////////////////////////////////////////////////////
168 . The <bookinfo> element is removed from the XML before processing for ASCII
169 . output formats.
170 . ////////////////////////////////////////////////////////////////////////////
171
172 .literal xml
173 <bookinfo>
174 <title>Specification of the Exim Mail Transfer Agent</title>
175 <titleabbrev>The Exim MTA</titleabbrev>
176 <date>
177 .fulldate
178 </date>
179 <author><firstname>Exim</firstname><surname>Maintainers</surname></author>
180 <authorinitials>EM</authorinitials>
181 <revhistory><revision>
182 .versiondatexml
183   <authorinitials>EM</authorinitials>
184 </revision></revhistory>
185 <copyright><year>
186 .copyyear
187            </year><holder>University of Cambridge</holder></copyright>
188 </bookinfo>
189 .literal off
190
191
192 . /////////////////////////////////////////////////////////////////////////////
193 . This chunk of literal XML implements index entries of the form "x, see y" and
194 . "x, see also y". However, the DocBook DTD doesn't allow <indexterm> entries
195 . at the top level, so we have to put the .chapter directive first.
196 . /////////////////////////////////////////////////////////////////////////////
197
198 .chapter "Introduction" "CHID1"
199 .literal xml
200
201 <indexterm role="variable">
202   <primary>$1, $2, etc.</primary>
203   <see><emphasis>numerical variables</emphasis></see>
204 </indexterm>
205 <indexterm role="concept">
206   <primary>address</primary>
207   <secondary>rewriting</secondary>
208   <see><emphasis>rewriting</emphasis></see>
209 </indexterm>
210 <indexterm role="concept">
211   <primary>Bounce Address Tag Validation</primary>
212   <see><emphasis>BATV</emphasis></see>
213 </indexterm>
214 <indexterm role="concept">
215   <primary>Client SMTP Authorization</primary>
216   <see><emphasis>CSA</emphasis></see>
217 </indexterm>
218 <indexterm role="concept">
219   <primary>CR character</primary>
220   <see><emphasis>carriage return</emphasis></see>
221 </indexterm>
222 <indexterm role="concept">
223   <primary>CRL</primary>
224   <see><emphasis>certificate revocation list</emphasis></see>
225 </indexterm>
226 <indexterm role="concept">
227   <primary>delivery</primary>
228   <secondary>failure report</secondary>
229   <see><emphasis>bounce message</emphasis></see>
230 </indexterm>
231 <indexterm role="concept">
232   <primary>dialup</primary>
233   <see><emphasis>intermittently connected hosts</emphasis></see>
234 </indexterm>
235 <indexterm role="concept">
236   <primary>exiscan</primary>
237   <see><emphasis>content scanning</emphasis></see>
238 </indexterm>
239 <indexterm role="concept">
240   <primary>failover</primary>
241   <see><emphasis>fallback</emphasis></see>
242 </indexterm>
243 <indexterm role="concept">
244   <primary>fallover</primary>
245   <see><emphasis>fallback</emphasis></see>
246 </indexterm>
247 <indexterm role="concept">
248   <primary>filter</primary>
249   <secondary>Sieve</secondary>
250   <see><emphasis>Sieve filter</emphasis></see>
251 </indexterm>
252 <indexterm role="concept">
253   <primary>ident</primary>
254   <see><emphasis>RFC 1413</emphasis></see>
255 </indexterm>
256 <indexterm role="concept">
257   <primary>LF character</primary>
258   <see><emphasis>linefeed</emphasis></see>
259 </indexterm>
260 <indexterm role="concept">
261   <primary>maximum</primary>
262   <seealso><emphasis>limit</emphasis></seealso>
263 </indexterm>
264 <indexterm role="concept">
265   <primary>monitor</primary>
266   <see><emphasis>Exim monitor</emphasis></see>
267 </indexterm>
268 <indexterm role="concept">
269   <primary>no_<emphasis>xxx</emphasis></primary>
270   <see>entry for xxx</see>
271 </indexterm>
272 <indexterm role="concept">
273   <primary>NUL</primary>
274   <see><emphasis>binary zero</emphasis></see>
275 </indexterm>
276 <indexterm role="concept">
277   <primary>passwd file</primary>
278   <see><emphasis>/etc/passwd</emphasis></see>
279 </indexterm>
280 <indexterm role="concept">
281   <primary>process id</primary>
282   <see><emphasis>pid</emphasis></see>
283 </indexterm>
284 <indexterm role="concept">
285   <primary>RBL</primary>
286   <see><emphasis>DNS list</emphasis></see>
287 </indexterm>
288 <indexterm role="concept">
289   <primary>redirection</primary>
290   <see><emphasis>address redirection</emphasis></see>
291 </indexterm>
292 <indexterm role="concept">
293   <primary>return path</primary>
294   <seealso><emphasis>envelope sender</emphasis></seealso>
295 </indexterm>
296 <indexterm role="concept">
297   <primary>scanning</primary>
298   <see><emphasis>content scanning</emphasis></see>
299 </indexterm>
300 <indexterm role="concept">
301   <primary>SSL</primary>
302   <see><emphasis>TLS</emphasis></see>
303 </indexterm>
304 <indexterm role="concept">
305   <primary>string</primary>
306   <secondary>expansion</secondary>
307   <see><emphasis>expansion</emphasis></see>
308 </indexterm>
309 <indexterm role="concept">
310   <primary>top bit</primary>
311   <see><emphasis>8-bit characters</emphasis></see>
312 </indexterm>
313 <indexterm role="concept">
314   <primary>variables</primary>
315   <see><emphasis>expansion, variables</emphasis></see>
316 </indexterm>
317 <indexterm role="concept">
318   <primary>zero, binary</primary>
319   <see><emphasis>binary zero</emphasis></see>
320 </indexterm>
321
322 .literal off
323
324
325 . /////////////////////////////////////////////////////////////////////////////
326 . This is the real start of the first chapter. See the comment above as to why
327 . we can't have the .chapter line here.
328 . chapter "Introduction"
329 . /////////////////////////////////////////////////////////////////////////////
330
331 Exim is a mail transfer agent (MTA) for hosts that are running Unix or
332 Unix-like operating systems. It was designed on the assumption that it would be
333 run on hosts that are permanently connected to the Internet. However, it can be
334 used on intermittently connected hosts with suitable configuration adjustments.
335
336 Configuration files currently exist for the following operating systems: AIX,
337 BSD/OS (aka BSDI), Darwin (Mac OS X), DGUX, Dragonfly, FreeBSD, GNU/Hurd,
338 GNU/Linux, HI-OSF (Hitachi), HI-UX, HP-UX, IRIX, MIPS RISCOS, NetBSD, OpenBSD,
339 OpenUNIX, QNX, SCO, SCO SVR4.2 (aka UNIX-SV), Solaris (aka SunOS5), SunOS4,
340 Tru64-Unix (formerly Digital UNIX, formerly DEC-OSF1), Ultrix, and UnixWare.
341 Some of these operating systems are no longer current and cannot easily be
342 tested, so the configuration files may no longer work in practice.
343
344 There are also configuration files for compiling Exim in the Cygwin environment
345 that can be installed on systems running Windows. However, this document does
346 not contain any information about running Exim in the Cygwin environment.
347
348 The terms and conditions for the use and distribution of Exim are contained in
349 the file &_NOTICE_&. Exim is distributed under the terms of the GNU General
350 Public Licence, a copy of which may be found in the file &_LICENCE_&.
351
352 The use, supply, or promotion of Exim for the purpose of sending bulk,
353 unsolicited electronic mail is incompatible with the basic aims of Exim,
354 which revolve around the free provision of a service that enhances the quality
355 of personal communications. The author of Exim regards indiscriminate
356 mass-mailing as an antisocial, irresponsible abuse of the Internet.
357
358 Exim owes a great deal to Smail 3 and its author, Ron Karr. Without the
359 experience of running and working on the Smail 3 code, I could never have
360 contemplated starting to write a new MTA. Many of the ideas and user interfaces
361 were originally taken from Smail 3, though the actual code of Exim is entirely
362 new, and has developed far beyond the initial concept.
363
364 Many people, both in Cambridge and around the world, have contributed to the
365 development and the testing of Exim, and to porting it to various operating
366 systems. I am grateful to them all. The distribution now contains a file called
367 &_ACKNOWLEDGMENTS_&, in which I have started recording the names of
368 contributors.
369
370
371 .section "Exim documentation" "SECID1"
372 . Keep this example change bar when updating the documentation!
373
374 .cindex "documentation"
375 This edition of the Exim specification applies to version &version() of Exim.
376 Substantive changes from the &previousversion; edition are marked in some
377 renditions of this document; this paragraph is so marked if the rendition is
378 capable of showing a change indicator.
379
380 This document is very much a reference manual; it is not a tutorial. The reader
381 is expected to have some familiarity with the SMTP mail transfer protocol and
382 with general Unix system administration. Although there are some discussions
383 and examples in places, the information is mostly organized in a way that makes
384 it easy to look up, rather than in a natural order for sequential reading.
385 Furthermore, this manual aims to cover every aspect of Exim in detail, including
386 a number of rarely-used, special-purpose features that are unlikely to be of
387 very wide interest.
388
389 .cindex "books about Exim"
390 An &"easier"& discussion of Exim which provides more in-depth explanatory,
391 introductory, and tutorial material can be found in a book entitled &'The Exim
392 SMTP Mail Server'& (second edition, 2007), published by UIT Cambridge
393 (&url(https://www.uit.co.uk/exim-book/)).
394
395 The book also contains a chapter that gives a general introduction to SMTP and
396 Internet mail. Inevitably, however, the book is unlikely to be fully up-to-date
397 with the latest release of Exim. (Note that the earlier book about Exim,
398 published by O'Reilly, covers Exim 3, and many things have changed in Exim 4.)
399
400 .cindex "Debian" "information sources"
401 If you are using a Debian distribution of Exim, you will find information about
402 Debian-specific features in the file
403 &_/usr/share/doc/exim4-base/README.Debian_&.
404 The command &(man update-exim.conf)& is another source of Debian-specific
405 information.
406
407 .cindex "&_doc/NewStuff_&"
408 .cindex "&_doc/ChangeLog_&"
409 .cindex "change log"
410 As Exim develops, there may be features in newer versions that have not
411 yet made it into this document, which is updated only when the most significant
412 digit of the fractional part of the version number changes. Specifications of
413 new features that are not yet in this manual are placed in the file
414 &_doc/NewStuff_& in the Exim distribution.
415
416 Some features may be classified as &"experimental"&. These may change
417 incompatibly while they are developing, or even be withdrawn. For this reason,
418 they are not documented in this manual. Information about experimental features
419 can be found in the file &_doc/experimental.txt_&.
420
421 All changes to Exim (whether new features, bug fixes, or other kinds of
422 change) are noted briefly in the file called &_doc/ChangeLog_&.
423
424 .cindex "&_doc/spec.txt_&"
425 This specification itself is available as an ASCII file in &_doc/spec.txt_& so
426 that it can easily be searched with a text editor. Other files in the &_doc_&
427 directory are:
428
429 .table2 100pt
430 .row &_OptionLists.txt_&     "list of all options in alphabetical order"
431 .row &_dbm.discuss.txt_&     "discussion about DBM libraries"
432 .row &_exim.8_&              "a man page of Exim's command line options"
433 .row &_experimental.txt_&    "documentation of experimental features"
434 .row &_filter.txt_&          "specification of the filter language"
435 .row &_Exim3.upgrade_&       "upgrade notes from release 2 to release 3"
436 .row &_Exim4.upgrade_&       "upgrade notes from release 3 to release 4"
437 .row &_openssl.txt_&         "installing a current OpenSSL release"
438 .endtable
439
440 The main specification and the specification of the filtering language are also
441 available in other formats (HTML, PostScript, PDF, and Texinfo). Section
442 &<<SECTavail>>& below tells you how to get hold of these.
443
444
445
446 .section "FTP site and websites" "SECID2"
447 .cindex "website"
448 .cindex "FTP site"
449 The primary site for Exim source distributions is the &%exim.org%& FTP site,
450 available over HTTPS, HTTP and FTP.  These services, and the &%exim.org%&
451 website, are hosted at the University of Cambridge.
452
453 .cindex "wiki"
454 .cindex "FAQ"
455 As well as Exim distribution tar files, the Exim website contains a number of
456 differently formatted versions of the documentation. A recent addition to the
457 online information is the Exim wiki (&url(https://wiki.exim.org)),
458 which contains what used to be a separate FAQ, as well as various other
459 examples, tips, and know-how that have been contributed by Exim users.
460 The wiki site should always redirect to the correct place, which is currently
461 provided by GitHub, and is open to editing by anyone with a GitHub account.
462
463 .cindex Bugzilla
464 An Exim Bugzilla exists at &url(https://bugs.exim.org). You can use
465 this to report bugs, and also to add items to the wish list. Please search
466 first to check that you are not duplicating a previous entry.
467 Please do not ask for configuration help in the bug-tracker.
468
469
470 .section "Mailing lists" "SECID3"
471 .cindex "mailing lists" "for Exim users"
472 The following Exim mailing lists exist:
473
474 .table2 140pt
475 .row &'exim-announce@exim.org'&   "Moderated, low volume announcements list"
476 .row &'exim-users@exim.org'&      "General discussion list"
477 .row &'exim-dev@exim.org'&        "Discussion of bugs, enhancements, etc."
478 .row &'exim-cvs@exim.org'&        "Automated commit messages from the VCS"
479 .endtable
480
481 You can subscribe to these lists, change your existing subscriptions, and view
482 or search the archives via the mailing lists link on the Exim home page.
483 .cindex "Debian" "mailing list for"
484 If you are using a Debian distribution of Exim, you may wish to subscribe to
485 the Debian-specific mailing list &'pkg-exim4-users@lists.alioth.debian.org'&
486 via this web page:
487 .display
488 &url(https://alioth-lists.debian.net/cgi-bin/mailman/listinfo/pkg-exim4-users)
489 .endd
490 Please ask Debian-specific questions on that list and not on the general Exim
491 lists.
492
493 .section "Bug reports" "SECID5"
494 .cindex "bug reports"
495 .cindex "reporting bugs"
496 Reports of obvious bugs can be emailed to &'bugs@exim.org'& or reported
497 via the Bugzilla (&url(https://bugs.exim.org)). However, if you are unsure
498 whether some behaviour is a bug or not, the best thing to do is to post a
499 message to the &'exim-dev'& mailing list and have it discussed.
500
501
502
503 .section "Where to find the Exim distribution" "SECTavail"
504 .cindex "FTP site"
505 .cindex "HTTPS download site"
506 .cindex "distribution" "FTP site"
507 .cindex "distribution" "https site"
508 The master distribution site for the Exim distribution is
509 .display
510 &url(https://downloads.exim.org/)
511 .endd
512 The service is available over HTTPS, HTTP and FTP.
513 We encourage people to migrate to HTTPS.
514
515 The content served at &url(https://downloads.exim.org/) is identical to the
516 content served at &url(https://ftp.exim.org/pub/exim) and
517 &url(ftp://ftp.exim.org/pub/exim).
518
519 If accessing via a hostname containing &'ftp'&, then the file references that
520 follow are relative to the &_exim_& directories at these sites.
521 If accessing via the hostname &'downloads'& then the subdirectories described
522 here are top-level directories.
523
524 There are now quite a number of independent mirror sites around
525 the world. Those that I know about are listed in the file called &_Mirrors_&.
526
527 Within the top exim directory there are subdirectories called &_exim3_& (for
528 previous Exim 3 distributions), &_exim4_& (for the latest Exim 4
529 distributions), and &_Testing_& for testing versions. In the &_exim4_&
530 subdirectory, the current release can always be found in files called
531 .display
532 &_exim-n.nn.tar.xz_&
533 &_exim-n.nn.tar.gz_&
534 &_exim-n.nn.tar.bz2_&
535 .endd
536 where &'n.nn'& is the highest such version number in the directory. The three
537 files contain identical data; the only difference is the type of compression.
538 The &_.xz_& file is usually the smallest, while the &_.gz_& file is the
539 most portable to old systems.
540
541 .cindex "distribution" "signing details"
542 .cindex "distribution" "public key"
543 .cindex "public key for signed distribution"
544 The distributions will be PGP signed by an individual key of the Release
545 Coordinator.  This key will have a uid containing an email address in the
546 &'exim.org'& domain and will have signatures from other people, including
547 other Exim maintainers.  We expect that the key will be in the "strong set" of
548 PGP keys.  There should be a trust path to that key from the Exim Maintainer's
549 PGP keys, a version of which can be found in the release directory in the file
550 &_Exim-Maintainers-Keyring.asc_&.  All keys used will be available in public keyserver pools,
551 such as &'pool.sks-keyservers.net'&.
552
553 At the time of the last update, releases were being made by Jeremy Harris and signed
554 with key &'0xBCE58C8CE41F32DF'&.  Other recent keys used for signing are those
555 of Heiko Schlittermann, &'0x26101B62F69376CE'&,
556 and of Phil Pennock, &'0x4D1E900E14C1CC04'&.
557
558 The signatures for the tar bundles are in:
559 .display
560 &_exim-n.nn.tar.xz.asc_&
561 &_exim-n.nn.tar.gz.asc_&
562 &_exim-n.nn.tar.bz2.asc_&
563 .endd
564 For each released version, the log of changes is made available in a
565 separate file in the directory &_ChangeLogs_& so that it is possible to
566 find out what has changed without having to download the entire distribution.
567
568 .cindex "documentation" "available formats"
569 The main distribution contains ASCII versions of this specification and other
570 documentation; other formats of the documents are available in separate files
571 inside the &_exim4_& directory of the FTP site:
572 .display
573 &_exim-html-n.nn.tar.gz_&
574 &_exim-pdf-n.nn.tar.gz_&
575 &_exim-postscript-n.nn.tar.gz_&
576 &_exim-texinfo-n.nn.tar.gz_&
577 .endd
578 These tar files contain only the &_doc_& directory, not the complete
579 distribution, and are also available in &_.bz2_& and &_.xz_& forms.
580
581
582 .section "Limitations" "SECID6"
583 .ilist
584 .cindex "limitations of Exim"
585 .cindex "bang paths" "not handled by Exim"
586 Exim is designed for use as an Internet MTA, and therefore handles addresses in
587 RFC 2822 domain format only. It cannot handle UUCP &"bang paths"&, though
588 simple two-component bang paths can be converted by a straightforward rewriting
589 configuration. This restriction does not prevent Exim from being interfaced to
590 UUCP as a transport mechanism, provided that domain addresses are used.
591 .next
592 .cindex "domainless addresses"
593 .cindex "address" "without domain"
594 Exim insists that every address it handles has a domain attached. For incoming
595 local messages, domainless addresses are automatically qualified with a
596 configured domain value. Configuration options specify from which remote
597 systems unqualified addresses are acceptable. These are then qualified on
598 arrival.
599 .next
600 .cindex "transport" "external"
601 .cindex "external transports"
602 The only external transport mechanisms that are currently implemented are SMTP
603 and LMTP over a TCP/IP network (including support for IPv6). However, a pipe
604 transport is available, and there are facilities for writing messages to files
605 and pipes, optionally in &'batched SMTP'& format; these facilities can be used
606 to send messages to other transport mechanisms such as UUCP, provided they can
607 handle domain-style addresses. Batched SMTP input is also catered for.
608 .next
609 Exim is not designed for storing mail for dial-in hosts. When the volumes of
610 such mail are large, it is better to get the messages &"delivered"& into files
611 (that is, off Exim's queue) and subsequently passed on to the dial-in hosts by
612 other means.
613 .next
614 Although Exim does have basic facilities for scanning incoming messages, these
615 are not comprehensive enough to do full virus or spam scanning. Such operations
616 are best carried out using additional specialized software packages. If you
617 compile Exim with the content-scanning extension, straightforward interfaces to
618 a number of common scanners are provided.
619 .endlist
620
621
622 .section "Runtime configuration" "SECID7"
623 Exim's runtime configuration is held in a single text file that is divided
624 into a number of sections. The entries in this file consist of keywords and
625 values, in the style of Smail 3 configuration files. A default configuration
626 file which is suitable for simple online installations is provided in the
627 distribution, and is described in chapter &<<CHAPdefconfil>>& below.
628
629
630 .section "Calling interface" "SECID8"
631 .cindex "Sendmail compatibility" "command line interface"
632 Like many MTAs, Exim has adopted the Sendmail command line interface so that it
633 can be a straight replacement for &_/usr/lib/sendmail_& or
634 &_/usr/sbin/sendmail_& when sending mail, but you do not need to know anything
635 about Sendmail in order to run Exim. For actions other than sending messages,
636 Sendmail-compatible options also exist, but those that produce output (for
637 example, &%-bp%&, which lists the messages in the queue) do so in Exim's own
638 format. There are also some additional options that are compatible with Smail
639 3, and some further options that are new to Exim. Chapter &<<CHAPcommandline>>&
640 documents all Exim's command line options. This information is automatically
641 made into the man page that forms part of the Exim distribution.
642
643 Control of messages in the queue can be done via certain privileged command
644 line options. There is also an optional monitor program called &'eximon'&,
645 which displays current information in an X window, and which contains a menu
646 interface to Exim's command line administration options.
647
648
649
650 .section "Terminology" "SECID9"
651 .cindex "terminology definitions"
652 .cindex "body of message" "definition of"
653 The &'body'& of a message is the actual data that the sender wants to transmit.
654 It is the last part of a message and is separated from the &'header'& (see
655 below) by a blank line.
656
657 .cindex "bounce message" "definition of"
658 When a message cannot be delivered, it is normally returned to the sender in a
659 delivery failure message or a &"non-delivery report"& (NDR). The term
660 &'bounce'& is commonly used for this action, and the error reports are often
661 called &'bounce messages'&. This is a convenient shorthand for &"delivery
662 failure error report"&. Such messages have an empty sender address in the
663 message's &'envelope'& (see below) to ensure that they cannot themselves give
664 rise to further bounce messages.
665
666 The term &'default'& appears frequently in this manual. It is used to qualify a
667 value which is used in the absence of any setting in the configuration. It may
668 also qualify an action which is taken unless a configuration setting specifies
669 otherwise.
670
671 The term &'defer'& is used when the delivery of a message to a specific
672 destination cannot immediately take place for some reason (a remote host may be
673 down, or a user's local mailbox may be full). Such deliveries are &'deferred'&
674 until a later time.
675
676 The word &'domain'& is sometimes used to mean all but the first component of a
677 host's name. It is &'not'& used in that sense here, where it normally refers to
678 the part of an email address following the @ sign.
679
680 .cindex "envelope, definition of"
681 .cindex "sender" "definition of"
682 A message in transit has an associated &'envelope'&, as well as a header and a
683 body. The envelope contains a sender address (to which bounce messages should
684 be delivered), and any number of recipient addresses. References to the
685 sender or the recipients of a message usually mean the addresses in the
686 envelope. An MTA uses these addresses for delivery, and for returning bounce
687 messages, not the addresses that appear in the header lines.
688
689 .cindex "message" "header, definition of"
690 .cindex "header section" "definition of"
691 The &'header'& of a message is the first part of a message's text, consisting
692 of a number of lines, each of which has a name such as &'From:'&, &'To:'&,
693 &'Subject:'&, etc. Long header lines can be split over several text lines by
694 indenting the continuations. The header is separated from the body by a blank
695 line.
696
697 .cindex "local part" "definition of"
698 .cindex "domain" "definition of"
699 The term &'local part'&, which is taken from RFC 2822, is used to refer to the
700 part of an email address that precedes the @ sign. The part that follows the
701 @ sign is called the &'domain'& or &'mail domain'&.
702
703 .cindex "local delivery" "definition of"
704 .cindex "remote delivery, definition of"
705 The terms &'local delivery'& and &'remote delivery'& are used to distinguish
706 delivery to a file or a pipe on the local host from delivery by SMTP over
707 TCP/IP to another host. As far as Exim is concerned, all hosts other than the
708 host it is running on are &'remote'&.
709
710 .cindex "return path" "definition of"
711 &'Return path'& is another name that is used for the sender address in a
712 message's envelope.
713
714 .cindex "queue" "definition of"
715 The term &'queue'& is used to refer to the set of messages awaiting delivery
716 because this term is in widespread use in the context of MTAs. However, in
717 Exim's case, the reality is more like a pool than a queue, because there is
718 normally no ordering of waiting messages.
719
720 .cindex "queue runner" "definition of"
721 The term &'queue runner'& is used to describe a process that scans the queue
722 and attempts to deliver those messages whose retry times have come. This term
723 is used by other MTAs and also relates to the command &%runq%&, but in Exim
724 the waiting messages are normally processed in an unpredictable order.
725
726 .cindex "spool directory" "definition of"
727 The term &'spool directory'& is used for a directory in which Exim keeps the
728 messages in its queue &-- that is, those that it is in the process of
729 delivering. This should not be confused with the directory in which local
730 mailboxes are stored, which is called a &"spool directory"& by some people. In
731 the Exim documentation, &"spool"& is always used in the first sense.
732
733
734
735
736
737
738 . ////////////////////////////////////////////////////////////////////////////
739 . ////////////////////////////////////////////////////////////////////////////
740
741 .chapter "Incorporated code" "CHID2"
742 .cindex "incorporated code"
743 .cindex "regular expressions" "library"
744 .cindex "PCRE"
745 .cindex "OpenDMARC"
746 A number of pieces of external code are included in the Exim distribution.
747
748 .ilist
749 Regular expressions are supported in the main Exim program and in the
750 Exim monitor using the freely-distributable PCRE library, copyright
751 &copy; University of Cambridge. The source to PCRE is no longer shipped with
752 Exim, so you will need to use the version of PCRE shipped with your system,
753 or obtain and install the full version of the library from
754 &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre).
755 .next
756 .cindex "cdb" "acknowledgment"
757 Support for the cdb (Constant DataBase) lookup method is provided by code
758 contributed by Nigel Metheringham of (at the time he contributed it) Planet
759 Online Ltd. The implementation is completely contained within the code of Exim.
760 It does not link against an external cdb library. The code contains the
761 following statements:
762
763 .blockquote
764 Copyright &copy; 1998 Nigel Metheringham, Planet Online Ltd
765
766 This program is free software; you can redistribute it and/or modify it under
767 the terms of the GNU General Public License as published by the Free Software
768 Foundation; either version 2 of the License, or (at your option) any later
769 version.
770 This code implements Dan Bernstein's Constant DataBase (cdb) spec. Information,
771 the spec and sample code for cdb can be obtained from
772 &url(https://cr.yp.to/cdb.html). This implementation borrows
773 some code from Dan Bernstein's implementation (which has no license
774 restrictions applied to it).
775 .endblockquote
776 .next
777 .cindex "SPA authentication"
778 .cindex "Samba project"
779 .cindex "Microsoft Secure Password Authentication"
780 Client support for Microsoft's &'Secure Password Authentication'& is provided
781 by code contributed by Marc Prud'hommeaux. Server support was contributed by
782 Tom Kistner. This includes code taken from the Samba project, which is released
783 under the Gnu GPL.
784 .next
785 .cindex "Cyrus"
786 .cindex "&'pwcheck'& daemon"
787 .cindex "&'pwauthd'& daemon"
788 Support for calling the Cyrus &'pwcheck'& and &'saslauthd'& daemons is provided
789 by code taken from the Cyrus-SASL library and adapted by Alexander S.
790 Sabourenkov. The permission notice appears below, in accordance with the
791 conditions expressed therein.
792
793 .blockquote
794 Copyright &copy; 2001 Carnegie Mellon University.  All rights reserved.
795
796 Redistribution and use in source and binary forms, with or without
797 modification, are permitted provided that the following conditions
798 are met:
799
800 .olist
801 Redistributions of source code must retain the above copyright
802 notice, this list of conditions and the following disclaimer.
803 .next
804 Redistributions in binary form must reproduce the above copyright
805 notice, this list of conditions and the following disclaimer in
806 the documentation and/or other materials provided with the
807 distribution.
808 .next
809 The name &"Carnegie Mellon University"& must not be used to
810 endorse or promote products derived from this software without
811 prior written permission. For permission or any other legal
812 details, please contact
813 .display
814               Office of Technology Transfer
815               Carnegie Mellon University
816               5000 Forbes Avenue
817               Pittsburgh, PA  15213-3890
818               (412) 268-4387, fax: (412) 268-7395
819               tech-transfer@andrew.cmu.edu
820 .endd
821 .next
822 Redistributions of any form whatsoever must retain the following
823 acknowledgment:
824
825 &"This product includes software developed by Computing Services
826 at Carnegie Mellon University (&url(https://www.cmu.edu/computing/)."&
827
828 CARNEGIE MELLON UNIVERSITY DISCLAIMS ALL WARRANTIES WITH REGARD TO
829 THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY
830 AND FITNESS, IN NO EVENT SHALL CARNEGIE MELLON UNIVERSITY BE LIABLE
831 FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
832 WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
833 AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING
834 OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
835 .endlist
836 .endblockquote
837
838 .next
839 .cindex "Exim monitor" "acknowledgment"
840 .cindex "X-windows"
841 .cindex "Athena"
842 The Exim Monitor program, which is an X-Window application, includes
843 modified versions of the Athena StripChart and TextPop widgets.
844 This code is copyright by DEC and MIT, and their permission notice appears
845 below, in accordance with the conditions expressed therein.
846
847 .blockquote
848 Copyright 1987, 1988 by Digital Equipment Corporation, Maynard, Massachusetts,
849 and the Massachusetts Institute of Technology, Cambridge, Massachusetts.
850
851 All Rights Reserved
852
853 Permission to use, copy, modify, and distribute this software and its
854 documentation for any purpose and without fee is hereby granted,
855 provided that the above copyright notice appear in all copies and that
856 both that copyright notice and this permission notice appear in
857 supporting documentation, and that the names of Digital or MIT not be
858 used in advertising or publicity pertaining to distribution of the
859 software without specific, written prior permission.
860
861 DIGITAL DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING
862 ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS, IN NO EVENT SHALL
863 DIGITAL BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR
864 ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS,
865 WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
866 ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS
867 SOFTWARE.
868 .endblockquote
869
870 .next
871 .cindex "opendmarc" "acknowledgment"
872 The DMARC implementation uses the OpenDMARC library which is Copyrighted by
873 The Trusted Domain Project. Portions of Exim source which use OpenDMARC
874 derived code are indicated in the respective source files. The full OpenDMARC
875 license is provided in the LICENSE.opendmarc file contained in the distributed
876 source code.
877
878 .next
879 Many people have contributed code fragments, some large, some small, that were
880 not covered by any specific license requirements. It is assumed that the
881 contributors are happy to see their code incorporated into Exim under the GPL.
882 .endlist
883
884
885
886
887
888 . ////////////////////////////////////////////////////////////////////////////
889 . ////////////////////////////////////////////////////////////////////////////
890
891 .chapter "How Exim receives and delivers mail" "CHID11" &&&
892          "Receiving and delivering mail"
893
894
895 .section "Overall philosophy" "SECID10"
896 .cindex "design philosophy"
897 Exim is designed to work efficiently on systems that are permanently connected
898 to the Internet and are handling a general mix of mail. In such circumstances,
899 most messages can be delivered immediately. Consequently, Exim does not
900 maintain independent queues of messages for specific domains or hosts, though
901 it does try to send several messages in a single SMTP connection after a host
902 has been down, and it also maintains per-host retry information.
903
904
905 .section "Policy control" "SECID11"
906 .cindex "policy control" "overview"
907 Policy controls are now an important feature of MTAs that are connected to the
908 Internet. Perhaps their most important job is to stop MTAs from being abused as
909 &"open relays"& by misguided individuals who send out vast amounts of
910 unsolicited junk and want to disguise its source. Exim provides flexible
911 facilities for specifying policy controls on incoming mail:
912
913 .ilist
914 .cindex "&ACL;" "introduction"
915 Exim 4 (unlike previous versions of Exim) implements policy controls on
916 incoming mail by means of &'Access Control Lists'& (ACLs). Each list is a
917 series of statements that may either grant or deny access. ACLs can be used at
918 several places in the SMTP dialogue while receiving a message from a remote
919 host. However, the most common places are after each RCPT command, and at the
920 very end of the message. The sysadmin can specify conditions for accepting or
921 rejecting individual recipients or the entire message, respectively, at these
922 two points (see chapter &<<CHAPACL>>&). Denial of access results in an SMTP
923 error code.
924 .next
925 An ACL is also available for locally generated, non-SMTP messages. In this
926 case, the only available actions are to accept or deny the entire message.
927 .next
928 When Exim is compiled with the content-scanning extension, facilities are
929 provided in the ACL mechanism for passing the message to external virus and/or
930 spam scanning software. The result of such a scan is passed back to the ACL,
931 which can then use it to decide what to do with the message.
932 .next
933 When a message has been received, either from a remote host or from the local
934 host, but before the final acknowledgment has been sent, a locally supplied C
935 function called &[local_scan()]& can be run to inspect the message and decide
936 whether to accept it or not (see chapter &<<CHAPlocalscan>>&). If the message
937 is accepted, the list of recipients can be modified by the function.
938 .next
939 Using the &[local_scan()]& mechanism is another way of calling external scanner
940 software. The &%SA-Exim%& add-on package works this way. It does not require
941 Exim to be compiled with the content-scanning extension.
942 .next
943 After a message has been accepted, a further checking mechanism is available in
944 the form of the &'system filter'& (see chapter &<<CHAPsystemfilter>>&). This
945 runs at the start of every delivery process.
946 .endlist
947
948
949
950 .section "User filters" "SECID12"
951 .cindex "filter" "introduction"
952 .cindex "Sieve filter"
953 In a conventional Exim configuration, users are able to run private filters by
954 setting up appropriate &_.forward_& files in their home directories. See
955 chapter &<<CHAPredirect>>& (about the &(redirect)& router) for the
956 configuration needed to support this, and the separate document entitled
957 &'Exim's interfaces to mail filtering'& for user details. Two different kinds
958 of filtering are available:
959
960 .ilist
961 Sieve filters are written in the standard filtering language that is defined
962 by RFC 3028.
963 .next
964 Exim filters are written in a syntax that is unique to Exim, but which is more
965 powerful than Sieve, which it pre-dates.
966 .endlist
967
968 User filters are run as part of the routing process, described below.
969
970
971
972 .section "Message identification" "SECTmessiden"
973 .cindex "message ids" "details of format"
974 .cindex "format" "of message id"
975 .cindex "id of message"
976 .cindex "base62"
977 .cindex "base36"
978 .cindex "Darwin"
979 .cindex "Cygwin"
980 Every message handled by Exim is given a &'message id'& which is sixteen
981 characters long. It is divided into three parts, separated by hyphens, for
982 example &`16VDhn-0001bo-D3`&. Each part is a sequence of letters and digits,
983 normally encoding numbers in base 62. However, in the Darwin operating
984 system (Mac OS X) and when Exim is compiled to run under Cygwin, base 36
985 (avoiding the use of lower case letters) is used instead, because the message
986 id is used to construct filenames, and the names of files in those systems are
987 not always case-sensitive.
988
989 .cindex "pid (process id)" "re-use of"
990 The detail of the contents of the message id have changed as Exim has evolved.
991 Earlier versions relied on the operating system not re-using a process id (pid)
992 within one second. On modern operating systems, this assumption can no longer
993 be made, so the algorithm had to be changed. To retain backward compatibility,
994 the format of the message id was retained, which is why the following rules are
995 somewhat eccentric:
996
997 .ilist
998 The first six characters of the message id are the time at which the message
999 started to be received, to a granularity of one second. That is, this field
1000 contains the number of seconds since the start of the epoch (the normal Unix
1001 way of representing the date and time of day).
1002 .next
1003 After the first hyphen, the next six characters are the id of the process that
1004 received the message.
1005 .next
1006 There are two different possibilities for the final two characters:
1007 .olist
1008 .oindex "&%localhost_number%&"
1009 If &%localhost_number%& is not set, this value is the fractional part of the
1010 time of reception, normally in units of 1/2000 of a second, but for systems
1011 that must use base 36 instead of base 62 (because of case-insensitive file
1012 systems), the units are 1/1000 of a second.
1013 .next
1014 If &%localhost_number%& is set, it is multiplied by 200 (100) and added to
1015 the fractional part of the time, which in this case is in units of 1/200
1016 (1/100) of a second.
1017 .endlist
1018 .endlist
1019
1020 After a message has been received, Exim waits for the clock to tick at the
1021 appropriate resolution before proceeding, so that if another message is
1022 received by the same process, or by another process with the same (re-used)
1023 pid, it is guaranteed that the time will be different. In most cases, the clock
1024 will already have ticked while the message was being received.
1025
1026
1027 .section "Receiving mail" "SECID13"
1028 .cindex "receiving mail"
1029 .cindex "message" "reception"
1030 The only way Exim can receive mail from another host is using SMTP over
1031 TCP/IP, in which case the sender and recipient addresses are transferred using
1032 SMTP commands. However, from a locally running process (such as a user's MUA),
1033 there are several possibilities:
1034
1035 .ilist
1036 If the process runs Exim with the &%-bm%& option, the message is read
1037 non-interactively (usually via a pipe), with the recipients taken from the
1038 command line, or from the body of the message if &%-t%& is also used.
1039 .next
1040 If the process runs Exim with the &%-bS%& option, the message is also read
1041 non-interactively, but in this case the recipients are listed at the start of
1042 the message in a series of SMTP RCPT commands, terminated by a DATA
1043 command. This is called &"batch SMTP"& format,
1044 but it isn't really SMTP. The SMTP commands are just another way of passing
1045 envelope addresses in a non-interactive submission.
1046 .next
1047 If the process runs Exim with the &%-bs%& option, the message is read
1048 interactively, using the SMTP protocol. A two-way pipe is normally used for
1049 passing data between the local process and the Exim process.
1050 This is &"real"& SMTP and is handled in the same way as SMTP over TCP/IP. For
1051 example, the ACLs for SMTP commands are used for this form of submission.
1052 .next
1053 A local process may also make a TCP/IP call to the host's loopback address
1054 (127.0.0.1) or any other of its IP addresses. When receiving messages, Exim
1055 does not treat the loopback address specially. It treats all such connections
1056 in the same way as connections from other hosts.
1057 .endlist
1058
1059
1060 .cindex "message sender, constructed by Exim"
1061 .cindex "sender" "constructed by Exim"
1062 In the three cases that do not involve TCP/IP, the sender address is
1063 constructed from the login name of the user that called Exim and a default
1064 qualification domain (which can be set by the &%qualify_domain%& configuration
1065 option). For local or batch SMTP, a sender address that is passed using the
1066 SMTP MAIL command is ignored. However, the system administrator may allow
1067 certain users (&"trusted users"&) to specify a different sender addresses
1068 unconditionally, or all users to specify certain forms of different sender
1069 address. The &%-f%& option or the SMTP MAIL command is used to specify these
1070 different addresses. See section &<<SECTtrustedadmin>>& for details of trusted
1071 users, and the &%untrusted_set_sender%& option for a way of allowing untrusted
1072 users to change sender addresses.
1073
1074 Messages received by either of the non-interactive mechanisms are subject to
1075 checking by the non-SMTP ACL if one is defined. Messages received using SMTP
1076 (either over TCP/IP or interacting with a local process) can be checked by a
1077 number of ACLs that operate at different times during the SMTP session. Either
1078 individual recipients or the entire message can be rejected if local policy
1079 requirements are not met. The &[local_scan()]& function (see chapter
1080 &<<CHAPlocalscan>>&) is run for all incoming messages.
1081
1082 Exim can be configured not to start a delivery process when a message is
1083 received; this can be unconditional, or depend on the number of incoming SMTP
1084 connections or the system load. In these situations, new messages wait on the
1085 queue until a queue runner process picks them up. However, in standard
1086 configurations under normal conditions, delivery is started as soon as a
1087 message is received.
1088
1089
1090
1091
1092
1093 .section "Handling an incoming message" "SECID14"
1094 .cindex "spool directory" "files that hold a message"
1095 .cindex "file" "how a message is held"
1096 When Exim accepts a message, it writes two files in its spool directory. The
1097 first contains the envelope information, the current status of the message, and
1098 the header lines, and the second contains the body of the message. The names of
1099 the two spool files consist of the message id, followed by &`-H`& for the
1100 file containing the envelope and header, and &`-D`& for the data file.
1101
1102 .cindex "spool directory" "&_input_& sub-directory"
1103 By default, all these message files are held in a single directory called
1104 &_input_& inside the general Exim spool directory. Some operating systems do
1105 not perform very well if the number of files in a directory gets large; to
1106 improve performance in such cases, the &%split_spool_directory%& option can be
1107 used. This causes Exim to split up the input files into 62 sub-directories
1108 whose names are single letters or digits. When this is done, the queue is
1109 processed one sub-directory at a time instead of all at once, which can improve
1110 overall performance even when there are not enough files in each directory to
1111 affect file system performance.
1112
1113 The envelope information consists of the address of the message's sender and
1114 the addresses of the recipients. This information is entirely separate from
1115 any addresses contained in the header lines. The status of the message includes
1116 a list of recipients who have already received the message. The format of the
1117 first spool file is described in chapter &<<CHAPspool>>&.
1118
1119 .cindex "rewriting" "addresses"
1120 Address rewriting that is specified in the rewrite section of the configuration
1121 (see chapter &<<CHAPrewrite>>&) is done once and for all on incoming addresses,
1122 both in the header lines and the envelope, at the time the message is accepted.
1123 If during the course of delivery additional addresses are generated (for
1124 example, via aliasing), these new addresses are rewritten as soon as they are
1125 generated. At the time a message is actually delivered (transported) further
1126 rewriting can take place; because this is a transport option, it can be
1127 different for different forms of delivery. It is also possible to specify the
1128 addition or removal of certain header lines at the time the message is
1129 delivered (see chapters &<<CHAProutergeneric>>& and
1130 &<<CHAPtransportgeneric>>&).
1131
1132
1133
1134 .section "Life of a message" "SECID15"
1135 .cindex "message" "life of"
1136 .cindex "message" "frozen"
1137 A message remains in the spool directory until it is completely delivered to
1138 its recipients or to an error address, or until it is deleted by an
1139 administrator or by the user who originally created it. In cases when delivery
1140 cannot proceed &-- for example when a message can neither be delivered to its
1141 recipients nor returned to its sender, the message is marked &"frozen"& on the
1142 spool, and no more deliveries are attempted.
1143
1144 .cindex "frozen messages" "thawing"
1145 .cindex "message" "thawing frozen"
1146 An administrator can &"thaw"& such messages when the problem has been
1147 corrected, and can also freeze individual messages by hand if necessary. In
1148 addition, an administrator can force a delivery error, causing a bounce message
1149 to be sent.
1150
1151 .oindex "&%timeout_frozen_after%&"
1152 .oindex "&%ignore_bounce_errors_after%&"
1153 There are options called &%ignore_bounce_errors_after%& and
1154 &%timeout_frozen_after%&, which discard frozen messages after a certain time.
1155 The first applies only to frozen bounces, the second to all frozen messages.
1156
1157 .cindex "message" "log file for"
1158 .cindex "log" "file for each message"
1159 While Exim is working on a message, it writes information about each delivery
1160 attempt to its main log file. This includes successful, unsuccessful, and
1161 delayed deliveries for each recipient (see chapter &<<CHAPlog>>&). The log
1162 lines are also written to a separate &'message log'& file for each message.
1163 These logs are solely for the benefit of the administrator and are normally
1164 deleted along with the spool files when processing of a message is complete.
1165 The use of individual message logs can be disabled by setting
1166 &%no_message_logs%&; this might give an improvement in performance on very busy
1167 systems.
1168
1169 .cindex "journal file"
1170 .cindex "file" "journal"
1171 All the information Exim itself needs to set up a delivery is kept in the first
1172 spool file, along with the header lines. When a successful delivery occurs, the
1173 address is immediately written at the end of a journal file, whose name is the
1174 message id followed by &`-J`&. At the end of a delivery run, if there are some
1175 addresses left to be tried again later, the first spool file (the &`-H`& file)
1176 is updated to indicate which these are, and the journal file is then deleted.
1177 Updating the spool file is done by writing a new file and renaming it, to
1178 minimize the possibility of data loss.
1179
1180 Should the system or Exim crash after a successful delivery but before
1181 the spool file has been updated, the journal is left lying around. The next
1182 time Exim attempts to deliver the message, it reads the journal file and
1183 updates the spool file before proceeding. This minimizes the chances of double
1184 deliveries caused by crashes.
1185
1186
1187
1188 .section "Processing an address for delivery" "SECTprocaddress"
1189 .cindex "drivers" "definition of"
1190 .cindex "router" "definition of"
1191 .cindex "transport" "definition of"
1192 The main delivery processing elements of Exim are called &'routers'& and
1193 &'transports'&, and collectively these are known as &'drivers'&. Code for a
1194 number of them is provided in the source distribution, and compile-time options
1195 specify which ones are included in the binary. Runtime options specify which
1196 ones are actually used for delivering messages.
1197
1198 .cindex "drivers" "instance definition"
1199 Each driver that is specified in the runtime configuration is an &'instance'&
1200 of that particular driver type. Multiple instances are allowed; for example,
1201 you can set up several different &(smtp)& transports, each with different
1202 option values that might specify different ports or different timeouts. Each
1203 instance has its own identifying name. In what follows we will normally use the
1204 instance name when discussing one particular instance (that is, one specific
1205 configuration of the driver), and the generic driver name when discussing
1206 the driver's features in general.
1207
1208 A &'router'& is a driver that operates on an address, either determining how
1209 its delivery should happen, by assigning it to a specific transport, or
1210 converting the address into one or more new addresses (for example, via an
1211 alias file). A router may also explicitly choose to fail an address, causing it
1212 to be bounced.
1213
1214 A &'transport'& is a driver that transmits a copy of the message from Exim's
1215 spool to some destination. There are two kinds of transport: for a &'local'&
1216 transport, the destination is a file or a pipe on the local host, whereas for a
1217 &'remote'& transport the destination is some other host. A message is passed
1218 to a specific transport as a result of successful routing. If a message has
1219 several recipients, it may be passed to a number of different transports.
1220
1221 .cindex "preconditions" "definition of"
1222 An address is processed by passing it to each configured router instance in
1223 turn, subject to certain preconditions, until a router accepts the address or
1224 specifies that it should be bounced. We will describe this process in more
1225 detail shortly. First, as a simple example, we consider how each recipient
1226 address in a message is processed in a small configuration of three routers.
1227
1228 To make this a more concrete example, it is described in terms of some actual
1229 routers, but remember, this is only an example. You can configure Exim's
1230 routers in many different ways, and there may be any number of routers in a
1231 configuration.
1232
1233 The first router that is specified in a configuration is often one that handles
1234 addresses in domains that are not recognized specifically by the local host.
1235 Typically these are addresses for arbitrary domains on the Internet. A precondition
1236 is set up which looks for the special domains known to the host (for example,
1237 its own domain name), and the router is run for addresses that do &'not'&
1238 match. Typically, this is a router that looks up domains in the DNS in order to
1239 find the hosts to which this address routes. If it succeeds, the address is
1240 assigned to a suitable SMTP transport; if it does not succeed, the router is
1241 configured to fail the address.
1242
1243 The second router is reached only when the domain is recognized as one that
1244 &"belongs"& to the local host. This router does redirection &-- also known as
1245 aliasing and forwarding. When it generates one or more new addresses from the
1246 original, each of them is routed independently from the start. Otherwise, the
1247 router may cause an address to fail, or it may simply decline to handle the
1248 address, in which case the address is passed to the next router.
1249
1250 The final router in many configurations is one that checks to see if the
1251 address belongs to a local mailbox. The precondition may involve a check to
1252 see if the local part is the name of a login account, or it may look up the
1253 local part in a file or a database. If its preconditions are not met, or if
1254 the router declines, we have reached the end of the routers. When this happens,
1255 the address is bounced.
1256
1257
1258
1259 .section "Processing an address for verification" "SECID16"
1260 .cindex "router" "for verification"
1261 .cindex "verifying address" "overview"
1262 As well as being used to decide how to deliver to an address, Exim's routers
1263 are also used for &'address verification'&. Verification can be requested as
1264 one of the checks to be performed in an ACL for incoming messages, on both
1265 sender and recipient addresses, and it can be tested using the &%-bv%& and
1266 &%-bvs%& command line options.
1267
1268 When an address is being verified, the routers are run in &"verify mode"&. This
1269 does not affect the way the routers work, but it is a state that can be
1270 detected. By this means, a router can be skipped or made to behave differently
1271 when verifying. A common example is a configuration in which the first router
1272 sends all messages to a message-scanning program unless they have been
1273 previously scanned. Thus, the first router accepts all addresses without any
1274 checking, making it useless for verifying. Normally, the &%no_verify%& option
1275 would be set for such a router, causing it to be skipped in verify mode.
1276
1277
1278
1279
1280 .section "Running an individual router" "SECTrunindrou"
1281 .cindex "router" "running details"
1282 .cindex "preconditions" "checking"
1283 .cindex "router" "result of running"
1284 As explained in the example above, a number of preconditions are checked before
1285 running a router. If any are not met, the router is skipped, and the address is
1286 passed to the next router. When all the preconditions on a router &'are'& met,
1287 the router is run. What happens next depends on the outcome, which is one of
1288 the following:
1289
1290 .ilist
1291 &'accept'&: The router accepts the address, and either assigns it to a
1292 transport or generates one or more &"child"& addresses. Processing the
1293 original address ceases
1294 .oindex "&%unseen%&"
1295 unless the &%unseen%& option is set on the router. This option
1296 can be used to set up multiple deliveries with different routing (for example,
1297 for keeping archive copies of messages). When &%unseen%& is set, the address is
1298 passed to the next router. Normally, however, an &'accept'& return marks the
1299 end of routing.
1300
1301 Any child addresses generated by the router are processed independently,
1302 starting with the first router by default. It is possible to change this by
1303 setting the &%redirect_router%& option to specify which router to start at for
1304 child addresses. Unlike &%pass_router%& (see below) the router specified by
1305 &%redirect_router%& may be anywhere in the router configuration.
1306 .next
1307 &'pass'&: The router recognizes the address, but cannot handle it itself. It
1308 requests that the address be passed to another router. By default, the address
1309 is passed to the next router, but this can be changed by setting the
1310 &%pass_router%& option. However, (unlike &%redirect_router%&) the named router
1311 must be below the current router (to avoid loops).
1312 .next
1313 &'decline'&: The router declines to accept the address because it does not
1314 recognize it at all. By default, the address is passed to the next router, but
1315 this can be prevented by setting the &%no_more%& option. When &%no_more%& is
1316 set, all the remaining routers are skipped. In effect, &%no_more%& converts
1317 &'decline'& into &'fail'&.
1318 .next
1319 &'fail'&: The router determines that the address should fail, and queues it for
1320 the generation of a bounce message. There is no further processing of the
1321 original address unless &%unseen%& is set on the router.
1322 .next
1323 &'defer'&: The router cannot handle the address at the present time. (A
1324 database may be offline, or a DNS lookup may have timed out.) No further
1325 processing of the address happens in this delivery attempt. It is tried again
1326 next time the message is considered for delivery.
1327 .next
1328 &'error'&: There is some error in the router (for example, a syntax error in
1329 its configuration). The action is as for defer.
1330 .endlist
1331
1332 If an address reaches the end of the routers without having been accepted by
1333 any of them, it is bounced as unrouteable. The default error message in this
1334 situation is &"unrouteable address"&, but you can set your own message by
1335 making use of the &%cannot_route_message%& option. This can be set for any
1336 router; the value from the last router that &"saw"& the address is used.
1337
1338 Sometimes while routing you want to fail a delivery when some conditions are
1339 met but others are not, instead of passing the address on for further routing.
1340 You can do this by having a second router that explicitly fails the delivery
1341 when the relevant conditions are met. The &(redirect)& router has a &"fail"&
1342 facility for this purpose.
1343
1344
1345 .section "Duplicate addresses" "SECID17"
1346 .cindex "case of local parts"
1347 .cindex "address duplicate, discarding"
1348 .cindex "duplicate addresses"
1349 Once routing is complete, Exim scans the addresses that are assigned to local
1350 and remote transports and discards any duplicates that it finds. During this
1351 check, local parts are treated case-sensitively. This happens only when
1352 actually delivering a message; when testing routers with &%-bt%&, all the
1353 routed addresses are shown.
1354
1355
1356
1357 .section "Router preconditions" "SECTrouprecon"
1358 .cindex "router" "preconditions, order of processing"
1359 .cindex "preconditions" "order of processing"
1360 The preconditions that are tested for each router are listed below, in the
1361 order in which they are tested. The individual configuration options are
1362 described in more detail in chapter &<<CHAProutergeneric>>&.
1363
1364 .ilist
1365 .cindex affix "router precondition"
1366 The &%local_part_prefix%& and &%local_part_suffix%& options can specify that
1367 the local parts handled by the router may or must have certain prefixes and/or
1368 suffixes. If a mandatory affix (prefix or suffix) is not present, the router is
1369 skipped. These conditions are tested first. When an affix is present, it is
1370 removed from the local part before further processing, including the evaluation
1371 of any other conditions.
1372 .next
1373 Routers can be designated for use only when not verifying an address, that is,
1374 only when routing it for delivery (or testing its delivery routing). If the
1375 &%verify%& option is set false, the router is skipped when Exim is verifying an
1376 address.
1377 Setting the &%verify%& option actually sets two options, &%verify_sender%& and
1378 &%verify_recipient%&, which independently control the use of the router for
1379 sender and recipient verification. You can set these options directly if
1380 you want a router to be used for only one type of verification.
1381 Note that cutthrough delivery is classed as a recipient verification for this purpose.
1382 .next
1383 If the &%address_test%& option is set false, the router is skipped when Exim is
1384 run with the &%-bt%& option to test an address routing. This can be helpful
1385 when the first router sends all new messages to a scanner of some sort; it
1386 makes it possible to use &%-bt%& to test subsequent delivery routing without
1387 having to simulate the effect of the scanner.
1388 .next
1389 Routers can be designated for use only when verifying an address, as
1390 opposed to routing it for delivery. The &%verify_only%& option controls this.
1391 Again, cutthrough delivery counts as a verification.
1392 .next
1393 Individual routers can be explicitly skipped when running the routers to
1394 check an address given in the SMTP EXPN command (see the &%expn%& option).
1395 .next
1396 If the &%domains%& option is set, the domain of the address must be in the set
1397 of domains that it defines.
1398 .next
1399 .vindex "&$local_part_prefix$&"
1400 .vindex "&$local_part$&"
1401 .vindex "&$local_part_suffix$&"
1402 .cindex affix "router precondition"
1403 If the &%local_parts%& option is set, the local part of the address must be in
1404 the set of local parts that it defines. If &%local_part_prefix%& or
1405 &%local_part_suffix%& is in use, the prefix or suffix is removed from the local
1406 part before this check. If you want to do precondition tests on local parts
1407 that include affixes, you can do so by using a &%condition%& option (see below)
1408 that uses the variables &$local_part$&, &$local_part_prefix$&, and
1409 &$local_part_suffix$& as necessary.
1410 .next
1411 .vindex "&$local_user_uid$&"
1412 .vindex "&$local_user_gid$&"
1413 .vindex "&$home$&"
1414 If the &%check_local_user%& option is set, the local part must be the name of
1415 an account on the local host. If this check succeeds, the uid and gid of the
1416 local user are placed in &$local_user_uid$& and &$local_user_gid$& and the
1417 user's home directory is placed in &$home$&; these values can be used in the
1418 remaining preconditions.
1419 .next
1420 If the &%router_home_directory%& option is set, it is expanded at this point,
1421 because it overrides the value of &$home$&. If this expansion were left till
1422 later, the value of &$home$& as set by &%check_local_user%& would be used in
1423 subsequent tests. Having two different values of &$home$& in the same router
1424 could lead to confusion.
1425 .next
1426 If the &%senders%& option is set, the envelope sender address must be in the
1427 set of addresses that it defines.
1428 .next
1429 If the &%require_files%& option is set, the existence or non-existence of
1430 specified files is tested.
1431 .next
1432 .cindex "customizing" "precondition"
1433 If the &%condition%& option is set, it is evaluated and tested. This option
1434 uses an expanded string to allow you to set up your own custom preconditions.
1435 Expanded strings are described in chapter &<<CHAPexpand>>&.
1436 .endlist
1437
1438
1439 Note that &%require_files%& comes near the end of the list, so you cannot use
1440 it to check for the existence of a file in which to lookup up a domain, local
1441 part, or sender. However, as these options are all expanded, you can use the
1442 &%exists%& expansion condition to make such tests within each condition. The
1443 &%require_files%& option is intended for checking files that the router may be
1444 going to use internally, or which are needed by a specific transport (for
1445 example, &_.procmailrc_&).
1446
1447
1448
1449 .section "Delivery in detail" "SECID18"
1450 .cindex "delivery" "in detail"
1451 When a message is to be delivered, the sequence of events is as follows:
1452
1453 .ilist
1454 If a system-wide filter file is specified, the message is passed to it. The
1455 filter may add recipients to the message, replace the recipients, discard the
1456 message, cause a new message to be generated, or cause the message delivery to
1457 fail. The format of the system filter file is the same as for Exim user filter
1458 files, described in the separate document entitled &'Exim's interfaces to mail
1459 filtering'&.
1460 .cindex "Sieve filter" "not available for system filter"
1461 (&*Note*&: Sieve cannot be used for system filter files.)
1462
1463 Some additional features are available in system filters &-- see chapter
1464 &<<CHAPsystemfilter>>& for details. Note that a message is passed to the system
1465 filter only once per delivery attempt, however many recipients it has. However,
1466 if there are several delivery attempts because one or more addresses could not
1467 be immediately delivered, the system filter is run each time. The filter
1468 condition &%first_delivery%& can be used to detect the first run of the system
1469 filter.
1470 .next
1471 Each recipient address is offered to each configured router, in turn, subject to
1472 its preconditions, until one is able to handle it. If no router can handle the
1473 address, that is, if they all decline, the address is failed. Because routers
1474 can be targeted at particular domains, several locally handled domains can be
1475 processed entirely independently of each other.
1476 .next
1477 .cindex "routing" "loops in"
1478 .cindex "loop" "while routing"
1479 A router that accepts an address may assign it to a local or a remote
1480 transport. However, the transport is not run at this time. Instead, the address
1481 is placed on a list for the particular transport, which will be run later.
1482 Alternatively, the router may generate one or more new addresses (typically
1483 from alias, forward, or filter files). New addresses are fed back into this
1484 process from the top, but in order to avoid loops, a router ignores any address
1485 which has an identically-named ancestor that was processed by itself.
1486 .next
1487 When all the routing has been done, addresses that have been successfully
1488 handled are passed to their assigned transports. When local transports are
1489 doing real local deliveries, they handle only one address at a time, but if a
1490 local transport is being used as a pseudo-remote transport (for example, to
1491 collect batched SMTP messages for transmission by some other means) multiple
1492 addresses can be handled. Remote transports can always handle more than one
1493 address at a time, but can be configured not to do so, or to restrict multiple
1494 addresses to the same domain.
1495 .next
1496 Each local delivery to a file or a pipe runs in a separate process under a
1497 non-privileged uid, and these deliveries are run one at a time. Remote
1498 deliveries also run in separate processes, normally under a uid that is private
1499 to Exim (&"the Exim user"&), but in this case, several remote deliveries can be
1500 run in parallel. The maximum number of simultaneous remote deliveries for any
1501 one message is set by the &%remote_max_parallel%& option.
1502 The order in which deliveries are done is not defined, except that all local
1503 deliveries happen before any remote deliveries.
1504 .next
1505 .cindex "queue runner"
1506 When it encounters a local delivery during a queue run, Exim checks its retry
1507 database to see if there has been a previous temporary delivery failure for the
1508 address before running the local transport. If there was a previous failure,
1509 Exim does not attempt a new delivery until the retry time for the address is
1510 reached. However, this happens only for delivery attempts that are part of a
1511 queue run. Local deliveries are always attempted when delivery immediately
1512 follows message reception, even if retry times are set for them. This makes for
1513 better behaviour if one particular message is causing problems (for example,
1514 causing quota overflow, or provoking an error in a filter file).
1515 .next
1516 .cindex "delivery" "retry in remote transports"
1517 Remote transports do their own retry handling, since an address may be
1518 deliverable to one of a number of hosts, each of which may have a different
1519 retry time. If there have been previous temporary failures and no host has
1520 reached its retry time, no delivery is attempted, whether in a queue run or
1521 not. See chapter &<<CHAPretry>>& for details of retry strategies.
1522 .next
1523 If there were any permanent errors, a bounce message is returned to an
1524 appropriate address (the sender in the common case), with details of the error
1525 for each failing address. Exim can be configured to send copies of bounce
1526 messages to other addresses.
1527 .next
1528 .cindex "delivery" "deferral"
1529 If one or more addresses suffered a temporary failure, the message is left on
1530 the queue, to be tried again later. Delivery of these addresses is said to be
1531 &'deferred'&.
1532 .next
1533 When all the recipient addresses have either been delivered or bounced,
1534 handling of the message is complete. The spool files and message log are
1535 deleted, though the message log can optionally be preserved if required.
1536 .endlist
1537
1538
1539
1540
1541 .section "Retry mechanism" "SECID19"
1542 .cindex "delivery" "retry mechanism"
1543 .cindex "retry" "description of mechanism"
1544 .cindex "queue runner"
1545 Exim's mechanism for retrying messages that fail to get delivered at the first
1546 attempt is the queue runner process. You must either run an Exim daemon that
1547 uses the &%-q%& option with a time interval to start queue runners at regular
1548 intervals or use some other means (such as &'cron'&) to start them. If you do
1549 not arrange for queue runners to be run, messages that fail temporarily at the
1550 first attempt will remain in your queue forever. A queue runner process works
1551 its way through the queue, one message at a time, trying each delivery that has
1552 passed its retry time.
1553 You can run several queue runners at once.
1554
1555 Exim uses a set of configured rules to determine when next to retry the failing
1556 address (see chapter &<<CHAPretry>>&). These rules also specify when Exim
1557 should give up trying to deliver to the address, at which point it generates a
1558 bounce message. If no retry rules are set for a particular host, address, and
1559 error combination, no retries are attempted, and temporary errors are treated
1560 as permanent.
1561
1562
1563
1564 .section "Temporary delivery failure" "SECID20"
1565 .cindex "delivery" "temporary failure"
1566 There are many reasons why a message may not be immediately deliverable to a
1567 particular address. Failure to connect to a remote machine (because it, or the
1568 connection to it, is down) is one of the most common. Temporary failures may be
1569 detected during routing as well as during the transport stage of delivery.
1570 Local deliveries may be delayed if NFS files are unavailable, or if a mailbox
1571 is on a file system where the user is over quota. Exim can be configured to
1572 impose its own quotas on local mailboxes; where system quotas are set they will
1573 also apply.
1574
1575 If a host is unreachable for a period of time, a number of messages may be
1576 waiting for it by the time it recovers, and sending them in a single SMTP
1577 connection is clearly beneficial. Whenever a delivery to a remote host is
1578 deferred,
1579 .cindex "hints database" "deferred deliveries"
1580 Exim makes a note in its hints database, and whenever a successful
1581 SMTP delivery has happened, it looks to see if any other messages are waiting
1582 for the same host. If any are found, they are sent over the same SMTP
1583 connection, subject to a configuration limit as to the maximum number in any
1584 one connection.
1585
1586
1587
1588 .section "Permanent delivery failure" "SECID21"
1589 .cindex "delivery" "permanent failure"
1590 .cindex "bounce message" "when generated"
1591 When a message cannot be delivered to some or all of its intended recipients, a
1592 bounce message is generated. Temporary delivery failures turn into permanent
1593 errors when their timeout expires. All the addresses that fail in a given
1594 delivery attempt are listed in a single message. If the original message has
1595 many recipients, it is possible for some addresses to fail in one delivery
1596 attempt and others to fail subsequently, giving rise to more than one bounce
1597 message. The wording of bounce messages can be customized by the administrator.
1598 See chapter &<<CHAPemsgcust>>& for details.
1599
1600 .cindex "&'X-Failed-Recipients:'& header line"
1601 Bounce messages contain an &'X-Failed-Recipients:'& header line that lists the
1602 failed addresses, for the benefit of programs that try to analyse such messages
1603 automatically.
1604
1605 .cindex "bounce message" "recipient of"
1606 A bounce message is normally sent to the sender of the original message, as
1607 obtained from the message's envelope. For incoming SMTP messages, this is the
1608 address given in the MAIL command. However, when an address is expanded via a
1609 forward or alias file, an alternative address can be specified for delivery
1610 failures of the generated addresses. For a mailing list expansion (see section
1611 &<<SECTmailinglists>>&) it is common to direct bounce messages to the manager
1612 of the list.
1613
1614
1615
1616 .section "Failures to deliver bounce messages" "SECID22"
1617 .cindex "bounce message" "failure to deliver"
1618 If a bounce message (either locally generated or received from a remote host)
1619 itself suffers a permanent delivery failure, the message is left in the queue,
1620 but it is frozen, awaiting the attention of an administrator. There are options
1621 that can be used to make Exim discard such failed messages, or to keep them
1622 for only a short time (see &%timeout_frozen_after%& and
1623 &%ignore_bounce_errors_after%&).
1624
1625
1626
1627
1628
1629 . ////////////////////////////////////////////////////////////////////////////
1630 . ////////////////////////////////////////////////////////////////////////////
1631
1632 .chapter "Building and installing Exim" "CHID3"
1633 .scindex IIDbuex "building Exim"
1634
1635 .section "Unpacking" "SECID23"
1636 Exim is distributed as a gzipped or bzipped tar file which, when unpacked,
1637 creates a directory with the name of the current release (for example,
1638 &_exim-&version()_&) into which the following files are placed:
1639
1640 .table2 140pt
1641 .irow &_ACKNOWLEDGMENTS_& "contains some acknowledgments"
1642 .irow &_CHANGES_&         "contains a reference to where changes are &&&
1643   documented"
1644 .irow &_LICENCE_&         "the GNU General Public Licence"
1645 .irow &_Makefile_&        "top-level make file"
1646 .irow &_NOTICE_&          "conditions for the use of Exim"
1647 .irow &_README_&          "list of files, directories and simple build &&&
1648   instructions"
1649 .endtable
1650
1651 Other files whose names begin with &_README_& may also be present. The
1652 following subdirectories are created:
1653
1654 .table2 140pt
1655 .irow &_Local_&           "an empty directory for local configuration files"
1656 .irow &_OS_&              "OS-specific files"
1657 .irow &_doc_&             "documentation files"
1658 .irow &_exim_monitor_&    "source files for the Exim monitor"
1659 .irow &_scripts_&         "scripts used in the build process"
1660 .irow &_src_&             "remaining source files"
1661 .irow &_util_&            "independent utilities"
1662 .endtable
1663
1664 The main utility programs are contained in the &_src_& directory and are built
1665 with the Exim binary. The &_util_& directory contains a few optional scripts
1666 that may be useful to some sites.
1667
1668
1669 .section "Multiple machine architectures and operating systems" "SECID24"
1670 .cindex "building Exim" "multiple OS/architectures"
1671 The building process for Exim is arranged to make it easy to build binaries for
1672 a number of different architectures and operating systems from the same set of
1673 source files. Compilation does not take place in the &_src_& directory.
1674 Instead, a &'build directory'& is created for each architecture and operating
1675 system.
1676 .cindex "symbolic link" "to build directory"
1677 Symbolic links to the sources are installed in this directory, which is where
1678 the actual building takes place. In most cases, Exim can discover the machine
1679 architecture and operating system for itself, but the defaults can be
1680 overridden if necessary.
1681 .cindex compiler requirements
1682 .cindex compiler version
1683 A C99-capable compiler will be required for the build.
1684
1685
1686 .section "PCRE library" "SECTpcre"
1687 .cindex "PCRE library"
1688 Exim no longer has an embedded PCRE library as the vast majority of
1689 modern systems include PCRE as a system library, although you may need to
1690 install the PCRE package or the PCRE development package for your operating
1691 system. If your system has a normal PCRE installation the Exim build
1692 process will need no further configuration. If the library or the
1693 headers are in an unusual location you will need to either set the PCRE_LIBS
1694 and INCLUDE directives appropriately,
1695 or set PCRE_CONFIG=yes to use the installed &(pcre-config)& command.
1696 If your operating system has no
1697 PCRE support then you will need to obtain and build the current PCRE
1698 from &url(ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/).
1699 More information on PCRE is available at &url(https://www.pcre.org/).
1700
1701 .section "DBM libraries" "SECTdb"
1702 .cindex "DBM libraries" "discussion of"
1703 .cindex "hints database" "DBM files used for"
1704 Even if you do not use any DBM files in your configuration, Exim still needs a
1705 DBM library in order to operate, because it uses indexed files for its hints
1706 databases. Unfortunately, there are a number of DBM libraries in existence, and
1707 different operating systems often have different ones installed.
1708
1709 .cindex "Solaris" "DBM library for"
1710 .cindex "IRIX, DBM library for"
1711 .cindex "BSD, DBM library for"
1712 .cindex "Linux, DBM library for"
1713 If you are using Solaris, IRIX, one of the modern BSD systems, or a modern
1714 Linux distribution, the DBM configuration should happen automatically, and you
1715 may be able to ignore this section. Otherwise, you may have to learn more than
1716 you would like about DBM libraries from what follows.
1717
1718 .cindex "&'ndbm'& DBM library"
1719 Licensed versions of Unix normally contain a library of DBM functions operating
1720 via the &'ndbm'& interface, and this is what Exim expects by default. Free
1721 versions of Unix seem to vary in what they contain as standard. In particular,
1722 some early versions of Linux have no default DBM library, and different
1723 distributors have chosen to bundle different libraries with their packaged
1724 versions. However, the more recent releases seem to have standardized on the
1725 Berkeley DB library.
1726
1727 Different DBM libraries have different conventions for naming the files they
1728 use. When a program opens a file called &_dbmfile_&, there are several
1729 possibilities:
1730
1731 .olist
1732 A traditional &'ndbm'& implementation, such as that supplied as part of
1733 Solaris, operates on two files called &_dbmfile.dir_& and &_dbmfile.pag_&.
1734 .next
1735 .cindex "&'gdbm'& DBM library"
1736 The GNU library, &'gdbm'&, operates on a single file. If used via its &'ndbm'&
1737 compatibility interface it makes two different hard links to it with names
1738 &_dbmfile.dir_& and &_dbmfile.pag_&, but if used via its native interface, the
1739 filename is used unmodified.
1740 .next
1741 .cindex "Berkeley DB library"
1742 The Berkeley DB package, if called via its &'ndbm'& compatibility interface,
1743 operates on a single file called &_dbmfile.db_&, but otherwise looks to the
1744 programmer exactly the same as the traditional &'ndbm'& implementation.
1745 .next
1746 If the Berkeley package is used in its native mode, it operates on a single
1747 file called &_dbmfile_&; the programmer's interface is somewhat different to
1748 the traditional &'ndbm'& interface.
1749 .next
1750 To complicate things further, there are several very different versions of the
1751 Berkeley DB package. Version 1.85 was stable for a very long time, releases
1752 2.&'x'& and 3.&'x'& were current for a while, but the latest versions when Exim last revamped support were numbered 4.&'x'&.
1753 Maintenance of some of the earlier releases has ceased. All versions of
1754 Berkeley DB could be obtained from
1755 &url(http://www.sleepycat.com/), which is now a redirect to their new owner's
1756 page with far newer versions listed.
1757 It is probably wise to plan to move your storage configurations away from
1758 Berkeley DB format, as today there are smaller and simpler alternatives more
1759 suited to Exim's usage model.
1760 .next
1761 .cindex "&'tdb'& DBM library"
1762 Yet another DBM library, called &'tdb'&, is available from
1763 &url(https://sourceforge.net/projects/tdb/files/). It has its own interface, and also
1764 operates on a single file.
1765 .endlist
1766
1767 .cindex "USE_DB"
1768 .cindex "DBM libraries" "configuration for building"
1769 Exim and its utilities can be compiled to use any of these interfaces. In order
1770 to use any version of the Berkeley DB package in native mode, you must set
1771 USE_DB in an appropriate configuration file (typically
1772 &_Local/Makefile_&). For example:
1773 .code
1774 USE_DB=yes
1775 .endd
1776 Similarly, for gdbm you set USE_GDBM, and for tdb you set USE_TDB. An
1777 error is diagnosed if you set more than one of these.
1778
1779 At the lowest level, the build-time configuration sets none of these options,
1780 thereby assuming an interface of type (1). However, some operating system
1781 configuration files (for example, those for the BSD operating systems and
1782 Linux) assume type (4) by setting USE_DB as their default, and the
1783 configuration files for Cygwin set USE_GDBM. Anything you set in
1784 &_Local/Makefile_&, however, overrides these system defaults.
1785
1786 As well as setting USE_DB, USE_GDBM, or USE_TDB, it may also be
1787 necessary to set DBMLIB, to cause inclusion of the appropriate library, as
1788 in one of these lines:
1789 .code
1790 DBMLIB = -ldb
1791 DBMLIB = -ltdb
1792 .endd
1793 Settings like that will work if the DBM library is installed in the standard
1794 place. Sometimes it is not, and the library's header file may also not be in
1795 the default path. You may need to set INCLUDE to specify where the header
1796 file is, and to specify the path to the library more fully in DBMLIB, as in
1797 this example:
1798 .code
1799 INCLUDE=-I/usr/local/include/db-4.1
1800 DBMLIB=/usr/local/lib/db-4.1/libdb.a
1801 .endd
1802 There is further detailed discussion about the various DBM libraries in the
1803 file &_doc/dbm.discuss.txt_& in the Exim distribution.
1804
1805
1806
1807 .section "Pre-building configuration" "SECID25"
1808 .cindex "building Exim" "pre-building configuration"
1809 .cindex "configuration for building Exim"
1810 .cindex "&_Local/Makefile_&"
1811 .cindex "&_src/EDITME_&"
1812 Before building Exim, a local configuration file that specifies options
1813 independent of any operating system has to be created with the name
1814 &_Local/Makefile_&. A template for this file is supplied as the file
1815 &_src/EDITME_&, and it contains full descriptions of all the option settings
1816 therein. These descriptions are therefore not repeated here. If you are
1817 building Exim for the first time, the simplest thing to do is to copy
1818 &_src/EDITME_& to &_Local/Makefile_&, then read it and edit it appropriately.
1819
1820 There are three settings that you must supply, because Exim will not build
1821 without them. They are the location of the runtime configuration file
1822 (CONFIGURE_FILE), the directory in which Exim binaries will be installed
1823 (BIN_DIRECTORY), and the identity of the Exim user (EXIM_USER and
1824 maybe EXIM_GROUP as well). The value of CONFIGURE_FILE can in fact be
1825 a colon-separated list of filenames; Exim uses the first of them that exists.
1826
1827 There are a few other parameters that can be specified either at build time or
1828 at runtime, to enable the same binary to be used on a number of different
1829 machines. However, if the locations of Exim's spool directory and log file
1830 directory (if not within the spool directory) are fixed, it is recommended that
1831 you specify them in &_Local/Makefile_& instead of at runtime, so that errors
1832 detected early in Exim's execution (such as a malformed configuration file) can
1833 be logged.
1834
1835 .cindex "content scanning" "specifying at build time"
1836 Exim's interfaces for calling virus and spam scanning software directly from
1837 access control lists are not compiled by default. If you want to include these
1838 facilities, you need to set
1839 .code
1840 WITH_CONTENT_SCAN=yes
1841 .endd
1842 in your &_Local/Makefile_&. For details of the facilities themselves, see
1843 chapter &<<CHAPexiscan>>&.
1844
1845
1846 .cindex "&_Local/eximon.conf_&"
1847 .cindex "&_exim_monitor/EDITME_&"
1848 If you are going to build the Exim monitor, a similar configuration process is
1849 required. The file &_exim_monitor/EDITME_& must be edited appropriately for
1850 your installation and saved under the name &_Local/eximon.conf_&. If you are
1851 happy with the default settings described in &_exim_monitor/EDITME_&,
1852 &_Local/eximon.conf_& can be empty, but it must exist.
1853
1854 This is all the configuration that is needed in straightforward cases for known
1855 operating systems. However, the building process is set up so that it is easy
1856 to override options that are set by default or by operating-system-specific
1857 configuration files, for example, to change the C compiler, which
1858 defaults to &%gcc%&. See section &<<SECToverride>>& below for details of how to
1859 do this.
1860
1861
1862
1863 .section "Support for iconv()" "SECID26"
1864 .cindex "&[iconv()]& support"
1865 .cindex "RFC 2047"
1866 The contents of header lines in messages may be encoded according to the rules
1867 described RFC 2047. This makes it possible to transmit characters that are not
1868 in the ASCII character set, and to label them as being in a particular
1869 character set. When Exim is inspecting header lines by means of the &%$h_%&
1870 mechanism, it decodes them, and translates them into a specified character set
1871 (default is set at build time). The translation is possible only if the operating system
1872 supports the &[iconv()]& function.
1873
1874 However, some of the operating systems that supply &[iconv()]& do not support
1875 very many conversions. The GNU &%libiconv%& library (available from
1876 &url(https://www.gnu.org/software/libiconv/)) can be installed on such
1877 systems to remedy this deficiency, as well as on systems that do not supply
1878 &[iconv()]& at all. After installing &%libiconv%&, you should add
1879 .code
1880 HAVE_ICONV=yes
1881 .endd
1882 to your &_Local/Makefile_& and rebuild Exim.
1883
1884
1885
1886 .section "Including TLS/SSL encryption support" "SECTinctlsssl"
1887 .cindex "TLS" "including support for TLS"
1888 .cindex "encryption" "including support for"
1889 .cindex "SUPPORT_TLS"
1890 .cindex "OpenSSL" "building Exim with"
1891 .cindex "GnuTLS" "building Exim with"
1892 Exim can be built to support encrypted SMTP connections, using the STARTTLS
1893 command as per RFC 2487. It can also support legacy clients that expect to
1894 start a TLS session immediately on connection to a non-standard port (see the
1895 &%tls_on_connect_ports%& runtime option and the &%-tls-on-connect%& command
1896 line option).
1897
1898 If you want to build Exim with TLS support, you must first install either the
1899 OpenSSL or GnuTLS library. There is no cryptographic code in Exim itself for
1900 implementing SSL.
1901
1902 If OpenSSL is installed, you should set
1903 .code
1904 SUPPORT_TLS=yes
1905 TLS_LIBS=-lssl -lcrypto
1906 .endd
1907 in &_Local/Makefile_&. You may also need to specify the locations of the
1908 OpenSSL library and include files. For example:
1909 .code
1910 SUPPORT_TLS=yes
1911 TLS_LIBS=-L/usr/local/openssl/lib -lssl -lcrypto
1912 TLS_INCLUDE=-I/usr/local/openssl/include/
1913 .endd
1914 .cindex "pkg-config" "OpenSSL"
1915 If you have &'pkg-config'& available, then instead you can just use:
1916 .code
1917 SUPPORT_TLS=yes
1918 USE_OPENSSL_PC=openssl
1919 .endd
1920 .cindex "USE_GNUTLS"
1921 If GnuTLS is installed, you should set
1922 .code
1923 SUPPORT_TLS=yes
1924 USE_GNUTLS=yes
1925 TLS_LIBS=-lgnutls -ltasn1 -lgcrypt
1926 .endd
1927 in &_Local/Makefile_&, and again you may need to specify the locations of the
1928 library and include files. For example:
1929 .code
1930 SUPPORT_TLS=yes
1931 USE_GNUTLS=yes
1932 TLS_LIBS=-L/usr/gnu/lib -lgnutls -ltasn1 -lgcrypt
1933 TLS_INCLUDE=-I/usr/gnu/include
1934 .endd
1935 .cindex "pkg-config" "GnuTLS"
1936 If you have &'pkg-config'& available, then instead you can just use:
1937 .code
1938 SUPPORT_TLS=yes
1939 USE_GNUTLS=yes
1940 USE_GNUTLS_PC=gnutls
1941 .endd
1942
1943 You do not need to set TLS_INCLUDE if the relevant directory is already
1944 specified in INCLUDE. Details of how to configure Exim to make use of TLS are
1945 given in chapter &<<CHAPTLS>>&.
1946
1947
1948
1949
1950 .section "Use of tcpwrappers" "SECID27"
1951
1952 .cindex "tcpwrappers, building Exim to support"
1953 .cindex "USE_TCP_WRAPPERS"
1954 .cindex "TCP_WRAPPERS_DAEMON_NAME"
1955 .cindex "tcp_wrappers_daemon_name"
1956 Exim can be linked with the &'tcpwrappers'& library in order to check incoming
1957 SMTP calls using the &'tcpwrappers'& control files. This may be a convenient
1958 alternative to Exim's own checking facilities for installations that are
1959 already making use of &'tcpwrappers'& for other purposes. To do this, you
1960 should set USE_TCP_WRAPPERS in &_Local/Makefile_&, arrange for the file
1961 &_tcpd.h_& to be available at compile time, and also ensure that the library
1962 &_libwrap.a_& is available at link time, typically by including &%-lwrap%& in
1963 EXTRALIBS_EXIM. For example, if &'tcpwrappers'& is installed in &_/usr/local_&,
1964 you might have
1965 .code
1966 USE_TCP_WRAPPERS=yes
1967 CFLAGS=-O -I/usr/local/include
1968 EXTRALIBS_EXIM=-L/usr/local/lib -lwrap
1969 .endd
1970 in &_Local/Makefile_&. The daemon name to use in the &'tcpwrappers'& control
1971 files is &"exim"&. For example, the line
1972 .code
1973 exim : LOCAL  192.168.1.  .friendly.domain.example
1974 .endd
1975 in your &_/etc/hosts.allow_& file allows connections from the local host, from
1976 the subnet 192.168.1.0/24, and from all hosts in &'friendly.domain.example'&.
1977 All other connections are denied. The daemon name used by &'tcpwrappers'&
1978 can be changed at build time by setting TCP_WRAPPERS_DAEMON_NAME in
1979 &_Local/Makefile_&, or by setting tcp_wrappers_daemon_name in the
1980 configure file. Consult the &'tcpwrappers'& documentation for
1981 further details.
1982
1983
1984 .section "Including support for IPv6" "SECID28"
1985 .cindex "IPv6" "including support for"
1986 Exim contains code for use on systems that have IPv6 support. Setting
1987 &`HAVE_IPV6=YES`& in &_Local/Makefile_& causes the IPv6 code to be included;
1988 it may also be necessary to set IPV6_INCLUDE and IPV6_LIBS on systems
1989 where the IPv6 support is not fully integrated into the normal include and
1990 library files.
1991
1992 Two different types of DNS record for handling IPv6 addresses have been
1993 defined. AAAA records (analogous to A records for IPv4) are in use, and are
1994 currently seen as the mainstream. Another record type called A6 was proposed
1995 as better than AAAA because it had more flexibility. However, it was felt to be
1996 over-complex, and its status was reduced to &"experimental"&.
1997 Exim used to
1998 have a compile option for including A6 record support but this has now been
1999 withdrawn.
2000
2001
2002
2003 .section "Dynamically loaded lookup module support" "SECTdynamicmodules"
2004 .cindex "lookup modules"
2005 .cindex "dynamic modules"
2006 .cindex ".so building"
2007 On some platforms, Exim supports not compiling all lookup types directly into
2008 the main binary, instead putting some into external modules which can be loaded
2009 on demand.
2010 This permits packagers to build Exim with support for lookups with extensive
2011 library dependencies without requiring all users to install all of those
2012 dependencies.
2013 Most, but not all, lookup types can be built this way.
2014
2015 Set &`LOOKUP_MODULE_DIR`& to the directory into which the modules will be
2016 installed; Exim will only load modules from that directory, as a security
2017 measure.  You will need to set &`CFLAGS_DYNAMIC`& if not already defined
2018 for your OS; see &_OS/Makefile-Linux_& for an example.
2019 Some other requirements for adjusting &`EXTRALIBS`& may also be necessary,
2020 see &_src/EDITME_& for details.
2021
2022 Then, for each module to be loaded dynamically, define the relevant
2023 &`LOOKUP_`&<&'lookup_type'&> flags to have the value "2" instead of "yes".
2024 For example, this will build in lsearch but load sqlite and mysql support
2025 on demand:
2026 .code
2027 LOOKUP_LSEARCH=yes
2028 LOOKUP_SQLITE=2
2029 LOOKUP_MYSQL=2
2030 .endd
2031
2032
2033 .section "The building process" "SECID29"
2034 .cindex "build directory"
2035 Once &_Local/Makefile_& (and &_Local/eximon.conf_&, if required) have been
2036 created, run &'make'& at the top level. It determines the architecture and
2037 operating system types, and creates a build directory if one does not exist.
2038 For example, on a Sun system running Solaris 8, the directory
2039 &_build-SunOS5-5.8-sparc_& is created.
2040 .cindex "symbolic link" "to source files"
2041 Symbolic links to relevant source files are installed in the build directory.
2042
2043 If this is the first time &'make'& has been run, it calls a script that builds
2044 a make file inside the build directory, using the configuration files from the
2045 &_Local_& directory. The new make file is then passed to another instance of
2046 &'make'&. This does the real work, building a number of utility scripts, and
2047 then compiling and linking the binaries for the Exim monitor (if configured), a
2048 number of utility programs, and finally Exim itself. The command &`make
2049 makefile`& can be used to force a rebuild of the make file in the build
2050 directory, should this ever be necessary.
2051
2052 If you have problems building Exim, check for any comments there may be in the
2053 &_README_& file concerning your operating system, and also take a look at the
2054 FAQ, where some common problems are covered.
2055
2056
2057
2058 .section 'Output from &"make"&' "SECID283"
2059 The output produced by the &'make'& process for compile lines is often very
2060 unreadable, because these lines can be very long. For this reason, the normal
2061 output is suppressed by default, and instead output similar to that which
2062 appears when compiling the 2.6 Linux kernel is generated: just a short line for
2063 each module that is being compiled or linked. However, it is still possible to
2064 get the full output, by calling &'make'& like this:
2065 .code
2066 FULLECHO='' make -e
2067 .endd
2068 The value of FULLECHO defaults to &"@"&, the flag character that suppresses
2069 command reflection in &'make'&. When you ask for the full output, it is
2070 given in addition to the short output.
2071
2072
2073
2074 .section "Overriding build-time options for Exim" "SECToverride"
2075 .cindex "build-time options, overriding"
2076 The main make file that is created at the beginning of the building process
2077 consists of the concatenation of a number of files which set configuration
2078 values, followed by a fixed set of &'make'& instructions. If a value is set
2079 more than once, the last setting overrides any previous ones. This provides a
2080 convenient way of overriding defaults. The files that are concatenated are, in
2081 order:
2082 .display
2083 &_OS/Makefile-Default_&
2084 &_OS/Makefile-_&<&'ostype'&>
2085 &_Local/Makefile_&
2086 &_Local/Makefile-_&<&'ostype'&>
2087 &_Local/Makefile-_&<&'archtype'&>
2088 &_Local/Makefile-_&<&'ostype'&>-<&'archtype'&>
2089 &_OS/Makefile-Base_&
2090 .endd
2091 .cindex "&_Local/Makefile_&"
2092 .cindex "building Exim" "operating system type"
2093 .cindex "building Exim" "architecture type"
2094 where <&'ostype'&> is the operating system type and <&'archtype'&> is the
2095 architecture type. &_Local/Makefile_& is required to exist, and the building
2096 process fails if it is absent. The other three &_Local_& files are optional,
2097 and are often not needed.
2098
2099 The values used for <&'ostype'&> and <&'archtype'&> are obtained from scripts
2100 called &_scripts/os-type_& and &_scripts/arch-type_& respectively. If either of
2101 the environment variables EXIM_OSTYPE or EXIM_ARCHTYPE is set, their
2102 values are used, thereby providing a means of forcing particular settings.
2103 Otherwise, the scripts try to get values from the &%uname%& command. If this
2104 fails, the shell variables OSTYPE and ARCHTYPE are inspected. A number
2105 of &'ad hoc'& transformations are then applied, to produce the standard names
2106 that Exim expects. You can run these scripts directly from the shell in order
2107 to find out what values are being used on your system.
2108
2109
2110 &_OS/Makefile-Default_& contains comments about the variables that are set
2111 therein. Some (but not all) are mentioned below. If there is something that
2112 needs changing, review the contents of this file and the contents of the make
2113 file for your operating system (&_OS/Makefile-<ostype>_&) to see what the
2114 default values are.
2115
2116
2117 .cindex "building Exim" "overriding default settings"
2118 If you need to change any of the values that are set in &_OS/Makefile-Default_&
2119 or in &_OS/Makefile-<ostype>_&, or to add any new definitions, you do not
2120 need to change the original files. Instead, you should make the changes by
2121 putting the new values in an appropriate &_Local_& file. For example,
2122 .cindex "Tru64-Unix build-time settings"
2123 when building Exim in many releases of the Tru64-Unix (formerly Digital UNIX,
2124 formerly DEC-OSF1) operating system, it is necessary to specify that the C
2125 compiler is called &'cc'& rather than &'gcc'&. Also, the compiler must be
2126 called with the option &%-std1%&, to make it recognize some of the features of
2127 Standard C that Exim uses. (Most other compilers recognize Standard C by
2128 default.) To do this, you should create a file called &_Local/Makefile-OSF1_&
2129 containing the lines
2130 .code
2131 CC=cc
2132 CFLAGS=-std1
2133 .endd
2134 If you are compiling for just one operating system, it may be easier to put
2135 these lines directly into &_Local/Makefile_&.
2136
2137 Keeping all your local configuration settings separate from the distributed
2138 files makes it easy to transfer them to new versions of Exim simply by copying
2139 the contents of the &_Local_& directory.
2140
2141
2142 .cindex "NIS lookup type" "including support for"
2143 .cindex "NIS+ lookup type" "including support for"
2144 .cindex "LDAP" "including support for"
2145 .cindex "lookup" "inclusion in binary"
2146 Exim contains support for doing LDAP, NIS, NIS+, and other kinds of file
2147 lookup, but not all systems have these components installed, so the default is
2148 not to include the relevant code in the binary. All the different kinds of file
2149 and database lookup that Exim supports are implemented as separate code modules
2150 which are included only if the relevant compile-time options are set. In the
2151 case of LDAP, NIS, and NIS+, the settings for &_Local/Makefile_& are:
2152 .code
2153 LOOKUP_LDAP=yes
2154 LOOKUP_NIS=yes
2155 LOOKUP_NISPLUS=yes
2156 .endd
2157 and similar settings apply to the other lookup types. They are all listed in
2158 &_src/EDITME_&. In many cases the relevant include files and interface
2159 libraries need to be installed before compiling Exim.
2160 .cindex "cdb" "including support for"
2161 However, there are some optional lookup types (such as cdb) for which
2162 the code is entirely contained within Exim, and no external include
2163 files or libraries are required. When a lookup type is not included in the
2164 binary, attempts to configure Exim to use it cause runtime configuration
2165 errors.
2166
2167 .cindex "pkg-config" "lookups"
2168 .cindex "pkg-config" "authenticators"
2169 Many systems now use a tool called &'pkg-config'& to encapsulate information
2170 about how to compile against a library; Exim has some initial support for
2171 being able to use pkg-config for lookups and authenticators.  For any given
2172 makefile variable which starts &`LOOKUP_`& or &`AUTH_`&, you can add a new
2173 variable with the &`_PC`& suffix in the name and assign as the value the
2174 name of the package to be queried.  The results of querying via the
2175 &'pkg-config'& command will be added to the appropriate Makefile variables
2176 with &`+=`& directives, so your version of &'make'& will need to support that
2177 syntax.  For instance:
2178 .code
2179 LOOKUP_SQLITE=yes
2180 LOOKUP_SQLITE_PC=sqlite3
2181 AUTH_GSASL=yes
2182 AUTH_GSASL_PC=libgsasl
2183 AUTH_HEIMDAL_GSSAPI=yes
2184 AUTH_HEIMDAL_GSSAPI_PC=heimdal-gssapi
2185 .endd
2186
2187 .cindex "Perl" "including support for"
2188 Exim can be linked with an embedded Perl interpreter, allowing Perl
2189 subroutines to be called during string expansion. To enable this facility,
2190 .code
2191 EXIM_PERL=perl.o
2192 .endd
2193 must be defined in &_Local/Makefile_&. Details of this facility are given in
2194 chapter &<<CHAPperl>>&.
2195
2196 .cindex "X11 libraries, location of"
2197 The location of the X11 libraries is something that varies a lot between
2198 operating systems, and there may be different versions of X11 to cope
2199 with. Exim itself makes no use of X11, but if you are compiling the Exim
2200 monitor, the X11 libraries must be available.
2201 The following three variables are set in &_OS/Makefile-Default_&:
2202 .code
2203 X11=/usr/X11R6
2204 XINCLUDE=-I$(X11)/include
2205 XLFLAGS=-L$(X11)/lib
2206 .endd
2207 These are overridden in some of the operating-system configuration files. For
2208 example, in &_OS/Makefile-SunOS5_& there is
2209 .code
2210 X11=/usr/openwin
2211 XINCLUDE=-I$(X11)/include
2212 XLFLAGS=-L$(X11)/lib -R$(X11)/lib
2213 .endd
2214 If you need to override the default setting for your operating system, place a
2215 definition of all three of these variables into your
2216 &_Local/Makefile-<ostype>_& file.
2217
2218 .cindex "EXTRALIBS"
2219 If you need to add any extra libraries to the link steps, these can be put in a
2220 variable called EXTRALIBS, which appears in all the link commands, but by
2221 default is not defined. In contrast, EXTRALIBS_EXIM is used only on the
2222 command for linking the main Exim binary, and not for any associated utilities.
2223
2224 .cindex "DBM libraries" "configuration for building"
2225 There is also DBMLIB, which appears in the link commands for binaries that
2226 use DBM functions (see also section &<<SECTdb>>&). Finally, there is
2227 EXTRALIBS_EXIMON, which appears only in the link step for the Exim monitor
2228 binary, and which can be used, for example, to include additional X11
2229 libraries.
2230
2231 .cindex "configuration file" "editing"
2232 The make file copes with rebuilding Exim correctly if any of the configuration
2233 files are edited. However, if an optional configuration file is deleted, it is
2234 necessary to touch the associated non-optional file (that is,
2235 &_Local/Makefile_& or &_Local/eximon.conf_&) before rebuilding.
2236
2237
2238 .section "OS-specific header files" "SECID30"
2239 .cindex "&_os.h_&"
2240 .cindex "building Exim" "OS-specific C header files"
2241 The &_OS_& directory contains a number of files with names of the form
2242 &_os.h-<ostype>_&. These are system-specific C header files that should not
2243 normally need to be changed. There is a list of macro settings that are
2244 recognized in the file &_OS/os.configuring_&, which should be consulted if you
2245 are porting Exim to a new operating system.
2246
2247
2248
2249 .section "Overriding build-time options for the monitor" "SECID31"
2250 .cindex "building Eximon"
2251 A similar process is used for overriding things when building the Exim monitor,
2252 where the files that are involved are
2253 .display
2254 &_OS/eximon.conf-Default_&
2255 &_OS/eximon.conf-_&<&'ostype'&>
2256 &_Local/eximon.conf_&
2257 &_Local/eximon.conf-_&<&'ostype'&>
2258 &_Local/eximon.conf-_&<&'archtype'&>
2259 &_Local/eximon.conf-_&<&'ostype'&>-<&'archtype'&>
2260 .endd
2261 .cindex "&_Local/eximon.conf_&"
2262 As with Exim itself, the final three files need not exist, and in this case the
2263 &_OS/eximon.conf-<ostype>_& file is also optional. The default values in
2264 &_OS/eximon.conf-Default_& can be overridden dynamically by setting environment
2265 variables of the same name, preceded by EXIMON_. For example, setting
2266 EXIMON_LOG_DEPTH in the environment overrides the value of
2267 LOG_DEPTH at runtime.
2268 .ecindex IIDbuex
2269
2270
2271 .section "Installing Exim binaries and scripts" "SECID32"
2272 .cindex "installing Exim"
2273 .cindex "BIN_DIRECTORY"
2274 The command &`make install`& runs the &(exim_install)& script with no
2275 arguments. The script copies binaries and utility scripts into the directory
2276 whose name is specified by the BIN_DIRECTORY setting in &_Local/Makefile_&.
2277 .cindex "setuid" "installing Exim with"
2278 The install script copies files only if they are newer than the files they are
2279 going to replace. The Exim binary is required to be owned by root and have the
2280 &'setuid'& bit set, for normal configurations. Therefore, you must run &`make
2281 install`& as root so that it can set up the Exim binary in this way. However, in
2282 some special situations (for example, if a host is doing no local deliveries)
2283 it may be possible to run Exim without making the binary setuid root (see
2284 chapter &<<CHAPsecurity>>& for details).
2285
2286 .cindex "CONFIGURE_FILE"
2287 Exim's runtime configuration file is named by the CONFIGURE_FILE setting
2288 in &_Local/Makefile_&. If this names a single file, and the file does not
2289 exist, the default configuration file &_src/configure.default_& is copied there
2290 by the installation script. If a runtime configuration file already exists, it
2291 is left alone. If CONFIGURE_FILE is a colon-separated list, naming several
2292 alternative files, no default is installed.
2293
2294 .cindex "system aliases file"
2295 .cindex "&_/etc/aliases_&"
2296 One change is made to the default configuration file when it is installed: the
2297 default configuration contains a router that references a system aliases file.
2298 The path to this file is set to the value specified by
2299 SYSTEM_ALIASES_FILE in &_Local/Makefile_& (&_/etc/aliases_& by default).
2300 If the system aliases file does not exist, the installation script creates it,
2301 and outputs a comment to the user.
2302
2303 The created file contains no aliases, but it does contain comments about the
2304 aliases a site should normally have. Mail aliases have traditionally been
2305 kept in &_/etc/aliases_&. However, some operating systems are now using
2306 &_/etc/mail/aliases_&. You should check if yours is one of these, and change
2307 Exim's configuration if necessary.
2308
2309 The default configuration uses the local host's name as the only local domain,
2310 and is set up to do local deliveries into the shared directory &_/var/mail_&,
2311 running as the local user. System aliases and &_.forward_& files in users' home
2312 directories are supported, but no NIS or NIS+ support is configured. Domains
2313 other than the name of the local host are routed using the DNS, with delivery
2314 over SMTP.
2315
2316 It is possible to install Exim for special purposes (such as building a binary
2317 distribution) in a private part of the file system. You can do this by a
2318 command such as
2319 .code
2320 make DESTDIR=/some/directory/ install
2321 .endd
2322 This has the effect of pre-pending the specified directory to all the file
2323 paths, except the name of the system aliases file that appears in the default
2324 configuration. (If a default alias file is created, its name &'is'& modified.)
2325 For backwards compatibility, ROOT is used if DESTDIR is not set,
2326 but this usage is deprecated.
2327
2328 .cindex "installing Exim" "what is not installed"
2329 Running &'make install'& does not copy the Exim 4 conversion script
2330 &'convert4r4'&. You will probably run this only once if you are
2331 upgrading from Exim 3. None of the documentation files in the &_doc_&
2332 directory are copied, except for the info files when you have set
2333 INFO_DIRECTORY, as described in section &<<SECTinsinfdoc>>& below.
2334
2335 For the utility programs, old versions are renamed by adding the suffix &_.O_&
2336 to their names. The Exim binary itself, however, is handled differently. It is
2337 installed under a name that includes the version number and the compile number,
2338 for example, &_exim-&version()-1_&. The script then arranges for a symbolic link
2339 called &_exim_& to point to the binary. If you are updating a previous version
2340 of Exim, the script takes care to ensure that the name &_exim_& is never absent
2341 from the directory (as seen by other processes).
2342
2343 .cindex "installing Exim" "testing the script"
2344 If you want to see what the &'make install'& will do before running it for
2345 real, you can pass the &%-n%& option to the installation script by this
2346 command:
2347 .code
2348 make INSTALL_ARG=-n install
2349 .endd
2350 The contents of the variable INSTALL_ARG are passed to the installation
2351 script. You do not need to be root to run this test. Alternatively, you can run
2352 the installation script directly, but this must be from within the build
2353 directory. For example, from the top-level Exim directory you could use this
2354 command:
2355 .code
2356 (cd build-SunOS5-5.5.1-sparc; ../scripts/exim_install -n)
2357 .endd
2358 .cindex "installing Exim" "install script options"
2359 There are two other options that can be supplied to the installation script.
2360
2361 .ilist
2362 &%-no_chown%& bypasses the call to change the owner of the installed binary
2363 to root, and the call to make it a setuid binary.
2364 .next
2365 &%-no_symlink%& bypasses the setting up of the symbolic link &_exim_& to the
2366 installed binary.
2367 .endlist
2368
2369 INSTALL_ARG can be used to pass these options to the script. For example:
2370 .code
2371 make INSTALL_ARG=-no_symlink install
2372 .endd
2373 The installation script can also be given arguments specifying which files are
2374 to be copied. For example, to install just the Exim binary, and nothing else,
2375 without creating the symbolic link, you could use:
2376 .code
2377 make INSTALL_ARG='-no_symlink exim' install
2378 .endd
2379
2380
2381
2382 .section "Installing info documentation" "SECTinsinfdoc"
2383 .cindex "installing Exim" "&'info'& documentation"
2384 Not all systems use the GNU &'info'& system for documentation, and for this
2385 reason, the Texinfo source of Exim's documentation is not included in the main
2386 distribution. Instead it is available separately from the FTP site (see section
2387 &<<SECTavail>>&).
2388
2389 If you have defined INFO_DIRECTORY in &_Local/Makefile_& and the Texinfo
2390 source of the documentation is found in the source tree, running &`make
2391 install`& automatically builds the info files and installs them.
2392
2393
2394
2395 .section "Setting up the spool directory" "SECID33"
2396 .cindex "spool directory" "creating"
2397 When it starts up, Exim tries to create its spool directory if it does not
2398 exist. The Exim uid and gid are used for the owner and group of the spool
2399 directory. Sub-directories are automatically created in the spool directory as
2400 necessary.
2401
2402
2403
2404
2405 .section "Testing" "SECID34"
2406 .cindex "testing" "installation"
2407 Having installed Exim, you can check that the runtime configuration file is
2408 syntactically valid by running the following command, which assumes that the
2409 Exim binary directory is within your PATH environment variable:
2410 .code
2411 exim -bV
2412 .endd
2413 If there are any errors in the configuration file, Exim outputs error messages.
2414 Otherwise it outputs the version number and build date,
2415 the DBM library that is being used, and information about which drivers and
2416 other optional code modules are included in the binary.
2417 Some simple routing tests can be done by using the address testing option. For
2418 example,
2419 .display
2420 &`exim -bt`& <&'local username'&>
2421 .endd
2422 should verify that it recognizes a local mailbox, and
2423 .display
2424 &`exim -bt`& <&'remote address'&>
2425 .endd
2426 a remote one. Then try getting it to deliver mail, both locally and remotely.
2427 This can be done by passing messages directly to Exim, without going through a
2428 user agent. For example:
2429 .code
2430 exim -v postmaster@your.domain.example
2431 From: user@your.domain.example
2432 To: postmaster@your.domain.example
2433 Subject: Testing Exim
2434
2435 This is a test message.
2436 ^D
2437 .endd
2438 The &%-v%& option causes Exim to output some verification of what it is doing.
2439 In this case you should see copies of three log lines, one for the message's
2440 arrival, one for its delivery, and one containing &"Completed"&.
2441
2442 .cindex "delivery" "problems with"
2443 If you encounter problems, look at Exim's log files (&'mainlog'& and
2444 &'paniclog'&) to see if there is any relevant information there. Another source
2445 of information is running Exim with debugging turned on, by specifying the
2446 &%-d%& option. If a message is stuck on Exim's spool, you can force a delivery
2447 with debugging turned on by a command of the form
2448 .display
2449 &`exim -d -M`& <&'exim-message-id'&>
2450 .endd
2451 You must be root or an &"admin user"& in order to do this. The &%-d%& option
2452 produces rather a lot of output, but you can cut this down to specific areas.
2453 For example, if you use &%-d-all+route%& only the debugging information
2454 relevant to routing is included. (See the &%-d%& option in chapter
2455 &<<CHAPcommandline>>& for more details.)
2456
2457 .cindex '&"sticky"& bit'
2458 .cindex "lock files"
2459 One specific problem that has shown up on some sites is the inability to do
2460 local deliveries into a shared mailbox directory, because it does not have the
2461 &"sticky bit"& set on it. By default, Exim tries to create a lock file before
2462 writing to a mailbox file, and if it cannot create the lock file, the delivery
2463 is deferred. You can get round this either by setting the &"sticky bit"& on the
2464 directory, or by setting a specific group for local deliveries and allowing
2465 that group to create files in the directory (see the comments above the
2466 &(local_delivery)& transport in the default configuration file). Another
2467 approach is to configure Exim not to use lock files, but just to rely on
2468 &[fcntl()]& locking instead. However, you should do this only if all user
2469 agents also use &[fcntl()]& locking. For further discussion of locking issues,
2470 see chapter &<<CHAPappendfile>>&.
2471
2472 One thing that cannot be tested on a system that is already running an MTA is
2473 the receipt of incoming SMTP mail on the standard SMTP port. However, the
2474 &%-oX%& option can be used to run an Exim daemon that listens on some other
2475 port, or &'inetd'& can be used to do this. The &%-bh%& option and the
2476 &'exim_checkaccess'& utility can be used to check out policy controls on
2477 incoming SMTP mail.
2478
2479 Testing a new version on a system that is already running Exim can most easily
2480 be done by building a binary with a different CONFIGURE_FILE setting. From
2481 within the runtime configuration, all other file and directory names
2482 that Exim uses can be altered, in order to keep it entirely clear of the
2483 production version.
2484
2485
2486 .section "Replacing another MTA with Exim" "SECID35"
2487 .cindex "replacing another MTA"
2488 Building and installing Exim for the first time does not of itself put it in
2489 general use. The name by which the system's MTA is called by mail user agents
2490 is either &_/usr/sbin/sendmail_&, or &_/usr/lib/sendmail_& (depending on the
2491 operating system), and it is necessary to make this name point to the &'exim'&
2492 binary in order to get the user agents to pass messages to Exim. This is
2493 normally done by renaming any existing file and making &_/usr/sbin/sendmail_&
2494 or &_/usr/lib/sendmail_&
2495 .cindex "symbolic link" "to &'exim'& binary"
2496 a symbolic link to the &'exim'& binary. It is a good idea to remove any setuid
2497 privilege and executable status from the old MTA. It is then necessary to stop
2498 and restart the mailer daemon, if one is running.
2499
2500 .cindex "FreeBSD, MTA indirection"
2501 .cindex "&_/etc/mail/mailer.conf_&"
2502 Some operating systems have introduced alternative ways of switching MTAs. For
2503 example, if you are running FreeBSD, you need to edit the file
2504 &_/etc/mail/mailer.conf_& instead of setting up a symbolic link as just
2505 described. A typical example of the contents of this file for running Exim is
2506 as follows:
2507 .code
2508 sendmail            /usr/exim/bin/exim
2509 send-mail           /usr/exim/bin/exim
2510 mailq               /usr/exim/bin/exim -bp
2511 newaliases          /usr/bin/true
2512 .endd
2513 Once you have set up the symbolic link, or edited &_/etc/mail/mailer.conf_&,
2514 your Exim installation is &"live"&. Check it by sending a message from your
2515 favourite user agent.
2516
2517 You should consider what to tell your users about the change of MTA. Exim may
2518 have different capabilities to what was previously running, and there are
2519 various operational differences such as the text of messages produced by
2520 command line options and in bounce messages. If you allow your users to make
2521 use of Exim's filtering capabilities, you should make the document entitled
2522 &'Exim's interface to mail filtering'& available to them.
2523
2524
2525
2526 .section "Upgrading Exim" "SECID36"
2527 .cindex "upgrading Exim"
2528 If you are already running Exim on your host, building and installing a new
2529 version automatically makes it available to MUAs, or any other programs that
2530 call the MTA directly. However, if you are running an Exim daemon, you do need
2531 to send it a HUP signal, to make it re-execute itself, and thereby pick up the
2532 new binary. You do not need to stop processing mail in order to install a new
2533 version of Exim. The install script does not modify an existing runtime
2534 configuration file.
2535
2536
2537
2538
2539 .section "Stopping the Exim daemon on Solaris" "SECID37"
2540 .cindex "Solaris" "stopping Exim on"
2541 The standard command for stopping the mailer daemon on Solaris is
2542 .code
2543 /etc/init.d/sendmail stop
2544 .endd
2545 If &_/usr/lib/sendmail_& has been turned into a symbolic link, this script
2546 fails to stop Exim because it uses the command &'ps -e'& and greps the output
2547 for the text &"sendmail"&; this is not present because the actual program name
2548 (that is, &"exim"&) is given by the &'ps'& command with these options. A
2549 solution is to replace the line that finds the process id with something like
2550 .code
2551 pid=`cat /var/spool/exim/exim-daemon.pid`
2552 .endd
2553 to obtain the daemon's pid directly from the file that Exim saves it in.
2554
2555 Note, however, that stopping the daemon does not &"stop Exim"&. Messages can
2556 still be received from local processes, and if automatic delivery is configured
2557 (the normal case), deliveries will still occur.
2558
2559
2560
2561
2562 . ////////////////////////////////////////////////////////////////////////////
2563 . ////////////////////////////////////////////////////////////////////////////
2564
2565 .chapter "The Exim command line" "CHAPcommandline"
2566 .scindex IIDclo1 "command line" "options"
2567 .scindex IIDclo2 "options" "command line"
2568 Exim's command line takes the standard Unix form of a sequence of options,
2569 each starting with a hyphen character, followed by a number of arguments. The
2570 options are compatible with the main options of Sendmail, and there are also
2571 some additional options, some of which are compatible with Smail 3. Certain
2572 combinations of options do not make sense, and provoke an error if used.
2573 The form of the arguments depends on which options are set.
2574
2575
2576 .section "Setting options by program name" "SECID38"
2577 .cindex "&'mailq'&"
2578 If Exim is called under the name &'mailq'&, it behaves as if the option &%-bp%&
2579 were present before any other options.
2580 The &%-bp%& option requests a listing of the contents of the mail queue on the
2581 standard output.
2582 This feature is for compatibility with some systems that contain a command of
2583 that name in one of the standard libraries, symbolically linked to
2584 &_/usr/sbin/sendmail_& or &_/usr/lib/sendmail_&.
2585
2586 .cindex "&'rsmtp'&"
2587 If Exim is called under the name &'rsmtp'& it behaves as if the option &%-bS%&
2588 were present before any other options, for compatibility with Smail. The
2589 &%-bS%& option is used for reading in a number of messages in batched SMTP
2590 format.
2591
2592 .cindex "&'rmail'&"
2593 If Exim is called under the name &'rmail'& it behaves as if the &%-i%& and
2594 &%-oee%& options were present before any other options, for compatibility with
2595 Smail. The name &'rmail'& is used as an interface by some UUCP systems.
2596
2597 .cindex "&'runq'&"
2598 .cindex "queue runner"
2599 If Exim is called under the name &'runq'& it behaves as if the option &%-q%&
2600 were present before any other options, for compatibility with Smail. The &%-q%&
2601 option causes a single queue runner process to be started.
2602
2603 .cindex "&'newaliases'&"
2604 .cindex "alias file" "building"
2605 .cindex "Sendmail compatibility" "calling Exim as &'newaliases'&"
2606 If Exim is called under the name &'newaliases'& it behaves as if the option
2607 &%-bi%& were present before any other options, for compatibility with Sendmail.
2608 This option is used for rebuilding Sendmail's alias file. Exim does not have
2609 the concept of a single alias file, but can be configured to run a given
2610 command if called with the &%-bi%& option.
2611
2612
2613 .section "Trusted and admin users" "SECTtrustedadmin"
2614 Some Exim options are available only to &'trusted users'& and others are
2615 available only to &'admin users'&. In the description below, the phrases &"Exim
2616 user"& and &"Exim group"& mean the user and group defined by EXIM_USER and
2617 EXIM_GROUP in &_Local/Makefile_& or set by the &%exim_user%& and
2618 &%exim_group%& options. These do not necessarily have to use the name &"exim"&.
2619
2620 .ilist
2621 .cindex "trusted users" "definition of"
2622 .cindex "user" "trusted definition of"
2623 The trusted users are root, the Exim user, any user listed in the
2624 &%trusted_users%& configuration option, and any user whose current group or any
2625 supplementary group is one of those listed in the &%trusted_groups%&
2626 configuration option. Note that the Exim group is not automatically trusted.
2627
2628 .cindex '&"From"& line'
2629 .cindex "envelope sender"
2630 Trusted users are always permitted to use the &%-f%& option or a leading
2631 &"From&~"& line to specify the envelope sender of a message that is passed to
2632 Exim through the local interface (see the &%-bm%& and &%-f%& options below).
2633 See the &%untrusted_set_sender%& option for a way of permitting non-trusted
2634 users to set envelope senders.
2635
2636 .cindex "&'From:'& header line"
2637 .cindex "&'Sender:'& header line"
2638 .cindex "header lines" "From:"
2639 .cindex "header lines" "Sender:"
2640 For a trusted user, there is never any check on the contents of the &'From:'&
2641 header line, and a &'Sender:'& line is never added. Furthermore, any existing
2642 &'Sender:'& line in incoming local (non-TCP/IP) messages is not removed.
2643
2644 Trusted users may also specify a host name, host address, interface address,
2645 protocol name, ident value, and authentication data when submitting a message
2646 locally. Thus, they are able to insert messages into Exim's queue locally that
2647 have the characteristics of messages received from a remote host. Untrusted
2648 users may in some circumstances use &%-f%&, but can never set the other values
2649 that are available to trusted users.
2650 .next
2651 .cindex "user" "admin definition of"
2652 .cindex "admin user" "definition of"
2653 The admin users are root, the Exim user, and any user that is a member of the
2654 Exim group or of any group listed in the &%admin_groups%& configuration option.
2655 The current group does not have to be one of these groups.
2656
2657 Admin users are permitted to list the queue, and to carry out certain
2658 operations on messages, for example, to force delivery failures. It is also
2659 necessary to be an admin user in order to see the full information provided by
2660 the Exim monitor, and full debugging output.
2661
2662 By default, the use of the &%-M%&, &%-q%&, &%-R%&, and &%-S%& options to cause
2663 Exim to attempt delivery of messages on its queue is restricted to admin users.
2664 However, this restriction can be relaxed by setting the &%prod_requires_admin%&
2665 option false (that is, specifying &%no_prod_requires_admin%&).
2666
2667 Similarly, the use of the &%-bp%& option to list all the messages in the queue
2668 is restricted to admin users unless &%queue_list_requires_admin%& is set
2669 false.
2670 .endlist
2671
2672
2673 &*Warning*&: If you configure your system so that admin users are able to
2674 edit Exim's configuration file, you are giving those users an easy way of
2675 getting root. There is further discussion of this issue at the start of chapter
2676 &<<CHAPconf>>&.
2677
2678
2679
2680
2681 .section "Command line options" "SECID39"
2682 Exim's command line options are described in alphabetical order below. If none
2683 of the options that specifies a specific action (such as starting the daemon or
2684 a queue runner, or testing an address, or receiving a message in a specific
2685 format, or listing the queue) are present, and there is at least one argument
2686 on the command line, &%-bm%& (accept a local message on the standard input,
2687 with the arguments specifying the recipients) is assumed. Otherwise, Exim
2688 outputs a brief message about itself and exits.
2689
2690 . ////////////////////////////////////////////////////////////////////////////
2691 . Insert a stylized XML comment here, to identify the start of the command line
2692 . options. This is for the benefit of the Perl script that automatically
2693 . creates a man page for the options.
2694 . ////////////////////////////////////////////////////////////////////////////
2695
2696 .literal xml
2697 <!-- === Start of command line options === -->
2698 .literal off
2699
2700
2701 .vlist
2702 .vitem &%--%&
2703 .oindex "--"
2704 .cindex "options" "command line; terminating"
2705 This is a pseudo-option whose only purpose is to terminate the options and
2706 therefore to cause subsequent command line items to be treated as arguments
2707 rather than options, even if they begin with hyphens.
2708
2709 .vitem &%--help%&
2710 .oindex "&%--help%&"
2711 This option causes Exim to output a few sentences stating what it is.
2712 The same output is generated if the Exim binary is called with no options and
2713 no arguments.
2714
2715 .vitem &%--version%&
2716 .oindex "&%--version%&"
2717 This option is an alias for &%-bV%& and causes version information to be
2718 displayed.
2719
2720 .vitem &%-Ac%& &&&
2721        &%-Am%&
2722 .oindex "&%-Ac%&"
2723 .oindex "&%-Am%&"
2724 These options are used by Sendmail for selecting configuration files and are
2725 ignored by Exim.
2726
2727 .vitem &%-B%&<&'type'&>
2728 .oindex "&%-B%&"
2729 .cindex "8-bit characters"
2730 .cindex "Sendmail compatibility" "8-bit characters"
2731 This is a Sendmail option for selecting 7 or 8 bit processing. Exim is 8-bit
2732 clean; it ignores this option.
2733
2734 .vitem &%-bd%&
2735 .oindex "&%-bd%&"
2736 .cindex "daemon"
2737 .cindex "SMTP" "listener"
2738 .cindex "queue runner"
2739 This option runs Exim as a daemon, awaiting incoming SMTP connections. Usually
2740 the &%-bd%& option is combined with the &%-q%&<&'time'&> option, to specify
2741 that the daemon should also initiate periodic queue runs.
2742
2743 The &%-bd%& option can be used only by an admin user. If either of the &%-d%&
2744 (debugging) or &%-v%& (verifying) options are set, the daemon does not
2745 disconnect from the controlling terminal. When running this way, it can be
2746 stopped by pressing ctrl-C.
2747
2748 By default, Exim listens for incoming connections to the standard SMTP port on
2749 all the host's running interfaces. However, it is possible to listen on other
2750 ports, on multiple ports, and only on specific interfaces. Chapter
2751 &<<CHAPinterfaces>>& contains a description of the options that control this.
2752
2753 When a listening daemon
2754 .cindex "daemon" "process id (pid)"
2755 .cindex "pid (process id)" "of daemon"
2756 is started without the use of &%-oX%& (that is, without overriding the normal
2757 configuration), it writes its process id to a file called &_exim-daemon.pid_&
2758 in Exim's spool directory. This location can be overridden by setting
2759 PID_FILE_PATH in &_Local/Makefile_&. The file is written while Exim is still
2760 running as root.
2761
2762 When &%-oX%& is used on the command line to start a listening daemon, the
2763 process id is not written to the normal pid file path. However, &%-oP%& can be
2764 used to specify a path on the command line if a pid file is required.
2765
2766 The SIGHUP signal
2767 .cindex "SIGHUP"
2768 .cindex "daemon" "restarting"
2769 can be used to cause the daemon to re-execute itself. This should be done
2770 whenever Exim's configuration file, or any file that is incorporated into it by
2771 means of the &%.include%& facility, is changed, and also whenever a new version
2772 of Exim is installed. It is not necessary to do this when other files that are
2773 referenced from the configuration (for example, alias files) are changed,
2774 because these are reread each time they are used.
2775
2776 .vitem &%-bdf%&
2777 .oindex "&%-bdf%&"
2778 This option has the same effect as &%-bd%& except that it never disconnects
2779 from the controlling terminal, even when no debugging is specified.
2780
2781 .vitem &%-be%&
2782 .oindex "&%-be%&"
2783 .cindex "testing" "string expansion"
2784 .cindex "expansion" "testing"
2785 Run Exim in expansion testing mode. Exim discards its root privilege, to
2786 prevent ordinary users from using this mode to read otherwise inaccessible
2787 files. If no arguments are given, Exim runs interactively, prompting for lines
2788 of data. Otherwise, it processes each argument in turn.
2789
2790 If Exim was built with USE_READLINE=yes in &_Local/Makefile_&, it tries
2791 to load the &%libreadline%& library dynamically whenever the &%-be%& option is
2792 used without command line arguments. If successful, it uses the &[readline()]&
2793 function, which provides extensive line-editing facilities, for reading the
2794 test data. A line history is supported.
2795
2796 Long expansion expressions can be split over several lines by using backslash
2797 continuations. As in Exim's runtime configuration, white space at the start of
2798 continuation lines is ignored. Each argument or data line is passed through the
2799 string expansion mechanism, and the result is output. Variable values from the
2800 configuration file (for example, &$qualify_domain$&) are available, but no
2801 message-specific values (such as &$message_exim_id$&) are set, because no message
2802 is being processed (but see &%-bem%& and &%-Mset%&).
2803
2804 &*Note*&: If you use this mechanism to test lookups, and you change the data
2805 files or databases you are using, you must exit and restart Exim before trying
2806 the same lookup again. Otherwise, because each Exim process caches the results
2807 of lookups, you will just get the same result as before.
2808
2809 Macro processing is done on lines before string-expansion: new macros can be
2810 defined and macros will be expanded.
2811 Because macros in the config file are often used for secrets, those are only
2812 available to admin users.
2813
2814 .vitem &%-bem%&&~<&'filename'&>
2815 .oindex "&%-bem%&"
2816 .cindex "testing" "string expansion"
2817 .cindex "expansion" "testing"
2818 This option operates like &%-be%& except that it must be followed by the name
2819 of a file. For example:
2820 .code
2821 exim -bem /tmp/testmessage
2822 .endd
2823 The file is read as a message (as if receiving a locally-submitted non-SMTP
2824 message) before any of the test expansions are done. Thus, message-specific
2825 variables such as &$message_size$& and &$header_from:$& are available. However,
2826 no &'Received:'& header is added to the message. If the &%-t%& option is set,
2827 recipients are read from the headers in the normal way, and are shown in the
2828 &$recipients$& variable. Note that recipients cannot be given on the command
2829 line, because further arguments are taken as strings to expand (just like
2830 &%-be%&).
2831
2832 .vitem &%-bF%&&~<&'filename'&>
2833 .oindex "&%-bF%&"
2834 .cindex "system filter" "testing"
2835 .cindex "testing" "system filter"
2836 This option is the same as &%-bf%& except that it assumes that the filter being
2837 tested is a system filter. The additional commands that are available only in
2838 system filters are recognized.
2839
2840 .vitem &%-bf%&&~<&'filename'&>
2841 .oindex "&%-bf%&"
2842 .cindex "filter" "testing"
2843 .cindex "testing" "filter file"
2844 .cindex "forward file" "testing"
2845 .cindex "testing" "forward file"
2846 .cindex "Sieve filter" "testing"
2847 This option runs Exim in user filter testing mode; the file is the filter file
2848 to be tested, and a test message must be supplied on the standard input. If
2849 there are no message-dependent tests in the filter, an empty file can be
2850 supplied.
2851
2852 If you want to test a system filter file, use &%-bF%& instead of &%-bf%&. You
2853 can use both &%-bF%& and &%-bf%& on the same command, in order to test a system
2854 filter and a user filter in the same run. For example:
2855 .code
2856 exim -bF /system/filter -bf /user/filter </test/message
2857 .endd
2858 This is helpful when the system filter adds header lines or sets filter
2859 variables that are used by the user filter.
2860
2861 If the test filter file does not begin with one of the special lines
2862 .code
2863 # Exim filter
2864 # Sieve filter
2865 .endd
2866 it is taken to be a normal &_.forward_& file, and is tested for validity under
2867 that interpretation. See sections &<<SECTitenonfilred>>& to
2868 &<<SECTspecitredli>>& for a description of the possible contents of non-filter
2869 redirection lists.
2870
2871 The result of an Exim command that uses &%-bf%&, provided no errors are
2872 detected, is a list of the actions that Exim would try to take if presented
2873 with the message for real. More details of filter testing are given in the
2874 separate document entitled &'Exim's interfaces to mail filtering'&.
2875
2876 When testing a filter file,
2877 .cindex "&""From""& line"
2878 .cindex "envelope sender"
2879 .oindex "&%-f%&" "for filter testing"
2880 the envelope sender can be set by the &%-f%& option,
2881 or by a &"From&~"& line at the start of the test message. Various parameters
2882 that would normally be taken from the envelope recipient address of the message
2883 can be set by means of additional command line options (see the next four
2884 options).
2885
2886 .vitem &%-bfd%&&~<&'domain'&>
2887 .oindex "&%-bfd%&"
2888 .vindex "&$qualify_domain$&"
2889 This sets the domain of the recipient address when a filter file is being
2890 tested by means of the &%-bf%& option. The default is the value of
2891 &$qualify_domain$&.
2892
2893 .vitem &%-bfl%&&~<&'local&~part'&>
2894 .oindex "&%-bfl%&"
2895 This sets the local part of the recipient address when a filter file is being
2896 tested by means of the &%-bf%& option. The default is the username of the
2897 process that calls Exim. A local part should be specified with any prefix or
2898 suffix stripped, because that is how it appears to the filter when a message is
2899 actually being delivered.
2900
2901 .vitem &%-bfp%&&~<&'prefix'&>
2902 .oindex "&%-bfp%&"
2903 .cindex affix "filter testing"
2904 This sets the prefix of the local part of the recipient address when a filter
2905 file is being tested by means of the &%-bf%& option. The default is an empty
2906 prefix.
2907
2908 .vitem &%-bfs%&&~<&'suffix'&>
2909 .oindex "&%-bfs%&"
2910 .cindex affix "filter testing"
2911 This sets the suffix of the local part of the recipient address when a filter
2912 file is being tested by means of the &%-bf%& option. The default is an empty
2913 suffix.
2914
2915 .vitem &%-bh%&&~<&'IP&~address'&>
2916 .oindex "&%-bh%&"
2917 .cindex "testing" "incoming SMTP"
2918 .cindex "SMTP" "testing incoming"
2919 .cindex "testing" "relay control"
2920 .cindex "relaying" "testing configuration"
2921 .cindex "policy control" "testing"
2922 .cindex "debugging" "&%-bh%& option"
2923 This option runs a fake SMTP session as if from the given IP address, using the
2924 standard input and output. The IP address may include a port number at the end,
2925 after a full stop. For example:
2926 .code
2927 exim -bh 10.9.8.7.1234
2928 exim -bh fe80::a00:20ff:fe86:a061.5678
2929 .endd
2930 When an IPv6 address is given, it is converted into canonical form. In the case
2931 of the second example above, the value of &$sender_host_address$& after
2932 conversion to the canonical form is
2933 &`fe80:0000:0000:0a00:20ff:fe86:a061.5678`&.
2934
2935 Comments as to what is going on are written to the standard error file. These
2936 include lines beginning with &"LOG"& for anything that would have been logged.
2937 This facility is provided for testing configuration options for incoming
2938 messages, to make sure they implement the required policy. For example, you can
2939 test your relay controls using &%-bh%&.
2940
2941 &*Warning 1*&:
2942 .cindex "RFC 1413"
2943 You can test features of the configuration that rely on ident (RFC 1413)
2944 information by using the &%-oMt%& option. However, Exim cannot actually perform
2945 an ident callout when testing using &%-bh%& because there is no incoming SMTP
2946 connection.
2947
2948 &*Warning 2*&: Address verification callouts (see section &<<SECTcallver>>&)
2949 are also skipped when testing using &%-bh%&. If you want these callouts to
2950 occur, use &%-bhc%& instead.
2951
2952 Messages supplied during the testing session are discarded, and nothing is
2953 written to any of the real log files. There may be pauses when DNS (and other)
2954 lookups are taking place, and of course these may time out. The &%-oMi%& option
2955 can be used to specify a specific IP interface and port if this is important,
2956 and &%-oMaa%& and &%-oMai%& can be used to set parameters as if the SMTP
2957 session were authenticated.
2958
2959 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%& whose
2960 output just states whether a given recipient address from a given host is
2961 acceptable or not. See section &<<SECTcheckaccess>>&.
2962
2963 Features such as authentication and encryption, where the client input is not
2964 plain text, cannot easily be tested with &%-bh%&. Instead, you should use a
2965 specialized SMTP test program such as
2966 &url(https://www.jetmore.org/john/code/swaks/,swaks).
2967
2968 .vitem &%-bhc%&&~<&'IP&~address'&>
2969 .oindex "&%-bhc%&"
2970 This option operates in the same way as &%-bh%&, except that address
2971 verification callouts are performed if required. This includes consulting and
2972 updating the callout cache database.
2973
2974 .vitem &%-bi%&
2975 .oindex "&%-bi%&"
2976 .cindex "alias file" "building"
2977 .cindex "building alias file"
2978 .cindex "Sendmail compatibility" "&%-bi%& option"
2979 Sendmail interprets the &%-bi%& option as a request to rebuild its alias file.
2980 Exim does not have the concept of a single alias file, and so it cannot mimic
2981 this behaviour. However, calls to &_/usr/lib/sendmail_& with the &%-bi%& option
2982 tend to appear in various scripts such as NIS make files, so the option must be
2983 recognized.
2984
2985 If &%-bi%& is encountered, the command specified by the &%bi_command%&
2986 configuration option is run, under the uid and gid of the caller of Exim. If
2987 the &%-oA%& option is used, its value is passed to the command as an argument.
2988 The command set by &%bi_command%& may not contain arguments. The command can
2989 use the &'exim_dbmbuild'& utility, or some other means, to rebuild alias files
2990 if this is required. If the &%bi_command%& option is not set, calling Exim with
2991 &%-bi%& is a no-op.
2992
2993 . // Keep :help first, then the rest in alphabetical order
2994 .vitem &%-bI:help%&
2995 .oindex "&%-bI:help%&"
2996 .cindex "querying exim information"
2997 We shall provide various options starting &`-bI:`& for querying Exim for
2998 information.  The output of many of these will be intended for machine
2999 consumption.  This one is not.  The &%-bI:help%& option asks Exim for a
3000 synopsis of supported options beginning &`-bI:`&.  Use of any of these
3001 options shall cause Exim to exit after producing the requested output.
3002
3003 .vitem &%-bI:dscp%&
3004 .oindex "&%-bI:dscp%&"
3005 .cindex "DSCP" "values"
3006 This option causes Exim to emit an alphabetically sorted list of all
3007 recognised DSCP names.
3008
3009 .vitem &%-bI:sieve%&
3010 .oindex "&%-bI:sieve%&"
3011 .cindex "Sieve filter" "capabilities"
3012 This option causes Exim to emit an alphabetically sorted list of all supported
3013 Sieve protocol extensions on stdout, one per line.  This is anticipated to be
3014 useful for ManageSieve (RFC 5804) implementations, in providing that protocol's
3015 &`SIEVE`& capability response line.  As the precise list may depend upon
3016 compile-time build options, which this option will adapt to, this is the only
3017 way to guarantee a correct response.
3018
3019 .vitem &%-bm%&
3020 .oindex "&%-bm%&"
3021 .cindex "local message reception"
3022 This option runs an Exim receiving process that accepts an incoming,
3023 locally-generated message on the standard input. The recipients are given as the
3024 command arguments (except when &%-t%& is also present &-- see below). Each
3025 argument can be a comma-separated list of RFC 2822 addresses. This is the
3026 default option for selecting the overall action of an Exim call; it is assumed
3027 if no other conflicting option is present.
3028
3029 If any addresses in the message are unqualified (have no domain), they are
3030 qualified by the values of the &%qualify_domain%& or &%qualify_recipient%&
3031 options, as appropriate. The &%-bnq%& option (see below) provides a way of
3032 suppressing this for special cases.
3033
3034 Policy checks on the contents of local messages can be enforced by means of
3035 the non-SMTP ACL. See chapter &<<CHAPACL>>& for details.
3036
3037 .cindex "return code" "for &%-bm%&"
3038 The return code is zero if the message is successfully accepted. Otherwise, the
3039 action is controlled by the &%-oe%&&'x'& option setting &-- see below.
3040
3041 The format
3042 .cindex "message" "format"
3043 .cindex "format" "message"
3044 .cindex "&""From""& line"
3045 .cindex "UUCP" "&""From""& line"
3046 .cindex "Sendmail compatibility" "&""From""& line"
3047 of the message must be as defined in RFC 2822, except that, for
3048 compatibility with Sendmail and Smail, a line in one of the forms
3049 .code
3050 From sender Fri Jan  5 12:55 GMT 1997
3051 From sender Fri, 5 Jan 97 12:55:01
3052 .endd
3053 (with the weekday optional, and possibly with additional text after the date)
3054 is permitted to appear at the start of the message. There appears to be no
3055 authoritative specification of the format of this line. Exim recognizes it by
3056 matching against the regular expression defined by the &%uucp_from_pattern%&
3057 option, which can be changed if necessary.
3058
3059 .oindex "&%-f%&" "overriding &""From""& line"
3060 The specified sender is treated as if it were given as the argument to the
3061 &%-f%& option, but if a &%-f%& option is also present, its argument is used in
3062 preference to the address taken from the message. The caller of Exim must be a
3063 trusted user for the sender of a message to be set in this way.
3064
3065 .vitem &%-bmalware%&&~<&'filename'&>
3066 .oindex "&%-bmalware%&"
3067 .cindex "testing", "malware"
3068 .cindex "malware scan test"
3069 This debugging option causes Exim to scan the given file or directory
3070 (depending on the used scanner interface),
3071 using the malware scanning framework.  The option of &%av_scanner%& influences
3072 this option, so if &%av_scanner%&'s value is dependent upon an expansion then
3073 the expansion should have defaults which apply to this invocation.  ACLs are
3074 not invoked, so if &%av_scanner%& references an ACL variable then that variable
3075 will never be populated and &%-bmalware%& will fail.
3076
3077 Exim will have changed working directory before resolving the filename, so
3078 using fully qualified pathnames is advisable.  Exim will be running as the Exim
3079 user when it tries to open the file, rather than as the invoking user.
3080 This option requires admin privileges.
3081
3082 The &%-bmalware%& option will not be extended to be more generally useful,
3083 there are better tools for file-scanning.  This option exists to help
3084 administrators verify their Exim and AV scanner configuration.
3085
3086 .vitem &%-bnq%&
3087 .oindex "&%-bnq%&"
3088 .cindex "address qualification, suppressing"
3089 By default, Exim automatically qualifies unqualified addresses (those
3090 without domains) that appear in messages that are submitted locally (that
3091 is, not over TCP/IP). This qualification applies both to addresses in
3092 envelopes, and addresses in header lines. Sender addresses are qualified using
3093 &%qualify_domain%&, and recipient addresses using &%qualify_recipient%& (which
3094 defaults to the value of &%qualify_domain%&).
3095
3096 Sometimes, qualification is not wanted. For example, if &%-bS%& (batch SMTP) is
3097 being used to re-submit messages that originally came from remote hosts after
3098 content scanning, you probably do not want to qualify unqualified addresses in
3099 header lines. (Such lines will be present only if you have not enabled a header
3100 syntax check in the appropriate ACL.)
3101
3102 The &%-bnq%& option suppresses all qualification of unqualified addresses in
3103 messages that originate on the local host. When this is used, unqualified
3104 addresses in the envelope provoke errors (causing message rejection) and
3105 unqualified addresses in header lines are left alone.
3106
3107
3108 .vitem &%-bP%&
3109 .oindex "&%-bP%&"
3110 .cindex "configuration options" "extracting"
3111 .cindex "options" "configuration &-- extracting"
3112 If this option is given with no arguments, it causes the values of all Exim's
3113 main configuration options to be written to the standard output. The values
3114 of one or more specific options can be requested by giving their names as
3115 arguments, for example:
3116 .code
3117 exim -bP qualify_domain hold_domains
3118 .endd
3119 .cindex "hiding configuration option values"
3120 .cindex "configuration options" "hiding value of"
3121 .cindex "options" "hiding value of"
3122 However, any option setting that is preceded by the word &"hide"& in the
3123 configuration file is not shown in full, except to an admin user. For other
3124 users, the output is as in this example:
3125 .code
3126 mysql_servers = <value not displayable>
3127 .endd
3128 If &%config%& is given as an argument, the config is
3129 output, as it was parsed, any include file resolved, any comment removed.
3130
3131 If &%config_file%& is given as an argument, the name of the runtime
3132 configuration file is output. (&%configure_file%& works too, for
3133 backward compatibility.)
3134 If a list of configuration files was supplied, the value that is output here
3135 is the name of the file that was actually used.
3136
3137 .cindex "options" "hiding name of"
3138 If the &%-n%& flag is given, then for most modes of &%-bP%& operation the
3139 name will not be output.
3140
3141 .cindex "daemon" "process id (pid)"
3142 .cindex "pid (process id)" "of daemon"
3143 If &%log_file_path%& or &%pid_file_path%& are given, the names of the
3144 directories where log files and daemon pid files are written are output,
3145 respectively. If these values are unset, log files are written in a
3146 sub-directory of the spool directory called &%log%&, and the pid file is
3147 written directly into the spool directory.
3148
3149 If &%-bP%& is followed by a name preceded by &`+`&, for example,
3150 .code
3151 exim -bP +local_domains
3152 .endd
3153 it searches for a matching named list of any type (domain, host, address, or
3154 local part) and outputs what it finds.
3155
3156 .cindex "options" "router &-- extracting"
3157 .cindex "options" "transport &-- extracting"
3158 .cindex "options" "authenticator &-- extracting"
3159 If one of the words &%router%&, &%transport%&, or &%authenticator%& is given,
3160 followed by the name of an appropriate driver instance, the option settings for
3161 that driver are output. For example:
3162 .code
3163 exim -bP transport local_delivery
3164 .endd
3165 The generic driver options are output first, followed by the driver's private
3166 options. A list of the names of drivers of a particular type can be obtained by
3167 using one of the words &%router_list%&, &%transport_list%&, or
3168 &%authenticator_list%&, and a complete list of all drivers with their option
3169 settings can be obtained by using &%routers%&, &%transports%&, or
3170 &%authenticators%&.
3171
3172 .cindex "environment"
3173 If &%environment%& is given as an argument, the set of environment
3174 variables is output, line by line. Using the &%-n%& flag suppresses the value of the
3175 variables.
3176
3177 .cindex "options" "macro &-- extracting"
3178 If invoked by an admin user, then &%macro%&, &%macro_list%& and &%macros%&
3179 are available, similarly to the drivers.  Because macros are sometimes used
3180 for storing passwords, this option is restricted.
3181 The output format is one item per line.
3182 For the "-bP macro <name>" form, if no such macro is found
3183 the exit status will be nonzero.
3184
3185 .vitem &%-bp%&
3186 .oindex "&%-bp%&"
3187 .cindex "queue" "listing messages in"
3188 .cindex "listing" "messages in the queue"
3189 This option requests a listing of the contents of the mail queue on the
3190 standard output. If the &%-bp%& option is followed by a list of message ids,
3191 just those messages are listed. By default, this option can be used only by an
3192 admin user. However, the &%queue_list_requires_admin%& option can be set false
3193 to allow any user to see the queue.
3194
3195 Each message in the queue is displayed as in the following example:
3196 .code
3197 25m  2.9K 0t5C6f-0000c8-00 <alice@wonderland.fict.example>
3198           red.king@looking-glass.fict.example
3199           <other addresses>
3200 .endd
3201 .cindex "message" "size in queue listing"
3202 .cindex "size" "of message"
3203 The first line contains the length of time the message has been in the queue
3204 (in this case 25 minutes), the size of the message (2.9K), the unique local
3205 identifier for the message, and the message sender, as contained in the
3206 envelope. For bounce messages, the sender address is empty, and appears as
3207 &"<>"&. If the message was submitted locally by an untrusted user who overrode
3208 the default sender address, the user's login name is shown in parentheses
3209 before the sender address.
3210
3211 .cindex "frozen messages" "in queue listing"
3212 If the message is frozen (attempts to deliver it are suspended) then the text
3213 &"*** frozen ***"& is displayed at the end of this line.
3214
3215 The recipients of the message (taken from the envelope, not the headers) are
3216 displayed on subsequent lines. Those addresses to which the message has already
3217 been delivered are marked with the letter D. If an original address gets
3218 expanded into several addresses via an alias or forward file, the original is
3219 displayed with a D only when deliveries for all of its child addresses are
3220 complete.
3221
3222
3223 .vitem &%-bpa%&
3224 .oindex "&%-bpa%&"
3225 This option operates like &%-bp%&, but in addition it shows delivered addresses
3226 that were generated from the original top level address(es) in each message by
3227 alias or forwarding operations. These addresses are flagged with &"+D"& instead
3228 of just &"D"&.
3229
3230
3231 .vitem &%-bpc%&
3232 .oindex "&%-bpc%&"
3233 .cindex "queue" "count of messages on"
3234 This option counts the number of messages in the queue, and writes the total
3235 to the standard output. It is restricted to admin users, unless
3236 &%queue_list_requires_admin%& is set false.
3237
3238
3239 .vitem &%-bpr%&
3240 .oindex "&%-bpr%&"
3241 This option operates like &%-bp%&, but the output is not sorted into
3242 chronological order of message arrival. This can speed it up when there are
3243 lots of messages in the queue, and is particularly useful if the output is
3244 going to be post-processed in a way that doesn't need the sorting.
3245
3246 .vitem &%-bpra%&
3247 .oindex "&%-bpra%&"
3248 This option is a combination of &%-bpr%& and &%-bpa%&.
3249
3250 .vitem &%-bpru%&
3251 .oindex "&%-bpru%&"
3252 This option is a combination of &%-bpr%& and &%-bpu%&.
3253
3254
3255 .vitem &%-bpu%&
3256 .oindex "&%-bpu%&"
3257 This option operates like &%-bp%& but shows only undelivered top-level
3258 addresses for each message displayed. Addresses generated by aliasing or
3259 forwarding are not shown, unless the message was deferred after processing by a
3260 router with the &%one_time%& option set.
3261
3262
3263 .vitem &%-brt%&
3264 .oindex "&%-brt%&"
3265 .cindex "testing" "retry configuration"
3266 .cindex "retry" "configuration testing"
3267 This option is for testing retry rules, and it must be followed by up to three
3268 arguments. It causes Exim to look for a retry rule that matches the values
3269 and to write it to the standard output. For example:
3270 .code
3271 exim -brt bach.comp.mus.example
3272 Retry rule: *.comp.mus.example  F,2h,15m; F,4d,30m;
3273 .endd
3274 See chapter &<<CHAPretry>>& for a description of Exim's retry rules. The first
3275 argument, which is required, can be a complete address in the form
3276 &'local_part@domain'&, or it can be just a domain name. If the second argument
3277 contains a dot, it is interpreted as an optional second domain name; if no
3278 retry rule is found for the first argument, the second is tried. This ties in
3279 with Exim's behaviour when looking for retry rules for remote hosts &-- if no
3280 rule is found that matches the host, one that matches the mail domain is
3281 sought. Finally, an argument that is the name of a specific delivery error, as
3282 used in setting up retry rules, can be given. For example:
3283 .code
3284 exim -brt haydn.comp.mus.example quota_3d
3285 Retry rule: *@haydn.comp.mus.example quota_3d  F,1h,15m
3286 .endd
3287
3288 .vitem &%-brw%&
3289 .oindex "&%-brw%&"
3290 .cindex "testing" "rewriting"
3291 .cindex "rewriting" "testing"
3292 This option is for testing address rewriting rules, and it must be followed by
3293 a single argument, consisting of either a local part without a domain, or a
3294 complete address with a fully qualified domain. Exim outputs how this address
3295 would be rewritten for each possible place it might appear. See chapter
3296 &<<CHAPrewrite>>& for further details.
3297
3298 .vitem &%-bS%&
3299 .oindex "&%-bS%&"
3300 .cindex "SMTP" "batched incoming"
3301 .cindex "batched SMTP input"
3302 This option is used for batched SMTP input, which is an alternative interface
3303 for non-interactive local message submission. A number of messages can be
3304 submitted in a single run. However, despite its name, this is not really SMTP
3305 input. Exim reads each message's envelope from SMTP commands on the standard
3306 input, but generates no responses. If the caller is trusted, or
3307 &%untrusted_set_sender%& is set, the senders in the SMTP MAIL commands are
3308 believed; otherwise the sender is always the caller of Exim.
3309
3310 The message itself is read from the standard input, in SMTP format (leading
3311 dots doubled), terminated by a line containing just a single dot. An error is
3312 provoked if the terminating dot is missing. A further message may then follow.
3313
3314 As for other local message submissions, the contents of incoming batch SMTP
3315 messages can be checked using the non-SMTP ACL (see chapter &<<CHAPACL>>&).
3316 Unqualified addresses are automatically qualified using &%qualify_domain%& and
3317 &%qualify_recipient%&, as appropriate, unless the &%-bnq%& option is used.
3318
3319 Some other SMTP commands are recognized in the input. HELO and EHLO act
3320 as RSET; VRFY, EXPN, ETRN, and HELP act as NOOP;
3321 QUIT quits, ignoring the rest of the standard input.
3322
3323 .cindex "return code" "for &%-bS%&"
3324 If any error is encountered, reports are written to the standard output and
3325 error streams, and Exim gives up immediately. The return code is 0 if no error
3326 was detected; it is 1 if one or more messages were accepted before the error
3327 was detected; otherwise it is 2.
3328
3329 More details of input using batched SMTP are given in section
3330 &<<SECTincomingbatchedSMTP>>&.
3331
3332 .vitem &%-bs%&
3333 .oindex "&%-bs%&"
3334 .cindex "SMTP" "local input"
3335 .cindex "local SMTP input"
3336 This option causes Exim to accept one or more messages by reading SMTP commands
3337 on the standard input, and producing SMTP replies on the standard output. SMTP
3338 policy controls, as defined in ACLs (see chapter &<<CHAPACL>>&) are applied.
3339 Some user agents use this interface as a way of passing locally-generated
3340 messages to the MTA.
3341
3342 In
3343 .cindex "sender" "source of"
3344 this usage, if the caller of Exim is trusted, or &%untrusted_set_sender%& is
3345 set, the senders of messages are taken from the SMTP MAIL commands.
3346 Otherwise the content of these commands is ignored and the sender is set up as
3347 the calling user. Unqualified addresses are automatically qualified using
3348 &%qualify_domain%& and &%qualify_recipient%&, as appropriate, unless the
3349 &%-bnq%& option is used.
3350
3351 .cindex "inetd"
3352 The
3353 &%-bs%& option is also used to run Exim from &'inetd'&, as an alternative to
3354 using a listening daemon. Exim can distinguish the two cases by checking
3355 whether the standard input is a TCP/IP socket. When Exim is called from
3356 &'inetd'&, the source of the mail is assumed to be remote, and the comments
3357 above concerning senders and qualification do not apply. In this situation,
3358 Exim behaves in exactly the same way as it does when receiving a message via
3359 the listening daemon.
3360
3361 .vitem &%-bt%&
3362 .oindex "&%-bt%&"
3363 .cindex "testing" "addresses"
3364 .cindex "address" "testing"
3365 This option runs Exim in address testing mode, in which each argument is taken
3366 as a recipient address to be tested for deliverability. The results are
3367 written to the standard output. If a test fails, and the caller is not an admin
3368 user, no details of the failure are output, because these might contain
3369 sensitive information such as usernames and passwords for database lookups.
3370
3371 If no arguments are given, Exim runs in an interactive manner, prompting with a
3372 right angle bracket for addresses to be tested.
3373
3374 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3375 &[readline()]& function, because it is running as &'root'& and there are
3376 security issues.
3377
3378 Each address is handled as if it were the recipient address of a message
3379 (compare the &%-bv%& option). It is passed to the routers and the result is
3380 written to the standard output. However, any router that has
3381 &%no_address_test%& set is bypassed. This can make &%-bt%& easier to use for
3382 genuine routing tests if your first router passes everything to a scanner
3383 program.
3384
3385 .cindex "return code" "for &%-bt%&"
3386 The return code is 2 if any address failed outright; it is 1 if no address
3387 failed outright but at least one could not be resolved for some reason. Return
3388 code 0 is given only when all addresses succeed.
3389
3390 .cindex "duplicate addresses"
3391 &*Note*&: When actually delivering a message, Exim removes duplicate recipient
3392 addresses after routing is complete, so that only one delivery takes place.
3393 This does not happen when testing with &%-bt%&; the full results of routing are
3394 always shown.
3395
3396 &*Warning*&: &%-bt%& can only do relatively simple testing. If any of the
3397 routers in the configuration makes any tests on the sender address of a
3398 message,
3399 .oindex "&%-f%&" "for address testing"
3400 you can use the &%-f%& option to set an appropriate sender when running
3401 &%-bt%& tests. Without it, the sender is assumed to be the calling user at the
3402 default qualifying domain. However, if you have set up (for example) routers
3403 whose behaviour depends on the contents of an incoming message, you cannot test
3404 those conditions using &%-bt%&. The &%-N%& option provides a possible way of
3405 doing such tests.
3406
3407 .vitem &%-bV%&
3408 .oindex "&%-bV%&"
3409 .cindex "version number of Exim"
3410 This option causes Exim to write the current version number, compilation
3411 number, and compilation date of the &'exim'& binary to the standard output.
3412 It also lists the DBM library that is being used, the optional modules (such as
3413 specific lookup types), the drivers that are included in the binary, and the
3414 name of the runtime configuration file that is in use.
3415
3416 As part of its operation, &%-bV%& causes Exim to read and syntax check its
3417 configuration file. However, this is a static check only. It cannot check
3418 values that are to be expanded. For example, although a misspelt ACL verb is
3419 detected, an error in the verb's arguments is not. You cannot rely on &%-bV%&
3420 alone to discover (for example) all the typos in the configuration; some
3421 realistic testing is needed. The &%-bh%& and &%-N%& options provide more
3422 dynamic testing facilities.
3423
3424 .vitem &%-bv%&
3425 .oindex "&%-bv%&"
3426 .cindex "verifying address" "using &%-bv%&"
3427 .cindex "address" "verification"
3428 This option runs Exim in address verification mode, in which each argument is
3429 taken as a recipient address to be verified by the routers. (This does
3430 not involve any verification callouts). During normal operation, verification
3431 happens mostly as a consequence processing a &%verify%& condition in an ACL
3432 (see chapter &<<CHAPACL>>&). If you want to test an entire ACL, possibly
3433 including callouts, see the &%-bh%& and &%-bhc%& options.
3434
3435 If verification fails, and the caller is not an admin user, no details of the
3436 failure are output, because these might contain sensitive information such as
3437 usernames and passwords for database lookups.
3438
3439 If no arguments are given, Exim runs in an interactive manner, prompting with a
3440 right angle bracket for addresses to be verified.
3441
3442 Unlike the &%-be%& test option, you cannot arrange for Exim to use the
3443 &[readline()]& function, because it is running as &'exim'& and there are
3444 security issues.
3445
3446 Verification differs from address testing (the &%-bt%& option) in that routers
3447 that have &%no_verify%& set are skipped, and if the address is accepted by a
3448 router that has &%fail_verify%& set, verification fails. The address is
3449 verified as a recipient if &%-bv%& is used; to test verification for a sender
3450 address, &%-bvs%& should be used.
3451
3452 If the &%-v%& option is not set, the output consists of a single line for each
3453 address, stating whether it was verified or not, and giving a reason in the
3454 latter case. Without &%-v%&, generating more than one address by redirection
3455 causes verification to end successfully, without considering the generated
3456 addresses. However, if just one address is generated, processing continues,
3457 and the generated address must verify successfully for the overall verification
3458 to succeed.
3459
3460 When &%-v%& is set, more details are given of how the address has been handled,
3461 and in the case of address redirection, all the generated addresses are also
3462 considered. Verification may succeed for some and fail for others.
3463
3464 The
3465 .cindex "return code" "for &%-bv%&"
3466 return code is 2 if any address failed outright; it is 1 if no address
3467 failed outright but at least one could not be resolved for some reason. Return
3468 code 0 is given only when all addresses succeed.
3469
3470 If any of the routers in the configuration makes any tests on the sender
3471 address of a message, you should use the &%-f%& option to set an appropriate
3472 sender when running &%-bv%& tests. Without it, the sender is assumed to be the
3473 calling user at the default qualifying domain.
3474
3475 .vitem &%-bvs%&
3476 .oindex "&%-bvs%&"
3477 This option acts like &%-bv%&, but verifies the address as a sender rather
3478 than a recipient address. This affects any rewriting and qualification that
3479 might happen.
3480
3481 .vitem &%-bw%&
3482 .oindex "&%-bw%&"
3483 .cindex "daemon"
3484 .cindex "inetd"
3485 .cindex "inetd" "wait mode"
3486 This option runs Exim as a daemon, awaiting incoming SMTP connections,
3487 similarly to the &%-bd%& option.  All port specifications on the command-line
3488 and in the configuration file are ignored.  Queue-running may not be specified.
3489
3490 In this mode, Exim expects to be passed a socket as fd 0 (stdin) which is
3491 listening for connections.  This permits the system to start up and have
3492 inetd (or equivalent) listen on the SMTP ports, starting an Exim daemon for
3493 each port only when the first connection is received.
3494
3495 If the option is given as &%-bw%&<&'time'&> then the time is a timeout, after
3496 which the daemon will exit, which should cause inetd to listen once more.
3497
3498 .vitem &%-C%&&~<&'filelist'&>
3499 .oindex "&%-C%&"
3500 .cindex "configuration file" "alternate"
3501 .cindex "CONFIGURE_FILE"
3502 .cindex "alternate configuration file"
3503 This option causes Exim to find the runtime configuration file from the given
3504 list instead of from the list specified by the CONFIGURE_FILE
3505 compile-time setting. Usually, the list will consist of just a single filename,
3506 but it can be a colon-separated list of names. In this case, the first
3507 file that exists is used. Failure to open an existing file stops Exim from
3508 proceeding any further along the list, and an error is generated.
3509
3510 When this option is used by a caller other than root, and the list is different
3511 from the compiled-in list, Exim gives up its root privilege immediately, and
3512 runs with the real and effective uid and gid set to those of the caller.
3513 However, if a TRUSTED_CONFIG_LIST file is defined in &_Local/Makefile_&, that
3514 file contains a list of full pathnames, one per line, for configuration files
3515 which are trusted. Root privilege is retained for any configuration file so
3516 listed, as long as the caller is the Exim user (or the user specified in the
3517 CONFIGURE_OWNER option, if any), and as long as the configuration file is
3518 not writeable by inappropriate users or groups.
3519
3520 Leaving TRUSTED_CONFIG_LIST unset precludes the possibility of testing a
3521 configuration using &%-C%& right through message reception and delivery,
3522 even if the caller is root. The reception works, but by that time, Exim is
3523 running as the Exim user, so when it re-executes to regain privilege for the
3524 delivery, the use of &%-C%& causes privilege to be lost. However, root can
3525 test reception and delivery using two separate commands (one to put a message
3526 in the queue, using &%-odq%&, and another to do the delivery, using &%-M%&).
3527
3528 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
3529 prefix string with which any file named in a &%-C%& command line option
3530 must start. In addition, the filename must not contain the sequence &`/../`&.
3531 However, if the value of the &%-C%& option is identical to the value of
3532 CONFIGURE_FILE in &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as
3533 usual. There is no default setting for ALT_CONFIG_PREFIX; when it is
3534 unset, any filename can be used with &%-C%&.
3535
3536 ALT_CONFIG_PREFIX can be used to confine alternative configuration files
3537 to a directory to which only root has access. This prevents someone who has
3538 broken into the Exim account from running a privileged Exim with an arbitrary
3539 configuration file.
3540
3541 The &%-C%& facility is useful for ensuring that configuration files are
3542 syntactically correct, but cannot be used for test deliveries, unless the
3543 caller is privileged, or unless it is an exotic configuration that does not
3544 require privilege. No check is made on the owner or group of the files
3545 specified by this option.
3546
3547
3548 .vitem &%-D%&<&'macro'&>=<&'value'&>
3549 .oindex "&%-D%&"
3550 .cindex "macro" "setting on command line"
3551 This option can be used to override macro definitions in the configuration file
3552 (see section &<<SECTmacrodefs>>&). However, like &%-C%&, if it is used by an
3553 unprivileged caller, it causes Exim to give up its root privilege.
3554 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
3555 completely disabled, and its use causes an immediate error exit.
3556
3557 If WHITELIST_D_MACROS is defined in &_Local/Makefile_& then it should be a
3558 colon-separated list of macros which are considered safe and, if &%-D%& only
3559 supplies macros from this list, and the values are acceptable, then Exim will
3560 not give up root privilege if the caller is root, the Exim run-time user, or
3561 the CONFIGURE_OWNER, if set.  This is a transition mechanism and is expected
3562 to be removed in the future.  Acceptable values for the macros satisfy the
3563 regexp: &`^[A-Za-z0-9_/.-]*$`&
3564
3565 The entire option (including equals sign if present) must all be within one
3566 command line item. &%-D%& can be used to set the value of a macro to the empty
3567 string, in which case the equals sign is optional. These two commands are
3568 synonymous:
3569 .code
3570 exim -DABC  ...
3571 exim -DABC= ...
3572 .endd
3573 To include spaces in a macro definition item, quotes must be used. If you use
3574 quotes, spaces are permitted around the macro name and the equals sign. For
3575 example:
3576 .code
3577 exim '-D ABC = something' ...
3578 .endd
3579 &%-D%& may be repeated up to 10 times on a command line.
3580 Only macro names up to 22 letters long can be set.
3581
3582
3583 .vitem &%-d%&<&'debug&~options'&>
3584 .oindex "&%-d%&"
3585 .cindex "debugging" "list of selectors"
3586 .cindex "debugging" "&%-d%& option"
3587 This option causes debugging information to be written to the standard
3588 error stream. It is restricted to admin users because debugging output may show
3589 database queries that contain password information. Also, the details of users'
3590 filter files should be protected. If a non-admin user uses &%-d%&, Exim
3591 writes an error message to the standard error stream and exits with a non-zero
3592 return code.
3593
3594 When &%-d%& is used, &%-v%& is assumed. If &%-d%& is given on its own, a lot of
3595 standard debugging data is output. This can be reduced, or increased to include
3596 some more rarely needed information, by directly following &%-d%& with a string
3597 made up of names preceded by plus or minus characters. These add or remove sets
3598 of debugging data, respectively. For example, &%-d+filter%& adds filter
3599 debugging, whereas &%-d-all+filter%& selects only filter debugging. Note that
3600 no spaces are allowed in the debug setting. The available debugging categories
3601 are:
3602 .display
3603 &`acl            `& ACL interpretation
3604 &`auth           `& authenticators
3605 &`deliver        `& general delivery logic
3606 &`dns            `& DNS lookups (see also resolver)
3607 &`dnsbl          `& DNS black list (aka RBL) code
3608 &`exec           `& arguments for &[execv()]& calls
3609 &`expand         `& detailed debugging for string expansions
3610 &`filter         `& filter handling
3611 &`hints_lookup   `& hints data lookups
3612 &`host_lookup    `& all types of name-to-IP address handling
3613 &`ident          `& ident lookup
3614 &`interface      `& lists of local interfaces
3615 &`lists          `& matching things in lists
3616 &`load           `& system load checks
3617 &`local_scan     `& can be used by &[local_scan()]& (see chapter &&&
3618                     &<<CHAPlocalscan>>&)
3619 &`lookup         `& general lookup code and all lookups
3620 &`memory         `& memory handling
3621 &`noutf8         `& modifier: avoid UTF-8 line-drawing
3622 &`pid            `& modifier: add pid to debug output lines
3623 &`process_info   `& setting info for the process log
3624 &`queue_run      `& queue runs
3625 &`receive        `& general message reception logic
3626 &`resolver       `& turn on the DNS resolver's debugging output
3627 &`retry          `& retry handling
3628 &`rewrite        `& address rewriting
3629 &`route          `& address routing
3630 &`timestamp      `& modifier: add timestamp to debug output lines
3631 &`tls            `& TLS logic
3632 &`transport      `& transports
3633 &`uid            `& changes of uid/gid and looking up uid/gid
3634 &`verify         `& address verification logic
3635 &`all            `& almost all of the above (see below), and also &%-v%&
3636 .endd
3637 The &`all`& option excludes &`memory`& when used as &`+all`&, but includes it
3638 for &`-all`&. The reason for this is that &`+all`& is something that people
3639 tend to use when generating debug output for Exim maintainers. If &`+memory`&
3640 is included, an awful lot of output that is very rarely of interest is
3641 generated, so it now has to be explicitly requested. However, &`-all`& does
3642 turn everything off.
3643
3644 .cindex "resolver, debugging output"
3645 .cindex "DNS resolver, debugging output"
3646 The &`resolver`& option produces output only if the DNS resolver was compiled
3647 with DEBUG enabled. This is not the case in some operating systems. Also,
3648 unfortunately, debugging output from the DNS resolver is written to stdout
3649 rather than stderr.
3650
3651 The default (&%-d%& with no argument) omits &`expand`&, &`filter`&,
3652 &`interface`&, &`load`&, &`memory`&, &`pid`&, &`resolver`&, and &`timestamp`&.
3653 However, the &`pid`& selector is forced when debugging is turned on for a
3654 daemon, which then passes it on to any re-executed Exims. Exim also
3655 automatically adds the pid to debug lines when several remote deliveries are
3656 run in parallel.
3657
3658 The &`timestamp`& selector causes the current time to be inserted at the start
3659 of all debug output lines. This can be useful when trying to track down delays
3660 in processing.
3661
3662 .cindex debugging "UTF-8 in"
3663 .cindex UTF-8 "in debug output"
3664 The &`noutf8`& selector disables the use of
3665 UTF-8 line-drawing characters to group related information.
3666 When disabled. ascii-art is used instead.
3667 Using the &`+all`& option does not set this modifier,
3668
3669 If the &%debug_print%& option is set in any driver, it produces output whenever
3670 any debugging is selected, or if &%-v%& is used.
3671
3672 .vitem &%-dd%&<&'debug&~options'&>
3673 .oindex "&%-dd%&"
3674 This option behaves exactly like &%-d%& except when used on a command that
3675 starts a daemon process. In that case, debugging is turned off for the
3676 subprocesses that the daemon creates. Thus, it is useful for monitoring the
3677 behaviour of the daemon without creating as much output as full debugging does.
3678
3679 .vitem &%-dropcr%&
3680 .oindex "&%-dropcr%&"
3681 This is an obsolete option that is now a no-op. It used to affect the way Exim
3682 handled CR and LF characters in incoming messages. What happens now is
3683 described in section &<<SECTlineendings>>&.
3684
3685 .vitem &%-E%&
3686 .oindex "&%-E%&"
3687 .cindex "bounce message" "generating"
3688 This option specifies that an incoming message is a locally-generated delivery
3689 failure report. It is used internally by Exim when handling delivery failures
3690 and is not intended for external use. Its only effect is to stop Exim
3691 generating certain messages to the postmaster, as otherwise message cascades
3692 could occur in some situations. As part of the same option, a message id may
3693 follow the characters &%-E%&. If it does, the log entry for the receipt of the
3694 new message contains the id, following &"R="&, as a cross-reference.
3695
3696 .vitem &%-e%&&'x'&
3697 .oindex "&%-e%&&'x'&"
3698 There are a number of Sendmail options starting with &%-oe%& which seem to be
3699 called by various programs without the leading &%o%& in the option. For
3700 example, the &%vacation%& program uses &%-eq%&. Exim treats all options of the
3701 form &%-e%&&'x'& as synonymous with the corresponding &%-oe%&&'x'& options.
3702
3703 .vitem &%-F%&&~<&'string'&>
3704 .oindex "&%-F%&"
3705 .cindex "sender" "name"
3706 .cindex "name" "of sender"
3707 This option sets the sender's full name for use when a locally-generated
3708 message is being accepted. In the absence of this option, the user's &'gecos'&
3709 entry from the password data is used. As users are generally permitted to alter
3710 their &'gecos'& entries, no security considerations are involved. White space
3711 between &%-F%& and the <&'string'&> is optional.
3712
3713 .vitem &%-f%&&~<&'address'&>
3714 .oindex "&%-f%&"
3715 .cindex "sender" "address"
3716 .cindex "address" "sender"
3717 .cindex "trusted users"
3718 .cindex "envelope sender"
3719 .cindex "user" "trusted"
3720 This option sets the address of the envelope sender of a locally-generated
3721 message (also known as the return path). The option can normally be used only
3722 by a trusted user, but &%untrusted_set_sender%& can be set to allow untrusted
3723 users to use it.
3724
3725 Processes running as root or the Exim user are always trusted. Other
3726 trusted users are defined by the &%trusted_users%& or &%trusted_groups%&
3727 options. In the absence of &%-f%&, or if the caller is not trusted, the sender
3728 of a local message is set to the caller's login name at the default qualify
3729 domain.
3730
3731 There is one exception to the restriction on the use of &%-f%&: an empty sender
3732 can be specified by any user, trusted or not, to create a message that can
3733 never provoke a bounce. An empty sender can be specified either as an empty
3734 string, or as a pair of angle brackets with nothing between them, as in these
3735 examples of shell commands:
3736 .code
3737 exim -f '<>' user@domain
3738 exim -f "" user@domain
3739 .endd
3740 In addition, the use of &%-f%& is not restricted when testing a filter file
3741 with &%-bf%& or when testing or verifying addresses using the &%-bt%& or
3742 &%-bv%& options.
3743
3744 Allowing untrusted users to change the sender address does not of itself make
3745 it possible to send anonymous mail. Exim still checks that the &'From:'& header
3746 refers to the local user, and if it does not, it adds a &'Sender:'& header,
3747 though this can be overridden by setting &%no_local_from_check%&.
3748
3749 White
3750 .cindex "&""From""& line"
3751 space between &%-f%& and the <&'address'&> is optional (that is, they can be
3752 given as two arguments or one combined argument). The sender of a
3753 locally-generated message can also be set (when permitted) by an initial
3754 &"From&~"& line in the message &-- see the description of &%-bm%& above &-- but
3755 if &%-f%& is also present, it overrides &"From&~"&.
3756
3757 .vitem &%-G%&
3758 .oindex "&%-G%&"
3759 .cindex "submission fixups, suppressing (command-line)"
3760 This option is equivalent to an ACL applying:
3761 .code
3762 control = suppress_local_fixups
3763 .endd
3764 for every message received.  Note that Sendmail will complain about such
3765 bad formatting, where Exim silently just does not fix it up.  This may change
3766 in future.
3767
3768 As this affects audit information, the caller must be a trusted user to use
3769 this option.
3770
3771 .vitem &%-h%&&~<&'number'&>
3772 .oindex "&%-h%&"
3773 .cindex "Sendmail compatibility" "&%-h%& option ignored"
3774 This option is accepted for compatibility with Sendmail, but has no effect. (In
3775 Sendmail it overrides the &"hop count"& obtained by counting &'Received:'&
3776 headers.)
3777
3778 .vitem &%-i%&
3779 .oindex "&%-i%&"
3780 .cindex "Solaris" "&'mail'& command"
3781 .cindex "dot" "in incoming non-SMTP message"
3782 This option, which has the same effect as &%-oi%&, specifies that a dot on a
3783 line by itself should not terminate an incoming, non-SMTP message. I can find
3784 no documentation for this option in Solaris 2.4 Sendmail, but the &'mailx'&
3785 command in Solaris 2.4 uses it. See also &%-ti%&.
3786
3787 .vitem &%-L%&&~<&'tag'&>
3788 .oindex "&%-L%&"
3789 .cindex "syslog" "process name; set with flag"
3790 This option is equivalent to setting &%syslog_processname%& in the config
3791 file and setting &%log_file_path%& to &`syslog`&.
3792 Its use is restricted to administrators.  The configuration file has to be
3793 read and parsed, to determine access rights, before this is set and takes
3794 effect, so early configuration file errors will not honour this flag.
3795
3796 The tag should not be longer than 32 characters.
3797
3798 .vitem &%-M%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3799 .oindex "&%-M%&"
3800 .cindex "forcing delivery"
3801 .cindex "delivery" "forcing attempt"
3802 .cindex "frozen messages" "forcing delivery"
3803 This option requests Exim to run a delivery attempt on each message in turn. If
3804 any of the messages are frozen, they are automatically thawed before the
3805 delivery attempt. The settings of &%queue_domains%&, &%queue_smtp_domains%&,
3806 and &%hold_domains%& are ignored.
3807
3808 Retry
3809 .cindex "hints database" "overriding retry hints"
3810 hints for any of the addresses are overridden &-- Exim tries to deliver even if
3811 the normal retry time has not yet been reached. This option requires the caller
3812 to be an admin user. However, there is an option called &%prod_requires_admin%&
3813 which can be set false to relax this restriction (and also the same requirement
3814 for the &%-q%&, &%-R%&, and &%-S%& options).
3815
3816 The deliveries happen synchronously, that is, the original Exim process does
3817 not terminate until all the delivery attempts have finished. No output is
3818 produced unless there is a serious error. If you want to see what is happening,
3819 use the &%-v%& option as well, or inspect Exim's main log.
3820
3821 .vitem &%-Mar%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3822 .oindex "&%-Mar%&"
3823 .cindex "message" "adding recipients"
3824 .cindex "recipient" "adding"
3825 This option requests Exim to add the addresses to the list of recipients of the
3826 message (&"ar"& for &"add recipients"&). The first argument must be a message
3827 id, and the remaining ones must be email addresses. However, if the message is
3828 active (in the middle of a delivery attempt), it is not altered. This option
3829 can be used only by an admin user.
3830
3831 .vitem "&%-MC%&&~<&'transport'&>&~<&'hostname'&>&~<&'sequence&~number'&>&&&
3832         &~<&'message&~id'&>"
3833 .oindex "&%-MC%&"
3834 .cindex "SMTP" "passed connection"
3835 .cindex "SMTP" "multiple deliveries"
3836 .cindex "multiple SMTP deliveries"
3837 This option is not intended for use by external callers. It is used internally
3838 by Exim to invoke another instance of itself to deliver a waiting message using
3839 an existing SMTP connection, which is passed as the standard input. Details are
3840 given in chapter &<<CHAPSMTP>>&. This must be the final option, and the caller
3841 must be root or the Exim user in order to use it.
3842
3843 .vitem &%-MCA%&
3844 .oindex "&%-MCA%&"
3845 This option is not intended for use by external callers. It is used internally
3846 by Exim in conjunction with the &%-MC%& option. It signifies that the
3847 connection to the remote host has been authenticated.
3848
3849 .vitem &%-MCD%&
3850 .oindex "&%-MCD%&"
3851 This option is not intended for use by external callers. It is used internally
3852 by Exim in conjunction with the &%-MC%& option. It signifies that the
3853 remote host supports the ESMTP &_DSN_& extension.
3854
3855 .vitem &%-MCG%&&~<&'queue&~name'&>
3856 .oindex "&%-MCG%&"
3857 This option is not intended for use by external callers. It is used internally
3858 by Exim in conjunction with the &%-MC%& option. It signifies that an
3859 alternate queue is used, named by the following argument.
3860
3861 .vitem &%-MCK%&
3862 .oindex "&%-MCK%&"
3863 This option is not intended for use by external callers. It is used internally
3864 by Exim in conjunction with the &%-MC%& option. It signifies that a
3865 remote host supports the ESMTP &_CHUNKING_& extension.
3866
3867 .vitem &%-MCP%&
3868 .oindex "&%-MCP%&"
3869 This option is not intended for use by external callers. It is used internally
3870 by Exim in conjunction with the &%-MC%& option. It signifies that the server to
3871 which Exim is connected supports pipelining.
3872
3873 .vitem &%-MCQ%&&~<&'process&~id'&>&~<&'pipe&~fd'&>
3874 .oindex "&%-MCQ%&"
3875 This option is not intended for use by external callers. It is used internally
3876 by Exim in conjunction with the &%-MC%& option when the original delivery was
3877 started by a queue runner. It passes on the process id of the queue runner,
3878 together with the file descriptor number of an open pipe. Closure of the pipe
3879 signals the final completion of the sequence of processes that are passing
3880 messages through the same SMTP connection.
3881
3882 .vitem &%-MCS%&
3883 .oindex "&%-MCS%&"
3884 This option is not intended for use by external callers. It is used internally
3885 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3886 SMTP SIZE option should be used on messages delivered down the existing
3887 connection.
3888
3889 .vitem &%-MCT%&
3890 .oindex "&%-MCT%&"
3891 This option is not intended for use by external callers. It is used internally
3892 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3893 host to which Exim is connected supports TLS encryption.
3894
3895 .vitem &%-MCt%&&~<&'IP&~address'&>&~<&'port'&>&~<&'cipher'&>
3896 .oindex "&%-MCt%&"
3897 This option is not intended for use by external callers. It is used internally
3898 by Exim in conjunction with the &%-MC%& option, and passes on the fact that the
3899 connection is being proxied by a parent process for handling TLS encryption.
3900 The arguments give the local address and port being proxied, and the TLS cipher.
3901
3902 .vitem &%-Mc%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3903 .oindex "&%-Mc%&"
3904 .cindex "hints database" "not overridden by &%-Mc%&"
3905 .cindex "delivery" "manually started &-- not forced"
3906 This option requests Exim to run a delivery attempt on each message, in turn,
3907 but unlike the &%-M%& option, it does check for retry hints, and respects any
3908 that are found. This option is not very useful to external callers. It is
3909 provided mainly for internal use by Exim when it needs to re-invoke itself in
3910 order to regain root privilege for a delivery (see chapter &<<CHAPsecurity>>&).
3911 However, &%-Mc%& can be useful when testing, in order to run a delivery that
3912 respects retry times and other options such as &%hold_domains%& that are
3913 overridden when &%-M%& is used. Such a delivery does not count as a queue run.
3914 If you want to run a specific delivery as if in a queue run, you should use
3915 &%-q%& with a message id argument. A distinction between queue run deliveries
3916 and other deliveries is made in one or two places.
3917
3918 .vitem &%-Mes%&&~<&'message&~id'&>&~<&'address'&>
3919 .oindex "&%-Mes%&"
3920 .cindex "message" "changing sender"
3921 .cindex "sender" "changing"
3922 This option requests Exim to change the sender address in the message to the
3923 given address, which must be a fully qualified address or &"<>"& (&"es"& for
3924 &"edit sender"&). There must be exactly two arguments. The first argument must
3925 be a message id, and the second one an email address. However, if the message
3926 is active (in the middle of a delivery attempt), its status is not altered.
3927 This option can be used only by an admin user.
3928
3929 .vitem &%-Mf%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3930 .oindex "&%-Mf%&"
3931 .cindex "freezing messages"
3932 .cindex "message" "manually freezing"
3933 This option requests Exim to mark each listed message as &"frozen"&. This
3934 prevents any delivery attempts taking place until the message is &"thawed"&,
3935 either manually or as a result of the &%auto_thaw%& configuration option.
3936 However, if any of the messages are active (in the middle of a delivery
3937 attempt), their status is not altered. This option can be used only by an admin
3938 user.
3939
3940 .vitem &%-Mg%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3941 .oindex "&%-Mg%&"
3942 .cindex "giving up on messages"
3943 .cindex "message" "abandoning delivery attempts"
3944 .cindex "delivery" "abandoning further attempts"
3945 This option requests Exim to give up trying to deliver the listed messages,
3946 including any that are frozen. However, if any of the messages are active,
3947 their status is not altered. For non-bounce messages, a delivery error message
3948 is sent to the sender, containing the text &"cancelled by administrator"&.
3949 Bounce messages are just discarded. This option can be used only by an admin
3950 user.
3951
3952 .vitem &%-Mmad%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3953 .oindex "&%-Mmad%&"
3954 .cindex "delivery" "cancelling all"
3955 This option requests Exim to mark all the recipient addresses in the messages
3956 as already delivered (&"mad"& for &"mark all delivered"&). However, if any
3957 message is active (in the middle of a delivery attempt), its status is not
3958 altered. This option can be used only by an admin user.
3959
3960 .vitem &%-Mmd%&&~<&'message&~id'&>&~<&'address'&>&~<&'address'&>&~...
3961 .oindex "&%-Mmd%&"
3962 .cindex "delivery" "cancelling by address"
3963 .cindex "recipient" "removing"
3964 .cindex "removing recipients"
3965 This option requests Exim to mark the given addresses as already delivered
3966 (&"md"& for &"mark delivered"&). The first argument must be a message id, and
3967 the remaining ones must be email addresses. These are matched to recipient
3968 addresses in the message in a case-sensitive manner. If the message is active
3969 (in the middle of a delivery attempt), its status is not altered. This option
3970 can be used only by an admin user.
3971
3972 .vitem &%-Mrm%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
3973 .oindex "&%-Mrm%&"
3974 .cindex "removing messages"
3975 .cindex "abandoning mail"
3976 .cindex "message" "manually discarding"
3977 This option requests Exim to remove the given messages from the queue. No
3978 bounce messages are sent; each message is simply forgotten. However, if any of
3979 the messages are active, their status is not altered. This option can be used
3980 only by an admin user or by the user who originally caused the message to be
3981 placed in the queue.
3982
3983 . .new
3984 . .vitem &%-MS%&
3985 . .oindex "&%-MS%&"
3986 . .cindex REQUIRETLS
3987 . This option is used to request REQUIRETLS processing on the message.
3988 . It is used internally by Exim in conjunction with -E when generating
3989 . a bounce message.
3990 . .wen
3991
3992 .vitem &%-Mset%&&~<&'message&~id'&>
3993 .oindex "&%-Mset%&"
3994 .cindex "testing" "string expansion"
3995 .cindex "expansion" "testing"
3996 This option is useful only in conjunction with &%-be%& (that is, when testing
3997 string expansions). Exim loads the given message from its spool before doing
3998 the test expansions, thus setting message-specific variables such as
3999 &$message_size$& and the header variables. The &$recipients$& variable is made
4000 available. This feature is provided to make it easier to test expansions that
4001 make use of these variables. However, this option can be used only by an admin
4002 user. See also &%-bem%&.
4003
4004 .vitem &%-Mt%&&~<&'message&~id'&>&~<&'message&~id'&>&~...
4005 .oindex "&%-Mt%&"
4006 .cindex "thawing messages"
4007 .cindex "unfreezing messages"
4008 .cindex "frozen messages" "thawing"
4009 .cindex "message" "thawing frozen"
4010 This option requests Exim to &"thaw"& any of the listed messages that are
4011 &"frozen"&, so that delivery attempts can resume. However, if any of the
4012 messages are active, their status is not altered. This option can be used only
4013 by an admin user.
4014
4015 .vitem &%-Mvb%&&~<&'message&~id'&>
4016 .oindex "&%-Mvb%&"
4017 .cindex "listing" "message body"
4018 .cindex "message" "listing body of"
4019 This option causes the contents of the message body (-D) spool file to be
4020 written to the standard output. This option can be used only by an admin user.
4021
4022 .vitem &%-Mvc%&&~<&'message&~id'&>
4023 .oindex "&%-Mvc%&"
4024 .cindex "message" "listing in RFC 2822 format"
4025 .cindex "listing" "message in RFC 2822 format"
4026 This option causes a copy of the complete message (header lines plus body) to
4027 be written to the standard output in RFC 2822 format. This option can be used
4028 only by an admin user.
4029
4030 .vitem &%-Mvh%&&~<&'message&~id'&>
4031 .oindex "&%-Mvh%&"
4032 .cindex "listing" "message headers"
4033 .cindex "header lines" "listing"
4034 .cindex "message" "listing header lines"
4035 This option causes the contents of the message headers (-H) spool file to be
4036 written to the standard output. This option can be used only by an admin user.
4037
4038 .vitem &%-Mvl%&&~<&'message&~id'&>
4039 .oindex "&%-Mvl%&"
4040 .cindex "listing" "message log"
4041 .cindex "message" "listing message log"
4042 This option causes the contents of the message log spool file to be written to
4043 the standard output. This option can be used only by an admin user.
4044
4045 .vitem &%-m%&
4046 .oindex "&%-m%&"
4047 This is apparently a synonym for &%-om%& that is accepted by Sendmail, so Exim
4048 treats it that way too.
4049
4050 .vitem &%-N%&
4051 .oindex "&%-N%&"
4052 .cindex "debugging" "&%-N%& option"
4053 .cindex "debugging" "suppressing delivery"
4054 This is a debugging option that inhibits delivery of a message at the transport
4055 level. It implies &%-v%&. Exim goes through many of the motions of delivery &--
4056 it just doesn't actually transport the message, but instead behaves as if it
4057 had successfully done so. However, it does not make any updates to the retry
4058 database, and the log entries for deliveries are flagged with &"*>"& rather
4059 than &"=>"&.
4060
4061 Because &%-N%& discards any message to which it applies, only root or the Exim
4062 user are allowed to use it with &%-bd%&, &%-q%&, &%-R%& or &%-M%&. In other
4063 words, an ordinary user can use it only when supplying an incoming message to
4064 which it will apply. Although transportation never fails when &%-N%& is set, an
4065 address may be deferred because of a configuration problem on a transport, or a
4066 routing problem. Once &%-N%& has been used for a delivery attempt, it sticks to
4067 the message, and applies to any subsequent delivery attempts that may happen
4068 for that message.
4069
4070 .vitem &%-n%&
4071 .oindex "&%-n%&"
4072 This option is interpreted by Sendmail to mean &"no aliasing"&.
4073 For normal modes of operation, it is ignored by Exim.
4074 When combined with &%-bP%& it makes the output more terse (suppresses
4075 option names, environment values and config pretty printing).
4076
4077 .vitem &%-O%&&~<&'data'&>
4078 .oindex "&%-O%&"
4079 This option is interpreted by Sendmail to mean &`set option`&. It is ignored by
4080 Exim.
4081
4082 .vitem &%-oA%&&~<&'file&~name'&>
4083 .oindex "&%-oA%&"
4084 .cindex "Sendmail compatibility" "&%-oA%& option"
4085 This option is used by Sendmail in conjunction with &%-bi%& to specify an
4086 alternative alias filename. Exim handles &%-bi%& differently; see the
4087 description above.
4088
4089 .vitem &%-oB%&&~<&'n'&>
4090 .oindex "&%-oB%&"
4091 .cindex "SMTP" "passed connection"
4092 .cindex "SMTP" "multiple deliveries"
4093 .cindex "multiple SMTP deliveries"
4094 This is a debugging option which limits the maximum number of messages that can
4095 be delivered down one SMTP connection, overriding the value set in any &(smtp)&
4096 transport. If <&'n'&> is omitted, the limit is set to 1.
4097
4098 .vitem &%-odb%&
4099 .oindex "&%-odb%&"
4100 .cindex "background delivery"
4101 .cindex "delivery" "in the background"
4102 This option applies to all modes in which Exim accepts incoming messages,
4103 including the listening daemon. It requests &"background"& delivery of such
4104 messages, which means that the accepting process automatically starts a
4105 delivery process for each message received, but does not wait for the delivery
4106 processes to finish.
4107
4108 When all the messages have been received, the reception process exits,
4109 leaving the delivery processes to finish in their own time. The standard output
4110 and error streams are closed at the start of each delivery process.
4111 This is the default action if none of the &%-od%& options are present.
4112
4113 If one of the queueing options in the configuration file
4114 (&%queue_only%& or &%queue_only_file%&, for example) is in effect, &%-odb%&
4115 overrides it if &%queue_only_override%& is set true, which is the default
4116 setting. If &%queue_only_override%& is set false, &%-odb%& has no effect.
4117
4118 .vitem &%-odf%&
4119 .oindex "&%-odf%&"
4120 .cindex "foreground delivery"
4121 .cindex "delivery" "in the foreground"
4122 This option requests &"foreground"& (synchronous) delivery when Exim has
4123 accepted a locally-generated message. (For the daemon it is exactly the same as
4124 &%-odb%&.) A delivery process is automatically started to deliver the message,
4125 and Exim waits for it to complete before proceeding.
4126
4127 The original Exim reception process does not finish until the delivery
4128 process for the final message has ended. The standard error stream is left open
4129 during deliveries.
4130
4131 However, like &%-odb%&, this option has no effect if &%queue_only_override%& is
4132 false and one of the queueing options in the configuration file is in effect.
4133
4134 If there is a temporary delivery error during foreground delivery, the
4135 message is left in the queue for later delivery, and the original reception
4136 process exits. See chapter &<<CHAPnonqueueing>>& for a way of setting up a
4137 restricted configuration that never queues messages.
4138
4139
4140 .vitem &%-odi%&
4141 .oindex "&%-odi%&"
4142 This option is synonymous with &%-odf%&. It is provided for compatibility with
4143 Sendmail.
4144
4145 .vitem &%-odq%&
4146 .oindex "&%-odq%&"
4147 .cindex "non-immediate delivery"
4148 .cindex "delivery" "suppressing immediate"
4149 .cindex "queueing incoming messages"
4150 This option applies to all modes in which Exim accepts incoming messages,
4151 including the listening daemon. It specifies that the accepting process should
4152 not automatically start a delivery process for each message received. Messages
4153 are placed in the queue, and remain there until a subsequent queue runner
4154 process encounters them. There are several configuration options (such as
4155 &%queue_only%&) that can be used to queue incoming messages under certain
4156 conditions. This option overrides all of them and also &%-odqs%&. It always
4157 forces queueing.
4158
4159 .vitem &%-odqs%&
4160 .oindex "&%-odqs%&"
4161 .cindex "SMTP" "delaying delivery"
4162 This option is a hybrid between &%-odb%&/&%-odi%& and &%-odq%&.
4163 However, like &%-odb%& and &%-odi%&, this option has no effect if
4164 &%queue_only_override%& is false and one of the queueing options in the
4165 configuration file is in effect.
4166
4167 When &%-odqs%& does operate, a delivery process is started for each incoming
4168 message, in the background by default, but in the foreground if &%-odi%& is
4169 also present. The recipient addresses are routed, and local deliveries are done
4170 in the normal way. However, if any SMTP deliveries are required, they are not
4171 done at this time, so the message remains in the queue until a subsequent queue
4172 runner process encounters it. Because routing was done, Exim knows which
4173 messages are waiting for which hosts, and so a number of messages for the same
4174 host can be sent in a single SMTP connection. The &%queue_smtp_domains%&
4175 configuration option has the same effect for specific domains. See also the
4176 &%-qq%& option.
4177
4178 .vitem &%-oee%&
4179 .oindex "&%-oee%&"
4180 .cindex "error" "reporting"
4181 If an error is detected while a non-SMTP message is being received (for
4182 example, a malformed address), the error is reported to the sender in a mail
4183 message.
4184
4185 .cindex "return code" "for &%-oee%&"
4186 Provided
4187 this error message is successfully sent, the Exim receiving process
4188 exits with a return code of zero. If not, the return code is 2 if the problem
4189 is that the original message has no recipients, or 1 for any other error.
4190 This is the default &%-oe%&&'x'& option if Exim is called as &'rmail'&.
4191
4192 .vitem &%-oem%&
4193 .oindex "&%-oem%&"
4194 .cindex "error" "reporting"
4195 .cindex "return code" "for &%-oem%&"
4196 This is the same as &%-oee%&, except that Exim always exits with a non-zero
4197 return code, whether or not the error message was successfully sent.
4198 This is the default &%-oe%&&'x'& option, unless Exim is called as &'rmail'&.
4199
4200 .vitem &%-oep%&
4201 .oindex "&%-oep%&"
4202 .cindex "error" "reporting"
4203 If an error is detected while a non-SMTP message is being received, the
4204 error is reported by writing a message to the standard error file (stderr).
4205 .cindex "return code" "for &%-oep%&"
4206 The return code is 1 for all errors.
4207
4208 .vitem &%-oeq%&
4209 .oindex "&%-oeq%&"
4210 .cindex "error" "reporting"
4211 This option is supported for compatibility with Sendmail, but has the same
4212 effect as &%-oep%&.
4213
4214 .vitem &%-oew%&
4215 .oindex "&%-oew%&"
4216 .cindex "error" "reporting"
4217 This option is supported for compatibility with Sendmail, but has the same
4218 effect as &%-oem%&.
4219
4220 .vitem &%-oi%&
4221 .oindex "&%-oi%&"
4222 .cindex "dot" "in incoming non-SMTP message"
4223 This option, which has the same effect as &%-i%&, specifies that a dot on a
4224 line by itself should not terminate an incoming, non-SMTP message. Otherwise, a
4225 single dot does terminate, though Exim does no special processing for other
4226 lines that start with a dot. This option is set by default if Exim is called as
4227 &'rmail'&. See also &%-ti%&.
4228
4229 .vitem &%-oitrue%&
4230 .oindex "&%-oitrue%&"
4231 This option is treated as synonymous with &%-oi%&.
4232
4233 .vitem &%-oMa%&&~<&'host&~address'&>
4234 .oindex "&%-oMa%&"
4235 .cindex "sender" "host address, specifying for local message"
4236 A number of options starting with &%-oM%& can be used to set values associated
4237 with remote hosts on locally-submitted messages (that is, messages not received
4238 over TCP/IP). These options can be used by any caller in conjunction with the
4239 &%-bh%&, &%-be%&, &%-bf%&, &%-bF%&, &%-bt%&, or &%-bv%& testing options. In
4240 other circumstances, they are ignored unless the caller is trusted.
4241
4242 The &%-oMa%& option sets the sender host address. This may include a port
4243 number at the end, after a full stop (period). For example:
4244 .code
4245 exim -bs -oMa 10.9.8.7.1234
4246 .endd
4247 An alternative syntax is to enclose the IP address in square brackets,
4248 followed by a colon and the port number:
4249 .code
4250 exim -bs -oMa [10.9.8.7]:1234
4251 .endd
4252 The IP address is placed in the &$sender_host_address$& variable, and the
4253 port, if present, in &$sender_host_port$&. If both &%-oMa%& and &%-bh%&
4254 are present on the command line, the sender host IP address is taken from
4255 whichever one is last.
4256
4257 .vitem &%-oMaa%&&~<&'name'&>
4258 .oindex "&%-oMaa%&"
4259 .cindex "authentication" "name, specifying for local message"
4260 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMaa%&
4261 option sets the value of &$sender_host_authenticated$& (the authenticator
4262 name). See chapter &<<CHAPSMTPAUTH>>& for a discussion of SMTP authentication.
4263 This option can be used with &%-bh%& and &%-bs%& to set up an
4264 authenticated SMTP session without actually using the SMTP AUTH command.
4265
4266 .vitem &%-oMai%&&~<&'string'&>
4267 .oindex "&%-oMai%&"
4268 .cindex "authentication" "id, specifying for local message"
4269 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMai%&
4270 option sets the value of &$authenticated_id$& (the id that was authenticated).
4271 This overrides the default value (the caller's login id, except with &%-bh%&,
4272 where there is no default) for messages from local sources. See chapter
4273 &<<CHAPSMTPAUTH>>& for a discussion of authenticated ids.
4274
4275 .vitem &%-oMas%&&~<&'address'&>
4276 .oindex "&%-oMas%&"
4277 .cindex "authentication" "sender, specifying for local message"
4278 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMas%&
4279 option sets the authenticated sender value in &$authenticated_sender$&. It
4280 overrides the sender address that is created from the caller's login id for
4281 messages from local sources, except when &%-bh%& is used, when there is no
4282 default. For both &%-bh%& and &%-bs%&, an authenticated sender that is
4283 specified on a MAIL command overrides this value. See chapter
4284 &<<CHAPSMTPAUTH>>& for a discussion of authenticated senders.
4285
4286 .vitem &%-oMi%&&~<&'interface&~address'&>
4287 .oindex "&%-oMi%&"
4288 .cindex "interface" "address, specifying for local message"
4289 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMi%&
4290 option sets the IP interface address value. A port number may be included,
4291 using the same syntax as for &%-oMa%&. The interface address is placed in
4292 &$received_ip_address$& and the port number, if present, in &$received_port$&.
4293
4294 .vitem &%-oMm%&&~<&'message&~reference'&>
4295 .oindex "&%-oMm%&"
4296 .cindex "message reference" "message reference, specifying for local message"
4297 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMm%&
4298 option sets the message reference, e.g. message-id, and is logged during
4299 delivery. This is useful when some kind of audit trail is required to tie
4300 messages together. The format of the message reference is checked and will
4301 abort if the format is invalid. The option will only be accepted if exim is
4302 running in trusted mode, not as any regular user.
4303
4304 The best example of a message reference is when Exim sends a bounce message.
4305 The message reference is the message-id of the original message for which Exim
4306 is sending the bounce.
4307
4308 .vitem &%-oMr%&&~<&'protocol&~name'&>
4309 .oindex "&%-oMr%&"
4310 .cindex "protocol, specifying for local message"
4311 .vindex "&$received_protocol$&"
4312 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMr%&
4313 option sets the received protocol value that is stored in
4314 &$received_protocol$&. However, it does not apply (and is ignored) when &%-bh%&
4315 or &%-bs%& is used. For &%-bh%&, the protocol is forced to one of the standard
4316 SMTP protocol names (see the description of &$received_protocol$& in section
4317 &<<SECTexpvar>>&). For &%-bs%&, the protocol is always &"local-"& followed by
4318 one of those same names. For &%-bS%& (batched SMTP) however, the protocol can
4319 be set by &%-oMr%&. Repeated use of this option is not supported.
4320
4321 .vitem &%-oMs%&&~<&'host&~name'&>
4322 .oindex "&%-oMs%&"
4323 .cindex "sender" "host name, specifying for local message"
4324 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMs%&
4325 option sets the sender host name in &$sender_host_name$&. When this option is
4326 present, Exim does not attempt to look up a host name from an IP address; it
4327 uses the name it is given.
4328
4329 .vitem &%-oMt%&&~<&'ident&~string'&>
4330 .oindex "&%-oMt%&"
4331 .cindex "sender" "ident string, specifying for local message"
4332 See &%-oMa%& above for general remarks about the &%-oM%& options. The &%-oMt%&
4333 option sets the sender ident value in &$sender_ident$&. The default setting for
4334 local callers is the login id of the calling process, except when &%-bh%& is
4335 used, when there is no default.
4336
4337 .vitem &%-om%&
4338 .oindex "&%-om%&"
4339 .cindex "Sendmail compatibility" "&%-om%& option ignored"
4340 In Sendmail, this option means &"me too"&, indicating that the sender of a
4341 message should receive a copy of the message if the sender appears in an alias
4342 expansion. Exim always does this, so the option does nothing.
4343
4344 .vitem &%-oo%&
4345 .oindex "&%-oo%&"
4346 .cindex "Sendmail compatibility" "&%-oo%& option ignored"
4347 This option is ignored. In Sendmail it specifies &"old style headers"&,
4348 whatever that means.
4349
4350 .vitem &%-oP%&&~<&'path'&>
4351 .oindex "&%-oP%&"
4352 .cindex "pid (process id)" "of daemon"
4353 .cindex "daemon" "process id (pid)"
4354 This option is useful only in conjunction with &%-bd%& or &%-q%& with a time
4355 value. The option specifies the file to which the process id of the daemon is
4356 written. When &%-oX%& is used with &%-bd%&, or when &%-q%& with a time is used
4357 without &%-bd%&, this is the only way of causing Exim to write a pid file,
4358 because in those cases, the normal pid file is not used.
4359
4360 .vitem &%-or%&&~<&'time'&>
4361 .oindex "&%-or%&"
4362 .cindex "timeout" "for non-SMTP input"
4363 This option sets a timeout value for incoming non-SMTP messages. If it is not
4364 set, Exim will wait forever for the standard input. The value can also be set
4365 by the &%receive_timeout%& option. The format used for specifying times is
4366 described in section &<<SECTtimeformat>>&.
4367
4368 .vitem &%-os%&&~<&'time'&>
4369 .oindex "&%-os%&"
4370 .cindex "timeout" "for SMTP input"
4371 .cindex "SMTP" "input timeout"
4372 This option sets a timeout value for incoming SMTP messages. The timeout
4373 applies to each SMTP command and block of data. The value can also be set by
4374 the &%smtp_receive_timeout%& option; it defaults to 5 minutes. The format used
4375 for specifying times is described in section &<<SECTtimeformat>>&.
4376
4377 .vitem &%-ov%&
4378 .oindex "&%-ov%&"
4379 This option has exactly the same effect as &%-v%&.
4380
4381 .vitem &%-oX%&&~<&'number&~or&~string'&>
4382 .oindex "&%-oX%&"
4383 .cindex "TCP/IP" "setting listening ports"
4384 .cindex "TCP/IP" "setting listening interfaces"
4385 .cindex "port" "receiving TCP/IP"
4386 This option is relevant only when the &%-bd%& (start listening daemon) option
4387 is also given. It controls which ports and interfaces the daemon uses. Details
4388 of the syntax, and how it interacts with configuration file options, are given
4389 in chapter &<<CHAPinterfaces>>&. When &%-oX%& is used to start a daemon, no pid
4390 file is written unless &%-oP%& is also present to specify a pid filename.
4391
4392 .vitem &%-pd%&
4393 .oindex "&%-pd%&"
4394 .cindex "Perl" "starting the interpreter"
4395 This option applies when an embedded Perl interpreter is linked with Exim (see
4396 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4397 option, forcing the starting of the interpreter to be delayed until it is
4398 needed.
4399
4400 .vitem &%-ps%&
4401 .oindex "&%-ps%&"
4402 .cindex "Perl" "starting the interpreter"
4403 This option applies when an embedded Perl interpreter is linked with Exim (see
4404 chapter &<<CHAPperl>>&). It overrides the setting of the &%perl_at_start%&
4405 option, forcing the starting of the interpreter to occur as soon as Exim is
4406 started.
4407
4408 .vitem &%-p%&<&'rval'&>:<&'sval'&>
4409 .oindex "&%-p%&"
4410 For compatibility with Sendmail, this option is equivalent to
4411 .display
4412 &`-oMr`& <&'rval'&> &`-oMs`& <&'sval'&>
4413 .endd
4414 It sets the incoming protocol and host name (for trusted callers). The
4415 host name and its colon can be omitted when only the protocol is to be set.
4416 Note the Exim already has two private options, &%-pd%& and &%-ps%&, that refer
4417 to embedded Perl. It is therefore impossible to set a protocol value of &`d`&
4418 or &`s`& using this option (but that does not seem a real limitation).
4419 Repeated use of this option is not supported.
4420
4421 .vitem &%-q%&
4422 .oindex "&%-q%&"
4423 .cindex "queue runner" "starting manually"
4424 This option is normally restricted to admin users. However, there is a
4425 configuration option called &%prod_requires_admin%& which can be set false to
4426 relax this restriction (and also the same requirement for the &%-M%&, &%-R%&,
4427 and &%-S%& options).
4428
4429 .cindex "queue runner" "description of operation"
4430 If other commandline options do not specify an action,
4431 the &%-q%& option starts one queue runner process. This scans the queue of
4432 waiting messages, and runs a delivery process for each one in turn. It waits
4433 for each delivery process to finish before starting the next one. A delivery
4434 process may not actually do any deliveries if the retry times for the addresses
4435 have not been reached. Use &%-qf%& (see below) if you want to override this.
4436
4437 If
4438 .cindex "SMTP" "passed connection"
4439 .cindex "SMTP" "multiple deliveries"
4440 .cindex "multiple SMTP deliveries"
4441 the delivery process spawns other processes to deliver other messages down
4442 passed SMTP connections, the queue runner waits for these to finish before
4443 proceeding.
4444
4445 When all the queued messages have been considered, the original queue runner
4446 process terminates. In other words, a single pass is made over the waiting
4447 mail, one message at a time. Use &%-q%& with a time (see below) if you want
4448 this to be repeated periodically.
4449
4450 Exim processes the waiting messages in an unpredictable order. It isn't very
4451 random, but it is likely to be different each time, which is all that matters.
4452 If one particular message screws up a remote MTA, other messages to the same
4453 MTA have a chance of getting through if they get tried first.
4454
4455 It is possible to cause the messages to be processed in lexical message id
4456 order, which is essentially the order in which they arrived, by setting the
4457 &%queue_run_in_order%& option, but this is not recommended for normal use.
4458
4459 .vitem &%-q%&<&'qflags'&>
4460 The &%-q%& option may be followed by one or more flag letters that change its
4461 behaviour. They are all optional, but if more than one is present, they must
4462 appear in the correct order. Each flag is described in a separate item below.
4463
4464 .vitem &%-qq...%&
4465 .oindex "&%-qq%&"
4466 .cindex "queue" "double scanning"
4467 .cindex "queue" "routing"
4468 .cindex "routing" "whole queue before delivery"
4469 An option starting with &%-qq%& requests a two-stage queue run. In the first
4470 stage, the queue is scanned as if the &%queue_smtp_domains%& option matched
4471 every domain. Addresses are routed, local deliveries happen, but no remote
4472 transports are run.
4473
4474 .cindex "hints database" "remembering routing"
4475 The hints database that remembers which messages are waiting for specific hosts
4476 is updated, as if delivery to those hosts had been deferred. After this is
4477 complete, a second, normal queue scan happens, with routing and delivery taking
4478 place as normal. Messages that are routed to the same host should mostly be
4479 delivered down a single SMTP
4480 .cindex "SMTP" "passed connection"
4481 .cindex "SMTP" "multiple deliveries"
4482 .cindex "multiple SMTP deliveries"
4483 connection because of the hints that were set up during the first queue scan.
4484 This option may be useful for hosts that are connected to the Internet
4485 intermittently.
4486
4487 .vitem &%-q[q]i...%&
4488 .oindex "&%-qi%&"
4489 .cindex "queue" "initial delivery"
4490 If the &'i'& flag is present, the queue runner runs delivery processes only for
4491 those messages that haven't previously been tried. (&'i'& stands for &"initial
4492 delivery"&.) This can be helpful if you are putting messages in the queue using
4493 &%-odq%& and want a queue runner just to process the new messages.
4494
4495 .vitem &%-q[q][i]f...%&
4496 .oindex "&%-qf%&"
4497 .cindex "queue" "forcing delivery"
4498 .cindex "delivery" "forcing in queue run"
4499 If one &'f'& flag is present, a delivery attempt is forced for each non-frozen
4500 message, whereas without &'f'& only those non-frozen addresses that have passed
4501 their retry times are tried.
4502
4503 .vitem &%-q[q][i]ff...%&
4504 .oindex "&%-qff%&"
4505 .cindex "frozen messages" "forcing delivery"
4506 If &'ff'& is present, a delivery attempt is forced for every message, whether
4507 frozen or not.
4508
4509 .vitem &%-q[q][i][f[f]]l%&
4510 .oindex "&%-ql%&"
4511 .cindex "queue" "local deliveries only"
4512 The &'l'& (the letter &"ell"&) flag specifies that only local deliveries are to
4513 be done. If a message requires any remote deliveries, it remains in the queue
4514 for later delivery.
4515
4516 .vitem &%-q[q][i][f[f]][l][G<name>[/<time>]]]%&
4517 .oindex "&%-qG%&"
4518 .cindex queue named
4519 .cindex "named queues"
4520 .cindex "queue" "delivering specific messages"
4521 If the &'G'& flag and a name is present, the queue runner operates on the
4522 queue with the given name rather than the default queue.
4523 The name should not contain a &'/'& character.
4524 For a periodic queue run (see below)
4525 append to the name a slash and a time value.
4526
4527 If other commandline options specify an action, a &'-qG<name>'& option
4528 will specify a queue to operate on.
4529 For example:
4530 .code
4531 exim -bp -qGquarantine
4532 mailq -qGquarantine
4533 exim -qGoffpeak -Rf @special.domain.example
4534 .endd
4535
4536 .vitem &%-q%&<&'qflags'&>&~<&'start&~id'&>&~<&'end&~id'&>
4537 When scanning the queue, Exim can be made to skip over messages whose ids are
4538 lexically less than a given value by following the &%-q%& option with a
4539 starting message id. For example:
4540 .code
4541 exim -q 0t5C6f-0000c8-00
4542 .endd
4543 Messages that arrived earlier than &`0t5C6f-0000c8-00`& are not inspected. If a
4544 second message id is given, messages whose ids are lexically greater than it
4545 are also skipped. If the same id is given twice, for example,
4546 .code
4547 exim -q 0t5C6f-0000c8-00 0t5C6f-0000c8-00
4548 .endd
4549 just one delivery process is started, for that message. This differs from
4550 &%-M%& in that retry data is respected, and it also differs from &%-Mc%& in
4551 that it counts as a delivery from a queue run. Note that the selection
4552 mechanism does not affect the order in which the messages are scanned. There
4553 are also other ways of selecting specific sets of messages for delivery in a
4554 queue run &-- see &%-R%& and &%-S%&.
4555
4556 .vitem &%-q%&<&'qflags'&><&'time'&>
4557 .cindex "queue runner" "starting periodically"
4558 .cindex "periodic queue running"
4559 When a time value is present, the &%-q%& option causes Exim to run as a daemon,
4560 starting a queue runner process at intervals specified by the given time value
4561 (whose format is described in section &<<SECTtimeformat>>&). This form of the
4562 &%-q%& option is commonly combined with the &%-bd%& option, in which case a
4563 single daemon process handles both functions. A common way of starting up a
4564 combined daemon at system boot time is to use a command such as
4565 .code
4566 /usr/exim/bin/exim -bd -q30m
4567 .endd
4568 Such a daemon listens for incoming SMTP calls, and also starts a queue runner
4569 process every 30 minutes.
4570
4571 When a daemon is started by &%-q%& with a time value, but without &%-bd%&, no
4572 pid file is written unless one is explicitly requested by the &%-oP%& option.
4573
4574 .vitem &%-qR%&<&'rsflags'&>&~<&'string'&>
4575 .oindex "&%-qR%&"
4576 This option is synonymous with &%-R%&. It is provided for Sendmail
4577 compatibility.
4578
4579 .vitem &%-qS%&<&'rsflags'&>&~<&'string'&>
4580 .oindex "&%-qS%&"
4581 This option is synonymous with &%-S%&.
4582
4583 .vitem &%-R%&<&'rsflags'&>&~<&'string'&>
4584 .oindex "&%-R%&"
4585 .cindex "queue runner" "for specific recipients"
4586 .cindex "delivery" "to given domain"
4587 .cindex "domain" "delivery to"
4588 The <&'rsflags'&> may be empty, in which case the white space before the string
4589 is optional, unless the string is &'f'&, &'ff'&, &'r'&, &'rf'&, or &'rff'&,
4590 which are the possible values for <&'rsflags'&>. White space is required if
4591 <&'rsflags'&> is not empty.
4592
4593 This option is similar to &%-q%& with no time value, that is, it causes Exim to
4594 perform a single queue run, except that, when scanning the messages on the
4595 queue, Exim processes only those that have at least one undelivered recipient
4596 address containing the given string, which is checked in a case-independent
4597 way. If the <&'rsflags'&> start with &'r'&, <&'string'&> is interpreted as a
4598 regular expression; otherwise it is a literal string.
4599
4600 If you want to do periodic queue runs for messages with specific recipients,
4601 you can combine &%-R%& with &%-q%& and a time value. For example:
4602 .code
4603 exim -q25m -R @special.domain.example
4604 .endd
4605 This example does a queue run for messages with recipients in the given domain
4606 every 25 minutes. Any additional flags that are specified with &%-q%& are
4607 applied to each queue run.
4608
4609 Once a message is selected for delivery by this mechanism, all its addresses
4610 are processed. For the first selected message, Exim overrides any retry
4611 information and forces a delivery attempt for each undelivered address. This
4612 means that if delivery of any address in the first message is successful, any
4613 existing retry information is deleted, and so delivery attempts for that
4614 address in subsequently selected messages (which are processed without forcing)
4615 will run. However, if delivery of any address does not succeed, the retry
4616 information is updated, and in subsequently selected messages, the failing
4617 address will be skipped.
4618
4619 .cindex "frozen messages" "forcing delivery"
4620 If the <&'rsflags'&> contain &'f'& or &'ff'&, the delivery forcing applies to
4621 all selected messages, not just the first; frozen messages are included when
4622 &'ff'& is present.
4623
4624 The &%-R%& option makes it straightforward to initiate delivery of all messages
4625 to a given domain after a host has been down for some time. When the SMTP
4626 command ETRN is accepted by its ACL (see chapter &<<CHAPACL>>&), its default
4627 effect is to run Exim with the &%-R%& option, but it can be configured to run
4628 an arbitrary command instead.
4629
4630 .vitem &%-r%&
4631 .oindex "&%-r%&"
4632 This is a documented (for Sendmail) obsolete alternative name for &%-f%&.
4633
4634 .vitem &%-S%&<&'rsflags'&>&~<&'string'&>
4635 .oindex "&%-S%&"
4636 .cindex "delivery" "from given sender"
4637 .cindex "queue runner" "for specific senders"
4638 This option acts like &%-R%& except that it checks the string against each
4639 message's sender instead of against the recipients. If &%-R%& is also set, both
4640 conditions must be met for a message to be selected. If either of the options
4641 has &'f'& or &'ff'& in its flags, the associated action is taken.
4642
4643 .vitem &%-Tqt%&&~<&'times'&>
4644 .oindex "&%-Tqt%&"
4645 This is an option that is exclusively for use by the Exim testing suite. It is not
4646 recognized when Exim is run normally. It allows for the setting up of explicit
4647 &"queue times"& so that various warning/retry features can be tested.
4648
4649 .vitem &%-t%&
4650 .oindex "&%-t%&"
4651 .cindex "recipient" "extracting from header lines"
4652 .cindex "&'Bcc:'& header line"
4653 .cindex "&'Cc:'& header line"
4654 .cindex "&'To:'& header line"
4655 When Exim is receiving a locally-generated, non-SMTP message on its standard
4656 input, the &%-t%& option causes the recipients of the message to be obtained
4657 from the &'To:'&, &'Cc:'&, and &'Bcc:'& header lines in the message instead of
4658 from the command arguments. The addresses are extracted before any rewriting
4659 takes place and the &'Bcc:'& header line, if present, is then removed.
4660
4661 .cindex "Sendmail compatibility" "&%-t%& option"
4662 If the command has any arguments, they specify addresses to which the message
4663 is &'not'& to be delivered. That is, the argument addresses are removed from
4664 the recipients list obtained from the headers. This is compatible with Smail 3
4665 and in accordance with the documented behaviour of several versions of
4666 Sendmail, as described in man pages on a number of operating systems (e.g.
4667 Solaris 8, IRIX 6.5, HP-UX 11). However, some versions of Sendmail &'add'&
4668 argument addresses to those obtained from the headers, and the O'Reilly
4669 Sendmail book documents it that way. Exim can be made to add argument addresses
4670 instead of subtracting them by setting the option
4671 &%extract_addresses_remove_arguments%& false.
4672
4673 .cindex "&%Resent-%& header lines" "with &%-t%&"
4674 If there are any &%Resent-%& header lines in the message, Exim extracts
4675 recipients from all &'Resent-To:'&, &'Resent-Cc:'&, and &'Resent-Bcc:'& header
4676 lines instead of from &'To:'&, &'Cc:'&, and &'Bcc:'&. This is for compatibility
4677 with Sendmail and other MTAs. (Prior to release 4.20, Exim gave an error if
4678 &%-t%& was used in conjunction with &%Resent-%& header lines.)
4679
4680 RFC 2822 talks about different sets of &%Resent-%& header lines (for when a
4681 message is resent several times). The RFC also specifies that they should be
4682 added at the front of the message, and separated by &'Received:'& lines. It is
4683 not at all clear how &%-t%& should operate in the present of multiple sets,
4684 nor indeed exactly what constitutes a &"set"&.
4685 In practice, it seems that MUAs do not follow the RFC. The &%Resent-%& lines
4686 are often added at the end of the header, and if a message is resent more than
4687 once, it is common for the original set of &%Resent-%& headers to be renamed as
4688 &%X-Resent-%& when a new set is added. This removes any possible ambiguity.
4689
4690 .vitem &%-ti%&
4691 .oindex "&%-ti%&"
4692 This option is exactly equivalent to &%-t%& &%-i%&. It is provided for
4693 compatibility with Sendmail.
4694
4695 .vitem &%-tls-on-connect%&
4696 .oindex "&%-tls-on-connect%&"
4697 .cindex "TLS" "use without STARTTLS"
4698 .cindex "TLS" "automatic start"
4699 This option is available when Exim is compiled with TLS support. It forces all
4700 incoming SMTP connections to behave as if the incoming port is listed in the
4701 &%tls_on_connect_ports%& option. See section &<<SECTsupobssmt>>& and chapter
4702 &<<CHAPTLS>>& for further details.
4703
4704
4705 .vitem &%-U%&
4706 .oindex "&%-U%&"
4707 .cindex "Sendmail compatibility" "&%-U%& option ignored"
4708 Sendmail uses this option for &"initial message submission"&, and its
4709 documentation states that in future releases, it may complain about
4710 syntactically invalid messages rather than fixing them when this flag is not
4711 set. Exim ignores this option.
4712
4713 .vitem &%-v%&
4714 .oindex "&%-v%&"
4715 This option causes Exim to write information to the standard error stream,
4716 describing what it is doing. In particular, it shows the log lines for
4717 receiving and delivering a message, and if an SMTP connection is made, the SMTP
4718 dialogue is shown. Some of the log lines shown may not actually be written to
4719 the log if the setting of &%log_selector%& discards them. Any relevant
4720 selectors are shown with each log line. If none are shown, the logging is
4721 unconditional.
4722
4723 .vitem &%-x%&
4724 .oindex "&%-x%&"
4725 AIX uses &%-x%& for a private purpose (&"mail from a local mail program has
4726 National Language Support extended characters in the body of the mail item"&).
4727 It sets &%-x%& when calling the MTA from its &%mail%& command. Exim ignores
4728 this option.
4729
4730 .vitem &%-X%&&~<&'logfile'&>
4731 .oindex "&%-X%&"
4732 This option is interpreted by Sendmail to cause debug information to be sent
4733 to the named file.  It is ignored by Exim.
4734
4735 .vitem &%-z%&&~<&'log-line'&>
4736 .oindex "&%-z%&"
4737 This option writes its argument to Exim's logfile.
4738 Use is restricted to administrators; the intent is for operational notes.
4739 Quotes should be used to maintain a multi-word item as a single argument,
4740 under most shells.
4741 .endlist
4742
4743 .ecindex IIDclo1
4744 .ecindex IIDclo2
4745
4746
4747 . ////////////////////////////////////////////////////////////////////////////
4748 . Insert a stylized DocBook comment here, to identify the end of the command
4749 . line options. This is for the benefit of the Perl script that automatically
4750 . creates a man page for the options.
4751 . ////////////////////////////////////////////////////////////////////////////
4752
4753 .literal xml
4754 <!-- === End of command line options === -->
4755 .literal off
4756
4757
4758
4759
4760
4761 . ////////////////////////////////////////////////////////////////////////////
4762 . ////////////////////////////////////////////////////////////////////////////
4763
4764
4765 .chapter "The Exim runtime configuration file" "CHAPconf" &&&
4766          "The runtime configuration file"
4767
4768 .cindex "runtime configuration"
4769 .cindex "configuration file" "general description"
4770 .cindex "CONFIGURE_FILE"
4771 .cindex "configuration file" "errors in"
4772 .cindex "error" "in configuration file"
4773 .cindex "return code" "for bad configuration"
4774 Exim uses a single runtime configuration file that is read whenever an Exim
4775 binary is executed. Note that in normal operation, this happens frequently,
4776 because Exim is designed to operate in a distributed manner, without central
4777 control.
4778
4779 If a syntax error is detected while reading the configuration file, Exim
4780 writes a message on the standard error, and exits with a non-zero return code.
4781 The message is also written to the panic log. &*Note*&: Only simple syntax
4782 errors can be detected at this time. The values of any expanded options are
4783 not checked until the expansion happens, even when the expansion does not
4784 actually alter the string.
4785
4786 The name of the configuration file is compiled into the binary for security
4787 reasons, and is specified by the CONFIGURE_FILE compilation option. In
4788 most configurations, this specifies a single file. However, it is permitted to
4789 give a colon-separated list of filenames, in which case Exim uses the first
4790 existing file in the list.
4791
4792 .cindex "EXIM_USER"
4793 .cindex "EXIM_GROUP"
4794 .cindex "CONFIGURE_OWNER"
4795 .cindex "CONFIGURE_GROUP"
4796 .cindex "configuration file" "ownership"
4797 .cindex "ownership" "configuration file"
4798 The runtime configuration file must be owned by root or by the user that is
4799 specified at compile time by the CONFIGURE_OWNER option (if set). The
4800 configuration file must not be world-writeable, or group-writeable unless its
4801 group is the root group or the one specified at compile time by the
4802 CONFIGURE_GROUP option.
4803
4804 &*Warning*&: In a conventional configuration, where the Exim binary is setuid
4805 to root, anybody who is able to edit the runtime configuration file has an
4806 easy way to run commands as root. If you specify a user or group in the
4807 CONFIGURE_OWNER or CONFIGURE_GROUP options, then that user and/or any users
4808 who are members of that group will trivially be able to obtain root privileges.
4809
4810 Up to Exim version 4.72, the runtime configuration file was also permitted to
4811 be writeable by the Exim user and/or group. That has been changed in Exim 4.73
4812 since it offered a simple privilege escalation for any attacker who managed to
4813 compromise the Exim user account.
4814
4815 A default configuration file, which will work correctly in simple situations,
4816 is provided in the file &_src/configure.default_&. If CONFIGURE_FILE
4817 defines just one filename, the installation process copies the default
4818 configuration to a new file of that name if it did not previously exist. If
4819 CONFIGURE_FILE is a list, no default is automatically installed. Chapter
4820 &<<CHAPdefconfil>>& is a &"walk-through"& discussion of the default
4821 configuration.
4822
4823
4824
4825 .section "Using a different configuration file" "SECID40"
4826 .cindex "configuration file" "alternate"
4827 A one-off alternate configuration can be specified by the &%-C%& command line
4828 option, which may specify a single file or a list of files. However, when
4829 &%-C%& is used, Exim gives up its root privilege, unless called by root (or
4830 unless the argument for &%-C%& is identical to the built-in value from
4831 CONFIGURE_FILE), or is listed in the TRUSTED_CONFIG_LIST file and the caller
4832 is the Exim user or the user specified in the CONFIGURE_OWNER setting. &%-C%&
4833 is useful mainly for checking the syntax of configuration files before
4834 installing them. No owner or group checks are done on a configuration file
4835 specified by &%-C%&, if root privilege has been dropped.
4836
4837 Even the Exim user is not trusted to specify an arbitrary configuration file
4838 with the &%-C%& option to be used with root privileges, unless that file is
4839 listed in the TRUSTED_CONFIG_LIST file. This locks out the possibility of
4840 testing a configuration using &%-C%& right through message reception and
4841 delivery, even if the caller is root. The reception works, but by that time,
4842 Exim is running as the Exim user, so when it re-execs to regain privilege for
4843 the delivery, the use of &%-C%& causes privilege to be lost. However, root
4844 can test reception and delivery using two separate commands (one to put a
4845 message in the queue, using &%-odq%&, and another to do the delivery, using
4846 &%-M%&).
4847
4848 If ALT_CONFIG_PREFIX is defined &_in Local/Makefile_&, it specifies a
4849 prefix string with which any file named in a &%-C%& command line option must
4850 start. In addition, the filename must not contain the sequence &"&`/../`&"&.
4851 There is no default setting for ALT_CONFIG_PREFIX; when it is unset, any
4852 filename can be used with &%-C%&.
4853
4854 One-off changes to a configuration can be specified by the &%-D%& command line
4855 option, which defines and overrides values for macros used inside the
4856 configuration file. However, like &%-C%&, the use of this option by a
4857 non-privileged user causes Exim to discard its root privilege.
4858 If DISABLE_D_OPTION is defined in &_Local/Makefile_&, the use of &%-D%& is
4859 completely disabled, and its use causes an immediate error exit.
4860
4861 The WHITELIST_D_MACROS option in &_Local/Makefile_& permits the binary builder
4862 to declare certain macro names trusted, such that root privilege will not
4863 necessarily be discarded.
4864 WHITELIST_D_MACROS defines a colon-separated list of macros which are
4865 considered safe and, if &%-D%& only supplies macros from this list, and the
4866 values are acceptable, then Exim will not give up root privilege if the caller
4867 is root, the Exim run-time user, or the CONFIGURE_OWNER, if set.  This is a
4868 transition mechanism and is expected to be removed in the future.  Acceptable
4869 values for the macros satisfy the regexp: &`^[A-Za-z0-9_/.-]*$`&
4870
4871 Some sites may wish to use the same Exim binary on different machines that
4872 share a file system, but to use different configuration files on each machine.
4873 If CONFIGURE_FILE_USE_NODE is defined in &_Local/Makefile_&, Exim first
4874 looks for a file whose name is the configuration filename followed by a dot
4875 and the machine's node name, as obtained from the &[uname()]& function. If this
4876 file does not exist, the standard name is tried. This processing occurs for
4877 each filename in the list given by CONFIGURE_FILE or &%-C%&.
4878
4879 In some esoteric situations different versions of Exim may be run under
4880 different effective uids and the CONFIGURE_FILE_USE_EUID is defined to
4881 help with this. See the comments in &_src/EDITME_& for details.
4882
4883
4884
4885 .section "Configuration file format" "SECTconffilfor"
4886 .cindex "configuration file" "format of"
4887 .cindex "format" "configuration file"
4888 Exim's configuration file is divided into a number of different parts. General
4889 option settings must always appear at the start of the file. The other parts
4890 are all optional, and may appear in any order. Each part other than the first
4891 is introduced by the word &"begin"& followed by at least one literal
4892 space, and the name of the part. The optional parts are:
4893
4894 .ilist
4895 &'ACL'&: Access control lists for controlling incoming SMTP mail (see chapter
4896 &<<CHAPACL>>&).
4897 .next
4898 .cindex "AUTH" "configuration"
4899 &'authenticators'&: Configuration settings for the authenticator drivers. These
4900 are concerned with the SMTP AUTH command (see chapter &<<CHAPSMTPAUTH>>&).
4901 .next
4902 &'routers'&: Configuration settings for the router drivers. Routers process
4903 addresses and determine how the message is to be delivered (see chapters
4904 &<<CHAProutergeneric>>&&--&<<CHAPredirect>>&).
4905 .next
4906 &'transports'&: Configuration settings for the transport drivers. Transports
4907 define mechanisms for copying messages to destinations (see chapters
4908 &<<CHAPtransportgeneric>>&&--&<<CHAPsmtptrans>>&).
4909 .next
4910 &'retry'&: Retry rules, for use when a message cannot be delivered immediately.
4911 If there is no retry section, or if it is empty (that is, no retry rules are
4912 defined), Exim will not retry deliveries. In this situation, temporary errors
4913 are treated the same as permanent errors. Retry rules are discussed in chapter
4914 &<<CHAPretry>>&.
4915 .next
4916 &'rewrite'&: Global address rewriting rules, for use when a message arrives and
4917 when new addresses are generated during delivery. Rewriting is discussed in
4918 chapter &<<CHAPrewrite>>&.
4919 .next
4920 &'local_scan'&: Private options for the &[local_scan()]& function. If you
4921 want to use this feature, you must set
4922 .code
4923 LOCAL_SCAN_HAS_OPTIONS=yes
4924 .endd
4925 in &_Local/Makefile_& before building Exim. Details of the &[local_scan()]&
4926 facility are given in chapter &<<CHAPlocalscan>>&.
4927 .endlist
4928
4929 .cindex "configuration file" "leading white space in"
4930 .cindex "configuration file" "trailing white space in"
4931 .cindex "white space" "in configuration file"
4932 Leading and trailing white space in configuration lines is always ignored.
4933
4934 Blank lines in the file, and lines starting with a # character (ignoring
4935 leading white space) are treated as comments and are ignored. &*Note*&: A
4936 # character other than at the beginning of a line is not treated specially,
4937 and does not introduce a comment.
4938
4939 Any non-comment line can be continued by ending it with a backslash. Note that
4940 the general rule for white space means that trailing white space after the
4941 backslash and leading white space at the start of continuation
4942 lines is ignored. Comment lines beginning with # (but not empty lines) may
4943 appear in the middle of a sequence of continuation lines.
4944
4945 A convenient way to create a configuration file is to start from the
4946 default, which is supplied in &_src/configure.default_&, and add, delete, or
4947 change settings as required.
4948
4949 The ACLs, retry rules, and rewriting rules have their own syntax which is
4950 described in chapters &<<CHAPACL>>&, &<<CHAPretry>>&, and &<<CHAPrewrite>>&,
4951 respectively. The other parts of the configuration file have some syntactic
4952 items in common, and these are described below, from section &<<SECTcos>>&
4953 onwards. Before that, the inclusion, macro, and conditional facilities are
4954 described.
4955
4956
4957
4958 .section "File inclusions in the configuration file" "SECID41"
4959 .cindex "inclusions in configuration file"
4960 .cindex "configuration file" "including other files"
4961 .cindex "&`.include`& in configuration file"
4962 .cindex "&`.include_if_exists`& in configuration file"
4963 You can include other files inside Exim's runtime configuration file by
4964 using this syntax:
4965 .display
4966 &`.include`& <&'filename'&>
4967 &`.include_if_exists`& <&'filename'&>
4968 .endd
4969 on a line by itself. Double quotes round the filename are optional. If you use
4970 the first form, a configuration error occurs if the file does not exist; the
4971 second form does nothing for non-existent files.
4972 The first form allows a relative name. It is resolved relative to
4973 the directory of the including file. For the second form an absolute filename
4974 is required.
4975
4976 Includes may be nested to any depth, but remember that Exim reads its
4977 configuration file often, so it is a good idea to keep them to a minimum.
4978 If you change the contents of an included file, you must HUP the daemon,
4979 because an included file is read only when the configuration itself is read.
4980
4981 The processing of inclusions happens early, at a physical line level, so, like
4982 comment lines, an inclusion can be used in the middle of an option setting,
4983 for example:
4984 .code
4985 hosts_lookup = a.b.c \
4986                .include /some/file
4987 .endd
4988 Include processing happens after macro processing (see below). Its effect is to
4989 process the lines of the included file as if they occurred inline where the
4990 inclusion appears.
4991
4992
4993
4994 .section "Macros in the configuration file" "SECTmacrodefs"
4995 .cindex "macro" "description of"
4996 .cindex "configuration file" "macros"
4997 If a line in the main part of the configuration (that is, before the first
4998 &"begin"& line) begins with an upper case letter, it is taken as a macro
4999 definition, and must be of the form
5000 .display
5001 <&'name'&> = <&'rest of line'&>
5002 .endd
5003 The name must consist of letters, digits, and underscores, and need not all be
5004 in upper case, though that is recommended. The rest of the line, including any
5005 continuations, is the replacement text, and has leading and trailing white
5006 space removed. Quotes are not removed. The replacement text can never end with
5007 a backslash character, but this doesn't seem to be a serious limitation.
5008
5009 Macros may also be defined between router, transport, authenticator, or ACL
5010 definitions. They may not, however, be defined within an individual driver or
5011 ACL, or in the &%local_scan%&, retry, or rewrite sections of the configuration.
5012
5013 .section "Macro substitution" "SECID42"
5014 Once a macro is defined, all subsequent lines in the file (and any included
5015 files) are scanned for the macro name; if there are several macros, the line is
5016 scanned for each, in turn, in the order in which the macros are defined. The
5017 replacement text is not re-scanned for the current macro, though it is scanned
5018 for subsequently defined macros. For this reason, a macro name may not contain
5019 the name of a previously defined macro as a substring. You could, for example,
5020 define
5021 .display
5022 &`ABCD_XYZ = `&<&'something'&>
5023 &`ABCD = `&<&'something else'&>
5024 .endd
5025 but putting the definitions in the opposite order would provoke a configuration
5026 error. Macro expansion is applied to individual physical lines from the file,
5027 before checking for line continuation or file inclusion (see above). If a line
5028 consists solely of a macro name, and the expansion of the macro is empty, the
5029 line is ignored. A macro at the start of a line may turn the line into a
5030 comment line or a &`.include`& line.
5031
5032
5033 .section "Redefining macros" "SECID43"
5034 Once defined, the value of a macro can be redefined later in the configuration
5035 (or in an included file). Redefinition is specified by using &'=='& instead of
5036 &'='&. For example:
5037 .code
5038 MAC =  initial value
5039 ...
5040 MAC == updated value
5041 .endd
5042 Redefinition does not alter the order in which the macros are applied to the
5043 subsequent lines of the configuration file. It is still the same order in which
5044 the macros were originally defined. All that changes is the macro's value.
5045 Redefinition makes it possible to accumulate values. For example:
5046 .code
5047 MAC =  initial value
5048 ...
5049 MAC == MAC and something added
5050 .endd
5051 This can be helpful in situations where the configuration file is built
5052 from a number of other files.
5053
5054 .section "Overriding macro values" "SECID44"
5055 The values set for macros in the configuration file can be overridden by the
5056 &%-D%& command line option, but Exim gives up its root privilege when &%-D%& is
5057 used, unless called by root or the Exim user. A definition on the command line
5058 using the &%-D%& option causes all definitions and redefinitions within the
5059 file to be ignored.
5060
5061
5062
5063 .section "Example of macro usage" "SECID45"
5064 As an example of macro usage, consider a configuration where aliases are looked
5065 up in a MySQL database. It helps to keep the file less cluttered if long
5066 strings such as SQL statements are defined separately as macros, for example:
5067 .code
5068 ALIAS_QUERY = select mailbox from user where \
5069               login='${quote_mysql:$local_part}';
5070 .endd
5071 This can then be used in a &(redirect)& router setting like this:
5072 .code
5073 data = ${lookup mysql{ALIAS_QUERY}}
5074 .endd
5075 In earlier versions of Exim macros were sometimes used for domain, host, or
5076 address lists. In Exim 4 these are handled better by named lists &-- see
5077 section &<<SECTnamedlists>>&.
5078
5079
5080 .section "Builtin macros" "SECTbuiltinmacros"
5081 Exim defines some macros depending on facilities available, which may
5082 differ due to build-time definitions and from one release to another.
5083 All of these macros start with an underscore.
5084 They can be used to conditionally include parts of a configuration
5085 (see below).
5086
5087 The following classes of macros are defined:
5088 .display
5089 &` _HAVE_*                    `&  build-time defines
5090 &` _DRIVER_ROUTER_*           `&  router drivers
5091 &` _DRIVER_TRANSPORT_*        `&  transport drivers
5092 &` _DRIVER_AUTHENTICATOR_*    `&  authenticator drivers
5093 &` _LOG_*                     `&  log_selector values
5094 &` _OPT_MAIN_*                `&  main config options
5095 &` _OPT_ROUTERS_*             `&  generic router options
5096 &` _OPT_TRANSPORTS_*          `&  generic transport options
5097 &` _OPT_AUTHENTICATORS_*      `&  generic authenticator options
5098 &` _OPT_ROUTER_*_*            `&  private router options
5099 &` _OPT_TRANSPORT_*_*         `&  private transport options
5100 &` _OPT_AUTHENTICATOR_*_*     `&  private authenticator options
5101 .endd
5102
5103 Use an &"exim -bP macros"& command to get the list of macros.
5104
5105
5106 .section "Conditional skips in the configuration file" "SECID46"
5107 .cindex "configuration file" "conditional skips"
5108 .cindex "&`.ifdef`&"
5109 You can use the directives &`.ifdef`&, &`.ifndef`&, &`.elifdef`&,
5110 &`.elifndef`&, &`.else`&, and &`.endif`& to dynamically include or exclude
5111 portions of the configuration file. The processing happens whenever the file is
5112 read (that is, when an Exim binary starts to run).
5113
5114 The implementation is very simple. Instances of the first four directives must
5115 be followed by text that includes the names of one or macros. The condition
5116 that is tested is whether or not any macro substitution has taken place in the
5117 line. Thus:
5118 .code
5119 .ifdef AAA
5120 message_size_limit = 50M
5121 .else
5122 message_size_limit = 100M
5123 .endif
5124 .endd
5125 sets a message size limit of 50M if the macro &`AAA`& is defined
5126 (or &`A`& or &`AA`&), and 100M
5127 otherwise. If there is more than one macro named on the line, the condition
5128 is true if any of them are defined. That is, it is an &"or"& condition. To
5129 obtain an &"and"& condition, you need to use nested &`.ifdef`&s.
5130
5131 Although you can use a macro expansion to generate one of these directives,
5132 it is not very useful, because the condition &"there was a macro substitution
5133 in this line"& will always be true.
5134
5135 Text following &`.else`& and &`.endif`& is ignored, and can be used as comment
5136 to clarify complicated nestings.
5137
5138
5139
5140 .section "Common option syntax" "SECTcos"
5141 .cindex "common option syntax"
5142 .cindex "syntax of common options"
5143 .cindex "configuration file" "common option syntax"
5144 For the main set of options, driver options, and &[local_scan()]& options,
5145 each setting is on a line by itself, and starts with a name consisting of
5146 lower-case letters and underscores. Many options require a data value, and in
5147 these cases the name must be followed by an equals sign (with optional white
5148 space) and then the value. For example:
5149 .code
5150 qualify_domain = mydomain.example.com
5151 .endd
5152 .cindex "hiding configuration option values"
5153 .cindex "configuration options" "hiding value of"
5154 .cindex "options" "hiding value of"
5155 Some option settings may contain sensitive data, for example, passwords for
5156 accessing databases. To stop non-admin users from using the &%-bP%& command
5157 line option to read these values, you can precede the option settings with the
5158 word &"hide"&. For example:
5159 .code
5160 hide mysql_servers = localhost/users/admin/secret-password
5161 .endd
5162 For non-admin users, such options are displayed like this:
5163 .code
5164 mysql_servers = <value not displayable>
5165 .endd
5166 If &"hide"& is used on a driver option, it hides the value of that option on
5167 all instances of the same driver.
5168
5169 The following sections describe the syntax used for the different data types
5170 that are found in option settings.
5171
5172
5173 .section "Boolean options" "SECID47"
5174 .cindex "format" "boolean"
5175 .cindex "boolean configuration values"
5176 .oindex "&%no_%&&'xxx'&"
5177 .oindex "&%not_%&&'xxx'&"
5178 Options whose type is given as boolean are on/off switches. There are two
5179 different ways of specifying such options: with and without a data value. If
5180 the option name is specified on its own without data, the switch is turned on;
5181 if it is preceded by &"no_"& or &"not_"& the switch is turned off. However,
5182 boolean options may be followed by an equals sign and one of the words
5183 &"true"&, &"false"&, &"yes"&, or &"no"&, as an alternative syntax. For example,
5184 the following two settings have exactly the same effect:
5185 .code
5186 queue_only
5187 queue_only = true
5188 .endd
5189 The following two lines also have the same (opposite) effect:
5190 .code
5191 no_queue_only
5192 queue_only = false
5193 .endd
5194 You can use whichever syntax you prefer.
5195
5196
5197
5198
5199 .section "Integer values" "SECID48"
5200 .cindex "integer configuration values"
5201 .cindex "format" "integer"
5202 If an option's type is given as &"integer"&, the value can be given in decimal,
5203 hexadecimal, or octal. If it starts with a digit greater than zero, a decimal
5204 number is assumed. Otherwise, it is treated as an octal number unless it starts
5205 with the characters &"0x"&, in which case the remainder is interpreted as a
5206 hexadecimal number.
5207
5208 If an integer value is followed by the letter K, it is multiplied by 1024; if
5209 it is followed by the letter M, it is multiplied by 1024x1024;
5210 if by the letter G, 1024x1024x1024.
5211 When the values
5212 of integer option settings are output, values which are an exact multiple of
5213 1024 or 1024x1024 are sometimes, but not always, printed using the letters K
5214 and M. The printing style is independent of the actual input format that was
5215 used.
5216
5217
5218 .section "Octal integer values" "SECID49"
5219 .cindex "integer format"
5220 .cindex "format" "octal integer"
5221 If an option's type is given as &"octal integer"&, its value is always
5222 interpreted as an octal number, whether or not it starts with the digit zero.
5223 Such options are always output in octal.
5224
5225
5226 .section "Fixed point numbers" "SECID50"
5227 .cindex "fixed point configuration values"
5228 .cindex "format" "fixed point"
5229 If an option's type is given as &"fixed-point"&, its value must be a decimal
5230 integer, optionally followed by a decimal point and up to three further digits.
5231
5232
5233
5234 .section "Time intervals" "SECTtimeformat"
5235 .cindex "time interval" "specifying in configuration"
5236 .cindex "format" "time interval"
5237 A time interval is specified as a sequence of numbers, each followed by one of
5238 the following letters, with no intervening white space:
5239
5240 .table2 30pt
5241 .irow &%s%& seconds
5242 .irow &%m%& minutes
5243 .irow &%h%& hours
5244 .irow &%d%& days
5245 .irow &%w%& weeks
5246 .endtable
5247
5248 For example, &"3h50m"& specifies 3 hours and 50 minutes. The values of time
5249 intervals are output in the same format. Exim does not restrict the values; it
5250 is perfectly acceptable, for example, to specify &"90m"& instead of &"1h30m"&.
5251
5252
5253
5254 .section "String values" "SECTstrings"
5255 .cindex "string" "format of configuration values"
5256 .cindex "format" "string"
5257 If an option's type is specified as &"string"&, the value can be specified with
5258 or without double-quotes. If it does not start with a double-quote, the value
5259 consists of the remainder of the line plus any continuation lines, starting at
5260 the first character after any leading white space, with trailing white space
5261 removed, and with no interpretation of the characters in the string. Because
5262 Exim removes comment lines (those beginning with #) at an early stage, they can
5263 appear in the middle of a multi-line string. The following two settings are
5264 therefore equivalent:
5265 .code
5266 trusted_users = uucp:mail
5267 trusted_users = uucp:\
5268                 # This comment line is ignored
5269                 mail
5270 .endd
5271 .cindex "string" "quoted"
5272 .cindex "escape characters in quoted strings"
5273 If a string does start with a double-quote, it must end with a closing
5274 double-quote, and any backslash characters other than those used for line
5275 continuation are interpreted as escape characters, as follows:
5276
5277 .table2 100pt
5278 .irow &`\\`&                     "single backslash"
5279 .irow &`\n`&                     "newline"
5280 .irow &`\r`&                     "carriage return"
5281 .irow &`\t`&                     "tab"
5282 .irow "&`\`&<&'octal digits'&>"  "up to 3 octal digits specify one character"
5283 .irow "&`\x`&<&'hex digits'&>"   "up to 2 hexadecimal digits specify one &&&
5284                                    character"
5285 .endtable
5286
5287 If a backslash is followed by some other character, including a double-quote
5288 character, that character replaces the pair.
5289
5290 Quoting is necessary only if you want to make use of the backslash escapes to
5291 insert special characters, or if you need to specify a value with leading or
5292 trailing spaces. These cases are rare, so quoting is almost never needed in
5293 current versions of Exim. In versions of Exim before 3.14, quoting was required
5294 in order to continue lines, so you may come across older configuration files
5295 and examples that apparently quote unnecessarily.
5296
5297
5298 .section "Expanded strings" "SECID51"
5299 .cindex "expansion" "definition of"
5300 Some strings in the configuration file are subjected to &'string expansion'&,
5301 by which means various parts of the string may be changed according to the
5302 circumstances (see chapter &<<CHAPexpand>>&). The input syntax for such strings
5303 is as just described; in particular, the handling of backslashes in quoted
5304 strings is done as part of the input process, before expansion takes place.
5305 However, backslash is also an escape character for the expander, so any
5306 backslashes that are required for that reason must be doubled if they are
5307 within a quoted configuration string.
5308
5309
5310 .section "User and group names" "SECID52"
5311 .cindex "user name" "format of"
5312 .cindex "format" "user name"
5313 .cindex "groups" "name format"
5314 .cindex "format" "group name"
5315 User and group names are specified as strings, using the syntax described
5316 above, but the strings are interpreted specially. A user or group name must
5317 either consist entirely of digits, or be a name that can be looked up using the
5318 &[getpwnam()]& or &[getgrnam()]& function, as appropriate.
5319
5320
5321 .section "List construction" "SECTlistconstruct"
5322 .cindex "list" "syntax of in configuration"
5323 .cindex "format" "list item in configuration"
5324 .cindex "string" "list, definition of"
5325 The data for some configuration options is a list of items, with colon as the
5326 default separator. Many of these options are shown with type &"string list"& in
5327 the descriptions later in this document. Others are listed as &"domain list"&,
5328 &"host list"&, &"address list"&, or &"local part list"&. Syntactically, they
5329 are all the same; however, those other than &"string list"& are subject to
5330 particular kinds of interpretation, as described in chapter
5331 &<<CHAPdomhosaddlists>>&.
5332
5333 In all these cases, the entire list is treated as a single string as far as the
5334 input syntax is concerned. The &%trusted_users%& setting in section
5335 &<<SECTstrings>>& above is an example. If a colon is actually needed in an item
5336 in a list, it must be entered as two colons. Leading and trailing white space
5337 on each item in a list is ignored. This makes it possible to include items that
5338 start with a colon, and in particular, certain forms of IPv6 address. For
5339 example, the list
5340 .code
5341 local_interfaces = 127.0.0.1 : ::::1
5342 .endd
5343 contains two IP addresses, the IPv4 address 127.0.0.1 and the IPv6 address ::1.
5344
5345 &*Note*&: Although leading and trailing white space is ignored in individual
5346 list items, it is not ignored when parsing the list. The space after the first
5347 colon in the example above is necessary. If it were not there, the list would
5348 be interpreted as the two items 127.0.0.1:: and 1.
5349
5350 .section "Changing list separators" "SECTlistsepchange"
5351 .cindex "list separator" "changing"
5352 .cindex "IPv6" "addresses in lists"
5353 Doubling colons in IPv6 addresses is an unwelcome chore, so a mechanism was
5354 introduced to allow the separator character to be changed. If a list begins
5355 with a left angle bracket, followed by any punctuation character, that
5356 character is used instead of colon as the list separator. For example, the list
5357 above can be rewritten to use a semicolon separator like this:
5358 .code
5359 local_interfaces = <; 127.0.0.1 ; ::1
5360 .endd
5361 This facility applies to all lists, with the exception of the list in
5362 &%log_file_path%&. It is recommended that the use of non-colon separators be
5363 confined to circumstances where they really are needed.
5364
5365 .cindex "list separator" "newline as"
5366 .cindex "newline" "as list separator"
5367 It is also possible to use newline and other control characters (those with
5368 code values less than 32, plus DEL) as separators in lists. Such separators
5369 must be provided literally at the time the list is processed. For options that
5370 are string-expanded, you can write the separator using a normal escape
5371 sequence. This will be processed by the expander before the string is
5372 interpreted as a list. For example, if a newline-separated list of domains is
5373 generated by a lookup, you can process it directly by a line such as this:
5374 .code
5375 domains = <\n ${lookup mysql{.....}}
5376 .endd
5377 This avoids having to change the list separator in such data. You are unlikely
5378 to want to use a control character as a separator in an option that is not
5379 expanded, because the value is literal text. However, it can be done by giving
5380 the value in quotes. For example:
5381 .code
5382 local_interfaces = "<\n 127.0.0.1 \n ::1"
5383 .endd
5384 Unlike printing character separators, which can be included in list items by
5385 doubling, it is not possible to include a control character as data when it is
5386 set as the separator. Two such characters in succession are interpreted as
5387 enclosing an empty list item.
5388
5389
5390
5391 .section "Empty items in lists" "SECTempitelis"
5392 .cindex "list" "empty item in"
5393 An empty item at the end of a list is always ignored. In other words, trailing
5394 separator characters are ignored. Thus, the list in
5395 .code
5396 senders = user@domain :
5397 .endd
5398 contains only a single item. If you want to include an empty string as one item
5399 in a list, it must not be the last item. For example, this list contains three
5400 items, the second of which is empty:
5401 .code
5402 senders = user1@domain : : user2@domain
5403 .endd
5404 &*Note*&: There must be white space between the two colons, as otherwise they
5405 are interpreted as representing a single colon data character (and the list
5406 would then contain just one item). If you want to specify a list that contains
5407 just one, empty item, you can do it as in this example:
5408 .code
5409 senders = :
5410 .endd
5411 In this case, the first item is empty, and the second is discarded because it
5412 is at the end of the list.
5413
5414
5415
5416
5417 .section "Format of driver configurations" "SECTfordricon"
5418 .cindex "drivers" "configuration format"
5419 There are separate parts in the configuration for defining routers, transports,
5420 and authenticators. In each part, you are defining a number of driver
5421 instances, each with its own set of options. Each driver instance is defined by
5422 a sequence of lines like this:
5423 .display
5424 <&'instance name'&>:
5425   <&'option'&>
5426   ...
5427   <&'option'&>
5428 .endd
5429 In the following example, the instance name is &(localuser)&, and it is
5430 followed by three options settings:
5431 .code
5432 localuser:
5433   driver = accept
5434   check_local_user
5435   transport = local_delivery
5436 .endd
5437 For each driver instance, you specify which Exim code module it uses &-- by the
5438 setting of the &%driver%& option &-- and (optionally) some configuration
5439 settings. For example, in the case of transports, if you want a transport to
5440 deliver with SMTP you would use the &(smtp)& driver; if you want to deliver to
5441 a local file you would use the &(appendfile)& driver. Each of the drivers is
5442 described in detail in its own separate chapter later in this manual.
5443
5444 You can have several routers, transports, or authenticators that are based on
5445 the same underlying driver (each must have a different instance name).
5446
5447 The order in which routers are defined is important, because addresses are
5448 passed to individual routers one by one, in order. The order in which
5449 transports are defined does not matter at all. The order in which
5450 authenticators are defined is used only when Exim, as a client, is searching
5451 them to find one that matches an authentication mechanism offered by the
5452 server.
5453
5454 .cindex "generic options"
5455 .cindex "options" "generic &-- definition of"
5456 Within a driver instance definition, there are two kinds of option: &'generic'&
5457 and &'private'&. The generic options are those that apply to all drivers of the
5458 same type (that is, all routers, all transports or all authenticators). The
5459 &%driver%& option is a generic option that must appear in every definition.
5460 .cindex "private options"
5461 The private options are special for each driver, and none need appear, because
5462 they all have default values.
5463
5464 The options may appear in any order, except that the &%driver%& option must
5465 precede any private options, since these depend on the particular driver. For
5466 this reason, it is recommended that &%driver%& always be the first option.
5467
5468 Driver instance names, which are used for reference in log entries and
5469 elsewhere, can be any sequence of letters, digits, and underscores (starting
5470 with a letter) and must be unique among drivers of the same type. A router and
5471 a transport (for example) can each have the same name, but no two router
5472 instances can have the same name. The name of a driver instance should not be
5473 confused with the name of the underlying driver module. For example, the
5474 configuration lines:
5475 .code
5476 remote_smtp:
5477   driver = smtp
5478 .endd
5479 create an instance of the &(smtp)& transport driver whose name is
5480 &(remote_smtp)&. The same driver code can be used more than once, with
5481 different instance names and different option settings each time. A second
5482 instance of the &(smtp)& transport, with different options, might be defined
5483 thus:
5484 .code
5485 special_smtp:
5486   driver = smtp
5487   port = 1234
5488   command_timeout = 10s
5489 .endd
5490 The names &(remote_smtp)& and &(special_smtp)& would be used to reference
5491 these transport instances from routers, and these names would appear in log
5492 lines.
5493
5494 Comment lines may be present in the middle of driver specifications. The full
5495 list of option settings for any particular driver instance, including all the
5496 defaulted values, can be extracted by making use of the &%-bP%& command line
5497 option.
5498
5499
5500
5501
5502
5503
5504 . ////////////////////////////////////////////////////////////////////////////
5505 . ////////////////////////////////////////////////////////////////////////////
5506
5507 .chapter "The default configuration file" "CHAPdefconfil"
5508 .scindex IIDconfiwal "configuration file" "default &""walk through""&"
5509 .cindex "default" "configuration file &""walk through""&"
5510 The default configuration file supplied with Exim as &_src/configure.default_&
5511 is sufficient for a host with simple mail requirements. As an introduction to
5512 the way Exim is configured, this chapter &"walks through"& the default
5513 configuration, giving brief explanations of the settings. Detailed descriptions
5514 of the options are given in subsequent chapters. The default configuration file
5515 itself contains extensive comments about ways you might want to modify the
5516 initial settings. However, note that there are many options that are not
5517 mentioned at all in the default configuration.
5518
5519
5520
5521 .section "Macros" "SECTdefconfmacros"
5522 All macros should be defined before any options.
5523
5524 One macro is specified, but commented out, in the default configuration:
5525 .code
5526 # ROUTER_SMARTHOST=MAIL.HOSTNAME.FOR.CENTRAL.SERVER.EXAMPLE
5527 .endd
5528 If all off-site mail is expected to be delivered to a "smarthost", then set the
5529 hostname here and uncomment the macro.  This will affect which router is used
5530 later on.  If this is left commented out, then Exim will perform direct-to-MX
5531 deliveries using a &(dnslookup)& router.
5532
5533 In addition to macros defined here, Exim includes a number of built-in macros
5534 to enable configuration to be guarded by a binary built with support for a
5535 given feature.  See section &<<SECTbuiltinmacros>>& for more details.
5536
5537
5538 .section "Main configuration settings" "SECTdefconfmain"
5539 The main (global) configuration option settings section must always come first
5540 in the file, after the macros.
5541 The first thing you'll see in the file, after some initial comments, is the line
5542 .code
5543 # primary_hostname =
5544 .endd
5545 This is a commented-out setting of the &%primary_hostname%& option. Exim needs
5546 to know the official, fully qualified name of your host, and this is where you
5547 can specify it. However, in most cases you do not need to set this option. When
5548 it is unset, Exim uses the &[uname()]& system function to obtain the host name.
5549
5550 The first three non-comment configuration lines are as follows:
5551 .code
5552 domainlist local_domains    = @
5553 domainlist relay_to_domains =
5554 hostlist   relay_from_hosts = 127.0.0.1
5555 .endd
5556 These are not, in fact, option settings. They are definitions of two named
5557 domain lists and one named host list. Exim allows you to give names to lists of
5558 domains, hosts, and email addresses, in order to make it easier to manage the
5559 configuration file (see section &<<SECTnamedlists>>&).
5560
5561 The first line defines a domain list called &'local_domains'&; this is used
5562 later in the configuration to identify domains that are to be delivered
5563 on the local host.
5564
5565 .cindex "@ in a domain list"
5566 There is just one item in this list, the string &"@"&. This is a special form
5567 of entry which means &"the name of the local host"&. Thus, if the local host is
5568 called &'a.host.example'&, mail to &'any.user@a.host.example'& is expected to
5569 be delivered locally. Because the local host's name is referenced indirectly,
5570 the same configuration file can be used on different hosts.
5571
5572 The second line defines a domain list called &'relay_to_domains'&, but the
5573 list itself is empty. Later in the configuration we will come to the part that
5574 controls mail relaying through the local host; it allows relaying to any
5575 domains in this list. By default, therefore, no relaying on the basis of a mail
5576 domain is permitted.
5577
5578 The third line defines a host list called &'relay_from_hosts'&. This list is
5579 used later in the configuration to permit relaying from any host or IP address
5580 that matches the list. The default contains just the IP address of the IPv4
5581 loopback interface, which means that processes on the local host are able to
5582 submit mail for relaying by sending it over TCP/IP to that interface. No other
5583 hosts are permitted to submit messages for relaying.
5584
5585 Just to be sure there's no misunderstanding: at this point in the configuration
5586 we aren't actually setting up any controls. We are just defining some domains
5587 and hosts that will be used in the controls that are specified later.
5588
5589 The next two configuration lines are genuine option settings:
5590 .code
5591 acl_smtp_rcpt = acl_check_rcpt
5592 acl_smtp_data = acl_check_data
5593 .endd
5594 These options specify &'Access Control Lists'& (ACLs) that are to be used
5595 during an incoming SMTP session for every recipient of a message (every RCPT
5596 command), and after the contents of the message have been received,
5597 respectively. The names of the lists are &'acl_check_rcpt'& and
5598 &'acl_check_data'&, and we will come to their definitions below, in the ACL
5599 section of the configuration. The RCPT ACL controls which recipients are
5600 accepted for an incoming message &-- if a configuration does not provide an ACL
5601 to check recipients, no SMTP mail can be accepted. The DATA ACL allows the
5602 contents of a message to be checked.
5603
5604 Two commented-out option settings are next:
5605 .code
5606 # av_scanner = clamd:/tmp/clamd
5607 # spamd_address = 127.0.0.1 783
5608 .endd
5609 These are example settings that can be used when Exim is compiled with the
5610 content-scanning extension. The first specifies the interface to the virus
5611 scanner, and the second specifies the interface to SpamAssassin. Further
5612 details are given in chapter &<<CHAPexiscan>>&.
5613
5614 Three more commented-out option settings follow:
5615 .code
5616 # tls_advertise_hosts = *
5617 # tls_certificate = /etc/ssl/exim.crt
5618 # tls_privatekey = /etc/ssl/exim.pem
5619 .endd
5620 These are example settings that can be used when Exim is compiled with
5621 support for TLS (aka SSL) as described in section &<<SECTinctlsssl>>&. The
5622 first one specifies the list of clients that are allowed to use TLS when
5623 connecting to this server; in this case, the wildcard means all clients. The
5624 other options specify where Exim should find its TLS certificate and private
5625 key, which together prove the server's identity to any clients that connect.
5626 More details are given in chapter &<<CHAPTLS>>&.
5627
5628 Another two commented-out option settings follow:
5629 .code
5630 # daemon_smtp_ports = 25 : 465 : 587
5631 # tls_on_connect_ports = 465
5632 .endd
5633 .cindex "port" "465 and 587"
5634 .cindex "port" "for message submission"
5635 .cindex "message" "submission, ports for"
5636 .cindex "submissions protocol"
5637 .cindex "smtps protocol"
5638 .cindex "ssmtp protocol"
5639 .cindex "SMTP" "submissions protocol"
5640 .cindex "SMTP" "ssmtp protocol"
5641 .cindex "SMTP" "smtps protocol"
5642 These options provide better support for roaming users who wish to use this
5643 server for message submission. They are not much use unless you have turned on
5644 TLS (as described in the previous paragraph) and authentication (about which
5645 more in section &<<SECTdefconfauth>>&).
5646 Mail submission from mail clients (MUAs) should be separate from inbound mail
5647 to your domain (MX delivery) for various good reasons (eg, ability to impose
5648 much saner TLS protocol and ciphersuite requirements without unintended
5649 consequences).
5650 RFC 6409 (previously 4409) specifies use of port 587 for SMTP Submission,
5651 which uses STARTTLS, so this is the &"submission"& port.
5652 RFC 8314 specifies use of port 465 as the &"submissions"& protocol,
5653 which should be used in preference to 587.
5654 You should also consider deploying SRV records to help clients find
5655 these ports.
5656 Older names for &"submissions"& are &"smtps"& and &"ssmtp"&.
5657
5658 Two more commented-out options settings follow:
5659 .code
5660 # qualify_domain =
5661 # qualify_recipient =
5662 .endd
5663 The first of these specifies a domain that Exim uses when it constructs a
5664 complete email address from a local login name. This is often needed when Exim
5665 receives a message from a local process. If you do not set &%qualify_domain%&,
5666 the value of &%primary_hostname%& is used. If you set both of these options,
5667 you can have different qualification domains for sender and recipient
5668 addresses. If you set only the first one, its value is used in both cases.
5669
5670 .cindex "domain literal" "recognizing format"
5671 The following line must be uncommented if you want Exim to recognize
5672 addresses of the form &'user@[10.11.12.13]'& that is, with a &"domain literal"&
5673 (an IP address within square brackets) instead of a named domain.
5674 .code
5675 # allow_domain_literals
5676 .endd
5677 The RFCs still require this form, but many people think that in the modern
5678 Internet it makes little sense to permit mail to be sent to specific hosts by
5679 quoting their IP addresses. This ancient format has been used by people who
5680 try to abuse hosts by using them for unwanted relaying. However, some
5681 people believe there are circumstances (for example, messages addressed to
5682 &'postmaster'&) where domain literals are still useful.
5683
5684 The next configuration line is a kind of trigger guard:
5685 .code
5686 never_users = root
5687 .endd
5688 It specifies that no delivery must ever be run as the root user. The normal
5689 convention is to set up &'root'& as an alias for the system administrator. This
5690 setting is a guard against slips in the configuration.
5691 The list of users specified by &%never_users%& is not, however, the complete
5692 list; the build-time configuration in &_Local/Makefile_& has an option called
5693 FIXED_NEVER_USERS specifying a list that cannot be overridden. The
5694 contents of &%never_users%& are added to this list. By default
5695 FIXED_NEVER_USERS also specifies root.
5696
5697 When a remote host connects to Exim in order to send mail, the only information
5698 Exim has about the host's identity is its IP address. The next configuration
5699 line,
5700 .code
5701 host_lookup = *
5702 .endd
5703 specifies that Exim should do a reverse DNS lookup on all incoming connections,
5704 in order to get a host name. This improves the quality of the logging
5705 information, but if you feel it is too expensive, you can remove it entirely,
5706 or restrict the lookup to hosts on &"nearby"& networks.
5707 Note that it is not always possible to find a host name from an IP address,
5708 because not all DNS reverse zones are maintained, and sometimes DNS servers are
5709 unreachable.
5710
5711 The next two lines are concerned with &'ident'& callbacks, as defined by RFC
5712 1413 (hence their names):
5713 .code
5714 rfc1413_hosts = *
5715 rfc1413_query_timeout = 0s
5716 .endd
5717 These settings cause Exim to avoid ident callbacks for all incoming SMTP calls.
5718 Few hosts offer RFC1413 service these days; calls have to be
5719 terminated by a timeout and this needlessly delays the startup
5720 of an incoming SMTP connection.
5721 If you have hosts for which you trust RFC1413 and need this
5722 information, you can change this.
5723
5724 This line enables an efficiency SMTP option.  It is negotiated by clients
5725 and not expected to cause problems but can be disabled if needed.
5726 .code
5727 prdr_enable = true
5728 .endd
5729
5730 When Exim receives messages over SMTP connections, it expects all addresses to
5731 be fully qualified with a domain, as required by the SMTP definition. However,
5732 if you are running a server to which simple clients submit messages, you may
5733 find that they send unqualified addresses. The two commented-out options:
5734 .code
5735 # sender_unqualified_hosts =
5736 # recipient_unqualified_hosts =
5737 .endd
5738 show how you can specify hosts that are permitted to send unqualified sender
5739 and recipient addresses, respectively.
5740
5741 The &%log_selector%& option is used to increase the detail of logging
5742 over the default:
5743 .code
5744 log_selector = +smtp_protocol_error +smtp_syntax_error \
5745                +tls_certificate_verified
5746 .endd
5747
5748 The &%percent_hack_domains%& option is also commented out:
5749 .code
5750 # percent_hack_domains =
5751 .endd
5752 It provides a list of domains for which the &"percent hack"& is to operate.
5753 This is an almost obsolete form of explicit email routing. If you do not know
5754 anything about it, you can safely ignore this topic.
5755
5756 The next two settings in the main part of the default configuration are
5757 concerned with messages that have been &"frozen"& on Exim's queue. When a
5758 message is frozen, Exim no longer continues to try to deliver it. Freezing
5759 occurs when a bounce message encounters a permanent failure because the sender
5760 address of the original message that caused the bounce is invalid, so the
5761 bounce cannot be delivered. This is probably the most common case, but there
5762 are also other conditions that cause freezing, and frozen messages are not
5763 always bounce messages.
5764 .code
5765 ignore_bounce_errors_after = 2d
5766 timeout_frozen_after = 7d
5767 .endd
5768 The first of these options specifies that failing bounce messages are to be
5769 discarded after 2 days in the queue. The second specifies that any frozen
5770 message (whether a bounce message or not) is to be timed out (and discarded)
5771 after a week. In this configuration, the first setting ensures that no failing
5772 bounce message ever lasts a week.
5773
5774 Exim queues it's messages in a spool directory. If you expect to have
5775 large queues, you may consider using this option. It splits the spool
5776 directory into subdirectories to avoid file system degradation from
5777 many files in a single directory, resulting in better performance.
5778 Manual manipulation of queued messages becomes more complex (though fortunately
5779 not often needed).
5780 .code
5781 # split_spool_directory = true
5782 .endd
5783
5784 In an ideal world everybody follows the standards. For non-ASCII
5785 messages RFC 2047 is a standard, allowing a maximum line length of 76
5786 characters. Exim adheres that standard and won't process messages which
5787 violate this standard. (Even ${rfc2047:...} expansions will fail.)
5788 In particular, the Exim maintainers have had multiple reports of
5789 problems from Russian administrators of issues until they disable this
5790 check, because of some popular, yet buggy, mail composition software.
5791 .code
5792 # check_rfc2047_length = false
5793 .endd
5794
5795 If you need to be strictly RFC compliant you may wish to disable the
5796 8BITMIME advertisement. Use this, if you exchange mails with systems
5797 that are not 8-bit clean.
5798 .code
5799 # accept_8bitmime = false
5800 .endd
5801
5802 Libraries you use may depend on specific environment settings.  This
5803 imposes a security risk (e.g. PATH). There are two lists:
5804 &%keep_environment%& for the variables to import as they are, and
5805 &%add_environment%& for variables we want to set to a fixed value.
5806 Note that TZ is handled separately, by the $%timezone%$ runtime
5807 option and by the TIMEZONE_DEFAULT buildtime option.
5808 .code
5809 # keep_environment = ^LDAP
5810 # add_environment = PATH=/usr/bin::/bin
5811 .endd
5812
5813
5814 .section "ACL configuration" "SECID54"
5815 .cindex "default" "ACLs"
5816 .cindex "&ACL;" "default configuration"
5817 In the default configuration, the ACL section follows the main configuration.
5818 It starts with the line
5819 .code
5820 begin acl
5821 .endd
5822 and it contains the definitions of two ACLs, called &'acl_check_rcpt'& and
5823 &'acl_check_data'&, that were referenced in the settings of &%acl_smtp_rcpt%&
5824 and &%acl_smtp_data%& above.
5825
5826 .cindex "RCPT" "ACL for"
5827 The first ACL is used for every RCPT command in an incoming SMTP message. Each
5828 RCPT command specifies one of the message's recipients. The ACL statements
5829 are considered in order, until the recipient address is either accepted or
5830 rejected. The RCPT command is then accepted or rejected, according to the
5831 result of the ACL processing.
5832 .code
5833 acl_check_rcpt:
5834 .endd
5835 This line, consisting of a name terminated by a colon, marks the start of the
5836 ACL, and names it.
5837 .code
5838 accept  hosts = :
5839 .endd
5840 This ACL statement accepts the recipient if the sending host matches the list.
5841 But what does that strange list mean? It doesn't actually contain any host
5842 names or IP addresses. The presence of the colon puts an empty item in the
5843 list; Exim matches this only if the incoming message did not come from a remote
5844 host, because in that case, the remote hostname is empty. The colon is
5845 important. Without it, the list itself is empty, and can never match anything.
5846
5847 What this statement is doing is to accept unconditionally all recipients in
5848 messages that are submitted by SMTP from local processes using the standard
5849 input and output (that is, not using TCP/IP). A number of MUAs operate in this
5850 manner.
5851 .code
5852 deny    message       = Restricted characters in address
5853         domains       = +local_domains
5854         local_parts   = ^[.] : ^.*[@%!/|]
5855
5856 deny    message       = Restricted characters in address
5857         domains       = !+local_domains
5858         local_parts   = ^[./|] : ^.*[@%!] : ^.*/\\.\\./
5859 .endd
5860 These statements are concerned with local parts that contain any of the
5861 characters &"@"&, &"%"&, &"!"&, &"/"&, &"|"&, or dots in unusual places.
5862 Although these characters are entirely legal in local parts (in the case of
5863 &"@"& and leading dots, only if correctly quoted), they do not commonly occur
5864 in Internet mail addresses.
5865
5866 The first three have in the past been associated with explicitly routed
5867 addresses (percent is still sometimes used &-- see the &%percent_hack_domains%&
5868 option). Addresses containing these characters are regularly tried by spammers
5869 in an attempt to bypass relaying restrictions, and also by open relay testing
5870 programs. Unless you really need them it is safest to reject these characters
5871 at this early stage. This configuration is heavy-handed in rejecting these
5872 characters for all messages it accepts from remote hosts. This is a deliberate
5873 policy of being as safe as possible.
5874
5875 The first rule above is stricter, and is applied to messages that are addressed
5876 to one of the local domains handled by this host. This is implemented by the
5877 first condition, which restricts it to domains that are listed in the
5878 &'local_domains'& domain list. The &"+"& character is used to indicate a
5879 reference to a named list. In this configuration, there is just one domain in
5880 &'local_domains'&, but in general there may be many.
5881
5882 The second condition on the first statement uses two regular expressions to
5883 block local parts that begin with a dot or contain &"@"&, &"%"&, &"!"&, &"/"&,
5884 or &"|"&. If you have local accounts that include these characters, you will
5885 have to modify this rule.
5886
5887 Empty components (two dots in a row) are not valid in RFC 2822, but Exim
5888 allows them because they have been encountered in practice. (Consider the
5889 common convention of local parts constructed as
5890 &"&'first-initial.second-initial.family-name'&"& when applied to someone like
5891 the author of Exim, who has no second initial.) However, a local part starting
5892 with a dot or containing &"/../"& can cause trouble if it is used as part of a
5893 filename (for example, for a mailing list). This is also true for local parts
5894 that contain slashes. A pipe symbol can also be troublesome if the local part
5895 is incorporated unthinkingly into a shell command line.
5896
5897 The second rule above applies to all other domains, and is less strict. This
5898 allows your own users to send outgoing messages to sites that use slashes
5899 and vertical bars in their local parts. It blocks local parts that begin
5900 with a dot, slash, or vertical bar, but allows these characters within the
5901 local part. However, the sequence &"/../"& is barred. The use of &"@"&, &"%"&,
5902 and &"!"& is blocked, as before. The motivation here is to prevent your users
5903 (or your users' viruses) from mounting certain kinds of attack on remote sites.
5904 .code
5905 accept  local_parts   = postmaster
5906         domains       = +local_domains
5907 .endd
5908 This statement, which has two conditions, accepts an incoming address if the
5909 local part is &'postmaster'& and the domain is one of those listed in the
5910 &'local_domains'& domain list. The &"+"& character is used to indicate a
5911 reference to a named list. In this configuration, there is just one domain in
5912 &'local_domains'&, but in general there may be many.
5913
5914 The presence of this statement means that mail to postmaster is never blocked
5915 by any of the subsequent tests. This can be helpful while sorting out problems
5916 in cases where the subsequent tests are incorrectly denying access.
5917 .code
5918 require verify        = sender
5919 .endd
5920 This statement requires the sender address to be verified before any subsequent
5921 ACL statement can be used. If verification fails, the incoming recipient
5922 address is refused. Verification consists of trying to route the address, to
5923 see if a bounce message could be delivered to it. In the case of remote
5924 addresses, basic verification checks only the domain, but &'callouts'& can be
5925 used for more verification if required. Section &<<SECTaddressverification>>&
5926 discusses the details of address verification.
5927 .code
5928 accept  hosts         = +relay_from_hosts
5929         control       = submission
5930 .endd
5931 This statement accepts the address if the message is coming from one of the
5932 hosts that are defined as being allowed to relay through this host. Recipient
5933 verification is omitted here, because in many cases the clients are dumb MUAs
5934 that do not cope well with SMTP error responses. For the same reason, the
5935 second line specifies &"submission mode"& for messages that are accepted. This
5936 is described in detail in section &<<SECTsubmodnon>>&; it causes Exim to fix
5937 messages that are deficient in some way, for example, because they lack a
5938 &'Date:'& header line. If you are actually relaying out from MTAs, you should
5939 probably add recipient verification here, and disable submission mode.
5940 .code
5941 accept  authenticated = *
5942         control       = submission
5943 .endd
5944 This statement accepts the address if the client host has authenticated itself.
5945 Submission mode is again specified, on the grounds that such messages are most
5946 likely to come from MUAs. The default configuration does not define any
5947 authenticators, though it does include some nearly complete commented-out
5948 examples described in &<<SECTdefconfauth>>&. This means that no client can in
5949 fact authenticate until you complete the authenticator definitions.
5950 .code
5951 require message = relay not permitted
5952         domains = +local_domains : +relay_to_domains
5953 .endd
5954 This statement rejects the address if its domain is neither a local domain nor
5955 one of the domains for which this host is a relay.
5956 .code
5957 require verify = recipient
5958 .endd
5959 This statement requires the recipient address to be verified; if verification
5960 fails, the address is rejected.
5961 .code
5962 # deny    message     = rejected because $sender_host_address \
5963 #                       is in a black list at $dnslist_domain\n\
5964 #                       $dnslist_text
5965 #         dnslists    = black.list.example
5966 #
5967 # warn    dnslists    = black.list.example
5968 #         add_header  = X-Warning: $sender_host_address is in \
5969 #                       a black list at $dnslist_domain
5970 #         log_message = found in $dnslist_domain
5971 .endd
5972 These commented-out lines are examples of how you could configure Exim to check
5973 sending hosts against a DNS black list. The first statement rejects messages
5974 from blacklisted hosts, whereas the second just inserts a warning header
5975 line.
5976 .code
5977 # require verify = csa
5978 .endd
5979 This commented-out line is an example of how you could turn on client SMTP
5980 authorization (CSA) checking. Such checks do DNS lookups for special SRV
5981 records.
5982 .code
5983 accept
5984 .endd
5985 The final statement in the first ACL unconditionally accepts any recipient
5986 address that has successfully passed all the previous tests.
5987 .code
5988 acl_check_data:
5989 .endd
5990 This line marks the start of the second ACL, and names it. Most of the contents
5991 of this ACL are commented out:
5992 .code
5993 # deny    malware   = *
5994 #         message   = This message contains a virus \
5995 #                     ($malware_name).
5996 .endd
5997 These lines are examples of how to arrange for messages to be scanned for
5998 viruses when Exim has been compiled with the content-scanning extension, and a
5999 suitable virus scanner is installed. If the message is found to contain a
6000 virus, it is rejected with the given custom error message.
6001 .code
6002 # warn    spam      = nobody
6003 #         message   = X-Spam_score: $spam_score\n\
6004 #                     X-Spam_score_int: $spam_score_int\n\
6005 #                     X-Spam_bar: $spam_bar\n\
6006 #                     X-Spam_report: $spam_report
6007 .endd
6008 These lines are an example of how to arrange for messages to be scanned by
6009 SpamAssassin when Exim has been compiled with the content-scanning extension,
6010 and SpamAssassin has been installed. The SpamAssassin check is run with
6011 &`nobody`& as its user parameter, and the results are added to the message as a
6012 series of extra header line. In this case, the message is not rejected,
6013 whatever the spam score.
6014 .code
6015 accept
6016 .endd
6017 This final line in the DATA ACL accepts the message unconditionally.
6018
6019
6020 .section "Router configuration" "SECID55"
6021 .cindex "default" "routers"
6022 .cindex "routers" "default"
6023 The router configuration comes next in the default configuration, introduced
6024 by the line
6025 .code
6026 begin routers
6027 .endd
6028 Routers are the modules in Exim that make decisions about where to send
6029 messages. An address is passed to each router, in turn, until it is either
6030 accepted, or failed. This means that the order in which you define the routers
6031 matters. Each router is fully described in its own chapter later in this
6032 manual. Here we give only brief overviews.
6033 .code
6034 # domain_literal:
6035 #   driver = ipliteral
6036 #   domains = !+local_domains
6037 #   transport = remote_smtp
6038 .endd
6039 .cindex "domain literal" "default router"
6040 This router is commented out because the majority of sites do not want to
6041 support domain literal addresses (those of the form &'user@[10.9.8.7]'&). If
6042 you uncomment this router, you also need to uncomment the setting of
6043 &%allow_domain_literals%& in the main part of the configuration.
6044
6045 Which router is used next depends upon whether or not the ROUTER_SMARTHOST
6046 macro has been defined, per
6047 .code
6048 .ifdef ROUTER_SMARTHOST
6049 smarthost:
6050 #...
6051 .else
6052 dnslookup:
6053 #...
6054 .endif
6055 .endd
6056
6057 If ROUTER_SMARTHOST has been defined, either at the top of the file or on the
6058 command-line, then we route all non-local mail to that smarthost; otherwise, we'll
6059 perform DNS lookups for direct-to-MX lookup.  Any mail which is to a local domain will
6060 skip these routers because of the &%domains%& option.
6061
6062 .code
6063 smarthost:
6064   driver = manualroute
6065   domains = ! +local_domains
6066   transport = smarthost_smtp
6067   route_data = ROUTER_SMARTHOST
6068   ignore_target_hosts = <; 0.0.0.0 ; 127.0.0.0/8 ; ::1
6069   no_more
6070 .endd
6071 This router only handles mail which is not to any local domains; this is
6072 specified by the line
6073 .code
6074 domains = ! +local_domains
6075 .endd
6076 The &%domains%& option lists the domains to which this router applies, but the
6077 exclamation mark is a negation sign, so the router is used only for domains
6078 that are not in the domain list called &'local_domains'& (which was defined at
6079 the start of the configuration). The plus sign before &'local_domains'&
6080 indicates that it is referring to a named list. Addresses in other domains are
6081 passed on to the following routers.
6082
6083 The name of the router driver is &(manualroute)& because we are manually
6084 specifying how mail should be routed onwards, instead of using DNS MX.
6085 While the name of this router instance is arbitrary, the &%driver%& option must
6086 be one of the driver modules that is in the Exim binary.
6087
6088 With no pre-conditions other than &%domains%&, all mail for non-local domains
6089 will be handled by this router, and the &%no_more%& setting will ensure that no
6090 other routers will be used for messages matching the pre-conditions.  See
6091 &<<SECTrouprecon>>& for more on how the pre-conditions apply.  For messages which
6092 are handled by this router, we provide a hostname to deliver to in &%route_data%&
6093 and the macro supplies the value; the address is then queued for the
6094 &(smarthost_smtp)& transport.
6095
6096 .code
6097 dnslookup:
6098   driver = dnslookup
6099   domains = ! +local_domains
6100   transport = remote_smtp
6101   ignore_target_hosts = 0.0.0.0 : 127.0.0.0/8
6102   no_more
6103 .endd
6104 The &%domains%& option behaves as per smarthost, above.
6105
6106 The name of the router driver is &(dnslookup)&,
6107 and is specified by the &%driver%& option. Do not be confused by the fact that
6108 the name of this router instance is the same as the name of the driver. The
6109 instance name is arbitrary, but the name set in the &%driver%& option must be
6110 one of the driver modules that is in the Exim binary.
6111
6112 The &(dnslookup)& router routes addresses by looking up their domains in the
6113 DNS in order to obtain a list of hosts to which the address is routed. If the
6114 router succeeds, the address is queued for the &(remote_smtp)& transport, as
6115 specified by the &%transport%& option. If the router does not find the domain
6116 in the DNS, no further routers are tried because of the &%no_more%& setting, so
6117 the address fails and is bounced.
6118
6119 The &%ignore_target_hosts%& option specifies a list of IP addresses that are to
6120 be entirely ignored. This option is present because a number of cases have been
6121 encountered where MX records in the DNS point to host names
6122 whose IP addresses are 0.0.0.0 or are in the 127 subnet (typically 127.0.0.1).
6123 Completely ignoring these IP addresses causes Exim to fail to route the
6124 email address, so it bounces. Otherwise, Exim would log a routing problem, and
6125 continue to try to deliver the message periodically until the address timed
6126 out.
6127 .code
6128 system_aliases:
6129   driver = redirect
6130   allow_fail
6131   allow_defer
6132   data = ${lookup{$local_part}lsearch{/etc/aliases}}
6133 # user = exim
6134   file_transport = address_file
6135   pipe_transport = address_pipe
6136 .endd
6137 Control reaches this and subsequent routers only for addresses in the local
6138 domains. This router checks to see whether the local part is defined as an
6139 alias in the &_/etc/aliases_& file, and if so, redirects it according to the
6140 data that it looks up from that file. If no data is found for the local part,
6141 the value of the &%data%& option is empty, causing the address to be passed to
6142 the next router.
6143
6144 &_/etc/aliases_& is a conventional name for the system aliases file that is
6145 often used. That is why it is referenced by from the default configuration
6146 file. However, you can change this by setting SYSTEM_ALIASES_FILE in
6147 &_Local/Makefile_& before building Exim.
6148 .code
6149 userforward:
6150   driver = redirect
6151   check_local_user
6152 # local_part_suffix = +* : -*
6153 # local_part_suffix_optional
6154   file = $home/.forward
6155 # allow_filter
6156   no_verify
6157   no_expn
6158   check_ancestor
6159   file_transport = address_file
6160   pipe_transport = address_pipe
6161   reply_transport = address_reply
6162 .endd
6163 This is the most complicated router in the default configuration. It is another
6164 redirection router, but this time it is looking for forwarding data set up by
6165 individual users. The &%check_local_user%& setting specifies a check that the
6166 local part of the address is the login name of a local user. If it is not, the
6167 router is skipped. The two commented options that follow &%check_local_user%&,
6168 namely:
6169 .code
6170 # local_part_suffix = +* : -*
6171 # local_part_suffix_optional
6172 .endd
6173 .vindex "&$local_part_suffix$&"
6174 show how you can specify the recognition of local part suffixes. If the first
6175 is uncommented, a suffix beginning with either a plus or a minus sign, followed
6176 by any sequence of characters, is removed from the local part and placed in the
6177 variable &$local_part_suffix$&. The second suffix option specifies that the
6178 presence of a suffix in the local part is optional. When a suffix is present,
6179 the check for a local login uses the local part with the suffix removed.
6180
6181 When a local user account is found, the file called &_.forward_& in the user's
6182 home directory is consulted. If it does not exist, or is empty, the router
6183 declines. Otherwise, the contents of &_.forward_& are interpreted as
6184 redirection data (see chapter &<<CHAPredirect>>& for more details).
6185
6186 .cindex "Sieve filter" "enabling in default router"
6187 Traditional &_.forward_& files contain just a list of addresses, pipes, or
6188 files. Exim supports this by default. However, if &%allow_filter%& is set (it
6189 is commented out by default), the contents of the file are interpreted as a set
6190 of Exim or Sieve filtering instructions, provided the file begins with &"#Exim
6191 filter"& or &"#Sieve filter"&, respectively. User filtering is discussed in the
6192 separate document entitled &'Exim's interfaces to mail filtering'&.
6193
6194 The &%no_verify%& and &%no_expn%& options mean that this router is skipped when
6195 verifying addresses, or when running as a consequence of an SMTP EXPN command.
6196 There are two reasons for doing this:
6197
6198 .olist
6199 Whether or not a local user has a &_.forward_& file is not really relevant when
6200 checking an address for validity; it makes sense not to waste resources doing
6201 unnecessary work.
6202 .next
6203 More importantly, when Exim is verifying addresses or handling an EXPN
6204 command during an SMTP session, it is running as the Exim user, not as root.
6205 The group is the Exim group, and no additional groups are set up.
6206 It may therefore not be possible for Exim to read users' &_.forward_& files at
6207 this time.
6208 .endlist
6209
6210 The setting of &%check_ancestor%& prevents the router from generating a new
6211 address that is the same as any previous address that was redirected. (This
6212 works round a problem concerning a bad interaction between aliasing and
6213 forwarding &-- see section &<<SECTredlocmai>>&).
6214
6215 The final three option settings specify the transports that are to be used when
6216 forwarding generates a direct delivery to a file, or to a pipe, or sets up an
6217 auto-reply, respectively. For example, if a &_.forward_& file contains
6218 .code
6219 a.nother@elsewhere.example, /home/spqr/archive
6220 .endd
6221 the delivery to &_/home/spqr/archive_& is done by running the &%address_file%&
6222 transport.
6223 .code
6224 localuser:
6225   driver = accept
6226   check_local_user
6227 # local_part_suffix = +* : -*
6228 # local_part_suffix_optional
6229   transport = local_delivery
6230 .endd
6231 The final router sets up delivery into local mailboxes, provided that the local
6232 part is the name of a local login, by accepting the address and assigning it to
6233 the &(local_delivery)& transport. Otherwise, we have reached the end of the
6234 routers, so the address is bounced. The commented suffix settings fulfil the
6235 same purpose as they do for the &(userforward)& router.
6236
6237
6238 .section "Transport configuration" "SECID56"
6239 .cindex "default" "transports"
6240 .cindex "transports" "default"
6241 Transports define mechanisms for actually delivering messages. They operate
6242 only when referenced from routers, so the order in which they are defined does
6243 not matter. The transports section of the configuration starts with
6244 .code
6245 begin transports
6246 .endd
6247 Two remote transports and four local transports are defined.
6248 .code
6249 remote_smtp:
6250   driver = smtp
6251   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6252 .ifdef _HAVE_DANE
6253   dnssec_request_domains = *
6254   hosts_try_dane = *
6255 .endif
6256 .ifdef _HAVE_PRDR
6257   hosts_try_prdr = *
6258 .endif
6259 .endd
6260 This transport is used for delivering messages over SMTP connections.
6261 The list of remote hosts comes from the router.
6262 The &%message_size_limit%& usage is a hack to avoid sending on messages
6263 with over-long lines.  The built-in macro _HAVE_DANE guards configuration
6264 to try to use DNSSEC for all queries and to use DANE for delivery;
6265 see section &<<SECDANE>>& for more details.
6266
6267 The &%hosts_try_prdr%& option enables an efficiency SMTP option.  It is
6268 negotiated between client and server and not expected to cause problems
6269 but can be disabled if needed.  The built-in macro _HAVE_PRDR guards the
6270 use of the &%hosts_try_prdr%& configuration option.
6271
6272 The other remote transport is used when delivering to a specific smarthost
6273 with whom there must be some kind of existing relationship, instead of the
6274 usual federated system.
6275
6276 .code
6277 smarthost_smtp:
6278   driver = smtp
6279   message_size_limit = ${if > {$max_received_linelength}{998} {1}{0}}
6280   multi_domain
6281   #
6282 .ifdef _HAVE_TLS
6283   # Comment out any of these which you have to, then file a Support
6284   # request with your smarthost provider to get things fixed:
6285   hosts_require_tls = *
6286   tls_verify_hosts = *
6287   # As long as tls_verify_hosts is enabled, this won't matter, but if you
6288   # have to comment it out then this will at least log whether you succeed
6289   # or not:
6290   tls_try_verify_hosts = *
6291   #
6292   # The SNI name should match the name which we'll expect to verify;
6293   # many mail systems don't use SNI and this doesn't matter, but if it does,
6294   # we need to send a name which the remote site will recognize.
6295   # This _should_ be the name which the smarthost operators specified as
6296   # the hostname for sending your mail to.
6297   tls_sni = ROUTER_SMARTHOST
6298   #
6299 .ifdef _HAVE_OPENSSL
6300   tls_require_ciphers = HIGH:!aNULL:@STRENGTH
6301 .endif
6302 .ifdef _HAVE_GNUTLS
6303   tls_require_ciphers = SECURE192:-VERS-SSL3.0:-VERS-TLS1.0:-VERS-TLS1.1
6304 .endif
6305 .endif
6306 .ifdef _HAVE_PRDR
6307   hosts_try_prdr = *
6308 .endif
6309 .endd
6310 After the same &%message_size_limit%& hack, we then specify that this Transport
6311 can handle messages to multiple domains in one run.  The assumption here is
6312 that you're routing all non-local mail to the same place and that place is
6313 happy to take all messages from you as quickly as possible.
6314 All other options depend upon built-in macros; if Exim was built without TLS support
6315 then no other options are defined.
6316 If TLS is available, then we configure "stronger than default" TLS ciphersuites
6317 and versions using the &%tls_require_ciphers%& option, where the value to be
6318 used depends upon the library providing TLS.
6319 Beyond that, the options adopt the stance that you should have TLS support available
6320 from your smarthost on today's Internet, so we turn on requiring TLS for the
6321 mail to be delivered, and requiring that the certificate be valid, and match
6322 the expected hostname.  The &%tls_sni%& option can be used by service providers
6323 to select an appropriate certificate to present to you and here we re-use the
6324 ROUTER_SMARTHOST macro, because that is unaffected by CNAMEs present in DNS.
6325 You want to specify the hostname which you'll expect to validate for, and that
6326 should not be subject to insecure tampering via DNS results.
6327
6328 For the &%hosts_try_prdr%& option see the previous transport.
6329
6330 All other options are defaulted.
6331 .code
6332 local_delivery:
6333   driver = appendfile
6334   file = /var/mail/$local_part
6335   delivery_date_add
6336   envelope_to_add
6337   return_path_add
6338 # group = mail
6339 # mode = 0660
6340 .endd
6341 This &(appendfile)& transport is used for local delivery to user mailboxes in
6342 traditional BSD mailbox format. By default it runs under the uid and gid of the
6343 local user, which requires the sticky bit to be set on the &_/var/mail_&
6344 directory. Some systems use the alternative approach of running mail deliveries
6345 under a particular group instead of using the sticky bit. The commented options
6346 show how this can be done.
6347
6348 Exim adds three headers to the message as it delivers it: &'Delivery-date:'&,
6349 &'Envelope-to:'& and &'Return-path:'&. This action is requested by the three
6350 similarly-named options above.
6351 .code
6352 address_pipe:
6353   driver = pipe
6354   return_output
6355 .endd
6356 This transport is used for handling deliveries to pipes that are generated by
6357 redirection (aliasing or users' &_.forward_& files). The &%return_output%&
6358 option specifies that any output on stdout or stderr generated by the pipe is to
6359 be returned to the sender.
6360 .code
6361 address_file:
6362   driver = appendfile
6363   delivery_date_add
6364   envelope_to_add
6365   return_path_add
6366 .endd
6367 This transport is used for handling deliveries to files that are generated by
6368 redirection. The name of the file is not specified in this instance of
6369 &(appendfile)&, because it comes from the &(redirect)& router.
6370 .code
6371 address_reply:
6372   driver = autoreply
6373 .endd
6374 This transport is used for handling automatic replies generated by users'
6375 filter files.
6376
6377
6378
6379 .section "Default retry rule" "SECID57"
6380 .cindex "retry" "default rule"
6381 .cindex "default" "retry rule"
6382 The retry section of the configuration file contains rules which affect the way
6383 Exim retries deliveries that cannot be completed at the first attempt. It is
6384 introduced by the line
6385 .code
6386 begin retry
6387 .endd
6388 In the default configuration, there is just one rule, which applies to all
6389 errors:
6390 .code
6391 *   *   F,2h,15m; G,16h,1h,1.5; F,4d,6h
6392 .endd
6393 This causes any temporarily failing address to be retried every 15 minutes for
6394 2 hours, then at intervals starting at one hour and increasing by a factor of
6395 1.5 until 16 hours have passed, then every 6 hours up to 4 days. If an address
6396 is not delivered after 4 days of temporary failure, it is bounced. The time is
6397 measured from first failure, not from the time the message was received.
6398
6399 If the retry section is removed from the configuration, or is empty (that is,
6400 if no retry rules are defined), Exim will not retry deliveries. This turns
6401 temporary errors into permanent errors.
6402
6403
6404 .section "Rewriting configuration" "SECID58"
6405 The rewriting section of the configuration, introduced by
6406 .code
6407 begin rewrite
6408 .endd
6409 contains rules for rewriting addresses in messages as they arrive. There are no
6410 rewriting rules in the default configuration file.
6411
6412
6413
6414 .section "Authenticators configuration" "SECTdefconfauth"
6415 .cindex "AUTH" "configuration"
6416 The authenticators section of the configuration, introduced by
6417 .code
6418 begin authenticators
6419 .endd
6420 defines mechanisms for the use of the SMTP AUTH command. The default
6421 configuration file contains two commented-out example authenticators
6422 which support plaintext username/password authentication using the
6423 standard PLAIN mechanism and the traditional but non-standard LOGIN
6424 mechanism, with Exim acting as the server. PLAIN and LOGIN are enough
6425 to support most MUA software.
6426
6427 The example PLAIN authenticator looks like this:
6428 .code
6429 #PLAIN:
6430 #  driver                  = plaintext
6431 #  server_set_id           = $auth2
6432 #  server_prompts          = :
6433 #  server_condition        = Authentication is not yet configured
6434 #  server_advertise_condition = ${if def:tls_in_cipher }
6435 .endd
6436 And the example LOGIN authenticator looks like this:
6437 .code
6438 #LOGIN:
6439 #  driver                  = plaintext
6440 #  server_set_id           = $auth1
6441 #  server_prompts          = <| Username: | Password:
6442 #  server_condition        = Authentication is not yet configured
6443 #  server_advertise_condition = ${if def:tls_in_cipher }
6444 .endd
6445
6446 The &%server_set_id%& option makes Exim remember the authenticated username
6447 in &$authenticated_id$&, which can be used later in ACLs or routers. The
6448 &%server_prompts%& option configures the &(plaintext)& authenticator so
6449 that it implements the details of the specific authentication mechanism,
6450 i.e. PLAIN or LOGIN. The &%server_advertise_condition%& setting controls
6451 when Exim offers authentication to clients; in the examples, this is only
6452 when TLS or SSL has been started, so to enable the authenticators you also
6453 need to add support for TLS as described in section &<<SECTdefconfmain>>&.
6454
6455 The &%server_condition%& setting defines how to verify that the username and
6456 password are correct. In the examples it just produces an error message.
6457 To make the authenticators work, you can use a string expansion
6458 expression like one of the examples in chapter &<<CHAPplaintext>>&.
6459
6460 Beware that the sequence of the parameters to PLAIN and LOGIN differ; the
6461 usercode and password are in different positions.
6462 Chapter &<<CHAPplaintext>>& covers both.
6463
6464 .ecindex IIDconfiwal
6465
6466
6467
6468 . ////////////////////////////////////////////////////////////////////////////
6469 . ////////////////////////////////////////////////////////////////////////////
6470
6471 .chapter "Regular expressions" "CHAPregexp"
6472
6473 .cindex "regular expressions" "library"
6474 .cindex "PCRE"
6475 Exim supports the use of regular expressions in many of its options. It
6476 uses the PCRE regular expression library; this provides regular expression
6477 matching that is compatible with Perl 5. The syntax and semantics of
6478 regular expressions is discussed in
6479 online Perl manpages, in
6480 many Perl reference books, and also in
6481 Jeffrey Friedl's &'Mastering Regular Expressions'&, which is published by
6482 O'Reilly (see &url(http://www.oreilly.com/catalog/regex2/)).
6483 . --- the http: URL here redirects to another page with the ISBN in the URL
6484 . --- where trying to use https: just redirects back to http:, so sticking
6485 . --- to the old URL for now.  2018-09-07.
6486
6487 The documentation for the syntax and semantics of the regular expressions that
6488 are supported by PCRE is included in the PCRE distribution, and no further
6489 description is included here. The PCRE functions are called from Exim using
6490 the default option settings (that is, with no PCRE options set), except that
6491 the PCRE_CASELESS option is set when the matching is required to be
6492 case-insensitive.
6493
6494 In most cases, when a regular expression is required in an Exim configuration,
6495 it has to start with a circumflex, in order to distinguish it from plain text
6496 or an &"ends with"& wildcard. In this example of a configuration setting, the
6497 second item in the colon-separated list is a regular expression.
6498 .code
6499 domains = a.b.c : ^\\d{3} : *.y.z : ...
6500 .endd
6501 The doubling of the backslash is required because of string expansion that
6502 precedes interpretation &-- see section &<<SECTlittext>>& for more discussion
6503 of this issue, and a way of avoiding the need for doubling backslashes. The
6504 regular expression that is eventually used in this example contains just one
6505 backslash. The circumflex is included in the regular expression, and has the
6506 normal effect of &"anchoring"& it to the start of the string that is being
6507 matched.
6508
6509 There are, however, two cases where a circumflex is not required for the
6510 recognition of a regular expression: these are the &%match%& condition in a
6511 string expansion, and the &%matches%& condition in an Exim filter file. In
6512 these cases, the relevant string is always treated as a regular expression; if
6513 it does not start with a circumflex, the expression is not anchored, and can
6514 match anywhere in the subject string.
6515
6516 In all cases, if you want a regular expression to match at the end of a string,
6517 you must code the $ metacharacter to indicate this. For example:
6518 .code
6519 domains = ^\\d{3}\\.example
6520 .endd
6521 matches the domain &'123.example'&, but it also matches &'123.example.com'&.
6522 You need to use:
6523 .code
6524 domains = ^\\d{3}\\.example\$
6525 .endd
6526 if you want &'example'& to be the top-level domain. The backslash before the
6527 $ is needed because string expansion also interprets dollar characters.
6528
6529
6530
6531 . ////////////////////////////////////////////////////////////////////////////
6532 . ////////////////////////////////////////////////////////////////////////////
6533
6534 .chapter "File and database lookups" "CHAPfdlookup"
6535 .scindex IIDfidalo1 "file" "lookups"
6536 .scindex IIDfidalo2 "database" "lookups"
6537 .cindex "lookup" "description of"
6538 Exim can be configured to look up data in files or databases as it processes
6539 messages. Two different kinds of syntax are used:
6540
6541 .olist
6542 A string that is to be expanded may contain explicit lookup requests. These
6543 cause parts of the string to be replaced by data that is obtained from the
6544 lookup. Lookups of this type are conditional expansion items. Different results
6545 can be defined for the cases of lookup success and failure. See chapter
6546 &<<CHAPexpand>>&, where string expansions are described in detail.
6547 The key for the lookup is specified as part of the string expansion.
6548 .next
6549 Lists of domains, hosts, and email addresses can contain lookup requests as a
6550 way of avoiding excessively long linear lists. In this case, the data that is
6551 returned by the lookup is often (but not always) discarded; whether the lookup
6552 succeeds or fails is what really counts. These kinds of list are described in
6553 chapter &<<CHAPdomhosaddlists>>&.
6554 The key for the lookup is given by the context in which the list is expanded.
6555 .endlist
6556
6557 String expansions, lists, and lookups interact with each other in such a way
6558 that there is no order in which to describe any one of them that does not
6559 involve references to the others. Each of these three chapters makes more sense
6560 if you have read the other two first. If you are reading this for the first
6561 time, be aware that some of it will make a lot more sense after you have read
6562 chapters &<<CHAPdomhosaddlists>>& and &<<CHAPexpand>>&.
6563
6564 .section "Examples of different lookup syntax" "SECID60"
6565 It is easy to confuse the two different kinds of lookup, especially as the
6566 lists that may contain the second kind are always expanded before being
6567 processed as lists. Therefore, they may also contain lookups of the first kind.
6568 Be careful to distinguish between the following two examples:
6569 .code
6570 domains = ${lookup{$sender_host_address}lsearch{/some/file}}
6571 domains = lsearch;/some/file
6572 .endd
6573 The first uses a string expansion, the result of which must be a domain list.
6574 No strings have been specified for a successful or a failing lookup; the
6575 defaults in this case are the looked-up data and an empty string, respectively.
6576 The expansion takes place before the string is processed as a list, and the
6577 file that is searched could contain lines like this:
6578 .code
6579 192.168.3.4: domain1:domain2:...
6580 192.168.1.9: domain3:domain4:...
6581 .endd
6582 When the lookup succeeds, the result of the expansion is a list of domains (and
6583 possibly other types of item that are allowed in domain lists).
6584
6585 In the second example, the lookup is a single item in a domain list. It causes
6586 Exim to use a lookup to see if the domain that is being processed can be found
6587 in the file. The file could contains lines like this:
6588 .code
6589 domain1:
6590 domain2:
6591 .endd
6592 Any data that follows the keys is not relevant when checking that the domain
6593 matches the list item.
6594
6595 It is possible, though no doubt confusing, to use both kinds of lookup at once.
6596 Consider a file containing lines like this:
6597 .code
6598 192.168.5.6: lsearch;/another/file
6599 .endd
6600 If the value of &$sender_host_address$& is 192.168.5.6, expansion of the
6601 first &%domains%& setting above generates the second setting, which therefore
6602 causes a second lookup to occur.
6603
6604 The rest of this chapter describes the different lookup types that are
6605 available. Any of them can be used in any part of the configuration where a
6606 lookup is permitted.
6607
6608
6609 .section "Lookup types" "SECID61"
6610 .cindex "lookup" "types of"
6611 .cindex "single-key lookup" "definition of"
6612 Two different types of data lookup are implemented:
6613
6614 .ilist
6615 The &'single-key'& type requires the specification of a file in which to look,
6616 and a single key to search for. The key must be a non-empty string for the
6617 lookup to succeed. The lookup type determines how the file is searched.
6618 .next
6619 .cindex "query-style lookup" "definition of"
6620 The &'query-style'& type accepts a generalized database query. No particular
6621 key value is assumed by Exim for query-style lookups. You can use whichever
6622 Exim variables you need to construct the database query.
6623 .endlist
6624
6625 The code for each lookup type is in a separate source file that is included in
6626 the binary of Exim only if the corresponding compile-time option is set. The
6627 default settings in &_src/EDITME_& are:
6628 .code
6629 LOOKUP_DBM=yes
6630 LOOKUP_LSEARCH=yes
6631 .endd
6632 which means that only linear searching and DBM lookups are included by default.
6633 For some types of lookup (e.g. SQL databases), you need to install appropriate
6634 libraries and header files before building Exim.
6635
6636
6637
6638
6639 .section "Single-key lookup types" "SECTsinglekeylookups"
6640 .cindex "lookup" "single-key types"
6641 .cindex "single-key lookup" "list of types"
6642 The following single-key lookup types are implemented:
6643
6644 .ilist
6645 .cindex "cdb" "description of"
6646 .cindex "lookup" "cdb"
6647 .cindex "binary zero" "in lookup key"
6648 &(cdb)&: The given file is searched as a Constant DataBase file, using the key
6649 string without a terminating binary zero. The cdb format is designed for
6650 indexed files that are read frequently and never updated, except by total
6651 re-creation. As such, it is particularly suitable for large files containing
6652 aliases or other indexed data referenced by an MTA. Information about cdb and
6653 tools for building the files can be found in several places:
6654 .display
6655 &url(https://cr.yp.to/cdb.html)
6656 &url(http://www.corpit.ru/mjt/tinycdb.html)
6657 &url(https://packages.debian.org/stable/utils/freecdb)
6658 &url(https://github.com/philpennock/cdbtools) (in Go)
6659 .endd
6660 . --- 2018-09-07: corpit.ru http:-only
6661 A cdb distribution is not needed in order to build Exim with cdb support,
6662 because the code for reading cdb files is included directly in Exim itself.
6663 However, no means of building or testing cdb files is provided with Exim, so
6664 you need to obtain a cdb distribution in order to do this.
6665 .next
6666 .cindex "DBM" "lookup type"
6667 .cindex "lookup" "dbm"
6668 .cindex "binary zero" "in lookup key"
6669 &(dbm)&: Calls to DBM library functions are used to extract data from the given
6670 DBM file by looking up the record with the given key. A terminating binary
6671 zero is included in the key that is passed to the DBM library. See section
6672 &<<SECTdb>>& for a discussion of DBM libraries.
6673
6674 .cindex "Berkeley DB library" "file format"
6675 For all versions of Berkeley DB, Exim uses the DB_HASH style of database
6676 when building DBM files using the &%exim_dbmbuild%& utility. However, when
6677 using Berkeley DB versions 3 or 4, it opens existing databases for reading with
6678 the DB_UNKNOWN option. This enables it to handle any of the types of database
6679 that the library supports, and can be useful for accessing DBM files created by
6680 other applications. (For earlier DB versions, DB_HASH is always used.)
6681 .next
6682 .cindex "lookup" "dbmjz"
6683 .cindex "lookup" "dbm &-- embedded NULs"
6684 .cindex "sasldb2"
6685 .cindex "dbmjz lookup type"
6686 &(dbmjz)&: This is the same as &(dbm)&, except that the lookup key is
6687 interpreted as an Exim list; the elements of the list are joined together with
6688 ASCII NUL characters to form the lookup key.  An example usage would be to
6689 authenticate incoming SMTP calls using the passwords from Cyrus SASL's
6690 &_/etc/sasldb2_& file with the &(gsasl)& authenticator or Exim's own
6691 &(cram_md5)& authenticator.
6692 .next
6693 .cindex "lookup" "dbmnz"
6694 .cindex "lookup" "dbm &-- terminating zero"
6695 .cindex "binary zero" "in lookup key"
6696 .cindex "Courier"
6697 .cindex "&_/etc/userdbshadow.dat_&"
6698 .cindex "dbmnz lookup type"
6699 &(dbmnz)&: This is the same as &(dbm)&, except that a terminating binary zero
6700 is not included in the key that is passed to the DBM library. You may need this
6701 if you want to look up data in files that are created by or shared with some
6702 other application that does not use terminating zeros. For example, you need to
6703 use &(dbmnz)& rather than &(dbm)& if you want to authenticate incoming SMTP
6704 calls using the passwords from Courier's &_/etc/userdbshadow.dat_& file. Exim's
6705 utility program for creating DBM files (&'exim_dbmbuild'&) includes the zeros
6706 by default, but has an option to omit them (see section &<<SECTdbmbuild>>&).
6707 .next
6708 .cindex "lookup" "dsearch"
6709 .cindex "dsearch lookup type"
6710 &(dsearch)&: The given file must be a directory; this is searched for an entry
6711 whose name is the key by calling the &[lstat()]& function. The key may not
6712 contain any forward slash characters. If &[lstat()]& succeeds, the result of
6713 the lookup is the name of the entry, which may be a file, directory,
6714 symbolic link, or any other kind of directory entry. An example of how this
6715 lookup can be used to support virtual domains is given in section
6716 &<<SECTvirtualdomains>>&.
6717 .next
6718 .cindex "lookup" "iplsearch"
6719 .cindex "iplsearch lookup type"
6720 &(iplsearch)&: The given file is a text file containing keys and data. A key is
6721 terminated by a colon or white space or the end of the line. The keys in the
6722 file must be IP addresses, or IP addresses with CIDR masks. Keys that involve
6723 IPv6 addresses must be enclosed in quotes to prevent the first internal colon
6724 being interpreted as a key terminator. For example:
6725 .code
6726 1.2.3.4:           data for 1.2.3.4
6727 192.168.0.0/16:    data for 192.168.0.0/16
6728 "abcd::cdab":      data for abcd::cdab
6729 "abcd:abcd::/32"   data for abcd:abcd::/32
6730 .endd
6731 The key for an &(iplsearch)& lookup must be an IP address (without a mask). The
6732 file is searched linearly, using the CIDR masks where present, until a matching
6733 key is found. The first key that matches is used; there is no attempt to find a
6734 &"best"& match. Apart from the way the keys are matched, the processing for
6735 &(iplsearch)& is the same as for &(lsearch)&.
6736
6737 &*Warning 1*&: Unlike most other single-key lookup types, a file of data for
6738 &(iplsearch)& can &'not'& be turned into a DBM or cdb file, because those
6739 lookup types support only literal keys.
6740
6741 &*Warning 2*&: In a host list, you must always use &(net-iplsearch)& so that
6742 the implicit key is the host's IP address rather than its name (see section
6743 &<<SECThoslispatsikey>>&).
6744
6745 .new
6746 &*Warning 3*&: Do not use an IPv4-mapped IPv6 address for a key; use the
6747 IPv4.  Such addresses being searched for are converted to IPv4.
6748 .wen
6749 .next
6750 .new
6751 .cindex lookup json
6752 .cindex json "lookup type"
6753 .cindex JSON expansions
6754 &(json)&: The given file is a text file with a JSON structure.
6755 An element of the structure is extracted, defined by the search key.
6756 The key is a list of subelement selectors
6757 (colon-separated by default but changeable in the usual way)
6758 which are applied in turn to select smaller and smaller portions
6759 of the JSON structure.
6760 If a selector is numeric, it must apply to a JSON array; the (zero-based)
6761 nunbered array element is selected.
6762 Otherwise it must apply to a JSON object; the named element is selected.
6763 The final resulting element can be a simple JSON type or a JSON object
6764 or array; for the latter two a string-representation os the JSON
6765 is returned.
6766 For elements of type string, the returned value is de-quoted.
6767 .wen
6768 .next
6769 .cindex "linear search"
6770 .cindex "lookup" "lsearch"
6771 .cindex "lsearch lookup type"
6772 .cindex "case sensitivity" "in lsearch lookup"
6773 &(lsearch)&: The given file is a text file that is searched linearly for a
6774 line beginning with the search key, terminated by a colon or white space or the
6775 end of the line. The search is case-insensitive; that is, upper and lower case
6776 letters are treated as the same. The first occurrence of the key that is found
6777 in the file is used.
6778
6779 White space between the key and the colon is permitted. The remainder of the
6780 line, with leading and trailing white space removed, is the data. This can be
6781 continued onto subsequent lines by starting them with any amount of white
6782 space, but only a single space character is included in the data at such a
6783 junction. If the data begins with a colon, the key must be terminated by a
6784 colon, for example:
6785 .code
6786 baduser:  :fail:
6787 .endd
6788 Empty lines and lines beginning with # are ignored, even if they occur in the
6789 middle of an item. This is the traditional textual format of alias files. Note
6790 that the keys in an &(lsearch)& file are literal strings. There is no
6791 wildcarding of any kind.
6792
6793 .cindex "lookup" "lsearch &-- colons in keys"
6794 .cindex "white space" "in lsearch key"
6795 In most &(lsearch)& files, keys are not required to contain colons or #
6796 characters, or white space. However, if you need this feature, it is available.
6797 If a key begins with a doublequote character, it is terminated only by a
6798 matching quote (or end of line), and the normal escaping rules apply to its
6799 contents (see section &<<SECTstrings>>&). An optional colon is permitted after
6800 quoted keys (exactly as for unquoted keys). There is no special handling of
6801 quotes for the data part of an &(lsearch)& line.
6802
6803 .next
6804 .cindex "NIS lookup type"
6805 .cindex "lookup" "NIS"
6806 .cindex "binary zero" "in lookup key"
6807 &(nis)&: The given file is the name of a NIS map, and a NIS lookup is done with
6808 the given key, without a terminating binary zero. There is a variant called
6809 &(nis0)& which does include the terminating binary zero in the key. This is
6810 reportedly needed for Sun-style alias files. Exim does not recognize NIS
6811 aliases; the full map names must be used.
6812
6813 .next
6814 .cindex "wildlsearch lookup type"
6815 .cindex "lookup" "wildlsearch"
6816 .cindex "nwildlsearch lookup type"
6817 .cindex "lookup" "nwildlsearch"
6818 &(wildlsearch)& or &(nwildlsearch)&: These search a file linearly, like
6819 &(lsearch)&, but instead of being interpreted as a literal string, each key in
6820 the file may be wildcarded. The difference between these two lookup types is
6821 that for &(wildlsearch)&, each key in the file is string-expanded before being
6822 used, whereas for &(nwildlsearch)&, no expansion takes place.
6823
6824 .cindex "case sensitivity" "in (n)wildlsearch lookup"
6825 Like &(lsearch)&, the testing is done case-insensitively. However, keys in the
6826 file that are regular expressions can be made case-sensitive by the use of
6827 &`(-i)`& within the pattern. The following forms of wildcard are recognized:
6828
6829 . ==== As this is a nested list, any displays it contains must be indented
6830 . ==== as otherwise they are too far to the left.
6831
6832 .olist
6833 The string may begin with an asterisk to mean &"ends with"&. For example:
6834 .code
6835     *.a.b.c       data for anything.a.b.c
6836     *fish         data for anythingfish
6837 .endd
6838 .next
6839 The string may begin with a circumflex to indicate a regular expression. For
6840 example, for &(wildlsearch)&:
6841 .code
6842     ^\N\d+\.a\.b\N    data for <digits>.a.b
6843 .endd
6844 Note the use of &`\N`& to disable expansion of the contents of the regular
6845 expression. If you are using &(nwildlsearch)&, where the keys are not
6846 string-expanded, the equivalent entry is:
6847 .code
6848     ^\d+\.a\.b        data for <digits>.a.b
6849 .endd
6850 The case-insensitive flag is set at the start of compiling the regular
6851 expression, but it can be turned off by using &`(-i)`& at an appropriate point.
6852 For example, to make the entire pattern case-sensitive:
6853 .code
6854     ^(?-i)\d+\.a\.b        data for <digits>.a.b
6855 .endd
6856
6857 If the regular expression contains white space or colon characters, you must
6858 either quote it (see &(lsearch)& above), or represent these characters in other
6859 ways. For example, &`\s`& can be used for white space and &`\x3A`& for a
6860 colon. This may be easier than quoting, because if you quote, you have to
6861 escape all the backslashes inside the quotes.
6862
6863 &*Note*&: It is not possible to capture substrings in a regular expression
6864 match for later use, because the results of all lookups are cached. If a lookup
6865 is repeated, the result is taken from the cache, and no actual pattern matching
6866 takes place. The values of all the numeric variables are unset after a
6867 &((n)wildlsearch)& match.
6868
6869 .next
6870 Although I cannot see it being of much use, the general matching function that
6871 is used to implement &((n)wildlsearch)& means that the string may begin with a
6872 lookup name terminated by a semicolon, and followed by lookup data. For
6873 example:
6874 .code
6875     cdb;/some/file  data for keys that match the file
6876 .endd
6877 The data that is obtained from the nested lookup is discarded.
6878 .endlist olist
6879
6880 Keys that do not match any of these patterns are interpreted literally. The
6881 continuation rules for the data are the same as for &(lsearch)&, and keys may
6882 be followed by optional colons.
6883
6884 &*Warning*&: Unlike most other single-key lookup types, a file of data for
6885 &((n)wildlsearch)& can &'not'& be turned into a DBM or cdb file, because those
6886 lookup types support only literal keys.
6887
6888 .next
6889 .cindex "lookup" "spf"
6890 If Exim is built with SPF support, manual lookups can be done
6891 (as opposed to the standard ACL condition method.
6892 For details see section &<<SECSPF>>&.
6893 .endlist ilist
6894
6895
6896 .section "Query-style lookup types" "SECTquerystylelookups"
6897 .cindex "lookup" "query-style types"
6898 .cindex "query-style lookup" "list of types"
6899 The supported query-style lookup types are listed below. Further details about
6900 many of them are given in later sections.
6901
6902 .ilist
6903 .cindex "DNS" "as a lookup type"
6904 .cindex "lookup" "DNS"
6905 &(dnsdb)&: This does a DNS search for one or more records whose domain names
6906 are given in the supplied query. The resulting data is the contents of the
6907 records. See section &<<SECTdnsdb>>&.
6908 .next
6909 .cindex "InterBase lookup type"
6910 .cindex "lookup" "InterBase"
6911 &(ibase)&: This does a lookup in an InterBase database.
6912 .next
6913 .cindex "LDAP" "lookup type"
6914 .cindex "lookup" "LDAP"
6915 &(ldap)&: This does an LDAP lookup using a query in the form of a URL, and
6916 returns attributes from a single entry. There is a variant called &(ldapm)&
6917 that permits values from multiple entries to be returned. A third variant
6918 called &(ldapdn)& returns the Distinguished Name of a single entry instead of
6919 any attribute values. See section &<<SECTldap>>&.
6920 .next
6921 .cindex "MySQL" "lookup type"
6922 .cindex "lookup" "MySQL"
6923 &(mysql)&: The format of the query is an SQL statement that is passed to a
6924 MySQL database. See section &<<SECTsql>>&.
6925 .next
6926 .cindex "NIS+ lookup type"
6927 .cindex "lookup" "NIS+"
6928 &(nisplus)&: This does a NIS+ lookup using a query that can specify the name of
6929 the field to be returned. See section &<<SECTnisplus>>&.
6930 .next
6931 .cindex "Oracle" "lookup type"
6932 .cindex "lookup" "Oracle"
6933 &(oracle)&: The format of the query is an SQL statement that is passed to an
6934 Oracle database. See section &<<SECTsql>>&.
6935 .next
6936 .cindex "lookup" "passwd"
6937 .cindex "passwd lookup type"
6938 .cindex "&_/etc/passwd_&"
6939 &(passwd)& is a query-style lookup with queries that are just user names. The
6940 lookup calls &[getpwnam()]& to interrogate the system password data, and on
6941 success, the result string is the same as you would get from an &(lsearch)&
6942 lookup on a traditional &_/etc/passwd file_&, though with &`*`& for the
6943 password value. For example:
6944 .code
6945 *:42:42:King Rat:/home/kr:/bin/bash
6946 .endd
6947 .next
6948 .cindex "PostgreSQL lookup type"
6949 .cindex "lookup" "PostgreSQL"
6950 &(pgsql)&: The format of the query is an SQL statement that is passed to a
6951 PostgreSQL database. See section &<<SECTsql>>&.
6952
6953 .next
6954 .cindex "Redis lookup type"
6955 .cindex lookup Redis
6956 &(redis)&: The format of the query is either a simple get or simple set,
6957 passed to a Redis database. See section &<<SECTsql>>&.
6958
6959 .next
6960 .cindex "sqlite lookup type"
6961 .cindex "lookup" "sqlite"
6962 &(sqlite)&: The format of the query is a filename followed by an SQL statement
6963 that is passed to an SQLite database. See section &<<SECTsqlite>>&.
6964
6965 .next
6966 &(testdb)&: This is a lookup type that is used for testing Exim. It is
6967 not likely to be useful in normal operation.
6968 .next
6969 .cindex "whoson lookup type"
6970 .cindex "lookup" "whoson"
6971 . --- still http:-only, 2018-09-07
6972 &(whoson)&: &'Whoson'& (&url(http://whoson.sourceforge.net)) is a protocol that
6973 allows a server to check whether a particular (dynamically allocated) IP
6974 address is currently allocated to a known (trusted) user and, optionally, to
6975 obtain the identity of the said user. For SMTP servers, &'Whoson'& was popular
6976 at one time for &"POP before SMTP"& authentication, but that approach has been
6977 superseded by SMTP authentication. In Exim, &'Whoson'& can be used to implement
6978 &"POP before SMTP"& checking using ACL statements such as
6979 .code
6980 require condition = \
6981   ${lookup whoson {$sender_host_address}{yes}{no}}
6982 .endd
6983 The query consists of a single IP address. The value returned is the name of
6984 the authenticated user, which is stored in the variable &$value$&. However, in
6985 this example, the data in &$value$& is not used; the result of the lookup is
6986 one of the fixed strings &"yes"& or &"no"&.
6987 .endlist
6988
6989
6990
6991 .section "Temporary errors in lookups" "SECID63"
6992 .cindex "lookup" "temporary error in"
6993 Lookup functions can return temporary error codes if the lookup cannot be
6994 completed. For example, an SQL or LDAP database might be unavailable. For this
6995 reason, it is not advisable to use a lookup that might do this for critical
6996 options such as a list of local domains.
6997
6998 When a lookup cannot be completed in a router or transport, delivery
6999 of the message (to the relevant address) is deferred, as for any other
7000 temporary error. In other circumstances Exim may assume the lookup has failed,
7001 or may give up altogether.
7002
7003
7004
7005 .section "Default values in single-key lookups" "SECTdefaultvaluelookups"
7006 .cindex "wildcard lookups"
7007 .cindex "lookup" "default values"
7008 .cindex "lookup" "wildcard"
7009 .cindex "lookup" "* added to type"
7010 .cindex "default" "in single-key lookups"
7011 In this context, a &"default value"& is a value specified by the administrator
7012 that is to be used if a lookup fails.
7013
7014 &*Note:*& This section applies only to single-key lookups. For query-style
7015 lookups, the facilities of the query language must be used. An attempt to
7016 specify a default for a query-style lookup provokes an error.
7017
7018 If &"*"& is added to a single-key lookup type (for example, &%lsearch*%&)
7019 and the initial lookup fails, the key &"*"& is looked up in the file to
7020 provide a default value. See also the section on partial matching below.
7021
7022 .cindex "*@ with single-key lookup"
7023 .cindex "lookup" "*@ added to type"
7024 .cindex "alias file" "per-domain default"
7025 Alternatively, if &"*@"& is added to a single-key lookup type (for example
7026 &%dbm*@%&) then, if the initial lookup fails and the key contains an @
7027 character, a second lookup is done with everything before the last @ replaced
7028 by *. This makes it possible to provide per-domain defaults in alias files
7029 that include the domains in the keys. If the second lookup fails (or doesn't
7030 take place because there is no @ in the key), &"*"& is looked up.
7031 For example, a &(redirect)& router might contain:
7032 .code
7033 data = ${lookup{$local_part@$domain}lsearch*@{/etc/mix-aliases}}
7034 .endd
7035 Suppose the address that is being processed is &'jane@eyre.example'&. Exim
7036 looks up these keys, in this order:
7037 .code
7038 jane@eyre.example
7039 *@eyre.example
7040 *
7041 .endd
7042 The data is taken from whichever key it finds first. &*Note*&: In an
7043 &(lsearch)& file, this does not mean the first of these keys in the file. A
7044 complete scan is done for each key, and only if it is not found at all does
7045 Exim move on to try the next key.
7046
7047
7048
7049 .section "Partial matching in single-key lookups" "SECTpartiallookup"
7050 .cindex "partial matching"
7051 .cindex "wildcard lookups"
7052 .cindex "lookup" "partial matching"
7053 .cindex "lookup" "wildcard"
7054 .cindex "asterisk" "in search type"
7055 The normal operation of a single-key lookup is to search the file for an exact
7056 match with the given key. However, in a number of situations where domains are
7057 being looked up, it is useful to be able to do partial matching. In this case,
7058 information in the file that has a key starting with &"*."& is matched by any
7059 domain that ends with the components that follow the full stop. For example, if
7060 a key in a DBM file is
7061 .code
7062 *.dates.fict.example
7063 .endd
7064 then when partial matching is enabled this is matched by (amongst others)
7065 &'2001.dates.fict.example'& and &'1984.dates.fict.example'&. It is also matched
7066 by &'dates.fict.example'&, if that does not appear as a separate key in the
7067 file.
7068
7069 &*Note*&: Partial matching is not available for query-style lookups. It is
7070 also not available for any lookup items in address lists (see section
7071 &<<SECTaddresslist>>&).
7072
7073 Partial matching is implemented by doing a series of separate lookups using
7074 keys constructed by modifying the original subject key. This means that it can
7075 be used with any of the single-key lookup types, provided that
7076 partial matching keys
7077 beginning with a special prefix (default &"*."&) are included in the data file.
7078 Keys in the file that do not begin with the prefix are matched only by
7079 unmodified subject keys when partial matching is in use.
7080
7081 Partial matching is requested by adding the string &"partial-"& to the front of
7082 the name of a single-key lookup type, for example, &%partial-dbm%&. When this
7083 is done, the subject key is first looked up unmodified; if that fails, &"*."&
7084 is added at the start of the subject key, and it is looked up again. If that
7085 fails, further lookups are tried with dot-separated components removed from the
7086 start of the subject key, one-by-one, and &"*."& added on the front of what
7087 remains.
7088
7089 A minimum number of two non-* components are required. This can be adjusted
7090 by including a number before the hyphen in the search type. For example,
7091 &%partial3-lsearch%& specifies a minimum of three non-* components in the
7092 modified keys. Omitting the number is equivalent to &"partial2-"&. If the
7093 subject key is &'2250.dates.fict.example'& then the following keys are looked
7094 up when the minimum number of non-* components is two:
7095 .code
7096 2250.dates.fict.example
7097 *.2250.dates.fict.example
7098 *.dates.fict.example
7099 *.fict.example
7100 .endd
7101 As soon as one key in the sequence is successfully looked up, the lookup
7102 finishes.
7103
7104 .cindex "lookup" "partial matching &-- changing prefix"
7105 .cindex "prefix" "for partial matching"
7106 The use of &"*."& as the partial matching prefix is a default that can be
7107 changed. The motivation for this feature is to allow Exim to operate with file
7108 formats that are used by other MTAs. A different prefix can be supplied in
7109 parentheses instead of the hyphen after &"partial"&. For example:
7110 .code
7111 domains = partial(.)lsearch;/some/file
7112 .endd
7113 In this example, if the domain is &'a.b.c'&, the sequence of lookups is
7114 &`a.b.c`&, &`.a.b.c`&, and &`.b.c`& (the default minimum of 2 non-wild
7115 components is unchanged). The prefix may consist of any punctuation characters
7116 other than a closing parenthesis. It may be empty, for example:
7117 .code
7118 domains = partial1()cdb;/some/file
7119 .endd
7120 For this example, if the domain is &'a.b.c'&, the sequence of lookups is
7121 &`a.b.c`&, &`b.c`&, and &`c`&.
7122
7123 If &"partial0"& is specified, what happens at the end (when the lookup with
7124 just one non-wild component has failed, and the original key is shortened right
7125 down to the null string) depends on the prefix:
7126
7127 .ilist
7128 If the prefix has zero length, the whole lookup fails.
7129 .next
7130 If the prefix has length 1, a lookup for just the prefix is done. For
7131 example, the final lookup for &"partial0(.)"& is for &`.`& alone.
7132 .next
7133 Otherwise, if the prefix ends in a dot, the dot is removed, and the
7134 remainder is looked up. With the default prefix, therefore, the final lookup is
7135 for &"*"& on its own.
7136 .next
7137 Otherwise, the whole prefix is looked up.
7138 .endlist
7139
7140
7141 If the search type ends in &"*"& or &"*@"& (see section
7142 &<<SECTdefaultvaluelookups>>& above), the search for an ultimate default that
7143 this implies happens after all partial lookups have failed. If &"partial0"& is
7144 specified, adding &"*"& to the search type has no effect with the default
7145 prefix, because the &"*"& key is already included in the sequence of partial
7146 lookups. However, there might be a use for lookup types such as
7147 &"partial0(.)lsearch*"&.
7148
7149 The use of &"*"& in lookup partial matching differs from its use as a wildcard
7150 in domain lists and the like. Partial matching works only in terms of
7151 dot-separated components; a key such as &`*fict.example`&
7152 in a database file is useless, because the asterisk in a partial matching
7153 subject key is always followed by a dot.
7154
7155
7156
7157
7158 .section "Lookup caching" "SECID64"
7159 .cindex "lookup" "caching"
7160 .cindex "caching" "lookup data"
7161 Exim caches all lookup results in order to avoid needless repetition of
7162 lookups. However, because (apart from the daemon) Exim operates as a collection
7163 of independent, short-lived processes, this caching applies only within a
7164 single Exim process. There is no inter-process lookup caching facility.
7165
7166 For single-key lookups, Exim keeps the relevant files open in case there is
7167 another lookup that needs them. In some types of configuration this can lead to
7168 many files being kept open for messages with many recipients. To avoid hitting
7169 the operating system limit on the number of simultaneously open files, Exim
7170 closes the least recently used file when it needs to open more files than its
7171 own internal limit, which can be changed via the &%lookup_open_max%& option.
7172
7173 The single-key lookup files are closed and the lookup caches are flushed at
7174 strategic points during delivery &-- for example, after all routing is
7175 complete.
7176
7177
7178
7179
7180 .section "Quoting lookup data" "SECID65"
7181 .cindex "lookup" "quoting"
7182 .cindex "quoting" "in lookups"
7183 When data from an incoming message is included in a query-style lookup, there
7184 is the possibility of special characters in the data messing up the syntax of
7185 the query. For example, a NIS+ query that contains
7186 .code
7187 [name=$local_part]
7188 .endd
7189 will be broken if the local part happens to contain a closing square bracket.
7190 For NIS+, data can be enclosed in double quotes like this:
7191 .code
7192 [name="$local_part"]
7193 .endd
7194 but this still leaves the problem of a double quote in the data. The rule for
7195 NIS+ is that double quotes must be doubled. Other lookup types have different
7196 rules, and to cope with the differing requirements, an expansion operator
7197 of the following form is provided:
7198 .code
7199 ${quote_<lookup-type>:<string>}
7200 .endd
7201 For example, the safest way to write the NIS+ query is
7202 .code
7203 [name="${quote_nisplus:$local_part}"]
7204 .endd
7205 See chapter &<<CHAPexpand>>& for full coverage of string expansions. The quote
7206 operator can be used for all lookup types, but has no effect for single-key
7207 lookups, since no quoting is ever needed in their key strings.
7208
7209
7210
7211
7212 .section "More about dnsdb" "SECTdnsdb"
7213 .cindex "dnsdb lookup"
7214 .cindex "lookup" "dnsdb"
7215 .cindex "DNS" "as a lookup type"
7216 The &(dnsdb)& lookup type uses the DNS as its database. A simple query consists
7217 of a record type and a domain name, separated by an equals sign. For example,
7218 an expansion string could contain:
7219 .code
7220 ${lookup dnsdb{mx=a.b.example}{$value}fail}
7221 .endd
7222 If the lookup succeeds, the result is placed in &$value$&, which in this case
7223 is used on its own as the result. If the lookup does not succeed, the
7224 &`fail`& keyword causes a &'forced expansion failure'& &-- see section
7225 &<<SECTforexpfai>>& for an explanation of what this means.
7226
7227 The supported DNS record types are A, CNAME, MX, NS, PTR, SOA, SPF, SRV, TLSA
7228 and TXT, and, when Exim is compiled with IPv6 support, AAAA.
7229 If no type is given, TXT is assumed.
7230
7231 For any record type, if multiple records are found, the data is returned as a
7232 concatenation, with newline as the default separator. The order, of course,
7233 depends on the DNS resolver. You can specify a different separator character
7234 between multiple records by putting a right angle-bracket followed immediately
7235 by the new separator at the start of the query. For example:
7236 .code
7237 ${lookup dnsdb{>: a=host1.example}}
7238 .endd
7239 It is permitted to specify a space as the separator character. Further
7240 white space is ignored.
7241 For lookup types that return multiple fields per record,
7242 an alternate field separator can be specified using a comma after the main
7243 separator character, followed immediately by the field separator.
7244
7245 .cindex "PTR record" "in &(dnsdb)& lookup"
7246 When the type is PTR,
7247 the data can be an IP address, written as normal; inversion and the addition of
7248 &%in-addr.arpa%& or &%ip6.arpa%& happens automatically. For example:
7249 .code
7250 ${lookup dnsdb{ptr=192.168.4.5}{$value}fail}
7251 .endd
7252 If the data for a PTR record is not a syntactically valid IP address, it is not
7253 altered and nothing is added.
7254
7255 .cindex "MX record" "in &(dnsdb)& lookup"
7256 .cindex "SRV record" "in &(dnsdb)& lookup"
7257 For an MX lookup, both the preference value and the host name are returned for
7258 each record, separated by a space. For an SRV lookup, the priority, weight,
7259 port, and host name are returned for each record, separated by spaces.
7260 The field separator can be modified as above.
7261
7262 .cindex "TXT record" "in &(dnsdb)& lookup"
7263 .cindex "SPF record" "in &(dnsdb)& lookup"
7264 For TXT records with multiple items of data, only the first item is returned,
7265 unless a field separator is specified.
7266 To concatenate items without a separator, use a semicolon instead.
7267 For SPF records the
7268 default behaviour is to concatenate multiple items without using a separator.
7269 .code
7270 ${lookup dnsdb{>\n,: txt=a.b.example}}
7271 ${lookup dnsdb{>\n; txt=a.b.example}}
7272 ${lookup dnsdb{spf=example.org}}
7273 .endd
7274 It is permitted to specify a space as the separator character. Further
7275 white space is ignored.
7276
7277 .cindex "SOA record" "in &(dnsdb)& lookup"
7278 For an SOA lookup, while no result is obtained the lookup is redone with
7279 successively more leading components dropped from the given domain.
7280 Only the primary-nameserver field is returned unless a field separator is
7281 specified.
7282 .code
7283 ${lookup dnsdb{>:,; soa=a.b.example.com}}
7284 .endd
7285
7286 .section "Dnsdb lookup modifiers" "SECTdnsdb_mod"
7287 .cindex "dnsdb modifiers"
7288 .cindex "modifiers" "dnsdb"
7289 .cindex "options" "dnsdb"
7290 Modifiers for &(dnsdb)& lookups are given by optional keywords,
7291 each followed by a comma,
7292 that may appear before the record type.
7293
7294 The &(dnsdb)& lookup fails only if all the DNS lookups fail. If there is a
7295 temporary DNS error for any of them, the behaviour is controlled by
7296 a defer-option modifier.
7297 The possible keywords are
7298 &"defer_strict"&, &"defer_never"&, and &"defer_lax"&.
7299 With &"strict"& behaviour, any temporary DNS error causes the
7300 whole lookup to defer. With &"never"& behaviour, a temporary DNS error is
7301 ignored, and the behaviour is as if the DNS lookup failed to find anything.
7302 With &"lax"& behaviour, all the queries are attempted, but a temporary DNS
7303 error causes the whole lookup to defer only if none of the other lookups
7304 succeed. The default is &"lax"&, so the following lookups are equivalent:
7305 .code
7306 ${lookup dnsdb{defer_lax,a=one.host.com:two.host.com}}
7307 ${lookup dnsdb{a=one.host.com:two.host.com}}
7308 .endd
7309 Thus, in the default case, as long as at least one of the DNS lookups
7310 yields some data, the lookup succeeds.
7311
7312 .cindex "DNSSEC" "dns lookup"
7313 Use of &(DNSSEC)& is controlled by a dnssec modifier.
7314 The possible keywords are
7315 &"dnssec_strict"&, &"dnssec_lax"&, and &"dnssec_never"&.
7316 With &"strict"& or &"lax"& DNSSEC information is requested
7317 with the lookup.
7318 With &"strict"& a response from the DNS resolver that
7319 is not labelled as authenticated data
7320 is treated as equivalent to a temporary DNS error.
7321 The default is &"never"&.
7322
7323 See also the &$lookup_dnssec_authenticated$& variable.
7324
7325 .cindex timeout "dns lookup"
7326 .cindex "DNS" timeout
7327 Timeout for the dnsdb lookup can be controlled by a retrans modifier.
7328 The form is &"retrans_VAL"& where VAL is an Exim time specification
7329 (e.g. &"5s"&).
7330 The default value is set by the main configuration option &%dns_retrans%&.
7331
7332 Retries for the dnsdb lookup can be controlled by a retry modifier.
7333 The form if &"retry_VAL"& where VAL is an integer.
7334 The default count is set by the main configuration option &%dns_retry%&.
7335
7336 .cindex caching "of dns lookup"
7337 .cindex TTL "of dns lookup"
7338 .cindex DNS TTL
7339 Dnsdb lookup results are cached within a single process (and its children).
7340 The cache entry lifetime is limited to the smallest time-to-live (TTL)
7341 value of the set of returned DNS records.
7342
7343
7344 .section "Pseudo dnsdb record types" "SECID66"
7345 .cindex "MX record" "in &(dnsdb)& lookup"
7346 By default, both the preference value and the host name are returned for
7347 each MX record, separated by a space. If you want only host names, you can use
7348 the pseudo-type MXH:
7349 .code
7350 ${lookup dnsdb{mxh=a.b.example}}
7351 .endd
7352 In this case, the preference values are omitted, and just the host names are
7353 returned.
7354
7355 .cindex "name server for enclosing domain"
7356 Another pseudo-type is ZNS (for &"zone NS"&). It performs a lookup for NS
7357 records on the given domain, but if none are found, it removes the first
7358 component of the domain name, and tries again. This process continues until NS
7359 records are found or there are no more components left (or there is a DNS
7360 error). In other words, it may return the name servers for a top-level domain,
7361 but it never returns the root name servers. If there are no NS records for the
7362 top-level domain, the lookup fails. Consider these examples:
7363 .code
7364 ${lookup dnsdb{zns=xxx.quercite.com}}
7365 ${lookup dnsdb{zns=xxx.edu}}
7366 .endd
7367 Assuming that in each case there are no NS records for the full domain name,
7368 the first returns the name servers for &%quercite.com%&, and the second returns
7369 the name servers for &%edu%&.
7370
7371 You should be careful about how you use this lookup because, unless the
7372 top-level domain does not exist, the lookup always returns some host names. The
7373 sort of use to which this might be put is for seeing if the name servers for a
7374 given domain are on a blacklist. You can probably assume that the name servers
7375 for the high-level domains such as &%com%& or &%co.uk%& are not going to be on
7376 such a list.
7377
7378 .cindex "CSA" "in &(dnsdb)& lookup"
7379 A third pseudo-type is CSA (Client SMTP Authorization). This looks up SRV
7380 records according to the CSA rules, which are described in section
7381 &<<SECTverifyCSA>>&. Although &(dnsdb)& supports SRV lookups directly, this is
7382 not sufficient because of the extra parent domain search behaviour of CSA. The
7383 result of a successful lookup such as:
7384 .code
7385 ${lookup dnsdb {csa=$sender_helo_name}}
7386 .endd
7387 has two space-separated fields: an authorization code and a target host name.
7388 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
7389 authorization required but absent, or &"?"& for unknown.
7390
7391 .cindex "A+" "in &(dnsdb)& lookup"
7392 The pseudo-type A+ performs an AAAA
7393 and then an A lookup.  All results are returned; defer processing
7394 (see below) is handled separately for each lookup.  Example:
7395 .code
7396 ${lookup dnsdb {>; a+=$sender_helo_name}}
7397 .endd
7398
7399
7400 .section "Multiple dnsdb lookups" "SECID67"
7401 In the previous sections, &(dnsdb)& lookups for a single domain are described.
7402 However, you can specify a list of domains or IP addresses in a single
7403 &(dnsdb)& lookup. The list is specified in the normal Exim way, with colon as
7404 the default separator, but with the ability to change this. For example:
7405 .code
7406 ${lookup dnsdb{one.domain.com:two.domain.com}}
7407 ${lookup dnsdb{a=one.host.com:two.host.com}}
7408 ${lookup dnsdb{ptr = <; 1.2.3.4 ; 4.5.6.8}}
7409 .endd
7410 In order to retain backwards compatibility, there is one special case: if
7411 the lookup type is PTR and no change of separator is specified, Exim looks
7412 to see if the rest of the string is precisely one IPv6 address. In this
7413 case, it does not treat it as a list.
7414
7415 The data from each lookup is concatenated, with newline separators by default,
7416 in the same way that multiple DNS records for a single item are handled. A
7417 different separator can be specified, as described above.
7418
7419
7420
7421
7422 .section "More about LDAP" "SECTldap"
7423 .cindex "LDAP" "lookup, more about"
7424 .cindex "lookup" "LDAP"
7425 .cindex "Solaris" "LDAP"
7426 The original LDAP implementation came from the University of Michigan; this has
7427 become &"Open LDAP"&, and there are now two different releases. Another
7428 implementation comes from Netscape, and Solaris 7 and subsequent releases
7429 contain inbuilt LDAP support. Unfortunately, though these are all compatible at
7430 the lookup function level, their error handling is different. For this reason
7431 it is necessary to set a compile-time variable when building Exim with LDAP, to
7432 indicate which LDAP library is in use. One of the following should appear in
7433 your &_Local/Makefile_&:
7434 .code
7435 LDAP_LIB_TYPE=UMICHIGAN
7436 LDAP_LIB_TYPE=OPENLDAP1
7437 LDAP_LIB_TYPE=OPENLDAP2
7438 LDAP_LIB_TYPE=NETSCAPE
7439 LDAP_LIB_TYPE=SOLARIS
7440 .endd
7441 If LDAP_LIB_TYPE is not set, Exim assumes &`OPENLDAP1`&, which has the
7442 same interface as the University of Michigan version.
7443
7444 There are three LDAP lookup types in Exim. These behave slightly differently in
7445 the way they handle the results of a query:
7446
7447 .ilist
7448 &(ldap)& requires the result to contain just one entry; if there are more, it
7449 gives an error.
7450 .next
7451 &(ldapdn)& also requires the result to contain just one entry, but it is the
7452 Distinguished Name that is returned rather than any attribute values.
7453 .next
7454 &(ldapm)& permits the result to contain more than one entry; the attributes
7455 from all of them are returned.
7456 .endlist
7457
7458
7459 For &(ldap)& and &(ldapm)&, if a query finds only entries with no attributes,
7460 Exim behaves as if the entry did not exist, and the lookup fails. The format of
7461 the data returned by a successful lookup is described in the next section.
7462 First we explain how LDAP queries are coded.
7463
7464
7465 .section "Format of LDAP queries" "SECTforldaque"
7466 .cindex "LDAP" "query format"
7467 An LDAP query takes the form of a URL as defined in RFC 2255. For example, in
7468 the configuration of a &(redirect)& router one might have this setting:
7469 .code
7470 data = ${lookup ldap \
7471   {ldap:///cn=$local_part,o=University%20of%20Cambridge,\
7472   c=UK?mailbox?base?}}
7473 .endd
7474 .cindex "LDAP" "with TLS"
7475 The URL may begin with &`ldap`& or &`ldaps`& if your LDAP library supports
7476 secure (encrypted) LDAP connections. The second of these ensures that an
7477 encrypted TLS connection is used.
7478
7479 With sufficiently modern LDAP libraries, Exim supports forcing TLS over regular
7480 LDAP connections, rather than the SSL-on-connect &`ldaps`&.
7481 See the &%ldap_start_tls%& option.
7482
7483 Starting with Exim 4.83, the initialization of LDAP with TLS is more tightly
7484 controlled. Every part of the TLS configuration can be configured by settings in
7485 &_exim.conf_&. Depending on the version of the client libraries installed on
7486 your system, some of the initialization may have required setting options in
7487 &_/etc/ldap.conf_& or &_~/.ldaprc_& to get TLS working with self-signed
7488 certificates. This revealed a nuance where the current UID that exim was
7489 running as could affect which config files it read. With Exim 4.83, these
7490 methods become optional, only taking effect if not specifically set in
7491 &_exim.conf_&.
7492
7493
7494 .section "LDAP quoting" "SECID68"
7495 .cindex "LDAP" "quoting"
7496 Two levels of quoting are required in LDAP queries, the first for LDAP itself
7497 and the second because the LDAP query is represented as a URL. Furthermore,
7498 within an LDAP query, two different kinds of quoting are required. For this
7499 reason, there are two different LDAP-specific quoting operators.
7500
7501 The &%quote_ldap%& operator is designed for use on strings that are part of
7502 filter specifications. Conceptually, it first does the following conversions on
7503 the string:
7504 .code
7505 *   =>   \2A
7506 (   =>   \28
7507 )   =>   \29
7508 \   =>   \5C
7509 .endd
7510 in accordance with RFC 2254. The resulting string is then quoted according
7511 to the rules for URLs, that is, all non-alphanumeric characters except
7512 .code
7513 ! $ ' - . _ ( ) * +
7514 .endd
7515 are converted to their hex values, preceded by a percent sign. For example:
7516 .code
7517 ${quote_ldap: a(bc)*, a<yz>; }
7518 .endd
7519 yields
7520 .code
7521 %20a%5C28bc%5C29%5C2A%2C%20a%3Cyz%3E%3B%20
7522 .endd
7523 Removing the URL quoting, this is (with a leading and a trailing space):
7524 .code
7525 a\28bc\29\2A, a<yz>;
7526 .endd
7527 The &%quote_ldap_dn%& operator is designed for use on strings that are part of
7528 base DN specifications in queries. Conceptually, it first converts the string
7529 by inserting a backslash in front of any of the following characters:
7530 .code
7531 , + " \ < > ;
7532 .endd
7533 It also inserts a backslash before any leading spaces or # characters, and
7534 before any trailing spaces. (These rules are in RFC 2253.) The resulting string
7535 is then quoted according to the rules for URLs. For example:
7536 .code
7537 ${quote_ldap_dn: a(bc)*, a<yz>; }
7538 .endd
7539 yields
7540 .code
7541 %5C%20a(bc)*%5C%2C%20a%5C%3Cyz%5C%3E%5C%3B%5C%20
7542 .endd
7543 Removing the URL quoting, this is (with a trailing space):
7544 .code
7545 \ a(bc)*\, a\<yz\>\;\
7546 .endd
7547 There are some further comments about quoting in the section on LDAP
7548 authentication below.
7549
7550
7551 .section "LDAP connections" "SECID69"
7552 .cindex "LDAP" "connections"
7553 The connection to an LDAP server may either be over TCP/IP, or, when OpenLDAP
7554 is in use, via a Unix domain socket. The example given above does not specify
7555 an LDAP server. A server that is reached by TCP/IP can be specified in a query
7556 by starting it with
7557 .code
7558 ldap://<hostname>:<port>/...
7559 .endd
7560 If the port (and preceding colon) are omitted, the standard LDAP port (389) is
7561 used. When no server is specified in a query, a list of default servers is
7562 taken from the &%ldap_default_servers%& configuration option. This supplies a
7563 colon-separated list of servers which are tried in turn until one successfully
7564 handles a query, or there is a serious error. Successful handling either
7565 returns the requested data, or indicates that it does not exist. Serious errors
7566 are syntactical, or multiple values when only a single value is expected.
7567 Errors which cause the next server to be tried are connection failures, bind
7568 failures, and timeouts.
7569
7570 For each server name in the list, a port number can be given. The standard way
7571 of specifying a host and port is to use a colon separator (RFC 1738). Because
7572 &%ldap_default_servers%& is a colon-separated list, such colons have to be
7573 doubled. For example
7574 .code
7575 ldap_default_servers = ldap1.example.com::145:ldap2.example.com
7576 .endd
7577 If &%ldap_default_servers%& is unset, a URL with no server name is passed
7578 to the LDAP library with no server name, and the library's default (normally
7579 the local host) is used.
7580
7581 If you are using the OpenLDAP library, you can connect to an LDAP server using
7582 a Unix domain socket instead of a TCP/IP connection. This is specified by using
7583 &`ldapi`& instead of &`ldap`& in LDAP queries. What follows here applies only
7584 to OpenLDAP. If Exim is compiled with a different LDAP library, this feature is
7585 not available.
7586
7587 For this type of connection, instead of a host name for the server, a pathname
7588 for the socket is required, and the port number is not relevant. The pathname
7589 can be specified either as an item in &%ldap_default_servers%&, or inline in
7590 the query. In the former case, you can have settings such as
7591 .code
7592 ldap_default_servers = /tmp/ldap.sock : backup.ldap.your.domain
7593 .endd
7594 When the pathname is given in the query, you have to escape the slashes as
7595 &`%2F`& to fit in with the LDAP URL syntax. For example:
7596 .code
7597 ${lookup ldap {ldapi://%2Ftmp%2Fldap.sock/o=...
7598 .endd
7599 When Exim processes an LDAP lookup and finds that the &"hostname"& is really
7600 a pathname, it uses the Unix domain socket code, even if the query actually
7601 specifies &`ldap`& or &`ldaps`&. In particular, no encryption is used for a
7602 socket connection. This behaviour means that you can use a setting of
7603 &%ldap_default_servers%& such as in the example above with traditional &`ldap`&
7604 or &`ldaps`& queries, and it will work. First, Exim tries a connection via
7605 the Unix domain socket; if that fails, it tries a TCP/IP connection to the
7606 backup host.
7607
7608 If an explicit &`ldapi`& type is given in a query when a host name is
7609 specified, an error is diagnosed. However, if there are more items in
7610 &%ldap_default_servers%&, they are tried. In other words:
7611
7612 .ilist
7613 Using a pathname with &`ldap`& or &`ldaps`& forces the use of the Unix domain
7614 interface.
7615 .next
7616 Using &`ldapi`& with a host name causes an error.
7617 .endlist
7618
7619
7620 Using &`ldapi`& with no host or path in the query, and no setting of
7621 &%ldap_default_servers%&, does whatever the library does by default.
7622
7623
7624
7625 .section "LDAP authentication and control information" "SECID70"
7626 .cindex "LDAP" "authentication"
7627 The LDAP URL syntax provides no way of passing authentication and other control
7628 information to the server. To make this possible, the URL in an LDAP query may
7629 be preceded by any number of <&'name'&>=<&'value'&> settings, separated by
7630 spaces. If a value contains spaces it must be enclosed in double quotes, and
7631 when double quotes are used, backslash is interpreted in the usual way inside
7632 them. The following names are recognized:
7633 .display
7634 &`DEREFERENCE`&  set the dereferencing parameter
7635 &`NETTIME    `&  set a timeout for a network operation
7636 &`USER       `&  set the DN, for authenticating the LDAP bind
7637 &`PASS       `&  set the password, likewise
7638 &`REFERRALS  `&  set the referrals parameter
7639 &`SERVERS    `&  set alternate server list for this query only
7640 &`SIZE       `&  set the limit for the number of entries returned
7641 &`TIME       `&  set the maximum waiting time for a query
7642 .endd
7643 The value of the DEREFERENCE parameter must be one of the words &"never"&,
7644 &"searching"&, &"finding"&, or &"always"&. The value of the REFERRALS parameter
7645 must be &"follow"& (the default) or &"nofollow"&. The latter stops the LDAP
7646 library from trying to follow referrals issued by the LDAP server.
7647
7648 .cindex LDAP timeout
7649 .cindex timeout "LDAP lookup"
7650 The name CONNECT is an obsolete name for NETTIME, retained for
7651 backwards compatibility. This timeout (specified as a number of seconds) is
7652 enforced from the client end for operations that can be carried out over a
7653 network. Specifically, it applies to network connections and calls to the
7654 &'ldap_result()'& function. If the value is greater than zero, it is used if
7655 LDAP_OPT_NETWORK_TIMEOUT is defined in the LDAP headers (OpenLDAP), or
7656 if LDAP_X_OPT_CONNECT_TIMEOUT is defined in the LDAP headers (Netscape
7657 SDK 4.1). A value of zero forces an explicit setting of &"no timeout"& for
7658 Netscape SDK; for OpenLDAP no action is taken.
7659
7660 The TIME parameter (also a number of seconds) is passed to the server to
7661 set a server-side limit on the time taken to complete a search.
7662
7663 The SERVERS parameter allows you to specify an alternate list of ldap servers
7664 to use for an individual lookup.  The global &%ldap_default_servers%& option provides a
7665 default list of ldap servers, and a single lookup can specify a single ldap
7666 server to use.  But when you need to do a lookup with a list of servers that is
7667 different than the default list (maybe different order, maybe a completely
7668 different set of servers), the SERVERS parameter allows you to specify this
7669 alternate list (colon-separated).
7670
7671 Here is an example of an LDAP query in an Exim lookup that uses some of these
7672 values. This is a single line, folded to fit on the page:
7673 .code
7674 ${lookup ldap
7675   {user="cn=manager,o=University of Cambridge,c=UK" pass=secret
7676   ldap:///o=University%20of%20Cambridge,c=UK?sn?sub?(cn=foo)}
7677   {$value}fail}
7678 .endd
7679 The encoding of spaces as &`%20`& is a URL thing which should not be done for
7680 any of the auxiliary data. Exim configuration settings that include lookups
7681 which contain password information should be preceded by &"hide"& to prevent
7682 non-admin users from using the &%-bP%& option to see their values.
7683
7684 The auxiliary data items may be given in any order. The default is no
7685 connection timeout (the system timeout is used), no user or password, no limit
7686 on the number of entries returned, and no time limit on queries.
7687
7688 When a DN is quoted in the USER= setting for LDAP authentication, Exim
7689 removes any URL quoting that it may contain before passing it LDAP. Apparently
7690 some libraries do this for themselves, but some do not. Removing the URL
7691 quoting has two advantages:
7692
7693 .ilist
7694 It makes it possible to use the same &%quote_ldap_dn%& expansion for USER=
7695 DNs as with DNs inside actual queries.
7696 .next
7697 It permits spaces inside USER= DNs.
7698 .endlist
7699
7700 For example, a setting such as
7701 .code
7702 USER=cn=${quote_ldap_dn:$1}
7703 .endd
7704 should work even if &$1$& contains spaces.
7705
7706 Expanded data for the PASS= value should be quoted using the &%quote%&
7707 expansion operator, rather than the LDAP quote operators. The only reason this
7708 field needs quoting is to ensure that it conforms to the Exim syntax, which
7709 does not allow unquoted spaces. For example:
7710 .code
7711 PASS=${quote:$3}
7712 .endd
7713 The LDAP authentication mechanism can be used to check passwords as part of
7714 SMTP authentication. See the &%ldapauth%& expansion string condition in chapter
7715 &<<CHAPexpand>>&.
7716
7717
7718
7719 .section "Format of data returned by LDAP" "SECID71"
7720 .cindex "LDAP" "returned data formats"
7721 The &(ldapdn)& lookup type returns the Distinguished Name from a single entry
7722 as a sequence of values, for example
7723 .code
7724 cn=manager,o=University of Cambridge,c=UK
7725 .endd
7726 The &(ldap)& lookup type generates an error if more than one entry matches the
7727 search filter, whereas &(ldapm)& permits this case, and inserts a newline in
7728 the result between the data from different entries. It is possible for multiple
7729 values to be returned for both &(ldap)& and &(ldapm)&, but in the former case
7730 you know that whatever values are returned all came from a single entry in the
7731 directory.
7732
7733 In the common case where you specify a single attribute in your LDAP query, the
7734 result is not quoted, and does not contain the attribute name. If the attribute
7735 has multiple values, they are separated by commas. Any comma that is
7736 part of an attribute's value is doubled.
7737
7738 If you specify multiple attributes, the result contains space-separated, quoted
7739 strings, each preceded by the attribute name and an equals sign. Within the
7740 quotes, the quote character, backslash, and newline are escaped with
7741 backslashes, and commas are used to separate multiple values for the attribute.
7742 Any commas in attribute values are doubled
7743 (permitting treatment of the values as a comma-separated list).
7744 Apart from the escaping, the string within quotes takes the same form as the
7745 output when a single attribute is requested. Specifying no attributes is the
7746 same as specifying all of an entry's attributes.
7747
7748 Here are some examples of the output format. The first line of each pair is an
7749 LDAP query, and the second is the data that is returned. The attribute called
7750 &%attr1%& has two values, one of them with an embedded comma, whereas
7751 &%attr2%& has only one value. Both attributes are derived from &%attr%&
7752 (they have SUP &%attr%& in their schema definitions).
7753
7754 .code
7755 ldap:///o=base?attr1?sub?(uid=fred)
7756 value1.1,value1,,2
7757
7758 ldap:///o=base?attr2?sub?(uid=fred)
7759 value two
7760
7761 ldap:///o=base?attr?sub?(uid=fred)
7762 value1.1,value1,,2,value two
7763
7764 ldap:///o=base?attr1,attr2?sub?(uid=fred)
7765 attr1="value1.1,value1,,2" attr2="value two"
7766
7767 ldap:///o=base??sub?(uid=fred)
7768 objectClass="top" attr1="value1.1,value1,,2" attr2="value two"
7769 .endd
7770 You can
7771 make use of Exim's &%-be%& option to run expansion tests and thereby check the
7772 results of LDAP lookups.
7773 The &%extract%& operator in string expansions can be used to pick out
7774 individual fields from data that consists of &'key'&=&'value'& pairs.
7775 The &%listextract%& operator should be used to pick out individual values
7776 of attributes, even when only a single value is expected.
7777 The doubling of embedded commas allows you to use the returned data as a
7778 comma separated list (using the "<," syntax for changing the input list separator).
7779
7780
7781
7782
7783 .section "More about NIS+" "SECTnisplus"
7784 .cindex "NIS+ lookup type"
7785 .cindex "lookup" "NIS+"
7786 NIS+ queries consist of a NIS+ &'indexed name'& followed by an optional colon
7787 and field name. If this is given, the result of a successful query is the
7788 contents of the named field; otherwise the result consists of a concatenation
7789 of &'field-name=field-value'& pairs, separated by spaces. Empty values and
7790 values containing spaces are quoted. For example, the query
7791 .code
7792 [name=mg1456],passwd.org_dir
7793 .endd
7794 might return the string
7795 .code
7796 name=mg1456 passwd="" uid=999 gid=999 gcos="Martin Guerre"
7797 home=/home/mg1456 shell=/bin/bash shadow=""
7798 .endd
7799 (split over two lines here to fit on the page), whereas
7800 .code
7801 [name=mg1456],passwd.org_dir:gcos
7802 .endd
7803 would just return
7804 .code
7805 Martin Guerre
7806 .endd
7807 with no quotes. A NIS+ lookup fails if NIS+ returns more than one table entry
7808 for the given indexed key. The effect of the &%quote_nisplus%& expansion
7809 operator is to double any quote characters within the text.
7810
7811
7812
7813 .section "SQL lookups" "SECTsql"
7814 .cindex "SQL lookup types"
7815 .cindex "MySQL" "lookup type"
7816 .cindex "PostgreSQL lookup type"
7817 .cindex "lookup" "MySQL"
7818 .cindex "lookup" "PostgreSQL"
7819 .cindex "Oracle" "lookup type"
7820 .cindex "lookup" "Oracle"
7821 .cindex "InterBase lookup type"
7822 .cindex "lookup" "InterBase"
7823 .cindex "Redis lookup type"
7824 .cindex lookup Redis
7825 Exim can support lookups in InterBase, MySQL, Oracle, PostgreSQL, Redis,
7826 and SQLite
7827 databases. Queries for these databases contain SQL statements, so an example
7828 might be
7829 .code
7830 ${lookup mysql{select mailbox from users where id='userx'}\
7831   {$value}fail}
7832 .endd
7833 If the result of the query contains more than one field, the data for each
7834 field in the row is returned, preceded by its name, so the result of
7835 .code
7836 ${lookup pgsql{select home,name from users where id='userx'}\
7837   {$value}}
7838 .endd
7839 might be
7840 .code
7841 home=/home/userx name="Mister X"
7842 .endd
7843 Empty values and values containing spaces are double quoted, with embedded
7844 quotes escaped by a backslash. If the result of the query contains just one
7845 field, the value is passed back verbatim, without a field name, for example:
7846 .code
7847 Mister X
7848 .endd
7849 If the result of the query yields more than one row, it is all concatenated,
7850 with a newline between the data for each row.
7851
7852
7853 .section "More about MySQL, PostgreSQL, Oracle, InterBase, and Redis" "SECID72"
7854 .cindex "MySQL" "lookup type"
7855 .cindex "PostgreSQL lookup type"
7856 .cindex "lookup" "MySQL"
7857 .cindex "lookup" "PostgreSQL"
7858 .cindex "Oracle" "lookup type"
7859 .cindex "lookup" "Oracle"
7860 .cindex "InterBase lookup type"
7861 .cindex "lookup" "InterBase"
7862 .cindex "Redis lookup type"
7863 .cindex lookup Redis
7864 If any MySQL, PostgreSQL, Oracle, InterBase or Redis lookups are used, the
7865 &%mysql_servers%&, &%pgsql_servers%&, &%oracle_servers%&, &%ibase_servers%&,
7866 or &%redis_servers%&
7867 option (as appropriate) must be set to a colon-separated list of server
7868 information.
7869 (For MySQL and PostgreSQL, the global option need not be set if all
7870 queries contain their own server information &-- see section
7871 &<<SECTspeserque>>&.)
7872 For all but Redis
7873 each item in the list is a slash-separated list of four
7874 items: host name, database name, user name, and password. In the case of
7875 Oracle, the host name field is used for the &"service name"&, and the database
7876 name field is not used and should be empty. For example:
7877 .code
7878 hide oracle_servers = oracle.plc.example//userx/abcdwxyz
7879 .endd
7880 Because password data is sensitive, you should always precede the setting with
7881 &"hide"&, to prevent non-admin users from obtaining the setting via the &%-bP%&
7882 option. Here is an example where two MySQL servers are listed:
7883 .code
7884 hide mysql_servers = localhost/users/root/secret:\
7885                      otherhost/users/root/othersecret
7886 .endd
7887 For MySQL and PostgreSQL, a host may be specified as <&'name'&>:<&'port'&> but
7888 because this is a colon-separated list, the colon has to be doubled. For each
7889 query, these parameter groups are tried in order until a connection is made and
7890 a query is successfully processed. The result of a query may be that no data is
7891 found, but that is still a successful query. In other words, the list of
7892 servers provides a backup facility, not a list of different places to look.
7893
7894 For Redis the global option need not be specified if all queries contain their
7895 own server information &-- see section &<<SECTspeserque>>&.
7896 If specified, the option must be set to a colon-separated list of server
7897 information.
7898 Each item in the list is a slash-separated list of three items:
7899 host, database number, and password.
7900 .olist
7901 The host is required and may be either an IPv4 address and optional
7902 port number (separated by a colon, which needs doubling due to the
7903 higher-level list), or a Unix socket pathname enclosed in parentheses
7904 .next
7905 The database number is optional; if present that number is selected in the backend
7906 .next
7907 The password is optional; if present it is used to authenticate to the backend
7908 .endlist
7909
7910 The &%quote_mysql%&, &%quote_pgsql%&, and &%quote_oracle%& expansion operators
7911 convert newline, tab, carriage return, and backspace to \n, \t, \r, and \b
7912 respectively, and the characters single-quote, double-quote, and backslash
7913 itself are escaped with backslashes.
7914
7915 The &%quote_redis%& expansion operator
7916 escapes whitespace and backslash characters with a backslash.
7917
7918 .section "Specifying the server in the query" "SECTspeserque"
7919 For MySQL, PostgreSQL and Redis lookups (but not currently for Oracle and InterBase),
7920 it is possible to specify a list of servers with an individual query. This is
7921 done by starting the query with
7922 .display
7923 &`servers=`&&'server1:server2:server3:...'&&`;`&
7924 .endd
7925 Each item in the list may take one of two forms:
7926 .olist
7927 If it contains no slashes it is assumed to be just a host name. The appropriate
7928 global option (&%mysql_servers%& or &%pgsql_servers%&) is searched for a host
7929 of the same name, and the remaining parameters (database, user, password) are
7930 taken from there.
7931 .next
7932 If it contains any slashes, it is taken as a complete parameter set.
7933 .endlist
7934 The list of servers is used in exactly the same way as the global list.
7935 Once a connection to a server has happened and a query has been
7936 successfully executed, processing of the lookup ceases.
7937
7938 This feature is intended for use in master/slave situations where updates
7939 are occurring and you want to update the master rather than a slave. If the
7940 master is in the list as a backup for reading, you might have a global setting
7941 like this:
7942 .code
7943 mysql_servers = slave1/db/name/pw:\
7944                 slave2/db/name/pw:\
7945                 master/db/name/pw
7946 .endd
7947 In an updating lookup, you could then write:
7948 .code
7949 ${lookup mysql{servers=master; UPDATE ...} }
7950 .endd
7951 That query would then be sent only to the master server. If, on the other hand,
7952 the master is not to be used for reading, and so is not present in the global
7953 option, you can still update it by a query of this form:
7954 .code
7955 ${lookup pgsql{servers=master/db/name/pw; UPDATE ...} }
7956 .endd
7957
7958
7959 .section "Special MySQL features" "SECID73"
7960 For MySQL, an empty host name or the use of &"localhost"& in &%mysql_servers%&
7961 causes a connection to the server on the local host by means of a Unix domain
7962 socket. An alternate socket can be specified in parentheses.
7963 An option group name for MySQL option files can be specified in square brackets;
7964 the default value is &"exim"&.
7965 The full syntax of each item in &%mysql_servers%& is:
7966 .display
7967 <&'hostname'&>::<&'port'&>(<&'socket name'&>)[<&'option group'&>]/&&&
7968   <&'database'&>/<&'user'&>/<&'password'&>
7969 .endd
7970 Any of the four sub-parts of the first field can be omitted. For normal use on
7971 the local host it can be left blank or set to just &"localhost"&.
7972
7973 No database need be supplied &-- but if it is absent here, it must be given in
7974 the queries.
7975
7976 If a MySQL query is issued that does not request any data (an insert, update,
7977 or delete command), the result of the lookup is the number of rows affected.
7978
7979 &*Warning*&: This can be misleading. If an update does not actually change
7980 anything (for example, setting a field to the value it already has), the result
7981 is zero because no rows are affected.
7982
7983
7984 .section "Special PostgreSQL features" "SECID74"
7985 PostgreSQL lookups can also use Unix domain socket connections to the database.
7986 This is usually faster and costs less CPU time than a TCP/IP connection.
7987 However it can be used only if the mail server runs on the same machine as the
7988 database server. A configuration line for PostgreSQL via Unix domain sockets
7989 looks like this:
7990 .code
7991 hide pgsql_servers = (/tmp/.s.PGSQL.5432)/db/user/password : ...
7992 .endd
7993 In other words, instead of supplying a host name, a path to the socket is
7994 given. The path name is enclosed in parentheses so that its slashes aren't
7995 visually confused with the delimiters for the other server parameters.
7996
7997 If a PostgreSQL query is issued that does not request any data (an insert,
7998 update, or delete command), the result of the lookup is the number of rows
7999 affected.
8000
8001 .section "More about SQLite" "SECTsqlite"
8002 .cindex "lookup" "SQLite"
8003 .cindex "sqlite lookup type"
8004 SQLite is different to the other SQL lookups because a filename is required in
8005 addition to the SQL query. An SQLite database is a single file, and there is no
8006 daemon as in the other SQL databases. The interface to Exim requires the name
8007 of the file, as an absolute path, to be given at the start of the query. It is
8008 separated from the query by white space. This means that the path name cannot
8009 contain white space. Here is a lookup expansion example:
8010 .code
8011 ${lookup sqlite {/some/thing/sqlitedb \
8012   select name from aliases where id='userx';}}
8013 .endd
8014 In a list, the syntax is similar. For example:
8015 .code
8016 domainlist relay_to_domains = sqlite;/some/thing/sqlitedb \
8017    select * from relays where ip='$sender_host_address';
8018 .endd
8019 The only character affected by the &%quote_sqlite%& operator is a single
8020 quote, which it doubles.
8021
8022 .cindex timeout SQLite
8023 .cindex sqlite "lookup timeout"
8024 The SQLite library handles multiple simultaneous accesses to the database
8025 internally. Multiple readers are permitted, but only one process can
8026 update at once. Attempts to access the database while it is being updated
8027 are rejected after a timeout period, during which the SQLite library
8028 waits for the lock to be released. In Exim, the default timeout is set
8029 to 5 seconds, but it can be changed by means of the &%sqlite_lock_timeout%&
8030 option.
8031
8032 .section "More about Redis" "SECTredis"
8033 .cindex "lookup" "Redis"
8034 .cindex "redis lookup type"
8035 Redis is a non-SQL database. Commands are simple get and set.
8036 Examples:
8037 .code
8038 ${lookup redis{set keyname ${quote_redis:objvalue plus}}}
8039 ${lookup redis{get keyname}}
8040 .endd
8041
8042 As of release 4.91, "lightweight" support for Redis Cluster is available.
8043 Requires &%redis_servers%& list to contain all the servers in the cluster, all
8044 of which must be reachable from the running exim instance. If the cluster has
8045 master/slave replication, the list must contain all the master and slave
8046 servers.
8047
8048 When the Redis Cluster returns a "MOVED" response to a query, Exim does not
8049 immediately follow the redirection but treats the response as a DEFER, moving on
8050 to the next server in the &%redis_servers%& list until the correct server is
8051 reached.
8052
8053 .ecindex IIDfidalo1
8054 .ecindex IIDfidalo2
8055
8056
8057 . ////////////////////////////////////////////////////////////////////////////
8058 . ////////////////////////////////////////////////////////////////////////////
8059
8060 .chapter "Domain, host, address, and local part lists" &&&
8061          "CHAPdomhosaddlists" &&&
8062          "Domain, host, and address lists"
8063 .scindex IIDdohoadli "lists of domains; hosts; etc."
8064 A number of Exim configuration options contain lists of domains, hosts,
8065 email addresses, or local parts. For example, the &%hold_domains%& option
8066 contains a list of domains whose delivery is currently suspended. These lists
8067 are also used as data in ACL statements (see chapter &<<CHAPACL>>&), and as
8068 arguments to expansion conditions such as &%match_domain%&.
8069
8070 Each item in one of these lists is a pattern to be matched against a domain,
8071 host, email address, or local part, respectively. In the sections below, the
8072 different types of pattern for each case are described, but first we cover some
8073 general facilities that apply to all four kinds of list.
8074
8075 Note that other parts of Exim use a &'string list'& which does not
8076 support all the complexity available in
8077 domain, host, address and local part lists.
8078
8079
8080
8081 .section "Expansion of lists" "SECTlistexpand"
8082 .cindex "expansion" "of lists"
8083 Each list is expanded as a single string before it is used.
8084
8085 &'Exception: the router headers_remove option, where list-item
8086 splitting is done before string-expansion.'&
8087
8088 The result of
8089 expansion must be a list, possibly containing empty items, which is split up
8090 into separate items for matching. By default, colon is the separator character,
8091 but this can be varied if necessary. See sections &<<SECTlistconstruct>>& and
8092 &<<SECTempitelis>>& for details of the list syntax; the second of these
8093 discusses the way to specify empty list items.
8094
8095
8096 If the string expansion is forced to fail, Exim behaves as if the item it is
8097 testing (domain, host, address, or local part) is not in the list. Other
8098 expansion failures cause temporary errors.
8099
8100 If an item in a list is a regular expression, backslashes, dollars and possibly
8101 other special characters in the expression must be protected against
8102 misinterpretation by the string expander. The easiest way to do this is to use
8103 the &`\N`& expansion feature to indicate that the contents of the regular
8104 expression should not be expanded. For example, in an ACL you might have:
8105 .code
8106 deny senders = \N^\d{8}\w@.*\.baddomain\.example$\N : \
8107                ${lookup{$domain}lsearch{/badsenders/bydomain}}
8108 .endd
8109 The first item is a regular expression that is protected from expansion by
8110 &`\N`&, whereas the second uses the expansion to obtain a list of unwanted
8111 senders based on the receiving domain.
8112
8113
8114
8115
8116 .section "Negated items in lists" "SECID76"
8117 .cindex "list" "negation"
8118 .cindex "negation" "in lists"
8119 Items in a list may be positive or negative. Negative items are indicated by a
8120 leading exclamation mark, which may be followed by optional white space. A list
8121 defines a set of items (domains, etc). When Exim processes one of these lists,
8122 it is trying to find out whether a domain, host, address, or local part
8123 (respectively) is in the set that is defined by the list. It works like this:
8124
8125 The list is scanned from left to right. If a positive item is matched, the
8126 subject that is being checked is in the set; if a negative item is matched, the
8127 subject is not in the set. If the end of the list is reached without the
8128 subject having matched any of the patterns, it is in the set if the last item
8129 was a negative one, but not if it was a positive one. For example, the list in
8130 .code
8131 domainlist relay_to_domains = !a.b.c : *.b.c
8132 .endd
8133 matches any domain ending in &'.b.c'& except for &'a.b.c'&. Domains that match
8134 neither &'a.b.c'& nor &'*.b.c'& do not match, because the last item in the
8135 list is positive. However, if the setting were
8136 .code
8137 domainlist relay_to_domains = !a.b.c
8138 .endd
8139 then all domains other than &'a.b.c'& would match because the last item in the
8140 list is negative. In other words, a list that ends with a negative item behaves
8141 as if it had an extra item &`:*`& on the end.
8142
8143 Another way of thinking about positive and negative items in lists is to read
8144 the connector as &"or"& after a positive item and as &"and"& after a negative
8145 item.
8146
8147
8148
8149 .section "File names in lists" "SECTfilnamlis"
8150 .cindex "list" "filename in"
8151 If an item in a domain, host, address, or local part list is an absolute
8152 filename (beginning with a slash character), each line of the file is read and
8153 processed as if it were an independent item in the list, except that further
8154 filenames are not allowed,
8155 and no expansion of the data from the file takes place.
8156 Empty lines in the file are ignored, and the file may also contain comment
8157 lines:
8158
8159 .ilist
8160 For domain and host lists, if a # character appears anywhere in a line of the
8161 file, it and all following characters are ignored.
8162 .next
8163 Because local parts may legitimately contain # characters, a comment in an
8164 address list or local part list file is recognized only if # is preceded by
8165 white space or the start of the line. For example:
8166 .code
8167 not#comment@x.y.z   # but this is a comment
8168 .endd
8169 .endlist
8170
8171 Putting a filename in a list has the same effect as inserting each line of the
8172 file as an item in the list (blank lines and comments excepted). However, there
8173 is one important difference: the file is read each time the list is processed,
8174 so if its contents vary over time, Exim's behaviour changes.
8175
8176 If a filename is preceded by an exclamation mark, the sense of any match
8177 within the file is inverted. For example, if
8178 .code
8179 hold_domains = !/etc/nohold-domains
8180 .endd
8181 and the file contains the lines
8182 .code
8183 !a.b.c
8184 *.b.c
8185 .endd
8186 then &'a.b.c'& is in the set of domains defined by &%hold_domains%&, whereas
8187 any domain matching &`*.b.c`& is not.
8188
8189
8190
8191 .section "An lsearch file is not an out-of-line list" "SECID77"
8192 As will be described in the sections that follow, lookups can be used in lists
8193 to provide indexed methods of checking list membership. There has been some
8194 confusion about the way &(lsearch)& lookups work in lists. Because
8195 an &(lsearch)& file contains plain text and is scanned sequentially, it is
8196 sometimes thought that it is allowed to contain wild cards and other kinds of
8197 non-constant pattern. This is not the case. The keys in an &(lsearch)& file are
8198 always fixed strings, just as for any other single-key lookup type.
8199
8200 If you want to use a file to contain wild-card patterns that form part of a
8201 list, just give the filename on its own, without a search type, as described
8202 in the previous section. You could also use the &(wildlsearch)& or
8203 &(nwildlsearch)&, but there is no advantage in doing this.
8204
8205
8206
8207
8208 .section "Named lists" "SECTnamedlists"
8209 .cindex "named lists"
8210 .cindex "list" "named"
8211 A list of domains, hosts, email addresses, or local parts can be given a name
8212 which is then used to refer to the list elsewhere in the configuration. This is
8213 particularly convenient if the same list is required in several different
8214 places. It also allows lists to be given meaningful names, which can improve
8215 the readability of the configuration. For example, it is conventional to define
8216 a domain list called &'local_domains'& for all the domains that are handled
8217 locally on a host, using a configuration line such as
8218 .code
8219 domainlist local_domains = localhost:my.dom.example
8220 .endd
8221 Named lists are referenced by giving their name preceded by a plus sign, so,
8222 for example, a router that is intended to handle local domains would be
8223 configured with the line
8224 .code
8225 domains = +local_domains
8226 .endd
8227 The first router in a configuration is often one that handles all domains
8228 except the local ones, using a configuration with a negated item like this:
8229 .code
8230 dnslookup:
8231   driver = dnslookup
8232   domains = ! +local_domains
8233   transport = remote_smtp
8234   no_more
8235 .endd
8236 The four kinds of named list are created by configuration lines starting with
8237 the words &%domainlist%&, &%hostlist%&, &%addresslist%&, or &%localpartlist%&,
8238 respectively. Then there follows the name that you are defining, followed by an
8239 equals sign and the list itself. For example:
8240 .code
8241 hostlist    relay_from_hosts = 192.168.23.0/24 : my.friend.example
8242 addresslist bad_senders = cdb;/etc/badsenders
8243 .endd
8244 A named list may refer to other named lists:
8245 .code
8246 domainlist  dom1 = first.example : second.example
8247 domainlist  dom2 = +dom1 : third.example
8248 domainlist  dom3 = fourth.example : +dom2 : fifth.example
8249 .endd
8250 &*Warning*&: If the last item in a referenced list is a negative one, the
8251 effect may not be what you intended, because the negation does not propagate
8252 out to the higher level. For example, consider:
8253 .code
8254 domainlist  dom1 = !a.b
8255 domainlist  dom2 = +dom1 : *.b
8256 .endd
8257 The second list specifies &"either in the &%dom1%& list or &'*.b'&"&. The first
8258 list specifies just &"not &'a.b'&"&, so the domain &'x.y'& matches it. That
8259 means it matches the second list as well. The effect is not the same as
8260 .code
8261 domainlist  dom2 = !a.b : *.b
8262 .endd
8263 where &'x.y'& does not match. It's best to avoid negation altogether in
8264 referenced lists if you can.
8265
8266 Named lists may have a performance advantage. When Exim is routing an
8267 address or checking an incoming message, it caches the result of tests on named
8268 lists. So, if you have a setting such as
8269 .code
8270 domains = +local_domains
8271 .endd
8272 on several of your routers
8273 or in several ACL statements,
8274 the actual test is done only for the first one. However, the caching works only
8275 if there are no expansions within the list itself or any sublists that it
8276 references. In other words, caching happens only for lists that are known to be
8277 the same each time they are referenced.
8278
8279 By default, there may be up to 16 named lists of each type. This limit can be
8280 extended by changing a compile-time variable. The use of domain and host lists
8281 is recommended for concepts such as local domains, relay domains, and relay
8282 hosts. The default configuration is set up like this.
8283
8284
8285
8286 .section "Named lists compared with macros" "SECID78"
8287 .cindex "list" "named compared with macro"
8288 .cindex "macro" "compared with named list"
8289 At first sight, named lists might seem to be no different from macros in the
8290 configuration file. However, macros are just textual substitutions. If you
8291 write
8292 .code
8293 ALIST = host1 : host2
8294 auth_advertise_hosts = !ALIST
8295 .endd
8296 it probably won't do what you want, because that is exactly the same as
8297 .code
8298 auth_advertise_hosts = !host1 : host2
8299 .endd
8300 Notice that the second host name is not negated. However, if you use a host
8301 list, and write
8302 .code
8303 hostlist alist = host1 : host2
8304 auth_advertise_hosts = ! +alist
8305 .endd
8306 the negation applies to the whole list, and so that is equivalent to
8307 .code
8308 auth_advertise_hosts = !host1 : !host2
8309 .endd
8310
8311
8312 .section "Named list caching" "SECID79"
8313 .cindex "list" "caching of named"
8314 .cindex "caching" "named lists"
8315 While processing a message, Exim caches the result of checking a named list if
8316 it is sure that the list is the same each time. In practice, this means that
8317 the cache operates only if the list contains no $ characters, which guarantees
8318 that it will not change when it is expanded. Sometimes, however, you may have
8319 an expanded list that you know will be the same each time within a given
8320 message. For example:
8321 .code
8322 domainlist special_domains = \
8323            ${lookup{$sender_host_address}cdb{/some/file}}
8324 .endd
8325 This provides a list of domains that depends only on the sending host's IP
8326 address. If this domain list is referenced a number of times (for example,
8327 in several ACL lines, or in several routers) the result of the check is not
8328 cached by default, because Exim does not know that it is going to be the
8329 same list each time.
8330
8331 By appending &`_cache`& to &`domainlist`& you can tell Exim to go ahead and
8332 cache the result anyway. For example:
8333 .code
8334 domainlist_cache special_domains = ${lookup{...
8335 .endd
8336 If you do this, you should be absolutely sure that caching is going to do
8337 the right thing in all cases. When in doubt, leave it out.
8338
8339
8340
8341 .section "Domain lists" "SECTdomainlist"
8342 .cindex "domain list" "patterns for"
8343 .cindex "list" "domain list"
8344 Domain lists contain patterns that are to be matched against a mail domain.
8345 The following types of item may appear in domain lists:
8346
8347 .ilist
8348 .cindex "primary host name"
8349 .cindex "host name" "matched in domain list"
8350 .oindex "&%primary_hostname%&"
8351 .cindex "domain list" "matching primary host name"
8352 .cindex "@ in a domain list"
8353 If a pattern consists of a single @ character, it matches the local host name,
8354 as set by the &%primary_hostname%& option (or defaulted). This makes it
8355 possible to use the same configuration file on several different hosts that
8356 differ only in their names.
8357 .next
8358 .cindex "@[] in a domain list"
8359 .cindex "domain list" "matching local IP interfaces"
8360 .cindex "domain literal"
8361 If a pattern consists of the string &`@[]`& it matches an IP address enclosed
8362 in square brackets (as in an email address that contains a domain literal), but
8363 only if that IP address is recognized as local for email routing purposes. The
8364 &%local_interfaces%& and &%extra_local_interfaces%& options can be used to
8365 control which of a host's several IP addresses are treated as local.
8366 In today's Internet, the use of domain literals is controversial.
8367 .next
8368 .cindex "@mx_any"
8369 .cindex "@mx_primary"
8370 .cindex "@mx_secondary"
8371 .cindex "domain list" "matching MX pointers to local host"
8372 If a pattern consists of the string &`@mx_any`& it matches any domain that
8373 has an MX record pointing to the local host or to any host that is listed in
8374 .oindex "&%hosts_treat_as_local%&"
8375 &%hosts_treat_as_local%&. The items &`@mx_primary`& and &`@mx_secondary`&
8376 are similar, except that the first matches only when a primary MX target is the
8377 local host, and the second only when no primary MX target is the local host,
8378 but a secondary MX target is. &"Primary"& means an MX record with the lowest
8379 preference value &-- there may of course be more than one of them.
8380
8381 The MX lookup that takes place when matching a pattern of this type is
8382 performed with the resolver options for widening names turned off. Thus, for
8383 example, a single-component domain will &'not'& be expanded by adding the
8384 resolver's default domain. See the &%qualify_single%& and &%search_parents%&
8385 options of the &(dnslookup)& router for a discussion of domain widening.
8386
8387 Sometimes you may want to ignore certain IP addresses when using one of these
8388 patterns. You can specify this by following the pattern with &`/ignore=`&<&'ip
8389 list'&>, where <&'ip list'&> is a list of IP addresses. These addresses are
8390 ignored when processing the pattern (compare the &%ignore_target_hosts%& option
8391 on a router). For example:
8392 .code
8393 domains = @mx_any/ignore=127.0.0.1
8394 .endd
8395 This example matches any domain that has an MX record pointing to one of
8396 the local host's IP addresses other than 127.0.0.1.
8397
8398 The list of IP addresses is in fact processed by the same code that processes
8399 host lists, so it may contain CIDR-coded network specifications and it may also
8400 contain negative items.
8401
8402 Because the list of IP addresses is a sublist within a domain list, you have to
8403 be careful about delimiters if there is more than one address. Like any other
8404 list, the default delimiter can be changed. Thus, you might have:
8405 .code
8406 domains = @mx_any/ignore=<;127.0.0.1;0.0.0.0 : \
8407           an.other.domain : ...
8408 .endd
8409 so that the sublist uses semicolons for delimiters. When IPv6 addresses are
8410 involved, it is easiest to change the delimiter for the main list as well:
8411 .code
8412 domains = <? @mx_any/ignore=<;127.0.0.1;::1 ? \
8413           an.other.domain ? ...
8414 .endd
8415 .next
8416 .cindex "asterisk" "in domain list"
8417 .cindex "domain list" "asterisk in"
8418 .cindex "domain list" "matching &""ends with""&"
8419 If a pattern starts with an asterisk, the remaining characters of the pattern
8420 are compared with the terminating characters of the domain. The use of &"*"& in
8421 domain lists differs from its use in partial matching lookups. In a domain
8422 list, the character following the asterisk need not be a dot, whereas partial
8423 matching works only in terms of dot-separated components. For example, a domain
8424 list item such as &`*key.ex`& matches &'donkey.ex'& as well as
8425 &'cipher.key.ex'&.
8426
8427 .next
8428 .cindex "regular expressions" "in domain list"
8429 .cindex "domain list" "matching regular expression"
8430 If a pattern starts with a circumflex character, it is treated as a regular
8431 expression, and matched against the domain using a regular expression matching
8432 function. The circumflex is treated as part of the regular expression.
8433 Email domains are case-independent, so this regular expression match is by
8434 default case-independent, but you can make it case-dependent by starting it
8435 with &`(?-i)`&. References to descriptions of the syntax of regular expressions
8436 are given in chapter &<<CHAPregexp>>&.
8437
8438 &*Warning*&: Because domain lists are expanded before being processed, you
8439 must escape any backslash and dollar characters in the regular expression, or
8440 use the special &`\N`& sequence (see chapter &<<CHAPexpand>>&) to specify that
8441 it is not to be expanded (unless you really do want to build a regular
8442 expression by expansion, of course).
8443 .next
8444 .cindex "lookup" "in domain list"
8445 .cindex "domain list" "matching by lookup"
8446 If a pattern starts with the name of a single-key lookup type followed by a
8447 semicolon (for example, &"dbm;"& or &"lsearch;"&), the remainder of the pattern
8448 must be a filename in a suitable format for the lookup type. For example, for
8449 &"cdb;"& it must be an absolute path:
8450 .code
8451 domains = cdb;/etc/mail/local_domains.cdb
8452 .endd
8453 The appropriate type of lookup is done on the file using the domain name as the
8454 key. In most cases, the data that is looked up is not used; Exim is interested
8455 only in whether or not the key is present in the file. However, when a lookup
8456 is used for the &%domains%& option on a router
8457 or a &%domains%& condition in an ACL statement, the data is preserved in the
8458 &$domain_data$& variable and can be referred to in other router options or
8459 other statements in the same ACL.
8460
8461 .next
8462 Any of the single-key lookup type names may be preceded by
8463 &`partial`&<&'n'&>&`-`&, where the <&'n'&> is optional, for example,
8464 .code
8465 domains = partial-dbm;/partial/domains
8466 .endd
8467 This causes partial matching logic to be invoked; a description of how this
8468 works is given in section &<<SECTpartiallookup>>&.
8469
8470 .next
8471 .cindex "asterisk" "in lookup type"
8472 Any of the single-key lookup types may be followed by an asterisk. This causes
8473 a default lookup for a key consisting of a single asterisk to be done if the
8474 original lookup fails. This is not a useful feature when using a domain list to
8475 select particular domains (because any domain would match), but it might have
8476 value if the result of the lookup is being used via the &$domain_data$&
8477 expansion variable.
8478 .next
8479 If the pattern starts with the name of a query-style lookup type followed by a
8480 semicolon (for example, &"nisplus;"& or &"ldap;"&), the remainder of the
8481 pattern must be an appropriate query for the lookup type, as described in
8482 chapter &<<CHAPfdlookup>>&. For example:
8483 .code
8484 hold_domains = mysql;select domain from holdlist \
8485   where domain = '${quote_mysql:$domain}';
8486 .endd
8487 In most cases, the data that is looked up is not used (so for an SQL query, for
8488 example, it doesn't matter what field you select). Exim is interested only in
8489 whether or not the query succeeds. However, when a lookup is used for the
8490 &%domains%& option on a router, the data is preserved in the &$domain_data$&
8491 variable and can be referred to in other options.
8492 .next
8493 .cindex "domain list" "matching literal domain name"
8494 If none of the above cases apply, a caseless textual comparison is made
8495 between the pattern and the domain.
8496 .endlist
8497
8498 Here is an example that uses several different kinds of pattern:
8499 .code
8500 domainlist funny_domains = \
8501   @ : \
8502   lib.unseen.edu : \
8503   *.foundation.fict.example : \
8504   \N^[1-2]\d{3}\.fict\.example$\N : \
8505   partial-dbm;/opt/data/penguin/book : \
8506   nis;domains.byname : \
8507   nisplus;[name=$domain,status=local],domains.org_dir
8508 .endd
8509 There are obvious processing trade-offs among the various matching modes. Using
8510 an asterisk is faster than a regular expression, and listing a few names
8511 explicitly probably is too. The use of a file or database lookup is expensive,
8512 but may be the only option if hundreds of names are required. Because the
8513 patterns are tested in order, it makes sense to put the most commonly matched
8514 patterns earlier.
8515
8516
8517
8518 .section "Host lists" "SECThostlist"
8519 .cindex "host list" "patterns in"
8520 .cindex "list" "host list"
8521 Host lists are used to control what remote hosts are allowed to do. For
8522 example, some hosts may be allowed to use the local host as a relay, and some
8523 may be permitted to use the SMTP ETRN command. Hosts can be identified in
8524 two different ways, by name or by IP address. In a host list, some types of
8525 pattern are matched to a host name, and some are matched to an IP address.
8526 You need to be particularly careful with this when single-key lookups are
8527 involved, to ensure that the right value is being used as the key.
8528
8529
8530 .section "Special host list patterns" "SECID80"
8531 .cindex "empty item in hosts list"
8532 .cindex "host list" "empty string in"
8533 If a host list item is the empty string, it matches only when no remote host is
8534 involved. This is the case when a message is being received from a local
8535 process using SMTP on the standard input, that is, when a TCP/IP connection is
8536 not used.
8537
8538 .cindex "asterisk" "in host list"
8539 The special pattern &"*"& in a host list matches any host or no host. Neither
8540 the IP address nor the name is actually inspected.
8541
8542
8543
8544 .section "Host list patterns that match by IP address" "SECThoslispatip"
8545 .cindex "host list" "matching IP addresses"
8546 If an IPv4 host calls an IPv6 host and the call is accepted on an IPv6 socket,
8547 the incoming address actually appears in the IPv6 host as
8548 &`::ffff:`&<&'v4address'&>. When such an address is tested against a host
8549 list, it is converted into a traditional IPv4 address first. (Not all operating
8550 systems accept IPv4 calls on IPv6 sockets, as there have been some security
8551 concerns.)
8552
8553 The following types of pattern in a host list check the remote host by
8554 inspecting its IP address:
8555
8556 .ilist
8557 If the pattern is a plain domain name (not a regular expression, not starting
8558 with *, not a lookup of any kind), Exim calls the operating system function
8559 to find the associated IP address(es). Exim uses the newer
8560 &[getipnodebyname()]& function when available, otherwise &[gethostbyname()]&.
8561 This typically causes a forward DNS lookup of the name. The result is compared
8562 with the IP address of the subject host.
8563
8564 If there is a temporary problem (such as a DNS timeout) with the host name
8565 lookup, a temporary error occurs. For example, if the list is being used in an
8566 ACL condition, the ACL gives a &"defer"& response, usually leading to a
8567 temporary SMTP error code. If no IP address can be found for the host name,
8568 what happens is described in section &<<SECTbehipnot>>& below.
8569
8570 .next
8571 .cindex "@ in a host list"
8572 If the pattern is &"@"&, the primary host name is substituted and used as a
8573 domain name, as just described.
8574
8575 .next
8576 If the pattern is an IP address, it is matched against the IP address of the
8577 subject host. IPv4 addresses are given in the normal &"dotted-quad"& notation.
8578 IPv6 addresses can be given in colon-separated format, but the colons have to
8579 be doubled so as not to be taken as item separators when the default list
8580 separator is used. IPv6 addresses are recognized even when Exim is compiled
8581 without IPv6 support. This means that if they appear in a host list on an
8582 IPv4-only host, Exim will not treat them as host names. They are just addresses
8583 that can never match a client host.
8584
8585 .next
8586 .cindex "@[] in a host list"
8587 If the pattern is &"@[]"&, it matches the IP address of any IP interface on
8588 the local host. For example, if the local host is an IPv4 host with one
8589 interface address 10.45.23.56, these two ACL statements have the same effect:
8590 .code
8591 accept hosts = 127.0.0.1 : 10.45.23.56
8592 accept hosts = @[]
8593 .endd
8594 .next
8595 .cindex "CIDR notation"
8596 If the pattern is an IP address followed by a slash and a mask length (for
8597 example 10.11.42.0/24), it is matched against the IP address of the subject
8598 host under the given mask. This allows, an entire network of hosts to be
8599 included (or excluded) by a single item. The mask uses CIDR notation; it
8600 specifies the number of address bits that must match, starting from the most
8601 significant end of the address.
8602
8603 &*Note*&: The mask is &'not'& a count of addresses, nor is it the high number
8604 of a range of addresses. It is the number of bits in the network portion of the
8605 address. The above example specifies a 24-bit netmask, so it matches all 256
8606 addresses in the 10.11.42.0 network. An item such as
8607 .code
8608 192.168.23.236/31
8609 .endd
8610 matches just two addresses, 192.168.23.236 and 192.168.23.237. A mask value of
8611 32 for an IPv4 address is the same as no mask at all; just a single address
8612 matches.
8613
8614 Here is another example which shows an IPv4 and an IPv6 network:
8615 .code
8616 recipient_unqualified_hosts = 192.168.0.0/16: \
8617                               3ffe::ffff::836f::::/48
8618 .endd
8619 The doubling of list separator characters applies only when these items
8620 appear inline in a host list. It is not required when indirecting via a file.
8621 For example:
8622 .code
8623 recipient_unqualified_hosts = /opt/exim/unqualnets
8624 .endd
8625 could make use of a file containing
8626 .code
8627 172.16.0.0/12
8628 3ffe:ffff:836f::/48
8629 .endd
8630 to have exactly the same effect as the previous example. When listing IPv6
8631 addresses inline, it is usually more convenient to use the facility for
8632 changing separator characters. This list contains the same two networks:
8633 .code
8634 recipient_unqualified_hosts = <; 172.16.0.0/12; \
8635                                  3ffe:ffff:836f::/48
8636 .endd
8637 The separator is changed to semicolon by the leading &"<;"& at the start of the
8638 list.
8639 .endlist
8640
8641
8642
8643 .section "Host list patterns for single-key lookups by host address" &&&
8644          "SECThoslispatsikey"
8645 .cindex "host list" "lookup of IP address"
8646 When a host is to be identified by a single-key lookup of its complete IP
8647 address, the pattern takes this form:
8648 .display
8649 &`net-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8650 .endd
8651 For example:
8652 .code
8653 hosts_lookup = net-cdb;/hosts-by-ip.db
8654 .endd
8655 The text form of the IP address of the subject host is used as the lookup key.
8656 IPv6 addresses are converted to an unabbreviated form, using lower case
8657 letters, with dots as separators because colon is the key terminator in
8658 &(lsearch)& files. [Colons can in fact be used in keys in &(lsearch)& files by
8659 quoting the keys, but this is a facility that was added later.] The data
8660 returned by the lookup is not used.
8661
8662 .cindex "IP address" "masking"
8663 .cindex "host list" "masked IP address"
8664 Single-key lookups can also be performed using masked IP addresses, using
8665 patterns of this form:
8666 .display
8667 &`net<`&&'number'&&`>-<`&&'single-key-search-type'&&`>;<`&&'search-data'&&`>`&
8668 .endd
8669 For example:
8670 .code
8671 net24-dbm;/networks.db
8672 .endd
8673 The IP address of the subject host is masked using <&'number'&> as the mask
8674 length. A textual string is constructed from the masked value, followed by the
8675 mask, and this is used as the lookup key. For example, if the host's IP address
8676 is 192.168.34.6, the key that is looked up for the above example is
8677 &"192.168.34.0/24"&.
8678
8679 When an IPv6 address is converted to a string, dots are normally used instead
8680 of colons, so that keys in &(lsearch)& files need not contain colons (which
8681 terminate &(lsearch)& keys). This was implemented some time before the ability
8682 to quote keys was made available in &(lsearch)& files. However, the more
8683 recently implemented &(iplsearch)& files do require colons in IPv6 keys
8684 (notated using the quoting facility) so as to distinguish them from IPv4 keys.
8685 For this reason, when the lookup type is &(iplsearch)&, IPv6 addresses are
8686 converted using colons and not dots. In all cases, full, unabbreviated IPv6
8687 addresses are always used.
8688
8689 Ideally, it would be nice to tidy up this anomalous situation by changing to
8690 colons in all cases, given that quoting is now available for &(lsearch)&.
8691 However, this would be an incompatible change that might break some existing
8692 configurations.
8693
8694 &*Warning*&: Specifying &%net32-%& (for an IPv4 address) or &%net128-%& (for an
8695 IPv6 address) is not the same as specifying just &%net-%& without a number. In
8696 the former case the key strings include the mask value, whereas in the latter
8697 case the IP address is used on its own.
8698
8699
8700
8701 .section "Host list patterns that match by host name" "SECThoslispatnam"
8702 .cindex "host" "lookup failures"
8703 .cindex "unknown host name"
8704 .cindex "host list" "matching host name"
8705 There are several types of pattern that require Exim to know the name of the
8706 remote host. These are either wildcard patterns or lookups by name. (If a
8707 complete hostname is given without any wildcarding, it is used to find an IP
8708 address to match against, as described in section &<<SECThoslispatip>>&
8709 above.)
8710
8711 If the remote host name is not already known when Exim encounters one of these
8712 patterns, it has to be found from the IP address.
8713 Although many sites on the Internet are conscientious about maintaining reverse
8714 DNS data for their hosts, there are also many that do not do this.
8715 Consequently, a name cannot always be found, and this may lead to unwanted
8716 effects. Take care when configuring host lists with wildcarded name patterns.
8717 Consider what will happen if a name cannot be found.
8718
8719 Because of the problems of determining host names from IP addresses, matching
8720 against host names is not as common as matching against IP addresses.
8721
8722 By default, in order to find a host name, Exim first does a reverse DNS lookup;
8723 if no name is found in the DNS, the system function (&[gethostbyaddr()]& or
8724 &[getipnodebyaddr()]& if available) is tried. The order in which these lookups
8725 are done can be changed by setting the &%host_lookup_order%& option. For
8726 security, once Exim has found one or more names, it looks up the IP addresses
8727 for these names and compares them with the IP address that it started with.
8728 Only those names whose IP addresses match are accepted. Any other names are
8729 discarded. If no names are left, Exim behaves as if the host name cannot be
8730 found. In the most common case there is only one name and one IP address.
8731
8732 There are some options that control what happens if a host name cannot be
8733 found. These are described in section &<<SECTbehipnot>>& below.
8734
8735 .cindex "host" "alias for"
8736 .cindex "alias for host"
8737 As a result of aliasing, hosts may have more than one name. When processing any
8738 of the following types of pattern, all the host's names are checked:
8739
8740 .ilist
8741 .cindex "asterisk" "in host list"
8742 If a pattern starts with &"*"& the remainder of the item must match the end of
8743 the host name. For example, &`*.b.c`& matches all hosts whose names end in
8744 &'.b.c'&. This special simple form is provided because this is a very common
8745 requirement. Other kinds of wildcarding require the use of a regular
8746 expression.
8747 .next
8748 .cindex "regular expressions" "in host list"
8749 .cindex "host list" "regular expression in"
8750 If the item starts with &"^"& it is taken to be a regular expression which is
8751 matched against the host name. Host names are case-independent, so this regular
8752 expression match is by default case-independent, but you can make it
8753 case-dependent by starting it with &`(?-i)`&. References to descriptions of the
8754 syntax of regular expressions are given in chapter &<<CHAPregexp>>&. For
8755 example,
8756 .code
8757 ^(a|b)\.c\.d$
8758 .endd
8759 is a regular expression that matches either of the two hosts &'a.c.d'& or
8760 &'b.c.d'&. When a regular expression is used in a host list, you must take care
8761 that backslash and dollar characters are not misinterpreted as part of the
8762 string expansion. The simplest way to do this is to use &`\N`& to mark that
8763 part of the string as non-expandable. For example:
8764 .code
8765 sender_unqualified_hosts = \N^(a|b)\.c\.d$\N : ....
8766 .endd
8767 &*Warning*&: If you want to match a complete host name, you must include the
8768 &`$`& terminating metacharacter in the regular expression, as in the above
8769 example. Without it, a match at the start of the host name is all that is
8770 required.
8771 .endlist
8772
8773
8774
8775
8776 .section "Behaviour when an IP address or name cannot be found" "SECTbehipnot"
8777 .cindex "host" "lookup failures, permanent"
8778 While processing a host list, Exim may need to look up an IP address from a
8779 name (see section &<<SECThoslispatip>>&), or it may need to look up a host name
8780 from an IP address (see section &<<SECThoslispatnam>>&). In either case, the
8781 behaviour when it fails to find the information it is seeking is the same.
8782
8783 &*Note*&: This section applies to permanent lookup failures. It does &'not'&
8784 apply to temporary DNS errors, whose handling is described in the next section.
8785
8786 .cindex "&`+include_unknown`&"
8787 .cindex "&`+ignore_unknown`&"
8788 Exim parses a host list from left to right. If it encounters a permanent
8789 lookup failure in any item in the host list before it has found a match,
8790 Exim treats it as a failure and the default behavior is as if the host
8791 does not match the list. This may not always be what you want to happen.
8792 To change Exim's behaviour, the special items &`+include_unknown`& or
8793 &`+ignore_unknown`& may appear in the list (at top level &-- they are
8794 not recognized in an indirected file).
8795
8796 .ilist
8797 If any item that follows &`+include_unknown`& requires information that
8798 cannot found, Exim behaves as if the host does match the list. For example,
8799 .code
8800 host_reject_connection = +include_unknown:*.enemy.ex
8801 .endd
8802 rejects connections from any host whose name matches &`*.enemy.ex`&, and also
8803 any hosts whose name it cannot find.
8804
8805 .next
8806 If any item that follows &`+ignore_unknown`& requires information that cannot
8807 be found, Exim ignores that item and proceeds to the rest of the list. For
8808 example:
8809 .code
8810 accept hosts = +ignore_unknown : friend.example : \
8811                192.168.4.5
8812 .endd
8813 accepts from any host whose name is &'friend.example'& and from 192.168.4.5,
8814 whether or not its host name can be found. Without &`+ignore_unknown`&, if no
8815 name can be found for 192.168.4.5, it is rejected.
8816 .endlist
8817
8818 Both &`+include_unknown`& and &`+ignore_unknown`& may appear in the same
8819 list. The effect of each one lasts until the next, or until the end of the
8820 list.
8821
8822 .section "Mixing wildcarded host names and addresses in host lists" &&&
8823          "SECTmixwilhos"
8824 .cindex "host list" "mixing names and addresses in"
8825
8826 This section explains the host/ip processing logic with the same concepts
8827 as the previous section, but specifically addresses what happens when a
8828 wildcarded hostname is one of the items in the hostlist.
8829
8830 .ilist
8831 If you have name lookups or wildcarded host names and
8832 IP addresses in the same host list, you should normally put the IP
8833 addresses first. For example, in an ACL you could have:
8834 .code
8835 accept hosts = 10.9.8.7 : *.friend.example
8836 .endd
8837 The reason you normally would order it this way lies in the
8838 left-to-right way that Exim processes lists.  It can test IP addresses
8839 without doing any DNS lookups, but when it reaches an item that requires
8840 a host name, it fails if it cannot find a host name to compare with the
8841 pattern. If the above list is given in the opposite order, the
8842 &%accept%& statement fails for a host whose name cannot be found, even
8843 if its IP address is 10.9.8.7.
8844
8845 .next
8846 If you really do want to do the name check first, and still recognize the IP
8847 address, you can rewrite the ACL like this:
8848 .code
8849 accept hosts = *.friend.example
8850 accept hosts = 10.9.8.7
8851 .endd
8852 If the first &%accept%& fails, Exim goes on to try the second one. See chapter
8853 &<<CHAPACL>>& for details of ACLs. Alternatively, you can use
8854 &`+ignore_unknown`&, which was discussed in depth in the first example in
8855 this section.
8856 .endlist
8857
8858
8859 .section "Temporary DNS errors when looking up host information" &&&
8860          "SECTtemdnserr"
8861 .cindex "host" "lookup failures, temporary"
8862 .cindex "&`+include_defer`&"
8863 .cindex "&`+ignore_defer`&"
8864 A temporary DNS lookup failure normally causes a defer action (except when
8865 &%dns_again_means_nonexist%& converts it into a permanent error). However,
8866 host lists can include &`+ignore_defer`& and &`+include_defer`&, analogous to
8867 &`+ignore_unknown`& and &`+include_unknown`&, as described in the previous
8868 section. These options should be used with care, probably only in non-critical
8869 host lists such as whitelists.
8870
8871
8872
8873 .section "Host list patterns for single-key lookups by host name" &&&
8874          "SECThoslispatnamsk"
8875 .cindex "unknown host name"
8876 .cindex "host list" "matching host name"
8877 If a pattern is of the form
8878 .display
8879 <&'single-key-search-type'&>;<&'search-data'&>
8880 .endd
8881 for example
8882 .code
8883 dbm;/host/accept/list
8884 .endd
8885 a single-key lookup is performed, using the host name as its key. If the
8886 lookup succeeds, the host matches the item. The actual data that is looked up
8887 is not used.
8888
8889 &*Reminder*&: With this kind of pattern, you must have host &'names'& as
8890 keys in the file, not IP addresses. If you want to do lookups based on IP
8891 addresses, you must precede the search type with &"net-"& (see section
8892 &<<SECThoslispatsikey>>&). There is, however, no reason why you could not use
8893 two items in the same list, one doing an address lookup and one doing a name
8894 lookup, both using the same file.
8895
8896
8897
8898 .section "Host list patterns for query-style lookups" "SECID81"
8899 If a pattern is of the form
8900 .display
8901 <&'query-style-search-type'&>;<&'query'&>
8902 .endd
8903 the query is obeyed, and if it succeeds, the host matches the item. The actual
8904 data that is looked up is not used. The variables &$sender_host_address$& and
8905 &$sender_host_name$& can be used in the query. For example:
8906 .code
8907 hosts_lookup = pgsql;\
8908   select ip from hostlist where ip='$sender_host_address'
8909 .endd
8910 The value of &$sender_host_address$& for an IPv6 address contains colons. You
8911 can use the &%sg%& expansion item to change this if you need to. If you want to
8912 use masked IP addresses in database queries, you can use the &%mask%& expansion
8913 operator.
8914
8915 If the query contains a reference to &$sender_host_name$&, Exim automatically
8916 looks up the host name if it has not already done so. (See section
8917 &<<SECThoslispatnam>>& for comments on finding host names.)
8918
8919 Historical note: prior to release 4.30, Exim would always attempt to find a
8920 host name before running the query, unless the search type was preceded by
8921 &`net-`&. This is no longer the case. For backwards compatibility, &`net-`& is
8922 still recognized for query-style lookups, but its presence or absence has no
8923 effect. (Of course, for single-key lookups, &`net-`& &'is'& important.
8924 See section &<<SECThoslispatsikey>>&.)
8925
8926
8927
8928
8929
8930 .section "Address lists" "SECTaddresslist"
8931 .cindex "list" "address list"
8932 .cindex "address list" "empty item"
8933 .cindex "address list" "patterns"
8934 Address lists contain patterns that are matched against mail addresses. There
8935 is one special case to be considered: the sender address of a bounce message is
8936 always empty. You can test for this by providing an empty item in an address
8937 list. For example, you can set up a router to process bounce messages by
8938 using this option setting:
8939 .code
8940 senders = :
8941 .endd
8942 The presence of the colon creates an empty item. If you do not provide any
8943 data, the list is empty and matches nothing. The empty sender can also be
8944 detected by a regular expression that matches an empty string,
8945 and by a query-style lookup that succeeds when &$sender_address$& is empty.
8946
8947 Non-empty items in an address list can be straightforward email addresses. For
8948 example:
8949 .code
8950 senders = jbc@askone.example : hs@anacreon.example
8951 .endd
8952 A certain amount of wildcarding is permitted. If a pattern contains an @
8953 character, but is not a regular expression and does not begin with a
8954 semicolon-terminated lookup type (described below), the local part of the
8955 subject address is compared with the local part of the pattern, which may start
8956 with an asterisk. If the local parts match, the domain is checked in exactly
8957 the same way as for a pattern in a domain list. For example, the domain can be
8958 wildcarded, refer to a named list, or be a lookup:
8959 .code
8960 deny senders = *@*.spamming.site:\
8961                *@+hostile_domains:\
8962                bozo@partial-lsearch;/list/of/dodgy/sites:\
8963                *@dbm;/bad/domains.db
8964 .endd
8965 .cindex "local part" "starting with !"
8966 .cindex "address list" "local part starting with !"
8967 If a local part that begins with an exclamation mark is required, it has to be
8968 specified using a regular expression, because otherwise the exclamation mark is
8969 treated as a sign of negation, as is standard in lists.
8970
8971 If a non-empty pattern that is not a regular expression or a lookup does not
8972 contain an @ character, it is matched against the domain part of the subject
8973 address. The only two formats that are recognized this way are a literal
8974 domain, or a domain pattern that starts with *. In both these cases, the effect
8975 is the same as if &`*@`& preceded the pattern. For example:
8976 .code
8977 deny senders = enemy.domain : *.enemy.domain
8978 .endd
8979
8980 The following kinds of more complicated address list pattern can match any
8981 address, including the empty address that is characteristic of bounce message
8982 senders:
8983
8984 .ilist
8985 .cindex "regular expressions" "in address list"
8986 .cindex "address list" "regular expression in"
8987 If (after expansion) a pattern starts with &"^"&, a regular expression match is
8988 done against the complete address, with the pattern as the regular expression.
8989 You must take care that backslash and dollar characters are not misinterpreted
8990 as part of the string expansion. The simplest way to do this is to use &`\N`&
8991 to mark that part of the string as non-expandable. For example:
8992 .code
8993 deny senders = \N^.*this.*@example\.com$\N : \
8994                \N^\d{8}.+@spamhaus.example$\N : ...
8995 .endd
8996 The &`\N`& sequences are removed by the expansion, so these items do indeed
8997 start with &"^"& by the time they are being interpreted as address patterns.
8998
8999 .next
9000 .cindex "address list" "lookup for complete address"
9001 Complete addresses can be looked up by using a pattern that starts with a
9002 lookup type terminated by a semicolon, followed by the data for the lookup. For
9003 example:
9004 .code
9005 deny senders = cdb;/etc/blocked.senders : \
9006   mysql;select address from blocked where \
9007   address='${quote_mysql:$sender_address}'
9008 .endd
9009 Both query-style and single-key lookup types can be used. For a single-key
9010 lookup type, Exim uses the complete address as the key. However, empty keys are
9011 not supported for single-key lookups, so a match against the empty address
9012 always fails. This restriction does not apply to query-style lookups.
9013
9014 Partial matching for single-key lookups (section &<<SECTpartiallookup>>&)
9015 cannot be used, and is ignored if specified, with an entry being written to the
9016 panic log.
9017 .cindex "*@ with single-key lookup"
9018 However, you can configure lookup defaults, as described in section
9019 &<<SECTdefaultvaluelookups>>&, but this is useful only for the &"*@"& type of
9020 default. For example, with this lookup:
9021 .code
9022 accept senders = lsearch*@;/some/file
9023 .endd
9024 the file could contains lines like this:
9025 .code
9026 user1@domain1.example
9027 *@domain2.example
9028 .endd
9029 and for the sender address &'nimrod@jaeger.example'&, the sequence of keys
9030 that are tried is:
9031 .code
9032 nimrod@jaeger.example
9033 *@jaeger.example
9034 *
9035 .endd
9036 &*Warning 1*&: Do not include a line keyed by &"*"& in the file, because that
9037 would mean that every address matches, thus rendering the test useless.
9038
9039 &*Warning 2*&: Do not confuse these two kinds of item:
9040 .code
9041 deny recipients = dbm*@;/some/file
9042 deny recipients = *@dbm;/some/file
9043 .endd
9044 The first does a whole address lookup, with defaulting, as just described,
9045 because it starts with a lookup type. The second matches the local part and
9046 domain independently, as described in a bullet point below.
9047 .endlist
9048
9049
9050 The following kinds of address list pattern can match only non-empty addresses.
9051 If the subject address is empty, a match against any of these pattern types
9052 always fails.
9053
9054
9055 .ilist
9056 .cindex "@@ with single-key lookup"
9057 .cindex "address list" "@@ lookup type"
9058 .cindex "address list" "split local part and domain"
9059 If a pattern starts with &"@@"& followed by a single-key lookup item
9060 (for example, &`@@lsearch;/some/file`&), the address that is being checked is
9061 split into a local part and a domain. The domain is looked up in the file. If
9062 it is not found, there is no match. If it is found, the data that is looked up
9063 from the file is treated as a colon-separated list of local part patterns, each
9064 of which is matched against the subject local part in turn.
9065
9066 .cindex "asterisk" "in address list"
9067 The lookup may be a partial one, and/or one involving a search for a default
9068 keyed by &"*"& (see section &<<SECTdefaultvaluelookups>>&). The local part
9069 patterns that are looked up can be regular expressions or begin with &"*"&, or
9070 even be further lookups. They may also be independently negated. For example,
9071 with
9072 .code
9073 deny senders = @@dbm;/etc/reject-by-domain
9074 .endd
9075 the data from which the DBM file is built could contain lines like
9076 .code
9077 baddomain.com:  !postmaster : *
9078 .endd
9079 to reject all senders except &%postmaster%& from that domain.
9080
9081 .cindex "local part" "starting with !"
9082 If a local part that actually begins with an exclamation mark is required, it
9083 has to be specified using a regular expression. In &(lsearch)& files, an entry
9084 may be split over several lines by indenting the second and subsequent lines,
9085 but the separating colon must still be included at line breaks. White space
9086 surrounding the colons is ignored. For example:
9087 .code
9088 aol.com:  spammer1 : spammer2 : ^[0-9]+$ :
9089   spammer3 : spammer4
9090 .endd
9091 As in all colon-separated lists in Exim, a colon can be included in an item by
9092 doubling.
9093
9094 If the last item in the list starts with a right angle-bracket, the remainder
9095 of the item is taken as a new key to look up in order to obtain a continuation
9096 list of local parts. The new key can be any sequence of characters. Thus one
9097 might have entries like
9098 .code
9099 aol.com: spammer1 : spammer 2 : >*
9100 xyz.com: spammer3 : >*
9101 *:       ^\d{8}$
9102 .endd
9103 in a file that was searched with &%@@dbm*%&, to specify a match for 8-digit
9104 local parts for all domains, in addition to the specific local parts listed for
9105 each domain. Of course, using this feature costs another lookup each time a
9106 chain is followed, but the effort needed to maintain the data is reduced.
9107
9108 .cindex "loop" "in lookups"
9109 It is possible to construct loops using this facility, and in order to catch
9110 them, the chains may be no more than fifty items long.
9111
9112 .next
9113 The @@<&'lookup'&> style of item can also be used with a query-style
9114 lookup, but in this case, the chaining facility is not available. The lookup
9115 can only return a single list of local parts.
9116 .endlist
9117
9118 &*Warning*&: There is an important difference between the address list items
9119 in these two examples:
9120 .code
9121 senders = +my_list
9122 senders = *@+my_list
9123 .endd
9124 In the first one, &`my_list`& is a named address list, whereas in the second
9125 example it is a named domain list.
9126
9127
9128
9129
9130 .section "Case of letters in address lists" "SECTcasletadd"
9131 .cindex "case of local parts"
9132 .cindex "address list" "case forcing"
9133 .cindex "case forcing in address lists"
9134 Domains in email addresses are always handled caselessly, but for local parts
9135 case may be significant on some systems (see &%caseful_local_part%& for how
9136 Exim deals with this when routing addresses). However, RFC 2505 (&'Anti-Spam
9137 Recommendations for SMTP MTAs'&) suggests that matching of addresses to
9138 blocking lists should be done in a case-independent manner. Since most address
9139 lists in Exim are used for this kind of control, Exim attempts to do this by
9140 default.
9141
9142 The domain portion of an address is always lowercased before matching it to an
9143 address list. The local part is lowercased by default, and any string
9144 comparisons that take place are done caselessly. This means that the data in
9145 the address list itself, in files included as plain filenames, and in any file
9146 that is looked up using the &"@@"& mechanism, can be in any case. However, the
9147 keys in files that are looked up by a search type other than &(lsearch)& (which
9148 works caselessly) must be in lower case, because these lookups are not
9149 case-independent.
9150
9151 .cindex "&`+caseful`&"
9152 To allow for the possibility of caseful address list matching, if an item in
9153 an address list is the string &"+caseful"&, the original case of the local
9154 part is restored for any comparisons that follow, and string comparisons are no
9155 longer case-independent. This does not affect the domain, which remains in
9156 lower case. However, although independent matches on the domain alone are still
9157 performed caselessly, regular expressions that match against an entire address
9158 become case-sensitive after &"+caseful"& has been seen.
9159
9160
9161
9162 .section "Local part lists" "SECTlocparlis"
9163 .cindex "list" "local part list"
9164 .cindex "local part" "list"
9165 Case-sensitivity in local part lists is handled in the same way as for address
9166 lists, as just described. The &"+caseful"& item can be used if required. In a
9167 setting of the &%local_parts%& option in a router with &%caseful_local_part%&
9168 set false, the subject is lowercased and the matching is initially
9169 case-insensitive. In this case, &"+caseful"& will restore case-sensitive
9170 matching in the local part list, but not elsewhere in the router. If
9171 &%caseful_local_part%& is set true in a router, matching in the &%local_parts%&
9172 option is case-sensitive from the start.
9173
9174 If a local part list is indirected to a file (see section &<<SECTfilnamlis>>&),
9175 comments are handled in the same way as address lists &-- they are recognized
9176 only if the # is preceded by white space or the start of the line.
9177 Otherwise, local part lists are matched in the same way as domain lists, except
9178 that the special items that refer to the local host (&`@`&, &`@[]`&,
9179 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`&) are not recognized.
9180 Refer to section &<<SECTdomainlist>>& for details of the other available item
9181 types.
9182 .ecindex IIDdohoadli
9183
9184
9185
9186
9187 . ////////////////////////////////////////////////////////////////////////////
9188 . ////////////////////////////////////////////////////////////////////////////
9189
9190 .chapter "String expansions" "CHAPexpand"
9191 .scindex IIDstrexp "expansion" "of strings"
9192 Many strings in Exim's runtime configuration are expanded before use. Some of
9193 them are expanded every time they are used; others are expanded only once.
9194
9195 When a string is being expanded it is copied verbatim from left to right except
9196 when a dollar or backslash character is encountered. A dollar specifies the
9197 start of a portion of the string that is interpreted and replaced as described
9198 below in section &<<SECTexpansionitems>>& onwards. Backslash is used as an
9199 escape character, as described in the following section.
9200
9201 Whether a string is expanded depends upon the context.  Usually this is solely
9202 dependent upon the option for which a value is sought; in this documentation,
9203 options for which string expansion is performed are marked with &dagger; after
9204 the data type.  ACL rules always expand strings.  A couple of expansion
9205 conditions do not expand some of the brace-delimited branches, for security
9206 reasons.
9207
9208
9209
9210 .section "Literal text in expanded strings" "SECTlittext"
9211 .cindex "expansion" "including literal text"
9212 An uninterpreted dollar can be included in an expanded string by putting a
9213 backslash in front of it. A backslash can be used to prevent any special
9214 character being treated specially in an expansion, including backslash itself.
9215 If the string appears in quotes in the configuration file, two backslashes are
9216 required because the quotes themselves cause interpretation of backslashes when
9217 the string is read in (see section &<<SECTstrings>>&).
9218
9219 .cindex "expansion" "non-expandable substrings"
9220 A portion of the string can specified as non-expandable by placing it between
9221 two occurrences of &`\N`&. This is particularly useful for protecting regular
9222 expressions, which often contain backslashes and dollar signs. For example:
9223 .code
9224 deny senders = \N^\d{8}[a-z]@some\.site\.example$\N
9225 .endd
9226 On encountering the first &`\N`&, the expander copies subsequent characters
9227 without interpretation until it reaches the next &`\N`& or the end of the
9228 string.
9229
9230
9231
9232 .section "Character escape sequences in expanded strings" "SECID82"
9233 .cindex "expansion" "escape sequences"
9234 A backslash followed by one of the letters &"n"&, &"r"&, or &"t"& in an
9235 expanded string is recognized as an escape sequence for the character newline,
9236 carriage return, or tab, respectively. A backslash followed by up to three
9237 octal digits is recognized as an octal encoding for a single character, and a
9238 backslash followed by &"x"& and up to two hexadecimal digits is a hexadecimal
9239 encoding.
9240
9241 These escape sequences are also recognized in quoted strings when they are read
9242 in. Their interpretation in expansions as well is useful for unquoted strings,
9243 and for other cases such as looked-up strings that are then expanded.
9244
9245
9246 .section "Testing string expansions" "SECID83"
9247 .cindex "expansion" "testing"
9248 .cindex "testing" "string expansion"
9249 .oindex "&%-be%&"
9250 Many expansions can be tested by calling Exim with the &%-be%& option. This
9251 takes the command arguments, or lines from the standard input if there are no
9252 arguments, runs them through the string expansion code, and writes the results
9253 to the standard output. Variables based on configuration values are set up, but
9254 since no message is being processed, variables such as &$local_part$& have no
9255 value. Nevertheless the &%-be%& option can be useful for checking out file and
9256 database lookups, and the use of expansion operators such as &%sg%&, &%substr%&
9257 and &%nhash%&.
9258
9259 Exim gives up its root privilege when it is called with the &%-be%& option, and
9260 instead runs under the uid and gid it was called with, to prevent users from
9261 using &%-be%& for reading files to which they do not have access.
9262
9263 .oindex "&%-bem%&"
9264 If you want to test expansions that include variables whose values are taken
9265 from a message, there are two other options that can be used. The &%-bem%&
9266 option is like &%-be%& except that it is followed by a filename. The file is
9267 read as a message before doing the test expansions. For example:
9268 .code
9269 exim -bem /tmp/test.message '$h_subject:'
9270 .endd
9271 The &%-Mset%& option is used in conjunction with &%-be%& and is followed by an
9272 Exim message identifier. For example:
9273 .code
9274 exim -be -Mset 1GrA8W-0004WS-LQ '$recipients'
9275 .endd
9276 This loads the message from Exim's spool before doing the test expansions, and
9277 is therefore restricted to admin users.
9278
9279
9280 .section "Forced expansion failure" "SECTforexpfai"
9281 .cindex "expansion" "forced failure"
9282 A number of expansions that are described in the following section have
9283 alternative &"true"& and &"false"& substrings, enclosed in brace characters
9284 (which are sometimes called &"curly brackets"&). Which of the two strings is
9285 used depends on some condition that is evaluated as part of the expansion. If,
9286 instead of a &"false"& substring, the word &"fail"& is used (not in braces),
9287 the entire string expansion fails in a way that can be detected by the code
9288 that requested the expansion. This is called &"forced expansion failure"&, and
9289 its consequences depend on the circumstances. In some cases it is no different
9290 from any other expansion failure, but in others a different action may be
9291 taken. Such variations are mentioned in the documentation of the option that is
9292 being expanded.
9293
9294
9295
9296
9297 .section "Expansion items" "SECTexpansionitems"
9298 The following items are recognized in expanded strings. White space may be used
9299 between sub-items that are keywords or substrings enclosed in braces inside an
9300 outer set of braces, to improve readability. &*Warning*&: Within braces,
9301 white space is significant.
9302
9303 .vlist
9304 .vitem &*$*&<&'variable&~name'&>&~or&~&*${*&<&'variable&~name'&>&*}*&
9305 .cindex "expansion" "variables"
9306 Substitute the contents of the named variable, for example:
9307 .code
9308 $local_part
9309 ${domain}
9310 .endd
9311 The second form can be used to separate the name from subsequent alphanumeric
9312 characters. This form (using braces) is available only for variables; it does
9313 &'not'& apply to message headers. The names of the variables are given in
9314 section &<<SECTexpvar>>& below. If the name of a non-existent variable is
9315 given, the expansion fails.
9316
9317 .vitem &*${*&<&'op'&>&*:*&<&'string'&>&*}*&
9318 .cindex "expansion" "operators"
9319 The string is first itself expanded, and then the operation specified by
9320 <&'op'&> is applied to it. For example:
9321 .code
9322 ${lc:$local_part}
9323 .endd
9324 The string starts with the first character after the colon, which may be
9325 leading white space. A list of operators is given in section &<<SECTexpop>>&
9326 below. The operator notation is used for simple expansion items that have just
9327 one argument, because it reduces the number of braces and therefore makes the
9328 string easier to understand.
9329
9330 .vitem &*$bheader_*&<&'header&~name'&>&*:*&&~or&~&*$bh_*&<&'header&~name'&>&*:*&
9331 This item inserts &"basic"& header lines. It is described with the &%header%&
9332 expansion item below.
9333
9334
9335 .vitem "&*${acl{*&<&'name'&>&*}{*&<&'arg'&>&*}...}*&"
9336 .cindex "expansion" "calling an acl"
9337 .cindex "&%acl%&" "call from expansion"
9338 The name and zero to nine argument strings are first expanded separately.  The expanded
9339 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
9340 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
9341 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
9342 and may use the variables; if another acl expansion is used the values
9343 are restored after it returns.  If the ACL sets
9344 a value using a "message =" modifier and returns accept or deny, the value becomes
9345 the result of the expansion.
9346 If no message is set and the ACL returns accept or deny
9347 the expansion result is an empty string.
9348 If the ACL returns defer the result is a forced-fail.  Otherwise the expansion fails.
9349
9350
9351 .vitem "&*${authresults{*&<&'authserv-id'&>&*}}*&"
9352 .cindex authentication "results header"
9353 .cindex headers "authentication-results:"
9354 .cindex authentication "expansion item"
9355 This item returns a string suitable for insertion as an
9356 &'Authentication-Results"'&
9357 header line.
9358 The given <&'authserv-id'&> is included in the result; typically this
9359 will be a domain name identifying the system performing the authentications.
9360 Methods that might be present in the result include:
9361 .code
9362 none
9363 iprev
9364 auth
9365 spf
9366 dkim
9367 .endd
9368
9369 Example use (as an ACL modifier):
9370 .code
9371       add_header = :at_start:${authresults {$primary_hostname}}
9372 .endd
9373 This is safe even if no authentication results are available.
9374
9375
9376 .vitem "&*${certextract{*&<&'field'&>&*}{*&<&'certificate'&>&*}&&&
9377        {*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9378 .cindex "expansion" "extracting certificate fields"
9379 .cindex "&%certextract%&" "certificate fields"
9380 .cindex "certificate" "extracting fields"
9381 The <&'certificate'&> must be a variable of type certificate.
9382 The field name is expanded and used to retrieve the relevant field from
9383 the certificate.  Supported fields are:
9384 .display
9385 &`version        `&
9386 &`serial_number  `&
9387 &`subject        `& RFC4514 DN
9388 &`issuer         `& RFC4514 DN
9389 &`notbefore      `& time
9390 &`notafter       `& time
9391 &`sig_algorithm  `&
9392 &`signature      `&
9393 &`subj_altname   `& tagged list
9394 &`ocsp_uri       `& list
9395 &`crl_uri        `& list
9396 .endd
9397 If the field is found,
9398 <&'string2'&> is expanded, and replaces the whole item;
9399 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9400 variable &$value$& contains the value that has been extracted. Afterwards, it
9401 is restored to any previous value it might have had.
9402
9403 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9404 key is not found. If {<&'string2'&>} is also omitted, the value that was
9405 extracted is used.
9406
9407 Some field names take optional modifiers, appended and separated by commas.
9408
9409 The field selectors marked as "RFC4514" above
9410 output a Distinguished Name string which is
9411 not quite
9412 parseable by Exim as a comma-separated tagged list
9413 (the exceptions being elements containing commas).
9414 RDN elements of a single type may be selected by
9415 a modifier of the type label; if so the expansion
9416 result is a list (newline-separated by default).
9417 The separator may be changed by another modifier of
9418 a right angle-bracket followed immediately by the new separator.
9419 Recognised RDN type labels include "CN", "O", "OU" and "DC".
9420
9421 The field selectors marked as "time" above
9422 take an optional modifier of "int"
9423 for which the result is the number of seconds since epoch.
9424 Otherwise the result is a human-readable string
9425 in the timezone selected by the main "timezone" option.
9426
9427 The field selectors marked as "list" above return a list,
9428 newline-separated by default,
9429 (embedded separator characters in elements are doubled).
9430 The separator may be changed by a modifier of
9431 a right angle-bracket followed immediately by the new separator.
9432
9433 The field selectors marked as "tagged" above
9434 prefix each list element with a type string and an equals sign.
9435 Elements of only one type may be selected by a modifier
9436 which is one of "dns", "uri" or "mail";
9437 if so the element tags are omitted.
9438
9439 If not otherwise noted field values are presented in human-readable form.
9440
9441 .vitem "&*${dlfunc{*&<&'file'&>&*}{*&<&'function'&>&*}{*&<&'arg'&>&*}&&&
9442        {*&<&'arg'&>&*}...}*&"
9443 .cindex &%dlfunc%&
9444 This expansion dynamically loads and then calls a locally-written C function.
9445 This functionality is available only if Exim is compiled with
9446 .code
9447 EXPAND_DLFUNC=yes
9448 .endd
9449 set in &_Local/Makefile_&. Once loaded, Exim remembers the dynamically loaded
9450 object so that it doesn't reload the same object file in the same Exim process
9451 (but of course Exim does start new processes frequently).
9452
9453 There may be from zero to eight arguments to the function. When compiling
9454 a local function that is to be called in this way, &_local_scan.h_& should be
9455 included. The Exim variables and functions that are defined by that API
9456 are also available for dynamically loaded functions. The function itself
9457 must have the following type:
9458 .code
9459 int dlfunction(uschar **yield, int argc, uschar *argv[])
9460 .endd
9461 Where &`uschar`& is a typedef for &`unsigned char`& in &_local_scan.h_&. The
9462 function should return one of the following values:
9463
9464 &`OK`&: Success. The string that is placed in the variable &'yield'& is put
9465 into the expanded string that is being built.
9466
9467 &`FAIL`&: A non-forced expansion failure occurs, with the error message taken
9468 from &'yield'&, if it is set.
9469
9470 &`FAIL_FORCED`&: A forced expansion failure occurs, with the error message
9471 taken from &'yield'& if it is set.
9472
9473 &`ERROR`&: Same as &`FAIL`&, except that a panic log entry is written.
9474
9475 When compiling a function that is to be used in this way with gcc,
9476 you need to add &%-shared%& to the gcc command. Also, in the Exim build-time
9477 configuration, you must add &%-export-dynamic%& to EXTRALIBS.
9478
9479
9480 .vitem "&*${env{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&"
9481 .cindex "expansion" "extracting value from environment"
9482 .cindex "environment" "values from"
9483 The key is first expanded separately, and leading and trailing white space
9484 removed.
9485 This is then searched for as a name in the environment.
9486 If a variable is found then its value is placed in &$value$&
9487 and <&'string1'&> is expanded, otherwise <&'string2'&> is expanded.
9488
9489 Instead of {<&'string2'&>} the word &"fail"& (not in curly brackets) can
9490 appear, for example:
9491 .code
9492 ${env{USER}{$value} fail }
9493 .endd
9494 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9495 {<&'string1'&>} must be present for &"fail"& to be recognized.
9496
9497 If {<&'string2'&>} is omitted an empty string is substituted on
9498 search failure.
9499 If {<&'string1'&>} is omitted the search result is substituted on
9500 search success.
9501
9502 The environment is adjusted by the &%keep_environment%& and
9503 &%add_environment%& main section options.
9504
9505
9506 .vitem "&*${extract{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9507        {*&<&'string3'&>&*}}*&"
9508 .cindex "expansion" "extracting substrings by key"
9509 .cindex "&%extract%&" "substrings by key"
9510 The key and <&'string1'&> are first expanded separately. Leading and trailing
9511 white space is removed from the key (but not from any of the strings). The key
9512 must not be empty and must not consist entirely of digits.
9513 The expanded <&'string1'&> must be of the form:
9514 .display
9515 <&'key1'&> = <&'value1'&>  <&'key2'&> = <&'value2'&> ...
9516 .endd
9517 .vindex "&$value$&"
9518 where the equals signs and spaces (but not both) are optional. If any of the
9519 values contain white space, they must be enclosed in double quotes, and any
9520 values that are enclosed in double quotes are subject to escape processing as
9521 described in section &<<SECTstrings>>&. The expanded <&'string1'&> is searched
9522 for the value that corresponds to the key. The search is case-insensitive. If
9523 the key is found, <&'string2'&> is expanded, and replaces the whole item;
9524 otherwise <&'string3'&> is used. During the expansion of <&'string2'&> the
9525 variable &$value$& contains the value that has been extracted. Afterwards, it
9526 is restored to any previous value it might have had.
9527
9528 If {<&'string3'&>} is omitted, the item is replaced by an empty string if the
9529 key is not found. If {<&'string2'&>} is also omitted, the value that was
9530 extracted is used. Thus, for example, these two expansions are identical, and
9531 yield &"2001"&:
9532 .code
9533 ${extract{gid}{uid=1984 gid=2001}}
9534 ${extract{gid}{uid=1984 gid=2001}{$value}}
9535 .endd
9536 Instead of {<&'string3'&>} the word &"fail"& (not in curly brackets) can
9537 appear, for example:
9538 .code
9539 ${extract{Z}{A=... B=...}{$value} fail }
9540 .endd
9541 This forces an expansion failure (see section &<<SECTforexpfai>>&);
9542 {<&'string2'&>} must be present for &"fail"& to be recognized.
9543
9544 .vitem "&*${extract json{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9545        {*&<&'string3'&>&*}}*&" &&&
9546        "&*${extract jsons{*&<&'key'&>&*}{*&<&'string1'&>&*}{*&<&'string2'&>&*}&&&
9547        {*&<&'string3'&>&*}}*&"
9548 .cindex "expansion" "extracting from JSON object"
9549 .cindex JSON expansions
9550 The key and <&'string1'&> are first expanded separately. Leading and trailing
9551 white space is removed from the key (but not from any of the strings). The key
9552 must not be empty and must not consist entirely of digits.
9553 The expanded <&'string1'&> must be of the form:
9554 .display
9555 { <&'"key1"'&> : <&'value1'&> ,  <&'"key2"'&> , <&'value2'&> ... }
9556 .endd
9557 .vindex "&$value$&"
9558 The braces, commas and colons, and the quoting of the member name are required;
9559 the spaces are optional.
9560 Matching of the key against the member names is done case-sensitively.
9561 For the &"json"& variant,
9562 if a returned value is a JSON string, it retains its leading and
9563 trailing quotes.
9564 .new
9565 For the &"jsons"& variant, which is intended for use with JSON strings, the
9566 leading and trailing quotes are removed from the returned value.
9567 .wen
9568 . XXX should be a UTF-8 compare
9569
9570 The results of matching are handled as above.
9571
9572
9573 .vitem "&*${extract{*&<&'number'&>&*}{*&<&'separators'&>&*}&&&
9574         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9575 .cindex "expansion" "extracting substrings by number"
9576 .cindex "&%extract%&" "substrings by number"
9577 The <&'number'&> argument must consist entirely of decimal digits,
9578 apart from leading and trailing white space, which is ignored.
9579 This is what distinguishes this form of &%extract%& from the previous kind. It
9580 behaves in the same way, except that, instead of extracting a named field, it
9581 extracts from <&'string1'&> the field whose number is given as the first
9582 argument. You can use &$value$& in <&'string2'&> or &`fail`& instead of
9583 <&'string3'&> as before.
9584
9585 The fields in the string are separated by any one of the characters in the
9586 separator string. These may include space or tab characters.
9587 The first field is numbered one. If the number is negative, the fields are
9588 counted from the end of the string, with the rightmost one numbered -1. If the
9589 number given is zero, the entire string is returned. If the modulus of the
9590 number is greater than the number of fields in the string, the result is the
9591 expansion of <&'string3'&>, or the empty string if <&'string3'&> is not
9592 provided. For example:
9593 .code
9594 ${extract{2}{:}{x:42:99:& Mailer::/bin/bash}}
9595 .endd
9596 yields &"42"&, and
9597 .code
9598 ${extract{-4}{:}{x:42:99:& Mailer::/bin/bash}}
9599 .endd
9600 yields &"99"&. Two successive separators mean that the field between them is
9601 empty (for example, the fifth field above).
9602
9603
9604 .vitem "&*${extract json {*&<&'number'&>&*}}&&&
9605         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&" &&&
9606        "&*${extract jsons{*&<&'number'&>&*}}&&&
9607         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9608 .cindex "expansion" "extracting from JSON array"
9609 .cindex JSON expansions
9610 The <&'number'&> argument must consist entirely of decimal digits,
9611 apart from leading and trailing white space, which is ignored.
9612
9613 Field selection and result handling is as above;
9614 there is no choice of field separator.
9615 For the &"json"& variant,
9616 if a returned value is a JSON string, it retains its leading and
9617 trailing quotes.
9618 .new
9619 For the &"jsons"& variant, which is intended for use with JSON strings, the
9620 leading and trailing quotes are removed from the returned value.
9621 .wen
9622
9623
9624 .vitem &*${filter{*&<&'string'&>&*}{*&<&'condition'&>&*}}*&
9625 .cindex "list" "selecting by condition"
9626 .cindex "expansion" "selecting from list by condition"
9627 .vindex "&$item$&"
9628 After expansion, <&'string'&> is interpreted as a list, colon-separated by
9629 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9630 For each item
9631 in this list, its value is place in &$item$&, and then the condition is
9632 evaluated. If the condition is true, &$item$& is added to the output as an
9633 item in a new list; if the condition is false, the item is discarded. The
9634 separator used for the output list is the same as the one used for the
9635 input, but a separator setting is not included in the output. For example:
9636 .code
9637 ${filter{a:b:c}{!eq{$item}{b}}}
9638 .endd
9639 yields &`a:c`&. At the end of the expansion, the value of &$item$& is restored
9640 to what it was before. See also the &*map*& and &*reduce*& expansion items.
9641
9642
9643 .vitem &*${hash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9644 .cindex "hash function" "textual"
9645 .cindex "expansion" "textual hash"
9646 This is a textual hashing function, and was the first to be implemented in
9647 early versions of Exim. In current releases, there are other hashing functions
9648 (numeric, MD5, and SHA-1), which are described below.
9649
9650 The first two strings, after expansion, must be numbers. Call them <&'m'&> and
9651 <&'n'&>. If you are using fixed values for these numbers, that is, if
9652 <&'string1'&> and <&'string2'&> do not change when they are expanded, you can
9653 use the simpler operator notation that avoids some of the braces:
9654 .code
9655 ${hash_<n>_<m>:<string>}
9656 .endd
9657 The second number is optional (in both notations). If <&'n'&> is greater than
9658 or equal to the length of the string, the expansion item returns the string.
9659 Otherwise it computes a new string of length <&'n'&> by applying a hashing
9660 function to the string. The new string consists of characters taken from the
9661 first <&'m'&> characters of the string
9662 .code
9663 abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQWRSTUVWXYZ0123456789
9664 .endd
9665 If <&'m'&> is not present the value 26 is used, so that only lower case
9666 letters appear. For example:
9667 .display
9668 &`$hash{3}{monty}}           `&   yields  &`jmg`&
9669 &`$hash{5}{monty}}           `&   yields  &`monty`&
9670 &`$hash{4}{62}{monty python}}`&   yields  &`fbWx`&
9671 .endd
9672
9673 .vitem "&*$header_*&<&'header&~name'&>&*:*&&~or&~&&&
9674         &*$h_*&<&'header&~name'&>&*:*&" &&&
9675        "&*$bheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9676         &*$bh_*&<&'header&~name'&>&*:*&" &&&
9677        "&*$lheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9678         &*$lh_*&<&'header&~name'&>&*:*&"
9679        "&*$rheader_*&<&'header&~name'&>&*:*&&~or&~&&&
9680         &*$rh_*&<&'header&~name'&>&*:*&"
9681 .cindex "expansion" "header insertion"
9682 .vindex "&$header_$&"
9683 .vindex "&$bheader_$&"
9684 .vindex "&$lheader_$&"
9685 .vindex "&$rheader_$&"
9686 .cindex "header lines" "in expansion strings"
9687 .cindex "header lines" "character sets"
9688 .cindex "header lines" "decoding"
9689 Substitute the contents of the named message header line, for example
9690 .code
9691 $header_reply-to:
9692 .endd
9693 The newline that terminates a header line is not included in the expansion, but
9694 internal newlines (caused by splitting the header line over several physical
9695 lines) may be present.
9696
9697 The difference between the four pairs of expansions is in the way
9698 the data in the header line is interpreted.
9699
9700 .ilist
9701 .cindex "white space" "in header lines"
9702 &%rheader%& gives the original &"raw"& content of the header line, with no
9703 processing at all, and without the removal of leading and trailing white space.
9704
9705 .next
9706 .cindex "list" "of header lines"
9707 &%lheader%& gives a colon-separated list, one element per header when there
9708 are multiple headers with a given name.
9709 Any embedded colon characters within an element are doubled, so normal Exim
9710 list-processing facilities can be used.
9711 The terminating newline of each element is removed; in other respects
9712 the content is &"raw"&.
9713
9714 .next
9715 .cindex "base64 encoding" "in header lines"
9716 &%bheader%& removes leading and trailing white space, and then decodes base64
9717 or quoted-printable MIME &"words"& within the header text, but does no
9718 character set translation. If decoding of what looks superficially like a MIME
9719 &"word"& fails, the raw string is returned. If decoding
9720 .cindex "binary zero" "in header line"
9721 produces a binary zero character, it is replaced by a question mark &-- this is
9722 what Exim does for binary zeros that are actually received in header lines.
9723
9724 .next
9725 &%header%& tries to translate the string as decoded by &%bheader%& to a
9726 standard character set. This is an attempt to produce the same string as would
9727 be displayed on a user's MUA. If translation fails, the &%bheader%& string is
9728 returned. Translation is attempted only on operating systems that support the
9729 &[iconv()]& function. This is indicated by the compile-time macro HAVE_ICONV in
9730 a system Makefile or in &_Local/Makefile_&.
9731 .endlist ilist
9732
9733 In a filter file, the target character set for &%header%& can be specified by a
9734 command of the following form:
9735 .code
9736 headers charset "UTF-8"
9737 .endd
9738 This command affects all references to &$h_$& (or &$header_$&) expansions in
9739 subsequently obeyed filter commands. In the absence of this command, the target
9740 character set in a filter is taken from the setting of the &%headers_charset%&
9741 option in the runtime configuration. The value of this option defaults to the
9742 value of HEADERS_CHARSET in &_Local/Makefile_&. The ultimate default is
9743 ISO-8859-1.
9744
9745 Header names follow the syntax of RFC 2822, which states that they may contain
9746 any printing characters except space and colon. Consequently, curly brackets
9747 &'do not'& terminate header names, and should not be used to enclose them as
9748 if they were variables. Attempting to do so causes a syntax error.
9749
9750 Only header lines that are common to all copies of a message are visible to
9751 this mechanism. These are the original header lines that are received with the
9752 message, and any that are added by an ACL statement or by a system
9753 filter. Header lines that are added to a particular copy of a message by a
9754 router or transport are not accessible.
9755
9756 For incoming SMTP messages, no header lines are visible in
9757 ACLs that are obeyed before the data phase completes,
9758 because the header structure is not set up until the message is received.
9759 They are visible in DKIM, PRDR and DATA ACLs.
9760 Header lines that are added in a RCPT ACL (for example)
9761 are saved until the message's incoming header lines are available, at which
9762 point they are added.
9763 When any of the above ACLs ar
9764 running, however, header lines added by earlier ACLs are visible.
9765
9766 Upper case and lower case letters are synonymous in header names. If the
9767 following character is white space, the terminating colon may be omitted, but
9768 this is not recommended, because you may then forget it when it is needed. When
9769 white space terminates the header name, this white space is included in the
9770 expanded string.  If the message does not contain the given header, the
9771 expansion item is replaced by an empty string. (See the &%def%& condition in
9772 section &<<SECTexpcond>>& for a means of testing for the existence of a
9773 header.)
9774
9775 If there is more than one header with the same name, they are all concatenated
9776 to form the substitution string, up to a maximum length of 64K. Unless
9777 &%rheader%& is being used, leading and trailing white space is removed from
9778 each header before concatenation, and a completely empty header is ignored. A
9779 newline character is then inserted between non-empty headers, but there is no
9780 newline at the very end. For the &%header%& and &%bheader%& expansion, for
9781 those headers that contain lists of addresses, a comma is also inserted at the
9782 junctions between headers. This does not happen for the &%rheader%& expansion.
9783
9784
9785 .vitem &*${hmac{*&<&'hashname'&>&*}{*&<&'secret'&>&*}{*&<&'string'&>&*}}*&
9786 .cindex "expansion" "hmac hashing"
9787 .cindex &%hmac%&
9788 This function uses cryptographic hashing (either MD5 or SHA-1) to convert a
9789 shared secret and some text into a message authentication code, as specified in
9790 RFC 2104. This differs from &`${md5:secret_text...}`& or
9791 &`${sha1:secret_text...}`& in that the hmac step adds a signature to the
9792 cryptographic hash, allowing for authentication that is not possible with MD5
9793 or SHA-1 alone. The hash name must expand to either &`md5`& or &`sha1`& at
9794 present. For example:
9795 .code
9796 ${hmac{md5}{somesecret}{$primary_hostname $tod_log}}
9797 .endd
9798 For the hostname &'mail.example.com'& and time 2002-10-17 11:30:59, this
9799 produces:
9800 .code
9801 dd97e3ba5d1a61b5006108f8c8252953
9802 .endd
9803 As an example of how this might be used, you might put in the main part of
9804 an Exim configuration:
9805 .code
9806 SPAMSCAN_SECRET=cohgheeLei2thahw
9807 .endd
9808 In a router or a transport you could then have:
9809 .code
9810 headers_add = \
9811   X-Spam-Scanned: ${primary_hostname} ${message_exim_id} \
9812   ${hmac{md5}{SPAMSCAN_SECRET}\
9813   {${primary_hostname},${message_exim_id},$h_message-id:}}
9814 .endd
9815 Then given a message, you can check where it was scanned by looking at the
9816 &'X-Spam-Scanned:'& header line. If you know the secret, you can check that
9817 this header line is authentic by recomputing the authentication code from the
9818 host name, message ID and the &'Message-id:'& header line. This can be done
9819 using Exim's &%-be%& option, or by other means, for example, by using the
9820 &'hmac_md5_hex()'& function in Perl.
9821
9822
9823 .vitem &*${if&~*&<&'condition'&>&*&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9824 .cindex "expansion" "conditional"
9825 .cindex "&%if%&, expansion item"
9826 If <&'condition'&> is true, <&'string1'&> is expanded and replaces the whole
9827 item; otherwise <&'string2'&> is used. The available conditions are described
9828 in section &<<SECTexpcond>>& below. For example:
9829 .code
9830 ${if eq {$local_part}{postmaster} {yes}{no} }
9831 .endd
9832 The second string need not be present; if it is not and the condition is not
9833 true, the item is replaced with nothing. Alternatively, the word &"fail"& may
9834 be present instead of the second string (without any curly brackets). In this
9835 case, the expansion is forced to fail if the condition is not true (see section
9836 &<<SECTforexpfai>>&).
9837
9838 If both strings are omitted, the result is the string &`true`& if the condition
9839 is true, and the empty string if the condition is false. This makes it less
9840 cumbersome to write custom ACL and router conditions. For example, instead of
9841 .code
9842 condition = ${if >{$acl_m4}{3}{true}{false}}
9843 .endd
9844 you can use
9845 .code
9846 condition = ${if >{$acl_m4}{3}}
9847 .endd
9848
9849
9850
9851 .vitem &*${imapfolder{*&<&'foldername'&>&*}}*&
9852 .cindex expansion "imap folder"
9853 .cindex "&%imapfolder%& expansion item"
9854 This item converts a (possibly multilevel, or with non-ASCII characters)
9855 folder specification to a Maildir name for filesystem use.
9856 For information on internationalisation support see &<<SECTi18nMDA>>&.
9857
9858
9859
9860 .vitem &*${length{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9861 .cindex "expansion" "string truncation"
9862 .cindex "&%length%& expansion item"
9863 The &%length%& item is used to extract the initial portion of a string. Both
9864 strings are expanded, and the first one must yield a number, <&'n'&>, say. If
9865 you are using a fixed value for the number, that is, if <&'string1'&> does not
9866 change when expanded, you can use the simpler operator notation that avoids
9867 some of the braces:
9868 .code
9869 ${length_<n>:<string>}
9870 .endd
9871 The result of this item is either the first <&'n'&> bytes or the whole
9872 of <&'string2'&>, whichever is the shorter. Do not confuse &%length%& with
9873 &%strlen%&, which gives the length of a string.
9874 All measurement is done in bytes and is not UTF-8 aware.
9875
9876
9877 .vitem "&*${listextract{*&<&'number'&>&*}&&&
9878         {*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&"
9879 .cindex "expansion" "extracting list elements by number"
9880 .cindex "&%listextract%&" "extract list elements by number"
9881 .cindex "list" "extracting elements by number"
9882 The <&'number'&> argument must consist entirely of decimal digits,
9883 apart from an optional leading minus,
9884 and leading and trailing white space (which is ignored).
9885
9886 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9887 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9888
9889 The first field of the list is numbered one.
9890 If the number is negative, the fields are
9891 counted from the end of the list, with the rightmost one numbered -1.
9892 The numbered element of the list is extracted and placed in &$value$&,
9893 then <&'string2'&> is expanded as the result.
9894
9895 If the modulus of the
9896 number is zero or greater than the number of fields in the string,
9897 the result is the expansion of <&'string3'&>.
9898
9899 For example:
9900 .code
9901 ${listextract{2}{x:42:99}}
9902 .endd
9903 yields &"42"&, and
9904 .code
9905 ${listextract{-3}{<, x,42,99,& Mailer,,/bin/bash}{result: $value}}
9906 .endd
9907 yields &"result: 42"&.
9908
9909 If {<&'string3'&>} is omitted, an empty string is used for string3.
9910 If {<&'string2'&>} is also omitted, the value that was
9911 extracted is used.
9912 You can use &`fail`& instead of {<&'string3'&>} as in a string extract.
9913
9914
9915 .vitem "&*${lookup{*&<&'key'&>&*}&~*&<&'search&~type'&>&*&~&&&
9916         {*&<&'file'&>&*}&~{*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9917 This is the first of one of two different types of lookup item, which are both
9918 described in the next item.
9919
9920 .vitem "&*${lookup&~*&<&'search&~type'&>&*&~{*&<&'query'&>&*}&~&&&
9921         {*&<&'string1'&>&*}&~{*&<&'string2'&>&*}}*&"
9922 .cindex "expansion" "lookup in"
9923 .cindex "file" "lookups"
9924 .cindex "lookup" "in expanded string"
9925 The two forms of lookup item specify data lookups in files and databases, as
9926 discussed in chapter &<<CHAPfdlookup>>&. The first form is used for single-key
9927 lookups, and the second is used for query-style lookups. The <&'key'&>,
9928 <&'file'&>, and <&'query'&> strings are expanded before use.
9929
9930 If there is any white space in a lookup item which is part of a filter command,
9931 a retry or rewrite rule, a routing rule for the &(manualroute)& router, or any
9932 other place where white space is significant, the lookup item must be enclosed
9933 in double quotes. The use of data lookups in users' filter files may be locked
9934 out by the system administrator.
9935
9936 .vindex "&$value$&"
9937 If the lookup succeeds, <&'string1'&> is expanded and replaces the entire item.
9938 During its expansion, the variable &$value$& contains the data returned by the
9939 lookup. Afterwards it reverts to the value it had previously (at the outer
9940 level it is empty). If the lookup fails, <&'string2'&> is expanded and replaces
9941 the entire item. If {<&'string2'&>} is omitted, the replacement is the empty
9942 string on failure. If <&'string2'&> is provided, it can itself be a nested
9943 lookup, thus providing a mechanism for looking up a default value when the
9944 original lookup fails.
9945
9946 If a nested lookup is used as part of <&'string1'&>, &$value$& contains the
9947 data for the outer lookup while the parameters of the second lookup are
9948 expanded, and also while <&'string2'&> of the second lookup is expanded, should
9949 the second lookup fail. Instead of {<&'string2'&>} the word &"fail"& can
9950 appear, and in this case, if the lookup fails, the entire expansion is forced
9951 to fail (see section &<<SECTforexpfai>>&). If both {<&'string1'&>} and
9952 {<&'string2'&>} are omitted, the result is the looked up value in the case of a
9953 successful lookup, and nothing in the case of failure.
9954
9955 For single-key lookups, the string &"partial"& is permitted to precede the
9956 search type in order to do partial matching, and * or *@ may follow a search
9957 type to request default lookups if the key does not match (see sections
9958 &<<SECTdefaultvaluelookups>>& and &<<SECTpartiallookup>>& for details).
9959
9960 .cindex "numerical variables (&$1$& &$2$& etc)" "in lookup expansion"
9961 If a partial search is used, the variables &$1$& and &$2$& contain the wild
9962 and non-wild parts of the key during the expansion of the replacement text.
9963 They return to their previous values at the end of the lookup item.
9964
9965 This example looks up the postmaster alias in the conventional alias file:
9966 .code
9967 ${lookup {postmaster} lsearch {/etc/aliases} {$value}}
9968 .endd
9969 This example uses NIS+ to look up the full name of the user corresponding to
9970 the local part of an address, forcing the expansion to fail if it is not found:
9971 .code
9972 ${lookup nisplus {[name=$local_part],passwd.org_dir:gcos} \
9973   {$value}fail}
9974 .endd
9975
9976
9977 .vitem &*${map{*&<&'string1'&>&*}{*&<&'string2'&>&*}}*&
9978 .cindex "expansion" "list creation"
9979 .vindex "&$item$&"
9980 After expansion, <&'string1'&> is interpreted as a list, colon-separated by
9981 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
9982 For each item
9983 in this list, its value is place in &$item$&, and then <&'string2'&> is
9984 expanded and added to the output as an item in a new list. The separator used
9985 for the output list is the same as the one used for the input, but a separator
9986 setting is not included in the output. For example:
9987 .code
9988 ${map{a:b:c}{[$item]}} ${map{<- x-y-z}{($item)}}
9989 .endd
9990 expands to &`[a]:[b]:[c] (x)-(y)-(z)`&. At the end of the expansion, the
9991 value of &$item$& is restored to what it was before. See also the &*filter*&
9992 and &*reduce*& expansion items.
9993
9994 .vitem &*${nhash{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
9995 .cindex "expansion" "numeric hash"
9996 .cindex "hash function" "numeric"
9997 The three strings are expanded; the first two must yield numbers. Call them
9998 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
9999 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10000 can use the simpler operator notation that avoids some of the braces:
10001 .code
10002 ${nhash_<n>_<m>:<string>}
10003 .endd
10004 The second number is optional (in both notations). If there is only one number,
10005 the result is a number in the range 0&--<&'n'&>-1. Otherwise, the string is
10006 processed by a div/mod hash function that returns two numbers, separated by a
10007 slash, in the ranges 0 to <&'n'&>-1 and 0 to <&'m'&>-1, respectively. For
10008 example,
10009 .code
10010 ${nhash{8}{64}{supercalifragilisticexpialidocious}}
10011 .endd
10012 returns the string &"6/33"&.
10013
10014
10015
10016 .vitem &*${perl{*&<&'subroutine'&>&*}{*&<&'arg'&>&*}{*&<&'arg'&>&*}...}*&
10017 .cindex "Perl" "use in expanded string"
10018 .cindex "expansion" "calling Perl from"
10019 This item is available only if Exim has been built to include an embedded Perl
10020 interpreter. The subroutine name and the arguments are first separately
10021 expanded, and then the Perl subroutine is called with those arguments. No
10022 additional arguments need be given; the maximum number permitted, including the
10023 name of the subroutine, is nine.
10024
10025 The return value of the subroutine is inserted into the expanded string, unless
10026 the return value is &%undef%&. In that case, the expansion fails in the same
10027 way as an explicit &"fail"& on a lookup item. The return value is a scalar.
10028 Whatever you return is evaluated in a scalar context. For example, if you
10029 return the name of a Perl vector, the return value is the size of the vector,
10030 not its contents.
10031
10032 If the subroutine exits by calling Perl's &%die%& function, the expansion fails
10033 with the error message that was passed to &%die%&. More details of the embedded
10034 Perl facility are given in chapter &<<CHAPperl>>&.
10035
10036 The &(redirect)& router has an option called &%forbid_filter_perl%& which locks
10037 out the use of this expansion item in filter files.
10038
10039
10040 .vitem &*${prvs{*&<&'address'&>&*}{*&<&'secret'&>&*}{*&<&'keynumber'&>&*}}*&
10041 .cindex "&%prvs%& expansion item"
10042 The first argument is a complete email address and the second is secret
10043 keystring. The third argument, specifying a key number, is optional. If absent,
10044 it defaults to 0. The result of the expansion is a prvs-signed email address,
10045 to be typically used with the &%return_path%& option on an &(smtp)& transport
10046 as part of a bounce address tag validation (BATV) scheme. For more discussion
10047 and an example, see section &<<SECTverifyPRVS>>&.
10048
10049 .vitem "&*${prvscheck{*&<&'address'&>&*}{*&<&'secret'&>&*}&&&
10050         {*&<&'string'&>&*}}*&"
10051 .cindex "&%prvscheck%& expansion item"
10052 This expansion item is the complement of the &%prvs%& item. It is used for
10053 checking prvs-signed addresses. If the expansion of the first argument does not
10054 yield a syntactically valid prvs-signed address, the whole item expands to the
10055 empty string. When the first argument does expand to a syntactically valid
10056 prvs-signed address, the second argument is expanded, with the prvs-decoded
10057 version of the address and the key number extracted from the address in the
10058 variables &$prvscheck_address$& and &$prvscheck_keynum$&, respectively.
10059
10060 These two variables can be used in the expansion of the second argument to
10061 retrieve the secret. The validity of the prvs-signed address is then checked
10062 against the secret. The result is stored in the variable &$prvscheck_result$&,
10063 which is empty for failure or &"1"& for success.
10064
10065 The third argument is optional; if it is missing, it defaults to an empty
10066 string. This argument is now expanded. If the result is an empty string, the
10067 result of the expansion is the decoded version of the address. This is the case
10068 whether or not the signature was valid. Otherwise, the result of the expansion
10069 is the expansion of the third argument.
10070
10071 All three variables can be used in the expansion of the third argument.
10072 However, once the expansion is complete, only &$prvscheck_result$& remains set.
10073 For more discussion and an example, see section &<<SECTverifyPRVS>>&.
10074
10075 .vitem &*${readfile{*&<&'file&~name'&>&*}{*&<&'eol&~string'&>&*}}*&
10076 .cindex "expansion" "inserting an entire file"
10077 .cindex "file" "inserting into expansion"
10078 .cindex "&%readfile%& expansion item"
10079 The filename and end-of-line string are first expanded separately. The file is
10080 then read, and its contents replace the entire item. All newline characters in
10081 the file are replaced by the end-of-line string if it is present. Otherwise,
10082 newlines are left in the string.
10083 String expansion is not applied to the contents of the file. If you want this,
10084 you must wrap the item in an &%expand%& operator. If the file cannot be read,
10085 the string expansion fails.
10086
10087 The &(redirect)& router has an option called &%forbid_filter_readfile%& which
10088 locks out the use of this expansion item in filter files.
10089
10090
10091
10092 .vitem "&*${readsocket{*&<&'name'&>&*}{*&<&'request'&>&*}&&&
10093         {*&<&'options'&>&*}{*&<&'eol&~string'&>&*}{*&<&'fail&~string'&>&*}}*&"
10094 .cindex "expansion" "inserting from a socket"
10095 .cindex "socket, use of in expansion"
10096 .cindex "&%readsocket%& expansion item"
10097 This item inserts data from a Unix domain or TCP socket into the expanded
10098 string. The minimal way of using it uses just two arguments, as in these
10099 examples:
10100 .code
10101 ${readsocket{/socket/name}{request string}}
10102 ${readsocket{inet:some.host:1234}{request string}}
10103 .endd
10104 For a Unix domain socket, the first substring must be the path to the socket.
10105 For an Internet socket, the first substring must contain &`inet:`& followed by
10106 a host name or IP address, followed by a colon and a port, which can be a
10107 number or the name of a TCP port in &_/etc/services_&. An IP address may
10108 optionally be enclosed in square brackets. This is best for IPv6 addresses. For
10109 example:
10110 .code
10111 ${readsocket{inet:[::1]:1234}{request string}}
10112 .endd
10113 Only a single host name may be given, but if looking it up yields more than
10114 one IP address, they are each tried in turn until a connection is made. For
10115 both kinds of socket, Exim makes a connection, writes the request string
10116 unless it is an empty string; and no terminating NUL is ever sent)
10117 and reads from the socket until an end-of-file
10118 is read. A timeout of 5 seconds is applied. Additional, optional arguments
10119 extend what can be done. Firstly, you can vary the timeout. For example:
10120 .code
10121 ${readsocket{/socket/name}{request string}{3s}}
10122 .endd
10123
10124 The third argument is a list of options, of which the first element is the timeout
10125 and must be present if the argument is given.
10126 Further elements are options of form &'name=value'&.
10127 Two option types is currently recognised: shutdown and tls.
10128 The first defines whether (the default)
10129 or not a shutdown is done on the connection after sending the request.
10130 Example, to not do so (preferred, eg. by some webservers):
10131 .code
10132 ${readsocket{/socket/name}{request string}{3s:shutdown=no}}
10133 .endd
10134 The second, tls, controls the use of TLS on the connection.  Example:
10135 .code
10136 ${readsocket{/socket/name}{request string}{3s:tls=yes}}
10137 .endd
10138 The default is to not use TLS.
10139 If it is enabled, a shutdown as descripbed above is never done.
10140
10141 A fourth argument allows you to change any newlines that are in the data
10142 that is read, in the same way as for &%readfile%& (see above). This example
10143 turns them into spaces:
10144 .code
10145 ${readsocket{inet:127.0.0.1:3294}{request string}{3s}{ }}
10146 .endd
10147 As with all expansions, the substrings are expanded before the processing
10148 happens. Errors in these sub-expansions cause the expansion to fail. In
10149 addition, the following errors can occur:
10150
10151 .ilist
10152 Failure to create a socket file descriptor;
10153 .next
10154 Failure to connect the socket;
10155 .next
10156 Failure to write the request string;
10157 .next
10158 Timeout on reading from the socket.
10159 .endlist
10160
10161 By default, any of these errors causes the expansion to fail. However, if
10162 you supply a fifth substring, it is expanded and used when any of the above
10163 errors occurs. For example:
10164 .code
10165 ${readsocket{/socket/name}{request string}{3s}{\n}\
10166   {socket failure}}
10167 .endd
10168 You can test for the existence of a Unix domain socket by wrapping this
10169 expansion in &`${if exists`&, but there is a race condition between that test
10170 and the actual opening of the socket, so it is safer to use the fifth argument
10171 if you want to be absolutely sure of avoiding an expansion error for a
10172 non-existent Unix domain socket, or a failure to connect to an Internet socket.
10173
10174 The &(redirect)& router has an option called &%forbid_filter_readsocket%& which
10175 locks out the use of this expansion item in filter files.
10176
10177
10178 .vitem &*${reduce{*&<&'string1'&>}{<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10179 .cindex "expansion" "reducing a list to a scalar"
10180 .cindex "list" "reducing to a scalar"
10181 .vindex "&$value$&"
10182 .vindex "&$item$&"
10183 This operation reduces a list to a single, scalar string. After expansion,
10184 <&'string1'&> is interpreted as a list, colon-separated by default, but the
10185 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10186 Then <&'string2'&> is expanded and
10187 assigned to the &$value$& variable. After this, each item in the <&'string1'&>
10188 list is assigned to &$item$&, in turn, and <&'string3'&> is expanded for each of
10189 them. The result of that expansion is assigned to &$value$& before the next
10190 iteration. When the end of the list is reached, the final value of &$value$& is
10191 added to the expansion output. The &*reduce*& expansion item can be used in a
10192 number of ways. For example, to add up a list of numbers:
10193 .code
10194 ${reduce {<, 1,2,3}{0}{${eval:$value+$item}}}
10195 .endd
10196 The result of that expansion would be &`6`&. The maximum of a list of numbers
10197 can be found:
10198 .code
10199 ${reduce {3:0:9:4:6}{0}{${if >{$item}{$value}{$item}{$value}}}}
10200 .endd
10201 At the end of a &*reduce*& expansion, the values of &$item$& and &$value$& are
10202 restored to what they were before. See also the &*filter*& and &*map*&
10203 expansion items.
10204
10205 .vitem &*$rheader_*&<&'header&~name'&>&*:*&&~or&~&*$rh_*&<&'header&~name'&>&*:*&
10206 This item inserts &"raw"& header lines. It is described with the &%header%&
10207 expansion item in section &<<SECTexpansionitems>>& above.
10208
10209 .vitem "&*${run{*&<&'command'&>&*&~*&<&'args'&>&*}{*&<&'string1'&>&*}&&&
10210         {*&<&'string2'&>&*}}*&"
10211 .cindex "expansion" "running a command"
10212 .cindex "&%run%& expansion item"
10213 The command and its arguments are first expanded as one string. The string is
10214 split apart into individual arguments by spaces, and then the command is run
10215 in a separate process, but under the same uid and gid.  As in other command
10216 executions from Exim, a shell is not used by default. If the command requires
10217 a shell, you must explicitly code it.
10218
10219 Since the arguments are split by spaces, when there is a variable expansion
10220 which has an empty result, it will cause the situation that the argument will
10221 simply be omitted when the program is actually executed by Exim. If the
10222 script/program requires a specific number of arguments and the expanded
10223 variable could possibly result in this empty expansion, the variable must be
10224 quoted. This is more difficult if the expanded variable itself could result
10225 in a string containing quotes, because it would interfere with the quotes
10226 around the command arguments. A possible guard against this is to wrap the
10227 variable in the &%sg%& operator to change any quote marks to some other
10228 character.
10229
10230 The standard input for the command exists, but is empty. The standard output
10231 and standard error are set to the same file descriptor.
10232 .cindex "return code" "from &%run%& expansion"
10233 .vindex "&$value$&"
10234 If the command succeeds (gives a zero return code) <&'string1'&> is expanded
10235 and replaces the entire item; during this expansion, the standard output/error
10236 from the command is in the variable &$value$&. If the command fails,
10237 <&'string2'&>, if present, is expanded and used. Once again, during the
10238 expansion, the standard output/error from the command is in the variable
10239 &$value$&.
10240
10241 If <&'string2'&> is absent, the result is empty. Alternatively, <&'string2'&>
10242 can be the word &"fail"& (not in braces) to force expansion failure if the
10243 command does not succeed. If both strings are omitted, the result is contents
10244 of the standard output/error on success, and nothing on failure.
10245
10246 .vindex "&$run_in_acl$&"
10247 The standard output/error of the command is put in the variable &$value$&.
10248 In this ACL example, the output of a command is logged for the admin to
10249 troubleshoot:
10250 .code
10251 warn  condition    = ${run{/usr/bin/id}{yes}{no}}
10252       log_message  = Output of id: $value
10253 .endd
10254 If the command requires shell idioms, such as the > redirect operator, the
10255 shell must be invoked directly, such as with:
10256 .code
10257 ${run{/bin/bash -c "/usr/bin/id >/tmp/id"}{yes}{yes}}
10258 .endd
10259
10260 .vindex "&$runrc$&"
10261 The return code from the command is put in the variable &$runrc$&, and this
10262 remains set afterwards, so in a filter file you can do things like this:
10263 .code
10264 if "${run{x y z}{}}$runrc" is 1 then ...
10265   elif $runrc is 2 then ...
10266   ...
10267 endif
10268 .endd
10269 If execution of the command fails (for example, the command does not exist),
10270 the return code is 127 &-- the same code that shells use for non-existent
10271 commands.
10272
10273 &*Warning*&: In a router or transport, you cannot assume the order in which
10274 option values are expanded, except for those preconditions whose order of
10275 testing is documented. Therefore, you cannot reliably expect to set &$runrc$&
10276 by the expansion of one option, and use it in another.
10277
10278 The &(redirect)& router has an option called &%forbid_filter_run%& which locks
10279 out the use of this expansion item in filter files.
10280
10281
10282 .vitem &*${sg{*&<&'subject'&>&*}{*&<&'regex'&>&*}{*&<&'replacement'&>&*}}*&
10283 .cindex "expansion" "string substitution"
10284 .cindex "&%sg%& expansion item"
10285 This item works like Perl's substitution operator (s) with the global (/g)
10286 option; hence its name. However, unlike the Perl equivalent, Exim does not
10287 modify the subject string; instead it returns the modified string for insertion
10288 into the overall expansion. The item takes three arguments: the subject string,
10289 a regular expression, and a substitution string. For example:
10290 .code
10291 ${sg{abcdefabcdef}{abc}{xyz}}
10292 .endd
10293 yields &"xyzdefxyzdef"&. Because all three arguments are expanded before use,
10294 if any $, } or \ characters are required in the regular expression or in the
10295 substitution string, they have to be escaped. For example:
10296 .code
10297 ${sg{abcdef}{^(...)(...)\$}{\$2\$1}}
10298 .endd
10299 yields &"defabc"&, and
10300 .code
10301 ${sg{1=A 4=D 3=C}{\N(\d+)=\N}{K\$1=}}
10302 .endd
10303 yields &"K1=A K4=D K3=C"&. Note the use of &`\N`& to protect the contents of
10304 the regular expression from string expansion.
10305
10306 The regular expression is compiled in 8-bit mode, working against bytes
10307 rather than any Unicode-aware character handling.
10308
10309
10310 .vitem &*${sort{*&<&'string'&>&*}{*&<&'comparator'&>&*}{*&<&'extractor'&>&*}}*&
10311 .cindex sorting "a list"
10312 .cindex list sorting
10313 .cindex expansion "list sorting"
10314 After expansion, <&'string'&> is interpreted as a list, colon-separated by
10315 default, but the separator can be changed in the usual way (&<<SECTlistsepchange>>&).
10316 The <&'comparator'&> argument is interpreted as the operator
10317 of a two-argument expansion condition.
10318 The numeric operators plus ge, gt, le, lt (and ~i variants) are supported.
10319 The comparison should return true when applied to two values
10320 if the first value should sort before the second value.
10321 The <&'extractor'&> expansion is applied repeatedly to elements of the list,
10322 the element being placed in &$item$&,
10323 to give values for comparison.
10324
10325 The item result is a sorted list,
10326 with the original list separator,
10327 of the list elements (in full) of the original.
10328
10329 Examples:
10330 .code
10331 ${sort{3:2:1:4}{<}{$item}}
10332 .endd
10333 sorts a list of numbers, and
10334 .code
10335 ${sort {${lookup dnsdb{>:,,mx=example.com}}} {<} {${listextract{1}{<,$item}}}}
10336 .endd
10337 will sort an MX lookup into priority order.
10338
10339
10340 .vitem &*${substr{*&<&'string1'&>&*}{*&<&'string2'&>&*}{*&<&'string3'&>&*}}*&
10341 .cindex "&%substr%& expansion item"
10342 .cindex "substring extraction"
10343 .cindex "expansion" "substring extraction"
10344 The three strings are expanded; the first two must yield numbers. Call them
10345 <&'n'&> and <&'m'&>. If you are using fixed values for these numbers, that is,
10346 if <&'string1'&> and <&'string2'&> do not change when they are expanded, you
10347 can use the simpler operator notation that avoids some of the braces:
10348 .code
10349 ${substr_<n>_<m>:<string>}
10350 .endd
10351 The second number is optional (in both notations).
10352 If it is absent in the simpler format, the preceding underscore must also be
10353 omitted.
10354
10355 The &%substr%& item can be used to extract more general substrings than
10356 &%length%&. The first number, <&'n'&>, is a starting offset, and <&'m'&> is the
10357 length required. For example
10358 .code
10359 ${substr{3}{2}{$local_part}}
10360 .endd
10361 If the starting offset is greater than the string length the result is the
10362 null string; if the length plus starting offset is greater than the string
10363 length, the result is the right-hand part of the string, starting from the
10364 given offset. The first byte (character) in the string has offset zero.
10365
10366 The &%substr%& expansion item can take negative offset values to count
10367 from the right-hand end of its operand. The last byte (character) is offset -1,
10368 the second-last is offset -2, and so on. Thus, for example,
10369 .code
10370 ${substr{-5}{2}{1234567}}
10371 .endd
10372 yields &"34"&. If the absolute value of a negative offset is greater than the
10373 length of the string, the substring starts at the beginning of the string, and
10374 the length is reduced by the amount of overshoot. Thus, for example,
10375 .code
10376 ${substr{-5}{2}{12}}
10377 .endd
10378 yields an empty string, but
10379 .code
10380 ${substr{-3}{2}{12}}
10381 .endd
10382 yields &"1"&.
10383
10384 When the second number is omitted from &%substr%&, the remainder of the string
10385 is taken if the offset is positive. If it is negative, all bytes (characters) in the
10386 string preceding the offset point are taken. For example, an offset of -1 and
10387 no length, as in these semantically identical examples:
10388 .code
10389 ${substr_-1:abcde}
10390 ${substr{-1}{abcde}}
10391 .endd
10392 yields all but the last character of the string, that is, &"abcd"&.
10393
10394 All measurement is done in bytes and is not UTF-8 aware.
10395
10396
10397
10398 .vitem "&*${tr{*&<&'subject'&>&*}{*&<&'characters'&>&*}&&&
10399         {*&<&'replacements'&>&*}}*&"
10400 .cindex "expansion" "character translation"
10401 .cindex "&%tr%& expansion item"
10402 This item does single-character (in bytes) translation on its subject string. The second
10403 argument is a list of characters to be translated in the subject string. Each
10404 matching character is replaced by the corresponding character from the
10405 replacement list. For example
10406 .code
10407 ${tr{abcdea}{ac}{13}}
10408 .endd
10409 yields &`1b3de1`&. If there are duplicates in the second character string, the
10410 last occurrence is used. If the third string is shorter than the second, its
10411 last character is replicated. However, if it is empty, no translation takes
10412 place.
10413
10414 All character handling is done in bytes and is not UTF-8 aware.
10415
10416 .endlist
10417
10418
10419
10420 .section "Expansion operators" "SECTexpop"
10421 .cindex "expansion" "operators"
10422 For expansion items that perform transformations on a single argument string,
10423 the &"operator"& notation is used because it is simpler and uses fewer braces.
10424 The substring is first expanded before the operation is applied to it. The
10425 following operations can be performed:
10426
10427 .vlist
10428 .vitem &*${address:*&<&'string'&>&*}*&
10429 .cindex "expansion" "RFC 2822 address handling"
10430 .cindex "&%address%& expansion item"
10431 The string is interpreted as an RFC 2822 address, as it might appear in a
10432 header line, and the effective address is extracted from it. If the string does
10433 not parse successfully, the result is empty.
10434
10435 The parsing correctly handles SMTPUTF8 Unicode in the string.
10436
10437
10438 .vitem &*${addresses:*&<&'string'&>&*}*&
10439 .cindex "expansion" "RFC 2822 address handling"
10440 .cindex "&%addresses%& expansion item"
10441 The string (after expansion) is interpreted as a list of addresses in RFC
10442 2822 format, such as can be found in a &'To:'& or &'Cc:'& header line. The
10443 operative address (&'local-part@domain'&) is extracted from each item, and the
10444 result of the expansion is a colon-separated list, with appropriate
10445 doubling of colons should any happen to be present in the email addresses.
10446 Syntactically invalid RFC2822 address items are omitted from the output.
10447
10448 It is possible to specify a character other than colon for the output
10449 separator by starting the string with > followed by the new separator
10450 character. For example:
10451 .code
10452 ${addresses:>& Chief <ceo@up.stairs>, sec@base.ment (dogsbody)}
10453 .endd
10454 expands to &`ceo@up.stairs&&sec@base.ment`&. The string is expanded
10455 first, so if the expanded string starts with >, it may change the output
10456 separator unintentionally. This can be avoided by setting the output
10457 separator explicitly:
10458 .code
10459 ${addresses:>:$h_from:}
10460 .endd
10461
10462 Compare the &*address*& (singular)
10463 expansion item, which extracts the working address from a single RFC2822
10464 address. See the &*filter*&, &*map*&, and &*reduce*& items for ways of
10465 processing lists.
10466
10467 To clarify "list of addresses in RFC 2822 format" mentioned above, Exim follows
10468 a strict interpretation of header line formatting.  Exim parses the bare,
10469 unquoted portion of an email address and if it finds a comma, treats it as an
10470 email address separator. For the example header line:
10471 .code
10472 From: =?iso-8859-2?Q?Last=2C_First?= <user@example.com>
10473 .endd
10474 The first example below demonstrates that Q-encoded email addresses are parsed
10475 properly if it is given the raw header (in this example, &`$rheader_from:`&).
10476 It does not see the comma because it's still encoded as "=2C".  The second
10477 example below is passed the contents of &`$header_from:`&, meaning it gets
10478 de-mimed. Exim sees the decoded "," so it treats it as &*two*& email addresses.
10479 The third example shows that the presence of a comma is skipped when it is
10480 quoted.  The fourth example shows SMTPUTF8 handling.
10481 .code
10482 # exim -be '${addresses:From: \
10483 =?iso-8859-2?Q?Last=2C_First?= <user@example.com>}'
10484 user@example.com
10485 # exim -be '${addresses:From: Last, First <user@example.com>}'
10486 Last:user@example.com
10487 # exim -be '${addresses:From: "Last, First" <user@example.com>}'
10488 user@example.com
10489 # exim -be '${addresses:フィル <フィリップ@example.jp>}'
10490 フィリップ@example.jp
10491 .endd
10492
10493 .vitem &*${base32:*&<&'digits'&>&*}*&
10494 .cindex "&%base32%& expansion item"
10495 .cindex "expansion" "conversion to base 32"
10496 The string must consist entirely of decimal digits. The number is converted to
10497 base 32 and output as a (empty, for zero) string of characters.
10498 Only lowercase letters are used.
10499
10500 .vitem &*${base32d:*&<&'base-32&~digits'&>&*}*&
10501 .cindex "&%base32d%& expansion item"
10502 .cindex "expansion" "conversion to base 32"
10503 The string must consist entirely of base-32 digits.
10504 The number is converted to decimal and output as a string.
10505
10506 .vitem &*${base62:*&<&'digits'&>&*}*&
10507 .cindex "&%base62%& expansion item"
10508 .cindex "expansion" "conversion to base 62"
10509 The string must consist entirely of decimal digits. The number is converted to
10510 base 62 and output as a string of six characters, including leading zeros. In
10511 the few operating environments where Exim uses base 36 instead of base 62 for
10512 its message identifiers (because those systems do not have case-sensitive
10513 filenames), base 36 is used by this operator, despite its name. &*Note*&: Just
10514 to be absolutely clear: this is &'not'& base64 encoding.
10515
10516 .vitem &*${base62d:*&<&'base-62&~digits'&>&*}*&
10517 .cindex "&%base62d%& expansion item"
10518 .cindex "expansion" "conversion to base 62"
10519 The string must consist entirely of base-62 digits, or, in operating
10520 environments where Exim uses base 36 instead of base 62 for its message
10521 identifiers, base-36 digits. The number is converted to decimal and output as a
10522 string.
10523
10524 .vitem &*${base64:*&<&'string'&>&*}*&
10525 .cindex "expansion" "base64 encoding"
10526 .cindex "base64 encoding" "in string expansion"
10527 .cindex "&%base64%& expansion item"
10528 .cindex certificate "base64 of DER"
10529 This operator converts a string into one that is base64 encoded.
10530
10531 If the string is a single variable of type certificate,
10532 returns the base64 encoding of the DER form of the certificate.
10533
10534
10535 .vitem &*${base64d:*&<&'string'&>&*}*&
10536 .cindex "expansion" "base64 decoding"
10537 .cindex "base64 decoding" "in string expansion"
10538 .cindex "&%base64d%& expansion item"
10539 This operator converts a base64-encoded string into the un-coded form.
10540
10541
10542 .vitem &*${domain:*&<&'string'&>&*}*&
10543 .cindex "domain" "extraction"
10544 .cindex "expansion" "domain extraction"
10545 The string is interpreted as an RFC 2822 address and the domain is extracted
10546 from it. If the string does not parse successfully, the result is empty.
10547
10548
10549 .vitem &*${escape:*&<&'string'&>&*}*&
10550 .cindex "expansion" "escaping non-printing characters"
10551 .cindex "&%escape%& expansion item"
10552 If the string contains any non-printing characters, they are converted to
10553 escape sequences starting with a backslash. Whether characters with the most
10554 significant bit set (so-called &"8-bit characters"&) count as printing or not
10555 is controlled by the &%print_topbitchars%& option.
10556
10557 .vitem &*${escape8bit:*&<&'string'&>&*}*&
10558 .cindex "expansion" "escaping 8-bit characters"
10559 .cindex "&%escape8bit%& expansion item"
10560 If the string contains and characters with the most significant bit set,
10561 they are converted to escape sequences starting with a backslash.
10562 Backslashes and DEL characters are also converted.
10563
10564
10565 .vitem &*${eval:*&<&'string'&>&*}*&&~and&~&*${eval10:*&<&'string'&>&*}*&
10566 .cindex "expansion" "expression evaluation"
10567 .cindex "expansion" "arithmetic expression"
10568 .cindex "&%eval%& expansion item"
10569 These items supports simple arithmetic and bitwise logical operations in
10570 expansion strings. The string (after expansion) must be a conventional
10571 arithmetic expression, but it is limited to basic arithmetic operators, bitwise
10572 logical operators, and parentheses. All operations are carried out using
10573 integer arithmetic. The operator priorities are as follows (the same as in the
10574 C programming language):
10575 .table2 70pt 300pt
10576 .irow &'highest:'& "not (~), negate (-)"
10577 .irow ""   "multiply (*), divide (/), remainder (%)"
10578 .irow ""   "plus (+), minus (-)"
10579 .irow ""   "shift-left (<<), shift-right (>>)"
10580 .irow ""   "and (&&)"
10581 .irow ""   "xor (^)"
10582 .irow &'lowest:'&  "or (|)"
10583 .endtable
10584 Binary operators with the same priority are evaluated from left to right. White
10585 space is permitted before or after operators.
10586
10587 For &%eval%&, numbers may be decimal, octal (starting with &"0"&) or
10588 hexadecimal (starting with &"0x"&). For &%eval10%&, all numbers are taken as
10589 decimal, even if they start with a leading zero; hexadecimal numbers are not
10590 permitted. This can be useful when processing numbers extracted from dates or
10591 times, which often do have leading zeros.
10592
10593 A number may be followed by &"K"&, &"M"& or &"G"& to multiply it by 1024, 1024*1024
10594 or 1024*1024*1024,
10595 respectively. Negative numbers are supported. The result of the computation is
10596 a decimal representation of the answer (without &"K"&, &"M"& or &"G"&). For example:
10597
10598 .display
10599 &`${eval:1+1}            `&  yields 2
10600 &`${eval:1+2*3}          `&  yields 7
10601 &`${eval:(1+2)*3}        `&  yields 9
10602 &`${eval:2+42%5}         `&  yields 4
10603 &`${eval:0xc&amp;5}          `&  yields 4
10604 &`${eval:0xc|5}          `&  yields 13
10605 &`${eval:0xc^5}          `&  yields 9
10606 &`${eval:0xc>>1}         `&  yields 6
10607 &`${eval:0xc<<1}         `&  yields 24
10608 &`${eval:~255&amp;0x1234}    `&  yields 4608
10609 &`${eval:-(~255&amp;0x1234)} `&  yields -4608
10610 .endd
10611
10612 As a more realistic example, in an ACL you might have
10613 .code
10614 deny   message = Too many bad recipients
10615        condition =                    \
10616          ${if and {                   \
10617            {>{$rcpt_count}{10}}       \
10618            {                          \
10619            <                          \
10620              {$recipients_count}      \
10621              {${eval:$rcpt_count/2}}  \
10622            }                          \
10623          }{yes}{no}}
10624 .endd
10625 The condition is true if there have been more than 10 RCPT commands and
10626 fewer than half of them have resulted in a valid recipient.
10627
10628
10629 .vitem &*${expand:*&<&'string'&>&*}*&
10630 .cindex "expansion" "re-expansion of substring"
10631 The &%expand%& operator causes a string to be expanded for a second time. For
10632 example,
10633 .code
10634 ${expand:${lookup{$domain}dbm{/some/file}{$value}}}
10635 .endd
10636 first looks up a string in a file while expanding the operand for &%expand%&,
10637 and then re-expands what it has found.
10638
10639
10640 .vitem &*${from_utf8:*&<&'string'&>&*}*&
10641 .cindex "Unicode"
10642 .cindex "UTF-8" "conversion from"
10643 .cindex "expansion" "UTF-8 conversion"
10644 .cindex "&%from_utf8%& expansion item"
10645 The world is slowly moving towards Unicode, although there are no standards for
10646 email yet. However, other applications (including some databases) are starting
10647 to store data in Unicode, using UTF-8 encoding. This operator converts from a
10648 UTF-8 string to an ISO-8859-1 string. UTF-8 code values greater than 255 are
10649 converted to underscores. The input must be a valid UTF-8 string. If it is not,
10650 the result is an undefined sequence of bytes.
10651
10652 Unicode code points with values less than 256 are compatible with ASCII and
10653 ISO-8859-1 (also known as Latin-1).
10654 For example, character 169 is the copyright symbol in both cases, though the
10655 way it is encoded is different. In UTF-8, more than one byte is needed for
10656 characters with code values greater than 127, whereas ISO-8859-1 is a
10657 single-byte encoding (but thereby limited to 256 characters). This makes
10658 translation from UTF-8 to ISO-8859-1 straightforward.
10659
10660
10661 .vitem &*${hash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10662 .cindex "hash function" "textual"
10663 .cindex "expansion" "textual hash"
10664 The &%hash%& operator is a simpler interface to the hashing function that can
10665 be used when the two parameters are fixed numbers (as opposed to strings that
10666 change when expanded). The effect is the same as
10667 .code
10668 ${hash{<n>}{<m>}{<string>}}
10669 .endd
10670 See the description of the general &%hash%& item above for details. The
10671 abbreviation &%h%& can be used when &%hash%& is used as an operator.
10672
10673
10674
10675 .vitem &*${hex2b64:*&<&'hexstring'&>&*}*&
10676 .cindex "base64 encoding" "conversion from hex"
10677 .cindex "expansion" "hex to base64"
10678 .cindex "&%hex2b64%& expansion item"
10679 This operator converts a hex string into one that is base64 encoded. This can
10680 be useful for processing the output of the various hashing functions.
10681
10682
10683
10684 .vitem &*${hexquote:*&<&'string'&>&*}*&
10685 .cindex "quoting" "hex-encoded unprintable characters"
10686 .cindex "&%hexquote%& expansion item"
10687 This operator converts non-printable characters in a string into a hex
10688 escape form. Byte values between 33 (!) and 126 (~) inclusive are left
10689 as is, and other byte values are converted to &`\xNN`&, for example, a
10690 byte value 127 is converted to &`\x7f`&.
10691
10692
10693 .vitem &*${ipv6denorm:*&<&'string'&>&*}*&
10694 .cindex "&%ipv6denorm%& expansion item"
10695 .cindex "IP address" normalisation
10696 This expands an IPv6 address to a full eight-element colon-separated set
10697 of hex digits including leading zeroes.
10698 A trailing ipv4-style dotted-decimal set is converted to hex.
10699 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10700
10701 .vitem &*${ipv6norm:*&<&'string'&>&*}*&
10702 .cindex "&%ipv6norm%& expansion item"
10703 .cindex "IP address" normalisation
10704 .cindex "IP address" "canonical form"
10705 This converts an IPv6 address to canonical form.
10706 Leading zeroes of groups are omitted, and the longest
10707 set of zero-valued groups is replaced with a double colon.
10708 A trailing ipv4-style dotted-decimal set is converted to hex.
10709 Pure IPv4 addresses are converted to IPv4-mapped IPv6.
10710
10711
10712 .vitem &*${lc:*&<&'string'&>&*}*&
10713 .cindex "case forcing in strings"
10714 .cindex "string" "case forcing"
10715 .cindex "lower casing"
10716 .cindex "expansion" "case forcing"
10717 .cindex "&%lc%& expansion item"
10718 This forces the letters in the string into lower-case, for example:
10719 .code
10720 ${lc:$local_part}
10721 .endd
10722 Case is defined per the system C locale.
10723
10724 .vitem &*${length_*&<&'number'&>&*:*&<&'string'&>&*}*&
10725 .cindex "expansion" "string truncation"
10726 .cindex "&%length%& expansion item"
10727 The &%length%& operator is a simpler interface to the &%length%& function that
10728 can be used when the parameter is a fixed number (as opposed to a string that
10729 changes when expanded). The effect is the same as
10730 .code
10731 ${length{<number>}{<string>}}
10732 .endd
10733 See the description of the general &%length%& item above for details. Note that
10734 &%length%& is not the same as &%strlen%&. The abbreviation &%l%& can be used
10735 when &%length%& is used as an operator.
10736 All measurement is done in bytes and is not UTF-8 aware.
10737
10738
10739 .vitem &*${listcount:*&<&'string'&>&*}*&
10740 .cindex "expansion" "list item count"
10741 .cindex "list" "item count"
10742 .cindex "list" "count of items"
10743 .cindex "&%listcount%& expansion item"
10744 The string is interpreted as a list and the number of items is returned.
10745
10746
10747 .vitem &*${listnamed:*&<&'name'&>&*}*&&~and&~&*${listnamed_*&<&'type'&>&*:*&<&'name'&>&*}*&
10748 .cindex "expansion" "named list"
10749 .cindex "&%listnamed%& expansion item"
10750 The name is interpreted as a named list and the content of the list is returned,
10751 expanding any referenced lists, re-quoting as needed for colon-separation.
10752 If the optional type is given it must be one of "a", "d", "h" or "l"
10753 and selects address-, domain-, host- or localpart- lists to search among respectively.
10754 Otherwise all types are searched in an undefined order and the first
10755 matching list is returned.
10756
10757
10758 .vitem &*${local_part:*&<&'string'&>&*}*&
10759 .cindex "expansion" "local part extraction"
10760 .cindex "&%local_part%& expansion item"
10761 The string is interpreted as an RFC 2822 address and the local part is
10762 extracted from it. If the string does not parse successfully, the result is
10763 empty.
10764 The parsing correctly handles SMTPUTF8 Unicode in the string.
10765
10766
10767 .vitem &*${mask:*&<&'IP&~address'&>&*/*&<&'bit&~count'&>&*}*&
10768 .cindex "masked IP address"
10769 .cindex "IP address" "masking"
10770 .cindex "CIDR notation"
10771 .cindex "expansion" "IP address masking"
10772 .cindex "&%mask%& expansion item"
10773 If the form of the string to be operated on is not an IP address followed by a
10774 slash and an integer (that is, a network address in CIDR notation), the
10775 expansion fails. Otherwise, this operator converts the IP address to binary,
10776 masks off the least significant bits according to the bit count, and converts
10777 the result back to text, with mask appended. For example,
10778 .code
10779 ${mask:10.111.131.206/28}
10780 .endd
10781 returns the string &"10.111.131.192/28"&. Since this operation is expected to
10782 be mostly used for looking up masked addresses in files, the result for an IPv6
10783 address uses dots to separate components instead of colons, because colon
10784 terminates a key string in lsearch files. So, for example,
10785 .code
10786 ${mask:3ffe:ffff:836f:0a00:000a:0800:200a:c031/99}
10787 .endd
10788 returns the string
10789 .code
10790 3ffe.ffff.836f.0a00.000a.0800.2000.0000/99
10791 .endd
10792 Letters in IPv6 addresses are always output in lower case.
10793
10794
10795 .vitem &*${md5:*&<&'string'&>&*}*&
10796 .cindex "MD5 hash"
10797 .cindex "expansion" "MD5 hash"
10798 .cindex certificate fingerprint
10799 .cindex "&%md5%& expansion item"
10800 The &%md5%& operator computes the MD5 hash value of the string, and returns it
10801 as a 32-digit hexadecimal number, in which any letters are in lower case.
10802
10803 If the string is a single variable of type certificate,
10804 returns the MD5 hash fingerprint of the certificate.
10805
10806
10807 .vitem &*${nhash_*&<&'n'&>&*_*&<&'m'&>&*:*&<&'string'&>&*}*&
10808 .cindex "expansion" "numeric hash"
10809 .cindex "hash function" "numeric"
10810 The &%nhash%& operator is a simpler interface to the numeric hashing function
10811 that can be used when the two parameters are fixed numbers (as opposed to
10812 strings that change when expanded). The effect is the same as
10813 .code
10814 ${nhash{<n>}{<m>}{<string>}}
10815 .endd
10816 See the description of the general &%nhash%& item above for details.
10817
10818
10819 .vitem &*${quote:*&<&'string'&>&*}*&
10820 .cindex "quoting" "in string expansions"
10821 .cindex "expansion" "quoting"
10822 .cindex "&%quote%& expansion item"
10823 The &%quote%& operator puts its argument into double quotes if it
10824 is an empty string or
10825 contains anything other than letters, digits, underscores, dots, and hyphens.
10826 Any occurrences of double quotes and backslashes are escaped with a backslash.
10827 Newlines and carriage returns are converted to &`\n`& and &`\r`&,
10828 respectively For example,
10829 .code
10830 ${quote:ab"*"cd}
10831 .endd
10832 becomes
10833 .code
10834 "ab\"*\"cd"
10835 .endd
10836 The place where this is useful is when the argument is a substitution from a
10837 variable or a message header.
10838
10839 .vitem &*${quote_local_part:*&<&'string'&>&*}*&
10840 .cindex "&%quote_local_part%& expansion item"
10841 This operator is like &%quote%&, except that it quotes the string only if
10842 required to do so by the rules of RFC 2822 for quoting local parts. For
10843 example, a plus sign would not cause quoting (but it would for &%quote%&).
10844 If you are creating a new email address from the contents of &$local_part$&
10845 (or any other unknown data), you should always use this operator.
10846
10847 This quoting determination is not SMTPUTF8-aware, thus quoting non-ASCII data
10848 will likely use the quoting form.
10849 Thus &'${quote_local_part:フィル}'& will always become &'"フィル"'&.
10850
10851
10852 .vitem &*${quote_*&<&'lookup-type'&>&*:*&<&'string'&>&*}*&
10853 .cindex "quoting" "lookup-specific"
10854 This operator applies lookup-specific quoting rules to the string. Each
10855 query-style lookup type has its own quoting rules which are described with
10856 the lookups in chapter &<<CHAPfdlookup>>&. For example,
10857 .code
10858 ${quote_ldap:two * two}
10859 .endd
10860 returns
10861 .code
10862 two%20%5C2A%20two
10863 .endd
10864 For single-key lookup types, no quoting is ever necessary and this operator
10865 yields an unchanged string.
10866
10867
10868 .vitem &*${randint:*&<&'n'&>&*}*&
10869 .cindex "random number"
10870 This operator returns a somewhat random number which is less than the
10871 supplied number and is at least 0.  The quality of this randomness depends
10872 on how Exim was built; the values are not suitable for keying material.
10873 If Exim is linked against OpenSSL then RAND_pseudo_bytes() is used.
10874 If Exim is linked against GnuTLS then gnutls_rnd(GNUTLS_RND_NONCE) is used,
10875 for versions of GnuTLS with that function.
10876 Otherwise, the implementation may be arc4random(), random() seeded by
10877 srandomdev() or srandom(), or a custom implementation even weaker than
10878 random().
10879
10880
10881 .vitem &*${reverse_ip:*&<&'ipaddr'&>&*}*&
10882 .cindex "expansion" "IP address"
10883 This operator reverses an IP address; for IPv4 addresses, the result is in
10884 dotted-quad decimal form, while for IPv6 addresses the result is in
10885 dotted-nibble hexadecimal form.  In both cases, this is the "natural" form
10886 for DNS.  For example,
10887 .code
10888 ${reverse_ip:192.0.2.4}
10889 ${reverse_ip:2001:0db8:c42:9:1:abcd:192.0.2.127}
10890 .endd
10891 returns
10892 .code
10893 4.2.0.192
10894 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
10895 .endd
10896
10897
10898 .vitem &*${rfc2047:*&<&'string'&>&*}*&
10899 .cindex "expansion" "RFC 2047"
10900 .cindex "RFC 2047" "expansion operator"
10901 .cindex "&%rfc2047%& expansion item"
10902 This operator encodes text according to the rules of RFC 2047. This is an
10903 encoding that is used in header lines to encode non-ASCII characters. It is
10904 assumed that the input string is in the encoding specified by the
10905 &%headers_charset%& option, which gets its default at build time. If the string
10906 contains only characters in the range 33&--126, and no instances of the
10907 characters
10908 .code
10909 ? = ( ) < > @ , ; : \ " . [ ] _
10910 .endd
10911 it is not modified. Otherwise, the result is the RFC 2047 encoding of the
10912 string, using as many &"encoded words"& as necessary to encode all the
10913 characters.
10914
10915
10916 .vitem &*${rfc2047d:*&<&'string'&>&*}*&
10917 .cindex "expansion" "RFC 2047"
10918 .cindex "RFC 2047" "decoding"
10919 .cindex "&%rfc2047d%& expansion item"
10920 This operator decodes strings that are encoded as per RFC 2047. Binary zero
10921 bytes are replaced by question marks. Characters are converted into the
10922 character set defined by &%headers_charset%&. Overlong RFC 2047 &"words"& are
10923 not recognized unless &%check_rfc2047_length%& is set false.
10924
10925 &*Note*&: If you use &%$header%&_&'xxx'&&*:*& (or &%$h%&_&'xxx'&&*:*&) to
10926 access a header line, RFC 2047 decoding is done automatically. You do not need
10927 to use this operator as well.
10928
10929
10930
10931 .vitem &*${rxquote:*&<&'string'&>&*}*&
10932 .cindex "quoting" "in regular expressions"
10933 .cindex "regular expressions" "quoting"
10934 .cindex "&%rxquote%& expansion item"
10935 The &%rxquote%& operator inserts a backslash before any non-alphanumeric
10936 characters in its argument. This is useful when substituting the values of
10937 variables or headers inside regular expressions.
10938
10939
10940 .vitem &*${sha1:*&<&'string'&>&*}*&
10941 .cindex "SHA-1 hash"
10942 .cindex "expansion" "SHA-1 hashing"
10943 .cindex certificate fingerprint
10944 .cindex "&%sha1%& expansion item"
10945 The &%sha1%& operator computes the SHA-1 hash value of the string, and returns
10946 it as a 40-digit hexadecimal number, in which any letters are in upper case.
10947
10948 If the string is a single variable of type certificate,
10949 returns the SHA-1 hash fingerprint of the certificate.
10950
10951
10952 .vitem &*${sha256:*&<&'string'&>&*}*&
10953 .cindex "SHA-256 hash"
10954 .cindex certificate fingerprint
10955 .cindex "expansion" "SHA-256 hashing"
10956 .cindex "&%sha256%& expansion item"
10957 The &%sha256%& operator computes the SHA-256 hash value of the string
10958 and returns
10959 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10960
10961 If the string is a single variable of type certificate,
10962 returns the SHA-256 hash fingerprint of the certificate.
10963
10964
10965 .vitem &*${sha3:*&<&'string'&>&*}*& &&&
10966        &*${sha3_<n>:*&<&'string'&>&*}*&
10967 .cindex "SHA3 hash"
10968 .cindex "expansion" "SHA3 hashing"
10969 .cindex "&%sha3%& expansion item"
10970 The &%sha3%& operator computes the SHA3-256 hash value of the string
10971 and returns
10972 it as a 64-digit hexadecimal number, in which any letters are in upper case.
10973
10974 If a number is appended, separated by an underbar, it specifies
10975 the output length.  Values of 224, 256, 384 and 512 are accepted;
10976 with 256 being the default.
10977
10978 The &%sha3%& expansion item is only supported if Exim has been
10979 compiled with GnuTLS 3.5.0 or later,
10980 or OpenSSL 1.1.1 or later.
10981 The macro "_CRYPTO_HASH_SHA3" will be defined if it is supported.
10982
10983
10984 .vitem &*${stat:*&<&'string'&>&*}*&
10985 .cindex "expansion" "statting a file"
10986 .cindex "file" "extracting characteristics"
10987 .cindex "&%stat%& expansion item"
10988 The string, after expansion, must be a file path. A call to the &[stat()]&
10989 function is made for this path. If &[stat()]& fails, an error occurs and the
10990 expansion fails. If it succeeds, the data from the stat replaces the item, as a
10991 series of <&'name'&>=<&'value'&> pairs, where the values are all numerical,
10992 except for the value of &"smode"&. The names are: &"mode"& (giving the mode as
10993 a 4-digit octal number), &"smode"& (giving the mode in symbolic format as a
10994 10-character string, as for the &'ls'& command), &"inode"&, &"device"&,
10995 &"links"&, &"uid"&, &"gid"&, &"size"&, &"atime"&, &"mtime"&, and &"ctime"&. You
10996 can extract individual fields using the &%extract%& expansion item.
10997
10998 The use of the &%stat%& expansion in users' filter files can be locked out by
10999 the system administrator. &*Warning*&: The file size may be incorrect on 32-bit
11000 systems for files larger than 2GB.
11001
11002 .vitem &*${str2b64:*&<&'string'&>&*}*&
11003 .cindex "&%str2b64%& expansion item"
11004 Now deprecated, a synonym for the &%base64%& expansion operator.
11005
11006
11007
11008 .vitem &*${strlen:*&<&'string'&>&*}*&
11009 .cindex "expansion" "string length"
11010 .cindex "string" "length in expansion"
11011 .cindex "&%strlen%& expansion item"
11012 The item is replace by the length of the expanded string, expressed as a
11013 decimal number. &*Note*&: Do not confuse &%strlen%& with &%length%&.
11014 All measurement is done in bytes and is not UTF-8 aware.
11015
11016
11017 .vitem &*${substr_*&<&'start'&>&*_*&<&'length'&>&*:*&<&'string'&>&*}*&
11018 .cindex "&%substr%& expansion item"
11019 .cindex "substring extraction"
11020 .cindex "expansion" "substring expansion"
11021 The &%substr%& operator is a simpler interface to the &%substr%& function that
11022 can be used when the two parameters are fixed numbers (as opposed to strings
11023 that change when expanded). The effect is the same as
11024 .code
11025 ${substr{<start>}{<length>}{<string>}}
11026 .endd
11027 See the description of the general &%substr%& item above for details. The
11028 abbreviation &%s%& can be used when &%substr%& is used as an operator.
11029 All measurement is done in bytes and is not UTF-8 aware.
11030
11031 .vitem &*${time_eval:*&<&'string'&>&*}*&
11032 .cindex "&%time_eval%& expansion item"
11033 .cindex "time interval" "decoding"
11034 This item converts an Exim time interval such as &`2d4h5m`& into a number of
11035 seconds.
11036
11037 .vitem &*${time_interval:*&<&'string'&>&*}*&
11038 .cindex "&%time_interval%& expansion item"
11039 .cindex "time interval" "formatting"
11040 The argument (after sub-expansion) must be a sequence of decimal digits that
11041 represents an interval of time as a number of seconds. It is converted into a
11042 number of larger units and output in Exim's normal time format, for example,
11043 &`1w3d4h2m6s`&.
11044
11045 .vitem &*${uc:*&<&'string'&>&*}*&
11046 .cindex "case forcing in strings"
11047 .cindex "string" "case forcing"
11048 .cindex "upper casing"
11049 .cindex "expansion" "case forcing"
11050 .cindex "&%uc%& expansion item"
11051 This forces the letters in the string into upper-case.
11052 Case is defined per the system C locale.
11053
11054 .vitem &*${utf8clean:*&<&'string'&>&*}*&
11055 .cindex "correction of invalid utf-8 sequences in strings"
11056 .cindex "utf-8" "utf-8 sequences"
11057 .cindex "incorrect utf-8"
11058 .cindex "expansion" "utf-8 forcing"
11059 .cindex "&%utf8clean%& expansion item"
11060 This replaces any invalid utf-8 sequence in the string by the character &`?`&.
11061 In versions of Exim before 4.92, this did not correctly do so for a truncated
11062 final codepoint's encoding, and the character would be silently dropped.
11063 If you must handle detection of this scenario across both sets of Exim behavior,
11064 the complexity will depend upon the task.
11065 For instance, to detect if the first character is multibyte and a 1-byte
11066 extraction can be successfully used as a path component (as is common for
11067 dividing up delivery folders), you might use:
11068 .code
11069 condition = ${if inlist{${utf8clean:${length_1:$local_part}}}{:?}{yes}{no}}
11070 .endd
11071 (which will false-positive if the first character of the local part is a
11072 literal question mark).
11073
11074 .vitem "&*${utf8_domain_to_alabel:*&<&'string'&>&*}*&" &&&
11075        "&*${utf8_domain_from_alabel:*&<&'string'&>&*}*&" &&&
11076        "&*${utf8_localpart_to_alabel:*&<&'string'&>&*}*&" &&&
11077        "&*${utf8_localpart_from_alabel:*&<&'string'&>&*}*&"
11078 .cindex expansion UTF-8
11079 .cindex UTF-8 expansion
11080 .cindex EAI
11081 .cindex internationalisation
11082 .cindex "&%utf8_domain_to_alabel%& expansion item"
11083 .cindex "&%utf8_domain_from_alabel%& expansion item"
11084 .cindex "&%utf8_localpart_to_alabel%& expansion item"
11085 .cindex "&%utf8_localpart_from_alabel%& expansion item"
11086 These convert EAI mail name components between UTF-8 and a-label forms.
11087 For information on internationalisation support see &<<SECTi18nMTA>>&.
11088 .endlist
11089
11090
11091
11092
11093
11094
11095 .section "Expansion conditions" "SECTexpcond"
11096 .scindex IIDexpcond "expansion" "conditions"
11097 The following conditions are available for testing by the &%${if%& construct
11098 while expanding strings:
11099
11100 .vlist
11101 .vitem &*!*&<&'condition'&>
11102 .cindex "expansion" "negating a condition"
11103 .cindex "negation" "in expansion condition"
11104 Preceding any condition with an exclamation mark negates the result of the
11105 condition.
11106
11107 .vitem <&'symbolic&~operator'&>&~&*{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11108 .cindex "numeric comparison"
11109 .cindex "expansion" "numeric comparison"
11110 There are a number of symbolic operators for doing numeric comparisons. They
11111 are:
11112 .display
11113 &`=   `&   equal
11114 &`==  `&   equal
11115 &`>   `&   greater
11116 &`>=  `&   greater or equal
11117 &`<   `&   less
11118 &`<=  `&   less or equal
11119 .endd
11120 For example:
11121 .code
11122 ${if >{$message_size}{10M} ...
11123 .endd
11124 Note that the general negation operator provides for inequality testing. The
11125 two strings must take the form of optionally signed decimal integers,
11126 optionally followed by one of the letters &"K"&, &"M"& or &"G"& (in either upper or
11127 lower case), signifying multiplication by 1024, 1024*1024 or 1024*1024*1024, respectively.
11128 As a special case, the numerical value of an empty string is taken as
11129 zero.
11130
11131 In all cases, a relative comparator OP is testing if <&'string1'&> OP
11132 <&'string2'&>; the above example is checking if &$message_size$& is larger than
11133 10M, not if 10M is larger than &$message_size$&.
11134
11135
11136 .vitem &*acl&~{{*&<&'name'&>&*}{*&<&'arg1'&>&*}&&&
11137         {*&<&'arg2'&>&*}...}*&
11138 .cindex "expansion" "calling an acl"
11139 .cindex "&%acl%&" "expansion condition"
11140 The name and zero to nine argument strings are first expanded separately.  The expanded
11141 arguments are assigned to the variables &$acl_arg1$& to &$acl_arg9$& in order.
11142 Any unused are made empty.  The variable &$acl_narg$& is set to the number of
11143 arguments.  The named ACL (see chapter &<<CHAPACL>>&) is called
11144 and may use the variables; if another acl expansion is used the values
11145 are restored after it returns.  If the ACL sets
11146 a value using a "message =" modifier the variable $value becomes
11147 the result of the expansion, otherwise it is empty.
11148 If the ACL returns accept the condition is true; if deny, false.
11149 If the ACL returns defer the result is a forced-fail.
11150
11151 .vitem &*bool&~{*&<&'string'&>&*}*&
11152 .cindex "expansion" "boolean parsing"
11153 .cindex "&%bool%& expansion condition"
11154 This condition turns a string holding a true or false representation into
11155 a boolean state.  It parses &"true"&, &"false"&, &"yes"& and &"no"&
11156 (case-insensitively); also integer numbers map to true if non-zero,
11157 false if zero.
11158 An empty string is treated as false.
11159 Leading and trailing whitespace is ignored;
11160 thus a string consisting only of whitespace is false.
11161 All other string values will result in expansion failure.
11162
11163 When combined with ACL variables, this expansion condition will let you
11164 make decisions in one place and act on those decisions in another place.
11165 For example:
11166 .code
11167 ${if bool{$acl_m_privileged_sender} ...
11168 .endd
11169
11170
11171 .vitem &*bool_lax&~{*&<&'string'&>&*}*&
11172 .cindex "expansion" "boolean parsing"
11173 .cindex "&%bool_lax%& expansion condition"
11174 Like &%bool%&, this condition turns a string into a boolean state.  But
11175 where &%bool%& accepts a strict set of strings, &%bool_lax%& uses the same
11176 loose definition that the Router &%condition%& option uses.  The empty string
11177 and the values &"false"&, &"no"& and &"0"& map to false, all others map to
11178 true.  Leading and trailing whitespace is ignored.
11179
11180 Note that where &"bool{00}"& is false, &"bool_lax{00}"& is true.
11181
11182 .vitem &*crypteq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11183 .cindex "expansion" "encrypted comparison"
11184 .cindex "encrypted strings, comparing"
11185 .cindex "&%crypteq%& expansion condition"
11186 This condition is included in the Exim binary if it is built to support any
11187 authentication mechanisms (see chapter &<<CHAPSMTPAUTH>>&). Otherwise, it is
11188 necessary to define SUPPORT_CRYPTEQ in &_Local/Makefile_& to get &%crypteq%&
11189 included in the binary.
11190
11191 The &%crypteq%& condition has two arguments. The first is encrypted and
11192 compared against the second, which is already encrypted. The second string may
11193 be in the LDAP form for storing encrypted strings, which starts with the
11194 encryption type in curly brackets, followed by the data. If the second string
11195 does not begin with &"{"& it is assumed to be encrypted with &[crypt()]& or
11196 &[crypt16()]& (see below), since such strings cannot begin with &"{"&.
11197 Typically this will be a field from a password file. An example of an encrypted
11198 string in LDAP form is:
11199 .code
11200 {md5}CY9rzUYh03PK3k6DJie09g==
11201 .endd
11202 If such a string appears directly in an expansion, the curly brackets have to
11203 be quoted, because they are part of the expansion syntax. For example:
11204 .code
11205 ${if crypteq {test}{\{md5\}CY9rzUYh03PK3k6DJie09g==}{yes}{no}}
11206 .endd
11207 The following encryption types (whose names are matched case-independently) are
11208 supported:
11209
11210 .ilist
11211 .cindex "MD5 hash"
11212 .cindex "base64 encoding" "in encrypted password"
11213 &%{md5}%& computes the MD5 digest of the first string, and expresses this as
11214 printable characters to compare with the remainder of the second string. If the
11215 length of the comparison string is 24, Exim assumes that it is base64 encoded
11216 (as in the above example). If the length is 32, Exim assumes that it is a
11217 hexadecimal encoding of the MD5 digest. If the length not 24 or 32, the
11218 comparison fails.
11219
11220 .next
11221 .cindex "SHA-1 hash"
11222 &%{sha1}%& computes the SHA-1 digest of the first string, and expresses this as
11223 printable characters to compare with the remainder of the second string. If the
11224 length of the comparison string is 28, Exim assumes that it is base64 encoded.
11225 If the length is 40, Exim assumes that it is a hexadecimal encoding of the
11226 SHA-1 digest. If the length is not 28 or 40, the comparison fails.
11227
11228 .next
11229 .cindex "&[crypt()]&"
11230 &%{crypt}%& calls the &[crypt()]& function, which traditionally used to use
11231 only the first eight characters of the password. However, in modern operating
11232 systems this is no longer true, and in many cases the entire password is used,
11233 whatever its length.
11234
11235 .next
11236 .cindex "&[crypt16()]&"
11237 &%{crypt16}%& calls the &[crypt16()]& function, which was originally created to
11238 use up to 16 characters of the password in some operating systems. Again, in
11239 modern operating systems, more characters may be used.
11240 .endlist
11241 Exim has its own version of &[crypt16()]&, which is just a double call to
11242 &[crypt()]&. For operating systems that have their own version, setting
11243 HAVE_CRYPT16 in &_Local/Makefile_& when building Exim causes it to use the
11244 operating system version instead of its own. This option is set by default in
11245 the OS-dependent &_Makefile_& for those operating systems that are known to
11246 support &[crypt16()]&.
11247
11248 Some years after Exim's &[crypt16()]& was implemented, a user discovered that
11249 it was not using the same algorithm as some operating systems' versions. It
11250 turns out that as well as &[crypt16()]& there is a function called
11251 &[bigcrypt()]& in some operating systems. This may or may not use the same
11252 algorithm, and both of them may be different to Exim's built-in &[crypt16()]&.
11253
11254 However, since there is now a move away from the traditional &[crypt()]&
11255 functions towards using SHA1 and other algorithms, tidying up this area of
11256 Exim is seen as very low priority.
11257
11258 If you do not put a encryption type (in curly brackets) in a &%crypteq%&
11259 comparison, the default is usually either &`{crypt}`& or &`{crypt16}`&, as
11260 determined by the setting of DEFAULT_CRYPT in &_Local/Makefile_&. The default
11261 default is &`{crypt}`&. Whatever the default, you can always use either
11262 function by specifying it explicitly in curly brackets.
11263
11264 .vitem &*def:*&<&'variable&~name'&>
11265 .cindex "expansion" "checking for empty variable"
11266 .cindex "&%def%& expansion condition"
11267 The &%def%& condition must be followed by the name of one of the expansion
11268 variables defined in section &<<SECTexpvar>>&. The condition is true if the
11269 variable does not contain the empty string. For example:
11270 .code
11271 ${if def:sender_ident {from $sender_ident}}
11272 .endd
11273 Note that the variable name is given without a leading &%$%& character. If the
11274 variable does not exist, the expansion fails.
11275
11276 .vitem "&*def:header_*&<&'header&~name'&>&*:*&&~&~or&~&&&
11277         &~&*def:h_*&<&'header&~name'&>&*:*&"
11278 .cindex "expansion" "checking header line existence"
11279 This condition is true if a message is being processed and the named header
11280 exists in the message. For example,
11281 .code
11282 ${if def:header_reply-to:{$h_reply-to:}{$h_from:}}
11283 .endd
11284 &*Note*&: No &%$%& appears before &%header_%& or &%h_%& in the condition, and
11285 the header name must be terminated by a colon if white space does not follow.
11286
11287 .vitem &*eq&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11288        &*eqi&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11289 .cindex "string" "comparison"
11290 .cindex "expansion" "string comparison"
11291 .cindex "&%eq%& expansion condition"
11292 .cindex "&%eqi%& expansion condition"
11293 The two substrings are first expanded. The condition is true if the two
11294 resulting strings are identical. For &%eq%& the comparison includes the case of
11295 letters, whereas for &%eqi%& the comparison is case-independent, where
11296 case is defined per the system C locale.
11297
11298 .vitem &*exists&~{*&<&'file&~name'&>&*}*&
11299 .cindex "expansion" "file existence test"
11300 .cindex "file" "existence test"
11301 .cindex "&%exists%&, expansion condition"
11302 The substring is first expanded and then interpreted as an absolute path. The
11303 condition is true if the named file (or directory) exists. The existence test
11304 is done by calling the &[stat()]& function. The use of the &%exists%& test in
11305 users' filter files may be locked out by the system administrator.
11306
11307 .vitem &*first_delivery*&
11308 .cindex "delivery" "first"
11309 .cindex "first delivery"
11310 .cindex "expansion" "first delivery test"
11311 .cindex "&%first_delivery%& expansion condition"
11312 This condition, which has no data, is true during a message's first delivery
11313 attempt. It is false during any subsequent delivery attempts.
11314
11315
11316 .vitem "&*forall{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&" &&&
11317        "&*forany{*&<&'a list'&>&*}{*&<&'a condition'&>&*}*&"
11318 .cindex "list" "iterative conditions"
11319 .cindex "expansion" "&*forall*& condition"
11320 .cindex "expansion" "&*forany*& condition"
11321 .vindex "&$item$&"
11322 These conditions iterate over a list. The first argument is expanded to form
11323 the list. By default, the list separator is a colon, but it can be changed by
11324 the normal method (&<<SECTlistsepchange>>&).
11325 The second argument is interpreted as a condition that is to
11326 be applied to each item in the list in turn. During the interpretation of the
11327 condition, the current list item is placed in a variable called &$item$&.
11328 .ilist
11329 For &*forany*&, interpretation stops if the condition is true for any item, and
11330 the result of the whole condition is true. If the condition is false for all
11331 items in the list, the overall condition is false.
11332 .next
11333 For &*forall*&, interpretation stops if the condition is false for any item,
11334 and the result of the whole condition is false. If the condition is true for
11335 all items in the list, the overall condition is true.
11336 .endlist
11337 Note that negation of &*forany*& means that the condition must be false for all
11338 items for the overall condition to succeed, and negation of &*forall*& means
11339 that the condition must be false for at least one item. In this example, the
11340 list separator is changed to a comma:
11341 .code
11342 ${if forany{<, $recipients}{match{$item}{^user3@}}{yes}{no}}
11343 .endd
11344 The value of &$item$& is saved and restored while &*forany*& or &*forall*& is
11345 being processed, to enable these expansion items to be nested.
11346
11347 To scan a named list, expand it with the &*listnamed*& operator.
11348
11349 .new
11350 .vitem "&*forall_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11351        "&*forany_json{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11352        "&*forall_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&" &&&
11353        "&*forany_jsons{*&<&'a JSON array'&>&*}{*&<&'a condition'&>&*}*&"
11354 .cindex JSON "iterative conditions"
11355 .cindex JSON expansions
11356 .cindex expansion "&*forall_json*& condition"
11357 .cindex expansion "&*forany_json*& condition"
11358 .cindex expansion "&*forall_jsons*& condition"
11359 .cindex expansion "&*forany_jsons*& condition"
11360 As for the above, except that the first argument must, after expansion,
11361 be a JSON array.
11362 The array separator is not changeable.
11363 For the &"jsons"& variants the elements are expected to be JSON strings
11364 and have their quotes removed before the evaluation of the condition.
11365 .wen
11366
11367
11368
11369 .vitem &*ge&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11370        &*gei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11371 .cindex "string" "comparison"
11372 .cindex "expansion" "string comparison"
11373 .cindex "&%ge%& expansion condition"
11374 .cindex "&%gei%& expansion condition"
11375 The two substrings are first expanded. The condition is true if the first
11376 string is lexically greater than or equal to the second string. For &%ge%& the
11377 comparison includes the case of letters, whereas for &%gei%& the comparison is
11378 case-independent.
11379 Case and collation order are defined per the system C locale.
11380
11381 .vitem &*gt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11382        &*gti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11383 .cindex "string" "comparison"
11384 .cindex "expansion" "string comparison"
11385 .cindex "&%gt%& expansion condition"
11386 .cindex "&%gti%& expansion condition"
11387 The two substrings are first expanded. The condition is true if the first
11388 string is lexically greater than the second string. For &%gt%& the comparison
11389 includes the case of letters, whereas for &%gti%& the comparison is
11390 case-independent.
11391 Case and collation order are defined per the system C locale.
11392
11393 .vitem &*inlist&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11394        &*inlisti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11395 .cindex "string" "comparison"
11396 .cindex "list" "iterative conditions"
11397 Both strings are expanded; the second string is treated as a list of simple
11398 strings; if the first string is a member of the second, then the condition
11399 is true.
11400 For the case-independent &%inlisti%& condition, case is defined per the system C locale.
11401
11402 These are simpler to use versions of the more powerful &*forany*& condition.
11403 Examples, and the &*forany*& equivalents:
11404 .code
11405 ${if inlist{needle}{foo:needle:bar}}
11406   ${if forany{foo:needle:bar}{eq{$item}{needle}}}
11407 ${if inlisti{Needle}{fOo:NeeDLE:bAr}}
11408   ${if forany{fOo:NeeDLE:bAr}{eqi{$item}{Needle}}}
11409 .endd
11410
11411 .vitem &*isip&~{*&<&'string'&>&*}*&  &&&
11412        &*isip4&~{*&<&'string'&>&*}*& &&&
11413        &*isip6&~{*&<&'string'&>&*}*&
11414 .cindex "IP address" "testing string format"
11415 .cindex "string" "testing for IP address"
11416 .cindex "&%isip%& expansion condition"
11417 .cindex "&%isip4%& expansion condition"
11418 .cindex "&%isip6%& expansion condition"
11419 The substring is first expanded, and then tested to see if it has the form of
11420 an IP address. Both IPv4 and IPv6 addresses are valid for &%isip%&, whereas
11421 &%isip4%& and &%isip6%& test specifically for IPv4 or IPv6 addresses.
11422
11423 For an IPv4 address, the test is for four dot-separated components, each of
11424 which consists of from one to three digits. For an IPv6 address, up to eight
11425 colon-separated components are permitted, each containing from one to four
11426 hexadecimal digits. There may be fewer than eight components if an empty
11427 component (adjacent colons) is present. Only one empty component is permitted.
11428
11429 &*Note*&: The checks used to be just on the form of the address; actual numerical
11430 values were not considered. Thus, for example, 999.999.999.999 passed the IPv4
11431 check.
11432 This is no longer the case.
11433
11434 The main use of these tests is to distinguish between IP addresses and
11435 host names, or between IPv4 and IPv6 addresses. For example, you could use
11436 .code
11437 ${if isip4{$sender_host_address}...
11438 .endd
11439 to test which IP version an incoming SMTP connection is using.
11440
11441 .vitem &*ldapauth&~{*&<&'ldap&~query'&>&*}*&
11442 .cindex "LDAP" "use for authentication"
11443 .cindex "expansion" "LDAP authentication test"
11444 .cindex "&%ldapauth%& expansion condition"
11445 This condition supports user authentication using LDAP. See section
11446 &<<SECTldap>>& for details of how to use LDAP in lookups and the syntax of
11447 queries. For this use, the query must contain a user name and password. The
11448 query itself is not used, and can be empty. The condition is true if the
11449 password is not empty, and the user name and password are accepted by the LDAP
11450 server. An empty password is rejected without calling LDAP because LDAP binds
11451 with an empty password are considered anonymous regardless of the username, and
11452 will succeed in most configurations. See chapter &<<CHAPSMTPAUTH>>& for details
11453 of SMTP authentication, and chapter &<<CHAPplaintext>>& for an example of how
11454 this can be used.
11455
11456
11457 .vitem &*le&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11458        &*lei&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11459 .cindex "string" "comparison"
11460 .cindex "expansion" "string comparison"
11461 .cindex "&%le%& expansion condition"
11462 .cindex "&%lei%& expansion condition"
11463 The two substrings are first expanded. The condition is true if the first
11464 string is lexically less than or equal to the second string. For &%le%& the
11465 comparison includes the case of letters, whereas for &%lei%& the comparison is
11466 case-independent.
11467 Case and collation order are defined per the system C locale.
11468
11469 .vitem &*lt&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*& &&&
11470        &*lti&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11471 .cindex "string" "comparison"
11472 .cindex "expansion" "string comparison"
11473 .cindex "&%lt%& expansion condition"
11474 .cindex "&%lti%& expansion condition"
11475 The two substrings are first expanded. The condition is true if the first
11476 string is lexically less than the second string. For &%lt%& the comparison
11477 includes the case of letters, whereas for &%lti%& the comparison is
11478 case-independent.
11479 Case and collation order are defined per the system C locale.
11480
11481
11482 .vitem &*match&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11483 .cindex "expansion" "regular expression comparison"
11484 .cindex "regular expressions" "match in expanded string"
11485 .cindex "&%match%& expansion condition"
11486 The two substrings are first expanded. The second is then treated as a regular
11487 expression and applied to the first. Because of the pre-expansion, if the
11488 regular expression contains dollar, or backslash characters, they must be
11489 escaped. Care must also be taken if the regular expression contains braces
11490 (curly brackets). A closing brace must be escaped so that it is not taken as a
11491 premature termination of <&'string2'&>. The easiest approach is to use the
11492 &`\N`& feature to disable expansion of the regular expression.
11493 For example,
11494 .code
11495 ${if match {$local_part}{\N^\d{3}\N} ...
11496 .endd
11497 If the whole expansion string is in double quotes, further escaping of
11498 backslashes is also required.
11499
11500 The condition is true if the regular expression match succeeds.
11501 The regular expression is not required to begin with a circumflex
11502 metacharacter, but if there is no circumflex, the expression is not anchored,
11503 and it may match anywhere in the subject, not just at the start. If you want
11504 the pattern to match at the end of the subject, you must include the &`$`&
11505 metacharacter at an appropriate point.
11506 All character handling is done in bytes and is not UTF-8 aware,
11507 but we might change this in a future Exim release.
11508
11509 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%if%& expansion"
11510 At the start of an &%if%& expansion the values of the numeric variable
11511 substitutions &$1$& etc. are remembered. Obeying a &%match%& condition that
11512 succeeds causes them to be reset to the substrings of that condition and they
11513 will have these values during the expansion of the success string. At the end
11514 of the &%if%& expansion, the previous values are restored. After testing a
11515 combination of conditions using &%or%&, the subsequent values of the numeric
11516 variables are those of the condition that succeeded.
11517
11518 .vitem &*match_address&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11519 .cindex "&%match_address%& expansion condition"
11520 See &*match_local_part*&.
11521
11522 .vitem &*match_domain&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11523 .cindex "&%match_domain%& expansion condition"
11524 See &*match_local_part*&.
11525
11526 .vitem &*match_ip&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11527 .cindex "&%match_ip%& expansion condition"
11528 This condition matches an IP address to a list of IP address patterns. It must
11529 be followed by two argument strings. The first (after expansion) must be an IP
11530 address or an empty string. The second (not expanded) is a restricted host
11531 list that can match only an IP address, not a host name. For example:
11532 .code
11533 ${if match_ip{$sender_host_address}{1.2.3.4:5.6.7.8}{...}{...}}
11534 .endd
11535 The specific types of host list item that are permitted in the list are:
11536
11537 .ilist
11538 An IP address, optionally with a CIDR mask.
11539 .next
11540 A single asterisk, which matches any IP address.
11541 .next
11542 An empty item, which matches only if the IP address is empty. This could be
11543 useful for testing for a locally submitted message or one from specific hosts
11544 in a single test such as
11545 . ==== As this is a nested list, any displays it contains must be indented
11546 . ==== as otherwise they are too far to the left. This comment applies to
11547 . ==== the use of xmlto plus fop. There's no problem when formatting with
11548 . ==== sdop, with or without the extra indent.
11549 .code
11550   ${if match_ip{$sender_host_address}{:4.3.2.1:...}{...}{...}}
11551 .endd
11552 where the first item in the list is the empty string.
11553 .next
11554 The item @[] matches any of the local host's interface addresses.
11555 .next
11556 Single-key lookups are assumed to be like &"net-"& style lookups in host lists,
11557 even if &`net-`& is not specified. There is never any attempt to turn the IP
11558 address into a host name. The most common type of linear search for
11559 &*match_ip*& is likely to be &*iplsearch*&, in which the file can contain CIDR
11560 masks. For example:
11561 .code
11562   ${if match_ip{$sender_host_address}{iplsearch;/some/file}...
11563 .endd
11564 It is of course possible to use other kinds of lookup, and in such a case, you
11565 do need to specify the &`net-`& prefix if you want to specify a specific
11566 address mask, for example:
11567 .code
11568   ${if match_ip{$sender_host_address}{net24-dbm;/some/file}...
11569 .endd
11570 However, unless you are combining a &%match_ip%& condition with others, it is
11571 just as easy to use the fact that a lookup is itself a condition, and write:
11572 .code
11573   ${lookup{${mask:$sender_host_address/24}}dbm{/a/file}...
11574 .endd
11575 .endlist ilist
11576
11577 Note that <&'string2'&> is not itself subject to string expansion, unless
11578 Exim was built with the EXPAND_LISTMATCH_RHS option.
11579
11580 Consult section &<<SECThoslispatip>>& for further details of these patterns.
11581
11582 .vitem &*match_local_part&~{*&<&'string1'&>&*}{*&<&'string2'&>&*}*&
11583 .cindex "domain list" "in expansion condition"
11584 .cindex "address list" "in expansion condition"
11585 .cindex "local part" "list, in expansion condition"
11586 .cindex "&%match_local_part%& expansion condition"
11587 This condition, together with &%match_address%& and &%match_domain%&, make it
11588 possible to test domain, address, and local part lists within expansions. Each
11589 condition requires two arguments: an item and a list to match. A trivial
11590 example is:
11591 .code
11592 ${if match_domain{a.b.c}{x.y.z:a.b.c:p.q.r}{yes}{no}}
11593 .endd
11594 In each case, the second argument may contain any of the allowable items for a
11595 list of the appropriate type. Also, because the second argument
11596 is a standard form of list, it is possible to refer to a named list.
11597 Thus, you can use conditions like this:
11598 .code
11599 ${if match_domain{$domain}{+local_domains}{...
11600 .endd
11601 .cindex "&`+caseful`&"
11602 For address lists, the matching starts off caselessly, but the &`+caseful`&
11603 item can be used, as in all address lists, to cause subsequent items to
11604 have their local parts matched casefully. Domains are always matched
11605 caselessly.
11606
11607 Note that <&'string2'&> is not itself subject to string expansion, unless
11608 Exim was built with the EXPAND_LISTMATCH_RHS option.
11609
11610 &*Note*&: Host lists are &'not'& supported in this way. This is because
11611 hosts have two identities: a name and an IP address, and it is not clear
11612 how to specify cleanly how such a test would work. However, IP addresses can be
11613 matched using &%match_ip%&.
11614
11615 .vitem &*pam&~{*&<&'string1'&>&*:*&<&'string2'&>&*:...}*&
11616 .cindex "PAM authentication"
11617 .cindex "AUTH" "with PAM"
11618 .cindex "Solaris" "PAM support"
11619 .cindex "expansion" "PAM authentication test"
11620 .cindex "&%pam%& expansion condition"
11621 &'Pluggable Authentication Modules'&
11622 (&url(https://mirrors.edge.kernel.org/pub/linux/libs/pam/)) are a facility that is
11623 available in the latest releases of Solaris and in some GNU/Linux
11624 distributions. The Exim support, which is intended for use in conjunction with
11625 the SMTP AUTH command, is available only if Exim is compiled with
11626 .code
11627 SUPPORT_PAM=yes
11628 .endd
11629 in &_Local/Makefile_&. You probably need to add &%-lpam%& to EXTRALIBS, and
11630 in some releases of GNU/Linux &%-ldl%& is also needed.
11631
11632 The argument string is first expanded, and the result must be a
11633 colon-separated list of strings. Leading and trailing white space is ignored.
11634 The PAM module is initialized with the service name &"exim"& and the user name
11635 taken from the first item in the colon-separated data string (<&'string1'&>).
11636 The remaining items in the data string are passed over in response to requests
11637 from the authentication function. In the simple case there will only be one
11638 request, for a password, so the data consists of just two strings.
11639
11640 There can be problems if any of the strings are permitted to contain colon
11641 characters. In the usual way, these have to be doubled to avoid being taken as
11642 separators. If the data is being inserted from a variable, the &%sg%& expansion
11643 item can be used to double any existing colons. For example, the configuration
11644 of a LOGIN authenticator might contain this setting:
11645 .code
11646 server_condition = ${if pam{$auth1:${sg{$auth2}{:}{::}}}}
11647 .endd
11648 For a PLAIN authenticator you could use:
11649 .code
11650 server_condition = ${if pam{$auth2:${sg{$auth3}{:}{::}}}}
11651 .endd
11652 In some operating systems, PAM authentication can be done only from a process
11653 running as root. Since Exim is running as the Exim user when receiving
11654 messages, this means that PAM cannot be used directly in those systems.
11655 . --- 2018-09-07: the pam_exim modified variant has gone, removed claims re using Exim via that
11656
11657
11658 .vitem &*pwcheck&~{*&<&'string1'&>&*:*&<&'string2'&>&*}*&
11659 .cindex "&'pwcheck'& daemon"
11660 .cindex "Cyrus"
11661 .cindex "expansion" "&'pwcheck'& authentication test"
11662 .cindex "&%pwcheck%& expansion condition"
11663 This condition supports user authentication using the Cyrus &'pwcheck'& daemon.
11664 This is one way of making it possible for passwords to be checked by a process
11665 that is not running as root. &*Note*&: The use of &'pwcheck'& is now
11666 deprecated. Its replacement is &'saslauthd'& (see below).
11667
11668 The pwcheck support is not included in Exim by default. You need to specify
11669 the location of the pwcheck daemon's socket in &_Local/Makefile_& before
11670 building Exim. For example:
11671 .code
11672 CYRUS_PWCHECK_SOCKET=/var/pwcheck/pwcheck
11673 .endd
11674 You do not need to install the full Cyrus software suite in order to use
11675 the pwcheck daemon. You can compile and install just the daemon alone
11676 from the Cyrus SASL library. Ensure that &'exim'& is the only user that has
11677 access to the &_/var/pwcheck_& directory.
11678
11679 The &%pwcheck%& condition takes one argument, which must be the user name and
11680 password, separated by a colon. For example, in a LOGIN authenticator
11681 configuration, you might have this:
11682 .code
11683 server_condition = ${if pwcheck{$auth1:$auth2}}
11684 .endd
11685 Again, for a PLAIN authenticator configuration, this would be:
11686 .code
11687 server_condition = ${if pwcheck{$auth2:$auth3}}
11688 .endd
11689 .vitem &*queue_running*&
11690 .cindex "queue runner" "detecting when delivering from"
11691 .cindex "expansion" "queue runner test"
11692 .cindex "&%queue_running%& expansion condition"
11693 This condition, which has no data, is true during delivery attempts that are
11694 initiated by queue runner processes, and false otherwise.
11695
11696
11697 .vitem &*radius&~{*&<&'authentication&~string'&>&*}*&
11698 .cindex "Radius"
11699 .cindex "expansion" "Radius authentication"
11700 .cindex "&%radius%& expansion condition"
11701 Radius authentication (RFC 2865) is supported in a similar way to PAM. You must
11702 set RADIUS_CONFIG_FILE in &_Local/Makefile_& to specify the location of
11703 the Radius client configuration file in order to build Exim with Radius
11704 support.
11705
11706 With just that one setting, Exim expects to be linked with the &%radiusclient%&
11707 library, using the original API. If you are using release 0.4.0 or later of
11708 this library, you need to set
11709 .code
11710 RADIUS_LIB_TYPE=RADIUSCLIENTNEW
11711 .endd
11712 in &_Local/Makefile_& when building Exim. You can also link Exim with the
11713 &%libradius%& library that comes with FreeBSD. To do this, set
11714 .code
11715 RADIUS_LIB_TYPE=RADLIB
11716 .endd
11717 in &_Local/Makefile_&, in addition to setting RADIUS_CONFIGURE_FILE.
11718 You may also have to supply a suitable setting in EXTRALIBS so that the
11719 Radius library can be found when Exim is linked.
11720
11721 The string specified by RADIUS_CONFIG_FILE is expanded and passed to the
11722 Radius client library, which calls the Radius server. The condition is true if
11723 the authentication is successful. For example:
11724 .code
11725 server_condition = ${if radius{<arguments>}}
11726 .endd
11727
11728
11729 .vitem "&*saslauthd&~{{*&<&'user'&>&*}{*&<&'password'&>&*}&&&
11730         {*&<&'service'&>&*}{*&<&'realm'&>&*}}*&"
11731 .cindex "&'saslauthd'& daemon"
11732 .cindex "Cyrus"
11733 .cindex "expansion" "&'saslauthd'& authentication test"
11734 .cindex "&%saslauthd%& expansion condition"
11735 This condition supports user authentication using the Cyrus &'saslauthd'&
11736 daemon. This replaces the older &'pwcheck'& daemon, which is now deprecated.
11737 Using this daemon is one way of making it possible for passwords to be checked
11738 by a process that is not running as root.
11739
11740 The saslauthd support is not included in Exim by default. You need to specify
11741 the location of the saslauthd daemon's socket in &_Local/Makefile_& before
11742 building Exim. For example:
11743 .code
11744 CYRUS_SASLAUTHD_SOCKET=/var/state/saslauthd/mux
11745 .endd
11746 You do not need to install the full Cyrus software suite in order to use
11747 the saslauthd daemon. You can compile and install just the daemon alone
11748 from the Cyrus SASL library.
11749
11750 Up to four arguments can be supplied to the &%saslauthd%& condition, but only
11751 two are mandatory. For example:
11752 .code
11753 server_condition = ${if saslauthd{{$auth1}{$auth2}}}
11754 .endd
11755 The service and the realm are optional (which is why the arguments are enclosed
11756 in their own set of braces). For details of the meaning of the service and
11757 realm, and how to run the daemon, consult the Cyrus documentation.
11758 .endlist vlist
11759
11760
11761
11762 .section "Combining expansion conditions" "SECID84"
11763 .cindex "expansion" "combining conditions"
11764 Several conditions can be tested at once by combining them using the &%and%&
11765 and &%or%& combination conditions. Note that &%and%& and &%or%& are complete
11766 conditions on their own, and precede their lists of sub-conditions. Each
11767 sub-condition must be enclosed in braces within the overall braces that contain
11768 the list. No repetition of &%if%& is used.
11769
11770
11771 .vlist
11772 .vitem &*or&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11773 .cindex "&""or""& expansion condition"
11774 .cindex "expansion" "&""or""& of conditions"
11775 The sub-conditions are evaluated from left to right. The condition is true if
11776 any one of the sub-conditions is true.
11777 For example,
11778 .code
11779 ${if or {{eq{$local_part}{spqr}}{eq{$domain}{testing.com}}}...
11780 .endd
11781 When a true sub-condition is found, the following ones are parsed but not
11782 evaluated. If there are several &"match"& sub-conditions the values of the
11783 numeric variables afterwards are taken from the first one that succeeds.
11784
11785 .vitem &*and&~{{*&<&'cond1'&>&*}{*&<&'cond2'&>&*}...}*&
11786 .cindex "&""and""& expansion condition"
11787 .cindex "expansion" "&""and""& of conditions"
11788 The sub-conditions are evaluated from left to right. The condition is true if
11789 all of the sub-conditions are true. If there are several &"match"&
11790 sub-conditions, the values of the numeric variables afterwards are taken from
11791 the last one. When a false sub-condition is found, the following ones are
11792 parsed but not evaluated.
11793 .endlist
11794 .ecindex IIDexpcond
11795
11796
11797
11798
11799 .section "Expansion variables" "SECTexpvar"
11800 .cindex "expansion" "variables, list of"
11801 This section contains an alphabetical list of all the expansion variables. Some
11802 of them are available only when Exim is compiled with specific options such as
11803 support for TLS or the content scanning extension.
11804
11805 .vlist
11806 .vitem "&$0$&, &$1$&, etc"
11807 .cindex "numerical variables (&$1$& &$2$& etc)"
11808 When a &%match%& expansion condition succeeds, these variables contain the
11809 captured substrings identified by the regular expression during subsequent
11810 processing of the success string of the containing &%if%& expansion item.
11811 In the expansion condition case
11812 they do not retain their values afterwards; in fact, their previous
11813 values are restored at the end of processing an &%if%& item. The numerical
11814 variables may also be set externally by some other matching process which
11815 precedes the expansion of the string. For example, the commands available in
11816 Exim filter files include an &%if%& command with its own regular expression
11817 matching condition.
11818
11819 .vitem "&$acl_arg1$&, &$acl_arg2$&, etc"
11820 Within an acl condition, expansion condition or expansion item
11821 any arguments are copied to these variables,
11822 any unused variables being made empty.
11823
11824 .vitem "&$acl_c...$&"
11825 Values can be placed in these variables by the &%set%& modifier in an ACL. They
11826 can be given any name that starts with &$acl_c$& and is at least six characters
11827 long, but the sixth character must be either a digit or an underscore. For
11828 example: &$acl_c5$&, &$acl_c_mycount$&. The values of the &$acl_c...$&
11829 variables persist throughout the lifetime of an SMTP connection. They can be
11830 used to pass information between ACLs and between different invocations of the
11831 same ACL. When a message is received, the values of these variables are saved
11832 with the message, and can be accessed by filters, routers, and transports
11833 during subsequent delivery.
11834
11835 .vitem "&$acl_m...$&"
11836 These variables are like the &$acl_c...$& variables, except that their values
11837 are reset after a message has been received. Thus, if several messages are
11838 received in one SMTP connection, &$acl_m...$& values are not passed on from one
11839 message to the next, as &$acl_c...$& values are. The &$acl_m...$& variables are
11840 also reset by MAIL, RSET, EHLO, HELO, and after starting a TLS session. When a
11841 message is received, the values of these variables are saved with the message,
11842 and can be accessed by filters, routers, and transports during subsequent
11843 delivery.
11844
11845 .vitem &$acl_narg$&
11846 Within an acl condition, expansion condition or expansion item
11847 this variable has the number of arguments.
11848
11849 .vitem &$acl_verify_message$&
11850 .vindex "&$acl_verify_message$&"
11851 After an address verification has failed, this variable contains the failure
11852 message. It retains its value for use in subsequent modifiers. The message can
11853 be preserved by coding like this:
11854 .code
11855 warn !verify = sender
11856      set acl_m0 = $acl_verify_message
11857 .endd
11858 You can use &$acl_verify_message$& during the expansion of the &%message%& or
11859 &%log_message%& modifiers, to include information about the verification
11860 failure.
11861
11862 .vitem &$address_data$&
11863 .vindex "&$address_data$&"
11864 This variable is set by means of the &%address_data%& option in routers. The
11865 value then remains with the address while it is processed by subsequent routers
11866 and eventually a transport. If the transport is handling multiple addresses,
11867 the value from the first address is used. See chapter &<<CHAProutergeneric>>&
11868 for more details. &*Note*&: The contents of &$address_data$& are visible in
11869 user filter files.
11870
11871 If &$address_data$& is set when the routers are called from an ACL to verify
11872 a recipient address, the final value is still in the variable for subsequent
11873 conditions and modifiers of the ACL statement. If routing the address caused it
11874 to be redirected to just one address, the child address is also routed as part
11875 of the verification, and in this case the final value of &$address_data$& is
11876 from the child's routing.
11877
11878 If &$address_data$& is set when the routers are called from an ACL to verify a
11879 sender address, the final value is also preserved, but this time in
11880 &$sender_address_data$&, to distinguish it from data from a recipient
11881 address.
11882
11883 In both cases (recipient and sender verification), the value does not persist
11884 after the end of the current ACL statement. If you want to preserve
11885 these values for longer, you can save them in ACL variables.
11886
11887 .vitem &$address_file$&
11888 .vindex "&$address_file$&"
11889 When, as a result of aliasing, forwarding, or filtering, a message is directed
11890 to a specific file, this variable holds the name of the file when the transport
11891 is running. At other times, the variable is empty. For example, using the
11892 default configuration, if user &%r2d2%& has a &_.forward_& file containing
11893 .code
11894 /home/r2d2/savemail
11895 .endd
11896 then when the &(address_file)& transport is running, &$address_file$&
11897 contains the text string &`/home/r2d2/savemail`&.
11898 .cindex "Sieve filter" "value of &$address_file$&"
11899 For Sieve filters, the value may be &"inbox"& or a relative folder name. It is
11900 then up to the transport configuration to generate an appropriate absolute path
11901 to the relevant file.
11902
11903 .vitem &$address_pipe$&
11904 .vindex "&$address_pipe$&"
11905 When, as a result of aliasing or forwarding, a message is directed to a pipe,
11906 this variable holds the pipe command when the transport is running.
11907
11908 .vitem "&$auth1$& &-- &$auth3$&"
11909 .vindex "&$auth1$&, &$auth2$&, etc"
11910 These variables are used in SMTP authenticators (see chapters
11911 &<<CHAPplaintext>>&&--&<<CHAPtlsauth>>&). Elsewhere, they are empty.
11912
11913 .vitem &$authenticated_id$&
11914 .cindex "authentication" "id"
11915 .vindex "&$authenticated_id$&"
11916 When a server successfully authenticates a client it may be configured to
11917 preserve some of the authentication information in the variable
11918 &$authenticated_id$& (see chapter &<<CHAPSMTPAUTH>>&). For example, a
11919 user/password authenticator configuration might preserve the user name for use
11920 in the routers. Note that this is not the same information that is saved in
11921 &$sender_host_authenticated$&.
11922
11923 When a message is submitted locally (that is, not over a TCP connection)
11924 the value of &$authenticated_id$& is normally the login name of the calling
11925 process. However, a trusted user can override this by means of the &%-oMai%&
11926 command line option.
11927 This second case also sets up information used by the
11928 &$authresults$& expansion item.
11929
11930 .vitem &$authenticated_fail_id$&
11931 .cindex "authentication" "fail" "id"
11932 .vindex "&$authenticated_fail_id$&"
11933 When an authentication attempt fails, the variable &$authenticated_fail_id$&
11934 will contain the failed authentication id. If more than one authentication
11935 id is attempted, it will contain only the last one. The variable is
11936 available for processing in the ACL's, generally the quit or notquit ACL.
11937 A message to a local recipient could still be accepted without requiring
11938 authentication, which means this variable could also be visible in all of
11939 the ACL's as well.
11940
11941
11942 .vitem &$authenticated_sender$&
11943 .cindex "sender" "authenticated"
11944 .cindex "authentication" "sender"
11945 .cindex "AUTH" "on MAIL command"
11946 .vindex "&$authenticated_sender$&"
11947 When acting as a server, Exim takes note of the AUTH= parameter on an incoming
11948 SMTP MAIL command if it believes the sender is sufficiently trusted, as
11949 described in section &<<SECTauthparamail>>&. Unless the data is the string
11950 &"<>"&, it is set as the authenticated sender of the message, and the value is
11951 available during delivery in the &$authenticated_sender$& variable. If the
11952 sender is not trusted, Exim accepts the syntax of AUTH=, but ignores the data.
11953
11954 .vindex "&$qualify_domain$&"
11955 When a message is submitted locally (that is, not over a TCP connection), the
11956 value of &$authenticated_sender$& is an address constructed from the login
11957 name of the calling process and &$qualify_domain$&, except that a trusted user
11958 can override this by means of the &%-oMas%& command line option.
11959
11960
11961 .vitem &$authentication_failed$&
11962 .cindex "authentication" "failure"
11963 .vindex "&$authentication_failed$&"
11964 This variable is set to &"1"& in an Exim server if a client issues an AUTH
11965 command that does not succeed. Otherwise it is set to &"0"&. This makes it
11966 possible to distinguish between &"did not try to authenticate"&
11967 (&$sender_host_authenticated$& is empty and &$authentication_failed$& is set to
11968 &"0"&) and &"tried to authenticate but failed"& (&$sender_host_authenticated$&
11969 is empty and &$authentication_failed$& is set to &"1"&). Failure includes any
11970 negative response to an AUTH command, including (for example) an attempt to use
11971 an undefined mechanism.
11972
11973 .vitem &$av_failed$&
11974 .cindex "content scanning" "AV scanner failure"
11975 This variable is available when Exim is compiled with the content-scanning
11976 extension. It is set to &"0"& by default, but will be set to &"1"& if any
11977 problem occurs with the virus scanner (specified by &%av_scanner%&) during
11978 the ACL malware condition.
11979
11980 .vitem &$body_linecount$&
11981 .cindex "message body" "line count"
11982 .cindex "body of message" "line count"
11983 .vindex "&$body_linecount$&"
11984 When a message is being received or delivered, this variable contains the
11985 number of lines in the message's body. See also &$message_linecount$&.
11986
11987 .vitem &$body_zerocount$&
11988 .cindex "message body" "binary zero count"
11989 .cindex "body of message" "binary zero count"
11990 .cindex "binary zero" "in message body"
11991 .vindex "&$body_zerocount$&"
11992 When a message is being received or delivered, this variable contains the
11993 number of binary zero bytes (ASCII NULs) in the message's body.
11994
11995 .vitem &$bounce_recipient$&
11996 .vindex "&$bounce_recipient$&"
11997 This is set to the recipient address of a bounce message while Exim is creating
11998 it. It is useful if a customized bounce message text file is in use (see
11999 chapter &<<CHAPemsgcust>>&).
12000
12001 .vitem &$bounce_return_size_limit$&
12002 .vindex "&$bounce_return_size_limit$&"
12003 This contains the value set in the &%bounce_return_size_limit%& option, rounded
12004 up to a multiple of 1000. It is useful when a customized error message text
12005 file is in use (see chapter &<<CHAPemsgcust>>&).
12006
12007 .vitem &$caller_gid$&
12008 .cindex "gid (group id)" "caller"
12009 .vindex "&$caller_gid$&"
12010 The real group id under which the process that called Exim was running. This is
12011 not the same as the group id of the originator of a message (see
12012 &$originator_gid$&). If Exim re-execs itself, this variable in the new
12013 incarnation normally contains the Exim gid.
12014
12015 .vitem &$caller_uid$&
12016 .cindex "uid (user id)" "caller"
12017 .vindex "&$caller_uid$&"
12018 The real user id under which the process that called Exim was running. This is
12019 not the same as the user id of the originator of a message (see
12020 &$originator_uid$&). If Exim re-execs itself, this variable in the new
12021 incarnation normally contains the Exim uid.
12022
12023 .vitem &$callout_address$&
12024 .vindex "&$callout_address$&"
12025 After a callout for verification, spamd or malware daemon service, the
12026 address that was connected to.
12027
12028 .vitem &$compile_number$&
12029 .vindex "&$compile_number$&"
12030 The building process for Exim keeps a count of the number
12031 of times it has been compiled. This serves to distinguish different
12032 compilations of the same version of Exim.
12033
12034 .vitem &$config_dir$&
12035 .vindex "&$config_dir$&"
12036 The directory name of the main configuration file. That is, the content of
12037 &$config_file$& with the last component stripped. The value does not
12038 contain the trailing slash. If &$config_file$& does not contain a slash,
12039 &$config_dir$& is ".".
12040
12041 .vitem &$config_file$&
12042 .vindex "&$config_file$&"
12043 The name of the main configuration file Exim is using.
12044
12045 .vitem &$dkim_verify_status$&
12046 Results of DKIM verification.
12047 For details see section &<<SECDKIMVFY>>&.
12048
12049 .vitem &$dkim_cur_signer$& &&&
12050        &$dkim_verify_reason$& &&&
12051        &$dkim_domain$& &&&
12052        &$dkim_identity$& &&&
12053        &$dkim_selector$& &&&
12054        &$dkim_algo$& &&&
12055        &$dkim_canon_body$& &&&
12056        &$dkim_canon_headers$& &&&
12057        &$dkim_copiedheaders$& &&&
12058        &$dkim_bodylength$& &&&
12059        &$dkim_created$& &&&
12060        &$dkim_expires$& &&&
12061        &$dkim_headernames$& &&&
12062        &$dkim_key_testing$& &&&
12063        &$dkim_key_nosubdomains$& &&&
12064        &$dkim_key_srvtype$& &&&
12065        &$dkim_key_granularity$& &&&
12066        &$dkim_key_notes$& &&&
12067        &$dkim_key_length$&
12068 These variables are only available within the DKIM ACL.
12069 For details see section &<<SECDKIMVFY>>&.
12070
12071 .vitem &$dkim_signers$&
12072 .vindex &$dkim_signers$&
12073 When a message has been received this variable contains
12074 a colon-separated list of signer domains and identities for the message.
12075 For details see section &<<SECDKIMVFY>>&.
12076
12077 .vitem &$dnslist_domain$& &&&
12078        &$dnslist_matched$& &&&
12079        &$dnslist_text$& &&&
12080        &$dnslist_value$&
12081 .vindex "&$dnslist_domain$&"
12082 .vindex "&$dnslist_matched$&"
12083 .vindex "&$dnslist_text$&"
12084 .vindex "&$dnslist_value$&"
12085 .cindex "black list (DNS)"
12086 When a DNS (black) list lookup succeeds, these variables are set to contain
12087 the following data from the lookup: the list's domain name, the key that was
12088 looked up, the contents of any associated TXT record, and the value from the
12089 main A record. See section &<<SECID204>>& for more details.
12090
12091 .vitem &$domain$&
12092 .vindex "&$domain$&"
12093 When an address is being routed, or delivered on its own, this variable
12094 contains the domain. Uppercase letters in the domain are converted into lower
12095 case for &$domain$&.
12096
12097 Global address rewriting happens when a message is received, so the value of
12098 &$domain$& during routing and delivery is the value after rewriting. &$domain$&
12099 is set during user filtering, but not during system filtering, because a
12100 message may have many recipients and the system filter is called just once.
12101
12102 When more than one address is being delivered at once (for example, several
12103 RCPT commands in one SMTP delivery), &$domain$& is set only if they all
12104 have the same domain. Transports can be restricted to handling only one domain
12105 at a time if the value of &$domain$& is required at transport time &-- this is
12106 the default for local transports. For further details of the environment in
12107 which local transports are run, see chapter &<<CHAPenvironment>>&.
12108
12109 .oindex "&%delay_warning_condition%&"
12110 At the end of a delivery, if all deferred addresses have the same domain, it is
12111 set in &$domain$& during the expansion of &%delay_warning_condition%&.
12112
12113 The &$domain$& variable is also used in some other circumstances:
12114
12115 .ilist
12116 When an ACL is running for a RCPT command, &$domain$& contains the domain of
12117 the recipient address. The domain of the &'sender'& address is in
12118 &$sender_address_domain$& at both MAIL time and at RCPT time. &$domain$& is not
12119 normally set during the running of the MAIL ACL. However, if the sender address
12120 is verified with a callout during the MAIL ACL, the sender domain is placed in
12121 &$domain$& during the expansions of &%hosts%&, &%interface%&, and &%port%& in
12122 the &(smtp)& transport.
12123
12124 .next
12125 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12126 &$domain$& contains the domain portion of the address that is being rewritten;
12127 it can be used in the expansion of the replacement address, for example, to
12128 rewrite domains by file lookup.
12129
12130 .next
12131 With one important exception, whenever a domain list is being scanned,
12132 &$domain$& contains the subject domain. &*Exception*&: When a domain list in
12133 a &%sender_domains%& condition in an ACL is being processed, the subject domain
12134 is in &$sender_address_domain$& and not in &$domain$&. It works this way so
12135 that, in a RCPT ACL, the sender domain list can be dependent on the
12136 recipient domain (which is what is in &$domain$& at this time).
12137
12138 .next
12139 .cindex "ETRN" "value of &$domain$&"
12140 .oindex "&%smtp_etrn_command%&"
12141 When the &%smtp_etrn_command%& option is being expanded, &$domain$& contains
12142 the complete argument of the ETRN command (see section &<<SECTETRN>>&).
12143 .endlist
12144
12145
12146 .vitem &$domain_data$&
12147 .vindex "&$domain_data$&"
12148 When the &%domains%& option on a router matches a domain by
12149 means of a lookup, the data read by the lookup is available during the running
12150 of the router as &$domain_data$&. In addition, if the driver routes the
12151 address to a transport, the value is available in that transport. If the
12152 transport is handling multiple addresses, the value from the first address is
12153 used.
12154
12155 &$domain_data$& is also set when the &%domains%& condition in an ACL matches a
12156 domain by means of a lookup. The data read by the lookup is available during
12157 the rest of the ACL statement. In all other situations, this variable expands
12158 to nothing.
12159
12160 .vitem &$exim_gid$&
12161 .vindex "&$exim_gid$&"
12162 This variable contains the numerical value of the Exim group id.
12163
12164 .vitem &$exim_path$&
12165 .vindex "&$exim_path$&"
12166 This variable contains the path to the Exim binary.
12167
12168 .vitem &$exim_uid$&
12169 .vindex "&$exim_uid$&"
12170 This variable contains the numerical value of the Exim user id.
12171
12172 .vitem &$exim_version$&
12173 .vindex "&$exim_version$&"
12174 This variable contains the version string of the Exim build.
12175 The first character is a major version number, currently 4.
12176 Then after a dot, the next group of digits is a minor version number.
12177 There may be other characters following the minor version.
12178
12179 .vitem &$header_$&<&'name'&>
12180 This is not strictly an expansion variable. It is expansion syntax for
12181 inserting the message header line with the given name. Note that the name must
12182 be terminated by colon or white space, because it may contain a wide variety of
12183 characters. Note also that braces must &'not'& be used.
12184 See the full description in section &<<SECTexpansionitems>>& above.
12185
12186 .vitem &$headers_added$&
12187 .vindex "&$headers_added$&"
12188 Within an ACL this variable contains the headers added so far by
12189 the ACL modifier add_header (section &<<SECTaddheadacl>>&).
12190 The headers are a newline-separated list.
12191
12192 .vitem &$home$&
12193 .vindex "&$home$&"
12194 When the &%check_local_user%& option is set for a router, the user's home
12195 directory is placed in &$home$& when the check succeeds. In particular, this
12196 means it is set during the running of users' filter files. A router may also
12197 explicitly set a home directory for use by a transport; this can be overridden
12198 by a setting on the transport itself.
12199
12200 When running a filter test via the &%-bf%& option, &$home$& is set to the value
12201 of the environment variable HOME, which is subject to the
12202 &%keep_environment%& and &%add_environment%& main config options.
12203
12204 .vitem &$host$&
12205 .vindex "&$host$&"
12206 If a router assigns an address to a transport (any transport), and passes a
12207 list of hosts with the address, the value of &$host$& when the transport starts
12208 to run is the name of the first host on the list. Note that this applies both
12209 to local and remote transports.
12210
12211 .cindex "transport" "filter"
12212 .cindex "filter" "transport filter"
12213 For the &(smtp)& transport, if there is more than one host, the value of
12214 &$host$& changes as the transport works its way through the list. In
12215 particular, when the &(smtp)& transport is expanding its options for encryption
12216 using TLS, or for specifying a transport filter (see chapter
12217 &<<CHAPtransportgeneric>>&), &$host$& contains the name of the host to which it
12218 is connected.
12219
12220 When used in the client part of an authenticator configuration (see chapter
12221 &<<CHAPSMTPAUTH>>&), &$host$& contains the name of the server to which the
12222 client is connected.
12223
12224
12225 .vitem &$host_address$&
12226 .vindex "&$host_address$&"
12227 This variable is set to the remote host's IP address whenever &$host$& is set
12228 for a remote connection. It is also set to the IP address that is being checked
12229 when the &%ignore_target_hosts%& option is being processed.
12230
12231 .vitem &$host_data$&
12232 .vindex "&$host_data$&"
12233 If a &%hosts%& condition in an ACL is satisfied by means of a lookup, the
12234 result of the lookup is made available in the &$host_data$& variable. This
12235 allows you, for example, to do things like this:
12236 .code
12237 deny  hosts = net-lsearch;/some/file
12238 message = $host_data
12239 .endd
12240 .vitem &$host_lookup_deferred$&
12241 .cindex "host name" "lookup, failure of"
12242 .vindex "&$host_lookup_deferred$&"
12243 This variable normally contains &"0"&, as does &$host_lookup_failed$&. When a
12244 message comes from a remote host and there is an attempt to look up the host's
12245 name from its IP address, and the attempt is not successful, one of these
12246 variables is set to &"1"&.
12247
12248 .ilist
12249 If the lookup receives a definite negative response (for example, a DNS lookup
12250 succeeded, but no records were found), &$host_lookup_failed$& is set to &"1"&.
12251
12252 .next
12253 If there is any kind of problem during the lookup, such that Exim cannot
12254 tell whether or not the host name is defined (for example, a timeout for a DNS
12255 lookup), &$host_lookup_deferred$& is set to &"1"&.
12256 .endlist ilist
12257
12258 Looking up a host's name from its IP address consists of more than just a
12259 single reverse lookup. Exim checks that a forward lookup of at least one of the
12260 names it receives from a reverse lookup yields the original IP address. If this
12261 is not the case, Exim does not accept the looked up name(s), and
12262 &$host_lookup_failed$& is set to &"1"&. Thus, being able to find a name from an
12263 IP address (for example, the existence of a PTR record in the DNS) is not
12264 sufficient on its own for the success of a host name lookup. If the reverse
12265 lookup succeeds, but there is a lookup problem such as a timeout when checking
12266 the result, the name is not accepted, and &$host_lookup_deferred$& is set to
12267 &"1"&. See also &$sender_host_name$&.
12268
12269 .cindex authentication "expansion item"
12270 Performing these checks sets up information used by the
12271 &$authresults$& expansion item.
12272
12273
12274 .vitem &$host_lookup_failed$&
12275 .vindex "&$host_lookup_failed$&"
12276 See &$host_lookup_deferred$&.
12277
12278 .vitem &$host_port$&
12279 .vindex "&$host_port$&"
12280 This variable is set to the remote host's TCP port whenever &$host$& is set
12281 for an outbound connection.
12282
12283 .vitem &$initial_cwd$&
12284 .vindex "&$initial_cwd$&
12285 This variable contains the full path name of the initial working
12286 directory of the current Exim process. This may differ from the current
12287 working directory, as Exim changes this to "/" during early startup, and
12288 to &$spool_directory$& later.
12289
12290 .vitem &$inode$&
12291 .vindex "&$inode$&"
12292 The only time this variable is set is while expanding the &%directory_file%&
12293 option in the &(appendfile)& transport. The variable contains the inode number
12294 of the temporary file which is about to be renamed. It can be used to construct
12295 a unique name for the file.
12296
12297 .vitem &$interface_address$&
12298 .vindex "&$interface_address$&"
12299 This is an obsolete name for &$received_ip_address$&.
12300
12301 .vitem &$interface_port$&
12302 .vindex "&$interface_port$&"
12303 This is an obsolete name for &$received_port$&.
12304
12305 .vitem &$item$&
12306 .vindex "&$item$&"
12307 This variable is used during the expansion of &*forall*& and &*forany*&
12308 conditions (see section &<<SECTexpcond>>&), and &*filter*&, &*map*&, and
12309 &*reduce*& items (see section &<<SECTexpcond>>&). In other circumstances, it is
12310 empty.
12311
12312 .vitem &$ldap_dn$&
12313 .vindex "&$ldap_dn$&"
12314 This variable, which is available only when Exim is compiled with LDAP support,
12315 contains the DN from the last entry in the most recently successful LDAP
12316 lookup.
12317
12318 .vitem &$load_average$&
12319 .vindex "&$load_average$&"
12320 This variable contains the system load average, multiplied by 1000 so that it
12321 is an integer. For example, if the load average is 0.21, the value of the
12322 variable is 210. The value is recomputed every time the variable is referenced.
12323
12324 .vitem &$local_part$&
12325 .vindex "&$local_part$&"
12326 When an address is being routed, or delivered on its own, this
12327 variable contains the local part. When a number of addresses are being
12328 delivered together (for example, multiple RCPT commands in an SMTP
12329 session), &$local_part$& is not set.
12330
12331 Global address rewriting happens when a message is received, so the value of
12332 &$local_part$& during routing and delivery is the value after rewriting.
12333 &$local_part$& is set during user filtering, but not during system filtering,
12334 because a message may have many recipients and the system filter is called just
12335 once.
12336
12337 .vindex "&$local_part_prefix$&"
12338 .vindex "&$local_part_suffix$&"
12339 .cindex affix variables
12340 If a local part prefix or suffix has been recognized, it is not included in the
12341 value of &$local_part$& during routing and subsequent delivery. The values of
12342 any prefix or suffix are in &$local_part_prefix$& and
12343 &$local_part_suffix$&, respectively.
12344
12345 When a message is being delivered to a file, pipe, or autoreply transport as a
12346 result of aliasing or forwarding, &$local_part$& is set to the local part of
12347 the parent address, not to the filename or command (see &$address_file$& and
12348 &$address_pipe$&).
12349
12350 When an ACL is running for a RCPT command, &$local_part$& contains the
12351 local part of the recipient address.
12352
12353 When a rewrite item is being processed (see chapter &<<CHAPrewrite>>&),
12354 &$local_part$& contains the local part of the address that is being rewritten;
12355 it can be used in the expansion of the replacement address, for example.
12356
12357 In all cases, all quoting is removed from the local part. For example, for both
12358 the addresses
12359 .code
12360 "abc:xyz"@test.example
12361 abc\:xyz@test.example
12362 .endd
12363 the value of &$local_part$& is
12364 .code
12365 abc:xyz
12366 .endd
12367 If you use &$local_part$& to create another address, you should always wrap it
12368 inside a quoting operator. For example, in a &(redirect)& router you could
12369 have:
12370 .code
12371 data = ${quote_local_part:$local_part}@new.domain.example
12372 .endd
12373 &*Note*&: The value of &$local_part$& is normally lower cased. If you want
12374 to process local parts in a case-dependent manner in a router, you can set the
12375 &%caseful_local_part%& option (see chapter &<<CHAProutergeneric>>&).
12376
12377 .vitem &$local_part_data$&
12378 .vindex "&$local_part_data$&"
12379 When the &%local_parts%& option on a router matches a local part by means of a
12380 lookup, the data read by the lookup is available during the running of the
12381 router as &$local_part_data$&. In addition, if the driver routes the address
12382 to a transport, the value is available in that transport. If the transport is
12383 handling multiple addresses, the value from the first address is used.
12384
12385 &$local_part_data$& is also set when the &%local_parts%& condition in an ACL
12386 matches a local part by means of a lookup. The data read by the lookup is
12387 available during the rest of the ACL statement. In all other situations, this
12388 variable expands to nothing.
12389
12390 .vitem &$local_part_prefix$&
12391 .vindex "&$local_part_prefix$&"
12392 .cindex affix variables
12393 When an address is being routed or delivered, and a
12394 specific prefix for the local part was recognized, it is available in this
12395 variable, having been removed from &$local_part$&.
12396
12397 .vitem &$local_part_suffix$&
12398 .vindex "&$local_part_suffix$&"
12399 When an address is being routed or delivered, and a
12400 specific suffix for the local part was recognized, it is available in this
12401 variable, having been removed from &$local_part$&.
12402
12403 .vitem &$local_scan_data$&
12404 .vindex "&$local_scan_data$&"
12405 This variable contains the text returned by the &[local_scan()]& function when
12406 a message is received. See chapter &<<CHAPlocalscan>>& for more details.
12407
12408 .vitem &$local_user_gid$&
12409 .vindex "&$local_user_gid$&"
12410 See &$local_user_uid$&.
12411
12412 .vitem &$local_user_uid$&
12413 .vindex "&$local_user_uid$&"
12414 This variable and &$local_user_gid$& are set to the uid and gid after the
12415 &%check_local_user%& router precondition succeeds. This means that their values
12416 are available for the remaining preconditions (&%senders%&, &%require_files%&,
12417 and &%condition%&), for the &%address_data%& expansion, and for any
12418 router-specific expansions. At all other times, the values in these variables
12419 are &`(uid_t)(-1)`& and &`(gid_t)(-1)`&, respectively.
12420
12421 .vitem &$localhost_number$&
12422 .vindex "&$localhost_number$&"
12423 This contains the expanded value of the
12424 &%localhost_number%& option. The expansion happens after the main options have
12425 been read.
12426
12427 .vitem &$log_inodes$&
12428 .vindex "&$log_inodes$&"
12429 The number of free inodes in the disk partition where Exim's
12430 log files are being written. The value is recalculated whenever the variable is
12431 referenced. If the relevant file system does not have the concept of inodes,
12432 the value of is -1. See also the &%check_log_inodes%& option.
12433
12434 .vitem &$log_space$&
12435 .vindex "&$log_space$&"
12436 The amount of free space (as a number of kilobytes) in the disk
12437 partition where Exim's log files are being written. The value is recalculated
12438 whenever the variable is referenced. If the operating system does not have the
12439 ability to find the amount of free space (only true for experimental systems),
12440 the space value is -1. See also the &%check_log_space%& option.
12441
12442
12443 .vitem &$lookup_dnssec_authenticated$&
12444 .vindex "&$lookup_dnssec_authenticated$&"
12445 This variable is set after a DNS lookup done by
12446 a dnsdb lookup expansion, dnslookup router or smtp transport.
12447 .cindex "DNS" "DNSSEC"
12448 It will be empty if &(DNSSEC)& was not requested,
12449 &"no"& if the result was not labelled as authenticated data
12450 and &"yes"& if it was.
12451 Results that are labelled as authoritative answer that match
12452 the &%dns_trust_aa%& configuration variable count also
12453 as authenticated data.
12454
12455 .vitem &$mailstore_basename$&
12456 .vindex "&$mailstore_basename$&"
12457 This variable is set only when doing deliveries in &"mailstore"& format in the
12458 &(appendfile)& transport. During the expansion of the &%mailstore_prefix%&,
12459 &%mailstore_suffix%&, &%message_prefix%&, and &%message_suffix%& options, it
12460 contains the basename of the files that are being written, that is, the name
12461 without the &".tmp"&, &".env"&, or &".msg"& suffix. At all other times, this
12462 variable is empty.
12463
12464 .vitem &$malware_name$&
12465 .vindex "&$malware_name$&"
12466 This variable is available when Exim is compiled with the
12467 content-scanning extension. It is set to the name of the virus that was found
12468 when the ACL &%malware%& condition is true (see section &<<SECTscanvirus>>&).
12469
12470 .vitem &$max_received_linelength$&
12471 .vindex "&$max_received_linelength$&"
12472 .cindex "maximum" "line length"
12473 .cindex "line length" "maximum"
12474 This variable contains the number of bytes in the longest line that was
12475 received as part of the message, not counting the line termination
12476 character(s).
12477 It is not valid if the &%spool_files_wireformat%& option is used.
12478
12479 .vitem &$message_age$&
12480 .cindex "message" "age of"
12481 .vindex "&$message_age$&"
12482 This variable is set at the start of a delivery attempt to contain the number
12483 of seconds since the message was received. It does not change during a single
12484 delivery attempt.
12485
12486 .vitem &$message_body$&
12487 .cindex "body of message" "expansion variable"
12488 .cindex "message body" "in expansion"
12489 .cindex "binary zero" "in message body"
12490 .vindex "&$message_body$&"
12491 .oindex "&%message_body_visible%&"
12492 This variable contains the initial portion of a message's body while it is
12493 being delivered, and is intended mainly for use in filter files. The maximum
12494 number of characters of the body that are put into the variable is set by the
12495 &%message_body_visible%& configuration option; the default is 500.
12496
12497 .oindex "&%message_body_newlines%&"
12498 By default, newlines are converted into spaces in &$message_body$&, to make it
12499 easier to search for phrases that might be split over a line break. However,
12500 this can be disabled by setting &%message_body_newlines%& to be true. Binary
12501 zeros are always converted into spaces.
12502
12503 .vitem &$message_body_end$&
12504 .cindex "body of message" "expansion variable"
12505 .cindex "message body" "in expansion"
12506 .vindex "&$message_body_end$&"
12507 This variable contains the final portion of a message's
12508 body while it is being delivered. The format and maximum size are as for
12509 &$message_body$&.
12510
12511 .vitem &$message_body_size$&
12512 .cindex "body of message" "size"
12513 .cindex "message body" "size"
12514 .vindex "&$message_body_size$&"
12515 When a message is being delivered, this variable contains the size of the body
12516 in bytes. The count starts from the character after the blank line that
12517 separates the body from the header. Newlines are included in the count. See
12518 also &$message_size$&, &$body_linecount$&, and &$body_zerocount$&.
12519
12520 If the spool file is wireformat
12521 (see the &%spool_files_wireformat%& main option)
12522 the CRLF line-terminators are included in the count.
12523
12524 .vitem &$message_exim_id$&
12525 .vindex "&$message_exim_id$&"
12526 When a message is being received or delivered, this variable contains the
12527 unique message id that is generated and used by Exim to identify the message.
12528 An id is not created for a message until after its header has been successfully
12529 received. &*Note*&: This is &'not'& the contents of the &'Message-ID:'& header
12530 line; it is the local id that Exim assigns to the message, for example:
12531 &`1BXTIK-0001yO-VA`&.
12532
12533 .vitem &$message_headers$&
12534 .vindex &$message_headers$&
12535 This variable contains a concatenation of all the header lines when a message
12536 is being processed, except for lines added by routers or transports. The header
12537 lines are separated by newline characters. Their contents are decoded in the
12538 same way as a header line that is inserted by &%bheader%&.
12539
12540 .vitem &$message_headers_raw$&
12541 .vindex &$message_headers_raw$&
12542 This variable is like &$message_headers$& except that no processing of the
12543 contents of header lines is done.
12544
12545 .vitem &$message_id$&
12546 This is an old name for &$message_exim_id$&. It is now deprecated.
12547
12548 .vitem &$message_linecount$&
12549 .vindex "&$message_linecount$&"
12550 This variable contains the total number of lines in the header and body of the
12551 message. Compare &$body_linecount$&, which is the count for the body only.
12552 During the DATA and content-scanning ACLs, &$message_linecount$& contains the
12553 number of lines received. Before delivery happens (that is, before filters,
12554 routers, and transports run) the count is increased to include the
12555 &'Received:'& header line that Exim standardly adds, and also any other header
12556 lines that are added by ACLs. The blank line that separates the message header
12557 from the body is not counted.
12558
12559 As with the special case of &$message_size$&, during the expansion of the
12560 appendfile transport's maildir_tag option in maildir format, the value of
12561 &$message_linecount$& is the precise size of the number of newlines in the
12562 file that has been written (minus one for the blank line between the
12563 header and the body).
12564
12565 Here is an example of the use of this variable in a DATA ACL:
12566 .code
12567 deny message   = Too many lines in message header
12568      condition = \
12569       ${if <{250}{${eval:$message_linecount - $body_linecount}}}
12570 .endd
12571 In the MAIL and RCPT ACLs, the value is zero because at that stage the
12572 message has not yet been received.
12573
12574 This variable is not valid if the &%spool_files_wireformat%& option is used.
12575
12576 .vitem &$message_size$&
12577 .cindex "size" "of message"
12578 .cindex "message" "size"
12579 .vindex "&$message_size$&"
12580 When a message is being processed, this variable contains its size in bytes. In
12581 most cases, the size includes those headers that were received with the
12582 message, but not those (such as &'Envelope-to:'&) that are added to individual
12583 deliveries as they are written. However, there is one special case: during the
12584 expansion of the &%maildir_tag%& option in the &(appendfile)& transport while
12585 doing a delivery in maildir format, the value of &$message_size$& is the
12586 precise size of the file that has been written. See also
12587 &$message_body_size$&, &$body_linecount$&, and &$body_zerocount$&.
12588
12589 .cindex "RCPT" "value of &$message_size$&"
12590 While running a per message ACL (mail/rcpt/predata), &$message_size$&
12591 contains the size supplied on the MAIL command, or -1 if no size was given. The
12592 value may not, of course, be truthful.
12593
12594 .vitem &$mime_$&&'xxx'&
12595 A number of variables whose names start with &$mime$& are
12596 available when Exim is compiled with the content-scanning extension. For
12597 details, see section &<<SECTscanmimepart>>&.
12598
12599 .vitem "&$n0$& &-- &$n9$&"
12600 These variables are counters that can be incremented by means
12601 of the &%add%& command in filter files.
12602
12603 .vitem &$original_domain$&
12604 .vindex "&$domain$&"
12605 .vindex "&$original_domain$&"
12606 When a top-level address is being processed for delivery, this contains the
12607 same value as &$domain$&. However, if a &"child"& address (for example,
12608 generated by an alias, forward, or filter file) is being processed, this
12609 variable contains the domain of the original address (lower cased). This
12610 differs from &$parent_domain$& only when there is more than one level of
12611 aliasing or forwarding. When more than one address is being delivered in a
12612 single transport run, &$original_domain$& is not set.
12613
12614 If a new address is created by means of a &%deliver%& command in a system
12615 filter, it is set up with an artificial &"parent"& address. This has the local
12616 part &'system-filter'& and the default qualify domain.
12617
12618 .vitem &$original_local_part$&
12619 .vindex "&$local_part$&"
12620 .vindex "&$original_local_part$&"
12621 When a top-level address is being processed for delivery, this contains the
12622 same value as &$local_part$&, unless a prefix or suffix was removed from the
12623 local part, because &$original_local_part$& always contains the full local
12624 part. When a &"child"& address (for example, generated by an alias, forward, or
12625 filter file) is being processed, this variable contains the full local part of
12626 the original address.
12627
12628 If the router that did the redirection processed the local part
12629 case-insensitively, the value in &$original_local_part$& is in lower case.
12630 This variable differs from &$parent_local_part$& only when there is more than
12631 one level of aliasing or forwarding. When more than one address is being
12632 delivered in a single transport run, &$original_local_part$& is not set.
12633
12634 If a new address is created by means of a &%deliver%& command in a system
12635 filter, it is set up with an artificial &"parent"& address. This has the local
12636 part &'system-filter'& and the default qualify domain.
12637
12638 .vitem &$originator_gid$&
12639 .cindex "gid (group id)" "of originating user"
12640 .cindex "sender" "gid"
12641 .vindex "&$caller_gid$&"
12642 .vindex "&$originator_gid$&"
12643 This variable contains the value of &$caller_gid$& that was set when the
12644 message was received. For messages received via the command line, this is the
12645 gid of the sending user. For messages received by SMTP over TCP/IP, this is
12646 normally the gid of the Exim user.
12647
12648 .vitem &$originator_uid$&
12649 .cindex "uid (user id)" "of originating user"
12650 .cindex "sender" "uid"
12651 .vindex "&$caller_uid$&"
12652 .vindex "&$originator_uid$&"
12653 The value of &$caller_uid$& that was set when the message was received. For
12654 messages received via the command line, this is the uid of the sending user.
12655 For messages received by SMTP over TCP/IP, this is normally the uid of the Exim
12656 user.
12657
12658 .vitem &$parent_domain$&
12659 .vindex "&$parent_domain$&"
12660 This variable is similar to &$original_domain$& (see
12661 above), except that it refers to the immediately preceding parent address.
12662
12663 .vitem &$parent_local_part$&
12664 .vindex "&$parent_local_part$&"
12665 This variable is similar to &$original_local_part$&
12666 (see above), except that it refers to the immediately preceding parent address.
12667
12668 .vitem &$pid$&
12669 .cindex "pid (process id)" "of current process"
12670 .vindex "&$pid$&"
12671 This variable contains the current process id.
12672
12673 .vitem &$pipe_addresses$&
12674 .cindex "filter" "transport filter"
12675 .cindex "transport" "filter"
12676 .vindex "&$pipe_addresses$&"
12677 This is not an expansion variable, but is mentioned here because the string
12678 &`$pipe_addresses`& is handled specially in the command specification for the
12679 &(pipe)& transport (chapter &<<CHAPpipetransport>>&) and in transport filters
12680 (described under &%transport_filter%& in chapter &<<CHAPtransportgeneric>>&).
12681 It cannot be used in general expansion strings, and provokes an &"unknown
12682 variable"& error if encountered.
12683
12684 .vitem &$primary_hostname$&
12685 .vindex "&$primary_hostname$&"
12686 This variable contains the value set by &%primary_hostname%& in the
12687 configuration file, or read by the &[uname()]& function. If &[uname()]& returns
12688 a single-component name, Exim calls &[gethostbyname()]& (or
12689 &[getipnodebyname()]& where available) in an attempt to acquire a fully
12690 qualified host name. See also &$smtp_active_hostname$&.
12691
12692
12693 .vitem &$proxy_external_address$& &&&
12694        &$proxy_external_port$& &&&
12695        &$proxy_local_address$& &&&
12696        &$proxy_local_port$& &&&
12697        &$proxy_session$&
12698 These variables are only available when built with Proxy Protocol
12699 or SOCKS5 support.
12700 For details see chapter &<<SECTproxyInbound>>&.
12701
12702 .vitem &$prdr_requested$&
12703 .cindex "PRDR" "variable for"
12704 This variable is set to &"yes"& if PRDR was requested by the client for the
12705 current message, otherwise &"no"&.
12706
12707 .vitem &$prvscheck_address$&
12708 This variable is used in conjunction with the &%prvscheck%& expansion item,
12709 which is described in sections &<<SECTexpansionitems>>& and
12710 &<<SECTverifyPRVS>>&.
12711
12712 .vitem &$prvscheck_keynum$&
12713 This variable is used in conjunction with the &%prvscheck%& expansion item,
12714 which is described in sections &<<SECTexpansionitems>>& and
12715 &<<SECTverifyPRVS>>&.
12716
12717 .vitem &$prvscheck_result$&
12718 This variable is used in conjunction with the &%prvscheck%& expansion item,
12719 which is described in sections &<<SECTexpansionitems>>& and
12720 &<<SECTverifyPRVS>>&.
12721
12722 .vitem &$qualify_domain$&
12723 .vindex "&$qualify_domain$&"
12724 The value set for the &%qualify_domain%& option in the configuration file.
12725
12726 .vitem &$qualify_recipient$&
12727 .vindex "&$qualify_recipient$&"
12728 The value set for the &%qualify_recipient%& option in the configuration file,
12729 or if not set, the value of &$qualify_domain$&.
12730
12731 .vitem &$queue_name$&
12732 .vindex &$queue_name$&
12733 .cindex "named queues"
12734 .cindex queues named
12735 The name of the spool queue in use; empty for the default queue.
12736
12737 .vitem &$rcpt_count$&
12738 .vindex "&$rcpt_count$&"
12739 When a message is being received by SMTP, this variable contains the number of
12740 RCPT commands received for the current message. If this variable is used in a
12741 RCPT ACL, its value includes the current command.
12742
12743 .vitem &$rcpt_defer_count$&
12744 .vindex "&$rcpt_defer_count$&"
12745 .cindex "4&'xx'& responses" "count of"
12746 When a message is being received by SMTP, this variable contains the number of
12747 RCPT commands in the current message that have previously been rejected with a
12748 temporary (4&'xx'&) response.
12749
12750 .vitem &$rcpt_fail_count$&
12751 .vindex "&$rcpt_fail_count$&"
12752 When a message is being received by SMTP, this variable contains the number of
12753 RCPT commands in the current message that have previously been rejected with a
12754 permanent (5&'xx'&) response.
12755
12756 .vitem &$received_count$&
12757 .vindex "&$received_count$&"
12758 This variable contains the number of &'Received:'& header lines in the message,
12759 including the one added by Exim (so its value is always greater than zero). It
12760 is available in the DATA ACL, the non-SMTP ACL, and while routing and
12761 delivering.
12762
12763 .vitem &$received_for$&
12764 .vindex "&$received_for$&"
12765 If there is only a single recipient address in an incoming message, this
12766 variable contains that address when the &'Received:'& header line is being
12767 built. The value is copied after recipient rewriting has happened, but before
12768 the &[local_scan()]& function is run.
12769
12770 .vitem &$received_ip_address$&
12771 .vindex "&$received_ip_address$&"
12772 As soon as an Exim server starts processing an incoming TCP/IP connection, this
12773 variable is set to the address of the local IP interface, and &$received_port$&
12774 is set to the local port number. (The remote IP address and port are in
12775 &$sender_host_address$& and &$sender_host_port$&.) When testing with &%-bh%&,
12776 the port value is -1 unless it has been set using the &%-oMi%& command line
12777 option.
12778
12779 As well as being useful in ACLs (including the &"connect"& ACL), these variable
12780 could be used, for example, to make the filename for a TLS certificate depend
12781 on which interface and/or port is being used for the incoming connection. The
12782 values of &$received_ip_address$& and &$received_port$& are saved with any
12783 messages that are received, thus making these variables available at delivery
12784 time.
12785 For outbound connections see &$sending_ip_address$&.
12786
12787 .vitem &$received_port$&
12788 .vindex "&$received_port$&"
12789 See &$received_ip_address$&.
12790
12791 .vitem &$received_protocol$&
12792 .vindex "&$received_protocol$&"
12793 When a message is being processed, this variable contains the name of the
12794 protocol by which it was received. Most of the names used by Exim are defined
12795 by RFCs 821, 2821, and 3848. They start with &"smtp"& (the client used HELO) or
12796 &"esmtp"& (the client used EHLO). This can be followed by &"s"& for secure
12797 (encrypted) and/or &"a"& for authenticated. Thus, for example, if the protocol
12798 is set to &"esmtpsa"&, the message was received over an encrypted SMTP
12799 connection and the client was successfully authenticated.
12800
12801 Exim uses the protocol name &"smtps"& for the case when encryption is
12802 automatically set up on connection without the use of STARTTLS (see
12803 &%tls_on_connect_ports%&), and the client uses HELO to initiate the
12804 encrypted SMTP session. The name &"smtps"& is also used for the rare situation
12805 where the client initially uses EHLO, sets up an encrypted connection using
12806 STARTTLS, and then uses HELO afterwards.
12807
12808 The &%-oMr%& option provides a way of specifying a custom protocol name for
12809 messages that are injected locally by trusted callers. This is commonly used to
12810 identify messages that are being re-injected after some kind of scanning.
12811
12812 .vitem &$received_time$&
12813 .vindex "&$received_time$&"
12814 This variable contains the date and time when the current message was received,
12815 as a number of seconds since the start of the Unix epoch.
12816
12817 .vitem &$recipient_data$&
12818 .vindex "&$recipient_data$&"
12819 This variable is set after an indexing lookup success in an ACL &%recipients%&
12820 condition. It contains the data from the lookup, and the value remains set
12821 until the next &%recipients%& test. Thus, you can do things like this:
12822 .display
12823 &`require recipients  = cdb*@;/some/file`&
12824 &`deny    `&&'some further test involving'& &`$recipient_data`&
12825 .endd
12826 &*Warning*&: This variable is set only when a lookup is used as an indexing
12827 method in the address list, using the semicolon syntax as in the example above.
12828 The variable is not set for a lookup that is used as part of the string
12829 expansion that all such lists undergo before being interpreted.
12830
12831 .vitem &$recipient_verify_failure$&
12832 .vindex "&$recipient_verify_failure$&"
12833 In an ACL, when a recipient verification fails, this variable contains
12834 information about the failure. It is set to one of the following words:
12835
12836 .ilist
12837 &"qualify"&: The address was unqualified (no domain), and the message
12838 was neither local nor came from an exempted host.
12839
12840 .next
12841 &"route"&: Routing failed.
12842
12843 .next
12844 &"mail"&: Routing succeeded, and a callout was attempted; rejection occurred at
12845 or before the MAIL command (that is, on initial connection, HELO, or
12846 MAIL).
12847
12848 .next
12849 &"recipient"&: The RCPT command in a callout was rejected.
12850 .next
12851
12852 &"postmaster"&: The postmaster check in a callout was rejected.
12853 .endlist
12854
12855 The main use of this variable is expected to be to distinguish between
12856 rejections of MAIL and rejections of RCPT.
12857
12858 .vitem &$recipients$&
12859 .vindex "&$recipients$&"
12860 This variable contains a list of envelope recipients for a message. A comma and
12861 a space separate the addresses in the replacement text. However, the variable
12862 is not generally available, to prevent exposure of Bcc recipients in
12863 unprivileged users' filter files. You can use &$recipients$& only in these
12864 cases:
12865
12866 .olist
12867 In a system filter file.
12868 .next
12869 In the ACLs associated with the DATA command and with non-SMTP messages, that
12870 is, the ACLs defined by &%acl_smtp_predata%&, &%acl_smtp_data%&,
12871 &%acl_smtp_mime%&, &%acl_not_smtp_start%&, &%acl_not_smtp%&, and
12872 &%acl_not_smtp_mime%&.
12873 .next
12874 From within a &[local_scan()]& function.
12875 .endlist
12876
12877
12878 .vitem &$recipients_count$&
12879 .vindex "&$recipients_count$&"
12880 When a message is being processed, this variable contains the number of
12881 envelope recipients that came with the message. Duplicates are not excluded
12882 from the count. While a message is being received over SMTP, the number
12883 increases for each accepted recipient. It can be referenced in an ACL.
12884
12885
12886 .vitem &$regex_match_string$&
12887 .vindex "&$regex_match_string$&"
12888 This variable is set to contain the matching regular expression after a
12889 &%regex%& ACL condition has matched (see section &<<SECTscanregex>>&).
12890
12891 .vitem "&$regex1$&, &$regex2$&, etc"
12892 .cindex "regex submatch variables (&$1regex$& &$2regex$& etc)"
12893 When a &%regex%& or &%mime_regex%& ACL condition succeeds,
12894 these variables contain the
12895 captured substrings identified by the regular expression.
12896
12897
12898 .vitem &$reply_address$&
12899 .vindex "&$reply_address$&"
12900 When a message is being processed, this variable contains the contents of the
12901 &'Reply-To:'& header line if one exists and it is not empty, or otherwise the
12902 contents of the &'From:'& header line. Apart from the removal of leading
12903 white space, the value is not processed in any way. In particular, no RFC 2047
12904 decoding or character code translation takes place.
12905
12906 .vitem &$return_path$&
12907 .vindex "&$return_path$&"
12908 When a message is being delivered, this variable contains the return path &--
12909 the sender field that will be sent as part of the envelope. It is not enclosed
12910 in <> characters. At the start of routing an address, &$return_path$& has the
12911 same value as &$sender_address$&, but if, for example, an incoming message to a
12912 mailing list has been expanded by a router which specifies a different address
12913 for bounce messages, &$return_path$& subsequently contains the new bounce
12914 address, whereas &$sender_address$& always contains the original sender address
12915 that was received with the message. In other words, &$sender_address$& contains
12916 the incoming envelope sender, and &$return_path$& contains the outgoing
12917 envelope sender.
12918
12919 .vitem &$return_size_limit$&
12920 .vindex "&$return_size_limit$&"
12921 This is an obsolete name for &$bounce_return_size_limit$&.
12922
12923 .vitem &$router_name$&
12924 .cindex "router" "name"
12925 .cindex "name" "of router"
12926 .vindex "&$router_name$&"
12927 During the running of a router this variable contains its name.
12928
12929 .vitem &$runrc$&
12930 .cindex "return code" "from &%run%& expansion"
12931 .vindex "&$runrc$&"
12932 This variable contains the return code from a command that is run by the
12933 &%${run...}%& expansion item. &*Warning*&: In a router or transport, you cannot
12934 assume the order in which option values are expanded, except for those
12935 preconditions whose order of testing is documented. Therefore, you cannot
12936 reliably expect to set &$runrc$& by the expansion of one option, and use it in
12937 another.
12938
12939 .vitem &$self_hostname$&
12940 .oindex "&%self%&" "value of host name"
12941 .vindex "&$self_hostname$&"
12942 When an address is routed to a supposedly remote host that turns out to be the
12943 local host, what happens is controlled by the &%self%& generic router option.
12944 One of its values causes the address to be passed to another router. When this
12945 happens, &$self_hostname$& is set to the name of the local host that the
12946 original router encountered. In other circumstances its contents are null.
12947
12948 .vitem &$sender_address$&
12949 .vindex "&$sender_address$&"
12950 When a message is being processed, this variable contains the sender's address
12951 that was received in the message's envelope. The case of letters in the address
12952 is retained, in both the local part and the domain. For bounce messages, the
12953 value of this variable is the empty string. See also &$return_path$&.
12954
12955 .vitem &$sender_address_data$&
12956 .vindex "&$address_data$&"
12957 .vindex "&$sender_address_data$&"
12958 If &$address_data$& is set when the routers are called from an ACL to verify a
12959 sender address, the final value is preserved in &$sender_address_data$&, to
12960 distinguish it from data from a recipient address. The value does not persist
12961 after the end of the current ACL statement. If you want to preserve it for
12962 longer, you can save it in an ACL variable.
12963
12964 .vitem &$sender_address_domain$&
12965 .vindex "&$sender_address_domain$&"
12966 The domain portion of &$sender_address$&.
12967
12968 .vitem &$sender_address_local_part$&
12969 .vindex "&$sender_address_local_part$&"
12970 The local part portion of &$sender_address$&.
12971
12972 .vitem &$sender_data$&
12973 .vindex "&$sender_data$&"
12974 This variable is set after a lookup success in an ACL &%senders%& condition or
12975 in a router &%senders%& option. It contains the data from the lookup, and the
12976 value remains set until the next &%senders%& test. Thus, you can do things like
12977 this:
12978 .display
12979 &`require senders      = cdb*@;/some/file`&
12980 &`deny    `&&'some further test involving'& &`$sender_data`&
12981 .endd
12982 &*Warning*&: This variable is set only when a lookup is used as an indexing
12983 method in the address list, using the semicolon syntax as in the example above.
12984 The variable is not set for a lookup that is used as part of the string
12985 expansion that all such lists undergo before being interpreted.
12986
12987 .vitem &$sender_fullhost$&
12988 .vindex "&$sender_fullhost$&"
12989 When a message is received from a remote host, this variable contains the host
12990 name and IP address in a single string. It ends with the IP address in square
12991 brackets, followed by a colon and a port number if the logging of ports is
12992 enabled. The format of the rest of the string depends on whether the host
12993 issued a HELO or EHLO SMTP command, and whether the host name was verified by
12994 looking up its IP address. (Looking up the IP address can be forced by the
12995 &%host_lookup%& option, independent of verification.) A plain host name at the
12996 start of the string is a verified host name; if this is not present,
12997 verification either failed or was not requested. A host name in parentheses is
12998 the argument of a HELO or EHLO command. This is omitted if it is identical to
12999 the verified host name or to the host's IP address in square brackets.
13000
13001 .vitem &$sender_helo_dnssec$&
13002 .vindex "&$sender_helo_dnssec$&"
13003 This boolean variable is true if a successful HELO verification was
13004 .cindex "DNS" "DNSSEC"
13005 done using DNS information the resolver library stated was authenticated data.
13006
13007 .vitem &$sender_helo_name$&
13008 .vindex "&$sender_helo_name$&"
13009 When a message is received from a remote host that has issued a HELO or EHLO
13010 command, the argument of that command is placed in this variable. It is also
13011 set if HELO or EHLO is used when a message is received using SMTP locally via
13012 the &%-bs%& or &%-bS%& options.
13013
13014 .vitem &$sender_host_address$&
13015 .vindex "&$sender_host_address$&"
13016 When a message is received from a remote host using SMTP,
13017 this variable contains that
13018 host's IP address. For locally non-SMTP submitted messages, it is empty.
13019
13020 .vitem &$sender_host_authenticated$&
13021 .vindex "&$sender_host_authenticated$&"
13022 This variable contains the name (not the public name) of the authenticator
13023 driver that successfully authenticated the client from which the message was
13024 received. It is empty if there was no successful authentication. See also
13025 &$authenticated_id$&.
13026
13027 .vitem &$sender_host_dnssec$&
13028 .vindex "&$sender_host_dnssec$&"
13029 If an attempt to populate &$sender_host_name$& has been made
13030 (by reference, &%hosts_lookup%& or
13031 otherwise) then this boolean will have been set true if, and only if, the
13032 resolver library states that both
13033 the reverse and forward DNS were authenticated data.  At all
13034 other times, this variable is false.
13035
13036 .cindex "DNS" "DNSSEC"
13037 It is likely that you will need to coerce DNSSEC support on in the resolver
13038 library, by setting:
13039 .code
13040 dns_dnssec_ok = 1
13041 .endd
13042
13043 Exim does not perform DNSSEC validation itself, instead leaving that to a
13044 validating resolver (e.g. unbound, or bind with suitable configuration).
13045
13046 If you have changed &%host_lookup_order%& so that &`bydns`& is not the first
13047 mechanism in the list, then this variable will be false.
13048
13049 This requires that your system resolver library support EDNS0 (and that
13050 DNSSEC flags exist in the system headers).  If the resolver silently drops
13051 all EDNS0 options, then this will have no effect.  OpenBSD's asr resolver
13052 is known to currently ignore EDNS0, documented in CAVEATS of asr_run(3).
13053
13054
13055 .vitem &$sender_host_name$&
13056 .vindex "&$sender_host_name$&"
13057 When a message is received from a remote host, this variable contains the
13058 host's name as obtained by looking up its IP address. For messages received by
13059 other means, this variable is empty.
13060
13061 .vindex "&$host_lookup_failed$&"
13062 If the host name has not previously been looked up, a reference to
13063 &$sender_host_name$& triggers a lookup (for messages from remote hosts).
13064 A looked up name is accepted only if it leads back to the original IP address
13065 via a forward lookup. If either the reverse or the forward lookup fails to find
13066 any data, or if the forward lookup does not yield the original IP address,
13067 &$sender_host_name$& remains empty, and &$host_lookup_failed$& is set to &"1"&.
13068
13069 .vindex "&$host_lookup_deferred$&"
13070 However, if either of the lookups cannot be completed (for example, there is a
13071 DNS timeout), &$host_lookup_deferred$& is set to &"1"&, and
13072 &$host_lookup_failed$& remains set to &"0"&.
13073
13074 Once &$host_lookup_failed$& is set to &"1"&, Exim does not try to look up the
13075 host name again if there is a subsequent reference to &$sender_host_name$&
13076 in the same Exim process, but it does try again if &$host_lookup_deferred$&
13077 is set to &"1"&.
13078
13079 Exim does not automatically look up every calling host's name. If you want
13080 maximum efficiency, you should arrange your configuration so that it avoids
13081 these lookups altogether. The lookup happens only if one or more of the
13082 following are true:
13083
13084 .ilist
13085 A string containing &$sender_host_name$& is expanded.
13086 .next
13087 The calling host matches the list in &%host_lookup%&. In the default
13088 configuration, this option is set to *, so it must be changed if lookups are
13089 to be avoided. (In the code, the default for &%host_lookup%& is unset.)
13090 .next
13091 Exim needs the host name in order to test an item in a host list. The items
13092 that require this are described in sections &<<SECThoslispatnam>>& and
13093 &<<SECThoslispatnamsk>>&.
13094 .next
13095 The calling host matches &%helo_try_verify_hosts%& or &%helo_verify_hosts%&.
13096 In this case, the host name is required to compare with the name quoted in any
13097 EHLO or HELO commands that the client issues.
13098 .next
13099 The remote host issues a EHLO or HELO command that quotes one of the
13100 domains in &%helo_lookup_domains%&. The default value of this option is
13101 . ==== As this is a nested list, any displays it contains must be indented
13102 . ==== as otherwise they are too far to the left.
13103 .code
13104   helo_lookup_domains = @ : @[]
13105 .endd
13106 which causes a lookup if a remote host (incorrectly) gives the server's name or
13107 IP address in an EHLO or HELO command.
13108 .endlist
13109
13110
13111 .vitem &$sender_host_port$&
13112 .vindex "&$sender_host_port$&"
13113 When a message is received from a remote host, this variable contains the port
13114 number that was used on the remote host.
13115
13116 .vitem &$sender_ident$&
13117 .vindex "&$sender_ident$&"
13118 When a message is received from a remote host, this variable contains the
13119 identification received in response to an RFC 1413 request. When a message has
13120 been received locally, this variable contains the login name of the user that
13121 called Exim.
13122
13123 .vitem &$sender_rate_$&&'xxx'&
13124 A number of variables whose names begin &$sender_rate_$& are set as part of the
13125 &%ratelimit%& ACL condition. Details are given in section
13126 &<<SECTratelimiting>>&.
13127
13128 .vitem &$sender_rcvhost$&
13129 .cindex "DNS" "reverse lookup"
13130 .cindex "reverse DNS lookup"
13131 .vindex "&$sender_rcvhost$&"
13132 This is provided specifically for use in &'Received:'& headers. It starts with
13133 either the verified host name (as obtained from a reverse DNS lookup) or, if
13134 there is no verified host name, the IP address in square brackets. After that
13135 there may be text in parentheses. When the first item is a verified host name,
13136 the first thing in the parentheses is the IP address in square brackets,
13137 followed by a colon and a port number if port logging is enabled. When the
13138 first item is an IP address, the port is recorded as &"port=&'xxxx'&"& inside
13139 the parentheses.
13140
13141 There may also be items of the form &"helo=&'xxxx'&"& if HELO or EHLO
13142 was used and its argument was not identical to the real host name or IP
13143 address, and &"ident=&'xxxx'&"& if an RFC 1413 ident string is available. If
13144 all three items are present in the parentheses, a newline and tab are inserted
13145 into the string, to improve the formatting of the &'Received:'& header.
13146
13147 .vitem &$sender_verify_failure$&
13148 .vindex "&$sender_verify_failure$&"
13149 In an ACL, when a sender verification fails, this variable contains information
13150 about the failure. The details are the same as for
13151 &$recipient_verify_failure$&.
13152
13153 .vitem &$sending_ip_address$&
13154 .vindex "&$sending_ip_address$&"
13155 This variable is set whenever an outgoing SMTP connection to another host has
13156 been set up. It contains the IP address of the local interface that is being
13157 used. This is useful if a host that has more than one IP address wants to take
13158 on different personalities depending on which one is being used. For incoming
13159 connections, see &$received_ip_address$&.
13160
13161 .vitem &$sending_port$&
13162 .vindex "&$sending_port$&"
13163 This variable is set whenever an outgoing SMTP connection to another host has
13164 been set up. It contains the local port that is being used. For incoming
13165 connections, see &$received_port$&.
13166
13167 .vitem &$smtp_active_hostname$&
13168 .vindex "&$smtp_active_hostname$&"
13169 During an incoming SMTP session, this variable contains the value of the active
13170 host name, as specified by the &%smtp_active_hostname%& option. The value of
13171 &$smtp_active_hostname$& is saved with any message that is received, so its
13172 value can be consulted during routing and delivery.
13173
13174 .vitem &$smtp_command$&
13175 .vindex "&$smtp_command$&"
13176 During the processing of an incoming SMTP command, this variable contains the
13177 entire command. This makes it possible to distinguish between HELO and EHLO in
13178 the HELO ACL, and also to distinguish between commands such as these:
13179 .code
13180 MAIL FROM:<>
13181 MAIL FROM: <>
13182 .endd
13183 For a MAIL command, extra parameters such as SIZE can be inspected. For a RCPT
13184 command, the address in &$smtp_command$& is the original address before any
13185 rewriting, whereas the values in &$local_part$& and &$domain$& are taken from
13186 the address after SMTP-time rewriting.
13187
13188 .vitem &$smtp_command_argument$&
13189 .cindex "SMTP" "command, argument for"
13190 .vindex "&$smtp_command_argument$&"
13191 While an ACL is running to check an SMTP command, this variable contains the
13192 argument, that is, the text that follows the command name, with leading white
13193 space removed. Following the introduction of &$smtp_command$&, this variable is
13194 somewhat redundant, but is retained for backwards compatibility.
13195
13196 .vitem &$smtp_command_history$&
13197 .cindex SMTP "command history"
13198 .vindex "&$smtp_command_history$&"
13199 A comma-separated list (with no whitespace) of the most-recent SMTP commands
13200 received, in time-order left to right.  Only a limited number of commands
13201 are remembered.
13202
13203 .vitem &$smtp_count_at_connection_start$&
13204 .vindex "&$smtp_count_at_connection_start$&"
13205 This variable is set greater than zero only in processes spawned by the Exim
13206 daemon for handling incoming SMTP connections. The name is deliberately long,
13207 in order to emphasize what the contents are. When the daemon accepts a new
13208 connection, it increments this variable. A copy of the variable is passed to
13209 the child process that handles the connection, but its value is fixed, and
13210 never changes. It is only an approximation of how many incoming connections
13211 there actually are, because many other connections may come and go while a
13212 single connection is being processed. When a child process terminates, the
13213 daemon decrements its copy of the variable.
13214
13215 .vitem "&$sn0$& &-- &$sn9$&"
13216 These variables are copies of the values of the &$n0$& &-- &$n9$& accumulators
13217 that were current at the end of the system filter file. This allows a system
13218 filter file to set values that can be tested in users' filter files. For
13219 example, a system filter could set a value indicating how likely it is that a
13220 message is junk mail.
13221
13222 .vitem &$spam_$&&'xxx'&
13223 A number of variables whose names start with &$spam$& are available when Exim
13224 is compiled with the content-scanning extension. For details, see section
13225 &<<SECTscanspamass>>&.
13226
13227 .vitem &$spf_header_comment$& &&&
13228        &$spf_received$& &&&
13229        &$spf_result$& &&&
13230        &$spf_result_guessed$& &&&
13231        &$spf_smtp_comment$&
13232 These variables are only available if Exim is built with SPF support.
13233 For details see section &<<SECSPF>>&.
13234
13235 .vitem &$spool_directory$&
13236 .vindex "&$spool_directory$&"
13237 The name of Exim's spool directory.
13238
13239 .vitem &$spool_inodes$&
13240 .vindex "&$spool_inodes$&"
13241 The number of free inodes in the disk partition where Exim's spool files are
13242 being written. The value is recalculated whenever the variable is referenced.
13243 If the relevant file system does not have the concept of inodes, the value of
13244 is -1. See also the &%check_spool_inodes%& option.
13245
13246 .vitem &$spool_space$&
13247 .vindex "&$spool_space$&"
13248 The amount of free space (as a number of kilobytes) in the disk partition where
13249 Exim's spool files are being written. The value is recalculated whenever the
13250 variable is referenced. If the operating system does not have the ability to
13251 find the amount of free space (only true for experimental systems), the space
13252 value is -1. For example, to check in an ACL that there is at least 50
13253 megabytes free on the spool, you could write:
13254 .code
13255 condition = ${if > {$spool_space}{50000}}
13256 .endd
13257 See also the &%check_spool_space%& option.
13258
13259
13260 .vitem &$thisaddress$&
13261 .vindex "&$thisaddress$&"
13262 This variable is set only during the processing of the &%foranyaddress%&
13263 command in a filter file. Its use is explained in the description of that
13264 command, which can be found in the separate document entitled &'Exim's
13265 interfaces to mail filtering'&.
13266
13267 .vitem &$tls_in_bits$&
13268 .vindex "&$tls_in_bits$&"
13269 Contains an approximation of the TLS cipher's bit-strength
13270 on the inbound connection; the meaning of
13271 this depends upon the TLS implementation used.
13272 If TLS has not been negotiated, the value will be 0.
13273 The value of this is automatically fed into the Cyrus SASL authenticator
13274 when acting as a server, to specify the "external SSF" (a SASL term).
13275
13276 The deprecated &$tls_bits$& variable refers to the inbound side
13277 except when used in the context of an outbound SMTP delivery, when it refers to
13278 the outbound.
13279
13280 .vitem &$tls_out_bits$&
13281 .vindex "&$tls_out_bits$&"
13282 Contains an approximation of the TLS cipher's bit-strength
13283 on an outbound SMTP connection; the meaning of
13284 this depends upon the TLS implementation used.
13285 If TLS has not been negotiated, the value will be 0.
13286
13287 .vitem &$tls_in_ourcert$&
13288 .vindex "&$tls_in_ourcert$&"
13289 .cindex certificate variables
13290 This variable refers to the certificate presented to the peer of an
13291 inbound connection when the message was received.
13292 It is only useful as the argument of a
13293 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13294 or a &%def%& condition.
13295
13296 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
13297 when a list of more than one
13298 file is used for &%tls_certificate%&, this variable is not reliable.
13299
13300 .vitem &$tls_in_peercert$&
13301 .vindex "&$tls_in_peercert$&"
13302 This variable refers to the certificate presented by the peer of an
13303 inbound connection when the message was received.
13304 It is only useful as the argument of a
13305 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13306 or a &%def%& condition.
13307 If certificate verification fails it may refer to a failing chain element
13308 which is not the leaf.
13309
13310 .vitem &$tls_out_ourcert$&
13311 .vindex "&$tls_out_ourcert$&"
13312 This variable refers to the certificate presented to the peer of an
13313 outbound connection.  It is only useful as the argument of a
13314 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13315 or a &%def%& condition.
13316
13317 .vitem &$tls_out_peercert$&
13318 .vindex "&$tls_out_peercert$&"
13319 This variable refers to the certificate presented by the peer of an
13320 outbound connection.  It is only useful as the argument of a
13321 &%certextract%& expansion item, &%md5%&, &%sha1%& or &%sha256%& operator,
13322 or a &%def%& condition.
13323 If certificate verification fails it may refer to a failing chain element
13324 which is not the leaf.
13325
13326 .vitem &$tls_in_certificate_verified$&
13327 .vindex "&$tls_in_certificate_verified$&"
13328 This variable is set to &"1"& if a TLS certificate was verified when the
13329 message was received, and &"0"& otherwise.
13330
13331 The deprecated &$tls_certificate_verified$& variable refers to the inbound side
13332 except when used in the context of an outbound SMTP delivery, when it refers to
13333 the outbound.
13334
13335 .vitem &$tls_out_certificate_verified$&
13336 .vindex "&$tls_out_certificate_verified$&"
13337 This variable is set to &"1"& if a TLS certificate was verified when an
13338 outbound SMTP connection was made,
13339 and &"0"& otherwise.
13340
13341 .vitem &$tls_in_cipher$&
13342 .vindex "&$tls_in_cipher$&"
13343 .vindex "&$tls_cipher$&"
13344 When a message is received from a remote host over an encrypted SMTP
13345 connection, this variable is set to the cipher suite that was negotiated, for
13346 example DES-CBC3-SHA. In other circumstances, in particular, for message
13347 received over unencrypted connections, the variable is empty. Testing
13348 &$tls_in_cipher$& for emptiness is one way of distinguishing between encrypted and
13349 non-encrypted connections during ACL processing.
13350
13351 The deprecated &$tls_cipher$& variable is the same as &$tls_in_cipher$& during message reception,
13352 but in the context of an outward SMTP delivery taking place via the &(smtp)& transport
13353 becomes the same as &$tls_out_cipher$&.
13354
13355 .new
13356 .vitem &$tls_in_cipher_std$&
13357 .vindex "&$tls_in_cipher_std$&"
13358 As above, but returning the RFC standard name for the cipher suite.
13359 .wen
13360
13361 .vitem &$tls_out_cipher$&
13362 .vindex "&$tls_out_cipher$&"
13363 This variable is
13364 cleared before any outgoing SMTP connection is made,
13365 and then set to the outgoing cipher suite if one is negotiated. See chapter
13366 &<<CHAPTLS>>& for details of TLS support and chapter &<<CHAPsmtptrans>>& for
13367 details of the &(smtp)& transport.
13368
13369 ,new
13370 .vitem &$tls_out_cipher_std$&
13371 .vindex "&$tls_out_cipher_std$&"
13372 As above, but returning the RFC standard name for the cipher suite.
13373 .wen
13374
13375 .vitem &$tls_out_dane$&
13376 .vindex &$tls_out_dane$&
13377 DANE active status.  See section &<<SECDANE>>&.
13378
13379 .vitem &$tls_in_ocsp$&
13380 .vindex "&$tls_in_ocsp$&"
13381 When a message is received from a remote client connection
13382 the result of any OCSP request from the client is encoded in this variable:
13383 .code
13384 0 OCSP proof was not requested (default value)
13385 1 No response to request
13386 2 Response not verified
13387 3 Verification failed
13388 4 Verification succeeded
13389 .endd
13390
13391 .vitem &$tls_out_ocsp$&
13392 .vindex "&$tls_out_ocsp$&"
13393 When a message is sent to a remote host connection
13394 the result of any OCSP request made is encoded in this variable.
13395 See &$tls_in_ocsp$& for values.
13396
13397 .vitem &$tls_in_peerdn$&
13398 .vindex "&$tls_in_peerdn$&"
13399 .vindex "&$tls_peerdn$&"
13400 .cindex certificate "extracting fields"
13401 When a message is received from a remote host over an encrypted SMTP
13402 connection, and Exim is configured to request a certificate from the client,
13403 the value of the Distinguished Name of the certificate is made available in the
13404 &$tls_in_peerdn$& during subsequent processing.
13405 If certificate verification fails it may refer to a failing chain element
13406 which is not the leaf.
13407
13408 The deprecated &$tls_peerdn$& variable refers to the inbound side
13409 except when used in the context of an outbound SMTP delivery, when it refers to
13410 the outbound.
13411
13412 .vitem &$tls_out_peerdn$&
13413 .vindex "&$tls_out_peerdn$&"
13414 When a message is being delivered to a remote host over an encrypted SMTP
13415 connection, and Exim is configured to request a certificate from the server,
13416 the value of the Distinguished Name of the certificate is made available in the
13417 &$tls_out_peerdn$& during subsequent processing.
13418 If certificate verification fails it may refer to a failing chain element
13419 which is not the leaf.
13420
13421 .vitem &$tls_in_sni$&
13422 .vindex "&$tls_in_sni$&"
13423 .vindex "&$tls_sni$&"
13424 .cindex "TLS" "Server Name Indication"
13425 When a TLS session is being established, if the client sends the Server
13426 Name Indication extension, the value will be placed in this variable.
13427 If the variable appears in &%tls_certificate%& then this option and
13428 some others, described in &<<SECTtlssni>>&,
13429 will be re-expanded early in the TLS session, to permit
13430 a different certificate to be presented (and optionally a different key to be
13431 used) to the client, based upon the value of the SNI extension.
13432
13433 The deprecated &$tls_sni$& variable refers to the inbound side
13434 except when used in the context of an outbound SMTP delivery, when it refers to
13435 the outbound.
13436
13437 .vitem &$tls_out_sni$&
13438 .vindex "&$tls_out_sni$&"
13439 .cindex "TLS" "Server Name Indication"
13440 During outbound
13441 SMTP deliveries, this variable reflects the value of the &%tls_sni%& option on
13442 the transport.
13443
13444 .vitem &$tls_out_tlsa_usage$&
13445 .vindex &$tls_out_tlsa_usage$&
13446 Bitfield of TLSA record types found.  See section &<<SECDANE>>&.
13447
13448 .vitem &$tod_bsdinbox$&
13449 .vindex "&$tod_bsdinbox$&"
13450 The time of day and the date, in the format required for BSD-style mailbox
13451 files, for example: Thu Oct 17 17:14:09 1995.
13452
13453 .vitem &$tod_epoch$&
13454 .vindex "&$tod_epoch$&"
13455 The time and date as a number of seconds since the start of the Unix epoch.
13456
13457 .vitem &$tod_epoch_l$&
13458 .vindex "&$tod_epoch_l$&"
13459 The time and date as a number of microseconds since the start of the Unix epoch.
13460
13461 .vitem &$tod_full$&
13462 .vindex "&$tod_full$&"
13463 A full version of the time and date, for example: Wed, 16 Oct 1995 09:51:40
13464 +0100. The timezone is always given as a numerical offset from UTC, with
13465 positive values used for timezones that are ahead (east) of UTC, and negative
13466 values for those that are behind (west).
13467
13468 .vitem &$tod_log$&
13469 .vindex "&$tod_log$&"
13470 The time and date in the format used for writing Exim's log files, for example:
13471 1995-10-12 15:32:29, but without a timezone.
13472
13473 .vitem &$tod_logfile$&
13474 .vindex "&$tod_logfile$&"
13475 This variable contains the date in the format yyyymmdd. This is the format that
13476 is used for datestamping log files when &%log_file_path%& contains the &`%D`&
13477 flag.
13478
13479 .vitem &$tod_zone$&
13480 .vindex "&$tod_zone$&"
13481 This variable contains the numerical value of the local timezone, for example:
13482 -0500.
13483
13484 .vitem &$tod_zulu$&
13485 .vindex "&$tod_zulu$&"
13486 This variable contains the UTC date and time in &"Zulu"& format, as specified
13487 by ISO 8601, for example: 20030221154023Z.
13488
13489 .vitem &$transport_name$&
13490 .cindex "transport" "name"
13491 .cindex "name" "of transport"
13492 .vindex "&$transport_name$&"
13493 During the running of a transport, this variable contains its name.
13494
13495 .vitem &$value$&
13496 .vindex "&$value$&"
13497 This variable contains the result of an expansion lookup, extraction operation,
13498 or external command, as described above. It is also used during a
13499 &*reduce*& expansion.
13500
13501 .vitem &$verify_mode$&
13502 .vindex "&$verify_mode$&"
13503 While a router or transport is being run in verify mode or for cutthrough delivery,
13504 contains "S" for sender-verification or "R" for recipient-verification.
13505 Otherwise, empty.
13506
13507 .vitem &$version_number$&
13508 .vindex "&$version_number$&"
13509 The version number of Exim.
13510
13511 .vitem &$warn_message_delay$&
13512 .vindex "&$warn_message_delay$&"
13513 This variable is set only during the creation of a message warning about a
13514 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13515
13516 .vitem &$warn_message_recipients$&
13517 .vindex "&$warn_message_recipients$&"
13518 This variable is set only during the creation of a message warning about a
13519 delivery delay. Details of its use are explained in section &<<SECTcustwarn>>&.
13520 .endlist
13521 .ecindex IIDstrexp
13522
13523
13524
13525 . ////////////////////////////////////////////////////////////////////////////
13526 . ////////////////////////////////////////////////////////////////////////////
13527
13528 .chapter "Embedded Perl" "CHAPperl"
13529 .scindex IIDperl "Perl" "calling from Exim"
13530 Exim can be built to include an embedded Perl interpreter. When this is done,
13531 Perl subroutines can be called as part of the string expansion process. To make
13532 use of the Perl support, you need version 5.004 or later of Perl installed on
13533 your system. To include the embedded interpreter in the Exim binary, include
13534 the line
13535 .code
13536 EXIM_PERL = perl.o
13537 .endd
13538 in your &_Local/Makefile_& and then build Exim in the normal way.
13539
13540
13541 .section "Setting up so Perl can be used" "SECID85"
13542 .oindex "&%perl_startup%&"
13543 Access to Perl subroutines is via a global configuration option called
13544 &%perl_startup%& and an expansion string operator &%${perl ...}%&. If there is
13545 no &%perl_startup%& option in the Exim configuration file then no Perl
13546 interpreter is started and there is almost no overhead for Exim (since none of
13547 the Perl library will be paged in unless used). If there is a &%perl_startup%&
13548 option then the associated value is taken to be Perl code which is executed in
13549 a newly created Perl interpreter.
13550
13551 The value of &%perl_startup%& is not expanded in the Exim sense, so you do not
13552 need backslashes before any characters to escape special meanings. The option
13553 should usually be something like
13554 .code
13555 perl_startup = do '/etc/exim.pl'
13556 .endd
13557 where &_/etc/exim.pl_& is Perl code which defines any subroutines you want to
13558 use from Exim. Exim can be configured either to start up a Perl interpreter as
13559 soon as it is entered, or to wait until the first time it is needed. Starting
13560 the interpreter at the beginning ensures that it is done while Exim still has
13561 its setuid privilege, but can impose an unnecessary overhead if Perl is not in
13562 fact used in a particular run. Also, note that this does not mean that Exim is
13563 necessarily running as root when Perl is called at a later time. By default,
13564 the interpreter is started only when it is needed, but this can be changed in
13565 two ways:
13566
13567 .ilist
13568 .oindex "&%perl_at_start%&"
13569 Setting &%perl_at_start%& (a boolean option) in the configuration requests
13570 a startup when Exim is entered.
13571 .next
13572 The command line option &%-ps%& also requests a startup when Exim is entered,
13573 overriding the setting of &%perl_at_start%&.
13574 .endlist
13575
13576 There is also a command line option &%-pd%& (for delay) which suppresses the
13577 initial startup, even if &%perl_at_start%& is set.
13578
13579 .ilist
13580 .oindex "&%perl_taintmode%&"
13581 .cindex "Perl" "taintmode"
13582 To provide more security executing Perl code via the embedded Perl
13583 interpreter, the &%perl_taintmode%& option can be set. This enables the
13584 taint mode of the Perl interpreter. You are encouraged to set this
13585 option to a true value. To avoid breaking existing installations, it
13586 defaults to false.
13587
13588
13589 .section "Calling Perl subroutines" "SECID86"
13590 When the configuration file includes a &%perl_startup%& option you can make use
13591 of the string expansion item to call the Perl subroutines that are defined
13592 by the &%perl_startup%& code. The operator is used in any of the following
13593 forms:
13594 .code
13595 ${perl{foo}}
13596 ${perl{foo}{argument}}
13597 ${perl{foo}{argument1}{argument2} ... }
13598 .endd
13599 which calls the subroutine &%foo%& with the given arguments. A maximum of eight
13600 arguments may be passed. Passing more than this results in an expansion failure
13601 with an error message of the form
13602 .code
13603 Too many arguments passed to Perl subroutine "foo" (max is 8)
13604 .endd
13605 The return value of the Perl subroutine is evaluated in a scalar context before
13606 it is passed back to Exim to be inserted into the expanded string. If the
13607 return value is &'undef'&, the expansion is forced to fail in the same way as
13608 an explicit &"fail"& on an &%if%& or &%lookup%& item. If the subroutine aborts
13609 by obeying Perl's &%die%& function, the expansion fails with the error message
13610 that was passed to &%die%&.
13611
13612
13613 .section "Calling Exim functions from Perl" "SECID87"
13614 Within any Perl code called from Exim, the function &'Exim::expand_string()'&
13615 is available to call back into Exim's string expansion function. For example,
13616 the Perl code
13617 .code
13618 my $lp = Exim::expand_string('$local_part');
13619 .endd
13620 makes the current Exim &$local_part$& available in the Perl variable &$lp$&.
13621 Note those are single quotes and not double quotes to protect against
13622 &$local_part$& being interpolated as a Perl variable.
13623
13624 If the string expansion is forced to fail by a &"fail"& item, the result of
13625 &'Exim::expand_string()'& is &%undef%&. If there is a syntax error in the
13626 expansion string, the Perl call from the original expansion string fails with
13627 an appropriate error message, in the same way as if &%die%& were used.
13628
13629 .cindex "debugging" "from embedded Perl"
13630 .cindex "log" "writing from embedded Perl"
13631 Two other Exim functions are available for use from within Perl code.
13632 &'Exim::debug_write()'& writes a string to the standard error stream if Exim's
13633 debugging is enabled. If you want a newline at the end, you must supply it.
13634 &'Exim::log_write()'& writes a string to Exim's main log, adding a leading
13635 timestamp. In this case, you should not supply a terminating newline.
13636
13637
13638 .section "Use of standard output and error by Perl" "SECID88"
13639 .cindex "Perl" "standard output and error"
13640 You should not write to the standard error or output streams from within your
13641 Perl code, as it is not defined how these are set up. In versions of Exim
13642 before 4.50, it is possible for the standard output or error to refer to the
13643 SMTP connection during message reception via the daemon. Writing to this stream
13644 is certain to cause chaos. From Exim 4.50 onwards, the standard output and
13645 error streams are connected to &_/dev/null_& in the daemon. The chaos is
13646 avoided, but the output is lost.
13647
13648 .cindex "Perl" "use of &%warn%&"
13649 The Perl &%warn%& statement writes to the standard error stream by default.
13650 Calls to &%warn%& may be embedded in Perl modules that you use, but over which
13651 you have no control. When Exim starts up the Perl interpreter, it arranges for
13652 output from the &%warn%& statement to be written to the Exim main log. You can
13653 change this by including appropriate Perl magic somewhere in your Perl code.
13654 For example, to discard &%warn%& output completely, you need this:
13655 .code
13656 $SIG{__WARN__} = sub { };
13657 .endd
13658 Whenever a &%warn%& is obeyed, the anonymous subroutine is called. In this
13659 example, the code for the subroutine is empty, so it does nothing, but you can
13660 include any Perl code that you like. The text of the &%warn%& message is passed
13661 as the first subroutine argument.
13662 .ecindex IIDperl
13663
13664
13665 . ////////////////////////////////////////////////////////////////////////////
13666 . ////////////////////////////////////////////////////////////////////////////
13667
13668 .chapter "Starting the daemon and the use of network interfaces" &&&
13669          "CHAPinterfaces" &&&
13670          "Starting the daemon"
13671 .cindex "daemon" "starting"
13672 .cindex "interface" "listening"
13673 .cindex "network interface"
13674 .cindex "interface" "network"
13675 .cindex "IP address" "for listening"
13676 .cindex "daemon" "listening IP addresses"
13677 .cindex "TCP/IP" "setting listening interfaces"
13678 .cindex "TCP/IP" "setting listening ports"
13679 A host that is connected to a TCP/IP network may have one or more physical
13680 hardware network interfaces. Each of these interfaces may be configured as one
13681 or more &"logical"& interfaces, which are the entities that a program actually
13682 works with. Each of these logical interfaces is associated with an IP address.
13683 In addition, TCP/IP software supports &"loopback"& interfaces (127.0.0.1 in
13684 IPv4 and ::1 in IPv6), which do not use any physical hardware. Exim requires
13685 knowledge about the host's interfaces for use in three different circumstances:
13686
13687 .olist
13688 When a listening daemon is started, Exim needs to know which interfaces
13689 and ports to listen on.
13690 .next
13691 When Exim is routing an address, it needs to know which IP addresses
13692 are associated with local interfaces. This is required for the correct
13693 processing of MX lists by removing the local host and others with the
13694 same or higher priority values. Also, Exim needs to detect cases
13695 when an address is routed to an IP address that in fact belongs to the
13696 local host. Unless the &%self%& router option or the &%allow_localhost%&
13697 option of the smtp transport is set (as appropriate), this is treated
13698 as an error situation.
13699 .next
13700 When Exim connects to a remote host, it may need to know which interface to use
13701 for the outgoing connection.
13702 .endlist
13703
13704
13705 Exim's default behaviour is likely to be appropriate in the vast majority
13706 of cases. If your host has only one interface, and you want all its IP
13707 addresses to be treated in the same way, and you are using only the
13708 standard SMTP port, you should not need to take any special action. The
13709 rest of this chapter does not apply to you.
13710
13711 In a more complicated situation you may want to listen only on certain
13712 interfaces, or on different ports, and for this reason there are a number of
13713 options that can be used to influence Exim's behaviour. The rest of this
13714 chapter describes how they operate.
13715
13716 When a message is received over TCP/IP, the interface and port that were
13717 actually used are set in &$received_ip_address$& and &$received_port$&.
13718
13719
13720
13721 .section "Starting a listening daemon" "SECID89"
13722 When a listening daemon is started (by means of the &%-bd%& command line
13723 option), the interfaces and ports on which it listens are controlled by the
13724 following options:
13725
13726 .ilist
13727 &%daemon_smtp_ports%& contains a list of default ports
13728 or service names.
13729 (For backward compatibility, this option can also be specified in the singular.)
13730 .next
13731 &%local_interfaces%& contains list of interface IP addresses on which to
13732 listen. Each item may optionally also specify a port.
13733 .endlist
13734
13735 The default list separator in both cases is a colon, but this can be changed as
13736 described in section &<<SECTlistsepchange>>&. When IPv6 addresses are involved,
13737 it is usually best to change the separator to avoid having to double all the
13738 colons. For example:
13739 .code
13740 local_interfaces = <; 127.0.0.1 ; \
13741                       192.168.23.65 ; \
13742                       ::1 ; \
13743                       3ffe:ffff:836f::fe86:a061
13744 .endd
13745 There are two different formats for specifying a port along with an IP address
13746 in &%local_interfaces%&:
13747
13748 .olist
13749 The port is added onto the address with a dot separator. For example, to listen
13750 on port 1234 on two different IP addresses:
13751 .code
13752 local_interfaces = <; 192.168.23.65.1234 ; \
13753                       3ffe:ffff:836f::fe86:a061.1234
13754 .endd
13755 .next
13756 The IP address is enclosed in square brackets, and the port is added
13757 with a colon separator, for example:
13758 .code
13759 local_interfaces = <; [192.168.23.65]:1234 ; \
13760                       [3ffe:ffff:836f::fe86:a061]:1234
13761 .endd
13762 .endlist
13763
13764 When a port is not specified, the value of &%daemon_smtp_ports%& is used. The
13765 default setting contains just one port:
13766 .code
13767 daemon_smtp_ports = smtp
13768 .endd
13769 If more than one port is listed, each interface that does not have its own port
13770 specified listens on all of them. Ports that are listed in
13771 &%daemon_smtp_ports%& can be identified either by name (defined in
13772 &_/etc/services_&) or by number. However, when ports are given with individual
13773 IP addresses in &%local_interfaces%&, only numbers (not names) can be used.
13774
13775
13776
13777 .section "Special IP listening addresses" "SECID90"
13778 The addresses 0.0.0.0 and ::0 are treated specially. They are interpreted
13779 as &"all IPv4 interfaces"& and &"all IPv6 interfaces"&, respectively. In each
13780 case, Exim tells the TCP/IP stack to &"listen on all IPv&'x'& interfaces"&
13781 instead of setting up separate listening sockets for each interface. The
13782 default value of &%local_interfaces%& is
13783 .code
13784 local_interfaces = 0.0.0.0
13785 .endd
13786 when Exim is built without IPv6 support; otherwise it is:
13787 .code
13788 local_interfaces = <; ::0 ; 0.0.0.0
13789 .endd
13790 Thus, by default, Exim listens on all available interfaces, on the SMTP port.
13791
13792
13793
13794 .section "Overriding local_interfaces and daemon_smtp_ports" "SECID91"
13795 The &%-oX%& command line option can be used to override the values of
13796 &%daemon_smtp_ports%& and/or &%local_interfaces%& for a particular daemon
13797 instance. Another way of doing this would be to use macros and the &%-D%&
13798 option. However, &%-oX%& can be used by any admin user, whereas modification of
13799 the runtime configuration by &%-D%& is allowed only when the caller is root or
13800 exim.
13801
13802 The value of &%-oX%& is a list of items. The default colon separator can be
13803 changed in the usual way (&<<SECTlistsepchange>>&) if required.
13804 If there are any items that do not
13805 contain dots or colons (that is, are not IP addresses), the value of
13806 &%daemon_smtp_ports%& is replaced by the list of those items. If there are any
13807 items that do contain dots or colons, the value of &%local_interfaces%& is
13808 replaced by those items. Thus, for example,
13809 .code
13810 -oX 1225
13811 .endd
13812 overrides &%daemon_smtp_ports%&, but leaves &%local_interfaces%& unchanged,
13813 whereas
13814 .code
13815 -oX 192.168.34.5.1125
13816 .endd
13817 overrides &%local_interfaces%&, leaving &%daemon_smtp_ports%& unchanged.
13818 (However, since &%local_interfaces%& now contains no items without ports, the
13819 value of &%daemon_smtp_ports%& is no longer relevant in this example.)
13820
13821
13822
13823 .section "Support for the submissions (aka SSMTP or SMTPS) protocol" "SECTsupobssmt"
13824 .cindex "submissions protocol"
13825 .cindex "ssmtp protocol"
13826 .cindex "smtps protocol"
13827 .cindex "SMTP" "ssmtp protocol"
13828 .cindex "SMTP" "smtps protocol"
13829 Exim supports the use of TLS-on-connect, used by mail clients in the
13830 &"submissions"& protocol, historically also known as SMTPS or SSMTP.
13831 For some years, IETF Standards Track documents only blessed the
13832 STARTTLS-based Submission service (port 587) while common practice was to support
13833 the same feature set on port 465, but using TLS-on-connect.
13834 If your installation needs to provide service to mail clients
13835 (Mail User Agents, MUAs) then you should provide service on both the 587 and
13836 the 465 TCP ports.
13837
13838 If the &%tls_on_connect_ports%& option is set to a list of port numbers or
13839 service names, connections to those ports must first establish TLS, before
13840 proceeding to the application layer use of the SMTP protocol.
13841
13842 The common use of this option is expected to be
13843 .code
13844 tls_on_connect_ports = 465
13845 .endd
13846 per RFC 8314.
13847 There is also a command line option &%-tls-on-connect%&, which forces all ports
13848 to behave in this way when a daemon is started.
13849
13850 &*Warning*&: Setting &%tls_on_connect_ports%& does not of itself cause the
13851 daemon to listen on those ports. You must still specify them in
13852 &%daemon_smtp_ports%&, &%local_interfaces%&, or the &%-oX%& option. (This is
13853 because &%tls_on_connect_ports%& applies to &%inetd%& connections as well as to
13854 connections via the daemon.)
13855
13856
13857
13858
13859 .section "IPv6 address scopes" "SECID92"
13860 .cindex "IPv6" "address scopes"
13861 IPv6 addresses have &"scopes"&, and a host with multiple hardware interfaces
13862 can, in principle, have the same link-local IPv6 address on different
13863 interfaces. Thus, additional information is needed, over and above the IP
13864 address, to distinguish individual interfaces. A convention of using a
13865 percent sign followed by something (often the interface name) has been
13866 adopted in some cases, leading to addresses like this:
13867 .code
13868 fe80::202:b3ff:fe03:45c1%eth0
13869 .endd
13870 To accommodate this usage, a percent sign followed by an arbitrary string is
13871 allowed at the end of an IPv6 address. By default, Exim calls &[getaddrinfo()]&
13872 to convert a textual IPv6 address for actual use. This function recognizes the
13873 percent convention in operating systems that support it, and it processes the
13874 address appropriately. Unfortunately, some older libraries have problems with
13875 &[getaddrinfo()]&. If
13876 .code
13877 IPV6_USE_INET_PTON=yes
13878 .endd
13879 is set in &_Local/Makefile_& (or an OS-dependent Makefile) when Exim is built,
13880 Exim uses &'inet_pton()'& to convert a textual IPv6 address for actual use,
13881 instead of &[getaddrinfo()]&. (Before version 4.14, it always used this
13882 function.) Of course, this means that the additional functionality of
13883 &[getaddrinfo()]& &-- recognizing scoped addresses &-- is lost.
13884
13885 .section "Disabling IPv6" "SECID93"
13886 .cindex "IPv6" "disabling"
13887 Sometimes it happens that an Exim binary that was compiled with IPv6 support is
13888 run on a host whose kernel does not support IPv6. The binary will fall back to
13889 using IPv4, but it may waste resources looking up AAAA records, and trying to
13890 connect to IPv6 addresses, causing delays to mail delivery. If you set the
13891 .oindex "&%disable_ipv6%&"
13892 &%disable_ipv6%& option true, even if the Exim binary has IPv6 support, no IPv6
13893 activities take place. AAAA records are never looked up, and any IPv6 addresses
13894 that are listed in &%local_interfaces%&, data for the &(manualroute)& router,
13895 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
13896 to handle IPv6 literal addresses.
13897
13898 On the other hand, when IPv6 is in use, there may be times when you want to
13899 disable it for certain hosts or domains. You can use the &%dns_ipv4_lookup%&
13900 option to globally suppress the lookup of AAAA records for specified domains,
13901 and you can use the &%ignore_target_hosts%& generic router option to ignore
13902 IPv6 addresses in an individual router.
13903
13904
13905
13906 .section "Examples of starting a listening daemon" "SECID94"
13907 The default case in an IPv6 environment is
13908 .code
13909 daemon_smtp_ports = smtp
13910 local_interfaces = <; ::0 ; 0.0.0.0
13911 .endd
13912 This specifies listening on the smtp port on all IPv6 and IPv4 interfaces.
13913 Either one or two sockets may be used, depending on the characteristics of
13914 the TCP/IP stack. (This is complicated and messy; for more information,
13915 read the comments in the &_daemon.c_& source file.)
13916
13917 To specify listening on ports 25 and 26 on all interfaces:
13918 .code
13919 daemon_smtp_ports = 25 : 26
13920 .endd
13921 (leaving &%local_interfaces%& at the default setting) or, more explicitly:
13922 .code
13923 local_interfaces = <; ::0.25     ; ::0.26 \
13924                       0.0.0.0.25 ; 0.0.0.0.26
13925 .endd
13926 To listen on the default port on all IPv4 interfaces, and on port 26 on the
13927 IPv4 loopback address only:
13928 .code
13929 local_interfaces = 0.0.0.0 : 127.0.0.1.26
13930 .endd
13931 To specify listening on the default port on specific interfaces only:
13932 .code
13933 local_interfaces = 10.0.0.67 : 192.168.34.67
13934 .endd
13935 &*Warning*&: Such a setting excludes listening on the loopback interfaces.
13936
13937
13938
13939 .section "Recognizing the local host" "SECTreclocipadd"
13940 The &%local_interfaces%& option is also used when Exim needs to determine
13941 whether or not an IP address refers to the local host. That is, the IP
13942 addresses of all the interfaces on which a daemon is listening are always
13943 treated as local.
13944
13945 For this usage, port numbers in &%local_interfaces%& are ignored. If either of
13946 the items 0.0.0.0 or ::0 are encountered, Exim gets a complete list of
13947 available interfaces from the operating system, and extracts the relevant
13948 (that is, IPv4 or IPv6) addresses to use for checking.
13949
13950 Some systems set up large numbers of virtual interfaces in order to provide
13951 many virtual web servers. In this situation, you may want to listen for
13952 email on only a few of the available interfaces, but nevertheless treat all
13953 interfaces as local when routing. You can do this by setting
13954 &%extra_local_interfaces%& to a list of IP addresses, possibly including the
13955 &"all"& wildcard values. These addresses are recognized as local, but are not
13956 used for listening. Consider this example:
13957 .code
13958 local_interfaces = <; 127.0.0.1 ; ::1 ; \
13959                       192.168.53.235 ; \
13960                       3ffe:2101:12:1:a00:20ff:fe86:a061
13961
13962 extra_local_interfaces = <; ::0 ; 0.0.0.0
13963 .endd
13964 The daemon listens on the loopback interfaces and just one IPv4 and one IPv6
13965 address, but all available interface addresses are treated as local when
13966 Exim is routing.
13967
13968 In some environments the local host name may be in an MX list, but with an IP
13969 address that is not assigned to any local interface. In other cases it may be
13970 desirable to treat other host names as if they referred to the local host. Both
13971 these cases can be handled by setting the &%hosts_treat_as_local%& option.
13972 This contains host names rather than IP addresses. When a host is referenced
13973 during routing, either via an MX record or directly, it is treated as the local
13974 host if its name matches &%hosts_treat_as_local%&, or if any of its IP
13975 addresses match &%local_interfaces%& or &%extra_local_interfaces%&.
13976
13977
13978
13979 .section "Delivering to a remote host" "SECID95"
13980 Delivery to a remote host is handled by the smtp transport. By default, it
13981 allows the system's TCP/IP functions to choose which interface to use (if
13982 there is more than one) when connecting to a remote host. However, the
13983 &%interface%& option can be set to specify which interface is used. See the
13984 description of the smtp transport in chapter &<<CHAPsmtptrans>>& for more
13985 details.
13986
13987
13988
13989
13990 . ////////////////////////////////////////////////////////////////////////////
13991 . ////////////////////////////////////////////////////////////////////////////
13992
13993 .chapter "Main configuration" "CHAPmainconfig"
13994 .scindex IIDconfima "configuration file" "main section"
13995 .scindex IIDmaiconf "main configuration"
13996 The first part of the runtime configuration file contains three types of item:
13997
13998 .ilist
13999 Macro definitions: These lines start with an upper case letter. See section
14000 &<<SECTmacrodefs>>& for details of macro processing.
14001 .next
14002 Named list definitions: These lines start with one of the words &"domainlist"&,
14003 &"hostlist"&, &"addresslist"&, or &"localpartlist"&. Their use is described in
14004 section &<<SECTnamedlists>>&.
14005 .next
14006 Main configuration settings: Each setting occupies one line of the file
14007 (with possible continuations). If any setting is preceded by the word
14008 &"hide"&, the &%-bP%& command line option displays its value to admin users
14009 only. See section &<<SECTcos>>& for a description of the syntax of these option
14010 settings.
14011 .endlist
14012
14013 This chapter specifies all the main configuration options, along with their
14014 types and default values. For ease of finding a particular option, they appear
14015 in alphabetical order in section &<<SECTalomo>>& below. However, because there
14016 are now so many options, they are first listed briefly in functional groups, as
14017 an aid to finding the name of the option you are looking for. Some options are
14018 listed in more than one group.
14019
14020 .section "Miscellaneous" "SECID96"
14021 .table2
14022 .row &%bi_command%&                  "to run for &%-bi%& command line option"
14023 .row &%debug_store%&                 "do extra internal checks"
14024 .row &%disable_ipv6%&                "do no IPv6 processing"
14025 .row &%keep_malformed%&              "for broken files &-- should not happen"
14026 .row &%localhost_number%&            "for unique message ids in clusters"
14027 .row &%message_body_newlines%&       "retain newlines in &$message_body$&"
14028 .row &%message_body_visible%&        "how much to show in &$message_body$&"
14029 .row &%mua_wrapper%&                 "run in &""MUA wrapper""& mode"
14030 .row &%print_topbitchars%&           "top-bit characters are printing"
14031 .row &%spool_wireformat%&            "use wire-format spool data files when possible"
14032 .row &%timezone%&                    "force time zone"
14033 .endtable
14034
14035
14036 .section "Exim parameters" "SECID97"
14037 .table2
14038 .row &%exim_group%&                  "override compiled-in value"
14039 .row &%exim_path%&                   "override compiled-in value"
14040 .row &%exim_user%&                   "override compiled-in value"
14041 .row &%primary_hostname%&            "default from &[uname()]&"
14042 .row &%split_spool_directory%&       "use multiple directories"
14043 .row &%spool_directory%&             "override compiled-in value"
14044 .endtable
14045
14046
14047
14048 .section "Privilege controls" "SECID98"
14049 .table2
14050 .row &%admin_groups%&                "groups that are Exim admin users"
14051 .row &%commandline_checks_require_admin%& "require admin for various checks"
14052 .row &%deliver_drop_privilege%&      "drop root for delivery processes"
14053 .row &%local_from_check%&            "insert &'Sender:'& if necessary"
14054 .row &%local_from_prefix%&           "for testing &'From:'& for local sender"
14055 .row &%local_from_suffix%&           "for testing &'From:'& for local sender"
14056 .row &%local_sender_retain%&         "keep &'Sender:'& from untrusted user"
14057 .row &%never_users%&                 "do not run deliveries as these"
14058 .row &%prod_requires_admin%&         "forced delivery requires admin user"
14059 .row &%queue_list_requires_admin%&   "queue listing requires admin user"
14060 .row &%trusted_groups%&              "groups that are trusted"
14061 .row &%trusted_users%&               "users that are trusted"
14062 .endtable
14063
14064
14065
14066 .section "Logging" "SECID99"
14067 .table2
14068 .row &%event_action%&                "custom logging"
14069 .row &%hosts_connection_nolog%&      "exemption from connect logging"
14070 .row &%log_file_path%&               "override compiled-in value"
14071 .row &%log_selector%&                "set/unset optional logging"
14072 .row &%log_timezone%&                "add timezone to log lines"
14073 .row &%message_logs%&                "create per-message logs"
14074 .row &%preserve_message_logs%&       "after message completion"
14075 .row &%process_log_path%&            "for SIGUSR1 and &'exiwhat'&"
14076 .row &%slow_lookup_log%&             "control logging of slow DNS lookups"
14077 .row &%syslog_duplication%&          "controls duplicate log lines on syslog"
14078 .row &%syslog_facility%&             "set syslog &""facility""& field"
14079 .row &%syslog_pid%&                  "pid in syslog lines"
14080 .row &%syslog_processname%&          "set syslog &""ident""& field"
14081 .row &%syslog_timestamp%&            "timestamp syslog lines"
14082 .row &%write_rejectlog%&             "control use of message log"
14083 .endtable
14084
14085
14086
14087 .section "Frozen messages" "SECID100"
14088 .table2
14089 .row &%auto_thaw%&                   "sets time for retrying frozen messages"
14090 .row &%freeze_tell%&                 "send message when freezing"
14091 .row &%move_frozen_messages%&        "to another directory"
14092 .row &%timeout_frozen_after%&        "keep frozen messages only so long"
14093 .endtable
14094
14095
14096
14097 .section "Data lookups" "SECID101"
14098 .table2
14099 .row &%ibase_servers%&               "InterBase servers"
14100 .row &%ldap_ca_cert_dir%&            "dir of CA certs to verify LDAP server's"
14101 .row &%ldap_ca_cert_file%&           "file of CA certs to verify LDAP server's"
14102 .row &%ldap_cert_file%&              "client cert file for LDAP"
14103 .row &%ldap_cert_key%&               "client key file for LDAP"
14104 .row &%ldap_cipher_suite%&           "TLS negotiation preference control"
14105 .row &%ldap_default_servers%&        "used if no server in query"
14106 .row &%ldap_require_cert%&           "action to take without LDAP server cert"
14107 .row &%ldap_start_tls%&              "require TLS within LDAP"
14108 .row &%ldap_version%&                "set protocol version"
14109 .row &%lookup_open_max%&             "lookup files held open"
14110 .row &%mysql_servers%&               "default MySQL servers"
14111 .row &%oracle_servers%&              "Oracle servers"
14112 .row &%pgsql_servers%&               "default PostgreSQL servers"
14113 .row &%sqlite_lock_timeout%&         "as it says"
14114 .endtable
14115
14116
14117
14118 .section "Message ids" "SECID102"
14119 .table2
14120 .row &%message_id_header_domain%&    "used to build &'Message-ID:'& header"
14121 .row &%message_id_header_text%&      "ditto"
14122 .endtable
14123
14124
14125
14126 .section "Embedded Perl Startup" "SECID103"
14127 .table2
14128 .row &%perl_at_start%&               "always start the interpreter"
14129 .row &%perl_startup%&                "code to obey when starting Perl"
14130 .row &%perl_taintmode%&              "enable taint mode in Perl"
14131 .endtable
14132
14133
14134
14135 .section "Daemon" "SECID104"
14136 .table2
14137 .row &%daemon_smtp_ports%&           "default ports"
14138 .row &%daemon_startup_retries%&      "number of times to retry"
14139 .row &%daemon_startup_sleep%&        "time to sleep between tries"
14140 .row &%extra_local_interfaces%&      "not necessarily listened on"
14141 .row &%local_interfaces%&            "on which to listen, with optional ports"
14142 .row &%pid_file_path%&               "override compiled-in value"
14143 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14144 .endtable
14145
14146
14147
14148 .section "Resource control" "SECID105"
14149 .table2
14150 .row &%check_log_inodes%&            "before accepting a message"
14151 .row &%check_log_space%&             "before accepting a message"
14152 .row &%check_spool_inodes%&          "before accepting a message"
14153 .row &%check_spool_space%&           "before accepting a message"
14154 .row &%deliver_queue_load_max%&      "no queue deliveries if load high"
14155 .row &%queue_only_load%&             "queue incoming if load high"
14156 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14157 .row &%queue_run_max%&               "maximum simultaneous queue runners"
14158 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14159 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14160 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14161 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14162 .row &%smtp_accept_max_per_connection%& "messages per connection"
14163 .row &%smtp_accept_max_per_host%&    "connections from one host"
14164 .row &%smtp_accept_queue%&           "queue mail if more connections"
14165 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14166                                            connection"
14167 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14168 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14169 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14170 .row &%smtp_load_reserve%&           "SMTP from reserved hosts if load high"
14171 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14172 .endtable
14173
14174
14175
14176 .section "Policy controls" "SECID106"
14177 .table2
14178 .row &%acl_not_smtp%&                "ACL for non-SMTP messages"
14179 .row &%acl_not_smtp_mime%&           "ACL for non-SMTP MIME parts"
14180 .row &%acl_not_smtp_start%&          "ACL for start of non-SMTP message"
14181 .row &%acl_smtp_auth%&               "ACL for AUTH"
14182 .row &%acl_smtp_connect%&            "ACL for connection"
14183 .row &%acl_smtp_data%&               "ACL for DATA"
14184 .row &%acl_smtp_data_prdr%&          "ACL for DATA, per-recipient"
14185 .row &%acl_smtp_dkim%&               "ACL for DKIM verification"
14186 .row &%acl_smtp_etrn%&               "ACL for ETRN"
14187 .row &%acl_smtp_expn%&               "ACL for EXPN"
14188 .row &%acl_smtp_helo%&               "ACL for EHLO or HELO"
14189 .row &%acl_smtp_mail%&               "ACL for MAIL"
14190 .row &%acl_smtp_mailauth%&           "ACL for AUTH on MAIL command"
14191 .row &%acl_smtp_mime%&               "ACL for MIME parts"
14192 .row &%acl_smtp_notquit%&            "ACL for non-QUIT terminations"
14193 .row &%acl_smtp_predata%&            "ACL for start of data"
14194 .row &%acl_smtp_quit%&               "ACL for QUIT"
14195 .row &%acl_smtp_rcpt%&               "ACL for RCPT"
14196 .row &%acl_smtp_starttls%&           "ACL for STARTTLS"
14197 .row &%acl_smtp_vrfy%&               "ACL for VRFY"
14198 .row &%av_scanner%&                  "specify virus scanner"
14199 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14200                                       words""&"
14201 .row &%dns_cname_loops%&             "follow CNAMEs returned by resolver"
14202 .row &%dns_csa_search_limit%&        "control CSA parent search depth"
14203 .row &%dns_csa_use_reverse%&         "en/disable CSA IP reverse search"
14204 .row &%header_maxsize%&              "total size of message header"
14205 .row &%header_line_maxsize%&         "individual header line limit"
14206 .row &%helo_accept_junk_hosts%&      "allow syntactic junk from these hosts"
14207 .row &%helo_allow_chars%&            "allow illegal chars in HELO names"
14208 .row &%helo_lookup_domains%&         "lookup hostname for these HELO names"
14209 .row &%helo_try_verify_hosts%&       "HELO soft-checked for these hosts"
14210 .row &%helo_verify_hosts%&           "HELO hard-checked for these hosts"
14211 .row &%host_lookup%&                 "host name looked up for these hosts"
14212 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14213 .row &%hosts_proxy%&                 "use proxy protocol for these hosts"
14214 .row &%host_reject_connection%&      "reject connection from these hosts"
14215 .row &%hosts_treat_as_local%&        "useful in some cluster configurations"
14216 .row &%local_scan_timeout%&          "timeout for &[local_scan()]&"
14217 .row &%message_size_limit%&          "for all messages"
14218 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14219 .row &%spamd_address%&               "set interface to SpamAssassin"
14220 .row &%strict_acl_vars%&             "object to unset ACL variables"
14221 .endtable
14222
14223
14224
14225 .section "Callout cache" "SECID107"
14226 .table2
14227 .row &%callout_domain_negative_expire%& "timeout for negative domain cache &&&
14228                                          item"
14229 .row &%callout_domain_positive_expire%& "timeout for positive domain cache &&&
14230                                          item"
14231 .row &%callout_negative_expire%&     "timeout for negative address cache item"
14232 .row &%callout_positive_expire%&     "timeout for positive address cache item"
14233 .row &%callout_random_local_part%&   "string to use for &""random""& testing"
14234 .endtable
14235
14236
14237
14238 .section "TLS" "SECID108"
14239 .table2
14240 .row &%gnutls_compat_mode%&          "use GnuTLS compatibility mode"
14241 .row &%gnutls_allow_auto_pkcs11%&    "allow GnuTLS to autoload PKCS11 modules"
14242 .row &%openssl_options%&             "adjust OpenSSL compatibility options"
14243 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14244 .row &%tls_certificate%&             "location of server certificate"
14245 .row &%tls_crl%&                     "certificate revocation list"
14246 .row &%tls_dh_max_bits%&             "clamp D-H bit count suggestion"
14247 .row &%tls_dhparam%&                 "DH parameters for server"
14248 .row &%tls_eccurve%&                 "EC curve selection for server"
14249 .row &%tls_ocsp_file%&               "location of server certificate status proof"
14250 .row &%tls_on_connect_ports%&        "specify SSMTP (SMTPS) ports"
14251 .row &%tls_privatekey%&              "location of server private key"
14252 .row &%tls_remember_esmtp%&          "don't reset after starting TLS"
14253 .row &%tls_require_ciphers%&         "specify acceptable ciphers"
14254 .row &%tls_try_verify_hosts%&        "try to verify client certificate"
14255 .row &%tls_verify_certificates%&     "expected client certificates"
14256 .row &%tls_verify_hosts%&            "insist on client certificate verify"
14257 .endtable
14258
14259
14260
14261 .section "Local user handling" "SECID109"
14262 .table2
14263 .row &%finduser_retries%&            "useful in NIS environments"
14264 .row &%gecos_name%&                  "used when creating &'Sender:'&"
14265 .row &%gecos_pattern%&               "ditto"
14266 .row &%max_username_length%&         "for systems that truncate"
14267 .row &%unknown_login%&               "used when no login name found"
14268 .row &%unknown_username%&            "ditto"
14269 .row &%uucp_from_pattern%&           "for recognizing &""From ""& lines"
14270 .row &%uucp_from_sender%&            "ditto"
14271 .endtable
14272
14273
14274
14275 .section "All incoming messages (SMTP and non-SMTP)" "SECID110"
14276 .table2
14277 .row &%header_maxsize%&              "total size of message header"
14278 .row &%header_line_maxsize%&         "individual header line limit"
14279 .row &%message_size_limit%&          "applies to all messages"
14280 .row &%percent_hack_domains%&        "recognize %-hack for these domains"
14281 .row &%received_header_text%&        "expanded to make &'Received:'&"
14282 .row &%received_headers_max%&        "for mail loop detection"
14283 .row &%recipients_max%&              "limit per message"
14284 .row &%recipients_max_reject%&       "permanently reject excess recipients"
14285 .endtable
14286
14287
14288
14289
14290 .section "Non-SMTP incoming messages" "SECID111"
14291 .table2
14292 .row &%receive_timeout%&             "for non-SMTP messages"
14293 .endtable
14294
14295
14296
14297
14298
14299 .section "Incoming SMTP messages" "SECID112"
14300 See also the &'Policy controls'& section above.
14301
14302 .table2
14303 .row &%dkim_verify_signers%&         "DKIM domain for which DKIM ACL is run"
14304 .row &%host_lookup%&                 "host name looked up for these hosts"
14305 .row &%host_lookup_order%&           "order of DNS and local name lookups"
14306 .row &%recipient_unqualified_hosts%& "may send unqualified recipients"
14307 .row &%rfc1413_hosts%&               "make ident calls to these hosts"
14308 .row &%rfc1413_query_timeout%&       "zero disables ident calls"
14309 .row &%sender_unqualified_hosts%&    "may send unqualified senders"
14310 .row &%smtp_accept_keepalive%&       "some TCP/IP magic"
14311 .row &%smtp_accept_max%&             "simultaneous incoming connections"
14312 .row &%smtp_accept_max_nonmail%&     "non-mail commands"
14313 .row &%smtp_accept_max_nonmail_hosts%& "hosts to which the limit applies"
14314 .row &%smtp_accept_max_per_connection%& "messages per connection"
14315 .row &%smtp_accept_max_per_host%&    "connections from one host"
14316 .row &%smtp_accept_queue%&           "queue mail if more connections"
14317 .row &%smtp_accept_queue_per_connection%& "queue if more messages per &&&
14318                                            connection"
14319 .row &%smtp_accept_reserve%&         "only reserve hosts if more connections"
14320 .row &%smtp_active_hostname%&        "host name to use in messages"
14321 .row &%smtp_banner%&                 "text for welcome banner"
14322 .row &%smtp_check_spool_space%&      "from SIZE on MAIL command"
14323 .row &%smtp_connect_backlog%&        "passed to TCP/IP stack"
14324 .row &%smtp_enforce_sync%&           "of SMTP command/responses"
14325 .row &%smtp_etrn_command%&           "what to run for ETRN"
14326 .row &%smtp_etrn_serialize%&         "only one at once"
14327 .row &%smtp_load_reserve%&           "only reserve hosts if this load"
14328 .row &%smtp_max_unknown_commands%&   "before dropping connection"
14329 .row &%smtp_ratelimit_hosts%&        "apply ratelimiting to these hosts"
14330 .row &%smtp_ratelimit_mail%&         "ratelimit for MAIL commands"
14331 .row &%smtp_ratelimit_rcpt%&         "ratelimit for RCPT commands"
14332 .row &%smtp_receive_timeout%&        "per command or data line"
14333 .row &%smtp_reserve_hosts%&          "these are the reserve hosts"
14334 .row &%smtp_return_error_details%&   "give detail on rejections"
14335 .endtable
14336
14337
14338
14339 .section "SMTP extensions" "SECID113"
14340 .table2
14341 .row &%accept_8bitmime%&             "advertise 8BITMIME"
14342 .row &%auth_advertise_hosts%&        "advertise AUTH to these hosts"
14343 .row &%chunking_advertise_hosts%&    "advertise CHUNKING to these hosts"
14344 .row &%dsn_advertise_hosts%&         "advertise DSN extensions to these hosts"
14345 .row &%ignore_fromline_hosts%&       "allow &""From ""& from these hosts"
14346 .row &%ignore_fromline_local%&       "allow &""From ""& from local SMTP"
14347 .row &%pipelining_advertise_hosts%&  "advertise pipelining to these hosts"
14348 .row &%prdr_enable%&                 "advertise PRDR to all hosts"
14349 .row &%smtputf8_advertise_hosts%&    "advertise SMTPUTF8 to these hosts"
14350 .row &%tls_advertise_hosts%&         "advertise TLS to these hosts"
14351 .endtable
14352
14353
14354
14355 .section "Processing messages" "SECID114"
14356 .table2
14357 .row &%allow_domain_literals%&       "recognize domain literal syntax"
14358 .row &%allow_mx_to_ip%&              "allow MX to point to IP address"
14359 .row &%allow_utf8_domains%&          "in addresses"
14360 .row &%check_rfc2047_length%&        "check length of RFC 2047 &""encoded &&&
14361                                       words""&"
14362 .row &%delivery_date_remove%&        "from incoming messages"
14363 .row &%envelope_to_remove%&          "from incoming messages"
14364 .row &%extract_addresses_remove_arguments%& "affects &%-t%& processing"
14365 .row &%headers_charset%&             "default for translations"
14366 .row &%qualify_domain%&              "default for senders"
14367 .row &%qualify_recipient%&           "default for recipients"
14368 .row &%return_path_remove%&          "from incoming messages"
14369 .row &%strip_excess_angle_brackets%& "in addresses"
14370 .row &%strip_trailing_dot%&          "at end of addresses"
14371 .row &%untrusted_set_sender%&        "untrusted can set envelope sender"
14372 .endtable
14373
14374
14375
14376 .section "System filter" "SECID115"
14377 .table2
14378 .row &%system_filter%&               "locate system filter"
14379 .row &%system_filter_directory_transport%& "transport for delivery to a &&&
14380                                             directory"
14381 .row &%system_filter_file_transport%& "transport for delivery to a file"
14382 .row &%system_filter_group%&         "group for filter running"
14383 .row &%system_filter_pipe_transport%& "transport for delivery to a pipe"
14384 .row &%system_filter_reply_transport%& "transport for autoreply delivery"
14385 .row &%system_filter_user%&          "user for filter running"
14386 .endtable
14387
14388
14389
14390 .section "Routing and delivery" "SECID116"
14391 .table2
14392 .row &%disable_ipv6%&                "do no IPv6 processing"
14393 .row &%dns_again_means_nonexist%&    "for broken domains"
14394 .row &%dns_check_names_pattern%&     "pre-DNS syntax check"
14395 .row &%dns_dnssec_ok%&               "parameter for resolver"
14396 .row &%dns_ipv4_lookup%&             "only v4 lookup for these domains"
14397 .row &%dns_retrans%&                 "parameter for resolver"
14398 .row &%dns_retry%&                   "parameter for resolver"
14399 .row &%dns_trust_aa%&                "DNS zones trusted as authentic"
14400 .row &%dns_use_edns0%&               "parameter for resolver"
14401 .row &%hold_domains%&                "hold delivery for these domains"
14402 .row &%local_interfaces%&            "for routing checks"
14403 .row &%queue_domains%&               "no immediate delivery for these"
14404 .row &%queue_only%&                  "no immediate delivery at all"
14405 .row &%queue_only_file%&             "no immediate delivery if file exists"
14406 .row &%queue_only_load%&             "no immediate delivery if load is high"
14407 .row &%queue_only_load_latch%&       "don't re-evaluate load for each message"
14408 .row &%queue_only_override%&         "allow command line to override"
14409 .row &%queue_run_in_order%&          "order of arrival"
14410 .row &%queue_run_max%&               "of simultaneous queue runners"
14411 .row &%queue_smtp_domains%&          "no immediate SMTP delivery for these"
14412 .row &%remote_max_parallel%&         "parallel SMTP delivery per message"
14413 .row &%remote_sort_domains%&         "order of remote deliveries"
14414 .row &%retry_data_expire%&           "timeout for retry data"
14415 .row &%retry_interval_max%&          "safety net for retry rules"
14416 .endtable
14417
14418
14419
14420 .section "Bounce and warning messages" "SECID117"
14421 .table2
14422 .row &%bounce_message_file%&         "content of bounce"
14423 .row &%bounce_message_text%&         "content of bounce"
14424 .row &%bounce_return_body%&          "include body if returning message"
14425 .row &%bounce_return_linesize_limit%& "limit on returned message line length"
14426 .row &%bounce_return_message%&       "include original message in bounce"
14427 .row &%bounce_return_size_limit%&    "limit on returned message"
14428 .row &%bounce_sender_authentication%& "send authenticated sender with bounce"
14429 .row &%dsn_from%&                    "set &'From:'& contents in bounces"
14430 .row &%errors_copy%&                 "copy bounce messages"
14431 .row &%errors_reply_to%&             "&'Reply-to:'& in bounces"
14432 .row &%delay_warning%&               "time schedule"
14433 .row &%delay_warning_condition%&     "condition for warning messages"
14434 .row &%ignore_bounce_errors_after%&  "discard undeliverable bounces"
14435 .row &%smtp_return_error_details%&   "give detail on rejections"
14436 .row &%warn_message_file%&           "content of warning message"
14437 .endtable
14438
14439
14440
14441 .section "Alphabetical list of main options" "SECTalomo"
14442 Those options that undergo string expansion before use are marked with
14443 &dagger;.
14444
14445 .option accept_8bitmime main boolean true
14446 .cindex "8BITMIME"
14447 .cindex "8-bit characters"
14448 .cindex "log" "selectors"
14449 .cindex "log" "8BITMIME"
14450 This option causes Exim to send 8BITMIME in its response to an SMTP
14451 EHLO command, and to accept the BODY= parameter on MAIL commands.
14452 However, though Exim is 8-bit clean, it is not a protocol converter, and it
14453 takes no steps to do anything special with messages received by this route.
14454
14455 Historically Exim kept this option off by default, but the maintainers
14456 feel that in today's Internet, this causes more problems than it solves.
14457 It now defaults to true.
14458 A more detailed analysis of the issues is provided by Dan Bernstein:
14459 .display
14460 &url(https://cr.yp.to/smtp/8bitmime.html)
14461 .endd
14462
14463 To log received 8BITMIME status use
14464 .code
14465 log_selector = +8bitmime
14466 .endd
14467
14468 .option acl_not_smtp main string&!! unset
14469 .cindex "&ACL;" "for non-SMTP messages"
14470 .cindex "non-SMTP messages" "ACLs for"
14471 This option defines the ACL that is run when a non-SMTP message has been
14472 read and is on the point of being accepted. See chapter &<<CHAPACL>>& for
14473 further details.
14474
14475 .option acl_not_smtp_mime main string&!! unset
14476 This option defines the ACL that is run for individual MIME parts of non-SMTP
14477 messages. It operates in exactly the same way as &%acl_smtp_mime%& operates for
14478 SMTP messages.
14479
14480 .option acl_not_smtp_start main string&!! unset
14481 .cindex "&ACL;" "at start of non-SMTP message"
14482 .cindex "non-SMTP messages" "ACLs for"
14483 This option defines the ACL that is run before Exim starts reading a
14484 non-SMTP message. See chapter &<<CHAPACL>>& for further details.
14485
14486 .option acl_smtp_auth main string&!! unset
14487 .cindex "&ACL;" "setting up for SMTP commands"
14488 .cindex "AUTH" "ACL for"
14489 This option defines the ACL that is run when an SMTP AUTH command is
14490 received. See chapter &<<CHAPACL>>& for further details.
14491
14492 .option acl_smtp_connect main string&!! unset
14493 .cindex "&ACL;" "on SMTP connection"
14494 This option defines the ACL that is run when an SMTP connection is received.
14495 See chapter &<<CHAPACL>>& for further details.
14496
14497 .option acl_smtp_data main string&!! unset
14498 .cindex "DATA" "ACL for"
14499 This option defines the ACL that is run after an SMTP DATA command has been
14500 processed and the message itself has been received, but before the final
14501 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14502
14503 .option acl_smtp_data_prdr main string&!! accept
14504 .cindex "PRDR" "ACL for"
14505 .cindex "DATA" "PRDR ACL for"
14506 .cindex "&ACL;" "PRDR-related"
14507 .cindex "&ACL;" "per-user data processing"
14508 This option defines the ACL that,
14509 if the PRDR feature has been negotiated,
14510 is run for each recipient after an SMTP DATA command has been
14511 processed and the message itself has been received, but before the
14512 acknowledgment is sent. See chapter &<<CHAPACL>>& for further details.
14513
14514 .option acl_smtp_dkim main string&!! unset
14515 .cindex DKIM "ACL for"
14516 This option defines the ACL that is run for each DKIM signature
14517 (by default, or as specified in the dkim_verify_signers option)
14518 of a received message.
14519 See section &<<SECDKIMVFY>>& for further details.
14520
14521 .option acl_smtp_etrn main string&!! unset
14522 .cindex "ETRN" "ACL for"
14523 This option defines the ACL that is run when an SMTP ETRN command is
14524 received. See chapter &<<CHAPACL>>& for further details.
14525
14526 .option acl_smtp_expn main string&!! unset
14527 .cindex "EXPN" "ACL for"
14528 This option defines the ACL that is run when an SMTP EXPN command is
14529 received. See chapter &<<CHAPACL>>& for further details.
14530
14531 .option acl_smtp_helo main string&!! unset
14532 .cindex "EHLO" "ACL for"
14533 .cindex "HELO" "ACL for"
14534 This option defines the ACL that is run when an SMTP EHLO or HELO
14535 command is received. See chapter &<<CHAPACL>>& for further details.
14536
14537
14538 .option acl_smtp_mail main string&!! unset
14539 .cindex "MAIL" "ACL for"
14540 This option defines the ACL that is run when an SMTP MAIL command is
14541 received. See chapter &<<CHAPACL>>& for further details.
14542
14543 .option acl_smtp_mailauth main string&!! unset
14544 .cindex "AUTH" "on MAIL command"
14545 This option defines the ACL that is run when there is an AUTH parameter on
14546 a MAIL command. See chapter &<<CHAPACL>>& for details of ACLs, and chapter
14547 &<<CHAPSMTPAUTH>>& for details of authentication.
14548
14549 .option acl_smtp_mime main string&!! unset
14550 .cindex "MIME content scanning" "ACL for"
14551 This option is available when Exim is built with the content-scanning
14552 extension. It defines the ACL that is run for each MIME part in a message. See
14553 section &<<SECTscanmimepart>>& for details.
14554
14555 .option acl_smtp_notquit main string&!! unset
14556 .cindex "not-QUIT, ACL for"
14557 This option defines the ACL that is run when an SMTP session
14558 ends without a QUIT command being received.
14559 See chapter &<<CHAPACL>>& for further details.
14560
14561 .option acl_smtp_predata main string&!! unset
14562 This option defines the ACL that is run when an SMTP DATA command is
14563 received, before the message itself is received. See chapter &<<CHAPACL>>& for
14564 further details.
14565
14566 .option acl_smtp_quit main string&!! unset
14567 .cindex "QUIT, ACL for"
14568 This option defines the ACL that is run when an SMTP QUIT command is
14569 received. See chapter &<<CHAPACL>>& for further details.
14570
14571 .option acl_smtp_rcpt main string&!! unset
14572 .cindex "RCPT" "ACL for"
14573 This option defines the ACL that is run when an SMTP RCPT command is
14574 received. See chapter &<<CHAPACL>>& for further details.
14575
14576 .option acl_smtp_starttls main string&!! unset
14577 .cindex "STARTTLS, ACL for"
14578 This option defines the ACL that is run when an SMTP STARTTLS command is
14579 received. See chapter &<<CHAPACL>>& for further details.
14580
14581 .option acl_smtp_vrfy main string&!! unset
14582 .cindex "VRFY" "ACL for"
14583 This option defines the ACL that is run when an SMTP VRFY command is
14584 received. See chapter &<<CHAPACL>>& for further details.
14585
14586 .option add_environment main "string list" empty
14587 .cindex "environment" "set values"
14588 This option allows to set individual environment variables that the
14589 currently linked libraries and programs in child processes use.
14590 See &<<SECTpipeenv>>& for the environment of &(pipe)& transports.
14591
14592 .option admin_groups main "string list&!!" unset
14593 .cindex "admin user"
14594 This option is expanded just once, at the start of Exim's processing. If the
14595 current group or any of the supplementary groups of an Exim caller is in this
14596 colon-separated list, the caller has admin privileges. If all your system
14597 programmers are in a specific group, for example, you can give them all Exim
14598 admin privileges by putting that group in &%admin_groups%&. However, this does
14599 not permit them to read Exim's spool files (whose group owner is the Exim gid).
14600 To permit this, you have to add individuals to the Exim group.
14601
14602 .option allow_domain_literals main boolean false
14603 .cindex "domain literal"
14604 If this option is set, the RFC 2822 domain literal format is permitted in
14605 email addresses. The option is not set by default, because the domain literal
14606 format is not normally required these days, and few people know about it. It
14607 has, however, been exploited by mail abusers.
14608
14609 Unfortunately, it seems that some DNS black list maintainers are using this
14610 format to report black listing to postmasters. If you want to accept messages
14611 addressed to your hosts by IP address, you need to set
14612 &%allow_domain_literals%& true, and also to add &`@[]`& to the list of local
14613 domains (defined in the named domain list &%local_domains%& in the default
14614 configuration). This &"magic string"& matches the domain literal form of all
14615 the local host's IP addresses.
14616
14617
14618 .option allow_mx_to_ip main boolean false
14619 .cindex "MX record" "pointing to IP address"
14620 It appears that more and more DNS zone administrators are breaking the rules
14621 and putting domain names that look like IP addresses on the right hand side of
14622 MX records. Exim follows the rules and rejects this, giving an error message
14623 that explains the misconfiguration. However, some other MTAs support this
14624 practice, so to avoid &"Why can't Exim do this?"& complaints,
14625 &%allow_mx_to_ip%& exists, in order to enable this heinous activity. It is not
14626 recommended, except when you have no other choice.
14627
14628 .option allow_utf8_domains main boolean false
14629 .cindex "domain" "UTF-8 characters in"
14630 .cindex "UTF-8" "in domain name"
14631 Lots of discussion is going on about internationalized domain names. One
14632 camp is strongly in favour of just using UTF-8 characters, and it seems
14633 that at least two other MTAs permit this. This option allows Exim users to
14634 experiment if they wish.
14635
14636 If it is set true, Exim's domain parsing function allows valid
14637 UTF-8 multicharacters to appear in domain name components, in addition to
14638 letters, digits, and hyphens. However, just setting this option is not
14639 enough; if you want to look up these domain names in the DNS, you must also
14640 adjust the value of &%dns_check_names_pattern%& to match the extended form. A
14641 suitable setting is:
14642 .code
14643 dns_check_names_pattern = (?i)^(?>(?(1)\.|())[a-z0-9\xc0-\xff]\
14644   (?>[-a-z0-9\x80-\xff]*[a-z0-9\x80-\xbf])?)+$
14645 .endd
14646 Alternatively, you can just disable this feature by setting
14647 .code
14648 dns_check_names_pattern =
14649 .endd
14650 That is, set the option to an empty string so that no check is done.
14651
14652
14653 .option auth_advertise_hosts main "host list&!!" *
14654 .cindex "authentication" "advertising"
14655 .cindex "AUTH" "advertising"
14656 If any server authentication mechanisms are configured, Exim advertises them in
14657 response to an EHLO command only if the calling host matches this list.
14658 Otherwise, Exim does not advertise AUTH.
14659 Exim does not accept AUTH commands from clients to which it has not
14660 advertised the availability of AUTH. The advertising of individual
14661 authentication mechanisms can be controlled by the use of the
14662 &%server_advertise_condition%& generic authenticator option on the individual
14663 authenticators. See chapter &<<CHAPSMTPAUTH>>& for further details.
14664
14665 Certain mail clients (for example, Netscape) require the user to provide a name
14666 and password for authentication if AUTH is advertised, even though it may
14667 not be needed (the host may accept messages from hosts on its local LAN without
14668 authentication, for example). The &%auth_advertise_hosts%& option can be used
14669 to make these clients more friendly by excluding them from the set of hosts to
14670 which Exim advertises AUTH.
14671
14672 .cindex "AUTH" "advertising when encrypted"
14673 If you want to advertise the availability of AUTH only when the connection
14674 is encrypted using TLS, you can make use of the fact that the value of this
14675 option is expanded, with a setting like this:
14676 .code
14677 auth_advertise_hosts = ${if eq{$tls_in_cipher}{}{}{*}}
14678 .endd
14679 .vindex "&$tls_in_cipher$&"
14680 If &$tls_in_cipher$& is empty, the session is not encrypted, and the result of
14681 the expansion is empty, thus matching no hosts. Otherwise, the result of the
14682 expansion is *, which matches all hosts.
14683
14684
14685 .option auto_thaw main time 0s
14686 .cindex "thawing messages"
14687 .cindex "unfreezing messages"
14688 If this option is set to a time greater than zero, a queue runner will try a
14689 new delivery attempt on any frozen message, other than a bounce message, if
14690 this much time has passed since it was frozen. This may result in the message
14691 being re-frozen if nothing has changed since the last attempt. It is a way of
14692 saying &"keep on trying, even though there are big problems"&.
14693
14694 &*Note*&: This is an old option, which predates &%timeout_frozen_after%& and
14695 &%ignore_bounce_errors_after%&. It is retained for compatibility, but it is not
14696 thought to be very useful any more, and its use should probably be avoided.
14697
14698
14699 .option av_scanner main string "see below"
14700 This option is available if Exim is built with the content-scanning extension.
14701 It specifies which anti-virus scanner to use. The default value is:
14702 .code
14703 sophie:/var/run/sophie
14704 .endd
14705 If the value of &%av_scanner%& starts with a dollar character, it is expanded
14706 before use. See section &<<SECTscanvirus>>& for further details.
14707
14708
14709 .option bi_command main string unset
14710 .oindex "&%-bi%&"
14711 This option supplies the name of a command that is run when Exim is called with
14712 the &%-bi%& option (see chapter &<<CHAPcommandline>>&). The string value is
14713 just the command name, it is not a complete command line. If an argument is
14714 required, it must come from the &%-oA%& command line option.
14715
14716
14717 .option bounce_message_file main string unset
14718 .cindex "bounce message" "customizing"
14719 .cindex "customizing" "bounce message"
14720 This option defines a template file containing paragraphs of text to be used
14721 for constructing bounce messages.  Details of the file's contents are given in
14722 chapter &<<CHAPemsgcust>>&. See also &%warn_message_file%&.
14723
14724
14725 .option bounce_message_text main string unset
14726 When this option is set, its contents are included in the default bounce
14727 message immediately after &"This message was created automatically by mail
14728 delivery software."& It is not used if &%bounce_message_file%& is set.
14729
14730 .option bounce_return_body main boolean true
14731 .cindex "bounce message" "including body"
14732 This option controls whether the body of an incoming message is included in a
14733 bounce message when &%bounce_return_message%& is true. The default setting
14734 causes the entire message, both header and body, to be returned (subject to the
14735 value of &%bounce_return_size_limit%&). If this option is false, only the
14736 message header is included. In the case of a non-SMTP message containing an
14737 error that is detected during reception, only those header lines preceding the
14738 point at which the error was detected are returned.
14739 .cindex "bounce message" "including original"
14740
14741 .option bounce_return_linesize_limit main integer 998
14742 .cindex "size" "of bounce lines, limit"
14743 .cindex "bounce message" "line length limit"
14744 .cindex "limit" "bounce message line length"
14745 This option sets a limit in bytes on the line length of messages
14746 that are returned to senders due to delivery problems,
14747 when &%bounce_return_message%& is true.
14748 The default value corresponds to RFC limits.
14749 If the message being returned has lines longer than this value it is
14750 treated as if the &%bounce_return_size_limit%& (below) restriction was exceeded.
14751
14752 The option also applies to bounces returned when an error is detected
14753 during reception of a message.
14754 In this case lines from the original are truncated.
14755
14756 The option does not apply to messages generated by an &(autoreply)& transport.
14757
14758
14759 .option bounce_return_message main boolean true
14760 If this option is set false, none of the original message is included in
14761 bounce messages generated by Exim. See also &%bounce_return_size_limit%& and
14762 &%bounce_return_body%&.
14763
14764
14765 .option bounce_return_size_limit main integer 100K
14766 .cindex "size" "of bounce, limit"
14767 .cindex "bounce message" "size limit"
14768 .cindex "limit" "bounce message size"
14769 This option sets a limit in bytes on the size of messages that are returned to
14770 senders as part of bounce messages when &%bounce_return_message%& is true. The
14771 limit should be less than the value of the global &%message_size_limit%& and of
14772 any &%message_size_limit%& settings on transports, to allow for the bounce text
14773 that Exim generates. If this option is set to zero there is no limit.
14774
14775 When the body of any message that is to be included in a bounce message is
14776 greater than the limit, it is truncated, and a comment pointing this out is
14777 added at the top. The actual cutoff may be greater than the value given, owing
14778 to the use of buffering for transferring the message in chunks (typically 8K in
14779 size). The idea is to save bandwidth on those undeliverable 15-megabyte
14780 messages.
14781
14782 .option bounce_sender_authentication main string unset
14783 .cindex "bounce message" "sender authentication"
14784 .cindex "authentication" "bounce message"
14785 .cindex "AUTH" "on bounce message"
14786 This option provides an authenticated sender address that is sent with any
14787 bounce messages generated by Exim that are sent over an authenticated SMTP
14788 connection. A typical setting might be:
14789 .code
14790 bounce_sender_authentication = mailer-daemon@my.domain.example
14791 .endd
14792 which would cause bounce messages to be sent using the SMTP command:
14793 .code
14794 MAIL FROM:<> AUTH=mailer-daemon@my.domain.example
14795 .endd
14796 The value of &%bounce_sender_authentication%& must always be a complete email
14797 address.
14798
14799 .option callout_domain_negative_expire main time 3h
14800 .cindex "caching" "callout timeouts"
14801 .cindex "callout" "caching timeouts"
14802 This option specifies the expiry time for negative callout cache data for a
14803 domain. See section &<<SECTcallver>>& for details of callout verification, and
14804 section &<<SECTcallvercache>>& for details of the caching.
14805
14806
14807 .option callout_domain_positive_expire main time 7d
14808 This option specifies the expiry time for positive callout cache data for a
14809 domain. See section &<<SECTcallver>>& for details of callout verification, and
14810 section &<<SECTcallvercache>>& for details of the caching.
14811
14812
14813 .option callout_negative_expire main time 2h
14814 This option specifies the expiry time for negative callout cache data for an
14815 address. See section &<<SECTcallver>>& for details of callout verification, and
14816 section &<<SECTcallvercache>>& for details of the caching.
14817
14818
14819 .option callout_positive_expire main time 24h
14820 This option specifies the expiry time for positive callout cache data for an
14821 address. See section &<<SECTcallver>>& for details of callout verification, and
14822 section &<<SECTcallvercache>>& for details of the caching.
14823
14824
14825 .option callout_random_local_part main string&!! "see below"
14826 This option defines the &"random"& local part that can be used as part of
14827 callout verification. The default value is
14828 .code
14829 $primary_hostname-$tod_epoch-testing
14830 .endd
14831 See section &<<CALLaddparcall>>& for details of how this value is used.
14832
14833
14834 .option check_log_inodes main integer 100
14835 See &%check_spool_space%& below.
14836
14837
14838 .option check_log_space main integer 10M
14839 See &%check_spool_space%& below.
14840
14841 .oindex "&%check_rfc2047_length%&"
14842 .cindex "RFC 2047" "disabling length check"
14843 .option check_rfc2047_length main boolean true
14844 RFC 2047 defines a way of encoding non-ASCII characters in headers using a
14845 system of &"encoded words"&. The RFC specifies a maximum length for an encoded
14846 word; strings to be encoded that exceed this length are supposed to use
14847 multiple encoded words. By default, Exim does not recognize encoded words that
14848 exceed the maximum length. However, it seems that some software, in violation
14849 of the RFC, generates overlong encoded words. If &%check_rfc2047_length%& is
14850 set false, Exim recognizes encoded words of any length.
14851
14852
14853 .option check_spool_inodes main integer 100
14854 See &%check_spool_space%& below.
14855
14856
14857 .option check_spool_space main integer 10M
14858 .cindex "checking disk space"
14859 .cindex "disk space, checking"
14860 .cindex "spool directory" "checking space"
14861 The four &%check_...%& options allow for checking of disk resources before a
14862 message is accepted.
14863
14864 .vindex "&$log_inodes$&"
14865 .vindex "&$log_space$&"
14866 .vindex "&$spool_inodes$&"
14867 .vindex "&$spool_space$&"
14868 When any of these options are nonzero, they apply to all incoming messages. If you
14869 want to apply different checks to different kinds of message, you can do so by
14870 testing the variables &$log_inodes$&, &$log_space$&, &$spool_inodes$&, and
14871 &$spool_space$& in an ACL with appropriate additional conditions.
14872
14873
14874 &%check_spool_space%& and &%check_spool_inodes%& check the spool partition if
14875 either value is greater than zero, for example:
14876 .code
14877 check_spool_space = 100M
14878 check_spool_inodes = 100
14879 .endd
14880 The spool partition is the one that contains the directory defined by
14881 SPOOL_DIRECTORY in &_Local/Makefile_&. It is used for holding messages in
14882 transit.
14883
14884 &%check_log_space%& and &%check_log_inodes%&  check the partition in which log
14885 files are written if either is greater than zero. These should be set only if
14886 &%log_file_path%& and &%spool_directory%& refer to different partitions.
14887
14888 If there is less space or fewer inodes than requested, Exim refuses to accept
14889 incoming mail. In the case of SMTP input this is done by giving a 452 temporary
14890 error response to the MAIL command. If ESMTP is in use and there was a
14891 SIZE parameter on the MAIL command, its value is added to the
14892 &%check_spool_space%& value, and the check is performed even if
14893 &%check_spool_space%& is zero, unless &%no_smtp_check_spool_space%& is set.
14894
14895 The values for &%check_spool_space%& and &%check_log_space%& are held as a
14896 number of kilobytes (though specified in bytes).
14897 If a non-multiple of 1024 is specified, it is rounded up.
14898
14899 For non-SMTP input and for batched SMTP input, the test is done at start-up; on
14900 failure a message is written to stderr and Exim exits with a non-zero code, as
14901 it obviously cannot send an error message of any kind.
14902
14903 There is a slight performance penalty for these checks.
14904 Versions of Exim preceding 4.88 had these disabled by default;
14905 high-rate installations confident they will never run out of resources
14906 may wish to deliberately disable them.
14907
14908 .option chunking_advertise_hosts main "host list&!!" *
14909 .cindex CHUNKING advertisement
14910 .cindex "RFC 3030" "CHUNKING"
14911 The CHUNKING extension (RFC3030) will be advertised in the EHLO message to
14912 these hosts.
14913 Hosts may use the BDAT command as an alternate to DATA.
14914
14915 .option commandline_checks_require_admin main boolean &`false`&
14916 .cindex "restricting access to features"
14917 This option restricts various basic checking features to require an
14918 administrative user.
14919 This affects most of the &%-b*%& options, such as &%-be%&.
14920
14921 .option debug_store main boolean &`false`&
14922 .cindex debugging "memory corruption"
14923 .cindex memory debugging
14924 This option, when true, enables extra checking in Exim's internal memory
14925 management.  For use when a memory corruption issue is being investigated,
14926 it should normally be left as default.
14927
14928 .option daemon_smtp_ports main string &`smtp`&
14929 .cindex "port" "for daemon"
14930 .cindex "TCP/IP" "setting listening ports"
14931 This option specifies one or more default SMTP ports on which the Exim daemon
14932 listens. See chapter &<<CHAPinterfaces>>& for details of how it is used. For
14933 backward compatibility, &%daemon_smtp_port%& (singular) is a synonym.
14934
14935 .option daemon_startup_retries main integer 9
14936 .cindex "daemon startup, retrying"
14937 This option, along with &%daemon_startup_sleep%&, controls the retrying done by
14938 the daemon at startup when it cannot immediately bind a listening socket
14939 (typically because the socket is already in use): &%daemon_startup_retries%&
14940 defines the number of retries after the first failure, and
14941 &%daemon_startup_sleep%& defines the length of time to wait between retries.
14942
14943 .option daemon_startup_sleep main time 30s
14944 See &%daemon_startup_retries%&.
14945
14946 .option delay_warning main "time list" 24h
14947 .cindex "warning of delay"
14948 .cindex "delay warning, specifying"
14949 .cindex "queue" "delay warning"
14950 When a message is delayed, Exim sends a warning message to the sender at
14951 intervals specified by this option. The data is a colon-separated list of times
14952 after which to send warning messages. If the value of the option is an empty
14953 string or a zero time, no warnings are sent. Up to 10 times may be given. If a
14954 message has been in the queue for longer than the last time, the last interval
14955 between the times is used to compute subsequent warning times. For example,
14956 with
14957 .code
14958 delay_warning = 4h:8h:24h
14959 .endd
14960 the first message is sent after 4 hours, the second after 8 hours, and
14961 the third one after 24 hours. After that, messages are sent every 16 hours,
14962 because that is the interval between the last two times on the list. If you set
14963 just one time, it specifies the repeat interval. For example, with:
14964 .code
14965 delay_warning = 6h
14966 .endd
14967 messages are repeated every six hours. To stop warnings after a given time, set
14968 a very large time at the end of the list. For example:
14969 .code
14970 delay_warning = 2h:12h:99d
14971 .endd
14972 Note that the option is only evaluated at the time a delivery attempt fails,
14973 which depends on retry and queue-runner configuration.
14974 Typically retries will be configured more frequently than warning messages.
14975
14976 .option delay_warning_condition main string&!! "see below"
14977 .vindex "&$domain$&"
14978 The string is expanded at the time a warning message might be sent. If all the
14979 deferred addresses have the same domain, it is set in &$domain$& during the
14980 expansion. Otherwise &$domain$& is empty. If the result of the expansion is a
14981 forced failure, an empty string, or a string matching any of &"0"&, &"no"& or
14982 &"false"& (the comparison being done caselessly) then the warning message is
14983 not sent. The default is:
14984 .code
14985 delay_warning_condition = ${if or {\
14986   { !eq{$h_list-id:$h_list-post:$h_list-subscribe:}{} }\
14987   { match{$h_precedence:}{(?i)bulk|list|junk} }\
14988   { match{$h_auto-submitted:}{(?i)auto-generated|auto-replied} }\
14989   } {no}{yes}}
14990 .endd
14991 This suppresses the sending of warnings for messages that contain &'List-ID:'&,
14992 &'List-Post:'&, or &'List-Subscribe:'& headers, or have &"bulk"&, &"list"& or
14993 &"junk"& in a &'Precedence:'& header, or have &"auto-generated"& or
14994 &"auto-replied"& in an &'Auto-Submitted:'& header.
14995
14996 .option deliver_drop_privilege main boolean false
14997 .cindex "unprivileged delivery"
14998 .cindex "delivery" "unprivileged"
14999 If this option is set true, Exim drops its root privilege at the start of a
15000 delivery process, and runs as the Exim user throughout. This severely restricts
15001 the kinds of local delivery that are possible, but is viable in certain types
15002 of configuration. There is a discussion about the use of root privilege in
15003 chapter &<<CHAPsecurity>>&.
15004
15005 .option deliver_queue_load_max main fixed-point unset
15006 .cindex "load average"
15007 .cindex "queue runner" "abandoning"
15008 When this option is set, a queue run is abandoned if the system load average
15009 becomes greater than the value of the option. The option has no effect on
15010 ancient operating systems on which Exim cannot determine the load average.
15011 See also &%queue_only_load%& and &%smtp_load_reserve%&.
15012
15013
15014 .option delivery_date_remove main boolean true
15015 .cindex "&'Delivery-date:'& header line"
15016 Exim's transports have an option for adding a &'Delivery-date:'& header to a
15017 message when it is delivered, in exactly the same way as &'Return-path:'& is
15018 handled. &'Delivery-date:'& records the actual time of delivery. Such headers
15019 should not be present in incoming messages, and this option causes them to be
15020 removed at the time the message is received, to avoid any problems that might
15021 occur when a delivered message is subsequently sent on to some other recipient.
15022
15023 .option disable_fsync main boolean false
15024 .cindex "&[fsync()]&, disabling"
15025 This option is available only if Exim was built with the compile-time option
15026 ENABLE_DISABLE_FSYNC. When this is not set, a reference to &%disable_fsync%& in
15027 a runtime configuration generates an &"unknown option"& error. You should not
15028 build Exim with ENABLE_DISABLE_FSYNC or set &%disable_fsync%& unless you
15029 really, really, really understand what you are doing. &'No pre-compiled
15030 distributions of Exim should ever make this option available.'&
15031
15032 When &%disable_fsync%& is set true, Exim no longer calls &[fsync()]& to force
15033 updated files' data to be written to disc before continuing. Unexpected events
15034 such as crashes and power outages may cause data to be lost or scrambled.
15035 Here be Dragons. &*Beware.*&
15036
15037
15038 .option disable_ipv6 main boolean false
15039 .cindex "IPv6" "disabling"
15040 If this option is set true, even if the Exim binary has IPv6 support, no IPv6
15041 activities take place. AAAA records are never looked up, and any IPv6 addresses
15042 that are listed in &%local_interfaces%&, data for the &%manualroute%& router,
15043 etc. are ignored. If IP literals are enabled, the &(ipliteral)& router declines
15044 to handle IPv6 literal addresses.
15045
15046
15047 .option dkim_verify_signers main "domain list&!!" $dkim_signers
15048 .cindex DKIM "controlling calls to the ACL"
15049 This option gives a list of DKIM domains for which the DKIM ACL is run.
15050 It is expanded after the message is received; by default it runs
15051 the ACL once for each signature in the message.
15052 See section &<<SECDKIMVFY>>&.
15053
15054
15055 .option dns_again_means_nonexist main "domain list&!!" unset
15056 .cindex "DNS" "&""try again""& response; overriding"
15057 DNS lookups give a &"try again"& response for the DNS errors
15058 &"non-authoritative host not found"& and &"SERVERFAIL"&. This can cause Exim to
15059 keep trying to deliver a message, or to give repeated temporary errors to
15060 incoming mail. Sometimes the effect is caused by a badly set up name server and
15061 may persist for a long time. If a domain which exhibits this problem matches
15062 anything in &%dns_again_means_nonexist%&, it is treated as if it did not exist.
15063 This option should be used with care. You can make it apply to reverse lookups
15064 by a setting such as this:
15065 .code
15066 dns_again_means_nonexist = *.in-addr.arpa
15067 .endd
15068 This option applies to all DNS lookups that Exim does. It also applies when the
15069 &[gethostbyname()]& or &[getipnodebyname()]& functions give temporary errors,
15070 since these are most likely to be caused by DNS lookup problems. The
15071 &(dnslookup)& router has some options of its own for controlling what happens
15072 when lookups for MX or SRV records give temporary errors. These more specific
15073 options are applied after this global option.
15074
15075 .option dns_check_names_pattern main string "see below"
15076 .cindex "DNS" "pre-check of name syntax"
15077 When this option is set to a non-empty string, it causes Exim to check domain
15078 names for characters that are not allowed in host names before handing them to
15079 the DNS resolver, because some resolvers give temporary errors for names that
15080 contain unusual characters. If a domain name contains any unwanted characters,
15081 a &"not found"& result is forced, and the resolver is not called. The check is
15082 done by matching the domain name against a regular expression, which is the
15083 value of this option. The default pattern is
15084 .code
15085 dns_check_names_pattern = \
15086   (?i)^(?>(?(1)\.|())[^\W_](?>[a-z0-9/-]*[^\W_])?)+$
15087 .endd
15088 which permits only letters, digits, slashes, and hyphens in components, but
15089 they must start and end with a letter or digit. Slashes are not, in fact,
15090 permitted in host names, but they are found in certain NS records (which can be
15091 accessed in Exim by using a &%dnsdb%& lookup). If you set
15092 &%allow_utf8_domains%&, you must modify this pattern, or set the option to an
15093 empty string.
15094
15095 .option dns_csa_search_limit main integer 5
15096 This option controls the depth of parental searching for CSA SRV records in the
15097 DNS, as described in more detail in section &<<SECTverifyCSA>>&.
15098
15099 .option dns_csa_use_reverse main boolean true
15100 This option controls whether or not an IP address, given as a CSA domain, is
15101 reversed and looked up in the reverse DNS, as described in more detail in
15102 section &<<SECTverifyCSA>>&.
15103
15104 .option dns_cname_loops main integer 1
15105 .cindex DNS "CNAME following"
15106 This option controls the following of CNAME chains, needed if the resolver does
15107 not do it internally.
15108 As of 2018 most should, and the default can be left.
15109 If you have an ancient one, a value of 10 is likely needed.
15110
15111 The default value of one CNAME-follow is needed
15112 thanks to the observed return for an MX request,
15113 given no MX presence but a CNAME to an A, of the CNAME.
15114
15115
15116 .option dns_dnssec_ok main integer -1
15117 .cindex "DNS" "resolver options"
15118 .cindex "DNS" "DNSSEC"
15119 If this option is set to a non-negative number then Exim will initialise the
15120 DNS resolver library to either use or not use DNSSEC, overriding the system
15121 default. A value of 0 coerces DNSSEC off, a value of 1 coerces DNSSEC on.
15122
15123 If the resolver library does not support DNSSEC then this option has no effect.
15124
15125
15126 .option dns_ipv4_lookup main "domain list&!!" unset
15127 .cindex "IPv6" "DNS lookup for AAAA records"
15128 .cindex "DNS" "IPv6 lookup for AAAA records"
15129 .cindex DNS "IPv6 disabling"
15130 When Exim is compiled with IPv6 support and &%disable_ipv6%& is not set, it
15131 looks for IPv6 address records (AAAA records) as well as IPv4 address records
15132 (A records) when trying to find IP addresses for hosts, unless the host's
15133 domain matches this list.
15134
15135 This is a fudge to help with name servers that give big delays or otherwise do
15136 not work for the AAAA record type. In due course, when the world's name
15137 servers have all been upgraded, there should be no need for this option.
15138
15139
15140 .option dns_retrans main time 0s
15141 .cindex "DNS" "resolver options"
15142 .cindex timeout "dns lookup"
15143 .cindex "DNS" timeout
15144 The options &%dns_retrans%& and &%dns_retry%& can be used to set the
15145 retransmission and retry parameters for DNS lookups. Values of zero (the
15146 defaults) leave the system default settings unchanged. The first value is the
15147 time between retries, and the second is the number of retries. It isn't
15148 totally clear exactly how these settings affect the total time a DNS lookup may
15149 take. I haven't found any documentation about timeouts on DNS lookups; these
15150 parameter values are available in the external resolver interface structure,
15151 but nowhere does it seem to describe how they are used or what you might want
15152 to set in them.
15153 See also the &%slow_lookup_log%& option.
15154
15155
15156 .option dns_retry main integer 0
15157 See &%dns_retrans%& above.
15158
15159
15160 .option dns_trust_aa main "domain list&!!" unset
15161 .cindex "DNS" "resolver options"
15162 .cindex "DNS" "DNSSEC"
15163 If this option is set then lookup results marked with the AA bit
15164 (Authoritative Answer) are trusted the same way as if they were
15165 DNSSEC-verified. The authority section's name of the answer must
15166 match with this expanded domain list.
15167
15168 Use this option only if you talk directly to a resolver that is
15169 authoritative for some zones and does not set the AD (Authentic Data)
15170 bit in the answer. Some DNS servers may have an configuration option to
15171 mark the answers from their own zones as verified (they set the AD bit).
15172 Others do not have this option. It is considered as poor practice using
15173 a resolver that is an authoritative server for some zones.
15174
15175 Use this option only if you really have to (e.g. if you want
15176 to use DANE for remote delivery to a server that is listed in the DNS
15177 zones that your resolver is authoritative for).
15178
15179 If the DNS answer packet has the AA bit set and contains resource record
15180 in the answer section, the name of the first NS record appearing in the
15181 authority section is compared against the list. If the answer packet is
15182 authoritative but the answer section is empty, the name of the first SOA
15183 record in the authoritative section is used instead.
15184
15185 .cindex "DNS" "resolver options"
15186 .option dns_use_edns0 main integer -1
15187 .cindex "DNS" "resolver options"
15188 .cindex "DNS" "EDNS0"
15189 .cindex "DNS" "OpenBSD
15190 If this option is set to a non-negative number then Exim will initialise the
15191 DNS resolver library to either use or not use EDNS0 extensions, overriding
15192 the system default. A value of 0 coerces EDNS0 off, a value of 1 coerces EDNS0
15193 on.
15194
15195 If the resolver library does not support EDNS0 then this option has no effect.
15196
15197 OpenBSD's asr resolver routines are known to ignore the EDNS0 option; this
15198 means that DNSSEC will not work with Exim on that platform either, unless Exim
15199 is linked against an alternative DNS client library.
15200
15201
15202 .option drop_cr main boolean false
15203 This is an obsolete option that is now a no-op. It used to affect the way Exim
15204 handled CR and LF characters in incoming messages. What happens now is
15205 described in section &<<SECTlineendings>>&.
15206
15207 .option dsn_advertise_hosts main "host list&!!" unset
15208 .cindex "bounce messages" "success"
15209 .cindex "DSN" "success"
15210 .cindex "Delivery Status Notification" "success"
15211 DSN extensions (RFC3461) will be advertised in the EHLO message to,
15212 and accepted from, these hosts.
15213 Hosts may use the NOTIFY and ENVID options on RCPT TO commands,
15214 and RET and ORCPT options on MAIL FROM commands.
15215 A NOTIFY=SUCCESS option requests success-DSN messages.
15216 A NOTIFY= option with no argument requests that no delay or failure DSNs
15217 are sent.
15218
15219 .option dsn_from main "string&!!" "see below"
15220 .cindex "&'From:'& header line" "in bounces"
15221 .cindex "bounce messages" "&'From:'& line, specifying"
15222 This option can be used to vary the contents of &'From:'& header lines in
15223 bounces and other automatically generated messages (&"Delivery Status
15224 Notifications"& &-- hence the name of the option). The default setting is:
15225 .code
15226 dsn_from = Mail Delivery System <Mailer-Daemon@$qualify_domain>
15227 .endd
15228 The value is expanded every time it is needed. If the expansion fails, a
15229 panic is logged, and the default value is used.
15230
15231 .option envelope_to_remove main boolean true
15232 .cindex "&'Envelope-to:'& header line"
15233 Exim's transports have an option for adding an &'Envelope-to:'& header to a
15234 message when it is delivered, in exactly the same way as &'Return-path:'& is
15235 handled. &'Envelope-to:'& records the original recipient address from the
15236 message's envelope that caused the delivery to happen. Such headers should not
15237 be present in incoming messages, and this option causes them to be removed at
15238 the time the message is received, to avoid any problems that might occur when a
15239 delivered message is subsequently sent on to some other recipient.
15240
15241
15242 .option errors_copy main "string list&!!" unset
15243 .cindex "bounce message" "copy to other address"
15244 .cindex "copy of bounce message"
15245 Setting this option causes Exim to send bcc copies of bounce messages that it
15246 generates to other addresses. &*Note*&: This does not apply to bounce messages
15247 coming from elsewhere. The value of the option is a colon-separated list of
15248 items. Each item consists of a pattern, terminated by white space, followed by
15249 a comma-separated list of email addresses. If a pattern contains spaces, it
15250 must be enclosed in double quotes.
15251
15252 Each pattern is processed in the same way as a single item in an address list
15253 (see section &<<SECTaddresslist>>&). When a pattern matches the recipient of
15254 the bounce message, the message is copied to the addresses on the list. The
15255 items are scanned in order, and once a matching one is found, no further items
15256 are examined. For example:
15257 .code
15258 errors_copy = spqr@mydomain   postmaster@mydomain.example :\
15259               rqps@mydomain   hostmaster@mydomain.example,\
15260                               postmaster@mydomain.example
15261 .endd
15262 .vindex "&$domain$&"
15263 .vindex "&$local_part$&"
15264 The address list is expanded before use. The expansion variables &$local_part$&
15265 and &$domain$& are set from the original recipient of the error message, and if
15266 there was any wildcard matching in the pattern, the expansion
15267 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%errors_copy%&"
15268 variables &$0$&, &$1$&, etc. are set in the normal way.
15269
15270
15271 .option errors_reply_to main string unset
15272 .cindex "bounce message" "&'Reply-to:'& in"
15273 By default, Exim's bounce and delivery warning messages contain the header line
15274 .display
15275 &`From: Mail Delivery System <Mailer-Daemon@`&&'qualify-domain'&&`>`&
15276 .endd
15277 .oindex &%quota_warn_message%&
15278 where &'qualify-domain'& is the value of the &%qualify_domain%& option.
15279 A warning message that is generated by the &%quota_warn_message%& option in an
15280 &(appendfile)& transport may contain its own &'From:'& header line that
15281 overrides the default.
15282
15283 Experience shows that people reply to bounce messages. If the
15284 &%errors_reply_to%& option is set, a &'Reply-To:'& header is added to bounce
15285 and warning messages. For example:
15286 .code
15287 errors_reply_to = postmaster@my.domain.example
15288 .endd
15289 The value of the option is not expanded. It must specify a valid RFC 2822
15290 address. However, if a warning message that is generated by the
15291 &%quota_warn_message%& option in an &(appendfile)& transport contain its
15292 own &'Reply-To:'& header line, the value of the &%errors_reply_to%& option is
15293 not used.
15294
15295
15296 .option event_action main string&!! unset
15297 .cindex events
15298 This option declares a string to be expanded for Exim's events mechanism.
15299 For details see chapter &<<CHAPevents>>&.
15300
15301
15302 .option exim_group main string "compile-time configured"
15303 .cindex "gid (group id)" "Exim's own"
15304 .cindex "Exim group"
15305 This option changes the gid under which Exim runs when it gives up root
15306 privilege. The default value is compiled into the binary. The value of this
15307 option is used only when &%exim_user%& is also set. Unless it consists entirely
15308 of digits, the string is looked up using &[getgrnam()]&, and failure causes a
15309 configuration error. See chapter &<<CHAPsecurity>>& for a discussion of
15310 security issues.
15311
15312
15313 .option exim_path main string "see below"
15314 .cindex "Exim binary, path name"
15315 This option specifies the path name of the Exim binary, which is used when Exim
15316 needs to re-exec itself. The default is set up to point to the file &'exim'& in
15317 the directory configured at compile time by the BIN_DIRECTORY setting. It
15318 is necessary to change &%exim_path%& if, exceptionally, Exim is run from some
15319 other place.
15320 &*Warning*&: Do not use a macro to define the value of this option, because
15321 you will break those Exim utilities that scan the configuration file to find
15322 where the binary is. (They then use the &%-bP%& option to extract option
15323 settings such as the value of &%spool_directory%&.)
15324
15325
15326 .option exim_user main string "compile-time configured"
15327 .cindex "uid (user id)" "Exim's own"
15328 .cindex "Exim user"
15329 This option changes the uid under which Exim runs when it gives up root
15330 privilege. The default value is compiled into the binary. Ownership of the run
15331 time configuration file and the use of the &%-C%& and &%-D%& command line
15332 options is checked against the values in the binary, not what is set here.
15333
15334 Unless it consists entirely of digits, the string is looked up using
15335 &[getpwnam()]&, and failure causes a configuration error. If &%exim_group%& is
15336 not also supplied, the gid is taken from the result of &[getpwnam()]& if it is
15337 used. See chapter &<<CHAPsecurity>>& for a discussion of security issues.
15338
15339
15340 .option extra_local_interfaces main "string list" unset
15341 This option defines network interfaces that are to be considered local when
15342 routing, but which are not used for listening by the daemon. See section
15343 &<<SECTreclocipadd>>& for details.
15344
15345
15346 . Allow this long option name to split; give it unsplit as a fifth argument
15347 . for the automatic .oindex that is generated by .option.
15348
15349 .option "extract_addresses_remove_arguments" main boolean true &&&
15350          extract_addresses_remove_arguments
15351 .oindex "&%-t%&"
15352 .cindex "command line" "addresses with &%-t%&"
15353 .cindex "Sendmail compatibility" "&%-t%& option"
15354 According to some Sendmail documentation (Sun, IRIX, HP-UX), if any addresses
15355 are present on the command line when the &%-t%& option is used to build an
15356 envelope from a message's &'To:'&, &'Cc:'& and &'Bcc:'& headers, the command
15357 line addresses are removed from the recipients list. This is also how Smail
15358 behaves. However, other Sendmail documentation (the O'Reilly book) states that
15359 command line addresses are added to those obtained from the header lines. When
15360 &%extract_addresses_remove_arguments%& is true (the default), Exim subtracts
15361 argument headers. If it is set false, Exim adds rather than removes argument
15362 addresses.
15363
15364
15365 .option finduser_retries main integer 0
15366 .cindex "NIS, retrying user lookups"
15367 On systems running NIS or other schemes in which user and group information is
15368 distributed from a remote system, there can be times when &[getpwnam()]& and
15369 related functions fail, even when given valid data, because things time out.
15370 Unfortunately these failures cannot be distinguished from genuine &"not found"&
15371 errors. If &%finduser_retries%& is set greater than zero, Exim will try that
15372 many extra times to find a user or a group, waiting for one second between
15373 retries.
15374
15375 .cindex "&_/etc/passwd_&" "multiple reading of"
15376 You should not set this option greater than zero if your user information is in
15377 a traditional &_/etc/passwd_& file, because it will cause Exim needlessly to
15378 search the file multiple times for non-existent users, and also cause delay.
15379
15380
15381
15382 .option freeze_tell main "string list, comma separated" unset
15383 .cindex "freezing messages" "sending a message when freezing"
15384 On encountering certain errors, or when configured to do so in a system filter,
15385 ACL, or special router, Exim freezes a message. This means that no further
15386 delivery attempts take place until an administrator thaws the message, or the
15387 &%auto_thaw%&, &%ignore_bounce_errors_after%&, or &%timeout_frozen_after%&
15388 feature cause it to be processed. If &%freeze_tell%& is set, Exim generates a
15389 warning message whenever it freezes something, unless the message it is
15390 freezing is a locally-generated bounce message. (Without this exception there
15391 is the possibility of looping.) The warning message is sent to the addresses
15392 supplied as the comma-separated value of this option. If several of the
15393 message's addresses cause freezing, only a single message is sent. If the
15394 freezing was automatic, the reason(s) for freezing can be found in the message
15395 log. If you configure freezing in a filter or ACL, you must arrange for any
15396 logging that you require.
15397
15398
15399 .option gecos_name main string&!! unset
15400 .cindex "HP-UX"
15401 .cindex "&""gecos""& field, parsing"
15402 Some operating systems, notably HP-UX, use the &"gecos"& field in the system
15403 password file to hold other information in addition to users' real names. Exim
15404 looks up this field for use when it is creating &'Sender:'& or &'From:'&
15405 headers. If either &%gecos_pattern%& or &%gecos_name%& are unset, the contents
15406 of the field are used unchanged, except that, if an ampersand is encountered,
15407 it is replaced by the user's login name with the first character forced to
15408 upper case, since this is a convention that is observed on many systems.
15409
15410 When these options are set, &%gecos_pattern%& is treated as a regular
15411 expression that is to be applied to the field (again with && replaced by the
15412 login name), and if it matches, &%gecos_name%& is expanded and used as the
15413 user's name.
15414
15415 .cindex "numerical variables (&$1$& &$2$& etc)" "in &%gecos_name%&"
15416 Numeric variables such as &$1$&, &$2$&, etc. can be used in the expansion to
15417 pick up sub-fields that were matched by the pattern. In HP-UX, where the user's
15418 name terminates at the first comma, the following can be used:
15419 .code
15420 gecos_pattern = ([^,]*)
15421 gecos_name = $1
15422 .endd
15423
15424 .option gecos_pattern main string unset
15425 See &%gecos_name%& above.
15426
15427
15428 .option gnutls_compat_mode main boolean unset
15429 This option controls whether GnuTLS is used in compatibility mode in an Exim
15430 server. This reduces security slightly, but improves interworking with older
15431 implementations of TLS.
15432
15433
15434 .option gnutls_allow_auto_pkcs11 main boolean unset
15435 This option will let GnuTLS (2.12.0 or later) autoload PKCS11 modules with
15436 the p11-kit configuration files in &_/etc/pkcs11/modules/_&.
15437
15438 See
15439 &url(https://www.gnutls.org/manual/gnutls.html#Smart-cards-and-HSMs)
15440 for documentation.
15441
15442
15443
15444 .option headers_charset main string "see below"
15445 This option sets a default character set for translating from encoded MIME
15446 &"words"& in header lines, when referenced by an &$h_xxx$& expansion item. The
15447 default is the value of HEADERS_CHARSET in &_Local/Makefile_&. The
15448 ultimate default is ISO-8859-1. For more details see the description of header
15449 insertions in section &<<SECTexpansionitems>>&.
15450
15451
15452
15453 .option header_maxsize main integer "see below"
15454 .cindex "header section" "maximum size of"
15455 .cindex "limit" "size of message header section"
15456 This option controls the overall maximum size of a message's header
15457 section. The default is the value of HEADER_MAXSIZE in
15458 &_Local/Makefile_&; the default for that is 1M. Messages with larger header
15459 sections are rejected.
15460
15461
15462 .option header_line_maxsize main integer 0
15463 .cindex "header lines" "maximum size of"
15464 .cindex "limit" "size of one header line"
15465 This option limits the length of any individual header line in a message, after
15466 all the continuations have been joined together. Messages with individual
15467 header lines that are longer than the limit are rejected. The default value of
15468 zero means &"no limit"&.
15469
15470
15471
15472
15473 .option helo_accept_junk_hosts main "host list&!!" unset
15474 .cindex "HELO" "accepting junk data"
15475 .cindex "EHLO" "accepting junk data"
15476 Exim checks the syntax of HELO and EHLO commands for incoming SMTP
15477 mail, and gives an error response for invalid data. Unfortunately, there are
15478 some SMTP clients that send syntactic junk. They can be accommodated by setting
15479 this option. Note that this is a syntax check only. See &%helo_verify_hosts%&
15480 if you want to do semantic checking.
15481 See also &%helo_allow_chars%& for a way of extending the permitted character
15482 set.
15483
15484
15485 .option helo_allow_chars main string unset
15486 .cindex "HELO" "underscores in"
15487 .cindex "EHLO" "underscores in"
15488 .cindex "underscore in EHLO/HELO"
15489 This option can be set to a string of rogue characters that are permitted in
15490 all EHLO and HELO names in addition to the standard letters, digits,
15491 hyphens, and dots. If you really must allow underscores, you can set
15492 .code
15493 helo_allow_chars = _
15494 .endd
15495 Note that the value is one string, not a list.
15496
15497
15498 .option helo_lookup_domains main "domain list&!!" &`@:@[]`&
15499 .cindex "HELO" "forcing reverse lookup"
15500 .cindex "EHLO" "forcing reverse lookup"
15501 If the domain given by a client in a HELO or EHLO command matches this
15502 list, a reverse lookup is done in order to establish the host's true name. The
15503 default forces a lookup if the client host gives the server's name or any of
15504 its IP addresses (in brackets), something that broken clients have been seen to
15505 do.
15506
15507
15508 .option helo_try_verify_hosts main "host list&!!" unset
15509 .cindex "HELO verifying" "optional"
15510 .cindex "EHLO" "verifying, optional"
15511 By default, Exim just checks the syntax of HELO and EHLO commands (see
15512 &%helo_accept_junk_hosts%& and &%helo_allow_chars%&). However, some sites like
15513 to do more extensive checking of the data supplied by these commands. The ACL
15514 condition &`verify = helo`& is provided to make this possible.
15515 Formerly, it was necessary also to set this option (&%helo_try_verify_hosts%&)
15516 to force the check to occur. From release 4.53 onwards, this is no longer
15517 necessary. If the check has not been done before &`verify = helo`& is
15518 encountered, it is done at that time. Consequently, this option is obsolete.
15519 Its specification is retained here for backwards compatibility.
15520
15521 When an EHLO or HELO command is received, if the calling host matches
15522 &%helo_try_verify_hosts%&, Exim checks that the host name given in the HELO or
15523 EHLO command either:
15524
15525 .ilist
15526 is an IP literal matching the calling address of the host, or
15527 .next
15528 .cindex "DNS" "reverse lookup"
15529 .cindex "reverse DNS lookup"
15530 matches the host name that Exim obtains by doing a reverse lookup of the
15531 calling host address, or
15532 .next
15533 when looked up in DNS yields the calling host address.
15534 .endlist
15535
15536 However, the EHLO or HELO command is not rejected if any of the checks
15537 fail. Processing continues, but the result of the check is remembered, and can
15538 be detected later in an ACL by the &`verify = helo`& condition.
15539
15540 If DNS was used for successful verification, the variable
15541 .cindex "DNS" "DNSSEC"
15542 &$helo_verify_dnssec$& records the DNSSEC status of the lookups.
15543
15544 .option helo_verify_hosts main "host list&!!" unset
15545 .cindex "HELO verifying" "mandatory"
15546 .cindex "EHLO" "verifying, mandatory"
15547 Like &%helo_try_verify_hosts%&, this option is obsolete, and retained only for
15548 backwards compatibility. For hosts that match this option, Exim checks the host
15549 name given in the HELO or EHLO in the same way as for
15550 &%helo_try_verify_hosts%&. If the check fails, the HELO or EHLO command is
15551 rejected with a 550 error, and entries are written to the main and reject logs.
15552 If a MAIL command is received before EHLO or HELO, it is rejected with a 503
15553 error.
15554
15555 .option hold_domains main "domain list&!!" unset
15556 .cindex "domain" "delaying delivery"
15557 .cindex "delivery" "delaying certain domains"
15558 This option allows mail for particular domains to be held in the queue
15559 manually. The option is overridden if a message delivery is forced with the
15560 &%-M%&, &%-qf%&, &%-Rf%& or &%-Sf%& options, and also while testing or
15561 verifying addresses using &%-bt%& or &%-bv%&. Otherwise, if a domain matches an
15562 item in &%hold_domains%&, no routing or delivery for that address is done, and
15563 it is deferred every time the message is looked at.
15564
15565 This option is intended as a temporary operational measure for delaying the
15566 delivery of mail while some problem is being sorted out, or some new
15567 configuration tested. If you just want to delay the processing of some
15568 domains until a queue run occurs, you should use &%queue_domains%& or
15569 &%queue_smtp_domains%&, not &%hold_domains%&.
15570
15571 A setting of &%hold_domains%& does not override Exim's code for removing
15572 messages from the queue if they have been there longer than the longest retry
15573 time in any retry rule. If you want to hold messages for longer than the normal
15574 retry times, insert a dummy retry rule with a long retry time.
15575
15576
15577 .option host_lookup main "host list&!!" unset
15578 .cindex "host name" "lookup, forcing"
15579 Exim does not look up the name of a calling host from its IP address unless it
15580 is required to compare against some host list, or the host matches
15581 &%helo_try_verify_hosts%& or &%helo_verify_hosts%&, or the host matches this
15582 option (which normally contains IP addresses rather than host names). The
15583 default configuration file contains
15584 .code
15585 host_lookup = *
15586 .endd
15587 which causes a lookup to happen for all hosts. If the expense of these lookups
15588 is felt to be too great, the setting can be changed or removed.
15589
15590 After a successful reverse lookup, Exim does a forward lookup on the name it
15591 has obtained, to verify that it yields the IP address that it started with. If
15592 this check fails, Exim behaves as if the name lookup failed.
15593
15594 .vindex "&$host_lookup_failed$&"
15595 .vindex "&$sender_host_name$&"
15596 After any kind of failure, the host name (in &$sender_host_name$&) remains
15597 unset, and &$host_lookup_failed$& is set to the string &"1"&. See also
15598 &%dns_again_means_nonexist%&, &%helo_lookup_domains%&, and
15599 &`verify = reverse_host_lookup`& in ACLs.
15600
15601
15602 .option host_lookup_order main "string list" &`bydns:byaddr`&
15603 This option specifies the order of different lookup methods when Exim is trying
15604 to find a host name from an IP address. The default is to do a DNS lookup
15605 first, and then to try a local lookup (using &[gethostbyaddr()]& or equivalent)
15606 if that fails. You can change the order of these lookups, or omit one entirely,
15607 if you want.
15608
15609 &*Warning*&: The &"byaddr"& method does not always yield aliases when there are
15610 multiple PTR records in the DNS and the IP address is not listed in
15611 &_/etc/hosts_&. Different operating systems give different results in this
15612 case. That is why the default tries a DNS lookup first.
15613
15614
15615
15616 .option host_reject_connection main "host list&!!" unset
15617 .cindex "host" "rejecting connections from"
15618 If this option is set, incoming SMTP calls from the hosts listed are rejected
15619 as soon as the connection is made.
15620 This option is obsolete, and retained only for backward compatibility, because
15621 nowadays the ACL specified by &%acl_smtp_connect%& can also reject incoming
15622 connections immediately.
15623
15624 The ability to give an immediate rejection (either by this option or using an
15625 ACL) is provided for use in unusual cases. Many hosts will just try again,
15626 sometimes without much delay. Normally, it is better to use an ACL to reject
15627 incoming messages at a later stage, such as after RCPT commands. See
15628 chapter &<<CHAPACL>>&.
15629
15630
15631 .option hosts_connection_nolog main "host list&!!" unset
15632 .cindex "host" "not logging connections from"
15633 This option defines a list of hosts for which connection logging does not
15634 happen, even though the &%smtp_connection%& log selector is set. For example,
15635 you might want not to log SMTP connections from local processes, or from
15636 127.0.0.1, or from your local LAN. This option is consulted in the main loop of
15637 the daemon; you should therefore strive to restrict its value to a short inline
15638 list of IP addresses and networks. To disable logging SMTP connections from
15639 local processes, you must create a host list with an empty item. For example:
15640 .code
15641 hosts_connection_nolog = :
15642 .endd
15643 If the &%smtp_connection%& log selector is not set, this option has no effect.
15644
15645
15646
15647 .option hosts_proxy main "host list&!!" unset
15648 .cindex proxy "proxy protocol"
15649 This option enables use of Proxy Protocol proxies for incoming
15650 connections.  For details see section &<<SECTproxyInbound>>&.
15651
15652
15653 .option hosts_treat_as_local main "domain list&!!" unset
15654 .cindex "local host" "domains treated as"
15655 .cindex "host" "treated as local"
15656 If this option is set, any host names that match the domain list are treated as
15657 if they were the local host when Exim is scanning host lists obtained from MX
15658 records
15659 or other sources. Note that the value of this option is a domain list, not a
15660 host list, because it is always used to check host names, not IP addresses.
15661
15662 This option also applies when Exim is matching the special items
15663 &`@mx_any`&, &`@mx_primary`&, and &`@mx_secondary`& in a domain list (see
15664 section &<<SECTdomainlist>>&), and when checking the &%hosts%& option in the
15665 &(smtp)& transport for the local host (see the &%allow_localhost%& option in
15666 that transport). See also &%local_interfaces%&, &%extra_local_interfaces%&, and
15667 chapter &<<CHAPinterfaces>>&, which contains a discussion about local network
15668 interfaces and recognizing the local host.
15669
15670
15671 .option ibase_servers main "string list" unset
15672 .cindex "InterBase" "server list"
15673 This option provides a list of InterBase servers and associated connection data,
15674 to be used in conjunction with &(ibase)& lookups (see section &<<SECID72>>&).
15675 The option is available only if Exim has been built with InterBase support.
15676
15677
15678
15679 .option ignore_bounce_errors_after main time 10w
15680 .cindex "bounce message" "discarding"
15681 .cindex "discarding bounce message"
15682 This option affects the processing of bounce messages that cannot be delivered,
15683 that is, those that suffer a permanent delivery failure. (Bounce messages that
15684 suffer temporary delivery failures are of course retried in the usual way.)
15685
15686 After a permanent delivery failure, bounce messages are frozen,
15687 because there is no sender to whom they can be returned. When a frozen bounce
15688 message has been in the queue for more than the given time, it is unfrozen at
15689 the next queue run, and a further delivery is attempted. If delivery fails
15690 again, the bounce message is discarded. This makes it possible to keep failed
15691 bounce messages around for a shorter time than the normal maximum retry time
15692 for frozen messages. For example,
15693 .code
15694 ignore_bounce_errors_after = 12h
15695 .endd
15696 retries failed bounce message deliveries after 12 hours, discarding any further
15697 failures. If the value of this option is set to a zero time period, bounce
15698 failures are discarded immediately. Setting a very long time (as in the default
15699 value) has the effect of disabling this option. For ways of automatically
15700 dealing with other kinds of frozen message, see &%auto_thaw%& and
15701 &%timeout_frozen_after%&.
15702
15703
15704 .option ignore_fromline_hosts main "host list&!!" unset
15705 .cindex "&""From""& line"
15706 .cindex "UUCP" "&""From""& line"
15707 Some broken SMTP clients insist on sending a UUCP-like &"From&~"& line before
15708 the headers of a message. By default this is treated as the start of the
15709 message's body, which means that any following headers are not recognized as
15710 such. Exim can be made to ignore it by setting &%ignore_fromline_hosts%& to
15711 match those hosts that insist on sending it. If the sender is actually a local
15712 process rather than a remote host, and is using &%-bs%& to inject the messages,
15713 &%ignore_fromline_local%& must be set to achieve this effect.
15714
15715
15716 .option ignore_fromline_local main boolean false
15717 See &%ignore_fromline_hosts%& above.
15718
15719 .option keep_environment main "string list" unset
15720 .cindex "environment" "values from"
15721 This option contains a string list of environment variables to keep.
15722 You have to trust these variables or you have to be sure that
15723 these variables do not impose any security risk. Keep in mind that
15724 during the startup phase Exim is running with an effective UID 0 in most
15725 installations. As the default value is an empty list, the default
15726 environment for using libraries, running embedded Perl code, or running
15727 external binaries is empty, and does not not even contain PATH or HOME.
15728
15729 Actually the list is interpreted as a list of patterns
15730 (&<<SECTlistexpand>>&), except that it is not expanded first.
15731
15732 WARNING: Macro substitution is still done first, so having a macro
15733 FOO and having FOO_HOME in your &%keep_environment%& option may have
15734 unexpected results. You may work around this using a regular expression
15735 that does not match the macro name: ^[F]OO_HOME$.
15736
15737 Current versions of Exim issue a warning during startup if you do not mention
15738 &%keep_environment%& in your runtime configuration file and if your
15739 current environment is not empty. Future versions may not issue that warning
15740 anymore.
15741
15742 See the &%add_environment%& main config option for a way to set
15743 environment variables to a fixed value.  The environment for &(pipe)&
15744 transports is handled separately, see section &<<SECTpipeenv>>& for
15745 details.
15746
15747
15748 .option keep_malformed main time 4d
15749 This option specifies the length of time to keep messages whose spool files
15750 have been corrupted in some way. This should, of course, never happen. At the
15751 next attempt to deliver such a message, it gets removed. The incident is
15752 logged.
15753
15754
15755 .option ldap_ca_cert_dir main string unset
15756 .cindex "LDAP", "TLS CA certificate directory"
15757 .cindex certificate "directory for LDAP"
15758 This option indicates which directory contains CA certificates for verifying
15759 a TLS certificate presented by an LDAP server.
15760 While Exim does not provide a default value, your SSL library may.
15761 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15762 and constrained to be a directory.
15763
15764
15765 .option ldap_ca_cert_file main string unset
15766 .cindex "LDAP", "TLS CA certificate file"
15767 .cindex certificate "file for LDAP"
15768 This option indicates which file contains CA certificates for verifying
15769 a TLS certificate presented by an LDAP server.
15770 While Exim does not provide a default value, your SSL library may.
15771 Analogous to &%tls_verify_certificates%& but as a client-side option for LDAP
15772 and constrained to be a file.
15773
15774
15775 .option ldap_cert_file main string unset
15776 .cindex "LDAP" "TLS client certificate file"
15777 .cindex certificate "file for LDAP"
15778 This option indicates which file contains an TLS client certificate which
15779 Exim should present to the LDAP server during TLS negotiation.
15780 Should be used together with &%ldap_cert_key%&.
15781
15782
15783 .option ldap_cert_key main string unset
15784 .cindex "LDAP" "TLS client key file"
15785 .cindex certificate "key for LDAP"
15786 This option indicates which file contains the secret/private key to use
15787 to prove identity to the LDAP server during TLS negotiation.
15788 Should be used together with &%ldap_cert_file%&, which contains the
15789 identity to be proven.
15790
15791
15792 .option ldap_cipher_suite main string unset
15793 .cindex "LDAP" "TLS cipher suite"
15794 This controls the TLS cipher-suite negotiation during TLS negotiation with
15795 the LDAP server.  See &<<SECTreqciphssl>>& for more details of the format of
15796 cipher-suite options with OpenSSL (as used by LDAP client libraries).
15797
15798
15799 .option ldap_default_servers main "string list" unset
15800 .cindex "LDAP" "default servers"
15801 This option provides a list of LDAP servers which are tried in turn when an
15802 LDAP query does not contain a server. See section &<<SECTforldaque>>& for
15803 details of LDAP queries. This option is available only when Exim has been built
15804 with LDAP support.
15805
15806
15807 .option ldap_require_cert main string unset.
15808 .cindex "LDAP" "policy for LDAP server TLS cert presentation"
15809 This should be one of the values "hard", "demand", "allow", "try" or "never".
15810 A value other than one of these is interpreted as "never".
15811 See the entry "TLS_REQCERT" in your system man page for ldap.conf(5).
15812 Although Exim does not set a default, the LDAP library probably defaults
15813 to hard/demand.
15814
15815
15816 .option ldap_start_tls main boolean false
15817 .cindex "LDAP" "whether or not to negotiate TLS"
15818 If set, Exim will attempt to negotiate TLS with the LDAP server when
15819 connecting on a regular LDAP port.  This is the LDAP equivalent of SMTP's
15820 "STARTTLS".  This is distinct from using "ldaps", which is the LDAP form
15821 of SSL-on-connect.
15822 In the event of failure to negotiate TLS, the action taken is controlled
15823 by &%ldap_require_cert%&.
15824 This option is ignored for &`ldapi`& connections.
15825
15826
15827 .option ldap_version main integer unset
15828 .cindex "LDAP" "protocol version, forcing"
15829 This option can be used to force Exim to set a specific protocol version for
15830 LDAP. If it option is unset, it is shown by the &%-bP%& command line option as
15831 -1. When this is the case, the default is 3 if LDAP_VERSION3 is defined in
15832 the LDAP headers; otherwise it is 2. This option is available only when Exim
15833 has been built with LDAP support.
15834
15835
15836
15837 .option local_from_check main boolean true
15838 .cindex "&'Sender:'& header line" "disabling addition of"
15839 .cindex "&'From:'& header line" "disabling checking of"
15840 When a message is submitted locally (that is, not over a TCP/IP connection) by
15841 an untrusted user, Exim removes any existing &'Sender:'& header line, and
15842 checks that the &'From:'& header line matches the login of the calling user and
15843 the domain specified by &%qualify_domain%&.
15844
15845 &*Note*&: An unqualified address (no domain) in the &'From:'& header in a
15846 locally submitted message is automatically qualified by Exim, unless the
15847 &%-bnq%& command line option is used.
15848
15849 You can use &%local_from_prefix%& and &%local_from_suffix%& to permit affixes
15850 on the local part. If the &'From:'& header line does not match, Exim adds a
15851 &'Sender:'& header with an address constructed from the calling user's login
15852 and the default qualify domain.
15853
15854 If &%local_from_check%& is set false, the &'From:'& header check is disabled,
15855 and no &'Sender:'& header is ever added. If, in addition, you want to retain
15856 &'Sender:'& header lines supplied by untrusted users, you must also set
15857 &%local_sender_retain%& to be true.
15858
15859 .cindex "envelope sender"
15860 These options affect only the header lines in the message. The envelope sender
15861 is still forced to be the login id at the qualify domain unless
15862 &%untrusted_set_sender%& permits the user to supply an envelope sender.
15863
15864 For messages received over TCP/IP, an ACL can specify &"submission mode"& to
15865 request similar header line checking. See section &<<SECTthesenhea>>&, which
15866 has more details about &'Sender:'& processing.
15867
15868
15869
15870
15871 .option local_from_prefix main string unset
15872 When Exim checks the &'From:'& header line of locally submitted messages for
15873 matching the login id (see &%local_from_check%& above), it can be configured to
15874 ignore certain prefixes and suffixes in the local part of the address. This is
15875 done by setting &%local_from_prefix%& and/or &%local_from_suffix%& to
15876 appropriate lists, in the same form as the &%local_part_prefix%& and
15877 &%local_part_suffix%& router options (see chapter &<<CHAProutergeneric>>&). For
15878 example, if
15879 .code
15880 local_from_prefix = *-
15881 .endd
15882 is set, a &'From:'& line containing
15883 .code
15884 From: anything-user@your.domain.example
15885 .endd
15886 will not cause a &'Sender:'& header to be added if &'user@your.domain.example'&
15887 matches the actual sender address that is constructed from the login name and
15888 qualify domain.
15889
15890
15891 .option local_from_suffix main string unset
15892 See &%local_from_prefix%& above.
15893
15894
15895 .option local_interfaces main "string list" "see below"
15896 This option controls which network interfaces are used by the daemon for
15897 listening; they are also used to identify the local host when routing. Chapter
15898 &<<CHAPinterfaces>>& contains a full description of this option and the related
15899 options &%daemon_smtp_ports%&, &%extra_local_interfaces%&,
15900 &%hosts_treat_as_local%&, and &%tls_on_connect_ports%&. The default value for
15901 &%local_interfaces%& is
15902 .code
15903 local_interfaces = 0.0.0.0
15904 .endd
15905 when Exim is built without IPv6 support; otherwise it is
15906 .code
15907 local_interfaces = <; ::0 ; 0.0.0.0
15908 .endd
15909
15910 .option local_scan_timeout main time 5m
15911 .cindex "timeout" "for &[local_scan()]& function"
15912 .cindex "&[local_scan()]& function" "timeout"
15913 This timeout applies to the &[local_scan()]& function (see chapter
15914 &<<CHAPlocalscan>>&). Zero means &"no timeout"&. If the timeout is exceeded,
15915 the incoming message is rejected with a temporary error if it is an SMTP
15916 message. For a non-SMTP message, the message is dropped and Exim ends with a
15917 non-zero code. The incident is logged on the main and reject logs.
15918
15919
15920
15921 .option local_sender_retain main boolean false
15922 .cindex "&'Sender:'& header line" "retaining from local submission"
15923 When a message is submitted locally (that is, not over a TCP/IP connection) by
15924 an untrusted user, Exim removes any existing &'Sender:'& header line. If you
15925 do not want this to happen, you must set &%local_sender_retain%&, and you must
15926 also set &%local_from_check%& to be false (Exim will complain if you do not).
15927 See also the ACL modifier &`control = suppress_local_fixups`&. Section
15928 &<<SECTthesenhea>>& has more details about &'Sender:'& processing.
15929
15930
15931
15932
15933 .option localhost_number main string&!! unset
15934 .cindex "host" "locally unique number for"
15935 .cindex "message ids" "with multiple hosts"
15936 .vindex "&$localhost_number$&"
15937 Exim's message ids are normally unique only within the local host. If
15938 uniqueness among a set of hosts is required, each host must set a different
15939 value for the &%localhost_number%& option. The string is expanded immediately
15940 after reading the configuration file (so that a number can be computed from the
15941 host name, for example) and the result of the expansion must be a number in the
15942 range 0&--16 (or 0&--10 on operating systems with case-insensitive file
15943 systems). This is available in subsequent string expansions via the variable
15944 &$localhost_number$&. When &%localhost_number is set%&, the final two
15945 characters of the message id, instead of just being a fractional part of the
15946 time, are computed from the time and the local host number as described in
15947 section &<<SECTmessiden>>&.
15948
15949
15950
15951 .option log_file_path main "string list&!!" "set at compile time"
15952 .cindex "log" "file path for"
15953 This option sets the path which is used to determine the names of Exim's log
15954 files, or indicates that logging is to be to syslog, or both. It is expanded
15955 when Exim is entered, so it can, for example, contain a reference to the host
15956 name. If no specific path is set for the log files at compile or runtime,
15957 or if the option is unset at runtime (i.e.  &`log_file_path = `&)
15958 they are written in a sub-directory called &_log_& in Exim's spool directory.
15959 Chapter &<<CHAPlog>>& contains further details about Exim's logging, and
15960 section &<<SECTwhelogwri>>& describes how the contents of &%log_file_path%& are
15961 used. If this string is fixed at your installation (contains no expansion
15962 variables) it is recommended that you do not set this option in the
15963 configuration file, but instead supply the path using LOG_FILE_PATH in
15964 &_Local/Makefile_& so that it is available to Exim for logging errors detected
15965 early on &-- in particular, failure to read the configuration file.
15966
15967
15968 .option log_selector main string unset
15969 .cindex "log" "selectors"
15970 This option can be used to reduce or increase the number of things that Exim
15971 writes to its log files. Its argument is made up of names preceded by plus or
15972 minus characters. For example:
15973 .code
15974 log_selector = +arguments -retry_defer
15975 .endd
15976 A list of possible names and what they control is given in the chapter on
15977 logging, in section &<<SECTlogselector>>&.
15978
15979
15980 .option log_timezone main boolean false
15981 .cindex "log" "timezone for entries"
15982 .vindex "&$tod_log$&"
15983 .vindex "&$tod_zone$&"
15984 By default, the timestamps on log lines are in local time without the
15985 timezone. This means that if your timezone changes twice a year, the timestamps
15986 in log lines are ambiguous for an hour when the clocks go back. One way of
15987 avoiding this problem is to set the timezone to UTC. An alternative is to set
15988 &%log_timezone%& true. This turns on the addition of the timezone offset to
15989 timestamps in log lines. Turning on this option can add quite a lot to the size
15990 of log files because each line is extended by 6 characters. Note that the
15991 &$tod_log$& variable contains the log timestamp without the zone, but there is
15992 another variable called &$tod_zone$& that contains just the timezone offset.
15993
15994
15995 .option lookup_open_max main integer 25
15996 .cindex "too many open files"
15997 .cindex "open files, too many"
15998 .cindex "file" "too many open"
15999 .cindex "lookup" "maximum open files"
16000 .cindex "limit" "open files for lookups"
16001 This option limits the number of simultaneously open files for single-key
16002 lookups that use regular files (that is, &(lsearch)&, &(dbm)&, and &(cdb)&).
16003 Exim normally keeps these files open during routing, because often the same
16004 file is required several times. If the limit is reached, Exim closes the least
16005 recently used file. Note that if you are using the &'ndbm'& library, it
16006 actually opens two files for each logical DBM database, though it still counts
16007 as one for the purposes of &%lookup_open_max%&. If you are getting &"too many
16008 open files"& errors with NDBM, you need to reduce the value of
16009 &%lookup_open_max%&.
16010
16011
16012 .option max_username_length main integer 0
16013 .cindex "length of login name"
16014 .cindex "user name" "maximum length"
16015 .cindex "limit" "user name length"
16016 Some operating systems are broken in that they truncate long arguments to
16017 &[getpwnam()]& to eight characters, instead of returning &"no such user"&. If
16018 this option is set greater than zero, any attempt to call &[getpwnam()]& with
16019 an argument that is longer behaves as if &[getpwnam()]& failed.
16020
16021
16022 .option message_body_newlines main bool false
16023 .cindex "message body" "newlines in variables"
16024 .cindex "newline" "in message body variables"
16025 .vindex "&$message_body$&"
16026 .vindex "&$message_body_end$&"
16027 By default, newlines in the message body are replaced by spaces when setting
16028 the &$message_body$& and &$message_body_end$& expansion variables. If this
16029 option is set true, this no longer happens.
16030
16031
16032 .option message_body_visible main integer 500
16033 .cindex "body of message" "visible size"
16034 .cindex "message body" "visible size"
16035 .vindex "&$message_body$&"
16036 .vindex "&$message_body_end$&"
16037 This option specifies how much of a message's body is to be included in the
16038 &$message_body$& and &$message_body_end$& expansion variables.
16039
16040
16041 .option message_id_header_domain main string&!! unset
16042 .cindex "&'Message-ID:'& header line"
16043 If this option is set, the string is expanded and used as the right hand side
16044 (domain) of the &'Message-ID:'& header that Exim creates if a
16045 locally-originated incoming message does not have one. &"Locally-originated"&
16046 means &"not received over TCP/IP."&
16047 Otherwise, the primary host name is used.
16048 Only letters, digits, dot and hyphen are accepted; any other characters are
16049 replaced by hyphens. If the expansion is forced to fail, or if the result is an
16050 empty string, the option is ignored.
16051
16052
16053 .option message_id_header_text main string&!! unset
16054 If this variable is set, the string is expanded and used to augment the text of
16055 the &'Message-id:'& header that Exim creates if a locally-originated incoming
16056 message does not have one. The text of this header is required by RFC 2822 to
16057 take the form of an address. By default, Exim uses its internal message id as
16058 the local part, and the primary host name as the domain. If this option is set,
16059 it is expanded, and provided the expansion is not forced to fail, and does not
16060 yield an empty string, the result is inserted into the header immediately
16061 before the @, separated from the internal message id by a dot. Any characters
16062 that are illegal in an address are automatically converted into hyphens. This
16063 means that variables such as &$tod_log$& can be used, because the spaces and
16064 colons will become hyphens.
16065
16066
16067 .option message_logs main boolean true
16068 .cindex "message logs" "disabling"
16069 .cindex "log" "message log; disabling"
16070 If this option is turned off, per-message log files are not created in the
16071 &_msglog_& spool sub-directory. This reduces the amount of disk I/O required by
16072 Exim, by reducing the number of files involved in handling a message from a
16073 minimum of four (header spool file, body spool file, delivery journal, and
16074 per-message log) to three. The other major I/O activity is Exim's main log,
16075 which is not affected by this option.
16076
16077
16078 .option message_size_limit main string&!! 50M
16079 .cindex "message" "size limit"
16080 .cindex "limit" "message size"
16081 .cindex "size" "of message, limit"
16082 This option limits the maximum size of message that Exim will process. The
16083 value is expanded for each incoming connection so, for example, it can be made
16084 to depend on the IP address of the remote host for messages arriving via
16085 TCP/IP. After expansion, the value must be a sequence of decimal digits,
16086 optionally followed by K or M.
16087
16088 &*Note*&: This limit cannot be made to depend on a message's sender or any
16089 other properties of an individual message, because it has to be advertised in
16090 the server's response to EHLO. String expansion failure causes a temporary
16091 error. A value of zero means no limit, but its use is not recommended. See also
16092 &%bounce_return_size_limit%&.
16093
16094 Incoming SMTP messages are failed with a 552 error if the limit is
16095 exceeded; locally-generated messages either get a stderr message or a delivery
16096 failure message to the sender, depending on the &%-oe%& setting. Rejection of
16097 an oversized message is logged in both the main and the reject logs. See also
16098 the generic transport option &%message_size_limit%&, which limits the size of
16099 message that an individual transport can process.
16100
16101 If you use a virus-scanner and set this option to to a value larger than the
16102 maximum size that your virus-scanner is configured to support, you may get
16103 failures triggered by large mails.  The right size to configure for the
16104 virus-scanner depends upon what data is passed and the options in use but it's
16105 probably safest to just set it to a little larger than this value.  E.g., with a
16106 default Exim message size of 50M and a default ClamAV StreamMaxLength of 10M,
16107 some problems may result.
16108
16109 A value of 0 will disable size limit checking; Exim will still advertise the
16110 SIZE extension in an EHLO response, but without a limit, so as to permit
16111 SMTP clients to still indicate the message size along with the MAIL verb.
16112
16113
16114 .option move_frozen_messages main boolean false
16115 .cindex "frozen messages" "moving"
16116 This option, which is available only if Exim has been built with the setting
16117 .code
16118 SUPPORT_MOVE_FROZEN_MESSAGES=yes
16119 .endd
16120 in &_Local/Makefile_&, causes frozen messages and their message logs to be
16121 moved from the &_input_& and &_msglog_& directories on the spool to &_Finput_&
16122 and &_Fmsglog_&, respectively. There is currently no support in Exim or the
16123 standard utilities for handling such moved messages, and they do not show up in
16124 lists generated by &%-bp%& or by the Exim monitor.
16125
16126
16127 .option mua_wrapper main boolean false
16128 Setting this option true causes Exim to run in a very restrictive mode in which
16129 it passes messages synchronously to a smart host. Chapter &<<CHAPnonqueueing>>&
16130 contains a full description of this facility.
16131
16132
16133
16134 .option mysql_servers main "string list" unset
16135 .cindex "MySQL" "server list"
16136 This option provides a list of MySQL servers and associated connection data, to
16137 be used in conjunction with &(mysql)& lookups (see section &<<SECID72>>&). The
16138 option is available only if Exim has been built with MySQL support.
16139
16140
16141 .option never_users main "string list&!!" unset
16142 This option is expanded just once, at the start of Exim's processing. Local
16143 message deliveries are normally run in processes that are setuid to the
16144 recipient, and remote deliveries are normally run under Exim's own uid and gid.
16145 It is usually desirable to prevent any deliveries from running as root, as a
16146 safety precaution.
16147
16148 When Exim is built, an option called FIXED_NEVER_USERS can be set to a
16149 list of users that must not be used for local deliveries. This list is fixed in
16150 the binary and cannot be overridden by the configuration file. By default, it
16151 contains just the single user name &"root"&. The &%never_users%& runtime option
16152 can be used to add more users to the fixed list.
16153
16154 If a message is to be delivered as one of the users on the fixed list or the
16155 &%never_users%& list, an error occurs, and delivery is deferred. A common
16156 example is
16157 .code
16158 never_users = root:daemon:bin
16159 .endd
16160 Including root is redundant if it is also on the fixed list, but it does no
16161 harm. This option overrides the &%pipe_as_creator%& option of the &(pipe)&
16162 transport driver.
16163
16164
16165 .option openssl_options main "string list" "+no_sslv2 +single_dh_use +no_ticket"
16166 .cindex "OpenSSL "compatibility options"
16167 This option allows an administrator to adjust the SSL options applied
16168 by OpenSSL to connections.  It is given as a space-separated list of items,
16169 each one to be +added or -subtracted from the current value.
16170
16171 This option is only available if Exim is built against OpenSSL.  The values
16172 available for this option vary according to the age of your OpenSSL install.
16173 The &"all"& value controls a subset of flags which are available, typically
16174 the bug workaround options.  The &'SSL_CTX_set_options'& man page will
16175 list the values known on your system and Exim should support all the
16176 &"bug workaround"& options and many of the &"modifying"& options.  The Exim
16177 names lose the leading &"SSL_OP_"& and are lower-cased.
16178
16179 Note that adjusting the options can have severe impact upon the security of
16180 SSL as used by Exim.  It is possible to disable safety checks and shoot
16181 yourself in the foot in various unpleasant ways.  This option should not be
16182 adjusted lightly.  An unrecognised item will be detected at startup, by
16183 invoking Exim with the &%-bV%& flag.
16184
16185 The option affects Exim operating both as a server and as a client.
16186
16187 Historical note: prior to release 4.80, Exim defaulted this value to
16188 "+dont_insert_empty_fragments", which may still be needed for compatibility
16189 with some clients, but which lowers security by increasing exposure to
16190 some now infamous attacks.
16191
16192 Examples:
16193 .code
16194 # Make both old MS and old Eudora happy:
16195 openssl_options = -all +microsoft_big_sslv3_buffer \
16196                        +dont_insert_empty_fragments
16197
16198 # Disable older protocol versions:
16199 openssl_options = +no_sslv2 +no_sslv3
16200 .endd
16201
16202 Possible options may include:
16203 .ilist
16204 &`all`&
16205 .next
16206 &`allow_unsafe_legacy_renegotiation`&
16207 .next
16208 &`cipher_server_preference`&
16209 .next
16210 &`dont_insert_empty_fragments`&
16211 .next
16212 &`ephemeral_rsa`&
16213 .next
16214 &`legacy_server_connect`&
16215 .next
16216 &`microsoft_big_sslv3_buffer`&
16217 .next
16218 &`microsoft_sess_id_bug`&
16219 .next
16220 &`msie_sslv2_rsa_padding`&
16221 .next
16222 &`netscape_challenge_bug`&
16223 .next
16224 &`netscape_reuse_cipher_change_bug`&
16225 .next
16226 &`no_compression`&
16227 .next
16228 &`no_session_resumption_on_renegotiation`&
16229 .next
16230 &`no_sslv2`&
16231 .next
16232 &`no_sslv3`&
16233 .next
16234 &`no_ticket`&
16235 .next
16236 &`no_tlsv1`&
16237 .next
16238 &`no_tlsv1_1`&
16239 .next
16240 &`no_tlsv1_2`&
16241 .next
16242 &`safari_ecdhe_ecdsa_bug`&
16243 .next
16244 &`single_dh_use`&
16245 .next
16246 &`single_ecdh_use`&
16247 .next
16248 &`ssleay_080_client_dh_bug`&
16249 .next
16250 &`sslref2_reuse_cert_type_bug`&
16251 .next
16252 &`tls_block_padding_bug`&
16253 .next
16254 &`tls_d5_bug`&
16255 .next
16256 &`tls_rollback_bug`&
16257 .endlist
16258
16259 As an aside, the &`safari_ecdhe_ecdsa_bug`& item is a misnomer and affects
16260 all clients connecting using the MacOS SecureTransport TLS facility prior
16261 to MacOS 10.8.4, including email clients.  If you see old MacOS clients failing
16262 to negotiate TLS then this option value might help, provided that your OpenSSL
16263 release is new enough to contain this work-around.  This may be a situation
16264 where you have to upgrade OpenSSL to get buggy clients working.
16265
16266
16267 .option oracle_servers main "string list" unset
16268 .cindex "Oracle" "server list"
16269 This option provides a list of Oracle servers and associated connection data,
16270 to be used in conjunction with &(oracle)& lookups (see section &<<SECID72>>&).
16271 The option is available only if Exim has been built with Oracle support.
16272
16273
16274 .option percent_hack_domains main "domain list&!!" unset
16275 .cindex "&""percent hack""&"
16276 .cindex "source routing" "in email address"
16277 .cindex "address" "source-routed"
16278 The &"percent hack"& is the convention whereby a local part containing a
16279 percent sign is re-interpreted as a new email address, with the percent
16280 replaced by @. This is sometimes called &"source routing"&, though that term is
16281 also applied to RFC 2822 addresses that begin with an @ character. If this
16282 option is set, Exim implements the percent facility for those domains listed,
16283 but no others. This happens before an incoming SMTP address is tested against
16284 an ACL.
16285
16286 &*Warning*&: The &"percent hack"& has often been abused by people who are
16287 trying to get round relaying restrictions. For this reason, it is best avoided
16288 if at all possible. Unfortunately, a number of less security-conscious MTAs
16289 implement it unconditionally. If you are running Exim on a gateway host, and
16290 routing mail through to internal MTAs without processing the local parts, it is
16291 a good idea to reject recipient addresses with percent characters in their
16292 local parts. Exim's default configuration does this.
16293
16294
16295 .option perl_at_start main boolean false
16296 .cindex "Perl"
16297 This option is available only when Exim is built with an embedded Perl
16298 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16299
16300
16301 .option perl_startup main string unset
16302 .cindex "Perl"
16303 This option is available only when Exim is built with an embedded Perl
16304 interpreter. See chapter &<<CHAPperl>>& for details of its use.
16305
16306 .option perl_startup main boolean false
16307 .cindex "Perl"
16308 This Option enables the taint mode of the embedded Perl interpreter.
16309
16310
16311 .option pgsql_servers main "string list" unset
16312 .cindex "PostgreSQL lookup type" "server list"
16313 This option provides a list of PostgreSQL servers and associated connection
16314 data, to be used in conjunction with &(pgsql)& lookups (see section
16315 &<<SECID72>>&). The option is available only if Exim has been built with
16316 PostgreSQL support.
16317
16318
16319 .option pid_file_path main string&!! "set at compile time"
16320 .cindex "daemon" "pid file path"
16321 .cindex "pid file, path for"
16322 This option sets the name of the file to which the Exim daemon writes its
16323 process id. The string is expanded, so it can contain, for example, references
16324 to the host name:
16325 .code
16326 pid_file_path = /var/log/$primary_hostname/exim.pid
16327 .endd
16328 If no path is set, the pid is written to the file &_exim-daemon.pid_& in Exim's
16329 spool directory.
16330 The value set by the option can be overridden by the &%-oP%& command line
16331 option. A pid file is not written if a &"non-standard"& daemon is run by means
16332 of the &%-oX%& option, unless a path is explicitly supplied by &%-oP%&.
16333
16334
16335 .option pipelining_advertise_hosts main "host list&!!" *
16336 .cindex "PIPELINING" "suppressing advertising"
16337 This option can be used to suppress the advertisement of the SMTP
16338 PIPELINING extension to specific hosts. See also the &*no_pipelining*&
16339 control in section &<<SECTcontrols>>&. When PIPELINING is not advertised and
16340 &%smtp_enforce_sync%& is true, an Exim server enforces strict synchronization
16341 for each SMTP command and response. When PIPELINING is advertised, Exim assumes
16342 that clients will use it; &"out of order"& commands that are &"expected"& do
16343 not count as protocol errors (see &%smtp_max_synprot_errors%&).
16344
16345
16346 .option prdr_enable main boolean false
16347 .cindex "PRDR" "enabling on server"
16348 This option can be used to enable the Per-Recipient Data Response extension
16349 to SMTP, defined by Eric Hall.
16350 If the option is set, PRDR is advertised by Exim when operating as a server.
16351 If the client requests PRDR, and more than one recipient, for a message
16352 an additional ACL is called for each recipient after the message content
16353 is received.  See section &<<SECTPRDRACL>>&.
16354
16355 .option preserve_message_logs main boolean false
16356 .cindex "message logs" "preserving"
16357 If this option is set, message log files are not deleted when messages are
16358 completed. Instead, they are moved to a sub-directory of the spool directory
16359 called &_msglog.OLD_&, where they remain available for statistical or debugging
16360 purposes. This is a dangerous option to set on systems with any appreciable
16361 volume of mail. Use with care!
16362
16363
16364 .option primary_hostname main string "see below"
16365 .cindex "name" "of local host"
16366 .cindex "host" "name of local"
16367 .cindex "local host" "name of"
16368 .vindex "&$primary_hostname$&"
16369 This specifies the name of the current host. It is used in the default EHLO or
16370 HELO command for outgoing SMTP messages (changeable via the &%helo_data%&
16371 option in the &(smtp)& transport), and as the default for &%qualify_domain%&.
16372 The value is also used by default in some SMTP response messages from an Exim
16373 server. This can be changed dynamically by setting &%smtp_active_hostname%&.
16374
16375 If &%primary_hostname%& is not set, Exim calls &[uname()]& to find the host
16376 name. If this fails, Exim panics and dies. If the name returned by &[uname()]&
16377 contains only one component, Exim passes it to &[gethostbyname()]& (or
16378 &[getipnodebyname()]& when available) in order to obtain the fully qualified
16379 version. The variable &$primary_hostname$& contains the host name, whether set
16380 explicitly by this option, or defaulted.
16381
16382
16383 .option print_topbitchars main boolean false
16384 .cindex "printing characters"
16385 .cindex "8-bit characters"
16386 By default, Exim considers only those characters whose codes lie in the range
16387 32&--126 to be printing characters. In a number of circumstances (for example,
16388 when writing log entries) non-printing characters are converted into escape
16389 sequences, primarily to avoid messing up the layout. If &%print_topbitchars%&
16390 is set, code values of 128 and above are also considered to be printing
16391 characters.
16392
16393 This option also affects the header syntax checks performed by the
16394 &(autoreply)& transport, and whether Exim uses RFC 2047 encoding of
16395 the user's full name when constructing From: and Sender: addresses (as
16396 described in section &<<SECTconstr>>&). Setting this option can cause
16397 Exim to generate eight bit message headers that do not conform to the
16398 standards.
16399
16400
16401 .option process_log_path main string unset
16402 .cindex "process log path"
16403 .cindex "log" "process log"
16404 .cindex "&'exiwhat'&"
16405 This option sets the name of the file to which an Exim process writes its
16406 &"process log"& when sent a USR1 signal. This is used by the &'exiwhat'&
16407 utility script. If this option is unset, the file called &_exim-process.info_&
16408 in Exim's spool directory is used. The ability to specify the name explicitly
16409 can be useful in environments where two different Exims are running, using
16410 different spool directories.
16411
16412
16413 .option prod_requires_admin main boolean true
16414 .cindex "restricting access to features"
16415 .oindex "&%-M%&"
16416 .oindex "&%-R%&"
16417 .oindex "&%-q%&"
16418 The &%-M%&, &%-R%&, and &%-q%& command-line options require the caller to be an
16419 admin user unless &%prod_requires_admin%& is set false. See also
16420 &%queue_list_requires_admin%& and &%commandline_checks_require_admin%&.
16421
16422
16423 .option qualify_domain main string "see below"
16424 .cindex "domain" "for qualifying addresses"
16425 .cindex "address" "qualification"
16426 This option specifies the domain name that is added to any envelope sender
16427 addresses that do not have a domain qualification. It also applies to
16428 recipient addresses if &%qualify_recipient%& is not set. Unqualified addresses
16429 are accepted by default only for locally-generated messages. Qualification is
16430 also applied to addresses in header lines such as &'From:'& and &'To:'& for
16431 locally-generated messages, unless the &%-bnq%& command line option is used.
16432
16433 Messages from external sources must always contain fully qualified addresses,
16434 unless the sending host matches &%sender_unqualified_hosts%& or
16435 &%recipient_unqualified_hosts%& (as appropriate), in which case incoming
16436 addresses are qualified with &%qualify_domain%& or &%qualify_recipient%& as
16437 necessary. Internally, Exim always works with fully qualified envelope
16438 addresses. If &%qualify_domain%& is not set, it defaults to the
16439 &%primary_hostname%& value.
16440
16441
16442 .option qualify_recipient main string "see below"
16443 This option allows you to specify a different domain for qualifying recipient
16444 addresses to the one that is used for senders. See &%qualify_domain%& above.
16445
16446
16447
16448 .option queue_domains main "domain list&!!" unset
16449 .cindex "domain" "specifying non-immediate delivery"
16450 .cindex "queueing incoming messages"
16451 .cindex "message" "queueing certain domains"
16452 This option lists domains for which immediate delivery is not required.
16453 A delivery process is started whenever a message is received, but only those
16454 domains that do not match are processed. All other deliveries wait until the
16455 next queue run. See also &%hold_domains%& and &%queue_smtp_domains%&.
16456
16457
16458 .option queue_list_requires_admin main boolean true
16459 .cindex "restricting access to features"
16460 .oindex "&%-bp%&"
16461 The &%-bp%& command-line option, which lists the messages that are on the
16462 queue, requires the caller to be an admin user unless
16463 &%queue_list_requires_admin%& is set false.
16464 See also &%prod_requires_admin%& and &%commandline_checks_require_admin%&.
16465
16466
16467 .option queue_only main boolean false
16468 .cindex "queueing incoming messages"
16469 .cindex "message" "queueing unconditionally"
16470 If &%queue_only%& is set, a delivery process is not automatically started
16471 whenever a message is received. Instead, the message waits in the queue for the
16472 next queue run. Even if &%queue_only%& is false, incoming messages may not get
16473 delivered immediately when certain conditions (such as heavy load) occur.
16474
16475 The &%-odq%& command line has the same effect as &%queue_only%&. The &%-odb%&
16476 and &%-odi%& command line options override &%queue_only%& unless
16477 &%queue_only_override%& is set false. See also &%queue_only_file%&,
16478 &%queue_only_load%&, and &%smtp_accept_queue%&.
16479
16480
16481 .option queue_only_file main string unset
16482 .cindex "queueing incoming messages"
16483 .cindex "message" "queueing by file existence"
16484 This option can be set to a colon-separated list of absolute path names, each
16485 one optionally preceded by &"smtp"&. When Exim is receiving a message,
16486 it tests for the existence of each listed path using a call to &[stat()]&. For
16487 each path that exists, the corresponding queueing option is set.
16488 For paths with no prefix, &%queue_only%& is set; for paths prefixed by
16489 &"smtp"&, &%queue_smtp_domains%& is set to match all domains. So, for example,
16490 .code
16491 queue_only_file = smtp/some/file
16492 .endd
16493 causes Exim to behave as if &%queue_smtp_domains%& were set to &"*"& whenever
16494 &_/some/file_& exists.
16495
16496
16497 .option queue_only_load main fixed-point unset
16498 .cindex "load average"
16499 .cindex "queueing incoming messages"
16500 .cindex "message" "queueing by load"
16501 If the system load average is higher than this value, incoming messages from
16502 all sources are queued, and no automatic deliveries are started. If this
16503 happens during local or remote SMTP input, all subsequent messages received on
16504 the same SMTP connection are queued by default, whatever happens to the load in
16505 the meantime, but this can be changed by setting &%queue_only_load_latch%&
16506 false.
16507
16508 Deliveries will subsequently be performed by queue runner processes. This
16509 option has no effect on ancient operating systems on which Exim cannot
16510 determine the load average. See also &%deliver_queue_load_max%& and
16511 &%smtp_load_reserve%&.
16512
16513
16514 .option queue_only_load_latch main boolean true
16515 .cindex "load average" "re-evaluating per message"
16516 When this option is true (the default), once one message has been queued
16517 because the load average is higher than the value set by &%queue_only_load%&,
16518 all subsequent messages received on the same SMTP connection are also queued.
16519 This is a deliberate choice; even though the load average may fall below the
16520 threshold, it doesn't seem right to deliver later messages on the same
16521 connection when not delivering earlier ones. However, there are special
16522 circumstances such as very long-lived connections from scanning appliances
16523 where this is not the best strategy. In such cases, &%queue_only_load_latch%&
16524 should be set false. This causes the value of the load average to be
16525 re-evaluated for each message.
16526
16527
16528 .option queue_only_override main boolean true
16529 .cindex "queueing incoming messages"
16530 When this option is true, the &%-od%&&'x'& command line options override the
16531 setting of &%queue_only%& or &%queue_only_file%& in the configuration file. If
16532 &%queue_only_override%& is set false, the &%-od%&&'x'& options cannot be used
16533 to override; they are accepted, but ignored.
16534
16535
16536 .option queue_run_in_order main boolean false
16537 .cindex "queue runner" "processing messages in order"
16538 If this option is set, queue runs happen in order of message arrival instead of
16539 in an arbitrary order. For this to happen, a complete list of the entire queue
16540 must be set up before the deliveries start. When the queue is all held in a
16541 single directory (the default), a single list is created for both the ordered
16542 and the non-ordered cases. However, if &%split_spool_directory%& is set, a
16543 single list is not created when &%queue_run_in_order%& is false. In this case,
16544 the sub-directories are processed one at a time (in a random order), and this
16545 avoids setting up one huge list for the whole queue. Thus, setting
16546 &%queue_run_in_order%& with &%split_spool_directory%& may degrade performance
16547 when the queue is large, because of the extra work in setting up the single,
16548 large list. In most situations, &%queue_run_in_order%& should not be set.
16549
16550
16551
16552 .option queue_run_max main integer&!! 5
16553 .cindex "queue runner" "maximum number of"
16554 This controls the maximum number of queue runner processes that an Exim daemon
16555 can run simultaneously. This does not mean that it starts them all at once,
16556 but rather that if the maximum number are still running when the time comes to
16557 start another one, it refrains from starting another one. This can happen with
16558 very large queues and/or very sluggish deliveries. This option does not,
16559 however, interlock with other processes, so additional queue runners can be
16560 started by other means, or by killing and restarting the daemon.
16561
16562 Setting this option to zero does not suppress queue runs; rather, it disables
16563 the limit, allowing any number of simultaneous queue runner processes to be
16564 run. If you do not want queue runs to occur, omit the &%-q%&&'xx'& setting on
16565 the daemon's command line.
16566
16567 .cindex queues named
16568 .cindex "named queues"
16569 To set limits for different named queues use
16570 an expansion depending on the &$queue_name$& variable.
16571
16572 .option queue_smtp_domains main "domain list&!!" unset
16573 .cindex "queueing incoming messages"
16574 .cindex "message" "queueing remote deliveries"
16575 When this option is set, a delivery process is started whenever a message is
16576 received, routing is performed, and local deliveries take place.
16577 However, if any SMTP deliveries are required for domains that match
16578 &%queue_smtp_domains%&, they are not immediately delivered, but instead the
16579 message waits in the queue for the next queue run. Since routing of the message
16580 has taken place, Exim knows to which remote hosts it must be delivered, and so
16581 when the queue run happens, multiple messages for the same host are delivered
16582 over a single SMTP connection. The &%-odqs%& command line option causes all
16583 SMTP deliveries to be queued in this way, and is equivalent to setting
16584 &%queue_smtp_domains%& to &"*"&. See also &%hold_domains%& and
16585 &%queue_domains%&.
16586
16587
16588 .option receive_timeout main time 0s
16589 .cindex "timeout" "for non-SMTP input"
16590 This option sets the timeout for accepting a non-SMTP message, that is, the
16591 maximum time that Exim waits when reading a message on the standard input. If
16592 the value is zero, it will wait forever. This setting is overridden by the
16593 &%-or%& command line option. The timeout for incoming SMTP messages is
16594 controlled by &%smtp_receive_timeout%&.
16595
16596 .option received_header_text main string&!! "see below"
16597 .cindex "customizing" "&'Received:'& header"
16598 .cindex "&'Received:'& header line" "customizing"
16599 This string defines the contents of the &'Received:'& message header that is
16600 added to each message, except for the timestamp, which is automatically added
16601 on at the end (preceded by a semicolon). The string is expanded each time it is
16602 used. If the expansion yields an empty string, no &'Received:'& header line is
16603 added to the message. Otherwise, the string should start with the text
16604 &"Received:"& and conform to the RFC 2822 specification for &'Received:'&
16605 header lines.
16606 .new
16607 The default setting is:
16608
16609 .code
16610 received_header_text = Received: \
16611   ${if def:sender_rcvhost {from $sender_rcvhost\n\t}\
16612     {${if def:sender_ident \
16613       {from ${quote_local_part:$sender_ident} }}\
16614         ${if def:sender_helo_name {(helo=$sender_helo_name)\n\t}}}}\
16615   by $primary_hostname \
16616   ${if def:received_protocol {with $received_protocol }}\
16617   ${if def:tls_in_cipher_std { tls $tls_in_cipher_std\n\t}}\
16618   (Exim $version_number)\n\t\
16619   ${if def:sender_address \
16620   {(envelope-from <$sender_address>)\n\t}}\
16621   id $message_exim_id\
16622   ${if def:received_for {\n\tfor $received_for}}
16623 .endd
16624 .wen
16625
16626 The reference to the TLS cipher is omitted when Exim is built without TLS
16627 support. The use of conditional expansions ensures that this works for both
16628 locally generated messages and messages received from remote hosts, giving
16629 header lines such as the following:
16630 .code
16631 Received: from scrooge.carol.example ([192.168.12.25] ident=root)
16632 by marley.carol.example with esmtp (Exim 4.00)
16633 (envelope-from <bob@carol.example>)
16634 id 16IOWa-00019l-00
16635 for chas@dickens.example; Tue, 25 Dec 2001 14:43:44 +0000
16636 Received: by scrooge.carol.example with local (Exim 4.00)
16637 id 16IOWW-000083-00; Tue, 25 Dec 2001 14:43:41 +0000
16638 .endd
16639 Until the body of the message has been received, the timestamp is the time when
16640 the message started to be received. Once the body has arrived, and all policy
16641 checks have taken place, the timestamp is updated to the time at which the
16642 message was accepted.
16643
16644
16645 .option received_headers_max main integer 30
16646 .cindex "loop" "prevention"
16647 .cindex "mail loop prevention"
16648 .cindex "&'Received:'& header line" "counting"
16649 When a message is to be delivered, the number of &'Received:'& headers is
16650 counted, and if it is greater than this parameter, a mail loop is assumed to
16651 have occurred, the delivery is abandoned, and an error message is generated.
16652 This applies to both local and remote deliveries.
16653
16654
16655 .option recipient_unqualified_hosts main "host list&!!" unset
16656 .cindex "unqualified addresses"
16657 .cindex "host" "unqualified addresses from"
16658 This option lists those hosts from which Exim is prepared to accept unqualified
16659 recipient addresses in message envelopes. The addresses are made fully
16660 qualified by the addition of the &%qualify_recipient%& value. This option also
16661 affects message header lines. Exim does not reject unqualified recipient
16662 addresses in headers, but it qualifies them only if the message came from a
16663 host that matches &%recipient_unqualified_hosts%&,
16664 or if the message was submitted locally (not using TCP/IP), and the &%-bnq%&
16665 option was not set.
16666
16667
16668 .option recipients_max main integer 0
16669 .cindex "limit" "number of recipients"
16670 .cindex "recipient" "maximum number"
16671 If this option is set greater than zero, it specifies the maximum number of
16672 original recipients for any message. Additional recipients that are generated
16673 by aliasing or forwarding do not count. SMTP messages get a 452 response for
16674 all recipients over the limit; earlier recipients are delivered as normal.
16675 Non-SMTP messages with too many recipients are failed, and no deliveries are
16676 done.
16677
16678 .cindex "RCPT" "maximum number of incoming"
16679 &*Note*&: The RFCs specify that an SMTP server should accept at least 100
16680 RCPT commands in a single message.
16681
16682
16683 .option recipients_max_reject main boolean false
16684 If this option is set true, Exim rejects SMTP messages containing too many
16685 recipients by giving 552 errors to the surplus RCPT commands, and a 554
16686 error to the eventual DATA command. Otherwise (the default) it gives a 452
16687 error to the surplus RCPT commands and accepts the message on behalf of the
16688 initial set of recipients. The remote server should then re-send the message
16689 for the remaining recipients at a later time.
16690
16691
16692 .option remote_max_parallel main integer 2
16693 .cindex "delivery" "parallelism for remote"
16694 This option controls parallel delivery of one message to a number of remote
16695 hosts. If the value is less than 2, parallel delivery is disabled, and Exim
16696 does all the remote deliveries for a message one by one. Otherwise, if a single
16697 message has to be delivered to more than one remote host, or if several copies
16698 have to be sent to the same remote host, up to &%remote_max_parallel%&
16699 deliveries are done simultaneously. If more than &%remote_max_parallel%&
16700 deliveries are required, the maximum number of processes are started, and as
16701 each one finishes, another is begun. The order of starting processes is the
16702 same as if sequential delivery were being done, and can be controlled by the
16703 &%remote_sort_domains%& option. If parallel delivery takes place while running
16704 with debugging turned on, the debugging output from each delivery process is
16705 tagged with its process id.
16706
16707 This option controls only the maximum number of parallel deliveries for one
16708 message in one Exim delivery process. Because Exim has no central queue
16709 manager, there is no way of controlling the total number of simultaneous
16710 deliveries if the configuration allows a delivery attempt as soon as a message
16711 is received.
16712
16713 .cindex "number of deliveries"
16714 .cindex "delivery" "maximum number of"
16715 If you want to control the total number of deliveries on the system, you
16716 need to set the &%queue_only%& option. This ensures that all incoming messages
16717 are added to the queue without starting a delivery process. Then set up an Exim
16718 daemon to start queue runner processes at appropriate intervals (probably
16719 fairly often, for example, every minute), and limit the total number of queue
16720 runners by setting the &%queue_run_max%& parameter. Because each queue runner
16721 delivers only one message at a time, the maximum number of deliveries that can
16722 then take place at once is &%queue_run_max%& multiplied by
16723 &%remote_max_parallel%&.
16724
16725 If it is purely remote deliveries you want to control, use
16726 &%queue_smtp_domains%& instead of &%queue_only%&. This has the added benefit of
16727 doing the SMTP routing before queueing, so that several messages for the same
16728 host will eventually get delivered down the same connection.
16729
16730
16731 .option remote_sort_domains main "domain list&!!" unset
16732 .cindex "sorting remote deliveries"
16733 .cindex "delivery" "sorting remote"
16734 When there are a number of remote deliveries for a message, they are sorted by
16735 domain into the order given by this list. For example,
16736 .code
16737 remote_sort_domains = *.cam.ac.uk:*.uk
16738 .endd
16739 would attempt to deliver to all addresses in the &'cam.ac.uk'& domain first,
16740 then to those in the &%uk%& domain, then to any others.
16741
16742
16743 .option retry_data_expire main time 7d
16744 .cindex "hints database" "data expiry"
16745 This option sets a &"use before"& time on retry information in Exim's hints
16746 database. Any older retry data is ignored. This means that, for example, once a
16747 host has not been tried for 7 days, Exim behaves as if it has no knowledge of
16748 past failures.
16749
16750
16751 .option retry_interval_max main time 24h
16752 .cindex "retry" "limit on interval"
16753 .cindex "limit" "on retry interval"
16754 Chapter &<<CHAPretry>>& describes Exim's mechanisms for controlling the
16755 intervals between delivery attempts for messages that cannot be delivered
16756 straight away. This option sets an overall limit to the length of time between
16757 retries. It cannot be set greater than 24 hours; any attempt to do so forces
16758 the default value.
16759
16760
16761 .option return_path_remove main boolean true
16762 .cindex "&'Return-path:'& header line" "removing"
16763 RFC 2821, section 4.4, states that an SMTP server must insert a
16764 &'Return-path:'& header line into a message when it makes a &"final delivery"&.
16765 The &'Return-path:'& header preserves the sender address as received in the
16766 MAIL command. This description implies that this header should not be present
16767 in an incoming message. If &%return_path_remove%& is true, any existing
16768 &'Return-path:'& headers are removed from messages at the time they are
16769 received. Exim's transports have options for adding &'Return-path:'& headers at
16770 the time of delivery. They are normally used only for final local deliveries.
16771
16772
16773 .option return_size_limit main integer 100K
16774 This option is an obsolete synonym for &%bounce_return_size_limit%&.
16775
16776
16777 .option rfc1413_hosts main "host list&!!" @[]
16778 .cindex "RFC 1413"
16779 .cindex "host" "for RFC 1413 calls"
16780 RFC 1413 identification calls are made to any client host which matches
16781 an item in the list.
16782 The default value specifies just this host, being any local interface
16783 for the system.
16784
16785 .option rfc1413_query_timeout main time 0s
16786 .cindex "RFC 1413" "query timeout"
16787 .cindex "timeout" "for RFC 1413 call"
16788 This sets the timeout on RFC 1413 identification calls. If it is set to zero,
16789 no RFC 1413 calls are ever made.
16790
16791
16792 .option sender_unqualified_hosts main "host list&!!" unset
16793 .cindex "unqualified addresses"
16794 .cindex "host" "unqualified addresses from"
16795 This option lists those hosts from which Exim is prepared to accept unqualified
16796 sender addresses. The addresses are made fully qualified by the addition of
16797 &%qualify_domain%&. This option also affects message header lines. Exim does
16798 not reject unqualified addresses in headers that contain sender addresses, but
16799 it qualifies them only if the message came from a host that matches
16800 &%sender_unqualified_hosts%&, or if the message was submitted locally (not
16801 using TCP/IP), and the &%-bnq%& option was not set.
16802
16803 .option set_environment main "string list" empty
16804 .cindex "environment"
16805 This option allows to set individual environment variables that the
16806 currently linked libraries and programs in child processes use. The
16807 default list is empty,
16808
16809
16810 .option slow_lookup_log main integer 0
16811 .cindex "logging" "slow lookups"
16812 .cindex "dns" "logging slow lookups"
16813 This option controls logging of slow lookups.
16814 If the value is nonzero it is taken as a number of milliseconds
16815 and lookups taking longer than this are logged.
16816 Currently this applies only to DNS lookups.
16817
16818
16819
16820 .option smtp_accept_keepalive main boolean true
16821 .cindex "keepalive" "on incoming connection"
16822 This option controls the setting of the SO_KEEPALIVE option on incoming
16823 TCP/IP socket connections. When set, it causes the kernel to probe idle
16824 connections periodically, by sending packets with &"old"& sequence numbers. The
16825 other end of the connection should send an acknowledgment if the connection is
16826 still okay or a reset if the connection has been aborted. The reason for doing
16827 this is that it has the beneficial effect of freeing up certain types of
16828 connection that can get stuck when the remote host is disconnected without
16829 tidying up the TCP/IP call properly. The keepalive mechanism takes several
16830 hours to detect unreachable hosts.
16831
16832
16833
16834 .option smtp_accept_max main integer 20
16835 .cindex "limit" "incoming SMTP connections"
16836 .cindex "SMTP" "incoming connection count"
16837 .cindex "inetd"
16838 This option specifies the maximum number of simultaneous incoming SMTP calls
16839 that Exim will accept. It applies only to the listening daemon; there is no
16840 control (in Exim) when incoming SMTP is being handled by &'inetd'&. If the
16841 value is set to zero, no limit is applied. However, it is required to be
16842 non-zero if either &%smtp_accept_max_per_host%& or &%smtp_accept_queue%& is
16843 set. See also &%smtp_accept_reserve%& and &%smtp_load_reserve%&.
16844
16845 A new SMTP connection is immediately rejected if the &%smtp_accept_max%& limit
16846 has been reached. If not, Exim first checks &%smtp_accept_max_per_host%&. If
16847 that limit has not been reached for the client host, &%smtp_accept_reserve%&
16848 and &%smtp_load_reserve%& are then checked before accepting the connection.
16849
16850
16851 .option smtp_accept_max_nonmail main integer 10
16852 .cindex "limit" "non-mail SMTP commands"
16853 .cindex "SMTP" "limiting non-mail commands"
16854 Exim counts the number of &"non-mail"& commands in an SMTP session, and drops
16855 the connection if there are too many. This option defines &"too many"&. The
16856 check catches some denial-of-service attacks, repeated failing AUTHs, or a mad
16857 client looping sending EHLO, for example. The check is applied only if the
16858 client host matches &%smtp_accept_max_nonmail_hosts%&.
16859
16860 When a new message is expected, one occurrence of RSET is not counted. This
16861 allows a client to send one RSET between messages (this is not necessary,
16862 but some clients do it). Exim also allows one uncounted occurrence of HELO
16863 or EHLO, and one occurrence of STARTTLS between messages. After
16864 starting up a TLS session, another EHLO is expected, and so it too is not
16865 counted. The first occurrence of AUTH in a connection, or immediately
16866 following STARTTLS is not counted. Otherwise, all commands other than
16867 MAIL, RCPT, DATA, and QUIT are counted.
16868
16869
16870 .option smtp_accept_max_nonmail_hosts main "host list&!!" *
16871 You can control which hosts are subject to the &%smtp_accept_max_nonmail%&
16872 check by setting this option. The default value makes it apply to all hosts. By
16873 changing the value, you can exclude any badly-behaved hosts that you have to
16874 live with.
16875
16876
16877 . Allow this long option name to split; give it unsplit as a fifth argument
16878 . for the automatic .oindex that is generated by .option.
16879 . We insert " &~&~" which is both pretty nasty visually and results in
16880 . non-searchable text.  HowItWorks.txt mentions an option for inserting
16881 . zero-width-space, which would be nicer visually and results in (at least)
16882 . html that Firefox will split on when it's forced to reflow (rather than
16883 . inserting a horizontal scrollbar).  However, the text is still not
16884 . searchable.  NM changed this occurrence for bug 1197 to no longer allow
16885 . the option name to split.
16886
16887 .option "smtp_accept_max_per_connection" main integer 1000 &&&
16888          smtp_accept_max_per_connection
16889 .cindex "SMTP" "limiting incoming message count"
16890 .cindex "limit" "messages per SMTP connection"
16891 The value of this option limits the number of MAIL commands that Exim is
16892 prepared to accept over a single SMTP connection, whether or not each command
16893 results in the transfer of a message. After the limit is reached, a 421
16894 response is given to subsequent MAIL commands. This limit is a safety
16895 precaution against a client that goes mad (incidents of this type have been
16896 seen).
16897
16898
16899 .option smtp_accept_max_per_host main string&!! unset
16900 .cindex "limit" "SMTP connections from one host"
16901 .cindex "host" "limiting SMTP connections from"
16902 This option restricts the number of simultaneous IP connections from a single
16903 host (strictly, from a single IP address) to the Exim daemon. The option is
16904 expanded, to enable different limits to be applied to different hosts by
16905 reference to &$sender_host_address$&. Once the limit is reached, additional
16906 connection attempts from the same host are rejected with error code 421. This
16907 is entirely independent of &%smtp_accept_reserve%&. The option's default value
16908 of zero imposes no limit. If this option is set greater than zero, it is
16909 required that &%smtp_accept_max%& be non-zero.
16910
16911 &*Warning*&: When setting this option you should not use any expansion
16912 constructions that take an appreciable amount of time. The expansion and test
16913 happen in the main daemon loop, in order to reject additional connections
16914 without forking additional processes (otherwise a denial-of-service attack
16915 could cause a vast number or processes to be created). While the daemon is
16916 doing this processing, it cannot accept any other incoming connections.
16917
16918
16919
16920 .option smtp_accept_queue main integer 0
16921 .cindex "SMTP" "incoming connection count"
16922 .cindex "queueing incoming messages"
16923 .cindex "message" "queueing by SMTP connection count"
16924 If the number of simultaneous incoming SMTP connections being handled via the
16925 listening daemon exceeds this value, messages received by SMTP are just placed
16926 in the queue; no delivery processes are started automatically. The count is
16927 fixed at the start of an SMTP connection. It cannot be updated in the
16928 subprocess that receives messages, and so the queueing or not queueing applies
16929 to all messages received in the same connection.
16930
16931 A value of zero implies no limit, and clearly any non-zero value is useful only
16932 if it is less than the &%smtp_accept_max%& value (unless that is zero). See
16933 also &%queue_only%&, &%queue_only_load%&, &%queue_smtp_domains%&, and the
16934 various &%-od%&&'x'& command line options.
16935
16936
16937 . See the comment on smtp_accept_max_per_connection
16938
16939 .option "smtp_accept_queue_per_connection" main integer 10 &&&
16940          smtp_accept_queue_per_connection
16941 .cindex "queueing incoming messages"
16942 .cindex "message" "queueing by message count"
16943 This option limits the number of delivery processes that Exim starts
16944 automatically when receiving messages via SMTP, whether via the daemon or by
16945 the use of &%-bs%& or &%-bS%&. If the value of the option is greater than zero,
16946 and the number of messages received in a single SMTP session exceeds this
16947 number, subsequent messages are placed in the queue, but no delivery processes
16948 are started. This helps to limit the number of Exim processes when a server
16949 restarts after downtime and there is a lot of mail waiting for it on other
16950 systems. On large systems, the default should probably be increased, and on
16951 dial-in client systems it should probably be set to zero (that is, disabled).
16952
16953
16954 .option smtp_accept_reserve main integer 0
16955 .cindex "SMTP" "incoming call count"
16956 .cindex "host" "reserved"
16957 When &%smtp_accept_max%& is set greater than zero, this option specifies a
16958 number of SMTP connections that are reserved for connections from the hosts
16959 that are specified in &%smtp_reserve_hosts%&. The value set in
16960 &%smtp_accept_max%& includes this reserve pool. The specified hosts are not
16961 restricted to this number of connections; the option specifies a minimum number
16962 of connection slots for them, not a maximum. It is a guarantee that this group
16963 of hosts can always get at least &%smtp_accept_reserve%& connections. However,
16964 the limit specified by &%smtp_accept_max_per_host%& is still applied to each
16965 individual host.
16966
16967 For example, if &%smtp_accept_max%& is set to 50 and &%smtp_accept_reserve%& is
16968 set to 5, once there are 45 active connections (from any hosts), new
16969 connections are accepted only from hosts listed in &%smtp_reserve_hosts%&,
16970 provided the other criteria for acceptance are met.
16971
16972
16973 .option smtp_active_hostname main string&!! unset
16974 .cindex "host" "name in SMTP responses"
16975 .cindex "SMTP" "host name in responses"
16976 .vindex "&$primary_hostname$&"
16977 This option is provided for multi-homed servers that want to masquerade as
16978 several different hosts. At the start of an incoming SMTP connection, its value
16979 is expanded and used instead of the value of &$primary_hostname$& in SMTP
16980 responses. For example, it is used as domain name in the response to an
16981 incoming HELO or EHLO command.
16982
16983 .vindex "&$smtp_active_hostname$&"
16984 The active hostname is placed in the &$smtp_active_hostname$& variable, which
16985 is saved with any messages that are received. It is therefore available for use
16986 in routers and transports when the message is later delivered.
16987
16988 If this option is unset, or if its expansion is forced to fail, or if the
16989 expansion results in an empty string, the value of &$primary_hostname$& is
16990 used. Other expansion failures cause a message to be written to the main and
16991 panic logs, and the SMTP command receives a temporary error. Typically, the
16992 value of &%smtp_active_hostname%& depends on the incoming interface address.
16993 For example:
16994 .code
16995 smtp_active_hostname = ${if eq{$received_ip_address}{10.0.0.1}\
16996   {cox.mydomain}{box.mydomain}}
16997 .endd
16998
16999 Although &$smtp_active_hostname$& is primarily concerned with incoming
17000 messages, it is also used as the default for HELO commands in callout
17001 verification if there is no remote transport from which to obtain a
17002 &%helo_data%& value.
17003
17004 .option smtp_banner main string&!! "see below"
17005 .cindex "SMTP" "welcome banner"
17006 .cindex "banner for SMTP"
17007 .cindex "welcome banner for SMTP"
17008 .cindex "customizing" "SMTP banner"
17009 This string, which is expanded every time it is used, is output as the initial
17010 positive response to an SMTP connection. The default setting is:
17011 .code
17012 smtp_banner = $smtp_active_hostname ESMTP Exim \
17013   $version_number $tod_full
17014 .endd
17015 Failure to expand the string causes a panic error. If you want to create a
17016 multiline response to the initial SMTP connection, use &"\n"& in the string at
17017 appropriate points, but not at the end. Note that the 220 code is not included
17018 in this string. Exim adds it automatically (several times in the case of a
17019 multiline response).
17020
17021
17022 .option smtp_check_spool_space main boolean true
17023 .cindex "checking disk space"
17024 .cindex "disk space, checking"
17025 .cindex "spool directory" "checking space"
17026 When this option is set, if an incoming SMTP session encounters the SIZE
17027 option on a MAIL command, it checks that there is enough space in the
17028 spool directory's partition to accept a message of that size, while still
17029 leaving free the amount specified by &%check_spool_space%& (even if that value
17030 is zero). If there isn't enough space, a temporary error code is returned.
17031
17032
17033 .option smtp_connect_backlog main integer 20
17034 .cindex "connection backlog"
17035 .cindex "SMTP" "connection backlog"
17036 .cindex "backlog of connections"
17037 This option specifies a maximum number of waiting SMTP connections. Exim passes
17038 this value to the TCP/IP system when it sets up its listener. Once this number
17039 of connections are waiting for the daemon's attention, subsequent connection
17040 attempts are refused at the TCP/IP level. At least, that is what the manuals
17041 say; in some circumstances such connection attempts have been observed to time
17042 out instead. For large systems it is probably a good idea to increase the
17043 value (to 50, say). It also gives some protection against denial-of-service
17044 attacks by SYN flooding.
17045
17046
17047 .option smtp_enforce_sync main boolean true
17048 .cindex "SMTP" "synchronization checking"
17049 .cindex "synchronization checking in SMTP"
17050 The SMTP protocol specification requires the client to wait for a response from
17051 the server at certain points in the dialogue. Without PIPELINING these
17052 synchronization points are after every command; with PIPELINING they are
17053 fewer, but they still exist.
17054
17055 Some spamming sites send out a complete set of SMTP commands without waiting
17056 for any response. Exim protects against this by rejecting a message if the
17057 client has sent further input when it should not have. The error response &"554
17058 SMTP synchronization error"& is sent, and the connection is dropped. Testing
17059 for this error cannot be perfect because of transmission delays (unexpected
17060 input may be on its way but not yet received when Exim checks). However, it
17061 does detect many instances.
17062
17063 The check can be globally disabled by setting &%smtp_enforce_sync%& false.
17064 If you want to disable the check selectively (for example, only for certain
17065 hosts), you can do so by an appropriate use of a &%control%& modifier in an ACL
17066 (see section &<<SECTcontrols>>&). See also &%pipelining_advertise_hosts%&.
17067
17068
17069
17070 .option smtp_etrn_command main string&!! unset
17071 .cindex "ETRN" "command to be run"
17072 .vindex "&$domain$&"
17073 If this option is set, the given command is run whenever an SMTP ETRN
17074 command is received from a host that is permitted to issue such commands (see
17075 chapter &<<CHAPACL>>&). The string is split up into separate arguments which
17076 are independently expanded. The expansion variable &$domain$& is set to the
17077 argument of the ETRN command, and no syntax checking is done on it. For
17078 example:
17079 .code
17080 smtp_etrn_command = /etc/etrn_command $domain \
17081                     $sender_host_address
17082 .endd
17083 A new process is created to run the command, but Exim does not wait for it to
17084 complete. Consequently, its status cannot be checked. If the command cannot be
17085 run, a line is written to the panic log, but the ETRN caller still receives
17086 a 250 success response. Exim is normally running under its own uid when
17087 receiving SMTP, so it is not possible for it to change the uid before running
17088 the command.
17089
17090
17091 .option smtp_etrn_serialize main boolean true
17092 .cindex "ETRN" "serializing"
17093 When this option is set, it prevents the simultaneous execution of more than
17094 one identical command as a result of ETRN in an SMTP connection. See
17095 section &<<SECTETRN>>& for details.
17096
17097
17098 .option smtp_load_reserve main fixed-point unset
17099 .cindex "load average"
17100 If the system load average ever gets higher than this, incoming SMTP calls are
17101 accepted only from those hosts that match an entry in &%smtp_reserve_hosts%&.
17102 If &%smtp_reserve_hosts%& is not set, no incoming SMTP calls are accepted when
17103 the load is over the limit. The option has no effect on ancient operating
17104 systems on which Exim cannot determine the load average. See also
17105 &%deliver_queue_load_max%& and &%queue_only_load%&.
17106
17107
17108
17109 .option smtp_max_synprot_errors main integer 3
17110 .cindex "SMTP" "limiting syntax and protocol errors"
17111 .cindex "limit" "SMTP syntax and protocol errors"
17112 Exim rejects SMTP commands that contain syntax or protocol errors. In
17113 particular, a syntactically invalid email address, as in this command:
17114 .code
17115 RCPT TO:<abc xyz@a.b.c>
17116 .endd
17117 causes immediate rejection of the command, before any other tests are done.
17118 (The ACL cannot be run if there is no valid address to set up for it.) An
17119 example of a protocol error is receiving RCPT before MAIL. If there are
17120 too many syntax or protocol errors in one SMTP session, the connection is
17121 dropped. The limit is set by this option.
17122
17123 .cindex "PIPELINING" "expected errors"
17124 When the PIPELINING extension to SMTP is in use, some protocol errors are
17125 &"expected"&, for instance, a RCPT command after a rejected MAIL command.
17126 Exim assumes that PIPELINING will be used if it advertises it (see
17127 &%pipelining_advertise_hosts%&), and in this situation, &"expected"& errors do
17128 not count towards the limit.
17129
17130
17131
17132 .option smtp_max_unknown_commands main integer 3
17133 .cindex "SMTP" "limiting unknown commands"
17134 .cindex "limit" "unknown SMTP commands"
17135 If there are too many unrecognized commands in an incoming SMTP session, an
17136 Exim server drops the connection. This is a defence against some kinds of abuse
17137 that subvert web
17138 clients
17139 into making connections to SMTP ports; in these circumstances, a number of
17140 non-SMTP command lines are sent first.
17141
17142
17143
17144 .option smtp_ratelimit_hosts main "host list&!!" unset
17145 .cindex "SMTP" "rate limiting"
17146 .cindex "limit" "rate of message arrival"
17147 .cindex "RCPT" "rate limiting"
17148 Some sites find it helpful to be able to limit the rate at which certain hosts
17149 can send them messages, and the rate at which an individual message can specify
17150 recipients.
17151
17152 Exim has two rate-limiting facilities. This section describes the older
17153 facility, which can limit rates within a single connection. The newer
17154 &%ratelimit%& ACL condition can limit rates across all connections. See section
17155 &<<SECTratelimiting>>& for details of the newer facility.
17156
17157 When a host matches &%smtp_ratelimit_hosts%&, the values of
17158 &%smtp_ratelimit_mail%& and &%smtp_ratelimit_rcpt%& are used to control the
17159 rate of acceptance of MAIL and RCPT commands in a single SMTP session,
17160 respectively. Each option, if set, must contain a set of four comma-separated
17161 values:
17162
17163 .ilist
17164 A threshold, before which there is no rate limiting.
17165 .next
17166 An initial time delay. Unlike other times in Exim, numbers with decimal
17167 fractional parts are allowed here.
17168 .next
17169 A factor by which to increase the delay each time.
17170 .next
17171 A maximum value for the delay. This should normally be less than 5 minutes,
17172 because after that time, the client is liable to timeout the SMTP command.
17173 .endlist
17174
17175 For example, these settings have been used successfully at the site which
17176 first suggested this feature, for controlling mail from their customers:
17177 .code
17178 smtp_ratelimit_mail = 2,0.5s,1.05,4m
17179 smtp_ratelimit_rcpt = 4,0.25s,1.015,4m
17180 .endd
17181 The first setting specifies delays that are applied to MAIL commands after
17182 two have been received over a single connection. The initial delay is 0.5
17183 seconds, increasing by a factor of 1.05 each time. The second setting applies
17184 delays to RCPT commands when more than four occur in a single message.
17185
17186
17187 .option smtp_ratelimit_mail main string unset
17188 See &%smtp_ratelimit_hosts%& above.
17189
17190
17191 .option smtp_ratelimit_rcpt main string unset
17192 See &%smtp_ratelimit_hosts%& above.
17193
17194
17195 .option smtp_receive_timeout main time&!! 5m
17196 .cindex "timeout" "for SMTP input"
17197 .cindex "SMTP" "input timeout"
17198 This sets a timeout value for SMTP reception. It applies to all forms of SMTP
17199 input, including batch SMTP. If a line of input (either an SMTP command or a
17200 data line) is not received within this time, the SMTP connection is dropped and
17201 the message is abandoned.
17202 A line is written to the log containing one of the following messages:
17203 .code
17204 SMTP command timeout on connection from...
17205 SMTP data timeout on connection from...
17206 .endd
17207 The former means that Exim was expecting to read an SMTP command; the latter
17208 means that it was in the DATA phase, reading the contents of a message.
17209
17210 If the first character of the option is a &"$"& the option is
17211 expanded before use and may depend on
17212 &$sender_host_name$&, &$sender_host_address$& and &$sender_host_port$&.
17213
17214
17215 .oindex "&%-os%&"
17216 The value set by this option can be overridden by the
17217 &%-os%& command-line option. A setting of zero time disables the timeout, but
17218 this should never be used for SMTP over TCP/IP. (It can be useful in some cases
17219 of local input using &%-bs%& or &%-bS%&.) For non-SMTP input, the reception
17220 timeout is controlled by &%receive_timeout%& and &%-or%&.
17221
17222
17223 .option smtp_reserve_hosts main "host list&!!" unset
17224 This option defines hosts for which SMTP connections are reserved; see
17225 &%smtp_accept_reserve%& and &%smtp_load_reserve%& above.
17226
17227
17228 .option smtp_return_error_details main boolean false
17229 .cindex "SMTP" "details policy failures"
17230 .cindex "policy control" "rejection, returning details"
17231 In the default state, Exim uses bland messages such as
17232 &"Administrative prohibition"& when it rejects SMTP commands for policy
17233 reasons. Many sysadmins like this because it gives away little information
17234 to spammers. However, some other sysadmins who are applying strict checking
17235 policies want to give out much fuller information about failures. Setting
17236 &%smtp_return_error_details%& true causes Exim to be more forthcoming. For
17237 example, instead of &"Administrative prohibition"&, it might give:
17238 .code
17239 550-Rejected after DATA: '>' missing at end of address:
17240 550 failing address in "From" header is: <user@dom.ain
17241 .endd
17242
17243
17244 .option smtputf8_advertise_hosts main "host list&!!" *
17245 .cindex "SMTPUTF8" "advertising"
17246 When Exim is built with support for internationalised mail names,
17247 the availability thereof is advertised in
17248 response to EHLO only to those client hosts that match this option. See
17249 chapter &<<CHAPi18n>>& for details of Exim's support for internationalisation.
17250
17251
17252 .option spamd_address main string "127.0.0.1 783"
17253 This option is available when Exim is compiled with the content-scanning
17254 extension. It specifies how Exim connects to SpamAssassin's &%spamd%& daemon.
17255 See section &<<SECTscanspamass>>& for more details.
17256
17257
17258
17259 .option spf_guess main string "v=spf1 a/24 mx/24 ptr ?all"
17260 This option is available when Exim is compiled with SPF support.
17261 See section &<<SECSPF>>& for more details.
17262
17263
17264
17265 .option split_spool_directory main boolean false
17266 .cindex "multiple spool directories"
17267 .cindex "spool directory" "split"
17268 .cindex "directories, multiple"
17269 If this option is set, it causes Exim to split its input directory into 62
17270 subdirectories, each with a single alphanumeric character as its name. The
17271 sixth character of the message id is used to allocate messages to
17272 subdirectories; this is the least significant base-62 digit of the time of
17273 arrival of the message.
17274
17275 Splitting up the spool in this way may provide better performance on systems
17276 where there are long mail queues, by reducing the number of files in any one
17277 directory. The msglog directory is also split up in a similar way to the input
17278 directory; however, if &%preserve_message_logs%& is set, all old msglog files
17279 are still placed in the single directory &_msglog.OLD_&.
17280
17281 It is not necessary to take any special action for existing messages when
17282 changing &%split_spool_directory%&. Exim notices messages that are in the
17283 &"wrong"& place, and continues to process them. If the option is turned off
17284 after a period of being on, the subdirectories will eventually empty and be
17285 automatically deleted.
17286
17287 When &%split_spool_directory%& is set, the behaviour of queue runner processes
17288 changes. Instead of creating a list of all messages in the queue, and then
17289 trying to deliver each one, in turn, it constructs a list of those in one
17290 sub-directory and tries to deliver them, before moving on to the next
17291 sub-directory. The sub-directories are processed in a random order. This
17292 spreads out the scanning of the input directories, and uses less memory. It is
17293 particularly beneficial when there are lots of messages in the queue. However,
17294 if &%queue_run_in_order%& is set, none of this new processing happens. The
17295 entire queue has to be scanned and sorted before any deliveries can start.
17296
17297
17298 .option spool_directory main string&!! "set at compile time"
17299 .cindex "spool directory" "path to"
17300 This defines the directory in which Exim keeps its spool, that is, the messages
17301 it is waiting to deliver. The default value is taken from the compile-time
17302 configuration setting, if there is one. If not, this option must be set. The
17303 string is expanded, so it can contain, for example, a reference to
17304 &$primary_hostname$&.
17305
17306 If the spool directory name is fixed on your installation, it is recommended
17307 that you set it at build time rather than from this option, particularly if the
17308 log files are being written to the spool directory (see &%log_file_path%&).
17309 Otherwise log files cannot be used for errors that are detected early on, such
17310 as failures in the configuration file.
17311
17312 By using this option to override the compiled-in path, it is possible to run
17313 tests of Exim without using the standard spool.
17314
17315 .option spool_wireformat main boolean false
17316 .cindex "spool directory" "file formats"
17317 If this option is set, Exim may for some messages use an alternative format
17318 for data-files in the spool which matches the wire format.
17319 Doing this permits more efficient message reception and transmission.
17320 Currently it is only done for messages received using the ESMTP CHUNKING
17321 option.
17322
17323 The following variables will not have useful values:
17324 .code
17325 $max_received_linelength
17326 $body_linecount
17327 $body_zerocount
17328 .endd
17329
17330 Users of the local_scan() API (see &<<CHAPlocalscan>>&),
17331 and any external programs which are passed a reference to a message data file
17332 (except via the &"regex"&, &"malware"& or &"spam"&) ACL conditions)
17333 will need to be aware of the different formats potentially available.
17334
17335 Using any of the ACL conditions noted will negate the reception benefit
17336 (as a Unix-mbox-format file is constructed for them).
17337 The transmission benefit is maintained.
17338
17339 .option sqlite_lock_timeout main time 5s
17340 .cindex "sqlite lookup type" "lock timeout"
17341 This option controls the timeout that the &(sqlite)& lookup uses when trying to
17342 access an SQLite database. See section &<<SECTsqlite>>& for more details.
17343
17344 .option strict_acl_vars main boolean false
17345 .cindex "&ACL;" "variables, handling unset"
17346 This option controls what happens if a syntactically valid but undefined ACL
17347 variable is referenced. If it is false (the default), an empty string
17348 is substituted; if it is true, an error is generated. See section
17349 &<<SECTaclvariables>>& for details of ACL variables.
17350
17351 .option strip_excess_angle_brackets main boolean false
17352 .cindex "angle brackets, excess"
17353 If this option is set, redundant pairs of angle brackets round &"route-addr"&
17354 items in addresses are stripped. For example, &'<<xxx@a.b.c.d>>'& is
17355 treated as &'<xxx@a.b.c.d>'&. If this is in the envelope and the message is
17356 passed on to another MTA, the excess angle brackets are not passed on. If this
17357 option is not set, multiple pairs of angle brackets cause a syntax error.
17358
17359
17360 .option strip_trailing_dot main boolean false
17361 .cindex "trailing dot on domain"
17362 .cindex "dot" "trailing on domain"
17363 If this option is set, a trailing dot at the end of a domain in an address is
17364 ignored. If this is in the envelope and the message is passed on to another
17365 MTA, the dot is not passed on. If this option is not set, a dot at the end of a
17366 domain causes a syntax error.
17367 However, addresses in header lines are checked only when an ACL requests header
17368 syntax checking.
17369
17370
17371 .option syslog_duplication main boolean true
17372 .cindex "syslog" "duplicate log lines; suppressing"
17373 When Exim is logging to syslog, it writes the log lines for its three
17374 separate logs at different syslog priorities so that they can in principle
17375 be separated on the logging hosts. Some installations do not require this
17376 separation, and in those cases, the duplication of certain log lines is a
17377 nuisance. If &%syslog_duplication%& is set false, only one copy of any
17378 particular log line is written to syslog. For lines that normally go to
17379 both the main log and the reject log, the reject log version (possibly
17380 containing message header lines) is written, at LOG_NOTICE priority.
17381 Lines that normally go to both the main and the panic log are written at
17382 the LOG_ALERT priority.
17383
17384
17385 .option syslog_facility main string unset
17386 .cindex "syslog" "facility; setting"
17387 This option sets the syslog &"facility"& name, used when Exim is logging to
17388 syslog. The value must be one of the strings &"mail"&, &"user"&, &"news"&,
17389 &"uucp"&, &"daemon"&, or &"local&'x'&"& where &'x'& is a digit between 0 and 7.
17390 If this option is unset, &"mail"& is used. See chapter &<<CHAPlog>>& for
17391 details of Exim's logging.
17392
17393
17394 .option syslog_pid main boolean true
17395 .cindex "syslog" "pid"
17396 If &%syslog_pid%& is set false, the PID on Exim's log lines are
17397 omitted when these lines are sent to syslog. (Syslog normally prefixes
17398 the log lines with the PID of the logging process automatically.) You need
17399 to enable the &`+pid`& log selector item, if you want Exim to write it's PID
17400 into the logs.) See chapter &<<CHAPlog>>& for details of Exim's logging.
17401
17402
17403
17404 .option syslog_processname main string &`exim`&
17405 .cindex "syslog" "process name; setting"
17406 This option sets the syslog &"ident"& name, used when Exim is logging to
17407 syslog. The value must be no longer than 32 characters. See chapter
17408 &<<CHAPlog>>& for details of Exim's logging.
17409
17410
17411
17412 .option syslog_timestamp main boolean true
17413 .cindex "syslog" "timestamps"
17414 If &%syslog_timestamp%& is set false, the timestamps on Exim's log lines are
17415 omitted when these lines are sent to syslog. See chapter &<<CHAPlog>>& for
17416 details of Exim's logging.
17417
17418
17419 .option system_filter main string&!! unset
17420 .cindex "filter" "system filter"
17421 .cindex "system filter" "specifying"
17422 .cindex "Sieve filter" "not available for system filter"
17423 This option specifies an Exim filter file that is applied to all messages at
17424 the start of each delivery attempt, before any routing is done. System filters
17425 must be Exim filters; they cannot be Sieve filters. If the system filter
17426 generates any deliveries to files or pipes, or any new mail messages, the
17427 appropriate &%system_filter_..._transport%& option(s) must be set, to define
17428 which transports are to be used. Details of this facility are given in chapter
17429 &<<CHAPsystemfilter>>&.
17430 A forced expansion failure results in no filter operation.
17431
17432
17433 .option system_filter_directory_transport main string&!! unset
17434 .vindex "&$address_file$&"
17435 This sets the name of the transport driver that is to be used when the
17436 &%save%& command in a system message filter specifies a path ending in &"/"&,
17437 implying delivery of each message into a separate file in some directory.
17438 During the delivery, the variable &$address_file$& contains the path name.
17439
17440
17441 .option system_filter_file_transport main string&!! unset
17442 .cindex "file" "transport for system filter"
17443 This sets the name of the transport driver that is to be used when the &%save%&
17444 command in a system message filter specifies a path not ending in &"/"&. During
17445 the delivery, the variable &$address_file$& contains the path name.
17446
17447 .option system_filter_group main string unset
17448 .cindex "gid (group id)" "system filter"
17449 This option is used only when &%system_filter_user%& is also set. It sets the
17450 gid under which the system filter is run, overriding any gid that is associated
17451 with the user. The value may be numerical or symbolic.
17452
17453 .option system_filter_pipe_transport main string&!! unset
17454 .cindex "&(pipe)& transport" "for system filter"
17455 .vindex "&$address_pipe$&"
17456 This specifies the transport driver that is to be used when a &%pipe%& command
17457 is used in a system filter. During the delivery, the variable &$address_pipe$&
17458 contains the pipe command.
17459
17460
17461 .option system_filter_reply_transport main string&!! unset
17462 .cindex "&(autoreply)& transport" "for system filter"
17463 This specifies the transport driver that is to be used when a &%mail%& command
17464 is used in a system filter.
17465
17466
17467 .option system_filter_user main string unset
17468 .cindex "uid (user id)" "system filter"
17469 If this option is set to root, the system filter is run in the main Exim
17470 delivery process, as root.  Otherwise, the system filter runs in a separate
17471 process, as the given user, defaulting to the Exim run-time user.
17472 Unless the string consists entirely of digits, it
17473 is looked up in the password data. Failure to find the named user causes a
17474 configuration error. The gid is either taken from the password data, or
17475 specified by &%system_filter_group%&. When the uid is specified numerically,
17476 &%system_filter_group%& is required to be set.
17477
17478 If the system filter generates any pipe, file, or reply deliveries, the uid
17479 under which the filter is run is used when transporting them, unless a
17480 transport option overrides.
17481
17482
17483 .option tcp_nodelay main boolean true
17484 .cindex "daemon" "TCP_NODELAY on sockets"
17485 .cindex "Nagle algorithm"
17486 .cindex "TCP_NODELAY on listening sockets"
17487 If this option is set false, it stops the Exim daemon setting the
17488 TCP_NODELAY option on its listening sockets. Setting TCP_NODELAY
17489 turns off the &"Nagle algorithm"&, which is a way of improving network
17490 performance in interactive (character-by-character) situations. Turning it off
17491 should improve Exim's performance a bit, so that is what happens by default.
17492 However, it appears that some broken clients cannot cope, and time out. Hence
17493 this option. It affects only those sockets that are set up for listening by the
17494 daemon. Sockets created by the smtp transport for delivering mail always set
17495 TCP_NODELAY.
17496
17497
17498 .option timeout_frozen_after main time 0s
17499 .cindex "frozen messages" "timing out"
17500 .cindex "timeout" "frozen messages"
17501 If &%timeout_frozen_after%& is set to a time greater than zero, a frozen
17502 message of any kind that has been in the queue for longer than the given time
17503 is automatically cancelled at the next queue run. If the frozen message is a
17504 bounce message, it is just discarded; otherwise, a bounce is sent to the
17505 sender, in a similar manner to cancellation by the &%-Mg%& command line option.
17506 If you want to timeout frozen bounce messages earlier than other kinds of
17507 frozen message, see &%ignore_bounce_errors_after%&.
17508
17509 &*Note:*& the default value of zero means no timeouts; with this setting,
17510 frozen messages remain in the queue forever (except for any frozen bounce
17511 messages that are released by &%ignore_bounce_errors_after%&).
17512
17513
17514 .option timezone main string unset
17515 .cindex "timezone, setting"
17516 .cindex "environment" "values from"
17517 The value of &%timezone%& is used to set the environment variable TZ while
17518 running Exim (if it is different on entry). This ensures that all timestamps
17519 created by Exim are in the required timezone. If you want all your timestamps
17520 to be in UTC (aka GMT) you should set
17521 .code
17522 timezone = UTC
17523 .endd
17524 The default value is taken from TIMEZONE_DEFAULT in &_Local/Makefile_&,
17525 or, if that is not set, from the value of the TZ environment variable when Exim
17526 is built. If &%timezone%& is set to the empty string, either at build or run
17527 time, any existing TZ variable is removed from the environment when Exim
17528 runs. This is appropriate behaviour for obtaining wall-clock time on some, but
17529 unfortunately not all, operating systems.
17530
17531
17532 .option tls_advertise_hosts main "host list&!!" *
17533 .cindex "TLS" "advertising"
17534 .cindex "encryption" "on SMTP connection"
17535 .cindex "SMTP" "encrypted connection"
17536 When Exim is built with support for TLS encrypted connections, the availability
17537 of the STARTTLS command to set up an encrypted session is advertised in
17538 response to EHLO only to those client hosts that match this option. See
17539 chapter &<<CHAPTLS>>& for details of Exim's support for TLS.
17540 Note that the default value requires that a certificate be supplied
17541 using the &%tls_certificate%& option.  If TLS support for incoming connections
17542 is not required the &%tls_advertise_hosts%& option should be set empty.
17543
17544
17545 .option tls_certificate main string list&!! unset
17546 .cindex "TLS" "server certificate; location of"
17547 .cindex "certificate" "server, location of"
17548 The value of this option is expanded, and must then be a list of absolute paths to
17549 files which contains the server's certificates.  Commonly only one file is
17550 needed.
17551 The server's private key is also
17552 assumed to be in this file if &%tls_privatekey%& is unset. See chapter
17553 &<<CHAPTLS>>& for further details.
17554
17555 &*Note*&: The certificates defined by this option are used only when Exim is
17556 receiving incoming messages as a server. If you want to supply certificates for
17557 use when sending messages as a client, you must set the &%tls_certificate%&
17558 option in the relevant &(smtp)& transport.
17559
17560 &*Note*&: If you use filenames based on IP addresses, change the list
17561 separator in the usual way (&<<SECTlistsepchange>>&) >to avoid confusion under IPv6.
17562
17563 &*Note*&: Under versions of OpenSSL preceding 1.1.1,
17564 when a list of more than one
17565 file is used, the &$tls_in_ourcert$& variable is unreliable.
17566
17567 &*Note*&: OCSP stapling is not usable under OpenSSL
17568 when a list of more than one file is used.
17569
17570 If the option contains &$tls_out_sni$& and Exim is built against OpenSSL, then
17571 if the OpenSSL build supports TLS extensions and the TLS client sends the
17572 Server Name Indication extension, then this option and others documented in
17573 &<<SECTtlssni>>& will be re-expanded.
17574
17575 If this option is unset or empty a fresh self-signed certificate will be
17576 generated for every connection.
17577
17578 .option tls_crl main string&!! unset
17579 .cindex "TLS" "server certificate revocation list"
17580 .cindex "certificate" "revocation list for server"
17581 This option specifies a certificate revocation list. The expanded value must
17582 be the name of a file that contains CRLs in PEM format.
17583
17584 Under OpenSSL the option can specify a directory with CRL files.
17585
17586 &*Note:*& Under OpenSSL the option must, if given, supply a CRL
17587 for each signing element of the certificate chain (i.e. all but the leaf).
17588 For the file variant this can be multiple PEM blocks in the one file.
17589
17590 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17591
17592
17593 .option tls_dh_max_bits main integer 2236
17594 .cindex "TLS" "D-H bit count"
17595 The number of bits used for Diffie-Hellman key-exchange may be suggested by
17596 the chosen TLS library.  That value might prove to be too high for
17597 interoperability.  This option provides a maximum clamp on the value
17598 suggested, trading off security for interoperability.
17599
17600 The value must be at least 1024.
17601
17602 The value 2236 was chosen because, at time of adding the option, it was the
17603 hard-coded maximum value supported by the NSS cryptographic library, as used
17604 by Thunderbird, while GnuTLS was suggesting 2432 bits as normal.
17605
17606 If you prefer more security and are willing to break some clients, raise this
17607 number.
17608
17609 Note that the value passed to GnuTLS for *generating* a new prime may be a
17610 little less than this figure, because GnuTLS is inexact and may produce a
17611 larger prime than requested.
17612
17613
17614 .option tls_dhparam main string&!! unset
17615 .cindex "TLS" "D-H parameters for server"
17616 The value of this option is expanded and indicates the source of DH parameters
17617 to be used by Exim.
17618
17619 &*Note: The Exim Maintainers strongly recommend using a filename with site-generated
17620 local DH parameters*&, which has been supported across all versions of Exim.  The
17621 other specific constants available are a fallback so that even when
17622 "unconfigured", Exim can offer Perfect Forward Secrecy in older ciphersuites in TLS.
17623
17624 If &%tls_dhparam%& is a filename starting with a &`/`&,
17625 then it names a file from which DH
17626 parameters should be loaded.  If the file exists, it should hold a PEM-encoded
17627 PKCS#3 representation of the DH prime.  If the file does not exist, for
17628 OpenSSL it is an error.  For GnuTLS, Exim will attempt to create the file and
17629 fill it with a generated DH prime.  For OpenSSL, if the DH bit-count from
17630 loading the file is greater than &%tls_dh_max_bits%& then it will be ignored,
17631 and treated as though the &%tls_dhparam%& were set to "none".
17632
17633 If this option expands to the string "none", then no DH parameters will be
17634 loaded by Exim.
17635
17636 If this option expands to the string "historic" and Exim is using GnuTLS, then
17637 Exim will attempt to load a file from inside the spool directory.  If the file
17638 does not exist, Exim will attempt to create it.
17639 See section &<<SECTgnutlsparam>>& for further details.
17640
17641 If Exim is using OpenSSL and this option is empty or unset, then Exim will load
17642 a default DH prime; the default is Exim-specific but lacks verifiable provenance.
17643
17644 In older versions of Exim the default was the 2048 bit prime described in section
17645 2.2 of RFC 5114, "2048-bit MODP Group with 224-bit Prime Order Subgroup", which
17646 in IKE is assigned number 23.
17647
17648 Otherwise, the option must expand to the name used by Exim for any of a number
17649 of DH primes specified in RFC 2409, RFC 3526, RFC 5114, RFC 7919, or from other
17650 sources.  As names, Exim uses a standard specified name, else "ike" followed by
17651 the number used by IKE, or "default" which corresponds to
17652 &`exim.dev.20160529.3`&.
17653
17654 The available standard primes are:
17655 &`ffdhe2048`&, &`ffdhe3072`&, &`ffdhe4096`&, &`ffdhe6144`&, &`ffdhe8192`&,
17656 &`ike1`&, &`ike2`&, &`ike5`&,
17657 &`ike14`&, &`ike15`&, &`ike16`&, &`ike17`&, &`ike18`&,
17658 &`ike22`&, &`ike23`& and &`ike24`&.
17659
17660 The available additional primes are:
17661 &`exim.dev.20160529.1`&, &`exim.dev.20160529.2`& and &`exim.dev.20160529.3`&.
17662
17663 Some of these will be too small to be accepted by clients.
17664 Some may be too large to be accepted by clients.
17665 The open cryptographic community has suspicions about the integrity of some
17666 of the later IKE values, which led into RFC7919 providing new fixed constants
17667 (the "ffdhe" identifiers).
17668
17669 At this point, all of the "ike" values should be considered obsolete;
17670 they're still in Exim to avoid breaking unusual configurations, but are
17671 candidates for removal the next time we have backwards-incompatible changes.
17672
17673 The TLS protocol does not negotiate an acceptable size for this; clients tend
17674 to hard-drop connections if what is offered by the server is unacceptable,
17675 whether too large or too small, and there's no provision for the client to
17676 tell the server what these constraints are.  Thus, as a server operator, you
17677 need to make an educated guess as to what is most likely to work for your
17678 userbase.
17679
17680 Some known size constraints suggest that a bit-size in the range 2048 to 2236
17681 is most likely to maximise interoperability.  The upper bound comes from
17682 applications using the Mozilla Network Security Services (NSS) library, which
17683 used to set its &`DH_MAX_P_BITS`& upper-bound to 2236.  This affects many
17684 mail user agents (MUAs). The lower bound comes from Debian installs of Exim4
17685 prior to the 4.80 release, as Debian used to patch Exim to raise the minimum
17686 acceptable bound from 1024 to 2048.
17687
17688
17689 .option tls_eccurve main string&!! &`auto`&
17690 .cindex TLS "EC cryptography"
17691 This option selects a EC curve for use by Exim when used with OpenSSL.
17692 It has no effect when Exim is used with GnuTLS.
17693
17694 After expansion it must contain a valid EC curve parameter, such as
17695 &`prime256v1`&, &`secp384r1`&, or &`P-512`&. Consult your OpenSSL manual
17696 for valid selections.
17697
17698 For OpenSSL versions before (and not including) 1.0.2, the string
17699 &`auto`& selects &`prime256v1`&. For more recent OpenSSL versions
17700 &`auto`& tells the library to choose.
17701
17702 If the option expands to an empty string, no EC curves will be enabled.
17703
17704
17705 .option tls_ocsp_file main string&!! unset
17706 .cindex TLS "certificate status"
17707 .cindex TLS "OCSP proof file"
17708 This option
17709 must if set expand to the absolute path to a file which contains a current
17710 status proof for the server's certificate, as obtained from the
17711 Certificate Authority.
17712
17713 Usable for GnuTLS 3.4.4 or 3.3.17 or OpenSSL 1.1.0 (or later).
17714
17715 For GnuTLS 3.5.6 or later the expanded value of this option can be a list
17716 of files, to match a list given for the &%tls_certificate%& option.
17717 The ordering of the two lists must match.
17718
17719
17720 .option tls_on_connect_ports main "string list" unset
17721 .cindex SSMTP
17722 .cindex SMTPS
17723 This option specifies a list of incoming SSMTP (aka SMTPS) ports that should
17724 operate the SSMTP (SMTPS) protocol, where a TLS session is immediately
17725 set up without waiting for the client to issue a STARTTLS command. For
17726 further details, see section &<<SECTsupobssmt>>&.
17727
17728
17729
17730 .option tls_privatekey main string list&!! unset
17731 .cindex "TLS" "server private key; location of"
17732 The value of this option is expanded, and must then be a list of absolute paths to
17733 files which contains the server's private keys.
17734 If this option is unset, or if
17735 the expansion is forced to fail, or the result is an empty string, the private
17736 key is assumed to be in the same file as the server's certificates. See chapter
17737 &<<CHAPTLS>>& for further details.
17738
17739 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17740
17741
17742 .option tls_remember_esmtp main boolean false
17743 .cindex "TLS" "esmtp state; remembering"
17744 .cindex "TLS" "broken clients"
17745 If this option is set true, Exim violates the RFCs by remembering that it is in
17746 &"esmtp"& state after successfully negotiating a TLS session. This provides
17747 support for broken clients that fail to send a new EHLO after starting a
17748 TLS session.
17749
17750
17751 .option tls_require_ciphers main string&!! unset
17752 .cindex "TLS" "requiring specific ciphers"
17753 .cindex "cipher" "requiring specific"
17754 This option controls which ciphers can be used for incoming TLS connections.
17755 The &(smtp)& transport has an option of the same name for controlling outgoing
17756 connections. This option is expanded for each connection, so can be varied for
17757 different clients if required. The value of this option must be a list of
17758 permitted cipher suites. The OpenSSL and GnuTLS libraries handle cipher control
17759 in somewhat different ways. If GnuTLS is being used, the client controls the
17760 preference order of the available ciphers. Details are given in sections
17761 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
17762
17763
17764 .option tls_try_verify_hosts main "host list&!!" unset
17765 .cindex "TLS" "client certificate verification"
17766 .cindex "certificate" "verification of client"
17767 See &%tls_verify_hosts%& below.
17768
17769
17770 .option tls_verify_certificates main string&!! system
17771 .cindex "TLS" "client certificate verification"
17772 .cindex "certificate" "verification of client"
17773 The value of this option is expanded, and must then be either the
17774 word "system"
17775 or the absolute path to
17776 a file or directory containing permitted certificates for clients that
17777 match &%tls_verify_hosts%& or &%tls_try_verify_hosts%&.
17778
17779 The "system" value for the option will use a
17780 system default location compiled into the SSL library.
17781 This is not available for GnuTLS versions preceding 3.0.20,
17782 and will be taken as empty; an explicit location
17783 must be specified.
17784
17785 The use of a directory for the option value is not available for GnuTLS versions
17786 preceding 3.3.6 and a single file must be used.
17787
17788 With OpenSSL the certificates specified
17789 explicitly
17790 either by file or directory
17791 are added to those given by the system default location.
17792
17793 These certificates should be for the certificate authorities trusted, rather
17794 than the public cert of individual clients.  With both OpenSSL and GnuTLS, if
17795 the value is a file then the certificates are sent by Exim as a server to
17796 connecting clients, defining the list of accepted certificate authorities.
17797 Thus the values defined should be considered public data.  To avoid this,
17798 use the explicit directory version.
17799
17800 See &<<SECTtlssni>>& for discussion of when this option might be re-expanded.
17801
17802 A forced expansion failure or setting to an empty string is equivalent to
17803 being unset.
17804
17805
17806 .option tls_verify_hosts main "host list&!!" unset
17807 .cindex "TLS" "client certificate verification"
17808 .cindex "certificate" "verification of client"
17809 This option, along with &%tls_try_verify_hosts%&, controls the checking of
17810 certificates from clients. The expected certificates are defined by
17811 &%tls_verify_certificates%&, which must be set. A configuration error occurs if
17812 either &%tls_verify_hosts%& or &%tls_try_verify_hosts%& is set and
17813 &%tls_verify_certificates%& is not set.
17814
17815 Any client that matches &%tls_verify_hosts%& is constrained by
17816 &%tls_verify_certificates%&. When the client initiates a TLS session, it must
17817 present one of the listed certificates. If it does not, the connection is
17818 aborted. &*Warning*&: Including a host in &%tls_verify_hosts%& does not require
17819 the host to use TLS. It can still send SMTP commands through unencrypted
17820 connections. Forcing a client to use TLS has to be done separately using an
17821 ACL to reject inappropriate commands when the connection is not encrypted.
17822
17823 A weaker form of checking is provided by &%tls_try_verify_hosts%&. If a client
17824 matches this option (but not &%tls_verify_hosts%&), Exim requests a
17825 certificate and checks it against &%tls_verify_certificates%&, but does not
17826 abort the connection if there is no certificate or if it does not match. This
17827 state can be detected in an ACL, which makes it possible to implement policies
17828 such as &"accept for relay only if a verified certificate has been received,
17829 but accept for local delivery if encrypted, even without a verified
17830 certificate"&.
17831
17832 Client hosts that match neither of these lists are not asked to present
17833 certificates.
17834
17835
17836 .option trusted_groups main "string list&!!" unset
17837 .cindex "trusted groups"
17838 .cindex "groups" "trusted"
17839 This option is expanded just once, at the start of Exim's processing. If this
17840 option is set, any process that is running in one of the listed groups, or
17841 which has one of them as a supplementary group, is trusted. The groups can be
17842 specified numerically or by name. See section &<<SECTtrustedadmin>>& for
17843 details of what trusted callers are permitted to do. If neither
17844 &%trusted_groups%& nor &%trusted_users%& is set, only root and the Exim user
17845 are trusted.
17846
17847 .option trusted_users main "string list&!!" unset
17848 .cindex "trusted users"
17849 .cindex "user" "trusted"
17850 This option is expanded just once, at the start of Exim's processing. If this
17851 option is set, any process that is running as one of the listed users is
17852 trusted. The users can be specified numerically or by name. See section
17853 &<<SECTtrustedadmin>>& for details of what trusted callers are permitted to do.
17854 If neither &%trusted_groups%& nor &%trusted_users%& is set, only root and the
17855 Exim user are trusted.
17856
17857 .option unknown_login main string&!! unset
17858 .cindex "uid (user id)" "unknown caller"
17859 .vindex "&$caller_uid$&"
17860 This is a specialized feature for use in unusual configurations. By default, if
17861 the uid of the caller of Exim cannot be looked up using &[getpwuid()]&, Exim
17862 gives up. The &%unknown_login%& option can be used to set a login name to be
17863 used in this circumstance. It is expanded, so values like &%user$caller_uid%&
17864 can be set. When &%unknown_login%& is used, the value of &%unknown_username%&
17865 is used for the user's real name (gecos field), unless this has been set by the
17866 &%-F%& option.
17867
17868 .option unknown_username main string unset
17869 See &%unknown_login%&.
17870
17871 .option untrusted_set_sender main "address list&!!" unset
17872 .cindex "trusted users"
17873 .cindex "sender" "setting by untrusted user"
17874 .cindex "untrusted user setting sender"
17875 .cindex "user" "untrusted setting sender"
17876 .cindex "envelope sender"
17877 When an untrusted user submits a message to Exim using the standard input, Exim
17878 normally creates an envelope sender address from the user's login and the
17879 default qualification domain. Data from the &%-f%& option (for setting envelope
17880 senders on non-SMTP messages) or the SMTP MAIL command (if &%-bs%& or &%-bS%&
17881 is used) is ignored.
17882
17883 However, untrusted users are permitted to set an empty envelope sender address,
17884 to declare that a message should never generate any bounces. For example:
17885 .code
17886 exim -f '<>' user@domain.example
17887 .endd
17888 .vindex "&$sender_ident$&"
17889 The &%untrusted_set_sender%& option allows you to permit untrusted users to set
17890 other envelope sender addresses in a controlled way. When it is set, untrusted
17891 users are allowed to set envelope sender addresses that match any of the
17892 patterns in the list. Like all address lists, the string is expanded. The
17893 identity of the user is in &$sender_ident$&, so you can, for example, restrict
17894 users to setting senders that start with their login ids
17895 followed by a hyphen
17896 by a setting like this:
17897 .code
17898 untrusted_set_sender = ^$sender_ident-
17899 .endd
17900 If you want to allow untrusted users to set envelope sender addresses without
17901 restriction, you can use
17902 .code
17903 untrusted_set_sender = *
17904 .endd
17905 The &%untrusted_set_sender%& option applies to all forms of local input, but
17906 only to the setting of the envelope sender. It does not permit untrusted users
17907 to use the other options which trusted user can use to override message
17908 parameters. Furthermore, it does not stop Exim from removing an existing
17909 &'Sender:'& header in the message, or from adding a &'Sender:'& header if
17910 necessary. See &%local_sender_retain%& and &%local_from_check%& for ways of
17911 overriding these actions. The handling of the &'Sender:'& header is also
17912 described in section &<<SECTthesenhea>>&.
17913
17914 The log line for a message's arrival shows the envelope sender following
17915 &"<="&. For local messages, the user's login always follows, after &"U="&. In
17916 &%-bp%& displays, and in the Exim monitor, if an untrusted user sets an
17917 envelope sender address, the user's login is shown in parentheses after the
17918 sender address.
17919
17920
17921 .option uucp_from_pattern main string "see below"
17922 .cindex "&""From""& line"
17923 .cindex "UUCP" "&""From""& line"
17924 Some applications that pass messages to an MTA via a command line interface use
17925 an initial line starting with &"From&~"& to pass the envelope sender. In
17926 particular, this is used by UUCP software. Exim recognizes such a line by means
17927 of a regular expression that is set in &%uucp_from_pattern%&. When the pattern
17928 matches, the sender address is constructed by expanding the contents of
17929 &%uucp_from_sender%&, provided that the caller of Exim is a trusted user. The
17930 default pattern recognizes lines in the following two forms:
17931 .code
17932 From ph10 Fri Jan  5 12:35 GMT 1996
17933 From ph10 Fri, 7 Jan 97 14:00:00 GMT
17934 .endd
17935 The pattern can be seen by running
17936 .code
17937 exim -bP uucp_from_pattern
17938 .endd
17939 It checks only up to the hours and minutes, and allows for a 2-digit or 4-digit
17940 year in the second case. The first word after &"From&~"& is matched in the
17941 regular expression by a parenthesized subpattern. The default value for
17942 &%uucp_from_sender%& is &"$1"&, which therefore just uses this first word
17943 (&"ph10"& in the example above) as the message's sender. See also
17944 &%ignore_fromline_hosts%&.
17945
17946
17947 .option uucp_from_sender main string&!! &`$1`&
17948 See &%uucp_from_pattern%& above.
17949
17950
17951 .option warn_message_file main string unset
17952 .cindex "warning of delay" "customizing the message"
17953 .cindex "customizing" "warning message"
17954 This option defines a template file containing paragraphs of text to be used
17955 for constructing the warning message which is sent by Exim when a message has
17956 been in the queue for a specified amount of time, as specified by
17957 &%delay_warning%&. Details of the file's contents are given in chapter
17958 &<<CHAPemsgcust>>&. See also &%bounce_message_file%&.
17959
17960
17961 .option write_rejectlog main boolean true
17962 .cindex "reject log" "disabling"
17963 If this option is set false, Exim no longer writes anything to the reject log.
17964 See chapter &<<CHAPlog>>& for details of what Exim writes to its logs.
17965 .ecindex IIDconfima
17966 .ecindex IIDmaiconf
17967
17968
17969
17970
17971 . ////////////////////////////////////////////////////////////////////////////
17972 . ////////////////////////////////////////////////////////////////////////////
17973
17974 .chapter "Generic options for routers" "CHAProutergeneric"
17975 .scindex IIDgenoprou1 "options" "generic; for routers"
17976 .scindex IIDgenoprou2 "generic options" "router"
17977 This chapter describes the generic options that apply to all routers.
17978 Those that are preconditions are marked with &Dagger; in the &"use"& field.
17979
17980 For a general description of how a router operates, see sections
17981 &<<SECTrunindrou>>& and &<<SECTrouprecon>>&. The latter specifies the order in
17982 which the preconditions are tested. The order of expansion of the options that
17983 provide data for a transport is: &%errors_to%&, &%headers_add%&,
17984 &%headers_remove%&, &%transport%&.
17985
17986
17987
17988 .option address_data routers string&!! unset
17989 .cindex "router" "data attached to address"
17990 The string is expanded just before the router is run, that is, after all the
17991 precondition tests have succeeded. If the expansion is forced to fail, the
17992 router declines, the value of &%address_data%& remains unchanged, and the
17993 &%more%& option controls what happens next. Other expansion failures cause
17994 delivery of the address to be deferred.
17995
17996 .vindex "&$address_data$&"
17997 When the expansion succeeds, the value is retained with the address, and can be
17998 accessed using the variable &$address_data$& in the current router, subsequent
17999 routers, and the eventual transport.
18000
18001 &*Warning*&: If the current or any subsequent router is a &(redirect)& router
18002 that runs a user's filter file, the contents of &$address_data$& are accessible
18003 in the filter. This is not normally a problem, because such data is usually
18004 either not confidential or it &"belongs"& to the current user, but if you do
18005 put confidential data into &$address_data$& you need to remember this point.
18006
18007 Even if the router declines or passes, the value of &$address_data$& remains
18008 with the address, though it can be changed by another &%address_data%& setting
18009 on a subsequent router. If a router generates child addresses, the value of
18010 &$address_data$& propagates to them. This also applies to the special kind of
18011 &"child"& that is generated by a router with the &%unseen%& option.
18012
18013 The idea of &%address_data%& is that you can use it to look up a lot of data
18014 for the address once, and then pick out parts of the data later. For example,
18015 you could use a single LDAP lookup to return a string of the form
18016 .code
18017 uid=1234 gid=5678 mailbox=/mail/xyz forward=/home/xyz/.forward
18018 .endd
18019 In the transport you could pick out the mailbox by a setting such as
18020 .code
18021 file = ${extract{mailbox}{$address_data}}
18022 .endd
18023 This makes the configuration file less messy, and also reduces the number of
18024 lookups (though Exim does cache lookups).
18025
18026 .vindex "&$sender_address_data$&"
18027 .vindex "&$address_data$&"
18028 The &%address_data%& facility is also useful as a means of passing information
18029 from one router to another, and from a router to a transport. In addition, if
18030 &$address_data$& is set by a router when verifying a recipient address from an
18031 ACL, it remains available for use in the rest of the ACL statement. After
18032 verifying a sender, the value is transferred to &$sender_address_data$&.
18033
18034
18035
18036 .option address_test routers&!? boolean true
18037 .oindex "&%-bt%&"
18038 .cindex "router" "skipping when address testing"
18039 If this option is set false, the router is skipped when routing is being tested
18040 by means of the &%-bt%& command line option. This can be a convenience when
18041 your first router sends messages to an external scanner, because it saves you
18042 having to set the &"already scanned"& indicator when testing real address
18043 routing.
18044
18045
18046
18047 .option cannot_route_message routers string&!! unset
18048 .cindex "router" "customizing &""cannot route""& message"
18049 .cindex "customizing" "&""cannot route""& message"
18050 This option specifies a text message that is used when an address cannot be
18051 routed because Exim has run out of routers. The default message is
18052 &"Unrouteable address"&. This option is useful only on routers that have
18053 &%more%& set false, or on the very last router in a configuration, because the
18054 value that is used is taken from the last router that is considered. This
18055 includes a router that is skipped because its preconditions are not met, as
18056 well as a router that declines. For example, using the default configuration,
18057 you could put:
18058 .code
18059 cannot_route_message = Remote domain not found in DNS
18060 .endd
18061 on the first router, which is a &(dnslookup)& router with &%more%& set false,
18062 and
18063 .code
18064 cannot_route_message = Unknown local user
18065 .endd
18066 on the final router that checks for local users. If string expansion fails for
18067 this option, the default message is used. Unless the expansion failure was
18068 explicitly forced, a message about the failure is written to the main and panic
18069 logs, in addition to the normal message about the routing failure.
18070
18071
18072 .option caseful_local_part routers boolean false
18073 .cindex "case of local parts"
18074 .cindex "router" "case of local parts"
18075 By default, routers handle the local parts of addresses in a case-insensitive
18076 manner, though the actual case is preserved for transmission with the message.
18077 If you want the case of letters to be significant in a router, you must set
18078 this option true. For individual router options that contain address or local
18079 part lists (for example, &%local_parts%&), case-sensitive matching can be
18080 turned on by &"+caseful"& as a list item. See section &<<SECTcasletadd>>& for
18081 more details.
18082
18083 .vindex "&$local_part$&"
18084 .vindex "&$original_local_part$&"
18085 .vindex "&$parent_local_part$&"
18086 The value of the &$local_part$& variable is forced to lower case while a
18087 router is running unless &%caseful_local_part%& is set. When a router assigns
18088 an address to a transport, the value of &$local_part$& when the transport runs
18089 is the same as it was in the router. Similarly, when a router generates child
18090 addresses by aliasing or forwarding, the values of &$original_local_part$&
18091 and &$parent_local_part$& are those that were used by the redirecting router.
18092
18093 This option applies to the processing of an address by a router. When a
18094 recipient address is being processed in an ACL, there is a separate &%control%&
18095 modifier that can be used to specify case-sensitive processing within the ACL
18096 (see section &<<SECTcontrols>>&).
18097
18098
18099
18100 .option check_local_user routers&!? boolean false
18101 .cindex "local user, checking in router"
18102 .cindex "router" "checking for local user"
18103 .cindex "&_/etc/passwd_&"
18104 .vindex "&$home$&"
18105 When this option is true, Exim checks that the local part of the recipient
18106 address (with affixes removed if relevant) is the name of an account on the
18107 local system. The check is done by calling the &[getpwnam()]& function rather
18108 than trying to read &_/etc/passwd_& directly. This means that other methods of
18109 holding password data (such as NIS) are supported. If the local part is a local
18110 user, &$home$& is set from the password data, and can be tested in other
18111 preconditions that are evaluated after this one (the order of evaluation is
18112 given in section &<<SECTrouprecon>>&). However, the value of &$home$& can be
18113 overridden by &%router_home_directory%&. If the local part is not a local user,
18114 the router is skipped.
18115
18116 If you want to check that the local part is either the name of a local user
18117 or matches something else, you cannot combine &%check_local_user%& with a
18118 setting of &%local_parts%&, because that specifies the logical &'and'& of the
18119 two conditions. However, you can use a &(passwd)& lookup in a &%local_parts%&
18120 setting to achieve this. For example:
18121 .code
18122 local_parts = passwd;$local_part : lsearch;/etc/other/users
18123 .endd
18124 Note, however, that the side effects of &%check_local_user%& (such as setting
18125 up a home directory) do not occur when a &(passwd)& lookup is used in a
18126 &%local_parts%& (or any other) precondition.
18127
18128
18129
18130 .option condition routers&!? string&!! unset
18131 .cindex "router" "customized precondition"
18132 This option specifies a general precondition test that has to succeed for the
18133 router to be called. The &%condition%& option is the last precondition to be
18134 evaluated (see section &<<SECTrouprecon>>&). The string is expanded, and if the
18135 result is a forced failure, or an empty string, or one of the strings &"0"& or
18136 &"no"& or &"false"& (checked without regard to the case of the letters), the
18137 router is skipped, and the address is offered to the next one.
18138
18139 If the result is any other value, the router is run (as this is the last
18140 precondition to be evaluated, all the other preconditions must be true).
18141
18142 This option is unusual in that multiple &%condition%& options may be present.
18143 All &%condition%& options must succeed.
18144
18145 The &%condition%& option provides a means of applying custom conditions to the
18146 running of routers. Note that in the case of a simple conditional expansion,
18147 the default expansion values are exactly what is wanted. For example:
18148 .code
18149 condition = ${if >{$message_age}{600}}
18150 .endd
18151 Because of the default behaviour of the string expansion, this is equivalent to
18152 .code
18153 condition = ${if >{$message_age}{600}{true}{}}
18154 .endd
18155
18156 A multiple condition example, which succeeds:
18157 .code
18158 condition = ${if >{$message_age}{600}}
18159 condition = ${if !eq{${lc:$local_part}}{postmaster}}
18160 condition = foobar
18161 .endd
18162
18163 If the expansion fails (other than forced failure) delivery is deferred. Some
18164 of the other precondition options are common special cases that could in fact
18165 be specified using &%condition%&.
18166
18167 Historical note: We have &%condition%& on ACLs and on Routers.  Routers
18168 are far older, and use one set of semantics.  ACLs are newer and when
18169 they were created, the ACL &%condition%& process was given far stricter
18170 parse semantics.  The &%bool{}%& expansion condition uses the same rules as
18171 ACLs.  The &%bool_lax{}%& expansion condition uses the same rules as
18172 Routers.  More pointedly, the &%bool_lax{}%& was written to match the existing
18173 Router rules processing behavior.
18174
18175 This is best illustrated in an example:
18176 .code
18177 # If used in an ACL condition will fail with a syntax error, but
18178 # in a router condition any extra characters are treated as a string
18179
18180 $ exim -be '${if eq {${lc:GOOGLE.com}} {google.com}} {yes} {no}}'
18181 true {yes} {no}}
18182
18183 $ exim -be '${if eq {${lc:WHOIS.com}} {google.com}} {yes} {no}}'
18184  {yes} {no}}
18185 .endd
18186 In each example above, the &%if%& statement actually ends after
18187 &"{google.com}}"&.  Since no true or false braces were defined, the
18188 default &%if%& behavior is to return a boolean true or a null answer
18189 (which evaluates to false). The rest of the line is then treated as a
18190 string. So the first example resulted in the boolean answer &"true"&
18191 with the string &" {yes} {no}}"& appended to it. The second example
18192 resulted in the null output (indicating false) with the string
18193 &" {yes} {no}}"& appended to it.
18194
18195 In fact you can put excess forward braces in too.  In the router
18196 &%condition%&, Exim's parser only looks for &"{"& symbols when they
18197 mean something, like after a &"$"& or when required as part of a
18198 conditional.  But otherwise &"{"& and &"}"& are treated as ordinary
18199 string characters.
18200
18201 Thus, in a Router, the above expansion strings will both always evaluate
18202 true, as the result of expansion is a non-empty string which doesn't
18203 match an explicit false value.  This can be tricky to debug.  By
18204 contrast, in an ACL either of those strings will always result in an
18205 expansion error because the result doesn't look sufficiently boolean.
18206
18207
18208 .option debug_print routers string&!! unset
18209 .cindex "testing" "variables in drivers"
18210 If this option is set and debugging is enabled (see the &%-d%& command line
18211 option) or in address-testing mode (see the &%-bt%& command line option),
18212 the string is expanded and included in the debugging output.
18213 If expansion of the string fails, the error message is written to the debugging
18214 output, and Exim carries on processing.
18215 This option is provided to help with checking out the values of variables and
18216 so on when debugging router configurations. For example, if a &%condition%&
18217 option appears not to be working, &%debug_print%& can be used to output the
18218 variables it references. The output happens after checks for &%domains%&,
18219 &%local_parts%&, and &%check_local_user%& but before any other preconditions
18220 are tested. A newline is added to the text if it does not end with one.
18221 The variable &$router_name$& contains the name of the router.
18222
18223
18224
18225 .option disable_logging routers boolean false
18226 If this option is set true, nothing is logged for any routing errors
18227 or for any deliveries caused by this router. You should not set this option
18228 unless you really, really know what you are doing. See also the generic
18229 transport option of the same name.
18230
18231 .option dnssec_request_domains routers "domain list&!!" unset
18232 .cindex "MX record" "security"
18233 .cindex "DNSSEC" "MX lookup"
18234 .cindex "security" "MX lookup"
18235 .cindex "DNS" "DNSSEC"
18236 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
18237 the dnssec request bit set.
18238 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18239
18240 .option dnssec_require_domains routers "domain list&!!" unset
18241 .cindex "MX record" "security"
18242 .cindex "DNSSEC" "MX lookup"
18243 .cindex "security" "MX lookup"
18244 .cindex "DNS" "DNSSEC"
18245 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
18246 the dnssec request bit set.  Any returns not having the Authenticated Data bit
18247 (AD bit) set will be ignored and logged as a host-lookup failure.
18248 This applies to all of the SRV, MX, AAAA, A lookup sequence.
18249
18250
18251 .option domains routers&!? "domain list&!!" unset
18252 .cindex "router" "restricting to specific domains"
18253 .vindex "&$domain_data$&"
18254 If this option is set, the router is skipped unless the current domain matches
18255 the list. If the match is achieved by means of a file lookup, the data that the
18256 lookup returned for the domain is placed in &$domain_data$& for use in string
18257 expansions of the driver's private options. See section &<<SECTrouprecon>>& for
18258 a list of the order in which preconditions are evaluated.
18259
18260
18261
18262 .option driver routers string unset
18263 This option must always be set. It specifies which of the available routers is
18264 to be used.
18265
18266
18267 .option dsn_lasthop routers boolean false
18268 .cindex "DSN" "success"
18269 .cindex "Delivery Status Notification" "success"
18270 If this option is set true, and extended DSN (RFC3461) processing is in effect,
18271 Exim will not pass on DSN requests to downstream DSN-aware hosts but will
18272 instead send a success DSN as if the next hop does not support DSN.
18273 Not effective on redirect routers.
18274
18275
18276
18277 .option errors_to routers string&!! unset
18278 .cindex "envelope sender"
18279 .cindex "router" "changing address for errors"
18280 If a router successfully handles an address, it may assign the address to a
18281 transport for delivery or it may generate child addresses. In both cases, if
18282 there is a delivery problem during later processing, the resulting bounce
18283 message is sent to the address that results from expanding this string,
18284 provided that the address verifies successfully. The &%errors_to%& option is
18285 expanded before &%headers_add%&, &%headers_remove%&, and &%transport%&.
18286
18287 The &%errors_to%& setting associated with an address can be overridden if it
18288 subsequently passes through other routers that have their own &%errors_to%&
18289 settings, or if the message is delivered by a transport with a &%return_path%&
18290 setting.
18291
18292 If &%errors_to%& is unset, or the expansion is forced to fail, or the result of
18293 the expansion fails to verify, the errors address associated with the incoming
18294 address is used. At top level, this is the envelope sender. A non-forced
18295 expansion failure causes delivery to be deferred.
18296
18297 If an address for which &%errors_to%& has been set ends up being delivered over
18298 SMTP, the envelope sender for that delivery is the &%errors_to%& value, so that
18299 any bounces that are generated by other MTAs on the delivery route are also
18300 sent there. You can set &%errors_to%& to the empty string by either of these
18301 settings:
18302 .code
18303 errors_to =
18304 errors_to = ""
18305 .endd
18306 An expansion item that yields an empty string has the same effect. If you do
18307 this, a locally detected delivery error for addresses processed by this router
18308 no longer gives rise to a bounce message; the error is discarded. If the
18309 address is delivered to a remote host, the return path is set to &`<>`&, unless
18310 overridden by the &%return_path%& option on the transport.
18311
18312 .vindex "&$address_data$&"
18313 If for some reason you want to discard local errors, but use a non-empty
18314 MAIL command for remote delivery, you can preserve the original return
18315 path in &$address_data$& in the router, and reinstate it in the transport by
18316 setting &%return_path%&.
18317
18318 The most common use of &%errors_to%& is to direct mailing list bounces to the
18319 manager of the list, as described in section &<<SECTmailinglists>>&, or to
18320 implement VERP (Variable Envelope Return Paths) (see section &<<SECTverp>>&).
18321
18322
18323
18324 .option expn routers&!? boolean true
18325 .cindex "address" "testing"
18326 .cindex "testing" "addresses"
18327 .cindex "EXPN" "router skipping"
18328 .cindex "router" "skipping for EXPN"
18329 If this option is turned off, the router is skipped when testing an address
18330 as a result of processing an SMTP EXPN command. You might, for example,
18331 want to turn it off on a router for users' &_.forward_& files, while leaving it
18332 on for the system alias file.
18333 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18334 are evaluated.
18335
18336 The use of the SMTP EXPN command is controlled by an ACL (see chapter
18337 &<<CHAPACL>>&). When Exim is running an EXPN command, it is similar to testing
18338 an address with &%-bt%&. Compare VRFY, whose counterpart is &%-bv%&.
18339
18340
18341
18342 .option fail_verify routers boolean false
18343 .cindex "router" "forcing verification failure"
18344 Setting this option has the effect of setting both &%fail_verify_sender%& and
18345 &%fail_verify_recipient%& to the same value.
18346
18347
18348
18349 .option fail_verify_recipient routers boolean false
18350 If this option is true and an address is accepted by this router when
18351 verifying a recipient, verification fails.
18352
18353
18354
18355 .option fail_verify_sender routers boolean false
18356 If this option is true and an address is accepted by this router when
18357 verifying a sender, verification fails.
18358
18359
18360
18361 .option fallback_hosts routers "string list" unset
18362 .cindex "router" "fallback hosts"
18363 .cindex "fallback" "hosts specified on router"
18364 String expansion is not applied to this option. The argument must be a
18365 colon-separated list of host names or IP addresses. The list separator can be
18366 changed (see section &<<SECTlistsepchange>>&), and a port can be specified with
18367 each name or address. In fact, the format of each item is exactly the same as
18368 defined for the list of hosts in a &(manualroute)& router (see section
18369 &<<SECTformatonehostitem>>&).
18370
18371 If a router queues an address for a remote transport, this host list is
18372 associated with the address, and used instead of the transport's fallback host
18373 list. If &%hosts_randomize%& is set on the transport, the order of the list is
18374 randomized for each use. See the &%fallback_hosts%& option of the &(smtp)&
18375 transport for further details.
18376
18377
18378 .option group routers string&!! "see below"
18379 .cindex "gid (group id)" "local delivery"
18380 .cindex "local transports" "uid and gid"
18381 .cindex "transport" "local"
18382 .cindex "router" "setting group"
18383 When a router queues an address for a transport, and the transport does not
18384 specify a group, the group given here is used when running the delivery
18385 process.
18386 The group may be specified numerically or by name. If expansion fails, the
18387 error is logged and delivery is deferred.
18388 The default is unset, unless &%check_local_user%& is set, when the default
18389 is taken from the password information. See also &%initgroups%& and &%user%&
18390 and the discussion in chapter &<<CHAPenvironment>>&.
18391
18392
18393
18394 .option headers_add routers list&!! unset
18395 .cindex "header lines" "adding"
18396 .cindex "router" "adding header lines"
18397 This option specifies a list of text headers,
18398 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18399 that is associated with any addresses that are accepted by the router.
18400 Each item is separately expanded, at routing time.  However, this
18401 option has no effect when an address is just being verified. The way in which
18402 the text is used to add header lines at transport time is described in section
18403 &<<SECTheadersaddrem>>&. New header lines are not actually added until the
18404 message is in the process of being transported. This means that references to
18405 header lines in string expansions in the transport's configuration do not
18406 &"see"& the added header lines.
18407
18408 The &%headers_add%& option is expanded after &%errors_to%&, but before
18409 &%headers_remove%& and &%transport%&. If an item is empty, or if
18410 an item expansion is forced to fail, the item has no effect. Other expansion
18411 failures are treated as configuration errors.
18412
18413 Unlike most options, &%headers_add%& can be specified multiple times
18414 for a router; all listed headers are added.
18415
18416 &*Warning 1*&: The &%headers_add%& option cannot be used for a &(redirect)&
18417 router that has the &%one_time%& option set.
18418
18419 .cindex "duplicate addresses"
18420 .oindex "&%unseen%&"
18421 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18422 additions are deleted when the address is passed on to subsequent routers.
18423 For a &%redirect%& router, if a generated address is the same as the incoming
18424 address, this can lead to duplicate addresses with different header
18425 modifications. Exim does not do duplicate deliveries (except, in certain
18426 circumstances, to pipes -- see section &<<SECTdupaddr>>&), but it is undefined
18427 which of the duplicates is discarded, so this ambiguous situation should be
18428 avoided. The &%repeat_use%& option of the &%redirect%& router may be of help.
18429
18430
18431
18432 .option headers_remove routers list&!! unset
18433 .cindex "header lines" "removing"
18434 .cindex "router" "removing header lines"
18435 This option specifies a list of text headers,
18436 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
18437 that is associated with any addresses that are accepted by the router.
18438 Each item is separately expanded, at routing time.  However, this
18439 option has no effect when an address is just being verified. The way in which
18440 the text is used to remove header lines at transport time is described in
18441 section &<<SECTheadersaddrem>>&. Header lines are not actually removed until
18442 the message is in the process of being transported. This means that references
18443 to header lines in string expansions in the transport's configuration still
18444 &"see"& the original header lines.
18445
18446 The &%headers_remove%& option is expanded after &%errors_to%& and
18447 &%headers_add%&, but before &%transport%&. If an item expansion is forced to fail,
18448 the item has no effect. Other expansion failures are treated as configuration
18449 errors.
18450
18451 Unlike most options, &%headers_remove%& can be specified multiple times
18452 for a router; all listed headers are removed.
18453
18454 &*Warning 1*&: The &%headers_remove%& option cannot be used for a &(redirect)&
18455 router that has the &%one_time%& option set.
18456
18457 &*Warning 2*&: If the &%unseen%& option is set on the router, all header
18458 removal requests are deleted when the address is passed on to subsequent
18459 routers, and this can lead to problems with duplicates -- see the similar
18460 warning for &%headers_add%& above.
18461
18462 &*Warning 3*&: Because of the separate expansion of the list items,
18463 items that contain a list separator must have it doubled.
18464 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
18465
18466
18467
18468 .option ignore_target_hosts routers "host list&!!" unset
18469 .cindex "IP address" "discarding"
18470 .cindex "router" "discarding IP addresses"
18471 Although this option is a host list, it should normally contain IP address
18472 entries rather than names. If any host that is looked up by the router has an
18473 IP address that matches an item in this list, Exim behaves as if that IP
18474 address did not exist. This option allows you to cope with rogue DNS entries
18475 like
18476 .code
18477 remote.domain.example.  A  127.0.0.1
18478 .endd
18479 by setting
18480 .code
18481 ignore_target_hosts = 127.0.0.1
18482 .endd
18483 on the relevant router. If all the hosts found by a &(dnslookup)& router are
18484 discarded in this way, the router declines. In a conventional configuration, an
18485 attempt to mail to such a domain would normally provoke the &"unrouteable
18486 domain"& error, and an attempt to verify an address in the domain would fail.
18487 Similarly, if &%ignore_target_hosts%& is set on an &(ipliteral)& router, the
18488 router declines if presented with one of the listed addresses.
18489
18490 You can use this option to disable the use of IPv4 or IPv6 for mail delivery by
18491 means of the first or the second of the following settings, respectively:
18492 .code
18493 ignore_target_hosts = 0.0.0.0/0
18494 ignore_target_hosts = <; 0::0/0
18495 .endd
18496 The pattern in the first line matches all IPv4 addresses, whereas the pattern
18497 in the second line matches all IPv6 addresses.
18498
18499 This option may also be useful for ignoring link-local and site-local IPv6
18500 addresses. Because, like all host lists, the value of &%ignore_target_hosts%&
18501 is expanded before use as a list, it is possible to make it dependent on the
18502 domain that is being routed.
18503
18504 .vindex "&$host_address$&"
18505 During its expansion, &$host_address$& is set to the IP address that is being
18506 checked.
18507
18508 .option initgroups routers boolean false
18509 .cindex "additional groups"
18510 .cindex "groups" "additional"
18511 .cindex "local transports" "uid and gid"
18512 .cindex "transport" "local"
18513 If the router queues an address for a transport, and this option is true, and
18514 the uid supplied by the router is not overridden by the transport, the
18515 &[initgroups()]& function is called when running the transport to ensure that
18516 any additional groups associated with the uid are set up. See also &%group%&
18517 and &%user%& and the discussion in chapter &<<CHAPenvironment>>&.
18518
18519
18520
18521 .option local_part_prefix routers&!? "string list" unset
18522 .cindex affix "router precondition"
18523 .cindex "router" "prefix for local part"
18524 .cindex "prefix" "for local part, used in router"
18525 If this option is set, the router is skipped unless the local part starts with
18526 one of the given strings, or &%local_part_prefix_optional%& is true. See
18527 section &<<SECTrouprecon>>& for a list of the order in which preconditions are
18528 evaluated.
18529
18530 The list is scanned from left to right, and the first prefix that matches is
18531 used. A limited form of wildcard is available; if the prefix begins with an
18532 asterisk, it matches the longest possible sequence of arbitrary characters at
18533 the start of the local part. An asterisk should therefore always be followed by
18534 some character that does not occur in normal local parts.
18535 .cindex "multiple mailboxes"
18536 .cindex "mailbox" "multiple"
18537 Wildcarding can be used to set up multiple user mailboxes, as described in
18538 section &<<SECTmulbox>>&.
18539
18540 .vindex "&$local_part$&"
18541 .vindex "&$local_part_prefix$&"
18542 During the testing of the &%local_parts%& option, and while the router is
18543 running, the prefix is removed from the local part, and is available in the
18544 expansion variable &$local_part_prefix$&. When a message is being delivered, if
18545 the router accepts the address, this remains true during subsequent delivery by
18546 a transport. In particular, the local part that is transmitted in the RCPT
18547 command for LMTP, SMTP, and BSMTP deliveries has the prefix removed by default.
18548 This behaviour can be overridden by setting &%rcpt_include_affixes%& true on
18549 the relevant transport.
18550
18551 When an address is being verified, &%local_part_prefix%& affects only the
18552 behaviour of the router. If the callout feature of verification is in use, this
18553 means that the full address, including the prefix, will be used during the
18554 callout.
18555
18556 The prefix facility is commonly used to handle local parts of the form
18557 &%owner-something%&. Another common use is to support local parts of the form
18558 &%real-username%& to bypass a user's &_.forward_& file &-- helpful when trying
18559 to tell a user their forwarding is broken &-- by placing a router like this one
18560 immediately before the router that handles &_.forward_& files:
18561 .code
18562 real_localuser:
18563   driver = accept
18564   local_part_prefix = real-
18565   check_local_user
18566   transport = local_delivery
18567 .endd
18568 For security, it would probably be a good idea to restrict the use of this
18569 router to locally-generated messages, using a condition such as this:
18570 .code
18571   condition = ${if match {$sender_host_address}\
18572                          {\N^(|127\.0\.0\.1)$\N}}
18573 .endd
18574
18575 If both &%local_part_prefix%& and &%local_part_suffix%& are set for a router,
18576 both conditions must be met if not optional. Care must be taken if wildcards
18577 are used in both a prefix and a suffix on the same router. Different
18578 separator characters must be used to avoid ambiguity.
18579
18580
18581 .option local_part_prefix_optional routers boolean false
18582 See &%local_part_prefix%& above.
18583
18584
18585
18586 .option local_part_suffix routers&!? "string list" unset
18587 .cindex "router" "suffix for local part"
18588 .cindex "suffix for local part" "used in router"
18589 This option operates in the same way as &%local_part_prefix%&, except that the
18590 local part must end (rather than start) with the given string, the
18591 &%local_part_suffix_optional%& option determines whether the suffix is
18592 mandatory, and the wildcard * character, if present, must be the last
18593 character of the suffix. This option facility is commonly used to handle local
18594 parts of the form &%something-request%& and multiple user mailboxes of the form
18595 &%username-foo%&.
18596
18597
18598 .option local_part_suffix_optional routers boolean false
18599 See &%local_part_suffix%& above.
18600
18601
18602
18603 .option local_parts routers&!? "local part list&!!" unset
18604 .cindex "router" "restricting to specific local parts"
18605 .cindex "local part" "checking in router"
18606 The router is run only if the local part of the address matches the list.
18607 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18608 are evaluated, and
18609 section &<<SECTlocparlis>>& for a discussion of local part lists. Because the
18610 string is expanded, it is possible to make it depend on the domain, for
18611 example:
18612 .code
18613 local_parts = dbm;/usr/local/specials/$domain
18614 .endd
18615 .vindex "&$local_part_data$&"
18616 If the match is achieved by a lookup, the data that the lookup returned
18617 for the local part is placed in the variable &$local_part_data$& for use in
18618 expansions of the router's private options. You might use this option, for
18619 example, if you have a large number of local virtual domains, and you want to
18620 send all postmaster mail to the same place without having to set up an alias in
18621 each virtual domain:
18622 .code
18623 postmaster:
18624   driver = redirect
18625   local_parts = postmaster
18626   data = postmaster@real.domain.example
18627 .endd
18628
18629
18630 .option log_as_local routers boolean "see below"
18631 .cindex "log" "delivery line"
18632 .cindex "delivery" "log line format"
18633 Exim has two logging styles for delivery, the idea being to make local
18634 deliveries stand out more visibly from remote ones. In the &"local"& style, the
18635 recipient address is given just as the local part, without a domain. The use of
18636 this style is controlled by this option. It defaults to true for the &(accept)&
18637 router, and false for all the others. This option applies only when a
18638 router assigns an address to a transport. It has no effect on routers that
18639 redirect addresses.
18640
18641
18642
18643 .option more routers boolean&!! true
18644 The result of string expansion for this option must be a valid boolean value,
18645 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
18646 result causes an error, and delivery is deferred. If the expansion is forced to
18647 fail, the default value for the option (true) is used. Other failures cause
18648 delivery to be deferred.
18649
18650 If this option is set false, and the router declines to handle the address, no
18651 further routers are tried, routing fails, and the address is bounced.
18652 .oindex "&%self%&"
18653 However, if the router explicitly passes an address to the following router by
18654 means of the setting
18655 .code
18656 self = pass
18657 .endd
18658 or otherwise, the setting of &%more%& is ignored. Also, the setting of &%more%&
18659 does not affect the behaviour if one of the precondition tests fails. In that
18660 case, the address is always passed to the next router.
18661
18662 Note that &%address_data%& is not considered to be a precondition. If its
18663 expansion is forced to fail, the router declines, and the value of &%more%&
18664 controls what happens next.
18665
18666
18667 .option pass_on_timeout routers boolean false
18668 .cindex "timeout" "of router"
18669 .cindex "router" "timeout"
18670 If a router times out during a host lookup, it normally causes deferral of the
18671 address. If &%pass_on_timeout%& is set, the address is passed on to the next
18672 router, overriding &%no_more%&. This may be helpful for systems that are
18673 intermittently connected to the Internet, or those that want to pass to a smart
18674 host any messages that cannot immediately be delivered.
18675
18676 There are occasional other temporary errors that can occur while doing DNS
18677 lookups. They are treated in the same way as a timeout, and this option
18678 applies to all of them.
18679
18680
18681
18682 .option pass_router routers string unset
18683 .cindex "router" "go to after &""pass""&"
18684 Routers that recognize the generic &%self%& option (&(dnslookup)&,
18685 &(ipliteral)&, and &(manualroute)&) are able to return &"pass"&, forcing
18686 routing to continue, and overriding a false setting of &%more%&. When one of
18687 these routers returns &"pass"&, the address is normally handed on to the next
18688 router in sequence. This can be changed by setting &%pass_router%& to the name
18689 of another router. However (unlike &%redirect_router%&) the named router must
18690 be below the current router, to avoid loops. Note that this option applies only
18691 to the special case of &"pass"&. It does not apply when a router returns
18692 &"decline"& because it cannot handle an address.
18693
18694
18695
18696 .option redirect_router routers string unset
18697 .cindex "router" "start at after redirection"
18698 Sometimes an administrator knows that it is pointless to reprocess addresses
18699 generated from alias or forward files with the same router again. For
18700 example, if an alias file translates real names into login ids there is no
18701 point searching the alias file a second time, especially if it is a large file.
18702
18703 The &%redirect_router%& option can be set to the name of any router instance.
18704 It causes the routing of any generated addresses to start at the named router
18705 instead of at the first router. This option has no effect if the router in
18706 which it is set does not generate new addresses.
18707
18708
18709
18710 .option require_files routers&!? "string list&!!" unset
18711 .cindex "file" "requiring for router"
18712 .cindex "router" "requiring file existence"
18713 This option provides a general mechanism for predicating the running of a
18714 router on the existence or non-existence of certain files or directories.
18715 Before running a router, as one of its precondition tests, Exim works its way
18716 through the &%require_files%& list, expanding each item separately.
18717
18718 Because the list is split before expansion, any colons in expansion items must
18719 be doubled, or the facility for using a different list separator must be used
18720 (&<<SECTlistsepchange>>&).
18721 If any expansion is forced to fail, the item is ignored. Other expansion
18722 failures cause routing of the address to be deferred.
18723
18724 If any expanded string is empty, it is ignored. Otherwise, except as described
18725 below, each string must be a fully qualified file path, optionally preceded by
18726 &"!"&. The paths are passed to the &[stat()]& function to test for the
18727 existence of the files or directories. The router is skipped if any paths not
18728 preceded by &"!"& do not exist, or if any paths preceded by &"!"& do exist.
18729
18730 .cindex "NFS"
18731 If &[stat()]& cannot determine whether a file exists or not, delivery of
18732 the message is deferred. This can happen when NFS-mounted filesystems are
18733 unavailable.
18734
18735 This option is checked after the &%domains%&, &%local_parts%&, and &%senders%&
18736 options, so you cannot use it to check for the existence of a file in which to
18737 look up a domain, local part, or sender. (See section &<<SECTrouprecon>>& for a
18738 full list of the order in which preconditions are evaluated.) However, as
18739 these options are all expanded, you can use the &%exists%& expansion condition
18740 to make such tests. The &%require_files%& option is intended for checking files
18741 that the router may be going to use internally, or which are needed by a
18742 transport (e.g., &_.procmailrc_&).
18743
18744 During delivery, the &[stat()]& function is run as root, but there is a
18745 facility for some checking of the accessibility of a file by another user.
18746 This is not a proper permissions check, but just a &"rough"& check that
18747 operates as follows:
18748
18749 If an item in a &%require_files%& list does not contain any forward slash
18750 characters, it is taken to be the user (and optional group, separated by a
18751 comma) to be checked for subsequent files in the list. If no group is specified
18752 but the user is specified symbolically, the gid associated with the uid is
18753 used. For example:
18754 .code
18755 require_files = mail:/some/file
18756 require_files = $local_part:$home/.procmailrc
18757 .endd
18758 If a user or group name in a &%require_files%& list does not exist, the
18759 &%require_files%& condition fails.
18760
18761 Exim performs the check by scanning along the components of the file path, and
18762 checking the access for the given uid and gid. It checks for &"x"& access on
18763 directories, and &"r"& access on the final file. Note that this means that file
18764 access control lists, if the operating system has them, are ignored.
18765
18766 &*Warning 1*&: When the router is being run to verify addresses for an
18767 incoming SMTP message, Exim is not running as root, but under its own uid. This
18768 may affect the result of a &%require_files%& check. In particular, &[stat()]&
18769 may yield the error EACCES (&"Permission denied"&). This means that the Exim
18770 user is not permitted to read one of the directories on the file's path.
18771
18772 &*Warning 2*&: Even when Exim is running as root while delivering a message,
18773 &[stat()]& can yield EACCES for a file in an NFS directory that is mounted
18774 without root access. In this case, if a check for access by a particular user
18775 is requested, Exim creates a subprocess that runs as that user, and tries the
18776 check again in that process.
18777
18778 The default action for handling an unresolved EACCES is to consider it to
18779 be caused by a configuration error, and routing is deferred because the
18780 existence or non-existence of the file cannot be determined. However, in some
18781 circumstances it may be desirable to treat this condition as if the file did
18782 not exist. If the filename (or the exclamation mark that precedes the filename
18783 for non-existence) is preceded by a plus sign, the EACCES error is treated
18784 as if the file did not exist. For example:
18785 .code
18786 require_files = +/some/file
18787 .endd
18788 If the router is not an essential part of verification (for example, it
18789 handles users' &_.forward_& files), another solution is to set the &%verify%&
18790 option false so that the router is skipped when verifying.
18791
18792
18793
18794 .option retry_use_local_part routers boolean "see below"
18795 .cindex "hints database" "retry keys"
18796 .cindex "local part" "in retry keys"
18797 When a delivery suffers a temporary routing failure, a retry record is created
18798 in Exim's hints database. For addresses whose routing depends only on the
18799 domain, the key for the retry record should not involve the local part, but for
18800 other addresses, both the domain and the local part should be included.
18801 Usually, remote routing is of the former kind, and local routing is of the
18802 latter kind.
18803
18804 This option controls whether the local part is used to form the key for retry
18805 hints for addresses that suffer temporary errors while being handled by this
18806 router. The default value is true for any router that has &%check_local_user%&
18807 set, and false otherwise. Note that this option does not apply to hints keys
18808 for transport delays; they are controlled by a generic transport option of the
18809 same name.
18810
18811 The setting of &%retry_use_local_part%& applies only to the router on which it
18812 appears. If the router generates child addresses, they are routed
18813 independently; this setting does not become attached to them.
18814
18815
18816
18817 .option router_home_directory routers string&!! unset
18818 .cindex "router" "home directory for"
18819 .cindex "home directory" "for router"
18820 .vindex "&$home$&"
18821 This option sets a home directory for use while the router is running. (Compare
18822 &%transport_home_directory%&, which sets a home directory for later
18823 transporting.) In particular, if used on a &(redirect)& router, this option
18824 sets a value for &$home$& while a filter is running. The value is expanded;
18825 forced expansion failure causes the option to be ignored &-- other failures
18826 cause the router to defer.
18827
18828 Expansion of &%router_home_directory%& happens immediately after the
18829 &%check_local_user%& test (if configured), before any further expansions take
18830 place.
18831 (See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18832 are evaluated.)
18833 While the router is running, &%router_home_directory%& overrides the value of
18834 &$home$& that came from &%check_local_user%&.
18835
18836 When a router accepts an address and assigns it to a local transport (including
18837 the cases when a &(redirect)& router generates a pipe, file, or autoreply
18838 delivery), the home directory setting for the transport is taken from the first
18839 of these values that is set:
18840
18841 .ilist
18842 The &%home_directory%& option on the transport;
18843 .next
18844 The &%transport_home_directory%& option on the router;
18845 .next
18846 The password data if &%check_local_user%& is set on the router;
18847 .next
18848 The &%router_home_directory%& option on the router.
18849 .endlist
18850
18851 In other words, &%router_home_directory%& overrides the password data for the
18852 router, but not for the transport.
18853
18854
18855
18856 .option self routers string freeze
18857 .cindex "MX record" "pointing to local host"
18858 .cindex "local host" "MX pointing to"
18859 This option applies to those routers that use a recipient address to find a
18860 list of remote hosts. Currently, these are the &(dnslookup)&, &(ipliteral)&,
18861 and &(manualroute)& routers.
18862 Certain configurations of the &(queryprogram)& router can also specify a list
18863 of remote hosts.
18864 Usually such routers are configured to send the message to a remote host via an
18865 &(smtp)& transport. The &%self%& option specifies what happens when the first
18866 host on the list turns out to be the local host.
18867 The way in which Exim checks for the local host is described in section
18868 &<<SECTreclocipadd>>&.
18869
18870 Normally this situation indicates either an error in Exim's configuration (for
18871 example, the router should be configured not to process this domain), or an
18872 error in the DNS (for example, the MX should not point to this host). For this
18873 reason, the default action is to log the incident, defer the address, and
18874 freeze the message. The following alternatives are provided for use in special
18875 cases:
18876
18877 .vlist
18878 .vitem &%defer%&
18879 Delivery of the message is tried again later, but the message is not frozen.
18880
18881 .vitem "&%reroute%&: <&'domain'&>"
18882 The domain is changed to the given domain, and the address is passed back to
18883 be reprocessed by the routers. No rewriting of headers takes place. This
18884 behaviour is essentially a redirection.
18885
18886 .vitem "&%reroute: rewrite:%& <&'domain'&>"
18887 The domain is changed to the given domain, and the address is passed back to be
18888 reprocessed by the routers. Any headers that contain the original domain are
18889 rewritten.
18890
18891 .vitem &%pass%&
18892 .oindex "&%more%&"
18893 .vindex "&$self_hostname$&"
18894 The router passes the address to the next router, or to the router named in the
18895 &%pass_router%& option if it is set. This overrides &%no_more%&. During
18896 subsequent routing and delivery, the variable &$self_hostname$& contains the
18897 name of the local host that the router encountered. This can be used to
18898 distinguish between different cases for hosts with multiple names. The
18899 combination
18900 .code
18901 self = pass
18902 no_more
18903 .endd
18904 ensures that only those addresses that routed to the local host are passed on.
18905 Without &%no_more%&, addresses that were declined for other reasons would also
18906 be passed to the next router.
18907
18908 .vitem &%fail%&
18909 Delivery fails and an error report is generated.
18910
18911 .vitem &%send%&
18912 .cindex "local host" "sending to"
18913 The anomaly is ignored and the address is queued for the transport. This
18914 setting should be used with extreme caution. For an &(smtp)& transport, it
18915 makes sense only in cases where the program that is listening on the SMTP port
18916 is not this version of Exim. That is, it must be some other MTA, or Exim with a
18917 different configuration file that handles the domain in another way.
18918 .endlist
18919
18920
18921
18922 .option senders routers&!? "address list&!!" unset
18923 .cindex "router" "checking senders"
18924 If this option is set, the router is skipped unless the message's sender
18925 address matches something on the list.
18926 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
18927 are evaluated.
18928
18929 There are issues concerning verification when the running of routers is
18930 dependent on the sender. When Exim is verifying the address in an &%errors_to%&
18931 setting, it sets the sender to the null string. When using the &%-bt%& option
18932 to check a configuration file, it is necessary also to use the &%-f%& option to
18933 set an appropriate sender. For incoming mail, the sender is unset when
18934 verifying the sender, but is available when verifying any recipients. If the
18935 SMTP VRFY command is enabled, it must be used after MAIL if the sender address
18936 matters.
18937
18938
18939 .option translate_ip_address routers string&!! unset
18940 .cindex "IP address" "translating"
18941 .cindex "packet radio"
18942 .cindex "router" "IP address translation"
18943 There exist some rare networking situations (for example, packet radio) where
18944 it is helpful to be able to translate IP addresses generated by normal routing
18945 mechanisms into other IP addresses, thus performing a kind of manual IP
18946 routing. This should be done only if the normal IP routing of the TCP/IP stack
18947 is inadequate or broken. Because this is an extremely uncommon requirement, the
18948 code to support this option is not included in the Exim binary unless
18949 SUPPORT_TRANSLATE_IP_ADDRESS=yes is set in &_Local/Makefile_&.
18950
18951 .vindex "&$host_address$&"
18952 The &%translate_ip_address%& string is expanded for every IP address generated
18953 by the router, with the generated address set in &$host_address$&. If the
18954 expansion is forced to fail, no action is taken.
18955 For any other expansion error, delivery of the message is deferred.
18956 If the result of the expansion is an IP address, that replaces the original
18957 address; otherwise the result is assumed to be a host name &-- this is looked
18958 up using &[gethostbyname()]& (or &[getipnodebyname()]& when available) to
18959 produce one or more replacement IP addresses. For example, to subvert all IP
18960 addresses in some specific networks, this could be added to a router:
18961 .code
18962 translate_ip_address = \
18963   ${lookup{${mask:$host_address/26}}lsearch{/some/file}\
18964     {$value}fail}}
18965 .endd
18966 The file would contain lines like
18967 .code
18968 10.2.3.128/26    some.host
18969 10.8.4.34/26     10.44.8.15
18970 .endd
18971 You should not make use of this facility unless you really understand what you
18972 are doing.
18973
18974
18975
18976 .option transport routers string&!! unset
18977 This option specifies the transport to be used when a router accepts an address
18978 and sets it up for delivery. A transport is never needed if a router is used
18979 only for verification. The value of the option is expanded at routing time,
18980 after the expansion of &%errors_to%&, &%headers_add%&, and &%headers_remove%&,
18981 and result must be the name of one of the configured transports. If it is not,
18982 delivery is deferred.
18983
18984 The &%transport%& option is not used by the &(redirect)& router, but it does
18985 have some private options that set up transports for pipe and file deliveries
18986 (see chapter &<<CHAPredirect>>&).
18987
18988
18989
18990 .option transport_current_directory routers string&!! unset
18991 .cindex "current directory for local transport"
18992 This option associates a current directory with any address that is routed
18993 to a local transport. This can happen either because a transport is
18994 explicitly configured for the router, or because it generates a delivery to a
18995 file or a pipe. During the delivery process (that is, at transport time), this
18996 option string is expanded and is set as the current directory, unless
18997 overridden by a setting on the transport.
18998 If the expansion fails for any reason, including forced failure, an error is
18999 logged, and delivery is deferred.
19000 See chapter &<<CHAPenvironment>>& for details of the local delivery
19001 environment.
19002
19003
19004
19005
19006 .option transport_home_directory routers string&!! "see below"
19007 .cindex "home directory" "for local transport"
19008 This option associates a home directory with any address that is routed to a
19009 local transport. This can happen either because a transport is explicitly
19010 configured for the router, or because it generates a delivery to a file or a
19011 pipe. During the delivery process (that is, at transport time), the option
19012 string is expanded and is set as the home directory, unless overridden by a
19013 setting of &%home_directory%& on the transport.
19014 If the expansion fails for any reason, including forced failure, an error is
19015 logged, and delivery is deferred.
19016
19017 If the transport does not specify a home directory, and
19018 &%transport_home_directory%& is not set for the router, the home directory for
19019 the transport is taken from the password data if &%check_local_user%& is set for
19020 the router. Otherwise it is taken from &%router_home_directory%& if that option
19021 is set; if not, no home directory is set for the transport.
19022
19023 See chapter &<<CHAPenvironment>>& for further details of the local delivery
19024 environment.
19025
19026
19027
19028
19029 .option unseen routers boolean&!! false
19030 .cindex "router" "carrying on after success"
19031 The result of string expansion for this option must be a valid boolean value,
19032 that is, one of the strings &"yes"&, &"no"&, &"true"&, or &"false"&. Any other
19033 result causes an error, and delivery is deferred. If the expansion is forced to
19034 fail, the default value for the option (false) is used. Other failures cause
19035 delivery to be deferred.
19036
19037 When this option is set true, routing does not cease if the router accepts the
19038 address. Instead, a copy of the incoming address is passed to the next router,
19039 overriding a false setting of &%more%&. There is little point in setting
19040 &%more%& false if &%unseen%& is always true, but it may be useful in cases when
19041 the value of &%unseen%& contains expansion items (and therefore, presumably, is
19042 sometimes true and sometimes false).
19043
19044 .cindex "copy of message (&%unseen%& option)"
19045 Setting the &%unseen%& option has a similar effect to the &%unseen%& command
19046 qualifier in filter files. It can be used to cause copies of messages to be
19047 delivered to some other destination, while also carrying out a normal delivery.
19048 In effect, the current address is made into a &"parent"& that has two children
19049 &-- one that is delivered as specified by this router, and a clone that goes on
19050 to be routed further. For this reason, &%unseen%& may not be combined with the
19051 &%one_time%& option in a &(redirect)& router.
19052
19053 &*Warning*&: Header lines added to the address (or specified for removal) by
19054 this router or by previous routers affect the &"unseen"& copy of the message
19055 only. The clone that continues to be processed by further routers starts with
19056 no added headers and none specified for removal. For a &%redirect%& router, if
19057 a generated address is the same as the incoming address, this can lead to
19058 duplicate addresses with different header modifications. Exim does not do
19059 duplicate deliveries (except, in certain circumstances, to pipes -- see section
19060 &<<SECTdupaddr>>&), but it is undefined which of the duplicates is discarded,
19061 so this ambiguous situation should be avoided. The &%repeat_use%& option of the
19062 &%redirect%& router may be of help.
19063
19064 Unlike the handling of header modifications, any data that was set by the
19065 &%address_data%& option in the current or previous routers &'is'& passed on to
19066 subsequent routers.
19067
19068
19069 .option user routers string&!! "see below"
19070 .cindex "uid (user id)" "local delivery"
19071 .cindex "local transports" "uid and gid"
19072 .cindex "transport" "local"
19073 .cindex "router" "user for filter processing"
19074 .cindex "filter" "user for processing"
19075 When a router queues an address for a transport, and the transport does not
19076 specify a user, the user given here is used when running the delivery process.
19077 The user may be specified numerically or by name. If expansion fails, the
19078 error is logged and delivery is deferred.
19079 This user is also used by the &(redirect)& router when running a filter file.
19080 The default is unset, except when &%check_local_user%& is set. In this case,
19081 the default is taken from the password information. If the user is specified as
19082 a name, and &%group%& is not set, the group associated with the user is used.
19083 See also &%initgroups%& and &%group%& and the discussion in chapter
19084 &<<CHAPenvironment>>&.
19085
19086
19087
19088 .option verify routers&!? boolean true
19089 Setting this option has the effect of setting &%verify_sender%& and
19090 &%verify_recipient%& to the same value.
19091
19092
19093 .option verify_only routers&!? boolean false
19094 .cindex "EXPN" "with &%verify_only%&"
19095 .oindex "&%-bv%&"
19096 .cindex "router" "used only when verifying"
19097 If this option is set, the router is used only when verifying an address,
19098 delivering in cutthrough mode or
19099 testing with the &%-bv%& option, not when actually doing a delivery, testing
19100 with the &%-bt%& option, or running the SMTP EXPN command. It can be further
19101 restricted to verifying only senders or recipients by means of
19102 &%verify_sender%& and &%verify_recipient%&.
19103
19104 &*Warning*&: When the router is being run to verify addresses for an incoming
19105 SMTP message, Exim is not running as root, but under its own uid. If the router
19106 accesses any files, you need to make sure that they are accessible to the Exim
19107 user or group.
19108
19109
19110 .option verify_recipient routers&!? boolean true
19111 If this option is false, the router is skipped when verifying recipient
19112 addresses,
19113 delivering in cutthrough mode
19114 or testing recipient verification using &%-bv%&.
19115 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19116 are evaluated.
19117 See also the &$verify_mode$& variable.
19118
19119
19120 .option verify_sender routers&!? boolean true
19121 If this option is false, the router is skipped when verifying sender addresses
19122 or testing sender verification using &%-bvs%&.
19123 See section &<<SECTrouprecon>>& for a list of the order in which preconditions
19124 are evaluated.
19125 See also the &$verify_mode$& variable.
19126 .ecindex IIDgenoprou1
19127 .ecindex IIDgenoprou2
19128
19129
19130
19131
19132
19133
19134 . ////////////////////////////////////////////////////////////////////////////
19135 . ////////////////////////////////////////////////////////////////////////////
19136
19137 .chapter "The accept router" "CHID4"
19138 .cindex "&(accept)& router"
19139 .cindex "routers" "&(accept)&"
19140 The &(accept)& router has no private options of its own. Unless it is being
19141 used purely for verification (see &%verify_only%&) a transport is required to
19142 be defined by the generic &%transport%& option. If the preconditions that are
19143 specified by generic options are met, the router accepts the address and queues
19144 it for the given transport. The most common use of this router is for setting
19145 up deliveries to local mailboxes. For example:
19146 .code
19147 localusers:
19148   driver = accept
19149   domains = mydomain.example
19150   check_local_user
19151   transport = local_delivery
19152 .endd
19153 The &%domains%& condition in this example checks the domain of the address, and
19154 &%check_local_user%& checks that the local part is the login of a local user.
19155 When both preconditions are met, the &(accept)& router runs, and queues the
19156 address for the &(local_delivery)& transport.
19157
19158
19159
19160
19161
19162
19163 . ////////////////////////////////////////////////////////////////////////////
19164 . ////////////////////////////////////////////////////////////////////////////
19165
19166 .chapter "The dnslookup router" "CHAPdnslookup"
19167 .scindex IIDdnsrou1 "&(dnslookup)& router"
19168 .scindex IIDdnsrou2 "routers" "&(dnslookup)&"
19169 The &(dnslookup)& router looks up the hosts that handle mail for the
19170 recipient's domain in the DNS. A transport must always be set for this router,
19171 unless &%verify_only%& is set.
19172
19173 If SRV support is configured (see &%check_srv%& below), Exim first searches for
19174 SRV records. If none are found, or if SRV support is not configured,
19175 MX records are looked up. If no MX records exist, address records are sought.
19176 However, &%mx_domains%& can be set to disable the direct use of address
19177 records.
19178
19179 MX records of equal priority are sorted by Exim into a random order. Exim then
19180 looks for address records for the host names obtained from MX or SRV records.
19181 When a host has more than one IP address, they are sorted into a random order,
19182 except that IPv6 addresses are sorted before IPv4 addresses. If all the
19183 IP addresses found are discarded by a setting of the &%ignore_target_hosts%&
19184 generic option, the router declines.
19185
19186 Unless they have the highest priority (lowest MX value), MX records that point
19187 to the local host, or to any host name that matches &%hosts_treat_as_local%&,
19188 are discarded, together with any other MX records of equal or lower priority.
19189
19190 .cindex "MX record" "pointing to local host"
19191 .cindex "local host" "MX pointing to"
19192 .oindex "&%self%&" "in &(dnslookup)& router"
19193 If the host pointed to by the highest priority MX record, or looked up as an
19194 address record, is the local host, or matches &%hosts_treat_as_local%&, what
19195 happens is controlled by the generic &%self%& option.
19196
19197
19198 .section "Problems with DNS lookups" "SECTprowitdnsloo"
19199 There have been problems with DNS servers when SRV records are looked up.
19200 Some misbehaving servers return a DNS error or timeout when a non-existent
19201 SRV record is sought. Similar problems have in the past been reported for
19202 MX records. The global &%dns_again_means_nonexist%& option can help with this
19203 problem, but it is heavy-handed because it is a global option.
19204
19205 For this reason, there are two options, &%srv_fail_domains%& and
19206 &%mx_fail_domains%&, that control what happens when a DNS lookup in a
19207 &(dnslookup)& router results in a DNS failure or a &"try again"& response. If
19208 an attempt to look up an SRV or MX record causes one of these results, and the
19209 domain matches the relevant list, Exim behaves as if the DNS had responded &"no
19210 such record"&. In the case of an SRV lookup, this means that the router
19211 proceeds to look for MX records; in the case of an MX lookup, it proceeds to
19212 look for A or AAAA records, unless the domain matches &%mx_domains%&, in which
19213 case routing fails.
19214
19215
19216 .section "Declining addresses by dnslookup" "SECTdnslookupdecline"
19217 .cindex "&(dnslookup)& router" "declines"
19218 There are a few cases where a &(dnslookup)& router will decline to accept
19219 an address; if such a router is expected to handle "all remaining non-local
19220 domains", then it is important to set &%no_more%&.
19221
19222 The router will defer rather than decline if the domain
19223 is found in the &%fail_defer_domains%& router option.
19224
19225 Reasons for a &(dnslookup)& router to decline currently include:
19226 .ilist
19227 The domain does not exist in DNS
19228 .next
19229 The domain exists but the MX record's host part is just "."; this is a common
19230 convention (borrowed from SRV) used to indicate that there is no such service
19231 for this domain and to not fall back to trying A/AAAA records.
19232 .next
19233 Ditto, but for SRV records, when &%check_srv%& is set on this router.
19234 .next
19235 MX record points to a non-existent host.
19236 .next
19237 MX record points to an IP address and the main section option
19238 &%allow_mx_to_ip%& is not set.
19239 .next
19240 MX records exist and point to valid hosts, but all hosts resolve only to
19241 addresses blocked by the &%ignore_target_hosts%& generic option on this router.
19242 .next
19243 The domain is not syntactically valid (see also &%allow_utf8_domains%& and
19244 &%dns_check_names_pattern%& for handling one variant of this)
19245 .next
19246 &%check_secondary_mx%& is set on this router but the local host can
19247 not be found in the MX records (see below)
19248 .endlist
19249
19250
19251
19252
19253 .section "Private options for dnslookup" "SECID118"
19254 .cindex "options" "&(dnslookup)& router"
19255 The private options for the &(dnslookup)& router are as follows:
19256
19257 .option check_secondary_mx dnslookup boolean false
19258 .cindex "MX record" "checking for secondary"
19259 If this option is set, the router declines unless the local host is found in
19260 (and removed from) the list of hosts obtained by MX lookup. This can be used to
19261 process domains for which the local host is a secondary mail exchanger
19262 differently to other domains. The way in which Exim decides whether a host is
19263 the local host is described in section &<<SECTreclocipadd>>&.
19264
19265
19266 .option check_srv dnslookup string&!! unset
19267 .cindex "SRV record" "enabling use of"
19268 The &(dnslookup)& router supports the use of SRV records (see RFC 2782) in
19269 addition to MX and address records. The support is disabled by default. To
19270 enable SRV support, set the &%check_srv%& option to the name of the service
19271 required. For example,
19272 .code
19273 check_srv = smtp
19274 .endd
19275 looks for SRV records that refer to the normal smtp service. The option is
19276 expanded, so the service name can vary from message to message or address
19277 to address. This might be helpful if SRV records are being used for a
19278 submission service. If the expansion is forced to fail, the &%check_srv%&
19279 option is ignored, and the router proceeds to look for MX records in the
19280 normal way.
19281
19282 When the expansion succeeds, the router searches first for SRV records for
19283 the given service (it assumes TCP protocol). A single SRV record with a
19284 host name that consists of just a single dot indicates &"no such service for
19285 this domain"&; if this is encountered, the router declines. If other kinds of
19286 SRV record are found, they are used to construct a host list for delivery
19287 according to the rules of RFC 2782. MX records are not sought in this case.
19288
19289 When no SRV records are found, MX records (and address records) are sought in
19290 the traditional way. In other words, SRV records take precedence over MX
19291 records, just as MX records take precedence over address records. Note that
19292 this behaviour is not sanctioned by RFC 2782, though a previous draft RFC
19293 defined it. It is apparently believed that MX records are sufficient for email
19294 and that SRV records should not be used for this purpose. However, SRV records
19295 have an additional &"weight"& feature which some people might find useful when
19296 trying to split an SMTP load between hosts of different power.
19297
19298 See section &<<SECTprowitdnsloo>>& above for a discussion of Exim's behaviour
19299 when there is a DNS lookup error.
19300
19301
19302
19303
19304 .option fail_defer_domains dnslookup "domain list&!!" unset
19305 .cindex "MX record" "not found"
19306 DNS lookups for domains matching &%fail_defer_domains%&
19307 which find no matching record will cause the router to defer
19308 rather than the default behaviour of decline.
19309 This maybe be useful for queueing messages for a newly created
19310 domain while the DNS configuration is not ready.
19311 However, it will result in any message with mistyped domains
19312 also being queued.
19313
19314
19315 .option ipv4_only "string&!!" unset
19316 .cindex IPv6 disabling
19317 .cindex DNS "IPv6 disabling"
19318 The string is expanded, and if the result is anything but a forced failure,
19319 or an empty string, or one of the strings “0” or “no” or “false”
19320 (checked without regard to the case of the letters),
19321 only A records are used.
19322
19323 .option ipv4_prefer "string&!!" unset
19324 .cindex IPv4 preference
19325 .cindex DNS "IPv4 preference"
19326 The string is expanded, and if the result is anything but a forced failure,
19327 or an empty string, or one of the strings “0” or “no” or “false”
19328 (checked without regard to the case of the letters),
19329 A records are sorted before AAAA records (inverting the default).
19330
19331 .option mx_domains dnslookup "domain list&!!" unset
19332 .cindex "MX record" "required to exist"
19333 .cindex "SRV record" "required to exist"
19334 A domain that matches &%mx_domains%& is required to have either an MX or an SRV
19335 record in order to be recognized. (The name of this option could be improved.)
19336 For example, if all the mail hosts in &'fict.example'& are known to have MX
19337 records, except for those in &'discworld.fict.example'&, you could use this
19338 setting:
19339 .code
19340 mx_domains = ! *.discworld.fict.example : *.fict.example
19341 .endd
19342 This specifies that messages addressed to a domain that matches the list but
19343 has no MX record should be bounced immediately instead of being routed using
19344 the address record.
19345
19346
19347 .option mx_fail_domains dnslookup "domain list&!!" unset
19348 If the DNS lookup for MX records for one of the domains in this list causes a
19349 DNS lookup error, Exim behaves as if no MX records were found. See section
19350 &<<SECTprowitdnsloo>>& for more discussion.
19351
19352
19353
19354
19355 .option qualify_single dnslookup boolean true
19356 .cindex "DNS" "resolver options"
19357 .cindex "DNS" "qualifying single-component names"
19358 When this option is true, the resolver option RES_DEFNAMES is set for DNS
19359 lookups. Typically, but not standardly, this causes the resolver to qualify
19360 single-component names with the default domain. For example, on a machine
19361 called &'dictionary.ref.example'&, the domain &'thesaurus'& would be changed to
19362 &'thesaurus.ref.example'& inside the resolver. For details of what your
19363 resolver actually does, consult your man pages for &'resolver'& and
19364 &'resolv.conf'&.
19365
19366
19367
19368 .option rewrite_headers dnslookup boolean true
19369 .cindex "rewriting" "header lines"
19370 .cindex "header lines" "rewriting"
19371 If the domain name in the address that is being processed is not fully
19372 qualified, it may be expanded to its full form by a DNS lookup. For example, if
19373 an address is specified as &'dormouse@teaparty'&, the domain might be
19374 expanded to &'teaparty.wonderland.fict.example'&. Domain expansion can also
19375 occur as a result of setting the &%widen_domains%& option. If
19376 &%rewrite_headers%& is true, all occurrences of the abbreviated domain name in
19377 any &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-to:'&, &'Sender:'&, and &'To:'&
19378 header lines of the message are rewritten with the full domain name.
19379
19380 This option should be turned off only when it is known that no message is
19381 ever going to be sent outside an environment where the abbreviation makes
19382 sense.
19383
19384 When an MX record is looked up in the DNS and matches a wildcard record, name
19385 servers normally return a record containing the name that has been looked up,
19386 making it impossible to detect whether a wildcard was present or not. However,
19387 some name servers have recently been seen to return the wildcard entry. If the
19388 name returned by a DNS lookup begins with an asterisk, it is not used for
19389 header rewriting.
19390
19391
19392 .option same_domain_copy_routing dnslookup boolean false
19393 .cindex "address" "copying routing"
19394 Addresses with the same domain are normally routed by the &(dnslookup)& router
19395 to the same list of hosts. However, this cannot be presumed, because the router
19396 options and preconditions may refer to the local part of the address. By
19397 default, therefore, Exim routes each address in a message independently. DNS
19398 servers run caches, so repeated DNS lookups are not normally expensive, and in
19399 any case, personal messages rarely have more than a few recipients.
19400
19401 If you are running mailing lists with large numbers of subscribers at the same
19402 domain, and you are using a &(dnslookup)& router which is independent of the
19403 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19404 lookups for identical domains in one message. In this case, when &(dnslookup)&
19405 routes an address to a remote transport, any other unrouted addresses in the
19406 message that have the same domain are automatically given the same routing
19407 without processing them independently,
19408 provided the following conditions are met:
19409
19410 .ilist
19411 No router that processed the address specified &%headers_add%& or
19412 &%headers_remove%&.
19413 .next
19414 The router did not change the address in any way, for example, by &"widening"&
19415 the domain.
19416 .endlist
19417
19418
19419
19420
19421 .option search_parents dnslookup boolean false
19422 .cindex "DNS" "resolver options"
19423 When this option is true, the resolver option RES_DNSRCH is set for DNS
19424 lookups. This is different from the &%qualify_single%& option in that it
19425 applies to domains containing dots. Typically, but not standardly, it causes
19426 the resolver to search for the name in the current domain and in parent
19427 domains. For example, on a machine in the &'fict.example'& domain, if looking
19428 up &'teaparty.wonderland'& failed, the resolver would try
19429 &'teaparty.wonderland.fict.example'&. For details of what your resolver
19430 actually does, consult your man pages for &'resolver'& and &'resolv.conf'&.
19431
19432 Setting this option true can cause problems in domains that have a wildcard MX
19433 record, because any domain that does not have its own MX record matches the
19434 local wildcard.
19435
19436
19437
19438 .option srv_fail_domains dnslookup "domain list&!!" unset
19439 If the DNS lookup for SRV records for one of the domains in this list causes a
19440 DNS lookup error, Exim behaves as if no SRV records were found. See section
19441 &<<SECTprowitdnsloo>>& for more discussion.
19442
19443
19444
19445
19446 .option widen_domains dnslookup "string list" unset
19447 .cindex "domain" "partial; widening"
19448 If a DNS lookup fails and this option is set, each of its strings in turn is
19449 added onto the end of the domain, and the lookup is tried again. For example,
19450 if
19451 .code
19452 widen_domains = fict.example:ref.example
19453 .endd
19454 is set and a lookup of &'klingon.dictionary'& fails,
19455 &'klingon.dictionary.fict.example'& is looked up, and if this fails,
19456 &'klingon.dictionary.ref.example'& is tried. Note that the &%qualify_single%&
19457 and &%search_parents%& options can cause some widening to be undertaken inside
19458 the DNS resolver. &%widen_domains%& is not applied to sender addresses
19459 when verifying, unless &%rewrite_headers%& is false (not the default).
19460
19461
19462 .section "Effect of qualify_single and search_parents" "SECID119"
19463 When a domain from an envelope recipient is changed by the resolver as a result
19464 of the &%qualify_single%& or &%search_parents%& options, Exim rewrites the
19465 corresponding address in the message's header lines unless &%rewrite_headers%&
19466 is set false. Exim then re-routes the address, using the full domain.
19467
19468 These two options affect only the DNS lookup that takes place inside the router
19469 for the domain of the address that is being routed. They do not affect lookups
19470 such as that implied by
19471 .code
19472 domains = @mx_any
19473 .endd
19474 that may happen while processing a router precondition before the router is
19475 entered. No widening ever takes place for these lookups.
19476 .ecindex IIDdnsrou1
19477 .ecindex IIDdnsrou2
19478
19479
19480
19481
19482
19483
19484
19485
19486
19487 . ////////////////////////////////////////////////////////////////////////////
19488 . ////////////////////////////////////////////////////////////////////////////
19489
19490 .chapter "The ipliteral router" "CHID5"
19491 .cindex "&(ipliteral)& router"
19492 .cindex "domain literal" "routing"
19493 .cindex "routers" "&(ipliteral)&"
19494 This router has no private options. Unless it is being used purely for
19495 verification (see &%verify_only%&) a transport is required to be defined by the
19496 generic &%transport%& option. The router accepts the address if its domain part
19497 takes the form of an RFC 2822 domain literal. For example, the &(ipliteral)&
19498 router handles the address
19499 .code
19500 root@[192.168.1.1]
19501 .endd
19502 by setting up delivery to the host with that IP address. IPv4 domain literals
19503 consist of an IPv4 address enclosed in square brackets. IPv6 domain literals
19504 are similar, but the address is preceded by &`ipv6:`&. For example:
19505 .code
19506 postmaster@[ipv6:fe80::a00:20ff:fe86:a061.5678]
19507 .endd
19508 Exim allows &`ipv4:`& before IPv4 addresses, for consistency, and on the
19509 grounds that sooner or later somebody will try it.
19510
19511 .oindex "&%self%&" "in &(ipliteral)& router"
19512 If the IP address matches something in &%ignore_target_hosts%&, the router
19513 declines. If an IP literal turns out to refer to the local host, the generic
19514 &%self%& option determines what happens.
19515
19516 The RFCs require support for domain literals; however, their use is
19517 controversial in today's Internet. If you want to use this router, you must
19518 also set the main configuration option &%allow_domain_literals%&. Otherwise,
19519 Exim will not recognize the domain literal syntax in addresses.
19520
19521
19522
19523 . ////////////////////////////////////////////////////////////////////////////
19524 . ////////////////////////////////////////////////////////////////////////////
19525
19526 .chapter "The iplookup router" "CHID6"
19527 .cindex "&(iplookup)& router"
19528 .cindex "routers" "&(iplookup)&"
19529 The &(iplookup)& router was written to fulfil a specific requirement in
19530 Cambridge University (which in fact no longer exists). For this reason, it is
19531 not included in the binary of Exim by default. If you want to include it, you
19532 must set
19533 .code
19534 ROUTER_IPLOOKUP=yes
19535 .endd
19536 in your &_Local/Makefile_& configuration file.
19537
19538 The &(iplookup)& router routes an address by sending it over a TCP or UDP
19539 connection to one or more specific hosts. The host can then return the same or
19540 a different address &-- in effect rewriting the recipient address in the
19541 message's envelope. The new address is then passed on to subsequent routers. If
19542 this process fails, the address can be passed on to other routers, or delivery
19543 can be deferred. Since &(iplookup)& is just a rewriting router, a transport
19544 must not be specified for it.
19545
19546 .cindex "options" "&(iplookup)& router"
19547 .option hosts iplookup string unset
19548 This option must be supplied. Its value is a colon-separated list of host
19549 names. The hosts are looked up using &[gethostbyname()]&
19550 (or &[getipnodebyname()]& when available)
19551 and are tried in order until one responds to the query. If none respond, what
19552 happens is controlled by &%optional%&.
19553
19554
19555 .option optional iplookup boolean false
19556 If &%optional%& is true, if no response is obtained from any host, the address
19557 is passed to the next router, overriding &%no_more%&. If &%optional%& is false,
19558 delivery to the address is deferred.
19559
19560
19561 .option port iplookup integer 0
19562 .cindex "port" "&(iplookup)& router"
19563 This option must be supplied. It specifies the port number for the TCP or UDP
19564 call.
19565
19566
19567 .option protocol iplookup string udp
19568 This option can be set to &"udp"& or &"tcp"& to specify which of the two
19569 protocols is to be used.
19570
19571
19572 .option query iplookup string&!! "see below"
19573 This defines the content of the query that is sent to the remote hosts. The
19574 default value is:
19575 .code
19576 $local_part@$domain $local_part@$domain
19577 .endd
19578 The repetition serves as a way of checking that a response is to the correct
19579 query in the default case (see &%response_pattern%& below).
19580
19581
19582 .option reroute iplookup string&!! unset
19583 If this option is not set, the rerouted address is precisely the byte string
19584 returned by the remote host, up to the first white space, if any. If set, the
19585 string is expanded to form the rerouted address. It can include parts matched
19586 in the response by &%response_pattern%& by means of numeric variables such as
19587 &$1$&, &$2$&, etc. The variable &$0$& refers to the entire input string,
19588 whether or not a pattern is in use. In all cases, the rerouted address must end
19589 up in the form &'local_part@domain'&.
19590
19591
19592 .option response_pattern iplookup string unset
19593 This option can be set to a regular expression that is applied to the string
19594 returned from the remote host. If the pattern does not match the response, the
19595 router declines. If &%response_pattern%& is not set, no checking of the
19596 response is done, unless the query was defaulted, in which case there is a
19597 check that the text returned after the first white space is the original
19598 address. This checks that the answer that has been received is in response to
19599 the correct question. For example, if the response is just a new domain, the
19600 following could be used:
19601 .code
19602 response_pattern = ^([^@]+)$
19603 reroute = $local_part@$1
19604 .endd
19605
19606 .option timeout iplookup time 5s
19607 This specifies the amount of time to wait for a response from the remote
19608 machine. The same timeout is used for the &[connect()]& function for a TCP
19609 call. It does not apply to UDP.
19610
19611
19612
19613
19614 . ////////////////////////////////////////////////////////////////////////////
19615 . ////////////////////////////////////////////////////////////////////////////
19616
19617 .chapter "The manualroute router" "CHID7"
19618 .scindex IIDmanrou1 "&(manualroute)& router"
19619 .scindex IIDmanrou2 "routers" "&(manualroute)&"
19620 .cindex "domain" "manually routing"
19621 The &(manualroute)& router is so-called because it provides a way of manually
19622 routing an address according to its domain. It is mainly used when you want to
19623 route addresses to remote hosts according to your own rules, bypassing the
19624 normal DNS routing that looks up MX records. However, &(manualroute)& can also
19625 route to local transports, a facility that may be useful if you want to save
19626 messages for dial-in hosts in local files.
19627
19628 The &(manualroute)& router compares a list of domain patterns with the domain
19629 it is trying to route. If there is no match, the router declines. Each pattern
19630 has associated with it a list of hosts and some other optional data, which may
19631 include a transport. The combination of a pattern and its data is called a
19632 &"routing rule"&. For patterns that do not have an associated transport, the
19633 generic &%transport%& option must specify a transport, unless the router is
19634 being used purely for verification (see &%verify_only%&).
19635
19636 .vindex "&$host$&"
19637 In the case of verification, matching the domain pattern is sufficient for the
19638 router to accept the address. When actually routing an address for delivery,
19639 an address that matches a domain pattern is queued for the associated
19640 transport. If the transport is not a local one, a host list must be associated
19641 with the pattern; IP addresses are looked up for the hosts, and these are
19642 passed to the transport along with the mail address. For local transports, a
19643 host list is optional. If it is present, it is passed in &$host$& as a single
19644 text string.
19645
19646 The list of routing rules can be provided as an inline string in
19647 &%route_list%&, or the data can be obtained by looking up the domain in a file
19648 or database by setting &%route_data%&. Only one of these settings may appear in
19649 any one instance of &(manualroute)&. The format of routing rules is described
19650 below, following the list of private options.
19651
19652
19653 .section "Private options for manualroute" "SECTprioptman"
19654
19655 .cindex "options" "&(manualroute)& router"
19656 The private options for the &(manualroute)& router are as follows:
19657
19658 .option host_all_ignored manualroute string defer
19659 See &%host_find_failed%&.
19660
19661 .option host_find_failed manualroute string freeze
19662 This option controls what happens when &(manualroute)& tries to find an IP
19663 address for a host, and the host does not exist. The option can be set to one
19664 of the following values:
19665 .code
19666 decline
19667 defer
19668 fail
19669 freeze
19670 ignore
19671 pass
19672 .endd
19673 The default (&"freeze"&) assumes that this state is a serious configuration
19674 error. The difference between &"pass"& and &"decline"& is that the former
19675 forces the address to be passed to the next router (or the router defined by
19676 &%pass_router%&),
19677 .oindex "&%more%&"
19678 overriding &%no_more%&, whereas the latter passes the address to the next
19679 router only if &%more%& is true.
19680
19681 The value &"ignore"& causes Exim to completely ignore a host whose IP address
19682 cannot be found. If all the hosts in the list are ignored, the behaviour is
19683 controlled by the &%host_all_ignored%& option. This takes the same values
19684 as &%host_find_failed%&, except that it cannot be set to &"ignore"&.
19685
19686 The &%host_find_failed%& option applies only to a definite &"does not exist"&
19687 state; if a host lookup gets a temporary error, delivery is deferred unless the
19688 generic &%pass_on_timeout%& option is set.
19689
19690
19691 .option hosts_randomize manualroute boolean false
19692 .cindex "randomized host list"
19693 .cindex "host" "list of; randomized"
19694 If this option is set, the order of the items in a host list in a routing rule
19695 is randomized each time the list is used, unless an option in the routing rule
19696 overrides (see below). Randomizing the order of a host list can be used to do
19697 crude load sharing. However, if more than one mail address is routed by the
19698 same router to the same host list, the host lists are considered to be the same
19699 (even though they may be randomized into different orders) for the purpose of
19700 deciding whether to batch the deliveries into a single SMTP transaction.
19701
19702 When &%hosts_randomize%& is true, a host list may be split
19703 into groups whose order is separately randomized. This makes it possible to
19704 set up MX-like behaviour. The boundaries between groups are indicated by an
19705 item that is just &`+`& in the host list. For example:
19706 .code
19707 route_list = * host1:host2:host3:+:host4:host5
19708 .endd
19709 The order of the first three hosts and the order of the last two hosts is
19710 randomized for each use, but the first three always end up before the last two.
19711 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored. If a
19712 randomized host list is passed to an &(smtp)& transport that also has
19713 &%hosts_randomize set%&, the list is not re-randomized.
19714
19715
19716 .option route_data manualroute string&!! unset
19717 If this option is set, it must expand to yield the data part of a routing rule.
19718 Typically, the expansion string includes a lookup based on the domain. For
19719 example:
19720 .code
19721 route_data = ${lookup{$domain}dbm{/etc/routes}}
19722 .endd
19723 If the expansion is forced to fail, or the result is an empty string, the
19724 router declines. Other kinds of expansion failure cause delivery to be
19725 deferred.
19726
19727
19728 .option route_list manualroute "string list" unset
19729 This string is a list of routing rules, in the form defined below. Note that,
19730 unlike most string lists, the items are separated by semicolons. This is so
19731 that they may contain colon-separated host lists.
19732
19733
19734 .option same_domain_copy_routing manualroute boolean false
19735 .cindex "address" "copying routing"
19736 Addresses with the same domain are normally routed by the &(manualroute)&
19737 router to the same list of hosts. However, this cannot be presumed, because the
19738 router options and preconditions may refer to the local part of the address. By
19739 default, therefore, Exim routes each address in a message independently. DNS
19740 servers run caches, so repeated DNS lookups are not normally expensive, and in
19741 any case, personal messages rarely have more than a few recipients.
19742
19743 If you are running mailing lists with large numbers of subscribers at the same
19744 domain, and you are using a &(manualroute)& router which is independent of the
19745 local part, you can set &%same_domain_copy_routing%& to bypass repeated DNS
19746 lookups for identical domains in one message. In this case, when
19747 &(manualroute)& routes an address to a remote transport, any other unrouted
19748 addresses in the message that have the same domain are automatically given the
19749 same routing without processing them independently. However, this is only done
19750 if &%headers_add%& and &%headers_remove%& are unset.
19751
19752
19753
19754
19755 .section "Routing rules in route_list" "SECID120"
19756 The value of &%route_list%& is a string consisting of a sequence of routing
19757 rules, separated by semicolons. If a semicolon is needed in a rule, it can be
19758 entered as two semicolons. Alternatively, the list separator can be changed as
19759 described (for colon-separated lists) in section &<<SECTlistconstruct>>&.
19760 Empty rules are ignored. The format of each rule is
19761 .display
19762 <&'domain pattern'&>  <&'list of hosts'&>  <&'options'&>
19763 .endd
19764 The following example contains two rules, each with a simple domain pattern and
19765 no options:
19766 .code
19767 route_list = \
19768   dict.ref.example  mail-1.ref.example:mail-2.ref.example ; \
19769   thes.ref.example  mail-3.ref.example:mail-4.ref.example
19770 .endd
19771 The three parts of a rule are separated by white space. The pattern and the
19772 list of hosts can be enclosed in quotes if necessary, and if they are, the
19773 usual quoting rules apply. Each rule in a &%route_list%& must start with a
19774 single domain pattern, which is the only mandatory item in the rule. The
19775 pattern is in the same format as one item in a domain list (see section
19776 &<<SECTdomainlist>>&),
19777 except that it may not be the name of an interpolated file.
19778 That is, it may be wildcarded, or a regular expression, or a file or database
19779 lookup (with semicolons doubled, because of the use of semicolon as a separator
19780 in a &%route_list%&).
19781
19782 The rules in &%route_list%& are searched in order until one of the patterns
19783 matches the domain that is being routed. The list of hosts and then options are
19784 then used as described below. If there is no match, the router declines. When
19785 &%route_list%& is set, &%route_data%& must not be set.
19786
19787
19788
19789 .section "Routing rules in route_data" "SECID121"
19790 The use of &%route_list%& is convenient when there are only a small number of
19791 routing rules. For larger numbers, it is easier to use a file or database to
19792 hold the routing information, and use the &%route_data%& option instead.
19793 The value of &%route_data%& is a list of hosts, followed by (optional) options.
19794 Most commonly, &%route_data%& is set as a string that contains an
19795 expansion lookup. For example, suppose we place two routing rules in a file
19796 like this:
19797 .code
19798 dict.ref.example:  mail-1.ref.example:mail-2.ref.example
19799 thes.ref.example:  mail-3.ref.example:mail-4.ref.example
19800 .endd
19801 This data can be accessed by setting
19802 .code
19803 route_data = ${lookup{$domain}lsearch{/the/file/name}}
19804 .endd
19805 Failure of the lookup results in an empty string, causing the router to
19806 decline. However, you do not have to use a lookup in &%route_data%&. The only
19807 requirement is that the result of expanding the string is a list of hosts,
19808 possibly followed by options, separated by white space. The list of hosts must
19809 be enclosed in quotes if it contains white space.
19810
19811
19812
19813
19814 .section "Format of the list of hosts" "SECID122"
19815 A list of hosts, whether obtained via &%route_data%& or &%route_list%&, is
19816 always separately expanded before use. If the expansion fails, the router
19817 declines. The result of the expansion must be a colon-separated list of names
19818 and/or IP addresses, optionally also including ports.
19819 If the list is written with spaces, it must be protected with quotes.
19820 The format of each item
19821 in the list is described in the next section. The list separator can be changed
19822 as described in section &<<SECTlistsepchange>>&.
19823
19824 If the list of hosts was obtained from a &%route_list%& item, the following
19825 variables are set during its expansion:
19826
19827 .ilist
19828 .cindex "numerical variables (&$1$& &$2$&  etc)" "in &(manualroute)& router"
19829 If the domain was matched against a regular expression, the numeric variables
19830 &$1$&, &$2$&, etc. may be set. For example:
19831 .code
19832 route_list = ^domain(\d+)   host-$1.text.example
19833 .endd
19834 .next
19835 &$0$& is always set to the entire domain.
19836 .next
19837 &$1$& is also set when partial matching is done in a file lookup.
19838
19839 .next
19840 .vindex "&$value$&"
19841 If the pattern that matched the domain was a lookup item, the data that was
19842 looked up is available in the expansion variable &$value$&. For example:
19843 .code
19844 route_list = lsearch;;/some/file.routes  $value
19845 .endd
19846 .endlist
19847
19848 Note the doubling of the semicolon in the pattern that is necessary because
19849 semicolon is the default route list separator.
19850
19851
19852
19853 .section "Format of one host item" "SECTformatonehostitem"
19854 Each item in the list of hosts is either a host name or an IP address,
19855 optionally with an attached port number. When no port is given, an IP address
19856 is not enclosed in brackets. When a port is specified, it overrides the port
19857 specification on the transport. The port is separated from the name or address
19858 by a colon. This leads to some complications:
19859
19860 .ilist
19861 Because colon is the default separator for the list of hosts, either
19862 the colon that specifies a port must be doubled, or the list separator must
19863 be changed. The following two examples have the same effect:
19864 .code
19865 route_list = * "host1.tld::1225 : host2.tld::1226"
19866 route_list = * "<+ host1.tld:1225 + host2.tld:1226"
19867 .endd
19868 .next
19869 When IPv6 addresses are involved, it gets worse, because they contain
19870 colons of their own. To make this case easier, it is permitted to
19871 enclose an IP address (either v4 or v6) in square brackets if a port
19872 number follows. For example:
19873 .code
19874 route_list = * "</ [10.1.1.1]:1225 / [::1]:1226"
19875 .endd
19876 .endlist
19877
19878 .section "How the list of hosts is used" "SECThostshowused"
19879 When an address is routed to an &(smtp)& transport by &(manualroute)&, each of
19880 the hosts is tried, in the order specified, when carrying out the SMTP
19881 delivery. However, the order can be changed by setting the &%hosts_randomize%&
19882 option, either on the router (see section &<<SECTprioptman>>& above), or on the
19883 transport.
19884
19885 Hosts may be listed by name or by IP address. An unadorned name in the list of
19886 hosts is interpreted as a host name. A name that is followed by &`/MX`& is
19887 interpreted as an indirection to a sublist of hosts obtained by looking up MX
19888 records in the DNS. For example:
19889 .code
19890 route_list = *  x.y.z:p.q.r/MX:e.f.g
19891 .endd
19892 If this feature is used with a port specifier, the port must come last. For
19893 example:
19894 .code
19895 route_list = *  dom1.tld/mx::1225
19896 .endd
19897 If the &%hosts_randomize%& option is set, the order of the items in the list is
19898 randomized before any lookups are done. Exim then scans the list; for any name
19899 that is not followed by &`/MX`& it looks up an IP address. If this turns out to
19900 be an interface on the local host and the item is not the first in the list,
19901 Exim discards it and any subsequent items. If it is the first item, what
19902 happens is controlled by the
19903 .oindex "&%self%&" "in &(manualroute)& router"
19904 &%self%& option of the router.
19905
19906 A name on the list that is followed by &`/MX`& is replaced with the list of
19907 hosts obtained by looking up MX records for the name. This is always a DNS
19908 lookup; the &%bydns%& and &%byname%& options (see section &<<SECThowoptused>>&
19909 below) are not relevant here. The order of these hosts is determined by the
19910 preference values in the MX records, according to the usual rules. Because
19911 randomizing happens before the MX lookup, it does not affect the order that is
19912 defined by MX preferences.
19913
19914 If the local host is present in the sublist obtained from MX records, but is
19915 not the most preferred host in that list, it and any equally or less
19916 preferred hosts are removed before the sublist is inserted into the main list.
19917
19918 If the local host is the most preferred host in the MX list, what happens
19919 depends on where in the original list of hosts the &`/MX`& item appears. If it
19920 is not the first item (that is, there are previous hosts in the main list),
19921 Exim discards this name and any subsequent items in the main list.
19922
19923 If the MX item is first in the list of hosts, and the local host is the
19924 most preferred host, what happens is controlled by the &%self%& option of the
19925 router.
19926
19927 DNS failures when lookup up the MX records are treated in the same way as DNS
19928 failures when looking up IP addresses: &%pass_on_timeout%& and
19929 &%host_find_failed%& are used when relevant.
19930
19931 The generic &%ignore_target_hosts%& option applies to all hosts in the list,
19932 whether obtained from an MX lookup or not.
19933
19934
19935
19936 .section "How the options are used" "SECThowoptused"
19937 The options are a sequence of words, space-separated.
19938 One of the words can be the name of a transport; this overrides the
19939 &%transport%& option on the router for this particular routing rule only. The
19940 other words (if present) control randomization of the list of hosts on a
19941 per-rule basis, and how the IP addresses of the hosts are to be found when
19942 routing to a remote transport. These options are as follows:
19943
19944 .ilist
19945 &%randomize%&: randomize the order of the hosts in this list, overriding the
19946 setting of &%hosts_randomize%& for this routing rule only.
19947 .next
19948 &%no_randomize%&: do not randomize the order of the hosts in this list,
19949 overriding the setting of &%hosts_randomize%& for this routing rule only.
19950 .next
19951 &%byname%&: use &[getipnodebyname()]& (&[gethostbyname()]& on older systems) to
19952 find IP addresses. This function may ultimately cause a DNS lookup, but it may
19953 also look in &_/etc/hosts_& or other sources of information.
19954 .next
19955 &%bydns%&: look up address records for the hosts directly in the DNS; fail if
19956 no address records are found. If there is a temporary DNS error (such as a
19957 timeout), delivery is deferred.
19958 .next
19959 &%ipv4_only%&: in direct DNS lookups, look up only A records.
19960 .next
19961 &%ipv4_prefer%&: in direct DNS lookups, sort A records before AAAA records.
19962 .endlist
19963
19964 For example:
19965 .code
19966 route_list = domain1  host1:host2:host3  randomize bydns;\
19967              domain2  host4:host5
19968 .endd
19969 If neither &%byname%& nor &%bydns%& is given, Exim behaves as follows: First, a
19970 DNS lookup is done. If this yields anything other than HOST_NOT_FOUND, that
19971 result is used. Otherwise, Exim goes on to try a call to &[getipnodebyname()]&
19972 or &[gethostbyname()]&, and the result of the lookup is the result of that
19973 call.
19974
19975 &*Warning*&: It has been discovered that on some systems, if a DNS lookup
19976 called via &[getipnodebyname()]& times out, HOST_NOT_FOUND is returned
19977 instead of TRY_AGAIN. That is why the default action is to try a DNS
19978 lookup first. Only if that gives a definite &"no such host"& is the local
19979 function called.
19980
19981 &*Compatibility*&: From Exim 4.85 until fixed for 4.90, there was an
19982 inadvertent constraint that a transport name as an option had to be the last
19983 option specified.
19984
19985
19986
19987 If no IP address for a host can be found, what happens is controlled by the
19988 &%host_find_failed%& option.
19989
19990 .vindex "&$host$&"
19991 When an address is routed to a local transport, IP addresses are not looked up.
19992 The host list is passed to the transport in the &$host$& variable.
19993
19994
19995
19996 .section "Manualroute examples" "SECID123"
19997 In some of the examples that follow, the presence of the &%remote_smtp%&
19998 transport, as defined in the default configuration file, is assumed:
19999
20000 .ilist
20001 .cindex "smart host" "example router"
20002 The &(manualroute)& router can be used to forward all external mail to a
20003 &'smart host'&. If you have set up, in the main part of the configuration, a
20004 named domain list that contains your local domains, for example:
20005 .code
20006 domainlist local_domains = my.domain.example
20007 .endd
20008 You can arrange for all other domains to be routed to a smart host by making
20009 your first router something like this:
20010 .code
20011 smart_route:
20012   driver = manualroute
20013   domains = !+local_domains
20014   transport = remote_smtp
20015   route_list = * smarthost.ref.example
20016 .endd
20017 This causes all non-local addresses to be sent to the single host
20018 &'smarthost.ref.example'&. If a colon-separated list of smart hosts is given,
20019 they are tried in order
20020 (but you can use &%hosts_randomize%& to vary the order each time).
20021 Another way of configuring the same thing is this:
20022 .code
20023 smart_route:
20024   driver = manualroute
20025   transport = remote_smtp
20026   route_list = !+local_domains  smarthost.ref.example
20027 .endd
20028 There is no difference in behaviour between these two routers as they stand.
20029 However, they behave differently if &%no_more%& is added to them. In the first
20030 example, the router is skipped if the domain does not match the &%domains%&
20031 precondition; the following router is always tried. If the router runs, it
20032 always matches the domain and so can never decline. Therefore, &%no_more%&
20033 would have no effect. In the second case, the router is never skipped; it
20034 always runs. However, if it doesn't match the domain, it declines. In this case
20035 &%no_more%& would prevent subsequent routers from running.
20036
20037 .next
20038 .cindex "mail hub example"
20039 A &'mail hub'& is a host which receives mail for a number of domains via MX
20040 records in the DNS and delivers it via its own private routing mechanism. Often
20041 the final destinations are behind a firewall, with the mail hub being the one
20042 machine that can connect to machines both inside and outside the firewall. The
20043 &(manualroute)& router is usually used on a mail hub to route incoming messages
20044 to the correct hosts. For a small number of domains, the routing can be inline,
20045 using the &%route_list%& option, but for a larger number a file or database
20046 lookup is easier to manage.
20047
20048 If the domain names are in fact the names of the machines to which the mail is
20049 to be sent by the mail hub, the configuration can be quite simple. For
20050 example:
20051 .code
20052 hub_route:
20053   driver = manualroute
20054   transport = remote_smtp
20055   route_list = *.rhodes.tvs.example  $domain
20056 .endd
20057 This configuration routes domains that match &`*.rhodes.tvs.example`& to hosts
20058 whose names are the same as the mail domains. A similar approach can be taken
20059 if the host name can be obtained from the domain name by a string manipulation
20060 that the expansion facilities can handle. Otherwise, a lookup based on the
20061 domain can be used to find the host:
20062 .code
20063 through_firewall:
20064   driver = manualroute
20065   transport = remote_smtp
20066   route_data = ${lookup {$domain} cdb {/internal/host/routes}}
20067 .endd
20068 The result of the lookup must be the name or IP address of the host (or
20069 hosts) to which the address is to be routed. If the lookup fails, the route
20070 data is empty, causing the router to decline. The address then passes to the
20071 next router.
20072
20073 .next
20074 .cindex "batched SMTP output example"
20075 .cindex "SMTP" "batched outgoing; example"
20076 You can use &(manualroute)& to deliver messages to pipes or files in batched
20077 SMTP format for onward transportation by some other means. This is one way of
20078 storing mail for a dial-up host when it is not connected. The route list entry
20079 can be as simple as a single domain name in a configuration like this:
20080 .code
20081 save_in_file:
20082   driver = manualroute
20083   transport = batchsmtp_appendfile
20084   route_list = saved.domain.example
20085 .endd
20086 though often a pattern is used to pick up more than one domain. If there are
20087 several domains or groups of domains with different transport requirements,
20088 different transports can be listed in the routing information:
20089 .code
20090 save_in_file:
20091   driver = manualroute
20092   route_list = \
20093     *.saved.domain1.example  $domain  batch_appendfile; \
20094     *.saved.domain2.example  \
20095       ${lookup{$domain}dbm{/domain2/hosts}{$value}fail} \
20096       batch_pipe
20097 .endd
20098 .vindex "&$domain$&"
20099 .vindex "&$host$&"
20100 The first of these just passes the domain in the &$host$& variable, which
20101 doesn't achieve much (since it is also in &$domain$&), but the second does a
20102 file lookup to find a value to pass, causing the router to decline to handle
20103 the address if the lookup fails.
20104
20105 .next
20106 .cindex "UUCP" "example of router for"
20107 Routing mail directly to UUCP software is a specific case of the use of
20108 &(manualroute)& in a gateway to another mail environment. This is an example of
20109 one way it can be done:
20110 .code
20111 # Transport
20112 uucp:
20113   driver = pipe
20114   user = nobody
20115   command = /usr/local/bin/uux -r - \
20116     ${substr_-5:$host}!rmail ${local_part}
20117   return_fail_output = true
20118
20119 # Router
20120 uucphost:
20121   transport = uucp
20122   driver = manualroute
20123   route_data = \
20124     ${lookup{$domain}lsearch{/usr/local/exim/uucphosts}}
20125 .endd
20126 The file &_/usr/local/exim/uucphosts_& contains entries like
20127 .code
20128 darksite.ethereal.example:           darksite.UUCP
20129 .endd
20130 It can be set up more simply without adding and removing &".UUCP"& but this way
20131 makes clear the distinction between the domain name
20132 &'darksite.ethereal.example'& and the UUCP host name &'darksite'&.
20133 .endlist
20134 .ecindex IIDmanrou1
20135 .ecindex IIDmanrou2
20136
20137
20138
20139
20140
20141
20142
20143
20144 . ////////////////////////////////////////////////////////////////////////////
20145 . ////////////////////////////////////////////////////////////////////////////
20146
20147 .chapter "The queryprogram router" "CHAPdriverlast"
20148 .scindex IIDquerou1 "&(queryprogram)& router"
20149 .scindex IIDquerou2 "routers" "&(queryprogram)&"
20150 .cindex "routing" "by external program"
20151 The &(queryprogram)& router routes an address by running an external command
20152 and acting on its output. This is an expensive way to route, and is intended
20153 mainly for use in lightly-loaded systems, or for performing experiments.
20154 However, if it is possible to use the precondition options (&%domains%&,
20155 &%local_parts%&, etc) to skip this router for most addresses, it could sensibly
20156 be used in special cases, even on a busy host. There are the following private
20157 options:
20158 .cindex "options" "&(queryprogram)& router"
20159
20160 .option command queryprogram string&!! unset
20161 This option must be set. It specifies the command that is to be run. The
20162 command is split up into a command name and arguments, and then each is
20163 expanded separately (exactly as for a &(pipe)& transport, described in chapter
20164 &<<CHAPpipetransport>>&).
20165
20166
20167 .option command_group queryprogram string unset
20168 .cindex "gid (group id)" "in &(queryprogram)& router"
20169 This option specifies a gid to be set when running the command while routing an
20170 address for deliver. It must be set if &%command_user%& specifies a numerical
20171 uid. If it begins with a digit, it is interpreted as the numerical value of the
20172 gid. Otherwise it is looked up using &[getgrnam()]&.
20173
20174
20175 .option command_user queryprogram string unset
20176 .cindex "uid (user id)" "for &(queryprogram)&"
20177 This option must be set. It specifies the uid which is set when running the
20178 command while routing an address for delivery. If the value begins with a digit,
20179 it is interpreted as the numerical value of the uid. Otherwise, it is looked up
20180 using &[getpwnam()]& to obtain a value for the uid and, if &%command_group%& is
20181 not set, a value for the gid also.
20182
20183 &*Warning:*& Changing uid and gid is possible only when Exim is running as
20184 root, which it does during a normal delivery in a conventional configuration.
20185 However, when an address is being verified during message reception, Exim is
20186 usually running as the Exim user, not as root. If the &(queryprogram)& router
20187 is called from a non-root process, Exim cannot change uid or gid before running
20188 the command. In this circumstance the command runs under the current uid and
20189 gid.
20190
20191
20192 .option current_directory queryprogram string /
20193 This option specifies an absolute path which is made the current directory
20194 before running the command.
20195
20196
20197 .option timeout queryprogram time 1h
20198 If the command does not complete within the timeout period, its process group
20199 is killed and the message is frozen. A value of zero time specifies no
20200 timeout.
20201
20202
20203 The standard output of the command is connected to a pipe, which is read when
20204 the command terminates. It should consist of a single line of output,
20205 containing up to five fields, separated by white space. The maximum length of
20206 the line is 1023 characters. Longer lines are silently truncated. The first
20207 field is one of the following words (case-insensitive):
20208
20209 .ilist
20210 &'Accept'&: routing succeeded; the remaining fields specify what to do (see
20211 below).
20212 .next
20213 &'Decline'&: the router declines; pass the address to the next router, unless
20214 &%no_more%& is set.
20215 .next
20216 &'Fail'&: routing failed; do not pass the address to any more routers. Any
20217 subsequent text on the line is an error message. If the router is run as part
20218 of address verification during an incoming SMTP message, the message is
20219 included in the SMTP response.
20220 .next
20221 &'Defer'&: routing could not be completed at this time; try again later. Any
20222 subsequent text on the line is an error message which is logged. It is not
20223 included in any SMTP response.
20224 .next
20225 &'Freeze'&: the same as &'defer'&, except that the message is frozen.
20226 .next
20227 &'Pass'&: pass the address to the next router (or the router specified by
20228 &%pass_router%&), overriding &%no_more%&.
20229 .next
20230 &'Redirect'&: the message is redirected. The remainder of the line is a list of
20231 new addresses, which are routed independently, starting with the first router,
20232 or the router specified by &%redirect_router%&, if set.
20233 .endlist
20234
20235 When the first word is &'accept'&, the remainder of the line consists of a
20236 number of keyed data values, as follows (split into two lines here, to fit on
20237 the page):
20238 .code
20239 ACCEPT TRANSPORT=<transport> HOSTS=<list of hosts>
20240 LOOKUP=byname|bydns DATA=<text>
20241 .endd
20242 The data items can be given in any order, and all are optional. If no transport
20243 is included, the transport specified by the generic &%transport%& option is
20244 used. The list of hosts and the lookup type are needed only if the transport is
20245 an &(smtp)& transport that does not itself supply a list of hosts.
20246
20247 The format of the list of hosts is the same as for the &(manualroute)& router.
20248 As well as host names and IP addresses with optional port numbers, as described
20249 in section &<<SECTformatonehostitem>>&, it may contain names followed by
20250 &`/MX`& to specify sublists of hosts that are obtained by looking up MX records
20251 (see section &<<SECThostshowused>>&).
20252
20253 If the lookup type is not specified, Exim behaves as follows when trying to
20254 find an IP address for each host: First, a DNS lookup is done. If this yields
20255 anything other than HOST_NOT_FOUND, that result is used. Otherwise, Exim
20256 goes on to try a call to &[getipnodebyname()]& or &[gethostbyname()]&, and the
20257 result of the lookup is the result of that call.
20258
20259 .vindex "&$address_data$&"
20260 If the DATA field is set, its value is placed in the &$address_data$&
20261 variable. For example, this return line
20262 .code
20263 accept hosts=x1.y.example:x2.y.example data="rule1"
20264 .endd
20265 routes the address to the default transport, passing a list of two hosts. When
20266 the transport runs, the string &"rule1"& is in &$address_data$&.
20267 .ecindex IIDquerou1
20268 .ecindex IIDquerou2
20269
20270
20271
20272
20273 . ////////////////////////////////////////////////////////////////////////////
20274 . ////////////////////////////////////////////////////////////////////////////
20275
20276 .chapter "The redirect router" "CHAPredirect"
20277 .scindex IIDredrou1 "&(redirect)& router"
20278 .scindex IIDredrou2 "routers" "&(redirect)&"
20279 .cindex "alias file" "in a &(redirect)& router"
20280 .cindex "address redirection" "&(redirect)& router"
20281 The &(redirect)& router handles several kinds of address redirection. Its most
20282 common uses are for resolving local part aliases from a central alias file
20283 (usually called &_/etc/aliases_&) and for handling users' personal &_.forward_&
20284 files, but it has many other potential uses. The incoming address can be
20285 redirected in several different ways:
20286
20287 .ilist
20288 It can be replaced by one or more new addresses which are themselves routed
20289 independently.
20290 .next
20291 It can be routed to be delivered to a given file or directory.
20292 .next
20293 It can be routed to be delivered to a specified pipe command.
20294 .next
20295 It can cause an automatic reply to be generated.
20296 .next
20297 It can be forced to fail, optionally with a custom error message.
20298 .next
20299 It can be temporarily deferred, optionally with a custom message.
20300 .next
20301 It can be discarded.
20302 .endlist
20303
20304 The generic &%transport%& option must not be set for &(redirect)& routers.
20305 However, there are some private options which define transports for delivery to
20306 files and pipes, and for generating autoreplies. See the &%file_transport%&,
20307 &%pipe_transport%& and &%reply_transport%& descriptions below.
20308
20309 If success DSNs have been requested
20310 .cindex "DSN" "success"
20311 .cindex "Delivery Status Notification" "success"
20312 redirection triggers one and the DSN options are not passed any further.
20313
20314
20315
20316 .section "Redirection data" "SECID124"
20317 The router operates by interpreting a text string which it obtains either by
20318 expanding the contents of the &%data%& option, or by reading the entire
20319 contents of a file whose name is given in the &%file%& option. These two
20320 options are mutually exclusive. The first is commonly used for handling system
20321 aliases, in a configuration like this:
20322 .code
20323 system_aliases:
20324   driver = redirect
20325   data = ${lookup{$local_part}lsearch{/etc/aliases}}
20326 .endd
20327 If the lookup fails, the expanded string in this example is empty. When the
20328 expansion of &%data%& results in an empty string, the router declines. A forced
20329 expansion failure also causes the router to decline; other expansion failures
20330 cause delivery to be deferred.
20331
20332 A configuration using &%file%& is commonly used for handling users'
20333 &_.forward_& files, like this:
20334 .code
20335 userforward:
20336   driver = redirect
20337   check_local_user
20338   file = $home/.forward
20339   no_verify
20340 .endd
20341 If the file does not exist, or causes no action to be taken (for example, it is
20342 empty or consists only of comments), the router declines. &*Warning*&: This
20343 is not the case when the file contains syntactically valid items that happen to
20344 yield empty addresses, for example, items containing only RFC 2822 address
20345 comments.
20346
20347
20348
20349 .section "Forward files and address verification" "SECID125"
20350 .cindex "address redirection" "while verifying"
20351 It is usual to set &%no_verify%& on &(redirect)& routers which handle users'
20352 &_.forward_& files, as in the example above. There are two reasons for this:
20353
20354 .ilist
20355 When Exim is receiving an incoming SMTP message from a remote host, it is
20356 running under the Exim uid, not as root. Exim is unable to change uid to read
20357 the file as the user, and it may not be able to read it as the Exim user. So in
20358 practice the router may not be able to operate.
20359 .next
20360 However, even when the router can operate, the existence of a &_.forward_& file
20361 is unimportant when verifying an address. What should be checked is whether the
20362 local part is a valid user name or not. Cutting out the redirection processing
20363 saves some resources.
20364 .endlist
20365
20366
20367
20368
20369
20370
20371 .section "Interpreting redirection data" "SECID126"
20372 .cindex "Sieve filter" "specifying in redirection data"
20373 .cindex "filter" "specifying in redirection data"
20374 The contents of the data string, whether obtained from &%data%& or &%file%&,
20375 can be interpreted in two different ways:
20376
20377 .ilist
20378 If the &%allow_filter%& option is set true, and the data begins with the text
20379 &"#Exim filter"& or &"#Sieve filter"&, it is interpreted as a list of
20380 &'filtering'& instructions in the form of an Exim or Sieve filter file,
20381 respectively. Details of the syntax and semantics of filter files are described
20382 in a separate document entitled &'Exim's interfaces to mail filtering'&; this
20383 document is intended for use by end users.
20384 .next
20385 Otherwise, the data must be a comma-separated list of redirection items, as
20386 described in the next section.
20387 .endlist
20388
20389 When a message is redirected to a file (a &"mail folder"&), the filename given
20390 in a non-filter redirection list must always be an absolute path. A filter may
20391 generate a relative path &-- how this is handled depends on the transport's
20392 configuration. See section &<<SECTfildiropt>>& for a discussion of this issue
20393 for the &(appendfile)& transport.
20394
20395
20396
20397 .section "Items in a non-filter redirection list" "SECTitenonfilred"
20398 .cindex "address redirection" "non-filter list items"
20399 When the redirection data is not an Exim or Sieve filter, for example, if it
20400 comes from a conventional alias or forward file, it consists of a list of
20401 addresses, filenames, pipe commands, or certain special items (see section
20402 &<<SECTspecitredli>>& below). The special items can be individually enabled or
20403 disabled by means of options whose names begin with &%allow_%& or &%forbid_%&,
20404 depending on their default values. The items in the list are separated by
20405 commas or newlines.
20406 If a comma is required in an item, the entire item must be enclosed in double
20407 quotes.
20408
20409 Lines starting with a # character are comments, and are ignored, and # may
20410 also appear following a comma, in which case everything between the # and the
20411 next newline character is ignored.
20412
20413 If an item is entirely enclosed in double quotes, these are removed. Otherwise
20414 double quotes are retained because some forms of mail address require their use
20415 (but never to enclose the entire address). In the following description,
20416 &"item"& refers to what remains after any surrounding double quotes have been
20417 removed.
20418
20419 .vindex "&$local_part$&"
20420 &*Warning*&: If you use an Exim expansion to construct a redirection address,
20421 and the expansion contains a reference to &$local_part$&, you should make use
20422 of the &%quote_local_part%& expansion operator, in case the local part contains
20423 special characters. For example, to redirect all mail for the domain
20424 &'obsolete.example'&, retaining the existing local part, you could use this
20425 setting:
20426 .code
20427 data = ${quote_local_part:$local_part}@newdomain.example
20428 .endd
20429
20430
20431 .section "Redirecting to a local mailbox" "SECTredlocmai"
20432 .cindex "routing" "loops in"
20433 .cindex "loop" "while routing, avoidance of"
20434 .cindex "address redirection" "to local mailbox"
20435 A redirection item may safely be the same as the address currently under
20436 consideration. This does not cause a routing loop, because a router is
20437 automatically skipped if any ancestor of the address that is being processed
20438 is the same as the current address and was processed by the current router.
20439 Such an address is therefore passed to the following routers, so it is handled
20440 as if there were no redirection. When making this loop-avoidance test, the
20441 complete local part, including any prefix or suffix, is used.
20442
20443 .cindex "address redirection" "local part without domain"
20444 Specifying the same local part without a domain is a common usage in personal
20445 filter files when the user wants to have messages delivered to the local
20446 mailbox and also forwarded elsewhere. For example, the user whose login is
20447 &'cleo'& might have a &_.forward_& file containing this:
20448 .code
20449 cleo, cleopatra@egypt.example
20450 .endd
20451 .cindex "backslash in alias file"
20452 .cindex "alias file" "backslash in"
20453 For compatibility with other MTAs, such unqualified local parts may be
20454 preceded by &"\"&, but this is not a requirement for loop prevention. However,
20455 it does make a difference if more than one domain is being handled
20456 synonymously.
20457
20458 If an item begins with &"\"& and the rest of the item parses as a valid RFC
20459 2822 address that does not include a domain, the item is qualified using the
20460 domain of the incoming address. In the absence of a leading &"\"&, unqualified
20461 addresses are qualified using the value in &%qualify_recipient%&, but you can
20462 force the incoming domain to be used by setting &%qualify_preserve_domain%&.
20463
20464 Care must be taken if there are alias names for local users.
20465 Consider an MTA handling a single local domain where the system alias file
20466 contains:
20467 .code
20468 Sam.Reman: spqr
20469 .endd
20470 Now suppose that Sam (whose login id is &'spqr'&) wants to save copies of
20471 messages in the local mailbox, and also forward copies elsewhere. He creates
20472 this forward file:
20473 .code
20474 Sam.Reman, spqr@reme.elsewhere.example
20475 .endd
20476 With these settings, an incoming message addressed to &'Sam.Reman'& fails. The
20477 &(redirect)& router for system aliases does not process &'Sam.Reman'& the
20478 second time round, because it has previously routed it,
20479 and the following routers presumably cannot handle the alias. The forward file
20480 should really contain
20481 .code
20482 spqr, spqr@reme.elsewhere.example
20483 .endd
20484 but because this is such a common error, the &%check_ancestor%& option (see
20485 below) exists to provide a way to get round it. This is normally set on a
20486 &(redirect)& router that is handling users' &_.forward_& files.
20487
20488
20489
20490 .section "Special items in redirection lists" "SECTspecitredli"
20491 In addition to addresses, the following types of item may appear in redirection
20492 lists (that is, in non-filter redirection data):
20493
20494 .ilist
20495 .cindex "pipe" "in redirection list"
20496 .cindex "address redirection" "to pipe"
20497 An item is treated as a pipe command if it begins with &"|"& and does not parse
20498 as a valid RFC 2822 address that includes a domain. A transport for running the
20499 command must be specified by the &%pipe_transport%& option.
20500 Normally, either the router or the transport specifies a user and a group under
20501 which to run the delivery. The default is to use the Exim user and group.
20502
20503 Single or double quotes can be used for enclosing the individual arguments of
20504 the pipe command; no interpretation of escapes is done for single quotes. If
20505 the command contains a comma character, it is necessary to put the whole item
20506 in double quotes, for example:
20507 .code
20508 "|/some/command ready,steady,go"
20509 .endd
20510 since items in redirection lists are terminated by commas. Do not, however,
20511 quote just the command. An item such as
20512 .code
20513 |"/some/command ready,steady,go"
20514 .endd
20515 is interpreted as a pipe with a rather strange command name, and no arguments.
20516
20517 Note that the above example assumes that the text comes from a lookup source
20518 of some sort, so that the quotes are part of the data.  If composing a
20519 redirect router with a &%data%& option directly specifying this command, the
20520 quotes will be used by the configuration parser to define the extent of one
20521 string, but will not be passed down into the redirect router itself.  There
20522 are two main approaches to get around this: escape quotes to be part of the
20523 data itself, or avoid using this mechanism and instead create a custom
20524 transport with the &%command%& option set and reference that transport from
20525 an &%accept%& router.
20526
20527 .next
20528 .cindex "file" "in redirection list"
20529 .cindex "address redirection" "to file"
20530 An item is interpreted as a path name if it begins with &"/"& and does not
20531 parse as a valid RFC 2822 address that includes a domain. For example,
20532 .code
20533 /home/world/minbari
20534 .endd
20535 is treated as a filename, but
20536 .code
20537 /s=molari/o=babylon/@x400gate.way
20538 .endd
20539 is treated as an address. For a filename, a transport must be specified using
20540 the &%file_transport%& option. However, if the generated path name ends with a
20541 forward slash character, it is interpreted as a directory name rather than a
20542 filename, and &%directory_transport%& is used instead.
20543
20544 Normally, either the router or the transport specifies a user and a group under
20545 which to run the delivery. The default is to use the Exim user and group.
20546
20547 .cindex "&_/dev/null_&"
20548 However, if a redirection item is the path &_/dev/null_&, delivery to it is
20549 bypassed at a high level, and the log entry shows &"**bypassed**"&
20550 instead of a transport name. In this case the user and group are not used.
20551
20552 .next
20553 .cindex "included address list"
20554 .cindex "address redirection" "included external list"
20555 If an item is of the form
20556 .code
20557 :include:<path name>
20558 .endd
20559 a list of further items is taken from the given file and included at that
20560 point. &*Note*&: Such a file can not be a filter file; it is just an
20561 out-of-line addition to the list. The items in the included list are separated
20562 by commas or newlines and are not subject to expansion. If this is the first
20563 item in an alias list in an &(lsearch)& file, a colon must be used to terminate
20564 the alias name. This example is incorrect:
20565 .code
20566 list1    :include:/opt/lists/list1
20567 .endd
20568 It must be given as
20569 .code
20570 list1:   :include:/opt/lists/list1
20571 .endd
20572 .next
20573 .cindex "address redirection" "to black hole"
20574 .cindex "delivery" "discard"
20575 .cindex "delivery" "blackhole"
20576 .cindex "black hole"
20577 .cindex "abandoning mail"
20578 Sometimes you want to throw away mail to a particular local part.  Making the
20579 &%data%& option expand to an empty string does not work, because that causes
20580 the router to decline. Instead, the alias item
20581 .code
20582 :blackhole:
20583 .endd
20584 can be used. It does what its name implies. No delivery is
20585 done, and no error message is generated. This has the same effect as specifying
20586 &_/dev/null_& as a destination, but it can be independently disabled.
20587
20588 &*Warning*&: If &':blackhole:'& appears anywhere in a redirection list, no
20589 delivery is done for the original local part, even if other redirection items
20590 are present. If you are generating a multi-item list (for example, by reading a
20591 database) and need the ability to provide a no-op item, you must use
20592 &_/dev/null_&.
20593
20594 .next
20595 .cindex "delivery" "forcing failure"
20596 .cindex "delivery" "forcing deferral"
20597 .cindex "failing delivery" "forcing"
20598 .cindex "deferred delivery, forcing"
20599 .cindex "customizing" "failure message"
20600 An attempt to deliver a particular address can be deferred or forced to fail by
20601 redirection items of the form
20602 .code
20603 :defer:
20604 :fail:
20605 .endd
20606 respectively. When a redirection list contains such an item, it applies
20607 to the entire redirection; any other items in the list are ignored. Any
20608 text following &':fail:'& or &':defer:'& is placed in the error text
20609 associated with the failure. For example, an alias file might contain:
20610 .code
20611 X.Employee:  :fail: Gone away, no forwarding address
20612 .endd
20613 In the case of an address that is being verified from an ACL or as the subject
20614 of a
20615 .cindex "VRFY" "error text, display of"
20616 VRFY command, the text is included in the SMTP error response by
20617 default.
20618 .cindex "EXPN" "error text, display of"
20619 The text is not included in the response to an EXPN command. In non-SMTP cases
20620 the text is included in the error message that Exim generates.
20621
20622 .cindex "SMTP" "error codes"
20623 By default, Exim sends a 451 SMTP code for a &':defer:'&, and 550 for
20624 &':fail:'&. However, if the message starts with three digits followed by a
20625 space, optionally followed by an extended code of the form &'n.n.n'&, also
20626 followed by a space, and the very first digit is the same as the default error
20627 code, the code from the message is used instead. If the very first digit is
20628 incorrect, a panic error is logged, and the default code is used. You can
20629 suppress the use of the supplied code in a redirect router by setting the
20630 &%forbid_smtp_code%& option true. In this case, any SMTP code is quietly
20631 ignored.
20632
20633 .vindex "&$acl_verify_message$&"
20634 In an ACL, an explicitly provided message overrides the default, but the
20635 default message is available in the variable &$acl_verify_message$& and can
20636 therefore be included in a custom message if this is desired.
20637
20638 Normally the error text is the rest of the redirection list &-- a comma does
20639 not terminate it &-- but a newline does act as a terminator. Newlines are not
20640 normally present in alias expansions. In &(lsearch)& lookups they are removed
20641 as part of the continuation process, but they may exist in other kinds of
20642 lookup and in &':include:'& files.
20643
20644 During routing for message delivery (as opposed to verification), a redirection
20645 containing &':fail:'& causes an immediate failure of the incoming address,
20646 whereas &':defer:'& causes the message to remain in the queue so that a
20647 subsequent delivery attempt can happen at a later time. If an address is
20648 deferred for too long, it will ultimately fail, because the normal retry
20649 rules still apply.
20650
20651 .next
20652 .cindex "alias file" "exception to default"
20653 Sometimes it is useful to use a single-key search type with a default (see
20654 chapter &<<CHAPfdlookup>>&) to look up aliases. However, there may be a need
20655 for exceptions to the default. These can be handled by aliasing them to
20656 &':unknown:'&. This differs from &':fail:'& in that it causes the &(redirect)&
20657 router to decline, whereas &':fail:'& forces routing to fail. A lookup which
20658 results in an empty redirection list has the same effect.
20659 .endlist
20660
20661
20662 .section "Duplicate addresses" "SECTdupaddr"
20663 .cindex "duplicate addresses"
20664 .cindex "address duplicate, discarding"
20665 .cindex "pipe" "duplicated"
20666 Exim removes duplicate addresses from the list to which it is delivering, so as
20667 to deliver just one copy to each address. This does not apply to deliveries
20668 routed to pipes by different immediate parent addresses, but an indirect
20669 aliasing scheme of the type
20670 .code
20671 pipe:       |/some/command $local_part
20672 localpart1: pipe
20673 localpart2: pipe
20674 .endd
20675 does not work with a message that is addressed to both local parts, because
20676 when the second is aliased to the intermediate local part &"pipe"& it gets
20677 discarded as being the same as a previously handled address. However, a scheme
20678 such as
20679 .code
20680 localpart1: |/some/command $local_part
20681 localpart2: |/some/command $local_part
20682 .endd
20683 does result in two different pipe deliveries, because the immediate parents of
20684 the pipes are distinct.
20685
20686
20687
20688 .section "Repeated redirection expansion" "SECID128"
20689 .cindex "repeated redirection expansion"
20690 .cindex "address redirection" "repeated for each delivery attempt"
20691 When a message cannot be delivered to all of its recipients immediately,
20692 leading to two or more delivery attempts, redirection expansion is carried out
20693 afresh each time for those addresses whose children were not all previously
20694 delivered. If redirection is being used as a mailing list, this can lead to new
20695 members of the list receiving copies of old messages. The &%one_time%& option
20696 can be used to avoid this.
20697
20698
20699 .section "Errors in redirection lists" "SECID129"
20700 .cindex "address redirection" "errors"
20701 If &%skip_syntax_errors%& is set, a malformed address that causes a parsing
20702 error is skipped, and an entry is written to the main log. This may be useful
20703 for mailing lists that are automatically managed. Otherwise, if an error is
20704 detected while generating the list of new addresses, the original address is
20705 deferred. See also &%syntax_errors_to%&.
20706
20707
20708
20709 .section "Private options for the redirect router" "SECID130"
20710
20711 .cindex "options" "&(redirect)& router"
20712 The private options for the &(redirect)& router are as follows:
20713
20714
20715 .option allow_defer redirect boolean false
20716 Setting this option allows the use of &':defer:'& in non-filter redirection
20717 data, or the &%defer%& command in an Exim filter file.
20718
20719
20720 .option allow_fail redirect boolean false
20721 .cindex "failing delivery" "from filter"
20722 If this option is true, the &':fail:'& item can be used in a redirection list,
20723 and the &%fail%& command may be used in an Exim filter file.
20724
20725
20726 .option allow_filter redirect boolean false
20727 .cindex "filter" "enabling use of"
20728 .cindex "Sieve filter" "enabling use of"
20729 Setting this option allows Exim to interpret redirection data that starts with
20730 &"#Exim filter"& or &"#Sieve filter"& as a set of filtering instructions. There
20731 are some features of Exim filter files that some administrators may wish to
20732 lock out; see the &%forbid_filter_%&&'xxx'& options below.
20733
20734 It is also possible to lock out Exim filters or Sieve filters while allowing
20735 the other type; see &%forbid_exim_filter%& and &%forbid_sieve_filter%&.
20736
20737
20738 The filter is run using the uid and gid set by the generic &%user%& and
20739 &%group%& options. These take their defaults from the password data if
20740 &%check_local_user%& is set, so in the normal case of users' personal filter
20741 files, the filter is run as the relevant user. When &%allow_filter%& is set
20742 true, Exim insists that either &%check_local_user%& or &%user%& is set.
20743
20744
20745
20746 .option allow_freeze redirect boolean false
20747 .cindex "freezing messages" "allowing in filter"
20748 Setting this option allows the use of the &%freeze%& command in an Exim filter.
20749 This command is more normally encountered in system filters, and is disabled by
20750 default for redirection filters because it isn't something you usually want to
20751 let ordinary users do.
20752
20753
20754
20755 .option check_ancestor redirect boolean false
20756 This option is concerned with handling generated addresses that are the same
20757 as some address in the list of redirection ancestors of the current address.
20758 Although it is turned off by default in the code, it is set in the default
20759 configuration file for handling users' &_.forward_& files. It is recommended
20760 for this use of the &(redirect)& router.
20761
20762 When &%check_ancestor%& is set, if a generated address (including the domain)
20763 is the same as any ancestor of the current address, it is replaced by a copy of
20764 the current address. This helps in the case where local part A is aliased to B,
20765 and B has a &_.forward_& file pointing back to A. For example, within a single
20766 domain, the local part &"Joe.Bloggs"& is aliased to &"jb"& and
20767 &_&~jb/.forward_& contains:
20768 .code
20769 \Joe.Bloggs, <other item(s)>
20770 .endd
20771 Without the &%check_ancestor%& setting, either local part (&"jb"& or
20772 &"joe.bloggs"&) gets processed once by each router and so ends up as it was
20773 originally. If &"jb"& is the real mailbox name, mail to &"jb"& gets delivered
20774 (having been turned into &"joe.bloggs"& by the &_.forward_& file and back to
20775 &"jb"& by the alias), but mail to &"joe.bloggs"& fails. Setting
20776 &%check_ancestor%& on the &(redirect)& router that handles the &_.forward_&
20777 file prevents it from turning &"jb"& back into &"joe.bloggs"& when that was the
20778 original address. See also the &%repeat_use%& option below.
20779
20780
20781 .option check_group redirect boolean "see below"
20782 When the &%file%& option is used, the group owner of the file is checked only
20783 when this option is set. The permitted groups are those listed in the
20784 &%owngroups%& option, together with the user's default group if
20785 &%check_local_user%& is set. If the file has the wrong group, routing is
20786 deferred. The default setting for this option is true if &%check_local_user%&
20787 is set and the &%modemask%& option permits the group write bit, or if the
20788 &%owngroups%& option is set. Otherwise it is false, and no group check occurs.
20789
20790
20791
20792 .option check_owner redirect boolean "see below"
20793 When the &%file%& option is used, the owner of the file is checked only when
20794 this option is set. If &%check_local_user%& is set, the local user is
20795 permitted; otherwise the owner must be one of those listed in the &%owners%&
20796 option. The default value for this option is true if &%check_local_user%& or
20797 &%owners%& is set. Otherwise the default is false, and no owner check occurs.
20798
20799
20800 .option data redirect string&!! unset
20801 This option is mutually exclusive with &%file%&. One or other of them must be
20802 set, but not both. The contents of &%data%& are expanded, and then used as the
20803 list of forwarding items, or as a set of filtering instructions. If the
20804 expansion is forced to fail, or the result is an empty string or a string that
20805 has no effect (consists entirely of comments), the router declines.
20806
20807 When filtering instructions are used, the string must begin with &"#Exim
20808 filter"&, and all comments in the string, including this initial one, must be
20809 terminated with newline characters. For example:
20810 .code
20811 data = #Exim filter\n\
20812        if $h_to: contains Exim then save $home/mail/exim endif
20813 .endd
20814 If you are reading the data from a database where newlines cannot be included,
20815 you can use the &${sg}$& expansion item to turn the escape string of your
20816 choice into a newline.
20817
20818
20819 .option directory_transport redirect string&!! unset
20820 A &(redirect)& router sets up a direct delivery to a directory when a path name
20821 ending with a slash is specified as a new &"address"&. The transport used is
20822 specified by this option, which, after expansion, must be the name of a
20823 configured transport. This should normally be an &(appendfile)& transport.
20824
20825
20826 .option file redirect string&!! unset
20827 This option specifies the name of a file that contains the redirection data. It
20828 is mutually exclusive with the &%data%& option. The string is expanded before
20829 use; if the expansion is forced to fail, the router declines. Other expansion
20830 failures cause delivery to be deferred. The result of a successful expansion
20831 must be an absolute path. The entire file is read and used as the redirection
20832 data. If the data is an empty string or a string that has no effect (consists
20833 entirely of comments), the router declines.
20834
20835 .cindex "NFS" "checking for file existence"
20836 If the attempt to open the file fails with a &"does not exist"& error, Exim
20837 runs a check on the containing directory,
20838 unless &%ignore_enotdir%& is true (see below).
20839 If the directory does not appear to exist, delivery is deferred. This can
20840 happen when users' &_.forward_& files are in NFS-mounted directories, and there
20841 is a mount problem. If the containing directory does exist, but the file does
20842 not, the router declines.
20843
20844
20845 .option file_transport redirect string&!! unset
20846 .vindex "&$address_file$&"
20847 A &(redirect)& router sets up a direct delivery to a file when a path name not
20848 ending in a slash is specified as a new &"address"&. The transport used is
20849 specified by this option, which, after expansion, must be the name of a
20850 configured transport. This should normally be an &(appendfile)& transport. When
20851 it is running, the filename is in &$address_file$&.
20852
20853
20854 .option filter_prepend_home redirect boolean true
20855 When this option is true, if a &(save)& command in an Exim filter specifies a
20856 relative path, and &$home$& is defined, it is automatically prepended to the
20857 relative path. If this option is set false, this action does not happen. The
20858 relative path is then passed to the transport unmodified.
20859
20860
20861 .option forbid_blackhole redirect boolean false
20862 .cindex "restricting access to features"
20863 .cindex "filter" "locking out certain features"
20864 If this option is true, the &':blackhole:'& item may not appear in a
20865 redirection list.
20866
20867
20868 .option forbid_exim_filter redirect boolean false
20869 .cindex "restricting access to features"
20870 .cindex "filter" "locking out certain features"
20871 If this option is set true, only Sieve filters are permitted when
20872 &%allow_filter%& is true.
20873
20874
20875
20876
20877 .option forbid_file redirect boolean false
20878 .cindex "restricting access to features"
20879 .cindex "delivery" "to file; forbidding"
20880 .cindex "filter" "locking out certain features"
20881 .cindex "Sieve filter" "forbidding delivery to a file"
20882 .cindex "Sieve filter" "&""keep""& facility; disabling"
20883 If this option is true, this router may not generate a new address that
20884 specifies delivery to a local file or directory, either from a filter or from a
20885 conventional forward file. This option is forced to be true if &%one_time%& is
20886 set. It applies to Sieve filters as well as to Exim filters, but if true, it
20887 locks out the Sieve's &"keep"& facility.
20888
20889
20890 .option forbid_filter_dlfunc redirect boolean false
20891 .cindex "restricting access to features"
20892 .cindex "filter" "locking out certain features"
20893 If this option is true, string expansions in Exim filters are not allowed to
20894 make use of the &%dlfunc%& expansion facility to run dynamically loaded
20895 functions.
20896
20897 .option forbid_filter_existstest redirect boolean false
20898 .cindex "restricting access to features"
20899 .cindex "filter" "locking out certain features"
20900 .cindex "expansion" "statting a file"
20901 If this option is true, string expansions in Exim filters are not allowed to
20902 make use of the &%exists%& condition or the &%stat%& expansion item.
20903
20904 .option forbid_filter_logwrite redirect boolean false
20905 .cindex "restricting access to features"
20906 .cindex "filter" "locking out certain features"
20907 If this option is true, use of the logging facility in Exim filters is not
20908 permitted. Logging is in any case available only if the filter is being run
20909 under some unprivileged uid (which is normally the case for ordinary users'
20910 &_.forward_& files).
20911
20912
20913 .option forbid_filter_lookup redirect boolean false
20914 .cindex "restricting access to features"
20915 .cindex "filter" "locking out certain features"
20916 If this option is true, string expansions in Exim filter files are not allowed
20917 to make use of &%lookup%& items.
20918
20919
20920 .option forbid_filter_perl redirect boolean false
20921 .cindex "restricting access to features"
20922 .cindex "filter" "locking out certain features"
20923 This option has an effect only if Exim is built with embedded Perl support. If
20924 it is true, string expansions in Exim filter files are not allowed to make use
20925 of the embedded Perl support.
20926
20927
20928 .option forbid_filter_readfile redirect boolean false
20929 .cindex "restricting access to features"
20930 .cindex "filter" "locking out certain features"
20931 If this option is true, string expansions in Exim filter files are not allowed
20932 to make use of &%readfile%& items.
20933
20934
20935 .option forbid_filter_readsocket redirect boolean false
20936 .cindex "restricting access to features"
20937 .cindex "filter" "locking out certain features"
20938 If this option is true, string expansions in Exim filter files are not allowed
20939 to make use of &%readsocket%& items.
20940
20941
20942 .option forbid_filter_reply redirect boolean false
20943 .cindex "restricting access to features"
20944 .cindex "filter" "locking out certain features"
20945 If this option is true, this router may not generate an automatic reply
20946 message. Automatic replies can be generated only from Exim or Sieve filter
20947 files, not from traditional forward files. This option is forced to be true if
20948 &%one_time%& is set.
20949
20950
20951 .option forbid_filter_run redirect boolean false
20952 .cindex "restricting access to features"
20953 .cindex "filter" "locking out certain features"
20954 If this option is true, string expansions in Exim filter files are not allowed
20955 to make use of &%run%& items.
20956
20957
20958 .option forbid_include redirect boolean false
20959 .cindex "restricting access to features"
20960 .cindex "filter" "locking out certain features"
20961 If this option is true, items of the form
20962 .code
20963 :include:<path name>
20964 .endd
20965 are not permitted in non-filter redirection lists.
20966
20967
20968 .option forbid_pipe redirect boolean false
20969 .cindex "restricting access to features"
20970 .cindex "filter" "locking out certain features"
20971 .cindex "delivery" "to pipe; forbidding"
20972 If this option is true, this router may not generate a new address which
20973 specifies delivery to a pipe, either from an Exim filter or from a conventional
20974 forward file. This option is forced to be true if &%one_time%& is set.
20975
20976
20977 .option forbid_sieve_filter redirect boolean false
20978 .cindex "restricting access to features"
20979 .cindex "filter" "locking out certain features"
20980 If this option is set true, only Exim filters are permitted when
20981 &%allow_filter%& is true.
20982
20983
20984 .cindex "SMTP" "error codes"
20985 .option forbid_smtp_code redirect boolean false
20986 If this option is set true, any SMTP error codes that are present at the start
20987 of messages specified for &`:defer:`& or &`:fail:`& are quietly ignored, and
20988 the default codes (451 and 550, respectively) are always used.
20989
20990
20991
20992
20993 .option hide_child_in_errmsg redirect boolean false
20994 .cindex "bounce message" "redirection details; suppressing"
20995 If this option is true, it prevents Exim from quoting a child address if it
20996 generates a bounce or delay message for it. Instead it says &"an address
20997 generated from <&'the top level address'&>"&. Of course, this applies only to
20998 bounces generated locally. If a message is forwarded to another host, &'its'&
20999 bounce may well quote the generated address.
21000
21001
21002 .option ignore_eacces redirect boolean false
21003 .cindex "EACCES"
21004 If this option is set and an attempt to open a redirection file yields the
21005 EACCES error (permission denied), the &(redirect)& router behaves as if the
21006 file did not exist.
21007
21008
21009 .option ignore_enotdir redirect boolean false
21010 .cindex "ENOTDIR"
21011 If this option is set and an attempt to open a redirection file yields the
21012 ENOTDIR error (something on the path is not a directory), the &(redirect)&
21013 router behaves as if the file did not exist.
21014
21015 Setting &%ignore_enotdir%& has another effect as well: When a &(redirect)&
21016 router that has the &%file%& option set discovers that the file does not exist
21017 (the ENOENT error), it tries to &[stat()]& the parent directory, as a check
21018 against unmounted NFS directories. If the parent can not be statted, delivery
21019 is deferred. However, it seems wrong to do this check when &%ignore_enotdir%&
21020 is set, because that option tells Exim to ignore &"something on the path is not
21021 a directory"& (the ENOTDIR error). This is a confusing area, because it seems
21022 that some operating systems give ENOENT where others give ENOTDIR.
21023
21024
21025
21026 .option include_directory redirect string unset
21027 If this option is set, the path names of any &':include:'& items in a
21028 redirection list must start with this directory.
21029
21030
21031 .option modemask redirect "octal integer" 022
21032 This specifies mode bits which must not be set for a file specified by the
21033 &%file%& option. If any of the forbidden bits are set, delivery is deferred.
21034
21035
21036 .option one_time redirect boolean false
21037 .cindex "one-time aliasing/forwarding expansion"
21038 .cindex "alias file" "one-time expansion"
21039 .cindex "forward file" "one-time expansion"
21040 .cindex "mailing lists" "one-time expansion"
21041 .cindex "address redirection" "one-time expansion"
21042 Sometimes the fact that Exim re-evaluates aliases and reprocesses redirection
21043 files each time it tries to deliver a message causes a problem when one or more
21044 of the generated addresses fails be delivered at the first attempt. The problem
21045 is not one of duplicate delivery &-- Exim is clever enough to handle that &--
21046 but of what happens when the redirection list changes during the time that the
21047 message is on Exim's queue. This is particularly true in the case of mailing
21048 lists, where new subscribers might receive copies of messages that were posted
21049 before they subscribed.
21050
21051 If &%one_time%& is set and any addresses generated by the router fail to
21052 deliver at the first attempt, the failing addresses are added to the message as
21053 &"top level"& addresses, and the parent address that generated them is marked
21054 &"delivered"&. Thus, redirection does not happen again at the next delivery
21055 attempt.
21056
21057 &*Warning 1*&: Any header line addition or removal that is specified by this
21058 router would be lost if delivery did not succeed at the first attempt. For this
21059 reason, the &%headers_add%& and &%headers_remove%& generic options are not
21060 permitted when &%one_time%& is set.
21061
21062 &*Warning 2*&: To ensure that the router generates only addresses (as opposed
21063 to pipe or file deliveries or auto-replies) &%forbid_file%&, &%forbid_pipe%&,
21064 and &%forbid_filter_reply%& are forced to be true when &%one_time%& is set.
21065
21066 &*Warning 3*&: The &%unseen%& generic router option may not be set with
21067 &%one_time%&.
21068
21069 The original top-level address is remembered with each of the generated
21070 addresses, and is output in any log messages. However, any intermediate parent
21071 addresses are not recorded. This makes a difference to the log only if
21072 &%all_parents%& log selector is set. It is expected that &%one_time%& will
21073 typically be used for mailing lists, where there is normally just one level of
21074 expansion.
21075
21076
21077 .option owners redirect "string list" unset
21078 .cindex "ownership" "alias file"
21079 .cindex "ownership" "forward file"
21080 .cindex "alias file" "ownership"
21081 .cindex "forward file" "ownership"
21082 This specifies a list of permitted owners for the file specified by &%file%&.
21083 This list is in addition to the local user when &%check_local_user%& is set.
21084 See &%check_owner%& above.
21085
21086
21087 .option owngroups redirect "string list" unset
21088 This specifies a list of permitted groups for the file specified by &%file%&.
21089 The list is in addition to the local user's primary group when
21090 &%check_local_user%& is set. See &%check_group%& above.
21091
21092
21093 .option pipe_transport redirect string&!! unset
21094 .vindex "&$address_pipe$&"
21095 A &(redirect)& router sets up a direct delivery to a pipe when a string
21096 starting with a vertical bar character is specified as a new &"address"&. The
21097 transport used is specified by this option, which, after expansion, must be the
21098 name of a configured transport. This should normally be a &(pipe)& transport.
21099 When the transport is run, the pipe command is in &$address_pipe$&.
21100
21101
21102 .option qualify_domain redirect string&!! unset
21103 .vindex "&$qualify_recipient$&"
21104 If this option is set, and an unqualified address (one without a domain) is
21105 generated, and that address would normally be qualified by the global setting
21106 in &%qualify_recipient%&, it is instead qualified with the domain specified by
21107 expanding this string. If the expansion fails, the router declines. If you want
21108 to revert to the default, you can have the expansion generate
21109 &$qualify_recipient$&.
21110
21111 This option applies to all unqualified addresses generated by Exim filters,
21112 but for traditional &_.forward_& files, it applies only to addresses that are
21113 not preceded by a backslash. Sieve filters cannot generate unqualified
21114 addresses.
21115
21116 .option qualify_preserve_domain redirect boolean false
21117 .cindex "domain" "in redirection; preserving"
21118 .cindex "preserving domain in redirection"
21119 .cindex "address redirection" "domain; preserving"
21120 If this option is set, the router's local &%qualify_domain%& option must not be
21121 set (a configuration error occurs if it is). If an unqualified address (one
21122 without a domain) is generated, it is qualified with the domain of the parent
21123 address (the immediately preceding ancestor) instead of the global
21124 &%qualify_recipient%& value. In the case of a traditional &_.forward_& file,
21125 this applies whether or not the address is preceded by a backslash.
21126
21127
21128 .option repeat_use redirect boolean true
21129 If this option is set false, the router is skipped for a child address that has
21130 any ancestor that was routed by this router. This test happens before any of
21131 the other preconditions are tested. Exim's default anti-looping rules skip
21132 only when the ancestor is the same as the current address. See also
21133 &%check_ancestor%& above and the generic &%redirect_router%& option.
21134
21135
21136 .option reply_transport redirect string&!! unset
21137 A &(redirect)& router sets up an automatic reply when a &%mail%& or
21138 &%vacation%& command is used in a filter file. The transport used is specified
21139 by this option, which, after expansion, must be the name of a configured
21140 transport. This should normally be an &(autoreply)& transport. Other transports
21141 are unlikely to do anything sensible or useful.
21142
21143
21144 .option rewrite redirect boolean true
21145 .cindex "address redirection" "disabling rewriting"
21146 If this option is set false, addresses generated by the router are not
21147 subject to address rewriting. Otherwise, they are treated like new addresses
21148 and are rewritten according to the global rewriting rules.
21149
21150
21151 .option sieve_subaddress redirect string&!! unset
21152 The value of this option is passed to a Sieve filter to specify the
21153 :subaddress part of an address.
21154
21155 .option sieve_useraddress redirect string&!! unset
21156 The value of this option is passed to a Sieve filter to specify the :user part
21157 of an address. However, if it is unset, the entire original local part
21158 (including any prefix or suffix) is used for :user.
21159
21160
21161 .option sieve_vacation_directory redirect string&!! unset
21162 .cindex "Sieve filter" "vacation directory"
21163 To enable the &"vacation"& extension for Sieve filters, you must set
21164 &%sieve_vacation_directory%& to the directory where vacation databases are held
21165 (do not put anything else in that directory), and ensure that the
21166 &%reply_transport%& option refers to an &(autoreply)& transport. Each user
21167 needs their own directory; Exim will create it if necessary.
21168
21169
21170
21171 .option skip_syntax_errors redirect boolean false
21172 .cindex "forward file" "broken"
21173 .cindex "address redirection" "broken files"
21174 .cindex "alias file" "broken"
21175 .cindex "broken alias or forward files"
21176 .cindex "ignoring faulty addresses"
21177 .cindex "skipping faulty addresses"
21178 .cindex "error" "skipping bad syntax"
21179 If &%skip_syntax_errors%& is set, syntactically malformed addresses in
21180 non-filter redirection data are skipped, and each failing address is logged. If
21181 &%syntax_errors_to%& is set, a message is sent to the address it defines,
21182 giving details of the failures. If &%syntax_errors_text%& is set, its contents
21183 are expanded and placed at the head of the error message generated by
21184 &%syntax_errors_to%&. Usually it is appropriate to set &%syntax_errors_to%& to
21185 be the same address as the generic &%errors_to%& option. The
21186 &%skip_syntax_errors%& option is often used when handling mailing lists.
21187
21188 If all the addresses in a redirection list are skipped because of syntax
21189 errors, the router declines to handle the original address, and it is passed to
21190 the following routers.
21191
21192 If &%skip_syntax_errors%& is set when an Exim filter is interpreted, any syntax
21193 error in the filter causes filtering to be abandoned without any action being
21194 taken. The incident is logged, and the router declines to handle the address,
21195 so it is passed to the following routers.
21196
21197 .cindex "Sieve filter" "syntax errors in"
21198 Syntax errors in a Sieve filter file cause the &"keep"& action to occur. This
21199 action is specified by RFC 3028. The values of &%skip_syntax_errors%&,
21200 &%syntax_errors_to%&, and &%syntax_errors_text%& are not used.
21201
21202 &%skip_syntax_errors%& can be used to specify that errors in users' forward
21203 lists or filter files should not prevent delivery. The &%syntax_errors_to%&
21204 option, used with an address that does not get redirected, can be used to
21205 notify users of these errors, by means of a router like this:
21206 .code
21207 userforward:
21208   driver = redirect
21209   allow_filter
21210   check_local_user
21211   file = $home/.forward
21212   file_transport = address_file
21213   pipe_transport = address_pipe
21214   reply_transport = address_reply
21215   no_verify
21216   skip_syntax_errors
21217   syntax_errors_to = real-$local_part@$domain
21218   syntax_errors_text = \
21219    This is an automatically generated message. An error has\n\
21220    been found in your .forward file. Details of the error are\n\
21221    reported below. While this error persists, you will receive\n\
21222    a copy of this message for every message that is addressed\n\
21223    to you. If your .forward file is a filter file, or if it is\n\
21224    a non-filter file containing no valid forwarding addresses,\n\
21225    a copy of each incoming message will be put in your normal\n\
21226    mailbox. If a non-filter file contains at least one valid\n\
21227    forwarding address, forwarding to the valid addresses will\n\
21228    happen, and those will be the only deliveries that occur.
21229 .endd
21230 You also need a router to ensure that local addresses that are prefixed by
21231 &`real-`& are recognized, but not forwarded or filtered. For example, you could
21232 put this immediately before the &(userforward)& router:
21233 .code
21234 real_localuser:
21235   driver = accept
21236   check_local_user
21237   local_part_prefix = real-
21238   transport = local_delivery
21239 .endd
21240 For security, it would probably be a good idea to restrict the use of this
21241 router to locally-generated messages, using a condition such as this:
21242 .code
21243   condition = ${if match {$sender_host_address}\
21244                          {\N^(|127\.0\.0\.1)$\N}}
21245 .endd
21246
21247
21248 .option syntax_errors_text redirect string&!! unset
21249 See &%skip_syntax_errors%& above.
21250
21251
21252 .option syntax_errors_to redirect string unset
21253 See &%skip_syntax_errors%& above.
21254 .ecindex IIDredrou1
21255 .ecindex IIDredrou2
21256
21257
21258
21259
21260
21261
21262 . ////////////////////////////////////////////////////////////////////////////
21263 . ////////////////////////////////////////////////////////////////////////////
21264
21265 .chapter "Environment for running local transports" "CHAPenvironment" &&&
21266          "Environment for local transports"
21267 .scindex IIDenvlotra1 "local transports" "environment for"
21268 .scindex IIDenvlotra2 "environment" "local transports"
21269 .scindex IIDenvlotra3 "transport" "local; environment for"
21270 Local transports handle deliveries to files and pipes. (The &(autoreply)&
21271 transport can be thought of as similar to a pipe.) Exim always runs transports
21272 in subprocesses, under specified uids and gids. Typical deliveries to local
21273 mailboxes run under the uid and gid of the local user.
21274
21275 Exim also sets a specific current directory while running the transport; for
21276 some transports a home directory setting is also relevant. The &(pipe)&
21277 transport is the only one that sets up environment variables; see section
21278 &<<SECTpipeenv>>& for details.
21279
21280 The values used for the uid, gid, and the directories may come from several
21281 different places. In many cases, the router that handles the address associates
21282 settings with that address as a result of its &%check_local_user%&, &%group%&,
21283 or &%user%& options. However, values may also be given in the transport's own
21284 configuration, and these override anything that comes from the router.
21285
21286
21287
21288 .section "Concurrent deliveries" "SECID131"
21289 .cindex "concurrent deliveries"
21290 .cindex "simultaneous deliveries"
21291 If two different messages for the same local recipient arrive more or less
21292 simultaneously, the two delivery processes are likely to run concurrently. When
21293 the &(appendfile)& transport is used to write to a file, Exim applies locking
21294 rules to stop concurrent processes from writing to the same file at the same
21295 time.
21296
21297 However, when you use a &(pipe)& transport, it is up to you to arrange any
21298 locking that is needed. Here is a silly example:
21299 .code
21300 my_transport:
21301   driver = pipe
21302   command = /bin/sh -c 'cat >>/some/file'
21303 .endd
21304 This is supposed to write the message at the end of the file. However, if two
21305 messages arrive at the same time, the file will be scrambled. You can use the
21306 &%exim_lock%& utility program (see section &<<SECTmailboxmaint>>&) to lock a
21307 file using the same algorithm that Exim itself uses.
21308
21309
21310
21311
21312 .section "Uids and gids" "SECTenvuidgid"
21313 .cindex "local transports" "uid and gid"
21314 .cindex "transport" "local; uid and gid"
21315 All transports have the options &%group%& and &%user%&. If &%group%& is set, it
21316 overrides any group that the router set in the address, even if &%user%& is not
21317 set for the transport. This makes it possible, for example, to run local mail
21318 delivery under the uid of the recipient (set by the router), but in a special
21319 group (set by the transport). For example:
21320 .code
21321 # Routers ...
21322 # User/group are set by check_local_user in this router
21323 local_users:
21324   driver = accept
21325   check_local_user
21326   transport = group_delivery
21327
21328 # Transports ...
21329 # This transport overrides the group
21330 group_delivery:
21331   driver = appendfile
21332   file = /var/spool/mail/$local_part
21333   group = mail
21334 .endd
21335 If &%user%& is set for a transport, its value overrides what is set in the
21336 address by the router. If &%user%& is non-numeric and &%group%& is not set, the
21337 gid associated with the user is used. If &%user%& is numeric, &%group%& must be
21338 set.
21339
21340 .oindex "&%initgroups%&"
21341 When the uid is taken from the transport's configuration, the &[initgroups()]&
21342 function is called for the groups associated with that uid if the
21343 &%initgroups%& option is set for the transport. When the uid is not specified
21344 by the transport, but is associated with the address by a router, the option
21345 for calling &[initgroups()]& is taken from the router configuration.
21346
21347 .cindex "&(pipe)& transport" "uid for"
21348 The &(pipe)& transport contains the special option &%pipe_as_creator%&. If this
21349 is set and &%user%& is not set, the uid of the process that called Exim to
21350 receive the message is used, and if &%group%& is not set, the corresponding
21351 original gid is also used.
21352
21353 This is the detailed preference order for obtaining a gid; the first of the
21354 following that is set is used:
21355
21356 .ilist
21357 A &%group%& setting of the transport;
21358 .next
21359 A &%group%& setting of the router;
21360 .next
21361 A gid associated with a user setting of the router, either as a result of
21362 &%check_local_user%& or an explicit non-numeric &%user%& setting;
21363 .next
21364 The group associated with a non-numeric &%user%& setting of the transport;
21365 .next
21366 In a &(pipe)& transport, the creator's gid if &%deliver_as_creator%& is set and
21367 the uid is the creator's uid;
21368 .next
21369 The Exim gid if the Exim uid is being used as a default.
21370 .endlist
21371
21372 If, for example, the user is specified numerically on the router and there are
21373 no group settings, no gid is available. In this situation, an error occurs.
21374 This is different for the uid, for which there always is an ultimate default.
21375 The first of the following that is set is used:
21376
21377 .ilist
21378 A &%user%& setting of the transport;
21379 .next
21380 In a &(pipe)& transport, the creator's uid if &%deliver_as_creator%& is set;
21381 .next
21382 A &%user%& setting of the router;
21383 .next
21384 A &%check_local_user%& setting of the router;
21385 .next
21386 The Exim uid.
21387 .endlist
21388
21389 Of course, an error will still occur if the uid that is chosen is on the
21390 &%never_users%& list.
21391
21392
21393
21394
21395
21396 .section "Current and home directories" "SECID132"
21397 .cindex "current directory for local transport"
21398 .cindex "home directory" "for local transport"
21399 .cindex "transport" "local; home directory for"
21400 .cindex "transport" "local; current directory for"
21401 Routers may set current and home directories for local transports by means of
21402 the &%transport_current_directory%& and &%transport_home_directory%& options.
21403 However, if the transport's &%current_directory%& or &%home_directory%& options
21404 are set, they override the router's values. In detail, the home directory
21405 for a local transport is taken from the first of these values that is set:
21406
21407 .ilist
21408 The &%home_directory%& option on the transport;
21409 .next
21410 The &%transport_home_directory%& option on the router;
21411 .next
21412 The password data if &%check_local_user%& is set on the router;
21413 .next
21414 The &%router_home_directory%& option on the router.
21415 .endlist
21416
21417 The current directory is taken from the first of these values that is set:
21418
21419 .ilist
21420 The &%current_directory%& option on the transport;
21421 .next
21422 The &%transport_current_directory%& option on the router.
21423 .endlist
21424
21425
21426 If neither the router nor the transport sets a current directory, Exim uses the
21427 value of the home directory, if it is set. Otherwise it sets the current
21428 directory to &_/_& before running a local transport.
21429
21430
21431
21432 .section "Expansion variables derived from the address" "SECID133"
21433 .vindex "&$domain$&"
21434 .vindex "&$local_part$&"
21435 .vindex "&$original_domain$&"
21436 Normally a local delivery is handling a single address, and in that case the
21437 variables such as &$domain$& and &$local_part$& are set during local
21438 deliveries. However, in some circumstances more than one address may be handled
21439 at once (for example, while writing batch SMTP for onward transmission by some
21440 other means). In this case, the variables associated with the local part are
21441 never set, &$domain$& is set only if all the addresses have the same domain,
21442 and &$original_domain$& is never set.
21443 .ecindex IIDenvlotra1
21444 .ecindex IIDenvlotra2
21445 .ecindex IIDenvlotra3
21446
21447
21448
21449
21450
21451
21452
21453 . ////////////////////////////////////////////////////////////////////////////
21454 . ////////////////////////////////////////////////////////////////////////////
21455
21456 .chapter "Generic options for transports" "CHAPtransportgeneric"
21457 .scindex IIDgenoptra1 "generic options" "transport"
21458 .scindex IIDgenoptra2 "options" "generic; for transports"
21459 .scindex IIDgenoptra3 "transport" "generic options for"
21460 The following generic options apply to all transports:
21461
21462
21463 .option body_only transports boolean false
21464 .cindex "transport" "body only"
21465 .cindex "message" "transporting body only"
21466 .cindex "body of message" "transporting"
21467 If this option is set, the message's headers are not transported. It is
21468 mutually exclusive with &%headers_only%&. If it is used with the &(appendfile)&
21469 or &(pipe)& transports, the settings of &%message_prefix%& and
21470 &%message_suffix%& should be checked, because this option does not
21471 automatically suppress them.
21472
21473
21474 .option current_directory transports string&!! unset
21475 .cindex "transport" "current directory for"
21476 This specifies the current directory that is to be set while running the
21477 transport, overriding any value that may have been set by the router.
21478 If the expansion fails for any reason, including forced failure, an error is
21479 logged, and delivery is deferred.
21480
21481
21482 .option disable_logging transports boolean false
21483 If this option is set true, nothing is logged for any
21484 deliveries by the transport or for any
21485 transport errors. You should not set this option unless you really, really know
21486 what you are doing.
21487
21488
21489 .option debug_print transports string&!! unset
21490 .cindex "testing" "variables in drivers"
21491 If this option is set and debugging is enabled (see the &%-d%& command line
21492 option), the string is expanded and included in the debugging output when the
21493 transport is run.
21494 If expansion of the string fails, the error message is written to the debugging
21495 output, and Exim carries on processing.
21496 This facility is provided to help with checking out the values of variables and
21497 so on when debugging driver configurations. For example, if a &%headers_add%&
21498 option is not working properly, &%debug_print%& could be used to output the
21499 variables it references. A newline is added to the text if it does not end with
21500 one.
21501 The variables &$transport_name$& and &$router_name$& contain the name of the
21502 transport and the router that called it.
21503
21504 .option delivery_date_add transports boolean false
21505 .cindex "&'Delivery-date:'& header line"
21506 If this option is true, a &'Delivery-date:'& header is added to the message.
21507 This gives the actual time the delivery was made. As this is not a standard
21508 header, Exim has a configuration option (&%delivery_date_remove%&) which
21509 requests its removal from incoming messages, so that delivered messages can
21510 safely be resent to other recipients.
21511
21512
21513 .option driver transports string unset
21514 This specifies which of the available transport drivers is to be used.
21515 There is no default, and this option must be set for every transport.
21516
21517
21518 .option envelope_to_add transports boolean false
21519 .cindex "&'Envelope-to:'& header line"
21520 If this option is true, an &'Envelope-to:'& header is added to the message.
21521 This gives the original address(es) in the incoming envelope that caused this
21522 delivery to happen. More than one address may be present if the transport is
21523 configured to handle several addresses at once, or if more than one original
21524 address was redirected to the same final address. As this is not a standard
21525 header, Exim has a configuration option (&%envelope_to_remove%&) which requests
21526 its removal from incoming messages, so that delivered messages can safely be
21527 resent to other recipients.
21528
21529
21530 .option event_action transports string&!! unset
21531 .cindex events
21532 This option declares a string to be expanded for Exim's events mechanism.
21533 For details see chapter &<<CHAPevents>>&.
21534
21535
21536 .option group transports string&!! "Exim group"
21537 .cindex "transport" "group; specifying"
21538 This option specifies a gid for running the transport process, overriding any
21539 value that the router supplies, and also overriding any value associated with
21540 &%user%& (see below).
21541
21542
21543 .option headers_add transports list&!! unset
21544 .cindex "header lines" "adding in transport"
21545 .cindex "transport" "header lines; adding"
21546 This option specifies a list of text headers,
21547 newline-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&),
21548 which are (separately) expanded and added to the header
21549 portion of a message as it is transported, as described in section
21550 &<<SECTheadersaddrem>>&. Additional header lines can also be specified by
21551 routers. If the result of the expansion is an empty string, or if the expansion
21552 is forced to fail, no action is taken. Other expansion failures are treated as
21553 errors and cause the delivery to be deferred.
21554
21555 Unlike most options, &%headers_add%& can be specified multiple times
21556 for a transport; all listed headers are added.
21557
21558
21559 .option headers_only transports boolean false
21560 .cindex "transport" "header lines only"
21561 .cindex "message" "transporting headers only"
21562 .cindex "header lines" "transporting"
21563 If this option is set, the message's body is not transported. It is mutually
21564 exclusive with &%body_only%&. If it is used with the &(appendfile)& or &(pipe)&
21565 transports, the settings of &%message_prefix%& and &%message_suffix%& should be
21566 checked, since this option does not automatically suppress them.
21567
21568
21569 .option headers_remove transports list&!! unset
21570 .cindex "header lines" "removing"
21571 .cindex "transport" "header lines; removing"
21572 This option specifies a list of header names,
21573 colon-separated (by default, changeable in the usual way &<<SECTlistsepchange>>&);
21574 these headers are omitted from the message as it is transported, as described
21575 in section &<<SECTheadersaddrem>>&. Header removal can also be specified by
21576 routers.
21577 Each list item is separately expanded.
21578 If the result of the expansion is an empty string, or if the expansion
21579 is forced to fail, no action is taken. Other expansion failures are treated as
21580 errors and cause the delivery to be deferred.
21581
21582 Unlike most options, &%headers_remove%& can be specified multiple times
21583 for a transport; all listed headers are removed.
21584
21585 &*Warning*&: Because of the separate expansion of the list items,
21586 items that contain a list separator must have it doubled.
21587 To avoid this, change the list separator (&<<SECTlistsepchange>>&).
21588
21589
21590
21591 .option headers_rewrite transports string unset
21592 .cindex "transport" "header lines; rewriting"
21593 .cindex "rewriting" "at transport time"
21594 This option allows addresses in header lines to be rewritten at transport time,
21595 that is, as the message is being copied to its destination. The contents of the
21596 option are a colon-separated list of rewriting rules. Each rule is in exactly
21597 the same form as one of the general rewriting rules that are applied when a
21598 message is received. These are described in chapter &<<CHAPrewrite>>&. For
21599 example,
21600 .code
21601 headers_rewrite = a@b c@d f : \
21602                   x@y w@z
21603 .endd
21604 changes &'a@b'& into &'c@d'& in &'From:'& header lines, and &'x@y'& into
21605 &'w@z'& in all address-bearing header lines. The rules are applied to the
21606 header lines just before they are written out at transport time, so they affect
21607 only those copies of the message that pass through the transport. However, only
21608 the message's original header lines, and any that were added by a system
21609 filter, are rewritten. If a router or transport adds header lines, they are not
21610 affected by this option. These rewriting rules are &'not'& applied to the
21611 envelope. You can change the return path using &%return_path%&, but you cannot
21612 change envelope recipients at this time.
21613
21614
21615 .option home_directory transports string&!! unset
21616 .cindex "transport" "home directory for"
21617 .vindex "&$home$&"
21618 This option specifies a home directory setting for a local transport,
21619 overriding any value that may be set by the router. The home directory is
21620 placed in &$home$& while expanding the transport's private options. It is also
21621 used as the current directory if no current directory is set by the
21622 &%current_directory%& option on the transport or the
21623 &%transport_current_directory%& option on the router. If the expansion fails
21624 for any reason, including forced failure, an error is logged, and delivery is
21625 deferred.
21626
21627
21628 .option initgroups transports boolean false
21629 .cindex "additional groups"
21630 .cindex "groups" "additional"
21631 .cindex "transport" "group; additional"
21632 If this option is true and the uid for the delivery process is provided by the
21633 transport, the &[initgroups()]& function is called when running the transport
21634 to ensure that any additional groups associated with the uid are set up.
21635
21636
21637 .option max_parallel transports integer&!! unset
21638 .cindex limit "transport parallelism"
21639 .cindex transport "parallel processes"
21640 .cindex transport "concurrency limit"
21641 .cindex "delivery" "parallelism for transport"
21642 If this option is set and expands to an integer greater than zero
21643 it limits the number of concurrent runs of the transport.
21644 The control does not apply to shadow transports.
21645
21646 .cindex "hints database" "transport concurrency control"
21647 Exim implements this control by means of a hints database in which a record is
21648 incremented whenever a transport process is being created. The record
21649 is decremented and possibly removed when the process terminates.
21650 Obviously there is scope for
21651 records to get left lying around if there is a system or program crash. To
21652 guard against this, Exim ignores any records that are more than six hours old.
21653
21654 If you use this option, you should also arrange to delete the
21655 relevant hints database whenever your system reboots. The names of the files
21656 start with &_misc_& and they are kept in the &_spool/db_& directory. There
21657 may be one or two files, depending on the type of DBM in use. The same files
21658 are used for ETRN and smtp transport serialization.
21659
21660
21661 .option message_size_limit transports string&!! 0
21662 .cindex "limit" "message size per transport"
21663 .cindex "size" "of message, limit"
21664 .cindex "transport" "message size; limiting"
21665 This option controls the size of messages passed through the transport. It is
21666 expanded before use; the result of the expansion must be a sequence of decimal
21667 digits, optionally followed by K or M. If the expansion fails for any reason,
21668 including forced failure, or if the result is not of the required form,
21669 delivery is deferred. If the value is greater than zero and the size of a
21670 message exceeds this limit, the address is failed. If there is any chance that
21671 the resulting bounce message could be routed to the same transport, you should
21672 ensure that &%return_size_limit%& is less than the transport's
21673 &%message_size_limit%&, as otherwise the bounce message will fail to get
21674 delivered.
21675
21676
21677
21678 .option rcpt_include_affixes transports boolean false
21679 .cindex "prefix" "for local part, including in envelope"
21680 .cindex "suffix for local part" "including in envelope"
21681 .cindex "local part" "prefix"
21682 .cindex "local part" "suffix"
21683 When this option is false (the default), and an address that has had any
21684 affixes (prefixes or suffixes) removed from the local part is delivered by any
21685 form of SMTP or LMTP, the affixes are not included. For example, if a router
21686 that contains
21687 .code
21688 local_part_prefix = *-
21689 .endd
21690 routes the address &'abc-xyz@some.domain'& to an SMTP transport, the envelope
21691 is delivered with
21692 .code
21693 RCPT TO:<xyz@some.domain>
21694 .endd
21695 This is also the case when an ACL-time callout is being used to verify a
21696 recipient address. However, if &%rcpt_include_affixes%& is set true, the
21697 whole local part is included in the RCPT command. This option applies to BSMTP
21698 deliveries by the &(appendfile)& and &(pipe)& transports as well as to the
21699 &(lmtp)& and &(smtp)& transports.
21700
21701
21702 .option retry_use_local_part transports boolean "see below"
21703 .cindex "hints database" "retry keys"
21704 When a delivery suffers a temporary failure, a retry record is created
21705 in Exim's hints database. For remote deliveries, the key for the retry record
21706 is based on the name and/or IP address of the failing remote host. For local
21707 deliveries, the key is normally the entire address, including both the local
21708 part and the domain. This is suitable for most common cases of local delivery
21709 temporary failure &-- for example, exceeding a mailbox quota should delay only
21710 deliveries to that mailbox, not to the whole domain.
21711
21712 However, in some special cases you may want to treat a temporary local delivery
21713 as a failure associated with the domain, and not with a particular local part.
21714 (For example, if you are storing all mail for some domain in files.) You can do
21715 this by setting &%retry_use_local_part%& false.
21716
21717 For all the local transports, its default value is true. For remote transports,
21718 the default value is false for tidiness, but changing the value has no effect
21719 on a remote transport in the current implementation.
21720
21721
21722 .option return_path transports string&!! unset
21723 .cindex "envelope sender"
21724 .cindex "transport" "return path; changing"
21725 .cindex "return path" "changing in transport"
21726 If this option is set, the string is expanded at transport time and replaces
21727 the existing return path (envelope sender) value in the copy of the message
21728 that is being delivered. An empty return path is permitted. This feature is
21729 designed for remote deliveries, where the value of this option is used in the
21730 SMTP MAIL command. If you set &%return_path%& for a local transport, the
21731 only effect is to change the address that is placed in the &'Return-path:'&
21732 header line, if one is added to the message (see the next option).
21733
21734 &*Note:*& A changed return path is not logged unless you add
21735 &%return_path_on_delivery%& to the log selector.
21736
21737 .vindex "&$return_path$&"
21738 The expansion can refer to the existing value via &$return_path$&. This is
21739 either the message's envelope sender, or an address set by the
21740 &%errors_to%& option on a router. If the expansion is forced to fail, no
21741 replacement occurs; if it fails for another reason, delivery is deferred. This
21742 option can be used to support VERP (Variable Envelope Return Paths) &-- see
21743 section &<<SECTverp>>&.
21744
21745 &*Note*&: If a delivery error is detected locally, including the case when a
21746 remote server rejects a message at SMTP time, the bounce message is not sent to
21747 the value of this option. It is sent to the previously set errors address.
21748 This defaults to the incoming sender address, but can be changed by setting
21749 &%errors_to%& in a router.
21750
21751
21752
21753 .option return_path_add transports boolean false
21754 .cindex "&'Return-path:'& header line"
21755 If this option is true, a &'Return-path:'& header is added to the message.
21756 Although the return path is normally available in the prefix line of BSD
21757 mailboxes, this is commonly not displayed by MUAs, and so the user does not
21758 have easy access to it.
21759
21760 RFC 2821 states that the &'Return-path:'& header is added to a message &"when
21761 the delivery SMTP server makes the final delivery"&. This implies that this
21762 header should not be present in incoming messages. Exim has a configuration
21763 option, &%return_path_remove%&, which requests removal of this header from
21764 incoming messages, so that delivered messages can safely be resent to other
21765 recipients.
21766
21767
21768 .option shadow_condition transports string&!! unset
21769 See &%shadow_transport%& below.
21770
21771
21772 .option shadow_transport transports string unset
21773 .cindex "shadow transport"
21774 .cindex "transport" "shadow"
21775 A local transport may set the &%shadow_transport%& option to the name of
21776 another local transport. Shadow remote transports are not supported.
21777
21778 Whenever a delivery to the main transport succeeds, and either
21779 &%shadow_condition%& is unset, or its expansion does not result in the empty
21780 string or one of the strings &"0"& or &"no"& or &"false"&, the message is also
21781 passed to the shadow transport, with the same delivery address or addresses. If
21782 expansion fails, no action is taken except that non-forced expansion failures
21783 cause a log line to be written.
21784
21785 The result of the shadow transport is discarded and does not affect the
21786 subsequent processing of the message. Only a single level of shadowing is
21787 provided; the &%shadow_transport%& option is ignored on any transport when it
21788 is running as a shadow. Options concerned with output from pipes are also
21789 ignored. The log line for the successful delivery has an item added on the end,
21790 of the form
21791 .code
21792 ST=<shadow transport name>
21793 .endd
21794 If the shadow transport did not succeed, the error message is put in
21795 parentheses afterwards. Shadow transports can be used for a number of different
21796 purposes, including keeping more detailed log information than Exim normally
21797 provides, and implementing automatic acknowledgment policies based on message
21798 headers that some sites insist on.
21799
21800
21801 .option transport_filter transports string&!! unset
21802 .cindex "transport" "filter"
21803 .cindex "filter" "transport filter"
21804 This option sets up a filtering (in the Unix shell sense) process for messages
21805 at transport time. It should not be confused with mail filtering as set up by
21806 individual users or via a system filter.
21807 If unset, or expanding to an empty string, no filtering is done.
21808
21809 When the message is about to be written out, the command specified by
21810 &%transport_filter%& is started up in a separate, parallel process, and
21811 the entire message, including the header lines, is passed to it on its standard
21812 input (this in fact is done from a third process, to avoid deadlock). The
21813 command must be specified as an absolute path.
21814
21815 The lines of the message that are written to the transport filter are
21816 terminated by newline (&"\n"&). The message is passed to the filter before any
21817 SMTP-specific processing, such as turning &"\n"& into &"\r\n"& and escaping
21818 lines beginning with a dot, and also before any processing implied by the
21819 settings of &%check_string%& and &%escape_string%& in the &(appendfile)& or
21820 &(pipe)& transports.
21821
21822 The standard error for the filter process is set to the same destination as its
21823 standard output; this is read and written to the message's ultimate
21824 destination. The process that writes the message to the filter, the
21825 filter itself, and the original process that reads the result and delivers it
21826 are all run in parallel, like a shell pipeline.
21827
21828 The filter can perform any transformations it likes, but of course should take
21829 care not to break RFC 2822 syntax. Exim does not check the result, except to
21830 test for a final newline when SMTP is in use. All messages transmitted over
21831 SMTP must end with a newline, so Exim supplies one if it is missing.
21832
21833 .cindex "content scanning" "per user"
21834 A transport filter can be used to provide content-scanning on a per-user basis
21835 at delivery time if the only required effect of the scan is to modify the
21836 message. For example, a content scan could insert a new header line containing
21837 a spam score. This could be interpreted by a filter in the user's MUA. It is
21838 not possible to discard a message at this stage.
21839
21840 .cindex "SMTP" "SIZE"
21841 A problem might arise if the filter increases the size of a message that is
21842 being sent down an SMTP connection. If the receiving SMTP server has indicated
21843 support for the SIZE parameter, Exim will have sent the size of the message
21844 at the start of the SMTP session. If what is actually sent is substantially
21845 more, the server might reject the message. This can be worked round by setting
21846 the &%size_addition%& option on the &(smtp)& transport, either to allow for
21847 additions to the message, or to disable the use of SIZE altogether.
21848
21849 .vindex "&$pipe_addresses$&"
21850 The value of the &%transport_filter%& option is the command string for starting
21851 the filter, which is run directly from Exim, not under a shell. The string is
21852 parsed by Exim in the same way as a command string for the &(pipe)& transport:
21853 Exim breaks it up into arguments and then expands each argument separately (see
21854 section &<<SECThowcommandrun>>&). Any kind of expansion failure causes delivery
21855 to be deferred. The special argument &$pipe_addresses$& is replaced by a number
21856 of arguments, one for each address that applies to this delivery. (This isn't
21857 an ideal name for this feature here, but as it was already implemented for the
21858 &(pipe)& transport, it seemed sensible not to change it.)
21859
21860 .vindex "&$host$&"
21861 .vindex "&$host_address$&"
21862 The expansion variables &$host$& and &$host_address$& are available when the
21863 transport is a remote one. They contain the name and IP address of the host to
21864 which the message is being sent. For example:
21865 .code
21866 transport_filter = /some/directory/transport-filter.pl \
21867   $host $host_address $sender_address $pipe_addresses
21868 .endd
21869
21870 Two problems arise if you want to use more complicated expansion items to
21871 generate transport filter commands, both of which due to the fact that the
21872 command is split up &'before'& expansion.
21873 .ilist
21874 If an expansion item contains white space, you must quote it, so that it is all
21875 part of the same command item. If the entire option setting is one such
21876 expansion item, you have to take care what kind of quoting you use. For
21877 example:
21878 .code
21879 transport_filter = '/bin/cmd${if eq{$host}{a.b.c}{1}{2}}'
21880 .endd
21881 This runs the command &(/bin/cmd1)& if the host name is &'a.b.c'&, and
21882 &(/bin/cmd2)& otherwise. If double quotes had been used, they would have been
21883 stripped by Exim when it read the option's value. When the value is used, if
21884 the single quotes were missing, the line would be split into two items,
21885 &`/bin/cmd${if`& and &`eq{$host}{a.b.c}{1}{2}`&, and an error would occur when
21886 Exim tried to expand the first one.
21887 .next
21888 Except for the special case of &$pipe_addresses$& that is mentioned above, an
21889 expansion cannot generate multiple arguments, or a command name followed by
21890 arguments. Consider this example:
21891 .code
21892 transport_filter = ${lookup{$host}lsearch{/a/file}\
21893                     {$value}{/bin/cat}}
21894 .endd
21895 The result of the lookup is interpreted as the name of the command, even
21896 if it contains white space. The simplest way round this is to use a shell:
21897 .code
21898 transport_filter = /bin/sh -c ${lookup{$host}lsearch{/a/file}\
21899                                {$value}{/bin/cat}}
21900 .endd
21901 .endlist
21902
21903 The filter process is run under the same uid and gid as the normal delivery.
21904 For remote deliveries this is the Exim uid/gid by default. The command should
21905 normally yield a zero return code. Transport filters are not supposed to fail.
21906 A non-zero code is taken to mean that the transport filter encountered some
21907 serious problem. Delivery of the message is deferred; the message remains on
21908 the queue and is tried again later. It is not possible to cause a message to be
21909 bounced from a transport filter.
21910
21911 If a transport filter is set on an autoreply transport, the original message is
21912 passed through the filter as it is being copied into the newly generated
21913 message, which happens if the &%return_message%& option is set.
21914
21915
21916 .option transport_filter_timeout transports time 5m
21917 .cindex "transport" "filter, timeout"
21918 When Exim is reading the output of a transport filter, it applies a timeout
21919 that can be set by this option. Exceeding the timeout is normally treated as a
21920 temporary delivery failure. However, if a transport filter is used with a
21921 &(pipe)& transport, a timeout in the transport filter is treated in the same
21922 way as a timeout in the pipe command itself. By default, a timeout is a hard
21923 error, but if the &(pipe)& transport's &%timeout_defer%& option is set true, it
21924 becomes a temporary error.
21925
21926
21927 .option user transports string&!! "Exim user"
21928 .cindex "uid (user id)" "local delivery"
21929 .cindex "transport" "user, specifying"
21930 This option specifies the user under whose uid the delivery process is to be
21931 run, overriding any uid that may have been set by the router. If the user is
21932 given as a name, the uid is looked up from the password data, and the
21933 associated group is taken as the value of the gid to be used if the &%group%&
21934 option is not set.
21935
21936 For deliveries that use local transports, a user and group are normally
21937 specified explicitly or implicitly (for example, as a result of
21938 &%check_local_user%&) by the router or transport.
21939
21940 .cindex "hints database" "access by remote transport"
21941 For remote transports, you should leave this option unset unless you really are
21942 sure you know what you are doing. When a remote transport is running, it needs
21943 to be able to access Exim's hints databases, because each host may have its own
21944 retry data.
21945 .ecindex IIDgenoptra1
21946 .ecindex IIDgenoptra2
21947 .ecindex IIDgenoptra3
21948
21949
21950
21951
21952
21953
21954 . ////////////////////////////////////////////////////////////////////////////
21955 . ////////////////////////////////////////////////////////////////////////////
21956
21957 .chapter "Address batching in local transports" "CHAPbatching" &&&
21958          "Address batching"
21959 .cindex "transport" "local; address batching in"
21960 The only remote transport (&(smtp)&) is normally configured to handle more than
21961 one address at a time, so that when several addresses are routed to the same
21962 remote host, just one copy of the message is sent. Local transports, however,
21963 normally handle one address at a time. That is, a separate instance of the
21964 transport is run for each address that is routed to the transport. A separate
21965 copy of the message is delivered each time.
21966
21967 .cindex "batched local delivery"
21968 .oindex "&%batch_max%&"
21969 .oindex "&%batch_id%&"
21970 In special cases, it may be desirable to handle several addresses at once in a
21971 local transport, for example:
21972
21973 .ilist
21974 In an &(appendfile)& transport, when storing messages in files for later
21975 delivery by some other means, a single copy of the message with multiple
21976 recipients saves space.
21977 .next
21978 In an &(lmtp)& transport, when delivering over &"local SMTP"& to some process,
21979 a single copy saves time, and is the normal way LMTP is expected to work.
21980 .next
21981 In a &(pipe)& transport, when passing the message
21982 to a scanner program or
21983 to some other delivery mechanism such as UUCP, multiple recipients may be
21984 acceptable.
21985 .endlist
21986
21987 These three local transports all have the same options for controlling multiple
21988 (&"batched"&) deliveries, namely &%batch_max%& and &%batch_id%&. To save
21989 repeating the information for each transport, these options are described here.
21990
21991 The &%batch_max%& option specifies the maximum number of addresses that can be
21992 delivered together in a single run of the transport. Its default value is one
21993 (no batching). When more than one address is routed to a transport that has a
21994 &%batch_max%& value greater than one, the addresses are delivered in a batch
21995 (that is, in a single run of the transport with multiple recipients), subject
21996 to certain conditions:
21997
21998 .ilist
21999 .vindex "&$local_part$&"
22000 If any of the transport's options contain a reference to &$local_part$&, no
22001 batching is possible.
22002 .next
22003 .vindex "&$domain$&"
22004 If any of the transport's options contain a reference to &$domain$&, only
22005 addresses with the same domain are batched.
22006 .next
22007 .cindex "customizing" "batching condition"
22008 If &%batch_id%& is set, it is expanded for each address, and only those
22009 addresses with the same expanded value are batched. This allows you to specify
22010 customized batching conditions. Failure of the expansion for any reason,
22011 including forced failure, disables batching, but it does not stop the delivery
22012 from taking place.
22013 .next
22014 Batched addresses must also have the same errors address (where to send
22015 delivery errors), the same header additions and removals, the same user and
22016 group for the transport, and if a host list is present, the first host must
22017 be the same.
22018 .endlist
22019
22020 In the case of the &(appendfile)& and &(pipe)& transports, batching applies
22021 both when the file or pipe command is specified in the transport, and when it
22022 is specified by a &(redirect)& router, but all the batched addresses must of
22023 course be routed to the same file or pipe command. These two transports have an
22024 option called &%use_bsmtp%&, which causes them to deliver the message in
22025 &"batched SMTP"& format, with the envelope represented as SMTP commands. The
22026 &%check_string%& and &%escape_string%& options are forced to the values
22027 .code
22028 check_string = "."
22029 escape_string = ".."
22030 .endd
22031 when batched SMTP is in use. A full description of the batch SMTP mechanism is
22032 given in section &<<SECTbatchSMTP>>&. The &(lmtp)& transport does not have a
22033 &%use_bsmtp%& option, because it always delivers using the SMTP protocol.
22034
22035 .cindex "&'Envelope-to:'& header line"
22036 If the generic &%envelope_to_add%& option is set for a batching transport, the
22037 &'Envelope-to:'& header that is added to the message contains all the addresses
22038 that are being processed together. If you are using a batching &(appendfile)&
22039 transport without &%use_bsmtp%&, the only way to preserve the recipient
22040 addresses is to set the &%envelope_to_add%& option.
22041
22042 .cindex "&(pipe)& transport" "with multiple addresses"
22043 .vindex "&$pipe_addresses$&"
22044 If you are using a &(pipe)& transport without BSMTP, and setting the
22045 transport's &%command%& option, you can include &$pipe_addresses$& as part of
22046 the command. This is not a true variable; it is a bit of magic that causes each
22047 of the recipient addresses to be inserted into the command as a separate
22048 argument. This provides a way of accessing all the addresses that are being
22049 delivered in the batch. &*Note:*& This is not possible for pipe commands that
22050 are specified by a &(redirect)& router.
22051
22052
22053
22054
22055 . ////////////////////////////////////////////////////////////////////////////
22056 . ////////////////////////////////////////////////////////////////////////////
22057
22058 .chapter "The appendfile transport" "CHAPappendfile"
22059 .scindex IIDapptra1 "&(appendfile)& transport"
22060 .scindex IIDapptra2 "transports" "&(appendfile)&"
22061 .cindex "directory creation"
22062 .cindex "creating directories"
22063 The &(appendfile)& transport delivers a message by appending it to an existing
22064 file, or by creating an entirely new file in a specified directory. Single
22065 files to which messages are appended can be in the traditional Unix mailbox
22066 format, or optionally in the MBX format supported by the Pine MUA and
22067 University of Washington IMAP daemon, &'inter alia'&. When each message is
22068 being delivered as a separate file, &"maildir"& format can optionally be used
22069 to give added protection against failures that happen part-way through the
22070 delivery. A third form of separate-file delivery known as &"mailstore"& is also
22071 supported. For all file formats, Exim attempts to create as many levels of
22072 directory as necessary, provided that &%create_directory%& is set.
22073
22074 The code for the optional formats is not included in the Exim binary by
22075 default. It is necessary to set SUPPORT_MBX, SUPPORT_MAILDIR and/or
22076 SUPPORT_MAILSTORE in &_Local/Makefile_& to have the appropriate code
22077 included.
22078
22079 .cindex "quota" "system"
22080 Exim recognizes system quota errors, and generates an appropriate message. Exim
22081 also supports its own quota control within the transport, for use when the
22082 system facility is unavailable or cannot be used for some reason.
22083
22084 If there is an error while appending to a file (for example, quota exceeded or
22085 partition filled), Exim attempts to reset the file's length and last
22086 modification time back to what they were before. If there is an error while
22087 creating an entirely new file, the new file is removed.
22088
22089 Before appending to a file, a number of security checks are made, and the
22090 file is locked. A detailed description is given below, after the list of
22091 private options.
22092
22093 The &(appendfile)& transport is most commonly used for local deliveries to
22094 users' mailboxes. However, it can also be used as a pseudo-remote transport for
22095 putting messages into files for remote delivery by some means other than Exim.
22096 &"Batch SMTP"& format is often used in this case (see the &%use_bsmtp%&
22097 option).
22098
22099
22100
22101 .section "The file and directory options" "SECTfildiropt"
22102 The &%file%& option specifies a single file, to which the message is appended;
22103 the &%directory%& option specifies a directory, in which a new file containing
22104 the message is created. Only one of these two options can be set, and for
22105 normal deliveries to mailboxes, one of them &'must'& be set.
22106
22107 .vindex "&$address_file$&"
22108 .vindex "&$local_part$&"
22109 However, &(appendfile)& is also used for delivering messages to files or
22110 directories whose names (or parts of names) are obtained from alias,
22111 forwarding, or filtering operations (for example, a &%save%& command in a
22112 user's Exim filter). When such a transport is running, &$local_part$& contains
22113 the local part that was aliased or forwarded, and &$address_file$& contains the
22114 name (or partial name) of the file or directory generated by the redirection
22115 operation. There are two cases:
22116
22117 .ilist
22118 If neither &%file%& nor &%directory%& is set, the redirection operation
22119 must specify an absolute path (one that begins with &`/`&). This is the most
22120 common case when users with local accounts use filtering to sort mail into
22121 different folders. See for example, the &(address_file)& transport in the
22122 default configuration. If the path ends with a slash, it is assumed to be the
22123 name of a directory. A delivery to a directory can also be forced by setting
22124 &%maildir_format%& or &%mailstore_format%&.
22125 .next
22126 If &%file%& or &%directory%& is set for a delivery from a redirection, it is
22127 used to determine the file or directory name for the delivery. Normally, the
22128 contents of &$address_file$& are used in some way in the string expansion.
22129 .endlist
22130
22131
22132 .cindex "Sieve filter" "configuring &(appendfile)&"
22133 .cindex "Sieve filter" "relative mailbox path handling"
22134 As an example of the second case, consider an environment where users do not
22135 have home directories. They may be permitted to use Exim filter commands of the
22136 form:
22137 .code
22138 save folder23
22139 .endd
22140 or Sieve filter commands of the form:
22141 .code
22142 require "fileinto";
22143 fileinto "folder23";
22144 .endd
22145 In this situation, the expansion of &%file%& or &%directory%& in the transport
22146 must transform the relative path into an appropriate absolute filename. In the
22147 case of Sieve filters, the name &'inbox'& must be handled. It is the name that
22148 is used as a result of a &"keep"& action in the filter. This example shows one
22149 way of handling this requirement:
22150 .code
22151 file = ${if eq{$address_file}{inbox} \
22152             {/var/mail/$local_part} \
22153             {${if eq{${substr_0_1:$address_file}}{/} \
22154                   {$address_file} \
22155                   {$home/mail/$address_file} \
22156             }} \
22157        }
22158 .endd
22159 With this setting of &%file%&, &'inbox'& refers to the standard mailbox
22160 location, absolute paths are used without change, and other folders are in the
22161 &_mail_& directory within the home directory.
22162
22163 &*Note 1*&: While processing an Exim filter, a relative path such as
22164 &_folder23_& is turned into an absolute path if a home directory is known to
22165 the router. In particular, this is the case if &%check_local_user%& is set. If
22166 you want to prevent this happening at routing time, you can set
22167 &%router_home_directory%& empty. This forces the router to pass the relative
22168 path to the transport.
22169
22170 &*Note 2*&: An absolute path in &$address_file$& is not treated specially;
22171 the &%file%& or &%directory%& option is still used if it is set.
22172
22173
22174
22175
22176 .section "Private options for appendfile" "SECID134"
22177 .cindex "options" "&(appendfile)& transport"
22178
22179
22180
22181 .option allow_fifo appendfile boolean false
22182 .cindex "fifo (named pipe)"
22183 .cindex "named pipe (fifo)"
22184 .cindex "pipe" "named (fifo)"
22185 Setting this option permits delivery to named pipes (FIFOs) as well as to
22186 regular files. If no process is reading the named pipe at delivery time, the
22187 delivery is deferred.
22188
22189
22190 .option allow_symlink appendfile boolean false
22191 .cindex "symbolic link" "to mailbox"
22192 .cindex "mailbox" "symbolic link"
22193 By default, &(appendfile)& will not deliver if the path name for the file is
22194 that of a symbolic link. Setting this option relaxes that constraint, but there
22195 are security issues involved in the use of symbolic links. Be sure you know
22196 what you are doing if you set this. Details of exactly what this option affects
22197 are included in the discussion which follows this list of options.
22198
22199
22200 .option batch_id appendfile string&!! unset
22201 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22202 However, batching is automatically disabled for &(appendfile)& deliveries that
22203 happen as a result of forwarding or aliasing or other redirection directly to a
22204 file.
22205
22206
22207 .option batch_max appendfile integer 1
22208 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
22209
22210
22211 .option check_group appendfile boolean false
22212 When this option is set, the group owner of the file defined by the &%file%&
22213 option is checked to see that it is the same as the group under which the
22214 delivery process is running. The default setting is false because the default
22215 file mode is 0600, which means that the group is irrelevant.
22216
22217
22218 .option check_owner appendfile boolean true
22219 When this option is set, the owner of the file defined by the &%file%& option
22220 is checked to ensure that it is the same as the user under which the delivery
22221 process is running.
22222
22223
22224 .option check_string appendfile string "see below"
22225 .cindex "&""From""& line"
22226 As &(appendfile)& writes the message, the start of each line is tested for
22227 matching &%check_string%&, and if it does, the initial matching characters are
22228 replaced by the contents of &%escape_string%&. The value of &%check_string%& is
22229 a literal string, not a regular expression, and the case of any letters it
22230 contains is significant.
22231
22232 If &%use_bsmtp%& is set the values of &%check_string%& and &%escape_string%&
22233 are forced to &"."& and &".."& respectively, and any settings in the
22234 configuration are ignored. Otherwise, they default to &"From&~"& and
22235 &">From&~"& when the &%file%& option is set, and unset when any of the
22236 &%directory%&, &%maildir%&, or &%mailstore%& options are set.
22237
22238 The default settings, along with &%message_prefix%& and &%message_suffix%&, are
22239 suitable for traditional &"BSD"& mailboxes, where a line beginning with
22240 &"From&~"& indicates the start of a new message. All four options need changing
22241 if another format is used. For example, to deliver to mailboxes in MMDF format:
22242 .cindex "MMDF format mailbox"
22243 .cindex "mailbox" "MMDF format"
22244 .code
22245 check_string = "\1\1\1\1\n"
22246 escape_string = "\1\1\1\1 \n"
22247 message_prefix = "\1\1\1\1\n"
22248 message_suffix = "\1\1\1\1\n"
22249 .endd
22250 .option create_directory appendfile boolean true
22251 .cindex "directory creation"
22252 When this option is true, Exim attempts to create any missing superior
22253 directories for the file that it is about to write. A created directory's mode
22254 is given by the &%directory_mode%& option.
22255
22256 The group ownership of a newly created directory is highly dependent on the
22257 operating system (and possibly the file system) that is being used. For
22258 example, in Solaris, if the parent directory has the setgid bit set, its group
22259 is propagated to the child; if not, the currently set group is used. However,
22260 in FreeBSD, the parent's group is always used.
22261
22262
22263
22264 .option create_file appendfile string anywhere
22265 This option constrains the location of files and directories that are created
22266 by this transport. It applies to files defined by the &%file%& option and
22267 directories defined by the &%directory%& option. In the case of maildir
22268 delivery, it applies to the top level directory, not the maildir directories
22269 beneath.
22270
22271 The option must be set to one of the words &"anywhere"&, &"inhome"&, or
22272 &"belowhome"&. In the second and third cases, a home directory must have been
22273 set for the transport. This option is not useful when an explicit filename is
22274 given for normal mailbox deliveries. It is intended for the case when filenames
22275 are generated from users' &_.forward_& files. These are usually handled
22276 by an &(appendfile)& transport called &%address_file%&. See also
22277 &%file_must_exist%&.
22278
22279
22280 .option directory appendfile string&!! unset
22281 This option is mutually exclusive with the &%file%& option, but one of &%file%&
22282 or &%directory%& must be set, unless the delivery is the direct result of a
22283 redirection (see section &<<SECTfildiropt>>&).
22284
22285 When &%directory%& is set, the string is expanded, and the message is delivered
22286 into a new file or files in or below the given directory, instead of being
22287 appended to a single mailbox file. A number of different formats are provided
22288 (see &%maildir_format%& and &%mailstore_format%&), and see section
22289 &<<SECTopdir>>& for further details of this form of delivery.
22290
22291
22292 .option directory_file appendfile string&!! "see below"
22293 .cindex "base62"
22294 .vindex "&$inode$&"
22295 When &%directory%& is set, but neither &%maildir_format%& nor
22296 &%mailstore_format%& is set, &(appendfile)& delivers each message into a file
22297 whose name is obtained by expanding this string. The default value is:
22298 .code
22299 q${base62:$tod_epoch}-$inode
22300 .endd
22301 This generates a unique name from the current time, in base 62 form, and the
22302 inode of the file. The variable &$inode$& is available only when expanding this
22303 option.
22304
22305
22306 .option directory_mode appendfile "octal integer" 0700
22307 If &(appendfile)& creates any directories as a result of the
22308 &%create_directory%& option, their mode is specified by this option.
22309
22310
22311 .option escape_string appendfile string "see description"
22312 See &%check_string%& above.
22313
22314
22315 .option file appendfile string&!! unset
22316 This option is mutually exclusive with the &%directory%& option, but one of
22317 &%file%& or &%directory%& must be set, unless the delivery is the direct result
22318 of a redirection (see section &<<SECTfildiropt>>&). The &%file%& option
22319 specifies a single file, to which the message is appended. One or more of
22320 &%use_fcntl_lock%&, &%use_flock_lock%&, or &%use_lockfile%& must be set with
22321 &%file%&.
22322
22323 .cindex "NFS" "lock file"
22324 .cindex "locking files"
22325 .cindex "lock files"
22326 If you are using more than one host to deliver over NFS into the same
22327 mailboxes, you should always use lock files.
22328
22329 The string value is expanded for each delivery, and must yield an absolute
22330 path. The most common settings of this option are variations on one of these
22331 examples:
22332 .code
22333 file = /var/spool/mail/$local_part
22334 file = /home/$local_part/inbox
22335 file = $home/inbox
22336 .endd
22337 .cindex "&""sticky""& bit"
22338 In the first example, all deliveries are done into the same directory. If Exim
22339 is configured to use lock files (see &%use_lockfile%& below) it must be able to
22340 create a file in the directory, so the &"sticky"& bit must be turned on for
22341 deliveries to be possible, or alternatively the &%group%& option can be used to
22342 run the delivery under a group id which has write access to the directory.
22343
22344
22345
22346 .option file_format appendfile string unset
22347 .cindex "file" "mailbox; checking existing format"
22348 This option requests the transport to check the format of an existing file
22349 before adding to it. The check consists of matching a specific string at the
22350 start of the file. The value of the option consists of an even number of
22351 colon-separated strings. The first of each pair is the test string, and the
22352 second is the name of a transport. If the transport associated with a matched
22353 string is not the current transport, control is passed over to the other
22354 transport. For example, suppose the standard &(local_delivery)& transport has
22355 this added to it:
22356 .code
22357 file_format = "From       : local_delivery :\
22358                \1\1\1\1\n : local_mmdf_delivery"
22359 .endd
22360 Mailboxes that begin with &"From"& are still handled by this transport, but if
22361 a mailbox begins with four binary ones followed by a newline, control is passed
22362 to a transport called &%local_mmdf_delivery%&, which presumably is configured
22363 to do the delivery in MMDF format. If a mailbox does not exist or is empty, it
22364 is assumed to match the current transport. If the start of a mailbox doesn't
22365 match any string, or if the transport named for a given string is not defined,
22366 delivery is deferred.
22367
22368
22369 .option file_must_exist appendfile boolean false
22370 If this option is true, the file specified by the &%file%& option must exist.
22371 A temporary error occurs if it does not, causing delivery to be deferred.
22372 If this option is false, the file is created if it does not exist.
22373
22374
22375 .option lock_fcntl_timeout appendfile time 0s
22376 .cindex "timeout" "mailbox locking"
22377 .cindex "mailbox" "locking, blocking and non-blocking"
22378 .cindex "locking files"
22379 By default, the &(appendfile)& transport uses non-blocking calls to &[fcntl()]&
22380 when locking an open mailbox file. If the call fails, the delivery process
22381 sleeps for &%lock_interval%& and tries again, up to &%lock_retries%& times.
22382 Non-blocking calls are used so that the file is not kept open during the wait
22383 for the lock; the reason for this is to make it as safe as possible for
22384 deliveries over NFS in the case when processes might be accessing an NFS
22385 mailbox without using a lock file. This should not be done, but
22386 misunderstandings and hence misconfigurations are not unknown.
22387
22388 On a busy system, however, the performance of a non-blocking lock approach is
22389 not as good as using a blocking lock with a timeout. In this case, the waiting
22390 is done inside the system call, and Exim's delivery process acquires the lock
22391 and can proceed as soon as the previous lock holder releases it.
22392
22393 If &%lock_fcntl_timeout%& is set to a non-zero time, blocking locks, with that
22394 timeout, are used. There may still be some retrying: the maximum number of
22395 retries is
22396 .code
22397 (lock_retries * lock_interval) / lock_fcntl_timeout
22398 .endd
22399 rounded up to the next whole number. In other words, the total time during
22400 which &(appendfile)& is trying to get a lock is roughly the same, unless
22401 &%lock_fcntl_timeout%& is set very large.
22402
22403 You should consider setting this option if you are getting a lot of delayed
22404 local deliveries because of errors of the form
22405 .code
22406 failed to lock mailbox /some/file (fcntl)
22407 .endd
22408
22409 .option lock_flock_timeout appendfile time 0s
22410 This timeout applies to file locking when using &[flock()]& (see
22411 &%use_flock%&); the timeout operates in a similar manner to
22412 &%lock_fcntl_timeout%&.
22413
22414
22415 .option lock_interval appendfile time 3s
22416 This specifies the time to wait between attempts to lock the file. See below
22417 for details of locking.
22418
22419
22420 .option lock_retries appendfile integer 10
22421 This specifies the maximum number of attempts to lock the file. A value of zero
22422 is treated as 1. See below for details of locking.
22423
22424
22425 .option lockfile_mode appendfile "octal integer" 0600
22426 This specifies the mode of the created lock file, when a lock file is being
22427 used (see &%use_lockfile%& and &%use_mbx_lock%&).
22428
22429
22430 .option lockfile_timeout appendfile time 30m
22431 .cindex "timeout" "mailbox locking"
22432 When a lock file is being used (see &%use_lockfile%&), if a lock file already
22433 exists and is older than this value, it is assumed to have been left behind by
22434 accident, and Exim attempts to remove it.
22435
22436
22437 .option mailbox_filecount appendfile string&!! unset
22438 .cindex "mailbox" "specifying size of"
22439 .cindex "size" "of mailbox"
22440 If this option is set, it is expanded, and the result is taken as the current
22441 number of files in the mailbox. It must be a decimal number, optionally
22442 followed by K or M. This provides a way of obtaining this information from an
22443 external source that maintains the data.
22444
22445
22446 .option mailbox_size appendfile string&!! unset
22447 .cindex "mailbox" "specifying size of"
22448 .cindex "size" "of mailbox"
22449 If this option is set, it is expanded, and the result is taken as the current
22450 size the mailbox. It must be a decimal number, optionally followed by K or M.
22451 This provides a way of obtaining this information from an external source that
22452 maintains the data. This is likely to be helpful for maildir deliveries where
22453 it is computationally expensive to compute the size of a mailbox.
22454
22455
22456
22457 .option maildir_format appendfile boolean false
22458 .cindex "maildir format" "specifying"
22459 If this option is set with the &%directory%& option, the delivery is into a new
22460 file, in the &"maildir"& format that is used by other mail software. When the
22461 transport is activated directly from a &(redirect)& router (for example, the
22462 &(address_file)& transport in the default configuration), setting
22463 &%maildir_format%& causes the path received from the router to be treated as a
22464 directory, whether or not it ends with &`/`&. This option is available only if
22465 SUPPORT_MAILDIR is present in &_Local/Makefile_&. See section
22466 &<<SECTmaildirdelivery>>& below for further details.
22467
22468
22469 .option maildir_quota_directory_regex appendfile string "See below"
22470 .cindex "maildir format" "quota; directories included in"
22471 .cindex "quota" "maildir; directories included in"
22472 This option is relevant only when &%maildir_use_size_file%& is set. It defines
22473 a regular expression for specifying directories, relative to the quota
22474 directory (see &%quota_directory%&), that should be included in the quota
22475 calculation. The default value is:
22476 .code
22477 maildir_quota_directory_regex = ^(?:cur|new|\..*)$
22478 .endd
22479 This includes the &_cur_& and &_new_& directories, and any maildir++ folders
22480 (directories whose names begin with a dot). If you want to exclude the
22481 &_Trash_&
22482 folder from the count (as some sites do), you need to change this setting to
22483 .code
22484 maildir_quota_directory_regex = ^(?:cur|new|\.(?!Trash).*)$
22485 .endd
22486 This uses a negative lookahead in the regular expression to exclude the
22487 directory whose name is &_.Trash_&. When a directory is excluded from quota
22488 calculations, quota processing is bypassed for any messages that are delivered
22489 directly into that directory.
22490
22491
22492 .option maildir_retries appendfile integer 10
22493 This option specifies the number of times to retry when writing a file in
22494 &"maildir"& format. See section &<<SECTmaildirdelivery>>& below.
22495
22496
22497 .option maildir_tag appendfile string&!! unset
22498 This option applies only to deliveries in maildir format, and is described in
22499 section &<<SECTmaildirdelivery>>& below.
22500
22501
22502 .option maildir_use_size_file appendfile&!! boolean false
22503 .cindex "maildir format" "&_maildirsize_& file"
22504 The result of string expansion for this option must be a valid boolean value.
22505 If it is true, it enables support for &_maildirsize_& files. Exim
22506 creates a &_maildirsize_& file in a maildir if one does not exist, taking the
22507 quota from the &%quota%& option of the transport. If &%quota%& is unset, the
22508 value is zero. See &%maildir_quota_directory_regex%& above and section
22509 &<<SECTmaildirdelivery>>& below for further details.
22510
22511 .option maildirfolder_create_regex appendfile string unset
22512 .cindex "maildir format" "&_maildirfolder_& file"
22513 .cindex "&_maildirfolder_&, creating"
22514 The value of this option is a regular expression. If it is unset, it has no
22515 effect. Otherwise, before a maildir delivery takes place, the pattern is
22516 matched against the name of the maildir directory, that is, the directory
22517 containing the &_new_& and &_tmp_& subdirectories that will be used for the
22518 delivery. If there is a match, Exim checks for the existence of a file called
22519 &_maildirfolder_& in the directory, and creates it if it does not exist.
22520 See section &<<SECTmaildirdelivery>>& for more details.
22521
22522
22523 .option mailstore_format appendfile boolean false
22524 .cindex "mailstore format" "specifying"
22525 If this option is set with the &%directory%& option, the delivery is into two
22526 new files in  &"mailstore"& format. The option is available only if
22527 SUPPORT_MAILSTORE is present in &_Local/Makefile_&. See section &<<SECTopdir>>&
22528 below for further details.
22529
22530
22531 .option mailstore_prefix appendfile string&!! unset
22532 This option applies only to deliveries in mailstore format, and is described in
22533 section &<<SECTopdir>>& below.
22534
22535
22536 .option mailstore_suffix appendfile string&!! unset
22537 This option applies only to deliveries in mailstore format, and is described in
22538 section &<<SECTopdir>>& below.
22539
22540
22541 .option mbx_format appendfile boolean false
22542 .cindex "locking files"
22543 .cindex "file" "locking"
22544 .cindex "file" "MBX format"
22545 .cindex "MBX format, specifying"
22546 This option is available only if Exim has been compiled with SUPPORT_MBX
22547 set in &_Local/Makefile_&. If &%mbx_format%& is set with the &%file%& option,
22548 the message is appended to the mailbox file in MBX format instead of
22549 traditional Unix format. This format is supported by Pine4 and its associated
22550 IMAP and POP daemons, by means of the &'c-client'& library that they all use.
22551
22552 &*Note*&: The &%message_prefix%& and &%message_suffix%& options are not
22553 automatically changed by the use of &%mbx_format%&. They should normally be set
22554 empty when using MBX format, so this option almost always appears in this
22555 combination:
22556 .code
22557 mbx_format = true
22558 message_prefix =
22559 message_suffix =
22560 .endd
22561 If none of the locking options are mentioned in the configuration,
22562 &%use_mbx_lock%& is assumed and the other locking options default to false. It
22563 is possible to specify the other kinds of locking with &%mbx_format%&, but
22564 &%use_fcntl_lock%& and &%use_mbx_lock%& are mutually exclusive. MBX locking
22565 interworks with &'c-client'&, providing for shared access to the mailbox. It
22566 should not be used if any program that does not use this form of locking is
22567 going to access the mailbox, nor should it be used if the mailbox file is NFS
22568 mounted, because it works only when the mailbox is accessed from a single host.
22569
22570 If you set &%use_fcntl_lock%& with an MBX-format mailbox, you cannot use
22571 the standard version of &'c-client'&, because as long as it has a mailbox open
22572 (this means for the whole of a Pine or IMAP session), Exim will not be able to
22573 append messages to it.
22574
22575
22576 .option message_prefix appendfile string&!! "see below"
22577 .cindex "&""From""& line"
22578 The string specified here is expanded and output at the start of every message.
22579 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22580 in which case it is:
22581 .code
22582 message_prefix = "From ${if def:return_path{$return_path}\
22583   {MAILER-DAEMON}} $tod_bsdinbox\n"
22584 .endd
22585 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22586 &`\n`& to &`\r\n`& in &%message_prefix%&.
22587
22588 .option message_suffix appendfile string&!! "see below"
22589 The string specified here is expanded and output at the end of every message.
22590 The default is unset unless &%file%& is specified and &%use_bsmtp%& is not set,
22591 in which case it is a single newline character. The suffix can be suppressed by
22592 setting
22593 .code
22594 message_suffix =
22595 .endd
22596 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
22597 &`\n`& to &`\r\n`& in &%message_suffix%&.
22598
22599 .option mode appendfile "octal integer" 0600
22600 If the output file is created, it is given this mode. If it already exists and
22601 has wider permissions, they are reduced to this mode. If it has narrower
22602 permissions, an error occurs unless &%mode_fail_narrower%& is false. However,
22603 if the delivery is the result of a &%save%& command in a filter file specifying
22604 a particular mode, the mode of the output file is always forced to take that
22605 value, and this option is ignored.
22606
22607
22608 .option mode_fail_narrower appendfile boolean true
22609 This option applies in the case when an existing mailbox file has a narrower
22610 mode than that specified by the &%mode%& option. If &%mode_fail_narrower%& is
22611 true, the delivery is deferred (&"mailbox has the wrong mode"&); otherwise Exim
22612 continues with the delivery attempt, using the existing mode of the file.
22613
22614
22615 .option notify_comsat appendfile boolean false
22616 If this option is true, the &'comsat'& daemon is notified after every
22617 successful delivery to a user mailbox. This is the daemon that notifies logged
22618 on users about incoming mail.
22619
22620
22621 .option quota appendfile string&!! unset
22622 .cindex "quota" "imposed by Exim"
22623 This option imposes a limit on the size of the file to which Exim is appending,
22624 or to the total space used in the directory tree when the &%directory%& option
22625 is set. In the latter case, computation of the space used is expensive, because
22626 all the files in the directory (and any sub-directories) have to be
22627 individually inspected and their sizes summed. (See &%quota_size_regex%& and
22628 &%maildir_use_size_file%& for ways to avoid this in environments where users
22629 have no shell access to their mailboxes).
22630
22631 As there is no interlock against two simultaneous deliveries into a
22632 multi-file mailbox, it is possible for the quota to be overrun in this case.
22633 For single-file mailboxes, of course, an interlock is a necessity.
22634
22635 A file's size is taken as its &'used'& value. Because of blocking effects, this
22636 may be a lot less than the actual amount of disk space allocated to the file.
22637 If the sizes of a number of files are being added up, the rounding effect can
22638 become quite noticeable, especially on systems that have large block sizes.
22639 Nevertheless, it seems best to stick to the &'used'& figure, because this is
22640 the obvious value which users understand most easily.
22641
22642 The value of the option is expanded, and must then be a numerical value
22643 (decimal point allowed), optionally followed by one of the letters K, M, or G,
22644 for kilobytes, megabytes, or gigabytes, optionally followed by a slash
22645 and further option modifiers. If Exim is running on a system with
22646 large file support (Linux and FreeBSD have this), mailboxes larger than 2G can
22647 be handled.
22648
22649 The option modifier &%no_check%& can be used to force delivery even if the over
22650 quota condition is met. The quota gets updated as usual.
22651
22652 &*Note*&: A value of zero is interpreted as &"no quota"&.
22653
22654 The expansion happens while Exim is running as root, before it changes uid for
22655 the delivery. This means that files that are inaccessible to the end user can
22656 be used to hold quota values that are looked up in the expansion. When delivery
22657 fails because this quota is exceeded, the handling of the error is as for
22658 system quota failures.
22659
22660 By default, Exim's quota checking mimics system quotas, and restricts the
22661 mailbox to the specified maximum size, though the value is not accurate to the
22662 last byte, owing to separator lines and additional headers that may get added
22663 during message delivery. When a mailbox is nearly full, large messages may get
22664 refused even though small ones are accepted, because the size of the current
22665 message is added to the quota when the check is made. This behaviour can be
22666 changed by setting &%quota_is_inclusive%& false. When this is done, the check
22667 for exceeding the quota does not include the current message. Thus, deliveries
22668 continue until the quota has been exceeded; thereafter, no further messages are
22669 delivered. See also &%quota_warn_threshold%&.
22670
22671
22672 .option quota_directory appendfile string&!! unset
22673 This option defines the directory to check for quota purposes when delivering
22674 into individual files. The default is the delivery directory, or, if a file
22675 called &_maildirfolder_& exists in a maildir directory, the parent of the
22676 delivery directory.
22677
22678
22679 .option quota_filecount appendfile string&!! 0
22680 This option applies when the &%directory%& option is set. It limits the total
22681 number of files in the directory (compare the inode limit in system quotas). It
22682 can only be used if &%quota%& is also set. The value is expanded; an expansion
22683 failure causes delivery to be deferred. A value of zero is interpreted as
22684 &"no quota"&.
22685
22686 The option modifier &%no_check%& can be used to force delivery even if the over
22687 quota condition is met. The quota gets updated as usual.
22688
22689 .option quota_is_inclusive appendfile boolean true
22690 See &%quota%& above.
22691
22692
22693 .option quota_size_regex appendfile string unset
22694 This option applies when one of the delivery modes that writes a separate file
22695 for each message is being used. When Exim wants to find the size of one of
22696 these files in order to test the quota, it first checks &%quota_size_regex%&.
22697 If this is set to a regular expression that matches the filename, and it
22698 captures one string, that string is interpreted as a representation of the
22699 file's size. The value of &%quota_size_regex%& is not expanded.
22700
22701 This feature is useful only when users have no shell access to their mailboxes
22702 &-- otherwise they could defeat the quota simply by renaming the files. This
22703 facility can be used with maildir deliveries, by setting &%maildir_tag%& to add
22704 the file length to the filename. For example:
22705 .code
22706 maildir_tag = ,S=$message_size
22707 quota_size_regex = ,S=(\d+)
22708 .endd
22709 An alternative to &$message_size$& is &$message_linecount$&, which contains the
22710 number of lines in the message.
22711
22712 The regular expression should not assume that the length is at the end of the
22713 filename (even though &%maildir_tag%& puts it there) because maildir MUAs
22714 sometimes add other information onto the ends of message filenames.
22715
22716 Section &<<SECID136>>& contains further information.
22717
22718
22719 .option quota_warn_message appendfile string&!! "see below"
22720 See below for the use of this option. If it is not set when
22721 &%quota_warn_threshold%& is set, it defaults to
22722 .code
22723 quota_warn_message = "\
22724   To: $local_part@$domain\n\
22725   Subject: Your mailbox\n\n\
22726   This message is automatically created \
22727   by mail delivery software.\n\n\
22728   The size of your mailbox has exceeded \
22729   a warning threshold that is\n\
22730   set by the system administrator.\n"
22731 .endd
22732
22733
22734 .option quota_warn_threshold appendfile string&!! 0
22735 .cindex "quota" "warning threshold"
22736 .cindex "mailbox" "size warning"
22737 .cindex "size" "of mailbox"
22738 This option is expanded in the same way as &%quota%& (see above). If the
22739 resulting value is greater than zero, and delivery of the message causes the
22740 size of the file or total space in the directory tree to cross the given
22741 threshold, a warning message is sent. If &%quota%& is also set, the threshold
22742 may be specified as a percentage of it by following the value with a percent
22743 sign. For example:
22744 .code
22745 quota = 10M
22746 quota_warn_threshold = 75%
22747 .endd
22748 If &%quota%& is not set, a setting of &%quota_warn_threshold%& that ends with a
22749 percent sign is ignored.
22750
22751 The warning message itself is specified by the &%quota_warn_message%& option,
22752 and it must start with a &'To:'& header line containing the recipient(s) of the
22753 warning message. These do not necessarily have to include the recipient(s) of
22754 the original message. A &'Subject:'& line should also normally be supplied. You
22755 can include any other header lines that you want. If you do not include a
22756 &'From:'& line, the default is:
22757 .code
22758 From: Mail Delivery System <mailer-daemon@$qualify_domain_sender>
22759 .endd
22760 .oindex &%errors_reply_to%&
22761 If you supply a &'Reply-To:'& line, it overrides the global &%errors_reply_to%&
22762 option.
22763
22764 The &%quota%& option does not have to be set in order to use this option; they
22765 are independent of one another except when the threshold is specified as a
22766 percentage.
22767
22768
22769 .option use_bsmtp appendfile boolean false
22770 .cindex "envelope sender"
22771 If this option is set true, &(appendfile)& writes messages in &"batch SMTP"&
22772 format, with the envelope sender and recipient(s) included as SMTP commands. If
22773 you want to include a leading HELO command with such messages, you can do
22774 so by setting the &%message_prefix%& option. See section &<<SECTbatchSMTP>>&
22775 for details of batch SMTP.
22776
22777
22778 .option use_crlf appendfile boolean false
22779 .cindex "carriage return"
22780 .cindex "linefeed"
22781 This option causes lines to be terminated with the two-character CRLF sequence
22782 (carriage return, linefeed) instead of just a linefeed character. In the case
22783 of batched SMTP, the byte sequence written to the file is then an exact image
22784 of what would be sent down a real SMTP connection.
22785
22786 &*Note:*& The contents of the &%message_prefix%& and &%message_suffix%& options
22787 (which are used to supply the traditional &"From&~"& and blank line separators
22788 in Berkeley-style mailboxes) are written verbatim, so must contain their own
22789 carriage return characters if these are needed. In cases where these options
22790 have non-empty defaults, the values end with a single linefeed, so they must be
22791 changed to end with &`\r\n`& if &%use_crlf%& is set.
22792
22793
22794 .option use_fcntl_lock appendfile boolean "see below"
22795 This option controls the use of the &[fcntl()]& function to lock a file for
22796 exclusive use when a message is being appended. It is set by default unless
22797 &%use_flock_lock%& is set. Otherwise, it should be turned off only if you know
22798 that all your MUAs use lock file locking. When both &%use_fcntl_lock%& and
22799 &%use_flock_lock%& are unset, &%use_lockfile%& must be set.
22800
22801
22802 .option use_flock_lock appendfile boolean false
22803 This option is provided to support the use of &[flock()]& for file locking, for
22804 the few situations where it is needed. Most modern operating systems support
22805 &[fcntl()]& and &[lockf()]& locking, and these two functions interwork with
22806 each other. Exim uses &[fcntl()]& locking by default.
22807
22808 This option is required only if you are using an operating system where
22809 &[flock()]& is used by programs that access mailboxes (typically MUAs), and
22810 where &[flock()]& does not correctly interwork with &[fcntl()]&. You can use
22811 both &[fcntl()]& and &[flock()]& locking simultaneously if you want.
22812
22813 .cindex "Solaris" "&[flock()]& support"
22814 Not all operating systems provide &[flock()]&. Some versions of Solaris do not
22815 have it (and some, I think, provide a not quite right version built on top of
22816 &[lockf()]&). If the OS does not have &[flock()]&, Exim will be built without
22817 the ability to use it, and any attempt to do so will cause a configuration
22818 error.
22819
22820 &*Warning*&: &[flock()]& locks do not work on NFS files (unless &[flock()]&
22821 is just being mapped onto &[fcntl()]& by the OS).
22822
22823
22824 .option use_lockfile appendfile boolean "see below"
22825 If this option is turned off, Exim does not attempt to create a lock file when
22826 appending to a mailbox file. In this situation, the only locking is by
22827 &[fcntl()]&. You should only turn &%use_lockfile%& off if you are absolutely
22828 sure that every MUA that is ever going to look at your users' mailboxes uses
22829 &[fcntl()]& rather than a lock file, and even then only when you are not
22830 delivering over NFS from more than one host.
22831
22832 .cindex "NFS" "lock file"
22833 In order to append to an NFS file safely from more than one host, it is
22834 necessary to take out a lock &'before'& opening the file, and the lock file
22835 achieves this. Otherwise, even with &[fcntl()]& locking, there is a risk of
22836 file corruption.
22837
22838 The &%use_lockfile%& option is set by default unless &%use_mbx_lock%& is set.
22839 It is not possible to turn both &%use_lockfile%& and &%use_fcntl_lock%& off,
22840 except when &%mbx_format%& is set.
22841
22842
22843 .option use_mbx_lock appendfile boolean "see below"
22844 This option is available only if Exim has been compiled with SUPPORT_MBX
22845 set in &_Local/Makefile_&. Setting the option specifies that special MBX
22846 locking rules be used. It is set by default if &%mbx_format%& is set and none
22847 of the locking options are mentioned in the configuration. The locking rules
22848 are the same as are used by the &'c-client'& library that underlies Pine and
22849 the IMAP4 and POP daemons that come with it (see the discussion below). The
22850 rules allow for shared access to the mailbox. However, this kind of locking
22851 does not work when the mailbox is NFS mounted.
22852
22853 You can set &%use_mbx_lock%& with either (or both) of &%use_fcntl_lock%& and
22854 &%use_flock_lock%& to control what kind of locking is used in implementing the
22855 MBX locking rules. The default is to use &[fcntl()]& if &%use_mbx_lock%& is set
22856 without &%use_fcntl_lock%& or &%use_flock_lock%&.
22857
22858
22859
22860
22861 .section "Operational details for appending" "SECTopappend"
22862 .cindex "appending to a file"
22863 .cindex "file" "appending"
22864 Before appending to a file, the following preparations are made:
22865
22866 .ilist
22867 If the name of the file is &_/dev/null_&, no action is taken, and a success
22868 return is given.
22869
22870 .next
22871 .cindex "directory creation"
22872 If any directories on the file's path are missing, Exim creates them if the
22873 &%create_directory%& option is set. A created directory's mode is given by the
22874 &%directory_mode%& option.
22875
22876 .next
22877 If &%file_format%& is set, the format of an existing file is checked. If this
22878 indicates that a different transport should be used, control is passed to that
22879 transport.
22880
22881 .next
22882 .cindex "file" "locking"
22883 .cindex "locking files"
22884 .cindex "NFS" "lock file"
22885 If &%use_lockfile%& is set, a lock file is built in a way that will work
22886 reliably over NFS, as follows:
22887
22888 .olist
22889 Create a &"hitching post"& file whose name is that of the lock file with the
22890 current time, primary host name, and process id added, by opening for writing
22891 as a new file. If this fails with an access error, delivery is deferred.
22892 .next
22893 Close the hitching post file, and hard link it to the lock filename.
22894 .next
22895 If the call to &[link()]& succeeds, creation of the lock file has succeeded.
22896 Unlink the hitching post name.
22897 .next
22898 Otherwise, use &[stat()]& to get information about the hitching post file, and
22899 then unlink hitching post name. If the number of links is exactly two, creation
22900 of the lock file succeeded but something (for example, an NFS server crash and
22901 restart) caused this fact not to be communicated to the &[link()]& call.
22902 .next
22903 If creation of the lock file failed, wait for &%lock_interval%& and try again,
22904 up to &%lock_retries%& times. However, since any program that writes to a
22905 mailbox should complete its task very quickly, it is reasonable to time out old
22906 lock files that are normally the result of user agent and system crashes. If an
22907 existing lock file is older than &%lockfile_timeout%& Exim attempts to unlink
22908 it before trying again.
22909 .endlist olist
22910
22911 .next
22912 A call is made to &[lstat()]& to discover whether the main file exists, and if
22913 so, what its characteristics are. If &[lstat()]& fails for any reason other
22914 than non-existence, delivery is deferred.
22915
22916 .next
22917 .cindex "symbolic link" "to mailbox"
22918 .cindex "mailbox" "symbolic link"
22919 If the file does exist and is a symbolic link, delivery is deferred, unless the
22920 &%allow_symlink%& option is set, in which case the ownership of the link is
22921 checked, and then &[stat()]& is called to find out about the real file, which
22922 is then subjected to the checks below. The check on the top-level link
22923 ownership prevents one user creating a link for another's mailbox in a sticky
22924 directory, though allowing symbolic links in this case is definitely not a good
22925 idea. If there is a chain of symbolic links, the intermediate ones are not
22926 checked.
22927
22928 .next
22929 If the file already exists but is not a regular file, or if the file's owner
22930 and group (if the group is being checked &-- see &%check_group%& above) are
22931 different from the user and group under which the delivery is running,
22932 delivery is deferred.
22933
22934 .next
22935 If the file's permissions are more generous than specified, they are reduced.
22936 If they are insufficient, delivery is deferred, unless &%mode_fail_narrower%&
22937 is set false, in which case the delivery is tried using the existing
22938 permissions.
22939
22940 .next
22941 The file's inode number is saved, and the file is then opened for appending.
22942 If this fails because the file has vanished, &(appendfile)& behaves as if it
22943 hadn't existed (see below). For any other failures, delivery is deferred.
22944
22945 .next
22946 If the file is opened successfully, check that the inode number hasn't
22947 changed, that it is still a regular file, and that the owner and permissions
22948 have not changed. If anything is wrong, defer delivery and freeze the message.
22949
22950 .next
22951 If the file did not exist originally, defer delivery if the &%file_must_exist%&
22952 option is set. Otherwise, check that the file is being created in a permitted
22953 directory if the &%create_file%& option is set (deferring on failure), and then
22954 open for writing as a new file, with the O_EXCL and O_CREAT options,
22955 except when dealing with a symbolic link (the &%allow_symlink%& option must be
22956 set). In this case, which can happen if the link points to a non-existent file,
22957 the file is opened for writing using O_CREAT but not O_EXCL, because
22958 that prevents link following.
22959
22960 .next
22961 .cindex "loop" "while file testing"
22962 If opening fails because the file exists, obey the tests given above for
22963 existing files. However, to avoid looping in a situation where the file is
22964 being continuously created and destroyed, the exists/not-exists loop is broken
22965 after 10 repetitions, and the message is then frozen.
22966
22967 .next
22968 If opening fails with any other error, defer delivery.
22969
22970 .next
22971 .cindex "file" "locking"
22972 .cindex "locking files"
22973 Once the file is open, unless both &%use_fcntl_lock%& and &%use_flock_lock%&
22974 are false, it is locked using &[fcntl()]& or &[flock()]& or both. If
22975 &%use_mbx_lock%& is false, an exclusive lock is requested in each case.
22976 However, if &%use_mbx_lock%& is true, Exim takes out a shared lock on the open
22977 file, and an exclusive lock on the file whose name is
22978 .code
22979 /tmp/.<device-number>.<inode-number>
22980 .endd
22981 using the device and inode numbers of the open mailbox file, in accordance with
22982 the MBX locking rules. This file is created with a mode that is specified by
22983 the &%lockfile_mode%& option.
22984
22985 If Exim fails to lock the file, there are two possible courses of action,
22986 depending on the value of the locking timeout. This is obtained from
22987 &%lock_fcntl_timeout%& or &%lock_flock_timeout%&, as appropriate.
22988
22989 If the timeout value is zero, the file is closed, Exim waits for
22990 &%lock_interval%&, and then goes back and re-opens the file as above and tries
22991 to lock it again. This happens up to &%lock_retries%& times, after which the
22992 delivery is deferred.
22993
22994 If the timeout has a value greater than zero, blocking calls to &[fcntl()]& or
22995 &[flock()]& are used (with the given timeout), so there has already been some
22996 waiting involved by the time locking fails. Nevertheless, Exim does not give up
22997 immediately. It retries up to
22998 .code
22999 (lock_retries * lock_interval) / <timeout>
23000 .endd
23001 times (rounded up).
23002 .endlist
23003
23004 At the end of delivery, Exim closes the file (which releases the &[fcntl()]&
23005 and/or &[flock()]& locks) and then deletes the lock file if one was created.
23006
23007
23008 .section "Operational details for delivery to a new file" "SECTopdir"
23009 .cindex "delivery" "to single file"
23010 .cindex "&""From""& line"
23011 When the &%directory%& option is set instead of &%file%&, each message is
23012 delivered into a newly-created file or set of files. When &(appendfile)& is
23013 activated directly from a &(redirect)& router, neither &%file%& nor
23014 &%directory%& is normally set, because the path for delivery is supplied by the
23015 router. (See for example, the &(address_file)& transport in the default
23016 configuration.) In this case, delivery is to a new file if either the path name
23017 ends in &`/`&, or the &%maildir_format%& or &%mailstore_format%& option is set.
23018
23019 No locking is required while writing the message to a new file, so the various
23020 locking options of the transport are ignored. The &"From"& line that by default
23021 separates messages in a single file is not normally needed, nor is the escaping
23022 of message lines that start with &"From"&, and there is no need to ensure a
23023 newline at the end of each message. Consequently, the default values for
23024 &%check_string%&, &%message_prefix%&, and &%message_suffix%& are all unset when
23025 any of &%directory%&, &%maildir_format%&, or &%mailstore_format%& is set.
23026
23027 If Exim is required to check a &%quota%& setting, it adds up the sizes of all
23028 the files in the delivery directory by default. However, you can specify a
23029 different directory by setting &%quota_directory%&. Also, for maildir
23030 deliveries (see below) the &_maildirfolder_& convention is honoured.
23031
23032
23033 .cindex "maildir format"
23034 .cindex "mailstore format"
23035 There are three different ways in which delivery to individual files can be
23036 done, controlled by the settings of the &%maildir_format%& and
23037 &%mailstore_format%& options. Note that code to support maildir or mailstore
23038 formats is not included in the binary unless SUPPORT_MAILDIR or
23039 SUPPORT_MAILSTORE, respectively, is set in &_Local/Makefile_&.
23040
23041 .cindex "directory creation"
23042 In all three cases an attempt is made to create the directory and any necessary
23043 sub-directories if they do not exist, provided that the &%create_directory%&
23044 option is set (the default). The location of a created directory can be
23045 constrained by setting &%create_file%&. A created directory's mode is given by
23046 the &%directory_mode%& option. If creation fails, or if the
23047 &%create_directory%& option is not set when creation is required, delivery is
23048 deferred.
23049
23050
23051
23052 .section "Maildir delivery" "SECTmaildirdelivery"
23053 .cindex "maildir format" "description of"
23054 If the &%maildir_format%& option is true, Exim delivers each message by writing
23055 it to a file whose name is &_tmp/<stime>.H<mtime>P<pid>.<host>_& in the
23056 directory that is defined by the &%directory%& option (the &"delivery
23057 directory"&). If the delivery is successful, the file is renamed into the
23058 &_new_& subdirectory.
23059
23060 In the filename, <&'stime'&> is the current time of day in seconds, and
23061 <&'mtime'&> is the microsecond fraction of the time. After a maildir delivery,
23062 Exim checks that the time-of-day clock has moved on by at least one microsecond
23063 before terminating the delivery process. This guarantees uniqueness for the
23064 filename. However, as a precaution, Exim calls &[stat()]& for the file before
23065 opening it. If any response other than ENOENT (does not exist) is given,
23066 Exim waits 2 seconds and tries again, up to &%maildir_retries%& times.
23067
23068 Before Exim carries out a maildir delivery, it ensures that subdirectories
23069 called &_new_&, &_cur_&, and &_tmp_& exist in the delivery directory. If they
23070 do not exist, Exim tries to create them and any superior directories in their
23071 path, subject to the &%create_directory%& and &%create_file%& options. If the
23072 &%maildirfolder_create_regex%& option is set, and the regular expression it
23073 contains matches the delivery directory, Exim also ensures that a file called
23074 &_maildirfolder_& exists in the delivery directory. If a missing directory or
23075 &_maildirfolder_& file cannot be created, delivery is deferred.
23076
23077 These features make it possible to use Exim to create all the necessary files
23078 and directories in a maildir mailbox, including subdirectories for maildir++
23079 folders. Consider this example:
23080 .code
23081 maildir_format = true
23082 directory = /var/mail/$local_part\
23083            ${if eq{$local_part_suffix}{}{}\
23084            {/.${substr_1:$local_part_suffix}}}
23085 maildirfolder_create_regex = /\.[^/]+$
23086 .endd
23087 If &$local_part_suffix$& is empty (there was no suffix for the local part),
23088 delivery is into a toplevel maildir with a name like &_/var/mail/pimbo_& (for
23089 the user called &'pimbo'&). The pattern in &%maildirfolder_create_regex%& does
23090 not match this name, so Exim will not look for or create the file
23091 &_/var/mail/pimbo/maildirfolder_&, though it will create
23092 &_/var/mail/pimbo/{cur,new,tmp}_& if necessary.
23093
23094 However, if &$local_part_suffix$& contains &`-eximusers`& (for example),
23095 delivery is into the maildir++ folder &_/var/mail/pimbo/.eximusers_&, which
23096 does match &%maildirfolder_create_regex%&. In this case, Exim will create
23097 &_/var/mail/pimbo/.eximusers/maildirfolder_& as well as the three maildir
23098 directories &_/var/mail/pimbo/.eximusers/{cur,new,tmp}_&.
23099
23100 &*Warning:*& Take care when setting &%maildirfolder_create_regex%& that it does
23101 not inadvertently match the toplevel maildir directory, because a
23102 &_maildirfolder_& file at top level would completely break quota calculations.
23103
23104 .cindex "quota" "in maildir delivery"
23105 .cindex "maildir++"
23106 If Exim is required to check a &%quota%& setting before a maildir delivery, and
23107 &%quota_directory%& is not set, it looks for a file called &_maildirfolder_& in
23108 the maildir directory (alongside &_new_&, &_cur_&, &_tmp_&). If this exists,
23109 Exim assumes the directory is a maildir++ folder directory, which is one level
23110 down from the user's top level mailbox directory. This causes it to start at
23111 the parent directory instead of the current directory when calculating the
23112 amount of space used.
23113
23114 One problem with delivering into a multi-file mailbox is that it is
23115 computationally expensive to compute the size of the mailbox for quota
23116 checking. Various approaches have been taken to reduce the amount of work
23117 needed. The next two sections describe two of them. A third alternative is to
23118 use some external process for maintaining the size data, and use the expansion
23119 of the &%mailbox_size%& option as a way of importing it into Exim.
23120
23121
23122
23123
23124 .section "Using tags to record message sizes" "SECID135"
23125 If &%maildir_tag%& is set, the string is expanded for each delivery.
23126 When the maildir file is renamed into the &_new_& sub-directory, the
23127 tag is added to its name. However, if adding the tag takes the length of the
23128 name to the point where the test &[stat()]& call fails with ENAMETOOLONG,
23129 the tag is dropped and the maildir file is created with no tag.
23130
23131
23132 .vindex "&$message_size$&"
23133 Tags can be used to encode the size of files in their names; see
23134 &%quota_size_regex%& above for an example. The expansion of &%maildir_tag%&
23135 happens after the message has been written. The value of the &$message_size$&
23136 variable is set to the number of bytes actually written. If the expansion is
23137 forced to fail, the tag is ignored, but a non-forced failure causes delivery to
23138 be deferred. The expanded tag may contain any printing characters except &"/"&.
23139 Non-printing characters in the string are ignored; if the resulting string is
23140 empty, it is ignored. If it starts with an alphanumeric character, a leading
23141 colon is inserted; this default has not proven to be the path that popular
23142 maildir implementations have chosen (but changing it in Exim would break
23143 backwards compatibility).
23144
23145 For one common implementation, you might set:
23146 .code
23147 maildir_tag = ,S=${message_size}
23148 .endd
23149 but you should check the documentation of the other software to be sure.
23150
23151 It is advisable to also set &%quota_size_regex%& when setting &%maildir_tag%&
23152 as this allows Exim to extract the size from your tag, instead of having to
23153 &[stat()]& each message file.
23154
23155
23156 .section "Using a maildirsize file" "SECID136"
23157 .cindex "quota" "in maildir delivery"
23158 .cindex "maildir format" "&_maildirsize_& file"
23159 If &%maildir_use_size_file%& is true, Exim implements the maildir++ rules for
23160 storing quota and message size information in a file called &_maildirsize_&
23161 within the toplevel maildir directory. If this file does not exist, Exim
23162 creates it, setting the quota from the &%quota%& option of the transport. If
23163 the maildir directory itself does not exist, it is created before any attempt
23164 to write a &_maildirsize_& file.
23165
23166 The &_maildirsize_& file is used to hold information about the sizes of
23167 messages in the maildir, thus speeding up quota calculations. The quota value
23168 in the file is just a cache; if the quota is changed in the transport, the new
23169 value overrides the cached value when the next message is delivered. The cache
23170 is maintained for the benefit of other programs that access the maildir and
23171 need to know the quota.
23172
23173 If the &%quota%& option in the transport is unset or zero, the &_maildirsize_&
23174 file is maintained (with a zero quota setting), but no quota is imposed.
23175
23176 A regular expression is available for controlling which directories in the
23177 maildir participate in quota calculations when a &_maildirsizefile_& is in use.
23178 See the description of the &%maildir_quota_directory_regex%& option above for
23179 details.
23180
23181
23182 .section "Mailstore delivery" "SECID137"
23183 .cindex "mailstore format" "description of"
23184 If the &%mailstore_format%& option is true, each message is written as two
23185 files in the given directory. A unique base name is constructed from the
23186 message id and the current delivery process, and the files that are written use
23187 this base name plus the suffixes &_.env_& and &_.msg_&. The &_.env_& file
23188 contains the message's envelope, and the &_.msg_& file contains the message
23189 itself. The base name is placed in the variable &$mailstore_basename$&.
23190
23191 During delivery, the envelope is first written to a file with the suffix
23192 &_.tmp_&. The &_.msg_& file is then written, and when it is complete, the
23193 &_.tmp_& file is renamed as the &_.env_& file. Programs that access messages in
23194 mailstore format should wait for the presence of both a &_.msg_& and a &_.env_&
23195 file before accessing either of them. An alternative approach is to wait for
23196 the absence of a &_.tmp_& file.
23197
23198 The envelope file starts with any text defined by the &%mailstore_prefix%&
23199 option, expanded and terminated by a newline if there isn't one. Then follows
23200 the sender address on one line, then all the recipient addresses, one per line.
23201 There can be more than one recipient only if the &%batch_max%& option is set
23202 greater than one. Finally, &%mailstore_suffix%& is expanded and the result
23203 appended to the file, followed by a newline if it does not end with one.
23204
23205 If expansion of &%mailstore_prefix%& or &%mailstore_suffix%& ends with a forced
23206 failure, it is ignored. Other expansion errors are treated as serious
23207 configuration errors, and delivery is deferred. The variable
23208 &$mailstore_basename$& is available for use during these expansions.
23209
23210
23211 .section "Non-special new file delivery" "SECID138"
23212 If neither &%maildir_format%& nor &%mailstore_format%& is set, a single new
23213 file is created directly in the named directory. For example, when delivering
23214 messages into files in batched SMTP format for later delivery to some host (see
23215 section &<<SECTbatchSMTP>>&), a setting such as
23216 .code
23217 directory = /var/bsmtp/$host
23218 .endd
23219 might be used. A message is written to a file with a temporary name, which is
23220 then renamed when the delivery is complete. The final name is obtained by
23221 expanding the contents of the &%directory_file%& option.
23222 .ecindex IIDapptra1
23223 .ecindex IIDapptra2
23224
23225
23226
23227
23228
23229
23230 . ////////////////////////////////////////////////////////////////////////////
23231 . ////////////////////////////////////////////////////////////////////////////
23232
23233 .chapter "The autoreply transport" "CHID8"
23234 .scindex IIDauttra1 "transports" "&(autoreply)&"
23235 .scindex IIDauttra2 "&(autoreply)& transport"
23236 The &(autoreply)& transport is not a true transport in that it does not cause
23237 the message to be transmitted. Instead, it generates a new mail message as an
23238 automatic reply to the incoming message. &'References:'& and
23239 &'Auto-Submitted:'& header lines are included. These are constructed according
23240 to the rules in RFCs 2822 and 3834, respectively.
23241
23242 If the router that passes the message to this transport does not have the
23243 &%unseen%& option set, the original message (for the current recipient) is not
23244 delivered anywhere. However, when the &%unseen%& option is set on the router
23245 that passes the message to this transport, routing of the address continues, so
23246 another router can set up a normal message delivery.
23247
23248
23249 The &(autoreply)& transport is usually run as the result of mail filtering, a
23250 &"vacation"& message being the standard example. However, it can also be run
23251 directly from a router like any other transport. To reduce the possibility of
23252 message cascades, messages created by the &(autoreply)& transport always have
23253 empty envelope sender addresses, like bounce messages.
23254
23255 The parameters of the message to be sent can be specified in the configuration
23256 by options described below. However, these are used only when the address
23257 passed to the transport does not contain its own reply information. When the
23258 transport is run as a consequence of a
23259 &%mail%&
23260 or &%vacation%& command in a filter file, the parameters of the message are
23261 supplied by the filter, and passed with the address. The transport's options
23262 that define the message are then ignored (so they are not usually set in this
23263 case). The message is specified entirely by the filter or by the transport; it
23264 is never built from a mixture of options. However, the &%file_optional%&,
23265 &%mode%&, and &%return_message%& options apply in all cases.
23266
23267 &(Autoreply)& is implemented as a local transport. When used as a result of a
23268 command in a user's filter file, &(autoreply)& normally runs under the uid and
23269 gid of the user, and with appropriate current and home directories (see chapter
23270 &<<CHAPenvironment>>&).
23271
23272 There is a subtle difference between routing a message to a &(pipe)& transport
23273 that generates some text to be returned to the sender, and routing it to an
23274 &(autoreply)& transport. This difference is noticeable only if more than one
23275 address from the same message is so handled. In the case of a pipe, the
23276 separate outputs from the different addresses are gathered up and returned to
23277 the sender in a single message, whereas if &(autoreply)& is used, a separate
23278 message is generated for each address that is passed to it.
23279
23280 Non-printing characters are not permitted in the header lines generated for the
23281 message that &(autoreply)& creates, with the exception of newlines that are
23282 immediately followed by white space. If any non-printing characters are found,
23283 the transport defers.
23284 Whether characters with the top bit set count as printing characters or not is
23285 controlled by the &%print_topbitchars%& global option.
23286
23287 If any of the generic options for manipulating headers (for example,
23288 &%headers_add%&) are set on an &(autoreply)& transport, they apply to the copy
23289 of the original message that is included in the generated message when
23290 &%return_message%& is set. They do not apply to the generated message itself.
23291
23292 .vindex "&$sender_address$&"
23293 If the &(autoreply)& transport receives return code 2 from Exim when it submits
23294 the message, indicating that there were no recipients, it does not treat this
23295 as an error. This means that autoreplies sent to &$sender_address$& when this
23296 is empty (because the incoming message is a bounce message) do not cause
23297 problems. They are just discarded.
23298
23299
23300
23301 .section "Private options for autoreply" "SECID139"
23302 .cindex "options" "&(autoreply)& transport"
23303
23304 .option bcc autoreply string&!! unset
23305 This specifies the addresses that are to receive &"blind carbon copies"& of the
23306 message when the message is specified by the transport.
23307
23308
23309 .option cc autoreply string&!! unset
23310 This specifies recipients of the message and the contents of the &'Cc:'& header
23311 when the message is specified by the transport.
23312
23313
23314 .option file autoreply string&!! unset
23315 The contents of the file are sent as the body of the message when the message
23316 is specified by the transport. If both &%file%& and &%text%& are set, the text
23317 string comes first.
23318
23319
23320 .option file_expand autoreply boolean false
23321 If this is set, the contents of the file named by the &%file%& option are
23322 subjected to string expansion as they are added to the message.
23323
23324
23325 .option file_optional autoreply boolean false
23326 If this option is true, no error is generated if the file named by the &%file%&
23327 option or passed with the address does not exist or cannot be read.
23328
23329
23330 .option from autoreply string&!! unset
23331 This specifies the contents of the &'From:'& header when the message is
23332 specified by the transport.
23333
23334
23335 .option headers autoreply string&!! unset
23336 This specifies additional RFC 2822 headers that are to be added to the message
23337 when the message is specified by the transport. Several can be given by using
23338 &"\n"& to separate them. There is no check on the format.
23339
23340
23341 .option log autoreply string&!! unset
23342 This option names a file in which a record of every message sent is logged when
23343 the message is specified by the transport.
23344
23345
23346 .option mode autoreply "octal integer" 0600
23347 If either the log file or the &"once"& file has to be created, this mode is
23348 used.
23349
23350
23351 .option never_mail autoreply "address list&!!" unset
23352 If any run of the transport creates a message with a recipient that matches any
23353 item in the list, that recipient is quietly discarded. If all recipients are
23354 discarded, no message is created. This applies both when the recipients are
23355 generated by a filter and when they are specified in the transport.
23356
23357
23358
23359 .option once autoreply string&!! unset
23360 This option names a file or DBM database in which a record of each &'To:'&
23361 recipient is kept when the message is specified by the transport. &*Note*&:
23362 This does not apply to &'Cc:'& or &'Bcc:'& recipients.
23363
23364 If &%once%& is unset, or is set to an empty string, the message is always sent.
23365 By default, if &%once%& is set to a non-empty filename, the message
23366 is not sent if a potential recipient is already listed in the database.
23367 However, if the &%once_repeat%& option specifies a time greater than zero, the
23368 message is sent if that much time has elapsed since a message was last sent to
23369 this recipient. A setting of zero time for &%once_repeat%& (the default)
23370 prevents a message from being sent a second time &-- in this case, zero means
23371 infinity.
23372
23373 If &%once_file_size%& is zero, a DBM database is used to remember recipients,
23374 and it is allowed to grow as large as necessary. If &%once_file_size%& is set
23375 greater than zero, it changes the way Exim implements the &%once%& option.
23376 Instead of using a DBM file to record every recipient it sends to, it uses a
23377 regular file, whose size will never get larger than the given value.
23378
23379 In the file, Exim keeps a linear list of recipient addresses and the times at
23380 which they were sent messages. If the file is full when a new address needs to
23381 be added, the oldest address is dropped. If &%once_repeat%& is not set, this
23382 means that a given recipient may receive multiple messages, but at
23383 unpredictable intervals that depend on the rate of turnover of addresses in the
23384 file. If &%once_repeat%& is set, it specifies a maximum time between repeats.
23385
23386
23387 .option once_file_size autoreply integer 0
23388 See &%once%& above.
23389
23390
23391 .option once_repeat autoreply time&!! 0s
23392 See &%once%& above.
23393 After expansion, the value of this option must be a valid time value.
23394
23395
23396 .option reply_to autoreply string&!! unset
23397 This specifies the contents of the &'Reply-To:'& header when the message is
23398 specified by the transport.
23399
23400
23401 .option return_message autoreply boolean false
23402 If this is set, a copy of the original message is returned with the new
23403 message, subject to the maximum size set in the &%return_size_limit%& global
23404 configuration option.
23405
23406
23407 .option subject autoreply string&!! unset
23408 This specifies the contents of the &'Subject:'& header when the message is
23409 specified by the transport. It is tempting to quote the original subject in
23410 automatic responses. For example:
23411 .code
23412 subject = Re: $h_subject:
23413 .endd
23414 There is a danger in doing this, however. It may allow a third party to
23415 subscribe your users to an opt-in mailing list, provided that the list accepts
23416 bounce messages as subscription confirmations. Well-managed lists require a
23417 non-bounce message to confirm a subscription, so the danger is relatively
23418 small.
23419
23420
23421
23422 .option text autoreply string&!! unset
23423 This specifies a single string to be used as the body of the message when the
23424 message is specified by the transport. If both &%text%& and &%file%& are set,
23425 the text comes first.
23426
23427
23428 .option to autoreply string&!! unset
23429 This specifies recipients of the message and the contents of the &'To:'& header
23430 when the message is specified by the transport.
23431 .ecindex IIDauttra1
23432 .ecindex IIDauttra2
23433
23434
23435
23436
23437 . ////////////////////////////////////////////////////////////////////////////
23438 . ////////////////////////////////////////////////////////////////////////////
23439
23440 .chapter "The lmtp transport" "CHAPLMTP"
23441 .cindex "transports" "&(lmtp)&"
23442 .cindex "&(lmtp)& transport"
23443 .cindex "LMTP" "over a pipe"
23444 .cindex "LMTP" "over a socket"
23445 The &(lmtp)& transport runs the LMTP protocol (RFC 2033) over a pipe to a
23446 specified command
23447 or by interacting with a Unix domain socket.
23448 This transport is something of a cross between the &(pipe)& and &(smtp)&
23449 transports. Exim also has support for using LMTP over TCP/IP; this is
23450 implemented as an option for the &(smtp)& transport. Because LMTP is expected
23451 to be of minority interest, the default build-time configure in &_src/EDITME_&
23452 has it commented out. You need to ensure that
23453 .code
23454 TRANSPORT_LMTP=yes
23455 .endd
23456 .cindex "options" "&(lmtp)& transport"
23457 is present in your &_Local/Makefile_& in order to have the &(lmtp)& transport
23458 included in the Exim binary. The private options of the &(lmtp)& transport are
23459 as follows:
23460
23461 .option batch_id lmtp string&!! unset
23462 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23463
23464
23465 .option batch_max lmtp integer 1
23466 This limits the number of addresses that can be handled in a single delivery.
23467 Most LMTP servers can handle several addresses at once, so it is normally a
23468 good idea to increase this value. See the description of local delivery
23469 batching in chapter &<<CHAPbatching>>&.
23470
23471
23472 .option command lmtp string&!! unset
23473 This option must be set if &%socket%& is not set. The string is a command which
23474 is run in a separate process. It is split up into a command name and list of
23475 arguments, each of which is separately expanded (so expansion cannot change the
23476 number of arguments). The command is run directly, not via a shell. The message
23477 is passed to the new process using the standard input and output to operate the
23478 LMTP protocol.
23479
23480 .option ignore_quota lmtp boolean false
23481 .cindex "LMTP" "ignoring quota errors"
23482 If this option is set true, the string &`IGNOREQUOTA`& is added to RCPT
23483 commands, provided that the LMTP server has advertised support for IGNOREQUOTA
23484 in its response to the LHLO command.
23485
23486 .option socket lmtp string&!! unset
23487 This option must be set if &%command%& is not set. The result of expansion must
23488 be the name of a Unix domain socket. The transport connects to the socket and
23489 delivers the message to it using the LMTP protocol.
23490
23491
23492 .option timeout lmtp time 5m
23493 The transport is aborted if the created process or Unix domain socket does not
23494 respond to LMTP commands or message input within this timeout. Delivery
23495 is deferred, and will be tried again later. Here is an example of a typical
23496 LMTP transport:
23497 .code
23498 lmtp:
23499   driver = lmtp
23500   command = /some/local/lmtp/delivery/program
23501   batch_max = 20
23502   user = exim
23503 .endd
23504 This delivers up to 20 addresses at a time, in a mixture of domains if
23505 necessary, running as the user &'exim'&.
23506
23507
23508
23509 . ////////////////////////////////////////////////////////////////////////////
23510 . ////////////////////////////////////////////////////////////////////////////
23511
23512 .chapter "The pipe transport" "CHAPpipetransport"
23513 .scindex IIDpiptra1 "transports" "&(pipe)&"
23514 .scindex IIDpiptra2 "&(pipe)& transport"
23515 The &(pipe)& transport is used to deliver messages via a pipe to a command
23516 running in another process. One example is the use of &(pipe)& as a
23517 pseudo-remote transport for passing messages to some other delivery mechanism
23518 (such as UUCP). Another is the use by individual users to automatically process
23519 their incoming messages. The &(pipe)& transport can be used in one of the
23520 following ways:
23521
23522 .ilist
23523 .vindex "&$local_part$&"
23524 A router routes one address to a transport in the normal way, and the
23525 transport is configured as a &(pipe)& transport. In this case, &$local_part$&
23526 contains the local part of the address (as usual), and the command that is run
23527 is specified by the &%command%& option on the transport.
23528 .next
23529 .vindex "&$pipe_addresses$&"
23530 If the &%batch_max%& option is set greater than 1 (the default is 1), the
23531 transport can handle more than one address in a single run. In this case, when
23532 more than one address is routed to the transport, &$local_part$& is not set
23533 (because it is not unique). However, the pseudo-variable &$pipe_addresses$&
23534 (described in section &<<SECThowcommandrun>>& below) contains all the addresses
23535 that are routed to the transport.
23536 .next
23537 .vindex "&$address_pipe$&"
23538 A router redirects an address directly to a pipe command (for example, from an
23539 alias or forward file). In this case, &$address_pipe$& contains the text of the
23540 pipe command, and the &%command%& option on the transport is ignored unless
23541 &%force_command%& is set. If only one address is being transported
23542 (&%batch_max%& is not greater than one, or only one address was redirected to
23543 this pipe command), &$local_part$& contains the local part that was redirected.
23544 .endlist
23545
23546
23547 The &(pipe)& transport is a non-interactive delivery method. Exim can also
23548 deliver messages over pipes using the LMTP interactive protocol. This is
23549 implemented by the &(lmtp)& transport.
23550
23551 In the case when &(pipe)& is run as a consequence of an entry in a local user's
23552 &_.forward_& file, the command runs under the uid and gid of that user. In
23553 other cases, the uid and gid have to be specified explicitly, either on the
23554 transport or on the router that handles the address. Current and &"home"&
23555 directories are also controllable. See chapter &<<CHAPenvironment>>& for
23556 details of the local delivery environment and chapter &<<CHAPbatching>>&
23557 for a discussion of local delivery batching.
23558
23559
23560 .section "Concurrent delivery" "SECID140"
23561 If two messages arrive at almost the same time, and both are routed to a pipe
23562 delivery, the two pipe transports may be run concurrently. You must ensure that
23563 any pipe commands you set up are robust against this happening. If the commands
23564 write to a file, the &%exim_lock%& utility might be of use.
23565 Alternatively the &%max_parallel%& option could be used with a value
23566 of "1" to enforce serialization.
23567
23568
23569
23570
23571 .section "Returned status and data" "SECID141"
23572 .cindex "&(pipe)& transport" "returned data"
23573 If the command exits with a non-zero return code, the delivery is deemed to
23574 have failed, unless either the &%ignore_status%& option is set (in which case
23575 the return code is treated as zero), or the return code is one of those listed
23576 in the &%temp_errors%& option, which are interpreted as meaning &"try again
23577 later"&. In this case, delivery is deferred. Details of a permanent failure are
23578 logged, but are not included in the bounce message, which merely contains
23579 &"local delivery failed"&.
23580
23581 If the command exits on a signal and the &%freeze_signal%& option is set then
23582 the message will be frozen in the queue. If that option is not set, a bounce
23583 will be sent as normal.
23584
23585 If the return code is greater than 128 and the command being run is a shell
23586 script, it normally means that the script was terminated by a signal whose
23587 value is the return code minus 128. The &%freeze_signal%& option does not
23588 apply in this case.
23589
23590 If Exim is unable to run the command (that is, if &[execve()]& fails), the
23591 return code is set to 127. This is the value that a shell returns if it is
23592 asked to run a non-existent command. The wording for the log line suggests that
23593 a non-existent command may be the problem.
23594
23595 The &%return_output%& option can affect the result of a pipe delivery. If it is
23596 set and the command produces any output on its standard output or standard
23597 error streams, the command is considered to have failed, even if it gave a zero
23598 return code or if &%ignore_status%& is set. The output from the command is
23599 included as part of the bounce message. The &%return_fail_output%& option is
23600 similar, except that output is returned only when the command exits with a
23601 failure return code, that is, a value other than zero or a code that matches
23602 &%temp_errors%&.
23603
23604
23605
23606 .section "How the command is run" "SECThowcommandrun"
23607 .cindex "&(pipe)& transport" "path for command"
23608 The command line is (by default) broken down into a command name and arguments
23609 by the &(pipe)& transport itself. The &%allow_commands%& and
23610 &%restrict_to_path%& options can be used to restrict the commands that may be
23611 run.
23612
23613 .cindex "quoting" "in pipe command"
23614 Unquoted arguments are delimited by white space. If an argument appears in
23615 double quotes, backslash is interpreted as an escape character in the usual
23616 way. If an argument appears in single quotes, no escaping is done.
23617
23618 String expansion is applied to the command line except when it comes from a
23619 traditional &_.forward_& file (commands from a filter file are expanded). The
23620 expansion is applied to each argument in turn rather than to the whole line.
23621 For this reason, any string expansion item that contains white space must be
23622 quoted so as to be contained within a single argument. A setting such as
23623 .code
23624 command = /some/path ${if eq{$local_part}{postmaster}{xx}{yy}}
23625 .endd
23626 will not work, because the expansion item gets split between several
23627 arguments. You have to write
23628 .code
23629 command = /some/path "${if eq{$local_part}{postmaster}{xx}{yy}}"
23630 .endd
23631 to ensure that it is all in one argument. The expansion is done in this way,
23632 argument by argument, so that the number of arguments cannot be changed as a
23633 result of expansion, and quotes or backslashes in inserted variables do not
23634 interact with external quoting. However, this leads to problems if you want to
23635 generate multiple arguments (or the command name plus arguments) from a single
23636 expansion. In this situation, the simplest solution is to use a shell. For
23637 example:
23638 .code
23639 command = /bin/sh -c ${lookup{$local_part}lsearch{/some/file}}
23640 .endd
23641
23642 .cindex "transport" "filter"
23643 .cindex "filter" "transport filter"
23644 .vindex "&$pipe_addresses$&"
23645 Special handling takes place when an argument consists of precisely the text
23646 &`$pipe_addresses`& (no quotes).
23647 This is not a general expansion variable; the only
23648 place this string is recognized is when it appears as an argument for a pipe or
23649 transport filter command. It causes each address that is being handled to be
23650 inserted in the argument list at that point &'as a separate argument'&. This
23651 avoids any problems with spaces or shell metacharacters, and is of use when a
23652 &(pipe)& transport is handling groups of addresses in a batch.
23653
23654 If &%force_command%& is enabled on the transport, Special handling takes place
23655 for an argument that consists of precisely the text &`$address_pipe`&.  It
23656 is handled similarly to &$pipe_addresses$& above.  It is expanded and each
23657 argument is inserted in the argument list at that point
23658 &'as a separate argument'&.  The &`$address_pipe`& item does not need to be
23659 the only item in the argument; in fact, if it were then &%force_command%&
23660 should behave as a no-op.  Rather, it should be used to adjust the command
23661 run while preserving the argument vector separation.
23662
23663 After splitting up into arguments and expansion, the resulting command is run
23664 in a subprocess directly from the transport, &'not'& under a shell. The
23665 message that is being delivered is supplied on the standard input, and the
23666 standard output and standard error are both connected to a single pipe that is
23667 read by Exim. The &%max_output%& option controls how much output the command
23668 may produce, and the &%return_output%& and &%return_fail_output%& options
23669 control what is done with it.
23670
23671 Not running the command under a shell (by default) lessens the security risks
23672 in cases when a command from a user's filter file is built out of data that was
23673 taken from an incoming message. If a shell is required, it can of course be
23674 explicitly specified as the command to be run. However, there are circumstances
23675 where existing commands (for example, in &_.forward_& files) expect to be run
23676 under a shell and cannot easily be modified. To allow for these cases, there is
23677 an option called &%use_shell%&, which changes the way the &(pipe)& transport
23678 works. Instead of breaking up the command line as just described, it expands it
23679 as a single string and passes the result to &_/bin/sh_&. The
23680 &%restrict_to_path%& option and the &$pipe_addresses$& facility cannot be used
23681 with &%use_shell%&, and the whole mechanism is inherently less secure.
23682
23683
23684
23685 .section "Environment variables" "SECTpipeenv"
23686 .cindex "&(pipe)& transport" "environment for command"
23687 .cindex "environment" "&(pipe)& transport"
23688 The environment variables listed below are set up when the command is invoked.
23689 This list is a compromise for maximum compatibility with other MTAs. Note that
23690 the &%environment%& option can be used to add additional variables to this
23691 environment. The environment for the &(pipe)& transport is not subject
23692 to the &%add_environment%& and &%keep_environment%& main config options.
23693 .display
23694 &`DOMAIN            `&   the domain of the address
23695 &`HOME              `&   the home directory, if set
23696 &`HOST              `&   the host name when called from a router (see below)
23697 &`LOCAL_PART        `&   see below
23698 &`LOCAL_PART_PREFIX `&   see below
23699 &`LOCAL_PART_SUFFIX `&   see below
23700 &`LOGNAME           `&   see below
23701 &`MESSAGE_ID        `&   Exim's local ID for the message
23702 &`PATH              `&   as specified by the &%path%& option below
23703 &`QUALIFY_DOMAIN    `&   the sender qualification domain
23704 &`RECIPIENT         `&   the complete recipient address
23705 &`SENDER            `&   the sender of the message (empty if a bounce)
23706 &`SHELL             `&   &`/bin/sh`&
23707 &`TZ                `&   the value of the &%timezone%& option, if set
23708 &`USER              `&   see below
23709 .endd
23710 When a &(pipe)& transport is called directly from (for example) an &(accept)&
23711 router, LOCAL_PART is set to the local part of the address. When it is
23712 called as a result of a forward or alias expansion, LOCAL_PART is set to
23713 the local part of the address that was expanded. In both cases, any affixes are
23714 removed from the local part, and made available in LOCAL_PART_PREFIX and
23715 LOCAL_PART_SUFFIX, respectively. LOGNAME and USER are set to the
23716 same value as LOCAL_PART for compatibility with other MTAs.
23717
23718 .cindex "HOST"
23719 HOST is set only when a &(pipe)& transport is called from a router that
23720 associates hosts with an address, typically when using &(pipe)& as a
23721 pseudo-remote transport. HOST is set to the first host name specified by
23722 the router.
23723
23724 .cindex "HOME"
23725 If the transport's generic &%home_directory%& option is set, its value is used
23726 for the HOME environment variable. Otherwise, a home directory may be set
23727 by the router's &%transport_home_directory%& option, which defaults to the
23728 user's home directory if &%check_local_user%& is set.
23729
23730
23731 .section "Private options for pipe" "SECID142"
23732 .cindex "options" "&(pipe)& transport"
23733
23734
23735
23736 .option allow_commands pipe "string list&!!" unset
23737 .cindex "&(pipe)& transport" "permitted commands"
23738 The string is expanded, and is then interpreted as a colon-separated list of
23739 permitted commands. If &%restrict_to_path%& is not set, the only commands
23740 permitted are those in the &%allow_commands%& list. They need not be absolute
23741 paths; the &%path%& option is still used for relative paths. If
23742 &%restrict_to_path%& is set with &%allow_commands%&, the command must either be
23743 in the &%allow_commands%& list, or a name without any slashes that is found on
23744 the path. In other words, if neither &%allow_commands%& nor
23745 &%restrict_to_path%& is set, there is no restriction on the command, but
23746 otherwise only commands that are permitted by one or the other are allowed. For
23747 example, if
23748 .code
23749 allow_commands = /usr/bin/vacation
23750 .endd
23751 and &%restrict_to_path%& is not set, the only permitted command is
23752 &_/usr/bin/vacation_&. The &%allow_commands%& option may not be set if
23753 &%use_shell%& is set.
23754
23755
23756 .option batch_id pipe string&!! unset
23757 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23758
23759
23760 .option batch_max pipe integer 1
23761 This limits the number of addresses that can be handled in a single delivery.
23762 See the description of local delivery batching in chapter &<<CHAPbatching>>&.
23763
23764
23765 .option check_string pipe string unset
23766 As &(pipe)& writes the message, the start of each line is tested for matching
23767 &%check_string%&, and if it does, the initial matching characters are replaced
23768 by the contents of &%escape_string%&, provided both are set. The value of
23769 &%check_string%& is a literal string, not a regular expression, and the case of
23770 any letters it contains is significant. When &%use_bsmtp%& is set, the contents
23771 of &%check_string%& and &%escape_string%& are forced to values that implement
23772 the SMTP escaping protocol. Any settings made in the configuration file are
23773 ignored.
23774
23775
23776 .option command pipe string&!! unset
23777 This option need not be set when &(pipe)& is being used to deliver to pipes
23778 obtained directly from address redirections. In other cases, the option must be
23779 set, to provide a command to be run. It need not yield an absolute path (see
23780 the &%path%& option below). The command is split up into separate arguments by
23781 Exim, and each argument is separately expanded, as described in section
23782 &<<SECThowcommandrun>>& above.
23783
23784
23785 .option environment pipe string&!! unset
23786 .cindex "&(pipe)& transport" "environment for command"
23787 .cindex "environment" "&(pipe)& transport"
23788 This option is used to add additional variables to the environment in which the
23789 command runs (see section &<<SECTpipeenv>>& for the default list). Its value is
23790 a string which is expanded, and then interpreted as a colon-separated list of
23791 environment settings of the form <&'name'&>=<&'value'&>.
23792
23793
23794 .option escape_string pipe string unset
23795 See &%check_string%& above.
23796
23797
23798 .option freeze_exec_fail pipe boolean false
23799 .cindex "exec failure"
23800 .cindex "failure of exec"
23801 .cindex "&(pipe)& transport" "failure of exec"
23802 Failure to exec the command in a pipe transport is by default treated like
23803 any other failure while running the command. However, if &%freeze_exec_fail%&
23804 is set, failure to exec is treated specially, and causes the message to be
23805 frozen, whatever the setting of &%ignore_status%&.
23806
23807
23808 .option freeze_signal pipe boolean false
23809 .cindex "signal exit"
23810 .cindex "&(pipe)& transport", "signal exit"
23811 Normally if the process run by a command in a pipe transport exits on a signal,
23812 a bounce message is sent. If &%freeze_signal%& is set, the message will be
23813 frozen in Exim's queue instead.
23814
23815
23816 .option force_command pipe boolean false
23817 .cindex "force command"
23818 .cindex "&(pipe)& transport", "force command"
23819 Normally when a router redirects an address directly to a pipe command
23820 the &%command%& option on the transport is ignored.  If &%force_command%&
23821 is set, the &%command%& option will used. This is especially
23822 useful for forcing a wrapper or additional argument to be added to the
23823 command. For example:
23824 .code
23825 command = /usr/bin/remote_exec myhost -- $address_pipe
23826 force_command
23827 .endd
23828
23829 Note that &$address_pipe$& is handled specially in &%command%& when
23830 &%force_command%& is set, expanding out to the original argument vector as
23831 separate items, similarly to a Unix shell &`"$@"`& construct.
23832
23833
23834 .option ignore_status pipe boolean false
23835 If this option is true, the status returned by the subprocess that is set up to
23836 run the command is ignored, and Exim behaves as if zero had been returned.
23837 Otherwise, a non-zero status or termination by signal causes an error return
23838 from the transport unless the status value is one of those listed in
23839 &%temp_errors%&; these cause the delivery to be deferred and tried again later.
23840
23841 &*Note*&: This option does not apply to timeouts, which do not return a status.
23842 See the &%timeout_defer%& option for how timeouts are handled.
23843
23844
23845 .option log_defer_output pipe boolean false
23846 .cindex "&(pipe)& transport" "logging output"
23847 If this option is set, and the status returned by the command is
23848 one of the codes listed in &%temp_errors%& (that is, delivery was deferred),
23849 and any output was produced on stdout or stderr, the first line of it is
23850 written to the main log.
23851
23852
23853 .option log_fail_output pipe boolean false
23854 If this option is set, and the command returns any output on stdout or
23855 stderr, and also ends with a return code that is neither zero nor one of
23856 the return codes listed in &%temp_errors%& (that is, the delivery
23857 failed), the first line of output is written to the main log. This
23858 option and &%log_output%& are mutually exclusive.  Only one of them may
23859 be set.
23860
23861
23862 .option log_output pipe boolean false
23863 If this option is set and the command returns any output on stdout or
23864 stderr, the first line of output is written to the main log, whatever
23865 the return code. This option and &%log_fail_output%& are mutually
23866 exclusive. Only one of them may be set.
23867
23868
23869 .option max_output pipe integer 20K
23870 This specifies the maximum amount of output that the command may produce on its
23871 standard output and standard error file combined. If the limit is exceeded, the
23872 process running the command is killed. This is intended as a safety measure to
23873 catch runaway processes. The limit is applied independently of the settings of
23874 the options that control what is done with such output (for example,
23875 &%return_output%&). Because of buffering effects, the amount of output may
23876 exceed the limit by a small amount before Exim notices.
23877
23878
23879 .option message_prefix pipe string&!! "see below"
23880 The string specified here is expanded and output at the start of every message.
23881 The default is unset if &%use_bsmtp%& is set. Otherwise it is
23882 .code
23883 message_prefix = \
23884   From ${if def:return_path{$return_path}{MAILER-DAEMON}}\
23885   ${tod_bsdinbox}\n
23886 .endd
23887 .cindex "Cyrus"
23888 .cindex "&%tmail%&"
23889 .cindex "&""From""& line"
23890 This is required by the commonly used &_/usr/bin/vacation_& program.
23891 However, it must &'not'& be present if delivery is to the Cyrus IMAP server,
23892 or to the &%tmail%& local delivery agent. The prefix can be suppressed by
23893 setting
23894 .code
23895 message_prefix =
23896 .endd
23897 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23898 &`\n`& to &`\r\n`& in &%message_prefix%&.
23899
23900
23901 .option message_suffix pipe string&!! "see below"
23902 The string specified here is expanded and output at the end of every message.
23903 The default is unset if &%use_bsmtp%& is set. Otherwise it is a single newline.
23904 The suffix can be suppressed by setting
23905 .code
23906 message_suffix =
23907 .endd
23908 &*Note:*& If you set &%use_crlf%& true, you must change any occurrences of
23909 &`\n`& to &`\r\n`& in &%message_suffix%&.
23910
23911
23912 .option path pipe string&!! "/bin:/usr/bin"
23913 This option is expanded and
23914 specifies the string that is set up in the PATH environment
23915 variable of the subprocess.
23916 If the &%command%& option does not yield an absolute path name, the command is
23917 sought in the PATH directories, in the usual way. &*Warning*&: This does not
23918 apply to a command specified as a transport filter.
23919
23920
23921 .option permit_coredump pipe boolean false
23922 Normally Exim inhibits core-dumps during delivery.  If you have a need to get
23923 a core-dump of a pipe command, enable this command.  This enables core-dumps
23924 during delivery and affects both the Exim binary and the pipe command run.
23925 It is recommended that this option remain off unless and until you have a need
23926 for it and that this only be enabled when needed, as the risk of excessive
23927 resource consumption can be quite high.  Note also that Exim is typically
23928 installed as a setuid binary and most operating systems will inhibit coredumps
23929 of these by default, so further OS-specific action may be required.
23930
23931
23932 .option pipe_as_creator pipe boolean false
23933 .cindex "uid (user id)" "local delivery"
23934 If the generic &%user%& option is not set and this option is true, the delivery
23935 process is run under the uid that was in force when Exim was originally called
23936 to accept the message. If the group id is not otherwise set (via the generic
23937 &%group%& option), the gid that was in force when Exim was originally called to
23938 accept the message is used.
23939
23940
23941 .option restrict_to_path pipe boolean false
23942 When this option is set, any command name not listed in &%allow_commands%& must
23943 contain no slashes. The command is searched for only in the directories listed
23944 in the &%path%& option. This option is intended for use in the case when a pipe
23945 command has been generated from a user's &_.forward_& file. This is usually
23946 handled by a &(pipe)& transport called &%address_pipe%&.
23947
23948
23949 .option return_fail_output pipe boolean false
23950 If this option is true, and the command produced any output and ended with a
23951 return code other than zero or one of the codes listed in &%temp_errors%& (that
23952 is, the delivery failed), the output is returned in the bounce message.
23953 However, if the message has a null sender (that is, it is itself a bounce
23954 message), output from the command is discarded. This option and
23955 &%return_output%& are mutually exclusive. Only one of them may be set.
23956
23957
23958
23959 .option return_output pipe boolean false
23960 If this option is true, and the command produced any output, the delivery is
23961 deemed to have failed whatever the return code from the command, and the output
23962 is returned in the bounce message. Otherwise, the output is just discarded.
23963 However, if the message has a null sender (that is, it is a bounce message),
23964 output from the command is always discarded, whatever the setting of this
23965 option. This option and &%return_fail_output%& are mutually exclusive. Only one
23966 of them may be set.
23967
23968
23969
23970 .option temp_errors pipe "string list" "see below"
23971 .cindex "&(pipe)& transport" "temporary failure"
23972 This option contains either a colon-separated list of numbers, or a single
23973 asterisk. If &%ignore_status%& is false
23974 and &%return_output%& is not set,
23975 and the command exits with a non-zero return code, the failure is treated as
23976 temporary and the delivery is deferred if the return code matches one of the
23977 numbers, or if the setting is a single asterisk. Otherwise, non-zero return
23978 codes are treated as permanent errors. The default setting contains the codes
23979 defined by EX_TEMPFAIL and EX_CANTCREAT in &_sysexits.h_&. If Exim is
23980 compiled on a system that does not define these macros, it assumes values of 75
23981 and 73, respectively.
23982
23983
23984 .option timeout pipe time 1h
23985 If the command fails to complete within this time, it is killed. This normally
23986 causes the delivery to fail (but see &%timeout_defer%&). A zero time interval
23987 specifies no timeout. In order to ensure that any subprocesses created by the
23988 command are also killed, Exim makes the initial process a process group leader,
23989 and kills the whole process group on a timeout. However, this can be defeated
23990 if one of the processes starts a new process group.
23991
23992 .option timeout_defer pipe boolean false
23993 A timeout in a &(pipe)& transport, either in the command that the transport
23994 runs, or in a transport filter that is associated with it, is by default
23995 treated as a hard error, and the delivery fails. However, if &%timeout_defer%&
23996 is set true, both kinds of timeout become temporary errors, causing the
23997 delivery to be deferred.
23998
23999 .option umask pipe "octal integer" 022
24000 This specifies the umask setting for the subprocess that runs the command.
24001
24002
24003 .option use_bsmtp pipe boolean false
24004 .cindex "envelope sender"
24005 If this option is set true, the &(pipe)& transport writes messages in &"batch
24006 SMTP"& format, with the envelope sender and recipient(s) included as SMTP
24007 commands. If you want to include a leading HELO command with such messages,
24008 you can do so by setting the &%message_prefix%& option. See section
24009 &<<SECTbatchSMTP>>& for details of batch SMTP.
24010
24011 .option use_classresources pipe boolean false
24012 .cindex "class resources (BSD)"
24013 This option is available only when Exim is running on FreeBSD, NetBSD, or
24014 BSD/OS. If it is set true, the &[setclassresources()]& function is used to set
24015 resource limits when a &(pipe)& transport is run to perform a delivery. The
24016 limits for the uid under which the pipe is to run are obtained from the login
24017 class database.
24018
24019
24020 .option use_crlf pipe boolean false
24021 .cindex "carriage return"
24022 .cindex "linefeed"
24023 This option causes lines to be terminated with the two-character CRLF sequence
24024 (carriage return, linefeed) instead of just a linefeed character. In the case
24025 of batched SMTP, the byte sequence written to the pipe is then an exact image
24026 of what would be sent down a real SMTP connection.
24027
24028 The contents of the &%message_prefix%& and &%message_suffix%& options are
24029 written verbatim, so must contain their own carriage return characters if these
24030 are needed. When &%use_bsmtp%& is not set, the default values for both
24031 &%message_prefix%& and &%message_suffix%& end with a single linefeed, so their
24032 values must be changed to end with &`\r\n`& if &%use_crlf%& is set.
24033
24034
24035 .option use_shell pipe boolean false
24036 .vindex "&$pipe_addresses$&"
24037 If this option is set, it causes the command to be passed to &_/bin/sh_&
24038 instead of being run directly from the transport, as described in section
24039 &<<SECThowcommandrun>>&. This is less secure, but is needed in some situations
24040 where the command is expected to be run under a shell and cannot easily be
24041 modified. The &%allow_commands%& and &%restrict_to_path%& options, and the
24042 &`$pipe_addresses`& facility are incompatible with &%use_shell%&. The
24043 command is expanded as a single string, and handed to &_/bin/sh_& as data for
24044 its &%-c%& option.
24045
24046
24047
24048 .section "Using an external local delivery agent" "SECID143"
24049 .cindex "local delivery" "using an external agent"
24050 .cindex "&'procmail'&"
24051 .cindex "external local delivery"
24052 .cindex "delivery" "&'procmail'&"
24053 .cindex "delivery" "by external agent"
24054 The &(pipe)& transport can be used to pass all messages that require local
24055 delivery to a separate local delivery agent such as &%procmail%&. When doing
24056 this, care must be taken to ensure that the pipe is run under an appropriate
24057 uid and gid. In some configurations one wants this to be a uid that is trusted
24058 by the delivery agent to supply the correct sender of the message. It may be
24059 necessary to recompile or reconfigure the delivery agent so that it trusts an
24060 appropriate user. The following is an example transport and router
24061 configuration for &%procmail%&:
24062 .code
24063 # transport
24064 procmail_pipe:
24065   driver = pipe
24066   command = /usr/local/bin/procmail -d $local_part
24067   return_path_add
24068   delivery_date_add
24069   envelope_to_add
24070   check_string = "From "
24071   escape_string = ">From "
24072   umask = 077
24073   user = $local_part
24074   group = mail
24075
24076 # router
24077 procmail:
24078   driver = accept
24079   check_local_user
24080   transport = procmail_pipe
24081 .endd
24082 In this example, the pipe is run as the local user, but with the group set to
24083 &'mail'&. An alternative is to run the pipe as a specific user such as &'mail'&
24084 or &'exim'&, but in this case you must arrange for &%procmail%& to trust that
24085 user to supply a correct sender address. If you do not specify either a
24086 &%group%& or a &%user%& option, the pipe command is run as the local user. The
24087 home directory is the user's home directory by default.
24088
24089 &*Note*&: The command that the pipe transport runs does &'not'& begin with
24090 .code
24091 IFS=" "
24092 .endd
24093 as shown in some &%procmail%& documentation, because Exim does not by default
24094 use a shell to run pipe commands.
24095
24096 .cindex "Cyrus"
24097 The next example shows a transport and a router for a system where local
24098 deliveries are handled by the Cyrus IMAP server.
24099 .code
24100 # transport
24101 local_delivery_cyrus:
24102   driver = pipe
24103   command = /usr/cyrus/bin/deliver \
24104             -m ${substr_1:$local_part_suffix} -- $local_part
24105   user = cyrus
24106   group = mail
24107   return_output
24108   log_output
24109   message_prefix =
24110   message_suffix =
24111
24112 # router
24113 local_user_cyrus:
24114   driver = accept
24115   check_local_user
24116   local_part_suffix = .*
24117   transport = local_delivery_cyrus
24118 .endd
24119 Note the unsetting of &%message_prefix%& and &%message_suffix%&, and the use of
24120 &%return_output%& to cause any text written by Cyrus to be returned to the
24121 sender.
24122 .ecindex IIDpiptra1
24123 .ecindex IIDpiptra2
24124
24125
24126 . ////////////////////////////////////////////////////////////////////////////
24127 . ////////////////////////////////////////////////////////////////////////////
24128
24129 .chapter "The smtp transport" "CHAPsmtptrans"
24130 .scindex IIDsmttra1 "transports" "&(smtp)&"
24131 .scindex IIDsmttra2 "&(smtp)& transport"
24132 The &(smtp)& transport delivers messages over TCP/IP connections using the SMTP
24133 or LMTP protocol. The list of hosts to try can either be taken from the address
24134 that is being processed (having been set up by the router), or specified
24135 explicitly for the transport. Timeout and retry processing (see chapter
24136 &<<CHAPretry>>&) is applied to each IP address independently.
24137
24138
24139 .section "Multiple messages on a single connection" "SECID144"
24140 The sending of multiple messages over a single TCP/IP connection can arise in
24141 two ways:
24142
24143 .ilist
24144 If a message contains more than &%max_rcpt%& (see below) addresses that are
24145 routed to the same host, more than one copy of the message has to be sent to
24146 that host. In this situation, multiple copies may be sent in a single run of
24147 the &(smtp)& transport over a single TCP/IP connection. (What Exim actually
24148 does when it has too many addresses to send in one message also depends on the
24149 value of the global &%remote_max_parallel%& option. Details are given in
24150 section &<<SECToutSMTPTCP>>&.)
24151 .next
24152 .cindex "hints database" "remembering routing"
24153 When a message has been successfully delivered over a TCP/IP connection, Exim
24154 looks in its hints database to see if there are any other messages awaiting a
24155 connection to the same host. If there are, a new delivery process is started
24156 for one of them, and the current TCP/IP connection is passed on to it. The new
24157 process may in turn send multiple copies and possibly create yet another
24158 process.
24159 .endlist
24160
24161
24162 For each copy sent over the same TCP/IP connection, a sequence counter is
24163 incremented, and if it ever gets to the value of &%connection_max_messages%&,
24164 no further messages are sent over that connection.
24165
24166
24167
24168 .section "Use of the $host and $host_address variables" "SECID145"
24169 .vindex "&$host$&"
24170 .vindex "&$host_address$&"
24171 At the start of a run of the &(smtp)& transport, the values of &$host$& and
24172 &$host_address$& are the name and IP address of the first host on the host list
24173 passed by the router. However, when the transport is about to connect to a
24174 specific host, and while it is connected to that host, &$host$& and
24175 &$host_address$& are set to the values for that host. These are the values
24176 that are in force when the &%helo_data%&, &%hosts_try_auth%&, &%interface%&,
24177 &%serialize_hosts%&, and the various TLS options are expanded.
24178
24179
24180 .section "Use of $tls_cipher and $tls_peerdn" "usecippeer"
24181 .vindex &$tls_bits$&
24182 .vindex &$tls_cipher$&
24183 .vindex &$tls_peerdn$&
24184 .vindex &$tls_sni$&
24185 At the start of a run of the &(smtp)& transport, the values of &$tls_bits$&,
24186 &$tls_cipher$&, &$tls_peerdn$& and &$tls_sni$&
24187 are the values that were set when the message was received.
24188 These are the values that are used for options that are expanded before any
24189 SMTP connections are made. Just before each connection is made, these four
24190 variables are emptied. If TLS is subsequently started, they are set to the
24191 appropriate values for the outgoing connection, and these are the values that
24192 are in force when any authenticators are run and when the
24193 &%authenticated_sender%& option is expanded.
24194
24195 These variables are deprecated in favour of &$tls_in_cipher$& et. al.
24196 and will be removed in a future release.
24197
24198
24199 .section "Private options for smtp" "SECID146"
24200 .cindex "options" "&(smtp)& transport"
24201 The private options of the &(smtp)& transport are as follows:
24202
24203
24204 .option address_retry_include_sender smtp boolean true
24205 .cindex "4&'xx'& responses" "retrying after"
24206 When an address is delayed because of a 4&'xx'& response to a RCPT command, it
24207 is the combination of sender and recipient that is delayed in subsequent queue
24208 runs until the retry time is reached. You can delay the recipient without
24209 reference to the sender (which is what earlier versions of Exim did), by
24210 setting &%address_retry_include_sender%& false. However, this can lead to
24211 problems with servers that regularly issue 4&'xx'& responses to RCPT commands.
24212
24213 .option allow_localhost smtp boolean false
24214 .cindex "local host" "sending to"
24215 .cindex "fallback" "hosts specified on transport"
24216 When a host specified in &%hosts%& or &%fallback_hosts%& (see below) turns out
24217 to be the local host, or is listed in &%hosts_treat_as_local%&, delivery is
24218 deferred by default. However, if &%allow_localhost%& is set, Exim goes on to do
24219 the delivery anyway. This should be used only in special cases when the
24220 configuration ensures that no looping will result (for example, a differently
24221 configured Exim is listening on the port to which the message is sent).
24222
24223
24224 .option authenticated_sender smtp string&!! unset
24225 .cindex "Cyrus"
24226 When Exim has authenticated as a client, or if &%authenticated_sender_force%&
24227 is true, this option sets a value for the AUTH= item on outgoing MAIL commands,
24228 overriding any existing authenticated sender value. If the string expansion is
24229 forced to fail, the option is ignored. Other expansion failures cause delivery
24230 to be deferred. If the result of expansion is an empty string, that is also
24231 ignored.
24232
24233 The expansion happens after the outgoing connection has been made and TLS
24234 started, if required. This means that the &$host$&, &$host_address$&,
24235 &$tls_out_cipher$&, and &$tls_out_peerdn$& variables are set according to the
24236 particular connection.
24237
24238 If the SMTP session is not authenticated, the expansion of
24239 &%authenticated_sender%& still happens (and can cause the delivery to be
24240 deferred if it fails), but no AUTH= item is added to MAIL commands
24241 unless &%authenticated_sender_force%& is true.
24242
24243 This option allows you to use the &(smtp)& transport in LMTP mode to
24244 deliver mail to Cyrus IMAP and provide the proper local part as the
24245 &"authenticated sender"&, via a setting such as:
24246 .code
24247 authenticated_sender = $local_part
24248 .endd
24249 This removes the need for IMAP subfolders to be assigned special ACLs to
24250 allow direct delivery to those subfolders.
24251
24252 Because of expected uses such as that just described for Cyrus (when no
24253 domain is involved), there is no checking on the syntax of the provided
24254 value.
24255
24256
24257 .option authenticated_sender_force smtp boolean false
24258 If this option is set true, the &%authenticated_sender%& option's value
24259 is used for the AUTH= item on outgoing MAIL commands, even if Exim has not
24260 authenticated as a client.
24261
24262
24263 .option command_timeout smtp time 5m
24264 This sets a timeout for receiving a response to an SMTP command that has been
24265 sent out. It is also used when waiting for the initial banner line from the
24266 remote host. Its value must not be zero.
24267
24268
24269 .option connect_timeout smtp time 5m
24270 This sets a timeout for the &[connect()]& function, which sets up a TCP/IP call
24271 to a remote host. A setting of zero allows the system timeout (typically
24272 several minutes) to act. To have any effect, the value of this option must be
24273 less than the system timeout. However, it has been observed that on some
24274 systems there is no system timeout, which is why the default value for this
24275 option is 5 minutes, a value recommended by RFC 1123.
24276
24277
24278 .option connection_max_messages smtp integer 500
24279 .cindex "SMTP" "passed connection"
24280 .cindex "SMTP" "multiple deliveries"
24281 .cindex "multiple SMTP deliveries"
24282 This controls the maximum number of separate message deliveries that are sent
24283 over a single TCP/IP connection. If the value is zero, there is no limit.
24284 For testing purposes, this value can be overridden by the &%-oB%& command line
24285 option.
24286
24287
24288 .option dane_require_tls_ciphers smtp string&!! unset
24289 .cindex "TLS" "requiring specific ciphers for DANE"
24290 .cindex "cipher" "requiring specific"
24291 .cindex DANE "TLS ciphers"
24292 This option may be used to override &%tls_require_ciphers%& for connections
24293 where DANE has been determined to be in effect.
24294 If not set, then &%tls_require_ciphers%& will be used.
24295 Normal SMTP delivery is not able to make strong demands of TLS cipher
24296 configuration, because delivery will fall back to plaintext.  Once DANE has
24297 been determined to be in effect, there is no plaintext fallback and making the
24298 TLS cipherlist configuration stronger will increase security, rather than
24299 counter-intuitively decreasing it.
24300 If the option expands to be empty or is forced to fail, then it will
24301 be treated as unset and &%tls_require_ciphers%& will be used instead.
24302
24303
24304 .option data_timeout smtp time 5m
24305 This sets a timeout for the transmission of each block in the data portion of
24306 the message. As a result, the overall timeout for a message depends on the size
24307 of the message. Its value must not be zero. See also &%final_timeout%&.
24308
24309
24310 .option dkim_canon smtp string&!! unset
24311 .option dkim_domain smtp string list&!! unset
24312 .option dkim_hash smtp string&!! sha256
24313 .option dkim_identity smtp string&!! unset
24314 .option dkim_private_key smtp string&!! unset
24315 .option dkim_selector smtp string&!! unset
24316 .option dkim_strict smtp string&!! unset
24317 .option dkim_sign_headers smtp string&!! "per RFC"
24318 .option dkim_timestamps smtp string&!! unset
24319 DKIM signing options.  For details see section &<<SECDKIMSIGN>>&.
24320
24321
24322 .option delay_after_cutoff smtp boolean true
24323 .cindex "final cutoff" "retries, controlling"
24324 .cindex retry "final cutoff"
24325 This option controls what happens when all remote IP addresses for a given
24326 domain have been inaccessible for so long that they have passed their retry
24327 cutoff times.
24328
24329 In the default state, if the next retry time has not been reached for any of
24330 them, the address is bounced without trying any deliveries. In other words,
24331 Exim delays retrying an IP address after the final cutoff time until a new
24332 retry time is reached, and can therefore bounce an address without ever trying
24333 a delivery, when machines have been down for a long time. Some people are
24334 unhappy at this prospect, so...
24335
24336 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
24337 addresses are past their final cutoff time, Exim tries to deliver to those
24338 IP addresses that have not been tried since the message arrived. If there are
24339 none, of if they all fail, the address is bounced. In other words, it does not
24340 delay when a new message arrives, but immediately tries those expired IP
24341 addresses that haven't been tried since the message arrived. If there is a
24342 continuous stream of messages for the dead hosts, unsetting
24343 &%delay_after_cutoff%& means that there will be many more attempts to deliver
24344 to them.
24345
24346
24347 .option dns_qualify_single smtp boolean true
24348 If the &%hosts%& or &%fallback_hosts%& option is being used,
24349 and the &%gethostbyname%& option is false,
24350 the RES_DEFNAMES resolver option is set. See the &%qualify_single%& option
24351 in chapter &<<CHAPdnslookup>>& for more details.
24352
24353
24354 .option dns_search_parents smtp boolean false
24355 If the &%hosts%& or &%fallback_hosts%& option is being used, and the
24356 &%gethostbyname%& option is false, the RES_DNSRCH resolver option is set.
24357 See the &%search_parents%& option in chapter &<<CHAPdnslookup>>& for more
24358 details.
24359
24360
24361 .option dnssec_request_domains smtp "domain list&!!" unset
24362 .cindex "MX record" "security"
24363 .cindex "DNSSEC" "MX lookup"
24364 .cindex "security" "MX lookup"
24365 .cindex "DNS" "DNSSEC"
24366 DNS lookups for domains matching &%dnssec_request_domains%& will be done with
24367 the dnssec request bit set.
24368 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24369
24370
24371
24372 .option dnssec_require_domains smtp "domain list&!!" unset
24373 .cindex "MX record" "security"
24374 .cindex "DNSSEC" "MX lookup"
24375 .cindex "security" "MX lookup"
24376 .cindex "DNS" "DNSSEC"
24377 DNS lookups for domains matching &%dnssec_require_domains%& will be done with
24378 the dnssec request bit set.  Any returns not having the Authenticated Data bit
24379 (AD bit) set will be ignored and logged as a host-lookup failure.
24380 This applies to all of the SRV, MX, AAAA, A lookup sequence.
24381
24382
24383
24384 .option dscp smtp string&!! unset
24385 .cindex "DCSP" "outbound"
24386 This option causes the DSCP value associated with a socket to be set to one
24387 of a number of fixed strings or to numeric value.
24388 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
24389 Common values include &`throughput`&, &`mincost`&, and on newer systems
24390 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
24391
24392 The outbound packets from Exim will be marked with this value in the header
24393 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
24394 that these values will have any effect, not be stripped by networking
24395 equipment, or do much of anything without cooperation with your Network
24396 Engineer and those of all network operators between the source and destination.
24397
24398
24399 .option fallback_hosts smtp "string list" unset
24400 .cindex "fallback" "hosts specified on transport"
24401 String expansion is not applied to this option. The argument must be a
24402 colon-separated list of host names or IP addresses, optionally also including
24403 port numbers, though the separator can be changed, as described in section
24404 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24405 item in a &%route_list%& setting for the &(manualroute)& router, as described
24406 in section &<<SECTformatonehostitem>>&.
24407
24408 Fallback hosts can also be specified on routers, which associate them with the
24409 addresses they process. As for the &%hosts%& option without &%hosts_override%&,
24410 &%fallback_hosts%& specified on the transport is used only if the address does
24411 not have its own associated fallback host list. Unlike &%hosts%&, a setting of
24412 &%fallback_hosts%& on an address is not overridden by &%hosts_override%&.
24413 However, &%hosts_randomize%& does apply to fallback host lists.
24414
24415 If Exim is unable to deliver to any of the hosts for a particular address, and
24416 the errors are not permanent rejections, the address is put on a separate
24417 transport queue with its host list replaced by the fallback hosts, unless the
24418 address was routed via MX records and the current host was in the original MX
24419 list. In that situation, the fallback host list is not used.
24420
24421 Once normal deliveries are complete, the fallback queue is delivered by
24422 re-running the same transports with the new host lists. If several failing
24423 addresses have the same fallback hosts (and &%max_rcpt%& permits it), a single
24424 copy of the message is sent.
24425
24426 The resolution of the host names on the fallback list is controlled by the
24427 &%gethostbyname%& option, as for the &%hosts%& option. Fallback hosts apply
24428 both to cases when the host list comes with the address and when it is taken
24429 from &%hosts%&. This option provides a &"use a smart host only if delivery
24430 fails"& facility.
24431
24432
24433 .option final_timeout smtp time 10m
24434 This is the timeout that applies while waiting for the response to the final
24435 line containing just &"."& that terminates a message. Its value must not be
24436 zero.
24437
24438 .option gethostbyname smtp boolean false
24439 If this option is true when the &%hosts%& and/or &%fallback_hosts%& options are
24440 being used, names are looked up using &[gethostbyname()]&
24441 (or &[getipnodebyname()]& when available)
24442 instead of using the DNS. Of course, that function may in fact use the DNS, but
24443 it may also consult other sources of information such as &_/etc/hosts_&.
24444
24445 .option gnutls_compat_mode smtp boolean unset
24446 This option controls whether GnuTLS is used in compatibility mode in an Exim
24447 server. This reduces security slightly, but improves interworking with older
24448 implementations of TLS.
24449
24450 .option helo_data smtp string&!! "see below"
24451 .cindex "HELO" "argument, setting"
24452 .cindex "EHLO" "argument, setting"
24453 .cindex "LHLO argument setting"
24454 The value of this option is expanded after a connection to a another host has
24455 been set up. The result is used as the argument for the EHLO, HELO, or LHLO
24456 command that starts the outgoing SMTP or LMTP session. The default value of the
24457 option is:
24458 .code
24459 $primary_hostname
24460 .endd
24461 During the expansion, the variables &$host$& and &$host_address$& are set to
24462 the identity of the remote host, and the variables &$sending_ip_address$& and
24463 &$sending_port$& are set to the local IP address and port number that are being
24464 used. These variables can be used to generate different values for different
24465 servers or different local IP addresses. For example, if you want the string
24466 that is used for &%helo_data%& to be obtained by a DNS lookup of the outgoing
24467 interface address, you could use this:
24468 .code
24469 helo_data = ${lookup dnsdb{ptr=$sending_ip_address}{$value}\
24470   {$primary_hostname}}
24471 .endd
24472 The use of &%helo_data%& applies both to sending messages and when doing
24473 callouts.
24474
24475 .option hosts smtp "string list&!!" unset
24476 Hosts are associated with an address by a router such as &(dnslookup)&, which
24477 finds the hosts by looking up the address domain in the DNS, or by
24478 &(manualroute)&, which has lists of hosts in its configuration. However,
24479 email addresses can be passed to the &(smtp)& transport by any router, and not
24480 all of them can provide an associated list of hosts.
24481
24482 The &%hosts%& option specifies a list of hosts to be used if the address being
24483 processed does not have any hosts associated with it. The hosts specified by
24484 &%hosts%& are also used, whether or not the address has its own hosts, if
24485 &%hosts_override%& is set.
24486
24487 The string is first expanded, before being interpreted as a colon-separated
24488 list of host names or IP addresses, possibly including port numbers. The
24489 separator may be changed to something other than colon, as described in section
24490 &<<SECTlistconstruct>>&. Each individual item in the list is the same as an
24491 item in a &%route_list%& setting for the &(manualroute)& router, as described
24492 in section &<<SECTformatonehostitem>>&. However, note that the &`/MX`& facility
24493 of the &(manualroute)& router is not available here.
24494
24495 If the expansion fails, delivery is deferred. Unless the failure was caused by
24496 the inability to complete a lookup, the error is logged to the panic log as
24497 well as the main log. Host names are looked up either by searching directly for
24498 address records in the DNS or by calling &[gethostbyname()]& (or
24499 &[getipnodebyname()]& when available), depending on the setting of the
24500 &%gethostbyname%& option. When Exim is compiled with IPv6 support, if a host
24501 that is looked up in the DNS has both IPv4 and IPv6 addresses, both types of
24502 address are used.
24503
24504 During delivery, the hosts are tried in order, subject to their retry status,
24505 unless &%hosts_randomize%& is set.
24506
24507
24508 .option hosts_avoid_esmtp smtp "host list&!!" unset
24509 .cindex "ESMTP, avoiding use of"
24510 .cindex "HELO" "forcing use of"
24511 .cindex "EHLO" "avoiding use of"
24512 .cindex "PIPELINING" "avoiding the use of"
24513 This option is for use with broken hosts that announce ESMTP facilities (for
24514 example, PIPELINING) and then fail to implement them properly. When a host
24515 matches &%hosts_avoid_esmtp%&, Exim sends HELO rather than EHLO at the
24516 start of the SMTP session. This means that it cannot use any of the ESMTP
24517 facilities such as AUTH, PIPELINING, SIZE, and STARTTLS.
24518
24519
24520 .option hosts_avoid_pipelining smtp "host list&!!" unset
24521 .cindex "PIPELINING" "avoiding the use of"
24522 Exim will not use the SMTP PIPELINING extension when delivering to any host
24523 that matches this list, even if the server host advertises PIPELINING support.
24524
24525
24526 .option hosts_avoid_tls smtp "host list&!!" unset
24527 .cindex "TLS" "avoiding for certain hosts"
24528 Exim will not try to start a TLS session when delivering to any host that
24529 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24530
24531 .option hosts_verify_avoid_tls smtp "host list&!!" unset
24532 .cindex "TLS" "avoiding for certain hosts"
24533 Exim will not try to start a TLS session for a verify callout,
24534 or when delivering in cutthrough mode,
24535 to any host that matches this list.
24536
24537
24538 .option hosts_max_try smtp integer 5
24539 .cindex "host" "maximum number to try"
24540 .cindex "limit" "number of hosts tried"
24541 .cindex "limit" "number of MX tried"
24542 .cindex "MX record" "maximum tried"
24543 This option limits the number of IP addresses that are tried for any one
24544 delivery in cases where there are temporary delivery errors. Section
24545 &<<SECTvalhosmax>>& describes in detail how the value of this option is used.
24546
24547
24548 .option hosts_max_try_hardlimit smtp integer 50
24549 This is an additional check on the maximum number of IP addresses that Exim
24550 tries for any one delivery. Section &<<SECTvalhosmax>>& describes its use and
24551 why it exists.
24552
24553
24554
24555 .option hosts_nopass_tls smtp "host list&!!" unset
24556 .cindex "TLS" "passing connection"
24557 .cindex "multiple SMTP deliveries"
24558 .cindex "TLS" "multiple message deliveries"
24559 For any host that matches this list, a connection on which a TLS session has
24560 been started will not be passed to a new delivery process for sending another
24561 message on the same connection. See section &<<SECTmulmessam>>& for an
24562 explanation of when this might be needed.
24563
24564 .option hosts_noproxy_tls smtp "host list&!!" *
24565 .cindex "TLS" "passing connection"
24566 .cindex "multiple SMTP deliveries"
24567 .cindex "TLS" "multiple message deliveries"
24568 For any host that matches this list, a TLS session which has
24569 been started will not be passed to a new delivery process for sending another
24570 message on the same session.
24571
24572 The traditional implementation closes down TLS and re-starts it in the new
24573 process, on the same open TCP connection, for each successive message
24574 sent.  If permitted by this option a pipe to to the new process is set up
24575 instead, and the original process maintains the TLS connection and proxies
24576 the SMTP connection from and to the new process and any subsequents.
24577 The new process has no access to TLS information, so cannot include it in
24578 logging.
24579
24580
24581
24582 .option hosts_override smtp boolean false
24583 If this option is set and the &%hosts%& option is also set, any hosts that are
24584 attached to the address are ignored, and instead the hosts specified by the
24585 &%hosts%& option are always used. This option does not apply to
24586 &%fallback_hosts%&.
24587
24588
24589 .option hosts_randomize smtp boolean false
24590 .cindex "randomized host list"
24591 .cindex "host" "list of; randomized"
24592 .cindex "fallback" "randomized hosts"
24593 If this option is set, and either the list of hosts is taken from the
24594 &%hosts%& or the &%fallback_hosts%& option, or the hosts supplied by the router
24595 were not obtained from MX records (this includes fallback hosts from the
24596 router), and were not randomized by the router, the order of trying the hosts
24597 is randomized each time the transport runs. Randomizing the order of a host
24598 list can be used to do crude load sharing.
24599
24600 When &%hosts_randomize%& is true, a host list may be split into groups whose
24601 order is separately randomized. This makes it possible to set up MX-like
24602 behaviour. The boundaries between groups are indicated by an item that is just
24603 &`+`& in the host list. For example:
24604 .code
24605 hosts = host1:host2:host3:+:host4:host5
24606 .endd
24607 The order of the first three hosts and the order of the last two hosts is
24608 randomized for each use, but the first three always end up before the last two.
24609 If &%hosts_randomize%& is not set, a &`+`& item in the list is ignored.
24610
24611 .option hosts_require_auth smtp "host list&!!" unset
24612 .cindex "authentication" "required by client"
24613 This option provides a list of servers for which authentication must succeed
24614 before Exim will try to transfer a message. If authentication fails for
24615 servers which are not in this list, Exim tries to send unauthenticated. If
24616 authentication fails for one of these servers, delivery is deferred. This
24617 temporary error is detectable in the retry rules, so it can be turned into a
24618 hard failure if required. See also &%hosts_try_auth%&, and chapter
24619 &<<CHAPSMTPAUTH>>& for details of authentication.
24620
24621
24622 .option hosts_request_ocsp smtp "host list&!!" *
24623 .cindex "TLS" "requiring for certain servers"
24624 Exim will request a Certificate Status on a
24625 TLS session for any host that matches this list.
24626 &%tls_verify_certificates%& should also be set for the transport.
24627
24628 .option hosts_require_dane smtp "host list&!!" unset
24629 .cindex DANE "transport options"
24630 .cindex DANE "requiring for certain servers"
24631 If built with DANE support, Exim  will require that a DNSSEC-validated
24632 TLSA record is present for any host matching the list,
24633 and that a DANE-verified TLS connection is made.
24634 There will be no fallback to in-clear communication.
24635 See section &<<SECDANE>>&.
24636
24637 .option hosts_require_ocsp smtp "host list&!!" unset
24638 .cindex "TLS" "requiring for certain servers"
24639 Exim will request, and check for a valid Certificate Status being given, on a
24640 TLS session for any host that matches this list.
24641 &%tls_verify_certificates%& should also be set for the transport.
24642
24643 .option hosts_require_tls smtp "host list&!!" unset
24644 .cindex "TLS" "requiring for certain servers"
24645 Exim will insist on using a TLS session when delivering to any host that
24646 matches this list. See chapter &<<CHAPTLS>>& for details of TLS.
24647 &*Note*&: This option affects outgoing mail only. To insist on TLS for
24648 incoming messages, use an appropriate ACL.
24649
24650 .option hosts_try_auth smtp "host list&!!" unset
24651 .cindex "authentication" "optional in client"
24652 This option provides a list of servers to which, provided they announce
24653 authentication support, Exim will attempt to authenticate as a client when it
24654 connects. If authentication fails, Exim will try to transfer the message
24655 unauthenticated. See also &%hosts_require_auth%&, and chapter
24656 &<<CHAPSMTPAUTH>>& for details of authentication.
24657
24658 .option hosts_try_chunking smtp "host list&!!" *
24659 .cindex CHUNKING "enabling, in client"
24660 .cindex BDAT "SMTP command"
24661 .cindex "RFC 3030" "CHUNKING"
24662 This option provides a list of servers to which, provided they announce
24663 CHUNKING support, Exim will attempt to use BDAT commands rather than DATA.
24664 BDAT will not be used in conjunction with a transport filter.
24665
24666 .option hosts_try_dane smtp "host list&!!" unset
24667 .cindex DANE "transport options"
24668 .cindex DANE "attempting for certain servers"
24669 If built with DANE support, Exim  will lookup a
24670 TLSA record for any host matching the list.
24671 If found and verified by DNSSEC,
24672 a DANE-verified TLS connection is made to that host;
24673 there will be no fallback to in-clear communication.
24674 See section &<<SECDANE>>&.
24675
24676 .option hosts_try_fastopen smtp "host list&!!" unset
24677 .cindex "fast open, TCP" "enabling, in client"
24678 .cindex "TCP Fast Open" "enabling, in client"
24679 .cindex "RFC 7413" "TCP Fast Open"
24680 This option provides a list of servers to which, provided
24681 the facility is supported by this system, Exim will attempt to
24682 perform a TCP Fast Open.
24683 No data is sent on the SYN segment but, if the remote server also
24684 supports the facility, it can send its SMTP banner immediately after
24685 the SYN,ACK segment.  This can save up to one round-trip time.
24686
24687 The facility is only active for previously-contacted servers,
24688 as the initiator must present a cookie in the SYN segment.
24689
24690 On (at least some) current Linux distributions the facility must be enabled
24691 in the kernel by the sysadmin before the support is usable.
24692 There is no option for control of the server side; if the system supports
24693 it it is always enabled.  Note that lengthy operations in the connect ACL,
24694 such as DNSBL lookups, will still delay the emission of the SMTP banner.
24695
24696 .option hosts_try_prdr smtp "host list&!!" *
24697 .cindex "PRDR" "enabling, optional in client"
24698 This option provides a list of servers to which, provided they announce
24699 PRDR support, Exim will attempt to negotiate PRDR
24700 for multi-recipient messages.
24701 The option can usually be left as default.
24702
24703 .option interface smtp "string list&!!" unset
24704 .cindex "bind IP address"
24705 .cindex "IP address" "binding"
24706 .vindex "&$host$&"
24707 .vindex "&$host_address$&"
24708 This option specifies which interface to bind to when making an outgoing SMTP
24709 call. The value is an IP address, not an interface name such as
24710 &`eth0`&. Do not confuse this with the interface address that was used when a
24711 message was received, which is in &$received_ip_address$&, formerly known as
24712 &$interface_address$&. The name was changed to minimize confusion with the
24713 outgoing interface address. There is no variable that contains an outgoing
24714 interface address because, unless it is set by this option, its value is
24715 unknown.
24716
24717 During the expansion of the &%interface%& option the variables &$host$& and
24718 &$host_address$& refer to the host to which a connection is about to be made
24719 during the expansion of the string. Forced expansion failure, or an empty
24720 string result causes the option to be ignored. Otherwise, after expansion, the
24721 string must be a list of IP addresses, colon-separated by default, but the
24722 separator can be changed in the usual way (&<<SECTlistsepchange>>&).
24723 For example:
24724 .code
24725 interface = <; 192.168.123.123 ; 3ffe:ffff:836f::fe86:a061
24726 .endd
24727 The first interface of the correct type (IPv4 or IPv6) is used for the outgoing
24728 connection. If none of them are the correct type, the option is ignored. If
24729 &%interface%& is not set, or is ignored, the system's IP functions choose which
24730 interface to use if the host has more than one.
24731
24732
24733 .option keepalive smtp boolean true
24734 .cindex "keepalive" "on outgoing connection"
24735 This option controls the setting of SO_KEEPALIVE on outgoing TCP/IP socket
24736 connections. When set, it causes the kernel to probe idle connections
24737 periodically, by sending packets with &"old"& sequence numbers. The other end
24738 of the connection should send a acknowledgment if the connection is still okay
24739 or a reset if the connection has been aborted. The reason for doing this is
24740 that it has the beneficial effect of freeing up certain types of connection
24741 that can get stuck when the remote host is disconnected without tidying up the
24742 TCP/IP call properly. The keepalive mechanism takes several hours to detect
24743 unreachable hosts.
24744
24745
24746 .option lmtp_ignore_quota smtp boolean false
24747 .cindex "LMTP" "ignoring quota errors"
24748 If this option is set true when the &%protocol%& option is set to &"lmtp"&, the
24749 string &`IGNOREQUOTA`& is added to RCPT commands, provided that the LMTP server
24750 has advertised support for IGNOREQUOTA in its response to the LHLO command.
24751
24752 .option max_rcpt smtp integer 100
24753 .cindex "RCPT" "maximum number of outgoing"
24754 This option limits the number of RCPT commands that are sent in a single
24755 SMTP message transaction. Each set of addresses is treated independently, and
24756 so can cause parallel connections to the same host if &%remote_max_parallel%&
24757 permits this.
24758
24759
24760 .option multi_domain smtp boolean&!! true
24761 .vindex "&$domain$&"
24762 When this option is set, the &(smtp)& transport can handle a number of
24763 addresses containing a mixture of different domains provided they all resolve
24764 to the same list of hosts. Turning the option off restricts the transport to
24765 handling only one domain at a time. This is useful if you want to use
24766 &$domain$& in an expansion for the transport, because it is set only when there
24767 is a single domain involved in a remote delivery.
24768
24769 It is expanded per-address and can depend on any of
24770 &$address_data$&, &$domain_data$&, &$local_part_data$&,
24771 &$host$&, &$host_address$& and &$host_port$&.
24772
24773 .option port smtp string&!! "see below"
24774 .cindex "port" "sending TCP/IP"
24775 .cindex "TCP/IP" "setting outgoing port"
24776 This option specifies the TCP/IP port on the server to which Exim connects.
24777 &*Note:*& Do not confuse this with the port that was used when a message was
24778 received, which is in &$received_port$&, formerly known as &$interface_port$&.
24779 The name was changed to minimize confusion with the outgoing port. There is no
24780 variable that contains an outgoing port.
24781
24782 If the value of this option begins with a digit it is taken as a port number;
24783 otherwise it is looked up using &[getservbyname()]&. The default value is
24784 normally &"smtp"&,
24785 but if &%protocol%& is set to &"lmtp"& the default is &"lmtp"&
24786 and if &%protocol%& is set to &"smtps"& the default is &"smtps"&.
24787 If the expansion fails, or if a port number cannot be found, delivery
24788 is deferred.
24789
24790 Note that at least one Linux distribution has been seen failing
24791 to put &"smtps"& in its &"/etc/services"& file, resulting is such deferrals.
24792
24793
24794
24795 .option protocol smtp string smtp
24796 .cindex "LMTP" "over TCP/IP"
24797 .cindex "ssmtp protocol" "outbound"
24798 .cindex "TLS" "SSL-on-connect outbound"
24799 .vindex "&$port$&"
24800 If this option is set to &"lmtp"& instead of &"smtp"&, the default value for
24801 the &%port%& option changes to &"lmtp"&, and the transport operates the LMTP
24802 protocol (RFC 2033) instead of SMTP. This protocol is sometimes used for local
24803 deliveries into closed message stores. Exim also has support for running LMTP
24804 over a pipe to a local process &-- see chapter &<<CHAPLMTP>>&.
24805
24806 If this option is set to &"smtps"&, the default value for the &%port%& option
24807 changes to &"smtps"&, and the transport initiates TLS immediately after
24808 connecting, as an outbound SSL-on-connect, instead of using STARTTLS to upgrade.
24809 The Internet standards bodies used to strongly discourage use of this mode,
24810 but as of RFC 8314 it is perferred over STARTTLS for message submission
24811 (as distinct from MTA-MTA communication).
24812
24813
24814 .option retry_include_ip_address smtp boolean&!! true
24815 Exim normally includes both the host name and the IP address in the key it
24816 constructs for indexing retry data after a temporary delivery failure. This
24817 means that when one of several IP addresses for a host is failing, it gets
24818 tried periodically (controlled by the retry rules), but use of the other IP
24819 addresses is not affected.
24820
24821 However, in some dialup environments hosts are assigned a different IP address
24822 each time they connect. In this situation the use of the IP address as part of
24823 the retry key leads to undesirable behaviour. Setting this option false causes
24824 Exim to use only the host name.
24825 Since it is expanded it can be made to depend on the host or domain.
24826
24827
24828 .option serialize_hosts smtp "host list&!!" unset
24829 .cindex "serializing connections"
24830 .cindex "host" "serializing connections"
24831 Because Exim operates in a distributed manner, if several messages for the same
24832 host arrive at around the same time, more than one simultaneous connection to
24833 the remote host can occur. This is not usually a problem except when there is a
24834 slow link between the hosts. In that situation it may be helpful to restrict
24835 Exim to one connection at a time. This can be done by setting
24836 &%serialize_hosts%& to match the relevant hosts.
24837
24838 .cindex "hints database" "serializing deliveries to a host"
24839 Exim implements serialization by means of a hints database in which a record is
24840 written whenever a process connects to one of the restricted hosts. The record
24841 is deleted when the connection is completed. Obviously there is scope for
24842 records to get left lying around if there is a system or program crash. To
24843 guard against this, Exim ignores any records that are more than six hours old.
24844
24845 If you set up this kind of serialization, you should also arrange to delete the
24846 relevant hints database whenever your system reboots. The names of the files
24847 start with &_misc_& and they are kept in the &_spool/db_& directory. There
24848 may be one or two files, depending on the type of DBM in use. The same files
24849 are used for ETRN serialization.
24850
24851 See also the &%max_parallel%& generic transport option.
24852
24853
24854 .option size_addition smtp integer 1024
24855 .cindex "SMTP" "SIZE"
24856 .cindex "message" "size issue for transport filter"
24857 .cindex "size" "of message"
24858 .cindex "transport" "filter"
24859 .cindex "filter" "transport filter"
24860 If a remote SMTP server indicates that it supports the SIZE option of the
24861 MAIL command, Exim uses this to pass over the message size at the start of
24862 an SMTP transaction. It adds the value of &%size_addition%& to the value it
24863 sends, to allow for headers and other text that may be added during delivery by
24864 configuration options or in a transport filter. It may be necessary to increase
24865 this if a lot of text is added to messages.
24866
24867 Alternatively, if the value of &%size_addition%& is set negative, it disables
24868 the use of the SIZE option altogether.
24869
24870
24871 .option socks_proxy smtp string&!! unset
24872 .cindex proxy SOCKS
24873 This option enables use of SOCKS proxies for connections made by the
24874 transport.  For details see section &<<SECTproxySOCKS>>&.
24875
24876
24877 .option tls_certificate smtp string&!! unset
24878 .cindex "TLS" "client certificate, location of"
24879 .cindex "certificate" "client, location of"
24880 .vindex "&$host$&"
24881 .vindex "&$host_address$&"
24882 The value of this option must be the absolute path to a file which contains the
24883 client's certificate, for possible use when sending a message over an encrypted
24884 connection. The values of &$host$& and &$host_address$& are set to the name and
24885 address of the server during the expansion. See chapter &<<CHAPTLS>>& for
24886 details of TLS.
24887
24888 &*Note*&: This option must be set if you want Exim to be able to use a TLS
24889 certificate when sending messages as a client. The global option of the same
24890 name specifies the certificate for Exim as a server; it is not automatically
24891 assumed that the same certificate should be used when Exim is operating as a
24892 client.
24893
24894
24895 .option tls_crl smtp string&!! unset
24896 .cindex "TLS" "client certificate revocation list"
24897 .cindex "certificate" "revocation list for client"
24898 This option specifies a certificate revocation list. The expanded value must
24899 be the name of a file that contains a CRL in PEM format.
24900
24901
24902 .option tls_dh_min_bits smtp integer 1024
24903 .cindex "TLS" "Diffie-Hellman minimum acceptable size"
24904 When establishing a TLS session, if a ciphersuite which uses Diffie-Hellman
24905 key agreement is negotiated, the server will provide a large prime number
24906 for use.  This option establishes the minimum acceptable size of that number.
24907 If the parameter offered by the server is too small, then the TLS handshake
24908 will fail.
24909
24910 Only supported when using GnuTLS.
24911
24912
24913 .option tls_privatekey smtp string&!! unset
24914 .cindex "TLS" "client private key, location of"
24915 .vindex "&$host$&"
24916 .vindex "&$host_address$&"
24917 The value of this option must be the absolute path to a file which contains the
24918 client's private key. This is used when sending a message over an encrypted
24919 connection using a client certificate. The values of &$host$& and
24920 &$host_address$& are set to the name and address of the server during the
24921 expansion. If this option is unset, or the expansion is forced to fail, or the
24922 result is an empty string, the private key is assumed to be in the same file as
24923 the certificate. See chapter &<<CHAPTLS>>& for details of TLS.
24924
24925
24926 .option tls_require_ciphers smtp string&!! unset
24927 .cindex "TLS" "requiring specific ciphers"
24928 .cindex "cipher" "requiring specific"
24929 .vindex "&$host$&"
24930 .vindex "&$host_address$&"
24931 The value of this option must be a list of permitted cipher suites, for use
24932 when setting up an outgoing encrypted connection. (There is a global option of
24933 the same name for controlling incoming connections.) The values of &$host$& and
24934 &$host_address$& are set to the name and address of the server during the
24935 expansion. See chapter &<<CHAPTLS>>& for details of TLS; note that this option
24936 is used in different ways by OpenSSL and GnuTLS (see sections
24937 &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&). For GnuTLS, the order of the
24938 ciphers is a preference order.
24939
24940
24941
24942 .option tls_sni smtp string&!! unset
24943 .cindex "TLS" "Server Name Indication"
24944 .vindex "&$tls_sni$&"
24945 If this option is set then it sets the $tls_out_sni variable and causes any
24946 TLS session to pass this value as the Server Name Indication extension to
24947 the remote side, which can be used by the remote side to select an appropriate
24948 certificate and private key for the session.
24949
24950 See &<<SECTtlssni>>& for more information.
24951
24952 Note that for OpenSSL, this feature requires a build of OpenSSL that supports
24953 TLS extensions.
24954
24955
24956
24957
24958 .option tls_tempfail_tryclear smtp boolean true
24959 .cindex "4&'xx'& responses" "to STARTTLS"
24960 When the server host is not in &%hosts_require_tls%&, and there is a problem in
24961 setting up a TLS session, this option determines whether or not Exim should try
24962 to deliver the message unencrypted. If it is set false, delivery to the
24963 current host is deferred; if there are other hosts, they are tried. If this
24964 option is set true, Exim attempts to deliver unencrypted after a 4&'xx'&
24965 response to STARTTLS. Also, if STARTTLS is accepted, but the subsequent
24966 TLS negotiation fails, Exim closes the current connection (because it is in an
24967 unknown state), opens a new one to the same host, and then tries the delivery
24968 in clear.
24969
24970
24971 .option tls_try_verify_hosts smtp "host list&!!" *
24972 .cindex "TLS" "server certificate verification"
24973 .cindex "certificate" "verification of server"
24974 This option gives a list of hosts for which, on encrypted connections,
24975 certificate verification will be tried but need not succeed.
24976 The &%tls_verify_certificates%& option must also be set.
24977 Note that unless the host is in this list
24978 TLS connections will be denied to hosts using self-signed certificates
24979 when &%tls_verify_certificates%& is matched.
24980 The &$tls_out_certificate_verified$& variable is set when
24981 certificate verification succeeds.
24982
24983
24984 .option tls_verify_cert_hostnames smtp "host list&!!" *
24985 .cindex "TLS" "server certificate hostname verification"
24986 .cindex "certificate" "verification of server"
24987 This option give a list of hosts for which,
24988 while verifying the server certificate,
24989 checks will be included on the host name
24990 (note that this will generally be the result of a DNS MX lookup)
24991 versus Subject and Subject-Alternate-Name fields.  Wildcard names are permitted
24992 limited to being the initial component of a 3-or-more component FQDN.
24993
24994 There is no equivalent checking on client certificates.
24995
24996
24997 .option tls_verify_certificates smtp string&!! system
24998 .cindex "TLS" "server certificate verification"
24999 .cindex "certificate" "verification of server"
25000 .vindex "&$host$&"
25001 .vindex "&$host_address$&"
25002 The value of this option must be either the
25003 word "system"
25004 or the absolute path to
25005 a file or directory containing permitted certificates for servers,
25006 for use when setting up an encrypted connection.
25007
25008 The "system" value for the option will use a location compiled into the SSL library.
25009 This is not available for GnuTLS versions preceding 3.0.20; a value of "system"
25010 is taken as empty and an explicit location
25011 must be specified.
25012
25013 The use of a directory for the option value is not available for GnuTLS versions
25014 preceding 3.3.6 and a single file must be used.
25015
25016 With OpenSSL the certificates specified
25017 explicitly
25018 either by file or directory
25019 are added to those given by the system default location.
25020
25021 The values of &$host$& and
25022 &$host_address$& are set to the name and address of the server during the
25023 expansion of this option. See chapter &<<CHAPTLS>>& for details of TLS.
25024
25025 For back-compatibility,
25026 if neither tls_verify_hosts nor tls_try_verify_hosts are set
25027 (a single-colon empty list counts as being set)
25028 and certificate verification fails the TLS connection is closed.
25029
25030
25031 .option tls_verify_hosts smtp "host list&!!" unset
25032 .cindex "TLS" "server certificate verification"
25033 .cindex "certificate" "verification of server"
25034 This option gives a list of hosts for which, on encrypted connections,
25035 certificate verification must succeed.
25036 The &%tls_verify_certificates%& option must also be set.
25037 If both this option and &%tls_try_verify_hosts%& are unset
25038 operation is as if this option selected all hosts.
25039
25040 .option utf8_downconvert smtp integer!! unset
25041 .cindex utf8 "address downconversion"
25042 .cindex i18n "utf8 address downconversion"
25043 If built with internationalization support,
25044 this option controls conversion of UTF-8 in message addresses
25045 to a-label form.
25046 For details see section &<<SECTi18nMTA>>&.
25047
25048
25049
25050
25051 .section "How the limits for the number of hosts to try are used" &&&
25052          "SECTvalhosmax"
25053 .cindex "host" "maximum number to try"
25054 .cindex "limit" "hosts; maximum number tried"
25055 There are two options that are concerned with the number of hosts that are
25056 tried when an SMTP delivery takes place. They are &%hosts_max_try%& and
25057 &%hosts_max_try_hardlimit%&.
25058
25059
25060 The &%hosts_max_try%& option limits the number of hosts that are tried
25061 for a single delivery. However, despite the term &"host"& in its name, the
25062 option actually applies to each IP address independently. In other words, a
25063 multihomed host is treated as several independent hosts, just as it is for
25064 retrying.
25065
25066 Many of the larger ISPs have multiple MX records which often point to
25067 multihomed hosts. As a result, a list of a dozen or more IP addresses may be
25068 created as a result of routing one of these domains.
25069
25070 Trying every single IP address on such a long list does not seem sensible; if
25071 several at the top of the list fail, it is reasonable to assume there is some
25072 problem that is likely to affect all of them. Roughly speaking, the value of
25073 &%hosts_max_try%& is the maximum number that are tried before deferring the
25074 delivery. However, the logic cannot be quite that simple.
25075
25076 Firstly, IP addresses that are skipped because their retry times have not
25077 arrived do not count, and in addition, addresses that are past their retry
25078 limits are also not counted, even when they are tried. This means that when
25079 some IP addresses are past their retry limits, more than the value of
25080 &%hosts_max_retry%& may be tried. The reason for this behaviour is to ensure
25081 that all IP addresses are considered before timing out an email address (but
25082 see below for an exception).
25083
25084 Secondly, when the &%hosts_max_try%& limit is reached, Exim looks down the host
25085 list to see if there is a subsequent host with a different (higher valued) MX.
25086 If there is, that host is considered next, and the current IP address is used
25087 but not counted. This behaviour helps in the case of a domain with a retry rule
25088 that hardly ever delays any hosts, as is now explained:
25089
25090 Consider the case of a long list of hosts with one MX value, and a few with a
25091 higher MX value. If &%hosts_max_try%& is small (the default is 5) only a few
25092 hosts at the top of the list are tried at first. With the default retry rule,
25093 which specifies increasing retry times, the higher MX hosts are eventually
25094 tried when those at the top of the list are skipped because they have not
25095 reached their retry times.
25096
25097 However, it is common practice to put a fixed short retry time on domains for
25098 large ISPs, on the grounds that their servers are rarely down for very long.
25099 Unfortunately, these are exactly the domains that tend to resolve to long lists
25100 of hosts. The short retry time means that the lowest MX hosts are tried every
25101 time. The attempts may be in a different order because of random sorting, but
25102 without the special MX check, the higher MX hosts would never be tried until
25103 all the lower MX hosts had timed out (which might be several days), because
25104 there are always some lower MX hosts that have reached their retry times. With
25105 the special check, Exim considers at least one IP address from each MX value at
25106 every delivery attempt, even if the &%hosts_max_try%& limit has already been
25107 reached.
25108
25109 The above logic means that &%hosts_max_try%& is not a hard limit, and in
25110 particular, Exim normally eventually tries all the IP addresses before timing
25111 out an email address. When &%hosts_max_try%& was implemented, this seemed a
25112 reasonable thing to do. Recently, however, some lunatic DNS configurations have
25113 been set up with hundreds of IP addresses for some domains. It can
25114 take a very long time indeed for an address to time out in these cases.
25115
25116 The &%hosts_max_try_hardlimit%& option was added to help with this problem.
25117 Exim never tries more than this number of IP addresses; if it hits this limit
25118 and they are all timed out, the email address is bounced, even though not all
25119 possible IP addresses have been tried.
25120 .ecindex IIDsmttra1
25121 .ecindex IIDsmttra2
25122
25123
25124
25125
25126
25127 . ////////////////////////////////////////////////////////////////////////////
25128 . ////////////////////////////////////////////////////////////////////////////
25129
25130 .chapter "Address rewriting" "CHAPrewrite"
25131 .scindex IIDaddrew "rewriting" "addresses"
25132 There are some circumstances in which Exim automatically rewrites domains in
25133 addresses. The two most common are when an address is given without a domain
25134 (referred to as an &"unqualified address"&) or when an address contains an
25135 abbreviated domain that is expanded by DNS lookup.
25136
25137 Unqualified envelope addresses are accepted only for locally submitted
25138 messages, or for messages that are received from hosts matching
25139 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
25140 appropriate. Unqualified addresses in header lines are qualified if they are in
25141 locally submitted messages, or messages from hosts that are permitted to send
25142 unqualified envelope addresses. Otherwise, unqualified addresses in header
25143 lines are neither qualified nor rewritten.
25144
25145 One situation in which Exim does &'not'& automatically rewrite a domain is
25146 when it is the name of a CNAME record in the DNS. The older RFCs suggest that
25147 such a domain should be rewritten using the &"canonical"& name, and some MTAs
25148 do this. The new RFCs do not contain this suggestion.
25149
25150
25151 .section "Explicitly configured address rewriting" "SECID147"
25152 This chapter describes the rewriting rules that can be used in the
25153 main rewrite section of the configuration file, and also in the generic
25154 &%headers_rewrite%& option that can be set on any transport.
25155
25156 Some people believe that configured address rewriting is a Mortal Sin.
25157 Others believe that life is not possible without it. Exim provides the
25158 facility; you do not have to use it.
25159
25160 The main rewriting rules that appear in the &"rewrite"& section of the
25161 configuration file are applied to addresses in incoming messages, both envelope
25162 addresses and addresses in header lines. Each rule specifies the types of
25163 address to which it applies.
25164
25165 Whether or not addresses in header lines are rewritten depends on the origin of
25166 the headers and the type of rewriting. Global rewriting, that is, rewriting
25167 rules from the rewrite section of the configuration file, is applied only to
25168 those headers that were received with the message. Header lines that are added
25169 by ACLs or by a system filter or by individual routers or transports (which
25170 are specific to individual recipient addresses) are not rewritten by the global
25171 rules.
25172
25173 Rewriting at transport time, by means of the &%headers_rewrite%& option,
25174 applies all headers except those added by routers and transports. That is, as
25175 well as the headers that were received with the message, it also applies to
25176 headers that were added by an ACL or a system filter.
25177
25178
25179 In general, rewriting addresses from your own system or domain has some
25180 legitimacy. Rewriting other addresses should be done only with great care and
25181 in special circumstances. The author of Exim believes that rewriting should be
25182 used sparingly, and mainly for &"regularizing"& addresses in your own domains.
25183 Although it can sometimes be used as a routing tool, this is very strongly
25184 discouraged.
25185
25186 There are two commonly encountered circumstances where rewriting is used, as
25187 illustrated by these examples:
25188
25189 .ilist
25190 The company whose domain is &'hitch.fict.example'& has a number of hosts that
25191 exchange mail with each other behind a firewall, but there is only a single
25192 gateway to the outer world. The gateway rewrites &'*.hitch.fict.example'& as
25193 &'hitch.fict.example'& when sending mail off-site.
25194 .next
25195 A host rewrites the local parts of its own users so that, for example,
25196 &'fp42@hitch.fict.example'& becomes &'Ford.Prefect@hitch.fict.example'&.
25197 .endlist
25198
25199
25200
25201 .section "When does rewriting happen?" "SECID148"
25202 .cindex "rewriting" "timing of"
25203 .cindex "&ACL;" "rewriting addresses in"
25204 Configured address rewriting can take place at several different stages of a
25205 message's processing.
25206
25207 .vindex "&$sender_address$&"
25208 At the start of an ACL for MAIL, the sender address may have been rewritten
25209 by a special SMTP-time rewrite rule (see section &<<SECTrewriteS>>&), but no
25210 ordinary rewrite rules have yet been applied. If, however, the sender address
25211 is verified in the ACL, it is rewritten before verification, and remains
25212 rewritten thereafter. The subsequent value of &$sender_address$& is the
25213 rewritten address. This also applies if sender verification happens in a
25214 RCPT ACL. Otherwise, when the sender address is not verified, it is
25215 rewritten as soon as a message's header lines have been received.
25216
25217 .vindex "&$domain$&"
25218 .vindex "&$local_part$&"
25219 Similarly, at the start of an ACL for RCPT, the current recipient's address
25220 may have been rewritten by a special SMTP-time rewrite rule, but no ordinary
25221 rewrite rules have yet been applied to it. However, the behaviour is different
25222 from the sender address when a recipient is verified. The address is rewritten
25223 for the verification, but the rewriting is not remembered at this stage. The
25224 value of &$local_part$& and &$domain$& after verification are always the same
25225 as they were before (that is, they contain the unrewritten &-- except for
25226 SMTP-time rewriting &-- address).
25227
25228 As soon as a message's header lines have been received, all the envelope
25229 recipient addresses are permanently rewritten, and rewriting is also applied to
25230 the addresses in the header lines (if configured). This happens before adding
25231 any header lines that were specified in MAIL or RCPT ACLs, and
25232 .cindex "&[local_scan()]& function" "address rewriting; timing of"
25233 before the DATA ACL and &[local_scan()]& functions are run.
25234
25235 When an address is being routed, either for delivery or for verification,
25236 rewriting is applied immediately to child addresses that are generated by
25237 redirection, unless &%no_rewrite%& is set on the router.
25238
25239 .cindex "envelope sender" "rewriting at transport time"
25240 .cindex "rewriting" "at transport time"
25241 .cindex "header lines" "rewriting at transport time"
25242 At transport time, additional rewriting of addresses in header lines can be
25243 specified by setting the generic &%headers_rewrite%& option on a transport.
25244 This option contains rules that are identical in form to those in the rewrite
25245 section of the configuration file. They are applied to the original message
25246 header lines and any that were added by ACLs or a system filter. They are not
25247 applied to header lines that are added by routers or the transport.
25248
25249 The outgoing envelope sender can be rewritten by means of the &%return_path%&
25250 transport option. However, it is not possible to rewrite envelope recipients at
25251 transport time.
25252
25253
25254
25255
25256 .section "Testing the rewriting rules that apply on input" "SECID149"
25257 .cindex "rewriting" "testing"
25258 .cindex "testing" "rewriting"
25259 Exim's input rewriting configuration appears in a part of the runtime
25260 configuration file headed by &"begin rewrite"&. It can be tested by the
25261 &%-brw%& command line option. This takes an address (which can be a full RFC
25262 2822 address) as its argument. The output is a list of how the address would be
25263 transformed by the rewriting rules for each of the different places it might
25264 appear in an incoming message, that is, for each different header and for the
25265 envelope sender and recipient fields. For example,
25266 .code
25267 exim -brw ph10@exim.workshop.example
25268 .endd
25269 might produce the output
25270 .code
25271 sender: Philip.Hazel@exim.workshop.example
25272 from: Philip.Hazel@exim.workshop.example
25273 to: ph10@exim.workshop.example
25274 cc: ph10@exim.workshop.example
25275 bcc: ph10@exim.workshop.example
25276 reply-to: Philip.Hazel@exim.workshop.example
25277 env-from: Philip.Hazel@exim.workshop.example
25278 env-to: ph10@exim.workshop.example
25279 .endd
25280 which shows that rewriting has been set up for that address when used in any of
25281 the source fields, but not when it appears as a recipient address. At the
25282 present time, there is no equivalent way of testing rewriting rules that are
25283 set for a particular transport.
25284
25285
25286 .section "Rewriting rules" "SECID150"
25287 .cindex "rewriting" "rules"
25288 The rewrite section of the configuration file consists of lines of rewriting
25289 rules in the form
25290 .display
25291 <&'source pattern'&>  <&'replacement'&>  <&'flags'&>
25292 .endd
25293 Rewriting rules that are specified for the &%headers_rewrite%& generic
25294 transport option are given as a colon-separated list. Each item in the list
25295 takes the same form as a line in the main rewriting configuration (except that
25296 any colons must be doubled, of course).
25297
25298 The formats of source patterns and replacement strings are described below.
25299 Each is terminated by white space, unless enclosed in double quotes, in which
25300 case normal quoting conventions apply inside the quotes. The flags are single
25301 characters which may appear in any order. Spaces and tabs between them are
25302 ignored.
25303
25304 For each address that could potentially be rewritten, the rules are scanned in
25305 order, and replacements for the address from earlier rules can themselves be
25306 replaced by later rules (but see the &"q"& and &"R"& flags).
25307
25308 The order in which addresses are rewritten is undefined, may change between
25309 releases, and must not be relied on, with one exception: when a message is
25310 received, the envelope sender is always rewritten first, before any header
25311 lines are rewritten. For example, the replacement string for a rewrite of an
25312 address in &'To:'& must not assume that the message's address in &'From:'& has
25313 (or has not) already been rewritten. However, a rewrite of &'From:'& may assume
25314 that the envelope sender has already been rewritten.
25315
25316 .vindex "&$domain$&"
25317 .vindex "&$local_part$&"
25318 The variables &$local_part$& and &$domain$& can be used in the replacement
25319 string to refer to the address that is being rewritten. Note that lookup-driven
25320 rewriting can be done by a rule of the form
25321 .code
25322 *@*   ${lookup ...
25323 .endd
25324 where the lookup key uses &$1$& and &$2$& or &$local_part$& and &$domain$& to
25325 refer to the address that is being rewritten.
25326
25327
25328 .section "Rewriting patterns" "SECID151"
25329 .cindex "rewriting" "patterns"
25330 .cindex "address list" "in a rewriting pattern"
25331 The source pattern in a rewriting rule is any item which may appear in an
25332 address list (see section &<<SECTaddresslist>>&). It is in fact processed as a
25333 single-item address list, which means that it is expanded before being tested
25334 against the address. As always, if you use a regular expression as a pattern,
25335 you must take care to escape dollar and backslash characters, or use the &`\N`&
25336 facility to suppress string expansion within the regular expression.
25337
25338 Domains in patterns should be given in lower case. Local parts in patterns are
25339 case-sensitive. If you want to do case-insensitive matching of local parts, you
25340 can use a regular expression that starts with &`^(?i)`&.
25341
25342 .cindex "numerical variables (&$1$& &$2$& etc)" "in rewriting rules"
25343 After matching, the numerical variables &$1$&, &$2$&, etc. may be set,
25344 depending on the type of match which occurred. These can be used in the
25345 replacement string to insert portions of the incoming address. &$0$& always
25346 refers to the complete incoming address. When a regular expression is used, the
25347 numerical variables are set from its capturing subexpressions. For other types
25348 of pattern they are set as follows:
25349
25350 .ilist
25351 If a local part or domain starts with an asterisk, the numerical variables
25352 refer to the character strings matched by asterisks, with &$1$& associated with
25353 the first asterisk, and &$2$& with the second, if present. For example, if the
25354 pattern
25355 .code
25356 *queen@*.fict.example
25357 .endd
25358 is matched against the address &'hearts-queen@wonderland.fict.example'& then
25359 .code
25360 $0 = hearts-queen@wonderland.fict.example
25361 $1 = hearts-
25362 $2 = wonderland
25363 .endd
25364 Note that if the local part does not start with an asterisk, but the domain
25365 does, it is &$1$& that contains the wild part of the domain.
25366
25367 .next
25368 If the domain part of the pattern is a partial lookup, the wild and fixed parts
25369 of the domain are placed in the next available numerical variables. Suppose,
25370 for example, that the address &'foo@bar.baz.example'& is processed by a
25371 rewriting rule of the form
25372 .display
25373 &`*@partial-dbm;/some/dbm/file`&    <&'replacement string'&>
25374 .endd
25375 and the key in the file that matches the domain is &`*.baz.example`&. Then
25376 .code
25377 $1 = foo
25378 $2 = bar
25379 $3 = baz.example
25380 .endd
25381 If the address &'foo@baz.example'& is looked up, this matches the same
25382 wildcard file entry, and in this case &$2$& is set to the empty string, but
25383 &$3$& is still set to &'baz.example'&. If a non-wild key is matched in a
25384 partial lookup, &$2$& is again set to the empty string and &$3$& is set to the
25385 whole domain. For non-partial domain lookups, no numerical variables are set.
25386 .endlist
25387
25388
25389 .section "Rewriting replacements" "SECID152"
25390 .cindex "rewriting" "replacements"
25391 If the replacement string for a rule is a single asterisk, addresses that
25392 match the pattern and the flags are &'not'& rewritten, and no subsequent
25393 rewriting rules are scanned. For example,
25394 .code
25395 hatta@lookingglass.fict.example  *  f
25396 .endd
25397 specifies that &'hatta@lookingglass.fict.example'& is never to be rewritten in
25398 &'From:'& headers.
25399
25400 .vindex "&$domain$&"
25401 .vindex "&$local_part$&"
25402 If the replacement string is not a single asterisk, it is expanded, and must
25403 yield a fully qualified address. Within the expansion, the variables
25404 &$local_part$& and &$domain$& refer to the address that is being rewritten.
25405 Any letters they contain retain their original case &-- they are not lower
25406 cased. The numerical variables are set up according to the type of pattern that
25407 matched the address, as described above. If the expansion is forced to fail by
25408 the presence of &"fail"& in a conditional or lookup item, rewriting by the
25409 current rule is abandoned, but subsequent rules may take effect. Any other
25410 expansion failure causes the entire rewriting operation to be abandoned, and an
25411 entry written to the panic log.
25412
25413
25414
25415 .section "Rewriting flags" "SECID153"
25416 There are three different kinds of flag that may appear on rewriting rules:
25417
25418 .ilist
25419 Flags that specify which headers and envelope addresses to rewrite: E, F, T, b,
25420 c, f, h, r, s, t.
25421 .next
25422 A flag that specifies rewriting at SMTP time: S.
25423 .next
25424 Flags that control the rewriting process: Q, q, R, w.
25425 .endlist
25426
25427 For rules that are part of the &%headers_rewrite%& generic transport option,
25428 E, F, T, and S are not permitted.
25429
25430
25431
25432 .section "Flags specifying which headers and envelope addresses to rewrite" &&&
25433          "SECID154"
25434 .cindex "rewriting" "flags"
25435 If none of the following flag letters, nor the &"S"& flag (see section
25436 &<<SECTrewriteS>>&) are present, a main rewriting rule applies to all headers
25437 and to both the sender and recipient fields of the envelope, whereas a
25438 transport-time rewriting rule just applies to all headers. Otherwise, the
25439 rewriting rule is skipped unless the relevant addresses are being processed.
25440 .display
25441 &`E`&       rewrite all envelope fields
25442 &`F`&       rewrite the envelope From field
25443 &`T`&       rewrite the envelope To field
25444 &`b`&       rewrite the &'Bcc:'& header
25445 &`c`&       rewrite the &'Cc:'& header
25446 &`f`&       rewrite the &'From:'& header
25447 &`h`&       rewrite all headers
25448 &`r`&       rewrite the &'Reply-To:'& header
25449 &`s`&       rewrite the &'Sender:'& header
25450 &`t`&       rewrite the &'To:'& header
25451 .endd
25452 "All headers" means all of the headers listed above that can be selected
25453 individually, plus their &'Resent-'& versions. It does not include
25454 other headers such as &'Subject:'& etc.
25455
25456 You should be particularly careful about rewriting &'Sender:'& headers, and
25457 restrict this to special known cases in your own domains.
25458
25459
25460 .section "The SMTP-time rewriting flag" "SECTrewriteS"
25461 .cindex "SMTP" "rewriting malformed addresses"
25462 .cindex "RCPT" "rewriting argument of"
25463 .cindex "MAIL" "rewriting argument of"
25464 The rewrite flag &"S"& specifies a rewrite of incoming envelope addresses at
25465 SMTP time, as soon as an address is received in a MAIL or RCPT command, and
25466 before any other processing; even before syntax checking. The pattern is
25467 required to be a regular expression, and it is matched against the whole of the
25468 data for the command, including any surrounding angle brackets.
25469
25470 .vindex "&$domain$&"
25471 .vindex "&$local_part$&"
25472 This form of rewrite rule allows for the handling of addresses that are not
25473 compliant with RFCs 2821 and 2822 (for example, &"bang paths"& in batched SMTP
25474 input). Because the input is not required to be a syntactically valid address,
25475 the variables &$local_part$& and &$domain$& are not available during the
25476 expansion of the replacement string. The result of rewriting replaces the
25477 original address in the MAIL or RCPT command.
25478
25479
25480 .section "Flags controlling the rewriting process" "SECID155"
25481 There are four flags which control the way the rewriting process works. These
25482 take effect only when a rule is invoked, that is, when the address is of the
25483 correct type (matches the flags) and matches the pattern:
25484
25485 .ilist
25486 If the &"Q"& flag is set on a rule, the rewritten address is permitted to be an
25487 unqualified local part. It is qualified with &%qualify_recipient%&. In the
25488 absence of &"Q"& the rewritten address must always include a domain.
25489 .next
25490 If the &"q"& flag is set on a rule, no further rewriting rules are considered,
25491 even if no rewriting actually takes place because of a &"fail"& in the
25492 expansion. The &"q"& flag is not effective if the address is of the wrong type
25493 (does not match the flags) or does not match the pattern.
25494 .next
25495 The &"R"& flag causes a successful rewriting rule to be re-applied to the new
25496 address, up to ten times. It can be combined with the &"q"& flag, to stop
25497 rewriting once it fails to match (after at least one successful rewrite).
25498 .next
25499 .cindex "rewriting" "whole addresses"
25500 When an address in a header is rewritten, the rewriting normally applies only
25501 to the working part of the address, with any comments and RFC 2822 &"phrase"&
25502 left unchanged. For example, rewriting might change
25503 .code
25504 From: Ford Prefect <fp42@restaurant.hitch.fict.example>
25505 .endd
25506 into
25507 .code
25508 From: Ford Prefect <prefectf@hitch.fict.example>
25509 .endd
25510 .cindex "RFC 2047"
25511 Sometimes there is a need to replace the whole address item, and this can be
25512 done by adding the flag letter &"w"& to a rule. If this is set on a rule that
25513 causes an address in a header line to be rewritten, the entire address is
25514 replaced, not just the working part. The replacement must be a complete RFC
25515 2822 address, including the angle brackets if necessary. If text outside angle
25516 brackets contains a character whose value is greater than 126 or less than 32
25517 (except for tab), the text is encoded according to RFC 2047. The character set
25518 is taken from &%headers_charset%&, which gets its default at build time.
25519
25520 When the &"w"& flag is set on a rule that causes an envelope address to be
25521 rewritten, all but the working part of the replacement address is discarded.
25522 .endlist
25523
25524
25525 .section "Rewriting examples" "SECID156"
25526 Here is an example of the two common rewriting paradigms:
25527 .code
25528 *@*.hitch.fict.example  $1@hitch.fict.example
25529 *@hitch.fict.example    ${lookup{$1}dbm{/etc/realnames}\
25530                      {$value}fail}@hitch.fict.example bctfrF
25531 .endd
25532 Note the use of &"fail"& in the lookup expansion in the second rule, forcing
25533 the string expansion to fail if the lookup does not succeed. In this context it
25534 has the effect of leaving the original address unchanged, but Exim goes on to
25535 consider subsequent rewriting rules, if any, because the &"q"& flag is not
25536 present in that rule. An alternative to &"fail"& would be to supply &$1$&
25537 explicitly, which would cause the rewritten address to be the same as before,
25538 at the cost of a small bit of processing. Not supplying either of these is an
25539 error, since the rewritten address would then contain no local part.
25540
25541 The first example above replaces the domain with a superior, more general
25542 domain. This may not be desirable for certain local parts. If the rule
25543 .code
25544 root@*.hitch.fict.example  *
25545 .endd
25546 were inserted before the first rule, rewriting would be suppressed for the
25547 local part &'root'& at any domain ending in &'hitch.fict.example'&.
25548
25549 Rewriting can be made conditional on a number of tests, by making use of
25550 &${if$& in the expansion item. For example, to apply a rewriting rule only to
25551 messages that originate outside the local host:
25552 .code
25553 *@*.hitch.fict.example  "${if !eq {$sender_host_address}{}\
25554                          {$1@hitch.fict.example}fail}"
25555 .endd
25556 The replacement string is quoted in this example because it contains white
25557 space.
25558
25559 .cindex "rewriting" "bang paths"
25560 .cindex "bang paths" "rewriting"
25561 Exim does not handle addresses in the form of &"bang paths"&. If it sees such
25562 an address it treats it as an unqualified local part which it qualifies with
25563 the local qualification domain (if the source of the message is local or if the
25564 remote host is permitted to send unqualified addresses). Rewriting can
25565 sometimes be used to handle simple bang paths with a fixed number of
25566 components. For example, the rule
25567 .code
25568 \N^([^!]+)!(.*)@your.domain.example$\N   $2@$1
25569 .endd
25570 rewrites a two-component bang path &'host.name!user'& as the domain address
25571 &'user@host.name'&. However, there is a security implication in using this as
25572 a global rewriting rule for envelope addresses. It can provide a backdoor
25573 method for using your system as a relay, because the incoming addresses appear
25574 to be local. If the bang path addresses are received via SMTP, it is safer to
25575 use the &"S"& flag to rewrite them as they are received, so that relay checking
25576 can be done on the rewritten addresses.
25577 .ecindex IIDaddrew
25578
25579
25580
25581
25582
25583 . ////////////////////////////////////////////////////////////////////////////
25584 . ////////////////////////////////////////////////////////////////////////////
25585
25586 .chapter "Retry configuration" "CHAPretry"
25587 .scindex IIDretconf1 "retry" "configuration, description of"
25588 .scindex IIDregconf2 "configuration file" "retry section"
25589 The &"retry"& section of the runtime configuration file contains a list of
25590 retry rules that control how often Exim tries to deliver messages that cannot
25591 be delivered at the first attempt. If there are no retry rules (the section is
25592 empty or not present), there are no retries. In this situation, temporary
25593 errors are treated as permanent. The default configuration contains a single,
25594 general-purpose retry rule (see section &<<SECID57>>&). The &%-brt%& command
25595 line option can be used to test which retry rule will be used for a given
25596 address, domain and error.
25597
25598 The most common cause of retries is temporary failure to deliver to a remote
25599 host because the host is down, or inaccessible because of a network problem.
25600 Exim's retry processing in this case is applied on a per-host (strictly, per IP
25601 address) basis, not on a per-message basis. Thus, if one message has recently
25602 been delayed, delivery of a new message to the same host is not immediately
25603 tried, but waits for the host's retry time to arrive. If the &%retry_defer%&
25604 log selector is set, the message
25605 .cindex "retry" "time not reached"
25606 &"retry time not reached"& is written to the main log whenever a delivery is
25607 skipped for this reason. Section &<<SECToutSMTPerr>>& contains more details of
25608 the handling of errors during remote deliveries.
25609
25610 Retry processing applies to routing as well as to delivering, except as covered
25611 in the next paragraph. The retry rules do not distinguish between these
25612 actions. It is not possible, for example, to specify different behaviour for
25613 failures to route the domain &'snark.fict.example'& and failures to deliver to
25614 the host &'snark.fict.example'&. I didn't think anyone would ever need this
25615 added complication, so did not implement it. However, although they share the
25616 same retry rule, the actual retry times for routing and transporting a given
25617 domain are maintained independently.
25618
25619 When a delivery is not part of a queue run (typically an immediate delivery on
25620 receipt of a message), the routers are always run, and local deliveries are
25621 always attempted, even if retry times are set for them. This makes for better
25622 behaviour if one particular message is causing problems (for example, causing
25623 quota overflow, or provoking an error in a filter file). If such a delivery
25624 suffers a temporary failure, the retry data is updated as normal, and
25625 subsequent delivery attempts from queue runs occur only when the retry time for
25626 the local address is reached.
25627
25628 .section "Changing retry rules" "SECID157"
25629 If you change the retry rules in your configuration, you should consider
25630 whether or not to delete the retry data that is stored in Exim's spool area in
25631 files with names like &_db/retry_&. Deleting any of Exim's hints files is
25632 always safe; that is why they are called &"hints"&.
25633
25634 The hints retry data contains suggested retry times based on the previous
25635 rules. In the case of a long-running problem with a remote host, it might
25636 record the fact that the host has timed out. If your new rules increase the
25637 timeout time for such a host, you should definitely remove the old retry data
25638 and let Exim recreate it, based on the new rules. Otherwise Exim might bounce
25639 messages that it should now be retaining.
25640
25641
25642
25643 .section "Format of retry rules" "SECID158"
25644 .cindex "retry" "rules"
25645 Each retry rule occupies one line and consists of three or four parts,
25646 separated by white space: a pattern, an error name, an optional list of sender
25647 addresses, and a list of retry parameters. The pattern and sender lists must be
25648 enclosed in double quotes if they contain white space. The rules are searched
25649 in order until one is found where the pattern, error name, and sender list (if
25650 present) match the failing host or address, the error that occurred, and the
25651 message's sender, respectively.
25652
25653
25654 The pattern is any single item that may appear in an address list (see section
25655 &<<SECTaddresslist>>&). It is in fact processed as a one-item address list,
25656 which means that it is expanded before being tested against the address that
25657 has been delayed. A negated address list item is permitted. Address
25658 list processing treats a plain domain name as if it were preceded by &"*@"&,
25659 which makes it possible for many retry rules to start with just a domain. For
25660 example,
25661 .code
25662 lookingglass.fict.example        *  F,24h,30m;
25663 .endd
25664 provides a rule for any address in the &'lookingglass.fict.example'& domain,
25665 whereas
25666 .code
25667 alice@lookingglass.fict.example  *  F,24h,30m;
25668 .endd
25669 applies only to temporary failures involving the local part &%alice%&.
25670 In practice, almost all rules start with a domain name pattern without a local
25671 part.
25672
25673 .cindex "regular expressions" "in retry rules"
25674 &*Warning*&: If you use a regular expression in a retry rule pattern, it
25675 must match a complete address, not just a domain, because that is how regular
25676 expressions work in address lists.
25677 .display
25678 &`^\Nxyz\d+\.abc\.example$\N        *  G,1h,10m,2`&     &%Wrong%&
25679 &`^\N[^@]+@xyz\d+\.abc\.example$\N  *  G,1h,10m,2`&     &%Right%&
25680 .endd
25681
25682
25683 .section "Choosing which retry rule to use for address errors" "SECID159"
25684 When Exim is looking for a retry rule after a routing attempt has failed (for
25685 example, after a DNS timeout), each line in the retry configuration is tested
25686 against the complete address only if &%retry_use_local_part%& is set for the
25687 router. Otherwise, only the domain is used, except when matching against a
25688 regular expression, when the local part of the address is replaced with &"*"&.
25689 A domain on its own can match a domain pattern, or a pattern that starts with
25690 &"*@"&. By default, &%retry_use_local_part%& is true for routers where
25691 &%check_local_user%& is true, and false for other routers.
25692
25693 Similarly, when Exim is looking for a retry rule after a local delivery has
25694 failed (for example, after a mailbox full error), each line in the retry
25695 configuration is tested against the complete address only if
25696 &%retry_use_local_part%& is set for the transport (it defaults true for all
25697 local transports).
25698
25699 .cindex "4&'xx'& responses" "retry rules for"
25700 However, when Exim is looking for a retry rule after a remote delivery attempt
25701 suffers an address error (a 4&'xx'& SMTP response for a recipient address), the
25702 whole address is always used as the key when searching the retry rules. The
25703 rule that is found is used to create a retry time for the combination of the
25704 failing address and the message's sender. It is the combination of sender and
25705 recipient that is delayed in subsequent queue runs until its retry time is
25706 reached. You can delay the recipient without regard to the sender by setting
25707 &%address_retry_include_sender%& false in the &(smtp)& transport but this can
25708 lead to problems with servers that regularly issue 4&'xx'& responses to RCPT
25709 commands.
25710
25711
25712
25713 .section "Choosing which retry rule to use for host and message errors" &&&
25714          "SECID160"
25715 For a temporary error that is not related to an individual address (for
25716 example, a connection timeout), each line in the retry configuration is checked
25717 twice. First, the name of the remote host is used as a domain name (preceded by
25718 &"*@"& when matching a regular expression). If this does not match the line,
25719 the domain from the email address is tried in a similar fashion. For example,
25720 suppose the MX records for &'a.b.c.example'& are
25721 .code
25722 a.b.c.example  MX  5  x.y.z.example
25723                MX  6  p.q.r.example
25724                MX  7  m.n.o.example
25725 .endd
25726 and the retry rules are
25727 .code
25728 p.q.r.example    *      F,24h,30m;
25729 a.b.c.example    *      F,4d,45m;
25730 .endd
25731 and a delivery to the host &'x.y.z.example'& suffers a connection failure. The
25732 first rule matches neither the host nor the domain, so Exim looks at the second
25733 rule. This does not match the host, but it does match the domain, so it is used
25734 to calculate the retry time for the host &'x.y.z.example'&. Meanwhile, Exim
25735 tries to deliver to &'p.q.r.example'&. If this also suffers a host error, the
25736 first retry rule is used, because it matches the host.
25737
25738 In other words, temporary failures to deliver to host &'p.q.r.example'& use the
25739 first rule to determine retry times, but for all the other hosts for the domain
25740 &'a.b.c.example'&, the second rule is used. The second rule is also used if
25741 routing to &'a.b.c.example'& suffers a temporary failure.
25742
25743 &*Note*&: The host name is used when matching the patterns, not its IP address.
25744 However, if a message is routed directly to an IP address without the use of a
25745 host name, for example, if a &(manualroute)& router contains a setting such as:
25746 .code
25747 route_list = *.a.example  192.168.34.23
25748 .endd
25749 then the &"host name"& that is used when searching for a retry rule is the
25750 textual form of the IP address.
25751
25752 .section "Retry rules for specific errors" "SECID161"
25753 .cindex "retry" "specific errors; specifying"
25754 The second field in a retry rule is the name of a particular error, or an
25755 asterisk, which matches any error. The errors that can be tested for are:
25756
25757 .vlist
25758 .vitem &%auth_failed%&
25759 Authentication failed when trying to send to a host in the
25760 &%hosts_require_auth%& list in an &(smtp)& transport.
25761
25762 .vitem &%data_4xx%&
25763 A 4&'xx'& error was received for an outgoing DATA command, either immediately
25764 after the command, or after sending the message's data.
25765
25766 .vitem &%mail_4xx%&
25767 A 4&'xx'& error was received for an outgoing MAIL command.
25768
25769 .vitem &%rcpt_4xx%&
25770 A 4&'xx'& error was received for an outgoing RCPT command.
25771 .endlist
25772
25773 For the three 4&'xx'& errors, either the first or both of the x's can be given
25774 as specific digits, for example: &`mail_45x`& or &`rcpt_436`&. For example, to
25775 recognize 452 errors given to RCPT commands for addresses in a certain domain,
25776 and have retries every ten minutes with a one-hour timeout, you could set up a
25777 retry rule of this form:
25778 .code
25779 the.domain.name  rcpt_452   F,1h,10m
25780 .endd
25781 These errors apply to both outgoing SMTP (the &(smtp)& transport) and outgoing
25782 LMTP (either the &(lmtp)& transport, or the &(smtp)& transport in LMTP mode).
25783
25784 .vlist
25785 .vitem &%lost_connection%&
25786 A server unexpectedly closed the SMTP connection. There may, of course,
25787 legitimate reasons for this (host died, network died), but if it repeats a lot
25788 for the same host, it indicates something odd.
25789
25790 .vitem &%lookup%&
25791 A DNS lookup for a host failed.
25792 Note that a &%dnslookup%& router will need to have matched
25793 its &%fail_defer_domains%& option for this retry type to be usable.
25794 Also note that a &%manualroute%& router will probably need
25795 its &%host_find_failed%& option set to &%defer%&.
25796
25797 .vitem &%refused_MX%&
25798 A connection to a host obtained from an MX record was refused.
25799
25800 .vitem &%refused_A%&
25801 A connection to a host not obtained from an MX record was refused.
25802
25803 .vitem &%refused%&
25804 A connection was refused.
25805
25806 .vitem &%timeout_connect_MX%&
25807 A connection attempt to a host obtained from an MX record timed out.
25808
25809 .vitem &%timeout_connect_A%&
25810 A connection attempt to a host not obtained from an MX record timed out.
25811
25812 .vitem &%timeout_connect%&
25813 A connection attempt timed out.
25814
25815 .vitem &%timeout_MX%&
25816 There was a timeout while connecting or during an SMTP session with a host
25817 obtained from an MX record.
25818
25819 .vitem &%timeout_A%&
25820 There was a timeout while connecting or during an SMTP session with a host not
25821 obtained from an MX record.
25822
25823 .vitem &%timeout%&
25824 There was a timeout while connecting or during an SMTP session.
25825
25826 .vitem &%tls_required%&
25827 The server was required to use TLS (it matched &%hosts_require_tls%& in the
25828 &(smtp)& transport), but either did not offer TLS, or it responded with 4&'xx'&
25829 to STARTTLS, or there was a problem setting up the TLS connection.
25830
25831 .vitem &%quota%&
25832 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25833 transport.
25834
25835 .vitem &%quota_%&<&'time'&>
25836 .cindex "quota" "error testing in retry rule"
25837 .cindex "retry" "quota error testing"
25838 A mailbox quota was exceeded in a local delivery by the &(appendfile)&
25839 transport, and the mailbox has not been accessed for <&'time'&>. For example,
25840 &'quota_4d'& applies to a quota error when the mailbox has not been accessed
25841 for four days.
25842 .endlist
25843
25844 .cindex "mailbox" "time of last read"
25845 The idea of &%quota_%&<&'time'&> is to make it possible to have shorter
25846 timeouts when the mailbox is full and is not being read by its owner. Ideally,
25847 it should be based on the last time that the user accessed the mailbox.
25848 However, it is not always possible to determine this. Exim uses the following
25849 heuristic rules:
25850
25851 .ilist
25852 If the mailbox is a single file, the time of last access (the &"atime"&) is
25853 used. As no new messages are being delivered (because the mailbox is over
25854 quota), Exim does not access the file, so this is the time of last user access.
25855 .next
25856 .cindex "maildir format" "time of last read"
25857 For a maildir delivery, the time of last modification of the &_new_&
25858 subdirectory is used. As the mailbox is over quota, no new files are created in
25859 the &_new_& subdirectory, because no new messages are being delivered. Any
25860 change to the &_new_& subdirectory is therefore assumed to be the result of an
25861 MUA moving a new message to the &_cur_& directory when it is first read. The
25862 time that is used is therefore the last time that the user read a new message.
25863 .next
25864 For other kinds of multi-file mailbox, the time of last access cannot be
25865 obtained, so a retry rule that uses this type of error field is never matched.
25866 .endlist
25867
25868 The quota errors apply both to system-enforced quotas and to Exim's own quota
25869 mechanism in the &(appendfile)& transport. The &'quota'& error also applies
25870 when a local delivery is deferred because a partition is full (the ENOSPC
25871 error).
25872
25873
25874
25875 .section "Retry rules for specified senders" "SECID162"
25876 .cindex "retry" "rules; sender-specific"
25877 You can specify retry rules that apply only when the failing message has a
25878 specific sender. In particular, this can be used to define retry rules that
25879 apply only to bounce messages. The third item in a retry rule can be of this
25880 form:
25881 .display
25882 &`senders=`&<&'address list'&>
25883 .endd
25884 The retry timings themselves are then the fourth item. For example:
25885 .code
25886 *   rcpt_4xx   senders=:   F,1h,30m
25887 .endd
25888 matches recipient 4&'xx'& errors for bounce messages sent to any address at any
25889 host. If the address list contains white space, it must be enclosed in quotes.
25890 For example:
25891 .code
25892 a.domain  rcpt_452  senders="xb.dom : yc.dom"  G,8h,10m,1.5
25893 .endd
25894 &*Warning*&: This facility can be unhelpful if it is used for host errors
25895 (which do not depend on the recipient). The reason is that the sender is used
25896 only to match the retry rule. Once the rule has been found for a host error,
25897 its contents are used to set a retry time for the host, and this will apply to
25898 all messages, not just those with specific senders.
25899
25900 When testing retry rules using &%-brt%&, you can supply a sender using the
25901 &%-f%& command line option, like this:
25902 .code
25903 exim -f "" -brt user@dom.ain
25904 .endd
25905 If you do not set &%-f%& with &%-brt%&, a retry rule that contains a senders
25906 list is never matched.
25907
25908
25909
25910
25911
25912 .section "Retry parameters" "SECID163"
25913 .cindex "retry" "parameters in rules"
25914 The third (or fourth, if a senders list is present) field in a retry rule is a
25915 sequence of retry parameter sets, separated by semicolons. Each set consists of
25916 .display
25917 <&'letter'&>,<&'cutoff time'&>,<&'arguments'&>
25918 .endd
25919 The letter identifies the algorithm for computing a new retry time; the cutoff
25920 time is the time beyond which this algorithm no longer applies, and the
25921 arguments vary the algorithm's action. The cutoff time is measured from the
25922 time that the first failure for the domain (combined with the local part if
25923 relevant) was detected, not from the time the message was received.
25924
25925 .cindex "retry" "algorithms"
25926 .cindex "retry" "fixed intervals"
25927 .cindex "retry" "increasing intervals"
25928 .cindex "retry" "random intervals"
25929 The available algorithms are:
25930
25931 .ilist
25932 &'F'&: retry at fixed intervals. There is a single time parameter specifying
25933 the interval.
25934 .next
25935 &'G'&: retry at geometrically increasing intervals. The first argument
25936 specifies a starting value for the interval, and the second a multiplier, which
25937 is used to increase the size of the interval at each retry.
25938 .next
25939 &'H'&: retry at randomized intervals. The arguments are as for &'G'&. For each
25940 retry, the previous interval is multiplied by the factor in order to get a
25941 maximum for the next interval. The minimum interval is the first argument of
25942 the parameter, and an actual interval is chosen randomly between them. Such a
25943 rule has been found to be helpful in cluster configurations when all the
25944 members of the cluster restart at once, and may therefore synchronize their
25945 queue processing times.
25946 .endlist
25947
25948 When computing the next retry time, the algorithm definitions are scanned in
25949 order until one whose cutoff time has not yet passed is reached. This is then
25950 used to compute a new retry time that is later than the current time. In the
25951 case of fixed interval retries, this simply means adding the interval to the
25952 current time. For geometrically increasing intervals, retry intervals are
25953 computed from the rule's parameters until one that is greater than the previous
25954 interval is found. The main configuration variable
25955 .cindex "limit" "retry interval"
25956 .cindex "retry" "interval, maximum"
25957 .oindex "&%retry_interval_max%&"
25958 &%retry_interval_max%& limits the maximum interval between retries. It
25959 cannot be set greater than &`24h`&, which is its default value.
25960
25961 A single remote domain may have a number of hosts associated with it, and each
25962 host may have more than one IP address. Retry algorithms are selected on the
25963 basis of the domain name, but are applied to each IP address independently. If,
25964 for example, a host has two IP addresses and one is unusable, Exim will
25965 generate retry times for it and will not try to use it until its next retry
25966 time comes. Thus the good IP address is likely to be tried first most of the
25967 time.
25968
25969 .cindex "hints database" "use for retrying"
25970 Retry times are hints rather than promises. Exim does not make any attempt to
25971 run deliveries exactly at the computed times. Instead, a queue runner process
25972 starts delivery processes for delayed messages periodically, and these attempt
25973 new deliveries only for those addresses that have passed their next retry time.
25974 If a new message arrives for a deferred address, an immediate delivery attempt
25975 occurs only if the address has passed its retry time. In the absence of new
25976 messages, the minimum time between retries is the interval between queue runner
25977 processes. There is not much point in setting retry times of five minutes if
25978 your queue runners happen only once an hour, unless there are a significant
25979 number of incoming messages (which might be the case on a system that is
25980 sending everything to a smart host, for example).
25981
25982 The data in the retry hints database can be inspected by using the
25983 &'exim_dumpdb'& or &'exim_fixdb'& utility programs (see chapter
25984 &<<CHAPutils>>&). The latter utility can also be used to change the data. The
25985 &'exinext'& utility script can be used to find out what the next retry times
25986 are for the hosts associated with a particular mail domain, and also for local
25987 deliveries that have been deferred.
25988
25989
25990 .section "Retry rule examples" "SECID164"
25991 Here are some example retry rules:
25992 .code
25993 alice@wonderland.fict.example quota_5d  F,7d,3h
25994 wonderland.fict.example       quota_5d
25995 wonderland.fict.example       *         F,1h,15m; G,2d,1h,2;
25996 lookingglass.fict.example     *         F,24h,30m;
25997 *                 refused_A   F,2h,20m;
25998 *                 *           F,2h,15m; G,16h,1h,1.5; F,5d,8h
25999 .endd
26000 The first rule sets up special handling for mail to
26001 &'alice@wonderland.fict.example'& when there is an over-quota error and the
26002 mailbox has not been read for at least 5 days. Retries continue every three
26003 hours for 7 days. The second rule handles over-quota errors for all other local
26004 parts at &'wonderland.fict.example'&; the absence of a local part has the same
26005 effect as supplying &"*@"&. As no retry algorithms are supplied, messages that
26006 fail are bounced immediately if the mailbox has not been read for at least 5
26007 days.
26008
26009 The third rule handles all other errors at &'wonderland.fict.example'&; retries
26010 happen every 15 minutes for an hour, then with geometrically increasing
26011 intervals until two days have passed since a delivery first failed. After the
26012 first hour there is a delay of one hour, then two hours, then four hours, and
26013 so on (this is a rather extreme example).
26014
26015 The fourth rule controls retries for the domain &'lookingglass.fict.example'&.
26016 They happen every 30 minutes for 24 hours only. The remaining two rules handle
26017 all other domains, with special action for connection refusal from hosts that
26018 were not obtained from an MX record.
26019
26020 The final rule in a retry configuration should always have asterisks in the
26021 first two fields so as to provide a general catch-all for any addresses that do
26022 not have their own special handling. This example tries every 15 minutes for 2
26023 hours, then with intervals starting at one hour and increasing by a factor of
26024 1.5 up to 16 hours, then every 8 hours up to 5 days.
26025
26026
26027
26028 .section "Timeout of retry data" "SECID165"
26029 .cindex "timeout" "of retry data"
26030 .oindex "&%retry_data_expire%&"
26031 .cindex "hints database" "data expiry"
26032 .cindex "retry" "timeout of data"
26033 Exim timestamps the data that it writes to its retry hints database. When it
26034 consults the data during a delivery it ignores any that is older than the value
26035 set in &%retry_data_expire%& (default 7 days). If, for example, a host hasn't
26036 been tried for 7 days, Exim will try to deliver to it immediately a message
26037 arrives, and if that fails, it will calculate a retry time as if it were
26038 failing for the first time.
26039
26040 This improves the behaviour for messages routed to rarely-used hosts such as MX
26041 backups. If such a host was down at one time, and happens to be down again when
26042 Exim tries a month later, using the old retry data would imply that it had been
26043 down all the time, which is not a justified assumption.
26044
26045 If a host really is permanently dead, this behaviour causes a burst of retries
26046 every now and again, but only if messages routed to it are rare. If there is a
26047 message at least once every 7 days the retry data never expires.
26048
26049
26050
26051
26052 .section "Long-term failures" "SECID166"
26053 .cindex "delivery failure, long-term"
26054 .cindex "retry" "after long-term failure"
26055 Special processing happens when an email address has been failing for so long
26056 that the cutoff time for the last algorithm is reached. For example, using the
26057 default retry rule:
26058 .code
26059 * * F,2h,15m; G,16h,1h,1.5; F,4d,6h
26060 .endd
26061 the cutoff time is four days. Reaching the retry cutoff is independent of how
26062 long any specific message has been failing; it is the length of continuous
26063 failure for the recipient address that counts.
26064
26065 When the cutoff time is reached for a local delivery, or for all the IP
26066 addresses associated with a remote delivery, a subsequent delivery failure
26067 causes Exim to give up on the address, and a bounce message is generated.
26068 In order to cater for new messages that use the failing address, a next retry
26069 time is still computed from the final algorithm, and is used as follows:
26070
26071 For local deliveries, one delivery attempt is always made for any subsequent
26072 messages. If this delivery fails, the address fails immediately. The
26073 post-cutoff retry time is not used.
26074
26075 .cindex "final cutoff" "retries, controlling"
26076 .cindex retry "final cutoff"
26077 If the delivery is remote, there are two possibilities, controlled by the
26078 .oindex "&%delay_after_cutoff%&"
26079 &%delay_after_cutoff%& option of the &(smtp)& transport. The option is true by
26080 default. Until the post-cutoff retry time for one of the IP addresses,
26081 as set by the &%retry_data_expire%& option, is
26082 reached, the failing email address is bounced immediately, without a delivery
26083 attempt taking place. After that time, one new delivery attempt is made to
26084 those IP addresses that are past their retry times, and if that still fails,
26085 the address is bounced and new retry times are computed.
26086
26087 In other words, when all the hosts for a given email address have been failing
26088 for a long time, Exim bounces rather then defers until one of the hosts' retry
26089 times is reached. Then it tries once, and bounces if that attempt fails. This
26090 behaviour ensures that few resources are wasted in repeatedly trying to deliver
26091 to a broken destination, but if the host does recover, Exim will eventually
26092 notice.
26093
26094 If &%delay_after_cutoff%& is set false, Exim behaves differently. If all IP
26095 addresses are past their final cutoff time, Exim tries to deliver to those IP
26096 addresses that have not been tried since the message arrived. If there are
26097 no suitable IP addresses, or if they all fail, the address is bounced. In other
26098 words, it does not delay when a new message arrives, but tries the expired
26099 addresses immediately, unless they have been tried since the message arrived.
26100 If there is a continuous stream of messages for the failing domains, setting
26101 &%delay_after_cutoff%& false means that there will be many more attempts to
26102 deliver to permanently failing IP addresses than when &%delay_after_cutoff%& is
26103 true.
26104
26105 .section "Deliveries that work intermittently" "SECID167"
26106 .cindex "retry" "intermittently working deliveries"
26107 Some additional logic is needed to cope with cases where a host is
26108 intermittently available, or when a message has some attribute that prevents
26109 its delivery when others to the same address get through. In this situation,
26110 because some messages are successfully delivered, the &"retry clock"& for the
26111 host or address keeps getting reset by the successful deliveries, and so
26112 failing messages remain in the queue for ever because the cutoff time is never
26113 reached.
26114
26115 Two exceptional actions are applied to prevent this happening. The first
26116 applies to errors that are related to a message rather than a remote host.
26117 Section &<<SECToutSMTPerr>>& has a discussion of the different kinds of error;
26118 examples of message-related errors are 4&'xx'& responses to MAIL or DATA
26119 commands, and quota failures. For this type of error, if a message's arrival
26120 time is earlier than the &"first failed"& time for the error, the earlier time
26121 is used when scanning the retry rules to decide when to try next and when to
26122 time out the address.
26123
26124 The exceptional second action applies in all cases. If a message has been on
26125 the queue for longer than the cutoff time of any applicable retry rule for a
26126 given address, a delivery is attempted for that address, even if it is not yet
26127 time, and if this delivery fails, the address is timed out. A new retry time is
26128 not computed in this case, so that other messages for the same address are
26129 considered immediately.
26130 .ecindex IIDretconf1
26131 .ecindex IIDregconf2
26132
26133
26134
26135
26136
26137
26138 . ////////////////////////////////////////////////////////////////////////////
26139 . ////////////////////////////////////////////////////////////////////////////
26140
26141 .chapter "SMTP authentication" "CHAPSMTPAUTH"
26142 .scindex IIDauthconf1 "SMTP" "authentication configuration"
26143 .scindex IIDauthconf2 "authentication"
26144 The &"authenticators"& section of Exim's runtime configuration is concerned
26145 with SMTP authentication. This facility is an extension to the SMTP protocol,
26146 described in RFC 2554, which allows a client SMTP host to authenticate itself
26147 to a server. This is a common way for a server to recognize clients that are
26148 permitted to use it as a relay. SMTP authentication is not of relevance to the
26149 transfer of mail between servers that have no managerial connection with each
26150 other.
26151
26152 .cindex "AUTH" "description of"
26153 Very briefly, the way SMTP authentication works is as follows:
26154
26155 .ilist
26156 The server advertises a number of authentication &'mechanisms'& in response to
26157 the client's EHLO command.
26158 .next
26159 The client issues an AUTH command, naming a specific mechanism. The command
26160 may, optionally, contain some authentication data.
26161 .next
26162 The server may issue one or more &'challenges'&, to which the client must send
26163 appropriate responses. In simple authentication mechanisms, the challenges are
26164 just prompts for user names and passwords. The server does not have to issue
26165 any challenges &-- in some mechanisms the relevant data may all be transmitted
26166 with the AUTH command.
26167 .next
26168 The server either accepts or denies authentication.
26169 .next
26170 If authentication succeeds, the client may optionally make use of the AUTH
26171 option on the MAIL command to pass an authenticated sender in subsequent
26172 mail transactions. Authentication lasts for the remainder of the SMTP
26173 connection.
26174 .next
26175 If authentication fails, the client may give up, or it may try a different
26176 authentication mechanism, or it may try transferring mail over the
26177 unauthenticated connection.
26178 .endlist
26179
26180 If you are setting up a client, and want to know which authentication
26181 mechanisms the server supports, you can use Telnet to connect to port 25 (the
26182 SMTP port) on the server, and issue an EHLO command. The response to this
26183 includes the list of supported mechanisms. For example:
26184 .display
26185 &`$ `&&*&`telnet server.example 25`&*&
26186 &`Trying 192.168.34.25...`&
26187 &`Connected to server.example.`&
26188 &`Escape character is &#x0027;^]&#x0027;.`&
26189 &`220 server.example ESMTP Exim 4.20 ...`&
26190 &*&`ehlo client.example`&*&
26191 &`250-server.example Hello client.example [10.8.4.5]`&
26192 &`250-SIZE 52428800`&
26193 &`250-PIPELINING`&
26194 &`250-AUTH PLAIN`&
26195 &`250 HELP`&
26196 .endd
26197 The second-last line of this example output shows that the server supports
26198 authentication using the PLAIN mechanism. In Exim, the different authentication
26199 mechanisms are configured by specifying &'authenticator'& drivers. Like the
26200 routers and transports, which authenticators are included in the binary is
26201 controlled by build-time definitions. The following are currently available,
26202 included by setting
26203 .code
26204 AUTH_CRAM_MD5=yes
26205 AUTH_CYRUS_SASL=yes
26206 AUTH_DOVECOT=yes
26207 AUTH_EXTERNAL=yes
26208 AUTH_GSASL=yes
26209 AUTH_HEIMDAL_GSSAPI=yes
26210 AUTH_PLAINTEXT=yes
26211 AUTH_SPA=yes
26212 AUTH_TLS=yes
26213 .endd
26214 in &_Local/Makefile_&, respectively. The first of these supports the CRAM-MD5
26215 authentication mechanism (RFC 2195), and the second provides an interface to
26216 the Cyrus SASL authentication library.
26217 The third is an interface to Dovecot's authentication system, delegating the
26218 work via a socket interface.
26219 .new
26220 The fourth provides for negotiation of authentication done via non-SMTP means,
26221 as defined by RFC 4422 Appendix A.
26222 .wen
26223 The fifth provides an interface to the GNU SASL authentication library, which
26224 provides mechanisms but typically not data sources.
26225 The sixth provides direct access to Heimdal GSSAPI, geared for Kerberos, but
26226 supporting setting a server keytab.
26227 The seventh can be configured to support
26228 the PLAIN authentication mechanism (RFC 2595) or the LOGIN mechanism, which is
26229 not formally documented, but used by several MUAs.
26230 The eighth authenticator
26231 supports Microsoft's &'Secure Password Authentication'& mechanism.
26232 The last is an Exim authenticator but not an SMTP one;
26233 instead it can use information from a TLS negotiation.
26234
26235 The authenticators are configured using the same syntax as other drivers (see
26236 section &<<SECTfordricon>>&). If no authenticators are required, no
26237 authentication section need be present in the configuration file. Each
26238 authenticator can in principle have both server and client functions. When Exim
26239 is receiving SMTP mail, it is acting as a server; when it is sending out
26240 messages over SMTP, it is acting as a client. Authenticator configuration
26241 options are provided for use in both these circumstances.
26242
26243 To make it clear which options apply to which situation, the prefixes
26244 &%server_%& and &%client_%& are used on option names that are specific to
26245 either the server or the client function, respectively. Server and client
26246 functions are disabled if none of their options are set. If an authenticator is
26247 to be used for both server and client functions, a single definition, using
26248 both sets of options, is required. For example:
26249 .code
26250 cram:
26251   driver = cram_md5
26252   public_name = CRAM-MD5
26253   server_secret = ${if eq{$auth1}{ph10}{secret1}fail}
26254   client_name = ph10
26255   client_secret = secret2
26256 .endd
26257 The &%server_%& option is used when Exim is acting as a server, and the
26258 &%client_%& options when it is acting as a client.
26259
26260 Descriptions of the individual authenticators are given in subsequent chapters.
26261 The remainder of this chapter covers the generic options for the
26262 authenticators, followed by general discussion of the way authentication works
26263 in Exim.
26264
26265 &*Beware:*& the meaning of &$auth1$&, &$auth2$&, ... varies on a per-driver and
26266 per-mechanism basis.  Please read carefully to determine which variables hold
26267 account labels such as usercodes and which hold passwords or other
26268 authenticating data.
26269
26270 Note that some mechanisms support two different identifiers for accounts: the
26271 &'authentication id'& and the &'authorization id'&.  The contractions &'authn'&
26272 and &'authz'& are commonly encountered.  The American spelling is standard here.
26273 Conceptually, authentication data such as passwords are tied to the identifier
26274 used to authenticate; servers may have rules to permit one user to act as a
26275 second user, so that after login the session is treated as though that second
26276 user had logged in.  That second user is the &'authorization id'&.  A robust
26277 configuration might confirm that the &'authz'& field is empty or matches the
26278 &'authn'& field.  Often this is just ignored.  The &'authn'& can be considered
26279 as verified data, the &'authz'& as an unverified request which the server might
26280 choose to honour.
26281
26282 A &'realm'& is a text string, typically a domain name, presented by a server
26283 to a client to help it select an account and credentials to use.  In some
26284 mechanisms, the client and server provably agree on the realm, but clients
26285 typically can not treat the realm as secure data to be blindly trusted.
26286
26287
26288
26289 .section "Generic options for authenticators" "SECID168"
26290 .cindex "authentication" "generic options"
26291 .cindex "options" "generic; for authenticators"
26292
26293 .option client_condition authenticators string&!! unset
26294 When Exim is authenticating as a client, it skips any authenticator whose
26295 &%client_condition%& expansion yields &"0"&, &"no"&, or &"false"&. This can be
26296 used, for example, to skip plain text authenticators when the connection is not
26297 encrypted by a setting such as:
26298 .code
26299 client_condition = ${if !eq{$tls_out_cipher}{}}
26300 .endd
26301
26302
26303 .option client_set_id authenticators string&!! unset
26304 When client authentication succeeds, this condition is expanded; the
26305 result is used in the log lines for outbound messages.
26306 Typically it will be the user name used for authentication.
26307
26308
26309 .option driver authenticators string unset
26310 This option must always be set. It specifies which of the available
26311 authenticators is to be used.
26312
26313
26314 .option public_name authenticators string unset
26315 This option specifies the name of the authentication mechanism that the driver
26316 implements, and by which it is known to the outside world. These names should
26317 contain only upper case letters, digits, underscores, and hyphens (RFC 2222),
26318 but Exim in fact matches them caselessly. If &%public_name%& is not set, it
26319 defaults to the driver's instance name.
26320
26321
26322 .option server_advertise_condition authenticators string&!! unset
26323 When a server is about to advertise an authentication mechanism, the condition
26324 is expanded. If it yields the empty string, &"0"&, &"no"&, or &"false"&, the
26325 mechanism is not advertised.
26326 If the expansion fails, the mechanism is not advertised. If the failure was not
26327 forced, and was not caused by a lookup defer, the incident is logged.
26328 See section &<<SECTauthexiser>>& below for further discussion.
26329
26330
26331 .option server_condition authenticators string&!! unset
26332 This option must be set for a &%plaintext%& server authenticator, where it
26333 is used directly to control authentication. See section &<<SECTplainserver>>&
26334 for details.
26335
26336 For the &(gsasl)& authenticator, this option is required for various
26337 mechanisms; see chapter &<<CHAPgsasl>>& for details.
26338
26339 For the other authenticators, &%server_condition%& can be used as an additional
26340 authentication or authorization mechanism that is applied after the other
26341 authenticator conditions succeed. If it is set, it is expanded when the
26342 authenticator would otherwise return a success code. If the expansion is forced
26343 to fail, authentication fails. Any other expansion failure causes a temporary
26344 error code to be returned. If the result of a successful expansion is an empty
26345 string, &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26346 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds. For any
26347 other result, a temporary error code is returned, with the expanded string as
26348 the error text.
26349
26350
26351 .option server_debug_print authenticators string&!! unset
26352 If this option is set and authentication debugging is enabled (see the &%-d%&
26353 command line option), the string is expanded and included in the debugging
26354 output when the authenticator is run as a server. This can help with checking
26355 out the values of variables.
26356 If expansion of the string fails, the error message is written to the debugging
26357 output, and Exim carries on processing.
26358
26359
26360 .option server_set_id authenticators string&!! unset
26361 .vindex "&$authenticated_id$&"
26362 .vindex "&$authenticated_fail_id$&"
26363 When an Exim server successfully authenticates a client, this string is
26364 expanded using data from the authentication, and preserved for any incoming
26365 messages in the variable &$authenticated_id$&. It is also included in the log
26366 lines for incoming messages. For example, a user/password authenticator
26367 configuration might preserve the user name that was used to authenticate, and
26368 refer to it subsequently during delivery of the message.
26369 On a failing authentication the expansion result is instead saved in
26370 the &$authenticated_fail_id$& variable.
26371 If expansion fails, the option is ignored.
26372
26373
26374 .option server_mail_auth_condition authenticators string&!! unset
26375 This option allows a server to discard authenticated sender addresses supplied
26376 as part of MAIL commands in SMTP connections that are authenticated by the
26377 driver on which &%server_mail_auth_condition%& is set. The option is not used
26378 as part of the authentication process; instead its (unexpanded) value is
26379 remembered for later use.
26380 How it is used is described in the following section.
26381
26382
26383
26384
26385
26386 .section "The AUTH parameter on MAIL commands" "SECTauthparamail"
26387 .cindex "authentication" "sender; authenticated"
26388 .cindex "AUTH" "on MAIL command"
26389 When a client supplied an AUTH= item on a MAIL command, Exim applies
26390 the following checks before accepting it as the authenticated sender of the
26391 message:
26392
26393 .ilist
26394 If the connection is not using extended SMTP (that is, HELO was used rather
26395 than EHLO), the use of AUTH= is a syntax error.
26396 .next
26397 If the value of the AUTH= parameter is &"<>"&, it is ignored.
26398 .next
26399 .vindex "&$authenticated_sender$&"
26400 If &%acl_smtp_mailauth%& is defined, the ACL it specifies is run. While it is
26401 running, the value of &$authenticated_sender$& is set to the value obtained
26402 from the AUTH= parameter. If the ACL does not yield &"accept"&, the value of
26403 &$authenticated_sender$& is deleted. The &%acl_smtp_mailauth%& ACL may not
26404 return &"drop"& or &"discard"&. If it defers, a temporary error code (451) is
26405 given for the MAIL command.
26406 .next
26407 If &%acl_smtp_mailauth%& is not defined, the value of the AUTH= parameter
26408 is accepted and placed in &$authenticated_sender$& only if the client has
26409 authenticated.
26410 .next
26411 If the AUTH= value was accepted by either of the two previous rules, and
26412 the client has authenticated, and the authenticator has a setting for the
26413 &%server_mail_auth_condition%&, the condition is checked at this point. The
26414 valued that was saved from the authenticator is expanded. If the expansion
26415 fails, or yields an empty string, &"0"&, &"no"&, or &"false"&, the value of
26416 &$authenticated_sender$& is deleted. If the expansion yields any other value,
26417 the value of &$authenticated_sender$& is retained and passed on with the
26418 message.
26419 .endlist
26420
26421
26422 When &$authenticated_sender$& is set for a message, it is passed on to other
26423 hosts to which Exim authenticates as a client. Do not confuse this value with
26424 &$authenticated_id$&, which is a string obtained from the authentication
26425 process, and which is not usually a complete email address.
26426
26427 .vindex "&$sender_address$&"
26428 Whenever an AUTH= value is ignored, the incident is logged. The ACL for
26429 MAIL, if defined, is run after AUTH= is accepted or ignored. It can
26430 therefore make use of &$authenticated_sender$&. The converse is not true: the
26431 value of &$sender_address$& is not yet set up when the &%acl_smtp_mailauth%&
26432 ACL is run.
26433
26434
26435
26436 .section "Authentication on an Exim server" "SECTauthexiser"
26437 .cindex "authentication" "on an Exim server"
26438 When Exim receives an EHLO command, it advertises the public names of those
26439 authenticators that are configured as servers, subject to the following
26440 conditions:
26441
26442 .ilist
26443 The client host must match &%auth_advertise_hosts%& (default *).
26444 .next
26445 It the &%server_advertise_condition%& option is set, its expansion must not
26446 yield the empty string, &"0"&, &"no"&, or &"false"&.
26447 .endlist
26448
26449 The order in which the authenticators are defined controls the order in which
26450 the mechanisms are advertised.
26451
26452 Some mail clients (for example, some versions of Netscape) require the user to
26453 provide a name and password for authentication whenever AUTH is advertised,
26454 even though authentication may not in fact be needed (for example, Exim may be
26455 set up to allow unconditional relaying from the client by an IP address check).
26456 You can make such clients more friendly by not advertising AUTH to them.
26457 For example, if clients on the 10.9.8.0/24 network are permitted (by the ACL
26458 that runs for RCPT) to relay without authentication, you should set
26459 .code
26460 auth_advertise_hosts = ! 10.9.8.0/24
26461 .endd
26462 so that no authentication mechanisms are advertised to them.
26463
26464 The &%server_advertise_condition%& controls the advertisement of individual
26465 authentication mechanisms. For example, it can be used to restrict the
26466 advertisement of a particular mechanism to encrypted connections, by a setting
26467 such as:
26468 .code
26469 server_advertise_condition = ${if eq{$tls_in_cipher}{}{no}{yes}}
26470 .endd
26471 .vindex "&$tls_in_cipher$&"
26472 If the session is encrypted, &$tls_in_cipher$& is not empty, and so the expansion
26473 yields &"yes"&, which allows the advertisement to happen.
26474
26475 When an Exim server receives an AUTH command from a client, it rejects it
26476 immediately if AUTH was not advertised in response to an earlier EHLO
26477 command. This is the case if
26478
26479 .ilist
26480 The client host does not match &%auth_advertise_hosts%&; or
26481 .next
26482 No authenticators are configured with server options; or
26483 .next
26484 Expansion of &%server_advertise_condition%& blocked the advertising of all the
26485 server authenticators.
26486 .endlist
26487
26488
26489 Otherwise, Exim runs the ACL specified by &%acl_smtp_auth%& in order
26490 to decide whether to accept the command. If &%acl_smtp_auth%& is not set,
26491 AUTH is accepted from any client host.
26492
26493 If AUTH is not rejected by the ACL, Exim searches its configuration for a
26494 server authentication mechanism that was advertised in response to EHLO and
26495 that matches the one named in the AUTH command. If it finds one, it runs
26496 the appropriate authentication protocol, and authentication either succeeds or
26497 fails. If there is no matching advertised mechanism, the AUTH command is
26498 rejected with a 504 error.
26499
26500 .vindex "&$received_protocol$&"
26501 .vindex "&$sender_host_authenticated$&"
26502 When a message is received from an authenticated host, the value of
26503 &$received_protocol$& is set to &"esmtpa"& or &"esmtpsa"& instead of &"esmtp"&
26504 or &"esmtps"&, and &$sender_host_authenticated$& contains the name (not the
26505 public name) of the authenticator driver that successfully authenticated the
26506 client from which the message was received. This variable is empty if there was
26507 no successful authentication.
26508
26509 .cindex authentication "expansion item"
26510 Successful authentication sets up information used by the
26511 &$authresults$& expansion item.
26512
26513
26514
26515
26516 .section "Testing server authentication" "SECID169"
26517 .cindex "authentication" "testing a server"
26518 .cindex "AUTH" "testing a server"
26519 .cindex "base64 encoding" "creating authentication test data"
26520 Exim's &%-bh%& option can be useful for testing server authentication
26521 configurations. The data for the AUTH command has to be sent using base64
26522 encoding. A quick way to produce such data for testing is the following Perl
26523 script:
26524 .code
26525 use MIME::Base64;
26526 printf ("%s", encode_base64(eval "\"$ARGV[0]\""));
26527 .endd
26528 .cindex "binary zero" "in authentication data"
26529 This interprets its argument as a Perl string, and then encodes it. The
26530 interpretation as a Perl string allows binary zeros, which are required for
26531 some kinds of authentication, to be included in the data. For example, a
26532 command line to run this script on such data might be
26533 .code
26534 encode '\0user\0password'
26535 .endd
26536 Note the use of single quotes to prevent the shell interpreting the
26537 backslashes, so that they can be interpreted by Perl to specify characters
26538 whose code value is zero.
26539
26540 &*Warning 1*&: If either of the user or password strings starts with an octal
26541 digit, you must use three zeros instead of one after the leading backslash. If
26542 you do not, the octal digit that starts your string will be incorrectly
26543 interpreted as part of the code for the first character.
26544
26545 &*Warning 2*&: If there are characters in the strings that Perl interprets
26546 specially, you must use a Perl escape to prevent them being misinterpreted. For
26547 example, a command such as
26548 .code
26549 encode '\0user@domain.com\0pas$$word'
26550 .endd
26551 gives an incorrect answer because of the unescaped &"@"& and &"$"& characters.
26552
26553 If you have the &%mimencode%& command installed, another way to do produce
26554 base64-encoded strings is to run the command
26555 .code
26556 echo -e -n `\0user\0password' | mimencode
26557 .endd
26558 The &%-e%& option of &%echo%& enables the interpretation of backslash escapes
26559 in the argument, and the &%-n%& option specifies no newline at the end of its
26560 output. However, not all versions of &%echo%& recognize these options, so you
26561 should check your version before relying on this suggestion.
26562
26563
26564
26565 .section "Authentication by an Exim client" "SECID170"
26566 .cindex "authentication" "on an Exim client"
26567 The &(smtp)& transport has two options called &%hosts_require_auth%& and
26568 &%hosts_try_auth%&. When the &(smtp)& transport connects to a server that
26569 announces support for authentication, and the host matches an entry in either
26570 of these options, Exim (as a client) tries to authenticate as follows:
26571
26572 .ilist
26573 For each authenticator that is configured as a client, in the order in which
26574 they are defined in the configuration, it searches the authentication
26575 mechanisms announced by the server for one whose name matches the public name
26576 of the authenticator.
26577 .next
26578 .vindex "&$host$&"
26579 .vindex "&$host_address$&"
26580 When it finds one that matches, it runs the authenticator's client code. The
26581 variables &$host$& and &$host_address$& are available for any string expansions
26582 that the client might do. They are set to the server's name and IP address. If
26583 any expansion is forced to fail, the authentication attempt is abandoned, and
26584 Exim moves on to the next authenticator. Otherwise an expansion failure causes
26585 delivery to be deferred.
26586 .next
26587 If the result of the authentication attempt is a temporary error or a timeout,
26588 Exim abandons trying to send the message to the host for the moment. It will
26589 try again later. If there are any backup hosts available, they are tried in the
26590 usual way.
26591 .next
26592 If the response to authentication is a permanent error (5&'xx'& code), Exim
26593 carries on searching the list of authenticators and tries another one if
26594 possible. If all authentication attempts give permanent errors, or if there are
26595 no attempts because no mechanisms match (or option expansions force failure),
26596 what happens depends on whether the host matches &%hosts_require_auth%& or
26597 &%hosts_try_auth%&. In the first case, a temporary error is generated, and
26598 delivery is deferred. The error can be detected in the retry rules, and thereby
26599 turned into a permanent error if you wish. In the second case, Exim tries to
26600 deliver the message unauthenticated.
26601 .endlist
26602
26603 Note that the hostlist test for whether to do authentication can be
26604 confused if name-IP lookups change between the time the peer is decided
26605 upon and the time that the transport runs.  For example, with a manualroute
26606 router given a host name, and with DNS "round-robin" used by that name: if
26607 the local resolver cache times out between the router and the transport
26608 running, the transport may get an IP for the name for its authentication
26609 check which does not match the connection peer IP.
26610 No authentication will then be done, despite the names being identical.
26611
26612 For such cases use a separate transport which always authenticates.
26613
26614 .cindex "AUTH" "on MAIL command"
26615 When Exim has authenticated itself to a remote server, it adds the AUTH
26616 parameter to the MAIL commands it sends, if it has an authenticated sender for
26617 the message. If the message came from a remote host, the authenticated sender
26618 is the one that was receiving on an incoming MAIL command, provided that the
26619 incoming connection was authenticated and the &%server_mail_auth%& condition
26620 allowed the authenticated sender to be retained. If a local process calls Exim
26621 to send a message, the sender address that is built from the login name and
26622 &%qualify_domain%& is treated as authenticated. However, if the
26623 &%authenticated_sender%& option is set on the &(smtp)& transport, it overrides
26624 the authenticated sender that was received with the message.
26625 .ecindex IIDauthconf1
26626 .ecindex IIDauthconf2
26627
26628
26629
26630
26631
26632
26633 . ////////////////////////////////////////////////////////////////////////////
26634 . ////////////////////////////////////////////////////////////////////////////
26635
26636 .chapter "The plaintext authenticator" "CHAPplaintext"
26637 .scindex IIDplaiauth1 "&(plaintext)& authenticator"
26638 .scindex IIDplaiauth2 "authenticators" "&(plaintext)&"
26639 The &(plaintext)& authenticator can be configured to support the PLAIN and
26640 LOGIN authentication mechanisms, both of which transfer authentication data as
26641 plain (unencrypted) text (though base64 encoded). The use of plain text is a
26642 security risk; you are strongly advised to insist on the use of SMTP encryption
26643 (see chapter &<<CHAPTLS>>&) if you use the PLAIN or LOGIN mechanisms. If you do
26644 use unencrypted plain text, you should not use the same passwords for SMTP
26645 connections as you do for login accounts.
26646
26647 .section "Plaintext options" "SECID171"
26648 .cindex "options" "&(plaintext)& authenticator (server)"
26649 When configured as a server, &(plaintext)& uses the following options:
26650
26651 .option server_condition authenticators string&!! unset
26652 This is actually a global authentication option, but it must be set in order to
26653 configure the &(plaintext)& driver as a server. Its use is described below.
26654
26655 .option server_prompts plaintext string&!! unset
26656 The contents of this option, after expansion, must be a colon-separated list of
26657 prompt strings. If expansion fails, a temporary authentication rejection is
26658 given.
26659
26660 .section "Using plaintext in a server" "SECTplainserver"
26661 .cindex "AUTH" "in &(plaintext)& authenticator"
26662 .cindex "binary zero" "in &(plaintext)& authenticator"
26663 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
26664         "in &(plaintext)& authenticator"
26665 .vindex "&$auth1$&, &$auth2$&, etc"
26666 .cindex "base64 encoding" "in &(plaintext)& authenticator"
26667
26668 When running as a server, &(plaintext)& performs the authentication test by
26669 expanding a string. The data sent by the client with the AUTH command, or in
26670 response to subsequent prompts, is base64 encoded, and so may contain any byte
26671 values when decoded. If any data is supplied with the command, it is treated as
26672 a list of strings, separated by NULs (binary zeros), the first three of which
26673 are placed in the expansion variables &$auth1$&, &$auth2$&, and &$auth3$&
26674 (neither LOGIN nor PLAIN uses more than three strings).
26675
26676 For compatibility with previous releases of Exim, the values are also placed in
26677 the expansion variables &$1$&, &$2$&, and &$3$&. However, the use of these
26678 variables for this purpose is now deprecated, as it can lead to confusion in
26679 string expansions that also use them for other things.
26680
26681 If there are more strings in &%server_prompts%& than the number of strings
26682 supplied with the AUTH command, the remaining prompts are used to obtain more
26683 data. Each response from the client may be a list of NUL-separated strings.
26684
26685 .vindex "&$authenticated_id$&"
26686 Once a sufficient number of data strings have been received,
26687 &%server_condition%& is expanded. If the expansion is forced to fail,
26688 authentication fails. Any other expansion failure causes a temporary error code
26689 to be returned. If the result of a successful expansion is an empty string,
26690 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
26691 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
26692 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
26693 For any other result, a temporary error code is returned, with the expanded
26694 string as the error text.
26695
26696 &*Warning*&: If you use a lookup in the expansion to find the user's
26697 password, be sure to make the authentication fail if the user is unknown.
26698 There are good and bad examples at the end of the next section.
26699
26700
26701
26702 .section "The PLAIN authentication mechanism" "SECID172"
26703 .cindex "PLAIN authentication mechanism"
26704 .cindex "authentication" "PLAIN mechanism"
26705 .cindex "binary zero" "in &(plaintext)& authenticator"
26706 The PLAIN authentication mechanism (RFC 2595) specifies that three strings be
26707 sent as one item of data (that is, one combined string containing two NUL
26708 separators). The data is sent either as part of the AUTH command, or
26709 subsequently in response to an empty prompt from the server.
26710
26711 The second and third strings are a user name and a corresponding password.
26712 Using a single fixed user name and password as an example, this could be
26713 configured as follows:
26714 .code
26715 fixed_plain:
26716   driver = plaintext
26717   public_name = PLAIN
26718   server_prompts = :
26719   server_condition = \
26720     ${if and {{eq{$auth2}{username}}{eq{$auth3}{mysecret}}}}
26721   server_set_id = $auth2
26722 .endd
26723 Note that the default result strings from &%if%& (&"true"& or an empty string)
26724 are exactly what we want here, so they need not be specified. Obviously, if the
26725 password contains expansion-significant characters such as dollar, backslash,
26726 or closing brace, they have to be escaped.
26727
26728 The &%server_prompts%& setting specifies a single, empty prompt (empty items at
26729 the end of a string list are ignored). If all the data comes as part of the
26730 AUTH command, as is commonly the case, the prompt is not used. This
26731 authenticator is advertised in the response to EHLO as
26732 .code
26733 250-AUTH PLAIN
26734 .endd
26735 and a client host can authenticate itself by sending the command
26736 .code
26737 AUTH PLAIN AHVzZXJuYW1lAG15c2VjcmV0
26738 .endd
26739 As this contains three strings (more than the number of prompts), no further
26740 data is required from the client. Alternatively, the client may just send
26741 .code
26742 AUTH PLAIN
26743 .endd
26744 to initiate authentication, in which case the server replies with an empty
26745 prompt. The client must respond with the combined data string.
26746
26747 The data string is base64 encoded, as required by the RFC. This example,
26748 when decoded, is <&'NUL'&>&`username`&<&'NUL'&>&`mysecret`&, where <&'NUL'&>
26749 represents a zero byte. This is split up into three strings, the first of which
26750 is empty. The &%server_condition%& option in the authenticator checks that the
26751 second two are &`username`& and &`mysecret`& respectively.
26752
26753 Having just one fixed user name and password, as in this example, is not very
26754 realistic, though for a small organization with only a handful of
26755 authenticating clients it could make sense.
26756
26757 A more sophisticated instance of this authenticator could use the user name in
26758 &$auth2$& to look up a password in a file or database, and maybe do an encrypted
26759 comparison (see &%crypteq%& in chapter &<<CHAPexpand>>&). Here is a example of
26760 this approach, where the passwords are looked up in a DBM file. &*Warning*&:
26761 This is an incorrect example:
26762 .code
26763 server_condition = \
26764   ${if eq{$auth3}{${lookup{$auth2}dbm{/etc/authpwd}}}}
26765 .endd
26766 The expansion uses the user name (&$auth2$&) as the key to look up a password,
26767 which it then compares to the supplied password (&$auth3$&). Why is this example
26768 incorrect? It works fine for existing users, but consider what happens if a
26769 non-existent user name is given. The lookup fails, but as no success/failure
26770 strings are given for the lookup, it yields an empty string. Thus, to defeat
26771 the authentication, all a client has to do is to supply a non-existent user
26772 name and an empty password. The correct way of writing this test is:
26773 .code
26774 server_condition = ${lookup{$auth2}dbm{/etc/authpwd}\
26775   {${if eq{$value}{$auth3}}} {false}}
26776 .endd
26777 In this case, if the lookup succeeds, the result is checked; if the lookup
26778 fails, &"false"& is returned and authentication fails. If &%crypteq%& is being
26779 used instead of &%eq%&, the first example is in fact safe, because &%crypteq%&
26780 always fails if its second argument is empty. However, the second way of
26781 writing the test makes the logic clearer.
26782
26783
26784 .section "The LOGIN authentication mechanism" "SECID173"
26785 .cindex "LOGIN authentication mechanism"
26786 .cindex "authentication" "LOGIN mechanism"
26787 The LOGIN authentication mechanism is not documented in any RFC, but is in use
26788 in a number of programs. No data is sent with the AUTH command. Instead, a
26789 user name and password are supplied separately, in response to prompts. The
26790 plaintext authenticator can be configured to support this as in this example:
26791 .code
26792 fixed_login:
26793   driver = plaintext
26794   public_name = LOGIN
26795   server_prompts = User Name : Password
26796   server_condition = \
26797     ${if and {{eq{$auth1}{username}}{eq{$auth2}{mysecret}}}}
26798   server_set_id = $auth1
26799 .endd
26800 Because of the way plaintext operates, this authenticator accepts data supplied
26801 with the AUTH command (in contravention of the specification of LOGIN), but
26802 if the client does not supply it (as is the case for LOGIN clients), the prompt
26803 strings are used to obtain two data items.
26804
26805 Some clients are very particular about the precise text of the prompts. For
26806 example, Outlook Express is reported to recognize only &"Username:"& and
26807 &"Password:"&. Here is an example of a LOGIN authenticator that uses those
26808 strings. It uses the &%ldapauth%& expansion condition to check the user
26809 name and password by binding to an LDAP server:
26810 .code
26811 login:
26812   driver = plaintext
26813   public_name = LOGIN
26814   server_prompts = Username:: : Password::
26815   server_condition = ${if and{{ \
26816     !eq{}{$auth1} }{ \
26817     ldapauth{\
26818       user="uid=${quote_ldap_dn:$auth1},ou=people,o=example.org" \
26819       pass=${quote:$auth2} \
26820       ldap://ldap.example.org/} }} }
26821   server_set_id = uid=$auth1,ou=people,o=example.org
26822 .endd
26823 We have to check that the username is not empty before using it, because LDAP
26824 does not permit empty DN components. We must also use the &%quote_ldap_dn%&
26825 operator to correctly quote the DN for authentication. However, the basic
26826 &%quote%& operator, rather than any of the LDAP quoting operators, is the
26827 correct one to use for the password, because quoting is needed only to make
26828 the password conform to the Exim syntax. At the LDAP level, the password is an
26829 uninterpreted string.
26830
26831
26832 .section "Support for different kinds of authentication" "SECID174"
26833 A number of string expansion features are provided for the purpose of
26834 interfacing to different ways of user authentication. These include checking
26835 traditionally encrypted passwords from &_/etc/passwd_& (or equivalent), PAM,
26836 Radius, &%ldapauth%&, &'pwcheck'&, and &'saslauthd'&. For details see section
26837 &<<SECTexpcond>>&.
26838
26839
26840
26841
26842 .section "Using plaintext in a client" "SECID175"
26843 .cindex "options" "&(plaintext)& authenticator (client)"
26844 The &(plaintext)& authenticator has two client options:
26845
26846 .option client_ignore_invalid_base64 plaintext boolean false
26847 If the client receives a server prompt that is not a valid base64 string,
26848 authentication is abandoned by default. However, if this option is set true,
26849 the error in the challenge is ignored and the client sends the response as
26850 usual.
26851
26852 .option client_send plaintext string&!! unset
26853 The string is a colon-separated list of authentication data strings. Each
26854 string is independently expanded before being sent to the server. The first
26855 string is sent with the AUTH command; any more strings are sent in response
26856 to prompts from the server. Before each string is expanded, the value of the
26857 most recent prompt is placed in the next &$auth$&<&'n'&> variable, starting
26858 with &$auth1$& for the first prompt. Up to three prompts are stored in this
26859 way. Thus, the prompt that is received in response to sending the first string
26860 (with the AUTH command) can be used in the expansion of the second string, and
26861 so on. If an invalid base64 string is received when
26862 &%client_ignore_invalid_base64%& is set, an empty string is put in the
26863 &$auth$&<&'n'&> variable.
26864
26865 &*Note*&: You cannot use expansion to create multiple strings, because
26866 splitting takes priority and happens first.
26867
26868 Because the PLAIN authentication mechanism requires NUL (binary zero) bytes in
26869 the data, further processing is applied to each string before it is sent. If
26870 there are any single circumflex characters in the string, they are converted to
26871 NULs. Should an actual circumflex be required as data, it must be doubled in
26872 the string.
26873
26874 This is an example of a client configuration that implements the PLAIN
26875 authentication mechanism with a fixed user name and password:
26876 .code
26877 fixed_plain:
26878   driver = plaintext
26879   public_name = PLAIN
26880   client_send = ^username^mysecret
26881 .endd
26882 The lack of colons means that the entire text is sent with the AUTH
26883 command, with the circumflex characters converted to NULs. A similar example
26884 that uses the LOGIN mechanism is:
26885 .code
26886 fixed_login:
26887   driver = plaintext
26888   public_name = LOGIN
26889   client_send = : username : mysecret
26890 .endd
26891 The initial colon means that the first string is empty, so no data is sent with
26892 the AUTH command itself. The remaining strings are sent in response to
26893 prompts.
26894 .ecindex IIDplaiauth1
26895 .ecindex IIDplaiauth2
26896
26897
26898
26899
26900 . ////////////////////////////////////////////////////////////////////////////
26901 . ////////////////////////////////////////////////////////////////////////////
26902
26903 .chapter "The cram_md5 authenticator" "CHID9"
26904 .scindex IIDcramauth1 "&(cram_md5)& authenticator"
26905 .scindex IIDcramauth2 "authenticators" "&(cram_md5)&"
26906 .cindex "CRAM-MD5 authentication mechanism"
26907 .cindex "authentication" "CRAM-MD5 mechanism"
26908 The CRAM-MD5 authentication mechanism is described in RFC 2195. The server
26909 sends a challenge string to the client, and the response consists of a user
26910 name and the CRAM-MD5 digest of the challenge string combined with a secret
26911 string (password) which is known to both server and client. Thus, the secret
26912 is not sent over the network as plain text, which makes this authenticator more
26913 secure than &(plaintext)&. However, the downside is that the secret has to be
26914 available in plain text at either end.
26915
26916
26917 .section "Using cram_md5 as a server" "SECID176"
26918 .cindex "options" "&(cram_md5)& authenticator (server)"
26919 This authenticator has one server option, which must be set to configure the
26920 authenticator as a server:
26921
26922 .option server_secret cram_md5 string&!! unset
26923 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(cram_md5)& authenticator"
26924 When the server receives the client's response, the user name is placed in
26925 the expansion variable &$auth1$&, and &%server_secret%& is expanded to
26926 obtain the password for that user. The server then computes the CRAM-MD5 digest
26927 that the client should have sent, and checks that it received the correct
26928 string. If the expansion of &%server_secret%& is forced to fail, authentication
26929 fails. If the expansion fails for some other reason, a temporary error code is
26930 returned to the client.
26931
26932 For compatibility with previous releases of Exim, the user name is also placed
26933 in &$1$&. However, the use of this variables for this purpose is now
26934 deprecated, as it can lead to confusion in string expansions that also use
26935 numeric variables for other things.
26936
26937 For example, the following authenticator checks that the user name given by the
26938 client is &"ph10"&, and if so, uses &"secret"& as the password. For any other
26939 user name, authentication fails.
26940 .code
26941 fixed_cram:
26942   driver = cram_md5
26943   public_name = CRAM-MD5
26944   server_secret = ${if eq{$auth1}{ph10}{secret}fail}
26945   server_set_id = $auth1
26946 .endd
26947 .vindex "&$authenticated_id$&"
26948 If authentication succeeds, the setting of &%server_set_id%& preserves the user
26949 name in &$authenticated_id$&. A more typical configuration might look up the
26950 secret string in a file, using the user name as the key. For example:
26951 .code
26952 lookup_cram:
26953   driver = cram_md5
26954   public_name = CRAM-MD5
26955   server_secret = ${lookup{$auth1}lsearch{/etc/authpwd}\
26956                   {$value}fail}
26957   server_set_id = $auth1
26958 .endd
26959 Note that this expansion explicitly forces failure if the lookup fails
26960 because &$auth1$& contains an unknown user name.
26961
26962 As another example, if you wish to re-use a Cyrus SASL sasldb2 file without
26963 using the relevant libraries, you need to know the realm to specify in the
26964 lookup and then ask for the &"userPassword"& attribute for that user in that
26965 realm, with:
26966 .code
26967 cyrusless_crammd5:
26968   driver = cram_md5
26969   public_name = CRAM-MD5
26970   server_secret = ${lookup{$auth1:mail.example.org:userPassword}\
26971                   dbmjz{/etc/sasldb2}{$value}fail}
26972   server_set_id = $auth1
26973 .endd
26974
26975 .section "Using cram_md5 as a client" "SECID177"
26976 .cindex "options" "&(cram_md5)& authenticator (client)"
26977 When used as a client, the &(cram_md5)& authenticator has two options:
26978
26979
26980
26981 .option client_name cram_md5 string&!! "the primary host name"
26982 This string is expanded, and the result used as the user name data when
26983 computing the response to the server's challenge.
26984
26985
26986 .option client_secret cram_md5 string&!! unset
26987 This option must be set for the authenticator to work as a client. Its value is
26988 expanded and the result used as the secret string when computing the response.
26989
26990
26991 .vindex "&$host$&"
26992 .vindex "&$host_address$&"
26993 Different user names and secrets can be used for different servers by referring
26994 to &$host$& or &$host_address$& in the options. Forced failure of either
26995 expansion string is treated as an indication that this authenticator is not
26996 prepared to handle this case. Exim moves on to the next configured client
26997 authenticator. Any other expansion failure causes Exim to give up trying to
26998 send the message to the current server.
26999
27000 A simple example configuration of a &(cram_md5)& authenticator, using fixed
27001 strings, is:
27002 .code
27003 fixed_cram:
27004   driver = cram_md5
27005   public_name = CRAM-MD5
27006   client_name = ph10
27007   client_secret = secret
27008 .endd
27009 .ecindex IIDcramauth1
27010 .ecindex IIDcramauth2
27011
27012
27013
27014 . ////////////////////////////////////////////////////////////////////////////
27015 . ////////////////////////////////////////////////////////////////////////////
27016
27017 .chapter "The cyrus_sasl authenticator" "CHID10"
27018 .scindex IIDcyrauth1 "&(cyrus_sasl)& authenticator"
27019 .scindex IIDcyrauth2 "authenticators" "&(cyrus_sasl)&"
27020 .cindex "Cyrus" "SASL library"
27021 .cindex "Kerberos"
27022 The code for this authenticator was provided by Matthew Byng-Maddick while
27023 at A L Digital Ltd.
27024
27025 The &(cyrus_sasl)& authenticator provides server support for the Cyrus SASL
27026 library implementation of the RFC 2222 (&"Simple Authentication and Security
27027 Layer"&). This library supports a number of authentication mechanisms,
27028 including PLAIN and LOGIN, but also several others that Exim does not support
27029 directly. In particular, there is support for Kerberos authentication.
27030
27031 The &(cyrus_sasl)& authenticator provides a gatewaying mechanism directly to
27032 the Cyrus interface, so if your Cyrus library can do, for example, CRAM-MD5,
27033 then so can the &(cyrus_sasl)& authenticator. By default it uses the public
27034 name of the driver to determine which mechanism to support.
27035
27036 Where access to some kind of secret file is required, for example, in GSSAPI
27037 or CRAM-MD5, it is worth noting that the authenticator runs as the Exim
27038 user, and that the Cyrus SASL library has no way of escalating privileges
27039 by default. You may also find you need to set environment variables,
27040 depending on the driver you are using.
27041
27042 The application name provided by Exim is &"exim"&, so various SASL options may
27043 be set in &_exim.conf_& in your SASL directory. If you are using GSSAPI for
27044 Kerberos, note that because of limitations in the GSSAPI interface,
27045 changing the server keytab might need to be communicated down to the Kerberos
27046 layer independently. The mechanism for doing so is dependent upon the Kerberos
27047 implementation.
27048
27049 For example, for older releases of Heimdal, the environment variable KRB5_KTNAME
27050 may be set to point to an alternative keytab file. Exim will pass this
27051 variable through from its own inherited environment when started as root or the
27052 Exim user. The keytab file needs to be readable by the Exim user.
27053 With newer releases of Heimdal, a setuid Exim may cause Heimdal to discard the
27054 environment variable.  In practice, for those releases, the Cyrus authenticator
27055 is not a suitable interface for GSSAPI (Kerberos) support.  Instead, consider
27056 the &(heimdal_gssapi)& authenticator, described in chapter &<<CHAPheimdalgss>>&
27057
27058
27059 .section "Using cyrus_sasl as a server" "SECID178"
27060 The &(cyrus_sasl)& authenticator has four private options. It puts the username
27061 (on a successful authentication) into &$auth1$&. For compatibility with
27062 previous releases of Exim, the username is also placed in &$1$&. However, the
27063 use of this variable for this purpose is now deprecated, as it can lead to
27064 confusion in string expansions that also use numeric variables for other
27065 things.
27066
27067
27068 .option server_hostname cyrus_sasl string&!! "see below"
27069 This option selects the hostname that is used when communicating with the
27070 library. The default value is &`$primary_hostname`&. It is up to the underlying
27071 SASL plug-in what it does with this data.
27072
27073
27074 .option server_mech cyrus_sasl string "see below"
27075 This option selects the authentication mechanism this driver should use. The
27076 default is the value of the generic &%public_name%& option. This option allows
27077 you to use a different underlying mechanism from the advertised name. For
27078 example:
27079 .code
27080 sasl:
27081   driver = cyrus_sasl
27082   public_name = X-ANYTHING
27083   server_mech = CRAM-MD5
27084   server_set_id = $auth1
27085 .endd
27086
27087 .option server_realm cyrus_sasl string&!! unset
27088 This specifies the SASL realm that the server claims to be in.
27089
27090
27091 .option server_service cyrus_sasl string &`smtp`&
27092 This is the SASL service that the server claims to implement.
27093
27094
27095 For straightforward cases, you do not need to set any of the authenticator's
27096 private options. All you need to do is to specify an appropriate mechanism as
27097 the public name. Thus, if you have a SASL library that supports CRAM-MD5 and
27098 PLAIN, you could have two authenticators as follows:
27099 .code
27100 sasl_cram_md5:
27101   driver = cyrus_sasl
27102   public_name = CRAM-MD5
27103   server_set_id = $auth1
27104
27105 sasl_plain:
27106   driver = cyrus_sasl
27107   public_name = PLAIN
27108   server_set_id = $auth2
27109 .endd
27110 Cyrus SASL does implement the LOGIN authentication method, even though it is
27111 not a standard method. It is disabled by default in the source distribution,
27112 but it is present in many binary distributions.
27113 .ecindex IIDcyrauth1
27114 .ecindex IIDcyrauth2
27115
27116
27117
27118
27119 . ////////////////////////////////////////////////////////////////////////////
27120 . ////////////////////////////////////////////////////////////////////////////
27121 .chapter "The dovecot authenticator" "CHAPdovecot"
27122 .scindex IIDdcotauth1 "&(dovecot)& authenticator"
27123 .scindex IIDdcotauth2 "authenticators" "&(dovecot)&"
27124 This authenticator is an interface to the authentication facility of the
27125 Dovecot POP/IMAP server, which can support a number of authentication methods.
27126 Note that Dovecot must be configured to use auth-client not auth-userdb.
27127 If you are using Dovecot to authenticate POP/IMAP clients, it might be helpful
27128 to use the same mechanisms for SMTP authentication. This is a server
27129 authenticator only. There is only one option:
27130
27131 .option server_socket dovecot string unset
27132
27133 This option must specify the UNIX socket that is the interface to Dovecot
27134 authentication. The &%public_name%& option must specify an authentication
27135 mechanism that Dovecot is configured to support. You can have several
27136 authenticators for different mechanisms. For example:
27137 .code
27138 dovecot_plain:
27139   driver = dovecot
27140   public_name = PLAIN
27141   server_socket = /var/run/dovecot/auth-client
27142   server_set_id = $auth1
27143
27144 dovecot_ntlm:
27145   driver = dovecot
27146   public_name = NTLM
27147   server_socket = /var/run/dovecot/auth-client
27148   server_set_id = $auth1
27149 .endd
27150 If the SMTP connection is encrypted, or if &$sender_host_address$& is equal to
27151 &$received_ip_address$& (that is, the connection is local), the &"secured"&
27152 option is passed in the Dovecot authentication command. If, for a TLS
27153 connection, a client certificate has been verified, the &"valid-client-cert"&
27154 option is passed. When authentication succeeds, the identity of the user
27155 who authenticated is placed in &$auth1$&.
27156 .ecindex IIDdcotauth1
27157 .ecindex IIDdcotauth2
27158
27159
27160 . ////////////////////////////////////////////////////////////////////////////
27161 . ////////////////////////////////////////////////////////////////////////////
27162 .chapter "The gsasl authenticator" "CHAPgsasl"
27163 .scindex IIDgsaslauth1 "&(gsasl)& authenticator"
27164 .scindex IIDgsaslauth2 "authenticators" "&(gsasl)&"
27165 .cindex "authentication" "GNU SASL"
27166 .cindex "authentication" "SASL"
27167 .cindex "authentication" "EXTERNAL"
27168 .cindex "authentication" "ANONYMOUS"
27169 .cindex "authentication" "PLAIN"
27170 .cindex "authentication" "LOGIN"
27171 .cindex "authentication" "DIGEST-MD5"
27172 .cindex "authentication" "CRAM-MD5"
27173 .cindex "authentication" "SCRAM-SHA-1"
27174 The &(gsasl)& authenticator provides server integration for the GNU SASL
27175 library and the mechanisms it provides.  This is new as of the 4.80 release
27176 and there are a few areas where the library does not let Exim smoothly
27177 scale to handle future authentication mechanisms, so no guarantee can be
27178 made that any particular new authentication mechanism will be supported
27179 without code changes in Exim.
27180
27181 Exim's &(gsasl)& authenticator does not have client-side support at this
27182 time; only the server-side support is implemented.  Patches welcome.
27183
27184
27185 .option server_channelbinding gsasl boolean false
27186 Do not set this true without consulting a cryptographic engineer.
27187
27188 Some authentication mechanisms are able to use external context at both ends
27189 of the session to bind the authentication to that context, and fail the
27190 authentication process if that context differs.  Specifically, some TLS
27191 ciphersuites can provide identifying information about the cryptographic
27192 context.
27193
27194 This should have meant that certificate identity and verification becomes a
27195 non-issue, as a man-in-the-middle attack will cause the correct client and
27196 server to see different identifiers and authentication will fail.
27197
27198 This is currently only supported when using the GnuTLS library.  This is
27199 only usable by mechanisms which support "channel binding"; at time of
27200 writing, that's the SCRAM family.
27201
27202 This defaults off to ensure smooth upgrade across Exim releases, in case
27203 this option causes some clients to start failing.  Some future release
27204 of Exim might have switched the default to be true.
27205
27206 However, Channel Binding in TLS has proven to be broken in current versions.
27207 Do not plan to rely upon this feature for security, ever, without consulting
27208 with a subject matter expert (a cryptographic engineer).
27209
27210
27211 .option server_hostname gsasl string&!! "see below"
27212 This option selects the hostname that is used when communicating with the
27213 library. The default value is &`$primary_hostname`&.
27214 Some mechanisms will use this data.
27215
27216
27217 .option server_mech gsasl string "see below"
27218 This option selects the authentication mechanism this driver should use. The
27219 default is the value of the generic &%public_name%& option. This option allows
27220 you to use a different underlying mechanism from the advertised name. For
27221 example:
27222 .code
27223 sasl:
27224   driver = gsasl
27225   public_name = X-ANYTHING
27226   server_mech = CRAM-MD5
27227   server_set_id = $auth1
27228 .endd
27229
27230
27231 .option server_password gsasl string&!! unset
27232 Various mechanisms need access to the cleartext password on the server, so
27233 that proof-of-possession can be demonstrated on the wire, without sending
27234 the password itself.
27235
27236 The data available for lookup varies per mechanism.
27237 In all cases, &$auth1$& is set to the &'authentication id'&.
27238 The &$auth2$& variable will always be the &'authorization id'& (&'authz'&)
27239 if available, else the empty string.
27240 The &$auth3$& variable will always be the &'realm'& if available,
27241 else the empty string.
27242
27243 A forced failure will cause authentication to defer.
27244
27245 If using this option, it may make sense to set the &%server_condition%&
27246 option to be simply "true".
27247
27248
27249 .option server_realm gsasl string&!! unset
27250 This specifies the SASL realm that the server claims to be in.
27251 Some mechanisms will use this data.
27252
27253
27254 .option server_scram_iter gsasl string&!! unset
27255 This option provides data for the SCRAM family of mechanisms.
27256 &$auth1$& is not available at evaluation time.
27257 (This may change, as we receive feedback on use)
27258
27259
27260 .option server_scram_salt gsasl string&!! unset
27261 This option provides data for the SCRAM family of mechanisms.
27262 &$auth1$& is not available at evaluation time.
27263 (This may change, as we receive feedback on use)
27264
27265
27266 .option server_service gsasl string &`smtp`&
27267 This is the SASL service that the server claims to implement.
27268 Some mechanisms will use this data.
27269
27270
27271 .section "&(gsasl)& auth variables" "SECTgsaslauthvar"
27272 .vindex "&$auth1$&, &$auth2$&, etc"
27273 These may be set when evaluating specific options, as detailed above.
27274 They will also be set when evaluating &%server_condition%&.
27275
27276 Unless otherwise stated below, the &(gsasl)& integration will use the following
27277 meanings for these variables:
27278
27279 .ilist
27280 .vindex "&$auth1$&"
27281 &$auth1$&: the &'authentication id'&
27282 .next
27283 .vindex "&$auth2$&"
27284 &$auth2$&: the &'authorization id'&
27285 .next
27286 .vindex "&$auth3$&"
27287 &$auth3$&: the &'realm'&
27288 .endlist
27289
27290 On a per-mechanism basis:
27291
27292 .ilist
27293 .cindex "authentication" "EXTERNAL"
27294 EXTERNAL: only &$auth1$& is set, to the possibly empty &'authorization id'&;
27295 the &%server_condition%& option must be present.
27296 .next
27297 .cindex "authentication" "ANONYMOUS"
27298 ANONYMOUS: only &$auth1$& is set, to the possibly empty &'anonymous token'&;
27299 the &%server_condition%& option must be present.
27300 .next
27301 .cindex "authentication" "GSSAPI"
27302 GSSAPI: &$auth1$& will be set to the &'GSSAPI Display Name'&;
27303 &$auth2$& will be set to the &'authorization id'&,
27304 the &%server_condition%& option must be present.
27305 .endlist
27306
27307 An &'anonymous token'& is something passed along as an unauthenticated
27308 identifier; this is analogous to FTP anonymous authentication passing an
27309 email address, or software-identifier@, as the "password".
27310
27311
27312 An example showing the password having the realm specified in the callback
27313 and demonstrating a Cyrus SASL to GSASL migration approach is:
27314 .code
27315 gsasl_cyrusless_crammd5:
27316   driver = gsasl
27317   public_name = CRAM-MD5
27318   server_realm = imap.example.org
27319   server_password = ${lookup{$auth1:$auth3:userPassword}\
27320                     dbmjz{/etc/sasldb2}{$value}fail}
27321   server_set_id = ${quote:$auth1}
27322   server_condition = yes
27323 .endd
27324
27325
27326 . ////////////////////////////////////////////////////////////////////////////
27327 . ////////////////////////////////////////////////////////////////////////////
27328
27329 .chapter "The heimdal_gssapi authenticator" "CHAPheimdalgss"
27330 .scindex IIDheimdalgssauth1 "&(heimdal_gssapi)& authenticator"
27331 .scindex IIDheimdalgssauth2 "authenticators" "&(heimdal_gssapi)&"
27332 .cindex "authentication" "GSSAPI"
27333 .cindex "authentication" "Kerberos"
27334 The &(heimdal_gssapi)& authenticator provides server integration for the
27335 Heimdal GSSAPI/Kerberos library, permitting Exim to set a keytab pathname
27336 reliably.
27337
27338 .option server_hostname heimdal_gssapi string&!! "see below"
27339 This option selects the hostname that is used, with &%server_service%&,
27340 for constructing the GSS server name, as a &'GSS_C_NT_HOSTBASED_SERVICE'&
27341 identifier.  The default value is &`$primary_hostname`&.
27342
27343 .option server_keytab heimdal_gssapi string&!! unset
27344 If set, then Heimdal will not use the system default keytab (typically
27345 &_/etc/krb5.keytab_&) but instead the pathname given in this option.
27346 The value should be a pathname, with no &"file:"& prefix.
27347
27348 .option server_service heimdal_gssapi string&!! "smtp"
27349 This option specifies the service identifier used, in conjunction with
27350 &%server_hostname%&, for building the identifier for finding credentials
27351 from the keytab.
27352
27353
27354 .section "&(heimdal_gssapi)& auth variables" "SECTheimdalgssauthvar"
27355 Beware that these variables will typically include a realm, thus will appear
27356 to be roughly like an email address already.  The &'authzid'& in &$auth2$& is
27357 not verified, so a malicious client can set it to anything.
27358
27359 The &$auth1$& field should be safely trustable as a value from the Key
27360 Distribution Center.  Note that these are not quite email addresses.
27361 Each identifier is for a role, and so the left-hand-side may include a
27362 role suffix.  For instance, &"joe/admin@EXAMPLE.ORG"&.
27363
27364 .vindex "&$auth1$&, &$auth2$&, etc"
27365 .ilist
27366 .vindex "&$auth1$&"
27367 &$auth1$&: the &'authentication id'&, set to the GSS Display Name.
27368 .next
27369 .vindex "&$auth2$&"
27370 &$auth2$&: the &'authorization id'&, sent within SASL encapsulation after
27371 authentication.  If that was empty, this will also be set to the
27372 GSS Display Name.
27373 .endlist
27374
27375
27376 . ////////////////////////////////////////////////////////////////////////////
27377 . ////////////////////////////////////////////////////////////////////////////
27378
27379 .chapter "The spa authenticator" "CHAPspa"
27380 .scindex IIDspaauth1 "&(spa)& authenticator"
27381 .scindex IIDspaauth2 "authenticators" "&(spa)&"
27382 .cindex "authentication" "Microsoft Secure Password"
27383 .cindex "authentication" "NTLM"
27384 .cindex "Microsoft Secure Password Authentication"
27385 .cindex "NTLM authentication"
27386 The &(spa)& authenticator provides client support for Microsoft's &'Secure
27387 Password Authentication'& mechanism,
27388 which is also sometimes known as NTLM (NT LanMan). The code for client side of
27389 this authenticator was contributed by Marc Prud'hommeaux, and much of it is
27390 taken from the Samba project (&url(https://www.samba.org/)). The code for the
27391 server side was subsequently contributed by Tom Kistner. The mechanism works as
27392 follows:
27393
27394 .ilist
27395 After the AUTH command has been accepted, the client sends an SPA
27396 authentication request based on the user name and optional domain.
27397 .next
27398 The server sends back a challenge.
27399 .next
27400 The client builds a challenge response which makes use of the user's password
27401 and sends it to the server, which then accepts or rejects it.
27402 .endlist
27403
27404 Encryption is used to protect the password in transit.
27405
27406
27407
27408 .section "Using spa as a server" "SECID179"
27409 .cindex "options" "&(spa)& authenticator (server)"
27410 The &(spa)& authenticator has just one server option:
27411
27412 .option server_password spa string&!! unset
27413 .cindex "numerical variables (&$1$& &$2$& etc)" "in &(spa)& authenticator"
27414 This option is expanded, and the result must be the cleartext password for the
27415 authenticating user, whose name is at this point in &$auth1$&. For
27416 compatibility with previous releases of Exim, the user name is also placed in
27417 &$1$&. However, the use of this variable for this purpose is now deprecated, as
27418 it can lead to confusion in string expansions that also use numeric variables
27419 for other things. For example:
27420 .code
27421 spa:
27422   driver = spa
27423   public_name = NTLM
27424   server_password = \
27425     ${lookup{$auth1}lsearch{/etc/exim/spa_clearpass}{$value}fail}
27426 .endd
27427 If the expansion is forced to fail, authentication fails. Any other expansion
27428 failure causes a temporary error code to be returned.
27429
27430
27431
27432
27433
27434 .section "Using spa as a client" "SECID180"
27435 .cindex "options" "&(spa)& authenticator (client)"
27436 The &(spa)& authenticator has the following client options:
27437
27438
27439
27440 .option client_domain spa string&!! unset
27441 This option specifies an optional domain for the authentication.
27442
27443
27444 .option client_password spa string&!! unset
27445 This option specifies the user's password, and must be set.
27446
27447
27448 .option client_username spa string&!! unset
27449 This option specifies the user name, and must be set. Here is an example of a
27450 configuration of this authenticator for use with the mail servers at
27451 &'msn.com'&:
27452 .code
27453 msn:
27454   driver = spa
27455   public_name = MSN
27456   client_username = msn/msn_username
27457   client_password = msn_plaintext_password
27458   client_domain = DOMAIN_OR_UNSET
27459 .endd
27460 .ecindex IIDspaauth1
27461 .ecindex IIDspaauth2
27462
27463
27464
27465
27466
27467 . ////////////////////////////////////////////////////////////////////////////
27468 . ////////////////////////////////////////////////////////////////////////////
27469
27470 .chapter "The external authenticator" "CHAPexternauth"
27471 .scindex IIDexternauth1 "&(external)& authenticator"
27472 .scindex IIDexternauth2 "authenticators" "&(external)&"
27473 .cindex "authentication" "Client Certificate"
27474 .cindex "authentication" "X509"
27475 .cindex "Certificate-based authentication"
27476 The &(external)& authenticator provides support for
27477 authentication based on non-SMTP information.
27478 The specification is in RFC 4422 Appendix A
27479 (&url(https://tools.ietf.org/html/rfc4422)).
27480 It is only a transport and negotiation mechanism;
27481 the process of authentication is entirely controlled
27482 by the server configuration.
27483
27484 The client presents an identity in-clear.
27485 It is probably wise for a server to only advertise,
27486 and for clients to only attempt,
27487 this authentication method on a secure (eg. under TLS) connection.
27488
27489 One possible use, compatible with the
27490 K-9 Mail Andoid client (&url(https://k9mail.github.io/)),
27491 is for using X509 client certificates.
27492
27493 It thus overlaps in function with the TLS authenticator
27494 (see &<<CHAPtlsauth>>&)
27495 but is a full SMTP SASL authenticator
27496 rather than being implicit for TLS-connection carried
27497 client certificates only.
27498
27499 The examples and discussion in this chapter assume that
27500 client-certificate authentication is being done.
27501
27502 The client must present a certificate,
27503 for which it must have been requested via the
27504 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27505 (see &<<CHAPTLS>>&).
27506 For authentication to be effective the certificate should be
27507 verifiable against a trust-anchor certificate known to the server.
27508
27509 .section "External options" "SECTexternsoptions"
27510 .cindex "options" "&(external)& authenticator (server)"
27511 The &(external)& authenticator has two server options:
27512
27513 .option server_param2 external string&!! unset
27514 .option server_param3 external string&!! unset
27515 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(external)& authenticator"
27516 These options are expanded before the &%server_condition%& option
27517 and the result are placed in &$auth2$& and &$auth3$& resectively.
27518 If the expansion is forced to fail, authentication fails. Any other expansion
27519 failure causes a temporary error code to be returned.
27520
27521 They can be used to clarify the coding of a complex &%server_condition%&.
27522
27523 .section "Using external in a server" "SECTexternserver"
27524 .cindex "AUTH" "in &(external)& authenticator"
27525 .cindex "numerical variables (&$1$& &$2$& etc)" &&&
27526         "in &(external)& authenticator"
27527 .vindex "&$auth1$&, &$auth2$&, etc"
27528 .cindex "base64 encoding" "in &(external)& authenticator"
27529
27530 When running as a server, &(external)& performs the authentication test by
27531 expanding a string. The data sent by the client with the AUTH command, or in
27532 response to subsequent prompts, is base64 encoded, and so may contain any byte
27533 values when decoded. The decoded value is treated as
27534 an identity for authentication and
27535 placed in the expansion variable &$auth1$&.
27536
27537 For compatibility with previous releases of Exim, the value is also placed in
27538 the expansion variable &$1$&. However, the use of this
27539 variable for this purpose is now deprecated, as it can lead to confusion in
27540 string expansions that also use them for other things.
27541
27542 .vindex "&$authenticated_id$&"
27543 Once an identity has been received,
27544 &%server_condition%& is expanded. If the expansion is forced to fail,
27545 authentication fails. Any other expansion failure causes a temporary error code
27546 to be returned. If the result of a successful expansion is an empty string,
27547 &"0"&, &"no"&, or &"false"&, authentication fails. If the result of the
27548 expansion is &"1"&, &"yes"&, or &"true"&, authentication succeeds and the
27549 generic &%server_set_id%& option is expanded and saved in &$authenticated_id$&.
27550 For any other result, a temporary error code is returned, with the expanded
27551 string as the error text.
27552
27553 Example:
27554 .code
27555 ext_ccert_san_mail:
27556   driver =            external
27557   public_name =       EXTERNAL
27558
27559   server_advertise_condition = $tls_in_certificate_verified
27560   server_param2 =     ${certextract {subj_altname,mail,>:} \
27561                                     {$tls_in_peercert}}
27562   server_condition =  ${if forany {$auth2} \
27563                             {eq {$item}{$auth1}}}
27564   server_set_id =     $auth1
27565 .endd
27566 This accepts a client certificate that is verifiable against any
27567 of your configured trust-anchors
27568 (which usually means the full set of public CAs)
27569 and which has a mail-SAN matching the claimed identity sent by the client.
27570
27571 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27572 The account name is therefore guessable by an opponent.
27573 TLS 1.3 protects both server and client certificates, and is not vulnerable
27574 in this way.
27575 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27576
27577
27578 .section "Using external in a client" "SECTexternclient"
27579 .cindex "options" "&(external)& authenticator (client)"
27580 The &(external)& authenticator has one client option:
27581
27582 .option client_send external string&!! unset
27583 This option is expanded and sent with the AUTH command as the
27584 identity being asserted.
27585
27586 Example:
27587 .code
27588 ext_ccert:
27589   driver =      external
27590   public_name = EXTERNAL
27591
27592   client_condition = ${if !eq{$tls_out_cipher}{}}
27593   client_send = myaccount@smarthost.example.net
27594 .endd
27595
27596
27597 .ecindex IIDexternauth1
27598 .ecindex IIDexternauth2
27599
27600
27601
27602
27603
27604 . ////////////////////////////////////////////////////////////////////////////
27605 . ////////////////////////////////////////////////////////////////////////////
27606
27607 .chapter "The tls authenticator" "CHAPtlsauth"
27608 .scindex IIDtlsauth1 "&(tls)& authenticator"
27609 .scindex IIDtlsauth2 "authenticators" "&(tls)&"
27610 .cindex "authentication" "Client Certificate"
27611 .cindex "authentication" "X509"
27612 .cindex "Certificate-based authentication"
27613 The &(tls)& authenticator provides server support for
27614 authentication based on client certificates.
27615
27616 It is not an SMTP authentication mechanism and is not
27617 advertised by the server as part of the SMTP EHLO response.
27618 It is an Exim authenticator in the sense that it affects
27619 the protocol element of the log line, can be tested for
27620 by the &%authenticated%& ACL condition, and can set
27621 the &$authenticated_id$& variable.
27622
27623 The client must present a verifiable certificate,
27624 for which it must have been requested via the
27625 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& main options
27626 (see &<<CHAPTLS>>&).
27627
27628 If an authenticator of this type is configured it is
27629 run before any SMTP-level communication is done,
27630 and can authenticate the connection.
27631 If it does, SMTP authentication is not offered.
27632
27633 A maximum of one authenticator of this type may be present.
27634
27635
27636 .cindex "options" "&(tls)& authenticator (server)"
27637 The &(tls)& authenticator has three server options:
27638
27639 .option server_param1 tls string&!! unset
27640 .cindex "variables (&$auth1$& &$auth2$& etc)" "in &(tls)& authenticator"
27641 This option is expanded after the TLS negotiation and
27642 the result is placed in &$auth1$&.
27643 If the expansion is forced to fail, authentication fails. Any other expansion
27644 failure causes a temporary error code to be returned.
27645
27646 .option server_param2 tls string&!! unset
27647 .option server_param3 tls string&!! unset
27648 As above, for &$auth2$& and &$auth3$&.
27649
27650 &%server_param1%& may also be spelled &%server_param%&.
27651
27652
27653 Example:
27654 .code
27655 tls:
27656   driver = tls
27657   server_param1 =     ${certextract {subj_altname,mail,>:} \
27658                                     {$tls_in_peercert}}
27659   server_condition =  ${if and { {eq{$tls_in_certificate_verified}{1}} \
27660                                  {forany {$auth1} \
27661                             {!= {0} \
27662                                 {${lookup ldap{ldap:///\
27663                          mailname=${quote_ldap_dn:${lc:$item}},\
27664                          ou=users,LDAP_DC?mailid} {$value}{0} \
27665                        }    }  } }}}
27666   server_set_id =     ${if = {1}{${listcount:$auth1}} {$auth1}{}}
27667 .endd
27668 This accepts a client certificate that is verifiable against any
27669 of your configured trust-anchors
27670 (which usually means the full set of public CAs)
27671 and which has a SAN with a good account name.
27672
27673 Note that, up to TLS1.2, the client cert is on the wire in-clear, including the SAN,
27674 The account name is therefore guessable by an opponent.
27675 TLS 1.3 protects both server and client certificates, and is not vulnerable
27676 in this way.
27677 Likewise, a traditional plaintext SMTP AUTH done inside TLS is not.
27678
27679 . An alternative might use
27680 . .code
27681 .   server_param1 = ${sha256:$tls_in_peercert}
27682 . .endd
27683 . to require one of a set of specific certs that define a given account
27684 . (the verification is still required, but mostly irrelevant).
27685 . This would help for per-device use.
27686 .
27687 . However, for the future we really need support for checking a
27688 . user cert in LDAP - which probably wants a base-64 DER.
27689
27690 .ecindex IIDtlsauth1
27691 .ecindex IIDtlsauth2
27692
27693
27694 Note that because authentication is traditionally an SMTP operation,
27695 the &%authenticated%& ACL condition cannot be used in
27696 a connect- or helo-ACL.
27697
27698
27699
27700 . ////////////////////////////////////////////////////////////////////////////
27701 . ////////////////////////////////////////////////////////////////////////////
27702
27703 .chapter "Encrypted SMTP connections using TLS/SSL" "CHAPTLS" &&&
27704          "Encrypted SMTP connections"
27705 .scindex IIDencsmtp1 "encryption" "on SMTP connection"
27706 .scindex IIDencsmtp2 "SMTP" "encryption"
27707 .cindex "TLS" "on SMTP connection"
27708 .cindex "OpenSSL"
27709 .cindex "GnuTLS"
27710 Support for TLS (Transport Layer Security), formerly known as SSL (Secure
27711 Sockets Layer), is implemented by making use of the OpenSSL library or the
27712 GnuTLS library (Exim requires GnuTLS release 1.0 or later). There is no
27713 cryptographic code in the Exim distribution itself for implementing TLS. In
27714 order to use this feature you must install OpenSSL or GnuTLS, and then build a
27715 version of Exim that includes TLS support (see section &<<SECTinctlsssl>>&).
27716 You also need to understand the basic concepts of encryption at a managerial
27717 level, and in particular, the way that public keys, private keys, and
27718 certificates are used.
27719
27720 RFC 3207 defines how SMTP connections can make use of encryption. Once a
27721 connection is established, the client issues a STARTTLS command. If the
27722 server accepts this, the client and the server negotiate an encryption
27723 mechanism. If the negotiation succeeds, the data that subsequently passes
27724 between them is encrypted.
27725
27726 Exim's ACLs can detect whether the current SMTP session is encrypted or not,
27727 and if so, what cipher suite is in use, whether the client supplied a
27728 certificate, and whether or not that certificate was verified. This makes it
27729 possible for an Exim server to deny or accept certain commands based on the
27730 encryption state.
27731
27732 &*Warning*&: Certain types of firewall and certain anti-virus products can
27733 disrupt TLS connections. You need to turn off SMTP scanning for these products
27734 in order to get TLS to work.
27735
27736
27737
27738 .section "Support for the &""submissions""& (aka &""ssmtp""& and &""smtps""&) protocol" &&&
27739          "SECID284"
27740 .cindex "submissions protocol"
27741 .cindex "ssmtp protocol"
27742 .cindex "smtps protocol"
27743 .cindex "SMTP" "submissions protocol"
27744 .cindex "SMTP" "ssmtp protocol"
27745 .cindex "SMTP" "smtps protocol"
27746 The history of port numbers for TLS in SMTP is a little messy and has been
27747 contentious.  As of RFC 8314, the common practice of using the historically
27748 allocated port 465 for "email submission but with TLS immediately upon connect
27749 instead of using STARTTLS" is officially blessed by the IETF, and recommended
27750 by them in preference to STARTTLS.
27751
27752 The name originally assigned to the port was &"ssmtp"& or &"smtps"&, but as
27753 clarity emerged over the dual roles of SMTP, for MX delivery and Email
27754 Submission, nomenclature has shifted.  The modern name is now &"submissions"&.
27755
27756 This approach was, for a while, officially abandoned when encrypted SMTP was
27757 standardized, but many clients kept using it, even as the TCP port number was
27758 reassigned for other use.
27759 Thus you may encounter guidance claiming that you shouldn't enable use of
27760 this port.
27761 In practice, a number of mail-clients have only ever supported submissions,
27762 not submission with STARTTLS upgrade.
27763 Ideally, offer both submission (587) and submissions (465) service.
27764
27765 Exim supports TLS-on-connect by means of the &%tls_on_connect_ports%&
27766 global option. Its value must be a list of port numbers;
27767 the most common use is expected to be:
27768 .code
27769 tls_on_connect_ports = 465
27770 .endd
27771 The port numbers specified by this option apply to all SMTP connections, both
27772 via the daemon and via &'inetd'&. You still need to specify all the ports that
27773 the daemon uses (by setting &%daemon_smtp_ports%& or &%local_interfaces%& or
27774 the &%-oX%& command line option) because &%tls_on_connect_ports%& does not add
27775 an extra port &-- rather, it specifies different behaviour on a port that is
27776 defined elsewhere.
27777
27778 There is also a &%-tls-on-connect%& command line option. This overrides
27779 &%tls_on_connect_ports%&; it forces the TLS-only behaviour for all ports.
27780
27781
27782
27783
27784
27785
27786 .section "OpenSSL vs GnuTLS" "SECTopenvsgnu"
27787 .cindex "TLS" "OpenSSL &'vs'& GnuTLS"
27788 The first TLS support in Exim was implemented using OpenSSL. Support for GnuTLS
27789 followed later, when the first versions of GnuTLS were released. To build Exim
27790 to use GnuTLS, you need to set
27791 .code
27792 USE_GNUTLS=yes
27793 .endd
27794 in Local/Makefile, in addition to
27795 .code
27796 SUPPORT_TLS=yes
27797 .endd
27798 You must also set TLS_LIBS and TLS_INCLUDE appropriately, so that the
27799 include files and libraries for GnuTLS can be found.
27800
27801 There are some differences in usage when using GnuTLS instead of OpenSSL:
27802
27803 .ilist
27804 The &%tls_verify_certificates%& option
27805 cannot be the path of a directory
27806 for GnuTLS versions before 3.3.6
27807 (for later versions, or OpenSSL, it can be either).
27808 .next
27809 The default value for &%tls_dhparam%& differs for historical reasons.
27810 .next
27811 .vindex "&$tls_in_peerdn$&"
27812 .vindex "&$tls_out_peerdn$&"
27813 Distinguished Name (DN) strings reported by the OpenSSL library use a slash for
27814 separating fields; GnuTLS uses commas, in accordance with RFC 2253. This
27815 affects the value of the &$tls_in_peerdn$& and &$tls_out_peerdn$& variables.
27816 .next
27817 OpenSSL identifies cipher suites using hyphens as separators, for example:
27818 DES-CBC3-SHA. GnuTLS historically used underscores, for example:
27819 RSA_ARCFOUR_SHA. What is more, OpenSSL complains if underscores are present
27820 in a cipher list. To make life simpler, Exim changes underscores to hyphens
27821 for OpenSSL and passes the string unchanged to GnuTLS (expecting the library
27822 to handle its own older variants) when processing lists of cipher suites in the
27823 &%tls_require_ciphers%& options (the global option and the &(smtp)& transport
27824 option).
27825 .next
27826 The &%tls_require_ciphers%& options operate differently, as described in the
27827 sections &<<SECTreqciphssl>>& and &<<SECTreqciphgnu>>&.
27828 .next
27829 The &%tls_dh_min_bits%& SMTP transport option is only honoured by GnuTLS.
27830 When using OpenSSL, this option is ignored.
27831 (If an API is found to let OpenSSL be configured in this way,
27832 let the Exim Maintainers know and we'll likely use it).
27833 .next
27834 With GnuTLS, if an explicit list is used for the &%tls_privatekey%& main option
27835 main option, it must be ordered to match the &%tls_certificate%& list.
27836 .next
27837 Some other recently added features may only be available in one or the other.
27838 This should be documented with the feature.  If the documentation does not
27839 explicitly state that the feature is infeasible in the other TLS
27840 implementation, then patches are welcome.
27841 .endlist
27842
27843
27844 .section "GnuTLS parameter computation" "SECTgnutlsparam"
27845 This section only applies if &%tls_dhparam%& is set to &`historic`& or to
27846 an explicit path; if the latter, then the text about generation still applies,
27847 but not the chosen filename.
27848 By default, as of Exim 4.80 a hard-coded D-H prime is used.
27849 See the documentation of &%tls_dhparam%& for more information.
27850
27851 GnuTLS uses D-H parameters that may take a substantial amount of time
27852 to compute. It is unreasonable to re-compute them for every TLS session.
27853 Therefore, Exim keeps this data in a file in its spool directory, called
27854 &_gnutls-params-NNNN_& for some value of NNNN, corresponding to the number
27855 of bits requested.
27856 The file is owned by the Exim user and is readable only by
27857 its owner. Every Exim process that start up GnuTLS reads the D-H
27858 parameters from this file. If the file does not exist, the first Exim process
27859 that needs it computes the data and writes it to a temporary file which is
27860 renamed once it is complete. It does not matter if several Exim processes do
27861 this simultaneously (apart from wasting a few resources). Once a file is in
27862 place, new Exim processes immediately start using it.
27863
27864 For maximum security, the parameters that are stored in this file should be
27865 recalculated periodically, the frequency depending on your paranoia level.
27866 If you are avoiding using the fixed D-H primes published in RFCs, then you
27867 are concerned about some advanced attacks and will wish to do this; if you do
27868 not regenerate then you might as well stick to the standard primes.
27869
27870 Arranging this is easy in principle; just delete the file when you want new
27871 values to be computed. However, there may be a problem. The calculation of new
27872 parameters needs random numbers, and these are obtained from &_/dev/random_&.
27873 If the system is not very active, &_/dev/random_& may delay returning data
27874 until enough randomness (entropy) is available. This may cause Exim to hang for
27875 a substantial amount of time, causing timeouts on incoming connections.
27876
27877 The solution is to generate the parameters externally to Exim. They are stored
27878 in &_gnutls-params-N_& in PEM format, which means that they can be
27879 generated externally using the &(certtool)& command that is part of GnuTLS.
27880
27881 To replace the parameters with new ones, instead of deleting the file
27882 and letting Exim re-create it, you can generate new parameters using
27883 &(certtool)& and, when this has been done, replace Exim's cache file by
27884 renaming. The relevant commands are something like this:
27885 .code
27886 # ls
27887 [ look for file; assume gnutls-params-2236 is the most recent ]
27888 # rm -f new-params
27889 # touch new-params
27890 # chown exim:exim new-params
27891 # chmod 0600 new-params
27892 # certtool --generate-dh-params --bits 2236 >>new-params
27893 # openssl dhparam -noout -text -in new-params | head
27894 [ check the first line, make sure it's not more than 2236;
27895   if it is, then go back to the start ("rm") and repeat
27896   until the size generated is at most the size requested ]
27897 # chmod 0400 new-params
27898 # mv new-params gnutls-params-2236
27899 .endd
27900 If Exim never has to generate the parameters itself, the possibility of
27901 stalling is removed.
27902
27903 The filename changed in Exim 4.80, to gain the -bits suffix.  The value which
27904 Exim will choose depends upon the version of GnuTLS in use.  For older GnuTLS,
27905 the value remains hard-coded in Exim as 1024.  As of GnuTLS 2.12.x, there is
27906 a way for Exim to ask for the "normal" number of bits for D-H public-key usage,
27907 and Exim does so.  This attempt to remove Exim from TLS policy decisions
27908 failed, as GnuTLS 2.12 returns a value higher than the current hard-coded limit
27909 of the NSS library.  Thus Exim gains the &%tls_dh_max_bits%& global option,
27910 which applies to all D-H usage, client or server.  If the value returned by
27911 GnuTLS is greater than &%tls_dh_max_bits%& then the value will be clamped down
27912 to &%tls_dh_max_bits%&.  The default value has been set at the current NSS
27913 limit, which is still much higher than Exim historically used.
27914
27915 The filename and bits used will change as the GnuTLS maintainers change the
27916 value for their parameter &`GNUTLS_SEC_PARAM_NORMAL`&, as clamped by
27917 &%tls_dh_max_bits%&.  At the time of writing (mid 2012), GnuTLS 2.12 recommends
27918 2432 bits, while NSS is limited to 2236 bits.
27919
27920 In fact, the requested value will be *lower* than &%tls_dh_max_bits%&, to
27921 increase the chance of the generated prime actually being within acceptable
27922 bounds, as GnuTLS has been observed to overshoot.  Note the check step in the
27923 procedure above.  There is no sane procedure available to Exim to double-check
27924 the size of the generated prime, so it might still be too large.
27925
27926
27927 .section "Requiring specific ciphers in OpenSSL" "SECTreqciphssl"
27928 .cindex "TLS" "requiring specific ciphers (OpenSSL)"
27929 .oindex "&%tls_require_ciphers%&" "OpenSSL"
27930 There is a function in the OpenSSL library that can be passed a list of cipher
27931 suites before the cipher negotiation takes place. This specifies which ciphers
27932 are acceptable for TLS versions prior to 1.3.
27933 The list is colon separated and may contain names like
27934 DES-CBC3-SHA. Exim passes the expanded value of &%tls_require_ciphers%&
27935 directly to this function call.
27936 Many systems will install the OpenSSL manual-pages, so you may have
27937 &'ciphers(1)'& available to you.
27938 The following quotation from the OpenSSL
27939 documentation specifies what forms of item are allowed in the cipher string:
27940
27941 .ilist
27942 It can consist of a single cipher suite such as RC4-SHA.
27943 .next
27944 It can represent a list of cipher suites containing a certain algorithm,
27945 or cipher suites of a certain type. For example SHA1 represents all
27946 ciphers suites using the digest algorithm SHA1 and SSLv3 represents all
27947 SSL v3 algorithms.
27948 .next
27949 Lists of cipher suites can be combined in a single cipher string using
27950 the + character. This is used as a logical and operation. For example
27951 SHA1+DES represents all cipher suites containing the SHA1 and the DES
27952 algorithms.
27953 .endlist
27954
27955 Each cipher string can be optionally preceded by one of the characters &`!`&,
27956 &`-`& or &`+`&.
27957 .ilist
27958 If &`!`& is used, the ciphers are permanently deleted from the list. The
27959 ciphers deleted can never reappear in the list even if they are explicitly
27960 stated.
27961 .next
27962 If &`-`& is used, the ciphers are deleted from the list, but some or all
27963 of the ciphers can be added again by later options.
27964 .next
27965 If &`+`& is used, the ciphers are moved to the end of the list. This
27966 option does not add any new ciphers; it just moves matching existing ones.
27967 .endlist
27968
27969 If none of these characters is present, the string is interpreted as
27970 a list of ciphers to be appended to the current preference list. If the list
27971 includes any ciphers already present they will be ignored: that is, they will
27972 not be moved to the end of the list.
27973 .endlist
27974
27975 The OpenSSL &'ciphers(1)'& command may be used to test the results of a given
27976 string:
27977 .code
27978 # note single-quotes to get ! past any shell history expansion
27979 $ openssl ciphers 'HIGH:!MD5:!SHA1'
27980 .endd
27981
27982 This example will let the library defaults be permitted on the MX port, where
27983 there's probably no identity verification anyway, but ups the ante on the
27984 submission ports where the administrator might have some influence on the
27985 choice of clients used:
27986 .code
27987 # OpenSSL variant; see man ciphers(1)
27988 tls_require_ciphers = ${if =={$received_port}{25}\
27989                            {DEFAULT}\
27990                            {HIGH:!MD5:!SHA1}}
27991 .endd
27992
27993 This example will prefer ECDSA-authenticated ciphers over RSA ones:
27994 .code
27995 tls_require_ciphers = ECDSA:RSA:!COMPLEMENTOFDEFAULT
27996 .endd
27997
27998 For TLS version 1.3 the control available is less fine-grained
27999 and Exim does not provide access to it at present.
28000 The value of the &%tls_require_ciphers%& option is ignored when
28001 TLS version 1.3 is negotiated.
28002
28003 As of writing the library default cipher suite list for TLSv1.3 is
28004 .code
28005 TLS_AES_256_GCM_SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS_AES_128_GCM_SHA256
28006 .endd
28007
28008
28009 .section "Requiring specific ciphers or other parameters in GnuTLS" &&&
28010          "SECTreqciphgnu"
28011 .cindex "GnuTLS" "specifying parameters for"
28012 .cindex "TLS" "specifying ciphers (GnuTLS)"
28013 .cindex "TLS" "specifying key exchange methods (GnuTLS)"
28014 .cindex "TLS" "specifying MAC algorithms (GnuTLS)"
28015 .cindex "TLS" "specifying protocols (GnuTLS)"
28016 .cindex "TLS" "specifying priority string (GnuTLS)"
28017 .oindex "&%tls_require_ciphers%&" "GnuTLS"
28018 The GnuTLS library allows the caller to provide a "priority string", documented
28019 as part of the &[gnutls_priority_init]& function.  This is very similar to the
28020 ciphersuite specification in OpenSSL.
28021
28022 The &%tls_require_ciphers%& option is treated as the GnuTLS priority string
28023 and controls both protocols and ciphers.
28024
28025 The &%tls_require_ciphers%& option is available both as an global option,
28026 controlling how Exim behaves as a server, and also as an option of the
28027 &(smtp)& transport, controlling how Exim behaves as a client.  In both cases
28028 the value is string expanded.  The resulting string is not an Exim list and
28029 the string is given to the GnuTLS library, so that Exim does not need to be
28030 aware of future feature enhancements of GnuTLS.
28031
28032 Documentation of the strings accepted may be found in the GnuTLS manual, under
28033 "Priority strings".  This is online as
28034 &url(https://www.gnutls.org/manual/html_node/Priority-Strings.html),
28035 but beware that this relates to GnuTLS 3, which may be newer than the version
28036 installed on your system.  If you are using GnuTLS 3,
28037 then the example code
28038 &url(https://www.gnutls.org/manual/gnutls.html#Listing-the-ciphersuites-in-a-priority-string)
28039 on that site can be used to test a given string.
28040
28041 For example:
28042 .code
28043 # Disable older versions of protocols
28044 tls_require_ciphers = NORMAL:%LATEST_RECORD_VERSION:-VERS-SSL3.0
28045 .endd
28046
28047 Prior to Exim 4.80, an older API of GnuTLS was used, and Exim supported three
28048 additional options, "&%gnutls_require_kx%&", "&%gnutls_require_mac%&" and
28049 "&%gnutls_require_protocols%&".  &%tls_require_ciphers%& was an Exim list.
28050
28051 This example will let the library defaults be permitted on the MX port, where
28052 there's probably no identity verification anyway, and lowers security further
28053 by increasing compatibility; but this ups the ante on the submission ports
28054 where the administrator might have some influence on the choice of clients
28055 used:
28056 .code
28057 # GnuTLS variant
28058 tls_require_ciphers = ${if =={$received_port}{25}\
28059                            {NORMAL:%COMPAT}\
28060                            {SECURE128}}
28061 .endd
28062
28063
28064 .section "Configuring an Exim server to use TLS" "SECID182"
28065 .cindex "TLS" "configuring an Exim server"
28066 When Exim has been built with TLS support, it advertises the availability of
28067 the STARTTLS command to client hosts that match &%tls_advertise_hosts%&,
28068 but not to any others. The default value of this option is *, which means
28069 that STARTTLS is always advertised.  Set it to blank to never advertise;
28070 this is reasonable for systems that want to use TLS only as a client.
28071
28072 If STARTTLS is to be used you
28073 need to set some other options in order to make TLS available.
28074
28075 If a client issues a STARTTLS command and there is some configuration
28076 problem in the server, the command is rejected with a 454 error. If the client
28077 persists in trying to issue SMTP commands, all except QUIT are rejected
28078 with the error
28079 .code
28080 554 Security failure
28081 .endd
28082 If a STARTTLS command is issued within an existing TLS session, it is
28083 rejected with a 554 error code.
28084
28085 To enable TLS operations on a server, the &%tls_advertise_hosts%& option
28086 must be set to match some hosts. The default is * which matches all hosts.
28087
28088 If this is all you do, TLS encryption will be enabled but not authentication -
28089 meaning that the peer has no assurance it is actually you he is talking to.
28090 You gain protection from a passive sniffer listening on the wire but not
28091 from someone able to intercept the communication.
28092
28093 Further protection requires some further configuration at the server end.
28094
28095 To make TLS work you need to set, in the server,
28096 .code
28097 tls_certificate = /some/file/name
28098 tls_privatekey = /some/file/name
28099 .endd
28100 These options are, in fact, expanded strings, so you can make them depend on
28101 the identity of the client that is connected if you wish. The first file
28102 contains the server's X509 certificate, and the second contains the private key
28103 that goes with it. These files need to be
28104 PEM format and readable by the Exim user, and must
28105 always be given as full path names.
28106 The key must not be password-protected.
28107 They can be the same file if both the
28108 certificate and the key are contained within it. If &%tls_privatekey%& is not
28109 set, or if its expansion is forced to fail or results in an empty string, this
28110 is assumed to be the case. The certificate file may also contain intermediate
28111 certificates that need to be sent to the client to enable it to authenticate
28112 the server's certificate.
28113
28114 For dual-stack (eg. RSA and ECDSA) configurations, these options can be
28115 colon-separated lists of file paths.  Ciphers using given authentication
28116 algorithms require the presence of a suitable certificate to supply the
28117 public-key.  The server selects among the certificates to present to the
28118 client depending on the selected cipher, hence the priority ordering for
28119 ciphers will affect which certificate is used.
28120
28121 If you do not understand about certificates and keys, please try to find a
28122 source of this background information, which is not Exim-specific. (There are a
28123 few comments below in section &<<SECTcerandall>>&.)
28124
28125 &*Note*&: These options do not apply when Exim is operating as a client &--
28126 they apply only in the case of a server. If you need to use a certificate in an
28127 Exim client, you must set the options of the same names in an &(smtp)&
28128 transport.
28129
28130 With just these options, an Exim server will be able to use TLS. It does not
28131 require the client to have a certificate (but see below for how to insist on
28132 this). There is one other option that may be needed in other situations. If
28133 .code
28134 tls_dhparam = /some/file/name
28135 .endd
28136 is set, the SSL library is initialized for the use of Diffie-Hellman ciphers
28137 with the parameters contained in the file.
28138 Set this to &`none`& to disable use of DH entirely, by making no prime
28139 available:
28140 .code
28141 tls_dhparam = none
28142 .endd
28143 This may also be set to a string identifying a standard prime to be used for
28144 DH; if it is set to &`default`& or, for OpenSSL, is unset, then the prime
28145 used is &`ike23`&.  There are a few standard primes available, see the
28146 documentation for &%tls_dhparam%& for the complete list.
28147
28148 See the command
28149 .code
28150 openssl dhparam
28151 .endd
28152 for a way of generating file data.
28153
28154 The strings supplied for these three options are expanded every time a client
28155 host connects. It is therefore possible to use different certificates and keys
28156 for different hosts, if you so wish, by making use of the client's IP address
28157 in &$sender_host_address$& to control the expansion. If a string expansion is
28158 forced to fail, Exim behaves as if the option is not set.
28159
28160 .cindex "cipher" "logging"
28161 .cindex "log" "TLS cipher"
28162 .vindex "&$tls_in_cipher$&"
28163 The variable &$tls_in_cipher$& is set to the cipher suite that was negotiated for
28164 an incoming TLS connection. It is included in the &'Received:'& header of an
28165 incoming message (by default &-- you can, of course, change this), and it is
28166 also included in the log line that records a message's arrival, keyed by
28167 &"X="&, unless the &%tls_cipher%& log selector is turned off. The &%encrypted%&
28168 condition can be used to test for specific cipher suites in ACLs.
28169
28170 Once TLS has been established, the ACLs that run for subsequent SMTP commands
28171 can check the name of the cipher suite and vary their actions accordingly. The
28172 cipher suite names vary, depending on which TLS library is being used. For
28173 example, OpenSSL uses the name DES-CBC3-SHA for the cipher suite which in other
28174 contexts is known as TLS_RSA_WITH_3DES_EDE_CBC_SHA. Check the OpenSSL or GnuTLS
28175 documentation for more details.
28176
28177 For outgoing SMTP deliveries, &$tls_out_cipher$& is used and logged
28178 (again depending on the &%tls_cipher%& log selector).
28179
28180
28181 .section "Requesting and verifying client certificates" "SECID183"
28182 .cindex "certificate" "verification of client"
28183 .cindex "TLS" "client certificate verification"
28184 If you want an Exim server to request a certificate when negotiating a TLS
28185 session with a client, you must set either &%tls_verify_hosts%& or
28186 &%tls_try_verify_hosts%&. You can, of course, set either of them to * to
28187 apply to all TLS connections. For any host that matches one of these options,
28188 Exim requests a certificate as part of the setup of the TLS session. The
28189 contents of the certificate are verified by comparing it with a list of
28190 expected trust-anchors or certificates.
28191 These may be the system default set (depending on library version),
28192 an explicit file or,
28193 depending on library version, a directory, identified by
28194 &%tls_verify_certificates%&.
28195
28196 A file can contain multiple certificates, concatenated end to end. If a
28197 directory is used
28198 (OpenSSL only),
28199 each certificate must be in a separate file, with a name (or a symbolic link)
28200 of the form <&'hash'&>.0, where <&'hash'&> is a hash value constructed from the
28201 certificate. You can compute the relevant hash by running the command
28202 .code
28203 openssl x509 -hash -noout -in /cert/file
28204 .endd
28205 where &_/cert/file_& contains a single certificate.
28206
28207 There is no checking of names of the client against the certificate
28208 Subject Name or Subject Alternate Names.
28209
28210 The difference between &%tls_verify_hosts%& and &%tls_try_verify_hosts%& is
28211 what happens if the client does not supply a certificate, or if the certificate
28212 does not match any of the certificates in the collection named by
28213 &%tls_verify_certificates%&. If the client matches &%tls_verify_hosts%&, the
28214 attempt to set up a TLS session is aborted, and the incoming connection is
28215 dropped. If the client matches &%tls_try_verify_hosts%&, the (encrypted) SMTP
28216 session continues. ACLs that run for subsequent SMTP commands can detect the
28217 fact that no certificate was verified, and vary their actions accordingly. For
28218 example, you can insist on a certificate before accepting a message for
28219 relaying, but not when the message is destined for local delivery.
28220
28221 .vindex "&$tls_in_peerdn$&"
28222 When a client supplies a certificate (whether it verifies or not), the value of
28223 the Distinguished Name of the certificate is made available in the variable
28224 &$tls_in_peerdn$& during subsequent processing of the message.
28225
28226 .cindex "log" "distinguished name"
28227 Because it is often a long text string, it is not included in the log line or
28228 &'Received:'& header by default. You can arrange for it to be logged, keyed by
28229 &"DN="&, by setting the &%tls_peerdn%& log selector, and you can use
28230 &%received_header_text%& to change the &'Received:'& header. When no
28231 certificate is supplied, &$tls_in_peerdn$& is empty.
28232
28233
28234 .section "Revoked certificates" "SECID184"
28235 .cindex "TLS" "revoked certificates"
28236 .cindex "revocation list"
28237 .cindex "certificate" "revocation list"
28238 .cindex "OCSP" "stapling"
28239 Certificate issuing authorities issue Certificate Revocation Lists (CRLs) when
28240 certificates are revoked. If you have such a list, you can pass it to an Exim
28241 server using the global option called &%tls_crl%& and to an Exim client using
28242 an identically named option for the &(smtp)& transport. In each case, the value
28243 of the option is expanded and must then be the name of a file that contains a
28244 CRL in PEM format.
28245 The downside is that clients have to periodically re-download a potentially huge
28246 file from every certificate authority they know of.
28247
28248 The way with most moving parts at query time is Online Certificate
28249 Status Protocol (OCSP), where the client verifies the certificate
28250 against an OCSP server run by the CA.  This lets the CA track all
28251 usage of the certs.  It requires running software with access to the
28252 private key of the CA, to sign the responses to the OCSP queries.  OCSP
28253 is based on HTTP and can be proxied accordingly.
28254
28255 The only widespread OCSP server implementation (known to this writer)
28256 comes as part of OpenSSL and aborts on an invalid request, such as
28257 connecting to the port and then disconnecting.  This requires
28258 re-entering the passphrase each time some random client does this.
28259
28260 The third way is OCSP Stapling; in this, the server using a certificate
28261 issued by the CA periodically requests an OCSP proof of validity from
28262 the OCSP server, then serves it up inline as part of the TLS
28263 negotiation.   This approach adds no extra round trips, does not let the
28264 CA track users, scales well with number of certs issued by the CA and is
28265 resilient to temporary OCSP server failures, as long as the server
28266 starts retrying to fetch an OCSP proof some time before its current
28267 proof expires.  The downside is that it requires server support.
28268
28269 Unless Exim is built with the support disabled,
28270 or with GnuTLS earlier than version 3.3.16 / 3.4.8
28271 support for OCSP stapling is included.
28272
28273 There is a global option called &%tls_ocsp_file%&.
28274 The file specified therein is expected to be in DER format, and contain
28275 an OCSP proof.  Exim will serve it as part of the TLS handshake.  This
28276 option will be re-expanded for SNI, if the &%tls_certificate%& option
28277 contains &`tls_in_sni`&, as per other TLS options.
28278
28279 Exim does not at this time implement any support for fetching a new OCSP
28280 proof.  The burden is on the administrator to handle this, outside of
28281 Exim.  The file specified should be replaced atomically, so that the
28282 contents are always valid.  Exim will expand the &%tls_ocsp_file%& option
28283 on each connection, so a new file will be handled transparently on the
28284 next connection.
28285
28286 When built with OpenSSL Exim will check for a valid next update timestamp
28287 in the OCSP proof; if not present, or if the proof has expired, it will be
28288 ignored.
28289
28290 For the client to be able to verify the stapled OCSP the server must
28291 also supply, in its stapled information, any intermediate
28292 certificates for the chain leading to the OCSP proof from the signer
28293 of the server certificate.  There may be zero or one such. These
28294 intermediate certificates should be added to the server OCSP stapling
28295 file named by &%tls_ocsp_file%&.
28296
28297 Note that the proof only covers the terminal server certificate,
28298 not any of the chain from CA to it.
28299
28300 There is no current way to staple a proof for a client certificate.
28301
28302 .code
28303   A helper script "ocsp_fetch.pl" for fetching a proof from a CA
28304   OCSP server is supplied.  The server URL may be included in the
28305   server certificate, if the CA is helpful.
28306
28307   One failure mode seen was the OCSP Signer cert expiring before the end
28308   of validity of the OCSP proof. The checking done by Exim/OpenSSL
28309   noted this as invalid overall, but the re-fetch script did not.
28310 .endd
28311
28312
28313
28314
28315 .section "Configuring an Exim client to use TLS" "SECID185"
28316 .cindex "cipher" "logging"
28317 .cindex "log" "TLS cipher"
28318 .cindex "log" "distinguished name"
28319 .cindex "TLS" "configuring an Exim client"
28320 The &%tls_cipher%& and &%tls_peerdn%& log selectors apply to outgoing SMTP
28321 deliveries as well as to incoming, the latter one causing logging of the
28322 server certificate's DN. The remaining client configuration for TLS is all
28323 within the &(smtp)& transport.
28324
28325 It is not necessary to set any options to have TLS work in the &(smtp)&
28326 transport. If Exim is built with TLS support, and TLS is advertised by a
28327 server, the &(smtp)& transport always tries to start a TLS session. However,
28328 this can be prevented by setting &%hosts_avoid_tls%& (an option of the
28329 transport) to a list of server hosts for which TLS should not be used.
28330
28331 If you do not want Exim to attempt to send messages unencrypted when an attempt
28332 to set up an encrypted connection fails in any way, you can set
28333 &%hosts_require_tls%& to a list of hosts for which encryption is mandatory. For
28334 those hosts, delivery is always deferred if an encrypted connection cannot be
28335 set up. If there are any other hosts for the address, they are tried in the
28336 usual way.
28337
28338 When the server host is not in &%hosts_require_tls%&, Exim may try to deliver
28339 the message unencrypted. It always does this if the response to STARTTLS is
28340 a 5&'xx'& code. For a temporary error code, or for a failure to negotiate a TLS
28341 session after a success response code, what happens is controlled by the
28342 &%tls_tempfail_tryclear%& option of the &(smtp)& transport. If it is false,
28343 delivery to this host is deferred, and other hosts (if available) are tried. If
28344 it is true, Exim attempts to deliver unencrypted after a 4&'xx'& response to
28345 STARTTLS, and if STARTTLS is accepted, but the subsequent TLS
28346 negotiation fails, Exim closes the current connection (because it is in an
28347 unknown state), opens a new one to the same host, and then tries the delivery
28348 unencrypted.
28349
28350 The &%tls_certificate%& and &%tls_privatekey%& options of the &(smtp)&
28351 transport provide the client with a certificate, which is passed to the server
28352 if it requests it. If the server is Exim, it will request a certificate only if
28353 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& matches the client.
28354
28355 If the &%tls_verify_certificates%& option is set on the &(smtp)& transport, it
28356 specifies a collection of expected server certificates.
28357 These may be
28358 the system default set (depending on library version),
28359 a file,
28360 or (depending on library version) a directory.
28361 The client verifies the server's certificate
28362 against this collection, taking into account any revoked certificates that are
28363 in the list defined by &%tls_crl%&.
28364 Failure to verify fails the TLS connection unless either of the
28365 &%tls_verify_hosts%& or &%tls_try_verify_hosts%& options are set.
28366
28367 The &%tls_verify_hosts%& and &%tls_try_verify_hosts%& options restrict
28368 certificate verification to the listed servers.  Verification either must
28369 or need not succeed respectively.
28370
28371 The &%tls_verify_cert_hostnames%& option lists hosts for which additional
28372 checks are made: that the host name (the one in the DNS A record)
28373 is valid for the certificate.
28374 The option defaults to always checking.
28375
28376 The &(smtp)& transport has two OCSP-related options:
28377 &%hosts_require_ocsp%&; a host-list for which a Certificate Status
28378 is requested and required for the connection to proceed.  The default
28379 value is empty.
28380 &%hosts_request_ocsp%&; a host-list for which (additionally)
28381 a Certificate Status is requested (but not necessarily verified).  The default
28382 value is "*" meaning that requests are made unless configured
28383 otherwise.
28384
28385 The host(s) should also be in &%hosts_require_tls%&, and
28386 &%tls_verify_certificates%& configured for the transport,
28387 for OCSP to be relevant.
28388
28389 If
28390 &%tls_require_ciphers%& is set on the &(smtp)& transport, it must contain a
28391 list of permitted cipher suites. If either of these checks fails, delivery to
28392 the current host is abandoned, and the &(smtp)& transport tries to deliver to
28393 alternative hosts, if any.
28394
28395  &*Note*&:
28396 These options must be set in the &(smtp)& transport for Exim to use TLS when it
28397 is operating as a client. Exim does not assume that a server certificate (set
28398 by the global options of the same name) should also be used when operating as a
28399 client.
28400
28401 .vindex "&$host$&"
28402 .vindex "&$host_address$&"
28403 All the TLS options in the &(smtp)& transport are expanded before use, with
28404 &$host$& and &$host_address$& containing the name and address of the server to
28405 which the client is connected. Forced failure of an expansion causes Exim to
28406 behave as if the relevant option were unset.
28407
28408 .vindex &$tls_out_bits$&
28409 .vindex &$tls_out_cipher$&
28410 .vindex &$tls_out_peerdn$&
28411 .vindex &$tls_out_sni$&
28412 Before an SMTP connection is established, the
28413 &$tls_out_bits$&, &$tls_out_cipher$&, &$tls_out_peerdn$& and &$tls_out_sni$&
28414 variables are emptied. (Until the first connection, they contain the values
28415 that were set when the message was received.) If STARTTLS is subsequently
28416 successfully obeyed, these variables are set to the relevant values for the
28417 outgoing connection.
28418
28419
28420
28421 .section "Use of TLS Server Name Indication" "SECTtlssni"
28422 .cindex "TLS" "Server Name Indication"
28423 .vindex "&$tls_in_sni$&"
28424 .oindex "&%tls_in_sni%&"
28425 With TLS1.0 or above, there is an extension mechanism by which extra
28426 information can be included at various points in the protocol.  One of these
28427 extensions, documented in RFC 6066 (and before that RFC 4366) is
28428 &"Server Name Indication"&, commonly &"SNI"&.  This extension is sent by the
28429 client in the initial handshake, so that the server can examine the servername
28430 within and possibly choose to use different certificates and keys (and more)
28431 for this session.
28432
28433 This is analogous to HTTP's &"Host:"& header, and is the main mechanism by
28434 which HTTPS-enabled web-sites can be virtual-hosted, many sites to one IP
28435 address.
28436
28437 With SMTP to MX, there are the same problems here as in choosing the identity
28438 against which to validate a certificate: you can't rely on insecure DNS to
28439 provide the identity which you then cryptographically verify.  So this will
28440 be of limited use in that environment.
28441
28442 With SMTP to Submission, there is a well-defined hostname which clients are
28443 connecting to and can validate certificates against.  Thus clients &*can*&
28444 choose to include this information in the TLS negotiation.  If this becomes
28445 wide-spread, then hosters can choose to present different certificates to
28446 different clients.  Or even negotiate different cipher suites.
28447
28448 The &%tls_sni%& option on an SMTP transport is an expanded string; the result,
28449 if not empty, will be sent on a TLS session as part of the handshake.  There's
28450 nothing more to it.  Choosing a sensible value not derived insecurely is the
28451 only point of caution.  The &$tls_out_sni$& variable will be set to this string
28452 for the lifetime of the client connection (including during authentication).
28453
28454 Except during SMTP client sessions, if &$tls_in_sni$& is set then it is a string
28455 received from a client.
28456 It can be logged with the &%log_selector%& item &`+tls_sni`&.
28457
28458 If the string &`tls_in_sni`& appears in the main section's &%tls_certificate%&
28459 option (prior to expansion) then the following options will be re-expanded
28460 during TLS session handshake, to permit alternative values to be chosen:
28461
28462 .ilist
28463 &%tls_certificate%&
28464 .next
28465 &%tls_crl%&
28466 .next
28467 &%tls_privatekey%&
28468 .next
28469 &%tls_verify_certificates%&
28470 .next
28471 &%tls_ocsp_file%&
28472 .endlist
28473
28474 Great care should be taken to deal with matters of case, various injection
28475 attacks in the string (&`../`& or SQL), and ensuring that a valid filename
28476 can always be referenced; it is important to remember that &$tls_in_sni$& is
28477 arbitrary unverified data provided prior to authentication.
28478 Further, the initial certificate is loaded before SNI is arrived, so
28479 an expansion for &%tls_certificate%& must have a default which is used
28480 when &$tls_in_sni$& is empty.
28481
28482 The Exim developers are proceeding cautiously and so far no other TLS options
28483 are re-expanded.
28484
28485 When Exim is built against OpenSSL, OpenSSL must have been built with support
28486 for TLS Extensions.  This holds true for OpenSSL 1.0.0+ and 0.9.8+ with
28487 enable-tlsext in EXTRACONFIGURE.  If you invoke &(openssl s_client -h)& and
28488 see &`-servername`& in the output, then OpenSSL has support.
28489
28490 When Exim is built against GnuTLS, SNI support is available as of GnuTLS
28491 0.5.10.  (Its presence predates the current API which Exim uses, so if Exim
28492 built, then you have SNI support).
28493
28494
28495
28496 .section "Multiple messages on the same encrypted TCP/IP connection" &&&
28497          "SECTmulmessam"
28498 .cindex "multiple SMTP deliveries with TLS"
28499 .cindex "TLS" "multiple message deliveries"
28500 Exim sends multiple messages down the same TCP/IP connection by starting up
28501 an entirely new delivery process for each message, passing the socket from
28502 one process to the next. This implementation does not fit well with the use
28503 of TLS, because there is quite a lot of state information associated with a TLS
28504 connection, not just a socket identification. Passing all the state information
28505 to a new process is not feasible. Consequently, for sending using TLS Exim
28506 starts an additional proxy process for handling the encryption, piping the
28507 unencrypted data stream from and to the delivery processes.
28508
28509 An older mode of operation can be enabled on a per-host basis by the
28510 &%hosts_noproxy_tls%& option on the &(smtp)& transport.  If the host matches
28511 this list the proxy process described above is not used; instead Exim
28512 shuts down an existing TLS session being run by the delivery process
28513 before passing the socket to a new process. The new process may then
28514 try to start a new TLS session, and if successful, may try to re-authenticate
28515 if AUTH is in use, before sending the next message.
28516
28517 The RFC is not clear as to whether or not an SMTP session continues in clear
28518 after TLS has been shut down, or whether TLS may be restarted again later, as
28519 just described. However, if the server is Exim, this shutdown and
28520 reinitialization works. It is not known which (if any) other servers operate
28521 successfully if the client closes a TLS session and continues with unencrypted
28522 SMTP, but there are certainly some that do not work. For such servers, Exim
28523 should not pass the socket to another process, because the failure of the
28524 subsequent attempt to use it would cause Exim to record a temporary host error,
28525 and delay other deliveries to that host.
28526
28527 To test for this case, Exim sends an EHLO command to the server after
28528 closing down the TLS session. If this fails in any way, the connection is
28529 closed instead of being passed to a new delivery process, but no retry
28530 information is recorded.
28531
28532 There is also a manual override; you can set &%hosts_nopass_tls%& on the
28533 &(smtp)& transport to match those hosts for which Exim should not pass
28534 connections to new processes if TLS has been used.
28535
28536
28537
28538
28539 .section "Certificates and all that" "SECTcerandall"
28540 .cindex "certificate" "references to discussion"
28541 In order to understand fully how TLS works, you need to know about
28542 certificates, certificate signing, and certificate authorities.
28543 This is a large topic and an introductory guide is unsuitable for the Exim
28544 reference manual, so instead we provide pointers to existing documentation.
28545
28546 The Apache web-server was for a long time the canonical guide, so their
28547 documentation is a good place to start; their SSL module's Introduction
28548 document is currently at
28549 .display
28550 &url(https://httpd.apache.org/docs/current/ssl/ssl_intro.html)
28551 .endd
28552 and their FAQ is at
28553 .display
28554 &url(https://httpd.apache.org/docs/current/ssl/ssl_faq.html)
28555 .endd
28556
28557 Eric Rescorla's book, &'SSL and TLS'&, published by Addison-Wesley (ISBN
28558 0-201-61598-3) in 2001, contains both introductory and more in-depth
28559 descriptions.
28560 More recently Ivan Ristić's book &'Bulletproof SSL and TLS'&,
28561 published by Feisty Duck (ISBN 978-1907117046) in 2013 is good.
28562 Ivan is the author of the popular TLS testing tools at
28563 &url(https://www.ssllabs.com/).
28564
28565
28566 .section "Certificate chains" "SECID186"
28567 The file named by &%tls_certificate%& may contain more than one
28568 certificate. This is useful in the case where the certificate that is being
28569 sent is validated by an intermediate certificate which the other end does
28570 not have. Multiple certificates must be in the correct order in the file.
28571 First the host's certificate itself, then the first intermediate
28572 certificate to validate the issuer of the host certificate, then the next
28573 intermediate certificate to validate the issuer of the first intermediate
28574 certificate, and so on, until finally (optionally) the root certificate.
28575 The root certificate must already be trusted by the recipient for
28576 validation to succeed, of course, but if it's not preinstalled, sending the
28577 root certificate along with the rest makes it available for the user to
28578 install if the receiving end is a client MUA that can interact with a user.
28579
28580 Note that certificates using MD5 are unlikely to work on today's Internet;
28581 even if your libraries allow loading them for use in Exim when acting as a
28582 server, increasingly clients will not accept such certificates.  The error
28583 diagnostics in such a case can be frustratingly vague.
28584
28585
28586
28587 .section "Self-signed certificates" "SECID187"
28588 .cindex "certificate" "self-signed"
28589 You can create a self-signed certificate using the &'req'& command provided
28590 with OpenSSL, like this:
28591 . ==== Do not shorten the duration here without reading and considering
28592 . ==== the text below.  Please leave it at 9999 days.
28593 .code
28594 openssl req -x509 -newkey rsa:1024 -keyout file1 -out file2 \
28595             -days 9999 -nodes
28596 .endd
28597 &_file1_& and &_file2_& can be the same file; the key and the certificate are
28598 delimited and so can be identified independently. The &%-days%& option
28599 specifies a period for which the certificate is valid. The &%-nodes%& option is
28600 important: if you do not set it, the key is encrypted with a passphrase
28601 that you are prompted for, and any use that is made of the key causes more
28602 prompting for the passphrase. This is not helpful if you are going to use
28603 this certificate and key in an MTA, where prompting is not possible.
28604
28605 . ==== I expect to still be working 26 years from now.  The less technical
28606 . ==== debt I create, in terms of storing up trouble for my later years, the
28607 . ==== happier I will be then.  We really have reached the point where we
28608 . ==== should start, at the very least, provoking thought and making folks
28609 . ==== pause before proceeding, instead of leaving all the fixes until two
28610 . ==== years before 2^31 seconds after the 1970 Unix epoch.
28611 . ==== -pdp, 2012
28612 NB: we are now past the point where 9999 days takes us past the 32-bit Unix
28613 epoch.  If your system uses unsigned time_t (most do) and is 32-bit, then
28614 the above command might produce a date in the past.  Think carefully about
28615 the lifetime of the systems you're deploying, and either reduce the duration
28616 of the certificate or reconsider your platform deployment.  (At time of
28617 writing, reducing the duration is the most likely choice, but the inexorable
28618 progression of time takes us steadily towards an era where this will not
28619 be a sensible resolution).
28620
28621 A self-signed certificate made in this way is sufficient for testing, and
28622 may be adequate for all your requirements if you are mainly interested in
28623 encrypting transfers, and not in secure identification.
28624
28625 However, many clients require that the certificate presented by the server be a
28626 user (also called &"leaf"& or &"site"&) certificate, and not a self-signed
28627 certificate. In this situation, the self-signed certificate described above
28628 must be installed on the client host as a trusted root &'certification
28629 authority'& (CA), and the certificate used by Exim must be a user certificate
28630 signed with that self-signed certificate.
28631
28632 For information on creating self-signed CA certificates and using them to sign
28633 user certificates, see the &'General implementation overview'& chapter of the
28634 Open-source PKI book, available online at
28635 &url(https://sourceforge.net/projects/ospkibook/).
28636 .ecindex IIDencsmtp1
28637 .ecindex IIDencsmtp2
28638
28639
28640
28641 .section DANE "SECDANE"
28642 .cindex DANE
28643 DNS-based Authentication of Named Entities, as applied to SMTP over TLS, provides assurance to a client that
28644 it is actually talking to the server it wants to rather than some attacker operating a Man In The Middle (MITM)
28645 operation.  The latter can terminate the TLS connection you make, and make another one to the server (so both
28646 you and the server still think you have an encrypted connection) and, if one of the "well known" set of
28647 Certificate Authorities has been suborned - something which *has* been seen already (2014), a verifiable
28648 certificate (if you're using normal root CAs, eg. the Mozilla set, as your trust anchors).
28649
28650 What DANE does is replace the CAs with the DNS as the trust anchor.  The assurance is limited to a) the possibility
28651 that the DNS has been suborned, b) mistakes made by the admins of the target server.   The attack surface presented
28652 by (a) is thought to be smaller than that of the set of root CAs.
28653
28654 It also allows the server to declare (implicitly) that connections to it should use TLS.  An MITM could simply
28655 fail to pass on a server's STARTTLS.
28656
28657 DANE scales better than having to maintain (and side-channel communicate) copies of server certificates
28658 for every possible target server.  It also scales (slightly) better than having to maintain on an SMTP
28659 client a copy of the standard CAs bundle.  It also means not having to pay a CA for certificates.
28660
28661 DANE requires a server operator to do three things: 1) run DNSSEC.  This provides assurance to clients
28662 that DNS lookups they do for the server have not been tampered with.  The domain MX record applying
28663 to this server, its A record, its TLSA record and any associated CNAME records must all be covered by
28664 DNSSEC.
28665 2) add TLSA DNS records.  These say what the server certificate for a TLS connection should be.
28666 3) offer a server certificate, or certificate chain, in TLS connections which is is anchored by one of the TLSA records.
28667
28668 There are no changes to Exim specific to server-side operation of DANE.
28669 Support for client-side operation of DANE can be included at compile time by defining SUPPORT_DANE=yes
28670 in &_Local/Makefile_&.
28671 If it has been included, the macro "_HAVE_DANE" will be defined.
28672
28673 The TLSA record for the server may have "certificate usage" of DANE-TA(2) or DANE-EE(3).
28674 These are the "Trust Anchor" and "End Entity" variants.
28675 The latter specifies the End Entity directly, i.e. the certificate involved is that of the server
28676 (and if only DANE-EE is used then it should be the sole one transmitted during the TLS handshake);
28677 this is appropriate for a single system, using a self-signed certificate.
28678 DANE-TA usage is effectively declaring a specific CA to be used; this might be a private CA or a public,
28679 well-known one.
28680 A private CA at simplest is just a self-signed certificate (with certain
28681 attributes) which is used to sign server certificates, but running one securely
28682 does require careful arrangement.
28683 With DANE-TA, as implemented in Exim and commonly in other MTAs,
28684 the server TLS handshake must transmit the entire certificate chain from CA to server-certificate.
28685 DANE-TA is commonly used for several services and/or servers, each having a TLSA query-domain CNAME record,
28686 all of which point to a single TLSA record.
28687 DANE-TA and DANE-EE can both be used together.
28688
28689 Our recommendation is to use DANE with a certificate from a public CA,
28690 because this enables a variety of strategies for remote clients to verify
28691 your certificate.
28692 You can then publish information both via DANE and another technology,
28693 "MTA-STS", described below.
28694
28695 When you use DANE-TA to publish trust anchor information, you ask entities
28696 outside your administrative control to trust the Certificate Authority for
28697 connections to you.
28698 If using a private CA then you should expect others to still apply the
28699 technical criteria they'd use for a public CA to your certificates.
28700 In particular, you should probably try to follow current best practices for CA
28701 operation around hash algorithms and key sizes.
28702 Do not expect other organizations to lower their security expectations just
28703 because a particular profile might be reasonable for your own internal use.
28704
28705 When this text was last updated, this in practice means to avoid use of SHA-1
28706 and MD5; if using RSA to use key sizes of at least 2048 bits (and no larger
28707 than 4096, for interoperability); to use keyUsage fields correctly; to use
28708 random serial numbers.
28709 The list of requirements is subject to change as best practices evolve.
28710 If you're not already using a private CA, or it doesn't meet these
28711 requirements, then we encourage you to avoid all these issues and use a public
28712 CA such as &url(https://letsencrypt.org/,Let's Encrypt) instead.
28713
28714 The TLSA record should have a Selector field of SPKI(1) and a Matching Type field of SHA2-512(2).
28715
28716 At the time of writing, &url(https://www.huque.com/bin/gen_tlsa)
28717 is useful for quickly generating TLSA records; and commands like
28718
28719 .code
28720   openssl x509 -in -pubkey -noout <certificate.pem \
28721   | openssl rsa -outform der -pubin 2>/dev/null \
28722   | openssl sha512 \
28723   | awk '{print $2}'
28724 .endd
28725
28726 are workable for 4th-field hashes.
28727
28728 For use with the DANE-TA model, server certificates must have a correct name (SubjectName or SubjectAltName).
28729
28730 The Certificate issued by the CA published in the DANE-TA model should be
28731 issued using a strong hash algorithm.
28732 Exim, and importantly various other MTAs sending to you, will not
28733 re-enable hash algorithms which have been disabled by default in TLS
28734 libraries.
28735 This means no MD5 and no SHA-1.  SHA2-256 is the minimum for reliable
28736 interoperability (and probably the maximum too, in 2018).
28737
28738 The use of OCSP-stapling should be considered, allowing for fast revocation of certificates (which would otherwise
28739 be limited by the DNS TTL on the TLSA records).  However, this is likely to only be usable with DANE-TA.  NOTE: the
28740 default of requesting OCSP for all hosts is modified iff DANE is in use, to:
28741
28742 .code
28743   hosts_request_ocsp = ${if or { {= {0}{$tls_out_tlsa_usage}} \
28744                                  {= {4}{$tls_out_tlsa_usage}} } \
28745                          {*}{}}
28746 .endd
28747
28748 The (new) variable &$tls_out_tlsa_usage$& is a bitfield with numbered bits set for TLSA record usage codes.
28749 The zero above means DANE was not in use, the four means that only DANE-TA usage TLSA records were
28750 found. If the definition of &%hosts_request_ocsp%& includes the
28751 string "tls_out_tlsa_usage", they are re-expanded in time to
28752 control the OCSP request.
28753
28754 This modification of hosts_request_ocsp is only done if it has the default value of "*".  Admins who change it, and
28755 those who use &%hosts_require_ocsp%&, should consider the interaction with DANE in their OCSP settings.
28756
28757
28758 For client-side DANE there are three new smtp transport options, &%hosts_try_dane%&, &%hosts_require_dane%&
28759 and &%dane_require_tls_ciphers%&.
28760 The require variant will result in failure if the target host is not DNSSEC-secured.
28761
28762 DANE will only be usable if the target host has DNSSEC-secured MX, A and TLSA records.
28763
28764 A TLSA lookup will be done if either of the above options match and the host-lookup succeeded using dnssec.
28765 If a TLSA lookup is done and succeeds, a DANE-verified TLS connection
28766 will be required for the host.  If it does not, the host will not
28767 be used; there is no fallback to non-DANE or non-TLS.
28768
28769 If DANE is requested and usable, then the TLS cipher list configuration
28770 prefers to use the option &%dane_require_tls_ciphers%& and falls
28771 back to &%tls_require_ciphers%& only if that is unset.
28772 This lets you configure "decent crypto" for DANE and "better than nothing
28773 crypto" as the default.  Note though that while GnuTLS lets the string control
28774 which versions of TLS/SSL will be negotiated, OpenSSL does not and you're
28775 limited to ciphersuite constraints.
28776
28777 If DANE is requested and useable (see above) the following transport options are ignored:
28778 .code
28779   hosts_require_tls
28780   tls_verify_hosts
28781   tls_try_verify_hosts
28782   tls_verify_certificates
28783   tls_crl
28784   tls_verify_cert_hostnames
28785 .endd
28786
28787 If DANE is not usable, whether requested or not, and CA-anchored
28788 verification evaluation is wanted, the above variables should be set appropriately.
28789
28790 Currently the &%dnssec_request_domains%& must be active and &%dnssec_require_domains%& is ignored.
28791
28792 If verification was successful using DANE then the "CV" item in the delivery log line will show as "CV=dane".
28793
28794 There is a new variable &$tls_out_dane$& which will have "yes" if
28795 verification succeeded using DANE and "no" otherwise (only useful
28796 in combination with events; see &<<CHAPevents>>&),
28797 and a new variable &$tls_out_tlsa_usage$& (detailed above).
28798
28799 .cindex DANE reporting
28800 An event (see &<<CHAPevents>>&) of type "dane:fail" will be raised on failures
28801 to achieve DANE-verified connection, if one was either requested and offered, or
28802 required.  This is intended to support TLS-reporting as defined in
28803 &url(https://tools.ietf.org/html/draft-ietf-uta-smtp-tlsrpt-17).
28804 The &$event_data$& will be one of the Result Types defined in
28805 Section 4.3 of that document.
28806
28807 Under GnuTLS, DANE is only supported from version 3.0.0 onwards.
28808
28809 DANE is specified in published RFCs and decouples certificate authority trust
28810 selection from a "race to the bottom" of "you must trust everything for mail
28811 to get through".  There is an alternative technology called MTA-STS, which
28812 instead publishes MX trust anchor information on an HTTPS website.  At the
28813 time this text was last updated, MTA-STS was still a draft, not yet an RFC.
28814 Exim has no support for MTA-STS as a client, but Exim mail server operators
28815 can choose to publish information describing their TLS configuration using
28816 MTA-STS to let those clients who do use that protocol derive trust
28817 information.
28818
28819 The MTA-STS design requires a certificate from a public Certificate Authority
28820 which is recognized by clients sending to you.
28821 That selection of which CAs are trusted by others is outside your control.
28822
28823 The most interoperable course of action is probably to use
28824 &url(https://letsencrypt.org/,Let's Encrypt), with automated certificate
28825 renewal; to publish the anchor information in DNSSEC-secured DNS via TLSA
28826 records for DANE clients (such as Exim and Postfix) and to publish anchor
28827 information for MTA-STS as well.  This is what is done for the &'exim.org'&
28828 domain itself (with caveats around occasionally broken MTA-STS because of
28829 incompatible specification changes prior to reaching RFC status).
28830
28831
28832
28833 . ////////////////////////////////////////////////////////////////////////////
28834 . ////////////////////////////////////////////////////////////////////////////
28835
28836 .chapter "Access control lists" "CHAPACL"
28837 .scindex IIDacl "&ACL;" "description"
28838 .cindex "control of incoming mail"
28839 .cindex "message" "controlling incoming"
28840 .cindex "policy control" "access control lists"
28841 Access Control Lists (ACLs) are defined in a separate section of the runtime
28842 configuration file, headed by &"begin acl"&. Each ACL definition starts with a
28843 name, terminated by a colon. Here is a complete ACL section that contains just
28844 one very small ACL:
28845 .code
28846 begin acl
28847 small_acl:
28848   accept   hosts = one.host.only
28849 .endd
28850 You can have as many lists as you like in the ACL section, and the order in
28851 which they appear does not matter. The lists are self-terminating.
28852
28853 The majority of ACLs are used to control Exim's behaviour when it receives
28854 certain SMTP commands. This applies both to incoming TCP/IP connections, and
28855 when a local process submits a message using SMTP by specifying the &%-bs%&
28856 option. The most common use is for controlling which recipients are accepted
28857 in incoming messages. In addition, you can define an ACL that is used to check
28858 local non-SMTP messages. The default configuration file contains an example of
28859 a realistic ACL for checking RCPT commands. This is discussed in chapter
28860 &<<CHAPdefconfil>>&.
28861
28862
28863 .section "Testing ACLs" "SECID188"
28864 The &%-bh%& command line option provides a way of testing your ACL
28865 configuration locally by running a fake SMTP session with which you interact.
28866
28867
28868 .section "Specifying when ACLs are used" "SECID189"
28869 .cindex "&ACL;" "options for specifying"
28870 In order to cause an ACL to be used, you have to name it in one of the relevant
28871 options in the main part of the configuration. These options are:
28872 .cindex "AUTH" "ACL for"
28873 .cindex "DATA" "ACLs for"
28874 .cindex "ETRN" "ACL for"
28875 .cindex "EXPN" "ACL for"
28876 .cindex "HELO" "ACL for"
28877 .cindex "EHLO" "ACL for"
28878 .cindex "DKIM" "ACL for"
28879 .cindex "MAIL" "ACL for"
28880 .cindex "QUIT, ACL for"
28881 .cindex "RCPT" "ACL for"
28882 .cindex "STARTTLS, ACL for"
28883 .cindex "VRFY" "ACL for"
28884 .cindex "SMTP" "connection, ACL for"
28885 .cindex "non-SMTP messages" "ACLs for"
28886 .cindex "MIME content scanning" "ACL for"
28887 .cindex "PRDR" "ACL for"
28888
28889 .table2 140pt
28890 .irow &%acl_not_smtp%&         "ACL for non-SMTP messages"
28891 .irow &%acl_not_smtp_mime%&    "ACL for non-SMTP MIME parts"
28892 .irow &%acl_not_smtp_start%&   "ACL at start of non-SMTP message"
28893 .irow &%acl_smtp_auth%&        "ACL for AUTH"
28894 .irow &%acl_smtp_connect%&     "ACL for start of SMTP connection"
28895 .irow &%acl_smtp_data%&        "ACL after DATA is complete"
28896 .irow &%acl_smtp_data_prdr%&   "ACL for each recipient, after DATA is complete"
28897 .irow &%acl_smtp_dkim%&        "ACL for each DKIM signer"
28898 .irow &%acl_smtp_etrn%&        "ACL for ETRN"
28899 .irow &%acl_smtp_expn%&        "ACL for EXPN"
28900 .irow &%acl_smtp_helo%&        "ACL for HELO or EHLO"
28901 .irow &%acl_smtp_mail%&        "ACL for MAIL"
28902 .irow &%acl_smtp_mailauth%&    "ACL for the AUTH parameter of MAIL"
28903 .irow &%acl_smtp_mime%&        "ACL for content-scanning MIME parts"
28904 .irow &%acl_smtp_notquit%&     "ACL for non-QUIT terminations"
28905 .irow &%acl_smtp_predata%&     "ACL at start of DATA command"
28906 .irow &%acl_smtp_quit%&        "ACL for QUIT"
28907 .irow &%acl_smtp_rcpt%&        "ACL for RCPT"
28908 .irow &%acl_smtp_starttls%&    "ACL for STARTTLS"
28909 .irow &%acl_smtp_vrfy%&        "ACL for VRFY"
28910 .endtable
28911
28912 For example, if you set
28913 .code
28914 acl_smtp_rcpt = small_acl
28915 .endd
28916 the little ACL defined above is used whenever Exim receives a RCPT command
28917 in an SMTP dialogue. The majority of policy tests on incoming messages can be
28918 done when RCPT commands arrive. A rejection of RCPT should cause the
28919 sending MTA to give up on the recipient address contained in the RCPT
28920 command, whereas rejection at other times may cause the client MTA to keep on
28921 trying to deliver the message. It is therefore recommended that you do as much
28922 testing as possible at RCPT time.
28923
28924
28925 .section "The non-SMTP ACLs" "SECID190"
28926 .cindex "non-SMTP messages" "ACLs for"
28927 The non-SMTP ACLs apply to all non-interactive incoming messages, that is, they
28928 apply to batched SMTP as well as to non-SMTP messages. (Batched SMTP is not
28929 really SMTP.) Many of the ACL conditions (for example, host tests, and tests on
28930 the state of the SMTP connection such as encryption and authentication) are not
28931 relevant and are forbidden in these ACLs. However, the sender and recipients
28932 are known, so the &%senders%& and &%sender_domains%& conditions and the
28933 &$sender_address$& and &$recipients$& variables can be used. Variables such as
28934 &$authenticated_sender$& are also available. You can specify added header lines
28935 in any of these ACLs.
28936
28937 The &%acl_not_smtp_start%& ACL is run right at the start of receiving a
28938 non-SMTP message, before any of the message has been read. (This is the
28939 analogue of the &%acl_smtp_predata%& ACL for SMTP input.) In the case of
28940 batched SMTP input, it runs after the DATA command has been reached. The
28941 result of this ACL is ignored; it cannot be used to reject a message. If you
28942 really need to, you could set a value in an ACL variable here and reject based
28943 on that in the &%acl_not_smtp%& ACL. However, this ACL can be used to set
28944 controls, and in particular, it can be used to set
28945 .code
28946 control = suppress_local_fixups
28947 .endd
28948 This cannot be used in the other non-SMTP ACLs because by the time they are
28949 run, it is too late.
28950
28951 The &%acl_not_smtp_mime%& ACL is available only when Exim is compiled with the
28952 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
28953
28954 The &%acl_not_smtp%& ACL is run just before the &[local_scan()]& function. Any
28955 kind of rejection is treated as permanent, because there is no way of sending a
28956 temporary error for these kinds of message.
28957
28958
28959 .section "The SMTP connect ACL" "SECID191"
28960 .cindex "SMTP" "connection, ACL for"
28961 .oindex &%smtp_banner%&
28962 The ACL test specified by &%acl_smtp_connect%& happens at the start of an SMTP
28963 session, after the test specified by &%host_reject_connection%& (which is now
28964 an anomaly) and any TCP Wrappers testing (if configured). If the connection is
28965 accepted by an &%accept%& verb that has a &%message%& modifier, the contents of
28966 the message override the banner message that is otherwise specified by the
28967 &%smtp_banner%& option.
28968
28969
28970 .section "The EHLO/HELO ACL" "SECID192"
28971 .cindex "EHLO" "ACL for"
28972 .cindex "HELO" "ACL for"
28973 The ACL test specified by &%acl_smtp_helo%& happens when the client issues an
28974 EHLO or HELO command, after the tests specified by &%helo_accept_junk_hosts%&,
28975 &%helo_allow_chars%&, &%helo_verify_hosts%&, and &%helo_try_verify_hosts%&.
28976 Note that a client may issue more than one EHLO or HELO command in an SMTP
28977 session, and indeed is required to issue a new EHLO or HELO after successfully
28978 setting up encryption following a STARTTLS command.
28979
28980 Note also that a deny neither forces the client to go away nor means that
28981 mail will be refused on the connection.  Consider checking for
28982 &$sender_helo_name$& being defined in a MAIL or RCPT ACL to do that.
28983
28984 If the command is accepted by an &%accept%& verb that has a &%message%&
28985 modifier, the message may not contain more than one line (it will be truncated
28986 at the first newline and a panic logged if it does). Such a message cannot
28987 affect the EHLO options that are listed on the second and subsequent lines of
28988 an EHLO response.
28989
28990
28991 .section "The DATA ACLs" "SECID193"
28992 .cindex "DATA" "ACLs for"
28993 Two ACLs are associated with the DATA command, because it is two-stage
28994 command, with two responses being sent to the client.
28995 When the DATA command is received, the ACL defined by &%acl_smtp_predata%&
28996 is obeyed. This gives you control after all the RCPT commands, but before
28997 the message itself is received. It offers the opportunity to give a negative
28998 response to the DATA command before the data is transmitted. Header lines
28999 added by MAIL or RCPT ACLs are not visible at this time, but any that
29000 are defined here are visible when the &%acl_smtp_data%& ACL is run.
29001
29002 You cannot test the contents of the message, for example, to verify addresses
29003 in the headers, at RCPT time or when the DATA command is received. Such
29004 tests have to appear in the ACL that is run after the message itself has been
29005 received, before the final response to the DATA command is sent. This is
29006 the ACL specified by &%acl_smtp_data%&, which is the second ACL that is
29007 associated with the DATA command.
29008
29009 .cindex CHUNKING "BDAT command"
29010 .cindex BDAT "SMTP command"
29011 .cindex "RFC 3030" CHUNKING
29012 If CHUNKING was advertised and a BDAT command sequence is received,
29013 the &%acl_smtp_predata%& ACL is not run.
29014 . XXX why not?  It should be possible, for the first BDAT.
29015 The &%acl_smtp_data%& is run after the last BDAT command and all of
29016 the data specified is received.
29017
29018 For both of these ACLs, it is not possible to reject individual recipients. An
29019 error response rejects the entire message. Unfortunately, it is known that some
29020 MTAs do not treat hard (5&'xx'&) responses to the DATA command (either
29021 before or after the data) correctly &-- they keep the message on their queues
29022 and try again later, but that is their problem, though it does waste some of
29023 your resources.
29024
29025 The &%acl_smtp_data%& ACL is run after
29026 the &%acl_smtp_data_prdr%&,
29027 the &%acl_smtp_dkim%&
29028 and the &%acl_smtp_mime%& ACLs.
29029
29030 .section "The SMTP DKIM ACL" "SECTDKIMACL"
29031 The &%acl_smtp_dkim%& ACL is available only when Exim is compiled with DKIM support
29032 enabled (which is the default).
29033
29034 The ACL test specified by &%acl_smtp_dkim%& happens after a message has been
29035 received, and is executed for each DKIM signature found in a message.  If not
29036 otherwise specified, the default action is to accept.
29037
29038 This ACL is evaluated before &%acl_smtp_mime%& and &%acl_smtp_data%&.
29039
29040 For details on the operation of DKIM, see section &<<SECDKIM>>&.
29041
29042
29043 .section "The SMTP MIME ACL" "SECID194"
29044 The &%acl_smtp_mime%& option is available only when Exim is compiled with the
29045 content-scanning extension. For details, see chapter &<<CHAPexiscan>>&.
29046
29047 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29048
29049
29050 .section "The SMTP PRDR ACL" "SECTPRDRACL"
29051 .cindex "PRDR" "ACL for"
29052 .oindex "&%prdr_enable%&"
29053 The &%acl_smtp_data_prdr%& ACL is available only when Exim is compiled
29054 with PRDR support enabled (which is the default).
29055 It becomes active only when the PRDR feature is negotiated between
29056 client and server for a message, and more than one recipient
29057 has been accepted.
29058
29059 The ACL test specified by &%acl_smtp_data_prdr%& happens after a message
29060 has been received, and is executed once for each recipient of the message
29061 with &$local_part$& and &$domain$& valid.
29062 The test may accept, defer or deny for individual recipients.
29063 The &%acl_smtp_data%& will still be called after this ACL and
29064 can reject the message overall, even if this ACL has accepted it
29065 for some or all recipients.
29066
29067 PRDR may be used to support per-user content filtering.  Without it
29068 one must defer any recipient after the first that has a different
29069 content-filter configuration.  With PRDR, the RCPT-time check
29070 .cindex "PRDR" "variable for"
29071 for this can be disabled when the variable &$prdr_requested$&
29072 is &"yes"&.
29073 Any required difference in behaviour of the main DATA-time
29074 ACL should however depend on the PRDR-time ACL having run, as Exim
29075 will avoid doing so in some situations (e.g. single-recipient mails).
29076
29077 See also the &%prdr_enable%& global option
29078 and the &%hosts_try_prdr%& smtp transport option.
29079
29080 This ACL is evaluated after &%acl_smtp_dkim%& but before &%acl_smtp_data%&.
29081 If the ACL is not defined, processing completes as if
29082 the feature was not requested by the client.
29083
29084 .section "The QUIT ACL" "SECTQUITACL"
29085 .cindex "QUIT, ACL for"
29086 The ACL for the SMTP QUIT command is anomalous, in that the outcome of the ACL
29087 does not affect the response code to QUIT, which is always 221. Thus, the ACL
29088 does not in fact control any access.
29089 For this reason, it may only accept
29090 or warn as its final result.
29091
29092 This ACL can be used for tasks such as custom logging at the end of an SMTP
29093 session. For example, you can use ACL variables in other ACLs to count
29094 messages, recipients, etc., and log the totals at QUIT time using one or
29095 more &%logwrite%& modifiers on a &%warn%& verb.
29096
29097 &*Warning*&: Only the &$acl_c$&&'x'& variables can be used for this, because
29098 the &$acl_m$&&'x'& variables are reset at the end of each incoming message.
29099
29100 You do not need to have a final &%accept%&, but if you do, you can use a
29101 &%message%& modifier to specify custom text that is sent as part of the 221
29102 response to QUIT.
29103
29104 This ACL is run only for a &"normal"& QUIT. For certain kinds of disastrous
29105 failure (for example, failure to open a log file, or when Exim is bombing out
29106 because it has detected an unrecoverable error), all SMTP commands from the
29107 client are given temporary error responses until QUIT is received or the
29108 connection is closed. In these special cases, the QUIT ACL does not run.
29109
29110
29111 .section "The not-QUIT ACL" "SECTNOTQUITACL"
29112 .vindex &$acl_smtp_notquit$&
29113 The not-QUIT ACL, specified by &%acl_smtp_notquit%&, is run in most cases when
29114 an SMTP session ends without sending QUIT. However, when Exim itself is in bad
29115 trouble, such as being unable to write to its log files, this ACL is not run,
29116 because it might try to do things (such as write to log files) that make the
29117 situation even worse.
29118
29119 Like the QUIT ACL, this ACL is provided to make it possible to do customized
29120 logging or to gather statistics, and its outcome is ignored. The &%delay%&
29121 modifier is forbidden in this ACL, and the only permitted verbs are &%accept%&
29122 and &%warn%&.
29123
29124 .vindex &$smtp_notquit_reason$&
29125 When the not-QUIT ACL is running, the variable &$smtp_notquit_reason$& is set
29126 to a string that indicates the reason for the termination of the SMTP
29127 connection. The possible values are:
29128 .table2
29129 .irow &`acl-drop`&                 "Another ACL issued a &%drop%& command"
29130 .irow &`bad-commands`&             "Too many unknown or non-mail commands"
29131 .irow &`command-timeout`&          "Timeout while reading SMTP commands"
29132 .irow &`connection-lost`&          "The SMTP connection has been lost"
29133 .irow &`data-timeout`&             "Timeout while reading message data"
29134 .irow &`local-scan-error`&         "The &[local_scan()]& function crashed"
29135 .irow &`local-scan-timeout`&       "The &[local_scan()]& function timed out"
29136 .irow &`signal-exit`&              "SIGTERM or SIGINT"
29137 .irow &`synchronization-error`&    "SMTP synchronization error"
29138 .irow &`tls-failed`&               "TLS failed to start"
29139 .endtable
29140 In most cases when an SMTP connection is closed without having received QUIT,
29141 Exim sends an SMTP response message before actually closing the connection.
29142 With the exception of the &`acl-drop`& case, the default message can be
29143 overridden by the &%message%& modifier in the not-QUIT ACL. In the case of a
29144 &%drop%& verb in another ACL, it is the message from the other ACL that is
29145 used.
29146
29147
29148 .section "Finding an ACL to use" "SECID195"
29149 .cindex "&ACL;" "finding which to use"
29150 The value of an &%acl_smtp_%&&'xxx'& option is expanded before use, so
29151 you can use different ACLs in different circumstances. For example,
29152 .code
29153 acl_smtp_rcpt = ${if ={25}{$interface_port} \
29154                      {acl_check_rcpt} {acl_check_rcpt_submit} }
29155 .endd
29156 In the default configuration file there are some example settings for
29157 providing an RFC 4409 message &"submission"& service on port 587 and
29158 an RFC 8314 &"submissions"& service on port 465. You can use a string
29159 expansion like this to choose an ACL for MUAs on these ports which is
29160 more appropriate for this purpose than the default ACL on port 25.
29161
29162 The expanded string does not have to be the name of an ACL in the
29163 configuration file; there are other possibilities. Having expanded the
29164 string, Exim searches for an ACL as follows:
29165
29166 .ilist
29167 If the string begins with a slash, Exim uses it as a filename, and reads its
29168 contents as an ACL. The lines are processed in the same way as lines in the
29169 Exim configuration file. In particular, continuation lines are supported, blank
29170 lines are ignored, as are lines whose first non-whitespace character is &"#"&.
29171 If the file does not exist or cannot be read, an error occurs (typically
29172 causing a temporary failure of whatever caused the ACL to be run). For example:
29173 .code
29174 acl_smtp_data = /etc/acls/\
29175   ${lookup{$sender_host_address}lsearch\
29176   {/etc/acllist}{$value}{default}}
29177 .endd
29178 This looks up an ACL file to use on the basis of the host's IP address, falling
29179 back to a default if the lookup fails. If an ACL is successfully read from a
29180 file, it is retained in memory for the duration of the Exim process, so that it
29181 can be re-used without having to re-read the file.
29182 .next
29183 If the string does not start with a slash, and does not contain any spaces,
29184 Exim searches the ACL section of the configuration for an ACL whose name
29185 matches the string.
29186 .next
29187 If no named ACL is found, or if the string contains spaces, Exim parses
29188 the string as an inline ACL. This can save typing in cases where you just
29189 want to have something like
29190 .code
29191 acl_smtp_vrfy = accept
29192 .endd
29193 in order to allow free use of the VRFY command. Such a string may contain
29194 newlines; it is processed in the same way as an ACL that is read from a file.
29195 .endlist
29196
29197
29198
29199
29200 .section "ACL return codes" "SECID196"
29201 .cindex "&ACL;" "return codes"
29202 Except for the QUIT ACL, which does not affect the SMTP return code (see
29203 section &<<SECTQUITACL>>& above), the result of running an ACL is either
29204 &"accept"& or &"deny"&, or, if some test cannot be completed (for example, if a
29205 database is down), &"defer"&. These results cause 2&'xx'&, 5&'xx'&, and 4&'xx'&
29206 return codes, respectively, to be used in the SMTP dialogue. A fourth return,
29207 &"error"&, occurs when there is an error such as invalid syntax in the ACL.
29208 This also causes a 4&'xx'& return code.
29209
29210 For the non-SMTP ACL, &"defer"& and &"error"& are treated in the same way as
29211 &"deny"&, because there is no mechanism for passing temporary errors to the
29212 submitters of non-SMTP messages.
29213
29214
29215 ACLs that are relevant to message reception may also return &"discard"&. This
29216 has the effect of &"accept"&, but causes either the entire message or an
29217 individual recipient address to be discarded. In other words, it is a
29218 blackholing facility. Use it with care.
29219
29220 If the ACL for MAIL returns &"discard"&, all recipients are discarded, and no
29221 ACL is run for subsequent RCPT commands. The effect of &"discard"& in a
29222 RCPT ACL is to discard just the one recipient address. If there are no
29223 recipients left when the message's data is received, the DATA ACL is not
29224 run. A &"discard"& return from the DATA or the non-SMTP ACL discards all the
29225 remaining recipients. The &"discard"& return is not permitted for the
29226 &%acl_smtp_predata%& ACL.
29227
29228 If the ACL for VRFY returns &"accept"&, a recipient verify (without callout)
29229 is done on the address and the result determines the SMTP response.
29230
29231
29232 .cindex "&[local_scan()]& function" "when all recipients discarded"
29233 The &[local_scan()]& function is always run, even if there are no remaining
29234 recipients; it may create new recipients.
29235
29236
29237
29238 .section "Unset ACL options" "SECID197"
29239 .cindex "&ACL;" "unset options"
29240 The default actions when any of the &%acl_%&&'xxx'& options are unset are not
29241 all the same. &*Note*&: These defaults apply only when the relevant ACL is
29242 not defined at all. For any defined ACL, the default action when control
29243 reaches the end of the ACL statements is &"deny"&.
29244
29245 For &%acl_smtp_quit%& and &%acl_not_smtp_start%& there is no default because
29246 these two are ACLs that are used only for their side effects. They cannot be
29247 used to accept or reject anything.
29248
29249 For &%acl_not_smtp%&, &%acl_smtp_auth%&, &%acl_smtp_connect%&,
29250 &%acl_smtp_data%&, &%acl_smtp_helo%&, &%acl_smtp_mail%&, &%acl_smtp_mailauth%&,
29251 &%acl_smtp_mime%&, &%acl_smtp_predata%&, and &%acl_smtp_starttls%&, the action
29252 when the ACL is not defined is &"accept"&.
29253
29254 For the others (&%acl_smtp_etrn%&, &%acl_smtp_expn%&, &%acl_smtp_rcpt%&, and
29255 &%acl_smtp_vrfy%&), the action when the ACL is not defined is &"deny"&.
29256 This means that &%acl_smtp_rcpt%& must be defined in order to receive any
29257 messages over an SMTP connection. For an example, see the ACL in the default
29258 configuration file.
29259
29260
29261
29262
29263 .section "Data for message ACLs" "SECID198"
29264 .cindex "&ACL;" "data for message ACL"
29265 .vindex &$domain$&
29266 .vindex &$local_part$&
29267 .vindex &$sender_address$&
29268 .vindex &$sender_host_address$&
29269 .vindex &$smtp_command$&
29270 When a MAIL or RCPT ACL, or either of the DATA ACLs, is running, the variables
29271 that contain information about the host and the message's sender (for example,
29272 &$sender_host_address$& and &$sender_address$&) are set, and can be used in ACL
29273 statements. In the case of RCPT (but not MAIL or DATA), &$domain$& and
29274 &$local_part$& are set from the argument address. The entire SMTP command
29275 is available in &$smtp_command$&.
29276
29277 When an ACL for the AUTH parameter of MAIL is running, the variables that
29278 contain information about the host are set, but &$sender_address$& is not yet
29279 set. Section &<<SECTauthparamail>>& contains a discussion of this parameter and
29280 how it is used.
29281
29282 .vindex "&$message_size$&"
29283 The &$message_size$& variable is set to the value of the SIZE parameter on
29284 the MAIL command at MAIL, RCPT and pre-data time, or to -1 if
29285 that parameter is not given. The value is updated to the true message size by
29286 the time the final DATA ACL is run (after the message data has been
29287 received).
29288
29289 .vindex "&$rcpt_count$&"
29290 .vindex "&$recipients_count$&"
29291 The &$rcpt_count$& variable increases by one for each RCPT command received.
29292 The &$recipients_count$& variable increases by one each time a RCPT command is
29293 accepted, so while an ACL for RCPT is being processed, it contains the number
29294 of previously accepted recipients. At DATA time (for both the DATA ACLs),
29295 &$rcpt_count$& contains the total number of RCPT commands, and
29296 &$recipients_count$& contains the total number of accepted recipients.
29297
29298
29299
29300
29301
29302 .section "Data for non-message ACLs" "SECTdatfornon"
29303 .cindex "&ACL;" "data for non-message ACL"
29304 .vindex &$smtp_command_argument$&
29305 .vindex &$smtp_command$&
29306 When an ACL is being run for AUTH, EHLO, ETRN, EXPN, HELO, STARTTLS, or VRFY,
29307 the remainder of the SMTP command line is placed in &$smtp_command_argument$&,
29308 and the entire SMTP command is available in &$smtp_command$&.
29309 These variables can be tested using a &%condition%& condition. For example,
29310 here is an ACL for use with AUTH, which insists that either the session is
29311 encrypted, or the CRAM-MD5 authentication method is used. In other words, it
29312 does not permit authentication methods that use cleartext passwords on
29313 unencrypted connections.
29314 .code
29315 acl_check_auth:
29316   accept encrypted = *
29317   accept condition = ${if eq{${uc:$smtp_command_argument}}\
29318                      {CRAM-MD5}}
29319   deny   message   = TLS encryption or CRAM-MD5 required
29320 .endd
29321 (Another way of applying this restriction is to arrange for the authenticators
29322 that use cleartext passwords not to be advertised when the connection is not
29323 encrypted. You can use the generic &%server_advertise_condition%& authenticator
29324 option to do this.)
29325
29326
29327
29328 .section "Format of an ACL" "SECID199"
29329 .cindex "&ACL;" "format of"
29330 .cindex "&ACL;" "verbs, definition of"
29331 An individual ACL consists of a number of statements. Each statement starts
29332 with a verb, optionally followed by a number of conditions and &"modifiers"&.
29333 Modifiers can change the way the verb operates, define error and log messages,
29334 set variables, insert delays, and vary the processing of accepted messages.
29335
29336 If all the conditions are met, the verb is obeyed. The same condition may be
29337 used (with different arguments) more than once in the same statement. This
29338 provides a means of specifying an &"and"& conjunction between conditions. For
29339 example:
29340 .code
29341 deny  dnslists = list1.example
29342       dnslists = list2.example
29343 .endd
29344 If there are no conditions, the verb is always obeyed. Exim stops evaluating
29345 the conditions and modifiers when it reaches a condition that fails. What
29346 happens then depends on the verb (and in one case, on a special modifier). Not
29347 all the conditions make sense at every testing point. For example, you cannot
29348 test a sender address in the ACL that is run for a VRFY command.
29349
29350
29351 .section "ACL verbs" "SECID200"
29352 The ACL verbs are as follows:
29353
29354 .ilist
29355 .cindex "&%accept%& ACL verb"
29356 &%accept%&: If all the conditions are met, the ACL returns &"accept"&. If any
29357 of the conditions are not met, what happens depends on whether &%endpass%&
29358 appears among the conditions (for syntax see below). If the failing condition
29359 is before &%endpass%&, control is passed to the next ACL statement; if it is
29360 after &%endpass%&, the ACL returns &"deny"&. Consider this statement, used to
29361 check a RCPT command:
29362 .code
29363 accept domains = +local_domains
29364        endpass
29365        verify = recipient
29366 .endd
29367 If the recipient domain does not match the &%domains%& condition, control
29368 passes to the next statement. If it does match, the recipient is verified, and
29369 the command is accepted if verification succeeds. However, if verification
29370 fails, the ACL yields &"deny"&, because the failing condition is after
29371 &%endpass%&.
29372
29373 The &%endpass%& feature has turned out to be confusing to many people, so its
29374 use is not recommended nowadays. It is always possible to rewrite an ACL so
29375 that &%endpass%& is not needed, and it is no longer used in the default
29376 configuration.
29377
29378 .cindex "&%message%& ACL modifier" "with &%accept%&"
29379 If a &%message%& modifier appears on an &%accept%& statement, its action
29380 depends on whether or not &%endpass%& is present. In the absence of &%endpass%&
29381 (when an &%accept%& verb either accepts or passes control to the next
29382 statement), &%message%& can be used to vary the message that is sent when an
29383 SMTP command is accepted. For example, in a RCPT ACL you could have:
29384 .display
29385 &`accept  `&<&'some conditions'&>
29386 &`        message = OK, I will allow you through today`&
29387 .endd
29388 You can specify an SMTP response code, optionally followed by an &"extended
29389 response code"& at the start of the message, but the first digit must be the
29390 same as would be sent by default, which is 2 for an &%accept%& verb.
29391
29392 If &%endpass%& is present in an &%accept%& statement, &%message%& specifies
29393 an error message that is used when access is denied. This behaviour is retained
29394 for backward compatibility, but current &"best practice"& is to avoid the use
29395 of &%endpass%&.
29396
29397
29398 .next
29399 .cindex "&%defer%& ACL verb"
29400 &%defer%&: If all the conditions are true, the ACL returns &"defer"& which, in
29401 an SMTP session, causes a 4&'xx'& response to be given. For a non-SMTP ACL,
29402 &%defer%& is the same as &%deny%&, because there is no way of sending a
29403 temporary error. For a RCPT command, &%defer%& is much the same as using a
29404 &(redirect)& router and &`:defer:`& while verifying, but the &%defer%& verb can
29405 be used in any ACL, and even for a recipient it might be a simpler approach.
29406
29407
29408 .next
29409 .cindex "&%deny%& ACL verb"
29410 &%deny%&: If all the conditions are met, the ACL returns &"deny"&. If any of
29411 the conditions are not met, control is passed to the next ACL statement. For
29412 example,
29413 .code
29414 deny dnslists = blackholes.mail-abuse.org
29415 .endd
29416 rejects commands from hosts that are on a DNS black list.
29417
29418
29419 .next
29420 .cindex "&%discard%& ACL verb"
29421 &%discard%&: This verb behaves like &%accept%&, except that it returns
29422 &"discard"& from the ACL instead of &"accept"&. It is permitted only on ACLs
29423 that are concerned with receiving messages. When all the conditions are true,
29424 the sending entity receives a &"success"& response. However, &%discard%& causes
29425 recipients to be discarded. If it is used in an ACL for RCPT, just the one
29426 recipient is discarded; if used for MAIL, DATA or in the non-SMTP ACL, all the
29427 message's recipients are discarded. Recipients that are discarded before DATA
29428 do not appear in the log line when the &%received_recipients%& log selector is set.
29429
29430 If the &%log_message%& modifier is set when &%discard%& operates,
29431 its contents are added to the line that is automatically written to the log.
29432 The &%message%& modifier operates exactly as it does for &%accept%&.
29433
29434
29435 .next
29436 .cindex "&%drop%& ACL verb"
29437 &%drop%&: This verb behaves like &%deny%&, except that an SMTP connection is
29438 forcibly closed after the 5&'xx'& error message has been sent. For example:
29439 .code
29440 drop   message   = I don't take more than 20 RCPTs
29441        condition = ${if > {$rcpt_count}{20}}
29442 .endd
29443 There is no difference between &%deny%& and &%drop%& for the connect-time ACL.
29444 The connection is always dropped after sending a 550 response.
29445
29446 .next
29447 .cindex "&%require%& ACL verb"
29448 &%require%&: If all the conditions are met, control is passed to the next ACL
29449 statement. If any of the conditions are not met, the ACL returns &"deny"&. For
29450 example, when checking a RCPT command,
29451 .code
29452 require message = Sender did not verify
29453         verify  = sender
29454 .endd
29455 passes control to subsequent statements only if the message's sender can be
29456 verified. Otherwise, it rejects the command. Note the positioning of the
29457 &%message%& modifier, before the &%verify%& condition. The reason for this is
29458 discussed in section &<<SECTcondmodproc>>&.
29459
29460 .next
29461 .cindex "&%warn%& ACL verb"
29462 &%warn%&: If all the conditions are true, a line specified by the
29463 &%log_message%& modifier is written to Exim's main log. Control always passes
29464 to the next ACL statement. If any condition is false, the log line is not
29465 written. If an identical log line is requested several times in the same
29466 message, only one copy is actually written to the log. If you want to force
29467 duplicates to be written, use the &%logwrite%& modifier instead.
29468
29469 If &%log_message%& is not present, a &%warn%& verb just checks its conditions
29470 and obeys any &"immediate"& modifiers (such as &%control%&, &%set%&,
29471 &%logwrite%&, &%add_header%&, and &%remove_header%&) that appear before the
29472 first failing condition. There is more about adding header lines in section
29473 &<<SECTaddheadacl>>&.
29474
29475 If any condition on a &%warn%& statement cannot be completed (that is, there is
29476 some sort of defer), the log line specified by &%log_message%& is not written.
29477 This does not include the case of a forced failure from a lookup, which
29478 is considered to be a successful completion. After a defer, no further
29479 conditions or modifiers in the &%warn%& statement are processed. The incident
29480 is logged, and the ACL continues to be processed, from the next statement
29481 onwards.
29482
29483
29484 .vindex "&$acl_verify_message$&"
29485 When one of the &%warn%& conditions is an address verification that fails, the
29486 text of the verification failure message is in &$acl_verify_message$&. If you
29487 want this logged, you must set it up explicitly. For example:
29488 .code
29489 warn   !verify = sender
29490        log_message = sender verify failed: $acl_verify_message
29491 .endd
29492 .endlist
29493
29494 At the end of each ACL there is an implicit unconditional &%deny%&.
29495
29496 As you can see from the examples above, the conditions and modifiers are
29497 written one to a line, with the first one on the same line as the verb, and
29498 subsequent ones on following lines. If you have a very long condition, you can
29499 continue it onto several physical lines by the usual backslash continuation
29500 mechanism. It is conventional to align the conditions vertically.
29501
29502
29503
29504 .section "ACL variables" "SECTaclvariables"
29505 .cindex "&ACL;" "variables"
29506 There are some special variables that can be set during ACL processing. They
29507 can be used to pass information between different ACLs, different invocations
29508 of the same ACL in the same SMTP connection, and between ACLs and the routers,
29509 transports, and filters that are used to deliver a message. The names of these
29510 variables must begin with &$acl_c$& or &$acl_m$&, followed either by a digit or
29511 an underscore, but the remainder of the name can be any sequence of
29512 alphanumeric characters and underscores that you choose. There is no limit on
29513 the number of ACL variables. The two sets act as follows:
29514 .ilist
29515 The values of those variables whose names begin with &$acl_c$& persist
29516 throughout an SMTP connection. They are never reset. Thus, a value that is set
29517 while receiving one message is still available when receiving the next message
29518 on the same SMTP connection.
29519 .next
29520 The values of those variables whose names begin with &$acl_m$& persist only
29521 while a message is being received. They are reset afterwards. They are also
29522 reset by MAIL, RSET, EHLO, HELO, and after starting up a TLS session.
29523 .endlist
29524
29525 When a message is accepted, the current values of all the ACL variables are
29526 preserved with the message and are subsequently made available at delivery
29527 time. The ACL variables are set by a modifier called &%set%&. For example:
29528 .code
29529 accept hosts = whatever
29530        set acl_m4 = some value
29531 accept authenticated = *
29532        set acl_c_auth = yes
29533 .endd
29534 &*Note*&: A leading dollar sign is not used when naming a variable that is to
29535 be set. If you want to set a variable without taking any action, you can use a
29536 &%warn%& verb without any other modifiers or conditions.
29537
29538 .oindex &%strict_acl_vars%&
29539 What happens if a syntactically valid but undefined ACL variable is
29540 referenced depends on the setting of the &%strict_acl_vars%& option. If it is
29541 false (the default), an empty string is substituted; if it is true, an
29542 error is generated.
29543
29544 Versions of Exim before 4.64 have a limited set of numbered variables, but
29545 their names are compatible, so there is no problem with upgrading.
29546
29547
29548 .section "Condition and modifier processing" "SECTcondmodproc"
29549 .cindex "&ACL;" "conditions; processing"
29550 .cindex "&ACL;" "modifiers; processing"
29551 An exclamation mark preceding a condition negates its result. For example:
29552 .code
29553 deny   domains = *.dom.example
29554       !verify  = recipient
29555 .endd
29556 causes the ACL to return &"deny"& if the recipient domain ends in
29557 &'dom.example'& and the recipient address cannot be verified. Sometimes
29558 negation can be used on the right-hand side of a condition. For example, these
29559 two statements are equivalent:
29560 .code
29561 deny  hosts = !192.168.3.4
29562 deny !hosts =  192.168.3.4
29563 .endd
29564 However, for many conditions (&%verify%& being a good example), only left-hand
29565 side negation of the whole condition is possible.
29566
29567 The arguments of conditions and modifiers are expanded. A forced failure
29568 of an expansion causes a condition to be ignored, that is, it behaves as if the
29569 condition is true. Consider these two statements:
29570 .code
29571 accept  senders = ${lookup{$host_name}lsearch\
29572                   {/some/file}{$value}fail}
29573 accept  senders = ${lookup{$host_name}lsearch\
29574                   {/some/file}{$value}{}}
29575 .endd
29576 Each attempts to look up a list of acceptable senders. If the lookup succeeds,
29577 the returned list is searched, but if the lookup fails the behaviour is
29578 different in the two cases. The &%fail%& in the first statement causes the
29579 condition to be ignored, leaving no further conditions. The &%accept%& verb
29580 therefore succeeds. The second statement, however, generates an empty list when
29581 the lookup fails. No sender can match an empty list, so the condition fails,
29582 and therefore the &%accept%& also fails.
29583
29584 ACL modifiers appear mixed in with conditions in ACL statements. Some of them
29585 specify actions that are taken as the conditions for a statement are checked;
29586 others specify text for messages that are used when access is denied or a
29587 warning is generated. The &%control%& modifier affects the way an incoming
29588 message is handled.
29589
29590 The positioning of the modifiers in an ACL statement is important, because the
29591 processing of a verb ceases as soon as its outcome is known. Only those
29592 modifiers that have already been encountered will take effect. For example,
29593 consider this use of the &%message%& modifier:
29594 .code
29595 require message = Can't verify sender
29596         verify  = sender
29597         message = Can't verify recipient
29598         verify  = recipient
29599         message = This message cannot be used
29600 .endd
29601 If sender verification fails, Exim knows that the result of the statement is
29602 &"deny"&, so it goes no further. The first &%message%& modifier has been seen,
29603 so its text is used as the error message. If sender verification succeeds, but
29604 recipient verification fails, the second message is used. If recipient
29605 verification succeeds, the third message becomes &"current"&, but is never used
29606 because there are no more conditions to cause failure.
29607
29608 For the &%deny%& verb, on the other hand, it is always the last &%message%&
29609 modifier that is used, because all the conditions must be true for rejection to
29610 happen. Specifying more than one &%message%& modifier does not make sense, and
29611 the message can even be specified after all the conditions. For example:
29612 .code
29613 deny   hosts = ...
29614       !senders = *@my.domain.example
29615        message = Invalid sender from client host
29616 .endd
29617 The &"deny"& result does not happen until the end of the statement is reached,
29618 by which time Exim has set up the message.
29619
29620
29621
29622 .section "ACL modifiers" "SECTACLmodi"
29623 .cindex "&ACL;" "modifiers; list of"
29624 The ACL modifiers are as follows:
29625
29626 .vlist
29627 .vitem &*add_header*&&~=&~<&'text'&>
29628 This modifier specifies one or more header lines that are to be added to an
29629 incoming message, assuming, of course, that the message is ultimately
29630 accepted. For details, see section &<<SECTaddheadacl>>&.
29631
29632 .vitem &*continue*&&~=&~<&'text'&>
29633 .cindex "&%continue%& ACL modifier"
29634 .cindex "database" "updating in ACL"
29635 This modifier does nothing of itself, and processing of the ACL always
29636 continues with the next condition or modifier. The value of &%continue%& is in
29637 the side effects of expanding its argument. Typically this could be used to
29638 update a database. It is really just a syntactic tidiness, to avoid having to
29639 write rather ugly lines like this:
29640 .display
29641 &`condition = ${if eq{0}{`&<&'some expansion'&>&`}{true}{true}}`&
29642 .endd
29643 Instead, all you need is
29644 .display
29645 &`continue = `&<&'some expansion'&>
29646 .endd
29647
29648 .vitem &*control*&&~=&~<&'text'&>
29649 .cindex "&%control%& ACL modifier"
29650 This modifier affects the subsequent processing of the SMTP connection or of an
29651 incoming message that is accepted. The effect of the first type of control
29652 lasts for the duration of the connection, whereas the effect of the second type
29653 lasts only until the current message has been received. The message-specific
29654 controls always apply to the whole message, not to individual recipients,
29655 even if the &%control%& modifier appears in a RCPT ACL.
29656
29657 As there are now quite a few controls that can be applied, they are described
29658 separately in section &<<SECTcontrols>>&. The &%control%& modifier can be used
29659 in several different ways. For example:
29660
29661 . ==== As this is a nested list, any displays it contains must be indented
29662 . ==== as otherwise they are too far to the left. That comment applies only
29663 . ==== when xmlto and fop are used; formatting with sdop gets it right either
29664 . ==== way.
29665
29666 .ilist
29667 It can be at the end of an &%accept%& statement:
29668 .code
29669     accept  ...some conditions
29670             control = queue_only
29671 .endd
29672 In this case, the control is applied when this statement yields &"accept"&, in
29673 other words, when the conditions are all true.
29674
29675 .next
29676 It can be in the middle of an &%accept%& statement:
29677 .code
29678     accept  ...some conditions...
29679             control = queue_only
29680             ...some more conditions...
29681 .endd
29682 If the first set of conditions are true, the control is applied, even if the
29683 statement does not accept because one of the second set of conditions is false.
29684 In this case, some subsequent statement must yield &"accept"& for the control
29685 to be relevant.
29686
29687 .next
29688 It can be used with &%warn%& to apply the control, leaving the
29689 decision about accepting or denying to a subsequent verb. For
29690 example:
29691 .code
29692     warn    ...some conditions...
29693             control = freeze
29694     accept  ...
29695 .endd
29696 This example of &%warn%& does not contain &%message%&, &%log_message%&, or
29697 &%logwrite%&, so it does not add anything to the message and does not write a
29698 log entry.
29699
29700 .next
29701 If you want to apply a control unconditionally, you can use it with a
29702 &%require%& verb. For example:
29703 .code
29704     require  control = no_multiline_responses
29705 .endd
29706 .endlist
29707
29708 .vitem &*delay*&&~=&~<&'time'&>
29709 .cindex "&%delay%& ACL modifier"
29710 .oindex "&%-bh%&"
29711 This modifier may appear in any ACL except notquit. It causes Exim to wait for
29712 the time interval before proceeding. However, when testing Exim using the
29713 &%-bh%& option, the delay is not actually imposed (an appropriate message is
29714 output instead). The time is given in the usual Exim notation, and the delay
29715 happens as soon as the modifier is processed. In an SMTP session, pending
29716 output is flushed before the delay is imposed.
29717
29718 Like &%control%&, &%delay%& can be used with &%accept%& or &%deny%&, for
29719 example:
29720 .code
29721 deny    ...some conditions...
29722         delay = 30s
29723 .endd
29724 The delay happens if all the conditions are true, before the statement returns
29725 &"deny"&. Compare this with:
29726 .code
29727 deny    delay = 30s
29728         ...some conditions...
29729 .endd
29730 which waits for 30s before processing the conditions. The &%delay%& modifier
29731 can also be used with &%warn%& and together with &%control%&:
29732 .code
29733 warn    ...some conditions...
29734         delay = 2m
29735         control = freeze
29736 accept  ...
29737 .endd
29738
29739 If &%delay%& is encountered when the SMTP PIPELINING extension is in use,
29740 responses to several commands are no longer buffered and sent in one packet (as
29741 they would normally be) because all output is flushed before imposing the
29742 delay. This optimization is disabled so that a number of small delays do not
29743 appear to the client as one large aggregated delay that might provoke an
29744 unwanted timeout. You can, however, disable output flushing for &%delay%& by
29745 using a &%control%& modifier to set &%no_delay_flush%&.
29746
29747
29748 .vitem &*endpass*&
29749 .cindex "&%endpass%& ACL modifier"
29750 This modifier, which has no argument, is recognized only in &%accept%& and
29751 &%discard%& statements. It marks the boundary between the conditions whose
29752 failure causes control to pass to the next statement, and the conditions whose
29753 failure causes the ACL to return &"deny"&. This concept has proved to be
29754 confusing to some people, so the use of &%endpass%& is no longer recommended as
29755 &"best practice"&. See the description of &%accept%& above for more details.
29756
29757
29758 .vitem &*log_message*&&~=&~<&'text'&>
29759 .cindex "&%log_message%& ACL modifier"
29760 This modifier sets up a message that is used as part of the log message if the
29761 ACL denies access or a &%warn%& statement's conditions are true. For example:
29762 .code
29763 require log_message = wrong cipher suite $tls_in_cipher
29764         encrypted   = DES-CBC3-SHA
29765 .endd
29766 &%log_message%& is also used when recipients are discarded by &%discard%&. For
29767 example:
29768 .display
29769 &`discard `&<&'some conditions'&>
29770 &`        log_message = Discarded $local_part@$domain because...`&
29771 .endd
29772 When access is denied, &%log_message%& adds to any underlying error message
29773 that may exist because of a condition failure. For example, while verifying a
29774 recipient address, a &':fail:'& redirection might have already set up a
29775 message.
29776
29777 The message may be defined before the conditions to which it applies, because
29778 the string expansion does not happen until Exim decides that access is to be
29779 denied. This means that any variables that are set by the condition are
29780 available for inclusion in the message. For example, the &$dnslist_$&<&'xxx'&>
29781 variables are set after a DNS black list lookup succeeds. If the expansion of
29782 &%log_message%& fails, or if the result is an empty string, the modifier is
29783 ignored.
29784
29785 .vindex "&$acl_verify_message$&"
29786 If you want to use a &%warn%& statement to log the result of an address
29787 verification, you can use &$acl_verify_message$& to include the verification
29788 error message.
29789
29790 If &%log_message%& is used with a &%warn%& statement, &"Warning:"& is added to
29791 the start of the logged message. If the same warning log message is requested
29792 more than once while receiving  a single email message, only one copy is
29793 actually logged. If you want to log multiple copies, use &%logwrite%& instead
29794 of &%log_message%&. In the absence of &%log_message%& and &%logwrite%&, nothing
29795 is logged for a successful &%warn%& statement.
29796
29797 If &%log_message%& is not present and there is no underlying error message (for
29798 example, from the failure of address verification), but &%message%& is present,
29799 the &%message%& text is used for logging rejections. However, if any text for
29800 logging contains newlines, only the first line is logged. In the absence of
29801 both &%log_message%& and &%message%&, a default built-in message is used for
29802 logging rejections.
29803
29804
29805 .vitem "&*log_reject_target*&&~=&~<&'log name list'&>"
29806 .cindex "&%log_reject_target%& ACL modifier"
29807 .cindex "logging in ACL" "specifying which log"
29808 This modifier makes it possible to specify which logs are used for messages
29809 about ACL rejections. Its argument is a colon-separated list of words that can
29810 be &"main"&, &"reject"&, or &"panic"&. The default is &`main:reject`&. The list
29811 may be empty, in which case a rejection is not logged at all. For example, this
29812 ACL fragment writes no logging information when access is denied:
29813 .display
29814 &`deny `&<&'some conditions'&>
29815 &`     log_reject_target =`&
29816 .endd
29817 This modifier can be used in SMTP and non-SMTP ACLs. It applies to both
29818 permanent and temporary rejections. Its effect lasts for the rest of the
29819 current ACL.
29820
29821
29822 .vitem &*logwrite*&&~=&~<&'text'&>
29823 .cindex "&%logwrite%& ACL modifier"
29824 .cindex "logging in ACL" "immediate"
29825 This modifier writes a message to a log file as soon as it is encountered when
29826 processing an ACL. (Compare &%log_message%&, which, except in the case of
29827 &%warn%& and &%discard%&, is used only if the ACL statement denies
29828 access.) The &%logwrite%& modifier can be used to log special incidents in
29829 ACLs. For example:
29830 .display
29831 &`accept `&<&'some special conditions'&>
29832 &`       control  = freeze`&
29833 &`       logwrite = froze message because ...`&
29834 .endd
29835 By default, the message is written to the main log. However, it may begin
29836 with a colon, followed by a comma-separated list of log names, and then
29837 another colon, to specify exactly which logs are to be written. For
29838 example:
29839 .code
29840 logwrite = :main,reject: text for main and reject logs
29841 logwrite = :panic: text for panic log only
29842 .endd
29843
29844
29845 .vitem &*message*&&~=&~<&'text'&>
29846 .cindex "&%message%& ACL modifier"
29847 This modifier sets up a text string that is expanded and used as a response
29848 message when an ACL statement terminates the ACL with an &"accept"&, &"deny"&,
29849 or &"defer"& response. (In the case of the &%accept%& and &%discard%& verbs,
29850 there is some complication if &%endpass%& is involved; see the description of
29851 &%accept%& for details.)
29852
29853 The expansion of the message happens at the time Exim decides that the ACL is
29854 to end, not at the time it processes &%message%&. If the expansion fails, or
29855 generates an empty string, the modifier is ignored. Here is an example where
29856 &%message%& must be specified first, because the ACL ends with a rejection if
29857 the &%hosts%& condition fails:
29858 .code
29859 require  message = Host not recognized
29860          hosts = 10.0.0.0/8
29861 .endd
29862 (Once a condition has failed, no further conditions or modifiers are
29863 processed.)
29864
29865 .cindex "SMTP" "error codes"
29866 .oindex "&%smtp_banner%&
29867 For ACLs that are triggered by SMTP commands, the message is returned as part
29868 of the SMTP response. The use of &%message%& with &%accept%& (or &%discard%&)
29869 is meaningful only for SMTP, as no message is returned when a non-SMTP message
29870 is accepted. In the case of the connect ACL, accepting with a message modifier
29871 overrides the value of &%smtp_banner%&. For the EHLO/HELO ACL, a customized
29872 accept message may not contain more than one line (otherwise it will be
29873 truncated at the first newline and a panic logged), and it cannot affect the
29874 EHLO options.
29875
29876 When SMTP is involved, the message may begin with an overriding response code,
29877 consisting of three digits optionally followed by an &"extended response code"&
29878 of the form &'n.n.n'&, each code being followed by a space. For example:
29879 .code
29880 deny  message = 599 1.2.3 Host not welcome
29881       hosts = 192.168.34.0/24
29882 .endd
29883 The first digit of the supplied response code must be the same as would be sent
29884 by default. A panic occurs if it is not. Exim uses a 550 code when it denies
29885 access, but for the predata ACL, note that the default success code is 354, not
29886 2&'xx'&.
29887
29888 Notwithstanding the previous paragraph, for the QUIT ACL, unlike the others,
29889 the message modifier cannot override the 221 response code.
29890
29891 The text in a &%message%& modifier is literal; any quotes are taken as
29892 literals, but because the string is expanded, backslash escapes are processed
29893 anyway. If the message contains newlines, this gives rise to a multi-line SMTP
29894 response.
29895
29896 .vindex "&$acl_verify_message$&"
29897 For ACLs that are called by an &%acl =%& ACL condition, the message is
29898 stored in &$acl_verify_message$&, from which the calling ACL may use it.
29899
29900 If &%message%& is used on a statement that verifies an address, the message
29901 specified overrides any message that is generated by the verification process.
29902 However, the original message is available in the variable
29903 &$acl_verify_message$&, so you can incorporate it into your message if you
29904 wish. In particular, if you want the text from &%:fail:%& items in &(redirect)&
29905 routers to be passed back as part of the SMTP response, you should either not
29906 use a &%message%& modifier, or make use of &$acl_verify_message$&.
29907
29908 For compatibility with previous releases of Exim, a &%message%& modifier that
29909 is used with a &%warn%& verb behaves in a similar way to the &%add_header%&
29910 modifier, but this usage is now deprecated. However, &%message%& acts only when
29911 all the conditions are true, wherever it appears in an ACL command, whereas
29912 &%add_header%& acts as soon as it is encountered. If &%message%& is used with
29913 &%warn%& in an ACL that is not concerned with receiving a message, it has no
29914 effect.
29915
29916
29917 .vitem &*queue*&&~=&~<&'text'&>
29918 .cindex "&%queue%& ACL modifier"
29919 .cindex "named queues" "selecting in ACL"
29920 This modifier specifies the use of a named queue for spool files
29921 for the message.
29922 It can only be used before the message is received (i.e. not in
29923 the DATA ACL).
29924 This could be used, for example, for known high-volume burst sources
29925 of traffic, or for quarantine of messages.
29926 Separate queue-runner processes will be needed for named queues.
29927 If the text after expansion is empty, the default queue is used.
29928
29929
29930 .vitem &*remove_header*&&~=&~<&'text'&>
29931 This modifier specifies one or more header names in a colon-separated list
29932  that are to be removed from an incoming message, assuming, of course, that
29933 the message is ultimately accepted. For details, see section &<<SECTremoveheadacl>>&.
29934
29935
29936 .vitem &*set*&&~<&'acl_name'&>&~=&~<&'value'&>
29937 .cindex "&%set%& ACL modifier"
29938 This modifier puts a value into one of the ACL variables (see section
29939 &<<SECTaclvariables>>&).
29940
29941
29942 .vitem &*udpsend*&&~=&~<&'parameters'&>
29943 .cindex "UDP communications"
29944 This modifier sends a UDP packet, for purposes such as statistics
29945 collection or behaviour monitoring. The parameters are expanded, and
29946 the result of the expansion must be a colon-separated list consisting
29947 of a destination server, port number, and the packet contents. The
29948 server can be specified as a host name or IPv4 or IPv6 address. The
29949 separator can be changed with the usual angle bracket syntax. For
29950 example, you might want to collect information on which hosts connect
29951 when:
29952 .code
29953 udpsend = <; 2001:dB8::dead:beef ; 1234 ;\
29954              $tod_zulu $sender_host_address
29955 .endd
29956 .endlist
29957
29958
29959
29960
29961 .section "Use of the control modifier" "SECTcontrols"
29962 .cindex "&%control%& ACL modifier"
29963 The &%control%& modifier supports the following settings:
29964
29965 .vlist
29966 .vitem &*control&~=&~allow_auth_unadvertised*&
29967 This modifier allows a client host to use the SMTP AUTH command even when it
29968 has not been advertised in response to EHLO. Furthermore, because there are
29969 apparently some really broken clients that do this, Exim will accept AUTH after
29970 HELO (rather than EHLO) when this control is set. It should be used only if you
29971 really need it, and you should limit its use to those broken clients that do
29972 not work without it. For example:
29973 .code
29974 warn hosts   = 192.168.34.25
29975      control = allow_auth_unadvertised
29976 .endd
29977 Normally, when an Exim server receives an AUTH command, it checks the name of
29978 the authentication mechanism that is given in the command to ensure that it
29979 matches an advertised mechanism. When this control is set, the check that a
29980 mechanism has been advertised is bypassed. Any configured mechanism can be used
29981 by the client. This control is permitted only in the connection and HELO ACLs.
29982
29983
29984 .vitem &*control&~=&~caseful_local_part*& &&&
29985        &*control&~=&~caselower_local_part*&
29986 .cindex "&ACL;" "case of local part in"
29987 .cindex "case of local parts"
29988 .vindex "&$local_part$&"
29989 These two controls are permitted only in the ACL specified by &%acl_smtp_rcpt%&
29990 (that is, during RCPT processing). By default, the contents of &$local_part$&
29991 are lower cased before ACL processing. If &"caseful_local_part"& is specified,
29992 any uppercase letters in the original local part are restored in &$local_part$&
29993 for the rest of the ACL, or until a control that sets &"caselower_local_part"&
29994 is encountered.
29995
29996 These controls affect only the current recipient. Moreover, they apply only to
29997 local part handling that takes place directly in the ACL (for example, as a key
29998 in lookups). If a test to verify the recipient is obeyed, the case-related
29999 handling of the local part during the verification is controlled by the router
30000 configuration (see the &%caseful_local_part%& generic router option).
30001
30002 This facility could be used, for example, to add a spam score to local parts
30003 containing upper case letters. For example, using &$acl_m4$& to accumulate the
30004 spam score:
30005 .code
30006 warn  control = caseful_local_part
30007       set acl_m4 = ${eval:\
30008                      $acl_m4 + \
30009                      ${if match{$local_part}{[A-Z]}{1}{0}}\
30010                     }
30011       control = caselower_local_part
30012 .endd
30013 Notice that we put back the lower cased version afterwards, assuming that
30014 is what is wanted for subsequent tests.
30015
30016
30017 .vitem &*control&~=&~cutthrough_delivery/*&<&'options'&>
30018 .cindex "&ACL;" "cutthrough routing"
30019 .cindex "cutthrough" "requesting"
30020 This option requests delivery be attempted while the item is being received.
30021
30022 The option is usable in the RCPT ACL.
30023 If enabled for a message received via smtp and routed to an smtp transport,
30024 and only one transport, interface, destination host and port combination
30025 is used for all recipients of the message,
30026 then the delivery connection is made while the receiving connection is open
30027 and data is copied from one to the other.
30028
30029 An attempt to set this option for any recipient but the first
30030 for a mail will be quietly ignored.
30031 If a recipient-verify callout
30032 (with use_sender)
30033 connection is subsequently
30034 requested in the same ACL it is held open and used for
30035 any subsequent recipients and the data,
30036 otherwise one is made after the initial RCPT ACL completes.
30037
30038 Note that routers are used in verify mode,
30039 and cannot depend on content of received headers.
30040 Note also that headers cannot be
30041 modified by any of the post-data ACLs (DATA, MIME and DKIM).
30042 Headers may be modified by routers (subject to the above) and transports.
30043 The &'Received-By:'& header is generated as soon as the body reception starts,
30044 rather than the traditional time after the full message is received;
30045 this will affect the timestamp.
30046
30047 All the usual ACLs are called; if one results in the message being
30048 rejected, all effort spent in delivery (including the costs on
30049 the ultimate destination) will be wasted.
30050 Note that in the case of data-time ACLs this includes the entire
30051 message body.
30052
30053 Cutthrough delivery is not supported via transport-filters or when DKIM signing
30054 of outgoing messages is done, because it sends data to the ultimate destination
30055 before the entire message has been received from the source.
30056 It is not supported for messages received with the SMTP PRDR
30057 or CHUNKING
30058 options in use.
30059
30060 Should the ultimate destination system positively accept or reject the mail,
30061 a corresponding indication is given to the source system and nothing is queued.
30062 If the item is successfully delivered in cutthrough mode
30063 the delivery log lines are tagged with ">>" rather than "=>" and appear
30064 before the acceptance "<=" line.
30065
30066 If there is a temporary error the item is queued for later delivery in the
30067 usual fashion.
30068 This behaviour can be adjusted by appending the option &*defer=*&<&'value'&>
30069 to the control; the default value is &"spool"& and the alternate value
30070 &"pass"& copies an SMTP defer response from the target back to the initiator
30071 and does not queue the message.
30072 Note that this is independent of any recipient verify conditions in the ACL.
30073
30074 Delivery in this mode avoids the generation of a bounce mail to a
30075 (possibly faked)
30076 sender when the destination system is doing content-scan based rejection.
30077
30078
30079 .vitem &*control&~=&~debug/*&<&'options'&>
30080 .cindex "&ACL;" "enabling debug logging"
30081 .cindex "debugging" "enabling from an ACL"
30082 This control turns on debug logging, almost as though Exim had been invoked
30083 with &`-d`&, with the output going to a new logfile in the usual logs directory,
30084 by default called &'debuglog'&.
30085 The filename can be adjusted with the &'tag'& option, which
30086 may access any variables already defined.  The logging may be adjusted with
30087 the &'opts'& option, which takes the same values as the &`-d`& command-line
30088 option.
30089 Logging started this way may be stopped, and the file removed,
30090 with the &'kill'& option.
30091 Some examples (which depend on variables that don't exist in all
30092 contexts):
30093 .code
30094       control = debug
30095       control = debug/tag=.$sender_host_address
30096       control = debug/opts=+expand+acl
30097       control = debug/tag=.$message_exim_id/opts=+expand
30098       control = debug/kill
30099 .endd
30100
30101
30102 .vitem &*control&~=&~dkim_disable_verify*&
30103 .cindex "disable DKIM verify"
30104 .cindex "DKIM" "disable verify"
30105 This control turns off DKIM verification processing entirely.  For details on
30106 the operation and configuration of DKIM, see section &<<SECDKIM>>&.
30107
30108
30109 .vitem &*control&~=&~dscp/*&<&'value'&>
30110 .cindex "&ACL;" "setting DSCP value"
30111 .cindex "DSCP" "inbound"
30112 This option causes the DSCP value associated with the socket for the inbound
30113 connection to be adjusted to a given value, given as one of a number of fixed
30114 strings or to numeric value.
30115 The &%-bI:dscp%& option may be used to ask Exim which names it knows of.
30116 Common values include &`throughput`&, &`mincost`&, and on newer systems
30117 &`ef`&, &`af41`&, etc.  Numeric values may be in the range 0 to 0x3F.
30118
30119 The outbound packets from Exim will be marked with this value in the header
30120 (for IPv4, the TOS field; for IPv6, the TCLASS field); there is no guarantee
30121 that these values will have any effect, not be stripped by networking
30122 equipment, or do much of anything without cooperation with your Network
30123 Engineer and those of all network operators between the source and destination.
30124
30125
30126 .vitem &*control&~=&~enforce_sync*& &&&
30127        &*control&~=&~no_enforce_sync*&
30128 .cindex "SMTP" "synchronization checking"
30129 .cindex "synchronization checking in SMTP"
30130 These controls make it possible to be selective about when SMTP synchronization
30131 is enforced. The global option &%smtp_enforce_sync%& specifies the initial
30132 state of the switch (it is true by default). See the description of this option
30133 in chapter &<<CHAPmainconfig>>& for details of SMTP synchronization checking.
30134
30135 The effect of these two controls lasts for the remainder of the SMTP
30136 connection. They can appear in any ACL except the one for the non-SMTP
30137 messages. The most straightforward place to put them is in the ACL defined by
30138 &%acl_smtp_connect%&, which is run at the start of an incoming SMTP connection,
30139 before the first synchronization check. The expected use is to turn off the
30140 synchronization checks for badly-behaved hosts that you nevertheless need to
30141 work with.
30142
30143
30144 .vitem &*control&~=&~fakedefer/*&<&'message'&>
30145 .cindex "fake defer"
30146 .cindex "defer, fake"
30147 This control works in exactly the same way as &%fakereject%& (described below)
30148 except that it causes an SMTP 450 response after the message data instead of a
30149 550 response. You must take care when using &%fakedefer%& because it causes the
30150 messages to be duplicated when the sender retries. Therefore, you should not
30151 use &%fakedefer%& if the message is to be delivered normally.
30152
30153 .vitem &*control&~=&~fakereject/*&<&'message'&>
30154 .cindex "fake rejection"
30155 .cindex "rejection, fake"
30156 This control is permitted only for the MAIL, RCPT, and DATA ACLs, in other
30157 words, only when an SMTP message is being received. If Exim accepts the
30158 message, instead the final 250 response, a 550 rejection message is sent.
30159 However, Exim proceeds to deliver the message as normal. The control applies
30160 only to the current message, not to any subsequent ones that may be received in
30161 the same SMTP connection.
30162
30163 The text for the 550 response is taken from the &%control%& modifier. If no
30164 message is supplied, the following is used:
30165 .code
30166 550-Your message has been rejected but is being
30167 550-kept for evaluation.
30168 550-If it was a legitimate message, it may still be
30169 550 delivered to the target recipient(s).
30170 .endd
30171 This facility should be used with extreme caution.
30172
30173 .vitem &*control&~=&~freeze*&
30174 .cindex "frozen messages" "forcing in ACL"
30175 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30176 other words, only when a message is being received. If the message is accepted,
30177 it is placed on Exim's queue and frozen. The control applies only to the
30178 current message, not to any subsequent ones that may be received in the same
30179 SMTP connection.
30180
30181 This modifier can optionally be followed by &`/no_tell`&. If the global option
30182 &%freeze_tell%& is set, it is ignored for the current message (that is, nobody
30183 is told about the freezing), provided all the &*control=freeze*& modifiers that
30184 are obeyed for the current message have the &`/no_tell`& option.
30185
30186 .vitem &*control&~=&~no_delay_flush*&
30187 .cindex "SMTP" "output flushing, disabling for delay"
30188 Exim normally flushes SMTP output before implementing a delay in an ACL, to
30189 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30190 use. This control, as long as it is encountered before the &%delay%& modifier,
30191 disables such output flushing.
30192
30193 .vitem &*control&~=&~no_callout_flush*&
30194 .cindex "SMTP" "output flushing, disabling for callout"
30195 Exim normally flushes SMTP output before performing a callout in an ACL, to
30196 avoid unexpected timeouts in clients when the SMTP PIPELINING extension is in
30197 use. This control, as long as it is encountered before the &%verify%& condition
30198 that causes the callout, disables such output flushing.
30199
30200 .vitem &*control&~=&~no_mbox_unspool*&
30201 This control is available when Exim is compiled with the content scanning
30202 extension. Content scanning may require a copy of the current message, or parts
30203 of it, to be written in &"mbox format"& to a spool file, for passing to a virus
30204 or spam scanner. Normally, such copies are deleted when they are no longer
30205 needed. If this control is set, the copies are not deleted. The control applies
30206 only to the current message, not to any subsequent ones that may be received in
30207 the same SMTP connection. It is provided for debugging purposes and is unlikely
30208 to be useful in production.
30209
30210 .vitem &*control&~=&~no_multiline_responses*&
30211 .cindex "multiline responses, suppressing"
30212 This control is permitted for any ACL except the one for non-SMTP messages.
30213 It seems that there are broken clients in use that cannot handle multiline
30214 SMTP responses, despite the fact that RFC 821 defined them over 20 years ago.
30215
30216 If this control is set, multiline SMTP responses from ACL rejections are
30217 suppressed. One way of doing this would have been to put out these responses as
30218 one long line. However, RFC 2821 specifies a maximum of 512 bytes per response
30219 (&"use multiline responses for more"& it says &-- ha!), and some of the
30220 responses might get close to that. So this facility, which is after all only a
30221 sop to broken clients, is implemented by doing two very easy things:
30222
30223 .ilist
30224 Extra information that is normally output as part of a rejection caused by
30225 sender verification failure is omitted. Only the final line (typically &"sender
30226 verification failed"&) is sent.
30227 .next
30228 If a &%message%& modifier supplies a multiline response, only the first
30229 line is output.
30230 .endlist
30231
30232 The setting of the switch can, of course, be made conditional on the
30233 calling host. Its effect lasts until the end of the SMTP connection.
30234
30235 .vitem &*control&~=&~no_pipelining*&
30236 .cindex "PIPELINING" "suppressing advertising"
30237 This control turns off the advertising of the PIPELINING extension to SMTP in
30238 the current session. To be useful, it must be obeyed before Exim sends its
30239 response to an EHLO command. Therefore, it should normally appear in an ACL
30240 controlled by &%acl_smtp_connect%& or &%acl_smtp_helo%&. See also
30241 &%pipelining_advertise_hosts%&.
30242
30243 .vitem &*control&~=&~queue_only*&
30244 .oindex "&%queue_only%&"
30245 .cindex "queueing incoming messages"
30246 This control is permitted only for the MAIL, RCPT, DATA, and non-SMTP ACLs, in
30247 other words, only when a message is being received. If the message is accepted,
30248 it is placed on Exim's queue and left there for delivery by a subsequent queue
30249 runner. No immediate delivery process is started. In other words, it has the
30250 effect as the &%queue_only%& global option. However, the control applies only
30251 to the current message, not to any subsequent ones that may be received in the
30252 same SMTP connection.
30253
30254 .vitem &*control&~=&~submission/*&<&'options'&>
30255 .cindex "message" "submission"
30256 .cindex "submission mode"
30257 This control is permitted only for the MAIL, RCPT, and start of data ACLs (the
30258 latter is the one defined by &%acl_smtp_predata%&). Setting it tells Exim that
30259 the current message is a submission from a local MUA. In this case, Exim
30260 operates in &"submission mode"&, and applies certain fixups to the message if
30261 necessary. For example, it adds a &'Date:'& header line if one is not present.
30262 This control is not permitted in the &%acl_smtp_data%& ACL, because that is too
30263 late (the message has already been created).
30264
30265 Chapter &<<CHAPmsgproc>>& describes the processing that Exim applies to
30266 messages. Section &<<SECTsubmodnon>>& covers the processing that happens in
30267 submission mode; the available options for this control are described there.
30268 The control applies only to the current message, not to any subsequent ones
30269 that may be received in the same SMTP connection.
30270
30271 .vitem &*control&~=&~suppress_local_fixups*&
30272 .cindex "submission fixups, suppressing"
30273 This control applies to locally submitted (non TCP/IP) messages, and is the
30274 complement of &`control = submission`&. It disables the fixups that are
30275 normally applied to locally-submitted messages. Specifically:
30276
30277 .ilist
30278 Any &'Sender:'& header line is left alone (in this respect, it is a
30279 dynamic version of &%local_sender_retain%&).
30280 .next
30281 No &'Message-ID:'&, &'From:'&, or &'Date:'& header lines are added.
30282 .next
30283 There is no check that &'From:'& corresponds to the actual sender.
30284 .endlist ilist
30285
30286 This control may be useful when a remotely-originated message is accepted,
30287 passed to some scanning program, and then re-submitted for delivery. It can be
30288 used only in the &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
30289 and &%acl_not_smtp_start%& ACLs, because it has to be set before the message's
30290 data is read.
30291
30292 &*Note:*& This control applies only to the current message, not to any others
30293 that are being submitted at the same time using &%-bs%& or &%-bS%&.
30294
30295 .vitem &*control&~=&~utf8_downconvert*&
30296 This control enables conversion of UTF-8 in message addresses
30297 to a-label form.
30298 For details see section &<<SECTi18nMTA>>&.
30299 .endlist vlist
30300
30301
30302 .section "Summary of message fixup control" "SECTsummesfix"
30303 All four possibilities for message fixups can be specified:
30304
30305 .ilist
30306 Locally submitted, fixups applied: the default.
30307 .next
30308 Locally submitted, no fixups applied: use
30309 &`control = suppress_local_fixups`&.
30310 .next
30311 Remotely submitted, no fixups applied: the default.
30312 .next
30313 Remotely submitted, fixups applied: use &`control = submission`&.
30314 .endlist
30315
30316
30317
30318 .section "Adding header lines in ACLs" "SECTaddheadacl"
30319 .cindex "header lines" "adding in an ACL"
30320 .cindex "header lines" "position of added lines"
30321 .cindex "&%add_header%& ACL modifier"
30322 The &%add_header%& modifier can be used to add one or more extra header lines
30323 to an incoming message, as in this example:
30324 .code
30325 warn dnslists = sbl.spamhaus.org : \
30326                 dialup.mail-abuse.org
30327      add_header = X-blacklisted-at: $dnslist_domain
30328 .endd
30329 The &%add_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30330 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30331 receiving a message). The message must ultimately be accepted for
30332 &%add_header%& to have any significant effect. You can use &%add_header%& with
30333 any ACL verb, including &%deny%& (though this is potentially useful only in a
30334 RCPT ACL).
30335
30336 Headers will not be added to the message if the modifier is used in
30337 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30338
30339 Leading and trailing newlines are removed from
30340 the data for the &%add_header%& modifier; if it then
30341 contains one or more newlines that
30342 are not followed by a space or a tab, it is assumed to contain multiple header
30343 lines. Each one is checked for valid syntax; &`X-ACL-Warn:`& is added to the
30344 front of any line that is not a valid header line.
30345
30346 Added header lines are accumulated during the MAIL, RCPT, and predata ACLs.
30347 They are added to the message before processing the DATA and MIME ACLs.
30348 However, if an identical header line is requested more than once, only one copy
30349 is actually added to the message. Further header lines may be accumulated
30350 during the DATA and MIME ACLs, after which they are added to the message, again
30351 with duplicates suppressed. Thus, it is possible to add two identical header
30352 lines to an SMTP message, but only if one is added before DATA and one after.
30353 In the case of non-SMTP messages, new headers are accumulated during the
30354 non-SMTP ACLs, and are added to the message after all the ACLs have run. If a
30355 message is rejected after DATA or by the non-SMTP ACL, all added header lines
30356 are included in the entry that is written to the reject log.
30357
30358 .cindex "header lines" "added; visibility of"
30359 Header lines are not visible in string expansions
30360 of message headers
30361 until they are added to the
30362 message. It follows that header lines defined in the MAIL, RCPT, and predata
30363 ACLs are not visible until the DATA ACL and MIME ACLs are run. Similarly,
30364 header lines that are added by the DATA or MIME ACLs are not visible in those
30365 ACLs. Because of this restriction, you cannot use header lines as a way of
30366 passing data between (for example) the MAIL and RCPT ACLs. If you want to do
30367 this, you can use ACL variables, as described in section
30368 &<<SECTaclvariables>>&.
30369
30370 The list of headers yet to be added is given by the &%$headers_added%& variable.
30371
30372 The &%add_header%& modifier acts immediately as it is encountered during the
30373 processing of an ACL. Notice the difference between these two cases:
30374 .display
30375 &`accept add_header = ADDED: some text`&
30376 &`       `&<&'some condition'&>
30377
30378 &`accept `&<&'some condition'&>
30379 &`       add_header = ADDED: some text`&
30380 .endd
30381 In the first case, the header line is always added, whether or not the
30382 condition is true. In the second case, the header line is added only if the
30383 condition is true. Multiple occurrences of &%add_header%& may occur in the same
30384 ACL statement. All those that are encountered before a condition fails are
30385 honoured.
30386
30387 .cindex "&%warn%& ACL verb"
30388 For compatibility with previous versions of Exim, a &%message%& modifier for a
30389 &%warn%& verb acts in the same way as &%add_header%&, except that it takes
30390 effect only if all the conditions are true, even if it appears before some of
30391 them. Furthermore, only the last occurrence of &%message%& is honoured. This
30392 usage of &%message%& is now deprecated. If both &%add_header%& and &%message%&
30393 are present on a &%warn%& verb, both are processed according to their
30394 specifications.
30395
30396 By default, new header lines are added to a message at the end of the existing
30397 header lines. However, you can specify that any particular header line should
30398 be added right at the start (before all the &'Received:'& lines), immediately
30399 after the first block of &'Received:'& lines, or immediately before any line
30400 that is not a &'Received:'& or &'Resent-something:'& header.
30401
30402 This is done by specifying &":at_start:"&, &":after_received:"&, or
30403 &":at_start_rfc:"& (or, for completeness, &":at_end:"&) before the text of the
30404 header line, respectively. (Header text cannot start with a colon, as there has
30405 to be a header name first.) For example:
30406 .code
30407 warn add_header = \
30408        :after_received:X-My-Header: something or other...
30409 .endd
30410 If more than one header line is supplied in a single &%add_header%& modifier,
30411 each one is treated independently and can therefore be placed differently. If
30412 you add more than one line at the start, or after the Received: block, they end
30413 up in reverse order.
30414
30415 &*Warning*&: This facility currently applies only to header lines that are
30416 added in an ACL. It does NOT work for header lines that are added in a
30417 system filter or in a router or transport.
30418
30419
30420
30421 .section "Removing header lines in ACLs" "SECTremoveheadacl"
30422 .cindex "header lines" "removing in an ACL"
30423 .cindex "header lines" "position of removed lines"
30424 .cindex "&%remove_header%& ACL modifier"
30425 The &%remove_header%& modifier can be used to remove one or more header lines
30426 from an incoming message, as in this example:
30427 .code
30428 warn   message        = Remove internal headers
30429        remove_header  = x-route-mail1 : x-route-mail2
30430 .endd
30431 The &%remove_header%& modifier is permitted in the MAIL, RCPT, PREDATA, DATA,
30432 MIME, DKIM, and non-SMTP ACLs (in other words, those that are concerned with
30433 receiving a message). The message must ultimately be accepted for
30434 &%remove_header%& to have any significant effect. You can use &%remove_header%&
30435 with any ACL verb, including &%deny%&, though this is really not useful for
30436 any verb that doesn't result in a delivered message.
30437
30438 Headers will not be removed from the message if the modifier is used in
30439 DATA, MIME or DKIM ACLs for a message delivered by cutthrough routing.
30440
30441 More than one header can be removed at the same time by using a colon separated
30442 list of header names. The header matching is case insensitive. Wildcards are
30443 not permitted, nor is list expansion performed, so you cannot use hostlists to
30444 create a list of headers, however both connection and message variable expansion
30445 are performed (&%$acl_c_*%& and &%$acl_m_*%&), illustrated in this example:
30446 .code
30447 warn   hosts           = +internal_hosts
30448        set acl_c_ihdrs = x-route-mail1 : x-route-mail2
30449 warn   message         = Remove internal headers
30450        remove_header   = $acl_c_ihdrs
30451 .endd
30452 Header names for removal are accumulated during the MAIL, RCPT, and predata ACLs.
30453 Matching header lines are removed from the message before processing the DATA and MIME ACLs.
30454 If multiple header lines match, all are removed.
30455 There is no harm in attempting to remove the same header twice nor in removing
30456 a non-existent header. Further header lines to be removed may be accumulated
30457 during the DATA and MIME ACLs, after which they are removed from the message,
30458 if present. In the case of non-SMTP messages, headers to be removed are
30459 accumulated during the non-SMTP ACLs, and are removed from the message after
30460 all the ACLs have run. If a message is rejected after DATA or by the non-SMTP
30461 ACL, there really is no effect because there is no logging of what headers
30462 would have been removed.
30463
30464 .cindex "header lines" "removed; visibility of"
30465 Header lines are not visible in string expansions until the DATA phase when it
30466 is received. Any header lines removed in the MAIL, RCPT, and predata ACLs are
30467 not visible in the DATA ACL and MIME ACLs. Similarly, header lines that are
30468 removed by the DATA or MIME ACLs are still visible in those ACLs. Because of
30469 this restriction, you cannot use header lines as a way of controlling data
30470 passed between (for example) the MAIL and RCPT ACLs. If you want to do this,
30471 you should instead use ACL variables, as described in section
30472 &<<SECTaclvariables>>&.
30473
30474 The &%remove_header%& modifier acts immediately as it is encountered during the
30475 processing of an ACL. Notice the difference between these two cases:
30476 .display
30477 &`accept remove_header = X-Internal`&
30478 &`       `&<&'some condition'&>
30479
30480 &`accept `&<&'some condition'&>
30481 &`       remove_header = X-Internal`&
30482 .endd
30483 In the first case, the header line is always removed, whether or not the
30484 condition is true. In the second case, the header line is removed only if the
30485 condition is true. Multiple occurrences of &%remove_header%& may occur in the
30486 same ACL statement. All those that are encountered before a condition fails
30487 are honoured.
30488
30489 &*Warning*&: This facility currently applies only to header lines that are
30490 present during ACL processing. It does NOT remove header lines that are added
30491 in a system filter or in a router or transport.
30492
30493
30494
30495
30496 .section "ACL conditions" "SECTaclconditions"
30497 .cindex "&ACL;" "conditions; list of"
30498 Some of the conditions listed in this section are available only when Exim is
30499 compiled with the content-scanning extension. They are included here briefly
30500 for completeness. More detailed descriptions can be found in the discussion on
30501 content scanning in chapter &<<CHAPexiscan>>&.
30502
30503 Not all conditions are relevant in all circumstances. For example, testing
30504 senders and recipients does not make sense in an ACL that is being run as the
30505 result of the arrival of an ETRN command, and checks on message headers can be
30506 done only in the ACLs specified by &%acl_smtp_data%& and &%acl_not_smtp%&. You
30507 can use the same condition (with different parameters) more than once in the
30508 same ACL statement. This provides a way of specifying an &"and"& conjunction.
30509 The conditions are as follows:
30510
30511
30512 .vlist
30513 .vitem &*acl&~=&~*&<&'name&~of&~acl&~or&~ACL&~string&~or&~file&~name&~'&>
30514 .cindex "&ACL;" "nested"
30515 .cindex "&ACL;" "indirect"
30516 .cindex "&ACL;" "arguments"
30517 .cindex "&%acl%& ACL condition"
30518 The possible values of the argument are the same as for the
30519 &%acl_smtp_%&&'xxx'& options. The named or inline ACL is run. If it returns
30520 &"accept"& the condition is true; if it returns &"deny"& the condition is
30521 false. If it returns &"defer"&, the current ACL returns &"defer"& unless the
30522 condition is on a &%warn%& verb. In that case, a &"defer"& return makes the
30523 condition false. This means that further processing of the &%warn%& verb
30524 ceases, but processing of the ACL continues.
30525
30526 If the argument is a named ACL, up to nine space-separated optional values
30527 can be appended; they appear within the called ACL in $acl_arg1 to $acl_arg9,
30528 and $acl_narg is set to the count of values.
30529 Previous values of these variables are restored after the call returns.
30530 The name and values are expanded separately.
30531 Note that spaces in complex expansions which are used as arguments
30532 will act as argument separators.
30533
30534 If the nested &%acl%& returns &"drop"& and the outer condition denies access,
30535 the connection is dropped. If it returns &"discard"&, the verb must be
30536 &%accept%& or &%discard%&, and the action is taken immediately &-- no further
30537 conditions are tested.
30538
30539 ACLs may be nested up to 20 deep; the limit exists purely to catch runaway
30540 loops. This condition allows you to use different ACLs in different
30541 circumstances. For example, different ACLs can be used to handle RCPT commands
30542 for different local users or different local domains.
30543
30544 .vitem &*authenticated&~=&~*&<&'string&~list'&>
30545 .cindex "&%authenticated%& ACL condition"
30546 .cindex "authentication" "ACL checking"
30547 .cindex "&ACL;" "testing for authentication"
30548 If the SMTP connection is not authenticated, the condition is false. Otherwise,
30549 the name of the authenticator is tested against the list. To test for
30550 authentication by any authenticator, you can set
30551 .code
30552 authenticated = *
30553 .endd
30554
30555 .vitem &*condition&~=&~*&<&'string'&>
30556 .cindex "&%condition%& ACL condition"
30557 .cindex "customizing" "ACL condition"
30558 .cindex "&ACL;" "customized test"
30559 .cindex "&ACL;" "testing, customized"
30560 This feature allows you to make up custom conditions. If the result of
30561 expanding the string is an empty string, the number zero, or one of the strings
30562 &"no"& or &"false"&, the condition is false. If the result is any non-zero
30563 number, or one of the strings &"yes"& or &"true"&, the condition is true. For
30564 any other value, some error is assumed to have occurred, and the ACL returns
30565 &"defer"&. However, if the expansion is forced to fail, the condition is
30566 ignored. The effect is to treat it as true, whether it is positive or
30567 negative.
30568
30569 .vitem &*decode&~=&~*&<&'location'&>
30570 .cindex "&%decode%& ACL condition"
30571 This condition is available only when Exim is compiled with the
30572 content-scanning extension, and it is allowed only in the ACL defined by
30573 &%acl_smtp_mime%&. It causes the current MIME part to be decoded into a file.
30574 If all goes well, the condition is true. It is false only if there are
30575 problems such as a syntax error or a memory shortage. For more details, see
30576 chapter &<<CHAPexiscan>>&.
30577
30578 .vitem &*dnslists&~=&~*&<&'list&~of&~domain&~names&~and&~other&~data'&>
30579 .cindex "&%dnslists%& ACL condition"
30580 .cindex "DNS list" "in ACL"
30581 .cindex "black list (DNS)"
30582 .cindex "&ACL;" "testing a DNS list"
30583 This condition checks for entries in DNS black lists. These are also known as
30584 &"RBL lists"&, after the original Realtime Blackhole List, but note that the
30585 use of the lists at &'mail-abuse.org'& now carries a charge. There are too many
30586 different variants of this condition to describe briefly here. See sections
30587 &<<SECTmorednslists>>&&--&<<SECTmorednslistslast>>& for details.
30588
30589 .vitem &*domains&~=&~*&<&'domain&~list'&>
30590 .cindex "&%domains%& ACL condition"
30591 .cindex "domain" "ACL checking"
30592 .cindex "&ACL;" "testing a recipient domain"
30593 .vindex "&$domain_data$&"
30594 This condition is relevant only after a RCPT command. It checks that the domain
30595 of the recipient address is in the domain list. If percent-hack processing is
30596 enabled, it is done before this test is done. If the check succeeds with a
30597 lookup, the result of the lookup is placed in &$domain_data$& until the next
30598 &%domains%& test.
30599
30600 &*Note carefully*& (because many people seem to fall foul of this): you cannot
30601 use &%domains%& in a DATA ACL.
30602
30603
30604 .vitem &*encrypted&~=&~*&<&'string&~list'&>
30605 .cindex "&%encrypted%& ACL condition"
30606 .cindex "encryption" "checking in an ACL"
30607 .cindex "&ACL;" "testing for encryption"
30608 If the SMTP connection is not encrypted, the condition is false. Otherwise, the
30609 name of the cipher suite in use is tested against the list. To test for
30610 encryption without testing for any specific cipher suite(s), set
30611 .code
30612 encrypted = *
30613 .endd
30614
30615
30616 .vitem &*hosts&~=&~*&<&'host&~list'&>
30617 .cindex "&%hosts%& ACL condition"
30618 .cindex "host" "ACL checking"
30619 .cindex "&ACL;" "testing the client host"
30620 This condition tests that the calling host matches the host list. If you have
30621 name lookups or wildcarded host names and IP addresses in the same host list,
30622 you should normally put the IP addresses first. For example, you could have:
30623 .code
30624 accept hosts = 10.9.8.7 : dbm;/etc/friendly/hosts
30625 .endd
30626 The lookup in this example uses the host name for its key. This is implied by
30627 the lookup type &"dbm"&. (For a host address lookup you would use &"net-dbm"&
30628 and it wouldn't matter which way round you had these two items.)
30629
30630 The reason for the problem with host names lies in the left-to-right way that
30631 Exim processes lists. It can test IP addresses without doing any DNS lookups,
30632 but when it reaches an item that requires a host name, it fails if it cannot
30633 find a host name to compare with the pattern. If the above list is given in the
30634 opposite order, the &%accept%& statement fails for a host whose name cannot be
30635 found, even if its IP address is 10.9.8.7.
30636
30637 If you really do want to do the name check first, and still recognize the IP
30638 address even if the name lookup fails, you can rewrite the ACL like this:
30639 .code
30640 accept hosts = dbm;/etc/friendly/hosts
30641 accept hosts = 10.9.8.7
30642 .endd
30643 The default action on failing to find the host name is to assume that the host
30644 is not in the list, so the first &%accept%& statement fails. The second
30645 statement can then check the IP address.
30646
30647 .vindex "&$host_data$&"
30648 If a &%hosts%& condition is satisfied by means of a lookup, the result
30649 of the lookup is made available in the &$host_data$& variable. This
30650 allows you, for example, to set up a statement like this:
30651 .code
30652 deny  hosts = net-lsearch;/some/file
30653 message = $host_data
30654 .endd
30655 which gives a custom error message for each denied host.
30656
30657 .vitem &*local_parts&~=&~*&<&'local&~part&~list'&>
30658 .cindex "&%local_parts%& ACL condition"
30659 .cindex "local part" "ACL checking"
30660 .cindex "&ACL;" "testing a local part"
30661 .vindex "&$local_part_data$&"
30662 This condition is relevant only after a RCPT command. It checks that the local
30663 part of the recipient address is in the list. If percent-hack processing is
30664 enabled, it is done before this test. If the check succeeds with a lookup, the
30665 result of the lookup is placed in &$local_part_data$&, which remains set until
30666 the next &%local_parts%& test.
30667
30668 .vitem &*malware&~=&~*&<&'option'&>
30669 .cindex "&%malware%& ACL condition"
30670 .cindex "&ACL;" "virus scanning"
30671 .cindex "&ACL;" "scanning for viruses"
30672 This condition is available only when Exim is compiled with the
30673 content-scanning extension. It causes the incoming message to be scanned for
30674 viruses. For details, see chapter &<<CHAPexiscan>>&.
30675
30676 .vitem &*mime_regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30677 .cindex "&%mime_regex%& ACL condition"
30678 .cindex "&ACL;" "testing by regex matching"
30679 This condition is available only when Exim is compiled with the
30680 content-scanning extension, and it is allowed only in the ACL defined by
30681 &%acl_smtp_mime%&. It causes the current MIME part to be scanned for a match
30682 with any of the regular expressions. For details, see chapter
30683 &<<CHAPexiscan>>&.
30684
30685 .vitem &*ratelimit&~=&~*&<&'parameters'&>
30686 .cindex "rate limiting"
30687 This condition can be used to limit the rate at which a user or host submits
30688 messages. Details are given in section &<<SECTratelimiting>>&.
30689
30690 .vitem &*recipients&~=&~*&<&'address&~list'&>
30691 .cindex "&%recipients%& ACL condition"
30692 .cindex "recipient" "ACL checking"
30693 .cindex "&ACL;" "testing a recipient"
30694 This condition is relevant only after a RCPT command. It checks the entire
30695 recipient address against a list of recipients.
30696
30697 .vitem &*regex&~=&~*&<&'list&~of&~regular&~expressions'&>
30698 .cindex "&%regex%& ACL condition"
30699 .cindex "&ACL;" "testing by regex matching"
30700 This condition is available only when Exim is compiled with the
30701 content-scanning extension, and is available only in the DATA, MIME, and
30702 non-SMTP ACLs. It causes the incoming message to be scanned for a match with
30703 any of the regular expressions. For details, see chapter &<<CHAPexiscan>>&.
30704
30705 .vitem &*sender_domains&~=&~*&<&'domain&~list'&>
30706 .cindex "&%sender_domains%& ACL condition"
30707 .cindex "sender" "ACL checking"
30708 .cindex "&ACL;" "testing a sender domain"
30709 .vindex "&$domain$&"
30710 .vindex "&$sender_address_domain$&"
30711 This condition tests the domain of the sender of the message against the given
30712 domain list. &*Note*&: The domain of the sender address is in
30713 &$sender_address_domain$&. It is &'not'& put in &$domain$& during the testing
30714 of this condition. This is an exception to the general rule for testing domain
30715 lists. It is done this way so that, if this condition is used in an ACL for a
30716 RCPT command, the recipient's domain (which is in &$domain$&) can be used to
30717 influence the sender checking.
30718
30719 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30720 relaying, because sender addresses are easily, and commonly, forged.
30721
30722 .vitem &*senders&~=&~*&<&'address&~list'&>
30723 .cindex "&%senders%& ACL condition"
30724 .cindex "sender" "ACL checking"
30725 .cindex "&ACL;" "testing a sender"
30726 This condition tests the sender of the message against the given list. To test
30727 for a bounce message, which has an empty sender, set
30728 .code
30729 senders = :
30730 .endd
30731 &*Warning*&: It is a bad idea to use this condition on its own as a control on
30732 relaying, because sender addresses are easily, and commonly, forged.
30733
30734 .vitem &*spam&~=&~*&<&'username'&>
30735 .cindex "&%spam%& ACL condition"
30736 .cindex "&ACL;" "scanning for spam"
30737 This condition is available only when Exim is compiled with the
30738 content-scanning extension. It causes the incoming message to be scanned by
30739 SpamAssassin. For details, see chapter &<<CHAPexiscan>>&.
30740
30741 .vitem &*verify&~=&~certificate*&
30742 .cindex "&%verify%& ACL condition"
30743 .cindex "TLS" "client certificate verification"
30744 .cindex "certificate" "verification of client"
30745 .cindex "&ACL;" "certificate verification"
30746 .cindex "&ACL;" "testing a TLS certificate"
30747 This condition is true in an SMTP session if the session is encrypted, and a
30748 certificate was received from the client, and the certificate was verified. The
30749 server requests a certificate only if the client matches &%tls_verify_hosts%&
30750 or &%tls_try_verify_hosts%& (see chapter &<<CHAPTLS>>&).
30751
30752 .vitem &*verify&~=&~csa*&
30753 .cindex "CSA verification"
30754 This condition checks whether the sending host (the client) is authorized to
30755 send email. Details of how this works are given in section
30756 &<<SECTverifyCSA>>&.
30757
30758 .vitem &*verify&~=&~header_names_ascii*&
30759 .cindex "&%verify%& ACL condition"
30760 .cindex "&ACL;" "verifying header names only ASCII"
30761 .cindex "header lines" "verifying header names only ASCII"
30762 .cindex "verifying" "header names only ASCII"
30763 This condition is relevant only in an ACL that is run after a message has been
30764 received, that is, in an ACL specified by &%acl_smtp_data%& or
30765 &%acl_not_smtp%&.  It checks all header names (not the content) to make sure
30766 there are no non-ASCII characters, also excluding control characters.  The
30767 allowable characters are decimal ASCII values 33 through 126.
30768
30769 Exim itself will handle headers with non-ASCII characters, but it can cause
30770 problems for downstream applications, so this option will allow their
30771 detection and rejection in the DATA ACL's.
30772
30773 .vitem &*verify&~=&~header_sender/*&<&'options'&>
30774 .cindex "&%verify%& ACL condition"
30775 .cindex "&ACL;" "verifying sender in the header"
30776 .cindex "header lines" "verifying the sender in"
30777 .cindex "sender" "verifying in header"
30778 .cindex "verifying" "sender in header"
30779 This condition is relevant only in an ACL that is run after a message has been
30780 received, that is, in an ACL specified by &%acl_smtp_data%& or
30781 &%acl_not_smtp%&. It checks that there is a verifiable address in at least one
30782 of the &'Sender:'&, &'Reply-To:'&, or &'From:'& header lines. Such an address
30783 is loosely thought of as a &"sender"& address (hence the name of the test).
30784 However, an address that appears in one of these headers need not be an address
30785 that accepts bounce messages; only sender addresses in envelopes are required
30786 to accept bounces. Therefore, if you use the callout option on this check, you
30787 might want to arrange for a non-empty address in the MAIL command.
30788
30789 Details of address verification and the options are given later, starting at
30790 section &<<SECTaddressverification>>& (callouts are described in section
30791 &<<SECTcallver>>&). You can combine this condition with the &%senders%&
30792 condition to restrict it to bounce messages only:
30793 .code
30794 deny    senders = :
30795         message = A valid sender header is required for bounces
30796        !verify  = header_sender
30797 .endd
30798
30799 .vitem &*verify&~=&~header_syntax*&
30800 .cindex "&%verify%& ACL condition"
30801 .cindex "&ACL;" "verifying header syntax"
30802 .cindex "header lines" "verifying syntax"
30803 .cindex "verifying" "header syntax"
30804 This condition is relevant only in an ACL that is run after a message has been
30805 received, that is, in an ACL specified by &%acl_smtp_data%& or
30806 &%acl_not_smtp%&. It checks the syntax of all header lines that can contain
30807 lists of addresses (&'Sender:'&, &'From:'&, &'Reply-To:'&, &'To:'&, &'Cc:'&,
30808 and &'Bcc:'&), returning true if there are no problems.
30809 Unqualified addresses (local parts without domains) are
30810 permitted only in locally generated messages and from hosts that match
30811 &%sender_unqualified_hosts%& or &%recipient_unqualified_hosts%&, as
30812 appropriate.
30813
30814 Note that this condition is a syntax check only. However, a common spamming
30815 ploy used to be to send syntactically invalid headers such as
30816 .code
30817 To: @
30818 .endd
30819 and this condition can be used to reject such messages, though they are not as
30820 common as they used to be.
30821
30822 .vitem &*verify&~=&~helo*&
30823 .cindex "&%verify%& ACL condition"
30824 .cindex "&ACL;" "verifying HELO/EHLO"
30825 .cindex "HELO" "verifying"
30826 .cindex "EHLO" "verifying"
30827 .cindex "verifying" "EHLO"
30828 .cindex "verifying" "HELO"
30829 This condition is true if a HELO or EHLO command has been received from the
30830 client host, and its contents have been verified. If there has been no previous
30831 attempt to verify the HELO/EHLO contents, it is carried out when this
30832 condition is encountered. See the description of the &%helo_verify_hosts%& and
30833 &%helo_try_verify_hosts%& options for details of how to request verification
30834 independently of this condition.
30835
30836 For SMTP input that does not come over TCP/IP (the &%-bs%& command line
30837 option), this condition is always true.
30838
30839
30840 .vitem &*verify&~=&~not_blind*&
30841 .cindex "verifying" "not blind"
30842 .cindex "bcc recipients, verifying none"
30843 This condition checks that there are no blind (bcc) recipients in the message.
30844 Every envelope recipient must appear either in a &'To:'& header line or in a
30845 &'Cc:'& header line for this condition to be true. Local parts are checked
30846 case-sensitively; domains are checked case-insensitively. If &'Resent-To:'& or
30847 &'Resent-Cc:'& header lines exist, they are also checked. This condition can be
30848 used only in a DATA or non-SMTP ACL.
30849
30850 There are, of course, many legitimate messages that make use of blind (bcc)
30851 recipients. This check should not be used on its own for blocking messages.
30852
30853
30854 .vitem &*verify&~=&~recipient/*&<&'options'&>
30855 .cindex "&%verify%& ACL condition"
30856 .cindex "&ACL;" "verifying recipient"
30857 .cindex "recipient" "verifying"
30858 .cindex "verifying" "recipient"
30859 .vindex "&$address_data$&"
30860 This condition is relevant only after a RCPT command. It verifies the current
30861 recipient. Details of address verification are given later, starting at section
30862 &<<SECTaddressverification>>&. After a recipient has been verified, the value
30863 of &$address_data$& is the last value that was set while routing the address.
30864 This applies even if the verification fails. When an address that is being
30865 verified is redirected to a single address, verification continues with the new
30866 address, and in that case, the subsequent value of &$address_data$& is the
30867 value for the child address.
30868
30869 .vitem &*verify&~=&~reverse_host_lookup/*&<&'options'&>
30870 .cindex "&%verify%& ACL condition"
30871 .cindex "&ACL;" "verifying host reverse lookup"
30872 .cindex "host" "verifying reverse lookup"
30873 This condition ensures that a verified host name has been looked up from the IP
30874 address of the client host. (This may have happened already if the host name
30875 was needed for checking a host list, or if the host matched &%host_lookup%&.)
30876 Verification ensures that the host name obtained from a reverse DNS lookup, or
30877 one of its aliases, does, when it is itself looked up in the DNS, yield the
30878 original IP address.
30879
30880 There is one possible option, &`defer_ok`&.  If this is present and a
30881 DNS operation returns a temporary error, the verify condition succeeds.
30882
30883 If this condition is used for a locally generated message (that is, when there
30884 is no client host involved), it always succeeds.
30885
30886 .vitem &*verify&~=&~sender/*&<&'options'&>
30887 .cindex "&%verify%& ACL condition"
30888 .cindex "&ACL;" "verifying sender"
30889 .cindex "sender" "verifying"
30890 .cindex "verifying" "sender"
30891 This condition is relevant only after a MAIL or RCPT command, or after a
30892 message has been received (the &%acl_smtp_data%& or &%acl_not_smtp%& ACLs). If
30893 the message's sender is empty (that is, this is a bounce message), the
30894 condition is true. Otherwise, the sender address is verified.
30895
30896 .vindex "&$address_data$&"
30897 .vindex "&$sender_address_data$&"
30898 If there is data in the &$address_data$& variable at the end of routing, its
30899 value is placed in &$sender_address_data$& at the end of verification. This
30900 value can be used in subsequent conditions and modifiers in the same ACL
30901 statement. It does not persist after the end of the current statement. If you
30902 want to preserve the value for longer, you can save it in an ACL variable.
30903
30904 Details of verification are given later, starting at section
30905 &<<SECTaddressverification>>&. Exim caches the result of sender verification,
30906 to avoid doing it more than once per message.
30907
30908 .vitem &*verify&~=&~sender=*&<&'address'&>&*/*&<&'options'&>
30909 .cindex "&%verify%& ACL condition"
30910 This is a variation of the previous option, in which a modified address is
30911 verified as a sender.
30912
30913 Note that '/' is legal in local-parts; if the address may have such
30914 (eg. is generated from the received message)
30915 they must be protected from the options parsing by doubling:
30916 .code
30917 verify = sender=${sg{${address:$h_sender:}}{/}{//}}
30918 .endd
30919 .endlist
30920
30921
30922
30923 .section "Using DNS lists" "SECTmorednslists"
30924 .cindex "DNS list" "in ACL"
30925 .cindex "black list (DNS)"
30926 .cindex "&ACL;" "testing a DNS list"
30927 In its simplest form, the &%dnslists%& condition tests whether the calling host
30928 is on at least one of a number of DNS lists by looking up the inverted IP
30929 address in one or more DNS domains. (Note that DNS list domains are not mail
30930 domains, so the &`+`& syntax for named lists doesn't work - it is used for
30931 special options instead.) For example, if the calling host's IP
30932 address is 192.168.62.43, and the ACL statement is
30933 .code
30934 deny dnslists = blackholes.mail-abuse.org : \
30935                 dialups.mail-abuse.org
30936 .endd
30937 the following records are looked up:
30938 .code
30939 43.62.168.192.blackholes.mail-abuse.org
30940 43.62.168.192.dialups.mail-abuse.org
30941 .endd
30942 As soon as Exim finds an existing DNS record, processing of the list stops.
30943 Thus, multiple entries on the list provide an &"or"& conjunction. If you want
30944 to test that a host is on more than one list (an &"and"& conjunction), you can
30945 use two separate conditions:
30946 .code
30947 deny dnslists = blackholes.mail-abuse.org
30948      dnslists = dialups.mail-abuse.org
30949 .endd
30950 If a DNS lookup times out or otherwise fails to give a decisive answer, Exim
30951 behaves as if the host does not match the list item, that is, as if the DNS
30952 record does not exist. If there are further items in the DNS list, they are
30953 processed.
30954
30955 This is usually the required action when &%dnslists%& is used with &%deny%&
30956 (which is the most common usage), because it prevents a DNS failure from
30957 blocking mail. However, you can change this behaviour by putting one of the
30958 following special items in the list:
30959 .display
30960 &`+include_unknown `&   behave as if the item is on the list
30961 &`+exclude_unknown `&   behave as if the item is not on the list (default)
30962 &`+defer_unknown   `&   give a temporary error
30963 .endd
30964 .cindex "&`+include_unknown`&"
30965 .cindex "&`+exclude_unknown`&"
30966 .cindex "&`+defer_unknown`&"
30967 Each of these applies to any subsequent items on the list. For example:
30968 .code
30969 deny dnslists = +defer_unknown : foo.bar.example
30970 .endd
30971 Testing the list of domains stops as soon as a match is found. If you want to
30972 warn for one list and block for another, you can use two different statements:
30973 .code
30974 deny  dnslists = blackholes.mail-abuse.org
30975 warn  message  = X-Warn: sending host is on dialups list
30976       dnslists = dialups.mail-abuse.org
30977 .endd
30978 .cindex caching "of dns lookup"
30979 .cindex DNS TTL
30980 DNS list lookups are cached by Exim for the duration of the SMTP session
30981 (but limited by the DNS return TTL value),
30982 so a lookup based on the IP address is done at most once for any incoming
30983 connection (assuming long-enough TTL).
30984 Exim does not share information between multiple incoming
30985 connections (but your local name server cache should be active).
30986
30987 There are a number of DNS lists to choose from, some commercial, some free,
30988 or free for small deployments.  An overview can be found at
30989 &url(https://en.wikipedia.org/wiki/Comparison_of_DNS_blacklists).
30990
30991
30992
30993 .section "Specifying the IP address for a DNS list lookup" "SECID201"
30994 .cindex "DNS list" "keyed by explicit IP address"
30995 By default, the IP address that is used in a DNS list lookup is the IP address
30996 of the calling host. However, you can specify another IP address by listing it
30997 after the domain name, introduced by a slash. For example:
30998 .code
30999 deny dnslists = black.list.tld/192.168.1.2
31000 .endd
31001 This feature is not very helpful with explicit IP addresses; it is intended for
31002 use with IP addresses that are looked up, for example, the IP addresses of the
31003 MX hosts or nameservers of an email sender address. For an example, see section
31004 &<<SECTmulkeyfor>>& below.
31005
31006
31007
31008
31009 .section "DNS lists keyed on domain names" "SECID202"
31010 .cindex "DNS list" "keyed by domain name"
31011 There are some lists that are keyed on domain names rather than inverted IP
31012 addresses (see, e.g., the &'domain based zones'& link at
31013 &url(http://www.rfc-ignorant.org/)). No reversing of components is used
31014 with these lists. You can change the name that is looked up in a DNS list by
31015 listing it after the domain name, introduced by a slash. For example,
31016 .code
31017 deny  message  = Sender's domain is listed at $dnslist_domain
31018       dnslists = dsn.rfc-ignorant.org/$sender_address_domain
31019 .endd
31020 This particular example is useful only in ACLs that are obeyed after the
31021 RCPT or DATA commands, when a sender address is available. If (for
31022 example) the message's sender is &'user@tld.example'& the name that is looked
31023 up by this example is
31024 .code
31025 tld.example.dsn.rfc-ignorant.org
31026 .endd
31027 A single &%dnslists%& condition can contain entries for both names and IP
31028 addresses. For example:
31029 .code
31030 deny dnslists = sbl.spamhaus.org : \
31031                 dsn.rfc-ignorant.org/$sender_address_domain
31032 .endd
31033 The first item checks the sending host's IP address; the second checks a domain
31034 name. The whole condition is true if either of the DNS lookups succeeds.
31035
31036
31037
31038
31039 .section "Multiple explicit keys for a DNS list" "SECTmulkeyfor"
31040 .cindex "DNS list" "multiple keys for"
31041 The syntax described above for looking up explicitly-defined values (either
31042 names or IP addresses) in a DNS blacklist is a simplification. After the domain
31043 name for the DNS list, what follows the slash can in fact be a list of items.
31044 As with all lists in Exim, the default separator is a colon. However, because
31045 this is a sublist within the list of DNS blacklist domains, it is necessary
31046 either to double the separators like this:
31047 .code
31048 dnslists = black.list.tld/name.1::name.2
31049 .endd
31050 or to change the separator character, like this:
31051 .code
31052 dnslists = black.list.tld/<;name.1;name.2
31053 .endd
31054 If an item in the list is an IP address, it is inverted before the DNS
31055 blacklist domain is appended. If it is not an IP address, no inversion
31056 occurs. Consider this condition:
31057 .code
31058 dnslists = black.list.tld/<;192.168.1.2;a.domain
31059 .endd
31060 The DNS lookups that occur are:
31061 .code
31062 2.1.168.192.black.list.tld
31063 a.domain.black.list.tld
31064 .endd
31065 Once a DNS record has been found (that matches a specific IP return
31066 address, if specified &-- see section &<<SECTaddmatcon>>&), no further lookups
31067 are done. If there is a temporary DNS error, the rest of the sublist of domains
31068 or IP addresses is tried. A temporary error for the whole dnslists item occurs
31069 only if no other DNS lookup in this sublist succeeds. In other words, a
31070 successful lookup for any of the items in the sublist overrides a temporary
31071 error for a previous item.
31072
31073 The ability to supply a list of items after the slash is in some sense just a
31074 syntactic convenience. These two examples have the same effect:
31075 .code
31076 dnslists = black.list.tld/a.domain : black.list.tld/b.domain
31077 dnslists = black.list.tld/a.domain::b.domain
31078 .endd
31079 However, when the data for the list is obtained from a lookup, the second form
31080 is usually much more convenient. Consider this example:
31081 .code
31082 deny message  = The mail servers for the domain \
31083                 $sender_address_domain \
31084                 are listed at $dnslist_domain ($dnslist_value); \
31085                 see $dnslist_text.
31086      dnslists = sbl.spamhaus.org/<|${lookup dnsdb {>|a=<|\
31087                                    ${lookup dnsdb {>|mxh=\
31088                                    $sender_address_domain} }} }
31089 .endd
31090 Note the use of &`>|`& in the dnsdb lookup to specify the separator for
31091 multiple DNS records. The inner dnsdb lookup produces a list of MX hosts
31092 and the outer dnsdb lookup finds the IP addresses for these hosts. The result
31093 of expanding the condition might be something like this:
31094 .code
31095 dnslists = sbl.spamhaus.org/<|192.168.2.3|192.168.5.6|...
31096 .endd
31097 Thus, this example checks whether or not the IP addresses of the sender
31098 domain's mail servers are on the Spamhaus black list.
31099
31100 The key that was used for a successful DNS list lookup is put into the variable
31101 &$dnslist_matched$& (see section &<<SECID204>>&).
31102
31103
31104
31105
31106 .section "Data returned by DNS lists" "SECID203"
31107 .cindex "DNS list" "data returned from"
31108 DNS lists are constructed using address records in the DNS. The original RBL
31109 just used the address 127.0.0.1 on the right hand side of each record, but the
31110 RBL+ list and some other lists use a number of values with different meanings.
31111 The values used on the RBL+ list are:
31112 .display
31113 127.1.0.1  RBL
31114 127.1.0.2  DUL
31115 127.1.0.3  DUL and RBL
31116 127.1.0.4  RSS
31117 127.1.0.5  RSS and RBL
31118 127.1.0.6  RSS and DUL
31119 127.1.0.7  RSS and DUL and RBL
31120 .endd
31121 Section &<<SECTaddmatcon>>& below describes how you can distinguish between
31122 different values. Some DNS lists may return more than one address record;
31123 see section &<<SECThanmuldnsrec>>& for details of how they are checked.
31124
31125
31126 .section "Variables set from DNS lists" "SECID204"
31127 .cindex "expansion" "variables, set from DNS list"
31128 .cindex "DNS list" "variables set from"
31129 .vindex "&$dnslist_domain$&"
31130 .vindex "&$dnslist_matched$&"
31131 .vindex "&$dnslist_text$&"
31132 .vindex "&$dnslist_value$&"
31133 When an entry is found in a DNS list, the variable &$dnslist_domain$& contains
31134 the name of the overall domain that matched (for example,
31135 &`spamhaus.example`&), &$dnslist_matched$& contains the key within that domain
31136 (for example, &`192.168.5.3`&), and &$dnslist_value$& contains the data from
31137 the DNS record. When the key is an IP address, it is not reversed in
31138 &$dnslist_matched$& (though it is, of course, in the actual lookup). In simple
31139 cases, for example:
31140 .code
31141 deny dnslists = spamhaus.example
31142 .endd
31143 the key is also available in another variable (in this case,
31144 &$sender_host_address$&). In more complicated cases, however, this is not true.
31145 For example, using a data lookup (as described in section &<<SECTmulkeyfor>>&)
31146 might generate a dnslists lookup like this:
31147 .code
31148 deny dnslists = spamhaus.example/<|192.168.1.2|192.168.6.7|...
31149 .endd
31150 If this condition succeeds, the value in &$dnslist_matched$& might be
31151 &`192.168.6.7`& (for example).
31152
31153 If more than one address record is returned by the DNS lookup, all the IP
31154 addresses are included in &$dnslist_value$&, separated by commas and spaces.
31155 The variable &$dnslist_text$& contains the contents of any associated TXT
31156 record. For lists such as RBL+ the TXT record for a merged entry is often not
31157 very meaningful. See section &<<SECTmordetinf>>& for a way of obtaining more
31158 information.
31159
31160 You can use the DNS list variables in &%message%& or &%log_message%& modifiers
31161 &-- although these appear before the condition in the ACL, they are not
31162 expanded until after it has failed. For example:
31163 .code
31164 deny    hosts = !+local_networks
31165         message = $sender_host_address is listed \
31166                   at $dnslist_domain
31167         dnslists = rbl-plus.mail-abuse.example
31168 .endd
31169
31170
31171
31172 .section "Additional matching conditions for DNS lists" "SECTaddmatcon"
31173 .cindex "DNS list" "matching specific returned data"
31174 You can add an equals sign and an IP address after a &%dnslists%& domain name
31175 in order to restrict its action to DNS records with a matching right hand side.
31176 For example,
31177 .code
31178 deny dnslists = rblplus.mail-abuse.org=127.0.0.2
31179 .endd
31180 rejects only those hosts that yield 127.0.0.2. Without this additional data,
31181 any address record is considered to be a match. For the moment, we assume
31182 that the DNS lookup returns just one record. Section &<<SECThanmuldnsrec>>&
31183 describes how multiple records are handled.
31184
31185 More than one IP address may be given for checking, using a comma as a
31186 separator. These are alternatives &-- if any one of them matches, the
31187 &%dnslists%& condition is true. For example:
31188 .code
31189 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31190 .endd
31191 If you want to specify a constraining address list and also specify names or IP
31192 addresses to be looked up, the constraining address list must be specified
31193 first. For example:
31194 .code
31195 deny dnslists = dsn.rfc-ignorant.org\
31196                 =127.0.0.2/$sender_address_domain
31197 .endd
31198
31199 If the character &`&&`& is used instead of &`=`&, the comparison for each
31200 listed IP address is done by a bitwise &"and"& instead of by an equality test.
31201 In other words, the listed addresses are used as bit masks. The comparison is
31202 true if all the bits in the mask are present in the address that is being
31203 tested. For example:
31204 .code
31205 dnslists = a.b.c&0.0.0.3
31206 .endd
31207 matches if the address is &'x.x.x.'&3, &'x.x.x.'&7, &'x.x.x.'&11, etc. If you
31208 want to test whether one bit or another bit is present (as opposed to both
31209 being present), you must use multiple values. For example:
31210 .code
31211 dnslists = a.b.c&0.0.0.1,0.0.0.2
31212 .endd
31213 matches if the final component of the address is an odd number or two times
31214 an odd number.
31215
31216
31217
31218 .section "Negated DNS matching conditions" "SECID205"
31219 You can supply a negative list of IP addresses as part of a &%dnslists%&
31220 condition. Whereas
31221 .code
31222 deny  dnslists = a.b.c=127.0.0.2,127.0.0.3
31223 .endd
31224 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31225 IP address yielded by the list is either 127.0.0.2 or 127.0.0.3"&,
31226 .code
31227 deny  dnslists = a.b.c!=127.0.0.2,127.0.0.3
31228 .endd
31229 means &"deny if the host is in the black list at the domain &'a.b.c'& and the
31230 IP address yielded by the list is not 127.0.0.2 and not 127.0.0.3"&. In other
31231 words, the result of the test is inverted if an exclamation mark appears before
31232 the &`=`& (or the &`&&`&) sign.
31233
31234 &*Note*&: This kind of negation is not the same as negation in a domain,
31235 host, or address list (which is why the syntax is different).
31236
31237 If you are using just one list, the negation syntax does not gain you much. The
31238 previous example is precisely equivalent to
31239 .code
31240 deny  dnslists = a.b.c
31241      !dnslists = a.b.c=127.0.0.2,127.0.0.3
31242 .endd
31243 However, if you are using multiple lists, the negation syntax is clearer.
31244 Consider this example:
31245 .code
31246 deny  dnslists = sbl.spamhaus.org : \
31247                  list.dsbl.org : \
31248                  dnsbl.njabl.org!=127.0.0.3 : \
31249                  relays.ordb.org
31250 .endd
31251 Using only positive lists, this would have to be:
31252 .code
31253 deny  dnslists = sbl.spamhaus.org : \
31254                  list.dsbl.org
31255 deny  dnslists = dnsbl.njabl.org
31256      !dnslists = dnsbl.njabl.org=127.0.0.3
31257 deny  dnslists = relays.ordb.org
31258 .endd
31259 which is less clear, and harder to maintain.
31260
31261
31262
31263
31264 .section "Handling multiple DNS records from a DNS list" "SECThanmuldnsrec"
31265 A DNS lookup for a &%dnslists%& condition may return more than one DNS record,
31266 thereby providing more than one IP address. When an item in a &%dnslists%& list
31267 is followed by &`=`& or &`&&`& and a list of IP addresses, in order to restrict
31268 the match to specific results from the DNS lookup, there are two ways in which
31269 the checking can be handled. For example, consider the condition:
31270 .code
31271 dnslists = a.b.c=127.0.0.1
31272 .endd
31273 What happens if the DNS lookup for the incoming IP address yields both
31274 127.0.0.1 and 127.0.0.2 by means of two separate DNS records? Is the
31275 condition true because at least one given value was found, or is it false
31276 because at least one of the found values was not listed? And how does this
31277 affect negated conditions? Both possibilities are provided for with the help of
31278 additional separators &`==`& and &`=&&`&.
31279
31280 .ilist
31281 If &`=`& or &`&&`& is used, the condition is true if any one of the looked up
31282 IP addresses matches one of the listed addresses. For the example above, the
31283 condition is true because 127.0.0.1 matches.
31284 .next
31285 If &`==`& or &`=&&`& is used, the condition is true only if every one of the
31286 looked up IP addresses matches one of the listed addresses. If the condition is
31287 changed to:
31288 .code
31289 dnslists = a.b.c==127.0.0.1
31290 .endd
31291 and the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31292 false because 127.0.0.2 is not listed. You would need to have:
31293 .code
31294 dnslists = a.b.c==127.0.0.1,127.0.0.2
31295 .endd
31296 for the condition to be true.
31297 .endlist
31298
31299 When &`!`& is used to negate IP address matching, it inverts the result, giving
31300 the precise opposite of the behaviour above. Thus:
31301 .ilist
31302 If &`!=`& or &`!&&`& is used, the condition is true if none of the looked up IP
31303 addresses matches one of the listed addresses. Consider:
31304 .code
31305 dnslists = a.b.c!&0.0.0.1
31306 .endd
31307 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31308 false because 127.0.0.1 matches.
31309 .next
31310 If &`!==`& or &`!=&&`& is used, the condition is true if there is at least one
31311 looked up IP address that does not match. Consider:
31312 .code
31313 dnslists = a.b.c!=&0.0.0.1
31314 .endd
31315 If the DNS lookup yields both 127.0.0.1 and 127.0.0.2, the condition is
31316 true, because 127.0.0.2 does not match. You would need to have:
31317 .code
31318 dnslists = a.b.c!=&0.0.0.1,0.0.0.2
31319 .endd
31320 for the condition to be false.
31321 .endlist
31322 When the DNS lookup yields only a single IP address, there is no difference
31323 between &`=`& and &`==`& and between &`&&`& and &`=&&`&.
31324
31325
31326
31327
31328 .section "Detailed information from merged DNS lists" "SECTmordetinf"
31329 .cindex "DNS list" "information from merged"
31330 When the facility for restricting the matching IP values in a DNS list is used,
31331 the text from the TXT record that is set in &$dnslist_text$& may not reflect
31332 the true reason for rejection. This happens when lists are merged and the IP
31333 address in the A record is used to distinguish them; unfortunately there is
31334 only one TXT record. One way round this is not to use merged lists, but that
31335 can be inefficient because it requires multiple DNS lookups where one would do
31336 in the vast majority of cases when the host of interest is not on any of the
31337 lists.
31338
31339 A less inefficient way of solving this problem is available. If
31340 two domain names, comma-separated, are given, the second is used first to
31341 do an initial check, making use of any IP value restrictions that are set.
31342 If there is a match, the first domain is used, without any IP value
31343 restrictions, to get the TXT record. As a byproduct of this, there is also
31344 a check that the IP being tested is indeed on the first list. The first
31345 domain is the one that is put in &$dnslist_domain$&. For example:
31346 .code
31347 deny message  = \
31348          rejected because $sender_host_address is blacklisted \
31349          at $dnslist_domain\n$dnslist_text
31350        dnslists = \
31351          sbl.spamhaus.org,sbl-xbl.spamhaus.org=127.0.0.2 : \
31352          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31353 .endd
31354 For the first blacklist item, this starts by doing a lookup in
31355 &'sbl-xbl.spamhaus.org'& and testing for a 127.0.0.2 return. If there is a
31356 match, it then looks in &'sbl.spamhaus.org'&, without checking the return
31357 value, and as long as something is found, it looks for the corresponding TXT
31358 record. If there is no match in &'sbl-xbl.spamhaus.org'&, nothing more is done.
31359 The second blacklist item is processed similarly.
31360
31361 If you are interested in more than one merged list, the same list must be
31362 given several times, but because the results of the DNS lookups are cached,
31363 the DNS calls themselves are not repeated. For example:
31364 .code
31365 deny dnslists = \
31366          http.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.2 : \
31367          socks.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.3 : \
31368          misc.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.4 : \
31369          dul.dnsbl.sorbs.net,dnsbl.sorbs.net=127.0.0.10
31370 .endd
31371 In this case there is one lookup in &'dnsbl.sorbs.net'&, and if none of the IP
31372 values matches (or if no record is found), this is the only lookup that is
31373 done. Only if there is a match is one of the more specific lists consulted.
31374
31375
31376
31377 .section "DNS lists and IPv6" "SECTmorednslistslast"
31378 .cindex "IPv6" "DNS black lists"
31379 .cindex "DNS list" "IPv6 usage"
31380 If Exim is asked to do a dnslist lookup for an IPv6 address, it inverts it
31381 nibble by nibble. For example, if the calling host's IP address is
31382 3ffe:ffff:836f:0a00:000a:0800:200a:c031, Exim might look up
31383 .code
31384 1.3.0.c.a.0.0.2.0.0.8.0.a.0.0.0.0.0.a.0.f.6.3.8.
31385   f.f.f.f.e.f.f.3.blackholes.mail-abuse.org
31386 .endd
31387 (split over two lines here to fit on the page). Unfortunately, some of the DNS
31388 lists contain wildcard records, intended for IPv4, that interact badly with
31389 IPv6. For example, the DNS entry
31390 .code
31391 *.3.some.list.example.    A    127.0.0.1
31392 .endd
31393 is probably intended to put the entire 3.0.0.0/8 IPv4 network on the list.
31394 Unfortunately, it also matches the entire 3::/4 IPv6 network.
31395
31396 You can exclude IPv6 addresses from DNS lookups by making use of a suitable
31397 &%condition%& condition, as in this example:
31398 .code
31399 deny   condition = ${if isip4{$sender_host_address}}
31400        dnslists  = some.list.example
31401 .endd
31402
31403 If an explicit key is being used for a DNS lookup and it may be an IPv6
31404 address you should specify alternate list separators for both the outer
31405 (DNS list name) list and inner (lookup keys) list:
31406 .code
31407        dnslists = <; dnsbl.example.com/<|$acl_m_addrslist
31408 .endd
31409
31410 .section "Rate limiting incoming messages" "SECTratelimiting"
31411 .cindex "rate limiting" "client sending"
31412 .cindex "limiting client sending rates"
31413 .oindex "&%smtp_ratelimit_*%&"
31414 The &%ratelimit%& ACL condition can be used to measure and control the rate at
31415 which clients can send email. This is more powerful than the
31416 &%smtp_ratelimit_*%& options, because those options control the rate of
31417 commands in a single SMTP session only, whereas the &%ratelimit%& condition
31418 works across all connections (concurrent and sequential) from the same client
31419 host. The syntax of the &%ratelimit%& condition is:
31420 .display
31421 &`ratelimit =`& <&'m'&> &`/`& <&'p'&> &`/`& <&'options'&> &`/`& <&'key'&>
31422 .endd
31423 If the average client sending rate is less than &'m'& messages per time
31424 period &'p'& then the condition is false; otherwise it is true.
31425
31426 As a side-effect, the &%ratelimit%& condition sets the expansion variable
31427 &$sender_rate$& to the client's computed rate, &$sender_rate_limit$& to the
31428 configured value of &'m'&, and &$sender_rate_period$& to the configured value
31429 of &'p'&.
31430
31431 The parameter &'p'& is the smoothing time constant, in the form of an Exim
31432 time interval, for example, &`8h`& for eight hours. A larger time constant
31433 means that it takes Exim longer to forget a client's past behaviour. The
31434 parameter &'m'& is the maximum number of messages that a client is permitted to
31435 send in each time interval. It also specifies the number of messages permitted
31436 in a fast burst. By increasing both &'m'& and &'p'& but keeping &'m/p'&
31437 constant, you can allow a client to send more messages in a burst without
31438 changing its long-term sending rate limit. Conversely, if &'m'& and &'p'& are
31439 both small, messages must be sent at an even rate.
31440
31441 There is a script in &_util/ratelimit.pl_& which extracts sending rates from
31442 log files, to assist with choosing appropriate settings for &'m'& and &'p'&
31443 when deploying the &%ratelimit%& ACL condition. The script prints usage
31444 instructions when it is run with no arguments.
31445
31446 The key is used to look up the data for calculating the client's average
31447 sending rate. This data is stored in Exim's spool directory, alongside the
31448 retry and other hints databases. The default key is &$sender_host_address$&,
31449 which means Exim computes the sending rate of each client host IP address.
31450 By changing the key you can change how Exim identifies clients for the purpose
31451 of ratelimiting. For example, to limit the sending rate of each authenticated
31452 user, independent of the computer they are sending from, set the key to
31453 &$authenticated_id$&. You must ensure that the lookup key is meaningful; for
31454 example, &$authenticated_id$& is only meaningful if the client has
31455 authenticated (which you can check with the &%authenticated%& ACL condition).
31456
31457 The lookup key does not have to identify clients: If you want to limit the
31458 rate at which a recipient receives messages, you can use the key
31459 &`$local_part@$domain`& with the &%per_rcpt%& option (see below) in a RCPT
31460 ACL.
31461
31462 Each &%ratelimit%& condition can have up to four options. A &%per_*%& option
31463 specifies what Exim measures the rate of, for example, messages or recipients
31464 or bytes. You can adjust the measurement using the &%unique=%& and/or
31465 &%count=%& options. You can also control when Exim updates the recorded rate
31466 using a &%strict%&, &%leaky%&, or &%readonly%& option. The options are
31467 separated by a slash, like the other parameters. They may appear in any order.
31468
31469 Internally, Exim appends the smoothing constant &'p'& onto the lookup key with
31470 any options that alter the meaning of the stored data. The limit &'m'& is not
31471 stored, so you can alter the configured maximum rate and Exim will still
31472 remember clients' past behaviour. If you change the &%per_*%& mode or add or
31473 remove the &%unique=%& option, the lookup key changes so Exim will forget past
31474 behaviour. The lookup key is not affected by changes to the update mode and
31475 the &%count=%& option.
31476
31477
31478 .section "Ratelimit options for what is being measured" "ratoptmea"
31479 .cindex "rate limiting" "per_* options"
31480 The &%per_conn%& option limits the client's connection rate. It is not
31481 normally used in the &%acl_not_smtp%&, &%acl_not_smtp_mime%&, or
31482 &%acl_not_smtp_start%& ACLs.
31483
31484 The &%per_mail%& option limits the client's rate of sending messages. This is
31485 the default if none of the &%per_*%& options is specified. It can be used in
31486 &%acl_smtp_mail%&, &%acl_smtp_rcpt%&, &%acl_smtp_predata%&, &%acl_smtp_mime%&,
31487 &%acl_smtp_data%&, or &%acl_not_smtp%&.
31488
31489 The &%per_byte%& option limits the sender's email bandwidth. It can be used in
31490 the same ACLs as the &%per_mail%& option, though it is best to use this option
31491 in the &%acl_smtp_mime%&, &%acl_smtp_data%& or &%acl_not_smtp%& ACLs; if it is
31492 used in an earlier ACL, Exim relies on the SIZE parameter given by the client
31493 in its MAIL command, which may be inaccurate or completely missing. You can
31494 follow the limit &'m'& in the configuration with K, M, or G to specify limits
31495 in kilobytes, megabytes, or gigabytes, respectively.
31496
31497 The &%per_rcpt%& option causes Exim to limit the rate at which recipients are
31498 accepted. It can be used in the &%acl_smtp_rcpt%&, &%acl_smtp_predata%&,
31499 &%acl_smtp_mime%&, &%acl_smtp_data%&, or &%acl_smtp_rcpt%& ACLs. In
31500 &%acl_smtp_rcpt%& the rate is updated one recipient at a time; in the other
31501 ACLs the rate is updated with the total (accepted) recipient count in one go. Note that
31502 in either case the rate limiting engine will see a message with many
31503 recipients as a large high-speed burst.
31504
31505 The &%per_addr%& option is like the &%per_rcpt%& option, except it counts the
31506 number of different recipients that the client has sent messages to in the
31507 last time period. That is, if the client repeatedly sends messages to the same
31508 recipient, its measured rate is not increased. This option can only be used in
31509 &%acl_smtp_rcpt%&.
31510
31511 The &%per_cmd%& option causes Exim to recompute the rate every time the
31512 condition is processed. This can be used to limit the rate of any SMTP
31513 command. If it is used in multiple ACLs it can limit the aggregate rate of
31514 multiple different commands.
31515
31516 The &%count=%& option can be used to alter how much Exim adds to the client's
31517 measured rate. For example, the &%per_byte%& option is equivalent to
31518 &`per_mail/count=$message_size`&. If there is no &%count=%& option, Exim
31519 increases the measured rate by one (except for the &%per_rcpt%& option in ACLs
31520 other than &%acl_smtp_rcpt%&). The count does not have to be an integer.
31521
31522 The &%unique=%& option is described in section &<<ratoptuniq>>& below.
31523
31524
31525 .section "Ratelimit update modes" "ratoptupd"
31526 .cindex "rate limiting" "reading data without updating"
31527 You can specify one of three options with the &%ratelimit%& condition to
31528 control when its database is updated. This section describes the &%readonly%&
31529 mode, and the next section describes the &%strict%& and &%leaky%& modes.
31530
31531 If the &%ratelimit%& condition is used in &%readonly%& mode, Exim looks up a
31532 previously-computed rate to check against the limit.
31533
31534 For example, you can test the client's sending rate and deny it access (when
31535 it is too fast) in the connect ACL. If the client passes this check then it
31536 can go on to send a message, in which case its recorded rate will be updated
31537 in the MAIL ACL. Subsequent connections from the same client will check this
31538 new rate.
31539 .code
31540 acl_check_connect:
31541  deny ratelimit = 100 / 5m / readonly
31542     log_message = RATE CHECK: $sender_rate/$sender_rate_period \
31543                   (max $sender_rate_limit)
31544 # ...
31545 acl_check_mail:
31546  warn ratelimit = 100 / 5m / strict
31547     log_message = RATE UPDATE: $sender_rate/$sender_rate_period \
31548                   (max $sender_rate_limit)
31549 .endd
31550
31551 If Exim encounters multiple &%ratelimit%& conditions with the same key when
31552 processing a message then it may increase the client's measured rate more than
31553 it should. For example, this will happen if you check the &%per_rcpt%& option
31554 in both &%acl_smtp_rcpt%& and &%acl_smtp_data%&. However it's OK to check the
31555 same &%ratelimit%& condition multiple times in the same ACL. You can avoid any
31556 multiple update problems by using the &%readonly%& option on later ratelimit
31557 checks.
31558
31559 The &%per_*%& options described above do not make sense in some ACLs. If you
31560 use a &%per_*%& option in an ACL where it is not normally permitted then the
31561 update mode defaults to &%readonly%& and you cannot specify the &%strict%& or
31562 &%leaky%& modes. In other ACLs the default update mode is &%leaky%& (see the
31563 next section) so you must specify the &%readonly%& option explicitly.
31564
31565
31566 .section "Ratelimit options for handling fast clients" "ratoptfast"
31567 .cindex "rate limiting" "strict and leaky modes"
31568 If a client's average rate is greater than the maximum, the rate limiting
31569 engine can react in two possible ways, depending on the presence of the
31570 &%strict%& or &%leaky%& update modes. This is independent of the other
31571 counter-measures (such as rejecting the message) that may be specified by the
31572 rest of the ACL.
31573
31574 The &%leaky%& (default) option means that the client's recorded rate is not
31575 updated if it is above the limit. The effect of this is that Exim measures the
31576 client's average rate of successfully sent email,
31577 up to the given limit.
31578 This is appropriate if the countermeasure when the condition is true
31579 consists of refusing the message, and
31580 is generally the better choice if you have clients that retry automatically.
31581 If the action when true is anything more complex then this option is
31582 likely not what is wanted.
31583
31584 The &%strict%& option means that the client's recorded rate is always
31585 updated. The effect of this is that Exim measures the client's average rate
31586 of attempts to send email, which can be much higher than the maximum it is
31587 actually allowed. If the client is over the limit it may be subjected to
31588 counter-measures by the ACL. It must slow down and allow sufficient time to
31589 pass that its computed rate falls below the maximum before it can send email
31590 again. The time (the number of smoothing periods) it must wait and not
31591 attempt to send mail can be calculated with this formula:
31592 .code
31593         ln(peakrate/maxrate)
31594 .endd
31595
31596
31597 .section "Limiting the rate of different events" "ratoptuniq"
31598 .cindex "rate limiting" "counting unique events"
31599 The &%ratelimit%& &%unique=%& option controls a mechanism for counting the
31600 rate of different events. For example, the &%per_addr%& option uses this
31601 mechanism to count the number of different recipients that the client has
31602 sent messages to in the last time period; it is equivalent to
31603 &`per_rcpt/unique=$local_part@$domain`&. You could use this feature to
31604 measure the rate that a client uses different sender addresses with the
31605 options &`per_mail/unique=$sender_address`&.
31606
31607 For each &%ratelimit%& key Exim stores the set of &%unique=%& values that it
31608 has seen for that key. The whole set is thrown away when it is older than the
31609 rate smoothing period &'p'&, so each different event is counted at most once
31610 per period. In the &%leaky%& update mode, an event that causes the client to
31611 go over the limit is not added to the set, in the same way that the client's
31612 recorded rate is not updated in the same situation.
31613
31614 When you combine the &%unique=%& and &%readonly%& options, the specific
31615 &%unique=%& value is ignored, and Exim just retrieves the client's stored
31616 rate.
31617
31618 The &%unique=%& mechanism needs more space in the ratelimit database than the
31619 other &%ratelimit%& options in order to store the event set. The number of
31620 unique values is potentially as large as the rate limit, so the extra space
31621 required increases with larger limits.
31622
31623 The uniqueification is not perfect: there is a small probability that Exim
31624 will think a new event has happened before. If the sender's rate is less than
31625 the limit, Exim should be more than 99.9% correct. However in &%strict%& mode
31626 the measured rate can go above the limit, in which case Exim may under-count
31627 events by a significant margin. Fortunately, if the rate is high enough (2.7
31628 times the limit) that the false positive rate goes above 9%, then Exim will
31629 throw away the over-full event set before the measured rate falls below the
31630 limit. Therefore the only harm should be that exceptionally high sending rates
31631 are logged incorrectly; any countermeasures you configure will be as effective
31632 as intended.
31633
31634
31635 .section "Using rate limiting" "useratlim"
31636 Exim's other ACL facilities are used to define what counter-measures are taken
31637 when the rate limit is exceeded. This might be anything from logging a warning
31638 (for example, while measuring existing sending rates in order to define
31639 policy), through time delays to slow down fast senders, up to rejecting the
31640 message. For example:
31641 .code
31642 # Log all senders' rates
31643 warn ratelimit = 0 / 1h / strict
31644      log_message = Sender rate $sender_rate / $sender_rate_period
31645
31646 # Slow down fast senders; note the need to truncate $sender_rate
31647 # at the decimal point.
31648 warn ratelimit = 100 / 1h / per_rcpt / strict
31649      delay     = ${eval: ${sg{$sender_rate}{[.].*}{}} - \
31650                    $sender_rate_limit }s
31651
31652 # Keep authenticated users under control
31653 deny authenticated = *
31654      ratelimit = 100 / 1d / strict / $authenticated_id
31655
31656 # System-wide rate limit
31657 defer message = Sorry, too busy. Try again later.
31658      ratelimit = 10 / 1s / $primary_hostname
31659
31660 # Restrict incoming rate from each host, with a default
31661 # set using a macro and special cases looked up in a table.
31662 defer message = Sender rate exceeds $sender_rate_limit \
31663                messages per $sender_rate_period
31664      ratelimit = ${lookup {$sender_host_address} \
31665                    cdb {DB/ratelimits.cdb} \
31666                    {$value} {RATELIMIT} }
31667 .endd
31668 &*Warning*&: If you have a busy server with a lot of &%ratelimit%& tests,
31669 especially with the &%per_rcpt%& option, you may suffer from a performance
31670 bottleneck caused by locking on the ratelimit hints database. Apart from
31671 making your ACLs less complicated, you can reduce the problem by using a
31672 RAM disk for Exim's hints directory (usually &_/var/spool/exim/db/_&). However
31673 this means that Exim will lose its hints data after a reboot (including retry
31674 hints, the callout cache, and ratelimit data).
31675
31676
31677
31678 .section "Address verification" "SECTaddressverification"
31679 .cindex "verifying address" "options for"
31680 .cindex "policy control" "address verification"
31681 Several of the &%verify%& conditions described in section
31682 &<<SECTaclconditions>>& cause addresses to be verified. Section
31683 &<<SECTsenaddver>>& discusses the reporting of sender verification failures.
31684 The verification conditions can be followed by options that modify the
31685 verification process. The options are separated from the keyword and from each
31686 other by slashes, and some of them contain parameters. For example:
31687 .code
31688 verify = sender/callout
31689 verify = recipient/defer_ok/callout=10s,defer_ok
31690 .endd
31691 The first stage of address verification, which always happens, is to run the
31692 address through the routers, in &"verify mode"&. Routers can detect the
31693 difference between verification and routing for delivery, and their actions can
31694 be varied by a number of generic options such as &%verify%& and &%verify_only%&
31695 (see chapter &<<CHAProutergeneric>>&). If routing fails, verification fails.
31696 The available options are as follows:
31697
31698 .ilist
31699 If the &%callout%& option is specified, successful routing to one or more
31700 remote hosts is followed by a &"callout"& to those hosts as an additional
31701 check. Callouts and their sub-options are discussed in the next section.
31702 .next
31703 If there is a defer error while doing verification routing, the ACL
31704 normally returns &"defer"&. However, if you include &%defer_ok%& in the
31705 options, the condition is forced to be true instead. Note that this is a main
31706 verification option as well as a suboption for callouts.
31707 .next
31708 The &%no_details%& option is covered in section &<<SECTsenaddver>>&, which
31709 discusses the reporting of sender address verification failures.
31710 .next
31711 The &%success_on_redirect%& option causes verification always to succeed
31712 immediately after a successful redirection. By default, if a redirection
31713 generates just one address, that address is also verified. See further
31714 discussion in section &<<SECTredirwhilveri>>&.
31715 .endlist
31716
31717 .cindex "verifying address" "differentiating failures"
31718 .vindex "&$recipient_verify_failure$&"
31719 .vindex "&$sender_verify_failure$&"
31720 .vindex "&$acl_verify_message$&"
31721 After an address verification failure, &$acl_verify_message$& contains the
31722 error message that is associated with the failure. It can be preserved by
31723 coding like this:
31724 .code
31725 warn  !verify = sender
31726        set acl_m0 = $acl_verify_message
31727 .endd
31728 If you are writing your own custom rejection message or log message when
31729 denying access, you can use this variable to include information about the
31730 verification failure.
31731
31732 In addition, &$sender_verify_failure$& or &$recipient_verify_failure$& (as
31733 appropriate) contains one of the following words:
31734
31735 .ilist
31736 &%qualify%&: The address was unqualified (no domain), and the message
31737 was neither local nor came from an exempted host.
31738 .next
31739 &%route%&: Routing failed.
31740 .next
31741 &%mail%&: Routing succeeded, and a callout was attempted; rejection
31742 occurred at or before the MAIL command (that is, on initial
31743 connection, HELO, or MAIL).
31744 .next
31745 &%recipient%&: The RCPT command in a callout was rejected.
31746 .next
31747 &%postmaster%&: The postmaster check in a callout was rejected.
31748 .endlist
31749
31750 The main use of these variables is expected to be to distinguish between
31751 rejections of MAIL and rejections of RCPT in callouts.
31752
31753 The above variables may also be set after a &*successful*&
31754 address verification to:
31755
31756 .ilist
31757 &%random%&: A random local-part callout succeeded
31758 .endlist
31759
31760
31761
31762
31763 .section "Callout verification" "SECTcallver"
31764 .cindex "verifying address" "by callout"
31765 .cindex "callout" "verification"
31766 .cindex "SMTP" "callout verification"
31767 For non-local addresses, routing verifies the domain, but is unable to do any
31768 checking of the local part. There are situations where some means of verifying
31769 the local part is desirable. One way this can be done is to make an SMTP
31770 &'callback'& to a delivery host for the sender address or a &'callforward'& to
31771 a subsequent host for a recipient address, to see if the host accepts the
31772 address. We use the term &'callout'& to cover both cases. Note that for a
31773 sender address, the callback is not to the client host that is trying to
31774 deliver the message, but to one of the hosts that accepts incoming mail for the
31775 sender's domain.
31776
31777 Exim does not do callouts by default. If you want them to happen, you must
31778 request them by setting appropriate options on the &%verify%& condition, as
31779 described below. This facility should be used with care, because it can add a
31780 lot of resource usage to the cost of verifying an address. However, Exim does
31781 cache the results of callouts, which helps to reduce the cost. Details of
31782 caching are in section &<<SECTcallvercache>>&.
31783
31784 Recipient callouts are usually used only between hosts that are controlled by
31785 the same administration. For example, a corporate gateway host could use
31786 callouts to check for valid recipients on an internal mailserver. A successful
31787 callout does not guarantee that a real delivery to the address would succeed;
31788 on the other hand, a failing callout does guarantee that a delivery would fail.
31789
31790 If the &%callout%& option is present on a condition that verifies an address, a
31791 second stage of verification occurs if the address is successfully routed to
31792 one or more remote hosts. The usual case is routing by a &(dnslookup)& or a
31793 &(manualroute)& router, where the router specifies the hosts. However, if a
31794 router that does not set up hosts routes to an &(smtp)& transport with a
31795 &%hosts%& setting, the transport's hosts are used. If an &(smtp)& transport has
31796 &%hosts_override%& set, its hosts are always used, whether or not the router
31797 supplies a host list.
31798 Callouts are only supported on &(smtp)& transports.
31799
31800 The port that is used is taken from the transport, if it is specified and is a
31801 remote transport. (For routers that do verification only, no transport need be
31802 specified.) Otherwise, the default SMTP port is used. If a remote transport
31803 specifies an outgoing interface, this is used; otherwise the interface is not
31804 specified. Likewise, the text that is used for the HELO command is taken from
31805 the transport's &%helo_data%& option; if there is no transport, the value of
31806 &$smtp_active_hostname$& is used.
31807
31808 For a sender callout check, Exim makes SMTP connections to the remote hosts, to
31809 test whether a bounce message could be delivered to the sender address. The
31810 following SMTP commands are sent:
31811 .display
31812 &`HELO `&<&'local host name'&>
31813 &`MAIL FROM:<>`&
31814 &`RCPT TO:`&<&'the address to be tested'&>
31815 &`QUIT`&
31816 .endd
31817 LHLO is used instead of HELO if the transport's &%protocol%& option is
31818 set to &"lmtp"&.
31819
31820 The callout may use EHLO, AUTH and/or STARTTLS given appropriate option
31821 settings.
31822
31823 A recipient callout check is similar. By default, it also uses an empty address
31824 for the sender. This default is chosen because most hosts do not make use of
31825 the sender address when verifying a recipient. Using the same address means
31826 that a single cache entry can be used for each recipient. Some sites, however,
31827 do make use of the sender address when verifying. These are catered for by the
31828 &%use_sender%& and &%use_postmaster%& options, described in the next section.
31829
31830 If the response to the RCPT command is a 2&'xx'& code, the verification
31831 succeeds. If it is 5&'xx'&, the verification fails. For any other condition,
31832 Exim tries the next host, if any. If there is a problem with all the remote
31833 hosts, the ACL yields &"defer"&, unless the &%defer_ok%& parameter of the
31834 &%callout%& option is given, in which case the condition is forced to succeed.
31835
31836 .cindex "SMTP" "output flushing, disabling for callout"
31837 A callout may take a little time. For this reason, Exim normally flushes SMTP
31838 output before performing a callout in an ACL, to avoid unexpected timeouts in
31839 clients when the SMTP PIPELINING extension is in use. The flushing can be
31840 disabled by using a &%control%& modifier to set &%no_callout_flush%&.
31841
31842
31843
31844
31845 .section "Additional parameters for callouts" "CALLaddparcall"
31846 .cindex "callout" "additional parameters for"
31847 The &%callout%& option can be followed by an equals sign and a number of
31848 optional parameters, separated by commas. For example:
31849 .code
31850 verify = recipient/callout=10s,defer_ok
31851 .endd
31852 The old syntax, which had &%callout_defer_ok%& and &%check_postmaster%& as
31853 separate verify options, is retained for backwards compatibility, but is now
31854 deprecated. The additional parameters for &%callout%& are as follows:
31855
31856
31857 .vlist
31858 .vitem <&'a&~time&~interval'&>
31859 .cindex "callout" "timeout, specifying"
31860 This specifies the timeout that applies for the callout attempt to each host.
31861 For example:
31862 .code
31863 verify = sender/callout=5s
31864 .endd
31865 The default is 30 seconds. The timeout is used for each response from the
31866 remote host. It is also used for the initial connection, unless overridden by
31867 the &%connect%& parameter.
31868
31869
31870 .vitem &*connect&~=&~*&<&'time&~interval'&>
31871 .cindex "callout" "connection timeout, specifying"
31872 This parameter makes it possible to set a different (usually smaller) timeout
31873 for making the SMTP connection. For example:
31874 .code
31875 verify = sender/callout=5s,connect=1s
31876 .endd
31877 If not specified, this timeout defaults to the general timeout value.
31878
31879 .vitem &*defer_ok*&
31880 .cindex "callout" "defer, action on"
31881 When this parameter is present, failure to contact any host, or any other kind
31882 of temporary error, is treated as success by the ACL. However, the cache is not
31883 updated in this circumstance.
31884
31885 .vitem &*fullpostmaster*&
31886 .cindex "callout" "full postmaster check"
31887 This operates like the &%postmaster%& option (see below), but if the check for
31888 &'postmaster@domain'& fails, it tries just &'postmaster'&, without a domain, in
31889 accordance with the specification in RFC 2821. The RFC states that the
31890 unqualified address &'postmaster'& should be accepted.
31891
31892
31893 .vitem &*mailfrom&~=&~*&<&'email&~address'&>
31894 .cindex "callout" "sender when verifying header"
31895 When verifying addresses in header lines using the &%header_sender%&
31896 verification option, Exim behaves by default as if the addresses are envelope
31897 sender addresses from a message. Callout verification therefore tests to see
31898 whether a bounce message could be delivered, by using an empty address in the
31899 MAIL command. However, it is arguable that these addresses might never be used
31900 as envelope senders, and could therefore justifiably reject bounce messages
31901 (empty senders). The &%mailfrom%& callout parameter allows you to specify what
31902 address to use in the MAIL command. For example:
31903 .code
31904 require  verify = header_sender/callout=mailfrom=abcd@x.y.z
31905 .endd
31906 This parameter is available only for the &%header_sender%& verification option.
31907
31908
31909 .vitem &*maxwait&~=&~*&<&'time&~interval'&>
31910 .cindex "callout" "overall timeout, specifying"
31911 This parameter sets an overall timeout for performing a callout verification.
31912 For example:
31913 .code
31914 verify = sender/callout=5s,maxwait=30s
31915 .endd
31916 This timeout defaults to four times the callout timeout for individual SMTP
31917 commands. The overall timeout applies when there is more than one host that can
31918 be tried. The timeout is checked before trying the next host. This prevents
31919 very long delays if there are a large number of hosts and all are timing out
31920 (for example, when network connections are timing out).
31921
31922
31923 .vitem &*no_cache*&
31924 .cindex "callout" "cache, suppressing"
31925 .cindex "caching callout, suppressing"
31926 When this parameter is given, the callout cache is neither read nor updated.
31927
31928 .vitem &*postmaster*&
31929 .cindex "callout" "postmaster; checking"
31930 When this parameter is set, a successful callout check is followed by a similar
31931 check for the local part &'postmaster'& at the same domain. If this address is
31932 rejected, the callout fails (but see &%fullpostmaster%& above). The result of
31933 the postmaster check is recorded in a cache record; if it is a failure, this is
31934 used to fail subsequent callouts for the domain without a connection being
31935 made, until the cache record expires.
31936
31937 .vitem &*postmaster_mailfrom&~=&~*&<&'email&~address'&>
31938 The postmaster check uses an empty sender in the MAIL command by default.
31939 You can use this parameter to do a postmaster check using a different address.
31940 For example:
31941 .code
31942 require  verify = sender/callout=postmaster_mailfrom=abc@x.y.z
31943 .endd
31944 If both &%postmaster%& and &%postmaster_mailfrom%& are present, the rightmost
31945 one overrides. The &%postmaster%& parameter is equivalent to this example:
31946 .code
31947 require  verify = sender/callout=postmaster_mailfrom=
31948 .endd
31949 &*Warning*&: The caching arrangements for postmaster checking do not take
31950 account of the sender address. It is assumed that either the empty address or
31951 a fixed non-empty address will be used. All that Exim remembers is that the
31952 postmaster check for the domain succeeded or failed.
31953
31954
31955 .vitem &*random*&
31956 .cindex "callout" "&""random""& check"
31957 When this parameter is set, before doing the normal callout check, Exim does a
31958 check for a &"random"& local part at the same domain. The local part is not
31959 really random &-- it is defined by the expansion of the option
31960 &%callout_random_local_part%&, which defaults to
31961 .code
31962 $primary_hostname-$tod_epoch-testing
31963 .endd
31964 The idea here is to try to determine whether the remote host accepts all local
31965 parts without checking. If it does, there is no point in doing callouts for
31966 specific local parts. If the &"random"& check succeeds, the result is saved in
31967 a cache record, and used to force the current and subsequent callout checks to
31968 succeed without a connection being made, until the cache record expires.
31969
31970 .vitem &*use_postmaster*&
31971 .cindex "callout" "sender for recipient check"
31972 This parameter applies to recipient callouts only. For example:
31973 .code
31974 deny  !verify = recipient/callout=use_postmaster
31975 .endd
31976 .vindex "&$qualify_domain$&"
31977 It causes a non-empty postmaster address to be used in the MAIL command when
31978 performing the callout for the recipient, and also for a &"random"& check if
31979 that is configured. The local part of the address is &`postmaster`& and the
31980 domain is the contents of &$qualify_domain$&.
31981
31982 .vitem &*use_sender*&
31983 This option applies to recipient callouts only. For example:
31984 .code
31985 require  verify = recipient/callout=use_sender
31986 .endd
31987 It causes the message's actual sender address to be used in the MAIL
31988 command when performing the callout, instead of an empty address. There is no
31989 need to use this option unless you know that the called hosts make use of the
31990 sender when checking recipients. If used indiscriminately, it reduces the
31991 usefulness of callout caching.
31992
31993 .vitem &*hold*&
31994 This option applies to recipient callouts only. For example:
31995 .code
31996 require  verify = recipient/callout=use_sender,hold
31997 .endd
31998 It causes the connection to be held open and used for any further recipients
31999 and for eventual delivery (should that be done quickly).
32000 Doing this saves on TCP and SMTP startup costs, and TLS costs also
32001 when that is used for the connections.
32002 The advantage is only gained if there are no callout cache hits
32003 (which could be enforced by the no_cache option),
32004 if the use_sender option is used,
32005 if neither the random nor the use_postmaster option is used,
32006 and if no other callouts intervene.
32007 .endlist
32008
32009 If you use any of the parameters that set a non-empty sender for the MAIL
32010 command (&%mailfrom%&, &%postmaster_mailfrom%&, &%use_postmaster%&, or
32011 &%use_sender%&), you should think about possible loops. Recipient checking is
32012 usually done between two hosts that are under the same management, and the host
32013 that receives the callouts is not normally configured to do callouts itself.
32014 Therefore, it is normally safe to use &%use_postmaster%& or &%use_sender%& in
32015 these circumstances.
32016
32017 However, if you use a non-empty sender address for a callout to an arbitrary
32018 host, there is the likelihood that the remote host will itself initiate a
32019 callout check back to your host. As it is checking what appears to be a message
32020 sender, it is likely to use an empty address in MAIL, thus avoiding a
32021 callout loop. However, to be on the safe side it would be best to set up your
32022 own ACLs so that they do not do sender verification checks when the recipient
32023 is the address you use for header sender or postmaster callout checking.
32024
32025 Another issue to think about when using non-empty senders for callouts is
32026 caching. When you set &%mailfrom%& or &%use_sender%&, the cache record is keyed
32027 by the sender/recipient combination; thus, for any given recipient, many more
32028 actual callouts are performed than when an empty sender or postmaster is used.
32029
32030
32031
32032
32033 .section "Callout caching" "SECTcallvercache"
32034 .cindex "hints database" "callout cache"
32035 .cindex "callout" "cache, description of"
32036 .cindex "caching" "callout"
32037 Exim caches the results of callouts in order to reduce the amount of resources
32038 used, unless you specify the &%no_cache%& parameter with the &%callout%&
32039 option. A hints database called &"callout"& is used for the cache. Two
32040 different record types are used: one records the result of a callout check for
32041 a specific address, and the other records information that applies to the
32042 entire domain (for example, that it accepts the local part &'postmaster'&).
32043
32044 When an original callout fails, a detailed SMTP error message is given about
32045 the failure. However, for subsequent failures use the cache data, this message
32046 is not available.
32047
32048 The expiry times for negative and positive address cache records are
32049 independent, and can be set by the global options &%callout_negative_expire%&
32050 (default 2h) and &%callout_positive_expire%& (default 24h), respectively.
32051
32052 If a host gives a negative response to an SMTP connection, or rejects any
32053 commands up to and including
32054 .code
32055 MAIL FROM:<>
32056 .endd
32057 (but not including the MAIL command with a non-empty address),
32058 any callout attempt is bound to fail. Exim remembers such failures in a
32059 domain cache record, which it uses to fail callouts for the domain without
32060 making new connections, until the domain record times out. There are two
32061 separate expiry times for domain cache records:
32062 &%callout_domain_negative_expire%& (default 3h) and
32063 &%callout_domain_positive_expire%& (default 7d).
32064
32065 Domain records expire when the negative expiry time is reached if callouts
32066 cannot be made for the domain, or if the postmaster check failed.
32067 Otherwise, they expire when the positive expiry time is reached. This
32068 ensures that, for example, a host that stops accepting &"random"& local parts
32069 will eventually be noticed.
32070
32071 The callout caching mechanism is based on the domain of the address that is
32072 being tested. If the domain routes to several hosts, it is assumed that their
32073 behaviour will be the same.
32074
32075
32076
32077 .section "Sender address verification reporting" "SECTsenaddver"
32078 .cindex "verifying" "suppressing error details"
32079 See section &<<SECTaddressverification>>& for a general discussion of
32080 verification. When sender verification fails in an ACL, the details of the
32081 failure are given as additional output lines before the 550 response to the
32082 relevant SMTP command (RCPT or DATA). For example, if sender callout is in use,
32083 you might see:
32084 .code
32085 MAIL FROM:<xyz@abc.example>
32086 250 OK
32087 RCPT TO:<pqr@def.example>
32088 550-Verification failed for <xyz@abc.example>
32089 550-Called:   192.168.34.43
32090 550-Sent:     RCPT TO:<xyz@abc.example>
32091 550-Response: 550 Unknown local part xyz in <xyz@abc.example>
32092 550 Sender verification failed
32093 .endd
32094 If more than one RCPT command fails in the same way, the details are given
32095 only for the first of them. However, some administrators do not want to send
32096 out this much information. You can suppress the details by adding
32097 &`/no_details`& to the ACL statement that requests sender verification. For
32098 example:
32099 .code
32100 verify = sender/no_details
32101 .endd
32102
32103 .section "Redirection while verifying" "SECTredirwhilveri"
32104 .cindex "verifying" "redirection while"
32105 .cindex "address redirection" "while verifying"
32106 A dilemma arises when a local address is redirected by aliasing or forwarding
32107 during verification: should the generated addresses themselves be verified,
32108 or should the successful expansion of the original address be enough to verify
32109 it? By default, Exim takes the following pragmatic approach:
32110
32111 .ilist
32112 When an incoming address is redirected to just one child address, verification
32113 continues with the child address, and if that fails to verify, the original
32114 verification also fails.
32115 .next
32116 When an incoming address is redirected to more than one child address,
32117 verification does not continue. A success result is returned.
32118 .endlist
32119
32120 This seems the most reasonable behaviour for the common use of aliasing as a
32121 way of redirecting different local parts to the same mailbox. It means, for
32122 example, that a pair of alias entries of the form
32123 .code
32124 A.Wol:   aw123
32125 aw123:   :fail: Gone away, no forwarding address
32126 .endd
32127 work as expected, with both local parts causing verification failure. When a
32128 redirection generates more than one address, the behaviour is more like a
32129 mailing list, where the existence of the alias itself is sufficient for
32130 verification to succeed.
32131
32132 It is possible, however, to change the default behaviour so that all successful
32133 redirections count as successful verifications, however many new addresses are
32134 generated. This is specified by the &%success_on_redirect%& verification
32135 option. For example:
32136 .code
32137 require verify = recipient/success_on_redirect/callout=10s
32138 .endd
32139 In this example, verification succeeds if a router generates a new address, and
32140 the callout does not occur, because no address was routed to a remote host.
32141
32142 When verification is being tested via the &%-bv%& option, the treatment of
32143 redirections is as just described, unless the &%-v%& or any debugging option is
32144 also specified. In that case, full verification is done for every generated
32145 address and a report is output for each of them.
32146
32147
32148
32149 .section "Client SMTP authorization (CSA)" "SECTverifyCSA"
32150 .cindex "CSA" "verifying"
32151 Client SMTP Authorization is a system that allows a site to advertise
32152 which machines are and are not permitted to send email. This is done by placing
32153 special SRV records in the DNS; these are looked up using the client's HELO
32154 domain. At the time of writing, CSA is still an Internet Draft. Client SMTP
32155 Authorization checks in Exim are performed by the ACL condition:
32156 .code
32157 verify = csa
32158 .endd
32159 This fails if the client is not authorized. If there is a DNS problem, or if no
32160 valid CSA SRV record is found, or if the client is authorized, the condition
32161 succeeds. These three cases can be distinguished using the expansion variable
32162 &$csa_status$&, which can take one of the values &"fail"&, &"defer"&,
32163 &"unknown"&, or &"ok"&. The condition does not itself defer because that would
32164 be likely to cause problems for legitimate email.
32165
32166 The error messages produced by the CSA code include slightly more
32167 detail. If &$csa_status$& is &"defer"&, this may be because of problems
32168 looking up the CSA SRV record, or problems looking up the CSA target
32169 address record. There are four reasons for &$csa_status$& being &"fail"&:
32170
32171 .ilist
32172 The client's host name is explicitly not authorized.
32173 .next
32174 The client's IP address does not match any of the CSA target IP addresses.
32175 .next
32176 The client's host name is authorized but it has no valid target IP addresses
32177 (for example, the target's addresses are IPv6 and the client is using IPv4).
32178 .next
32179 The client's host name has no CSA SRV record but a parent domain has asserted
32180 that all subdomains must be explicitly authorized.
32181 .endlist
32182
32183 The &%csa%& verification condition can take an argument which is the domain to
32184 use for the DNS query. The default is:
32185 .code
32186 verify = csa/$sender_helo_name
32187 .endd
32188 This implementation includes an extension to CSA. If the query domain
32189 is an address literal such as [192.0.2.95], or if it is a bare IP
32190 address, Exim searches for CSA SRV records in the reverse DNS as if
32191 the HELO domain was (for example) &'95.2.0.192.in-addr.arpa'&. Therefore it is
32192 meaningful to say:
32193 .code
32194 verify = csa/$sender_host_address
32195 .endd
32196 In fact, this is the check that Exim performs if the client does not say HELO.
32197 This extension can be turned off by setting the main configuration option
32198 &%dns_csa_use_reverse%& to be false.
32199
32200 If a CSA SRV record is not found for the domain itself, a search
32201 is performed through its parent domains for a record which might be
32202 making assertions about subdomains. The maximum depth of this search is limited
32203 using the main configuration option &%dns_csa_search_limit%&, which is 5 by
32204 default. Exim does not look for CSA SRV records in a top level domain, so the
32205 default settings handle HELO domains as long as seven
32206 (&'hostname.five.four.three.two.one.com'&). This encompasses the vast majority
32207 of legitimate HELO domains.
32208
32209 The &'dnsdb'& lookup also has support for CSA. Although &'dnsdb'& also supports
32210 direct SRV lookups, this is not sufficient because of the extra parent domain
32211 search behaviour of CSA, and (as with PTR lookups) &'dnsdb'& also turns IP
32212 addresses into lookups in the reverse DNS space. The result of a successful
32213 lookup such as:
32214 .code
32215 ${lookup dnsdb {csa=$sender_helo_name}}
32216 .endd
32217 has two space-separated fields: an authorization code and a target host name.
32218 The authorization code can be &"Y"& for yes, &"N"& for no, &"X"& for explicit
32219 authorization required but absent, or &"?"& for unknown.
32220
32221
32222
32223
32224 .section "Bounce address tag validation" "SECTverifyPRVS"
32225 .cindex "BATV, verifying"
32226 Bounce address tag validation (BATV) is a scheme whereby the envelope senders
32227 of outgoing messages have a cryptographic, timestamped &"tag"& added to them.
32228 Genuine incoming bounce messages should therefore always be addressed to
32229 recipients that have a valid tag. This scheme is a way of detecting unwanted
32230 bounce messages caused by sender address forgeries (often called &"collateral
32231 spam"&), because the recipients of such messages do not include valid tags.
32232
32233 There are two expansion items to help with the implementation of the BATV
32234 &"prvs"& (private signature) scheme in an Exim configuration. This scheme signs
32235 the original envelope sender address by using a simple key to add a hash of the
32236 address and some time-based randomizing information. The &%prvs%& expansion
32237 item creates a signed address, and the &%prvscheck%& expansion item checks one.
32238 The syntax of these expansion items is described in section
32239 &<<SECTexpansionitems>>&.
32240 The validity period on signed addresses is seven days.
32241
32242 As an example, suppose the secret per-address keys are stored in an MySQL
32243 database. A query to look up the key for an address could be defined as a macro
32244 like this:
32245 .code
32246 PRVSCHECK_SQL = ${lookup mysql{SELECT secret FROM batv_prvs \
32247                 WHERE sender='${quote_mysql:$prvscheck_address}'\
32248                 }{$value}}
32249 .endd
32250 Suppose also that the senders who make use of BATV are defined by an address
32251 list called &%batv_senders%&. Then, in the ACL for RCPT commands, you could
32252 use this:
32253 .code
32254 # Bounces: drop unsigned addresses for BATV senders
32255 deny message = This address does not send an unsigned reverse path
32256      senders = :
32257      recipients = +batv_senders
32258
32259 # Bounces: In case of prvs-signed address, check signature.
32260 deny message = Invalid reverse path signature.
32261      senders = :
32262      condition  = ${prvscheck {$local_part@$domain}\
32263                   {PRVSCHECK_SQL}{1}}
32264      !condition = $prvscheck_result
32265 .endd
32266 The first statement rejects recipients for bounce messages that are addressed
32267 to plain BATV sender addresses, because it is known that BATV senders do not
32268 send out messages with plain sender addresses. The second statement rejects
32269 recipients that are prvs-signed, but with invalid signatures (either because
32270 the key is wrong, or the signature has timed out).
32271
32272 A non-prvs-signed address is not rejected by the second statement, because the
32273 &%prvscheck%& expansion yields an empty string if its first argument is not a
32274 prvs-signed address, thus causing the &%condition%& condition to be false. If
32275 the first argument is a syntactically valid prvs-signed address, the yield is
32276 the third string (in this case &"1"&), whether or not the cryptographic and
32277 timeout checks succeed. The &$prvscheck_result$& variable contains the result
32278 of the checks (empty for failure, &"1"& for success).
32279
32280 There is one more issue you must consider when implementing prvs-signing:
32281 you have to ensure that the routers accept prvs-signed addresses and
32282 deliver them correctly. The easiest way to handle this is to use a &(redirect)&
32283 router to remove the signature with a configuration along these lines:
32284 .code
32285 batv_redirect:
32286   driver = redirect
32287   data = ${prvscheck {$local_part@$domain}{PRVSCHECK_SQL}}
32288 .endd
32289 This works because, if the third argument of &%prvscheck%& is empty, the result
32290 of the expansion of a prvs-signed address is the decoded value of the original
32291 address. This router should probably be the first of your routers that handles
32292 local addresses.
32293
32294 To create BATV-signed addresses in the first place, a transport of this form
32295 can be used:
32296 .code
32297 external_smtp_batv:
32298   driver = smtp
32299   return_path = ${prvs {$return_path} \
32300                        {${lookup mysql{SELECT \
32301                        secret FROM batv_prvs WHERE \
32302                        sender='${quote_mysql:$sender_address}'} \
32303                        {$value}fail}}}
32304 .endd
32305 If no key can be found for the existing return path, no signing takes place.
32306
32307
32308
32309 .section "Using an ACL to control relaying" "SECTrelaycontrol"
32310 .cindex "&ACL;" "relay control"
32311 .cindex "relaying" "control by ACL"
32312 .cindex "policy control" "relay control"
32313 An MTA is said to &'relay'& a message if it receives it from some host and
32314 delivers it directly to another host as a result of a remote address contained
32315 within it. Redirecting a local address via an alias or forward file and then
32316 passing the message on to another host is not relaying,
32317 .cindex "&""percent hack""&"
32318 but a redirection as a result of the &"percent hack"& is.
32319
32320 Two kinds of relaying exist, which are termed &"incoming"& and &"outgoing"&.
32321 A host which is acting as a gateway or an MX backup is concerned with incoming
32322 relaying from arbitrary hosts to a specific set of domains. On the other hand,
32323 a host which is acting as a smart host for a number of clients is concerned
32324 with outgoing relaying from those clients to the Internet at large. Often the
32325 same host is fulfilling both functions,
32326 . ///
32327 . as illustrated in the diagram below,
32328 . ///
32329 but in principle these two kinds of relaying are entirely independent. What is
32330 not wanted is the transmission of mail from arbitrary remote hosts through your
32331 system to arbitrary domains.
32332
32333
32334 You can implement relay control by means of suitable statements in the ACL that
32335 runs for each RCPT command. For convenience, it is often easiest to use
32336 Exim's named list facility to define the domains and hosts involved. For
32337 example, suppose you want to do the following:
32338
32339 .ilist
32340 Deliver a number of domains to mailboxes on the local host (or process them
32341 locally in some other way). Let's say these are &'my.dom1.example'& and
32342 &'my.dom2.example'&.
32343 .next
32344 Relay mail for a number of other domains for which you are the secondary MX.
32345 These might be &'friend1.example'& and &'friend2.example'&.
32346 .next
32347 Relay mail from the hosts on your local LAN, to whatever domains are involved.
32348 Suppose your LAN is 192.168.45.0/24.
32349 .endlist
32350
32351
32352 In the main part of the configuration, you put the following definitions:
32353 .code
32354 domainlist local_domains    = my.dom1.example : my.dom2.example
32355 domainlist relay_to_domains = friend1.example : friend2.example
32356 hostlist   relay_from_hosts = 192.168.45.0/24
32357 .endd
32358 Now you can use these definitions in the ACL that is run for every RCPT
32359 command:
32360 .code
32361 acl_check_rcpt:
32362   accept domains = +local_domains : +relay_to_domains
32363   accept hosts   = +relay_from_hosts
32364 .endd
32365 The first statement accepts any RCPT command that contains an address in
32366 the local or relay domains. For any other domain, control passes to the second
32367 statement, which accepts the command only if it comes from one of the relay
32368 hosts. In practice, you will probably want to make your ACL more sophisticated
32369 than this, for example, by including sender and recipient verification. The
32370 default configuration includes a more comprehensive example, which is described
32371 in chapter &<<CHAPdefconfil>>&.
32372
32373
32374
32375 .section "Checking a relay configuration" "SECTcheralcon"
32376 .cindex "relaying" "checking control of"
32377 You can check the relay characteristics of your configuration in the same way
32378 that you can test any ACL behaviour for an incoming SMTP connection, by using
32379 the &%-bh%& option to run a fake SMTP session with which you interact.
32380 .ecindex IIDacl
32381
32382
32383
32384 . ////////////////////////////////////////////////////////////////////////////
32385 . ////////////////////////////////////////////////////////////////////////////
32386
32387 .chapter "Content scanning at ACL time" "CHAPexiscan"
32388 .scindex IIDcosca "content scanning" "at ACL time"
32389 The extension of Exim to include content scanning at ACL time, formerly known
32390 as &"exiscan"&, was originally implemented as a patch by Tom Kistner. The code
32391 was integrated into the main source for Exim release 4.50, and Tom continues to
32392 maintain it. Most of the wording of this chapter is taken from Tom's
32393 specification.
32394
32395 It is also possible to scan the content of messages at other times. The
32396 &[local_scan()]& function (see chapter &<<CHAPlocalscan>>&) allows for content
32397 scanning after all the ACLs have run. A transport filter can be used to scan
32398 messages at delivery time (see the &%transport_filter%& option, described in
32399 chapter &<<CHAPtransportgeneric>>&).
32400
32401 If you want to include the ACL-time content-scanning features when you compile
32402 Exim, you need to arrange for WITH_CONTENT_SCAN to be defined in your
32403 &_Local/Makefile_&. When you do that, the Exim binary is built with:
32404
32405 .ilist
32406 Two additional ACLs (&%acl_smtp_mime%& and &%acl_not_smtp_mime%&) that are run
32407 for all MIME parts for SMTP and non-SMTP messages, respectively.
32408 .next
32409 Additional ACL conditions and modifiers: &%decode%&, &%malware%&,
32410 &%mime_regex%&, &%regex%&, and &%spam%&. These can be used in the ACL that is
32411 run at the end of message reception (the &%acl_smtp_data%& ACL).
32412 .next
32413 An additional control feature (&"no_mbox_unspool"&) that saves spooled copies
32414 of messages, or parts of messages, for debugging purposes.
32415 .next
32416 Additional expansion variables that are set in the new ACL and by the new
32417 conditions.
32418 .next
32419 Two new main configuration options: &%av_scanner%& and &%spamd_address%&.
32420 .endlist
32421
32422 Content-scanning is continually evolving, and new features are still being
32423 added. While such features are still unstable and liable to incompatible
32424 changes, they are made available in Exim by setting options whose names begin
32425 EXPERIMENTAL_ in &_Local/Makefile_&. Such features are not documented in
32426 this manual. You can find out about them by reading the file called
32427 &_doc/experimental.txt_&.
32428
32429 All the content-scanning facilities work on a MBOX copy of the message that is
32430 temporarily created in a file called:
32431 .display
32432 <&'spool_directory'&>&`/scan/`&<&'message_id'&>/<&'message_id'&>&`.eml`&
32433 .endd
32434 The &_.eml_& extension is a friendly hint to virus scanners that they can
32435 expect an MBOX-like structure inside that file. The file is created when the
32436 first content scanning facility is called. Subsequent calls to content
32437 scanning conditions open the same file again. The directory is recursively
32438 removed when the &%acl_smtp_data%& ACL has finished running, unless
32439 .code
32440 control = no_mbox_unspool
32441 .endd
32442 has been encountered. When the MIME ACL decodes files, they are put into the
32443 same directory by default.
32444
32445
32446
32447 .section "Scanning for viruses" "SECTscanvirus"
32448 .cindex "virus scanning"
32449 .cindex "content scanning" "for viruses"
32450 .cindex "content scanning" "the &%malware%& condition"
32451 The &%malware%& ACL condition lets you connect virus scanner software to Exim.
32452 It supports a &"generic"& interface to scanners called via the shell, and
32453 specialized interfaces for &"daemon"& type virus scanners, which are resident
32454 in memory and thus are much faster.
32455
32456 A timeout of 2 minutes is applied to a scanner call (by default);
32457 if it expires then a defer action is taken.
32458
32459 .oindex "&%av_scanner%&"
32460 You can set the &%av_scanner%& option in the main part of the configuration
32461 to specify which scanner to use, together with any additional options that
32462 are needed. The basic syntax is as follows:
32463 .display
32464 &`av_scanner = <`&&'scanner-type'&&`>:<`&&'option1'&&`>:<`&&'option2'&&`>:[...]`&
32465 .endd
32466 If you do not set &%av_scanner%&, it defaults to
32467 .code
32468 av_scanner = sophie:/var/run/sophie
32469 .endd
32470 If the value of &%av_scanner%& starts with a dollar character, it is expanded
32471 before use.
32472 The usual list-parsing of the content (see &<<SECTlistconstruct>>&) applies.
32473 The following scanner types are supported in this release,
32474 though individual ones can be included or not at build time:
32475
32476 .vlist
32477 .vitem &%avast%&
32478 .cindex "virus scanners" "avast"
32479 This is the scanner daemon of Avast. It has been tested with Avast Core
32480 Security (currently at version 2.2.0).
32481 You can get a trial version at &url(https://www.avast.com) or for Linux
32482 at &url(https://www.avast.com/linux-server-antivirus).
32483 This scanner type takes one option,
32484 which can be either a full path to a UNIX socket,
32485 or host and port specifiers separated by white space.
32486 The host may be a name or an IP address; the port is either a
32487 single number or a pair of numbers with a dash between.
32488 A list of options may follow. These options are interpreted on the
32489 Exim's side of the malware scanner, or are given on separate lines to
32490 the daemon as options before the main scan command.
32491
32492 .cindex &`pass_unscanned`& "avast"
32493 If &`pass_unscanned`&
32494 is set, any files the Avast scanner can't scan (e.g.
32495 decompression bombs, or invalid archives) are considered clean. Use with
32496 care.
32497
32498 For example:
32499 .code
32500 av_scanner = avast:/var/run/avast/scan.sock:FLAGS -fullfiles:SENSITIVITY -pup
32501 av_scanner = avast:/var/run/avast/scan.sock:pass_unscanned:FLAGS -fullfiles:SENSITIVITY -pup
32502 av_scanner = avast:192.168.2.22 5036
32503 .endd
32504 If you omit the argument, the default path
32505 &_/var/run/avast/scan.sock_&
32506 is used.
32507 If you use a remote host,
32508 you need to make Exim's spool directory available to it,
32509 as the scanner is passed a file path, not file contents.
32510 For information about available commands and their options you may use
32511 .code
32512 $ socat UNIX:/var/run/avast/scan.sock STDIO:
32513     FLAGS
32514     SENSITIVITY
32515     PACK
32516 .endd
32517
32518 If the scanner returns a temporary failure (e.g. license issues, or
32519 permission problems), the message is deferred and a paniclog entry is
32520 written.  The usual &`defer_ok`& option is available.
32521
32522 .vitem &%aveserver%&
32523 .cindex "virus scanners" "Kaspersky"
32524 This is the scanner daemon of Kaspersky Version 5. You can get a trial version
32525 at &url(https://www.kaspersky.com/). This scanner type takes one option,
32526 which is the path to the daemon's UNIX socket. The default is shown in this
32527 example:
32528 .code
32529 av_scanner = aveserver:/var/run/aveserver
32530 .endd
32531
32532
32533 .vitem &%clamd%&
32534 .cindex "virus scanners" "clamd"
32535 This daemon-type scanner is GPL and free. You can get it at
32536 &url(https://www.clamav.net/). Some older versions of clamd do not seem to
32537 unpack MIME containers, so it used to be recommended to unpack MIME attachments
32538 in the MIME ACL. This is no longer believed to be necessary.
32539
32540 The options are a list of server specifiers, which may be
32541 a UNIX socket specification,
32542 a TCP socket specification,
32543 or a (global) option.
32544
32545 A socket specification consists of a space-separated list.
32546 For a Unix socket the first element is a full path for the socket,
32547 for a TCP socket the first element is the IP address
32548 and the second a port number,
32549 Any further elements are per-server (non-global) options.
32550 These per-server options are supported:
32551 .code
32552 retry=<timespec>        Retry on connect fail
32553 .endd
32554
32555 The &`retry`& option specifies a time after which a single retry for
32556 a failed connect is made.  The default is to not retry.
32557
32558 If a Unix socket file is specified, only one server is supported.
32559
32560 Examples:
32561 .code
32562 av_scanner = clamd:/opt/clamd/socket
32563 av_scanner = clamd:192.0.2.3 1234
32564 av_scanner = clamd:192.0.2.3 1234:local
32565 av_scanner = clamd:192.0.2.3 1234 retry=10s
32566 av_scanner = clamd:192.0.2.3 1234 : 192.0.2.4 1234
32567 .endd
32568 If the value of av_scanner points to a UNIX socket file or contains the
32569 &`local`&
32570 option, then the ClamAV interface will pass a filename containing the data
32571 to be scanned, which should normally result in less I/O happening and be
32572 more efficient.  Normally in the TCP case, the data is streamed to ClamAV as
32573 Exim does not assume that there is a common filesystem with the remote host.
32574
32575 The final example shows that multiple TCP targets can be specified.  Exim will
32576 randomly use one for each incoming email (i.e. it load balances them).  Note
32577 that only TCP targets may be used if specifying a list of scanners; a UNIX
32578 socket cannot be mixed in with TCP targets.  If one of the servers becomes
32579 unavailable, Exim will try the remaining one(s) until it finds one that works.
32580 When a clamd server becomes unreachable, Exim will log a message.  Exim does
32581 not keep track of scanner state between multiple messages, and the scanner
32582 selection is random, so the message will get logged in the mainlog for each
32583 email that the down scanner gets chosen first (message wrapped to be readable):
32584 .code
32585 2013-10-09 14:30:39 1VTumd-0000Y8-BQ malware acl condition:
32586    clamd: connection to localhost, port 3310 failed
32587    (Connection refused)
32588 .endd
32589
32590 If the option is unset, the default is &_/tmp/clamd_&. Thanks to David Saez for
32591 contributing the code for this scanner.
32592
32593 .vitem &%cmdline%&
32594 .cindex "virus scanners" "command line interface"
32595 This is the keyword for the generic command line scanner interface. It can be
32596 used to attach virus scanners that are invoked from the shell. This scanner
32597 type takes 3 mandatory options:
32598
32599 .olist
32600 The full path and name of the scanner binary, with all command line options,
32601 and a placeholder (&`%s`&) for the directory to scan.
32602
32603 .next
32604 A regular expression to match against the STDOUT and STDERR output of the
32605 virus scanner. If the expression matches, a virus was found. You must make
32606 absolutely sure that this expression matches on &"virus found"&. This is called
32607 the &"trigger"& expression.
32608
32609 .next
32610 Another regular expression, containing exactly one pair of parentheses, to
32611 match the name of the virus found in the scanners output. This is called the
32612 &"name"& expression.
32613 .endlist olist
32614
32615 For example, Sophos Sweep reports a virus on a line like this:
32616 .code
32617 Virus 'W32/Magistr-B' found in file ./those.bat
32618 .endd
32619 For the trigger expression, we can match the phrase &"found in file"&. For the
32620 name expression, we want to extract the W32/Magistr-B string, so we can match
32621 for the single quotes left and right of it. Altogether, this makes the
32622 configuration setting:
32623 .code
32624 av_scanner = cmdline:\
32625              /path/to/sweep -ss -all -rec -archive %s:\
32626              found in file:'(.+)'
32627 .endd
32628 .vitem &%drweb%&
32629 .cindex "virus scanners" "DrWeb"
32630 The DrWeb daemon scanner (&url(https://www.sald.ru/)) interface
32631 takes one option,
32632 either a full path to a UNIX socket,
32633 or host and port specifiers separated by white space.
32634 The host may be a name or an IP address; the port is either a
32635 single number or a pair of numbers with a dash between.
32636 For example:
32637 .code
32638 av_scanner = drweb:/var/run/drwebd.sock
32639 av_scanner = drweb:192.168.2.20 31337
32640 .endd
32641 If you omit the argument, the default path &_/usr/local/drweb/run/drwebd.sock_&
32642 is used. Thanks to Alex Miller for contributing the code for this scanner.
32643
32644 .vitem &%f-protd%&
32645 .cindex "virus scanners" "f-protd"
32646 The f-protd scanner is accessed via HTTP over TCP.
32647 One argument is taken, being a space-separated hostname and port number
32648 (or port-range).
32649 For example:
32650 .code
32651 av_scanner = f-protd:localhost 10200-10204
32652 .endd
32653 If you omit the argument, the default values shown above are used.
32654
32655 .vitem &%f-prot6d%&
32656 .cindex "virus scanners" "f-prot6d"
32657 The f-prot6d scanner is accessed using the FPSCAND protocol over TCP.
32658 One argument is taken, being a space-separated hostname and port number.
32659 For example:
32660 .code
32661 av_scanner = f-prot6d:localhost 10200
32662 .endd
32663 If you omit the argument, the default values show above are used.
32664
32665 .vitem &%fsecure%&
32666 .cindex "virus scanners" "F-Secure"
32667 The F-Secure daemon scanner (&url(https://www.f-secure.com/)) takes one
32668 argument which is the path to a UNIX socket. For example:
32669 .code
32670 av_scanner = fsecure:/path/to/.fsav
32671 .endd
32672 If no argument is given, the default is &_/var/run/.fsav_&. Thanks to Johan
32673 Thelmen for contributing the code for this scanner.
32674
32675 .vitem &%kavdaemon%&
32676 .cindex "virus scanners" "Kaspersky"
32677 This is the scanner daemon of Kaspersky Version 4. This version of the
32678 Kaspersky scanner is outdated. Please upgrade (see &%aveserver%& above). This
32679 scanner type takes one option, which is the path to the daemon's UNIX socket.
32680 For example:
32681 .code
32682 av_scanner = kavdaemon:/opt/AVP/AvpCtl
32683 .endd
32684 The default path is &_/var/run/AvpCtl_&.
32685
32686 .vitem &%mksd%&
32687 .cindex "virus scanners" "mksd"
32688 This was a daemon type scanner that is aimed mainly at Polish users,
32689 though some documentation was available in English.
32690 The history can be shown at &url(https://en.wikipedia.org/wiki/Mks_vir)
32691 and this appears to be a candidate for removal from Exim, unless
32692 we are informed of other virus scanners which use the same protocol
32693 to integrate.
32694 The only option for this scanner type is
32695 the maximum number of processes used simultaneously to scan the attachments,
32696 provided that mksd has
32697 been run with at least the same number of child processes. For example:
32698 .code
32699 av_scanner = mksd:2
32700 .endd
32701 You can safely omit this option (the default value is 1).
32702
32703 .vitem &%sock%&
32704 .cindex "virus scanners" "simple socket-connected"
32705 This is a general-purpose way of talking to simple scanner daemons
32706 running on the local machine.
32707 There are four options:
32708 an address (which may be an IP address and port, or the path of a Unix socket),
32709 a commandline to send (may include a single %s which will be replaced with
32710 the path to the mail file to be scanned),
32711 an RE to trigger on from the returned data,
32712 and an RE to extract malware_name from the returned data.
32713 For example:
32714 .code
32715 av_scanner = sock:127.0.0.1 6001:%s:(SPAM|VIRUS):(.*)$
32716 .endd
32717 Note that surrounding whitespace is stripped from each option, meaning
32718 there is no way to specify a trailing newline.
32719 The socket specifier and both regular-expressions are required.
32720 Default for the commandline is &_%s\n_& (note this does have a trailing newline);
32721 specify an empty element to get this.
32722
32723 .vitem &%sophie%&
32724 .cindex "virus scanners" "Sophos and Sophie"
32725 Sophie is a daemon that uses Sophos' &%libsavi%& library to scan for viruses.
32726 You can get Sophie at &url(http://sophie.sourceforge.net/). The only option
32727 for this scanner type is the path to the UNIX socket that Sophie uses for
32728 client communication. For example:
32729 .code
32730 av_scanner = sophie:/tmp/sophie
32731 .endd
32732 The default path is &_/var/run/sophie_&, so if you are using this, you can omit
32733 the option.
32734 .endlist
32735
32736 When &%av_scanner%& is correctly set, you can use the &%malware%& condition in
32737 the DATA ACL. &*Note*&: You cannot use the &%malware%& condition in the MIME
32738 ACL.
32739
32740 The &%av_scanner%& option is expanded each time &%malware%& is called. This
32741 makes it possible to use different scanners. See further below for an example.
32742 The &%malware%& condition caches its results, so when you use it multiple times
32743 for the same message, the actual scanning process is only carried out once.
32744 However, using expandable items in &%av_scanner%& disables this caching, in
32745 which case each use of the &%malware%& condition causes a new scan of the
32746 message.
32747
32748 The &%malware%& condition takes a right-hand argument that is expanded before
32749 use and taken as a list, slash-separated by default.
32750 The first element can then be one of
32751
32752 .ilist
32753 &"true"&, &"*"&, or &"1"&, in which case the message is scanned for viruses.
32754 The condition succeeds if a virus was found, and fail otherwise. This is the
32755 recommended usage.
32756 .next
32757 &"false"& or &"0"& or an empty string, in which case no scanning is done and
32758 the condition fails immediately.
32759 .next
32760 A regular expression, in which case the message is scanned for viruses. The
32761 condition succeeds if a virus is found and its name matches the regular
32762 expression. This allows you to take special actions on certain types of virus.
32763 Note that &"/"& characters in the RE must be doubled due to the list-processing,
32764 unless the separator is changed (in the usual way &<<SECTlistsepchange>>&).
32765 .endlist
32766
32767 You can append a &`defer_ok`& element to the &%malware%& argument list to accept
32768 messages even if there is a problem with the virus scanner.
32769 Otherwise, such a problem causes the ACL to defer.
32770
32771 You can append a &`tmo=<val>`& element to the &%malware%& argument list to
32772 specify a non-default timeout.  The default is two minutes.
32773 For example:
32774 .code
32775 malware = * / defer_ok / tmo=10s
32776 .endd
32777 A timeout causes the ACL to defer.
32778
32779 .vindex "&$callout_address$&"
32780 When a connection is made to the scanner the expansion variable &$callout_address$&
32781 is set to record the actual address used.
32782
32783 .vindex "&$malware_name$&"
32784 When a virus is found, the condition sets up an expansion variable called
32785 &$malware_name$& that contains the name of the virus. You can use it in a
32786 &%message%& modifier that specifies the error returned to the sender, and/or in
32787 logging data.
32788
32789 Beware the interaction of Exim's &%message_size_limit%& with any size limits
32790 imposed by your anti-virus scanner.
32791
32792 Here is a very simple scanning example:
32793 .code
32794 deny message = This message contains malware ($malware_name)
32795      malware = *
32796 .endd
32797 The next example accepts messages when there is a problem with the scanner:
32798 .code
32799 deny message = This message contains malware ($malware_name)
32800      malware = */defer_ok
32801 .endd
32802 The next example shows how to use an ACL variable to scan with both sophie and
32803 aveserver. It assumes you have set:
32804 .code
32805 av_scanner = $acl_m0
32806 .endd
32807 in the main Exim configuration.
32808 .code
32809 deny message = This message contains malware ($malware_name)
32810      set acl_m0 = sophie
32811      malware = *
32812
32813 deny message = This message contains malware ($malware_name)
32814      set acl_m0 = aveserver
32815      malware = *
32816 .endd
32817
32818
32819 .section "Scanning with SpamAssassin and Rspamd" "SECTscanspamass"
32820 .cindex "content scanning" "for spam"
32821 .cindex "spam scanning"
32822 .cindex "SpamAssassin"
32823 .cindex "Rspamd"
32824 The &%spam%& ACL condition calls SpamAssassin's &%spamd%& daemon to get a spam
32825 score and a report for the message.
32826 Support is also provided for Rspamd.
32827
32828 For more information about installation and configuration of SpamAssassin or
32829 Rspamd refer to their respective websites at
32830 &url(https://spamassassin.apache.org/) and &url(https://www.rspamd.com/)
32831
32832 SpamAssassin can be installed with CPAN by running:
32833 .code
32834 perl -MCPAN -e 'install Mail::SpamAssassin'
32835 .endd
32836 SpamAssassin has its own set of configuration files. Please review its
32837 documentation to see how you can tweak it. The default installation should work
32838 nicely, however.
32839
32840 .oindex "&%spamd_address%&"
32841 By default, SpamAssassin listens on 127.0.0.1, TCP port 783 and if you
32842 intend to use an instance running on the local host you do not need to set
32843 &%spamd_address%&. If you intend to use another host or port for SpamAssassin,
32844 you must set the &%spamd_address%& option in the global part of the Exim
32845 configuration as follows (example):
32846 .code
32847 spamd_address = 192.168.99.45 783
32848 .endd
32849 The SpamAssassin protocol relies on a TCP half-close from the client.
32850 If your SpamAssassin client side is running a Linux system with an
32851 iptables firewall, consider setting
32852 &%net.netfilter.nf_conntrack_tcp_timeout_close_wait%& to at least the
32853 timeout, Exim uses when waiting for a response from the SpamAssassin
32854 server (currently defaulting to 120s).  With a lower value the Linux
32855 connection tracking may consider your half-closed connection as dead too
32856 soon.
32857
32858
32859 To use Rspamd (which by default listens on all local addresses
32860 on TCP port 11333)
32861 you should add &%variant=rspamd%& after the address/port pair, for example:
32862 .code
32863 spamd_address = 127.0.0.1 11333 variant=rspamd
32864 .endd
32865
32866 As of version 2.60, &%SpamAssassin%& also supports communication over UNIX
32867 sockets. If you want to us these, supply &%spamd_address%& with an absolute
32868 filename instead of an address/port pair:
32869 .code
32870 spamd_address = /var/run/spamd_socket
32871 .endd
32872 You can have multiple &%spamd%& servers to improve scalability. These can
32873 reside on other hardware reachable over the network. To specify multiple
32874 &%spamd%& servers, put multiple address/port pairs in the &%spamd_address%&
32875 option, separated with colons (the separator can be changed in the usual way &<<SECTlistsepchange>>&):
32876 .code
32877 spamd_address = 192.168.2.10 783 : \
32878                 192.168.2.11 783 : \
32879                 192.168.2.12 783
32880 .endd
32881 Up to 32 &%spamd%& servers are supported.
32882 When a server fails to respond to the connection attempt, all other
32883 servers are tried until one succeeds. If no server responds, the &%spam%&
32884 condition defers.
32885
32886 Unix and TCP socket specifications may be mixed in any order.
32887 Each element of the list is a list itself, space-separated by default
32888 and changeable in the usual way (&<<SECTlistsepchange>>&);
32889 take care to not double the separator.
32890
32891 For TCP socket specifications a host name or IP (v4 or v6, but
32892 subject to list-separator quoting rules) address can be used,
32893 and the port can be one or a dash-separated pair.
32894 In the latter case, the range is tried in strict order.
32895
32896 Elements after the first for Unix sockets, or second for TCP socket,
32897 are options.
32898 The supported options are:
32899 .code
32900 pri=<priority>      Selection priority
32901 weight=<value>      Selection bias
32902 time=<start>-<end>  Use only between these times of day
32903 retry=<timespec>    Retry on connect fail
32904 tmo=<timespec>      Connection time limit
32905 variant=rspamd      Use Rspamd rather than SpamAssassin protocol
32906 .endd
32907
32908 The &`pri`& option specifies a priority for the server within the list,
32909 higher values being tried first.
32910 The default priority is 1.
32911
32912 The &`weight`& option specifies a selection bias.
32913 Within a priority set
32914 servers are queried in a random fashion, weighted by this value.
32915 The default value for selection bias is 1.
32916
32917 Time specifications for the &`time`& option are <hour>.<minute>.<second>
32918 in the local time zone; each element being one or more digits.
32919 Either the seconds or both minutes and seconds, plus the leading &`.`&
32920 characters, may be omitted and will be taken as zero.
32921
32922 Timeout specifications for the &`retry`& and &`tmo`& options
32923 are the usual Exim time interval standard, e.g. &`20s`& or &`1m`&.
32924
32925 The &`tmo`& option specifies an overall timeout for communication.
32926 The default value is two minutes.
32927
32928 The &`retry`& option specifies a time after which a single retry for
32929 a failed connect is made.
32930 The default is to not retry.
32931
32932 The &%spamd_address%& variable is expanded before use if it starts with
32933 a dollar sign. In this case, the expansion may return a string that is
32934 used as the list so that multiple spamd servers can be the result of an
32935 expansion.
32936
32937 .vindex "&$callout_address$&"
32938 When a connection is made to the server the expansion variable &$callout_address$&
32939 is set to record the actual address used.
32940
32941 .section "Calling SpamAssassin from an Exim ACL" "SECID206"
32942 Here is a simple example of the use of the &%spam%& condition in a DATA ACL:
32943 .code
32944 deny message = This message was classified as SPAM
32945      spam = joe
32946 .endd
32947 The right-hand side of the &%spam%& condition specifies a name. This is
32948 relevant if you have set up multiple SpamAssassin profiles. If you do not want
32949 to scan using a specific profile, but rather use the SpamAssassin system-wide
32950 default profile, you can scan for an unknown name, or simply use &"nobody"&.
32951 Rspamd does not use this setting. However, you must put something on the
32952 right-hand side.
32953
32954 The name allows you to use per-domain or per-user antispam profiles in
32955 principle, but this is not straightforward in practice, because a message may
32956 have multiple recipients, not necessarily all in the same domain. Because the
32957 &%spam%& condition has to be called from a DATA-time ACL in order to be able to
32958 read the contents of the message, the variables &$local_part$& and &$domain$&
32959 are not set.
32960 Careful enforcement of single-recipient messages
32961 (e.g. by responding with defer in the recipient ACL for all recipients
32962 after the first),
32963 or the use of PRDR,
32964 .cindex "PRDR" "use for per-user SpamAssassin profiles"
32965 are needed to use this feature.
32966
32967 The right-hand side of the &%spam%& condition is expanded before being used, so
32968 you can put lookups or conditions there. When the right-hand side evaluates to
32969 &"0"& or &"false"&, no scanning is done and the condition fails immediately.
32970
32971
32972 Scanning with SpamAssassin uses a lot of resources. If you scan every message,
32973 large ones may cause significant performance degradation. As most spam messages
32974 are quite small, it is recommended that you do not scan the big ones. For
32975 example:
32976 .code
32977 deny message = This message was classified as SPAM
32978      condition = ${if < {$message_size}{10K}}
32979      spam = nobody
32980 .endd
32981
32982 The &%spam%& condition returns true if the threshold specified in the user's
32983 SpamAssassin profile has been matched or exceeded. If you want to use the
32984 &%spam%& condition for its side effects (see the variables below), you can make
32985 it always return &"true"& by appending &`:true`& to the username.
32986
32987 .cindex "spam scanning" "returned variables"
32988 When the &%spam%& condition is run, it sets up a number of expansion
32989 variables.
32990 Except for &$spam_report$&,
32991 these variables are saved with the received message so are
32992 available for use at delivery time.
32993
32994 .vlist
32995 .vitem &$spam_score$&
32996 The spam score of the message, for example, &"3.4"& or &"30.5"&. This is useful
32997 for inclusion in log or reject messages.
32998
32999 .vitem &$spam_score_int$&
33000 The spam score of the message, multiplied by ten, as an integer value. For
33001 example &"34"& or &"305"&. It may appear to disagree with &$spam_score$&
33002 because &$spam_score$& is rounded and &$spam_score_int$& is truncated.
33003 The integer value is useful for numeric comparisons in conditions.
33004
33005 .vitem &$spam_bar$&
33006 A string consisting of a number of &"+"& or &"-"& characters, representing the
33007 integer part of the spam score value. A spam score of 4.4 would have a
33008 &$spam_bar$& value of &"++++"&. This is useful for inclusion in warning
33009 headers, since MUAs can match on such strings. The maximum length of the
33010 spam bar is 50 characters.
33011
33012 .vitem &$spam_report$&
33013 A multiline text table, containing the full SpamAssassin report for the
33014 message. Useful for inclusion in headers or reject messages.
33015 This variable is only usable in a DATA-time ACL.
33016 Beware that SpamAssassin may return non-ASCII characters, especially
33017 when running in country-specific locales, which are not legal
33018 unencoded in headers.
33019
33020 .vitem &$spam_action$&
33021 For SpamAssassin either 'reject' or 'no action' depending on the
33022 spam score versus threshold.
33023 For Rspamd, the recommended action.
33024
33025 .endlist
33026
33027 The &%spam%& condition caches its results unless expansion in
33028 spamd_address was used. If you call it again with the same user name, it
33029 does not scan again, but rather returns the same values as before.
33030
33031 The &%spam%& condition returns DEFER if there is any error while running
33032 the message through SpamAssassin or if the expansion of spamd_address
33033 failed. If you want to treat DEFER as FAIL (to pass on to the next ACL
33034 statement block), append &`/defer_ok`& to the right-hand side of the
33035 spam condition, like this:
33036 .code
33037 deny message = This message was classified as SPAM
33038      spam    = joe/defer_ok
33039 .endd
33040 This causes messages to be accepted even if there is a problem with &%spamd%&.
33041
33042 Here is a longer, commented example of the use of the &%spam%&
33043 condition:
33044 .code
33045 # put headers in all messages (no matter if spam or not)
33046 warn  spam = nobody:true
33047       add_header = X-Spam-Score: $spam_score ($spam_bar)
33048       add_header = X-Spam-Report: $spam_report
33049
33050 # add second subject line with *SPAM* marker when message
33051 # is over threshold
33052 warn  spam = nobody
33053       add_header = Subject: *SPAM* $h_Subject:
33054
33055 # reject spam at high scores (> 12)
33056 deny  message = This message scored $spam_score spam points.
33057       spam = nobody:true
33058       condition = ${if >{$spam_score_int}{120}{1}{0}}
33059 .endd
33060
33061
33062
33063 .section "Scanning MIME parts" "SECTscanmimepart"
33064 .cindex "content scanning" "MIME parts"
33065 .cindex "MIME content scanning"
33066 .oindex "&%acl_smtp_mime%&"
33067 .oindex "&%acl_not_smtp_mime%&"
33068 The &%acl_smtp_mime%& global option specifies an ACL that is called once for
33069 each MIME part of an SMTP message, including multipart types, in the sequence
33070 of their position in the message. Similarly, the &%acl_not_smtp_mime%& option
33071 specifies an ACL that is used for the MIME parts of non-SMTP messages. These
33072 options may both refer to the same ACL if you want the same processing in both
33073 cases.
33074
33075 These ACLs are called (possibly many times) just before the &%acl_smtp_data%&
33076 ACL in the case of an SMTP message, or just before the &%acl_not_smtp%& ACL in
33077 the case of a non-SMTP message. However, a MIME ACL is called only if the
33078 message contains a &'Content-Type:'& header line. When a call to a MIME
33079 ACL does not yield &"accept"&, ACL processing is aborted and the appropriate
33080 result code is sent to the client. In the case of an SMTP message, the
33081 &%acl_smtp_data%& ACL is not called when this happens.
33082
33083 You cannot use the &%malware%& or &%spam%& conditions in a MIME ACL; these can
33084 only be used in the DATA or non-SMTP ACLs. However, you can use the &%regex%&
33085 condition to match against the raw MIME part. You can also use the
33086 &%mime_regex%& condition to match against the decoded MIME part (see section
33087 &<<SECTscanregex>>&).
33088
33089 At the start of a MIME ACL, a number of variables are set from the header
33090 information for the relevant MIME part. These are described below. The contents
33091 of the MIME part are not by default decoded into a disk file except for MIME
33092 parts whose content-type is &"message/rfc822"&. If you want to decode a MIME
33093 part into a disk file, you can use the &%decode%& condition. The general
33094 syntax is:
33095 .display
33096 &`decode = [/`&<&'path'&>&`/]`&<&'filename'&>
33097 .endd
33098 The right hand side is expanded before use. After expansion,
33099 the value can be:
33100
33101 .olist
33102 &"0"& or &"false"&, in which case no decoding is done.
33103 .next
33104 The string &"default"&. In that case, the file is put in the temporary
33105 &"default"& directory <&'spool_directory'&>&_/scan/_&<&'message_id'&>&_/_& with
33106 a sequential filename consisting of the message id and a sequence number. The
33107 full path and name is available in &$mime_decoded_filename$& after decoding.
33108 .next
33109 A full path name starting with a slash. If the full name is an existing
33110 directory, it is used as a replacement for the default directory. The filename
33111 is then sequentially assigned. If the path does not exist, it is used as
33112 the full path and filename.
33113 .next
33114 If the string does not start with a slash, it is used as the
33115 filename, and the default path is then used.
33116 .endlist
33117 The &%decode%& condition normally succeeds. It is only false for syntax
33118 errors or unusual circumstances such as memory shortages. You can easily decode
33119 a file with its original, proposed filename using
33120 .code
33121 decode = $mime_filename
33122 .endd
33123 However, you should keep in mind that &$mime_filename$& might contain
33124 anything. If you place files outside of the default path, they are not
33125 automatically unlinked.
33126
33127 For RFC822 attachments (these are messages attached to messages, with a
33128 content-type of &"message/rfc822"&), the ACL is called again in the same manner
33129 as for the primary message, only that the &$mime_is_rfc822$& expansion
33130 variable is set (see below). Attached messages are always decoded to disk
33131 before being checked, and the files are unlinked once the check is done.
33132
33133 The MIME ACL supports the &%regex%& and &%mime_regex%& conditions. These can be
33134 used to match regular expressions against raw and decoded MIME parts,
33135 respectively. They are described in section &<<SECTscanregex>>&.
33136
33137 .cindex "MIME content scanning" "returned variables"
33138 The following list describes all expansion variables that are
33139 available in the MIME ACL:
33140
33141 .vlist
33142 .vitem &$mime_boundary$&
33143 If the current part is a multipart (see &$mime_is_multipart$&) below, it should
33144 have a boundary string, which is stored in this variable. If the current part
33145 has no boundary parameter in the &'Content-Type:'& header, this variable
33146 contains the empty string.
33147
33148 .vitem &$mime_charset$&
33149 This variable contains the character set identifier, if one was found in the
33150 &'Content-Type:'& header. Examples for charset identifiers are:
33151 .code
33152 us-ascii
33153 gb2312 (Chinese)
33154 iso-8859-1
33155 .endd
33156 Please note that this value is not normalized, so you should do matches
33157 case-insensitively.
33158
33159 .vitem &$mime_content_description$&
33160 This variable contains the normalized content of the &'Content-Description:'&
33161 header. It can contain a human-readable description of the parts content. Some
33162 implementations repeat the filename for attachments here, but they are usually
33163 only used for display purposes.
33164
33165 .vitem &$mime_content_disposition$&
33166 This variable contains the normalized content of the &'Content-Disposition:'&
33167 header. You can expect strings like &"attachment"& or &"inline"& here.
33168
33169 .vitem &$mime_content_id$&
33170 This variable contains the normalized content of the &'Content-ID:'& header.
33171 This is a unique ID that can be used to reference a part from another part.
33172
33173 .vitem &$mime_content_size$&
33174 This variable is set only after the &%decode%& modifier (see above) has been
33175 successfully run. It contains the size of the decoded part in kilobytes. The
33176 size is always rounded up to full kilobytes, so only a completely empty part
33177 has a &$mime_content_size$& of zero.
33178
33179 .vitem &$mime_content_transfer_encoding$&
33180 This variable contains the normalized content of the
33181 &'Content-transfer-encoding:'& header. This is a symbolic name for an encoding
33182 type. Typical values are &"base64"& and &"quoted-printable"&.
33183
33184 .vitem &$mime_content_type$&
33185 If the MIME part has a &'Content-Type:'& header, this variable contains its
33186 value, lowercased, and without any options (like &"name"& or &"charset"&). Here
33187 are some examples of popular MIME types, as they may appear in this variable:
33188 .code
33189 text/plain
33190 text/html
33191 application/octet-stream
33192 image/jpeg
33193 audio/midi
33194 .endd
33195 If the MIME part has no &'Content-Type:'& header, this variable contains the
33196 empty string.
33197
33198 .vitem &$mime_decoded_filename$&
33199 This variable is set only after the &%decode%& modifier (see above) has been
33200 successfully run. It contains the full path and filename of the file
33201 containing the decoded data.
33202 .endlist
33203
33204 .cindex "RFC 2047"
33205 .vlist
33206 .vitem &$mime_filename$&
33207 This is perhaps the most important of the MIME variables. It contains a
33208 proposed filename for an attachment, if one was found in either the
33209 &'Content-Type:'& or &'Content-Disposition:'& headers. The filename will be
33210 RFC2047
33211 or RFC2231
33212 decoded, but no additional sanity checks are done.
33213  If no filename was
33214 found, this variable contains the empty string.
33215
33216 .vitem &$mime_is_coverletter$&
33217 This variable attempts to differentiate the &"cover letter"& of an e-mail from
33218 attached data. It can be used to clamp down on flashy or unnecessarily encoded
33219 content in the cover letter, while not restricting attachments at all.
33220
33221 The variable contains 1 (true) for a MIME part believed to be part of the
33222 cover letter, and 0 (false) for an attachment. At present, the algorithm is as
33223 follows:
33224
33225 .olist
33226 The outermost MIME part of a message is always a cover letter.
33227
33228 .next
33229 If a multipart/alternative or multipart/related MIME part is a cover letter,
33230 so are all MIME subparts within that multipart.
33231
33232 .next
33233 If any other multipart is a cover letter, the first subpart is a cover letter,
33234 and the rest are attachments.
33235
33236 .next
33237 All parts contained within an attachment multipart are attachments.
33238 .endlist olist
33239
33240 As an example, the following will ban &"HTML mail"& (including that sent with
33241 alternative plain text), while allowing HTML files to be attached. HTML
33242 coverletter mail attached to non-HTML coverletter mail will also be allowed:
33243 .code
33244 deny message = HTML mail is not accepted here
33245 !condition = $mime_is_rfc822
33246 condition = $mime_is_coverletter
33247 condition = ${if eq{$mime_content_type}{text/html}{1}{0}}
33248 .endd
33249 .vitem &$mime_is_multipart$&
33250 This variable has the value 1 (true) when the current part has the main type
33251 &"multipart"&, for example, &"multipart/alternative"& or &"multipart/mixed"&.
33252 Since multipart entities only serve as containers for other parts, you may not
33253 want to carry out specific actions on them.
33254
33255 .vitem &$mime_is_rfc822$&
33256 This variable has the value 1 (true) if the current part is not a part of the
33257 checked message itself, but part of an attached message. Attached message
33258 decoding is fully recursive.
33259
33260 .vitem &$mime_part_count$&
33261 This variable is a counter that is raised for each processed MIME part. It
33262 starts at zero for the very first part (which is usually a multipart). The
33263 counter is per-message, so it is reset when processing RFC822 attachments (see
33264 &$mime_is_rfc822$&). The counter stays set after &%acl_smtp_mime%& is
33265 complete, so you can use it in the DATA ACL to determine the number of MIME
33266 parts of a message. For non-MIME messages, this variable contains the value -1.
33267 .endlist
33268
33269
33270
33271 .section "Scanning with regular expressions" "SECTscanregex"
33272 .cindex "content scanning" "with regular expressions"
33273 .cindex "regular expressions" "content scanning with"
33274 You can specify your own custom regular expression matches on the full body of
33275 the message, or on individual MIME parts.
33276
33277 The &%regex%& condition takes one or more regular expressions as arguments and
33278 matches them against the full message (when called in the DATA ACL) or a raw
33279 MIME part (when called in the MIME ACL). The &%regex%& condition matches
33280 linewise, with a maximum line length of 32K characters. That means you cannot
33281 have multiline matches with the &%regex%& condition.
33282
33283 The &%mime_regex%& condition can be called only in the MIME ACL. It matches up
33284 to 32K of decoded content (the whole content at once, not linewise). If the
33285 part has not been decoded with the &%decode%& modifier earlier in the ACL, it
33286 is decoded automatically when &%mime_regex%& is executed (using default path
33287 and filename values). If the decoded data is larger than  32K, only the first
33288 32K characters are checked.
33289
33290 The regular expressions are passed as a colon-separated list. To include a
33291 literal colon, you must double it. Since the whole right-hand side string is
33292 expanded before being used, you must also escape dollar signs and backslashes
33293 with more backslashes, or use the &`\N`& facility to disable expansion.
33294 Here is a simple example that contains two regular expressions:
33295 .code
33296 deny message = contains blacklisted regex ($regex_match_string)
33297      regex = [Mm]ortgage : URGENT BUSINESS PROPOSAL
33298 .endd
33299 The conditions returns true if any one of the regular expressions matches. The
33300 &$regex_match_string$& expansion variable is then set up and contains the
33301 matching regular expression.
33302 The expansion variables &$regex1$& &$regex2$& etc
33303 are set to any substrings captured by the regular expression.
33304
33305 &*Warning*&: With large messages, these conditions can be fairly
33306 CPU-intensive.
33307
33308 .ecindex IIDcosca
33309
33310
33311
33312
33313 . ////////////////////////////////////////////////////////////////////////////
33314 . ////////////////////////////////////////////////////////////////////////////
33315
33316 .chapter "Adding a local scan function to Exim" "CHAPlocalscan" &&&
33317          "Local scan function"
33318 .scindex IIDlosca "&[local_scan()]& function" "description of"
33319 .cindex "customizing" "input scan using C function"
33320 .cindex "policy control" "by local scan function"
33321 In these days of email worms, viruses, and ever-increasing spam, some sites
33322 want to apply a lot of checking to messages before accepting them.
33323
33324 The content scanning extension (chapter &<<CHAPexiscan>>&) has facilities for
33325 passing messages to external virus and spam scanning software. You can also do
33326 a certain amount in Exim itself through string expansions and the &%condition%&
33327 condition in the ACL that runs after the SMTP DATA command or the ACL for
33328 non-SMTP messages (see chapter &<<CHAPACL>>&), but this has its limitations.
33329
33330 To allow for further customization to a site's own requirements, there is the
33331 possibility of linking Exim with a private message scanning function, written
33332 in C. If you want to run code that is written in something other than C, you
33333 can of course use a little C stub to call it.
33334
33335 The local scan function is run once for every incoming message, at the point
33336 when Exim is just about to accept the message.
33337 It can therefore be used to control non-SMTP messages from local processes as
33338 well as messages arriving via SMTP.
33339
33340 Exim applies a timeout to calls of the local scan function, and there is an
33341 option called &%local_scan_timeout%& for setting it. The default is 5 minutes.
33342 Zero means &"no timeout"&.
33343 Exim also sets up signal handlers for SIGSEGV, SIGILL, SIGFPE, and SIGBUS
33344 before calling the local scan function, so that the most common types of crash
33345 are caught. If the timeout is exceeded or one of those signals is caught, the
33346 incoming message is rejected with a temporary error if it is an SMTP message.
33347 For a non-SMTP message, the message is dropped and Exim ends with a non-zero
33348 code. The incident is logged on the main and reject logs.
33349
33350
33351
33352 .section "Building Exim to use a local scan function" "SECID207"
33353 .cindex "&[local_scan()]& function" "building Exim to use"
33354 To make use of the local scan function feature, you must tell Exim where your
33355 function is before building Exim, by setting
33356 both HAVE_LOCAL_SCAN and
33357 LOCAL_SCAN_SOURCE in your
33358 &_Local/Makefile_&. A recommended place to put it is in the &_Local_&
33359 directory, so you might set
33360 .code
33361 HAVE_LOCAL_SCAN=yes
33362 LOCAL_SCAN_SOURCE=Local/local_scan.c
33363 .endd
33364 for example. The function must be called &[local_scan()]&. It is called by
33365 Exim after it has received a message, when the success return code is about to
33366 be sent. This is after all the ACLs have been run. The return code from your
33367 function controls whether the message is actually accepted or not. There is a
33368 commented template function (that just accepts the message) in the file
33369 _src/local_scan.c_.
33370
33371 If you want to make use of Exim's runtime configuration file to set options
33372 for your &[local_scan()]& function, you must also set
33373 .code
33374 LOCAL_SCAN_HAS_OPTIONS=yes
33375 .endd
33376 in &_Local/Makefile_& (see section &<<SECTconoptloc>>& below).
33377
33378
33379
33380
33381 .section "API for local_scan()" "SECTapiforloc"
33382 .cindex "&[local_scan()]& function" "API description"
33383 .cindex &%dlfunc%& "API description"
33384 You must include this line near the start of your code:
33385 .code
33386 #include "local_scan.h"
33387 .endd
33388 This header file defines a number of variables and other values, and the
33389 prototype for the function itself. Exim is coded to use unsigned char values
33390 almost exclusively, and one of the things this header defines is a shorthand
33391 for &`unsigned char`& called &`uschar`&.
33392 It also contains the following macro definitions, to simplify casting character
33393 strings and pointers to character strings:
33394 .code
33395 #define CS   (char *)
33396 #define CCS  (const char *)
33397 #define CSS  (char **)
33398 #define US   (unsigned char *)
33399 #define CUS  (const unsigned char *)
33400 #define USS  (unsigned char **)
33401 .endd
33402 The function prototype for &[local_scan()]& is:
33403 .code
33404 extern int local_scan(int fd, uschar **return_text);
33405 .endd
33406 The arguments are as follows:
33407
33408 .ilist
33409 &%fd%& is a file descriptor for the file that contains the body of the message
33410 (the -D file). The file is open for reading and writing, but updating it is not
33411 recommended. &*Warning*&: You must &'not'& close this file descriptor.
33412
33413 The descriptor is positioned at character 19 of the file, which is the first
33414 character of the body itself, because the first 19 characters are the message
33415 id followed by &`-D`& and a newline. If you rewind the file, you should use the
33416 macro SPOOL_DATA_START_OFFSET to reset to the start of the data, just in
33417 case this changes in some future version.
33418 .next
33419 &%return_text%& is an address which you can use to return a pointer to a text
33420 string at the end of the function. The value it points to on entry is NULL.
33421 .endlist
33422
33423 The function must return an &%int%& value which is one of the following macros:
33424
33425 .vlist
33426 .vitem &`LOCAL_SCAN_ACCEPT`&
33427 .vindex "&$local_scan_data$&"
33428 The message is accepted. If you pass back a string of text, it is saved with
33429 the message, and made available in the variable &$local_scan_data$&. No
33430 newlines are permitted (if there are any, they are turned into spaces) and the
33431 maximum length of text is 1000 characters.
33432
33433 .vitem &`LOCAL_SCAN_ACCEPT_FREEZE`&
33434 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33435 queued without immediate delivery, and is frozen.
33436
33437 .vitem &`LOCAL_SCAN_ACCEPT_QUEUE`&
33438 This behaves as LOCAL_SCAN_ACCEPT, except that the accepted message is
33439 queued without immediate delivery.
33440
33441 .vitem &`LOCAL_SCAN_REJECT`&
33442 The message is rejected; the returned text is used as an error message which is
33443 passed back to the sender and which is also logged. Newlines are permitted &--
33444 they cause a multiline response for SMTP rejections, but are converted to
33445 &`\n`& in log lines. If no message is given, &"Administrative prohibition"& is
33446 used.
33447
33448 .vitem &`LOCAL_SCAN_TEMPREJECT`&
33449 The message is temporarily rejected; the returned text is used as an error
33450 message as for LOCAL_SCAN_REJECT. If no message is given, &"Temporary local
33451 problem"& is used.
33452
33453 .vitem &`LOCAL_SCAN_REJECT_NOLOGHDR`&
33454 This behaves as LOCAL_SCAN_REJECT, except that the header of the rejected
33455 message is not written to the reject log. It has the effect of unsetting the
33456 &%rejected_header%& log selector for just this rejection. If
33457 &%rejected_header%& is already unset (see the discussion of the
33458 &%log_selection%& option in section &<<SECTlogselector>>&), this code is the
33459 same as LOCAL_SCAN_REJECT.
33460
33461 .vitem &`LOCAL_SCAN_TEMPREJECT_NOLOGHDR`&
33462 This code is a variation of LOCAL_SCAN_TEMPREJECT in the same way that
33463 LOCAL_SCAN_REJECT_NOLOGHDR is a variation of LOCAL_SCAN_REJECT.
33464 .endlist
33465
33466 If the message is not being received by interactive SMTP, rejections are
33467 reported by writing to &%stderr%& or by sending an email, as configured by the
33468 &%-oe%& command line options.
33469
33470
33471
33472 .section "Configuration options for local_scan()" "SECTconoptloc"
33473 .cindex "&[local_scan()]& function" "configuration options"
33474 It is possible to have option settings in the main configuration file
33475 that set values in static variables in the &[local_scan()]& module. If you
33476 want to do this, you must have the line
33477 .code
33478 LOCAL_SCAN_HAS_OPTIONS=yes
33479 .endd
33480 in your &_Local/Makefile_& when you build Exim. (This line is in
33481 &_OS/Makefile-Default_&, commented out). Then, in the &[local_scan()]& source
33482 file, you must define static variables to hold the option values, and a table
33483 to define them.
33484
33485 The table must be a vector called &%local_scan_options%&, of type
33486 &`optionlist`&. Each entry is a triplet, consisting of a name, an option type,
33487 and a pointer to the variable that holds the value. The entries must appear in
33488 alphabetical order. Following &%local_scan_options%& you must also define a
33489 variable called &%local_scan_options_count%& that contains the number of
33490 entries in the table. Here is a short example, showing two kinds of option:
33491 .code
33492 static int my_integer_option = 42;
33493 static uschar *my_string_option = US"a default string";
33494
33495 optionlist local_scan_options[] = {
33496   { "my_integer", opt_int,       &my_integer_option },
33497   { "my_string",  opt_stringptr, &my_string_option }
33498 };
33499
33500 int local_scan_options_count =
33501   sizeof(local_scan_options)/sizeof(optionlist);
33502 .endd
33503 The values of the variables can now be changed from Exim's runtime
33504 configuration file by including a local scan section as in this example:
33505 .code
33506 begin local_scan
33507 my_integer = 99
33508 my_string = some string of text...
33509 .endd
33510 The available types of option data are as follows:
33511
33512 .vlist
33513 .vitem &*opt_bool*&
33514 This specifies a boolean (true/false) option. The address should point to a
33515 variable of type &`BOOL`&, which will be set to TRUE or FALSE, which are macros
33516 that are defined as &"1"& and &"0"&, respectively. If you want to detect
33517 whether such a variable has been set at all, you can initialize it to
33518 TRUE_UNSET. (BOOL variables are integers underneath, so can hold more than two
33519 values.)
33520
33521 .vitem &*opt_fixed*&
33522 This specifies a fixed point number, such as is used for load averages.
33523 The address should point to a variable of type &`int`&. The value is stored
33524 multiplied by 1000, so, for example, 1.4142 is truncated and stored as 1414.
33525
33526 .vitem &*opt_int*&
33527 This specifies an integer; the address should point to a variable of type
33528 &`int`&. The value may be specified in any of the integer formats accepted by
33529 Exim.
33530
33531 .vitem &*opt_mkint*&
33532 This is the same as &%opt_int%&, except that when such a value is output in a
33533 &%-bP%& listing, if it is an exact number of kilobytes or megabytes, it is
33534 printed with the suffix K or M.
33535
33536 .vitem &*opt_octint*&
33537 This also specifies an integer, but the value is always interpreted as an
33538 octal integer, whether or not it starts with the digit zero, and it is
33539 always output in octal.
33540
33541 .vitem &*opt_stringptr*&
33542 This specifies a string value; the address must be a pointer to a
33543 variable that points to a string (for example, of type &`uschar *`&).
33544
33545 .vitem &*opt_time*&
33546 This specifies a time interval value. The address must point to a variable of
33547 type &`int`&. The value that is placed there is a number of seconds.
33548 .endlist
33549
33550 If the &%-bP%& command line option is followed by &`local_scan`&, Exim prints
33551 out the values of all the &[local_scan()]& options.
33552
33553
33554
33555 .section "Available Exim variables" "SECID208"
33556 .cindex "&[local_scan()]& function" "available Exim variables"
33557 The header &_local_scan.h_& gives you access to a number of C variables. These
33558 are the only ones that are guaranteed to be maintained from release to release.
33559 Note, however, that you can obtain the value of any Exim expansion variable,
33560 including &$recipients$&, by calling &'expand_string()'&. The exported
33561 C variables are as follows:
33562
33563 .vlist
33564 .vitem &*int&~body_linecount*&
33565 This variable contains the number of lines in the message's body.
33566 It is not valid if the &%spool_files_wireformat%& option is used.
33567
33568 .vitem &*int&~body_zerocount*&
33569 This variable contains the number of binary zero bytes in the message's body.
33570 It is not valid if the &%spool_files_wireformat%& option is used.
33571
33572 .vitem &*unsigned&~int&~debug_selector*&
33573 This variable is set to zero when no debugging is taking place. Otherwise, it
33574 is a bitmap of debugging selectors. Two bits are identified for use in
33575 &[local_scan()]&; they are defined as macros:
33576
33577 .ilist
33578 The &`D_v`& bit is set when &%-v%& was present on the command line. This is a
33579 testing option that is not privileged &-- any caller may set it. All the
33580 other selector bits can be set only by admin users.
33581
33582 .next
33583 The &`D_local_scan`& bit is provided for use by &[local_scan()]&; it is set
33584 by the &`+local_scan`& debug selector. It is not included in the default set
33585 of debugging bits.
33586 .endlist ilist
33587
33588 Thus, to write to the debugging output only when &`+local_scan`& has been
33589 selected, you should use code like this:
33590 .code
33591 if ((debug_selector & D_local_scan) != 0)
33592   debug_printf("xxx", ...);
33593 .endd
33594 .vitem &*uschar&~*expand_string_message*&
33595 After a failing call to &'expand_string()'& (returned value NULL), the
33596 variable &%expand_string_message%& contains the error message, zero-terminated.
33597
33598 .vitem &*header_line&~*header_list*&
33599 A pointer to a chain of header lines. The &%header_line%& structure is
33600 discussed below.
33601
33602 .vitem &*header_line&~*header_last*&
33603 A pointer to the last of the header lines.
33604
33605 .vitem &*uschar&~*headers_charset*&
33606 The value of the &%headers_charset%& configuration option.
33607
33608 .vitem &*BOOL&~host_checking*&
33609 This variable is TRUE during a host checking session that is initiated by the
33610 &%-bh%& command line option.
33611
33612 .vitem &*uschar&~*interface_address*&
33613 The IP address of the interface that received the message, as a string. This
33614 is NULL for locally submitted messages.
33615
33616 .vitem &*int&~interface_port*&
33617 The port on which this message was received. When testing with the &%-bh%&
33618 command line option, the value of this variable is -1 unless a port has been
33619 specified via the &%-oMi%& option.
33620
33621 .vitem &*uschar&~*message_id*&
33622 This variable contains Exim's message id for the incoming message (the value of
33623 &$message_exim_id$&) as a zero-terminated string.
33624
33625 .vitem &*uschar&~*received_protocol*&
33626 The name of the protocol by which the message was received.
33627
33628 .vitem &*int&~recipients_count*&
33629 The number of accepted recipients.
33630
33631 .vitem &*recipient_item&~*recipients_list*&
33632 .cindex "recipient" "adding in local scan"
33633 .cindex "recipient" "removing in local scan"
33634 The list of accepted recipients, held in a vector of length
33635 &%recipients_count%&. The &%recipient_item%& structure is discussed below. You
33636 can add additional recipients by calling &'receive_add_recipient()'& (see
33637 below). You can delete recipients by removing them from the vector and
33638 adjusting the value in &%recipients_count%&. In particular, by setting
33639 &%recipients_count%& to zero you remove all recipients. If you then return the
33640 value &`LOCAL_SCAN_ACCEPT`&, the message is accepted, but immediately
33641 blackholed. To replace the recipients, you can set &%recipients_count%& to zero
33642 and then call &'receive_add_recipient()'& as often as needed.
33643
33644 .vitem &*uschar&~*sender_address*&
33645 The envelope sender address. For bounce messages this is the empty string.
33646
33647 .vitem &*uschar&~*sender_host_address*&
33648 The IP address of the sending host, as a string. This is NULL for
33649 locally-submitted messages.
33650
33651 .vitem &*uschar&~*sender_host_authenticated*&
33652 The name of the authentication mechanism that was used, or NULL if the message
33653 was not received over an authenticated SMTP connection.
33654
33655 .vitem &*uschar&~*sender_host_name*&
33656 The name of the sending host, if known.
33657
33658 .vitem &*int&~sender_host_port*&
33659 The port on the sending host.
33660
33661 .vitem &*BOOL&~smtp_input*&
33662 This variable is TRUE for all SMTP input, including BSMTP.
33663
33664 .vitem &*BOOL&~smtp_batched_input*&
33665 This variable is TRUE for BSMTP input.
33666
33667 .vitem &*int&~store_pool*&
33668 The contents of this variable control which pool of memory is used for new
33669 requests. See section &<<SECTmemhanloc>>& for details.
33670 .endlist
33671
33672
33673 .section "Structure of header lines" "SECID209"
33674 The &%header_line%& structure contains the members listed below.
33675 You can add additional header lines by calling the &'header_add()'& function
33676 (see below). You can cause header lines to be ignored (deleted) by setting
33677 their type to *.
33678
33679
33680 .vlist
33681 .vitem &*struct&~header_line&~*next*&
33682 A pointer to the next header line, or NULL for the last line.
33683
33684 .vitem &*int&~type*&
33685 A code identifying certain headers that Exim recognizes. The codes are printing
33686 characters, and are documented in chapter &<<CHAPspool>>& of this manual.
33687 Notice in particular that any header line whose type is * is not transmitted
33688 with the message. This flagging is used for header lines that have been
33689 rewritten, or are to be removed (for example, &'Envelope-sender:'& header
33690 lines.) Effectively, * means &"deleted"&.
33691
33692 .vitem &*int&~slen*&
33693 The number of characters in the header line, including the terminating and any
33694 internal newlines.
33695
33696 .vitem &*uschar&~*text*&
33697 A pointer to the text of the header. It always ends with a newline, followed by
33698 a zero byte. Internal newlines are preserved.
33699 .endlist
33700
33701
33702
33703 .section "Structure of recipient items" "SECID210"
33704 The &%recipient_item%& structure contains these members:
33705
33706 .vlist
33707 .vitem &*uschar&~*address*&
33708 This is a pointer to the recipient address as it was received.
33709
33710 .vitem &*int&~pno*&
33711 This is used in later Exim processing when top level addresses are created by
33712 the &%one_time%& option. It is not relevant at the time &[local_scan()]& is run
33713 and must always contain -1 at this stage.
33714
33715 .vitem &*uschar&~*errors_to*&
33716 If this value is not NULL, bounce messages caused by failing to deliver to the
33717 recipient are sent to the address it contains. In other words, it overrides the
33718 envelope sender for this one recipient. (Compare the &%errors_to%& generic
33719 router option.) If a &[local_scan()]& function sets an &%errors_to%& field to
33720 an unqualified address, Exim qualifies it using the domain from
33721 &%qualify_recipient%&. When &[local_scan()]& is called, the &%errors_to%& field
33722 is NULL for all recipients.
33723 .endlist
33724
33725
33726
33727 .section "Available Exim functions" "SECID211"
33728 .cindex "&[local_scan()]& function" "available Exim functions"
33729 The header &_local_scan.h_& gives you access to a number of Exim functions.
33730 These are the only ones that are guaranteed to be maintained from release to
33731 release:
33732
33733 .vlist
33734 .vitem "&*pid_t&~child_open(uschar&~**argv,&~uschar&~**envp,&~int&~newumask,&&&
33735        &~int&~*infdptr,&~int&~*outfdptr, &~&~BOOL&~make_leader)*&"
33736
33737 This function creates a child process that runs the command specified by
33738 &%argv%&. The environment for the process is specified by &%envp%&, which can
33739 be NULL if no environment variables are to be passed. A new umask is supplied
33740 for the process in &%newumask%&.
33741
33742 Pipes to the standard input and output of the new process are set up
33743 and returned to the caller via the &%infdptr%& and &%outfdptr%& arguments. The
33744 standard error is cloned to the standard output. If there are any file
33745 descriptors &"in the way"& in the new process, they are closed. If the final
33746 argument is TRUE, the new process is made into a process group leader.
33747
33748 The function returns the pid of the new process, or -1 if things go wrong.
33749
33750 .vitem &*int&~child_close(pid_t&~pid,&~int&~timeout)*&
33751 This function waits for a child process to terminate, or for a timeout (in
33752 seconds) to expire. A timeout value of zero means wait as long as it takes. The
33753 return value is as follows:
33754
33755 .ilist
33756 >= 0
33757
33758 The process terminated by a normal exit and the value is the process
33759 ending status.
33760
33761 .next
33762 < 0 and > &--256
33763
33764 The process was terminated by a signal and the value is the negation of the
33765 signal number.
33766
33767 .next
33768 &--256
33769
33770 The process timed out.
33771 .next
33772 &--257
33773
33774 The was some other error in wait(); &%errno%& is still set.
33775 .endlist
33776
33777 .vitem &*pid_t&~child_open_exim(int&~*fd)*&
33778 This function provide you with a means of submitting a new message to
33779 Exim. (Of course, you can also call &_/usr/sbin/sendmail_& yourself if you
33780 want, but this packages it all up for you.) The function creates a pipe,
33781 forks a subprocess that is running
33782 .code
33783 exim -t -oem -oi -f <>
33784 .endd
33785 and returns to you (via the &`int *`& argument) a file descriptor for the pipe
33786 that is connected to the standard input. The yield of the function is the PID
33787 of the subprocess. You can then write a message to the file descriptor, with
33788 recipients in &'To:'&, &'Cc:'&, and/or &'Bcc:'& header lines.
33789
33790 When you have finished, call &'child_close()'& to wait for the process to
33791 finish and to collect its ending status. A timeout value of zero is usually
33792 fine in this circumstance. Unless you have made a mistake with the recipient
33793 addresses, you should get a return code of zero.
33794
33795
33796 .vitem &*pid_t&~child_open_exim2(int&~*fd,&~uschar&~*sender,&~uschar&~&&&
33797        *sender_authentication)*&
33798 This function is a more sophisticated version of &'child_open()'&. The command
33799 that it runs is:
33800 .display
33801 &`exim -t -oem -oi -f `&&'sender'&&` -oMas `&&'sender_authentication'&
33802 .endd
33803 The third argument may be NULL, in which case the &%-oMas%& option is omitted.
33804
33805
33806 .vitem &*void&~debug_printf(char&~*,&~...)*&
33807 This is Exim's debugging function, with arguments as for &'(printf()'&. The
33808 output is written to the standard error stream. If no debugging is selected,
33809 calls to &'debug_printf()'& have no effect. Normally, you should make calls
33810 conditional on the &`local_scan`& debug selector by coding like this:
33811 .code
33812 if ((debug_selector & D_local_scan) != 0)
33813   debug_printf("xxx", ...);
33814 .endd
33815
33816 .vitem &*uschar&~*expand_string(uschar&~*string)*&
33817 This is an interface to Exim's string expansion code. The return value is the
33818 expanded string, or NULL if there was an expansion failure.
33819 The C variable &%expand_string_message%& contains an error message after an
33820 expansion failure. If expansion does not change the string, the return value is
33821 the pointer to the input string. Otherwise, the return value points to a new
33822 block of memory that was obtained by a call to &'store_get()'&. See section
33823 &<<SECTmemhanloc>>& below for a discussion of memory handling.
33824
33825 .vitem &*void&~header_add(int&~type,&~char&~*format,&~...)*&
33826 This function allows you to an add additional header line at the end of the
33827 existing ones. The first argument is the type, and should normally be a space
33828 character. The second argument is a format string and any number of
33829 substitution arguments as for &[sprintf()]&. You may include internal newlines
33830 if you want, and you must ensure that the string ends with a newline.
33831
33832 .vitem "&*void&~header_add_at_position(BOOL&~after,&~uschar&~*name,&~&&&
33833         BOOL&~topnot,&~int&~type,&~char&~*format, &~&~...)*&"
33834 This function adds a new header line at a specified point in the header
33835 chain. The header itself is specified as for &'header_add()'&.
33836
33837 If &%name%& is NULL, the new header is added at the end of the chain if
33838 &%after%& is true, or at the start if &%after%& is false. If &%name%& is not
33839 NULL, the header lines are searched for the first non-deleted header that
33840 matches the name. If one is found, the new header is added before it if
33841 &%after%& is false. If &%after%& is true, the new header is added after the
33842 found header and any adjacent subsequent ones with the same name (even if
33843 marked &"deleted"&). If no matching non-deleted header is found, the &%topnot%&
33844 option controls where the header is added. If it is true, addition is at the
33845 top; otherwise at the bottom. Thus, to add a header after all the &'Received:'&
33846 headers, or at the top if there are no &'Received:'& headers, you could use
33847 .code
33848 header_add_at_position(TRUE, US"Received", TRUE,
33849   ' ', "X-xxx: ...");
33850 .endd
33851 Normally, there is always at least one non-deleted &'Received:'& header, but
33852 there may not be if &%received_header_text%& expands to an empty string.
33853
33854
33855 .vitem &*void&~header_remove(int&~occurrence,&~uschar&~*name)*&
33856 This function removes header lines. If &%occurrence%& is zero or negative, all
33857 occurrences of the header are removed. If occurrence is greater than zero, that
33858 particular instance of the header is removed. If no header(s) can be found that
33859 match the specification, the function does nothing.
33860
33861
33862 .vitem "&*BOOL&~header_testname(header_line&~*hdr,&~uschar&~*name,&~&&&
33863         int&~length,&~BOOL&~notdel)*&"
33864 This function tests whether the given header has the given name. It is not just
33865 a string comparison, because white space is permitted between the name and the
33866 colon. If the &%notdel%& argument is true, a false return is forced for all
33867 &"deleted"& headers; otherwise they are not treated specially. For example:
33868 .code
33869 if (header_testname(h, US"X-Spam", 6, TRUE)) ...
33870 .endd
33871 .vitem &*uschar&~*lss_b64encode(uschar&~*cleartext,&~int&~length)*&
33872 .cindex "base64 encoding" "functions for &[local_scan()]& use"
33873 This function base64-encodes a string, which is passed by address and length.
33874 The text may contain bytes of any value, including zero. The result is passed
33875 back in dynamic memory that is obtained by calling &'store_get()'&. It is
33876 zero-terminated.
33877
33878 .vitem &*int&~lss_b64decode(uschar&~*codetext,&~uschar&~**cleartext)*&
33879 This function decodes a base64-encoded string. Its arguments are a
33880 zero-terminated base64-encoded string and the address of a variable that is set
33881 to point to the result, which is in dynamic memory. The length of the decoded
33882 string is the yield of the function. If the input is invalid base64 data, the
33883 yield is -1. A zero byte is added to the end of the output string to make it
33884 easy to interpret as a C string (assuming it contains no zeros of its own). The
33885 added zero byte is not included in the returned count.
33886
33887 .vitem &*int&~lss_match_domain(uschar&~*domain,&~uschar&~*list)*&
33888 This function checks for a match in a domain list. Domains are always
33889 matched caselessly. The return value is one of the following:
33890 .display
33891 &`OK     `& match succeeded
33892 &`FAIL   `& match failed
33893 &`DEFER  `& match deferred
33894 .endd
33895 DEFER is usually caused by some kind of lookup defer, such as the
33896 inability to contact a database.
33897
33898 .vitem "&*int&~lss_match_local_part(uschar&~*localpart,&~uschar&~*list,&~&&&
33899         BOOL&~caseless)*&"
33900 This function checks for a match in a local part list. The third argument
33901 controls case-sensitivity. The return values are as for
33902 &'lss_match_domain()'&.
33903
33904 .vitem "&*int&~lss_match_address(uschar&~*address,&~uschar&~*list,&~&&&
33905         BOOL&~caseless)*&"
33906 This function checks for a match in an address list. The third argument
33907 controls the case-sensitivity of the local part match. The domain is always
33908 matched caselessly. The return values are as for &'lss_match_domain()'&.
33909
33910 .vitem "&*int&~lss_match_host(uschar&~*host_name,&~uschar&~*host_address,&~&&&
33911         uschar&~*list)*&"
33912 This function checks for a match in a host list. The most common usage is
33913 expected to be
33914 .code
33915 lss_match_host(sender_host_name, sender_host_address, ...)
33916 .endd
33917 .vindex "&$sender_host_address$&"
33918 An empty address field matches an empty item in the host list. If the host name
33919 is NULL, the name corresponding to &$sender_host_address$& is automatically
33920 looked up if a host name is required to match an item in the list. The return
33921 values are as for &'lss_match_domain()'&, but in addition, &'lss_match_host()'&
33922 returns ERROR in the case when it had to look up a host name, but the lookup
33923 failed.
33924
33925 .vitem "&*void&~log_write(unsigned&~int&~selector,&~int&~which,&~char&~&&&
33926         *format,&~...)*&"
33927 This function writes to Exim's log files. The first argument should be zero (it
33928 is concerned with &%log_selector%&). The second argument can be &`LOG_MAIN`& or
33929 &`LOG_REJECT`& or &`LOG_PANIC`& or the inclusive &"or"& of any combination of
33930 them. It specifies to which log or logs the message is written. The remaining
33931 arguments are a format and relevant insertion arguments. The string should not
33932 contain any newlines, not even at the end.
33933
33934
33935 .vitem &*void&~receive_add_recipient(uschar&~*address,&~int&~pno)*&
33936 This function adds an additional recipient to the message. The first argument
33937 is the recipient address. If it is unqualified (has no domain), it is qualified
33938 with the &%qualify_recipient%& domain. The second argument must always be -1.
33939
33940 This function does not allow you to specify a private &%errors_to%& address (as
33941 described with the structure of &%recipient_item%& above), because it pre-dates
33942 the addition of that field to the structure. However, it is easy to add such a
33943 value afterwards. For example:
33944 .code
33945  receive_add_recipient(US"monitor@mydom.example", -1);
33946  recipients_list[recipients_count-1].errors_to =
33947    US"postmaster@mydom.example";
33948 .endd
33949
33950 .vitem &*BOOL&~receive_remove_recipient(uschar&~*recipient)*&
33951 This is a convenience function to remove a named recipient from the list of
33952 recipients. It returns true if a recipient was removed, and false if no
33953 matching recipient could be found. The argument must be a complete email
33954 address.
33955 .endlist
33956
33957
33958 .cindex "RFC 2047"
33959 .vlist
33960 .vitem "&*uschar&~rfc2047_decode(uschar&~*string,&~BOOL&~lencheck,&&&
33961   &~uschar&~*target,&~int&~zeroval,&~int&~*lenptr, &~&~uschar&~**error)*&"
33962 This function decodes strings that are encoded according to RFC 2047. Typically
33963 these are the contents of header lines. First, each &"encoded word"& is decoded
33964 from the Q or B encoding into a byte-string. Then, if provided with the name of
33965 a charset encoding, and if the &[iconv()]& function is available, an attempt is
33966 made  to translate the result to the named character set. If this fails, the
33967 binary string is returned with an error message.
33968
33969 The first argument is the string to be decoded. If &%lencheck%& is TRUE, the
33970 maximum MIME word length is enforced. The third argument is the target
33971 encoding, or NULL if no translation is wanted.
33972
33973 .cindex "binary zero" "in RFC 2047 decoding"
33974 .cindex "RFC 2047" "binary zero in"
33975 If a binary zero is encountered in the decoded string, it is replaced by the
33976 contents of the &%zeroval%& argument. For use with Exim headers, the value must
33977 not be 0 because header lines are handled as zero-terminated strings.
33978
33979 The function returns the result of processing the string, zero-terminated; if
33980 &%lenptr%& is not NULL, the length of the result is set in the variable to
33981 which it points. When &%zeroval%& is 0, &%lenptr%& should not be NULL.
33982
33983 If an error is encountered, the function returns NULL and uses the &%error%&
33984 argument to return an error message. The variable pointed to by &%error%& is
33985 set to NULL if there is no error; it may be set non-NULL even when the function
33986 returns a non-NULL value if decoding was successful, but there was a problem
33987 with translation.
33988
33989
33990 .vitem &*int&~smtp_fflush(void)*&
33991 This function is used in conjunction with &'smtp_printf()'&, as described
33992 below.
33993
33994 .vitem &*void&~smtp_printf(char&~*,&~...)*&
33995 The arguments of this function are like &[printf()]&; it writes to the SMTP
33996 output stream. You should use this function only when there is an SMTP output
33997 stream, that is, when the incoming message is being received via interactive
33998 SMTP. This is the case when &%smtp_input%& is TRUE and &%smtp_batched_input%&
33999 is FALSE. If you want to test for an incoming message from another host (as
34000 opposed to a local process that used the &%-bs%& command line option), you can
34001 test the value of &%sender_host_address%&, which is non-NULL when a remote host
34002 is involved.
34003
34004 If an SMTP TLS connection is established, &'smtp_printf()'& uses the TLS
34005 output function, so it can be used for all forms of SMTP connection.
34006
34007 Strings that are written by &'smtp_printf()'& from within &[local_scan()]&
34008 must start with an appropriate response code: 550 if you are going to return
34009 LOCAL_SCAN_REJECT, 451 if you are going to return
34010 LOCAL_SCAN_TEMPREJECT, and 250 otherwise. Because you are writing the
34011 initial lines of a multi-line response, the code must be followed by a hyphen
34012 to indicate that the line is not the final response line. You must also ensure
34013 that the lines you write terminate with CRLF. For example:
34014 .code
34015 smtp_printf("550-this is some extra info\r\n");
34016 return LOCAL_SCAN_REJECT;
34017 .endd
34018 Note that you can also create multi-line responses by including newlines in
34019 the data returned via the &%return_text%& argument. The added value of using
34020 &'smtp_printf()'& is that, for instance, you could introduce delays between
34021 multiple output lines.
34022
34023 The &'smtp_printf()'& function does not return any error indication, because it
34024 does not automatically flush pending output, and therefore does not test
34025 the state of the stream. (In the main code of Exim, flushing and error
34026 detection is done when Exim is ready for the next SMTP input command.) If
34027 you want to flush the output and check for an error (for example, the
34028 dropping of a TCP/IP connection), you can call &'smtp_fflush()'&, which has no
34029 arguments. It flushes the output stream, and returns a non-zero value if there
34030 is an error.
34031
34032 .vitem &*void&~*store_get(int)*&
34033 This function accesses Exim's internal store (memory) manager. It gets a new
34034 chunk of memory whose size is given by the argument. Exim bombs out if it ever
34035 runs out of memory. See the next section for a discussion of memory handling.
34036
34037 .vitem &*void&~*store_get_perm(int)*&
34038 This function is like &'store_get()'&, but it always gets memory from the
34039 permanent pool. See the next section for a discussion of memory handling.
34040
34041 .vitem &*uschar&~*string_copy(uschar&~*string)*&
34042 See below.
34043
34044 .vitem &*uschar&~*string_copyn(uschar&~*string,&~int&~length)*&
34045 See below.
34046
34047 .vitem &*uschar&~*string_sprintf(char&~*format,&~...)*&
34048 These three functions create strings using Exim's dynamic memory facilities.
34049 The first makes a copy of an entire string. The second copies up to a maximum
34050 number of characters, indicated by the second argument. The third uses a format
34051 and insertion arguments to create a new string. In each case, the result is a
34052 pointer to a new string in the current memory pool. See the next section for
34053 more discussion.
34054 .endlist
34055
34056
34057
34058 .section "More about Exim's memory handling" "SECTmemhanloc"
34059 .cindex "&[local_scan()]& function" "memory handling"
34060 No function is provided for freeing memory, because that is never needed.
34061 The dynamic memory that Exim uses when receiving a message is automatically
34062 recycled if another message is received by the same process (this applies only
34063 to incoming SMTP connections &-- other input methods can supply only one
34064 message at a time). After receiving the last message, a reception process
34065 terminates.
34066
34067 Because it is recycled, the normal dynamic memory cannot be used for holding
34068 data that must be preserved over a number of incoming messages on the same SMTP
34069 connection. However, Exim in fact uses two pools of dynamic memory; the second
34070 one is not recycled, and can be used for this purpose.
34071
34072 If you want to allocate memory that remains available for subsequent messages
34073 in the same SMTP connection, you should set
34074 .code
34075 store_pool = POOL_PERM
34076 .endd
34077 before calling the function that does the allocation. There is no need to
34078 restore the value if you do not need to; however, if you do want to revert to
34079 the normal pool, you can either restore the previous value of &%store_pool%& or
34080 set it explicitly to POOL_MAIN.
34081
34082 The pool setting applies to all functions that get dynamic memory, including
34083 &'expand_string()'&, &'store_get()'&, and the &'string_xxx()'& functions.
34084 There is also a convenience function called &'store_get_perm()'& that gets a
34085 block of memory from the permanent pool while preserving the value of
34086 &%store_pool%&.
34087 .ecindex IIDlosca
34088
34089
34090
34091
34092 . ////////////////////////////////////////////////////////////////////////////
34093 . ////////////////////////////////////////////////////////////////////////////
34094
34095 .chapter "System-wide message filtering" "CHAPsystemfilter"
34096 .scindex IIDsysfil1 "filter" "system filter"
34097 .scindex IIDsysfil2 "filtering all mail"
34098 .scindex IIDsysfil3 "system filter"
34099 The previous chapters (on ACLs and the local scan function) describe checks
34100 that can be applied to messages before they are accepted by a host. There is
34101 also a mechanism for checking messages once they have been received, but before
34102 they are delivered. This is called the &'system filter'&.
34103
34104 The system filter operates in a similar manner to users' filter files, but it
34105 is run just once per message (however many recipients the message has).
34106 It should not normally be used as a substitute for routing, because &%deliver%&
34107 commands in a system router provide new envelope recipient addresses.
34108 The system filter must be an Exim filter. It cannot be a Sieve filter.
34109
34110 The system filter is run at the start of a delivery attempt, before any routing
34111 is done. If a message fails to be completely delivered at the first attempt,
34112 the system filter is run again at the start of every retry.
34113 If you want your filter to do something only once per message, you can make use
34114 of the &%first_delivery%& condition in an &%if%& command in the filter to
34115 prevent it happening on retries.
34116
34117 .vindex "&$domain$&"
34118 .vindex "&$local_part$&"
34119 &*Warning*&: Because the system filter runs just once, variables that are
34120 specific to individual recipient addresses, such as &$local_part$& and
34121 &$domain$&, are not set, and the &"personal"& condition is not meaningful. If
34122 you want to run a centrally-specified filter for each recipient address
34123 independently, you can do so by setting up a suitable &(redirect)& router, as
34124 described in section &<<SECTperaddfil>>& below.
34125
34126
34127 .section "Specifying a system filter" "SECID212"
34128 .cindex "uid (user id)" "system filter"
34129 .cindex "gid (group id)" "system filter"
34130 The name of the file that contains the system filter must be specified by
34131 setting &%system_filter%&. If you want the filter to run under a uid and gid
34132 other than root, you must also set &%system_filter_user%& and
34133 &%system_filter_group%& as appropriate. For example:
34134 .code
34135 system_filter = /etc/mail/exim.filter
34136 system_filter_user = exim
34137 .endd
34138 If a system filter generates any deliveries directly to files or pipes (via the
34139 &%save%& or &%pipe%& commands), transports to handle these deliveries must be
34140 specified by setting &%system_filter_file_transport%& and
34141 &%system_filter_pipe_transport%&, respectively. Similarly,
34142 &%system_filter_reply_transport%& must be set to handle any messages generated
34143 by the &%reply%& command.
34144
34145
34146 .section "Testing a system filter" "SECID213"
34147 You can run simple tests of a system filter in the same way as for a user
34148 filter, but you should use &%-bF%& rather than &%-bf%&, so that features that
34149 are permitted only in system filters are recognized.
34150
34151 If you want to test the combined effect of a system filter and a user filter,
34152 you can use both &%-bF%& and &%-bf%& on the same command line.
34153
34154
34155
34156 .section "Contents of a system filter" "SECID214"
34157 The language used to specify system filters is the same as for users' filter
34158 files. It is described in the separate end-user document &'Exim's interface to
34159 mail filtering'&. However, there are some additional features that are
34160 available only in system filters; these are described in subsequent sections.
34161 If they are encountered in a user's filter file or when testing with &%-bf%&,
34162 they cause errors.
34163
34164 .cindex "frozen messages" "manual thaw; testing in filter"
34165 There are two special conditions which, though available in users' filter
34166 files, are designed for use in system filters. The condition &%first_delivery%&
34167 is true only for the first attempt at delivering a message, and
34168 &%manually_thawed%& is true only if the message has been frozen, and
34169 subsequently thawed by an admin user. An explicit forced delivery counts as a
34170 manual thaw, but thawing as a result of the &%auto_thaw%& setting does not.
34171
34172 &*Warning*&: If a system filter uses the &%first_delivery%& condition to
34173 specify an &"unseen"& (non-significant) delivery, and that delivery does not
34174 succeed, it will not be tried again.
34175 If you want Exim to retry an unseen delivery until it succeeds, you should
34176 arrange to set it up every time the filter runs.
34177
34178 When a system filter finishes running, the values of the variables &$n0$& &--
34179 &$n9$& are copied into &$sn0$& &-- &$sn9$& and are thereby made available to
34180 users' filter files. Thus a system filter can, for example, set up &"scores"&
34181 to which users' filter files can refer.
34182
34183
34184
34185 .section "Additional variable for system filters" "SECID215"
34186 .vindex "&$recipients$&"
34187 The expansion variable &$recipients$&, containing a list of all the recipients
34188 of the message (separated by commas and white space), is available in system
34189 filters. It is not available in users' filters for privacy reasons.
34190
34191
34192
34193 .section "Defer, freeze, and fail commands for system filters" "SECID216"
34194 .cindex "freezing messages"
34195 .cindex "message" "freezing"
34196 .cindex "message" "forced failure"
34197 .cindex "&%fail%&" "in system filter"
34198 .cindex "&%freeze%& in system filter"
34199 .cindex "&%defer%& in system filter"
34200 There are three extra commands (&%defer%&, &%freeze%& and &%fail%&) which are
34201 always available in system filters, but are not normally enabled in users'
34202 filters. (See the &%allow_defer%&, &%allow_freeze%& and &%allow_fail%& options
34203 for the &(redirect)& router.) These commands can optionally be followed by the
34204 word &%text%& and a string containing an error message, for example:
34205 .code
34206 fail text "this message looks like spam to me"
34207 .endd
34208 The keyword &%text%& is optional if the next character is a double quote.
34209
34210 The &%defer%& command defers delivery of the original recipients of the
34211 message. The &%fail%& command causes all the original recipients to be failed,
34212 and a bounce message to be created. The &%freeze%& command suspends all
34213 delivery attempts for the original recipients. In all cases, any new deliveries
34214 that are specified by the filter are attempted as normal after the filter has
34215 run.
34216
34217 The &%freeze%& command is ignored if the message has been manually unfrozen and
34218 not manually frozen since. This means that automatic freezing by a system
34219 filter can be used as a way of checking out suspicious messages. If a message
34220 is found to be all right, manually unfreezing it allows it to be delivered.
34221
34222 .cindex "log" "&%fail%& command log line"
34223 .cindex "&%fail%&" "log line; reducing"
34224 The text given with a fail command is used as part of the bounce message as
34225 well as being written to the log. If the message is quite long, this can fill
34226 up a lot of log space when such failures are common. To reduce the size of the
34227 log message, Exim interprets the text in a special way if it starts with the
34228 two characters &`<<`& and contains &`>>`& later. The text between these two
34229 strings is written to the log, and the rest of the text is used in the bounce
34230 message. For example:
34231 .code
34232 fail "<<filter test 1>>Your message is rejected \
34233      because it contains attachments that we are \
34234      not prepared to receive."
34235 .endd
34236
34237 .cindex "loop" "caused by &%fail%&"
34238 Take great care with the &%fail%& command when basing the decision to fail on
34239 the contents of the message, because the bounce message will of course include
34240 the contents of the original message and will therefore trigger the &%fail%&
34241 command again (causing a mail loop) unless steps are taken to prevent this.
34242 Testing the &%error_message%& condition is one way to prevent this. You could
34243 use, for example
34244 .code
34245 if $message_body contains "this is spam" and not error_message
34246 then fail text "spam is not wanted here" endif
34247 .endd
34248 though of course that might let through unwanted bounce messages. The
34249 alternative is clever checking of the body and/or headers to detect bounces
34250 generated by the filter.
34251
34252 The interpretation of a system filter file ceases after a
34253 &%defer%&,
34254 &%freeze%&, or &%fail%& command is obeyed. However, any deliveries that were
34255 set up earlier in the filter file are honoured, so you can use a sequence such
34256 as
34257 .code
34258 mail ...
34259 freeze
34260 .endd
34261 to send a specified message when the system filter is freezing (or deferring or
34262 failing) a message. The normal deliveries for the message do not, of course,
34263 take place.
34264
34265
34266
34267 .section "Adding and removing headers in a system filter" "SECTaddremheasys"
34268 .cindex "header lines" "adding; in system filter"
34269 .cindex "header lines" "removing; in system filter"
34270 .cindex "filter" "header lines; adding/removing"
34271 Two filter commands that are available only in system filters are:
34272 .code
34273 headers add <string>
34274 headers remove <string>
34275 .endd
34276 The argument for the &%headers add%& is a string that is expanded and then
34277 added to the end of the message's headers. It is the responsibility of the
34278 filter maintainer to make sure it conforms to RFC 2822 syntax. Leading white
34279 space is ignored, and if the string is otherwise empty, or if the expansion is
34280 forced to fail, the command has no effect.
34281
34282 You can use &"\n"& within the string, followed by white space, to specify
34283 continued header lines. More than one header may be added in one command by
34284 including &"\n"& within the string without any following white space. For
34285 example:
34286 .code
34287 headers add "X-header-1: ....\n  \
34288              continuation of X-header-1 ...\n\
34289              X-header-2: ...."
34290 .endd
34291 Note that the header line continuation white space after the first newline must
34292 be placed before the backslash that continues the input string, because white
34293 space after input continuations is ignored.
34294
34295 The argument for &%headers remove%& is a colon-separated list of header names.
34296 This command applies only to those headers that are stored with the message;
34297 those that are added at delivery time (such as &'Envelope-To:'& and
34298 &'Return-Path:'&) cannot be removed by this means. If there is more than one
34299 header with the same name, they are all removed.
34300
34301 The &%headers%& command in a system filter makes an immediate change to the set
34302 of header lines that was received with the message (with possible additions
34303 from ACL processing). Subsequent commands in the system filter operate on the
34304 modified set, which also forms the basis for subsequent message delivery.
34305 Unless further modified during routing or transporting, this set of headers is
34306 used for all recipients of the message.
34307
34308 During routing and transporting, the variables that refer to the contents of
34309 header lines refer only to those lines that are in this set. Thus, header lines
34310 that are added by a system filter are visible to users' filter files and to all
34311 routers and transports. This contrasts with the manipulation of header lines by
34312 routers and transports, which is not immediate, but which instead is saved up
34313 until the message is actually being written (see section
34314 &<<SECTheadersaddrem>>&).
34315
34316 If the message is not delivered at the first attempt, header lines that were
34317 added by the system filter are stored with the message, and so are still
34318 present at the next delivery attempt. Header lines that were removed are still
34319 present, but marked &"deleted"& so that they are not transported with the
34320 message. For this reason, it is usual to make the &%headers%& command
34321 conditional on &%first_delivery%& so that the set of header lines is not
34322 modified more than once.
34323
34324 Because header modification in a system filter acts immediately, you have to
34325 use an indirect approach if you want to modify the contents of a header line.
34326 For example:
34327 .code
34328 headers add "Old-Subject: $h_subject:"
34329 headers remove "Subject"
34330 headers add "Subject: new subject (was: $h_old-subject:)"
34331 headers remove "Old-Subject"
34332 .endd
34333
34334
34335
34336 .section "Setting an errors address in a system filter" "SECID217"
34337 .cindex "envelope sender"
34338 In a system filter, if a &%deliver%& command is followed by
34339 .code
34340 errors_to <some address>
34341 .endd
34342 in order to change the envelope sender (and hence the error reporting) for that
34343 delivery, any address may be specified. (In a user filter, only the current
34344 user's address can be set.) For example, if some mail is being monitored, you
34345 might use
34346 .code
34347 unseen deliver monitor@spying.example errors_to root@local.example
34348 .endd
34349 to take a copy which would not be sent back to the normal error reporting
34350 address if its delivery failed.
34351
34352
34353
34354 .section "Per-address filtering" "SECTperaddfil"
34355 .vindex "&$domain$&"
34356 .vindex "&$local_part$&"
34357 In contrast to the system filter, which is run just once per message for each
34358 delivery attempt, it is also possible to set up a system-wide filtering
34359 operation that runs once for each recipient address. In this case, variables
34360 such as &$local_part$& and &$domain$& can be used, and indeed, the choice of
34361 filter file could be made dependent on them. This is an example of a router
34362 which implements such a filter:
34363 .code
34364 central_filter:
34365   check_local_user
34366   driver = redirect
34367   domains = +local_domains
34368   file = /central/filters/$local_part
34369   no_verify
34370   allow_filter
34371   allow_freeze
34372 .endd
34373 The filter is run in a separate process under its own uid. Therefore, either
34374 &%check_local_user%& must be set (as above), in which case the filter is run as
34375 the local user, or the &%user%& option must be used to specify which user to
34376 use. If both are set, &%user%& overrides.
34377
34378 Care should be taken to ensure that none of the commands in the filter file
34379 specify a significant delivery if the message is to go on to be delivered to
34380 its intended recipient. The router will not then claim to have dealt with the
34381 address, so it will be passed on to subsequent routers to be delivered in the
34382 normal way.
34383 .ecindex IIDsysfil1
34384 .ecindex IIDsysfil2
34385 .ecindex IIDsysfil3
34386
34387
34388
34389
34390
34391
34392 . ////////////////////////////////////////////////////////////////////////////
34393 . ////////////////////////////////////////////////////////////////////////////
34394
34395 .chapter "Message processing" "CHAPmsgproc"
34396 .scindex IIDmesproc "message" "general processing"
34397 Exim performs various transformations on the sender and recipient addresses of
34398 all messages that it handles, and also on the messages' header lines. Some of
34399 these are optional and configurable, while others always take place. All of
34400 this processing, except rewriting as a result of routing, and the addition or
34401 removal of header lines while delivering, happens when a message is received,
34402 before it is placed on Exim's queue.
34403
34404 Some of the automatic processing takes place by default only for
34405 &"locally-originated"& messages. This adjective is used to describe messages
34406 that are not received over TCP/IP, but instead are passed to an Exim process on
34407 its standard input. This includes the interactive &"local SMTP"& case that is
34408 set up by the &%-bs%& command line option.
34409
34410 &*Note*&: Messages received over TCP/IP on the loopback interface (127.0.0.1
34411 or ::1) are not considered to be locally-originated. Exim does not treat the
34412 loopback interface specially in any way.
34413
34414 If you want the loopback interface to be treated specially, you must ensure
34415 that there are appropriate entries in your ACLs.
34416
34417
34418
34419
34420 .section "Submission mode for non-local messages" "SECTsubmodnon"
34421 .cindex "message" "submission"
34422 .cindex "submission mode"
34423 Processing that happens automatically for locally-originated messages (unless
34424 &%suppress_local_fixups%& is set) can also be requested for messages that are
34425 received over TCP/IP. The term &"submission mode"& is used to describe this
34426 state. Submission mode is set by the modifier
34427 .code
34428 control = submission
34429 .endd
34430 in a MAIL, RCPT, or pre-data ACL for an incoming message (see sections
34431 &<<SECTACLmodi>>& and &<<SECTcontrols>>&). This makes Exim treat the message as
34432 a local submission, and is normally used when the source of the message is
34433 known to be an MUA running on a client host (as opposed to an MTA). For
34434 example, to set submission mode for messages originating on the IPv4 loopback
34435 interface, you could include the following in the MAIL ACL:
34436 .code
34437 warn  hosts = 127.0.0.1
34438       control = submission
34439 .endd
34440 .cindex "&%sender_retain%& submission option"
34441 There are some options that can be used when setting submission mode. A slash
34442 is used to separate options. For example:
34443 .code
34444 control = submission/sender_retain
34445 .endd
34446 Specifying &%sender_retain%& has the effect of setting &%local_sender_retain%&
34447 true and &%local_from_check%& false for the current incoming message. The first
34448 of these allows an existing &'Sender:'& header in the message to remain, and
34449 the second suppresses the check to ensure that &'From:'& matches the
34450 authenticated sender. With this setting, Exim still fixes up messages by adding
34451 &'Date:'& and &'Message-ID:'& header lines if they are missing, but makes no
34452 attempt to check sender authenticity in header lines.
34453
34454 When &%sender_retain%& is not set, a submission mode setting may specify a
34455 domain to be used when generating a &'From:'& or &'Sender:'& header line. For
34456 example:
34457 .code
34458 control = submission/domain=some.domain
34459 .endd
34460 The domain may be empty. How this value is used is described in sections
34461 &<<SECTthefrohea>>& and &<<SECTthesenhea>>&. There is also a &%name%& option
34462 that allows you to specify the user's full name for inclusion in a created
34463 &'Sender:'& or &'From:'& header line. For example:
34464 .code
34465 accept authenticated = *
34466        control = submission/domain=wonderland.example/\
34467                             name=${lookup {$authenticated_id} \
34468                                    lsearch {/etc/exim/namelist}}
34469 .endd
34470 Because the name may contain any characters, including slashes, the &%name%&
34471 option must be given last. The remainder of the string is used as the name. For
34472 the example above, if &_/etc/exim/namelist_& contains:
34473 .code
34474 bigegg:  Humpty Dumpty
34475 .endd
34476 then when the sender has authenticated as &'bigegg'&, the generated &'Sender:'&
34477 line would be:
34478 .code
34479 Sender: Humpty Dumpty <bigegg@wonderland.example>
34480 .endd
34481 .cindex "return path" "in submission mode"
34482 By default, submission mode forces the return path to the same address as is
34483 used to create the &'Sender:'& header. However, if &%sender_retain%& is
34484 specified, the return path is also left unchanged.
34485
34486 &*Note*&: The changes caused by submission mode take effect after the predata
34487 ACL. This means that any sender checks performed before the fix-ups use the
34488 untrusted sender address specified by the user, not the trusted sender address
34489 specified by submission mode. Although this might be slightly unexpected, it
34490 does mean that you can configure ACL checks to spot that a user is trying to
34491 spoof another's address.
34492
34493 .section "Line endings" "SECTlineendings"
34494 .cindex "line endings"
34495 .cindex "carriage return"
34496 .cindex "linefeed"
34497 RFC 2821 specifies that CRLF (two characters: carriage-return, followed by
34498 linefeed) is the line ending for messages transmitted over the Internet using
34499 SMTP over TCP/IP. However, within individual operating systems, different
34500 conventions are used. For example, Unix-like systems use just LF, but others
34501 use CRLF or just CR.
34502
34503 Exim was designed for Unix-like systems, and internally, it stores messages
34504 using the system's convention of a single LF as a line terminator. When
34505 receiving a message, all line endings are translated to this standard format.
34506 Originally, it was thought that programs that passed messages directly to an
34507 MTA within an operating system would use that system's convention. Experience
34508 has shown that this is not the case; for example, there are Unix applications
34509 that use CRLF in this circumstance. For this reason, and for compatibility with
34510 other MTAs, the way Exim handles line endings for all messages is now as
34511 follows:
34512
34513 .ilist
34514 LF not preceded by CR is treated as a line ending.
34515 .next
34516 CR is treated as a line ending; if it is immediately followed by LF, the LF
34517 is ignored.
34518 .next
34519 The sequence &"CR, dot, CR"& does not terminate an incoming SMTP message,
34520 nor a local message in the state where a line containing only a dot is a
34521 terminator.
34522 .next
34523 If a bare CR is encountered within a header line, an extra space is added after
34524 the line terminator so as not to end the header line. The reasoning behind this
34525 is that bare CRs in header lines are most likely either to be mistakes, or
34526 people trying to play silly games.
34527 .next
34528 If the first header line received in a message ends with CRLF, a subsequent
34529 bare LF in a header line is treated in the same way as a bare CR in a header
34530 line.
34531 .endlist
34532
34533
34534
34535
34536
34537 .section "Unqualified addresses" "SECID218"
34538 .cindex "unqualified addresses"
34539 .cindex "address" "qualification"
34540 By default, Exim expects every envelope address it receives from an external
34541 host to be fully qualified. Unqualified addresses cause negative responses to
34542 SMTP commands. However, because SMTP is used as a means of transporting
34543 messages from MUAs running on personal workstations, there is sometimes a
34544 requirement to accept unqualified addresses from specific hosts or IP networks.
34545
34546 Exim has two options that separately control which hosts may send unqualified
34547 sender or recipient addresses in SMTP commands, namely
34548 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&. In both
34549 cases, if an unqualified address is accepted, it is qualified by adding the
34550 value of &%qualify_domain%& or &%qualify_recipient%&, as appropriate.
34551
34552 .oindex "&%qualify_domain%&"
34553 .oindex "&%qualify_recipient%&"
34554 Unqualified addresses in header lines are automatically qualified for messages
34555 that are locally originated, unless the &%-bnq%& option is given on the command
34556 line. For messages received over SMTP, unqualified addresses in header lines
34557 are qualified only if unqualified addresses are permitted in SMTP commands. In
34558 other words, such qualification is also controlled by
34559 &%sender_unqualified_hosts%& and &%recipient_unqualified_hosts%&,
34560
34561
34562
34563
34564 .section "The UUCP From line" "SECID219"
34565 .cindex "&""From""& line"
34566 .cindex "UUCP" "&""From""& line"
34567 .cindex "sender" "address"
34568 .oindex "&%uucp_from_pattern%&"
34569 .oindex "&%uucp_from_sender%&"
34570 .cindex "envelope sender"
34571 .cindex "Sendmail compatibility" "&""From""& line"
34572 Messages that have come from UUCP (and some other applications) often begin
34573 with a line containing the envelope sender and a timestamp, following the word
34574 &"From"&. Examples of two common formats are:
34575 .code
34576 From a.oakley@berlin.mus Fri Jan  5 12:35 GMT 1996
34577 From f.butler@berlin.mus Fri, 7 Jan 97 14:00:00 GMT
34578 .endd
34579 This line precedes the RFC 2822 header lines. For compatibility with Sendmail,
34580 Exim recognizes such lines at the start of messages that are submitted to it
34581 via the command line (that is, on the standard input). It does not recognize
34582 such lines in incoming SMTP messages, unless the sending host matches
34583 &%ignore_fromline_hosts%& or the &%-bs%& option was used for a local message
34584 and &%ignore_fromline_local%& is set. The recognition is controlled by a
34585 regular expression that is defined by the &%uucp_from_pattern%& option, whose
34586 default value matches the two common cases shown above and puts the address
34587 that follows &"From"& into &$1$&.
34588
34589 .cindex "numerical variables (&$1$& &$2$& etc)" "in &""From ""& line handling"
34590 When the caller of Exim for a non-SMTP message that contains a &"From"& line is
34591 a trusted user, the message's sender address is constructed by expanding the
34592 contents of &%uucp_sender_address%&, whose default value is &"$1"&. This is
34593 then parsed as an RFC 2822 address. If there is no domain, the local part is
34594 qualified with &%qualify_domain%& unless it is the empty string. However, if
34595 the command line &%-f%& option is used, it overrides the &"From"& line.
34596
34597 If the caller of Exim is not trusted, the &"From"& line is recognized, but the
34598 sender address is not changed. This is also the case for incoming SMTP messages
34599 that are permitted to contain &"From"& lines.
34600
34601 Only one &"From"& line is recognized. If there is more than one, the second is
34602 treated as a data line that starts the body of the message, as it is not valid
34603 as a header line. This also happens if a &"From"& line is present in an
34604 incoming SMTP message from a source that is not permitted to send them.
34605
34606
34607
34608 .section "Resent- header lines" "SECID220"
34609 .cindex "&%Resent-%& header lines"
34610 .cindex "header lines" "Resent-"
34611 RFC 2822 makes provision for sets of header lines starting with the string
34612 &`Resent-`& to be added to a message when it is resent by the original
34613 recipient to somebody else. These headers are &'Resent-Date:'&,
34614 &'Resent-From:'&, &'Resent-Sender:'&, &'Resent-To:'&, &'Resent-Cc:'&,
34615 &'Resent-Bcc:'& and &'Resent-Message-ID:'&. The RFC says:
34616
34617 .blockquote
34618 &'Resent fields are strictly informational. They MUST NOT be used in the normal
34619 processing of replies or other such automatic actions on messages.'&
34620 .endblockquote
34621
34622 This leaves things a bit vague as far as other processing actions such as
34623 address rewriting are concerned. Exim treats &%Resent-%& header lines as
34624 follows:
34625
34626 .ilist
34627 A &'Resent-From:'& line that just contains the login id of the submitting user
34628 is automatically rewritten in the same way as &'From:'& (see below).
34629 .next
34630 If there's a rewriting rule for a particular header line, it is also applied to
34631 &%Resent-%& header lines of the same type. For example, a rule that rewrites
34632 &'From:'& also rewrites &'Resent-From:'&.
34633 .next
34634 For local messages, if &'Sender:'& is removed on input, &'Resent-Sender:'& is
34635 also removed.
34636 .next
34637 For a locally-submitted message,
34638 if there are any &%Resent-%& header lines but no &'Resent-Date:'&,
34639 &'Resent-From:'&, or &'Resent-Message-Id:'&, they are added as necessary. It is
34640 the contents of &'Resent-Message-Id:'& (rather than &'Message-Id:'&) which are
34641 included in log lines in this case.
34642 .next
34643 The logic for adding &'Sender:'& is duplicated for &'Resent-Sender:'& when any
34644 &%Resent-%& header lines are present.
34645 .endlist
34646
34647
34648
34649
34650 .section "The Auto-Submitted: header line" "SECID221"
34651 Whenever Exim generates an autoreply, a bounce, or a delay warning message, it
34652 includes the header line:
34653 .code
34654 Auto-Submitted: auto-replied
34655 .endd
34656
34657 .section "The Bcc: header line" "SECID222"
34658 .cindex "&'Bcc:'& header line"
34659 If Exim is called with the &%-t%& option, to take recipient addresses from a
34660 message's header, it removes any &'Bcc:'& header line that may exist (after
34661 extracting its addresses). If &%-t%& is not present on the command line, any
34662 existing &'Bcc:'& is not removed.
34663
34664
34665 .section "The Date: header line" "SECID223"
34666 .cindex "&'Date:'& header line"
34667 .cindex "header lines" "Date:"
34668 If a locally-generated or submission-mode message has no &'Date:'& header line,
34669 Exim adds one, using the current date and time, unless the
34670 &%suppress_local_fixups%& control has been specified.
34671
34672 .section "The Delivery-date: header line" "SECID224"
34673 .cindex "&'Delivery-date:'& header line"
34674 .oindex "&%delivery_date_remove%&"
34675 &'Delivery-date:'& header lines are not part of the standard RFC 2822 header
34676 set. Exim can be configured to add them to the final delivery of messages. (See
34677 the generic &%delivery_date_add%& transport option.) They should not be present
34678 in messages in transit. If the &%delivery_date_remove%& configuration option is
34679 set (the default), Exim removes &'Delivery-date:'& header lines from incoming
34680 messages.
34681
34682
34683 .section "The Envelope-to: header line" "SECID225"
34684 .cindex "&'Envelope-to:'& header line"
34685 .cindex "header lines" "Envelope-to:"
34686 .oindex "&%envelope_to_remove%&"
34687 &'Envelope-to:'& header lines are not part of the standard RFC 2822 header set.
34688 Exim can be configured to add them to the final delivery of messages. (See the
34689 generic &%envelope_to_add%& transport option.) They should not be present in
34690 messages in transit. If the &%envelope_to_remove%& configuration option is set
34691 (the default), Exim removes &'Envelope-to:'& header lines from incoming
34692 messages.
34693
34694
34695 .section "The From: header line" "SECTthefrohea"
34696 .cindex "&'From:'& header line"
34697 .cindex "header lines" "From:"
34698 .cindex "Sendmail compatibility" "&""From""& line"
34699 .cindex "message" "submission"
34700 .cindex "submission mode"
34701 If a submission-mode message does not contain a &'From:'& header line, Exim
34702 adds one if either of the following conditions is true:
34703
34704 .ilist
34705 The envelope sender address is not empty (that is, this is not a bounce
34706 message). The added header line copies the envelope sender address.
34707 .next
34708 .vindex "&$authenticated_id$&"
34709 The SMTP session is authenticated and &$authenticated_id$& is not empty.
34710 .olist
34711 .vindex "&$qualify_domain$&"
34712 If no domain is specified by the submission control, the local part is
34713 &$authenticated_id$& and the domain is &$qualify_domain$&.
34714 .next
34715 If a non-empty domain is specified by the submission control, the local
34716 part is &$authenticated_id$&, and the domain is the specified domain.
34717 .next
34718 If an empty domain is specified by the submission control,
34719 &$authenticated_id$& is assumed to be the complete address.
34720 .endlist
34721 .endlist
34722
34723 A non-empty envelope sender takes precedence.
34724
34725 If a locally-generated incoming message does not contain a &'From:'& header
34726 line, and the &%suppress_local_fixups%& control is not set, Exim adds one
34727 containing the sender's address. The calling user's login name and full name
34728 are used to construct the address, as described in section &<<SECTconstr>>&.
34729 They are obtained from the password data by calling &[getpwuid()]& (but see the
34730 &%unknown_login%& configuration option). The address is qualified with
34731 &%qualify_domain%&.
34732
34733 For compatibility with Sendmail, if an incoming, non-SMTP message has a
34734 &'From:'& header line containing just the unqualified login name of the calling
34735 user, this is replaced by an address containing the user's login name and full
34736 name as described in section &<<SECTconstr>>&.
34737
34738
34739 .section "The Message-ID: header line" "SECID226"
34740 .cindex "&'Message-ID:'& header line"
34741 .cindex "header lines" "Message-ID:"
34742 .cindex "message" "submission"
34743 .oindex "&%message_id_header_text%&"
34744 If a locally-generated or submission-mode incoming message does not contain a
34745 &'Message-ID:'& or &'Resent-Message-ID:'& header line, and the
34746 &%suppress_local_fixups%& control is not set, Exim adds a suitable header line
34747 to the message. If there are any &'Resent-:'& headers in the message, it
34748 creates &'Resent-Message-ID:'&. The id is constructed from Exim's internal
34749 message id, preceded by the letter E to ensure it starts with a letter, and
34750 followed by @ and the primary host name. Additional information can be included
34751 in this header line by setting the &%message_id_header_text%& and/or
34752 &%message_id_header_domain%& options.
34753
34754
34755 .section "The Received: header line" "SECID227"
34756 .cindex "&'Received:'& header line"
34757 .cindex "header lines" "Received:"
34758 A &'Received:'& header line is added at the start of every message. The
34759 contents are defined by the &%received_header_text%& configuration option, and
34760 Exim automatically adds a semicolon and a timestamp to the configured string.
34761
34762 The &'Received:'& header is generated as soon as the message's header lines
34763 have been received. At this stage, the timestamp in the &'Received:'& header
34764 line is the time that the message started to be received. This is the value
34765 that is seen by the DATA ACL and by the &[local_scan()]& function.
34766
34767 Once a message is accepted, the timestamp in the &'Received:'& header line is
34768 changed to the time of acceptance, which is (apart from a small delay while the
34769 -H spool file is written) the earliest time at which delivery could start.
34770
34771
34772 .section "The References: header line" "SECID228"
34773 .cindex "&'References:'& header line"
34774 .cindex "header lines" "References:"
34775 Messages created by the &(autoreply)& transport include a &'References:'&
34776 header line. This is constructed according to the rules that are described in
34777 section 3.64 of RFC 2822 (which states that replies should contain such a
34778 header line), and section 3.14 of RFC 3834 (which states that automatic
34779 responses are not different in this respect). However, because some mail
34780 processing software does not cope well with very long header lines, no more
34781 than 12 message IDs are copied from the &'References:'& header line in the
34782 incoming message. If there are more than 12, the first one and then the final
34783 11 are copied, before adding the message ID of the incoming message.
34784
34785
34786
34787 .section "The Return-path: header line" "SECID229"
34788 .cindex "&'Return-path:'& header line"
34789 .cindex "header lines" "Return-path:"
34790 .oindex "&%return_path_remove%&"
34791 &'Return-path:'& header lines are defined as something an MTA may insert when
34792 it does the final delivery of messages. (See the generic &%return_path_add%&
34793 transport option.) Therefore, they should not be present in messages in
34794 transit. If the &%return_path_remove%& configuration option is set (the
34795 default), Exim removes &'Return-path:'& header lines from incoming messages.
34796
34797
34798
34799 .section "The Sender: header line" "SECTthesenhea"
34800 .cindex "&'Sender:'& header line"
34801 .cindex "message" "submission"
34802 .cindex "header lines" "Sender:"
34803 For a locally-originated message from an untrusted user, Exim may remove an
34804 existing &'Sender:'& header line, and it may add a new one. You can modify
34805 these actions by setting the &%local_sender_retain%& option true, the
34806 &%local_from_check%& option false, or by using the &%suppress_local_fixups%&
34807 control setting.
34808
34809 When a local message is received from an untrusted user and
34810 &%local_from_check%& is true (the default), and the &%suppress_local_fixups%&
34811 control has not been set, a check is made to see if the address given in the
34812 &'From:'& header line is the correct (local) sender of the message. The address
34813 that is expected has the login name as the local part and the value of
34814 &%qualify_domain%& as the domain. Prefixes and suffixes for the local part can
34815 be permitted by setting &%local_from_prefix%& and &%local_from_suffix%&
34816 appropriately. If &'From:'& does not contain the correct sender, a &'Sender:'&
34817 line is added to the message.
34818
34819 If you set &%local_from_check%& false, this checking does not occur. However,
34820 the removal of an existing &'Sender:'& line still happens, unless you also set
34821 &%local_sender_retain%& to be true. It is not possible to set both of these
34822 options true at the same time.
34823
34824 .cindex "submission mode"
34825 By default, no processing of &'Sender:'& header lines is done for messages
34826 received over TCP/IP or for messages submitted by trusted users. However, when
34827 a message is received over TCP/IP in submission mode, and &%sender_retain%& is
34828 not specified on the submission control, the following processing takes place:
34829
34830 .vindex "&$authenticated_id$&"
34831 First, any existing &'Sender:'& lines are removed. Then, if the SMTP session is
34832 authenticated, and &$authenticated_id$& is not empty, a sender address is
34833 created as follows:
34834
34835 .ilist
34836 .vindex "&$qualify_domain$&"
34837 If no domain is specified by the submission control, the local part is
34838 &$authenticated_id$& and the domain is &$qualify_domain$&.
34839 .next
34840 If a non-empty domain is specified by the submission control, the local part
34841 is &$authenticated_id$&, and the domain is the specified domain.
34842 .next
34843 If an empty domain is specified by the submission control,
34844 &$authenticated_id$& is assumed to be the complete address.
34845 .endlist
34846
34847 This address is compared with the address in the &'From:'& header line. If they
34848 are different, a &'Sender:'& header line containing the created address is
34849 added. Prefixes and suffixes for the local part in &'From:'& can be permitted
34850 by setting &%local_from_prefix%& and &%local_from_suffix%& appropriately.
34851
34852 .cindex "return path" "created from &'Sender:'&"
34853 &*Note*&: Whenever a &'Sender:'& header line is created, the return path for
34854 the message (the envelope sender address) is changed to be the same address,
34855 except in the case of submission mode when &%sender_retain%& is specified.
34856
34857
34858
34859 .section "Adding and removing header lines in routers and transports" &&&
34860          "SECTheadersaddrem"
34861 .cindex "header lines" "adding; in router or transport"
34862 .cindex "header lines" "removing; in router or transport"
34863 When a message is delivered, the addition and removal of header lines can be
34864 specified in a system filter, or on any of the routers and transports that
34865 process the message. Section &<<SECTaddremheasys>>& contains details about
34866 modifying headers in a system filter. Header lines can also be added in an ACL
34867 as a message is received (see section &<<SECTaddheadacl>>&).
34868
34869 In contrast to what happens in a system filter, header modifications that are
34870 specified on routers and transports apply only to the particular recipient
34871 addresses that are being processed by those routers and transports. These
34872 changes do not actually take place until a copy of the message is being
34873 transported. Therefore, they do not affect the basic set of header lines, and
34874 they do not affect the values of the variables that refer to header lines.
34875
34876 &*Note*&: In particular, this means that any expansions in the configuration of
34877 the transport cannot refer to the modified header lines, because such
34878 expansions all occur before the message is actually transported.
34879
34880 For both routers and transports, the argument of a &%headers_add%&
34881 option must be in the form of one or more RFC 2822 header lines, separated by
34882 newlines (coded as &"\n"&). For example:
34883 .code
34884 headers_add = X-added-header: added by $primary_hostname\n\
34885               X-added-second: another added header line
34886 .endd
34887 Exim does not check the syntax of these added header lines.
34888
34889 Multiple &%headers_add%& options for a single router or transport can be
34890 specified; the values will append to a single list of header lines.
34891 Each header-line is separately expanded.
34892
34893 The argument of a &%headers_remove%& option must consist of a colon-separated
34894 list of header names. This is confusing, because header names themselves are
34895 often terminated by colons. In this case, the colons are the list separators,
34896 not part of the names. For example:
34897 .code
34898 headers_remove = return-receipt-to:acknowledge-to
34899 .endd
34900
34901 Multiple &%headers_remove%& options for a single router or transport can be
34902 specified; the arguments will append to a single header-names list.
34903 Each item is separately expanded.
34904 Note that colons in complex expansions which are used to
34905 form all or part of a &%headers_remove%& list
34906 will act as list separators.
34907
34908 When &%headers_add%& or &%headers_remove%& is specified on a router,
34909 items are expanded at routing time,
34910 and then associated with all addresses that are
34911 accepted by that router, and also with any new addresses that it generates. If
34912 an address passes through several routers as a result of aliasing or
34913 forwarding, the changes are cumulative.
34914
34915 .oindex "&%unseen%&"
34916 However, this does not apply to multiple routers that result from the use of
34917 the &%unseen%& option. Any header modifications that were specified by the
34918 &"unseen"& router or its predecessors apply only to the &"unseen"& delivery.
34919
34920 Addresses that end up with different &%headers_add%& or &%headers_remove%&
34921 settings cannot be delivered together in a batch, so a transport is always
34922 dealing with a set of addresses that have the same header-processing
34923 requirements.
34924
34925 The transport starts by writing the original set of header lines that arrived
34926 with the message, possibly modified by the system filter. As it writes out
34927 these lines, it consults the list of header names that were attached to the
34928 recipient address(es) by &%headers_remove%& options in routers, and it also
34929 consults the transport's own &%headers_remove%& option. Header lines whose
34930 names are on either of these lists are not written out. If there are multiple
34931 instances of any listed header, they are all skipped.
34932
34933 After the remaining original header lines have been written, new header
34934 lines that were specified by routers' &%headers_add%& options are written, in
34935 the order in which they were attached to the address. These are followed by any
34936 header lines specified by the transport's &%headers_add%& option.
34937
34938 This way of handling header line modifications in routers and transports has
34939 the following consequences:
34940
34941 .ilist
34942 The original set of header lines, possibly modified by the system filter,
34943 remains &"visible"&, in the sense that the &$header_$&&'xxx'& variables refer
34944 to it, at all times.
34945 .next
34946 Header lines that are added by a router's
34947 &%headers_add%& option are not accessible by means of the &$header_$&&'xxx'&
34948 expansion syntax in subsequent routers or the transport.
34949 .next
34950 Conversely, header lines that are specified for removal by &%headers_remove%&
34951 in a router remain visible to subsequent routers and the transport.
34952 .next
34953 Headers added to an address by &%headers_add%& in a router cannot be removed by
34954 a later router or by a transport.
34955 .next
34956 An added header can refer to the contents of an original header that is to be
34957 removed, even it has the same name as the added header. For example:
34958 .code
34959 headers_remove = subject
34960 headers_add = Subject: new subject (was: $h_subject:)
34961 .endd
34962 .endlist
34963
34964 &*Warning*&: The &%headers_add%& and &%headers_remove%& options cannot be used
34965 for a &(redirect)& router that has the &%one_time%& option set.
34966
34967
34968
34969
34970
34971 .section "Constructed addresses" "SECTconstr"
34972 .cindex "address" "constructed"
34973 .cindex "constructed address"
34974 When Exim constructs a sender address for a locally-generated message, it uses
34975 the form
34976 .display
34977 <&'user name'&>&~&~<&'login'&&`@`&&'qualify_domain'&>
34978 .endd
34979 For example:
34980 .code
34981 Zaphod Beeblebrox <zaphod@end.univ.example>
34982 .endd
34983 The user name is obtained from the &%-F%& command line option if set, or
34984 otherwise by looking up the calling user by &[getpwuid()]& and extracting the
34985 &"gecos"& field from the password entry. If the &"gecos"& field contains an
34986 ampersand character, this is replaced by the login name with the first letter
34987 upper cased, as is conventional in a number of operating systems. See the
34988 &%gecos_name%& option for a way to tailor the handling of the &"gecos"& field.
34989 The &%unknown_username%& option can be used to specify user names in cases when
34990 there is no password file entry.
34991
34992 .cindex "RFC 2047"
34993 In all cases, the user name is made to conform to RFC 2822 by quoting all or
34994 parts of it if necessary. In addition, if it contains any non-printing
34995 characters, it is encoded as described in RFC 2047, which defines a way of
34996 including non-ASCII characters in header lines. The value of the
34997 &%headers_charset%& option specifies the name of the encoding that is used (the
34998 characters are assumed to be in this encoding). The setting of
34999 &%print_topbitchars%& controls whether characters with the top bit set (that
35000 is, with codes greater than 127) count as printing characters or not.
35001
35002
35003
35004 .section "Case of local parts" "SECID230"
35005 .cindex "case of local parts"
35006 .cindex "local part" "case of"
35007 RFC 2822 states that the case of letters in the local parts of addresses cannot
35008 be assumed to be non-significant. Exim preserves the case of local parts of
35009 addresses, but by default it uses a lower-cased form when it is routing,
35010 because on most Unix systems, usernames are in lower case and case-insensitive
35011 routing is required. However, any particular router can be made to use the
35012 original case for local parts by setting the &%caseful_local_part%& generic
35013 router option.
35014
35015 .cindex "mixed-case login names"
35016 If you must have mixed-case user names on your system, the best way to proceed,
35017 assuming you want case-independent handling of incoming email, is to set up
35018 your first router to convert incoming local parts in your domains to the
35019 correct case by means of a file lookup. For example:
35020 .code
35021 correct_case:
35022   driver = redirect
35023   domains = +local_domains
35024   data = ${lookup{$local_part}cdb\
35025               {/etc/usercased.cdb}{$value}fail}\
35026               @$domain
35027 .endd
35028 For this router, the local part is forced to lower case by the default action
35029 (&%caseful_local_part%& is not set). The lower-cased local part is used to look
35030 up a new local part in the correct case. If you then set &%caseful_local_part%&
35031 on any subsequent routers which process your domains, they will operate on
35032 local parts with the correct case in a case-sensitive manner.
35033
35034
35035
35036 .section "Dots in local parts" "SECID231"
35037 .cindex "dot" "in local part"
35038 .cindex "local part" "dots in"
35039 RFC 2822 forbids empty components in local parts. That is, an unquoted local
35040 part may not begin or end with a dot, nor have two consecutive dots in the
35041 middle. However, it seems that many MTAs do not enforce this, so Exim permits
35042 empty components for compatibility.
35043
35044
35045
35046 .section "Rewriting addresses" "SECID232"
35047 .cindex "rewriting" "addresses"
35048 Rewriting of sender and recipient addresses, and addresses in headers, can
35049 happen automatically, or as the result of configuration options, as described
35050 in chapter &<<CHAPrewrite>>&. The headers that may be affected by this are
35051 &'Bcc:'&, &'Cc:'&, &'From:'&, &'Reply-To:'&, &'Sender:'&, and &'To:'&.
35052
35053 Automatic rewriting includes qualification, as mentioned above. The other case
35054 in which it can happen is when an incomplete non-local domain is given. The
35055 routing process may cause this to be expanded into the full domain name. For
35056 example, a header such as
35057 .code
35058 To: hare@teaparty
35059 .endd
35060 might get rewritten as
35061 .code
35062 To: hare@teaparty.wonderland.fict.example
35063 .endd
35064 Rewriting as a result of routing is the one kind of message processing that
35065 does not happen at input time, as it cannot be done until the address has
35066 been routed.
35067
35068 Strictly, one should not do &'any'& deliveries of a message until all its
35069 addresses have been routed, in case any of the headers get changed as a
35070 result of routing. However, doing this in practice would hold up many
35071 deliveries for unreasonable amounts of time, just because one address could not
35072 immediately be routed. Exim therefore does not delay other deliveries when
35073 routing of one or more addresses is deferred.
35074 .ecindex IIDmesproc
35075
35076
35077
35078 . ////////////////////////////////////////////////////////////////////////////
35079 . ////////////////////////////////////////////////////////////////////////////
35080
35081 .chapter "SMTP processing" "CHAPSMTP"
35082 .scindex IIDsmtpproc1 "SMTP" "processing details"
35083 .scindex IIDsmtpproc2 "LMTP" "processing details"
35084 Exim supports a number of different ways of using the SMTP protocol, and its
35085 LMTP variant, which is an interactive protocol for transferring messages into a
35086 closed mail store application. This chapter contains details of how SMTP is
35087 processed. For incoming mail, the following are available:
35088
35089 .ilist
35090 SMTP over TCP/IP (Exim daemon or &'inetd'&);
35091 .next
35092 SMTP over the standard input and output (the &%-bs%& option);
35093 .next
35094 Batched SMTP on the standard input (the &%-bS%& option).
35095 .endlist
35096
35097 For mail delivery, the following are available:
35098
35099 .ilist
35100 SMTP over TCP/IP (the &(smtp)& transport);
35101 .next
35102 LMTP over TCP/IP (the &(smtp)& transport with the &%protocol%& option set to
35103 &"lmtp"&);
35104 .next
35105 LMTP over a pipe to a process running in the local host (the &(lmtp)&
35106 transport);
35107 .next
35108 Batched SMTP to a file or pipe (the &(appendfile)& and &(pipe)& transports with
35109 the &%use_bsmtp%& option set).
35110 .endlist
35111
35112 &'Batched SMTP'& is the name for a process in which batches of messages are
35113 stored in or read from files (or pipes), in a format in which SMTP commands are
35114 used to contain the envelope information.
35115
35116
35117
35118 .section "Outgoing SMTP and LMTP over TCP/IP" "SECToutSMTPTCP"
35119 .cindex "SMTP" "outgoing over TCP/IP"
35120 .cindex "outgoing SMTP over TCP/IP"
35121 .cindex "LMTP" "over TCP/IP"
35122 .cindex "outgoing LMTP over TCP/IP"
35123 .cindex "EHLO"
35124 .cindex "HELO"
35125 .cindex "SIZE option on MAIL command"
35126 Outgoing SMTP and LMTP over TCP/IP is implemented by the &(smtp)& transport.
35127 The &%protocol%& option selects which protocol is to be used, but the actual
35128 processing is the same in both cases.
35129
35130 If, in response to its EHLO command, Exim is told that the SIZE
35131 parameter is supported, it adds SIZE=<&'n'&> to each subsequent MAIL
35132 command. The value of <&'n'&> is the message size plus the value of the
35133 &%size_addition%& option (default 1024) to allow for additions to the message
35134 such as per-transport header lines, or changes made in a
35135 .cindex "transport" "filter"
35136 .cindex "filter" "transport filter"
35137 transport filter. If &%size_addition%& is set negative, the use of SIZE is
35138 suppressed.
35139
35140 If the remote server advertises support for PIPELINING, Exim uses the
35141 pipelining extension to SMTP (RFC 2197) to reduce the number of TCP/IP packets
35142 required for the transaction.
35143
35144 If the remote server advertises support for the STARTTLS command, and Exim
35145 was built to support TLS encryption, it tries to start a TLS session unless the
35146 server matches &%hosts_avoid_tls%&. See chapter &<<CHAPTLS>>& for more details.
35147 Either a match in that or &%hosts_verify_avoid_tls%& apply when the transport
35148 is called for verification.
35149
35150 If the remote server advertises support for the AUTH command, Exim scans
35151 the authenticators configuration for any suitable client settings, as described
35152 in chapter &<<CHAPSMTPAUTH>>&.
35153
35154 .cindex "carriage return"
35155 .cindex "linefeed"
35156 Responses from the remote host are supposed to be terminated by CR followed by
35157 LF. However, there are known to be hosts that do not send CR characters, so in
35158 order to be able to interwork with such hosts, Exim treats LF on its own as a
35159 line terminator.
35160
35161 If a message contains a number of different addresses, all those with the same
35162 characteristics (for example, the same envelope sender) that resolve to the
35163 same set of hosts, in the same order, are sent in a single SMTP transaction,
35164 even if they are for different domains, unless there are more than the setting
35165 of the &%max_rcpt%&s option in the &(smtp)& transport allows, in which case
35166 they are split into groups containing no more than &%max_rcpt%&s addresses
35167 each. If &%remote_max_parallel%& is greater than one, such groups may be sent
35168 in parallel sessions. The order of hosts with identical MX values is not
35169 significant when checking whether addresses can be batched in this way.
35170
35171 When the &(smtp)& transport suffers a temporary failure that is not
35172 message-related, Exim updates its transport-specific database, which contains
35173 records indexed by host name that remember which messages are waiting for each
35174 particular host. It also updates the retry database with new retry times.
35175
35176 .cindex "hints database" "retry keys"
35177 Exim's retry hints are based on host name plus IP address, so if one address of
35178 a multi-homed host is broken, it will soon be skipped most of the time.
35179 See the next section for more detail about error handling.
35180
35181 .cindex "SMTP" "passed connection"
35182 .cindex "SMTP" "batching over TCP/IP"
35183 When a message is successfully delivered over a TCP/IP SMTP connection, Exim
35184 looks in the hints database for the transport to see if there are any queued
35185 messages waiting for the host to which it is connected. If it finds one, it
35186 creates a new Exim process using the &%-MC%& option (which can only be used by
35187 a process running as root or the Exim user) and passes the TCP/IP socket to it
35188 so that it can deliver another message using the same socket. The new process
35189 does only those deliveries that are routed to the connected host, and may in
35190 turn pass the socket on to a third process, and so on.
35191
35192 The &%connection_max_messages%& option of the &(smtp)& transport can be used to
35193 limit the number of messages sent down a single TCP/IP connection.
35194
35195 .cindex "asterisk" "after IP address"
35196 The second and subsequent messages delivered down an existing connection are
35197 identified in the main log by the addition of an asterisk after the closing
35198 square bracket of the IP address.
35199
35200
35201
35202
35203 .section "Errors in outgoing SMTP" "SECToutSMTPerr"
35204 .cindex "error" "in outgoing SMTP"
35205 .cindex "SMTP" "errors in outgoing"
35206 .cindex "host" "error"
35207 Three different kinds of error are recognized for outgoing SMTP: host errors,
35208 message errors, and recipient errors.
35209
35210 .vlist
35211 .vitem "&*Host errors*&"
35212 A host error is not associated with a particular message or with a
35213 particular recipient of a message. The host errors are:
35214
35215 .ilist
35216 Connection refused or timed out,
35217 .next
35218 Any error response code on connection,
35219 .next
35220 Any error response code to EHLO or HELO,
35221 .next
35222 Loss of connection at any time, except after &"."&,
35223 .next
35224 I/O errors at any time,
35225 .next
35226 Timeouts during the session, other than in response to MAIL, RCPT or
35227 the &"."& at the end of the data.
35228 .endlist ilist
35229
35230 For a host error, a permanent error response on connection, or in response to
35231 EHLO, causes all addresses routed to the host to be failed. Any other host
35232 error causes all addresses to be deferred, and retry data to be created for the
35233 host. It is not tried again, for any message, until its retry time arrives. If
35234 the current set of addresses are not all delivered in this run (to some
35235 alternative host), the message is added to the list of those waiting for this
35236 host, so if it is still undelivered when a subsequent successful delivery is
35237 made to the host, it will be sent down the same SMTP connection.
35238
35239 .vitem "&*Message errors*&"
35240 .cindex "message" "error"
35241 A message error is associated with a particular message when sent to a
35242 particular host, but not with a particular recipient of the message. The
35243 message errors are:
35244
35245 .ilist
35246 Any error response code to MAIL, DATA, or the &"."& that terminates
35247 the data,
35248 .next
35249 Timeout after MAIL,
35250 .next
35251 Timeout or loss of connection after the &"."& that terminates the data. A
35252 timeout after the DATA command itself is treated as a host error, as is loss of
35253 connection at any other time.
35254 .endlist ilist
35255
35256 For a message error, a permanent error response (5&'xx'&) causes all addresses
35257 to be failed, and a delivery error report to be returned to the sender. A
35258 temporary error response (4&'xx'&), or one of the timeouts, causes all
35259 addresses to be deferred. Retry data is not created for the host, but instead,
35260 a retry record for the combination of host plus message id is created. The
35261 message is not added to the list of those waiting for this host. This ensures
35262 that the failing message will not be sent to this host again until the retry
35263 time arrives. However, other messages that are routed to the host are not
35264 affected, so if it is some property of the message that is causing the error,
35265 it will not stop the delivery of other mail.
35266
35267 If the remote host specified support for the SIZE parameter in its response
35268 to EHLO, Exim adds SIZE=&'nnn'& to the MAIL command, so an
35269 over-large message will cause a message error because the error arrives as a
35270 response to MAIL.
35271
35272 .vitem "&*Recipient errors*&"
35273 .cindex "recipient" "error"
35274 A recipient error is associated with a particular recipient of a message. The
35275 recipient errors are:
35276
35277 .ilist
35278 Any error response to RCPT,
35279 .next
35280 Timeout after RCPT.
35281 .endlist
35282
35283 For a recipient error, a permanent error response (5&'xx'&) causes the
35284 recipient address to be failed, and a bounce message to be returned to the
35285 sender. A temporary error response (4&'xx'&) or a timeout causes the failing
35286 address to be deferred, and routing retry data to be created for it. This is
35287 used to delay processing of the address in subsequent queue runs, until its
35288 routing retry time arrives. This applies to all messages, but because it
35289 operates only in queue runs, one attempt will be made to deliver a new message
35290 to the failing address before the delay starts to operate. This ensures that,
35291 if the failure is really related to the message rather than the recipient
35292 (&"message too big for this recipient"& is a possible example), other messages
35293 have a chance of getting delivered. If a delivery to the address does succeed,
35294 the retry information gets cleared, so all stuck messages get tried again, and
35295 the retry clock is reset.
35296
35297 The message is not added to the list of those waiting for this host. Use of the
35298 host for other messages is unaffected, and except in the case of a timeout,
35299 other recipients are processed independently, and may be successfully delivered
35300 in the current SMTP session. After a timeout it is of course impossible to
35301 proceed with the session, so all addresses get deferred. However, those other
35302 than the one that failed do not suffer any subsequent retry delays. Therefore,
35303 if one recipient is causing trouble, the others have a chance of getting
35304 through when a subsequent delivery attempt occurs before the failing
35305 recipient's retry time.
35306 .endlist
35307
35308 In all cases, if there are other hosts (or IP addresses) available for the
35309 current set of addresses (for example, from multiple MX records), they are
35310 tried in this run for any undelivered addresses, subject of course to their
35311 own retry data. In other words, recipient error retry data does not take effect
35312 until the next delivery attempt.
35313
35314 Some hosts have been observed to give temporary error responses to every
35315 MAIL command at certain times (&"insufficient space"& has been seen). It
35316 would be nice if such circumstances could be recognized, and defer data for the
35317 host itself created, but this is not possible within the current Exim design.
35318 What actually happens is that retry data for every (host, message) combination
35319 is created.
35320
35321 The reason that timeouts after MAIL and RCPT are treated specially is that
35322 these can sometimes arise as a result of the remote host's verification
35323 procedures. Exim makes this assumption, and treats them as if a temporary error
35324 response had been received. A timeout after &"."& is treated specially because
35325 it is known that some broken implementations fail to recognize the end of the
35326 message if the last character of the last line is a binary zero. Thus, it is
35327 helpful to treat this case as a message error.
35328
35329 Timeouts at other times are treated as host errors, assuming a problem with the
35330 host, or the connection to it. If a timeout after MAIL, RCPT,
35331 or &"."& is really a connection problem, the assumption is that at the next try
35332 the timeout is likely to occur at some other point in the dialogue, causing it
35333 then to be treated as a host error.
35334
35335 There is experimental evidence that some MTAs drop the connection after the
35336 terminating &"."& if they do not like the contents of the message for some
35337 reason, in contravention of the RFC, which indicates that a 5&'xx'& response
35338 should be given. That is why Exim treats this case as a message rather than a
35339 host error, in order not to delay other messages to the same host.
35340
35341
35342
35343
35344 .section "Incoming SMTP messages over TCP/IP" "SECID233"
35345 .cindex "SMTP" "incoming over TCP/IP"
35346 .cindex "incoming SMTP over TCP/IP"
35347 .cindex "inetd"
35348 .cindex "daemon"
35349 Incoming SMTP messages can be accepted in one of two ways: by running a
35350 listening daemon, or by using &'inetd'&. In the latter case, the entry in
35351 &_/etc/inetd.conf_& should be like this:
35352 .code
35353 smtp stream tcp nowait exim /opt/exim/bin/exim in.exim -bs
35354 .endd
35355 Exim distinguishes between this case and the case of a locally running user
35356 agent using the &%-bs%& option by checking whether or not the standard input is
35357 a socket. When it is, either the port must be privileged (less than 1024), or
35358 the caller must be root or the Exim user. If any other user passes a socket
35359 with an unprivileged port number, Exim prints a message on the standard error
35360 stream and exits with an error code.
35361
35362 By default, Exim does not make a log entry when a remote host connects or
35363 disconnects (either via the daemon or &'inetd'&), unless the disconnection is
35364 unexpected. It can be made to write such log entries by setting the
35365 &%smtp_connection%& log selector.
35366
35367 .cindex "carriage return"
35368 .cindex "linefeed"
35369 Commands from the remote host are supposed to be terminated by CR followed by
35370 LF. However, there are known to be hosts that do not send CR characters. In
35371 order to be able to interwork with such hosts, Exim treats LF on its own as a
35372 line terminator.
35373 Furthermore, because common code is used for receiving messages from all
35374 sources, a CR on its own is also interpreted as a line terminator. However, the
35375 sequence &"CR, dot, CR"& does not terminate incoming SMTP data.
35376
35377 .cindex "EHLO" "invalid data"
35378 .cindex "HELO" "invalid data"
35379 One area that sometimes gives rise to problems concerns the EHLO or
35380 HELO commands. Some clients send syntactically invalid versions of these
35381 commands, which Exim rejects by default. (This is nothing to do with verifying
35382 the data that is sent, so &%helo_verify_hosts%& is not relevant.) You can tell
35383 Exim not to apply a syntax check by setting &%helo_accept_junk_hosts%& to
35384 match the broken hosts that send invalid commands.
35385
35386 .cindex "SIZE option on MAIL command"
35387 .cindex "MAIL" "SIZE option"
35388 The amount of disk space available is checked whenever SIZE is received on
35389 a MAIL command, independently of whether &%message_size_limit%& or
35390 &%check_spool_space%& is configured, unless &%smtp_check_spool_space%& is set
35391 false. A temporary error is given if there is not enough space. If
35392 &%check_spool_space%& is set, the check is for that amount of space plus the
35393 value given with SIZE, that is, it checks that the addition of the incoming
35394 message will not reduce the space below the threshold.
35395
35396 When a message is successfully received, Exim includes the local message id in
35397 its response to the final &"."& that terminates the data. If the remote host
35398 logs this text it can help with tracing what has happened to a message.
35399
35400 The Exim daemon can limit the number of simultaneous incoming connections it is
35401 prepared to handle (see the &%smtp_accept_max%& option). It can also limit the
35402 number of simultaneous incoming connections from a single remote host (see the
35403 &%smtp_accept_max_per_host%& option). Additional connection attempts are
35404 rejected using the SMTP temporary error code 421.
35405
35406 The Exim daemon does not rely on the SIGCHLD signal to detect when a
35407 subprocess has finished, as this can get lost at busy times. Instead, it looks
35408 for completed subprocesses every time it wakes up. Provided there are other
35409 things happening (new incoming calls, starts of queue runs), completed
35410 processes will be noticed and tidied away. On very quiet systems you may
35411 sometimes see a &"defunct"& Exim process hanging about. This is not a problem;
35412 it will be noticed when the daemon next wakes up.
35413
35414 When running as a daemon, Exim can reserve some SMTP slots for specific hosts,
35415 and can also be set up to reject SMTP calls from non-reserved hosts at times of
35416 high system load &-- for details see the &%smtp_accept_reserve%&,
35417 &%smtp_load_reserve%&, and &%smtp_reserve_hosts%& options. The load check
35418 applies in both the daemon and &'inetd'& cases.
35419
35420 Exim normally starts a delivery process for each message received, though this
35421 can be varied by means of the &%-odq%& command line option and the
35422 &%queue_only%&, &%queue_only_file%&, and &%queue_only_load%& options. The
35423 number of simultaneously running delivery processes started in this way from
35424 SMTP input can be limited by the &%smtp_accept_queue%& and
35425 &%smtp_accept_queue_per_connection%& options. When either limit is reached,
35426 subsequently received messages are just put on the input queue without starting
35427 a delivery process.
35428
35429 The controls that involve counts of incoming SMTP calls (&%smtp_accept_max%&,
35430 &%smtp_accept_queue%&, &%smtp_accept_reserve%&) are not available when Exim is
35431 started up from the &'inetd'& daemon, because in that case each connection is
35432 handled by an entirely independent Exim process. Control by load average is,
35433 however, available with &'inetd'&.
35434
35435 Exim can be configured to verify addresses in incoming SMTP commands as they
35436 are received. See chapter &<<CHAPACL>>& for details. It can also be configured
35437 to rewrite addresses at this time &-- before any syntax checking is done. See
35438 section &<<SECTrewriteS>>&.
35439
35440 Exim can also be configured to limit the rate at which a client host submits
35441 MAIL and RCPT commands in a single SMTP session. See the
35442 &%smtp_ratelimit_hosts%& option.
35443
35444
35445
35446 .section "Unrecognized SMTP commands" "SECID234"
35447 .cindex "SMTP" "unrecognized commands"
35448 If Exim receives more than &%smtp_max_unknown_commands%& unrecognized SMTP
35449 commands during a single SMTP connection, it drops the connection after sending
35450 the error response to the last command. The default value for
35451 &%smtp_max_unknown_commands%& is 3. This is a defence against some kinds of
35452 abuse that subvert web servers into making connections to SMTP ports; in these
35453 circumstances, a number of non-SMTP lines are sent first.
35454
35455
35456 .section "Syntax and protocol errors in SMTP commands" "SECID235"
35457 .cindex "SMTP" "syntax errors"
35458 .cindex "SMTP" "protocol errors"
35459 A syntax error is detected if an SMTP command is recognized, but there is
35460 something syntactically wrong with its data, for example, a malformed email
35461 address in a RCPT command. Protocol errors include invalid command
35462 sequencing such as RCPT before MAIL. If Exim receives more than
35463 &%smtp_max_synprot_errors%& such commands during a single SMTP connection, it
35464 drops the connection after sending the error response to the last command. The
35465 default value for &%smtp_max_synprot_errors%& is 3. This is a defence against
35466 broken clients that loop sending bad commands (yes, it has been seen).
35467
35468
35469
35470 .section "Use of non-mail SMTP commands" "SECID236"
35471 .cindex "SMTP" "non-mail commands"
35472 The &"non-mail"& SMTP commands are those other than MAIL, RCPT, and
35473 DATA. Exim counts such commands, and drops the connection if there are too
35474 many of them in a single SMTP session. This action catches some
35475 denial-of-service attempts and things like repeated failing AUTHs, or a mad
35476 client looping sending EHLO. The global option &%smtp_accept_max_nonmail%&
35477 defines what &"too many"& means. Its default value is 10.
35478
35479 When a new message is expected, one occurrence of RSET is not counted. This
35480 allows a client to send one RSET between messages (this is not necessary,
35481 but some clients do it). Exim also allows one uncounted occurrence of HELO
35482 or EHLO, and one occurrence of STARTTLS between messages. After
35483 starting up a TLS session, another EHLO is expected, and so it too is not
35484 counted.
35485
35486 The first occurrence of AUTH in a connection, or immediately following
35487 STARTTLS is also not counted. Otherwise, all commands other than MAIL,
35488 RCPT, DATA, and QUIT are counted.
35489
35490 You can control which hosts are subject to the limit set by
35491 &%smtp_accept_max_nonmail%& by setting
35492 &%smtp_accept_max_nonmail_hosts%&. The default value is &`*`&, which makes
35493 the limit apply to all hosts. This option means that you can exclude any
35494 specific badly-behaved hosts that you have to live with.
35495
35496
35497
35498
35499 .section "The VRFY and EXPN commands" "SECID237"
35500 When Exim receives a VRFY or EXPN command on a TCP/IP connection, it
35501 runs the ACL specified by &%acl_smtp_vrfy%& or &%acl_smtp_expn%& (as
35502 appropriate) in order to decide whether the command should be accepted or not.
35503
35504 .cindex "VRFY" "processing"
35505 When no ACL is defined for VRFY, or if it rejects without
35506 setting an explicit response code, the command is accepted
35507 (with a 252 SMTP response code)
35508 in order to support awkward clients that do a VRFY before every RCPT.
35509 When VRFY is accepted, it runs exactly the same code as when Exim is
35510 called with the &%-bv%& option, and returns 250/451/550
35511 SMTP response codes.
35512
35513 .cindex "EXPN" "processing"
35514 If no ACL for EXPN is defined, the command is rejected.
35515 When EXPN is accepted, a single-level expansion of the address is done.
35516 EXPN is treated as an &"address test"& (similar to the &%-bt%& option) rather
35517 than a verification (the &%-bv%& option). If an unqualified local part is given
35518 as the argument to EXPN, it is qualified with &%qualify_domain%&. Rejections
35519 of VRFY and EXPN commands are logged on the main and reject logs, and
35520 VRFY verification failures are logged on the main log for consistency with
35521 RCPT failures.
35522
35523
35524
35525 .section "The ETRN command" "SECTETRN"
35526 .cindex "ETRN" "processing"
35527 RFC 1985 describes an SMTP command called ETRN that is designed to
35528 overcome the security problems of the TURN command (which has fallen into
35529 disuse). When Exim receives an ETRN command on a TCP/IP connection, it runs
35530 the ACL specified by &%acl_smtp_etrn%& in order to decide whether the command
35531 should be accepted or not. If no ACL is defined, the command is rejected.
35532
35533 The ETRN command is concerned with &"releasing"& messages that are awaiting
35534 delivery to certain hosts. As Exim does not organize its message queue by host,
35535 the only form of ETRN that is supported by default is the one where the
35536 text starts with the &"#"& prefix, in which case the remainder of the text is
35537 specific to the SMTP server. A valid ETRN command causes a run of Exim with
35538 the &%-R%& option to happen, with the remainder of the ETRN text as its
35539 argument. For example,
35540 .code
35541 ETRN #brigadoon
35542 .endd
35543 runs the command
35544 .code
35545 exim -R brigadoon
35546 .endd
35547 which causes a delivery attempt on all messages with undelivered addresses
35548 containing the text &"brigadoon"&. When &%smtp_etrn_serialize%& is set (the
35549 default), Exim prevents the simultaneous execution of more than one queue run
35550 for the same argument string as a result of an ETRN command. This stops
35551 a misbehaving client from starting more than one queue runner at once.
35552
35553 .cindex "hints database" "ETRN serialization"
35554 Exim implements the serialization by means of a hints database in which a
35555 record is written whenever a process is started by ETRN, and deleted when
35556 the process completes. However, Exim does not keep the SMTP session waiting for
35557 the ETRN process to complete. Once ETRN is accepted, the client is sent
35558 a &"success"& return code. Obviously there is scope for hints records to get
35559 left lying around if there is a system or program crash. To guard against this,
35560 Exim ignores any records that are more than six hours old.
35561
35562 .oindex "&%smtp_etrn_command%&"
35563 For more control over what ETRN does, the &%smtp_etrn_command%& option can
35564 used. This specifies a command that is run whenever ETRN is received,
35565 whatever the form of its argument. For
35566 example:
35567 .code
35568 smtp_etrn_command = /etc/etrn_command $domain \
35569                     $sender_host_address
35570 .endd
35571 .vindex "&$domain$&"
35572 The string is split up into arguments which are independently expanded. The
35573 expansion variable &$domain$& is set to the argument of the ETRN command,
35574 and no syntax checking is done on the contents of this argument. Exim does not
35575 wait for the command to complete, so its status code is not checked. Exim runs
35576 under its own uid and gid when receiving incoming SMTP, so it is not possible
35577 for it to change them before running the command.
35578
35579
35580
35581 .section "Incoming local SMTP" "SECID238"
35582 .cindex "SMTP" "local incoming"
35583 Some user agents use SMTP to pass messages to their local MTA using the
35584 standard input and output, as opposed to passing the envelope on the command
35585 line and writing the message to the standard input. This is supported by the
35586 &%-bs%& option. This form of SMTP is handled in the same way as incoming
35587 messages over TCP/IP (including the use of ACLs), except that the envelope
35588 sender given in a MAIL command is ignored unless the caller is trusted. In
35589 an ACL you can detect this form of SMTP input by testing for an empty host
35590 identification. It is common to have this as the first line in the ACL that
35591 runs for RCPT commands:
35592 .code
35593 accept hosts = :
35594 .endd
35595 This accepts SMTP messages from local processes without doing any other tests.
35596
35597
35598
35599 .section "Outgoing batched SMTP" "SECTbatchSMTP"
35600 .cindex "SMTP" "batched outgoing"
35601 .cindex "batched SMTP output"
35602 Both the &(appendfile)& and &(pipe)& transports can be used for handling
35603 batched SMTP. Each has an option called &%use_bsmtp%& which causes messages to
35604 be output in BSMTP format. No SMTP responses are possible for this form of
35605 delivery. All it is doing is using SMTP commands as a way of transmitting the
35606 envelope along with the message.
35607
35608 The message is written to the file or pipe preceded by the SMTP commands
35609 MAIL and RCPT, and followed by a line containing a single dot. Lines in
35610 the message that start with a dot have an extra dot added. The SMTP command
35611 HELO is not normally used. If it is required, the &%message_prefix%& option
35612 can be used to specify it.
35613
35614 Because &(appendfile)& and &(pipe)& are both local transports, they accept only
35615 one recipient address at a time by default. However, you can arrange for them
35616 to handle several addresses at once by setting the &%batch_max%& option. When
35617 this is done for BSMTP, messages may contain multiple RCPT commands. See
35618 chapter &<<CHAPbatching>>& for more details.
35619
35620 .vindex "&$host$&"
35621 When one or more addresses are routed to a BSMTP transport by a router that
35622 sets up a host list, the name of the first host on the list is available to the
35623 transport in the variable &$host$&. Here is an example of such a transport and
35624 router:
35625 .code
35626 begin routers
35627 route_append:
35628   driver = manualroute
35629   transport = smtp_appendfile
35630   route_list = domain.example  batch.host.example
35631
35632 begin transports
35633 smtp_appendfile:
35634   driver = appendfile
35635   directory = /var/bsmtp/$host
35636   batch_max = 1000
35637   use_bsmtp
35638   user = exim
35639 .endd
35640 This causes messages addressed to &'domain.example'& to be written in BSMTP
35641 format to &_/var/bsmtp/batch.host.example_&, with only a single copy of each
35642 message (unless there are more than 1000 recipients).
35643
35644
35645
35646 .section "Incoming batched SMTP" "SECTincomingbatchedSMTP"
35647 .cindex "SMTP" "batched incoming"
35648 .cindex "batched SMTP input"
35649 The &%-bS%& command line option causes Exim to accept one or more messages by
35650 reading SMTP on the standard input, but to generate no responses. If the caller
35651 is trusted, the senders in the MAIL commands are believed; otherwise the
35652 sender is always the caller of Exim. Unqualified senders and receivers are not
35653 rejected (there seems little point) but instead just get qualified. HELO
35654 and EHLO act as RSET; VRFY, EXPN, ETRN and  HELP, act
35655 as NOOP; QUIT quits.
35656
35657 Minimal policy checking is done for BSMTP input. Only the non-SMTP
35658 ACL is run in the same way as for non-SMTP local input.
35659
35660 If an error is detected while reading a message, including a missing &"."& at
35661 the end, Exim gives up immediately. It writes details of the error to the
35662 standard output in a stylized way that the calling program should be able to
35663 make some use of automatically, for example:
35664 .code
35665 554 Unexpected end of file
35666 Transaction started in line 10
35667 Error detected in line 14
35668 .endd
35669 It writes a more verbose version, for human consumption, to the standard error
35670 file, for example:
35671 .code
35672 An error was detected while processing a file of BSMTP input.
35673 The error message was:
35674
35675 501 '>' missing at end of address
35676
35677 The SMTP transaction started in line 10.
35678 The error was detected in line 12.
35679 The SMTP command at fault was:
35680
35681 rcpt to:<malformed@in.com.plete
35682
35683 1 previous message was successfully processed.
35684 The rest of the batch was abandoned.
35685 .endd
35686 The return code from Exim is zero only if there were no errors. It is 1 if some
35687 messages were accepted before an error was detected, and 2 if no messages were
35688 accepted.
35689 .ecindex IIDsmtpproc1
35690 .ecindex IIDsmtpproc2
35691
35692
35693
35694 . ////////////////////////////////////////////////////////////////////////////
35695 . ////////////////////////////////////////////////////////////////////////////
35696
35697 .chapter "Customizing bounce and warning messages" "CHAPemsgcust" &&&
35698          "Customizing messages"
35699 When a message fails to be delivered, or remains in the queue for more than a
35700 configured amount of time, Exim sends a message to the original sender, or
35701 to an alternative configured address. The text of these messages is built into
35702 the code of Exim, but it is possible to change it, either by adding a single
35703 string, or by replacing each of the paragraphs by text supplied in a file.
35704
35705 The &'From:'& and &'To:'& header lines are automatically generated; you can
35706 cause a &'Reply-To:'& line to be added by setting the &%errors_reply_to%&
35707 option. Exim also adds the line
35708 .code
35709 Auto-Submitted: auto-generated
35710 .endd
35711 to all warning and bounce messages,
35712
35713
35714 .section "Customizing bounce messages" "SECID239"
35715 .cindex "customizing" "bounce message"
35716 .cindex "bounce message" "customizing"
35717 If &%bounce_message_text%& is set, its contents are included in the default
35718 message immediately after &"This message was created automatically by mail
35719 delivery software."& The string is not expanded. It is not used if
35720 &%bounce_message_file%& is set.
35721
35722 When &%bounce_message_file%& is set, it must point to a template file for
35723 constructing error messages. The file consists of a series of text items,
35724 separated by lines consisting of exactly four asterisks. If the file cannot be
35725 opened, default text is used and a message is written to the main and panic
35726 logs. If any text item in the file is empty, default text is used for that
35727 item.
35728
35729 .vindex "&$bounce_recipient$&"
35730 .vindex "&$bounce_return_size_limit$&"
35731 Each item of text that is read from the file is expanded, and there are two
35732 expansion variables which can be of use here: &$bounce_recipient$& is set to
35733 the recipient of an error message while it is being created, and
35734 &$bounce_return_size_limit$& contains the value of the &%return_size_limit%&
35735 option, rounded to a whole number.
35736
35737 The items must appear in the file in the following order:
35738
35739 .ilist
35740 The first item is included in the headers, and should include at least a
35741 &'Subject:'& header. Exim does not check the syntax of these headers.
35742 .next
35743 The second item forms the start of the error message. After it, Exim lists the
35744 failing addresses with their error messages.
35745 .next
35746 The third item is used to introduce any text from pipe transports that is to be
35747 returned to the sender. It is omitted if there is no such text.
35748 .next
35749 The fourth, fifth and sixth items will be ignored and may be empty.
35750 The fields exist for back-compatibility
35751 .endlist
35752
35753 The default state (&%bounce_message_file%& unset) is equivalent to the
35754 following file, in which the sixth item is empty. The &'Subject:'& and some
35755 other lines have been split in order to fit them on the page:
35756 .code
35757 Subject: Mail delivery failed
35758   ${if eq{$sender_address}{$bounce_recipient}
35759   {: returning message to sender}}
35760 ****
35761 This message was created automatically by mail delivery software.
35762
35763 A message ${if eq{$sender_address}{$bounce_recipient}
35764   {that you sent }{sent by
35765
35766 <$sender_address>
35767
35768 }}could not be delivered to all of its recipients.
35769 This is a permanent error. The following address(es) failed:
35770 ****
35771 The following text was generated during the delivery attempt(s):
35772 ****
35773 ------ This is a copy of the message, including all the headers.
35774   ------
35775 ****
35776 ------ The body of the message is $message_size characters long;
35777   only the first
35778 ------ $bounce_return_size_limit or so are included here.
35779 ****
35780 .endd
35781 .section "Customizing warning messages" "SECTcustwarn"
35782 .cindex "customizing" "warning message"
35783 .cindex "warning of delay" "customizing the message"
35784 The option &%warn_message_file%& can be pointed at a template file for use when
35785 warnings about message delays are created. In this case there are only three
35786 text sections:
35787
35788 .ilist
35789 The first item is included in the headers, and should include at least a
35790 &'Subject:'& header. Exim does not check the syntax of these headers.
35791 .next
35792 The second item forms the start of the warning message. After it, Exim lists
35793 the delayed addresses.
35794 .next
35795 The third item then ends the message.
35796 .endlist
35797
35798 The default state is equivalent to the following file, except that some lines
35799 have been split here, in order to fit them on the page:
35800 .code
35801 Subject: Warning: message $message_exim_id delayed
35802   $warn_message_delay
35803 ****
35804 This message was created automatically by mail delivery software.
35805
35806 A message ${if eq{$sender_address}{$warn_message_recipients}
35807 {that you sent }{sent by
35808
35809 <$sender_address>
35810
35811 }}has not been delivered to all of its recipients after
35812 more than $warn_message_delay in the queue on $primary_hostname.
35813
35814 The message identifier is:     $message_exim_id
35815 The subject of the message is: $h_subject
35816 The date of the message is:    $h_date
35817
35818 The following address(es) have not yet been delivered:
35819 ****
35820 No action is required on your part. Delivery attempts will
35821 continue for some time, and this warning may be repeated at
35822 intervals if the message remains undelivered. Eventually the
35823 mail delivery software will give up, and when that happens,
35824 the message will be returned to you.
35825 .endd
35826 .vindex "&$warn_message_delay$&"
35827 .vindex "&$warn_message_recipients$&"
35828 However, in the default state the subject and date lines are omitted if no
35829 appropriate headers exist. During the expansion of this file,
35830 &$warn_message_delay$& is set to the delay time in one of the forms &"<&'n'&>
35831 minutes"& or &"<&'n'&> hours"&, and &$warn_message_recipients$& contains a list
35832 of recipients for the warning message. There may be more than one if there are
35833 multiple addresses with different &%errors_to%& settings on the routers that
35834 handled them.
35835
35836
35837
35838
35839 . ////////////////////////////////////////////////////////////////////////////
35840 . ////////////////////////////////////////////////////////////////////////////
35841
35842 .chapter "Some common configuration settings" "CHAPcomconreq"
35843 This chapter discusses some configuration settings that seem to be fairly
35844 common. More examples and discussion can be found in the Exim book.
35845
35846
35847
35848 .section "Sending mail to a smart host" "SECID240"
35849 .cindex "smart host" "example router"
35850 If you want to send all mail for non-local domains to a &"smart host"&, you
35851 should replace the default &(dnslookup)& router with a router which does the
35852 routing explicitly:
35853 .code
35854 send_to_smart_host:
35855   driver = manualroute
35856   route_list = !+local_domains smart.host.name
35857   transport = remote_smtp
35858 .endd
35859 You can use the smart host's IP address instead of the name if you wish.
35860 If you are using Exim only to submit messages to a smart host, and not for
35861 receiving incoming messages, you can arrange for it to do the submission
35862 synchronously by setting the &%mua_wrapper%& option (see chapter
35863 &<<CHAPnonqueueing>>&).
35864
35865
35866
35867
35868 .section "Using Exim to handle mailing lists" "SECTmailinglists"
35869 .cindex "mailing lists"
35870 Exim can be used to run simple mailing lists, but for large and/or complicated
35871 requirements, the use of additional specialized mailing list software such as
35872 Majordomo or Mailman is recommended.
35873
35874 The &(redirect)& router can be used to handle mailing lists where each list
35875 is maintained in a separate file, which can therefore be managed by an
35876 independent manager. The &%domains%& router option can be used to run these
35877 lists in a separate domain from normal mail. For example:
35878 .code
35879 lists:
35880   driver = redirect
35881   domains = lists.example
35882   file = /usr/lists/$local_part
35883   forbid_pipe
35884   forbid_file
35885   errors_to = $local_part-request@lists.example
35886   no_more
35887 .endd
35888 This router is skipped for domains other than &'lists.example'&. For addresses
35889 in that domain, it looks for a file that matches the local part. If there is no
35890 such file, the router declines, but because &%no_more%& is set, no subsequent
35891 routers are tried, and so the whole delivery fails.
35892
35893 The &%forbid_pipe%& and &%forbid_file%& options prevent a local part from being
35894 expanded into a filename or a pipe delivery, which is usually inappropriate in
35895 a mailing list.
35896
35897 .oindex "&%errors_to%&"
35898 The &%errors_to%& option specifies that any delivery errors caused by addresses
35899 taken from a mailing list are to be sent to the given address rather than the
35900 original sender of the message. However, before acting on this, Exim verifies
35901 the error address, and ignores it if verification fails.
35902
35903 For example, using the configuration above, mail sent to
35904 &'dicts@lists.example'& is passed on to those addresses contained in
35905 &_/usr/lists/dicts_&, with error reports directed to
35906 &'dicts-request@lists.example'&, provided that this address can be verified.
35907 There could be a file called &_/usr/lists/dicts-request_& containing
35908 the address(es) of this particular list's manager(s), but other approaches,
35909 such as setting up an earlier router (possibly using the &%local_part_prefix%&
35910 or &%local_part_suffix%& options) to handle addresses of the form
35911 &%owner-%&&'xxx'& or &%xxx-%&&'request'&, are also possible.
35912
35913
35914
35915 .section "Syntax errors in mailing lists" "SECID241"
35916 .cindex "mailing lists" "syntax errors in"
35917 If an entry in redirection data contains a syntax error, Exim normally defers
35918 delivery of the original address. That means that a syntax error in a mailing
35919 list holds up all deliveries to the list. This may not be appropriate when a
35920 list is being maintained automatically from data supplied by users, and the
35921 addresses are not rigorously checked.
35922
35923 If the &%skip_syntax_errors%& option is set, the &(redirect)& router just skips
35924 entries that fail to parse, noting the incident in the log. If in addition
35925 &%syntax_errors_to%& is set to a verifiable address, a message is sent to it
35926 whenever a broken address is skipped. It is usually appropriate to set
35927 &%syntax_errors_to%& to the same address as &%errors_to%&.
35928
35929
35930
35931 .section "Re-expansion of mailing lists" "SECID242"
35932 .cindex "mailing lists" "re-expansion of"
35933 Exim remembers every individual address to which a message has been delivered,
35934 in order to avoid duplication, but it normally stores only the original
35935 recipient addresses with a message. If all the deliveries to a mailing list
35936 cannot be done at the first attempt, the mailing list is re-expanded when the
35937 delivery is next tried. This means that alterations to the list are taken into
35938 account at each delivery attempt, so addresses that have been added to
35939 the list since the message arrived will therefore receive a copy of the
35940 message, even though it pre-dates their subscription.
35941
35942 If this behaviour is felt to be undesirable, the &%one_time%& option can be set
35943 on the &(redirect)& router. If this is done, any addresses generated by the
35944 router that fail to deliver at the first attempt are added to the message as
35945 &"top level"& addresses, and the parent address that generated them is marked
35946 &"delivered"&. Thus, expansion of the mailing list does not happen again at the
35947 subsequent delivery attempts. The disadvantage of this is that if any of the
35948 failing addresses are incorrect, correcting them in the file has no effect on
35949 pre-existing messages.
35950
35951 The original top-level address is remembered with each of the generated
35952 addresses, and is output in any log messages. However, any intermediate parent
35953 addresses are not recorded. This makes a difference to the log only if the
35954 &%all_parents%& selector is set, but for mailing lists there is normally only
35955 one level of expansion anyway.
35956
35957
35958
35959 .section "Closed mailing lists" "SECID243"
35960 .cindex "mailing lists" "closed"
35961 The examples so far have assumed open mailing lists, to which anybody may
35962 send mail. It is also possible to set up closed lists, where mail is accepted
35963 from specified senders only. This is done by making use of the generic
35964 &%senders%& option to restrict the router that handles the list.
35965
35966 The following example uses the same file as a list of recipients and as a list
35967 of permitted senders. It requires three routers:
35968 .code
35969 lists_request:
35970   driver = redirect
35971   domains = lists.example
35972   local_part_suffix = -request
35973   file = /usr/lists/$local_part$local_part_suffix
35974   no_more
35975
35976 lists_post:
35977   driver = redirect
35978   domains = lists.example
35979   senders = ${if exists {/usr/lists/$local_part}\
35980              {lsearch;/usr/lists/$local_part}{*}}
35981   file = /usr/lists/$local_part
35982   forbid_pipe
35983   forbid_file
35984   errors_to = $local_part-request@lists.example
35985   no_more
35986
35987 lists_closed:
35988   driver = redirect
35989   domains = lists.example
35990   allow_fail
35991   data = :fail: $local_part@lists.example is a closed mailing list
35992 .endd
35993 All three routers have the same &%domains%& setting, so for any other domains,
35994 they are all skipped. The first router runs only if the local part ends in
35995 &%-request%&. It handles messages to the list manager(s) by means of an open
35996 mailing list.
35997
35998 The second router runs only if the &%senders%& precondition is satisfied. It
35999 checks for the existence of a list that corresponds to the local part, and then
36000 checks that the sender is on the list by means of a linear search. It is
36001 necessary to check for the existence of the file before trying to search it,
36002 because otherwise Exim thinks there is a configuration error. If the file does
36003 not exist, the expansion of &%senders%& is *, which matches all senders. This
36004 means that the router runs, but because there is no list, declines, and
36005 &%no_more%& ensures that no further routers are run. The address fails with an
36006 &"unrouteable address"& error.
36007
36008 The third router runs only if the second router is skipped, which happens when
36009 a mailing list exists, but the sender is not on it. This router forcibly fails
36010 the address, giving a suitable error message.
36011
36012
36013
36014
36015 .section "Variable Envelope Return Paths (VERP)" "SECTverp"
36016 .cindex "VERP"
36017 .cindex "Variable Envelope Return Paths"
36018 .cindex "envelope sender"
36019 Variable Envelope Return Paths &-- see &url(https://cr.yp.to/proto/verp.txt) &--
36020 are a way of helping mailing list administrators discover which subscription
36021 address is the cause of a particular delivery failure. The idea is to encode
36022 the original recipient address in the outgoing envelope sender address, so that
36023 if the message is forwarded by another host and then subsequently bounces, the
36024 original recipient can be extracted from the recipient address of the bounce.
36025
36026 .oindex &%errors_to%&
36027 .oindex &%return_path%&
36028 Envelope sender addresses can be modified by Exim using two different
36029 facilities: the &%errors_to%& option on a router (as shown in previous mailing
36030 list examples), or the &%return_path%& option on a transport. The second of
36031 these is effective only if the message is successfully delivered to another
36032 host; it is not used for errors detected on the local host (see the description
36033 of &%return_path%& in chapter &<<CHAPtransportgeneric>>&). Here is an example
36034 of the use of &%return_path%& to implement VERP on an &(smtp)& transport:
36035 .code
36036 verp_smtp:
36037   driver = smtp
36038   max_rcpt = 1
36039   return_path = \
36040     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36041       {$1-request+$local_part=$domain@your.dom.example}fail}
36042 .endd
36043 This has the effect of rewriting the return path (envelope sender) on outgoing
36044 SMTP messages, if the local part of the original return path ends in
36045 &"-request"&, and the domain is &'your.dom.example'&. The rewriting inserts the
36046 local part and domain of the recipient into the return path. Suppose, for
36047 example, that a message whose return path has been set to
36048 &'somelist-request@your.dom.example'& is sent to
36049 &'subscriber@other.dom.example'&. In the transport, the return path is
36050 rewritten as
36051 .code
36052 somelist-request+subscriber=other.dom.example@your.dom.example
36053 .endd
36054 .vindex "&$local_part$&"
36055 For this to work, you must tell Exim to send multiple copies of messages that
36056 have more than one recipient, so that each copy has just one recipient. This is
36057 achieved by setting &%max_rcpt%& to 1. Without this, a single copy of a message
36058 might be sent to several different recipients in the same domain, in which case
36059 &$local_part$& is not available in the transport, because it is not unique.
36060
36061 Unless your host is doing nothing but mailing list deliveries, you should
36062 probably use a separate transport for the VERP deliveries, so as not to use
36063 extra resources in making one-per-recipient copies for other deliveries. This
36064 can easily be done by expanding the &%transport%& option in the router:
36065 .code
36066 dnslookup:
36067   driver = dnslookup
36068   domains = ! +local_domains
36069   transport = \
36070     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}\
36071       {verp_smtp}{remote_smtp}}
36072   no_more
36073 .endd
36074 If you want to change the return path using &%errors_to%& in a router instead
36075 of using &%return_path%& in the transport, you need to set &%errors_to%& on all
36076 routers that handle mailing list addresses. This will ensure that all delivery
36077 errors, including those detected on the local host, are sent to the VERP
36078 address.
36079
36080 On a host that does no local deliveries and has no manual routing, only the
36081 &(dnslookup)& router needs to be changed. A special transport is not needed for
36082 SMTP deliveries. Every mailing list recipient has its own return path value,
36083 and so Exim must hand them to the transport one at a time. Here is an example
36084 of a &(dnslookup)& router that implements VERP:
36085 .code
36086 verp_dnslookup:
36087   driver = dnslookup
36088   domains = ! +local_domains
36089   transport = remote_smtp
36090   errors_to = \
36091     ${if match {$return_path}{^(.+?)-request@your.dom.example\$}}
36092      {$1-request+$local_part=$domain@your.dom.example}fail}
36093   no_more
36094 .endd
36095 Before you start sending out messages with VERPed return paths, you must also
36096 configure Exim to accept the bounce messages that come back to those paths.
36097 Typically this is done by setting a &%local_part_suffix%& option for a
36098 router, and using this to route the messages to wherever you want to handle
36099 them.
36100
36101 The overhead incurred in using VERP depends very much on the size of the
36102 message, the number of recipient addresses that resolve to the same remote
36103 host, and the speed of the connection over which the message is being sent. If
36104 a lot of addresses resolve to the same host and the connection is slow, sending
36105 a separate copy of the message for each address may take substantially longer
36106 than sending a single copy with many recipients (for which VERP cannot be
36107 used).
36108
36109
36110
36111
36112
36113
36114 .section "Virtual domains" "SECTvirtualdomains"
36115 .cindex "virtual domains"
36116 .cindex "domain" "virtual"
36117 The phrase &'virtual domain'& is unfortunately used with two rather different
36118 meanings:
36119
36120 .ilist
36121 A domain for which there are no real mailboxes; all valid local parts are
36122 aliases for other email addresses. Common examples are organizational
36123 top-level domains and &"vanity"& domains.
36124 .next
36125 One of a number of independent domains that are all handled by the same host,
36126 with mailboxes on that host, but where the mailbox owners do not necessarily
36127 have login accounts on that host.
36128 .endlist
36129
36130 The first usage is probably more common, and does seem more &"virtual"& than
36131 the second. This kind of domain can be handled in Exim with a straightforward
36132 aliasing router. One approach is to create a separate alias file for each
36133 virtual domain. Exim can test for the existence of the alias file to determine
36134 whether the domain exists. The &(dsearch)& lookup type is useful here, leading
36135 to a router of this form:
36136 .code
36137 virtual:
36138   driver = redirect
36139   domains = dsearch;/etc/mail/virtual
36140   data = ${lookup{$local_part}lsearch{/etc/mail/virtual/$domain}}
36141   no_more
36142 .endd
36143 The &%domains%& option specifies that the router is to be skipped, unless there
36144 is a file in the &_/etc/mail/virtual_& directory whose name is the same as the
36145 domain that is being processed. When the router runs, it looks up the local
36146 part in the file to find a new address (or list of addresses). The &%no_more%&
36147 setting ensures that if the lookup fails (leading to &%data%& being an empty
36148 string), Exim gives up on the address without trying any subsequent routers.
36149
36150 This one router can handle all the virtual domains because the alias filenames
36151 follow a fixed pattern. Permissions can be arranged so that appropriate people
36152 can edit the different alias files. A successful aliasing operation results in
36153 a new envelope recipient address, which is then routed from scratch.
36154
36155 The other kind of &"virtual"& domain can also be handled in a straightforward
36156 way. One approach is to create a file for each domain containing a list of
36157 valid local parts, and use it in a router like this:
36158 .code
36159 my_domains:
36160   driver = accept
36161   domains = dsearch;/etc/mail/domains
36162   local_parts = lsearch;/etc/mail/domains/$domain
36163   transport = my_mailboxes
36164 .endd
36165 The address is accepted if there is a file for the domain, and the local part
36166 can be found in the file. The &%domains%& option is used to check for the
36167 file's existence because &%domains%& is tested before the &%local_parts%&
36168 option (see section &<<SECTrouprecon>>&). You cannot use &%require_files%&,
36169 because that option is tested after &%local_parts%&. The transport is as
36170 follows:
36171 .code
36172 my_mailboxes:
36173   driver = appendfile
36174   file = /var/mail/$domain/$local_part
36175   user = mail
36176 .endd
36177 This uses a directory of mailboxes for each domain. The &%user%& setting is
36178 required, to specify which uid is to be used for writing to the mailboxes.
36179
36180 The configuration shown here is just one example of how you might support this
36181 requirement. There are many other ways this kind of configuration can be set
36182 up, for example, by using a database instead of separate files to hold all the
36183 information about the domains.
36184
36185
36186
36187 .section "Multiple user mailboxes" "SECTmulbox"
36188 .cindex "multiple mailboxes"
36189 .cindex "mailbox" "multiple"
36190 .cindex "local part" "prefix"
36191 .cindex "local part" "suffix"
36192 Heavy email users often want to operate with multiple mailboxes, into which
36193 incoming mail is automatically sorted. A popular way of handling this is to
36194 allow users to use multiple sender addresses, so that replies can easily be
36195 identified. Users are permitted to add prefixes or suffixes to their local
36196 parts for this purpose. The wildcard facility of the generic router options
36197 &%local_part_prefix%& and &%local_part_suffix%& can be used for this. For
36198 example, consider this router:
36199 .code
36200 userforward:
36201   driver = redirect
36202   check_local_user
36203   file = $home/.forward
36204   local_part_suffix = -*
36205   local_part_suffix_optional
36206   allow_filter
36207 .endd
36208 .vindex "&$local_part_suffix$&"
36209 It runs a user's &_.forward_& file for all local parts of the form
36210 &'username-*'&. Within the filter file the user can distinguish different
36211 cases by testing the variable &$local_part_suffix$&. For example:
36212 .code
36213 if $local_part_suffix contains -special then
36214 save /home/$local_part/Mail/special
36215 endif
36216 .endd
36217 If the filter file does not exist, or does not deal with such addresses, they
36218 fall through to subsequent routers, and, assuming no subsequent use of the
36219 &%local_part_suffix%& option is made, they presumably fail. Thus, users have
36220 control over which suffixes are valid.
36221
36222 Alternatively, a suffix can be used to trigger the use of a different
36223 &_.forward_& file &-- which is the way a similar facility is implemented in
36224 another MTA:
36225 .code
36226 userforward:
36227   driver = redirect
36228   check_local_user
36229   file = $home/.forward$local_part_suffix
36230   local_part_suffix = -*
36231   local_part_suffix_optional
36232   allow_filter
36233 .endd
36234 If there is no suffix, &_.forward_& is used; if the suffix is &'-special'&, for
36235 example, &_.forward-special_& is used. Once again, if the appropriate file
36236 does not exist, or does not deal with the address, it is passed on to
36237 subsequent routers, which could, if required, look for an unqualified
36238 &_.forward_& file to use as a default.
36239
36240
36241
36242 .section "Simplified vacation processing" "SECID244"
36243 .cindex "vacation processing"
36244 The traditional way of running the &'vacation'& program is for a user to set up
36245 a pipe command in a &_.forward_& file
36246 (see section &<<SECTspecitredli>>& for syntax details).
36247 This is prone to error by inexperienced users. There are two features of Exim
36248 that can be used to make this process simpler for users:
36249
36250 .ilist
36251 A local part prefix such as &"vacation-"& can be specified on a router which
36252 can cause the message to be delivered directly to the &'vacation'& program, or
36253 alternatively can use Exim's &(autoreply)& transport. The contents of a user's
36254 &_.forward_& file are then much simpler. For example:
36255 .code
36256 spqr, vacation-spqr
36257 .endd
36258 .next
36259 The &%require_files%& generic router option can be used to trigger a
36260 vacation delivery by checking for the existence of a certain file in the
36261 user's home directory. The &%unseen%& generic option should also be used, to
36262 ensure that the original delivery also proceeds. In this case, all the user has
36263 to do is to create a file called, say, &_.vacation_&, containing a vacation
36264 message.
36265 .endlist
36266
36267 Another advantage of both these methods is that they both work even when the
36268 use of arbitrary pipes by users is locked out.
36269
36270
36271
36272 .section "Taking copies of mail" "SECID245"
36273 .cindex "message" "copying every"
36274 Some installations have policies that require archive copies of all messages to
36275 be made. A single copy of each message can easily be taken by an appropriate
36276 command in a system filter, which could, for example, use a different file for
36277 each day's messages.
36278
36279 There is also a shadow transport mechanism that can be used to take copies of
36280 messages that are successfully delivered by local transports, one copy per
36281 delivery. This could be used, &'inter alia'&, to implement automatic
36282 notification of delivery by sites that insist on doing such things.
36283
36284
36285
36286 .section "Intermittently connected hosts" "SECID246"
36287 .cindex "intermittently connected hosts"
36288 It has become quite common (because it is cheaper) for hosts to connect to the
36289 Internet periodically rather than remain connected all the time. The normal
36290 arrangement is that mail for such hosts accumulates on a system that is
36291 permanently connected.
36292
36293 Exim was designed for use on permanently connected hosts, and so it is not
36294 particularly well-suited to use in an intermittently connected environment.
36295 Nevertheless there are some features that can be used.
36296
36297
36298 .section "Exim on the upstream server host" "SECID247"
36299 It is tempting to arrange for incoming mail for the intermittently connected
36300 host to remain in Exim's queue until the client connects. However, this
36301 approach does not scale very well. Two different kinds of waiting message are
36302 being mixed up in the same queue &-- those that cannot be delivered because of
36303 some temporary problem, and those that are waiting for their destination host
36304 to connect. This makes it hard to manage the queue, as well as wasting
36305 resources, because each queue runner scans the entire queue.
36306
36307 A better approach is to separate off those messages that are waiting for an
36308 intermittently connected host. This can be done by delivering these messages
36309 into local files in batch SMTP, &"mailstore"&, or other envelope-preserving
36310 format, from where they are transmitted by other software when their
36311 destination connects. This makes it easy to collect all the mail for one host
36312 in a single directory, and to apply local timeout rules on a per-message basis
36313 if required.
36314
36315 On a very small scale, leaving the mail on Exim's queue can be made to work. If
36316 you are doing this, you should configure Exim with a long retry period for the
36317 intermittent host. For example:
36318 .code
36319 cheshire.wonderland.fict.example    *   F,5d,24h
36320 .endd
36321 This stops a lot of failed delivery attempts from occurring, but Exim remembers
36322 which messages it has queued up for that host. Once the intermittent host comes
36323 online, forcing delivery of one message (either by using the &%-M%& or &%-R%&
36324 options, or by using the ETRN SMTP command (see section &<<SECTETRN>>&)
36325 causes all the queued up messages to be delivered, often down a single SMTP
36326 connection. While the host remains connected, any new messages get delivered
36327 immediately.
36328
36329 If the connecting hosts do not have fixed IP addresses, that is, if a host is
36330 issued with a different IP address each time it connects, Exim's retry
36331 mechanisms on the holding host get confused, because the IP address is normally
36332 used as part of the key string for holding retry information. This can be
36333 avoided by unsetting &%retry_include_ip_address%& on the &(smtp)& transport.
36334 Since this has disadvantages for permanently connected hosts, it is best to
36335 arrange a separate transport for the intermittently connected ones.
36336
36337
36338
36339 .section "Exim on the intermittently connected client host" "SECID248"
36340 The value of &%smtp_accept_queue_per_connection%& should probably be
36341 increased, or even set to zero (that is, disabled) on the intermittently
36342 connected host, so that all incoming messages down a single connection get
36343 delivered immediately.
36344
36345 .cindex "SMTP" "passed connection"
36346 .cindex "SMTP" "multiple deliveries"
36347 .cindex "multiple SMTP deliveries"
36348 Mail waiting to be sent from an intermittently connected host will probably
36349 not have been routed, because without a connection DNS lookups are not
36350 possible. This means that if a normal queue run is done at connection time,
36351 each message is likely to be sent in a separate SMTP session. This can be
36352 avoided by starting the queue run with a command line option beginning with
36353 &%-qq%& instead of &%-q%&. In this case, the queue is scanned twice. In the
36354 first pass, routing is done but no deliveries take place. The second pass is a
36355 normal queue run; since all the messages have been previously routed, those
36356 destined for the same host are likely to get sent as multiple deliveries in a
36357 single SMTP connection.
36358
36359
36360
36361 . ////////////////////////////////////////////////////////////////////////////
36362 . ////////////////////////////////////////////////////////////////////////////
36363
36364 .chapter "Using Exim as a non-queueing client" "CHAPnonqueueing" &&&
36365          "Exim as a non-queueing client"
36366 .cindex "client, non-queueing"
36367 .cindex "smart host" "suppressing queueing"
36368 On a personal computer, it is a common requirement for all
36369 email to be sent to a &"smart host"&. There are plenty of MUAs that can be
36370 configured to operate that way, for all the popular operating systems.
36371 However, there are some MUAs for Unix-like systems that cannot be so
36372 configured: they submit messages using the command line interface of
36373 &_/usr/sbin/sendmail_&. Furthermore, utility programs such as &'cron'& submit
36374 messages this way.
36375
36376 If the personal computer runs continuously, there is no problem, because it can
36377 run a conventional MTA that handles delivery to the smart host, and deal with
36378 any delays via its queueing mechanism. However, if the computer does not run
36379 continuously or runs different operating systems at different times, queueing
36380 email is not desirable.
36381
36382 There is therefore a requirement for something that can provide the
36383 &_/usr/sbin/sendmail_& interface but deliver messages to a smart host without
36384 any queueing or retrying facilities. Furthermore, the delivery to the smart
36385 host should be synchronous, so that if it fails, the sending MUA is immediately
36386 informed. In other words, we want something that extends an MUA that submits
36387 to a local MTA via the command line so that it behaves like one that submits
36388 to a remote smart host using TCP/SMTP.
36389
36390 There are a number of applications (for example, there is one called &'ssmtp'&)
36391 that do this job. However, people have found them to be lacking in various
36392 ways. For instance, you might want to allow aliasing and forwarding to be done
36393 before sending a message to the smart host.
36394
36395 Exim already had the necessary infrastructure for doing this job. Just a few
36396 tweaks were needed to make it behave as required, though it is somewhat of an
36397 overkill to use a fully-featured MTA for this purpose.
36398
36399 .oindex "&%mua_wrapper%&"
36400 There is a Boolean global option called &%mua_wrapper%&, defaulting false.
36401 Setting &%mua_wrapper%& true causes Exim to run in a special mode where it
36402 assumes that it is being used to &"wrap"& a command-line MUA in the manner
36403 just described. As well as setting &%mua_wrapper%&, you also need to provide a
36404 compatible router and transport configuration. Typically there will be just one
36405 router and one transport, sending everything to a smart host.
36406
36407 When run in MUA wrapping mode, the behaviour of Exim changes in the
36408 following ways:
36409
36410 .ilist
36411 A daemon cannot be run, nor will Exim accept incoming messages from &'inetd'&.
36412 In other words, the only way to submit messages is via the command line.
36413 .next
36414 Each message is synchronously delivered as soon as it is received (&%-odi%& is
36415 assumed). All queueing options (&%queue_only%&, &%queue_smtp_domains%&,
36416 &%control%& in an ACL, etc.) are quietly ignored. The Exim reception process
36417 does not finish until the delivery attempt is complete. If the delivery is
36418 successful, a zero return code is given.
36419 .next
36420 Address redirection is permitted, but the final routing for all addresses must
36421 be to the same remote transport, and to the same list of hosts. Furthermore,
36422 the return address (envelope sender) must be the same for all recipients, as
36423 must any added or deleted header lines. In other words, it must be possible to
36424 deliver the message in a single SMTP transaction, however many recipients there
36425 are.
36426 .next
36427 If these conditions are not met, or if routing any address results in a
36428 failure or defer status, or if Exim is unable to deliver all the recipients
36429 successfully to one of the smart hosts, delivery of the entire message fails.
36430 .next
36431 Because no queueing is allowed, all failures are treated as permanent; there
36432 is no distinction between 4&'xx'& and 5&'xx'& SMTP response codes from the
36433 smart host. Furthermore, because only a single yes/no response can be given to
36434 the caller, it is not possible to deliver to some recipients and not others. If
36435 there is an error (temporary or permanent) for any recipient, all are failed.
36436 .next
36437 If more than one smart host is listed, Exim will try another host after a
36438 connection failure or a timeout, in the normal way. However, if this kind of
36439 failure happens for all the hosts, the delivery fails.
36440 .next
36441 When delivery fails, an error message is written to the standard error stream
36442 (as well as to Exim's log), and Exim exits to the caller with a return code
36443 value 1. The message is expunged from Exim's spool files. No bounce messages
36444 are ever generated.
36445 .next
36446 No retry data is maintained, and any retry rules are ignored.
36447 .next
36448 A number of Exim options are overridden: &%deliver_drop_privilege%& is forced
36449 true, &%max_rcpt%& in the &(smtp)& transport is forced to &"unlimited"&,
36450 &%remote_max_parallel%& is forced to one, and fallback hosts are ignored.
36451 .endlist
36452
36453 The overall effect is that Exim makes a single synchronous attempt to deliver
36454 the message, failing if there is any kind of problem. Because no local
36455 deliveries are done and no daemon can be run, Exim does not need root
36456 privilege. It should be possible to run it setuid to &'exim'& instead of setuid
36457 to &'root'&. See section &<<SECTrunexiwitpri>>& for a general discussion about
36458 the advantages and disadvantages of running without root privilege.
36459
36460
36461
36462
36463 . ////////////////////////////////////////////////////////////////////////////
36464 . ////////////////////////////////////////////////////////////////////////////
36465
36466 .chapter "Log files" "CHAPlog"
36467 .scindex IIDloggen "log" "general description"
36468 .cindex "log" "types of"
36469 Exim writes three different logs, referred to as the main log, the reject log,
36470 and the panic log:
36471
36472 .ilist
36473 .cindex "main log"
36474 The main log records the arrival of each message and each delivery in a single
36475 line in each case. The format is as compact as possible, in an attempt to keep
36476 down the size of log files. Two-character flag sequences make it easy to pick
36477 out these lines. A number of other events are recorded in the main log. Some of
36478 them are optional, in which case the &%log_selector%& option controls whether
36479 they are included or not. A Perl script called &'eximstats'&, which does simple
36480 analysis of main log files, is provided in the Exim distribution (see section
36481 &<<SECTmailstat>>&).
36482 .next
36483 .cindex "reject log"
36484 The reject log records information from messages that are rejected as a result
36485 of a configuration option (that is, for policy reasons).
36486 The first line of each rejection is a copy of the line that is also written to
36487 the main log. Then, if the message's header has been read at the time the log
36488 is written, its contents are written to this log. Only the original header
36489 lines are available; header lines added by ACLs are not logged. You can use the
36490 reject log to check that your policy controls are working correctly; on a busy
36491 host this may be easier than scanning the main log for rejection messages. You
36492 can suppress the writing of the reject log by setting &%write_rejectlog%&
36493 false.
36494 .next
36495 .cindex "panic log"
36496 .cindex "system log"
36497 When certain serious errors occur, Exim writes entries to its panic log. If the
36498 error is sufficiently disastrous, Exim bombs out afterwards. Panic log entries
36499 are usually written to the main log as well, but can get lost amid the mass of
36500 other entries. The panic log should be empty under normal circumstances. It is
36501 therefore a good idea to check it (or to have a &'cron'& script check it)
36502 regularly, in order to become aware of any problems. When Exim cannot open its
36503 panic log, it tries as a last resort to write to the system log (syslog). This
36504 is opened with LOG_PID+LOG_CONS and the facility code of LOG_MAIL. The
36505 message itself is written at priority LOG_CRIT.
36506 .endlist
36507
36508 Every log line starts with a timestamp, in the format shown in the following
36509 example. Note that many of the examples shown in this chapter are line-wrapped.
36510 In the log file, this would be all on one line:
36511 .code
36512 2001-09-16 16:09:47 SMTP connection from [127.0.0.1] closed
36513   by QUIT
36514 .endd
36515 By default, the timestamps are in the local timezone. There are two
36516 ways of changing this:
36517
36518 .ilist
36519 You can set the &%timezone%& option to a different time zone; in particular, if
36520 you set
36521 .code
36522 timezone = UTC
36523 .endd
36524 the timestamps will be in UTC (aka GMT).
36525 .next
36526 If you set &%log_timezone%& true, the time zone is added to the timestamp, for
36527 example:
36528 .code
36529 2003-04-25 11:17:07 +0100 Start queue run: pid=12762
36530 .endd
36531 .endlist
36532
36533 .cindex "log" "process ids in"
36534 .cindex "pid (process id)" "in log lines"
36535 Exim does not include its process id in log lines by default, but you can
36536 request that it does so by specifying the &`pid`& log selector (see section
36537 &<<SECTlogselector>>&). When this is set, the process id is output, in square
36538 brackets, immediately after the time and date.
36539
36540
36541
36542
36543 .section "Where the logs are written" "SECTwhelogwri"
36544 .cindex "log" "destination"
36545 .cindex "log" "to file"
36546 .cindex "log" "to syslog"
36547 .cindex "syslog"
36548 The logs may be written to local files, or to syslog, or both. However, it
36549 should be noted that many syslog implementations use UDP as a transport, and
36550 are therefore unreliable in the sense that messages are not guaranteed to
36551 arrive at the loghost, nor is the ordering of messages necessarily maintained.
36552 It has also been reported that on large log files (tens of megabytes) you may
36553 need to tweak syslog to prevent it syncing the file with each write &-- on
36554 Linux this has been seen to make syslog take 90% plus of CPU time.
36555
36556 The destination for Exim's logs is configured by setting LOG_FILE_PATH in
36557 &_Local/Makefile_& or by setting &%log_file_path%& in the runtime
36558 configuration. This latter string is expanded, so it can contain, for example,
36559 references to the host name:
36560 .code
36561 log_file_path = /var/log/$primary_hostname/exim_%slog
36562 .endd
36563 It is generally advisable, however, to set the string in &_Local/Makefile_&
36564 rather than at runtime, because then the setting is available right from the
36565 start of Exim's execution. Otherwise, if there's something it wants to log
36566 before it has read the configuration file (for example, an error in the
36567 configuration file) it will not use the path you want, and may not be able to
36568 log at all.
36569
36570 The value of LOG_FILE_PATH or &%log_file_path%& is a colon-separated
36571 list, currently limited to at most two items. This is one option where the
36572 facility for changing a list separator may not be used. The list must always be
36573 colon-separated. If an item in the list is &"syslog"& then syslog is used;
36574 otherwise the item must either be an absolute path, containing &`%s`& at the
36575 point where &"main"&, &"reject"&, or &"panic"& is to be inserted, or be empty,
36576 implying the use of a default path.
36577
36578 When Exim encounters an empty item in the list, it searches the list defined by
36579 LOG_FILE_PATH, and uses the first item it finds that is neither empty nor
36580 &"syslog"&. This means that an empty item in &%log_file_path%& can be used to
36581 mean &"use the path specified at build time"&. It no such item exists, log
36582 files are written in the &_log_& subdirectory of the spool directory. This is
36583 equivalent to the setting:
36584 .code
36585 log_file_path = $spool_directory/log/%slog
36586 .endd
36587 If you do not specify anything at build time or runtime,
36588 or if you unset the option at runtime (i.e. &`log_file_path = `&),
36589 that is where the logs are written.
36590
36591 A log file path may also contain &`%D`& or &`%M`& if datestamped log filenames
36592 are in use &-- see section &<<SECTdatlogfil>>& below.
36593
36594 Here are some examples of possible settings:
36595 .display
36596 &`LOG_FILE_PATH=syslog                    `& syslog only
36597 &`LOG_FILE_PATH=:syslog                   `& syslog and default path
36598 &`LOG_FILE_PATH=syslog : /usr/log/exim_%s `& syslog and specified path
36599 &`LOG_FILE_PATH=/usr/log/exim_%s          `& specified path only
36600 .endd
36601 If there are more than two paths in the list, the first is used and a panic
36602 error is logged.
36603
36604
36605
36606 .section "Logging to local files that are periodically &""cycled""&" "SECID285"
36607 .cindex "log" "cycling local files"
36608 .cindex "cycling logs"
36609 .cindex "&'exicyclog'&"
36610 .cindex "log" "local files; writing to"
36611 Some operating systems provide centralized and standardized methods for cycling
36612 log files. For those that do not, a utility script called &'exicyclog'& is
36613 provided (see section &<<SECTcyclogfil>>&). This renames and compresses the
36614 main and reject logs each time it is called. The maximum number of old logs to
36615 keep can be set. It is suggested this script is run as a daily &'cron'& job.
36616
36617 An Exim delivery process opens the main log when it first needs to write to it,
36618 and it keeps the file open in case subsequent entries are required &-- for
36619 example, if a number of different deliveries are being done for the same
36620 message. However, remote SMTP deliveries can take a long time, and this means
36621 that the file may be kept open long after it is renamed if &'exicyclog'& or
36622 something similar is being used to rename log files on a regular basis. To
36623 ensure that a switch of log files is noticed as soon as possible, Exim calls
36624 &[stat()]& on the main log's name before reusing an open file, and if the file
36625 does not exist, or its inode has changed, the old file is closed and Exim
36626 tries to open the main log from scratch. Thus, an old log file may remain open
36627 for quite some time, but no Exim processes should write to it once it has been
36628 renamed.
36629
36630
36631
36632 .section "Datestamped log files" "SECTdatlogfil"
36633 .cindex "log" "datestamped files"
36634 Instead of cycling the main and reject log files by renaming them
36635 periodically, some sites like to use files whose names contain a datestamp,
36636 for example, &_mainlog-20031225_&. The datestamp is in the form &_yyyymmdd_& or
36637 &_yyyymm_&. Exim has support for this way of working. It is enabled by setting
36638 the &%log_file_path%& option to a path that includes &`%D`& or &`%M`& at the
36639 point where the datestamp is required. For example:
36640 .code
36641 log_file_path = /var/spool/exim/log/%slog-%D
36642 log_file_path = /var/log/exim-%s-%D.log
36643 log_file_path = /var/spool/exim/log/%D-%slog
36644 log_file_path = /var/log/exim/%s.%M
36645 .endd
36646 As before, &`%s`& is replaced by &"main"& or &"reject"&; the following are
36647 examples of names generated by the above examples:
36648 .code
36649 /var/spool/exim/log/mainlog-20021225
36650 /var/log/exim-reject-20021225.log
36651 /var/spool/exim/log/20021225-mainlog
36652 /var/log/exim/main.200212
36653 .endd
36654 When this form of log file is specified, Exim automatically switches to new
36655 files at midnight. It does not make any attempt to compress old logs; you
36656 will need to write your own script if you require this. You should not
36657 run &'exicyclog'& with this form of logging.
36658
36659 The location of the panic log is also determined by &%log_file_path%&, but it
36660 is not datestamped, because rotation of the panic log does not make sense.
36661 When generating the name of the panic log, &`%D`& or &`%M`& are removed from
36662 the string. In addition, if it immediately follows a slash, a following
36663 non-alphanumeric character is removed; otherwise a preceding non-alphanumeric
36664 character is removed. Thus, the four examples above would give these panic
36665 log names:
36666 .code
36667 /var/spool/exim/log/paniclog
36668 /var/log/exim-panic.log
36669 /var/spool/exim/log/paniclog
36670 /var/log/exim/panic
36671 .endd
36672
36673
36674 .section "Logging to syslog" "SECID249"
36675 .cindex "log" "syslog; writing to"
36676 The use of syslog does not change what Exim logs or the format of its messages,
36677 except in one respect. If &%syslog_timestamp%& is set false, the timestamps on
36678 Exim's log lines are omitted when these lines are sent to syslog. Apart from
36679 that, the same strings are written to syslog as to log files. The syslog
36680 &"facility"& is set to LOG_MAIL, and the program name to &"exim"&
36681 by default, but you can change these by setting the &%syslog_facility%& and
36682 &%syslog_processname%& options, respectively. If Exim was compiled with
36683 SYSLOG_LOG_PID set in &_Local/Makefile_& (this is the default in
36684 &_src/EDITME_&), then, on systems that permit it (all except ULTRIX), the
36685 LOG_PID flag is set so that the &[syslog()]& call adds the pid as well as
36686 the time and host name to each line.
36687 The three log streams are mapped onto syslog priorities as follows:
36688
36689 .ilist
36690 &'mainlog'& is mapped to LOG_INFO
36691 .next
36692 &'rejectlog'& is mapped to LOG_NOTICE
36693 .next
36694 &'paniclog'& is mapped to LOG_ALERT
36695 .endlist
36696
36697 Many log lines are written to both &'mainlog'& and &'rejectlog'&, and some are
36698 written to both &'mainlog'& and &'paniclog'&, so there will be duplicates if
36699 these are routed by syslog to the same place. You can suppress this duplication
36700 by setting &%syslog_duplication%& false.
36701
36702 Exim's log lines can sometimes be very long, and some of its &'rejectlog'&
36703 entries contain multiple lines when headers are included. To cope with both
36704 these cases, entries written to syslog are split into separate &[syslog()]&
36705 calls at each internal newline, and also after a maximum of
36706 870 data characters. (This allows for a total syslog line length of 1024, when
36707 additions such as timestamps are added.) If you are running a syslog
36708 replacement that can handle lines longer than the 1024 characters allowed by
36709 RFC 3164, you should set
36710 .code
36711 SYSLOG_LONG_LINES=yes
36712 .endd
36713 in &_Local/Makefile_& before building Exim. That stops Exim from splitting long
36714 lines, but it still splits at internal newlines in &'reject'& log entries.
36715
36716 To make it easy to re-assemble split lines later, each component of a split
36717 entry starts with a string of the form [<&'n'&>/<&'m'&>] or [<&'n'&>\<&'m'&>]
36718 where <&'n'&> is the component number and <&'m'&> is the total number of
36719 components in the entry. The / delimiter is used when the line was split
36720 because it was too long; if it was split because of an internal newline, the \
36721 delimiter is used. For example, supposing the length limit to be 50 instead of
36722 870, the following would be the result of a typical rejection message to
36723 &'mainlog'& (LOG_INFO), each line in addition being preceded by the time, host
36724 name, and pid as added by syslog:
36725 .code
36726 [1/5] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected from
36727 [2/5]  [127.0.0.1] (ph10): syntax error in 'From' header
36728 [3/5]  when scanning for sender: missing or malformed lo
36729 [4/5] cal part in "<>" (envelope sender is <ph10@cam.exa
36730 [5/5] mple>)
36731 .endd
36732 The same error might cause the following lines to be written to &"rejectlog"&
36733 (LOG_NOTICE):
36734 .code
36735 [1/18] 2002-09-16 16:09:43 16RdAL-0006pc-00 rejected fro
36736 [2/18] m [127.0.0.1] (ph10): syntax error in 'From' head
36737 [3/18] er when scanning for sender: missing or malformed
36738 [4/18]  local part in "<>" (envelope sender is <ph10@cam
36739 [5\18] .example>)
36740 [6\18] Recipients: ph10@some.domain.cam.example
36741 [7\18] P Received: from [127.0.0.1] (ident=ph10)
36742 [8\18]        by xxxxx.cam.example with smtp (Exim 4.00)
36743 [9\18]        id 16RdAL-0006pc-00
36744 [10/18]        for ph10@cam.example; Mon, 16 Sep 2002 16:
36745 [11\18] 09:43 +0100
36746 [12\18] F From: <>
36747 [13\18]   Subject: this is a test header
36748 [18\18]   X-something: this is another header
36749 [15/18] I Message-Id: <E16RdAL-0006pc-00@xxxxx.cam.examp
36750 [16\18] le>
36751 [17\18] B Bcc:
36752 [18/18]   Date: Mon, 16 Sep 2002 16:09:43 +0100
36753 .endd
36754 Log lines that are neither too long nor contain newlines are written to syslog
36755 without modification.
36756
36757 If only syslog is being used, the Exim monitor is unable to provide a log tail
36758 display, unless syslog is routing &'mainlog'& to a file on the local host and
36759 the environment variable EXIMON_LOG_FILE_PATH is set to tell the monitor
36760 where it is.
36761
36762
36763
36764 .section "Log line flags" "SECID250"
36765 One line is written to the main log for each message received, and for each
36766 successful, unsuccessful, and delayed delivery. These lines can readily be
36767 picked out by the distinctive two-character flags that immediately follow the
36768 timestamp. The flags are:
36769 .display
36770 &`<=`&     message arrival
36771 &`(=`&     message fakereject
36772 &`=>`&     normal message delivery
36773 &`->`&     additional address in same delivery
36774 &`>>`&     cutthrough message delivery
36775 &`*>`&     delivery suppressed by &%-N%&
36776 &`**`&     delivery failed; address bounced
36777 &`==`&     delivery deferred; temporary problem
36778 .endd
36779
36780
36781 .section "Logging message reception" "SECID251"
36782 .cindex "log" "reception line"
36783 The format of the single-line entry in the main log that is written for every
36784 message received is shown in the basic example below, which is split over
36785 several lines in order to fit it on the page:
36786 .code
36787 2002-10-31 08:57:53 16ZCW1-0005MB-00 <= kryten@dwarf.fict.example
36788   H=mailer.fict.example [192.168.123.123] U=exim
36789   P=smtp S=5678 id=<incoming message id>
36790 .endd
36791 The address immediately following &"<="& is the envelope sender address. A
36792 bounce message is shown with the sender address &"<>"&, and if it is locally
36793 generated, this is followed by an item of the form
36794 .code
36795 R=<message id>
36796 .endd
36797 which is a reference to the message that caused the bounce to be sent.
36798
36799 .cindex "HELO"
36800 .cindex "EHLO"
36801 For messages from other hosts, the H and U fields identify the remote host and
36802 record the RFC 1413 identity of the user that sent the message, if one was
36803 received. The number given in square brackets is the IP address of the sending
36804 host. If there is a single, unparenthesized  host name in the H field, as
36805 above, it has been verified to correspond to the IP address (see the
36806 &%host_lookup%& option). If the name is in parentheses, it was the name quoted
36807 by the remote host in the SMTP HELO or EHLO command, and has not been
36808 verified. If verification yields a different name to that given for HELO or
36809 EHLO, the verified name appears first, followed by the HELO or EHLO
36810 name in parentheses.
36811
36812 Misconfigured hosts (and mail forgers) sometimes put an IP address, with or
36813 without brackets, in the HELO or EHLO command, leading to entries in
36814 the log containing text like these examples:
36815 .code
36816 H=(10.21.32.43) [192.168.8.34]
36817 H=([10.21.32.43]) [192.168.8.34]
36818 .endd
36819 This can be confusing. Only the final address in square brackets can be relied
36820 on.
36821
36822 For locally generated messages (that is, messages not received over TCP/IP),
36823 the H field is omitted, and the U field contains the login name of the caller
36824 of Exim.
36825
36826 .cindex "authentication" "logging"
36827 .cindex "AUTH" "logging"
36828 For all messages, the P field specifies the protocol used to receive the
36829 message. This is the value that is stored in &$received_protocol$&. In the case
36830 of incoming SMTP messages, the value indicates whether or not any SMTP
36831 extensions (ESMTP), encryption, or authentication were used. If the SMTP
36832 session was encrypted, there is an additional X field that records the cipher
36833 suite that was used.
36834
36835 .cindex log protocol
36836 The protocol is set to &"esmtpsa"& or &"esmtpa"& for messages received from
36837 hosts that have authenticated themselves using the SMTP AUTH command. The first
36838 value is used when the SMTP connection was encrypted (&"secure"&). In this case
36839 there is an additional item A= followed by the name of the authenticator that
36840 was used. If an authenticated identification was set up by the authenticator's
36841 &%server_set_id%& option, this is logged too, separated by a colon from the
36842 authenticator name.
36843
36844 .cindex "size" "of message"
36845 The id field records the existing message id, if present. The size of the
36846 received message is given by the S field. When the message is delivered,
36847 headers may be removed or added, so that the size of delivered copies of the
36848 message may not correspond with this value (and indeed may be different to each
36849 other).
36850
36851 The &%log_selector%& option can be used to request the logging of additional
36852 data when a message is received. See section &<<SECTlogselector>>& below.
36853
36854
36855
36856 .section "Logging deliveries" "SECID252"
36857 .cindex "log" "delivery line"
36858 The format of the single-line entry in the main log that is written for every
36859 delivery is shown in one of the examples below, for local and remote
36860 deliveries, respectively. Each example has been split into multiple lines in order
36861 to fit it on the page:
36862 .code
36863 2002-10-31 08:59:13 16ZCW1-0005MB-00 => marv
36864   <marv@hitch.fict.example> R=localuser T=local_delivery
36865 2002-10-31 09:00:10 16ZCW1-0005MB-00 =>
36866   monk@holistic.fict.example R=dnslookup T=remote_smtp
36867   H=holistic.fict.example [192.168.234.234]
36868 .endd
36869 For ordinary local deliveries, the original address is given in angle brackets
36870 after the final delivery address, which might be a pipe or a file. If
36871 intermediate address(es) exist between the original and the final address, the
36872 last of these is given in parentheses after the final address. The R and T
36873 fields record the router and transport that were used to process the address.
36874
36875 If SMTP AUTH was used for the delivery there is an additional item A=
36876 followed by the name of the authenticator that was used.
36877 If an authenticated identification was set up by the authenticator's &%client_set_id%&
36878 option, this is logged too, separated by a colon from the authenticator name.
36879
36880 If a shadow transport was run after a successful local delivery, the log line
36881 for the successful delivery has an item added on the end, of the form
36882 .display
36883 &`ST=<`&&'shadow transport name'&&`>`&
36884 .endd
36885 If the shadow transport did not succeed, the error message is put in
36886 parentheses afterwards.
36887
36888 .cindex "asterisk" "after IP address"
36889 When more than one address is included in a single delivery (for example, two
36890 SMTP RCPT commands in one transaction) the second and subsequent addresses are
36891 flagged with &`->`& instead of &`=>`&. When two or more messages are delivered
36892 down a single SMTP connection, an asterisk follows the IP address in the log
36893 lines for the second and subsequent messages.
36894 When two or more messages are delivered down a single TLS connection, the
36895 DNS and some TLS-related information logged for the first message delivered
36896 will not be present in the log lines for the second and subsequent messages.
36897 TLS cipher information is still available.
36898
36899 .cindex "delivery" "cutthrough; logging"
36900 .cindex "cutthrough" "logging"
36901 When delivery is done in cutthrough mode it is flagged with &`>>`& and the log
36902 line precedes the reception line, since cutthrough waits for a possible
36903 rejection from the destination in case it can reject the sourced item.
36904
36905 The generation of a reply message by a filter file gets logged as a
36906 &"delivery"& to the addressee, preceded by &">"&.
36907
36908 The &%log_selector%& option can be used to request the logging of additional
36909 data when a message is delivered. See section &<<SECTlogselector>>& below.
36910
36911
36912 .section "Discarded deliveries" "SECID253"
36913 .cindex "discarded messages"
36914 .cindex "message" "discarded"
36915 .cindex "delivery" "discarded; logging"
36916 When a message is discarded as a result of the command &"seen finish"& being
36917 obeyed in a filter file which generates no deliveries, a log entry of the form
36918 .code
36919 2002-12-10 00:50:49 16auJc-0001UB-00 => discarded
36920   <low.club@bridge.example> R=userforward
36921 .endd
36922 is written, to record why no deliveries are logged. When a message is discarded
36923 because it is aliased to &":blackhole:"& the log line is like this:
36924 .code
36925 1999-03-02 09:44:33 10HmaX-0005vi-00 => :blackhole:
36926   <hole@nowhere.example> R=blackhole_router
36927 .endd
36928
36929
36930 .section "Deferred deliveries" "SECID254"
36931 When a delivery is deferred, a line of the following form is logged:
36932 .code
36933 2002-12-19 16:20:23 16aiQz-0002Q5-00 == marvin@endrest.example
36934   R=dnslookup T=smtp defer (146): Connection refused
36935 .endd
36936 In the case of remote deliveries, the error is the one that was given for the
36937 last IP address that was tried. Details of individual SMTP failures are also
36938 written to the log, so the above line would be preceded by something like
36939 .code
36940 2002-12-19 16:20:23 16aiQz-0002Q5-00 Failed to connect to
36941   mail1.endrest.example [192.168.239.239]: Connection refused
36942 .endd
36943 When a deferred address is skipped because its retry time has not been reached,
36944 a message is written to the log, but this can be suppressed by setting an
36945 appropriate value in &%log_selector%&.
36946
36947
36948
36949 .section "Delivery failures" "SECID255"
36950 .cindex "delivery" "failure; logging"
36951 If a delivery fails because an address cannot be routed, a line of the
36952 following form is logged:
36953 .code
36954 1995-12-19 16:20:23 0tRiQz-0002Q5-00 ** jim@trek99.example
36955   <jim@trek99.example>: unknown mail domain
36956 .endd
36957 If a delivery fails at transport time, the router and transport are shown, and
36958 the response from the remote host is included, as in this example:
36959 .code
36960 2002-07-11 07:14:17 17SXDU-000189-00 ** ace400@pb.example
36961   R=dnslookup T=remote_smtp: SMTP error from remote mailer
36962   after pipelined RCPT TO:<ace400@pb.example>: host
36963   pbmail3.py.example [192.168.63.111]: 553 5.3.0
36964   <ace400@pb.example>...Addressee unknown
36965 .endd
36966 The word &"pipelined"& indicates that the SMTP PIPELINING extension was being
36967 used. See &%hosts_avoid_esmtp%& in the &(smtp)& transport for a way of
36968 disabling PIPELINING. The log lines for all forms of delivery failure are
36969 flagged with &`**`&.
36970
36971
36972
36973 .section "Fake deliveries" "SECID256"
36974 .cindex "delivery" "fake; logging"
36975 If a delivery does not actually take place because the &%-N%& option has been
36976 used to suppress it, a normal delivery line is written to the log, except that
36977 &"=>"& is replaced by &"*>"&.
36978
36979
36980
36981 .section "Completion" "SECID257"
36982 A line of the form
36983 .code
36984 2002-10-31 09:00:11 16ZCW1-0005MB-00 Completed
36985 .endd
36986 is written to the main log when a message is about to be removed from the spool
36987 at the end of its processing.
36988
36989
36990
36991
36992 .section "Summary of Fields in Log Lines" "SECID258"
36993 .cindex "log" "summary of fields"
36994 A summary of the field identifiers that are used in log lines is shown in
36995 the following table:
36996 .display
36997 &`A   `&        authenticator name (and optional id and sender)
36998 &`C   `&        SMTP confirmation on delivery
36999 &`    `&        command list for &"no mail in SMTP session"&
37000 &`CV  `&        certificate verification status
37001 &`D   `&        duration of &"no mail in SMTP session"&
37002 &`DKIM`&        domain verified in incoming message
37003 &`DN  `&        distinguished name from peer certificate
37004 &`DS  `&        DNSSEC secured lookups
37005 &`DT  `&        on &`=>`& lines: time taken for a delivery
37006 &`F   `&        sender address (on delivery lines)
37007 &`H   `&        host name and IP address
37008 &`I   `&        local interface used
37009 &`id  `&        message id (from header) for incoming message
37010 &`K   `&        CHUNKING extension used
37011 &`L   `&        on &`<=`& and &`=>`& lines: PIPELINING extension used
37012 &`M8S `&        8BITMIME status for incoming message
37013 &`P   `&        on &`<=`& lines: protocol used
37014 &`    `&        on &`=>`& and &`**`& lines: return path
37015 &`PRDR`&        PRDR extension used
37016 &`PRX `&        on &`<=`& and &`=>`& lines: proxy address
37017 &`Q   `&        alternate queue name
37018 &`QT  `&        on &`=>`& lines: time spent on queue so far
37019 &`    `&        on &"Completed"& lines: time spent on queue
37020 &`R   `&        on &`<=`& lines: reference for local bounce
37021 &`    `&        on &`=>`&  &`>>`& &`**`& and &`==`& lines: router name
37022 &`RT  `&        on &`<=`& lines: time taken for reception
37023 &`S   `&        size of message in bytes
37024 &`SNI `&        server name indication from TLS client hello
37025 &`ST  `&        shadow transport name
37026 &`T   `&        on &`<=`& lines: message subject (topic)
37027 &`TFO `&        connection took advantage of TCP Fast Open
37028 &`    `&        on &`=>`& &`**`& and &`==`& lines: transport name
37029 &`U   `&        local user or RFC 1413 identity
37030 &`X   `&        TLS cipher suite
37031 .endd
37032
37033
37034 .section "Other log entries" "SECID259"
37035 Various other types of log entry are written from time to time. Most should be
37036 self-explanatory. Among the more common are:
37037
37038 .ilist
37039 .cindex "retry" "time not reached"
37040 &'retry time not reached'&&~&~An address previously suffered a temporary error
37041 during routing or local delivery, and the time to retry has not yet arrived.
37042 This message is not written to an individual message log file unless it happens
37043 during the first delivery attempt.
37044 .next
37045 &'retry time not reached for any host'&&~&~An address previously suffered
37046 temporary errors during remote delivery, and the retry time has not yet arrived
37047 for any of the hosts to which it is routed.
37048 .next
37049 .cindex "spool directory" "file locked"
37050 &'spool file locked'&&~&~An attempt to deliver a message cannot proceed because
37051 some other Exim process is already working on the message. This can be quite
37052 common if queue running processes are started at frequent intervals. The
37053 &'exiwhat'& utility script can be used to find out what Exim processes are
37054 doing.
37055 .next
37056 .cindex "error" "ignored"
37057 &'error ignored'&&~&~There are several circumstances that give rise to this
37058 message:
37059 .olist
37060 Exim failed to deliver a bounce message whose age was greater than
37061 &%ignore_bounce_errors_after%&. The bounce was discarded.
37062 .next
37063 A filter file set up a delivery using the &"noerror"& option, and the delivery
37064 failed. The delivery was discarded.
37065 .next
37066 A delivery set up by a router configured with
37067 . ==== As this is a nested list, any displays it contains must be indented
37068 . ==== as otherwise they are too far to the left.
37069 .code
37070     errors_to = <>
37071 .endd
37072 failed. The delivery was discarded.
37073 .endlist olist
37074 .next
37075 .cindex DKIM "log line"
37076 &'DKIM: d='&&~&~Verbose results of a DKIM verification attempt, if enabled for
37077 logging and the message has a DKIM signature header.
37078 .endlist ilist
37079
37080
37081
37082
37083
37084 .section "Reducing or increasing what is logged" "SECTlogselector"
37085 .cindex "log" "selectors"
37086 By setting the &%log_selector%& global option, you can disable some of Exim's
37087 default logging, or you can request additional logging. The value of
37088 &%log_selector%& is made up of names preceded by plus or minus characters. For
37089 example:
37090 .code
37091 log_selector = +arguments -retry_defer
37092 .endd
37093 The list of optional log items is in the following table, with the default
37094 selection marked by asterisks:
37095 .display
37096 &` 8bitmime                   `&  received 8BITMIME status
37097 &`*acl_warn_skipped           `&  skipped &%warn%& statement in ACL
37098 &` address_rewrite            `&  address rewriting
37099 &` all_parents                `&  all parents in => lines
37100 &` arguments                  `&  command line arguments
37101 &`*connection_reject          `&  connection rejections
37102 &`*delay_delivery             `&  immediate delivery delayed
37103 &` deliver_time               `&  time taken to perform delivery
37104 &` delivery_size              `&  add &`S=`&&'nnn'& to => lines
37105 &`*dkim                       `&  DKIM verified domain on <= lines
37106 &` dkim_verbose               `&  separate full DKIM verification result line, per signature
37107 &`*dnslist_defer              `&  defers of DNS list (aka RBL) lookups
37108 &` dnssec                     `&  DNSSEC secured lookups
37109 &`*etrn                       `&  ETRN commands
37110 &`*host_lookup_failed         `&  as it says
37111 &` ident_timeout              `&  timeout for ident connection
37112 &` incoming_interface         `&  local interface on <= and => lines
37113 &` incoming_port              `&  remote port on <= lines
37114 &`*lost_incoming_connection   `&  as it says (includes timeouts)
37115 &` millisec                   `&  millisecond timestamps and RT,QT,DT,D times
37116 &`*msg_id                     `&  on <= lines, Message-ID: header value
37117 &` msg_id_created             `&  on <= lines, Message-ID: header value when one had to be added
37118 &` outgoing_interface         `&  local interface on => lines
37119 &` outgoing_port              `&  add remote port to => lines
37120 &`*queue_run                  `&  start and end queue runs
37121 &` queue_time                 `&  time on queue for one recipient
37122 &` queue_time_overall         `&  time on queue for whole message
37123 &` pid                        `&  Exim process id
37124 &` pipelining                 `&  PIPELINING use, on <= and => lines
37125 &` proxy                      `&  proxy address on <= and => lines
37126 &` receive_time               `&  time taken to receive message
37127 &` received_recipients        `&  recipients on <= lines
37128 &` received_sender            `&  sender on <= lines
37129 &`*rejected_header            `&  header contents on reject log
37130 &`*retry_defer                `&  &"retry time not reached"&
37131 &` return_path_on_delivery    `&  put return path on => and ** lines
37132 &` sender_on_delivery         `&  add sender to => lines
37133 &`*sender_verify_fail         `&  sender verification failures
37134 &`*size_reject                `&  rejection because too big
37135 &`*skip_delivery              `&  delivery skipped in a queue run
37136 &`*smtp_confirmation          `&  SMTP confirmation on => lines
37137 &` smtp_connection            `&  incoming SMTP connections
37138 &` smtp_incomplete_transaction`&  incomplete SMTP transactions
37139 &` smtp_mailauth              `&  AUTH argument to MAIL commands
37140 &` smtp_no_mail               `&  session with no MAIL commands
37141 &` smtp_protocol_error        `&  SMTP protocol errors
37142 &` smtp_syntax_error          `&  SMTP syntax errors
37143 &` subject                    `&  contents of &'Subject:'& on <= lines
37144 &`*tls_certificate_verified   `&  certificate verification status
37145 &`*tls_cipher                 `&  TLS cipher suite on <= and => lines
37146 &` tls_peerdn                 `&  TLS peer DN on <= and => lines
37147 &` tls_sni                    `&  TLS SNI on <= lines
37148 &` unknown_in_list            `&  DNS lookup failed in list match
37149
37150 &` all                        `&  all of the above
37151 .endd
37152 See also the &%slow_lookup_log%& main configuration option,
37153 section &<<SECID99>>&
37154
37155 More details on each of these items follows:
37156
37157 .ilist
37158 .cindex "8BITMIME"
37159 .cindex "log" "8BITMIME"
37160 &%8bitmime%&: This causes Exim to log any 8BITMIME status of received messages,
37161 which may help in tracking down interoperability issues with ancient MTAs
37162 that are not 8bit clean.  This is added to the &"<="& line, tagged with
37163 &`M8S=`& and a value of &`0`&, &`7`& or &`8`&, corresponding to "not given",
37164 &`7BIT`& and &`8BITMIME`& respectively.
37165 .next
37166 .cindex "&%warn%& ACL verb" "log when skipping"
37167 &%acl_warn_skipped%&: When an ACL &%warn%& statement is skipped because one of
37168 its conditions cannot be evaluated, a log line to this effect is written if
37169 this log selector is set.
37170 .next
37171 .cindex "log" "rewriting"
37172 .cindex "rewriting" "logging"
37173 &%address_rewrite%&: This applies both to global rewrites and per-transport
37174 rewrites, but not to rewrites in filters run as an unprivileged user (because
37175 such users cannot access the log).
37176 .next
37177 .cindex "log" "full parentage"
37178 &%all_parents%&: Normally only the original and final addresses are logged on
37179 delivery lines; with this selector, intermediate parents are given in
37180 parentheses between them.
37181 .next
37182 .cindex "log" "Exim arguments"
37183 .cindex "Exim arguments, logging"
37184 &%arguments%&: This causes Exim to write the arguments with which it was called
37185 to the main log, preceded by the current working directory. This is a debugging
37186 feature, added to make it easier to find out how certain MUAs call
37187 &_/usr/sbin/sendmail_&. The logging does not happen if Exim has given up root
37188 privilege because it was called with the &%-C%& or &%-D%& options. Arguments
37189 that are empty or that contain white space are quoted. Non-printing characters
37190 are shown as escape sequences. This facility cannot log unrecognized arguments,
37191 because the arguments are checked before the configuration file is read. The
37192 only way to log such cases is to interpose a script such as &_util/logargs.sh_&
37193 between the caller and Exim.
37194 .next
37195 .cindex "log" "connection rejections"
37196 &%connection_reject%&: A log entry is written whenever an incoming SMTP
37197 connection is rejected, for whatever reason.
37198 .next
37199 .cindex "log" "delayed delivery"
37200 .cindex "delayed delivery, logging"
37201 &%delay_delivery%&: A log entry is written whenever a delivery process is not
37202 started for an incoming message because the load is too high or too many
37203 messages were received on one connection. Logging does not occur if no delivery
37204 process is started because &%queue_only%& is set or &%-odq%& was used.
37205 .next
37206 .cindex "log" "delivery duration"
37207 &%deliver_time%&: For each delivery, the amount of real time it has taken to
37208 perform the actual delivery is logged as DT=<&'time'&>, for example, &`DT=1s`&.
37209 If millisecond logging is enabled, short times will be shown with greater
37210 precision, eg. &`DT=0.304s`&.
37211 .next
37212 .cindex "log" "message size on delivery"
37213 .cindex "size" "of message"
37214 &%delivery_size%&: For each delivery, the size of message delivered is added to
37215 the &"=>"& line, tagged with S=.
37216 .next
37217 .cindex log "DKIM verification"
37218 .cindex DKIM "verification logging"
37219 &%dkim%&: For message acceptance log lines, when an DKIM signature in the header
37220 verifies successfully a tag of DKIM is added, with one of the verified domains.
37221 .next
37222 .cindex log "DKIM verification"
37223 .cindex DKIM "verification logging"
37224 &%dkim_verbose%&: A log entry is written for each attempted DKIM verification.
37225 .next
37226 .cindex "log" "dnslist defer"
37227 .cindex "DNS list" "logging defer"
37228 .cindex "black list (DNS)"
37229 &%dnslist_defer%&: A log entry is written if an attempt to look up a host in a
37230 DNS black list suffers a temporary error.
37231 .next
37232 .cindex log dnssec
37233 .cindex dnssec logging
37234 &%dnssec%&: For message acceptance and (attempted) delivery log lines, when
37235 dns lookups gave secure results a tag of DS is added.
37236 For acceptance this covers the reverse and forward lookups for host name verification.
37237 It does not cover helo-name verification.
37238 For delivery this covers the SRV, MX, A and/or AAAA lookups.
37239 .next
37240 .cindex "log" "ETRN commands"
37241 .cindex "ETRN" "logging"
37242 &%etrn%&: Every valid ETRN command that is received is logged, before the ACL
37243 is run to determine whether or not it is actually accepted. An invalid ETRN
37244 command, or one received within a message transaction is not logged by this
37245 selector (see &%smtp_syntax_error%& and &%smtp_protocol_error%&).
37246 .next
37247 .cindex "log" "host lookup failure"
37248 &%host_lookup_failed%&: When a lookup of a host's IP addresses fails to find
37249 any addresses, or when a lookup of an IP address fails to find a host name, a
37250 log line is written. This logging does not apply to direct DNS lookups when
37251 routing email addresses, but it does apply to &"byname"& lookups.
37252 .next
37253 .cindex "log" "ident timeout"
37254 .cindex "RFC 1413" "logging timeout"
37255 &%ident_timeout%&: A log line is written whenever an attempt to connect to a
37256 client's ident port times out.
37257 .next
37258 .cindex "log" "incoming interface"
37259 .cindex "log" "local interface"
37260 .cindex "log" "local address and port"
37261 .cindex "TCP/IP" "logging local address and port"
37262 .cindex "interface" "logging"
37263 &%incoming_interface%&: The interface on which a message was received is added
37264 to the &"<="& line as an IP address in square brackets, tagged by I= and
37265 followed by a colon and the port number. The local interface and port are also
37266 added to other SMTP log lines, for example, &"SMTP connection from"&, to
37267 rejection lines, and (despite the name) to outgoing &"=>"& and &"->"& lines.
37268 The latter can be disabled by turning off the &%outgoing_interface%& option.
37269 .next
37270 .cindex log "incoming proxy address"
37271 .cindex proxy "logging proxy address"
37272 .cindex "TCP/IP" "logging proxy address"
37273 &%proxy%&: The internal (closest to the system running Exim) IP address
37274 of the proxy, tagged by PRX=, on the &"<="& line for a message accepted
37275 on a proxied connection
37276 or the &"=>"& line for a message delivered on a proxied connection.
37277 See &<<SECTproxyInbound>>& for more information.
37278 .next
37279 .cindex "log" "incoming remote port"
37280 .cindex "port" "logging remote"
37281 .cindex "TCP/IP" "logging incoming remote port"
37282 .vindex "&$sender_fullhost$&"
37283 .vindex "&$sender_rcvhost$&"
37284 &%incoming_port%&: The remote port number from which a message was received is
37285 added to log entries and &'Received:'& header lines, following the IP address
37286 in square brackets, and separated from it by a colon. This is implemented by
37287 changing the value that is put in the &$sender_fullhost$& and
37288 &$sender_rcvhost$& variables. Recording the remote port number has become more
37289 important with the widening use of NAT (see RFC 2505).
37290 .next
37291 .cindex "log" "dropped connection"
37292 &%lost_incoming_connection%&: A log line is written when an incoming SMTP
37293 connection is unexpectedly dropped.
37294 .next
37295 .cindex "log" "millisecond timestamps"
37296 .cindex millisecond logging
37297 .cindex timestamps "millisecond, in logs"
37298 &%millisec%&: Timestamps have a period and three decimal places of finer granularity
37299 appended to the seconds value.
37300 .next
37301 .new
37302 .cindex "log" "message id"
37303 &%msg_id%&: The value of the Message-ID: header.
37304 .next
37305 &%msg_id_created%&: The value of the Message-ID: header, when one had to be created.
37306 This will be either because the message is a bounce, or was submitted locally
37307 (submission mode) without one.
37308 The field identifier will have an asterix appended: &"id*="&.
37309 .wen
37310 .next
37311 .cindex "log" "outgoing interface"
37312 .cindex "log" "local interface"
37313 .cindex "log" "local address and port"
37314 .cindex "TCP/IP" "logging local address and port"
37315 .cindex "interface" "logging"
37316 &%outgoing_interface%&: If &%incoming_interface%& is turned on, then the
37317 interface on which a message was sent is added to delivery lines as an I= tag
37318 followed by IP address in square brackets. You can disable this by turning
37319 off the &%outgoing_interface%& option.
37320 .next
37321 .cindex "log" "outgoing remote port"
37322 .cindex "port" "logging outgoing remote"
37323 .cindex "TCP/IP" "logging outgoing remote port"
37324 &%outgoing_port%&: The remote port number is added to delivery log lines (those
37325 containing => tags) following the IP address.
37326 The local port is also added if &%incoming_interface%& and
37327 &%outgoing_interface%& are both enabled.
37328 This option is not included in the default setting, because for most ordinary
37329 configurations, the remote port number is always 25 (the SMTP port), and the
37330 local port is a random ephemeral port.
37331 .next
37332 .cindex "log" "process ids in"
37333 .cindex "pid (process id)" "in log lines"
37334 &%pid%&: The current process id is added to every log line, in square brackets,
37335 immediately after the time and date.
37336 .next
37337 .cindex log pipelining
37338 .cindex pipelining "logging outgoing"
37339 &%pipelining%&: A field is added to delivery and accept
37340 log lines when the ESMTP PIPELINING extension was used.
37341 The field is a single "L".
37342
37343 On accept lines, where PIPELINING was offered but not used by the client,
37344 the field has a minus appended.
37345 .next
37346 .cindex "log" "queue run"
37347 .cindex "queue runner" "logging"
37348 &%queue_run%&: The start and end of every queue run are logged.
37349 .next
37350 .cindex "log" "queue time"
37351 &%queue_time%&: The amount of time the message has been in the queue on the
37352 local host is logged as QT=<&'time'&> on delivery (&`=>`&) lines, for example,
37353 &`QT=3m45s`&. The clock starts when Exim starts to receive the message, so it
37354 includes reception time as well as the delivery time for the current address.
37355 This means that it may be longer than the difference between the arrival and
37356 delivery log line times, because the arrival log line is not written until the
37357 message has been successfully received.
37358 If millisecond logging is enabled, short times will be shown with greater
37359 precision, eg. &`QT=1.578s`&.
37360 .next
37361 &%queue_time_overall%&: The amount of time the message has been in the queue on
37362 the local host is logged as QT=<&'time'&> on &"Completed"& lines, for
37363 example, &`QT=3m45s`&. The clock starts when Exim starts to receive the
37364 message, so it includes reception time as well as the total delivery time.
37365 .next
37366 .cindex "log" "receive duration"
37367 &%receive_time%&: For each message, the amount of real time it has taken to
37368 perform the reception is logged as RT=<&'time'&>, for example, &`RT=1s`&.
37369 If millisecond logging is enabled, short times will be shown with greater
37370 precision, eg. &`RT=0.204s`&.
37371 .next
37372 .cindex "log" "recipients"
37373 &%received_recipients%&: The recipients of a message are listed in the main log
37374 as soon as the message is received. The list appears at the end of the log line
37375 that is written when a message is received, preceded by the word &"for"&. The
37376 addresses are listed after they have been qualified, but before any rewriting
37377 has taken place.
37378 Recipients that were discarded by an ACL for MAIL or RCPT do not appear
37379 in the list.
37380 .next
37381 .cindex "log" "sender reception"
37382 &%received_sender%&: The unrewritten original sender of a message is added to
37383 the end of the log line that records the message's arrival, after the word
37384 &"from"& (before the recipients if &%received_recipients%& is also set).
37385 .next
37386 .cindex "log" "header lines for rejection"
37387 &%rejected_header%&: If a message's header has been received at the time a
37388 rejection is written to the reject log, the complete header is added to the
37389 log. Header logging can be turned off individually for messages that are
37390 rejected by the &[local_scan()]& function (see section &<<SECTapiforloc>>&).
37391 .next
37392 .cindex "log" "retry defer"
37393 &%retry_defer%&: A log line is written if a delivery is deferred because a
37394 retry time has not yet been reached. However, this &"retry time not reached"&
37395 message is always omitted from individual message logs after the first delivery
37396 attempt.
37397 .next
37398 .cindex "log" "return path"
37399 &%return_path_on_delivery%&: The return path that is being transmitted with
37400 the message is included in delivery and bounce lines, using the tag P=.
37401 This is omitted if no delivery actually happens, for example, if routing fails,
37402 or if delivery is to &_/dev/null_& or to &`:blackhole:`&.
37403 .next
37404 .cindex "log" "sender on delivery"
37405 &%sender_on_delivery%&: The message's sender address is added to every delivery
37406 and bounce line, tagged by F= (for &"from"&).
37407 This is the original sender that was received with the message; it is not
37408 necessarily the same as the outgoing return path.
37409 .next
37410 .cindex "log" "sender verify failure"
37411 &%sender_verify_fail%&: If this selector is unset, the separate log line that
37412 gives details of a sender verification failure is not written. Log lines for
37413 the rejection of SMTP commands contain just &"sender verify failed"&, so some
37414 detail is lost.
37415 .next
37416 .cindex "log" "size rejection"
37417 &%size_reject%&: A log line is written whenever a message is rejected because
37418 it is too big.
37419 .next
37420 .cindex "log" "frozen messages; skipped"
37421 .cindex "frozen messages" "logging skipping"
37422 &%skip_delivery%&: A log line is written whenever a message is skipped during a
37423 queue run because it is frozen or because another process is already delivering
37424 it.
37425 .cindex "&""spool file is locked""&"
37426 The message that is written is &"spool file is locked"&.
37427 .next
37428 .cindex "log" "smtp confirmation"
37429 .cindex "SMTP" "logging confirmation"
37430 .cindex "LMTP" "logging confirmation"
37431 &%smtp_confirmation%&: The response to the final &"."& in the SMTP or LMTP dialogue for
37432 outgoing messages is added to delivery log lines in the form &`C=`&<&'text'&>.
37433 A number of MTAs (including Exim) return an identifying string in this
37434 response.
37435 .next
37436 .cindex "log" "SMTP connections"
37437 .cindex "SMTP" "logging connections"
37438 &%smtp_connection%&: A log line is written whenever an incoming SMTP connection is
37439 established or closed, unless the connection is from a host that matches
37440 &%hosts_connection_nolog%&. (In contrast, &%lost_incoming_connection%& applies
37441 only when the closure is unexpected.) This applies to connections from local
37442 processes that use &%-bs%& as well as to TCP/IP connections. If a connection is
37443 dropped in the middle of a message, a log line is always written, whether or
37444 not this selector is set, but otherwise nothing is written at the start and end
37445 of connections unless this selector is enabled.
37446
37447 For TCP/IP connections to an Exim daemon, the current number of connections is
37448 included in the log message for each new connection, but note that the count is
37449 reset if the daemon is restarted.
37450 Also, because connections are closed (and the closure is logged) in
37451 subprocesses, the count may not include connections that have been closed but
37452 whose termination the daemon has not yet noticed. Thus, while it is possible to
37453 match up the opening and closing of connections in the log, the value of the
37454 logged counts may not be entirely accurate.
37455 .next
37456 .cindex "log" "SMTP transaction; incomplete"
37457 .cindex "SMTP" "logging incomplete transactions"
37458 &%smtp_incomplete_transaction%&: When a mail transaction is aborted by
37459 RSET, QUIT, loss of connection, or otherwise, the incident is logged,
37460 and the message sender plus any accepted recipients are included in the log
37461 line. This can provide evidence of dictionary attacks.
37462 .next
37463 .cindex "log" "non-MAIL SMTP sessions"
37464 .cindex "MAIL" "logging session without"
37465 &%smtp_no_mail%&: A line is written to the main log whenever an accepted SMTP
37466 connection terminates without having issued a MAIL command. This includes both
37467 the case when the connection is dropped, and the case when QUIT is used. It
37468 does not include cases where the connection is rejected right at the start (by
37469 an ACL, or because there are too many connections, or whatever). These cases
37470 already have their own log lines.
37471
37472 The log line that is written contains the identity of the client in the usual
37473 way, followed by D= and a time, which records the duration of the connection.
37474 If the connection was authenticated, this fact is logged exactly as it is for
37475 an incoming message, with an A= item. If the connection was encrypted, CV=,
37476 DN=, and X= items may appear as they do for an incoming message, controlled by
37477 the same logging options.
37478
37479 Finally, if any SMTP commands were issued during the connection, a C= item
37480 is added to the line, listing the commands that were used. For example,
37481 .code
37482 C=EHLO,QUIT
37483 .endd
37484 shows that the client issued QUIT straight after EHLO. If there were fewer
37485 than 20 commands, they are all listed. If there were more than 20 commands,
37486 the last 20 are listed, preceded by &"..."&. However, with the default
37487 setting of 10 for &%smtp_accept_max_nonmail%&, the connection will in any case
37488 have been aborted before 20 non-mail commands are processed.
37489 .next
37490 &%smtp_mailauth%&: A third subfield with the authenticated sender,
37491 colon-separated, is appended to the A= item for a message arrival or delivery
37492 log line, if an AUTH argument to the SMTP MAIL command (see &<<SECTauthparamail>>&)
37493 was accepted or used.
37494 .next
37495 .cindex "log" "SMTP protocol error"
37496 .cindex "SMTP" "logging protocol error"
37497 &%smtp_protocol_error%&: A log line is written for every SMTP protocol error
37498 encountered. Exim does not have perfect detection of all protocol errors
37499 because of transmission delays and the use of pipelining. If PIPELINING has
37500 been advertised to a client, an Exim server assumes that the client will use
37501 it, and therefore it does not count &"expected"& errors (for example, RCPT
37502 received after rejecting MAIL) as protocol errors.
37503 .next
37504 .cindex "SMTP" "logging syntax errors"
37505 .cindex "SMTP" "syntax errors; logging"
37506 .cindex "SMTP" "unknown command; logging"
37507 .cindex "log" "unknown SMTP command"
37508 .cindex "log" "SMTP syntax error"
37509 &%smtp_syntax_error%&: A log line is written for every SMTP syntax error
37510 encountered. An unrecognized command is treated as a syntax error. For an
37511 external connection, the host identity is given; for an internal connection
37512 using &%-bs%& the sender identification (normally the calling user) is given.
37513 .next
37514 .cindex "log" "subject"
37515 .cindex "subject, logging"
37516 &%subject%&: The subject of the message is added to the arrival log line,
37517 preceded by &"T="& (T for &"topic"&, since S is already used for &"size"&).
37518 Any MIME &"words"& in the subject are decoded. The &%print_topbitchars%& option
37519 specifies whether characters with values greater than 127 should be logged
37520 unchanged, or whether they should be rendered as escape sequences.
37521 .next
37522 .cindex "log" "certificate verification"
37523 .cindex log DANE
37524 .cindex DANE logging
37525 &%tls_certificate_verified%&: An extra item is added to <= and => log lines
37526 when TLS is in use. The item is &`CV=yes`& if the peer's certificate was
37527 verified
37528 using a CA trust anchor,
37529 &`CA=dane`& if using a DNS trust anchor,
37530 and &`CV=no`& if not.
37531 .next
37532 .cindex "log" "TLS cipher"
37533 .cindex "TLS" "logging cipher"
37534 &%tls_cipher%&: When a message is sent or received over an encrypted
37535 connection, the cipher suite used is added to the log line, preceded by X=.
37536 .next
37537 .cindex "log" "TLS peer DN"
37538 .cindex "TLS" "logging peer DN"
37539 &%tls_peerdn%&: When a message is sent or received over an encrypted
37540 connection, and a certificate is supplied by the remote host, the peer DN is
37541 added to the log line, preceded by DN=.
37542 .next
37543 .cindex "log" "TLS SNI"
37544 .cindex "TLS" "logging SNI"
37545 &%tls_sni%&: When a message is received over an encrypted connection, and
37546 the remote host provided the Server Name Indication extension, the SNI is
37547 added to the log line, preceded by SNI=.
37548 .next
37549 .cindex "log" "DNS failure in list"
37550 &%unknown_in_list%&: This setting causes a log entry to be written when the
37551 result of a list match is failure because a DNS lookup failed.
37552 .endlist
37553
37554
37555 .section "Message log" "SECID260"
37556 .cindex "message" "log file for"
37557 .cindex "log" "message log; description of"
37558 .cindex "&_msglog_& directory"
37559 .oindex "&%preserve_message_logs%&"
37560 In addition to the general log files, Exim writes a log file for each message
37561 that it handles. The names of these per-message logs are the message ids, and
37562 they are kept in the &_msglog_& sub-directory of the spool directory. Each
37563 message log contains copies of the log lines that apply to the message. This
37564 makes it easier to inspect the status of an individual message without having
37565 to search the main log. A message log is deleted when processing of the message
37566 is complete, unless &%preserve_message_logs%& is set, but this should be used
37567 only with great care because they can fill up your disk very quickly.
37568
37569 On a heavily loaded system, it may be desirable to disable the use of
37570 per-message logs, in order to reduce disk I/O. This can be done by setting the
37571 &%message_logs%& option false.
37572 .ecindex IIDloggen
37573
37574
37575
37576
37577 . ////////////////////////////////////////////////////////////////////////////
37578 . ////////////////////////////////////////////////////////////////////////////
37579
37580 .chapter "Exim utilities" "CHAPutils"
37581 .scindex IIDutils "utilities"
37582 A number of utility scripts and programs are supplied with Exim and are
37583 described in this chapter. There is also the Exim Monitor, which is covered in
37584 the next chapter. The utilities described here are:
37585
37586 .itable none 0 0 3  7* left  15* left  40* left
37587 .irow &<<SECTfinoutwha>>&     &'exiwhat'&       &&&
37588   "list what Exim processes are doing"
37589 .irow &<<SECTgreptheque>>&    &'exiqgrep'&      "grep the queue"
37590 .irow &<<SECTsumtheque>>&     &'exiqsumm'&      "summarize the queue"
37591 .irow &<<SECTextspeinf>>&     &'exigrep'&       "search the main log"
37592 .irow &<<SECTexipick>>&       &'exipick'&       "select messages on &&&
37593                                                 various criteria"
37594 .irow &<<SECTcyclogfil>>&     &'exicyclog'&     "cycle (rotate) log files"
37595 .irow &<<SECTmailstat>>&      &'eximstats'&     &&&
37596   "extract statistics from the log"
37597 .irow &<<SECTcheckaccess>>&   &'exim_checkaccess'& &&&
37598   "check address acceptance from given IP"
37599 .irow &<<SECTdbmbuild>>&      &'exim_dbmbuild'& "build a DBM file"
37600 .irow &<<SECTfinindret>>&     &'exinext'&       "extract retry information"
37601 .irow &<<SECThindatmai>>&     &'exim_dumpdb'&   "dump a hints database"
37602 .irow &<<SECThindatmai>>&     &'exim_tidydb'&   "clean up a hints database"
37603 .irow &<<SECThindatmai>>&     &'exim_fixdb'&    "patch a hints database"
37604 .irow &<<SECTmailboxmaint>>&  &'exim_lock'&     "lock a mailbox file"
37605 .endtable
37606
37607 Another utility that might be of use to sites with many MTAs is Tom Kistner's
37608 &'exilog'&. It provides log visualizations across multiple Exim servers. See
37609 &url(https://duncanthrax.net/exilog/) for details.
37610
37611
37612
37613
37614 .section "Finding out what Exim processes are doing (exiwhat)" "SECTfinoutwha"
37615 .cindex "&'exiwhat'&"
37616 .cindex "process, querying"
37617 .cindex "SIGUSR1"
37618 On operating systems that can restart a system call after receiving a signal
37619 (most modern OS), an Exim process responds to the SIGUSR1 signal by writing
37620 a line describing what it is doing to the file &_exim-process.info_& in the
37621 Exim spool directory. The &'exiwhat'& script sends the signal to all Exim
37622 processes it can find, having first emptied the file. It then waits for one
37623 second to allow the Exim processes to react before displaying the results. In
37624 order to run &'exiwhat'& successfully you have to have sufficient privilege to
37625 send the signal to the Exim processes, so it is normally run as root.
37626
37627 &*Warning*&: This is not an efficient process. It is intended for occasional
37628 use by system administrators. It is not sensible, for example, to set up a
37629 script that sends SIGUSR1 signals to Exim processes at short intervals.
37630
37631
37632 Unfortunately, the &'ps'& command that &'exiwhat'& uses to find Exim processes
37633 varies in different operating systems. Not only are different options used,
37634 but the format of the output is different. For this reason, there are some
37635 system configuration options that configure exactly how &'exiwhat'& works. If
37636 it doesn't seem to be working for you, check the following compile-time
37637 options:
37638 .display
37639 &`EXIWHAT_PS_CMD    `& the command for running &'ps'&
37640 &`EXIWHAT_PS_ARG    `& the argument for &'ps'&
37641 &`EXIWHAT_EGREP_ARG `& the argument for &'egrep'& to select from &'ps'& output
37642 &`EXIWHAT_KILL_ARG  `& the argument for the &'kill'& command
37643 .endd
37644 An example of typical output from &'exiwhat'& is
37645 .code
37646 164 daemon: -q1h, listening on port 25
37647 10483 running queue: waiting for 0tAycK-0002ij-00 (10492)
37648 10492 delivering 0tAycK-0002ij-00 to mail.ref.example
37649   [10.19.42.42] (editor@ref.example)
37650 10592 handling incoming call from [192.168.243.242]
37651 10628 accepting a local non-SMTP message
37652 .endd
37653 The first number in the output line is the process number. The third line has
37654 been split here, in order to fit it on the page.
37655
37656
37657
37658 .section "Selective queue listing (exiqgrep)" "SECTgreptheque"
37659 .cindex "&'exiqgrep'&"
37660 .cindex "queue" "grepping"
37661 This utility is a Perl script contributed by Matt Hubbard. It runs
37662 .code
37663 exim -bpu
37664 .endd
37665 or (in case &*-a*& switch is specified)
37666 .code
37667 exim -bp
37668 .endd
37669 The &*-C*& option is used to specify an alternate &_exim.conf_& which might
37670 contain alternate exim configuration the queue management might be using.
37671
37672 to obtain a queue listing, and then greps the output to select messages
37673 that match given criteria. The following selection options are available:
37674
37675 .vlist
37676 .vitem &*-f*&&~<&'regex'&>
37677 Match the sender address using a case-insensitive search. The field that is
37678 tested is enclosed in angle brackets, so you can test for bounce messages with
37679 .code
37680 exiqgrep -f '^<>$'
37681 .endd
37682 .vitem &*-r*&&~<&'regex'&>
37683 Match a recipient address using a case-insensitive search. The field that is
37684 tested is not enclosed in angle brackets.
37685
37686 .vitem &*-s*&&~<&'regex'&>
37687 Match against the size field.
37688
37689 .vitem &*-y*&&~<&'seconds'&>
37690 Match messages that are younger than the given time.
37691
37692 .vitem &*-o*&&~<&'seconds'&>
37693 Match messages that are older than the given time.
37694
37695 .vitem &*-z*&
37696 Match only frozen messages.
37697
37698 .vitem &*-x*&
37699 Match only non-frozen messages.
37700 .endlist
37701
37702 The following options control the format of the output:
37703
37704 .vlist
37705 .vitem &*-c*&
37706 Display only the count of matching messages.
37707
37708 .vitem &*-l*&
37709 Long format &-- display the full message information as output by Exim. This is
37710 the default.
37711
37712 .vitem &*-i*&
37713 Display message ids only.
37714
37715 .vitem &*-b*&
37716 Brief format &-- one line per message.
37717
37718 .vitem &*-R*&
37719 Display messages in reverse order.
37720
37721 .vitem &*-a*&
37722 Include delivered recipients in queue listing.
37723 .endlist
37724
37725 There is one more option, &%-h%&, which outputs a list of options.
37726
37727
37728
37729 .section "Summarizing the queue (exiqsumm)" "SECTsumtheque"
37730 .cindex "&'exiqsumm'&"
37731 .cindex "queue" "summary"
37732 The &'exiqsumm'& utility is a Perl script which reads the output of &`exim
37733 -bp`& and produces a summary of the messages in the queue. Thus, you use it by
37734 running a command such as
37735 .code
37736 exim -bp | exiqsumm
37737 .endd
37738 The output consists of one line for each domain that has messages waiting for
37739 it, as in the following example:
37740 .code
37741 3   2322   74m   66m  msn.com.example
37742 .endd
37743 Each line lists the number of pending deliveries for a domain, their total
37744 volume, and the length of time that the oldest and the newest messages have
37745 been waiting. Note that the number of pending deliveries is greater than the
37746 number of messages when messages have more than one recipient.
37747
37748 A summary line is output at the end. By default the output is sorted on the
37749 domain name, but &'exiqsumm'& has the options &%-a%& and &%-c%&, which cause
37750 the output to be sorted by oldest message and by count of messages,
37751 respectively. There are also three options that split the messages for each
37752 domain into two or more subcounts: &%-b%& separates bounce messages, &%-f%&
37753 separates frozen messages, and &%-s%& separates messages according to their
37754 sender.
37755
37756 The output of &'exim -bp'& contains the original addresses in the message, so
37757 this also applies to the output from &'exiqsumm'&. No domains from addresses
37758 generated by aliasing or forwarding are included (unless the &%one_time%&
37759 option of the &(redirect)& router has been used to convert them into &"top
37760 level"& addresses).
37761
37762
37763
37764
37765 .section "Extracting specific information from the log (exigrep)" &&&
37766          "SECTextspeinf"
37767 .cindex "&'exigrep'&"
37768 .cindex "log" "extracts; grepping for"
37769 The &'exigrep'& utility is a Perl script that searches one or more main log
37770 files for entries that match a given pattern. When it finds a match, it
37771 extracts all the log entries for the relevant message, not just those that
37772 match the pattern. Thus, &'exigrep'& can extract complete log entries for a
37773 given message, or all mail for a given user, or for a given host, for example.
37774 The input files can be in Exim log format or syslog format.
37775 If a matching log line is not associated with a specific message, it is
37776 included in &'exigrep'&'s output without any additional lines. The usage is:
37777 .display
37778 &`exigrep [-t<`&&'n'&&`>] [-I] [-l] [-M] [-v] <`&&'pattern'&&`> [<`&&'log file'&&`>] ...`&
37779 .endd
37780 If no log filenames are given on the command line, the standard input is read.
37781
37782 The &%-t%& argument specifies a number of seconds. It adds an additional
37783 condition for message selection. Messages that are complete are shown only if
37784 they spent more than <&'n'&> seconds in the queue.
37785
37786 By default, &'exigrep'& does case-insensitive matching. The &%-I%& option
37787 makes it case-sensitive. This may give a performance improvement when searching
37788 large log files. Without &%-I%&, the Perl pattern matches use Perl's &`/i`&
37789 option; with &%-I%& they do not. In both cases it is possible to change the
37790 case sensitivity within the pattern by using &`(?i)`& or &`(?-i)`&.
37791
37792 The &%-l%& option means &"literal"&, that is, treat all characters in the
37793 pattern as standing for themselves. Otherwise the pattern must be a Perl
37794 regular expression.
37795
37796 The &%-v%& option inverts the matching condition. That is, a line is selected
37797 if it does &'not'& match the pattern.
37798
37799 The &%-M%& options means &"related messages"&. &'exigrep'& will show messages
37800 that are generated as a result/response to a message that &'exigrep'& matched
37801 normally.
37802
37803 Example of &%-M%&:
37804 user_a sends a message to user_b, which generates a bounce back to user_b. If
37805 &'exigrep'& is used to search for &"user_a"&, only the first message will be
37806 displayed.  But if &'exigrep'& is used to search for &"user_b"&, the first and
37807 the second (bounce) message will be displayed. Using &%-M%& with &'exigrep'&
37808 when searching for &"user_a"& will show both messages since the bounce is
37809 &"related"& to or a &"result"& of the first message that was found by the
37810 search term.
37811
37812 If the location of a &'zcat'& command is known from the definition of
37813 ZCAT_COMMAND in &_Local/Makefile_&, &'exigrep'& automatically passes any file
37814 whose name ends in COMPRESS_SUFFIX through &'zcat'& as it searches it.
37815 If the ZCAT_COMMAND is not executable, &'exigrep'& tries to use
37816 autodetection of some well known compression extensions.
37817
37818
37819 .section "Selecting messages by various criteria (exipick)" "SECTexipick"
37820 .cindex "&'exipick'&"
37821 John Jetmore's &'exipick'& utility is included in the Exim distribution. It
37822 lists messages from the queue according to a variety of criteria. For details
37823 of &'exipick'&'s facilities, run &'exipick'& with
37824 the &%--help%& option.
37825
37826
37827 .section "Cycling log files (exicyclog)" "SECTcyclogfil"
37828 .cindex "log" "cycling local files"
37829 .cindex "cycling logs"
37830 .cindex "&'exicyclog'&"
37831 The &'exicyclog'& script can be used to cycle (rotate) &'mainlog'& and
37832 &'rejectlog'& files. This is not necessary if only syslog is being used, or if
37833 you are using log files with datestamps in their names (see section
37834 &<<SECTdatlogfil>>&). Some operating systems have their own standard mechanisms
37835 for log cycling, and these can be used instead of &'exicyclog'& if preferred.
37836 There are two command line options for &'exicyclog'&:
37837 .ilist
37838 &%-k%& <&'count'&> specifies the number of log files to keep, overriding the
37839 default that is set when Exim is built. The default default is 10.
37840 .next
37841 &%-l%& <&'path'&> specifies the log file path, in the same format as Exim's
37842 &%log_file_path%& option (for example, &`/var/log/exim_%slog`&), again
37843 overriding the script's default, which is to find the setting from Exim's
37844 configuration.
37845 .endlist
37846
37847 Each time &'exicyclog'& is run the filenames get &"shuffled down"& by one. If
37848 the main log filename is &_mainlog_& (the default) then when &'exicyclog'& is
37849 run &_mainlog_& becomes &_mainlog.01_&, the previous &_mainlog.01_& becomes
37850 &_mainlog.02_& and so on, up to the limit that is set in the script or by the
37851 &%-k%& option. Log files whose numbers exceed the limit are discarded. Reject
37852 logs are handled similarly.
37853
37854 If the limit is greater than 99, the script uses 3-digit numbers such as
37855 &_mainlog.001_&, &_mainlog.002_&, etc. If you change from a number less than 99
37856 to one that is greater, or &'vice versa'&, you will have to fix the names of
37857 any existing log files.
37858
37859 If no &_mainlog_& file exists, the script does nothing. Files that &"drop off"&
37860 the end are deleted. All files with numbers greater than 01 are compressed,
37861 using a compression command which is configured by the COMPRESS_COMMAND
37862 setting in &_Local/Makefile_&. It is usual to run &'exicyclog'& daily from a
37863 root &%crontab%& entry of the form
37864 .code
37865 1 0 * * * su exim -c /usr/exim/bin/exicyclog
37866 .endd
37867 assuming you have used the name &"exim"& for the Exim user. You can run
37868 &'exicyclog'& as root if you wish, but there is no need.
37869
37870
37871
37872 .section "Mail statistics (eximstats)" "SECTmailstat"
37873 .cindex "statistics"
37874 .cindex "&'eximstats'&"
37875 A Perl script called &'eximstats'& is provided for extracting statistical
37876 information from log files. The output is either plain text, or HTML.
37877 . --- 2018-09-07: LogReport's Lire appears to be dead; website is a Yahoo Japan
37878 . --- 404 error and everything else points to that.
37879
37880 The &'eximstats'& script has been hacked about quite a bit over time. The
37881 latest version is the result of some extensive revision by Steve Campbell. A
37882 lot of information is given by default, but there are options for suppressing
37883 various parts of it. Following any options, the arguments to the script are a
37884 list of files, which should be main log files. For example:
37885 .code
37886 eximstats -nr /var/spool/exim/log/mainlog.01
37887 .endd
37888 By default, &'eximstats'& extracts information about the number and volume of
37889 messages received from or delivered to various hosts. The information is sorted
37890 both by message count and by volume, and the top fifty hosts in each category
37891 are listed on the standard output. Similar information, based on email
37892 addresses or domains instead of hosts can be requested by means of various
37893 options. For messages delivered and received locally, similar statistics are
37894 also produced per user.
37895
37896 The output also includes total counts and statistics about delivery errors, and
37897 histograms showing the number of messages received and deliveries made in each
37898 hour of the day. A delivery with more than one address in its envelope (for
37899 example, an SMTP transaction with more than one RCPT command) is counted
37900 as a single delivery by &'eximstats'&.
37901
37902 Though normally more deliveries than receipts are reported (as messages may
37903 have multiple recipients), it is possible for &'eximstats'& to report more
37904 messages received than delivered, even though the queue is empty at the start
37905 and end of the period in question. If an incoming message contains no valid
37906 recipients, no deliveries are recorded for it. A bounce message is handled as
37907 an entirely separate message.
37908
37909 &'eximstats'& always outputs a grand total summary giving the volume and number
37910 of messages received and deliveries made, and the number of hosts involved in
37911 each case. It also outputs the number of messages that were delayed (that is,
37912 not completely delivered at the first attempt), and the number that had at
37913 least one address that failed.
37914
37915 The remainder of the output is in sections that can be independently disabled
37916 or modified by various options. It consists of a summary of deliveries by
37917 transport, histograms of messages received and delivered per time interval
37918 (default per hour), information about the time messages spent in the queue,
37919 a list of relayed messages, lists of the top fifty sending hosts, local
37920 senders, destination hosts, and destination local users by count and by volume,
37921 and a list of delivery errors that occurred.
37922
37923 The relay information lists messages that were actually relayed, that is, they
37924 came from a remote host and were directly delivered to some other remote host,
37925 without being processed (for example, for aliasing or forwarding) locally.
37926
37927 There are quite a few options for &'eximstats'& to control exactly what it
37928 outputs. These are documented in the Perl script itself, and can be extracted
37929 by running the command &(perldoc)& on the script. For example:
37930 .code
37931 perldoc /usr/exim/bin/eximstats
37932 .endd
37933
37934 .section "Checking access policy (exim_checkaccess)" "SECTcheckaccess"
37935 .cindex "&'exim_checkaccess'&"
37936 .cindex "policy control" "checking access"
37937 .cindex "checking access"
37938 The &%-bh%& command line argument allows you to run a fake SMTP session with
37939 debugging output, in order to check what Exim is doing when it is applying
37940 policy controls to incoming SMTP mail. However, not everybody is sufficiently
37941 familiar with the SMTP protocol to be able to make full use of &%-bh%&, and
37942 sometimes you just want to answer the question &"Does this address have
37943 access?"& without bothering with any further details.
37944
37945 The &'exim_checkaccess'& utility is a &"packaged"& version of &%-bh%&. It takes
37946 two arguments, an IP address and an email address:
37947 .code
37948 exim_checkaccess 10.9.8.7 A.User@a.domain.example
37949 .endd
37950 The utility runs a call to Exim with the &%-bh%& option, to test whether the
37951 given email address would be accepted in a RCPT command in a TCP/IP
37952 connection from the host with the given IP address. The output of the utility
37953 is either the word &"accepted"&, or the SMTP error response, for example:
37954 .code
37955 Rejected:
37956 550 Relay not permitted
37957 .endd
37958 When running this test, the utility uses &`<>`& as the envelope sender address
37959 for the MAIL command, but you can change this by providing additional
37960 options. These are passed directly to the Exim command. For example, to specify
37961 that the test is to be run with the sender address &'himself@there.example'&
37962 you can use:
37963 .code
37964 exim_checkaccess 10.9.8.7 A.User@a.domain.example \
37965                  -f himself@there.example
37966 .endd
37967 Note that these additional Exim command line items must be given after the two
37968 mandatory arguments.
37969
37970 Because the &%exim_checkaccess%& uses &%-bh%&, it does not perform callouts
37971 while running its checks. You can run checks that include callouts by using
37972 &%-bhc%&, but this is not yet available in a &"packaged"& form.
37973
37974
37975
37976 .section "Making DBM files (exim_dbmbuild)" "SECTdbmbuild"
37977 .cindex "DBM" "building dbm files"
37978 .cindex "building DBM files"
37979 .cindex "&'exim_dbmbuild'&"
37980 .cindex "lower casing"
37981 .cindex "binary zero" "in lookup key"
37982 The &'exim_dbmbuild'& program reads an input file containing keys and data in
37983 the format used by the &(lsearch)& lookup (see section
37984 &<<SECTsinglekeylookups>>&). It writes a DBM file using the lower-cased alias
37985 names as keys and the remainder of the information as data. The lower-casing
37986 can be prevented by calling the program with the &%-nolc%& option.
37987
37988 A terminating zero is included as part of the key string. This is expected by
37989 the &(dbm)& lookup type. However, if the option &%-nozero%& is given,
37990 &'exim_dbmbuild'& creates files without terminating zeroes in either the key
37991 strings or the data strings. The &(dbmnz)& lookup type can be used with such
37992 files.
37993
37994 The program requires two arguments: the name of the input file (which can be a
37995 single hyphen to indicate the standard input), and the name of the output file.
37996 It creates the output under a temporary name, and then renames it if all went
37997 well.
37998
37999 .cindex "USE_DB"
38000 If the native DB interface is in use (USE_DB is set in a compile-time
38001 configuration file &-- this is common in free versions of Unix) the two
38002 filenames must be different, because in this mode the Berkeley DB functions
38003 create a single output file using exactly the name given. For example,
38004 .code
38005 exim_dbmbuild /etc/aliases /etc/aliases.db
38006 .endd
38007 reads the system alias file and creates a DBM version of it in
38008 &_/etc/aliases.db_&.
38009
38010 In systems that use the &'ndbm'& routines (mostly proprietary versions of
38011 Unix), two files are used, with the suffixes &_.dir_& and &_.pag_&. In this
38012 environment, the suffixes are added to the second argument of
38013 &'exim_dbmbuild'&, so it can be the same as the first. This is also the case
38014 when the Berkeley functions are used in compatibility mode (though this is not
38015 recommended), because in that case it adds a &_.db_& suffix to the filename.
38016
38017 If a duplicate key is encountered, the program outputs a warning, and when it
38018 finishes, its return code is 1 rather than zero, unless the &%-noduperr%&
38019 option is used. By default, only the first of a set of duplicates is used &--
38020 this makes it compatible with &(lsearch)& lookups. There is an option
38021 &%-lastdup%& which causes it to use the data for the last duplicate instead.
38022 There is also an option &%-nowarn%&, which stops it listing duplicate keys to
38023 &%stderr%&. For other errors, where it doesn't actually make a new file, the
38024 return code is 2.
38025
38026
38027
38028
38029 .section "Finding individual retry times (exinext)" "SECTfinindret"
38030 .cindex "retry" "times"
38031 .cindex "&'exinext'&"
38032 A utility called &'exinext'& (mostly a Perl script) provides the ability to
38033 fish specific information out of the retry database. Given a mail domain (or a
38034 complete address), it looks up the hosts for that domain, and outputs any retry
38035 information for the hosts or for the domain. At present, the retry information
38036 is obtained by running &'exim_dumpdb'& (see below) and post-processing the
38037 output. For example:
38038 .code
38039 $ exinext piglet@milne.fict.example
38040 kanga.milne.example:192.168.8.1 error 146: Connection refused
38041   first failed: 21-Feb-1996 14:57:34
38042   last tried:   21-Feb-1996 14:57:34
38043   next try at:  21-Feb-1996 15:02:34
38044 roo.milne.example:192.168.8.3 error 146: Connection refused
38045   first failed: 20-Jan-1996 13:12:08
38046   last tried:   21-Feb-1996 11:42:03
38047   next try at:  21-Feb-1996 19:42:03
38048   past final cutoff time
38049 .endd
38050 You can also give &'exinext'& a local part, without a domain, and it
38051 will give any retry information for that local part in your default domain.
38052 A message id can be used to obtain retry information pertaining to a specific
38053 message. This exists only when an attempt to deliver a message to a remote host
38054 suffers a message-specific error (see section &<<SECToutSMTPerr>>&).
38055 &'exinext'& is not particularly efficient, but then it is not expected to be
38056 run very often.
38057
38058 The &'exinext'& utility calls Exim to find out information such as the location
38059 of the spool directory. The utility has &%-C%& and &%-D%& options, which are
38060 passed on to the &'exim'& commands. The first specifies an alternate Exim
38061 configuration file, and the second sets macros for use within the configuration
38062 file. These features are mainly to help in testing, but might also be useful in
38063 environments where more than one configuration file is in use.
38064
38065
38066
38067 .section "Hints database maintenance" "SECThindatmai"
38068 .cindex "hints database" "maintenance"
38069 .cindex "maintaining Exim's hints database"
38070 Three utility programs are provided for maintaining the DBM files that Exim
38071 uses to contain its delivery hint information. Each program requires two
38072 arguments. The first specifies the name of Exim's spool directory, and the
38073 second is the name of the database it is to operate on. These are as follows:
38074
38075 .ilist
38076 &'retry'&: the database of retry information
38077 .next
38078 &'wait-'&<&'transport name'&>: databases of information about messages waiting
38079 for remote hosts
38080 .next
38081 &'callout'&: the callout cache
38082 .next
38083 &'ratelimit'&: the data for implementing the ratelimit ACL condition
38084 .next
38085 &'misc'&: other hints data
38086 .endlist
38087
38088 The &'misc'& database is used for
38089
38090 .ilist
38091 Serializing ETRN runs (when &%smtp_etrn_serialize%& is set)
38092 .next
38093 Serializing delivery to a specific host (when &%serialize_hosts%& is set in an
38094 &(smtp)& transport)
38095 .next
38096 Limiting the concurrency of specific transports (when &%max_parallel%& is set
38097 in a transport)
38098 .endlist
38099
38100
38101
38102 .section "exim_dumpdb" "SECID261"
38103 .cindex "&'exim_dumpdb'&"
38104 The entire contents of a database are written to the standard output by the
38105 &'exim_dumpdb'& program, which has no options or arguments other than the
38106 spool and database names. For example, to dump the retry database:
38107 .code
38108 exim_dumpdb /var/spool/exim retry
38109 .endd
38110 Two lines of output are produced for each entry:
38111 .code
38112 T:mail.ref.example:192.168.242.242 146 77 Connection refused
38113 31-Oct-1995 12:00:12 02-Nov-1995 12:21:39 02-Nov-1995 20:21:39 *
38114 .endd
38115 The first item on the first line is the key of the record. It starts with one
38116 of the letters R, or T, depending on whether it refers to a routing or
38117 transport retry. For a local delivery, the next part is the local address; for
38118 a remote delivery it is the name of the remote host, followed by its failing IP
38119 address (unless &%retry_include_ip_address%& is set false on the &(smtp)&
38120 transport). If the remote port is not the standard one (port 25), it is added
38121 to the IP address. Then there follows an error code, an additional error code,
38122 and a textual description of the error.
38123
38124 The three times on the second line are the time of first failure, the time of
38125 the last delivery attempt, and the computed time for the next attempt. The line
38126 ends with an asterisk if the cutoff time for the last retry rule has been
38127 exceeded.
38128
38129 Each output line from &'exim_dumpdb'& for the &'wait-xxx'& databases
38130 consists of a host name followed by a list of ids for messages that are or were
38131 waiting to be delivered to that host. If there are a very large number for any
38132 one host, continuation records, with a sequence number added to the host name,
38133 may be seen. The data in these records is often out of date, because a message
38134 may be routed to several alternative hosts, and Exim makes no effort to keep
38135 cross-references.
38136
38137
38138
38139 .section "exim_tidydb" "SECID262"
38140 .cindex "&'exim_tidydb'&"
38141 The &'exim_tidydb'& utility program is used to tidy up the contents of a hints
38142 database. If run with no options, it removes all records that are more than 30
38143 days old. The age is calculated from the date and time that the record was last
38144 updated. Note that, in the case of the retry database, it is &'not'& the time
38145 since the first delivery failure. Information about a host that has been down
38146 for more than 30 days will remain in the database, provided that the record is
38147 updated sufficiently often.
38148
38149 The cutoff date can be altered by means of the &%-t%& option, which must be
38150 followed by a time. For example, to remove all records older than a week from
38151 the retry database:
38152 .code
38153 exim_tidydb -t 7d /var/spool/exim retry
38154 .endd
38155 Both the &'wait-xxx'& and &'retry'& databases contain items that involve
38156 message ids. In the former these appear as data in records keyed by host &--
38157 they were messages that were waiting for that host &-- and in the latter they
38158 are the keys for retry information for messages that have suffered certain
38159 types of error. When &'exim_tidydb'& is run, a check is made to ensure that
38160 message ids in database records are those of messages that are still on the
38161 queue. Message ids for messages that no longer exist are removed from
38162 &'wait-xxx'& records, and if this leaves any records empty, they are deleted.
38163 For the &'retry'& database, records whose keys are non-existent message ids are
38164 removed. The &'exim_tidydb'& utility outputs comments on the standard output
38165 whenever it removes information from the database.
38166
38167 Certain records are automatically removed by Exim when they are no longer
38168 needed, but others are not. For example, if all the MX hosts for a domain are
38169 down, a retry record is created for each one. If the primary MX host comes back
38170 first, its record is removed when Exim successfully delivers to it, but the
38171 records for the others remain because Exim has not tried to use those hosts.
38172
38173 It is important, therefore, to run &'exim_tidydb'& periodically on all the
38174 hints databases. You should do this at a quiet time of day, because it requires
38175 a database to be locked (and therefore inaccessible to Exim) while it does its
38176 work. Removing records from a DBM file does not normally make the file smaller,
38177 but all the common DBM libraries are able to re-use the space that is released.
38178 After an initial phase of increasing in size, the databases normally reach a
38179 point at which they no longer get any bigger, as long as they are regularly
38180 tidied.
38181
38182 &*Warning*&: If you never run &'exim_tidydb'&, the space used by the hints
38183 databases is likely to keep on increasing.
38184
38185
38186
38187
38188 .section "exim_fixdb" "SECID263"
38189 .cindex "&'exim_fixdb'&"
38190 The &'exim_fixdb'& program is a utility for interactively modifying databases.
38191 Its main use is for testing Exim, but it might also be occasionally useful for
38192 getting round problems in a live system. It has no options, and its interface
38193 is somewhat crude. On entry, it prompts for input with a right angle-bracket. A
38194 key of a database record can then be entered, and the data for that record is
38195 displayed.
38196
38197 If &"d"& is typed at the next prompt, the entire record is deleted. For all
38198 except the &'retry'& database, that is the only operation that can be carried
38199 out. For the &'retry'& database, each field is output preceded by a number, and
38200 data for individual fields can be changed by typing the field number followed
38201 by new data, for example:
38202 .code
38203 > 4 951102:1000
38204 .endd
38205 resets the time of the next delivery attempt. Time values are given as a
38206 sequence of digit pairs for year, month, day, hour, and minute. Colons can be
38207 used as optional separators.
38208
38209
38210
38211
38212 .section "Mailbox maintenance (exim_lock)" "SECTmailboxmaint"
38213 .cindex "mailbox" "maintenance"
38214 .cindex "&'exim_lock'&"
38215 .cindex "locking mailboxes"
38216 The &'exim_lock'& utility locks a mailbox file using the same algorithm as
38217 Exim. For a discussion of locking issues, see section &<<SECTopappend>>&.
38218 &'Exim_lock'& can be used to prevent any modification of a mailbox by Exim or
38219 a user agent while investigating a problem. The utility requires the name of
38220 the file as its first argument. If the locking is successful, the second
38221 argument is run as a command (using C's &[system()]& function); if there is no
38222 second argument, the value of the SHELL environment variable is used; if this
38223 is unset or empty, &_/bin/sh_& is run. When the command finishes, the mailbox
38224 is unlocked and the utility ends. The following options are available:
38225
38226 .vlist
38227 .vitem &%-fcntl%&
38228 Use &[fcntl()]& locking on the open mailbox.
38229
38230 .vitem &%-flock%&
38231 Use &[flock()]& locking on the open mailbox, provided the operating system
38232 supports it.
38233
38234 .vitem &%-interval%&
38235 This must be followed by a number, which is a number of seconds; it sets the
38236 interval to sleep between retries (default 3).
38237
38238 .vitem &%-lockfile%&
38239 Create a lock file before opening the mailbox.
38240
38241 .vitem &%-mbx%&
38242 Lock the mailbox using MBX rules.
38243
38244 .vitem &%-q%&
38245 Suppress verification output.
38246
38247 .vitem &%-retries%&
38248 This must be followed by a number; it sets the number of times to try to get
38249 the lock (default 10).
38250
38251 .vitem &%-restore_time%&
38252 This option causes &%exim_lock%& to restore the modified and read times to the
38253 locked file before exiting. This allows you to access a locked mailbox (for
38254 example, to take a backup copy) without disturbing the times that the user
38255 subsequently sees.
38256
38257 .vitem &%-timeout%&
38258 This must be followed by a number, which is a number of seconds; it sets a
38259 timeout to be used with a blocking &[fcntl()]& lock. If it is not set (the
38260 default), a non-blocking call is used.
38261
38262 .vitem &%-v%&
38263 Generate verbose output.
38264 .endlist
38265
38266 If none of &%-fcntl%&, &%-flock%&, &%-lockfile%& or &%-mbx%& are given, the
38267 default is to create a lock file and also to use &[fcntl()]& locking on the
38268 mailbox, which is the same as Exim's default. The use of &%-flock%& or
38269 &%-fcntl%& requires that the file be writeable; the use of &%-lockfile%&
38270 requires that the directory containing the file be writeable. Locking by lock
38271 file does not last forever; Exim assumes that a lock file is expired if it is
38272 more than 30 minutes old.
38273
38274 The &%-mbx%& option can be used with either or both of &%-fcntl%& or
38275 &%-flock%&. It assumes &%-fcntl%& by default. MBX locking causes a shared lock
38276 to be taken out on the open mailbox, and an exclusive lock on the file
38277 &_/tmp/.n.m_& where &'n'& and &'m'& are the device number and inode
38278 number of the mailbox file. When the locking is released, if an exclusive lock
38279 can be obtained for the mailbox, the file in &_/tmp_& is deleted.
38280
38281 The default output contains verification of the locking that takes place. The
38282 &%-v%& option causes some additional information to be given. The &%-q%& option
38283 suppresses all output except error messages.
38284
38285 A command such as
38286 .code
38287 exim_lock /var/spool/mail/spqr
38288 .endd
38289 runs an interactive shell while the file is locked, whereas
38290 .display
38291 &`exim_lock -q /var/spool/mail/spqr <<End`&
38292 <&'some commands'&>
38293 &`End`&
38294 .endd
38295 runs a specific non-interactive sequence of commands while the file is locked,
38296 suppressing all verification output. A single command can be run by a command
38297 such as
38298 .code
38299 exim_lock -q /var/spool/mail/spqr \
38300   "cp /var/spool/mail/spqr /some/where"
38301 .endd
38302 Note that if a command is supplied, it must be entirely contained within the
38303 second argument &-- hence the quotes.
38304 .ecindex IIDutils
38305
38306
38307 . ////////////////////////////////////////////////////////////////////////////
38308 . ////////////////////////////////////////////////////////////////////////////
38309
38310 .chapter "The Exim monitor" "CHAPeximon"
38311 .scindex IIDeximon "Exim monitor" "description"
38312 .cindex "X-windows"
38313 .cindex "&'eximon'&"
38314 .cindex "Local/eximon.conf"
38315 .cindex "&_exim_monitor/EDITME_&"
38316 The Exim monitor is an application which displays in an X window information
38317 about the state of Exim's queue and what Exim is doing. An admin user can
38318 perform certain operations on messages from this GUI interface; however all
38319 such facilities are also available from the command line, and indeed, the
38320 monitor itself makes use of the command line to perform any actions requested.
38321
38322
38323
38324 .section "Running the monitor" "SECID264"
38325 The monitor is started by running the script called &'eximon'&. This is a shell
38326 script that sets up a number of environment variables, and then runs the
38327 binary called &_eximon.bin_&. The default appearance of the monitor window can
38328 be changed by editing the &_Local/eximon.conf_& file created by editing
38329 &_exim_monitor/EDITME_&. Comments in that file describe what the various
38330 parameters are for.
38331
38332 The parameters that get built into the &'eximon'& script can be overridden for
38333 a particular invocation by setting up environment variables of the same names,
38334 preceded by &`EXIMON_`&. For example, a shell command such as
38335 .code
38336 EXIMON_LOG_DEPTH=400 eximon
38337 .endd
38338 (in a Bourne-compatible shell) runs &'eximon'& with an overriding setting of
38339 the LOG_DEPTH parameter. If EXIMON_LOG_FILE_PATH is set in the environment, it
38340 overrides the Exim log file configuration. This makes it possible to have
38341 &'eximon'& tailing log data that is written to syslog, provided that MAIL.INFO
38342 syslog messages are routed to a file on the local host.
38343
38344 X resources can be used to change the appearance of the window in the normal
38345 way. For example, a resource setting of the form
38346 .code
38347 Eximon*background: gray94
38348 .endd
38349 changes the colour of the background to light grey rather than white. The
38350 stripcharts are drawn with both the data lines and the reference lines in
38351 black. This means that the reference lines are not visible when on top of the
38352 data. However, their colour can be changed by setting a resource called
38353 &"highlight"& (an odd name, but that's what the Athena stripchart widget uses).
38354 For example, if your X server is running Unix, you could set up lighter
38355 reference lines in the stripcharts by obeying
38356 .code
38357 xrdb -merge <<End
38358 Eximon*highlight: gray
38359 End
38360 .endd
38361 .cindex "admin user"
38362 In order to see the contents of messages in the queue, and to operate on them,
38363 &'eximon'& must either be run as root or by an admin user.
38364
38365 The command-line parameters of &'eximon'& are passed to &_eximon.bin_& and may
38366 contain X11 resource parameters interpreted by the X11 library.  In addition,
38367 if the first parameter starts with the string "gdb" then it is removed and the
38368 binary is invoked under gdb (the parameter is used as the gdb command-name, so
38369 versioned variants of gdb can be invoked).
38370
38371 The monitor's window is divided into three parts. The first contains one or
38372 more stripcharts and two action buttons, the second contains a &"tail"& of the
38373 main log file, and the third is a display of the queue of messages awaiting
38374 delivery, with two more action buttons. The following sections describe these
38375 different parts of the display.
38376
38377
38378
38379
38380 .section "The stripcharts" "SECID265"
38381 .cindex "stripchart"
38382 The first stripchart is always a count of messages in the queue. Its name can
38383 be configured by setting QUEUE_STRIPCHART_NAME in the
38384 &_Local/eximon.conf_& file. The remaining stripcharts are defined in the
38385 configuration script by regular expression matches on log file entries, making
38386 it possible to display, for example, counts of messages delivered to certain
38387 hosts or using certain transports. The supplied defaults display counts of
38388 received and delivered messages, and of local and SMTP deliveries. The default
38389 period between stripchart updates is one minute; this can be adjusted by a
38390 parameter in the &_Local/eximon.conf_& file.
38391
38392 The stripchart displays rescale themselves automatically as the value they are
38393 displaying changes. There are always 10 horizontal lines in each chart; the
38394 title string indicates the value of each division when it is greater than one.
38395 For example, &"x2"& means that each division represents a value of 2.
38396
38397 It is also possible to have a stripchart which shows the percentage fullness of
38398 a particular disk partition, which is useful when local deliveries are confined
38399 to a single partition.
38400
38401 .cindex "&%statvfs%& function"
38402 This relies on the availability of the &[statvfs()]& function or equivalent in
38403 the operating system. Most, but not all versions of Unix that support Exim have
38404 this. For this particular stripchart, the top of the chart always represents
38405 100%, and the scale is given as &"x10%"&. This chart is configured by setting
38406 SIZE_STRIPCHART and (optionally) SIZE_STRIPCHART_NAME in the
38407 &_Local/eximon.conf_& file.
38408
38409
38410
38411
38412 .section "Main action buttons" "SECID266"
38413 .cindex "size" "of monitor window"
38414 .cindex "Exim monitor" "window size"
38415 .cindex "window size"
38416 Below the stripcharts there is an action button for quitting the monitor. Next
38417 to this is another button marked &"Size"&. They are placed here so that
38418 shrinking the window to its default minimum size leaves just the queue count
38419 stripchart and these two buttons visible. Pressing the &"Size"& button causes
38420 the window to expand to its maximum size, unless it is already at the maximum,
38421 in which case it is reduced to its minimum.
38422
38423 When expanding to the maximum, if the window cannot be fully seen where it
38424 currently is, it is moved back to where it was the last time it was at full
38425 size. When it is expanding from its minimum size, the old position is
38426 remembered, and next time it is reduced to the minimum it is moved back there.
38427
38428 The idea is that you can keep a reduced window just showing one or two
38429 stripcharts at a convenient place on your screen, easily expand it to show
38430 the full window when required, and just as easily put it back to what it was.
38431 The idea is copied from what the &'twm'& window manager does for its
38432 &'f.fullzoom'& action. The minimum size of the window can be changed by setting
38433 the MIN_HEIGHT and MIN_WIDTH values in &_Local/eximon.conf_&.
38434
38435 Normally, the monitor starts up with the window at its full size, but it can be
38436 built so that it starts up with the window at its smallest size, by setting
38437 START_SMALL=yes in &_Local/eximon.conf_&.
38438
38439
38440
38441 .section "The log display" "SECID267"
38442 .cindex "log" "tail of; in monitor"
38443 The second section of the window is an area in which a display of the tail of
38444 the main log is maintained.
38445 To save space on the screen, the timestamp on each log line is shortened by
38446 removing the date and, if &%log_timezone%& is set, the timezone.
38447 The log tail is not available when the only destination for logging data is
38448 syslog, unless the syslog lines are routed to a local file whose name is passed
38449 to &'eximon'& via the EXIMON_LOG_FILE_PATH environment variable.
38450
38451 The log sub-window has a scroll bar at its lefthand side which can be used to
38452 move back to look at earlier text, and the up and down arrow keys also have a
38453 scrolling effect. The amount of log that is kept depends on the setting of
38454 LOG_BUFFER in &_Local/eximon.conf_&, which specifies the amount of memory
38455 to use. When this is full, the earlier 50% of data is discarded &-- this is
38456 much more efficient than throwing it away line by line. The sub-window also has
38457 a horizontal scroll bar for accessing the ends of long log lines. This is the
38458 only means of horizontal scrolling; the right and left arrow keys are not
38459 available. Text can be cut from this part of the window using the mouse in the
38460 normal way. The size of this subwindow is controlled by parameters in the
38461 configuration file &_Local/eximon.conf_&.
38462
38463 Searches of the text in the log window can be carried out by means of the ^R
38464 and ^S keystrokes, which default to a reverse and a forward search,
38465 respectively. The search covers only the text that is displayed in the window.
38466 It cannot go further back up the log.
38467
38468 The point from which the search starts is indicated by a caret marker. This is
38469 normally at the end of the text in the window, but can be positioned explicitly
38470 by pointing and clicking with the left mouse button, and is moved automatically
38471 by a successful search. If new text arrives in the window when it is scrolled
38472 back, the caret remains where it is, but if the window is not scrolled back,
38473 the caret is moved to the end of the new text.
38474
38475 Pressing ^R or ^S pops up a window into which the search text can be typed.
38476 There are buttons for selecting forward or reverse searching, for carrying out
38477 the search, and for cancelling. If the &"Search"& button is pressed, the search
38478 happens and the window remains so that further searches can be done. If the
38479 &"Return"& key is pressed, a single search is done and the window is closed. If
38480 ^C is typed the search is cancelled.
38481
38482 The searching facility is implemented using the facilities of the Athena text
38483 widget. By default this pops up a window containing both &"search"& and
38484 &"replace"& options. In order to suppress the unwanted &"replace"& portion for
38485 eximon, a modified version of the &%TextPop%& widget is distributed with Exim.
38486 However, the linkers in BSDI and HP-UX seem unable to handle an externally
38487 provided version of &%TextPop%& when the remaining parts of the text widget
38488 come from the standard libraries. The compile-time option EXIMON_TEXTPOP can be
38489 unset to cut out the modified &%TextPop%&, making it possible to build Eximon
38490 on these systems, at the expense of having unwanted items in the search popup
38491 window.
38492
38493
38494
38495 .section "The queue display" "SECID268"
38496 .cindex "queue" "display in monitor"
38497 The bottom section of the monitor window contains a list of all messages that
38498 are in the queue, which includes those currently being received or delivered,
38499 as well as those awaiting delivery. The size of this subwindow is controlled by
38500 parameters in the configuration file &_Local/eximon.conf_&, and the frequency
38501 at which it is updated is controlled by another parameter in the same file &--
38502 the default is 5 minutes, since queue scans can be quite expensive. However,
38503 there is an &"Update"& action button just above the display which can be used
38504 to force an update of the queue display at any time.
38505
38506 When a host is down for some time, a lot of pending mail can build up for it,
38507 and this can make it hard to deal with other messages in the queue. To help
38508 with this situation there is a button next to &"Update"& called &"Hide"&. If
38509 pressed, a dialogue box called &"Hide addresses ending with"& is put up. If you
38510 type anything in here and press &"Return"&, the text is added to a chain of
38511 such texts, and if every undelivered address in a message matches at least one
38512 of the texts, the message is not displayed.
38513
38514 If there is an address that does not match any of the texts, all the addresses
38515 are displayed as normal. The matching happens on the ends of addresses so, for
38516 example, &'cam.ac.uk'& specifies all addresses in Cambridge, while
38517 &'xxx@foo.com.example'& specifies just one specific address. When any hiding
38518 has been set up, a button called &"Unhide"& is displayed. If pressed, it
38519 cancels all hiding. Also, to ensure that hidden messages do not get forgotten,
38520 a hide request is automatically cancelled after one hour.
38521
38522 While the dialogue box is displayed, you can't press any buttons or do anything
38523 else to the monitor window. For this reason, if you want to cut text from the
38524 queue display to use in the dialogue box, you have to do the cutting before
38525 pressing the &"Hide"& button.
38526
38527 The queue display contains, for each unhidden queued message, the length of
38528 time it has been in the queue, the size of the message, the message id, the
38529 message sender, and the first undelivered recipient, all on one line. If it is
38530 a bounce message, the sender is shown as &"<>"&. If there is more than one
38531 recipient to which the message has not yet been delivered, subsequent ones are
38532 listed on additional lines, up to a maximum configured number, following which
38533 an ellipsis is displayed. Recipients that have already received the message are
38534 not shown.
38535
38536 .cindex "frozen messages" "display"
38537 If a message is frozen, an asterisk is displayed at the left-hand side.
38538
38539 The queue display has a vertical scroll bar, and can also be scrolled by means
38540 of the arrow keys. Text can be cut from it using the mouse in the normal way.
38541 The text searching facilities, as described above for the log window, are also
38542 available, but the caret is always moved to the end of the text when the queue
38543 display is updated.
38544
38545
38546
38547 .section "The queue menu" "SECID269"
38548 .cindex "queue" "menu in monitor"
38549 If the &%shift%& key is held down and the left button is clicked when the mouse
38550 pointer is over the text for any message, an action menu pops up, and the first
38551 line of the queue display for the message is highlighted. This does not affect
38552 any selected text.
38553
38554 If you want to use some other event for popping up the menu, you can set the
38555 MENU_EVENT parameter in &_Local/eximon.conf_& to change the default, or
38556 set EXIMON_MENU_EVENT in the environment before starting the monitor. The
38557 value set in this parameter is a standard X event description. For example, to
38558 run eximon using &%ctrl%& rather than &%shift%& you could use
38559 .code
38560 EXIMON_MENU_EVENT='Ctrl<Btn1Down>' eximon
38561 .endd
38562 The title of the menu is the message id, and it contains entries which act as
38563 follows:
38564
38565 .ilist
38566 &'message log'&: The contents of the message log for the message are displayed
38567 in a new text window.
38568 .next
38569 &'headers'&: Information from the spool file that contains the envelope
38570 information and headers is displayed in a new text window. See chapter
38571 &<<CHAPspool>>& for a description of the format of spool files.
38572 .next
38573 &'body'&: The contents of the spool file containing the body of the message are
38574 displayed in a new text window. There is a default limit of 20,000 bytes to the
38575 amount of data displayed. This can be changed by setting the BODY_MAX
38576 option at compile time, or the EXIMON_BODY_MAX option at runtime.
38577 .next
38578 &'deliver message'&: A call to Exim is made using the &%-M%& option to request
38579 delivery of the message. This causes an automatic thaw if the message is
38580 frozen. The &%-v%& option is also set, and the output from Exim is displayed in
38581 a new text window. The delivery is run in a separate process, to avoid holding
38582 up the monitor while the delivery proceeds.
38583 .next
38584 &'freeze message'&: A call to Exim is made using the &%-Mf%& option to request
38585 that the message be frozen.
38586 .next
38587 .cindex "thawing messages"
38588 .cindex "unfreezing messages"
38589 .cindex "frozen messages" "thawing"
38590 &'thaw message'&: A call to Exim is made using the &%-Mt%& option to request
38591 that the message be thawed.
38592 .next
38593 .cindex "delivery" "forcing failure"
38594 &'give up on msg'&: A call to Exim is made using the &%-Mg%& option to request
38595 that Exim gives up trying to deliver the message. A bounce message is generated
38596 for any remaining undelivered addresses.
38597 .next
38598 &'remove message'&: A call to Exim is made using the &%-Mrm%& option to request
38599 that the message be deleted from the system without generating a bounce
38600 message.
38601 .next
38602 &'add recipient'&: A dialog box is displayed into which a recipient address can
38603 be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38604 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38605 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38606 causes a call to Exim to be made using the &%-Mar%& option to request that an
38607 additional recipient be added to the message, unless the entry box is empty, in
38608 which case no action is taken.
38609 .next
38610 &'mark delivered'&: A dialog box is displayed into which a recipient address
38611 can be typed. If the address is not qualified and the QUALIFY_DOMAIN parameter
38612 is set in &_Local/eximon.conf_&, the address is qualified with that domain.
38613 Otherwise it must be entered as a fully qualified address. Pressing RETURN
38614 causes a call to Exim to be made using the &%-Mmd%& option to mark the given
38615 recipient address as already delivered, unless the entry box is empty, in which
38616 case no action is taken.
38617 .next
38618 &'mark all delivered'&: A call to Exim is made using the &%-Mmad%& option to
38619 mark all recipient addresses as already delivered.
38620 .next
38621 &'edit sender'&: A dialog box is displayed initialized with the current
38622 sender's address. Pressing RETURN causes a call to Exim to be made using the
38623 &%-Mes%& option to replace the sender address, unless the entry box is empty,
38624 in which case no action is taken. If you want to set an empty sender (as in
38625 bounce messages), you must specify it as &"<>"&. Otherwise, if the address is
38626 not qualified and the QUALIFY_DOMAIN parameter is set in &_Local/eximon.conf_&,
38627 the address is qualified with that domain.
38628 .endlist
38629
38630 When a delivery is forced, a window showing the &%-v%& output is displayed. In
38631 other cases when a call to Exim is made, if there is any output from Exim (in
38632 particular, if the command fails) a window containing the command and the
38633 output is displayed. Otherwise, the results of the action are normally apparent
38634 from the log and queue displays. However, if you set ACTION_OUTPUT=yes in
38635 &_Local/eximon.conf_&, a window showing the Exim command is always opened, even
38636 if no output is generated.
38637
38638 The queue display is automatically updated for actions such as freezing and
38639 thawing, unless ACTION_QUEUE_UPDATE=no has been set in
38640 &_Local/eximon.conf_&. In this case the &"Update"& button has to be used to
38641 force an update of the display after one of these actions.
38642
38643 In any text window that is displayed as result of a menu action, the normal
38644 cut-and-paste facility is available, and searching can be carried out using ^R
38645 and ^S, as described above for the log tail window.
38646 .ecindex IIDeximon
38647
38648
38649
38650
38651
38652 . ////////////////////////////////////////////////////////////////////////////
38653 . ////////////////////////////////////////////////////////////////////////////
38654
38655 .chapter "Security considerations" "CHAPsecurity"
38656 .scindex IIDsecurcon "security" "discussion of"
38657 This chapter discusses a number of issues concerned with security, some of
38658 which are also covered in other parts of this manual.
38659
38660 For reasons that this author does not understand, some people have promoted
38661 Exim as a &"particularly secure"& mailer. Perhaps it is because of the
38662 existence of this chapter in the documentation. However, the intent of the
38663 chapter is simply to describe the way Exim works in relation to certain
38664 security concerns, not to make any specific claims about the effectiveness of
38665 its security as compared with other MTAs.
38666
38667 What follows is a description of the way Exim is supposed to be. Best efforts
38668 have been made to try to ensure that the code agrees with the theory, but an
38669 absence of bugs can never be guaranteed. Any that are reported will get fixed
38670 as soon as possible.
38671
38672
38673 .section "Building a more &""hardened""& Exim" "SECID286"
38674 .cindex "security" "build-time features"
38675 There are a number of build-time options that can be set in &_Local/Makefile_&
38676 to create Exim binaries that are &"harder"& to attack, in particular by a rogue
38677 Exim administrator who does not have the root password, or by someone who has
38678 penetrated the Exim (but not the root) account. These options are as follows:
38679
38680 .ilist
38681 ALT_CONFIG_PREFIX can be set to a string that is required to match the
38682 start of any filenames used with the &%-C%& option. When it is set, these
38683 filenames are also not allowed to contain the sequence &"/../"&. (However, if
38684 the value of the &%-C%& option is identical to the value of CONFIGURE_FILE in
38685 &_Local/Makefile_&, Exim ignores &%-C%& and proceeds as usual.) There is no
38686 default setting for &%ALT_CONFIG_PREFIX%&.
38687
38688 If the permitted configuration files are confined to a directory to
38689 which only root has access, this guards against someone who has broken
38690 into the Exim account from running a privileged Exim with an arbitrary
38691 configuration file, and using it to break into other accounts.
38692 .next
38693
38694 If a non-trusted configuration file (i.e. not the default configuration file
38695 or one which is trusted by virtue of being listed in the TRUSTED_CONFIG_LIST
38696 file) is specified with &%-C%&, or if macros are given with &%-D%& (but see
38697 the next item), then root privilege is retained only if the caller of Exim is
38698 root. This locks out the possibility of testing a configuration using &%-C%&
38699 right through message reception and delivery, even if the caller is root. The
38700 reception works, but by that time, Exim is running as the Exim user, so when
38701 it re-execs to regain privilege for the delivery, the use of &%-C%& causes
38702 privilege to be lost. However, root can test reception and delivery using two
38703 separate commands.
38704
38705 .next
38706 The WHITELIST_D_MACROS build option declares some macros to be safe to override
38707 with &%-D%& if the real uid is one of root, the Exim run-time user or the
38708 CONFIGURE_OWNER, if defined.  The potential impact of this option is limited by
38709 requiring the run-time value supplied to &%-D%& to match a regex that errs on
38710 the restrictive side.  Requiring build-time selection of safe macros is onerous
38711 but this option is intended solely as a transition mechanism to permit
38712 previously-working configurations to continue to work after release 4.73.
38713 .next
38714 If DISABLE_D_OPTION is defined, the use of the &%-D%& command line option
38715 is disabled.
38716 .next
38717 FIXED_NEVER_USERS can be set to a colon-separated list of users that are
38718 never to be used for any deliveries. This is like the &%never_users%& runtime
38719 option, but it cannot be overridden; the runtime option adds additional users
38720 to the list. The default setting is &"root"&; this prevents a non-root user who
38721 is permitted to modify the runtime file from using Exim as a way to get root.
38722 .endlist
38723
38724
38725
38726 .section "Root privilege" "SECID270"
38727 .cindex "setuid"
38728 .cindex "root privilege"
38729 The Exim binary is normally setuid to root, which means that it gains root
38730 privilege (runs as root) when it starts execution. In some special cases (for
38731 example, when the daemon is not in use and there are no local deliveries), it
38732 may be possible to run Exim setuid to some user other than root. This is
38733 discussed in the next section. However, in most installations, root privilege
38734 is required for two things:
38735
38736 .ilist
38737 To set up a socket connected to the standard SMTP port (25) when initialising
38738 the listening daemon. If Exim is run from &'inetd'&, this privileged action is
38739 not required.
38740 .next
38741 To be able to change uid and gid in order to read users' &_.forward_& files and
38742 perform local deliveries as the receiving user or as specified in the
38743 configuration.
38744 .endlist
38745
38746 It is not necessary to be root to do any of the other things Exim does, such as
38747 receiving messages and delivering them externally over SMTP, and it is
38748 obviously more secure if Exim does not run as root except when necessary.
38749 For this reason, a user and group for Exim to use must be defined in
38750 &_Local/Makefile_&. These are known as &"the Exim user"& and &"the Exim
38751 group"&. Their values can be changed by the runtime configuration, though this
38752 is not recommended. Often a user called &'exim'& is used, but some sites use
38753 &'mail'& or another user name altogether.
38754
38755 Exim uses &[setuid()]& whenever it gives up root privilege. This is a permanent
38756 abdication; the process cannot regain root afterwards. Prior to release 4.00,
38757 &[seteuid()]& was used in some circumstances, but this is no longer the case.
38758
38759 After a new Exim process has interpreted its command line options, it changes
38760 uid and gid in the following cases:
38761
38762 .ilist
38763 .oindex "&%-C%&"
38764 .oindex "&%-D%&"
38765 If the &%-C%& option is used to specify an alternate configuration file, or if
38766 the &%-D%& option is used to define macro values for the configuration, and the
38767 calling process is not running as root, the uid and gid are changed to those of
38768 the calling process.
38769 However, if DISABLE_D_OPTION is defined in &_Local/Makefile_&, the &%-D%&
38770 option may not be used at all.
38771 If WHITELIST_D_MACROS is defined in &_Local/Makefile_&, then some macro values
38772 can be supplied if the calling process is running as root, the Exim run-time
38773 user or CONFIGURE_OWNER, if defined.
38774 .next
38775 .oindex "&%-be%&"
38776 .oindex "&%-bf%&"
38777 .oindex "&%-bF%&"
38778 If the expansion test option (&%-be%&) or one of the filter testing options
38779 (&%-bf%& or &%-bF%&) are used, the uid and gid are changed to those of the
38780 calling process.
38781 .next
38782 If the process is not a daemon process or a queue runner process or a delivery
38783 process or a process for testing address routing (started with &%-bt%&), the
38784 uid and gid are changed to the Exim user and group. This means that Exim always
38785 runs under its own uid and gid when receiving messages. This also applies when
38786 testing address verification
38787 .oindex "&%-bv%&"
38788 .oindex "&%-bh%&"
38789 (the &%-bv%& option) and testing incoming message policy controls (the &%-bh%&
38790 option).
38791 .next
38792 For a daemon, queue runner, delivery, or address testing process, the uid
38793 remains as root at this stage, but the gid is changed to the Exim group.
38794 .endlist
38795
38796 The processes that initially retain root privilege behave as follows:
38797
38798 .ilist
38799 A daemon process changes the gid to the Exim group and the uid to the Exim
38800 user after setting up one or more listening sockets. The &[initgroups()]&
38801 function is called, so that if the Exim user is in any additional groups, they
38802 will be used during message reception.
38803 .next
38804 A queue runner process retains root privilege throughout its execution. Its
38805 job is to fork a controlled sequence of delivery processes.
38806 .next
38807 A delivery process retains root privilege throughout most of its execution,
38808 but any actual deliveries (that is, the transports themselves) are run in
38809 subprocesses which always change to a non-root uid and gid. For local
38810 deliveries this is typically the uid and gid of the owner of the mailbox; for
38811 remote deliveries, the Exim uid and gid are used. Once all the delivery
38812 subprocesses have been run, a delivery process changes to the Exim uid and gid
38813 while doing post-delivery tidying up such as updating the retry database and
38814 generating bounce and warning messages.
38815
38816 While the recipient addresses in a message are being routed, the delivery
38817 process runs as root. However, if a user's filter file has to be processed,
38818 this is done in a subprocess that runs under the individual user's uid and
38819 gid. A system filter is run as root unless &%system_filter_user%& is set.
38820 .next
38821 A process that is testing addresses (the &%-bt%& option) runs as root so that
38822 the routing is done in the same environment as a message delivery.
38823 .endlist
38824
38825
38826
38827
38828 .section "Running Exim without privilege" "SECTrunexiwitpri"
38829 .cindex "privilege, running without"
38830 .cindex "unprivileged running"
38831 .cindex "root privilege" "running without"
38832 Some installations like to run Exim in an unprivileged state for more of its
38833 operation, for added security. Support for this mode of operation is provided
38834 by the global option &%deliver_drop_privilege%&. When this is set, the uid and
38835 gid are changed to the Exim user and group at the start of a delivery process
38836 (and also queue runner and address testing processes). This means that address
38837 routing is no longer run as root, and the deliveries themselves cannot change
38838 to any other uid.
38839
38840 .cindex SIGHUP
38841 .cindex "daemon" "restarting"
38842 Leaving the binary setuid to root, but setting &%deliver_drop_privilege%& means
38843 that the daemon can still be started in the usual way, and it can respond
38844 correctly to SIGHUP because the re-invocation regains root privilege.
38845
38846 An alternative approach is to make Exim setuid to the Exim user and also setgid
38847 to the Exim group. If you do this, the daemon must be started from a root
38848 process. (Calling Exim from a root process makes it behave in the way it does
38849 when it is setuid root.) However, the daemon cannot restart itself after a
38850 SIGHUP signal because it cannot regain privilege.
38851
38852 It is still useful to set &%deliver_drop_privilege%& in this case, because it
38853 stops Exim from trying to re-invoke itself to do a delivery after a message has
38854 been received. Such a re-invocation is a waste of resources because it has no
38855 effect.
38856
38857 If restarting the daemon is not an issue (for example, if &%mua_wrapper%& is
38858 set, or &'inetd'& is being used instead of a daemon), having the binary setuid
38859 to the Exim user seems a clean approach, but there is one complication:
38860
38861 In this style of operation, Exim is running with the real uid and gid set to
38862 those of the calling process, and the effective uid/gid set to Exim's values.
38863 Ideally, any association with the calling process' uid/gid should be dropped,
38864 that is, the real uid/gid should be reset to the effective values so as to
38865 discard any privileges that the caller may have. While some operating systems
38866 have a function that permits this action for a non-root effective uid, quite a
38867 number of them do not. Because of this lack of standardization, Exim does not
38868 address this problem at this time.
38869
38870 For this reason, the recommended approach for &"mostly unprivileged"& running
38871 is to keep the Exim binary setuid to root, and to set
38872 &%deliver_drop_privilege%&. This also has the advantage of allowing a daemon to
38873 be used in the most straightforward way.
38874
38875 If you configure Exim not to run delivery processes as root, there are a
38876 number of restrictions on what you can do:
38877
38878 .ilist
38879 You can deliver only as the Exim user/group. You should  explicitly use the
38880 &%user%& and &%group%& options to override routers or local transports that
38881 normally deliver as the recipient. This makes sure that configurations that
38882 work in this mode function the same way in normal mode. Any implicit or
38883 explicit specification of another user causes an error.
38884 .next
38885 Use of &_.forward_& files is severely restricted, such that it is usually
38886 not worthwhile to include them in the configuration.
38887 .next
38888 Users who wish to use &_.forward_& would have to make their home directory and
38889 the file itself accessible to the Exim user. Pipe and append-to-file entries,
38890 and their equivalents in Exim filters, cannot be used. While they could be
38891 enabled in the Exim user's name, that would be insecure and not very useful.
38892 .next
38893 Unless the local user mailboxes are all owned by the Exim user (possible in
38894 some POP3 or IMAP-only environments):
38895
38896 .olist
38897 They must be owned by the Exim group and be writeable by that group. This
38898 implies you must set &%mode%& in the appendfile configuration, as well as the
38899 mode of the mailbox files themselves.
38900 .next
38901 You must set &%no_check_owner%&, since most or all of the files will not be
38902 owned by the Exim user.
38903 .next
38904 You must set &%file_must_exist%&, because Exim cannot set the owner correctly
38905 on a newly created mailbox when unprivileged. This also implies that new
38906 mailboxes need to be created manually.
38907 .endlist olist
38908 .endlist ilist
38909
38910
38911 These restrictions severely restrict what can be done in local deliveries.
38912 However, there are no restrictions on remote deliveries. If you are running a
38913 gateway host that does no local deliveries, setting &%deliver_drop_privilege%&
38914 gives more security at essentially no cost.
38915
38916 If you are using the &%mua_wrapper%& facility (see chapter
38917 &<<CHAPnonqueueing>>&), &%deliver_drop_privilege%& is forced to be true.
38918
38919
38920
38921
38922 .section "Delivering to local files" "SECID271"
38923 Full details of the checks applied by &(appendfile)& before it writes to a file
38924 are given in chapter &<<CHAPappendfile>>&.
38925
38926
38927
38928 .section "Running local commands" "SECTsecconslocalcmds"
38929 .cindex "security" "local commands"
38930 .cindex "security" "command injection attacks"
38931 There are a number of ways in which an administrator can configure Exim to run
38932 commands based upon received, untrustworthy, data. Further, in some
38933 configurations a user who can control a &_.forward_& file can also arrange to
38934 run commands. Configuration to check includes, but is not limited to:
38935
38936 .ilist
38937 Use of &%use_shell%& in the pipe transport: various forms of shell command
38938 injection may be possible with this option present. It is dangerous and should
38939 be used only with considerable caution. Consider constraints which whitelist
38940 allowed characters in a variable which is to be used in a pipe transport that
38941 has &%use_shell%& enabled.
38942 .next
38943 A number of options such as &%forbid_filter_run%&, &%forbid_filter_perl%&,
38944 &%forbid_filter_dlfunc%& and so forth which restrict facilities available to
38945 &_.forward_& files in a redirect router. If Exim is running on a central mail
38946 hub to which ordinary users do not have shell access, but home directories are
38947 NFS mounted (for instance) then administrators should review the list of these
38948 forbid options available, and should bear in mind that the options that may
38949 need forbidding can change as new features are added between releases.
38950 .next
38951 The &%${run...}%& expansion item does not use a shell by default, but
38952 administrators can configure use of &_/bin/sh_& as part of the command.
38953 Such invocations should be viewed with prejudicial suspicion.
38954 .next
38955 Administrators who use embedded Perl are advised to explore how Perl's
38956 taint checking might apply to their usage.
38957 .next
38958 Use of &%${expand...}%& is somewhat analogous to shell's eval builtin and
38959 administrators are well advised to view its use with suspicion, in case (for
38960 instance) it allows a local-part to contain embedded Exim directives.
38961 .next
38962 Use of &%${match_local_part...}%& and friends becomes more dangerous if
38963 Exim was built with EXPAND_LISTMATCH_RHS defined: the second string in
38964 each can reference arbitrary lists and files, rather than just being a list
38965 of opaque strings.
38966 The EXPAND_LISTMATCH_RHS option was added and set false by default because of
38967 real-world security vulnerabilities caused by its use with untrustworthy data
38968 injected in, for SQL injection attacks.
38969 Consider the use of the &%inlisti%& expansion condition instead.
38970 .endlist
38971
38972
38973
38974
38975 .section "Trust in configuration data" "SECTsecconfdata"
38976 .cindex "security" "data sources"
38977 .cindex "security" "regular expressions"
38978 .cindex "regular expressions" "security"
38979 .cindex "PCRE" "security"
38980 If configuration data for Exim can come from untrustworthy sources, there
38981 are some issues to be aware of:
38982
38983 .ilist
38984 Use of &%${expand...}%& may provide a path for shell injection attacks.
38985 .next
38986 Letting untrusted data provide a regular expression is unwise.
38987 .next
38988 Using &%${match...}%& to apply a fixed regular expression against untrusted
38989 data may result in pathological behaviour within PCRE.  Be aware of what
38990 "backtracking" means and consider options for being more strict with a regular
38991 expression. Avenues to explore include limiting what can match (avoiding &`.`&
38992 when &`[a-z0-9]`& or other character class will do), use of atomic grouping and
38993 possessive quantifiers or just not using regular expressions against untrusted
38994 data.
38995 .next
38996 It can be important to correctly use &%${quote:...}%&,
38997 &%${quote_local_part:...}%& and &%${quote_%&<&'lookup-type'&>&%:...}%& expansion
38998 items to ensure that data is correctly constructed.
38999 .next
39000 Some lookups might return multiple results, even though normal usage is only
39001 expected to yield one result.
39002 .endlist
39003
39004
39005
39006
39007 .section "IPv4 source routing" "SECID272"
39008 .cindex "source routing" "in IP packets"
39009 .cindex "IP source routing"
39010 Many operating systems suppress IP source-routed packets in the kernel, but
39011 some cannot be made to do this, so Exim does its own check. It logs incoming
39012 IPv4 source-routed TCP calls, and then drops them. Things are all different in
39013 IPv6. No special checking is currently done.
39014
39015
39016
39017 .section "The VRFY, EXPN, and ETRN commands in SMTP" "SECID273"
39018 Support for these SMTP commands is disabled by default. If required, they can
39019 be enabled by defining suitable ACLs.
39020
39021
39022
39023
39024 .section "Privileged users" "SECID274"
39025 .cindex "trusted users"
39026 .cindex "admin user"
39027 .cindex "privileged user"
39028 .cindex "user" "trusted"
39029 .cindex "user" "admin"
39030 Exim recognizes two sets of users with special privileges. Trusted users are
39031 able to submit new messages to Exim locally, but supply their own sender
39032 addresses and information about a sending host. For other users submitting
39033 local messages, Exim sets up the sender address from the uid, and doesn't
39034 permit a remote host to be specified.
39035
39036 .oindex "&%-f%&"
39037 However, an untrusted user is permitted to use the &%-f%& command line option
39038 in the special form &%-f <>%& to indicate that a delivery failure for the
39039 message should not cause an error report. This affects the message's envelope,
39040 but it does not affect the &'Sender:'& header. Untrusted users may also be
39041 permitted to use specific forms of address with the &%-f%& option by setting
39042 the &%untrusted_set_sender%& option.
39043
39044 Trusted users are used to run processes that receive mail messages from some
39045 other mail domain and pass them on to Exim for delivery either locally, or over
39046 the Internet. Exim trusts a caller that is running as root, as the Exim user,
39047 as any user listed in the &%trusted_users%& configuration option, or under any
39048 group listed in the &%trusted_groups%& option.
39049
39050 Admin users are permitted to do things to the messages on Exim's queue. They
39051 can freeze or thaw messages, cause them to be returned to their senders, remove
39052 them entirely, or modify them in various ways. In addition, admin users can run
39053 the Exim monitor and see all the information it is capable of providing, which
39054 includes the contents of files on the spool.
39055
39056 .oindex "&%-M%&"
39057 .oindex "&%-q%&"
39058 By default, the use of the &%-M%& and &%-q%& options to cause Exim to attempt
39059 delivery of messages on its queue is restricted to admin users. This
39060 restriction can be relaxed by setting the &%no_prod_requires_admin%& option.
39061 Similarly, the use of &%-bp%& (and its variants) to list the contents of the
39062 queue is also restricted to admin users. This restriction can be relaxed by
39063 setting &%no_queue_list_requires_admin%&.
39064
39065 Exim recognizes an admin user if the calling process is running as root or as
39066 the Exim user or if any of the groups associated with the calling process is
39067 the Exim group. It is not necessary actually to be running under the Exim
39068 group. However, if admin users who are not root or the Exim user are to access
39069 the contents of files on the spool via the Exim monitor (which runs
39070 unprivileged), Exim must be built to allow group read access to its spool
39071 files.
39072
39073 By default, regular users are trusted to perform basic testing and
39074 introspection commands, as themselves.  This setting can be tightened by
39075 setting the &%commandline_checks_require_admin%& option.
39076 This affects most of the checking options,
39077 such as &%-be%& and anything else &%-b*%&.
39078
39079
39080 .section "Spool files" "SECID275"
39081 .cindex "spool directory" "files"
39082 Exim's spool directory and everything it contains is owned by the Exim user and
39083 set to the Exim group. The mode for spool files is defined in the
39084 &_Local/Makefile_& configuration file, and defaults to 0640. This means that
39085 any user who is a member of the Exim group can access these files.
39086
39087
39088
39089 .section "Use of argv[0]" "SECID276"
39090 Exim examines the last component of &%argv[0]%&, and if it matches one of a set
39091 of specific strings, Exim assumes certain options. For example, calling Exim
39092 with the last component of &%argv[0]%& set to &"rsmtp"& is exactly equivalent
39093 to calling it with the option &%-bS%&. There are no security implications in
39094 this.
39095
39096
39097
39098 .section "Use of %f formatting" "SECID277"
39099 The only use made of &"%f"& by Exim is in formatting load average values. These
39100 are actually stored in integer variables as 1000 times the load average.
39101 Consequently, their range is limited and so therefore is the length of the
39102 converted output.
39103
39104
39105
39106 .section "Embedded Exim path" "SECID278"
39107 Exim uses its own path name, which is embedded in the code, only when it needs
39108 to re-exec in order to regain root privilege. Therefore, it is not root when it
39109 does so. If some bug allowed the path to get overwritten, it would lead to an
39110 arbitrary program's being run as exim, not as root.
39111
39112
39113
39114 .section "Dynamic module directory" "SECTdynmoddir"
39115 Any dynamically loadable modules must be installed into the directory
39116 defined in &`LOOKUP_MODULE_DIR`& in &_Local/Makefile_& for Exim to permit
39117 loading it.
39118
39119
39120 .section "Use of sprintf()" "SECID279"
39121 .cindex "&[sprintf()]&"
39122 A large number of occurrences of &"sprintf"& in the code are actually calls to
39123 &'string_sprintf()'&, a function that returns the result in malloc'd store.
39124 The intermediate formatting is done into a large fixed buffer by a function
39125 that runs through the format string itself, and checks the length of each
39126 conversion before performing it, thus preventing buffer overruns.
39127
39128 The remaining uses of &[sprintf()]& happen in controlled circumstances where
39129 the output buffer is known to be sufficiently long to contain the converted
39130 string.
39131
39132
39133
39134 .section "Use of debug_printf() and log_write()" "SECID280"
39135 Arbitrary strings are passed to both these functions, but they do their
39136 formatting by calling the function &'string_vformat()'&, which runs through
39137 the format string itself, and checks the length of each conversion.
39138
39139
39140
39141 .section "Use of strcat() and strcpy()" "SECID281"
39142 These are used only in cases where the output buffer is known to be large
39143 enough to hold the result.
39144 .ecindex IIDsecurcon
39145
39146
39147
39148
39149 . ////////////////////////////////////////////////////////////////////////////
39150 . ////////////////////////////////////////////////////////////////////////////
39151
39152 .chapter "Format of spool files" "CHAPspool"
39153 .scindex IIDforspo1 "format" "spool files"
39154 .scindex IIDforspo2 "spool directory" "format of files"
39155 .scindex IIDforspo3 "spool files" "format of"
39156 .cindex "spool files" "editing"
39157 A message on Exim's queue consists of two files, whose names are the message id
39158 followed by -D and -H, respectively. The data portion of the message is kept in
39159 the -D file on its own. The message's envelope, status, and headers are all
39160 kept in the -H file, whose format is described in this chapter. Each of these
39161 two files contains the final component of its own name as its first line. This
39162 is insurance against disk crashes where the directory is lost but the files
39163 themselves are recoverable.
39164
39165 The file formats may be changed, or new formats added, at any release.
39166 Spool files are not intended as an interface to other programs
39167 and should not be used as such.
39168
39169 Some people are tempted into editing -D files in order to modify messages. You
39170 need to be extremely careful if you do this; it is not recommended and you are
39171 on your own if you do it. Here are some of the pitfalls:
39172
39173 .ilist
39174 You must ensure that Exim does not try to deliver the message while you are
39175 fiddling with it. The safest way is to take out a write lock on the -D file,
39176 which is what Exim itself does, using &[fcntl()]&. If you update the file in
39177 place, the lock will be retained. If you write a new file and rename it, the
39178 lock will be lost at the instant of rename.
39179 .next
39180 .vindex "&$body_linecount$&"
39181 If you change the number of lines in the file, the value of
39182 &$body_linecount$&, which is stored in the -H file, will be incorrect and can
39183 cause incomplete transmission of messages or undeliverable messages.
39184 .next
39185 If the message is in MIME format, you must take care not to break it.
39186 .next
39187 If the message is cryptographically signed, any change will invalidate the
39188 signature.
39189 .endlist
39190 All in all, modifying -D files is fraught with danger.
39191
39192 Files whose names end with -J may also be seen in the &_input_& directory (or
39193 its subdirectories when &%split_spool_directory%& is set). These are journal
39194 files, used to record addresses to which the message has been delivered during
39195 the course of a delivery attempt. If there are still undelivered recipients at
39196 the end, the -H file is updated, and the -J file is deleted. If, however, there
39197 is some kind of crash (for example, a power outage) before this happens, the -J
39198 file remains in existence. When Exim next processes the message, it notices the
39199 -J file and uses it to update the -H file before starting the next delivery
39200 attempt.
39201
39202 Files whose names end with -K or .eml may also be seen in the spool.
39203 These are temporaries used for DKIM or malware processing, when that is used.
39204 They should be tidied up by normal operations; any old ones are probably
39205 relics of crashes and can be removed.
39206
39207 .section "Format of the -H file" "SECID282"
39208 .cindex "uid (user id)" "in spool file"
39209 .cindex "gid (group id)" "in spool file"
39210 The second line of the -H file contains the login name for the uid of the
39211 process that called Exim to read the message, followed by the numerical uid and
39212 gid. For a locally generated message, this is normally the user who sent the
39213 message. For a message received over TCP/IP via the daemon, it is
39214 normally the Exim user.
39215
39216 The third line of the file contains the address of the message's sender as
39217 transmitted in the envelope, contained in angle brackets. The sender address is
39218 empty for bounce messages. For incoming SMTP mail, the sender address is given
39219 in the MAIL command. For locally generated mail, the sender address is
39220 created by Exim from the login name of the current user and the configured
39221 &%qualify_domain%&. However, this can be overridden by the &%-f%& option or a
39222 leading &"From&~"& line if the caller is trusted, or if the supplied address is
39223 &"<>"& or an address that matches &%untrusted_set_senders%&.
39224
39225 The fourth line contains two numbers. The first is the time that the message
39226 was received, in the conventional Unix form &-- the number of seconds since the
39227 start of the epoch. The second number is a count of the number of messages
39228 warning of delayed delivery that have been sent to the sender.
39229
39230 There follow a number of lines starting with a hyphen. These can appear in any
39231 order, and are omitted when not relevant:
39232
39233 .vlist
39234 .vitem "&%-acl%&&~<&'number'&>&~<&'length'&>"
39235 This item is obsolete, and is not generated from Exim release 4.61 onwards;
39236 &%-aclc%& and &%-aclm%& are used instead. However, &%-acl%& is still
39237 recognized, to provide backward compatibility. In the old format, a line of
39238 this form is present for every ACL variable that is not empty. The number
39239 identifies the variable; the &%acl_c%&&*x*& variables are numbered 0&--9 and
39240 the &%acl_m%&&*x*& variables are numbered 10&--19. The length is the length of
39241 the data string for the variable. The string itself starts at the beginning of
39242 the next line, and is followed by a newline character. It may contain internal
39243 newlines.
39244
39245 .vitem "&%-aclc%&&~<&'rest-of-name'&>&~<&'length'&>"
39246 A line of this form is present for every ACL connection variable that is
39247 defined. Note that there is a space between &%-aclc%& and the rest of the name.
39248 The length is the length of the data string for the variable. The string itself
39249 starts at the beginning of the next line, and is followed by a newline
39250 character. It may contain internal newlines.
39251
39252 .vitem "&%-aclm%&&~<&'rest-of-name'&>&~<&'length'&>"
39253 A line of this form is present for every ACL message variable that is defined.
39254 Note that there is a space between &%-aclm%& and the rest of the name. The
39255 length is the length of the data string for the variable. The string itself
39256 starts at the beginning of the next line, and is followed by a newline
39257 character. It may contain internal newlines.
39258
39259 .vitem "&%-active_hostname%&&~<&'hostname'&>"
39260 This is present if, when the message was received over SMTP, the value of
39261 &$smtp_active_hostname$& was different to the value of &$primary_hostname$&.
39262
39263 .vitem &%-allow_unqualified_recipient%&
39264 This is present if unqualified recipient addresses are permitted in header
39265 lines (to stop such addresses from being qualified if rewriting occurs at
39266 transport time). Local messages that were input using &%-bnq%& and remote
39267 messages from hosts that match &%recipient_unqualified_hosts%& set this flag.
39268
39269 .vitem &%-allow_unqualified_sender%&
39270 This is present if unqualified sender addresses are permitted in header lines
39271 (to stop such addresses from being qualified if rewriting occurs at transport
39272 time). Local messages that were input using &%-bnq%& and remote messages from
39273 hosts that match &%sender_unqualified_hosts%& set this flag.
39274
39275 .vitem "&%-auth_id%&&~<&'text'&>"
39276 The id information for a message received on an authenticated SMTP connection
39277 &-- the value of the &$authenticated_id$& variable.
39278
39279 .vitem "&%-auth_sender%&&~<&'address'&>"
39280 The address of an authenticated sender &-- the value of the
39281 &$authenticated_sender$& variable.
39282
39283 .vitem "&%-body_linecount%&&~<&'number'&>"
39284 This records the number of lines in the body of the message, and is
39285 present unless &%-spool_file_wireformat%& is.
39286
39287 .vitem "&%-body_zerocount%&&~<&'number'&>"
39288 This records the number of binary zero bytes in the body of the message, and is
39289 present if the number is greater than zero.
39290
39291 .vitem &%-deliver_firsttime%&
39292 This is written when a new message is first added to the spool. When the spool
39293 file is updated after a deferral, it is omitted.
39294
39295 .vitem "&%-frozen%&&~<&'time'&>"
39296 .cindex "frozen messages" "spool data"
39297 The message is frozen, and the freezing happened at <&'time'&>.
39298
39299 .vitem "&%-helo_name%&&~<&'text'&>"
39300 This records the host name as specified by a remote host in a HELO or EHLO
39301 command.
39302
39303 .vitem "&%-host_address%&&~<&'address'&>.<&'port'&>"
39304 This records the IP address of the host from which the message was received and
39305 the remote port number that was used. It is omitted for locally generated
39306 messages.
39307
39308 .vitem "&%-host_auth%&&~<&'text'&>"
39309 If the message was received on an authenticated SMTP connection, this records
39310 the name of the authenticator &-- the value of the
39311 &$sender_host_authenticated$& variable.
39312
39313 .vitem &%-host_lookup_failed%&
39314 This is present if an attempt to look up the sending host's name from its IP
39315 address failed. It corresponds to the &$host_lookup_failed$& variable.
39316
39317 .vitem "&%-host_name%&&~<&'text'&>"
39318 .cindex "reverse DNS lookup"
39319 .cindex "DNS" "reverse lookup"
39320 This records the name of the remote host from which the message was received,
39321 if the host name was looked up from the IP address when the message was being
39322 received. It is not present if no reverse lookup was done.
39323
39324 .vitem "&%-ident%&&~<&'text'&>"
39325 For locally submitted messages, this records the login of the originating user,
39326 unless it was a trusted user and the &%-oMt%& option was used to specify an
39327 ident value. For messages received over TCP/IP, this records the ident string
39328 supplied by the remote host, if any.
39329
39330 .vitem "&%-interface_address%&&~<&'address'&>.<&'port'&>"
39331 This records the IP address of the local interface and the port number through
39332 which a message was received from a remote host. It is omitted for locally
39333 generated messages.
39334
39335 .vitem &%-local%&
39336 The message is from a local sender.
39337
39338 .vitem &%-localerror%&
39339 The message is a locally-generated bounce message.
39340
39341 .vitem "&%-local_scan%&&~<&'string'&>"
39342 This records the data string that was returned by the &[local_scan()]& function
39343 when the message was received &-- the value of the &$local_scan_data$&
39344 variable. It is omitted if no data was returned.
39345
39346 .vitem &%-manual_thaw%&
39347 The message was frozen but has been thawed manually, that is, by an explicit
39348 Exim command rather than via the auto-thaw process.
39349
39350 .vitem &%-N%&
39351 A testing delivery process was started using the &%-N%& option to suppress any
39352 actual deliveries, but delivery was deferred. At any further delivery attempts,
39353 &%-N%& is assumed.
39354
39355 .vitem &%-received_protocol%&
39356 This records the value of the &$received_protocol$& variable, which contains
39357 the name of the protocol by which the message was received.
39358
39359 .vitem &%-sender_set_untrusted%&
39360 The envelope sender of this message was set by an untrusted local caller (used
39361 to ensure that the caller is displayed in queue listings).
39362
39363 .vitem "&%-spam_score_int%&&~<&'number'&>"
39364 If a message was scanned by SpamAssassin, this is present. It records the value
39365 of &$spam_score_int$&.
39366
39367 .vitem &%-spool_file_wireformat%&
39368 The -D file for this message is in wire-format (for ESMTP CHUNKING)
39369 rather than Unix-format.
39370 The line-ending is CRLF rather than newline.
39371 There is still, however, no leading-dot-stuffing.
39372
39373 .vitem &%-tls_certificate_verified%&
39374 A TLS certificate was received from the client that sent this message, and the
39375 certificate was verified by the server.
39376
39377 .vitem "&%-tls_cipher%&&~<&'cipher name'&>"
39378 When the message was received over an encrypted connection, this records the
39379 name of the cipher suite that was used.
39380
39381 .vitem "&%-tls_peerdn%&&~<&'peer DN'&>"
39382 When the message was received over an encrypted connection, and a certificate
39383 was received from the client, this records the Distinguished Name from that
39384 certificate.
39385 .endlist
39386
39387 Following the options there is a list of those addresses to which the message
39388 is not to be delivered. This set of addresses is initialized from the command
39389 line when the &%-t%& option is used and &%extract_addresses_remove_arguments%&
39390 is set; otherwise it starts out empty. Whenever a successful delivery is made,
39391 the address is added to this set. The addresses are kept internally as a
39392 balanced binary tree, and it is a representation of that tree which is written
39393 to the spool file. If an address is expanded via an alias or forward file, the
39394 original address is added to the tree when deliveries to all its child
39395 addresses are complete.
39396
39397 If the tree is empty, there is a single line in the spool file containing just
39398 the text &"XX"&. Otherwise, each line consists of two letters, which are either
39399 Y or N, followed by an address. The address is the value for the node of the
39400 tree, and the letters indicate whether the node has a left branch and/or a
39401 right branch attached to it, respectively. If branches exist, they immediately
39402 follow. Here is an example of a three-node tree:
39403 .code
39404 YY darcy@austen.fict.example
39405 NN alice@wonderland.fict.example
39406 NN editor@thesaurus.ref.example
39407 .endd
39408 After the non-recipients tree, there is a list of the message's recipients.
39409 This is a simple list, preceded by a count. It includes all the original
39410 recipients of the message, including those to whom the message has already been
39411 delivered. In the simplest case, the list contains one address per line. For
39412 example:
39413 .code
39414 4
39415 editor@thesaurus.ref.example
39416 darcy@austen.fict.example
39417 rdo@foundation
39418 alice@wonderland.fict.example
39419 .endd
39420 However, when a child address has been added to the top-level addresses as a
39421 result of the use of the &%one_time%& option on a &(redirect)& router, each
39422 line is of the following form:
39423 .display
39424 <&'top-level address'&> <&'errors_to address'&> &&&
39425   <&'length'&>,<&'parent number'&>#<&'flag bits'&>
39426 .endd
39427 The 01 flag bit indicates the presence of the three other fields that follow
39428 the top-level address. Other bits may be used in future to support additional
39429 fields. The <&'parent number'&> is the offset in the recipients list of the
39430 original parent of the &"one time"& address. The first two fields are the
39431 envelope sender that is associated with this address and its length. If the
39432 length is zero, there is no special envelope sender (there are then two space
39433 characters in the line). A non-empty field can arise from a &(redirect)& router
39434 that has an &%errors_to%& setting.
39435
39436
39437 A blank line separates the envelope and status information from the headers
39438 which follow. A header may occupy several lines of the file, and to save effort
39439 when reading it in, each header is preceded by a number and an identifying
39440 character. The number is the number of characters in the header, including any
39441 embedded newlines and the terminating newline. The character is one of the
39442 following:
39443
39444 .table2 50pt
39445 .row <&'blank'&>         "header in which Exim has no special interest"
39446 .row &`B`&               "&'Bcc:'& header"
39447 .row &`C`&               "&'Cc:'& header"
39448 .row &`F`&               "&'From:'& header"
39449 .row &`I`&               "&'Message-id:'& header"
39450 .row &`P`&               "&'Received:'& header &-- P for &""postmark""&"
39451 .row &`R`&               "&'Reply-To:'& header"
39452 .row &`S`&               "&'Sender:'& header"
39453 .row &`T`&               "&'To:'& header"
39454 .row &`*`&               "replaced or deleted header"
39455 .endtable
39456
39457 Deleted or replaced (rewritten) headers remain in the spool file for debugging
39458 purposes. They are not transmitted when the message is delivered. Here is a
39459 typical set of headers:
39460 .code
39461 111P Received: by hobbit.fict.example with local (Exim 4.00)
39462 id 14y9EI-00026G-00; Fri, 11 May 2001 10:28:59 +0100
39463 049  Message-Id: <E14y9EI-00026G-00@hobbit.fict.example>
39464 038* X-rewrote-sender: bb@hobbit.fict.example
39465 042* From: Bilbo Baggins <bb@hobbit.fict.example>
39466 049F From: Bilbo Baggins <B.Baggins@hobbit.fict.example>
39467 099* To: alice@wonderland.fict.example, rdo@foundation,
39468 darcy@austen.fict.example, editor@thesaurus.ref.example
39469 104T To: alice@wonderland.fict.example, rdo@foundation.example,
39470 darcy@austen.fict.example, editor@thesaurus.ref.example
39471 038  Date: Fri, 11 May 2001 10:28:59 +0100
39472 .endd
39473 The asterisked headers indicate that the envelope sender, &'From:'& header, and
39474 &'To:'& header have been rewritten, the last one because routing expanded the
39475 unqualified domain &'foundation'&.
39476 .ecindex IIDforspo1
39477 .ecindex IIDforspo2
39478 .ecindex IIDforspo3
39479
39480 .section "Format of the -D file" "SECID282a"
39481 The data file is traditionally in Unix-standard format: lines are ended with
39482 an ASCII newline character.
39483 However, when the &%spool_wireformat%& main option is used some -D files
39484 can have an alternate format.
39485 This is flagged by a &%-spool_file_wireformat%& line in the corresponding -H file.
39486 The -D file lines (not including the first name-component line) are
39487 suitable for direct copying to the wire when transmitting using the
39488 ESMTP CHUNKING option, meaning lower processing overhead.
39489 Lines are terminated with an ASCII CRLF pair.
39490 There is no dot-stuffing (and no dot-termination).
39491
39492 . ////////////////////////////////////////////////////////////////////////////
39493 . ////////////////////////////////////////////////////////////////////////////
39494
39495 .chapter "DKIM and SPF" "CHAPdkim" &&&
39496          "DKIM and SPF Support"
39497 .cindex "DKIM"
39498
39499 .section "DKIM (DomainKeys Identified Mail)" SECDKIM
39500
39501 DKIM is a mechanism by which messages sent by some entity can be provably
39502 linked to a domain which that entity controls.  It permits reputation to
39503 be tracked on a per-domain basis, rather than merely upon source IP address.
39504 DKIM is documented in RFC 6376.
39505
39506 As DKIM relies on the message being unchanged in transit, messages handled
39507 by a mailing-list (which traditionally adds to the message) will not match
39508 any original DKIM signature.
39509
39510 DKIM support is compiled into Exim by default if TLS support is present.
39511 It can be disabled by setting DISABLE_DKIM=yes in &_Local/Makefile_&.
39512
39513 Exim's DKIM implementation allows for
39514 .olist
39515 Signing outgoing messages: This function is implemented in the SMTP transport.
39516 It can co-exist with all other Exim features
39517 (including transport filters)
39518 except cutthrough delivery.
39519 .next
39520 Verifying signatures in incoming messages: This is implemented by an additional
39521 ACL (acl_smtp_dkim), which can be called several times per message, with
39522 different signature contexts.
39523 .endlist
39524
39525 In typical Exim style, the verification implementation does not include any
39526 default "policy". Instead it enables you to build your own policy using
39527 Exim's standard controls.
39528
39529 Please note that verification of DKIM signatures in incoming mail is turned
39530 on by default for logging (in the <= line) purposes.
39531
39532 Additional log detail can be enabled using the &%dkim_verbose%& log_selector.
39533 When set, for each signature in incoming email,
39534 exim will log a line displaying the most important signature details, and the
39535 signature status. Here is an example (with line-breaks added for clarity):
39536 .code
39537 2009-09-09 10:22:28 1MlIRf-0003LU-U3 DKIM:
39538     d=facebookmail.com s=q1-2009b
39539     c=relaxed/relaxed a=rsa-sha1
39540     i=@facebookmail.com t=1252484542 [verification succeeded]
39541 .endd
39542
39543 You might want to turn off DKIM verification processing entirely for internal
39544 or relay mail sources. To do that, set the &%dkim_disable_verify%& ACL
39545 control modifier. This should typically be done in the RCPT ACL, at points
39546 where you accept mail from relay sources (internal hosts or authenticated
39547 senders).
39548
39549
39550 .section "Signing outgoing messages" "SECDKIMSIGN"
39551 .cindex "DKIM" "signing"
39552
39553 For signing to be usable you must have published a DKIM record in DNS.
39554 Note that RFC 8301 (which does not cover EC keys) says:
39555 .code
39556 rsa-sha1 MUST NOT be used for signing or verifying.
39557
39558 Signers MUST use RSA keys of at least 1024 bits for all keys.
39559 Signers SHOULD use RSA keys of at least 2048 bits.
39560 .endd
39561
39562 Note also that the key content (the 'p=' field)
39563 in the DNS record is different between RSA and EC keys;
39564 for the former it is the base64 of the ASN.1 for the RSA public key
39565 (equivalent to the private-key .pem with the header/trailer stripped)
39566 but for EC keys it is the base64 of the pure key; no ASN.1 wrapping.
39567
39568 Signing is enabled by setting private options on the SMTP transport.
39569 These options take (expandable) strings as arguments.
39570
39571 .option dkim_domain smtp string list&!! unset
39572 The domain(s) you want to sign with.
39573 After expansion, this can be a list.
39574 Each element in turn,
39575 .new
39576 lowercased,
39577 .wen
39578 is put into the &%$dkim_domain%& expansion variable
39579 while expanding the remaining signing options.
39580 If it is empty after expansion, DKIM signing is not done,
39581 and no error will result even if &%dkim_strict%& is set.
39582
39583 .option dkim_selector smtp string list&!! unset
39584 This sets the key selector string.
39585 After expansion, which can use &$dkim_domain$&, this can be a list.
39586 Each element in turn is put in the expansion
39587 variable &%$dkim_selector%& which may be used in the &%dkim_private_key%&
39588 option along with &%$dkim_domain%&.
39589 If the option is empty after expansion, DKIM signing is not done for this domain,
39590 and no error will result even if &%dkim_strict%& is set.
39591
39592 .option dkim_private_key smtp string&!! unset
39593 This sets the private key to use.
39594 You can use the &%$dkim_domain%& and
39595 &%$dkim_selector%& expansion variables to determine the private key to use.
39596 The result can either
39597 .ilist
39598 be a valid RSA private key in ASCII armor (.pem file), including line breaks
39599 .next
39600 with GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39601 be a valid Ed25519 private key (same format as above)
39602 .next
39603 start with a slash, in which case it is treated as a file that contains
39604 the private key
39605 .next
39606 be "0", "false" or the empty string, in which case the message will not
39607 be signed. This case will not result in an error, even if &%dkim_strict%&
39608 is set.
39609 .endlist
39610
39611 To generate keys under OpenSSL:
39612 .code
39613 openssl genrsa -out dkim_rsa.private 2048
39614 openssl rsa -in dkim_rsa.private -out /dev/stdout -pubout -outform PEM
39615 .endd
39616 Take the base-64 lines from the output of the second command, concatenated,
39617 for the DNS TXT record.
39618 See section 3.6 of RFC6376 for the record specification.
39619
39620 Under GnuTLS:
39621 .code
39622 certtool --generate-privkey --rsa --bits=2048 --password='' -8 --outfile=dkim_rsa.private
39623 certtool --load-privkey=dkim_rsa.private --pubkey-info
39624 .endd
39625
39626 Note that RFC 8301 says:
39627 .code
39628 Signers MUST use RSA keys of at least 1024 bits for all keys.
39629 Signers SHOULD use RSA keys of at least 2048 bits.
39630 .endd
39631
39632 .new
39633 EC keys for DKIM are defined by RFC 8463.
39634 .wen
39635 They are considerably smaller than RSA keys for equivalent protection.
39636 As they are a recent development, users should consider dual-signing
39637 (by setting a list of selectors, and an expansion for this option)
39638 for some transition period.
39639 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39640 for EC keys.
39641
39642 OpenSSL 1.1.1 and GnuTLS 3.6.0 can create Ed25519 private keys:
39643 .code
39644 openssl genpkey -algorithm ed25519 -out dkim_ed25519.private
39645 certtool --generate-privkey --key-type=ed25519 --outfile=dkim_ed25519.private
39646 .endd
39647
39648 To produce the required public key value for a DNS record:
39649 .code
39650 openssl pkey -outform DER -pubout -in dkim_ed25519.private | tail -c +13 | base64
39651 certtool --load_privkey=dkim_ed25519.private --pubkey_info --outder | tail -c +13 | base64
39652 .endd
39653
39654 .new
39655 Exim also supports an alternate format
39656 of Ed25519 keys in DNS which was a candidate during development
39657 of the standard, but not adopted.
39658 A future release will probably drop that support.
39659 .wen
39660
39661 .option dkim_hash smtp string&!! sha256
39662 Can be set to any one of the supported hash methods, which are:
39663 .ilist
39664 &`sha1`& &-- should not be used, is old and insecure
39665 .next
39666 &`sha256`& &-- the default
39667 .next
39668 &`sha512`& &-- possibly more secure but less well supported
39669 .endlist
39670
39671 Note that RFC 8301 says:
39672 .code
39673 rsa-sha1 MUST NOT be used for signing or verifying.
39674 .endd
39675
39676 .option dkim_identity smtp string&!! unset
39677 If set after expansion, the value is used to set an "i=" tag in
39678 the signing header.  The DKIM standards restrict the permissible
39679 syntax of this optional tag to a mail address, with possibly-empty
39680 local part, an @, and a domain identical to or subdomain of the "d="
39681 tag value.  Note that Exim does not check the value.
39682
39683 .option dkim_canon smtp string&!! unset
39684 This option sets the canonicalization method used when signing a message.
39685 The DKIM RFC currently supports two methods: "simple" and "relaxed".
39686 The option defaults to "relaxed" when unset. Note: the current implementation
39687 only supports signing with the same canonicalization method for both headers and body.
39688
39689 .option dkim_strict smtp string&!! unset
39690 This  option  defines  how  Exim  behaves  when  signing a message that
39691 should be signed fails for some reason.  When the expansion evaluates to
39692 either "1" or "true", Exim will defer. Otherwise Exim will send the message
39693 unsigned. You can use the &%$dkim_domain%& and &%$dkim_selector%& expansion
39694 variables here.
39695
39696 .option dkim_sign_headers smtp string&!! "see below"
39697 If set, this option must expand to a colon-separated
39698 list of header names.
39699 Headers with these names, or the absence or such a header, will be included
39700 in the message signature.
39701 When unspecified, the header names listed in RFC4871 will be used,
39702 whether or not each header is present in the message.
39703 The default list is available for the expansion in the macro
39704 "_DKIM_SIGN_HEADERS".
39705
39706 If a name is repeated, multiple headers by that name (or the absence thereof)
39707 will be signed.  The textually later headers in the headers part of the
39708 message are signed first, if there are multiples.
39709
39710 A name can be prefixed with either an '=' or a '+' character.
39711 If an '=' prefix is used, all headers that are present with this name
39712 will be signed.
39713 If a '+' prefix if used, all headers that are present with this name
39714 will be signed, and one signature added for a missing header with the
39715 name will be appended.
39716
39717 .option dkim_timestamps smtp integer&!! unset
39718 This option controls the inclusion of timestamp information in the signature.
39719 If not set, no such information will be included.
39720 Otherwise, must be an unsigned number giving an offset in seconds from the current time
39721 for the expiry tag
39722 (eg. 1209600 for two weeks);
39723 both creation (t=) and expiry (x=) tags will be included.
39724
39725 RFC 6376 lists these tags as RECOMMENDED.
39726
39727
39728 .section "Verifying DKIM signatures in incoming mail" "SECDKIMVFY"
39729 .cindex "DKIM" "verification"
39730
39731 Verification of DKIM signatures in SMTP incoming email is done for all
39732 messages for which an ACL control &%dkim_disable_verify%& has not been set.
39733 .cindex authentication "expansion item"
39734 Performing verification sets up information used by the
39735 &$authresults$& expansion item.
39736
39737 The results of that verification are then made available to the
39738 &%acl_smtp_dkim%& ACL, which can examine and modify them.
39739 By default, this ACL is called once for each
39740 syntactically(!) correct signature in the incoming message.
39741 A missing ACL definition defaults to accept.
39742 If any ACL call does not accept, the message is not accepted.
39743 If a cutthrough delivery was in progress for the message, that is
39744 summarily dropped (having wasted the transmission effort).
39745
39746 To evaluate the verification result in the ACL
39747 a large number of expansion variables
39748 containing the signature status and its details are set up during the
39749 runtime of the ACL.
39750
39751 Calling the ACL only for existing signatures is not sufficient to build
39752 more advanced policies. For that reason, the global option
39753 &%dkim_verify_signers%&, and a global expansion variable
39754 &%$dkim_signers%& exist.
39755
39756 The global option &%dkim_verify_signers%& can be set to a colon-separated
39757 list of DKIM domains or identities for which the ACL &%acl_smtp_dkim%& is
39758 called. It is expanded when the message has been received. At this point,
39759 the expansion variable &%$dkim_signers%& already contains a colon-separated
39760 list of signer domains and identities for the message. When
39761 &%dkim_verify_signers%& is not specified in the main configuration,
39762 it defaults as:
39763 .code
39764 dkim_verify_signers = $dkim_signers
39765 .endd
39766 This leads to the default behaviour of calling &%acl_smtp_dkim%& for each
39767 DKIM signature in the message. Current DKIM verifiers may want to explicitly
39768 call the ACL for known domains or identities. This would be achieved as follows:
39769 .code
39770 dkim_verify_signers = paypal.com:ebay.com:$dkim_signers
39771 .endd
39772 This would result in &%acl_smtp_dkim%& always being called for "paypal.com"
39773 and "ebay.com", plus all domains and identities that have signatures in the message.
39774 You can also be more creative in constructing your policy. For example:
39775 .code
39776 dkim_verify_signers = $sender_address_domain:$dkim_signers
39777 .endd
39778
39779 If a domain or identity is listed several times in the (expanded) value of
39780 &%dkim_verify_signers%&, the ACL is only called once for that domain or identity.
39781
39782 .new
39783 Note that if the option is set using untrustworthy data
39784 (such as the From: header)
39785 care should be taken to force lowercase for domains
39786 and for the domain part if identities.
39787 The default setting can be regarded as trustworthy in this respect.
39788 .wen
39789
39790 If multiple signatures match a domain (or identity), the ACL is called once
39791 for each matching signature.
39792
39793
39794 Inside the &%acl_smtp_dkim%&, the following expansion variables are
39795 available (from most to least important):
39796
39797
39798 .vlist
39799 .vitem &%$dkim_cur_signer%&
39800 The signer that is being evaluated in this ACL run. This can be a domain or
39801 an identity. This is one of the list items from the expanded main option
39802 &%dkim_verify_signers%& (see above).
39803
39804 .vitem &%$dkim_verify_status%&
39805 Within the DKIM ACL,
39806 a string describing the general status of the signature. One of
39807 .ilist
39808 &%none%&: There is no signature in the message for the current domain or
39809 identity (as reflected by &%$dkim_cur_signer%&).
39810 .next
39811 &%invalid%&: The signature could not be verified due to a processing error.
39812 More detail is available in &%$dkim_verify_reason%&.
39813 .next
39814 &%fail%&: Verification of the signature failed.  More detail is
39815 available in &%$dkim_verify_reason%&.
39816 .next
39817 &%pass%&: The signature passed verification. It is valid.
39818 .endlist
39819
39820 This variable can be overwritten using an ACL 'set' modifier.
39821 This might, for instance, be done to enforce a policy restriction on
39822 hash-method or key-size:
39823 .code
39824   warn condition       = ${if eq {$dkim_verify_status}{pass}}
39825        condition       = ${if eq {${length_3:$dkim_algo}}{rsa}}
39826        condition       = ${if or {{eq {$dkim_algo}{rsa-sha1}} \
39827                                   {< {$dkim_key_length}{1024}}}}
39828        logwrite        = NOTE: forcing DKIM verify fail (was pass)
39829        set dkim_verify_status = fail
39830        set dkim_verify_reason = hash too weak or key too short
39831 .endd
39832
39833 So long as a DKIM ACL is defined (it need do no more than accept),
39834 after all the DKIM ACL runs have completed, the value becomes a
39835 colon-separated list of the values after each run.
39836 This is maintained for the mime, prdr and data ACLs.
39837
39838 .vitem &%$dkim_verify_reason%&
39839 A string giving a little bit more detail when &%$dkim_verify_status%& is either
39840 "fail" or "invalid". One of
39841 .ilist
39842 &%pubkey_unavailable%& (when &%$dkim_verify_status%&="invalid"): The public
39843 key for the domain could not be retrieved. This may be a temporary problem.
39844 .next
39845 &%pubkey_syntax%& (when &%$dkim_verify_status%&="invalid"): The public key
39846 record for the domain is syntactically invalid.
39847 .next
39848 &%bodyhash_mismatch%& (when &%$dkim_verify_status%&="fail"): The calculated
39849 body hash does not match the one specified in the signature header. This
39850 means that the message body was modified in transit.
39851 .next
39852 &%signature_incorrect%& (when &%$dkim_verify_status%&="fail"): The signature
39853 could not be verified. This may mean that headers were modified,
39854 re-written or otherwise changed in a way which is incompatible with
39855 DKIM verification. It may of course also mean that the signature is forged.
39856 .endlist
39857
39858 This variable can be overwritten, with any value, using an ACL 'set' modifier.
39859
39860 .vitem &%$dkim_domain%&
39861 The signing domain. IMPORTANT: This variable is only populated if there is
39862 an actual signature in the message for the current domain or identity (as
39863 reflected by &%$dkim_cur_signer%&).
39864
39865 .vitem &%$dkim_identity%&
39866 The signing identity, if present. IMPORTANT: This variable is only populated
39867 if there is an actual signature in the message for the current domain or
39868 identity (as reflected by &%$dkim_cur_signer%&).
39869
39870 .vitem &%$dkim_selector%&
39871 The key record selector string.
39872
39873 .vitem &%$dkim_algo%&
39874 The algorithm used. One of 'rsa-sha1' or 'rsa-sha256'.
39875 If running under GnuTLS 3.6.0 or OpenSSL 1.1.1 or later,
39876 may also be 'ed25519-sha256'.
39877 The "_CRYPTO_SIGN_ED25519" macro will be defined if support is present
39878 for EC keys.
39879
39880 Note that RFC 8301 says:
39881 .code
39882 rsa-sha1 MUST NOT be used for signing or verifying.
39883
39884 DKIM signatures identified as having been signed with historic
39885 algorithms (currently, rsa-sha1) have permanently failed evaluation
39886 .endd
39887
39888 To enforce this you must have a DKIM ACL which checks this variable
39889 and overwrites the &$dkim_verify_status$& variable as discussed above.
39890
39891 .vitem &%$dkim_canon_body%&
39892 The body canonicalization method. One of 'relaxed' or 'simple'.
39893
39894 .vitem &%$dkim_canon_headers%&
39895 The header canonicalization method. One of 'relaxed' or 'simple'.
39896
39897 .vitem &%$dkim_copiedheaders%&
39898 A transcript of headers and their values which are included in the signature
39899 (copied from the 'z=' tag of the signature).
39900 Note that RFC6376 requires that verification fail if the From: header is
39901 not included in the signature.  Exim does not enforce this; sites wishing
39902 strict enforcement should code the check explicitly.
39903
39904 .vitem &%$dkim_bodylength%&
39905 The number of signed body bytes. If zero ("0"), the body is unsigned. If no
39906 limit was set by the signer, "9999999999999" is returned. This makes sure
39907 that this variable always expands to an integer value.
39908 &*Note:*& The presence of the signature tag specifying a signing body length
39909 is one possible route to spoofing of valid DKIM signatures.
39910 A paranoid implementation might wish to regard signature where this variable
39911 shows less than the "no limit" return as being invalid.
39912
39913 .vitem &%$dkim_created%&
39914 UNIX timestamp reflecting the date and time when the signature was created.
39915 When this was not specified by the signer, "0" is returned.
39916
39917 .vitem &%$dkim_expires%&
39918 UNIX timestamp reflecting the date and time when the signer wants the
39919 signature to be treated as "expired". When this was not specified by the
39920 signer, "9999999999999" is returned. This makes it possible to do useful
39921 integer size comparisons against this value.
39922 Note that Exim does not check this value.
39923
39924 .vitem &%$dkim_headernames%&
39925 A colon-separated list of names of headers included in the signature.
39926
39927 .vitem &%$dkim_key_testing%&
39928 "1" if the key record has the "testing" flag set, "0" if not.
39929
39930 .vitem &%$dkim_key_nosubdomains%&
39931 "1" if the key record forbids subdomaining, "0" otherwise.
39932
39933 .vitem &%$dkim_key_srvtype%&
39934 Service type (tag s=) from the key record. Defaults to "*" if not specified
39935 in the key record.
39936
39937 .vitem &%$dkim_key_granularity%&
39938 Key granularity (tag g=) from the key record. Defaults to "*" if not specified
39939 in the key record.
39940
39941 .vitem &%$dkim_key_notes%&
39942 Notes from the key record (tag n=).
39943
39944 .vitem &%$dkim_key_length%&
39945 Number of bits in the key.
39946
39947 Note that RFC 8301 says:
39948 .code
39949 Verifiers MUST NOT consider signatures using RSA keys of
39950 less than 1024 bits as valid signatures.
39951 .endd
39952
39953 To enforce this you must have a DKIM ACL which checks this variable
39954 and overwrites the &$dkim_verify_status$& variable as discussed above.
39955 As EC keys are much smaller, the check should only do this for RSA keys.
39956
39957 .endlist
39958
39959 In addition, two ACL conditions are provided:
39960
39961 .vlist
39962 .vitem &%dkim_signers%&
39963 ACL condition that checks a colon-separated list of domains or identities
39964 for a match against the domain or identity that the ACL is currently verifying
39965 (reflected by &%$dkim_cur_signer%&). This is typically used to restrict an ACL
39966 verb to a group of domains or identities. For example:
39967
39968 .code
39969 # Warn when Mail purportedly from GMail has no gmail signature
39970 warn log_message = GMail sender without gmail.com DKIM signature
39971      sender_domains = gmail.com
39972      dkim_signers = gmail.com
39973      dkim_status = none
39974 .endd
39975
39976 Note that the above does not check for a total lack of DKIM signing;
39977 for that check for empty &$h_DKIM-Signature:$& in the data ACL.
39978
39979 .vitem &%dkim_status%&
39980 ACL condition that checks a colon-separated list of possible DKIM verification
39981 results against the actual result of verification. This is typically used
39982 to restrict an ACL verb to a list of verification outcomes, for example:
39983
39984 .code
39985 deny message = Mail from Paypal with invalid/missing signature
39986      sender_domains = paypal.com:paypal.de
39987      dkim_signers = paypal.com:paypal.de
39988      dkim_status = none:invalid:fail
39989 .endd
39990
39991 The possible status keywords are: 'none','invalid','fail' and 'pass'. Please
39992 see the documentation of the &%$dkim_verify_status%& expansion variable above
39993 for more information of what they mean.
39994 .endlist
39995
39996
39997
39998
39999 .section "SPF (Sender Policy Framework)" SECSPF
40000 .cindex SPF verification
40001
40002 SPF is a mechanism whereby a domain may assert which IP addresses may transmit
40003 messages with its domain in the envelope from, documented by RFC 7208.
40004 For more information on SPF see &url(http://www.openspf.org).
40005 . --- 2018-09-07: still not https
40006
40007 Messages sent by a system not authorised will fail checking of such assertions.
40008 This includes retransmissions done by traditional forwarders.
40009
40010 SPF verification support is built into Exim if SUPPORT_SPF=yes is set in
40011 &_Local/Makefile_&.  The support uses the &_libspf2_& library
40012 &url(https://www.libspf2.org/).
40013 There is no Exim involvement in the transmission of messages;
40014 publishing certain DNS records is all that is required.
40015
40016 For verification, an ACL condition and an expansion lookup are provided.
40017 .cindex authentication "expansion item"
40018 Performing verification sets up information used by the
40019 &$authresults$& expansion item.
40020
40021
40022 .cindex SPF "ACL condition"
40023 .cindex ACL "spf condition"
40024 The ACL condition "spf" can be used at or after the MAIL ACL.
40025 It takes as an argument a list of strings giving the outcome of the SPF check,
40026 and will succeed for any matching outcome.
40027 Valid strings are:
40028 .vlist
40029 .vitem &%pass%&
40030 The SPF check passed, the sending host is positively verified by SPF.
40031
40032 .vitem &%fail%&
40033 The SPF check failed, the sending host is NOT allowed to send mail for the
40034 domain in the envelope-from address.
40035
40036 .vitem &%softfail%&
40037 The SPF check failed, but the queried domain can't absolutely confirm that this
40038 is a forgery.
40039
40040 .vitem &%none%&
40041 The queried domain does not publish SPF records.
40042
40043 .vitem &%neutral%&
40044 The SPF check returned a "neutral" state.  This means the queried domain has
40045 published a SPF record, but wants to allow outside servers to send mail under
40046 its domain as well.  This should be treated like "none".
40047
40048 .vitem &%permerror%&
40049 This indicates a syntax error in the SPF record of the queried domain.
40050 You may deny messages when this occurs.
40051
40052 .vitem &%temperror%&
40053 This indicates a temporary error during all processing, including Exim's
40054 SPF processing.  You may defer messages when this occurs.
40055 .endlist
40056
40057 You can prefix each string with an exclamation mark to  invert
40058 its meaning,  for example  "!fail" will  match all  results but
40059 "fail".  The  string  list is  evaluated  left-to-right,  in a
40060 short-circuit fashion.
40061
40062 Example:
40063 .code
40064 deny spf = fail
40065      message = $sender_host_address is not allowed to send mail from \
40066                ${if def:sender_address_domain \
40067                     {$sender_address_domain}{$sender_helo_name}}.  \
40068                Please see http://www.openspf.org/Why?scope=\
40069                ${if def:sender_address_domain {mfrom}{helo}};\
40070                identity=${if def:sender_address_domain \
40071                              {$sender_address}{$sender_helo_name}};\
40072                ip=$sender_host_address
40073 .endd
40074
40075 When the spf condition has run, it sets up several expansion
40076 variables:
40077
40078 .cindex SPF "verification variables"
40079 .vlist
40080 .vitem &$spf_header_comment$&
40081 .vindex &$spf_header_comment$&
40082   This contains a human-readable string describing the outcome
40083   of the SPF check. You can add it to a custom header or use
40084   it for logging purposes.
40085
40086 .vitem &$spf_received$&
40087 .vindex &$spf_received$&
40088   This contains a complete Received-SPF: header that can be
40089   added to the message. Please note that according to the SPF
40090   draft, this header must be added at the top of the header
40091   list. Please see section 10 on how you can do this.
40092
40093   Note: in case of "Best-guess" (see below), the convention is
40094   to put this string in a header called X-SPF-Guess: instead.
40095
40096 .vitem &$spf_result$&
40097 .vindex &$spf_result$&
40098   This contains the outcome of the SPF check in string form,
40099   one of pass, fail, softfail, none, neutral, permerror or
40100   temperror.
40101
40102 .vitem &$spf_result_guessed$&
40103 .vindex &$spf_result_guessed$&
40104   This boolean is true only if a best-guess operation was used
40105   and required in order to obtain a result.
40106
40107 .vitem &$spf_smtp_comment$&
40108 .vindex &$spf_smtp_comment$&
40109   This contains a string that can be used in a SMTP response
40110   to the calling party. Useful for "fail".
40111 .endlist
40112
40113
40114 .cindex SPF "ACL condition"
40115 .cindex ACL "spf_guess condition"
40116 .cindex SPF "best guess"
40117 In addition to SPF, you can also perform checks for so-called
40118 "Best-guess".  Strictly speaking, "Best-guess" is not standard
40119 SPF, but it is supported by the same framework that enables SPF
40120 capability.
40121 Refer to &url(http://www.openspf.org/FAQ/Best_guess_record)
40122 for a description of what it means.
40123 . --- 2018-09-07: still not https:
40124
40125 To access this feature, simply use the spf_guess condition in place
40126 of the spf one.  For example:
40127
40128 .code
40129 deny spf_guess = fail
40130      message = $sender_host_address doesn't look trustworthy to me
40131 .endd
40132
40133 In case you decide to reject messages based on this check, you
40134 should note that although it uses the same framework, "Best-guess"
40135 is not SPF, and therefore you should not mention SPF at all in your
40136 reject message.
40137
40138 When the spf_guess condition has run, it sets up the same expansion
40139 variables as when spf condition is run, described above.
40140
40141 Additionally, since Best-guess is not standardized, you may redefine
40142 what "Best-guess" means to you by redefining the main configuration
40143 &%spf_guess%& option.
40144 For example, the following:
40145
40146 .code
40147 spf_guess = v=spf1 a/16 mx/16 ptr ?all
40148 .endd
40149
40150 would relax host matching rules to a broader network range.
40151
40152
40153 .cindex SPF "lookup expansion"
40154 .cindex lookup spf
40155 A lookup expansion is also available. It takes an email
40156 address as the key and an IP address as the database:
40157
40158 .code
40159   ${lookup {username@domain} spf {ip.ip.ip.ip}}
40160 .endd
40161
40162 The lookup will return the same result strings as can appear in
40163 &$spf_result$& (pass,fail,softfail,neutral,none,err_perm,err_temp).
40164 Currently, only IPv4 addresses are supported.
40165
40166
40167
40168
40169 . ////////////////////////////////////////////////////////////////////////////
40170 . ////////////////////////////////////////////////////////////////////////////
40171
40172 .chapter "Proxies" "CHAPproxies" &&&
40173          "Proxy support"
40174 .cindex "proxy support"
40175 .cindex "proxy" "access via"
40176
40177 A proxy is an intermediate system through which communication is passed.
40178 Proxies may provide a security, availability or load-distribution function.
40179
40180
40181 .section "Inbound proxies" SECTproxyInbound
40182 .cindex proxy inbound
40183 .cindex proxy "server side"
40184 .cindex proxy "Proxy protocol"
40185 .cindex "Proxy protocol" proxy
40186
40187 Exim has support for receiving inbound SMTP connections via a proxy
40188 that uses &"Proxy Protocol"& to speak to it.
40189 To include this support, include &"SUPPORT_PROXY=yes"&
40190 in Local/Makefile.
40191
40192 It was built on the HAProxy specification, found at
40193 &url(https://www.haproxy.org/download/1.8/doc/proxy-protocol.txt).
40194
40195 The purpose of this facility is so that an application load balancer,
40196 such as HAProxy, can sit in front of several Exim servers
40197 to distribute load.
40198 Exim uses the local protocol communication with the proxy to obtain
40199 the remote SMTP system IP address and port information.
40200 There is no logging if a host passes or
40201 fails Proxy Protocol negotiation, but it can easily be determined and
40202 recorded in an ACL (example is below).
40203
40204 Use of a proxy is enabled by setting the &%hosts_proxy%&
40205 main configuration option to a hostlist; connections from these
40206 hosts will use Proxy Protocol.
40207 Exim supports both version 1 and version 2 of the Proxy Protocol and
40208 automatically determines which version is in use.
40209
40210 The Proxy Protocol header is the first data received on a TCP connection
40211 and is inserted before any TLS-on-connect handshake from the client; Exim
40212 negotiates TLS between Exim-as-server and the remote client, not between
40213 Exim and the proxy server.
40214
40215 The following expansion variables are usable
40216 (&"internal"& and &"external"& here refer to the interfaces
40217 of the proxy):
40218 .display
40219 &'proxy_external_address   '& IP of host being proxied or IP of remote interface of proxy
40220 &'proxy_external_port      '& Port of host being proxied or Port on remote interface of proxy
40221 &'proxy_local_address      '& IP of proxy server inbound or IP of local interface of proxy
40222 &'proxy_local_port         '& Port of proxy server inbound or Port on local interface of proxy
40223 &'proxy_session            '& boolean: SMTP connection via proxy
40224 .endd
40225 If &$proxy_session$& is set but &$proxy_external_address$& is empty
40226 there was a protocol error.
40227 The variables &$sender_host_address$& and &$sender_host_port$&
40228 will have values for the actual client system, not the proxy.
40229
40230 Since the real connections are all coming from the proxy, and the
40231 per host connection tracking is done before Proxy Protocol is
40232 evaluated, &%smtp_accept_max_per_host%& must be set high enough to
40233 handle all of the parallel volume you expect per inbound proxy.
40234 With the option set so high, you lose the ability
40235 to protect your server from many connections from one IP.
40236 In order to prevent your server from overload, you
40237 need to add a per connection ratelimit to your connect ACL.
40238 A possible solution is:
40239 .display
40240   # Set max number of connections per host
40241   LIMIT   = 5
40242   # Or do some kind of IP lookup in a flat file or database
40243   # LIMIT = ${lookup{$sender_host_address}iplsearch{/etc/exim/proxy_limits}}
40244
40245   defer   message        = Too many connections from this IP right now
40246           ratelimit      = LIMIT / 5s / per_conn / strict
40247 .endd
40248
40249
40250
40251 .section "Outbound proxies" SECTproxySOCKS
40252 .cindex proxy outbound
40253 .cindex proxy "client side"
40254 .cindex proxy SOCKS
40255 .cindex SOCKS proxy
40256 Exim has support for sending outbound SMTP via a proxy
40257 using a protocol called SOCKS5 (defined by RFC1928).
40258 The support can be optionally included by defining SUPPORT_SOCKS=yes in
40259 Local/Makefile.
40260
40261 Use of a proxy is enabled by setting the &%socks_proxy%& option
40262 on an smtp transport.
40263 The option value is expanded and should then be a list
40264 (colon-separated by default) of proxy specifiers.
40265 Each proxy specifier is a list
40266 (space-separated by default) where the initial element
40267 is an IP address and any subsequent elements are options.
40268
40269 Options are a string <name>=<value>.
40270 The list of options is in the following table:
40271 .display
40272 &'auth   '& authentication method
40273 &'name   '& authentication username
40274 &'pass   '& authentication password
40275 &'port   '& tcp port
40276 &'tmo    '& connection timeout
40277 &'pri    '& priority
40278 &'weight '& selection bias
40279 .endd
40280
40281 More details on each of these options follows:
40282
40283 .ilist
40284 .cindex authentication "to proxy"
40285 .cindex proxy authentication
40286 &%auth%&: Either &"none"& (default) or &"name"&.
40287 Using &"name"& selects username/password authentication per RFC 1929
40288 for access to the proxy.
40289 Default is &"none"&.
40290 .next
40291 &%name%&: sets the username for the &"name"& authentication method.
40292 Default is empty.
40293 .next
40294 &%pass%&: sets the password for the &"name"& authentication method.
40295 Default is empty.
40296 .next
40297 &%port%&: the TCP port number to use for the connection to the proxy.
40298 Default is 1080.
40299 .next
40300 &%tmo%&: sets a connection timeout in seconds for this proxy.
40301 Default is 5.
40302 .next
40303 &%pri%&: specifies a priority for the proxy within the list,
40304 higher values being tried first.
40305 The default priority is 1.
40306 .next
40307 &%weight%&: specifies a selection bias.
40308 Within a priority set servers are queried in a random fashion,
40309 weighted by this value.
40310 The default value for selection bias is 1.
40311 .endlist
40312
40313 Proxies from the list are tried according to their priority
40314 and weight settings until one responds.  The timeout for the
40315 overall connection applies to the set of proxied attempts.
40316
40317 .section Logging SECTproxyLog
40318 To log the (local) IP of a proxy in the incoming or delivery logline,
40319 add &"+proxy"& to the &%log_selector%& option.
40320 This will add a component tagged with &"PRX="& to the line.
40321
40322 . ////////////////////////////////////////////////////////////////////////////
40323 . ////////////////////////////////////////////////////////////////////////////
40324
40325 .chapter "Internationalisation" "CHAPi18n" &&&
40326          "Internationalisation""
40327 .cindex internationalisation "email address"
40328 .cindex EAI
40329 .cindex i18n
40330 .cindex utf8 "mail name handling"
40331
40332 Exim has support for Internationalised mail names.
40333 To include this it must be built with SUPPORT_I18N and the libidn library.
40334 Standards supported are RFCs 2060, 5890, 6530 and 6533.
40335
40336 If Exim is built with SUPPORT_I18N_2008 (in addition to SUPPORT_I18N, not
40337 instead of it) then IDNA2008 is supported; this adds an extra library
40338 requirement, upon libidn2.
40339
40340 .section "MTA operations" SECTi18nMTA
40341 .cindex SMTPUTF8 "ESMTP option"
40342 The main configuration option &%smtputf8_advertise_hosts%& specifies
40343 a host list.  If this matches the sending host and
40344 accept_8bitmime is true (the default) then the ESMTP option
40345 SMTPUTF8 will be advertised.
40346
40347 If the sender specifies the SMTPUTF8 option on a MAIL command
40348 international handling for the message is enabled and
40349 the expansion variable &$message_smtputf8$& will have value TRUE.
40350
40351 The option &%allow_utf8_domains%& is set to true for this
40352 message. All DNS lookups are converted to a-label form
40353 whatever the setting of &%allow_utf8_domains%&
40354 when Exim is built with SUPPORT_I18N.
40355
40356 Both localparts and domain are maintained as the original
40357 UTF-8 form internally; any comparison or regular-expression use will
40358 require appropriate care.  Filenames created, eg. by
40359 the appendfile transport, will have UTF-8 names.
40360
40361 HELO names sent by the smtp transport will have any UTF-8
40362 components expanded to a-label form,
40363 and any certificate name checks will be done using the a-label
40364 form of the name.
40365
40366 .cindex log protocol
40367 .cindex SMTPUTF8 logging
40368 .cindex i18n logging
40369 Log lines and Received-by: header lines will acquire a "utf8"
40370 prefix on the protocol element, eg. utf8esmtp.
40371
40372 The following expansion operators can be used:
40373 .code
40374 ${utf8_domain_to_alabel:str}
40375 ${utf8_domain_from_alabel:str}
40376 ${utf8_localpart_to_alabel:str}
40377 ${utf8_localpart_from_alabel:str}
40378 .endd
40379
40380 .cindex utf8 "address downconversion"
40381 .cindex i18n "utf8 address downconversion"
40382 The RCPT ACL
40383 may use the following modifier:
40384 .display
40385 control = utf8_downconvert
40386 control = utf8_downconvert/<value>
40387 .endd
40388 This sets a flag requiring that addresses are converted to
40389 a-label form before smtp delivery, for use in a
40390 Message Submission Agent context.
40391 If a value is appended it may be:
40392 .display
40393 &`1  `& (default) mandatory downconversion
40394 &`0  `& no downconversion
40395 &`-1 `& if SMTPUTF8 not supported by destination host
40396 .endd
40397
40398 If mua_wrapper is set, the utf8_downconvert control
40399 is initially set to -1.
40400
40401 The smtp transport has an option &%utf8_downconvert%&.
40402 If set it must expand to one of the three values described above,
40403 and it overrides any previously set value.
40404
40405
40406 There is no explicit support for VRFY and EXPN.
40407 Configurations supporting these should inspect
40408 &$smtp_command_argument$& for an SMTPUTF8 argument.
40409
40410 There is no support for LMTP on Unix sockets.
40411 Using the "lmtp" protocol option on an smtp transport,
40412 for LMTP over TCP, should work as expected.
40413
40414 There is no support for DSN unitext handling,
40415 and no provision for converting logging from or to UTF-8.
40416
40417
40418
40419 .section "MDA operations" SECTi18nMDA
40420 To aid in constructing names suitable for IMAP folders
40421 the following expansion operator can be used:
40422 .code
40423 ${imapfolder {<string>} {<sep>} {<specials>}}
40424 .endd
40425
40426 The string is converted from the charset specified by
40427 the "headers charset" command (in a filter file)
40428 or &%headers_charset%& main configuration option (otherwise),
40429 to the
40430 modified UTF-7 encoding specified by RFC 2060,
40431 with the following exception: All occurrences of <sep>
40432 (which has to be a single character)
40433 are replaced with periods ("."), and all periods and slashes that are not
40434 <sep> and are not in the <specials> string are BASE64 encoded.
40435
40436 The third argument can be omitted, defaulting to an empty string.
40437 The second argument can be omitted, defaulting to "/".
40438
40439 This is the encoding used by Courier for Maildir names on disk, and followed
40440 by many other IMAP servers.
40441
40442 Examples:
40443 .display
40444 &`${imapfolder {Foo/Bar}}       `& yields &`Foo.Bar`&
40445 &`${imapfolder {Foo/Bar}{.}{/}} `& yields &`Foo&&AC8-Bar`&
40446 &`${imapfolder {Räksmörgås}}    `& yields &`R&&AOQ-ksm&&APY-rg&&AOU-s`&
40447 .endd
40448
40449 Note that the source charset setting is vital, and also that characters
40450 must be representable in UTF-16.
40451
40452
40453 . ////////////////////////////////////////////////////////////////////////////
40454 . ////////////////////////////////////////////////////////////////////////////
40455
40456 .chapter "Events" "CHAPevents" &&&
40457          "Events"
40458 .cindex events
40459
40460 The events mechanism in Exim can be used to intercept processing at a number
40461 of points.  It was originally invented to give a way to do customised logging
40462 actions (for example, to a database) but can also be used to modify some
40463 processing actions.
40464
40465 Most installations will never need to use Events.
40466 The support can be left out of a build by defining DISABLE_EVENT=yes
40467 in &_Local/Makefile_&.
40468
40469 There are two major classes of events: main and transport.
40470 The main configuration option &%event_action%& controls reception events;
40471 a transport option &%event_action%& controls delivery events.
40472
40473 Both options are a string which is expanded when the event fires.
40474 An example might look like:
40475 .cindex logging custom
40476 .code
40477 event_action = ${if eq {msg:delivery}{$event_name} \
40478 {${lookup pgsql {SELECT * FROM record_Delivery( \
40479     '${quote_pgsql:$sender_address_domain}',\
40480     '${quote_pgsql:${lc:$sender_address_local_part}}', \
40481     '${quote_pgsql:$domain}', \
40482     '${quote_pgsql:${lc:$local_part}}', \
40483     '${quote_pgsql:$host_address}', \
40484     '${quote_pgsql:${lc:$host}}', \
40485     '${quote_pgsql:$message_exim_id}')}} \
40486 } {}}
40487 .endd
40488
40489 Events have names which correspond to the point in process at which they fire.
40490 The name is placed in the variable &$event_name$& and the event action
40491 expansion must check this, as it will be called for every possible event type.
40492
40493 The current list of events is:
40494 .display
40495 &`dane:fail              after    transport  `& per connection
40496 &`msg:complete           after    main       `& per message
40497 &`msg:delivery           after    transport  `& per recipient
40498 &`msg:rcpt:host:defer    after    transport  `& per recipient per host
40499 &`msg:rcpt:defer         after    transport  `& per recipient
40500 &`msg:host:defer         after    transport  `& per attempt
40501 &`msg:fail:delivery      after    transport  `& per recipient
40502 &`msg:fail:internal      after    main       `& per recipient
40503 &`tcp:connect            before   transport  `& per connection
40504 &`tcp:close              after    transport  `& per connection
40505 &`tls:cert               before   both       `& per certificate in verification chain
40506 &`smtp:connect           after    transport  `& per connection
40507 .endd
40508 New event types may be added in future.
40509
40510 The event name is a colon-separated list, defining the type of
40511 event in a tree of possibilities.  It may be used as a list
40512 or just matched on as a whole.  There will be no spaces in the name.
40513
40514 The second column in the table above describes whether the event fires
40515 before or after the action is associates with.  Those which fire before
40516 can be used to affect that action (more on this below).
40517
40518 The third column in the table above says what section of the configuration
40519 should define the event action.
40520
40521 An additional variable, &$event_data$&, is filled with information varying
40522 with the event type:
40523 .display
40524 &`dane:fail            `& failure reason
40525 &`msg:delivery         `& smtp confirmation message
40526 &`msg:fail:internal    `& failure reason
40527 &`msg:fail:delivery    `& smtp error message
40528 &`msg:rcpt:host:defer  `& error string
40529 &`msg:rcpt:defer       `& error string
40530 &`msg:host:defer       `& error string
40531 &`tls:cert             `& verification chain depth
40532 &`smtp:connect         `& smtp banner
40533 .endd
40534
40535 The :defer events populate one extra variable: &$event_defer_errno$&.
40536
40537 For complex operations an ACL expansion can be used in &%event_action%&
40538 however due to the multiple contexts that Exim operates in during
40539 the course of its processing:
40540 .ilist
40541 variables set in transport events will not be visible outside that
40542 transport call
40543 .next
40544 acl_m variables in a server context are lost on a new connection,
40545 and after smtp helo/ehlo/mail/starttls/rset commands
40546 .endlist
40547 Using an ACL expansion with the logwrite modifier can be
40548 a useful way of writing to the main log.
40549
40550 The expansion of the event_action option should normally
40551 return an empty string.  Should it return anything else the
40552 following will be forced:
40553 .display
40554 &`tcp:connect      `&  do not connect
40555 &`tls:cert         `&  refuse verification
40556 &`smtp:connect     `&  close connection
40557 .endd
40558 All other message types ignore the result string, and
40559 no other use is made of it.
40560
40561 For a tcp:connect event, if the connection is being made to a proxy
40562 then the address and port variables will be that of the proxy and not
40563 the target system.
40564
40565 For tls:cert events, if GnuTLS is in use this will trigger only per
40566 chain element received on the connection.
40567 For OpenSSL it will trigger for every chain element including those
40568 loaded locally.
40569
40570 . ////////////////////////////////////////////////////////////////////////////
40571 . ////////////////////////////////////////////////////////////////////////////
40572
40573 .chapter "Adding new drivers or lookup types" "CHID13" &&&
40574          "Adding drivers or lookups"
40575 .cindex "adding drivers"
40576 .cindex "new drivers, adding"
40577 .cindex "drivers" "adding new"
40578 The following actions have to be taken in order to add a new router, transport,
40579 authenticator, or lookup type to Exim:
40580
40581 .olist
40582 Choose a name for the driver or lookup type that does not conflict with any
40583 existing name; I will use &"newdriver"& in what follows.
40584 .next
40585 Add to &_src/EDITME_& the line:
40586 .display
40587 <&'type'&>&`_NEWDRIVER=yes`&
40588 .endd
40589 where <&'type'&> is ROUTER, TRANSPORT, AUTH, or LOOKUP. If the
40590 code is not to be included in the binary by default, comment this line out. You
40591 should also add any relevant comments about the driver or lookup type.
40592 .next
40593 Add to &_src/config.h.defaults_& the line:
40594 .code
40595 #define <type>_NEWDRIVER
40596 .endd
40597 .next
40598 Edit &_src/drtables.c_&, adding conditional code to pull in the private header
40599 and create a table entry as is done for all the other drivers and lookup types.
40600 .next
40601 Edit &_scripts/lookups-Makefile_& if this is a new lookup; there is a for-loop
40602 near the bottom, ranging the &`name_mod`& variable over a list of all lookups.
40603 Add your &`NEWDRIVER`& to that list.
40604 As long as the dynamic module would be named &_newdriver.so_&, you can use the
40605 simple form that most lookups have.
40606 .next
40607 Edit &_Makefile_& in the appropriate sub-directory (&_src/routers_&,
40608 &_src/transports_&, &_src/auths_&, or &_src/lookups_&); add a line for the new
40609 driver or lookup type and add it to the definition of OBJ.
40610 .next
40611 Edit &_OS/Makefile-Base_& adding a &_.o_& file for the predefined-macros, to the
40612 definition of OBJ_MACRO.  Add a set of line to do the compile also.
40613 .next
40614 Create &_newdriver.h_& and &_newdriver.c_& in the appropriate sub-directory of
40615 &_src_&.
40616 .next
40617 Edit &_scripts/MakeLinks_& and add commands to link the &_.h_& and &_.c_& files
40618 as for other drivers and lookups.
40619 .endlist
40620
40621 Then all you need to do is write the code! A good way to start is to make a
40622 proforma by copying an existing module of the same type, globally changing all
40623 occurrences of the name, and cutting out most of the code. Note that any
40624 options you create must be listed in alphabetical order, because the tables are
40625 searched using a binary chop procedure.
40626
40627 There is a &_README_& file in each of the sub-directories of &_src_& describing
40628 the interface that is expected.
40629
40630
40631
40632
40633 . ////////////////////////////////////////////////////////////////////////////
40634 . ////////////////////////////////////////////////////////////////////////////
40635
40636 . /////////////////////////////////////////////////////////////////////////////
40637 . These lines are processing instructions for the Simple DocBook Processor that
40638 . Philip Hazel has developed as a less cumbersome way of making PostScript and
40639 . PDFs than using xmlto and fop. They will be ignored by all other XML
40640 . processors.
40641 . /////////////////////////////////////////////////////////////////////////////
40642
40643 .literal xml
40644 <?sdop
40645   format="newpage"
40646   foot_right_recto="&chaptertitle;"
40647   foot_right_verso="&chaptertitle;"
40648 ?>
40649 .literal off
40650
40651 .makeindex "Options index"   "option"
40652 .makeindex "Variables index" "variable"
40653 .makeindex "Concept index"   "concept"
40654
40655
40656 . /////////////////////////////////////////////////////////////////////////////
40657 . /////////////////////////////////////////////////////////////////////////////